feat(amplify-category-auth): add HostedUI custom domain in metadata

HostedUIDomain equals to either the domain prefix or the custom domain defined in the user pool. However we need to differentiate a custom domain from a domain prefix for the config put in aws-exports.js fix aws-amplify#1880
vic-blt · Jan 28, 2021 · a21f00e · a21f00e
1 parent 39dfd27
commit a21f00e
Show file tree

Hide file tree

Showing 10 changed files with 31 additions and 13 deletions.
diff --git a/packages/amplify-category-auth/src/provider-utils/awscloudformation/import/index.ts b/packages/amplify-category-auth/src/provider-utils/awscloudformation/import/index.ts
@@ -734,6 +734,7 @@ const createMetaOutput = (answers: ImportAnswers, hasOAuthConfig: boolean): Meta
     ...(answers.appClientNative!.ClientSecret ? { AppClientSecret: answers.appClientNative!.ClientSecret } : {}),
     AppClientIDWeb: answers.appClientWeb!.ClientId,
     HostedUIDomain: userPool.Domain,
+    HostedUICustomDomain: userPool.CustomDomain,
   };
 
   if (answers.authSelections === 'identityPoolAndUserPool') {

diff --git a/packages/amplify-category-auth/src/provider-utils/awscloudformation/import/types.ts b/packages/amplify-category-auth/src/provider-utils/awscloudformation/import/types.ts
@@ -45,6 +45,7 @@ export type MetaOutput = {
   FacebookWebClient?: string;
   GoogleWebClient?: string;
   HostedUIDomain?: string;
+  HostedUICustomDomain?: string;
   OAuthMetadata?: string;
   CreatedSNSRole?: string;
 };

diff --git a/packages/amplify-e2e-tests/src/import-helpers/expects.ts b/packages/amplify-e2e-tests/src/import-helpers/expects.ts
@@ -9,6 +9,7 @@ export const expectAuthProjectDetailsMatch = (projectDetails: AuthProjectDetails
   expect(projectDetails.meta.AppClientID).toEqual(ogProjectDetails.meta.AppClientID);
   expect(projectDetails.meta.AppClientIDWeb).toEqual(ogProjectDetails.meta.AppClientIDWeb);
   expect(projectDetails.meta.HostedUIDomain).toEqual(ogProjectDetails.meta.HostedUIDomain);
+  expect(projectDetails.meta.HostedUICustomDomain).toEqual(ogProjectDetails.meta.HostedUICustomDomain);
 
   if (projectDetails.meta.OAuthMetadata) {
     expect(ogProjectDetails.meta.OAuthMetadata).toBeDefined();
@@ -48,6 +49,7 @@ export const expectAuthLocalAndOGMetaFilesOutputMatching = (projectRoot: string,
   expect(authMeta.output.AppClientID).toEqual(ogAuthMeta.output.AppClientID);
   expect(authMeta.output.AppClientIDWeb).toEqual(ogAuthMeta.output.AppClientIDWeb);
   expect(authMeta.output.HostedUIDomain).toEqual(ogAuthMeta.output.HostedUIDomain);
+  expect(authMeta.output.HostedUICustomDomain).toEqual(ogAuthMeta.output.HostedUICustomDomain);
   expect(authMeta.output.UserPoolId).toEqual(ogAuthMeta.output.UserPoolId);
 };
 

diff --git a/packages/amplify-e2e-tests/src/import-helpers/types.ts b/packages/amplify-e2e-tests/src/import-helpers/types.ts
@@ -22,6 +22,7 @@ export type AuthProjectDetails = {
     AppClientSecret?: string;
     AppClientIDWeb?: string;
     HostedUIDomain?: string;
+    HostedUICustomDomain?: string;
     OAuthMetadata?: $TSObject;
     IdentityPoolId?: string;
     IdentityPoolName?: string;

diff --git a/packages/amplify-e2e-tests/src/import-helpers/utilities.ts b/packages/amplify-e2e-tests/src/import-helpers/utilities.ts
@@ -41,6 +41,7 @@ export const getAuthProjectDetails = (projectRoot: string): AuthProjectDetails =
       AppClientSecret: authMeta.output.AppClientSecret,
       AppClientIDWeb: authMeta.output.AppClientIDWeb,
       HostedUIDomain: authMeta.output.HostedUIDomain,
+      HostedUICustomDomain: authMeta.output.HostedUICustomDomain,
       OAuthMetadata: authMeta.output.OAuthMetadata ? JSON.parse(authMeta.output.OAuthMetadata) : undefined,
     },
     team: {
@@ -105,6 +106,7 @@ export const getOGAuthProjectDetails = (projectRoot: string): AuthProjectDetails
       AppClientSecret: authMeta.output.AppClientSecret,
       AppClientIDWeb: authMeta.output.AppClientIDWeb,
       HostedUIDomain: authMeta.output.HostedUIDomain,
+      HostedUICustomDomain: authMeta.output.HostedUICustomDomain,
       OAuthMetadata: authMeta.output.OAuthMetadata ? JSON.parse(authMeta.output.OAuthMetadata) : undefined,
     },
     team: {

diff --git a/packages/amplify-frontend-android/lib/frontend-config-creator.js b/packages/amplify-frontend-android/lib/frontend-config-creator.js
@@ -228,7 +228,8 @@ function getCognitoConfig(cognitoResources, projectRegion) {
   let redirectSignOut;
 
   if (cognitoResource.output.HostedUIDomain) {
-    domain = `${cognitoResource.output.HostedUIDomain}.auth.${projectRegion}.amazoncognito.com`;
+    domain =
+      cognitoResource.output.HostedUICustomDomain || `${cognitoResource.output.HostedUIDomain}.auth.${projectRegion}.amazoncognito.com`;
   }
 
   if (cognitoResource.output.OAuthMetadata) {

diff --git a/packages/amplify-frontend-flutter/lib/frontend-config-creator.js b/packages/amplify-frontend-flutter/lib/frontend-config-creator.js
@@ -205,7 +205,8 @@ function getCognitoConfig(cognitoResources, projectRegion) {
   let redirectSignOut;
 
   if (cognitoResource.output.HostedUIDomain) {
-    domain = `${cognitoResource.output.HostedUIDomain}.auth.${projectRegion}.amazoncognito.com`;
+    domain =
+      cognitoResource.output.HostedUICustomDomain || `${cognitoResource.output.HostedUIDomain}.auth.${projectRegion}.amazoncognito.com`;
   }
 
   if (cognitoResource.output.OAuthMetadata) {

diff --git a/packages/amplify-frontend-ios/lib/frontend-config-creator.js b/packages/amplify-frontend-ios/lib/frontend-config-creator.js
@@ -210,7 +210,8 @@ function getCognitoConfig(cognitoResources, projectRegion) {
   let redirectSignOut;
 
   if (cognitoResource.output.HostedUIDomain) {
-    domain = `${cognitoResource.output.HostedUIDomain}.auth.${projectRegion}.amazoncognito.com`;
+    domain =
+      cognitoResource.output.HostedUICustomDomain || `${cognitoResource.output.HostedUIDomain}.auth.${projectRegion}.amazoncognito.com`;
   }
 
   if (cognitoResource.output.OAuthMetadata) {

diff --git a/packages/amplify-frontend-javascript/lib/frontend-config-creator.js b/packages/amplify-frontend-javascript/lib/frontend-config-creator.js
@@ -248,7 +248,8 @@ function getCognitoConfig(cognitoResources, projectRegion) {
   let federationTarget;
 
   if (cognitoResource.output.HostedUIDomain) {
-    domain = `${cognitoResource.output.HostedUIDomain}.auth.${projectRegion}.amazoncognito.com`;
+    domain =
+      cognitoResource.output.HostedUICustomDomain || `${cognitoResource.output.HostedUIDomain}.auth.${projectRegion}.amazoncognito.com`;
   }
   if (cognitoResource.output.OAuthMetadata) {
     const oAuthMetadata = JSON.parse(cognitoResource.output.OAuthMetadata);
@@ -339,7 +340,8 @@ function getAPIGWConfig(apigwResources, projectRegion, configOutput) {
   };
 
   for (let i = 0; i < apigwResources.length; i += 1) {
-    if (apigwResources[i].output.ApiName && apigwResources[i].output.RootUrl) { // only REST endpoints contains this information
+    if (apigwResources[i].output.ApiName && apigwResources[i].output.RootUrl) {
+      // only REST endpoints contains this information
       apigwConfig.aws_cloud_logic_custom.push({
         name: apigwResources[i].output.ApiName,
         endpoint: apigwResources[i].output.RootUrl,

diff --git a/packages/amplify-provider-awscloudformation/src/display-helpful-urls.js b/packages/amplify-provider-awscloudformation/src/display-helpful-urls.js
@@ -91,15 +91,17 @@ function showRestAPIURL(context, resourcesToBeCreated) {
 }
 
 function showContainerHostingInfo(context, resourcesToBeCreated) {
-  const resource = resourcesToBeCreated.find(resource => resource.category === 'hosting' && resource.service === 'ElasticContainer' && !resource.hostedZoneId);
+  const resource = resourcesToBeCreated.find(
+    resource => resource.category === 'hosting' && resource.service === 'ElasticContainer' && !resource.hostedZoneId,
+  );
   if (resource && resource.output) {
     const {
       output: {
         LoadBalancerCnameDomainName,
         LoadBalancerAliasDomainName,
         CloudfrontDistributionAliasDomainName,
-        CloudfrontDistributionCnameDomainName
-      }
+        CloudfrontDistributionCnameDomainName,
+      },
     } = resource;
 
     context.print.info(`Make sure to add the following CNAMEs to your domain’s DNS records:\n`);
@@ -143,19 +145,23 @@ function showHostedUIURLs(context, resourcesToBeCreated) {
     }
     const { Region } = amplifyMeta.providers.awscloudformation;
 
-    const { HostedUIDomain, AppClientIDWeb, OAuthMetadata } = amplifyMeta[category][resourceName].output;
+    const { HostedUIDomain, HostedUICustomDomain, AppClientIDWeb, OAuthMetadata } = amplifyMeta[category][resourceName].output;
 
     if (OAuthMetadata) {
       const oAuthMetadata = JSON.parse(OAuthMetadata);
-      const hostedUIEndpoint = `https://${HostedUIDomain}.auth.${Region}.amazoncognito.com/`;
+      const hostedUIEndpoint = HostedUICustomDomain
+        ? `https://${HostedUICustomDomain}`
+        : `https://${HostedUIDomain}.auth.${Region}.amazoncognito.com/`;
       context.print.info(chalk`Hosted UI Endpoint: {blue.underline ${hostedUIEndpoint}}`);
       const redirectURIs = oAuthMetadata.CallbackURLs.concat(oAuthMetadata.LogoutURLs);
       if (redirectURIs.length > 0) {
         const [responseType] = oAuthMetadata.AllowedOAuthFlows;
 
-        const testHostedUIEndpoint = `https://${HostedUIDomain}.auth.${Region}.amazoncognito.com/login?response_type=${
-          responseType === 'implicit' ? 'token' : 'code'
-        }&client_id=${AppClientIDWeb}&redirect_uri=${redirectURIs[0]}\n`;
+        const testHostedUIEndpoint =
+          (HostedUICustomDomain ? `https://${HostedUICustomDomain}` : `https://${HostedUIDomain}.auth.${Region}.amazoncognito.com`) +
+          `/login?response_type=${responseType === 'implicit' ? 'token' : 'code'}&client_id=${AppClientIDWeb}&redirect_uri=${
+            redirectURIs[0]
+          }\n`;
         context.print.info(chalk`Test Your Hosted UI Endpoint: {blue.underline ${testHostedUIEndpoint}}`);
       }
     }