Clean up test cases and rename policy schema version error

Author: ch5zzy

packages/auth/src/core/auth/auth_impl.test.ts

@@ -788,44 +788,67 @@ describe('core/auth/auth_impl', () => {
   });
 
   context('passwordPolicy', () => {
+    const TEST_ALLOWED_NON_ALPHANUMERIC_CHARS = ['!', '(', ')'];
+    const TEST_MIN_PASSWORD_LENGTH = 6;
+
     const passwordPolicyResponse = {
       customStrengthOptions: {
-        minPasswordLength: 6
+        minPasswordLength: TEST_MIN_PASSWORD_LENGTH
       },
-      allowedNonAlphanumericCharacters: ['!', '(', ')'],
+      allowedNonAlphanumericCharacters: TEST_ALLOWED_NON_ALPHANUMERIC_CHARS,
       schemaVersion: 1
     };
     const passwordPolicyResponseRequireNumeric = {
       customStrengthOptions: {
-        minPasswordLength: 6,
+        minPasswordLength: TEST_MIN_PASSWORD_LENGTH,
         containsNumericCharacter: true
       },
-      allowedNonAlphanumericCharacters: ['!', '(', ')'],
+      allowedNonAlphanumericCharacters: TEST_ALLOWED_NON_ALPHANUMERIC_CHARS,
       schemaVersion: 1
     };
     const passwordPolicyResponseUnsupportedVersion = {
       customStrengthOptions: {
-        maxPasswordLength: 9
+        maxPasswordLength: TEST_MIN_PASSWORD_LENGTH,
+        unsupportedPasswordPolicyProperty: 10
       },
-      allowedNonAlphanumericCharacters: ['!'],
+      allowedNonAlphanumericCharacters: TEST_ALLOWED_NON_ALPHANUMERIC_CHARS,
       schemaVersion: 0
     };
     const cachedPasswordPolicy = {
       customStrengthOptions: {
-        minPasswordLength: 6
+        minPasswordLength: TEST_MIN_PASSWORD_LENGTH
       },
-      allowedNonAlphanumericCharacters: ['!', '(', ')']
+      allowedNonAlphanumericCharacters: TEST_ALLOWED_NON_ALPHANUMERIC_CHARS
     };
     const cachedPasswordPolicyRequireNumeric = {
       customStrengthOptions: {
-        minPasswordLength: 6,
+        minPasswordLength: TEST_MIN_PASSWORD_LENGTH,
         containsNumericCharacter: true
       },
-      allowedNonAlphanumericCharacters: ['!', '(', ')']
+      allowedNonAlphanumericCharacters: TEST_ALLOWED_NON_ALPHANUMERIC_CHARS
     };
 
     beforeEach(async () => {
       mockFetch.setUp();
+      mockEndpointWithParams(
+        Endpoint.GET_PASSWORD_POLICY,
+        {},
+        passwordPolicyResponse
+      );
+      mockEndpointWithParams(
+        Endpoint.GET_PASSWORD_POLICY,
+        {
+          tenantId: 'tenant-id'
+        },
+        passwordPolicyResponseRequireNumeric
+      );
+      mockEndpointWithParams(
+        Endpoint.GET_PASSWORD_POLICY,
+        {
+          tenantId: 'tenant-id-with-unsupported-policy-version'
+        },
+        passwordPolicyResponseUnsupportedVersion
+      );
     });
 
     afterEach(() => {
@@ -835,11 +858,6 @@ describe('core/auth/auth_impl', () => {
     it('password policy should be set for project if tenant ID is null', async () => {
       auth = await testAuth();
       auth.tenantId = null;
-      mockEndpointWithParams(
-        Endpoint.GET_PASSWORD_POLICY,
-        {},
-        passwordPolicyResponse
-      );
       await auth._updatePasswordPolicy();
 
       expect(auth._getPasswordPolicy()).to.eql(cachedPasswordPolicy);
@@ -848,13 +866,6 @@ describe('core/auth/auth_impl', () => {
     it('password policy should be set for tenant if tenant ID is not null', async () => {
       auth = await testAuth();
       auth.tenantId = 'tenant-id';
-      mockEndpointWithParams(
-        Endpoint.GET_PASSWORD_POLICY,
-        {
-          tenantId: 'tenant-id'
-        },
-        passwordPolicyResponseRequireNumeric
-      );
       await auth._updatePasswordPolicy();
 
       expect(auth._getPasswordPolicy()).to.eql(
@@ -865,20 +876,9 @@ describe('core/auth/auth_impl', () => {
     it('password policy should dynamically switch if tenant ID switches.', async () => {
       auth = await testAuth();
       auth.tenantId = null;
-      mockEndpointWithParams(
-        Endpoint.GET_PASSWORD_POLICY,
-        {},
-        passwordPolicyResponse
-      );
       await auth._updatePasswordPolicy();
+
       auth.tenantId = 'tenant-id';
-      mockEndpointWithParams(
-        Endpoint.GET_PASSWORD_POLICY,
-        {
-          tenantId: 'tenant-id'
-        },
-        passwordPolicyResponseRequireNumeric
-      );
       await auth._updatePasswordPolicy();
 
       auth.tenantId = null;
@@ -893,17 +893,12 @@ describe('core/auth/auth_impl', () => {
 
     it('password policy should not be set when the schema version is not supported', async () => {
       auth = await testAuth();
-      auth.tenantId = null;
-      mockEndpointWithParams(
-        Endpoint.GET_PASSWORD_POLICY,
-        {},
-        passwordPolicyResponseUnsupportedVersion
-      );
+      auth.tenantId = 'tenant-id-with-unsupported-policy-version';
       await expect(auth._updatePasswordPolicy()).to.be.rejectedWith(
-        AuthErrorCode.PASSWORD_POLICY_VERSION_MISMATCH
+        AuthErrorCode.UNSUPPORTED_PASSWORD_POLICY_SCHEMA_VERSION
       );
 
-      expect(auth._getPasswordPolicy()).to.be.null;
+      expect(auth._getPasswordPolicy()).to.be.undefined;
     });
   });
 });

packages/auth/src/core/auth/auth_impl.ts

@@ -444,7 +444,7 @@ export class AuthImpl implements AuthInternal, _FirebaseService {
     ) {
       return Promise.reject(
         this._errorFactory.create(
-          AuthErrorCode.PASSWORD_POLICY_VERSION_MISMATCH,
+          AuthErrorCode.UNSUPPORTED_PASSWORD_POLICY_SCHEMA_VERSION,
           {}
         )
       );

packages/auth/src/core/errors.ts

@@ -133,7 +133,7 @@ export const enum AuthErrorCode {
   MISSING_RECAPTCHA_VERSION = 'missing-recaptcha-version',
   INVALID_RECAPTCHA_VERSION = 'invalid-recaptcha-version',
   INVALID_REQ_TYPE = 'invalid-req-type',
-  PASSWORD_POLICY_VERSION_MISMATCH = 'password-policy-version-mismatch'
+  UNSUPPORTED_PASSWORD_POLICY_SCHEMA_VERSION = 'unsupported-password-policy-schema-version'
 }
 
 function _debugErrorMap(): ErrorMap<AuthErrorCode> {
@@ -383,8 +383,8 @@ function _debugErrorMap(): ErrorMap<AuthErrorCode> {
     [AuthErrorCode.INVALID_REQ_TYPE]: 'Invalid request parameters.',
     [AuthErrorCode.INVALID_RECAPTCHA_VERSION]:
       'The reCAPTCHA version is invalid when sending request to the backend.',
-    [AuthErrorCode.PASSWORD_POLICY_VERSION_MISMATCH]:
-      'The password policy received from the backend has a schema version that is not supported by this version of the Firebase SDK.'
+    [AuthErrorCode.UNSUPPORTED_PASSWORD_POLICY_SCHEMA_VERSION]:
+      'The password policy received from the backend uses a schema version that is not supported by this version of the Firebase SDK.'
   };
 }