Skip to content

Commit 0eecfa8

Browse files
pragatimodipragatimodi
committed
Update variable names
1 parent 15a8651 commit 0eecfa8

File tree

3 files changed

+37
-37
lines changed

3 files changed

+37
-37
lines changed

‎auth/user_mgt.go

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -87,13 +87,13 @@ type multiFactorEnrollments struct {
8787

8888
// MultiFactorInfo describes a user enrolled second phone factor.
8989
type MultiFactorInfo struct {
90-
UID string
91-
DisplayName string
92-
EnrollmentTimestamp int64
93-
FactorID string
94-
PhoneNumber string // Deprecated: Use PhoneMultiFactorInfo instead
95-
PhoneMultiFactorInfo *PhoneMultiFactorInfo
96-
TOTPMultiFactorInfo *TOTPMultiFactorInfo
90+
UID string
91+
DisplayName string
92+
EnrollmentTimestamp int64
93+
FactorID string
94+
PhoneNumber string // Deprecated: Use PhoneMultiFactorInfo instead
95+
Phone *PhoneMultiFactorInfo
96+
TOTP *TOTPMultiFactorInfo
9797
}
9898

9999
// MultiFactorSettings describes the multi-factor related user settings.
@@ -195,9 +195,9 @@ func convertMultiFactorInfoToServerFormat(mfaInfo MultiFactorInfo) (multiFactorI
195195

196196
switch mfaInfo.FactorID {
197197
case phoneMultiFactorID:
198-
authFactorInfo.PhoneInfo = mfaInfo.PhoneMultiFactorInfo.PhoneNumber
198+
authFactorInfo.PhoneInfo = mfaInfo.Phone.PhoneNumber
199199
case totpMultiFactorID:
200-
authFactorInfo.TOTPInfo = (*TOTPInfo)(mfaInfo.TOTPMultiFactorInfo)
200+
authFactorInfo.TOTPInfo = (*TOTPInfo)(mfaInfo.TOTP)
201201
default:
202202
out, _ := json.Marshal(mfaInfo)
203203
return multiFactorInfoResponse{}, fmt.Errorf("unsupported second factor %s provided", string(out))
@@ -698,10 +698,10 @@ func validateAndFormatMfaSettings(mfaSettings MultiFactorSettings, methodType st
698698
return nil, fmt.Errorf("the second factor \"displayName\" for \"%s\" must be a valid non-empty string", multiFactorInfo.DisplayName)
699699
}
700700
if multiFactorInfo.FactorID == phoneMultiFactorID {
701-
if multiFactorInfo.PhoneMultiFactorInfo != nil {
701+
if multiFactorInfo.Phone != nil {
702702
// If PhoneMultiFactorInfo is provided, validate its PhoneNumber field
703-
if err := validatePhone(multiFactorInfo.PhoneMultiFactorInfo.PhoneNumber); err != nil {
704-
return nil, fmt.Errorf("the second factor \"phoneNumber\" for \"%s\" must be a non-empty E.164 standard compliant identifier string", multiFactorInfo.PhoneMultiFactorInfo.PhoneNumber)
703+
if err := validatePhone(multiFactorInfo.Phone.PhoneNumber); err != nil {
704+
return nil, fmt.Errorf("the second factor \"phoneNumber\" for \"%s\" must be a non-empty E.164 standard compliant identifier string", multiFactorInfo.Phone.PhoneNumber)
705705
}
706706
// No need for the else here since we are returning from the function
707707
} else if multiFactorInfo.PhoneNumber != "" {
@@ -710,7 +710,7 @@ func validateAndFormatMfaSettings(mfaSettings MultiFactorSettings, methodType st
710710
return nil, fmt.Errorf("the second factor \"phoneNumber\" for \"%s\" must be a non-empty E.164 standard compliant identifier string", multiFactorInfo.PhoneNumber)
711711
}
712712
// The PhoneNumber field is deprecated, set it in PhoneMultiFactorInfo and inform about the deprecation.
713-
multiFactorInfo.PhoneMultiFactorInfo = &PhoneMultiFactorInfo{
713+
multiFactorInfo.Phone = &PhoneMultiFactorInfo{
714714
PhoneNumber: multiFactorInfo.PhoneNumber,
715715
}
716716
} else {
@@ -1121,7 +1121,7 @@ func (r *userQueryResponse) makeExportedUserRecord() (*ExportedUserRecord, error
11211121
EnrollmentTimestamp: enrollmentTimestamp,
11221122
FactorID: phoneMultiFactorID,
11231123
PhoneNumber: factor.PhoneInfo,
1124-
PhoneMultiFactorInfo: &PhoneMultiFactorInfo{
1124+
Phone: &PhoneMultiFactorInfo{
11251125
PhoneNumber: factor.PhoneInfo,
11261126
},
11271127
})
@@ -1131,7 +1131,7 @@ func (r *userQueryResponse) makeExportedUserRecord() (*ExportedUserRecord, error
11311131
DisplayName: factor.DisplayName,
11321132
EnrollmentTimestamp: enrollmentTimestamp,
11331133
FactorID: totpMultiFactorID,
1134-
TOTPMultiFactorInfo: &TOTPMultiFactorInfo{},
1134+
TOTP: &TOTPMultiFactorInfo{},
11351135
})
11361136
} else {
11371137
return nil, fmt.Errorf("unsupported multi-factor auth response: %#v", factor)

‎auth/user_mgt_test.go

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ var testUser = &UserRecord{
7272
UID: "enrolledPhoneFactor",
7373
FactorID: "phone",
7474
EnrollmentTimestamp: 1614776780000,
75-
PhoneMultiFactorInfo: &PhoneMultiFactorInfo{
75+
Phone: &PhoneMultiFactorInfo{
7676
PhoneNumber: "+1234567890",
7777
},
7878
PhoneNumber: "+1234567890",
@@ -82,7 +82,7 @@ var testUser = &UserRecord{
8282
UID: "enrolledTOTPFactor",
8383
FactorID: "totp",
8484
EnrollmentTimestamp: 1614776780000,
85-
TOTPMultiFactorInfo: &TOTPMultiFactorInfo{},
85+
TOTP: &TOTPMultiFactorInfo{},
8686
DisplayName: "My MFA TOTP",
8787
},
8888
},
@@ -657,7 +657,7 @@ func TestInvalidCreateUser(t *testing.T) {
657657
EnrolledFactors: []*MultiFactorInfo{
658658
{
659659
UID: "EnrollmentID",
660-
PhoneMultiFactorInfo: &PhoneMultiFactorInfo{
660+
Phone: &PhoneMultiFactorInfo{
661661
PhoneNumber: "+11234567890",
662662
},
663663
DisplayName: "Spouse's phone number",
@@ -670,7 +670,7 @@ func TestInvalidCreateUser(t *testing.T) {
670670
(&UserToCreate{}).MFASettings(MultiFactorSettings{
671671
EnrolledFactors: []*MultiFactorInfo{
672672
{
673-
PhoneMultiFactorInfo: &PhoneMultiFactorInfo{
673+
Phone: &PhoneMultiFactorInfo{
674674
PhoneNumber: "invalid",
675675
},
676676
DisplayName: "Spouse's phone number",
@@ -683,7 +683,7 @@ func TestInvalidCreateUser(t *testing.T) {
683683
(&UserToCreate{}).MFASettings(MultiFactorSettings{
684684
EnrolledFactors: []*MultiFactorInfo{
685685
{
686-
PhoneMultiFactorInfo: &PhoneMultiFactorInfo{
686+
Phone: &PhoneMultiFactorInfo{
687687
PhoneNumber: "+11234567890",
688688
},
689689
DisplayName: "Spouse's phone number",
@@ -697,7 +697,7 @@ func TestInvalidCreateUser(t *testing.T) {
697697
(&UserToCreate{}).MFASettings(MultiFactorSettings{
698698
EnrolledFactors: []*MultiFactorInfo{
699699
{
700-
PhoneMultiFactorInfo: &PhoneMultiFactorInfo{
700+
Phone: &PhoneMultiFactorInfo{
701701
PhoneNumber: "+11234567890",
702702
},
703703
DisplayName: "Spouse's phone number",
@@ -710,7 +710,7 @@ func TestInvalidCreateUser(t *testing.T) {
710710
(&UserToCreate{}).MFASettings(MultiFactorSettings{
711711
EnrolledFactors: []*MultiFactorInfo{
712712
{
713-
PhoneMultiFactorInfo: &PhoneMultiFactorInfo{
713+
Phone: &PhoneMultiFactorInfo{
714714
PhoneNumber: "+11234567890",
715715
},
716716
FactorID: "phone",
@@ -793,7 +793,7 @@ var createUserCases = []struct {
793793
(&UserToCreate{}).MFASettings(MultiFactorSettings{
794794
EnrolledFactors: []*MultiFactorInfo{
795795
{
796-
PhoneMultiFactorInfo: &PhoneMultiFactorInfo{
796+
Phone: &PhoneMultiFactorInfo{
797797
PhoneNumber: "+11234567890",
798798
},
799799
DisplayName: "Phone Number active",
@@ -821,14 +821,14 @@ var createUserCases = []struct {
821821
(&UserToCreate{}).MFASettings(MultiFactorSettings{
822822
EnrolledFactors: []*MultiFactorInfo{
823823
{
824-
PhoneMultiFactorInfo: &PhoneMultiFactorInfo{
824+
Phone: &PhoneMultiFactorInfo{
825825
PhoneNumber: "+11234567890",
826826
},
827827
DisplayName: "number1",
828828
FactorID: "phone",
829829
},
830830
{
831-
PhoneMultiFactorInfo: &PhoneMultiFactorInfo{
831+
Phone: &PhoneMultiFactorInfo{
832832
PhoneNumber: "+11234567890",
833833
},
834834
DisplayName: "number2",
@@ -911,7 +911,7 @@ func TestInvalidUpdateUser(t *testing.T) {
911911
EnrolledFactors: []*MultiFactorInfo{
912912
{
913913
UID: "enrolledSecondFactor1",
914-
PhoneMultiFactorInfo: &PhoneMultiFactorInfo{
914+
Phone: &PhoneMultiFactorInfo{
915915
PhoneNumber: "+11234567890",
916916
},
917917
FactorID: "phone",
@@ -924,7 +924,7 @@ func TestInvalidUpdateUser(t *testing.T) {
924924
EnrolledFactors: []*MultiFactorInfo{
925925
{
926926
UID: "enrolledSecondFactor1",
927-
PhoneMultiFactorInfo: &PhoneMultiFactorInfo{
927+
Phone: &PhoneMultiFactorInfo{
928928
PhoneNumber: "invalid",
929929
},
930930
DisplayName: "Spouse's phone number",
@@ -1078,22 +1078,22 @@ var updateUserCases = []struct {
10781078
EnrolledFactors: []*MultiFactorInfo{
10791079
{
10801080
UID: "enrolledSecondFactor1",
1081-
PhoneMultiFactorInfo: &PhoneMultiFactorInfo{
1081+
Phone: &PhoneMultiFactorInfo{
10821082
PhoneNumber: "+11234567890",
10831083
},
10841084
DisplayName: "Spouse's phone number",
10851085
FactorID: "phone",
10861086
EnrollmentTimestamp: time.Now().Unix(),
10871087
}, {
10881088
UID: "enrolledSecondFactor2",
1089-
PhoneMultiFactorInfo: &PhoneMultiFactorInfo{
1089+
Phone: &PhoneMultiFactorInfo{
10901090
PhoneNumber: "+11234567890",
10911091
},
10921092
PhoneNumber: "+11234567890",
10931093
DisplayName: "Spouse's phone number",
10941094
FactorID: "phone",
10951095
}, {
1096-
PhoneMultiFactorInfo: &PhoneMultiFactorInfo{
1096+
Phone: &PhoneMultiFactorInfo{
10971097
PhoneNumber: "+11234567890",
10981098
},
10991099
PhoneNumber: "+11234567890",

‎integration/auth/user_mgt_test.go

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -439,7 +439,7 @@ func TestCreateUserMFA(t *testing.T) {
439439
FactorID: "phone",
440440
},
441441
{
442-
PhoneMultiFactorInfo: &auth.PhoneMultiFactorInfo{
442+
Phone: &auth.PhoneMultiFactorInfo{
443443
PhoneNumber: "+19876543210",
444444
},
445445
DisplayName: "Phone Number active",
@@ -457,7 +457,7 @@ func TestCreateUserMFA(t *testing.T) {
457457
UID: user.MultiFactor.EnrolledFactors[0].UID,
458458
DisplayName: "Phone Number deprecated",
459459
FactorID: "phone",
460-
PhoneMultiFactorInfo: &auth.PhoneMultiFactorInfo{
460+
Phone: &auth.PhoneMultiFactorInfo{
461461
PhoneNumber: "+11234567890",
462462
},
463463
PhoneNumber: "+11234567890",
@@ -467,7 +467,7 @@ func TestCreateUserMFA(t *testing.T) {
467467
UID: user.MultiFactor.EnrolledFactors[1].UID,
468468
DisplayName: "Phone Number active",
469469
FactorID: "phone",
470-
PhoneMultiFactorInfo: &auth.PhoneMultiFactorInfo{
470+
Phone: &auth.PhoneMultiFactorInfo{
471471
PhoneNumber: "+19876543210",
472472
},
473473
PhoneNumber: "+19876543210",
@@ -745,7 +745,7 @@ func TestUpdateUserMFA(t *testing.T) {
745745
MFASettings(auth.MultiFactorSettings{
746746
EnrolledFactors: []*auth.MultiFactorInfo{
747747
{
748-
PhoneMultiFactorInfo: &auth.PhoneMultiFactorInfo{
748+
Phone: &auth.PhoneMultiFactorInfo{
749749
PhoneNumber: "+11234567890",
750750
},
751751
DisplayName: "Phone Number active",
@@ -773,7 +773,7 @@ func TestUpdateUserMFA(t *testing.T) {
773773
{
774774
DisplayName: "Phone Number active updated",
775775
FactorID: "phone",
776-
PhoneMultiFactorInfo: &auth.PhoneMultiFactorInfo{
776+
Phone: &auth.PhoneMultiFactorInfo{
777777
PhoneNumber: "+11234567890",
778778
},
779779
},
@@ -809,7 +809,7 @@ func TestUpdateUserMFA(t *testing.T) {
809809
EnrolledFactors: []*auth.MultiFactorInfo{
810810
{
811811
UID: updatedUser.MultiFactor.EnrolledFactors[0].UID,
812-
PhoneMultiFactorInfo: &auth.PhoneMultiFactorInfo{
812+
Phone: &auth.PhoneMultiFactorInfo{
813813
PhoneNumber: "+11234567890",
814814
},
815815
PhoneNumber: "+11234567890",
@@ -819,7 +819,7 @@ func TestUpdateUserMFA(t *testing.T) {
819819
},
820820
{
821821
UID: updatedUser.MultiFactor.EnrolledFactors[1].UID,
822-
PhoneMultiFactorInfo: &auth.PhoneMultiFactorInfo{
822+
Phone: &auth.PhoneMultiFactorInfo{
823823
PhoneNumber: "+19876543210",
824824
},
825825
PhoneNumber: "+19876543210",

0 commit comments

Comments
 (0)