feat!: change user-agent logic (#12)

BREAKING CHANGE: a new approach for using custom User-Agent is introduced. Now, some method signatures and  User-Agent "appending" logic have changed, be cautios. Custom User-Agent is now added as a postfix to the default one.

Author: icerzack

README.md

@@ -45,6 +45,8 @@ After that initialize `Client` with the retrieved token.
 
 ### Usage example
 
+> [!NOTE] It is highly recommended to use the `WithClientUserAgent` option to set a custom User-Agent for the client.
+
 ```go
 package main
 
@@ -61,13 +63,13 @@ func main() {
     // It should be Service User Token
     token := "gAAAAABeVNzu-..."
 
-    // A Prefix to be added to User-Agent.
-    prefix := "iam-custom"
+    // A client User-Agent.
+    userAgent := "iam-custom"
 
     // Create a new IAM client.
     iamClient, err := iam.New(
     	iam.WithAuthOpts(&iam.AuthOpts{KeystoneToken: token}),
-    	iam.WithUserAgentPrefix(prefix),
+    	iam.WithClientUserAgent(userAgent),
     )
     // Handle the error.
     if err != nil {

examples/federation-with-user/main.go

@@ -25,8 +25,8 @@ var (
 	token          = "gAAAAA..."
 	deleteAfterRun = false
 
-	// Prefix to be added to User-Agent.
-	prefix = "iam-go"
+	// Client User-Agent to be added.
+	clientUserAgent = "iam-go"
 
 	federationName               = "federation_name"
 	federationDescription        = "federation_description"
@@ -45,7 +45,7 @@ func main() {
 	// Create a new IAM client.
 	iamClient, err := iam.New(
 		iam.WithAuthOpts(&iam.AuthOpts{KeystoneToken: token}),
-		iam.WithUserAgentPrefix(prefix),
+		iam.WithClientUserAgent(clientUserAgent),
 	)
 	if err != nil {
 		fmt.Println(err)

examples/group-with-user/main.go

@@ -27,8 +27,8 @@ var (
 	token          = "gAAAAA..."
 	deleteAfterRun = false
 
-	// Prefix to be added to User-Agent.
-	prefix = "iam-go"
+	// Client User-Agent to be added.
+	clientUserAgent = "iam-go"
 
 	groupName          = "test_group_name"
 	description        = "group_description"
@@ -41,7 +41,7 @@ func main() {
 	// Create a new IAM client.
 	iamClient, err := iam.New(
 		iam.WithAuthOpts(&iam.AuthOpts{KeystoneToken: token}),
-		iam.WithUserAgentPrefix(prefix),
+		iam.WithClientUserAgent(clientUserAgent),
 	)
 	if err != nil {
 		fmt.Println(err)

examples/s3credentials-create-delete/main.go

@@ -12,8 +12,8 @@ var (
 	token          = "gAAAAA..."
 	deleteAfterRun = false
 
-	// Prefix to be added to User-Agent.
-	prefix = "iam-go"
+	// Client User-Agent to be added.
+	clientUserAgent = "iam-go"
 
 	// ID of the User to create S3 Credentials for.
 	userID = "a1b2c3..."
@@ -29,7 +29,7 @@ func main() {
 	// Create a new IAM client.
 	iamClient, err := iam.New(
 		iam.WithAuthOpts(&iam.AuthOpts{KeystoneToken: token}),
-		iam.WithUserAgentPrefix(prefix),
+		iam.WithClientUserAgent(clientUserAgent),
 	)
 	// Handle the error.
 	if err != nil {

examples/serviceuser-create-update-delete/main.go

@@ -22,10 +22,12 @@ var (
 	token          = "gAAAAA..."
 	deleteAfterRun = false
 
-	// Prefix to be added to User-Agent.
-	prefix = "iam-go"
+	// Client User-Agent to be added.
+	clientUserAgent = "iam-go"
+
 	// Name of the Service User to create.
 	name = "service-user"
+
 	// Password of the Service User to create.
 	password = "Qazwsxedc123"
 )
@@ -34,7 +36,7 @@ func main() {
 	// Create a new IAM client.
 	iamClient, err := iam.New(
 		iam.WithAuthOpts(&iam.AuthOpts{KeystoneToken: token}),
-		iam.WithUserAgentPrefix(prefix),
+		iam.WithClientUserAgent(clientUserAgent),
 	)
 	if err != nil {
 		fmt.Println(err)

examples/transfer-role/main.go

@@ -21,16 +21,16 @@ func main() {
 	// KeystoneToken
 	token := "gAAAAA..."
 
-	// Prefix to be added to User-Agent.
-	prefix := "iam-go"
+	// Client User-Agent to be added.
+	clientUserAgent := "iam-go"
 
 	// ID of the User to assign role to.
 	userID := "654321_65432"
 
 	// Create a new IAM client.
 	iamClient, err := iam.New(
 		iam.WithAuthOpts(&iam.AuthOpts{KeystoneToken: token}),
-		iam.WithUserAgentPrefix(prefix),
+		iam.WithClientUserAgent(clientUserAgent),
 	)
 	// Handle the error.
 	if err != nil {

examples/user-create-delete/main.go

@@ -22,8 +22,8 @@ var (
 	token          = "gAAAAA..."
 	deleteAfterRun = false
 
-	// Prefix to be added to User-Agent.
-	prefix = "iam-go"
+	// Client User-Agent to be added.
+	clientUserAgent = "iam-go"
 
 	// Email of the User to create.
 	email = "testmail@example.com"
@@ -33,7 +33,7 @@ func main() {
 	// Create a new IAM client.
 	iamClient, err := iam.New(
 		iam.WithAuthOpts(&iam.AuthOpts{KeystoneToken: token}),
-		iam.WithUserAgentPrefix(prefix),
+		iam.WithClientUserAgent(clientUserAgent),
 	)
 	// Handle the error.
 	if err != nil {

iam.go

@@ -95,10 +95,12 @@ func WithAuthOpts(authOpts *AuthOpts) Option {
 	}
 }
 
-// WithUserAgentPrefix is a functional parameter for Client, used to set a custom prefix.
-func WithUserAgentPrefix(prefix string) Option {
+// WithClientUserAgent is a functional parameter for Client, used to set a custom User-Agent postfix.
+//
+// It is highly recommended to use this option!
+func WithClientUserAgent(userAgent string) Option {
 	return func(c *Client) {
-		c.baseClient.UserAgentPrefix = prefix
+		c.baseClient.ClientUserAgent = userAgent
 	}
 }
 
@@ -127,10 +129,9 @@ func New(opts ...Option) (*Client, error) {
 
 	appVersion := findModuleVersion()
 	userAgent := appName + "/" + appVersion
-	if c.baseClient.UserAgentPrefix == "" {
-		c.baseClient.UserAgent = userAgent
-	} else {
-		c.baseClient.UserAgent = c.baseClient.UserAgentPrefix + " " + userAgent
+	c.baseClient.UserAgent = userAgent
+	if c.baseClient.ClientUserAgent != "" {
+		c.baseClient.UserAgent += " " + c.baseClient.ClientUserAgent
 	}
 
 	c.Users = users.New(c.baseClient)

internal/client/client.go

@@ -30,8 +30,8 @@ type BaseClient struct {
 	// UserAgent represents a User-Agent to be added to all requests.
 	UserAgent string
 
-	// UserAgentPrefix contains custom prefix to be added to userAgent.
-	UserAgentPrefix string
+	// ClientUserAgent contains custom User-Agent postfix to be added.
+	ClientUserAgent string
 }
 
 // DoRequest performs the HTTP request with the current Client.HTTPClient and given User-Agent prefix.