fix comments after refactoring

Author: ndyakov

credentials_provider.go

@@ -26,11 +26,11 @@ type entraidCredentialsProvider struct {
 	rwLock sync.RWMutex
 }
 
-// onTokenNext is a method that is called when the token manager receives a new manager.
+// onTokenNext is a method that is called when the token manager receives a new token.
 func (e *entraidCredentialsProvider) onTokenNext(t *token.Token) {
 	e.rwLock.RLock()
 	defer e.rwLock.RUnlock()
-	// Notify all listeners with the new manager.
+	// Notify all listeners with the new token.
 	for _, listener := range e.listeners {
 		listener.OnNext(t)
 	}
@@ -64,7 +64,7 @@ func (e *entraidCredentialsProvider) Subscribe(listener auth.CredentialsListener
 	}
 
 	if !alreadySubscribed {
-		// Get the manager from the identity provider.
+		// add new listener
 		e.listeners = append(e.listeners, listener)
 	}
 	e.rwLock.Unlock()
@@ -105,7 +105,7 @@ func (e *entraidCredentialsProvider) Subscribe(listener auth.CredentialsListener
 
 // newCredentialsProvider creates a new credentials provider.
 // It takes a TokenManager and CredentialProviderOptions as arguments and returns a StreamingCredentialsProvider interface.
-// The TokenManager is used to obtain the manager, and the CredentialProviderOptions contains options for the credentials provider.
+// The TokenManager is used to obtain the token, and the CredentialProviderOptions contains options for the credentials provider.
 // The credentials provider is responsible for managing the credentials and refreshing them when necessary.
 // It returns an error if the token manager cannot be started.
 func newCredentialsProvider(tokenManager manager.TokenManager, options CredentialsProviderOptions) (auth.StreamingCredentialsProvider, error) {

identity/authority_configuration.go

@@ -4,19 +4,19 @@ import "fmt"
 
 const (
 	// AuthorityTypeDefault is the default authority type.
-	// This is used to specify the authority type when requesting a manager.
+	// This is used to specify the authority type when requesting a token.
 	AuthorityTypeDefault = "default"
 	// AuthorityTypeMultiTenant is the multi-tenant authority type.
-	// This is used to specify the multi-tenant authority type when requesting a manager.
-	// This type of authority is used to authenticate the identity when requesting a manager.
+	// This is used to specify the multi-tenant authority type when requesting a token.
+	// This type of authority is used to authenticate the identity when requesting a token.
 	AuthorityTypeMultiTenant = "multi-tenant"
 	// AuthorityTypeCustom is the custom authority type.
-	// This is used to specify the custom authority type when requesting a manager.
+	// This is used to specify the custom authority type when requesting a token.
 	AuthorityTypeCustom = "custom"
 )
 
 // AuthorityConfiguration represents the authority configuration for the identity provider.
-// It is used to configure the authority type and authority URL when requesting a manager.
+// It is used to configure the authority type and authority URL when requesting a token.
 type AuthorityConfiguration struct {
 	// AuthorityType is the type of authority used to authenticate with the identity provider.
 	// This can be either "default", "multi-tenant", or "custom".
@@ -28,7 +28,7 @@ type AuthorityConfiguration struct {
 	Authority string
 
 	// TenantID is the tenant ID of the identity provider.
-	// This is used to identify the tenant when requesting a manager.
+	// This is used to identify the tenant when requesting a token.
 	// This is typically the ID of the Azure Active Directory tenant.
 	TenantID string
 }

identity/azure_default_identity_provider.go

@@ -14,7 +14,7 @@ import (
 type DefaultAzureIdentityProviderOptions struct {
 	// AzureOptions is the options used to configure the Azure identity provider.
 	AzureOptions *azidentity.DefaultAzureCredentialOptions
-	// Scopes is the list of scopes used to request a manager from the identity provider.
+	// Scopes is the list of scopes used to request a token from the identity provider.
 	Scopes []string
 
 	// credFactory is a factory for creating the default Azure credential.
@@ -56,8 +56,8 @@ func NewDefaultAzureIdentityProvider(opts DefaultAzureIdentityProviderOptions) (
 	}, nil
 }
 
-// RequestToken requests a manager from the Azure Default Identity provider.
-// It returns the manager, the expiration time, and an error if any.
+// RequestToken requests a token from the Azure Default Identity provider.
+// It returns the token, the expiration time, and an error if any.
 func (a *DefaultAzureIdentityProvider) RequestToken() (shared.IdentityProviderResponse, error) {
 	credFactory := a.credFactory
 	if credFactory == nil {
@@ -70,7 +70,7 @@ func (a *DefaultAzureIdentityProvider) RequestToken() (shared.IdentityProviderRe
 
 	token, err := cred.GetToken(context.TODO(), policy.TokenRequestOptions{Scopes: a.scopes})
 	if err != nil {
-		return nil, fmt.Errorf("failed to get manager: %w", err)
+		return nil, fmt.Errorf("failed to get token: %w", err)
 	}
 
 	return shared.NewIDPResponse(shared.ResponseTypeAccessToken, &token)

identity/azure_default_identity_provider_test.go

@@ -36,11 +36,11 @@ func TestAzureDefaultIdentityProvider_RequestToken(t *testing.T) {
 		t.Fatalf("failed to create DefaultAzureIdentityProvider: %v", err)
 	}
 
-	// Request a manager from the provider in incorrect environment
+	// Request a token from the provider in incorrect environment
 	// should fail.
 	token, err := provider.RequestToken()
-	assert.Nil(t, token, "manager should be nil")
-	assert.Error(t, err, "failed to request manager")
+	assert.Nil(t, token, "token should be nil")
+	assert.Error(t, err, "failed to request token")
 
 	// use mockAzureCredential to simulate the environment
 	mToken := azcore.AccessToken{
@@ -52,10 +52,10 @@ func TestAzureDefaultIdentityProvider_RequestToken(t *testing.T) {
 	mCredFactory.On("NewDefaultAzureCredential", mock.Anything).Return(mCreds, nil)
 	provider.credFactory = mCredFactory
 	token, err = provider.RequestToken()
-	assert.NotNil(t, token, "manager should not be nil")
-	assert.NoError(t, err, "failed to request manager")
-	assert.Equal(t, shared.ResponseTypeAccessToken, token.Type(), "manager type should be access manager")
-	assert.Equal(t, mToken, token.AccessToken(), "access manager should be equal to testJWTToken")
+	assert.NotNil(t, token, "token should not be nil")
+	assert.NoError(t, err, "failed to request token")
+	assert.Equal(t, shared.ResponseTypeAccessToken, token.Type(), "token type should be access token")
+	assert.Equal(t, mToken, token.AccessToken(), "access token should be equal to testJWTToken")
 }
 
 func TestAzureDefaultIdentityProvider_RequestTokenWithScopes(t *testing.T) {
@@ -69,10 +69,10 @@ func TestAzureDefaultIdentityProvider_RequestTokenWithScopes(t *testing.T) {
 	}
 
 	t.Run("RequestToken with custom scopes", func(t *testing.T) {
-		// Request a manager from the provider
+		// Request a token from the provider
 		token, err := provider.RequestToken()
-		assert.Nil(t, token, "manager should be nil")
-		assert.Error(t, err, "failed to request manager")
+		assert.Nil(t, token, "token should be nil")
+		assert.Error(t, err, "failed to request token")
 
 		// use mockAzureCredential to simulate the environment
 		mToken := azcore.AccessToken{
@@ -84,18 +84,18 @@ func TestAzureDefaultIdentityProvider_RequestTokenWithScopes(t *testing.T) {
 		mCredFactory.On("NewDefaultAzureCredential", mock.Anything).Return(mCreds, nil)
 		provider.credFactory = mCredFactory
 		token, err = provider.RequestToken()
-		assert.NotNil(t, token, "manager should not be nil")
-		assert.NoError(t, err, "failed to request manager")
-		assert.Equal(t, shared.ResponseTypeAccessToken, token.Type(), "manager type should be access manager")
-		assert.Equal(t, mToken, token.AccessToken(), "access manager should be equal to testJWTToken")
+		assert.NotNil(t, token, "token should not be nil")
+		assert.NoError(t, err, "failed to request token")
+		assert.Equal(t, shared.ResponseTypeAccessToken, token.Type(), "token type should be access token")
+		assert.Equal(t, mToken, token.AccessToken(), "access token should be equal to testJWTToken")
 	})
 	t.Run("RequestToken with error from credFactory", func(t *testing.T) {
 		// use mockAzureCredential to simulate the environment
 		mCredFactory := &mockCredFactory{}
 		mCredFactory.On("NewDefaultAzureCredential", mock.Anything).Return(nil, assert.AnError)
 		provider.credFactory = mCredFactory
 		token, err := provider.RequestToken()
-		assert.Nil(t, token, "manager should be nil")
-		assert.Error(t, err, "failed to request manager")
+		assert.Nil(t, token, "token should be nil")
+		assert.Error(t, err, "failed to request token")
 	})
 }

identity/confidential_identity_provider.go

@@ -27,7 +27,7 @@ type ConfidentialIdentityProviderOptions struct {
 	// ClientPrivateKey is the private key used to authenticate with the identity provider.
 	ClientPrivateKey crypto.PrivateKey
 
-	// Scopes is the list of scopes used to request a manager from the identity provider.
+	// Scopes is the list of scopes used to request a token from the identity provider.
 	Scopes []string
 
 	// Authority is the authority used to authenticate with the identity provider.
@@ -46,10 +46,10 @@ type ConfidentialIdentityProvider struct {
 	// credential is the credential used to authenticate with the identity provider.
 	credential confidential.Credential
 
-	// scopes is the list of scopes used to request a manager from the identity provider.
+	// scopes is the list of scopes used to request a token from the identity provider.
 	scopes []string
 
-	// client confidential is the client used to request a manager from the identity provider.
+	// client confidential is the client used to request a token from the identity provider.
 	client confidentialTokenClient
 }
 
@@ -81,7 +81,7 @@ func (d *defaultConfidentialCredFactory) NewCredFromCert(clientCert []*x509.Cert
 }
 
 // NewConfidentialIdentityProvider creates a new confidential identity provider.
-// It is used to configure the identity provider when requesting a manager.
+// It is used to configure the identity provider when requesting a token.
 // It is used to specify the client ID, tenant ID, and scopes for the identity.
 // It is also used to specify the type of credentials used to authenticate with the identity provider.
 // The credentials can be either a client secret or a client certificate.
@@ -153,7 +153,7 @@ func NewConfidentialIdentityProvider(opts ConfidentialIdentityProviderOptions) (
 	}, nil
 }
 
-// RequestToken requests a manager from the identity provider.
+// RequestToken requests a token from the identity provider.
 // It returns the identity provider response, including the auth result.
 func (c *ConfidentialIdentityProvider) RequestToken() (shared.IdentityProviderResponse, error) {
 	if c.client == nil {

identity/identity_test.go

@@ -12,7 +12,7 @@ import (
 	"github.com/stretchr/testify/mock"
 )
 
-// testJWTToken is a JWT manager for testing
+// testJWTToken is a JWT token for testing
 //
 //	{
 //	 "iss": "test jwt",

identity/managed_identity_provider.go

@@ -19,34 +19,34 @@ type ManagedIdentityClient interface {
 }
 
 // ManagedIdentityProviderOptions represents the options for the managed identity provider.
-// It is used to configure the identity provider when requesting a manager.
+// It is used to configure the identity provider when requesting a token.
 type ManagedIdentityProviderOptions struct {
 	// UserAssignedClientID is the client ID of the user assigned identity.
-	// This is used to identify the identity when requesting a manager.
+	// This is used to identify the identity when requesting a token.
 	UserAssignedClientID string
 	// ManagedIdentityType is the type of managed identity.
 	// This can be either SystemAssigned or UserAssigned.
 	ManagedIdentityType string
 	// Scopes is a list of scopes that the identity has access to.
-	// This is used to specify the permissions that the identity has when requesting a manager.
+	// This is used to specify the permissions that the identity has when requesting a token.
 	Scopes []string
 }
 
 // ManagedIdentityProvider represents a managed identity provider.
 type ManagedIdentityProvider struct {
 	// userAssignedClientID is the client ID of the user assigned identity.
-	// This is used to identify the identity when requesting a manager.
+	// This is used to identify the identity when requesting a token.
 	userAssignedClientID string
 
 	// managedIdentityType is the type of managed identity.
 	// This can be either SystemAssigned or UserAssigned.
 	managedIdentityType string
 
 	// scopes is a list of scopes that the identity has access to.
-	// This is used to specify the permissions that the identity has when requesting a manager.
+	// This is used to specify the permissions that the identity has when requesting a token.
 	scopes []string
 
-	// client is the managed identity client used to request a manager.
+	// client is the managed identity client used to request a token.
 	client ManagedIdentityClient
 }
 
@@ -60,7 +60,7 @@ func (c *realManagedIdentityClient) AcquireToken(ctx context.Context, resource s
 }
 
 // NewManagedIdentityProvider creates a new managed identity provider for Azure with managed identity.
-// It is used to configure the identity provider when requesting a manager.
+// It is used to configure the identity provider when requesting a token.
 func NewManagedIdentityProvider(opts ManagedIdentityProviderOptions) (*ManagedIdentityProvider, error) {
 	var client ManagedIdentityClient
 
@@ -72,7 +72,7 @@ func NewManagedIdentityProvider(opts ManagedIdentityProviderOptions) (*ManagedId
 	case SystemAssignedIdentity:
 		// SystemAssignedIdentity is the type of identity that is automatically managed by Azure.
 		// This type of identity is automatically created and managed by Azure.
-		// It is used to authenticate the identity when requesting a manager.
+		// It is used to authenticate the identity when requesting a token.
 		miClient, err := mi.New(mi.SystemAssigned())
 		if err != nil {
 			return nil, fmt.Errorf("couldn't create managed identity client: %w", err)
@@ -99,7 +99,7 @@ func NewManagedIdentityProvider(opts ManagedIdentityProviderOptions) (*ManagedId
 	}, nil
 }
 
-// RequestToken requests a manager from the managed identity provider.
+// RequestToken requests a token from the managed identity provider.
 // It returns IdentityProviderResponse, which contains the Acc and the expiration time.
 func (m *ManagedIdentityProvider) RequestToken() (shared.IdentityProviderResponse, error) {
 	if m.client == nil {
@@ -113,11 +113,11 @@ func (m *ManagedIdentityProvider) RequestToken() (shared.IdentityProviderRespons
 	if len(m.scopes) > 0 {
 		resource = m.scopes[0]
 	}
-	// acquire manager using the managed identity client
+	// acquire token using the managed identity client
 	// the resource is the URL of the resource that the identity has access to
 	authResult, err := m.client.AcquireToken(context.TODO(), resource)
 	if err != nil {
-		return nil, fmt.Errorf("coudn't acquire manager: %w", err)
+		return nil, fmt.Errorf("coudn't acquire token: %w", err)
 	}
 
 	return shared.NewIDPResponse(shared.ResponseTypeAuthResult, &authResult)

identity/managed_identity_provider_test.go

@@ -174,7 +174,7 @@ func TestRequestToken_ErrorCases(t *testing.T) {
 				m.On("AcquireToken", mock.Anything, RedisResource).
 					Return(public.AuthResult{}, errors.New("failed to acquire token"))
 			},
-			expectedError: "coudn't acquire manager: failed to acquire token",
+			expectedError: "coudn't acquire token: failed to acquire token",
 		},
 		{
 			name: "AcquireToken fails with custom resource",
@@ -186,7 +186,7 @@ func TestRequestToken_ErrorCases(t *testing.T) {
 				m.On("AcquireToken", mock.Anything, "custom-resource").
 					Return(public.AuthResult{}, errors.New("failed to acquire token"))
 			},
-			expectedError: "coudn't acquire manager: failed to acquire token",
+			expectedError: "coudn't acquire token: failed to acquire token",
 		},
 		{
 			name: "AcquireToken fails with invalid resource",
@@ -198,7 +198,7 @@ func TestRequestToken_ErrorCases(t *testing.T) {
 				m.On("AcquireToken", mock.Anything, "invalid-resource").
 					Return(public.AuthResult{}, errors.New("invalid resource"))
 			},
-			expectedError: "coudn't acquire manager: invalid resource",
+			expectedError: "coudn't acquire token: invalid resource",
 		},
 	}
 

identity/providers.go

@@ -14,12 +14,12 @@ const (
 	ClientCertificateCredentialType = "ClientCertificate"
 
 	// RedisScopeDefault is the default scope for Redis.
-	// This is used to specify the scope that the identity has access to when requesting a manager.
+	// This is used to specify the scope that the identity has access to when requesting a token.
 	// The scope is typically the URL of the resource that the identity has access to.
 	RedisScopeDefault = "https://redis.azure.com/.default"
 
 	// RedisResource is the default resource for Redis.
-	// This is used to specify the resource that the identity has access to when requesting a manager.
+	// This is used to specify the resource that the identity has access to when requesting a token.
 	// The resource is typically the URL of the resource that the identity has access to.
 	RedisResource = "https://redis.azure.com"
 )

manager/defaults.go

@@ -61,9 +61,9 @@ func defaultRetryOptionsOr(retryOptions RetryOptions) RetryOptions {
 	return retryOptions
 }
 
-// defaultIdentityProviderResponseParserOr returns the default manager parser if the provided manager parser is not set.
-// It sets the default manager parser to the defaultIdentityProviderResponseParser function.
-// The default manager parser is used to parse the raw manager and return a Token object.
+// defaultIdentityProviderResponseParserOr returns the default token parser if the provided token parser is not set.
+// It sets the default token parser to the defaultIdentityProviderResponseParser function.
+// The default token parser is used to parse the raw token and return a Token object.
 func defaultIdentityProviderResponseParserOr(idpResponseParser shared.IdentityProviderResponseParser) shared.IdentityProviderResponseParser {
 	if idpResponseParser == nil {
 		return &defaultIdentityProviderResponseParser{}
@@ -82,9 +82,9 @@ func defaultTokenManagerOptionsOr(options TokenManagerOptions) TokenManagerOptio
 
 type defaultIdentityProviderResponseParser struct{}
 
-// ParseResponse parses the response from the identity provider and extracts the manager.
+// ParseResponse parses the response from the identity provider and extracts the token.
 // It takes an IdentityProviderResponse as an argument and returns a Token and an error if any.
-// The IdentityProviderResponse contains the raw manager and the expiration time.
+// The IdentityProviderResponse contains the raw token and the expiration time.
 func (*defaultIdentityProviderResponseParser) ParseResponse(response shared.IdentityProviderResponse) (*token.Token, error) {
 	var username, password, rawToken string
 	var expiresOn time.Time
@@ -106,7 +106,7 @@ func (*defaultIdentityProviderResponseParser) ParseResponse(response shared.Iden
 		if response.Type() == shared.ResponseTypeAccessToken {
 			accessToken := response.AccessToken()
 			if accessToken.Token == "" {
-				return nil, fmt.Errorf("access manager is empty")
+				return nil, fmt.Errorf("access token is empty")
 			}
 			token = accessToken.Token
 			expiresOn = accessToken.ExpiresOn.UTC()
@@ -117,10 +117,10 @@ func (*defaultIdentityProviderResponseParser) ParseResponse(response shared.Iden
 			Oid string `json:"oid,omitempty"`
 		}{}
 
-		// jwt manager should be verified from the identity provider
+		// jwt token should be verified from the identity provider
 		_, _, err := jwt.NewParser().ParseUnverified(token, &claims)
 		if err != nil {
-			return nil, fmt.Errorf("failed to parse jwt manager: %w", err)
+			return nil, fmt.Errorf("failed to parse jwt token: %w", err)
 		}
 		rawToken = token
 		username = claims.Oid
@@ -144,7 +144,7 @@ func (*defaultIdentityProviderResponseParser) ParseResponse(response shared.Iden
 		return nil, fmt.Errorf("expires on is in the past")
 	}
 
-	// parse manager as jwt manager and get claims
+	// parse token as jwt token and get claims
 	return token.New(
 		username,
 		password,