Merge pull request #14120 from aws-amplify/gen2-migrations-execute

Gen2 migrations revert command

Author: abhi7cr

packages/amplify-migration-template-gen/API.md

@@ -13,6 +13,8 @@ export class TemplateGenerator {
     constructor(fromStack: string, toStack: string, accountId: string, cfnClient: CloudFormationClient, ssmClient: SSMClient, cognitoIdpClient: CognitoIdentityProviderClient, appId: string, environmentName: string);
     // (undocumented)
     generate(): Promise<boolean>;
+    // (undocumented)
+    revert(): Promise<boolean>;
 }
 
 // (No @packageDocumentation comment for this package)

packages/amplify-migration-template-gen/src/category-template-generator.ts

@@ -4,6 +4,7 @@ import assert from 'node:assert';
 import {
   CFN_AUTH_TYPE,
   CFN_CATEGORY_TYPE,
+  CFN_IAM_TYPE,
   CFNChangeTemplateWithParams,
   CFNResource,
   CFNStackRefactorTemplates,
@@ -22,6 +23,11 @@ const HOSTED_PROVIDER_CREDENTIALS_PARAMETER_NAME = 'hostedUIProviderCreds';
 const USER_POOL_ID_OUTPUT_KEY_NAME = 'UserPoolId';
 const GEN1_WEB_APP_CLIENT = 'UserPoolClientWeb';
 const GEN2_NATIVE_APP_CLIENT = 'UserPoolNativeAppClient';
+const RESOURCE_TYPES_WITH_MULTIPLE_RESOURCES = [
+  CFN_AUTH_TYPE.UserPoolClient.valueOf(),
+  CFN_AUTH_TYPE.UserPoolGroup.valueOf(),
+  CFN_IAM_TYPE.Role.valueOf(),
+];
 
 class CategoryTemplateGenerator<CFNCategoryType extends CFN_CATEGORY_TYPE> {
   private gen1DescribeStacksResponse: Stack | undefined;
@@ -121,7 +127,7 @@ class CategoryTemplateGenerator<CFNCategoryType extends CFN_CATEGORY_TYPE> {
     return this.generateRefactorTemplates(this.gen1ResourcesToMove, this.gen2ResourcesToRemove, gen1Template, gen2Template);
   }
 
-  private async readTemplate(stackId: string) {
+  public async readTemplate(stackId: string) {
     const getTemplateResponse = await this.cfnClient.send(
       new GetTemplateCommand({
         StackName: stackId,
@@ -132,7 +138,7 @@ class CategoryTemplateGenerator<CFNCategoryType extends CFN_CATEGORY_TYPE> {
     return JSON.parse(templateBody) as CFNTemplate;
   }
 
-  private async describeStack(stackId: string) {
+  public async describeStack(stackId: string) {
     return (
       await this.cfnClient.send(
         new DescribeStacksCommand({
@@ -191,9 +197,15 @@ class CategoryTemplateGenerator<CFNCategoryType extends CFN_CATEGORY_TYPE> {
         // In gen1, we differentiate clients with Web. In gen2, we differentiate with Native.
         const isWebClient = gen1ResourceLogicalId === GEN1_WEB_APP_CLIENT && !gen2ResourceLogicalId.includes(GEN2_NATIVE_APP_CLIENT);
         const isNativeClient = gen1ResourceLogicalId !== GEN1_WEB_APP_CLIENT && gen2ResourceLogicalId.includes(GEN2_NATIVE_APP_CLIENT);
+        const foundUserPoolClientPair = gen1Resource.Type === CFN_AUTH_TYPE.UserPoolClient && (isWebClient || isNativeClient);
+        const foundUserPoolGroupPair =
+          gen1Resource.Type === CFN_AUTH_TYPE.UserPoolGroup && gen2ResourceLogicalId.includes(gen1ResourceLogicalId);
+        const foundIamRolePair = gen1Resource.Type === CFN_IAM_TYPE.Role && gen2ResourceLogicalId.includes(gen1ResourceLogicalId);
         if (
-          gen1Resource.Type !== CFN_AUTH_TYPE.UserPoolClient ||
-          (gen1Resource.Type === CFN_AUTH_TYPE.UserPoolClient && (isWebClient || isNativeClient))
+          !RESOURCE_TYPES_WITH_MULTIPLE_RESOURCES.includes(gen1Resource.Type) ||
+          foundUserPoolClientPair ||
+          foundUserPoolGroupPair ||
+          foundIamRolePair
         ) {
           gen1ToGen2ResourceLogicalIdMapping.set(gen1ResourceLogicalId, gen2ResourceLogicalId);
           clonedGen1ResourceMap.delete(gen1ResourceLogicalId);
@@ -219,16 +231,17 @@ class CategoryTemplateGenerator<CFNCategoryType extends CFN_CATEGORY_TYPE> {
     return resolvedRefsGen2Template;
   }
 
-  private generateRefactorTemplates(
+  public generateRefactorTemplates(
     gen1ResourcesToMove: Map<string, CFNResource>,
     gen2ResourcesToRemove: Map<string, CFNResource>,
     gen1Template: CFNTemplate,
     gen2Template: CFNTemplate,
+    sourceToDestinationResourceLogicalIdMapping?: Map<string, string>,
   ): CFNStackRefactorTemplates {
     const gen1LogicalResourceIds = [...gen1ResourcesToMove.keys()];
-    const gen1StackOutputs = this.gen1DescribeStacksResponse?.Outputs;
-    assert(gen1StackOutputs);
-    const gen1ToGen2ResourceLogicalIdMapping = this.buildGen1ToGen2ResourceLogicalIdMapping(gen1ResourcesToMove, gen2ResourcesToRemove);
+    const gen1ToGen2ResourceLogicalIdMapping =
+      sourceToDestinationResourceLogicalIdMapping ??
+      this.buildGen1ToGen2ResourceLogicalIdMapping(gen1ResourcesToMove, gen2ResourcesToRemove);
     const clonedGen1Template = JSON.parse(JSON.stringify(gen1Template));
     const clonedGen2Template = JSON.parse(JSON.stringify(gen2Template));
     const gen2TemplateForRefactor = this.addGen1ResourcesToGen2Stack(
@@ -237,6 +250,7 @@ class CategoryTemplateGenerator<CFNCategoryType extends CFN_CATEGORY_TYPE> {
       gen1ToGen2ResourceLogicalIdMapping,
       clonedGen2Template,
     );
+
     const gen1TemplateForRefactor = this.removeGen1ResourcesFromGen1Stack(clonedGen1Template, gen1LogicalResourceIds);
     return {
       sourceTemplate: gen1TemplateForRefactor,

packages/amplify-migration-template-gen/src/cfn-stack-refactor-updater.ts

@@ -9,7 +9,8 @@ import {
   StackRefactorStatus,
 } from '@aws-sdk/client-cloudformation';
 import assert from 'node:assert';
-import { FailedRefactorResponse } from './types';
+import { CFNStackStatus, FailedRefactorResponse } from './types';
+import { pollStackForCompletionState } from './cfn-stack-updater';
 
 const POLL_ATTEMPTS = 30;
 const POLL_INTERVAL_MS = 1500;
@@ -78,6 +79,16 @@ export async function tryRefactorStack(
       },
     ];
   }
+
+  const sourceStackName = createStackRefactorCommandInput.StackDefinitions?.[0].StackName;
+  const destinationStackName = createStackRefactorCommandInput.StackDefinitions?.[1].StackName;
+  assert(sourceStackName);
+  assert(destinationStackName);
+  const sourceStackStatus = await pollStackForCompletionState(cfnClient, sourceStackName);
+  assert(sourceStackStatus === CFNStackStatus.UPDATE_COMPLETE, `${sourceStackName} was not updated successfully.`);
+  const destinationStackStatus = await pollStackForCompletionState(cfnClient, destinationStackName);
+  assert(destinationStackStatus === CFNStackStatus.UPDATE_COMPLETE, `${destinationStackName} was not updated successfully.`);
+
   return [true, undefined];
 }
 

packages/amplify-migration-template-gen/src/cfn-stack-updater.ts

@@ -49,7 +49,11 @@ export async function tryUpdateStack(
  * @param attempts number of attempts to poll for completion.
  * @returns the stack status
  */
-export async function pollStackForCompletionState(cfnClient: CloudFormationClient, stackName: string, attempts: number): Promise<string> {
+export async function pollStackForCompletionState(
+  cfnClient: CloudFormationClient,
+  stackName: string,
+  attempts: number = POLL_ATTEMPTS,
+): Promise<string> {
   do {
     const { Stacks } = await cfnClient.send(
       new DescribeStacksCommand({

packages/amplify-migration-template-gen/src/migration-readme-generator.test.ts

@@ -1,135 +1,67 @@
 import MigrationReadMeGenerator from './migration-readme-generator';
 import fs from 'node:fs/promises';
-import { CFNTemplate } from './types';
 
 jest.mock('node:fs/promises');
 
 describe('MigrationReadMeGenerator', () => {
   const PATH = 'test';
-  const CATEGORY = 'auth';
-  const GEN1_CATEGORY_STACK_ID = 'arn:aws:cloudformation:us-east-1:1234567890:stack/amplify-testauth-dev-12345-auth-ABCDE/12345';
-  const GEN2_CATEGORY_STACK_ID = 'arn:aws:cloudformation:us-east-1:1234567890:stack/amplify-mygen2app-test-sandbox-12345-auth-ABCDE/12345';
   const migrationReadMeGenerator = new MigrationReadMeGenerator({
     path: PATH,
-    category: CATEGORY,
-    gen1CategoryStackId: GEN1_CATEGORY_STACK_ID,
-    gen2CategoryStackId: GEN2_CATEGORY_STACK_ID,
+    categories: ['auth', 'storage'],
   });
-  const oldStackTemplate: CFNTemplate = {
-    Description: 'Gen1FooTemplate',
-    AWSTemplateFormatVersion: 'AWSTemplateFormatVersion',
-    Resources: {
-      Gen1Foo: {
-        Type: 'AWS::S3::Bucket',
-        Properties: {
-          Name: 'FooBucket',
-        },
-      },
-    },
-    Parameters: {},
-    Outputs: {},
-  };
-  const newStackTemplate: CFNTemplate = {
-    Description: 'Gen1FooTemplate',
-    AWSTemplateFormatVersion: 'AWSTemplateFormatVersion',
-    Resources: {
-      Gen2Foo: {
-        Type: 'AWS::S3::Bucket',
-        Properties: {
-          Name: 'FooBucket',
-        },
-      },
-    },
-    Parameters: {
-      authSelections: {
-        Type: 'String',
-      },
-    },
-    Outputs: {},
-  };
-  const logicalIdMapping = new Map([['Gen1FooUserPool', 'Gen2FooUserPool']]);
 
   it('should initialize migration readme', async () => {
     await migrationReadMeGenerator.initialize();
-    expect(fs.writeFile).toHaveBeenCalledWith('test/MIGRATION_README.md', '## Stack refactor steps for auth category\n', {
+    expect(fs.writeFile).toHaveBeenCalledWith('test/MIGRATION_README.md', '', {
       encoding: 'utf8',
     });
   });
 
   it('should render step1', async () => {
-    await migrationReadMeGenerator.renderStep1(oldStackTemplate, newStackTemplate, logicalIdMapping, oldStackTemplate, newStackTemplate);
+    await migrationReadMeGenerator.renderStep1();
     expect(fs.appendFile).toHaveBeenCalledWith(
       'test/MIGRATION_README.md',
-      `### STEP 1: CREATE AND EXECUTE CLOUDFORMATION STACK REFACTOR FOR auth CATEGORY
-This step will move the Gen1 auth resources to Gen2 stack.
-
-1.a) Create stack refactor
-\`\`\`
-aws cloudformation create-stack-refactor  --stack-definitions StackName=amplify-testauth-dev-12345-auth-ABCDE,TemplateBody@=file://test/step3-sourceTemplate.json  StackName=amplify-mygen2app-test-sandbox-12345-auth-ABCDE,TemplateBody@=file://test/step3-destinationTemplate.json  --resource-mappings  '[{\"Source\":{\"StackName\":\"amplify-testauth-dev-12345-auth-ABCDE\",\"LogicalResourceId\":\"Gen1FooUserPool\"},\"Destination\":{\"StackName\":\"amplify-mygen2app-test-sandbox-12345-auth-ABCDE\",\"LogicalResourceId\":\"Gen2FooUserPool\"}}]'
-\`\`\`
- 
-\`\`\`
-export STACK_REFACTOR_ID=<<REFACTOR-ID-FROM-CREATE-STACK-REFACTOR_CALL>>
-\`\`\`
-  
-1.b) Describe stack refactor to check for creation status
-\`\`\`
- aws cloudformation describe-stack-refactor --stack-refactor-id $STACK_REFACTOR_ID
-\`\`\`
- 
-1.c) Execute stack refactor
+      `## REDEPLOY GEN2 APPLICATION
+1.a) Uncomment the following lines in \`amplify/backend.ts\` file
 \`\`\`
- aws cloudformation execute-stack-refactor --stack-refactor-id $STACK_REFACTOR_ID
-\`\`\`
- 
-1.d) Describe stack refactor to check for execution status
-\`\`\`
- aws cloudformation describe-stack-refactor --stack-refactor-id $STACK_REFACTOR_ID
+s3Bucket.bucketName = YOUR_GEN1_BUCKET_NAME;
 \`\`\`
 
-#### Rollback step for refactor:
 \`\`\`
- aws cloudformation create-stack-refactor  --stack-definitions StackName=amplify-testauth-dev-12345-auth-ABCDE,TemplateBody@=file://test/step3-sourceTemplate-rollback.json  StackName=amplify-mygen2app-test-sandbox-12345-auth-ABCDE,TemplateBody@=file://test/step3-destinationTemplate-rollback.json  --resource-mappings  '[{\"Source\":{\"StackName\":\"amplify-mygen2app-test-sandbox-12345-auth-ABCDE\",\"LogicalResourceId\":\"Gen2FooUserPool\"},\"Destination\":{\"StackName\":\"amplify-testauth-dev-12345-auth-ABCDE\",\"LogicalResourceId\":\"Gen1FooUserPool\"}}]'
+s3Bucket.applyRemovalPolicy(RemovalPolicy.RETAIN, { applyToUpdateReplacePolicy: true });
 \`\`\`
 
 \`\`\`
-export STACK_REFACTOR_ID=<<REFACTOR-ID-FROM-CREATE-STACK-REFACTOR_CALL>>
+cfnUserPool.applyRemovalPolicy(RemovalPolicy.RETAIN, { applyToUpdateReplacePolicy: true });
 \`\`\`
 
-Describe stack refactor to check for creation status
 \`\`\`
- aws cloudformation describe-stack-refactor --stack-refactor-id $STACK_REFACTOR_ID
+cfnIdentityPool.applyRemovalPolicy(RemovalPolicy.RETAIN, { applyToUpdateReplacePolicy: true });
 \`\`\`
 
-Execute stack refactor
 \`\`\`
- aws cloudformation execute-stack-refactor --stack-refactor-id $STACK_REFACTOR_ID
+Tags.of(backend.stack).add("gen1-migrated-app", "true");
 \`\`\`
 
-Describe stack refactor to check for execution status
+1.b) Deploy sandbox using the below command or trigger a CI/CD build via hosting by committing this file to your Git repository
 \`\`\`
- aws cloudformation describe-stack-refactor --stack-refactor-id $STACK_REFACTOR_ID
+npx ampx sandbox
 \`\`\`
- `,
-      { encoding: 'utf8' },
+`,
     );
   });
 
-  it('should render step2', async () => {
-    await migrationReadMeGenerator.renderStep2();
+  it('should render step1 without storage', async () => {
+    const PATH = 'test';
+    const migrationReadMeGenerator = new MigrationReadMeGenerator({
+      path: PATH,
+      categories: ['auth'],
+    });
+    await migrationReadMeGenerator.renderStep1();
     expect(fs.appendFile).toHaveBeenCalledWith(
       'test/MIGRATION_README.md',
-      `### STEP 2: REDEPLOY GEN2 APPLICATION
-This step will remove the hardcoded references from the template and replace them with resource references (where applicable).
-
-2.a) Uncomment the following lines in \`amplify/backend.ts\` file to instruct CDK to use the gen1 S3 bucket (if storage is enabled) and apply retain removal policies for auth and/or storage resources
-\`\`\`
-s3Bucket.bucketName = YOUR_GEN1_BUCKET_NAME;
-\`\`\`
-
-\`\`\`
-s3Bucket.applyRemovalPolicy(RemovalPolicy.RETAIN, { applyToUpdateReplacePolicy: true });
-\`\`\`
+      `## REDEPLOY GEN2 APPLICATION
+1.a) Uncomment the following lines in \`amplify/backend.ts\` file
 
 \`\`\`
 cfnUserPool.applyRemovalPolicy(RemovalPolicy.RETAIN, { applyToUpdateReplacePolicy: true });
@@ -143,7 +75,7 @@ cfnIdentityPool.applyRemovalPolicy(RemovalPolicy.RETAIN, { applyToUpdateReplaceP
 Tags.of(backend.stack).add("gen1-migrated-app", "true");
 \`\`\`
 
-2.b) Deploy sandbox using the below command or trigger a CI/CD build via hosting by committing this file to your Git repository
+1.b) Deploy sandbox using the below command or trigger a CI/CD build via hosting by committing this file to your Git repository
 \`\`\`
 npx ampx sandbox
 \`\`\`