chore: use Provider for consistency

Author: fadymak

README.md

@@ -743,16 +743,15 @@ Whether to send a notification email when a user's phone number is changed. Defa
 `GOTRUE_MAILER_TEMPLATES_IDENTITY_LINKED_NOTIFICATION` - `string`
 
 URL path to an email template to use when notifying a user that a new identity has been linked to their account. (e.g. `https://www.example.com/path-to-email-template.html`)
-`Email` and `IdentityProvider` variables are available.
+`Email` and `Provider` variables are available.
 
 Default Content (if template is unavailable):
 
 ```html
 <h2>A new identity has been linked</h2>
 
 <p>
-  A new identity ({{ .IdentityProvider }}) has been linked to your account {{
-  .Email }}.
+  A new identity ({{ .Provider }}) has been linked to your account {{ .Email }}.
 </p>
 <p>If you did not make this change, please contact support immediately.</p>
 ```
@@ -764,16 +763,16 @@ Whether to send a notification email when a new identity is linked to a user's a
 `GOTRUE_MAILER_TEMPLATES_IDENTITY_UNLINKED_NOTIFICATION` - `string`
 
 URL path to an email template to use when notifying a user that an identity has been unlinked from their account. (e.g. `https://www.example.com/path-to-email-template.html`)
-`Email` and `IdentityProvider` variables are available.
+`Email` and `Provider` variables are available.
 
 Default Content (if template is unavailable):
 
 ```html
 <h2>An identity has been unlinked</h2>
 
 <p>
-  An identity ({{ .IdentityProvider }}) has been unlinked from your account {{
-  .Email }}.
+  An identity ({{ .Provider }}) has been unlinked from your account {{ .Email
+  }}.
 </p>
 <p>If you did not make this change, please contact support immediately.</p>
 ```

internal/api/identity.go

@@ -51,7 +51,7 @@ func (a *API) DeleteIdentity(w http.ResponseWriter, r *http.Request) error {
 		return apierrors.NewUnprocessableEntityError(apierrors.ErrorCodeIdentityNotFound, "Identity doesn't exist")
 	}
 
-	identityProvider := identityToBeDeleted.Provider
+	provider := identityToBeDeleted.Provider
 	err = db.Transaction(func(tx *storage.Connection) error {
 		if terr := models.NewAuditLogEntry(config.AuditLog, r, tx, user, models.IdentityUnlinkAction, "", map[string]interface{}{
 			"identity_id": identityToBeDeleted.ID,
@@ -92,7 +92,7 @@ func (a *API) DeleteIdentity(w http.ResponseWriter, r *http.Request) error {
 
 	// Send identity unlinked notification email if enabled and user has an email
 	if config.Mailer.Notifications.IdentityUnlinkedEnabled && user.GetEmail() != "" {
-		if err := a.sendIdentityUnlinkedNotification(r, db, user, identityProvider); err != nil {
+		if err := a.sendIdentityUnlinkedNotification(r, db, user, provider); err != nil {
 			// Log the error but don't fail the unlinking
 			logrus.WithError(err).Warn("Unable to send identity unlinked notification email")
 		}

internal/api/identity_test.go

@@ -257,7 +257,7 @@ func (ts *IdentityTestSuite) TestLinkIdentitySendsNotificationEmailEnabled() {
 	// Assert that identity linked notification email was sent
 	require.Len(ts.T(), mockMailer.IdentityLinkedMailCalls, 1, "Expected 1 identity linked notification email(s) to be sent")
 	require.Equal(ts.T(), u.ID, mockMailer.IdentityLinkedMailCalls[0].User.ID, "Email should be sent to the correct user")
-	require.Equal(ts.T(), "google", mockMailer.IdentityLinkedMailCalls[0].IdentityProvider, "Provider should match")
+	require.Equal(ts.T(), "google", mockMailer.IdentityLinkedMailCalls[0].Provider, "Provider should match")
 	require.Equal(ts.T(), "one@example.com", mockMailer.IdentityLinkedMailCalls[0].User.GetEmail(), "Email should be sent to the correct email address")
 }
 
@@ -313,7 +313,7 @@ func (ts *IdentityTestSuite) TestUnlinkIdentitySendsNotificationEmailEnabled() {
 	// Assert that identity unlinked notification email was sent
 	require.Len(ts.T(), mockMailer.IdentityUnlinkedMailCalls, 1, "Expected 1 identity unlinked notification email(s) to be sent")
 	require.Equal(ts.T(), u.ID, mockMailer.IdentityUnlinkedMailCalls[0].User.ID, "Email should be sent to the correct user")
-	require.Equal(ts.T(), "phone", mockMailer.IdentityUnlinkedMailCalls[0].IdentityProvider, "Provider should match")
+	require.Equal(ts.T(), "phone", mockMailer.IdentityUnlinkedMailCalls[0].Provider, "Provider should match")
 	require.Equal(ts.T(), "two@example.com", mockMailer.IdentityUnlinkedMailCalls[0].User.GetEmail(), "Email should be sent to the correct email address")
 }
 

internal/api/mail.go

@@ -634,10 +634,10 @@ func (a *API) sendPhoneChangedNotification(r *http.Request, tx *storage.Connecti
 	return nil
 }
 
-func (a *API) sendIdentityLinkedNotification(r *http.Request, tx *storage.Connection, u *models.User, identityProvider string) error {
+func (a *API) sendIdentityLinkedNotification(r *http.Request, tx *storage.Connection, u *models.User, provider string) error {
 	err := a.sendEmail(r, tx, u, sendEmailParams{
-		emailActionType:  mail.IdentityLinkedNotification,
-		identityProvider: identityProvider,
+		emailActionType: mail.IdentityLinkedNotification,
+		provider:        provider,
 	})
 	if err != nil {
 		if errors.Is(err, EmailRateLimitExceeded) {
@@ -651,10 +651,10 @@ func (a *API) sendIdentityLinkedNotification(r *http.Request, tx *storage.Connec
 	return nil
 }
 
-func (a *API) sendIdentityUnlinkedNotification(r *http.Request, tx *storage.Connection, u *models.User, identityProvider string) error {
+func (a *API) sendIdentityUnlinkedNotification(r *http.Request, tx *storage.Connection, u *models.User, provider string) error {
 	err := a.sendEmail(r, tx, u, sendEmailParams{
-		emailActionType:  mail.IdentityUnlinkedNotification,
-		identityProvider: identityProvider,
+		emailActionType: mail.IdentityUnlinkedNotification,
+		provider:        provider,
 	})
 	if err != nil {
 		if errors.Is(err, EmailRateLimitExceeded) {
@@ -749,7 +749,7 @@ type sendEmailParams struct {
 	tokenHashWithPrefix string
 	oldEmail            string
 	oldPhone            string
-	identityProvider    string
+	provider            string
 	factorType          string
 }
 
@@ -874,9 +874,9 @@ func (a *API) sendEmail(r *http.Request, tx *storage.Connection, u *models.User,
 	case mail.PhoneChangedNotification:
 		err = mr.PhoneChangedNotificationMail(r, u, params.oldPhone)
 	case mail.IdentityLinkedNotification:
-		err = mr.IdentityLinkedNotificationMail(r, u, params.identityProvider)
+		err = mr.IdentityLinkedNotificationMail(r, u, params.provider)
 	case mail.IdentityUnlinkedNotification:
-		err = mr.IdentityUnlinkedNotificationMail(r, u, params.identityProvider)
+		err = mr.IdentityUnlinkedNotificationMail(r, u, params.provider)
 	case mail.MFAFactorEnrolledNotification:
 		err = mr.MFAFactorEnrolledNotificationMail(r, u, params.factorType)
 	case mail.MFAFactorUnenrolledNotification:

internal/mailer/mailer.go

@@ -43,8 +43,8 @@ type Mailer interface {
 	PasswordChangedNotificationMail(r *http.Request, user *models.User) error
 	EmailChangedNotificationMail(r *http.Request, user *models.User, oldEmail string) error
 	PhoneChangedNotificationMail(r *http.Request, user *models.User, oldPhone string) error
-	IdentityLinkedNotificationMail(r *http.Request, user *models.User, identityProvider string) error
-	IdentityUnlinkedNotificationMail(r *http.Request, user *models.User, identityProvider string) error
+	IdentityLinkedNotificationMail(r *http.Request, user *models.User, provider string) error
+	IdentityUnlinkedNotificationMail(r *http.Request, user *models.User, provider string) error
 	MFAFactorEnrolledNotificationMail(r *http.Request, user *models.User, factorType string) error
 	MFAFactorUnenrolledNotificationMail(r *http.Request, user *models.User, factorType string) error
 }

internal/mailer/mockclient/mockclient.go

@@ -91,13 +91,13 @@ type PhoneChangedMailCall struct {
 }
 
 type IdentityLinkedMailCall struct {
-	User             *models.User
-	IdentityProvider string
+	User     *models.User
+	Provider string
 }
 
 type IdentityUnlinkedMailCall struct {
-	User             *models.User
-	IdentityProvider string
+	User     *models.User
+	Provider string
 }
 
 type MFAFactorEnrolledMailCall struct {
@@ -205,18 +205,18 @@ func (m *MockMailer) PhoneChangedNotificationMail(r *http.Request, user *models.
 	return nil
 }
 
-func (m *MockMailer) IdentityLinkedNotificationMail(r *http.Request, user *models.User, identityProvider string) error {
+func (m *MockMailer) IdentityLinkedNotificationMail(r *http.Request, user *models.User, provider string) error {
 	m.IdentityLinkedMailCalls = append(m.IdentityLinkedMailCalls, IdentityLinkedMailCall{
-		User:             user,
-		IdentityProvider: identityProvider,
+		User:     user,
+		Provider: provider,
 	})
 	return nil
 }
 
-func (m *MockMailer) IdentityUnlinkedNotificationMail(r *http.Request, user *models.User, identityProvider string) error {
+func (m *MockMailer) IdentityUnlinkedNotificationMail(r *http.Request, user *models.User, provider string) error {
 	m.IdentityUnlinkedMailCalls = append(m.IdentityUnlinkedMailCalls, IdentityUnlinkedMailCall{
-		User:             user,
-		IdentityProvider: identityProvider,
+		User:     user,
+		Provider: provider,
 	})
 	return nil
 }

internal/mailer/templatemailer/templatemailer.go

@@ -20,13 +20,13 @@ const (
 	ReauthenticationTemplate = "reauthentication"
 
 	// Account Changes Notifications
-	PasswordChangedNotificationTemplate       = "password_changed_notification"
-	EmailChangedNotificationTemplate          = "email_changed_notification"
-	PhoneChangedNotificationTemplate          = "phone_changed_notification"
-	IdentityLinkedNotificationTemplate        = "identity_linked_notification"
-	IdentityUnlinkedNotificationTemplate      = "identity_unlinked_notification"
-	MFAFactorEnrolledNotificationTemplate     = "mfa_factor_enrolled_notification"
-	MFAFactorUnenrolledNotificationTemplate   = "mfa_factor_unenrolled_notification"
+	PasswordChangedNotificationTemplate     = "password_changed_notification"
+	EmailChangedNotificationTemplate        = "email_changed_notification"
+	PhoneChangedNotificationTemplate        = "phone_changed_notification"
+	IdentityLinkedNotificationTemplate      = "identity_linked_notification"
+	IdentityUnlinkedNotificationTemplate    = "identity_unlinked_notification"
+	MFAFactorEnrolledNotificationTemplate   = "mfa_factor_enrolled_notification"
+	MFAFactorUnenrolledNotificationTemplate = "mfa_factor_unenrolled_notification"
 )
 
 const defaultInviteMail = `<h2>You have been invited</h2>
@@ -86,13 +86,13 @@ const defaultPhoneChangedNotificationMail = `<h2>Your phone number has been chan
 
 const defaultIdentityLinkedNotificationMail = `<h2>A new identity has been linked</h2>
 
-<p>A new identity ({{ .IdentityProvider }}) has been linked to your account {{ .Email }}.</p>
+<p>A new identity ({{ .Provider }}) has been linked to your account {{ .Email }}.</p>
 <p>If you did not make this change, please contact support immediately.</p>
 `
 
 const defaultIdentityUnlinkedNotificationMail = `<h2>An identity has been unlinked</h2>
 
-<p>An identity ({{ .IdentityProvider }}) has been unlinked from your account {{ .Email }}.</p>
+<p>An identity ({{ .Provider }}) has been unlinked from your account {{ .Email }}.</p>
 <p>If you did not make this change, please contact support immediately.</p>
 `
 
@@ -450,20 +450,20 @@ func (m *Mailer) PhoneChangedNotificationMail(r *http.Request, user *models.User
 	return m.mail(r.Context(), m.cfg, PhoneChangedNotificationTemplate, user.GetEmail(), data)
 }
 
-func (m *Mailer) IdentityLinkedNotificationMail(r *http.Request, user *models.User, identityProvider string) error {
+func (m *Mailer) IdentityLinkedNotificationMail(r *http.Request, user *models.User, provider string) error {
 	data := map[string]any{
-		"Email":            user.GetEmail(),
-		"IdentityProvider": identityProvider, // the provider of the newly linked identity
-		"Data":             user.UserMetaData,
+		"Email":    user.GetEmail(),
+		"Provider": provider, // the provider of the newly linked identity
+		"Data":     user.UserMetaData,
 	}
 	return m.mail(r.Context(), m.cfg, IdentityLinkedNotificationTemplate, user.GetEmail(), data)
 }
 
-func (m *Mailer) IdentityUnlinkedNotificationMail(r *http.Request, user *models.User, identityProvider string) error {
+func (m *Mailer) IdentityUnlinkedNotificationMail(r *http.Request, user *models.User, provider string) error {
 	data := map[string]any{
-		"Email":            user.GetEmail(),
-		"IdentityProvider": identityProvider, // the provider of the unlinked identity
-		"Data":             user.UserMetaData,
+		"Email":    user.GetEmail(),
+		"Provider": provider, // the provider of the unlinked identity
+		"Data":     user.UserMetaData,
 	}
 	return m.mail(r.Context(), m.cfg, IdentityUnlinkedNotificationTemplate, user.GetEmail(), data)
 }