fix: update user-agent

Author: SignalRichard

stackoverflow/client/client.go

@@ -11,17 +11,19 @@ import (
 )
 
 type Client struct {
-	BaseURL     string
-	TeamName    string
-	AccessToken string
-	HTTPClient  *http.Client
-	DefaultTags []string
+	BaseURL         string
+	TeamName        string
+	AccessToken     string
+	UserAgentHeader string
+	HTTPClient      *http.Client
+	DefaultTags     []string
 }
 
-func NewClient(baseURL *string, accessToken *string) *Client {
+func NewClient(baseURL *string, accessToken *string, userAgentHeader *string) *Client {
 	c := Client{
-		BaseURL:     *baseURL,
-		AccessToken: *accessToken,
+		BaseURL:         *baseURL,
+		AccessToken:     *accessToken,
+		UserAgentHeader: *userAgentHeader,
 		HTTPClient: &http.Client{
 			Timeout: time.Minute,
 		},
@@ -36,6 +38,7 @@ func (c *Client) doRequest(req *http.Request, successCode int) ([]byte, error) {
 	req.Header.Set("Authorization", authzHeader)
 	req.Header.Set("Accept", "application/json")
 	req.Header.Set("Content-Type", "application/json")
+	req.Header.Set("User-Agent", c.UserAgentHeader)
 
 	res, err := c.HTTPClient.Do(req)
 	if err != nil {

stackoverflow/provider.go

@@ -2,16 +2,23 @@ package stackoverflow
 
 import (
 	"context"
+	"log"
 
 	so "terraform-provider-stackoverflow/stackoverflow/client"
 
 	"github.com/hashicorp/terraform-plugin-sdk/v2/diag"
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
+
+	version "terraform-provider-stackoverflow/version"
 )
 
+// TerraformProviderProductUserAgent is included in the User-Agent header for
+// any API requests made by the provider.
+const TerraformProviderProductUserAgent = "terraform-provider-stackoverflow"
+
 // Provider -
 func Provider() *schema.Provider {
-	return &schema.Provider{
+	provider := &schema.Provider{
 		Schema: map[string]*schema.Schema{
 			"access_token": {
 				Type:        schema.TypeString,
@@ -39,16 +46,21 @@ func Provider() *schema.Provider {
 			"stackoverflow_question":   dataQuestion(),
 			"stackoverflow_tag":        dataTag(),
 		},
-		ConfigureContextFunc: providerConfigure,
 	}
-}
 
-func providerConfigure(ctx context.Context, d *schema.ResourceData) (interface{}, diag.Diagnostics) {
-	accessToken := d.Get("access_token").(string)
-	baseURL := d.Get("base_url").(string)
+	provider.ConfigureContextFunc = func(ctx context.Context, d *schema.ResourceData) (interface{}, diag.Diagnostics) {
+		accessToken := d.Get("access_token").(string)
+		baseURL := d.Get("base_url").(string)
+		userAgentHeader := provider.UserAgent(TerraformProviderProductUserAgent, version.ProviderVersion)
+
+		var diags diag.Diagnostics
 
-	var diags diag.Diagnostics
-	client := so.NewClient(&baseURL, &accessToken)
+		client := so.NewClient(&baseURL, &accessToken, &userAgentHeader)
+
+		log.Printf("User-Agent: %s", client.UserAgentHeader)
+
+		return client, diags
+	}
 
-	return client, diags
+	return provider
 }

version/version.go

@@ -0,0 +1,6 @@
+// Package version contains a variable used to construct the User-Agent for API
+// requests.
+package version
+
+// ProviderVersion is set during the release process to the release version of the binary.
+var ProviderVersion = "dev"