Rename captchaResp and fakeToken params

Author: NhienLam

packages/auth/src/api/account_management/mfa.ts

@@ -57,7 +57,9 @@ export interface StartPhoneMfaEnrollmentRequest {
   idToken: string;
   phoneEnrollmentInfo: {
     phoneNumber: string;
+    // reCAPTCHA v2 token
     recaptchaToken?: string;
+    // reCAPTCHA Enterprise token
     captchaResponse?: string;
     clientType?: RecaptchaClientType;
     recaptchaVersion?: RecaptchaVersion;

packages/auth/src/api/authentication/mfa.ts

@@ -49,7 +49,9 @@ export interface StartPhoneMfaSignInRequest {
   mfaPendingCredential: string;
   mfaEnrollmentId: string;
   phoneSignInInfo: {
+    // reCAPTCHA v2 token
     recaptchaToken?: string;
+    // reCAPTCHA Enterprise token
     captchaResponse?: string;
     clientType?: RecaptchaClientType;
     recaptchaVersion?: RecaptchaVersion;

packages/auth/src/api/authentication/sms.ts

@@ -32,8 +32,10 @@ import { Auth } from '../../model/public_types';
 
 export interface SendPhoneVerificationCodeRequest {
   phoneNumber: string;
+  // reCAPTCHA v2 token
   recaptchaToken?: string;
   tenantId?: string;
+  // reCAPTCHA Enterprise token
   captchaResponse?: string;
   clientType?: RecaptchaClientType;
   recaptchaVersion?: RecaptchaVersion;

packages/auth/src/platform_browser/recaptcha/recaptcha.test.ts

@@ -39,7 +39,6 @@ describe('platform_browser/recaptcha/recaptcha', () => {
   let recaptchaV2: MockReCaptcha;
   let recaptchaV3: MockGreCAPTCHA;
   let recaptchaEnterprise: MockGreCAPTCHATopLevel;
-  let recaptchaConfig: RecaptchaConfig;
 
   const TEST_SITE_KEY = 'test-site-key';
 
@@ -57,6 +56,41 @@ describe('platform_browser/recaptcha/recaptcha', () => {
     ]
   };
 
+  const GET_RECAPTCHA_CONFIG_RESPONSE_OFF: GetRecaptchaConfigResponse = {
+    recaptchaKey: 'projects/testproj/keys/' + TEST_SITE_KEY,
+    recaptchaEnforcementState: [
+      {
+        provider: RecaptchaProvider.EMAIL_PASSWORD_PROVIDER,
+        enforcementState: EnforcementState.OFF
+      },
+      {
+        provider: RecaptchaProvider.PHONE_PROVIDER,
+        enforcementState: EnforcementState.OFF
+      }
+    ]
+  };
+
+  const GET_RECAPTCHA_CONFIG_RESPONSE_ENFORCE_AND_OFF: GetRecaptchaConfigResponse =
+    {
+      recaptchaKey: 'projects/testproj/keys/' + TEST_SITE_KEY,
+      recaptchaEnforcementState: [
+        {
+          provider: RecaptchaProvider.EMAIL_PASSWORD_PROVIDER,
+          enforcementState: EnforcementState.ENFORCE
+        },
+        {
+          provider: RecaptchaProvider.PHONE_PROVIDER,
+          enforcementState: EnforcementState.OFF
+        }
+      ]
+    };
+
+  const recaptchaConfig = new RecaptchaConfig(GET_RECAPTCHA_CONFIG_RESPONSE);
+  const recaptchaConfigOff = new RecaptchaConfig(GET_RECAPTCHA_CONFIG_RESPONSE_OFF);
+  const recaptchaConfigEnforceAndOff = new RecaptchaConfig(
+    GET_RECAPTCHA_CONFIG_RESPONSE_ENFORCE_AND_OFF
+  );
+
   context('#verify', () => {
     beforeEach(async () => {
       auth = await testAuth();
@@ -81,10 +115,6 @@ describe('platform_browser/recaptcha/recaptcha', () => {
   });
 
   context('#RecaptchaConfig', () => {
-    beforeEach(async () => {
-      recaptchaConfig = new RecaptchaConfig(GET_RECAPTCHA_CONFIG_RESPONSE);
-    });
-
     it('should construct the recaptcha config from the backend response', () => {
       expect(recaptchaConfig.siteKey).to.eq(TEST_SITE_KEY);
       expect(recaptchaConfig.recaptchaEnforcementState[0]).to.eql({
@@ -95,6 +125,10 @@ describe('platform_browser/recaptcha/recaptcha', () => {
         provider: RecaptchaProvider.PHONE_PROVIDER,
         enforcementState: EnforcementState.AUDIT
       });
+      expect(recaptchaConfigEnforceAndOff.recaptchaEnforcementState[1]).to.eql({
+        provider: RecaptchaProvider.PHONE_PROVIDER,
+        enforcementState: EnforcementState.OFF
+      });
     });
 
     it('#getProviderEnforcementState should return the correct enforcement state of the provider', () => {
@@ -108,6 +142,11 @@ describe('platform_browser/recaptcha/recaptcha', () => {
           RecaptchaProvider.PHONE_PROVIDER
         )
       ).to.eq(EnforcementState.AUDIT);
+      expect(
+        recaptchaConfigEnforceAndOff.getProviderEnforcementState(
+          RecaptchaProvider.PHONE_PROVIDER
+        )
+      ).to.eq(EnforcementState.OFF);
       expect(recaptchaConfig.getProviderEnforcementState('invalid-provider')).to
         .be.null;
     });
@@ -121,29 +160,18 @@ describe('platform_browser/recaptcha/recaptcha', () => {
       expect(
         recaptchaConfig.isProviderEnabled(RecaptchaProvider.PHONE_PROVIDER)
       ).to.be.true;
+      expect(
+        recaptchaConfigEnforceAndOff.isProviderEnabled(
+          RecaptchaProvider.PHONE_PROVIDER
+        )
+      ).to.be.false;
       expect(recaptchaConfig.isProviderEnabled('invalid-provider')).to.be.false;
     });
 
     it('#isAnyProviderEnabled should return true if at least one provider is enabled', () => {
       expect(recaptchaConfig.isAnyProviderEnabled()).to.be.true;
-
-      const getRecaptchaConfigResponse: GetRecaptchaConfigResponse = {
-        recaptchaKey: 'projects/testproj/keys/' + TEST_SITE_KEY,
-        recaptchaEnforcementState: [
-          {
-            provider: RecaptchaProvider.EMAIL_PASSWORD_PROVIDER,
-            enforcementState: EnforcementState.OFF
-          },
-          {
-            provider: RecaptchaProvider.PHONE_PROVIDER,
-            enforcementState: EnforcementState.OFF
-          }
-        ]
-      };
-      const configNoProviderEnabled = new RecaptchaConfig(
-        getRecaptchaConfigResponse
-      );
-      expect(configNoProviderEnabled.isAnyProviderEnabled()).to.be.false;
+      expect(recaptchaConfigEnforceAndOff.isAnyProviderEnabled()).to.be.true;
+      expect(recaptchaConfigOff.isAnyProviderEnabled()).to.be.false;
     });
   });
 });

packages/auth/src/platform_browser/recaptcha/recaptcha_enterprise_verifier.ts

@@ -157,13 +157,13 @@ export async function injectRecaptchaFields<T>(
   auth: AuthInternal,
   request: T,
   action: RecaptchaActionName,
-  captchaResp = false,
-  fakeToken = false
+  isCaptchaResp = false,
+  isFakeToken = false
 ): Promise<T> {
   const verifier = new RecaptchaEnterpriseVerifier(auth);
   let captchaResponse;
 
-  if (fakeToken) {
+  if (isFakeToken) {
     captchaResponse = FAKE_TOKEN;
   } else {
     try {
@@ -212,7 +212,7 @@ export async function injectRecaptchaFields<T>(
     return newRequest;
   }
 
-  if (!captchaResp) {
+  if (!isCaptchaResp) {
     Object.assign(newRequest, { captchaResponse });
   } else {
     Object.assign(newRequest, { 'captchaResp': captchaResponse });