tailscale: fix default User-Agent header to include terraform version #361
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
mpminardi
force-pushed
the
mpminardi/user-agent-changes
branch
2 times, most recently
from
a418631
to
0af5102
Compare
mpminardi
commented
Apr 30, 2024
| @@ -8,24 +8,10 @@ import ( | |||
| "github.com/tailscale/terraform-provider-tailscale/tailscale" | |||
| ) | |||
|
|
|||
| // version is filled by goreleaser at build time. | |||
| var version = "dev" | |||
There was a problem hiding this comment.
Moved this to provider.go as that is the one place it is used currently and to avoid messiness with having to pass the version into the Provider method.
mpminardi
commented
Apr 30, 2024
| @@ -84,14 +91,18 @@ func Provider(options ...ProviderOption) *schema.Provider { | |||
| }, | |||
| } | |||
|
|
|||
| provider.ConfigureContextFunc = func(ctx context.Context, d *schema.ResourceData) (interface{}, diag.Diagnostics) { | |||
There was a problem hiding this comment.
Moved setting ConfigureContextFunc here so we can pass the provider into providerConfigure.
mpminardi
commented
Apr 30, 2024
| @@ -113,6 +124,9 @@ func providerConfigure(_ context.Context, d *schema.ResourceData) (interface{}, | |||
| } | |||
|
|
|||
| userAgent := d.Get("user_agent").(string) | |||
| if userAgent == "" { | |||
| userAgent = provider.UserAgent("terraform-provider-tailscale", providerVersion) | |||
There was a problem hiding this comment.
This is essentially an identical call to what we were making before, but at this point the underlying provider.TerraformVersion value used in the UserAgent call is populated properly.
mpminardi
commented
Apr 30, 2024
| @@ -5,7 +5,7 @@ builds: | |||
| flags: | |||
| - -trimpath | |||
| ldflags: | |||
| - "-s -w -X main.version={{.Version}} -X main.commit={{.Commit}}" | |||
| - "-s -w -X github.com/tailscale/terraform-provider-tailscale/tailscale.providerVersion={{.Version}} -X main.commit={{.Commit}}" | |||
There was a problem hiding this comment.
This needs to be the fully qualified path since it no longer lives in main.go. See here in the AzureRM Terraform provider for similar usage.
knyar
approved these changes
May 1, 2024
soniaappasamy
approved these changes
May 1, 2024
The `schema.Provider.UserAgent` helper function was previously being called at a point in the plugin lifecycle before the `TerraformVersion` for the provider was set by Terraform Core. This was resulting in the Terraform version information being missing from the User-Agent header. The call to `schema.Provider.UserAgent` has now been moved into the `providerConfigure` func as this is called later in the configure lifecycle where the Terraform version is properly set. Fixes tailscale/corp#19630 Signed-off-by: Mario Minardi <mario@tailscale.com>
mpminardi
force-pushed
the
mpminardi/user-agent-changes
branch
from
0af5102
to
5aaffc9
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The
schema.Provider.UserAgenthelper function was previously being called at a point in the plugin lifecycle before theTerraformVersionfor the provider was set by Terraform Core. This was resulting in the Terraform version information being missing from the User-Agent header. The call toschema.Provider.UserAgenthas now been moved into theproviderConfigurefunc as this is called later in the configure lifecycle where the Terraform version is properly set.Header Before
Terraform/ (+https://www.terraform.io) Terraform-Plugin-SDK/2.33.0 terraform-provider-tailscale/devHeader After
Terraform/1.8.2 (+https://www.terraform.io) Terraform-Plugin-SDK/2.33.0 terraform-provider-tailscale/devFixes https://github.com/tailscale/corp/issues/19630