Remove tenant level mobileLinksConfig CRUD. (#2731)

* removing tenant level mobileLinksConfig change

Author: Xiaoshouzi-gh

etc/firebase-admin.auth.api.md

@@ -950,7 +950,6 @@ export class Tenant {
     readonly displayName?: string;
     readonly emailPrivacyConfig?: EmailPrivacyConfig;
     get emailSignInConfig(): EmailSignInProviderConfig | undefined;
-    readonly mobileLinksConfig?: MobileLinksConfig;
     get multiFactorConfig(): MultiFactorConfig | undefined;
     readonly passwordPolicyConfig?: PasswordPolicyConfig;
     get recaptchaConfig(): RecaptchaConfig | undefined;
@@ -1032,7 +1031,6 @@ export interface UpdateTenantRequest {
     displayName?: string;
     emailPrivacyConfig?: EmailPrivacyConfig;
     emailSignInConfig?: EmailSignInProviderConfig;
-    mobileLinksConfig?: MobileLinksConfig;
     multiFactorConfig?: MultiFactorConfig;
     passwordPolicyConfig?: PasswordPolicyConfig;
     recaptchaConfig?: RecaptchaConfig;

src/auth/tenant.ts

@@ -24,7 +24,6 @@ import {
   MultiFactorAuthConfig, SmsRegionConfig, SmsRegionsAuthConfig, RecaptchaAuthConfig, RecaptchaConfig,
   PasswordPolicyConfig,
   PasswordPolicyAuthConfig, PasswordPolicyAuthServerConfig, EmailPrivacyConfig, EmailPrivacyAuthConfig,
-  MobileLinksConfig, MobileLinksAuthConfig
 } from './auth-config';
 
 /**
@@ -78,11 +77,6 @@ export interface UpdateTenantRequest {
    * The email privacy configuration for the tenant
    */
   emailPrivacyConfig?: EmailPrivacyConfig;
-
-  /**
-   * The mobile links configuration for the project
-   */
-  mobileLinksConfig?: MobileLinksConfig;
 }
 
 /**
@@ -101,7 +95,6 @@ export interface TenantOptionsServerRequest extends EmailSignInConfigServerReque
   recaptchaConfig?: RecaptchaConfig;
   passwordPolicyConfig?: PasswordPolicyAuthServerConfig;
   emailPrivacyConfig?: EmailPrivacyConfig;
-  mobileLinksConfig?: MobileLinksConfig;
 }
 
 /** The tenant server response interface. */
@@ -117,7 +110,6 @@ export interface TenantServerResponse {
   recaptchaConfig? : RecaptchaConfig;
   passwordPolicyConfig?: PasswordPolicyAuthServerConfig;
   emailPrivacyConfig?: EmailPrivacyConfig;
-  mobileLinksConfig?: MobileLinksConfig;
 }
 
 /**
@@ -183,11 +175,6 @@ export class Tenant {
    * The email privacy configuration for the tenant
    */
   public readonly emailPrivacyConfig?: EmailPrivacyConfig;
-  /**
-   * The mobile links configuration for the tenant
-   */
-  public readonly mobileLinksConfig?: MobileLinksConfig
-  
 
   /**
    * Builds the corresponding server request for a TenantOptions object.
@@ -230,9 +217,6 @@ export class Tenant {
     if (typeof tenantOptions.emailPrivacyConfig !== 'undefined') {
       request.emailPrivacyConfig = tenantOptions.emailPrivacyConfig;
     }
-    if (typeof tenantOptions.mobileLinksConfig !== 'undefined') {
-      request.mobileLinksConfig = tenantOptions.mobileLinksConfig;
-    }
     return request;
   }
 
@@ -270,7 +254,6 @@ export class Tenant {
       recaptchaConfig: true,
       passwordPolicyConfig: true,
       emailPrivacyConfig: true,
-      mobileLinksConfig: true,
     };
     const label = createRequest ? 'CreateTenantRequest' : 'UpdateTenantRequest';
     if (!validator.isNonNullObject(request)) {
@@ -334,10 +317,6 @@ export class Tenant {
     if (typeof request.emailPrivacyConfig !== 'undefined') {
       EmailPrivacyAuthConfig.validate(request.emailPrivacyConfig);
     }
-    // Validate Mobile Links Config if provided.
-    if (typeof request.mobileLinksConfig !== 'undefined') {
-      MobileLinksAuthConfig.validate(request.mobileLinksConfig);
-    }
   }
 
   /**
@@ -384,9 +363,6 @@ export class Tenant {
     if (typeof response.emailPrivacyConfig !== 'undefined') {
       this.emailPrivacyConfig = deepCopy(response.emailPrivacyConfig);
     }
-    if (typeof response.mobileLinksConfig !== 'undefined') {
-      this.mobileLinksConfig = deepCopy(response.mobileLinksConfig);
-    }
   }
 
   /**
@@ -427,7 +403,6 @@ export class Tenant {
       recaptchaConfig: this.recaptchaConfig_?.toJSON(),
       passwordPolicyConfig: deepCopy(this.passwordPolicyConfig),
       emailPrivacyConfig: deepCopy(this.emailPrivacyConfig),
-      mobileLinksConfig: deepCopy(this.mobileLinksConfig),
     };
     if (typeof json.multiFactorConfig === 'undefined') {
       delete json.multiFactorConfig;
@@ -447,9 +422,6 @@ export class Tenant {
     if (typeof json.emailPrivacyConfig === 'undefined') {
       delete json.emailPrivacyConfig;
     }
-    if (typeof json.mobileLinksConfig === 'undefined') {
-      delete json.mobileLinksConfig;
-    }
     return json;
   }
 }

test/unit/auth/tenant.spec.ts

@@ -103,9 +103,6 @@ describe('Tenant', () => {
     emailPrivacyConfig: {
       enableImprovedEmailPrivacy: true,
     },
-    mobileLinksConfig: {
-      domain: 'HOSTING_DOMAIN'
-    },
   };
 
   const clientRequest: UpdateTenantRequest = {
@@ -135,9 +132,6 @@ describe('Tenant', () => {
     emailPrivacyConfig: {
       enableImprovedEmailPrivacy: true,
     },
-    mobileLinksConfig: {
-      domain: 'HOSTING_DOMAIN'
-    },
   };
 
   const serverRequestWithoutMfa: TenantServerResponse = {
@@ -149,9 +143,6 @@ describe('Tenant', () => {
     emailPrivacyConfig: {
       enableImprovedEmailPrivacy: true,
     },
-    mobileLinksConfig: {
-      domain: 'HOSTING_DOMAIN'
-    },
   };
 
   const clientRequestWithoutMfa: UpdateTenantRequest = {
@@ -164,9 +155,6 @@ describe('Tenant', () => {
     emailPrivacyConfig: {
       enableImprovedEmailPrivacy: true,
     },
-    mobileLinksConfig: {
-      domain: 'HOSTING_DOMAIN'
-    },
   };
 
   const clientRequestWithRecaptcha: UpdateTenantRequest = {
@@ -231,9 +219,6 @@ describe('Tenant', () => {
     emailPrivacyConfig: {
       enableImprovedEmailPrivacy: true,
     },
-    mobileLinksConfig: {
-      domain: 'HOSTING_DOMAIN'
-    },
   };
 
   describe('buildServerRequest()', () => {
@@ -599,22 +584,6 @@ describe('Tenant', () => {
         }).to.throw('"EmailPrivacyConfig.enableImprovedEmailPrivacy" must be a valid boolean value.');
       });
 
-      it('should throw on invalid MobileLinksConfig attribute', () => {
-        const tenantOptionsClientRequest = deepCopy(clientRequest) as any;
-        tenantOptionsClientRequest.mobileLinksConfig.invalidParameter = 'invalid';
-        expect(() => {
-          Tenant.buildServerRequest(tenantOptionsClientRequest, !createRequest);
-        }).to.throw('"invalidParameter" is not a valid "MobileLinksConfig" parameter.');
-      });
-
-      it('should throw on invalid domain attribute', () => {
-        const tenantOptionsClientRequest = deepCopy(clientRequest) as any;
-        tenantOptionsClientRequest.mobileLinksConfig.domain = 'random domain';
-        expect(() => {
-          Tenant.buildServerRequest(tenantOptionsClientRequest, !createRequest);
-        }).to.throw('"MobileLinksConfig.domain" must be either "HOSTING_DOMAIN" or "FIREBASE_DYNAMIC_LINK_DOMAIN".');
-      });
-
       it('should not throw on valid client request object', () => {
         const tenantOptionsClientRequest = deepCopy(clientRequestWithRecaptcha);
         expect(() => {
@@ -1010,22 +979,6 @@ describe('Tenant', () => {
         }).to.throw('"EmailPrivacyConfig.enableImprovedEmailPrivacy" must be a valid boolean value.');
       });
 
-      it('should throw on invalid MobileLinksConfig attribute', () => {
-        const tenantOptionsClientRequest = deepCopy(clientRequest) as any;
-        tenantOptionsClientRequest.mobileLinksConfig.invalidParameter = 'invalid';
-        expect(() => {
-          Tenant.buildServerRequest(tenantOptionsClientRequest, createRequest);
-        }).to.throw('"invalidParameter" is not a valid "MobileLinksConfig" parameter.');
-      });
-
-      it('should throw on invalid domain attribute', () => {
-        const tenantOptionsClientRequest = deepCopy(clientRequest) as any;
-        tenantOptionsClientRequest.mobileLinksConfig.domain = 'random domain';
-        expect(() => {
-          Tenant.buildServerRequest(tenantOptionsClientRequest, createRequest);
-        }).to.throw('"MobileLinksConfig.domain" must be either "HOSTING_DOMAIN" or "FIREBASE_DYNAMIC_LINK_DOMAIN".');
-      });
-
       const nonObjects = [null, NaN, 0, 1, true, false, '', 'a', [], [1, 'a'], _.noop];
       nonObjects.forEach((request) => {
         it('should throw on invalid CreateTenantRequest:' + JSON.stringify(request), () => {
@@ -1145,13 +1098,6 @@ describe('Tenant', () => {
         deepCopy(clientRequest.passwordPolicyConfig));
     });
 
-    it('should set readonly property mobileLinksConfig', () => {
-      const expectedMobileLinksConfig = {
-        domain: 'HOSTING_DOMAIN',
-      };
-      expect(clientRequest.mobileLinksConfig).to.deep.equal(expectedMobileLinksConfig);
-    });
-
     it('should set readonly property emailPrivacyConfig', () => {
       const expectedEmailPrivacyConfig = {
         enableImprovedEmailPrivacy: true,
@@ -1201,7 +1147,6 @@ describe('Tenant', () => {
         recaptchaConfig: deepCopy(serverResponseWithRecaptcha.recaptchaConfig),
         passwordPolicyConfig: deepCopy(clientRequest.passwordPolicyConfig),
         emailPrivacyConfig: deepCopy(clientRequest.emailPrivacyConfig),
-        mobileLinksConfig: deepCopy(clientRequest.mobileLinksConfig),
       });
     });
 
@@ -1213,7 +1158,6 @@ describe('Tenant', () => {
       delete serverRequestCopyWithoutMfa.recaptchaConfig;
       delete serverRequestCopyWithoutMfa.passwordPolicyConfig;
       delete serverRequestCopyWithoutMfa.emailPrivacyConfig;
-      delete serverRequestCopyWithoutMfa.mobileLinksConfig;
       expect(new Tenant(serverRequestCopyWithoutMfa).toJSON()).to.deep.equal({
         tenantId: 'TENANT-ID',
         displayName: 'TENANT-DISPLAY-NAME',