feat: add friendly name to enroll factor response (supabase#1277)

## What kind of change does this PR introduce? See title - [x] Need to update docs PR to update GoTrue: https://github.com/supabase/gotrue/pull/1277/files Docs Update: supabase#1277 --------- Co-authored-by: [email protected] <[email protected]>
uxodb · Nov 15, 2023 · 0c6eb61 · 0c6eb61
1 parent 86b4310
commit 0c6eb61
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 5 deletions.
diff --git a/internal/api/mfa.go b/internal/api/mfa.go
@@ -33,9 +33,10 @@ type TOTPObject struct {
 }
 
 type EnrollFactorResponse struct {
-	ID   uuid.UUID  `json:"id"`
-	Type string     `json:"type"`
-	TOTP TOTPObject `json:"totp,omitempty"`
+	ID           uuid.UUID  `json:"id"`
+	Type         string     `json:"type"`
+	FriendlyName string     `json:"friendly_name"`
+	TOTP         TOTPObject `json:"totp,omitempty"`
 }
 
 type VerifyFactorParams struct {
@@ -149,8 +150,9 @@ func (a *API) EnrollFactor(w http.ResponseWriter, r *http.Request) error {
 	}
 
 	return sendJSON(w, http.StatusOK, &EnrollFactorResponse{
-		ID:   factor.ID,
-		Type: models.TOTP,
+		ID:           factor.ID,
+		Type:         models.TOTP,
+		FriendlyName: factor.FriendlyName,
 		TOTP: TOTPObject{
 			// See: https://css-tricks.com/probably-dont-base64-svg/
 			QRCode: buf.String(),

diff --git a/internal/api/mfa_test.go b/internal/api/mfa_test.go
@@ -147,6 +147,7 @@ func (ts *MFATestSuite) TestEnrollFactor() {
 				qrCode := enrollResp.TOTP.QRCode
 				hasSVGStartAndEnd := strings.Contains(qrCode, "<svg") && strings.Contains(qrCode, "</svg>")
 				require.True(ts.T(), hasSVGStartAndEnd)
+				require.Equal(ts.T(), c.friendlyName, enrollResp.FriendlyName)
 			}
 		})
 	}