provider: introduce FindGoModuleVersion helper for module versions

Before this change, we relied on the plugin libraries to expose their version. Unfortunately, this was incorrectly set in SDKv2[1] and non-existent in the framework[2]. The recommended approach is to instead dig into the build information via`runtime/debug.ReadBuildInfo()`[3] which is what we introduce here in a slightly safer and consistent way. [1]: hashicorp/terraform-plugin-sdk#1257 [2]: hashicorp/terraform-plugin-framework#855 [3]: https://pkg.go.dev/runtime/debug#ReadBuildInfo Signed-off-by: Jacob Bednarz <[email protected]>
cloudflare · Oct 12, 2023 · 39e9d6a · 39e9d6a
1 parent b68b789
commit 39e9d6a
Show file tree

Hide file tree

Showing 4 changed files with 56 additions and 6 deletions.
diff --git a/internal/framework/provider/provider.go b/internal/framework/provider/provider.go
@@ -239,9 +239,11 @@ func (p *CloudflareProvider) Configure(ctx context.Context, req provider.Configu
 
 	options = append(options, cloudflare.Debug(logging.IsDebugOrHigher()))
 
+	pluginVersion := utils.FindGoModuleVersion("github.com/hashicorp/terraform-plugin-framework")
 	userAgentParams := utils.UserAgentBuilderParams{
 		ProviderVersion: &p.version,
 		PluginType:      cloudflare.StringPtr("terraform-plugin-framework"),
+		PluginVersion:   pluginVersion,
 	}
 	if !data.UserAgentOperatorSuffix.IsNull() {
 		userAgentParams.OperatorSuffix = cloudflare.StringPtr(data.UserAgentOperatorSuffix.String())

diff --git a/internal/sdkv2provider/provider.go b/internal/sdkv2provider/provider.go
@@ -16,7 +16,6 @@ import (
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/logging"
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/validation"
-	"github.com/hashicorp/terraform-plugin-sdk/v2/meta"
 )
 
 func init() {
@@ -383,10 +382,11 @@ func configure(version string, p *schema.Provider) func(context.Context, *schema
 
 		options = append(options, cloudflare.Debug(logging.IsDebugOrHigher()))
 
+		pluginVersion := utils.FindGoModuleVersion("github.com/hashicorp/terraform-plugin-sdk/v2")
 		userAgentParams := utils.UserAgentBuilderParams{
 			ProviderVersion: cloudflare.StringPtr(version),
 			PluginType:      cloudflare.StringPtr("terraform-plugin-sdk"),
-			PluginVersion:   cloudflare.StringPtr(meta.SDKVersionString()),
+			PluginVersion:   pluginVersion,
 		}
 		if v, ok := d.GetOk(consts.UserAgentOperatorSuffixSchemaKey); ok {
 			userAgentParams.OperatorSuffix = cloudflare.StringPtr(v.(string))

diff --git a/internal/utils/get_go_module_version.go b/internal/utils/get_go_module_version.go
@@ -0,0 +1,33 @@
+package utils
+
+import (
+	"runtime/debug"
+	"strings"
+
+	"github.com/cloudflare/cloudflare-go"
+)
+
+// FindGoModuleVersion digs into the build information and extracts the version
+// of a module for use without the prefixed `v` (should it exist).
+func FindGoModuleVersion(modulePath string) *string {
+	info, ok := debug.ReadBuildInfo()
+	if !ok {
+		// shouldn't ever happen but just in case we aren't using modules
+		return nil
+	}
+
+	for _, mod := range info.Deps {
+		if mod.Path != modulePath {
+			continue
+		}
+
+		version := mod.Version
+		if strings.HasPrefix(version, "v") {
+			version = strings.TrimPrefix(version, "v")
+		}
+
+		return cloudflare.StringPtr(version)
+	}
+
+	return nil
+}
diff --git a/internal/utils/user_agent_builder.go b/internal/utils/user_agent_builder.go
@@ -5,11 +5,24 @@ import (
 )
 
 type UserAgentBuilderParams struct {
-	ProviderVersion  *string
-	PluginVersion    *string
-	PluginType       *string
+	// Version of `terraform-provider-cloudflare`.
+	ProviderVersion *string
+
+	// Version of `terraform-plugin-*` libraries that we rely on for the internal
+	// operations.
+	PluginVersion *string
+
+	// Which plugin is in use. Currently only available options are
+	// `terraform-plugin-sdk` and `terraform-plugin-framework`.
+	PluginType *string
+
+	// Version of Terraform that is initiating the operation. Mutually exclusive
+	// with `OperatorSuffix`.
 	TerraformVersion *string
-	OperatorSuffix   *string
+
+	// Customised operation suffix to append to the user agent for identifying
+	// traffic. Mutually exclusive with `TerraformVersion`.
+	OperatorSuffix *string
 }
 
 func (p *UserAgentBuilderParams) String() string {
@@ -37,6 +50,8 @@ func (p *UserAgentBuilderParams) String() string {
 	return ua
 }
 
+// BuildUserAgent takes the `UserAgentBuilderParams` and contextually builds
+// a HTTP user agent for making API calls.
 func BuildUserAgent(params UserAgentBuilderParams) string {
 	return params.String()
 }