update actionCodeSetting with linkDomain field (#2676)

Author: Xiaoshouzi-gh

etc/firebase-admin.auth.api.md

@@ -15,11 +15,13 @@ export interface ActionCodeSettings {
         installApp?: boolean;
         minimumVersion?: string;
     };
+    // @deprecated
     dynamicLinkDomain?: string;
     handleCodeInApp?: boolean;
     iOS?: {
         bundleId: string;
     };
+    linkDomain?: string;
     url: string;
 }
 
@@ -223,6 +225,11 @@ export class AuthClientErrorCode {
         message: string;
     };
     // (undocumented)
+    static INVALID_HOSTING_LINK_DOMAIN: {
+        code: string;
+        message: string;
+    };
+    // (undocumented)
     static INVALID_ID_TOKEN: {
         code: string;
         message: string;

src/auth/action-code-settings-builder.ts

@@ -94,15 +94,27 @@ export interface ActionCodeSettings {
    * configured per project. This field provides the ability to explicitly choose
    * configured per project. This fields provides the ability explicitly choose
    * one. If none is provided, the oldest domain is used by default.
+   * @deprecated use linkDomain instead
    */
   dynamicLinkDomain?: string;
+
+  /**
+   * Defines the custom Firebase Hosting domain to use when the link is to be opened
+   * via a specified mobile app,
+   * This is a replacement of Firebase Dynamic Link.
+   * If none is provided, 
+   * a default hosting domain will be used (for example, `example.firebaseapp.com`)
+   */
+
+  linkDomain?: string;
 }
 
 /** Defines the email action code server request. */
 interface EmailActionCodeRequest {
   continueUrl?: string;
   canHandleCodeInApp?: boolean;
   dynamicLinkDomain?: string;
+  linkDomain?: string;
   androidPackageName?: string;
   androidMinimumVersion: string;
   androidInstallApp?: boolean;
@@ -123,6 +135,7 @@ export class ActionCodeSettingsBuilder {
   private ibi?: string;
   private canHandleCodeInApp?: boolean;
   private dynamicLinkDomain?: string;
+  private linkDomain?: string;
 
   /**
    * ActionCodeSettingsBuilder constructor.
@@ -166,6 +179,14 @@ export class ActionCodeSettingsBuilder {
     }
     this.dynamicLinkDomain = actionCodeSettings.dynamicLinkDomain;
 
+    if (typeof actionCodeSettings.linkDomain !== 'undefined' &&
+      !validator.isNonEmptyString(actionCodeSettings.linkDomain)) {
+      throw new FirebaseAuthError(
+        AuthClientErrorCode.INVALID_HOSTING_LINK_DOMAIN,
+      );
+    }
+    this.linkDomain = actionCodeSettings.linkDomain;
+
     if (typeof actionCodeSettings.iOS !== 'undefined') {
       if (!validator.isNonNullObject(actionCodeSettings.iOS)) {
         throw new FirebaseAuthError(
@@ -230,6 +251,7 @@ export class ActionCodeSettingsBuilder {
       continueUrl: this.continueUrl,
       canHandleCodeInApp: this.canHandleCodeInApp,
       dynamicLinkDomain: this.dynamicLinkDomain,
+      linkDomain: this.linkDomain,
       androidPackageName: this.apn,
       androidMinimumVersion: this.amv,
       androidInstallApp: this.installApp,

src/auth/base-auth.ts

@@ -749,7 +749,7 @@ export abstract class BaseAuth {
    *     minimumVersion: '12'
    *   },
    *   handleCodeInApp: true,
-   *   dynamicLinkDomain: 'custom.page.link'
+   *   linkDomain: 'project-id.firebaseapp.com'
    * };
    * admin.auth()
    *     .generatePasswordResetLink('[email protected]', actionCodeSettings)
@@ -802,7 +802,7 @@ export abstract class BaseAuth {
    *     minimumVersion: '12'
    *   },
    *   handleCodeInApp: true,
-   *   dynamicLinkDomain: 'custom.page.link'
+   *   linkDomain: 'project-id.firebaseapp.com'
    * };
    * admin.auth()
    *     .generateEmailVerificationLink('[email protected]', actionCodeSettings)
@@ -883,7 +883,7 @@ export abstract class BaseAuth {
    *     minimumVersion: '12'
    *   },
    *   handleCodeInApp: true,
-   *   dynamicLinkDomain: 'custom.page.link'
+   *   linkDomain: 'project-id.firebaseapp.com'
    * };
    * admin.auth()
    *     .generateEmailVerificationLink('[email protected]', actionCodeSettings)

src/utils/error.ts

@@ -471,6 +471,11 @@ export class AuthClientErrorCode {
     message: 'The provided dynamic link domain is not configured or authorized ' +
       'for the current project.',
   };
+  public static INVALID_HOSTING_LINK_DOMAIN = {
+    code: 'invalid-hosting-link-domain',
+    message: 'The provided hosting link domain is not configured in Firebase ' +
+      'Hosting or is not owned by the current project.',
+  };
   public static INVALID_EMAIL_VERIFIED = {
     code: 'invalid-email-verified',
     message: 'The emailVerified field must be a boolean.',
@@ -933,6 +938,8 @@ const AUTH_SERVER_TO_CLIENT_CODE: ServerToClientCode = {
   INVALID_CONTINUE_URI: 'INVALID_CONTINUE_URI',
   // Dynamic link domain in provided ActionCodeSettings is not authorized.
   INVALID_DYNAMIC_LINK_DOMAIN: 'INVALID_DYNAMIC_LINK_DOMAIN',
+  // Hosting link domain in provided ActionCodeSettings is not owned by the current project.
+  INVALID_HOSTING_LINK_DOMAIN: 'INVALID_HOSTING_LINK_DOMAIN',
   // uploadAccount provides an email that already exists.
   DUPLICATE_EMAIL: 'EMAIL_ALREADY_EXISTS',
   // uploadAccount provides a localId that already exists.

test/unit/auth/action-code-settings-builder.spec.ts

@@ -28,6 +28,7 @@ chai.use(sinonChai);
 chai.use(chaiAsPromised);
 
 const expect = chai.expect;
+const TEST_LINK_DOMAIN = 'project-id.firebaseapp.com';
 
 describe('ActionCodeSettingsBuilder', () => {
   describe('constructor', () => {
@@ -43,7 +44,10 @@ describe('ActionCodeSettingsBuilder', () => {
           installApp: true,
           minimumVersion: '6',
         },
+        // not removing this test since we are going to accept both dynamicLinkDomain 
+        // and linkDomain for the onboarding phase.
         dynamicLinkDomain: 'custom.page.link',
+        linkDomain: TEST_LINK_DOMAIN,
       })).not.to.throw;
     });
 
@@ -69,6 +73,7 @@ describe('ActionCodeSettingsBuilder', () => {
             minimumVersion: '6',
           },
           dynamicLinkDomain: 'custom.page.link',
+          linkDomain: TEST_LINK_DOMAIN,
         } as any);
       }).to.throw(AuthClientErrorCode.MISSING_CONTINUE_URI.message);
     });
@@ -109,6 +114,20 @@ describe('ActionCodeSettingsBuilder', () => {
       });
     });
 
+    const invalidHostingDomains = [null, NaN, 0, 1, true, false, '', 
+      [TEST_LINK_DOMAIN], [], {}, { a: 1 }, _.noop];
+    invalidHostingDomains.forEach((domain) => {
+      it('should throw on invalid linkDomain:' + JSON.stringify(domain), () => {
+        expect(() => {
+          return new ActionCodeSettingsBuilder({
+            url: 'https://www.example.com/path/file?a=1&b=2',
+            handleCodeInApp: true,
+            linkDomain: domain,
+          } as any);
+        }).to.throw(AuthClientErrorCode.INVALID_HOSTING_LINK_DOMAIN.message);
+      });
+    });
+
     const invalidIOSSettings = [null, NaN, 0, 1, true, false, '', 'a', [], [1, 'a'], _.noop];
     invalidIOSSettings.forEach((settings) => {
       it('should throw on invalid iOS object:' + JSON.stringify(settings), () => {
@@ -228,11 +247,13 @@ describe('ActionCodeSettingsBuilder', () => {
           minimumVersion: '6',
         },
         dynamicLinkDomain: 'custom.page.link',
+        linkDomain: TEST_LINK_DOMAIN,
       });
       const expectedRequest = {
         continueUrl: 'https://www.example.com/path/file?a=1&b=2',
         canHandleCodeInApp: true,
         dynamicLinkDomain: 'custom.page.link',
+        linkDomain: TEST_LINK_DOMAIN,
         androidPackageName: 'com.example.android',
         androidMinimumVersion: '6',
         androidInstallApp: true,

test/unit/auth/auth-api-request.spec.ts

@@ -3078,6 +3078,7 @@ AUTH_REQUEST_HANDLER_TESTS.forEach((handler) => {
           minimumVersion: '6',
         },
         dynamicLinkDomain: 'custom.page.link',
+        linkDomain: 'project-id.firebaseapp.com',
       };
       const expectedActionCodeSettingsRequest = new ActionCodeSettingsBuilder(actionCodeSettings).buildRequest();
       const expectedLink = 'https://custom.page.link?link=' +

test/unit/auth/auth.spec.ts

@@ -2887,6 +2887,7 @@ AUTH_CONFIGS.forEach((testConfig) => {
             minimumVersion: '6',
           },
           dynamicLinkDomain: 'custom.page.link',
+          linkDomain: 'project-id.firebaseapp.com',
         };
         const expectedLink = 'https://custom.page.link?link=' +
             encodeURIComponent('https://projectId.firebaseapp.com/__/auth/action?oobCode=CODE') +