Skip to content

chore: Updates user agent to include if PreviewProviderV2AdvancedCluster env var is enabled #3275

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
Open

chore: Updates user agent to include if PreviewProviderV2AdvancedCluster env var is enabled #3275

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
a1f231c
include previewProviderV2Cluster info in user agent
svc-apix-Bot Apr 11, 2025
798046d
comments
svc-apix-Bot Apr 14, 2025
57388e3
min
svc-apix-Bot Apr 14, 2025
6051cb9
min
svc-apix-Bot Apr 14, 2025
07c9915
PR comments
svc-apix-Bot Apr 16, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 20 additions & 20 deletions internal/config/client.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@ import (
"strings"
"time"

adminpreview "github.com/mongodb/atlas-sdk-go/admin"
admin20240530 "go.mongodb.org/atlas-sdk/v20240530005/admin"
admin20240805 "go.mongodb.org/atlas-sdk/v20240805005/admin"
admin20241113 "go.mongodb.org/atlas-sdk/v20241113005/admin"
Expand All @@ -20,6 +19,7 @@ import (

"github.com/hashicorp/terraform-plugin-sdk/v2/helper/logging"
"github.com/mongodb-forks/digest"
adminpreview "github.com/mongodb/atlas-sdk-go/admin"
"github.com/spf13/cast"

"github.com/mongodb/terraform-provider-mongodbatlas/version"
Expand All @@ -43,12 +43,13 @@ type MongoDBClient struct {

// Config contains the configurations needed to use SDKs
type Config struct {
AssumeRole *AssumeRole
PublicKey string
PrivateKey string
BaseURL string
RealmBaseURL string
TerraformVersion string
AssumeRole *AssumeRole
PublicKey string
PrivateKey string
BaseURL string
RealmBaseURL string
TerraformVersion string
PreviewV2AdvancedClusterEnabled bool
}

type AssumeRole struct {
Expand All @@ -68,11 +69,6 @@ type SecretData struct {
PrivateKey string `json:"private_key"`
}

type PlatformVersion struct {
Name string
Version string
}

// NewClient func...
func (c *Config) NewClient(ctx context.Context) (any, error) {
// setup a transport to handle digest
Expand Down Expand Up @@ -237,16 +233,20 @@ func (c *MongoDBClient) GetRealmClient(ctx context.Context) (*realm.Client, erro
}

func userAgent(c *Config) string {
platformVersions := []PlatformVersion{
{toolName, version.ProviderVersion},
{terraformPlatformName, c.TerraformVersion},
versions := []string{
fmt.Sprintf("%s/%s", toolName, version.ProviderVersion),
fmt.Sprintf("%s/%s", terraformPlatformName, c.TerraformVersion),
}

var metadata []string
if c.PreviewV2AdvancedClusterEnabled {
metadata = append(metadata, "IsPreviewV2AdvancedClusterEnabled=true")
}

var parts []string
for _, info := range platformVersions {
part := fmt.Sprintf("%s/%s", info.Name, info.Version)
parts = append(parts, part)
userAgent := strings.Join(versions, " ")
if len(metadata) > 0 {
userAgent = fmt.Sprintf("%s (%s)", userAgent, strings.Join(metadata, "; "))
Copy link
Member

@lantoli lantoli Apr 14, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why not follow the current format? e.g.

User-Agent: terraform-provider-mongodbatlas/devel Terraform/1.9.3 IsPreviewV2AdvancedClusterEnabled/true

(also consider reducing IsPreviewV2AdvancedClusterEnabled to something shorter but still easy to know what it is)

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

keeping existing format & renamed to IsAdvancedClusterPreview

Also will also include value if false as:
User-Agent: terraform-provider-mongodbatlas/devel Terraform/1.9.3 IsAdvancedClusterPreview/false

}

return strings.Join(parts, " ")
return userAgent
}
11 changes: 6 additions & 5 deletions internal/provider/provider.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -243,11 +243,12 @@ func (p *MongodbtlasProvider) Configure(ctx context.Context, req provider.Config
}

cfg := config.Config{
PublicKey: data.PublicKey.ValueString(),
PrivateKey: data.PrivateKey.ValueString(),
BaseURL: data.BaseURL.ValueString(),
RealmBaseURL: data.RealmBaseURL.ValueString(),
TerraformVersion: req.TerraformVersion,
PublicKey: data.PublicKey.ValueString(),
PrivateKey: data.PrivateKey.ValueString(),
BaseURL: data.BaseURL.ValueString(),
RealmBaseURL: data.RealmBaseURL.ValueString(),
TerraformVersion: req.TerraformVersion,
PreviewV2AdvancedClusterEnabled: config.PreviewProviderV2AdvancedCluster(),
}

var assumeRoles []tfAssumeRoleModel
Expand Down