Skip to content

fix(migrate-template-gen): replace console logs with ora for async tasks #14173

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
abhi7cr merged 3 commits into from
Apr 14, 2025
Merged

fix(migrate-template-gen): replace console logs with ora for async tasks #14173

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f12636c
fix(migrate-template-gen): replace console logs with ora for async tasks
Apr 14, 2025
dd19e48
chore: update lock file
Apr 14, 2025
1926c8b
fix(migrate-template-gen): add start call for ora
Apr 14, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion packages/amplify-migration-template-gen/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,8 @@
"dependencies": {
"@aws-sdk/client-cloudformation": "^3.744.0",
"@aws-sdk/client-cognito-identity-provider": "^3.592.0",
"@aws-sdk/client-ssm": "^3.592.0"
"@aws-sdk/client-ssm": "^3.592.0",
"ora": "^4.0.3"
},
"jest": {
"collectCoverageFrom": [
Expand Down
23 changes: 12 additions & 11 deletions packages/amplify-migration-template-gen/src/template-generator.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ import { tryRefactorStack } from './cfn-stack-refactor-updater';
import CfnOutputResolver from './resolvers/cfn-output-resolver';
import CfnDependencyResolver from './resolvers/cfn-dependency-resolver';
import CfnParameterResolver from './resolvers/cfn-parameter-resolver';
import ora from 'ora';

const CFN_RESOURCE_STACK_TYPE = 'AWS::CloudFormation::Stack';
const GEN2_AMPLIFY_AUTH_LOGICAL_ID_PREFIX = 'amplifyAuth';
Expand Down Expand Up @@ -242,21 +243,22 @@ class TemplateGenerator {
categoryTemplateGenerator: CategoryTemplateGenerator<CFN_CATEGORY_TYPE>,
sourceCategoryStackId: string,
): Promise<CFNTemplate | undefined> {
let updatingGen1CategoryStack;
try {
const { newTemplate, parameters: gen1StackParameters } = await categoryTemplateGenerator.generateGen1PreProcessTemplate();

assert(gen1StackParameters);
console.log(`Updating Gen1 ${category} stack...`);
updatingGen1CategoryStack = ora(`Updating Gen1 ${category} stack...`).start();

const gen1StackUpdateStatus = await tryUpdateStack(this.cfnClient, sourceCategoryStackId, gen1StackParameters, newTemplate);

assert(gen1StackUpdateStatus === CFNStackStatus.UPDATE_COMPLETE);
console.log(`Updated Gen1 ${category} stack successfully`);
updatingGen1CategoryStack.succeed(`Updated Gen1 ${category} stack successfully`);

return newTemplate;
} catch (e) {
if (this.isNoResourcesError(e)) {
console.log(e.message);
updatingGen1CategoryStack?.succeed(`No resources found to move in Gen1 ${category} stack. Skipping update.`);
return undefined;
}
throw e;
Expand All @@ -274,12 +276,12 @@ class TemplateGenerator {
}> {
const { newTemplate, oldTemplate, parameters } = await categoryTemplateGenerator.generateGen2ResourceRemovalTemplate();

console.log(`Updating Gen2 ${category} stack...`);
const updatingGen2CategoryStack = ora(`Updating Gen2 ${category} stack...`).start();

const gen2StackUpdateStatus = await tryUpdateStack(this.cfnClient, destinationCategoryStackId, parameters ?? [], newTemplate);

assert(gen2StackUpdateStatus === CFNStackStatus.UPDATE_COMPLETE);
console.log(`Updated Gen2 ${category} stack successfully`);
updatingGen2CategoryStack.succeed(`Updated Gen2 ${category} stack successfully`);

return { newTemplate, oldTemplate, parameters };
}
Expand Down Expand Up @@ -369,7 +371,6 @@ class TemplateGenerator {
logicalIdMappingForRefactor = logicalIdMapping;
} catch (e) {
if (typeof e === 'object' && 'message' in e && e.message.includes(NO_RESOURCES_TO_MOVE_ERROR)) {
console.log(e.message);
continue;
}
throw e;
Expand All @@ -378,6 +379,7 @@ class TemplateGenerator {

assert(newSourceTemplate);
assert(newDestinationTemplate);
const refactorResources = ora(`Moving ${category} resources from ${this.getSourceToDestinationMessage(isRevert)} stack...`).start();
const { success, failedRefactorMetadata } = await this.refactorResources(
logicalIdMappingForRefactor,
sourceCategoryStackId,
Expand All @@ -388,7 +390,7 @@ class TemplateGenerator {
destinationTemplateForRefactor,
);
if (!success) {
console.log(
refactorResources.fail(
`Moving ${category} resources from ${this.getSourceToDestinationMessage(isRevert)} stack failed. Reason: ${
failedRefactorMetadata?.reason
}. Status: ${failedRefactorMetadata?.status}. RefactorId: ${failedRefactorMetadata?.stackRefactorId}.`,
Expand All @@ -399,7 +401,7 @@ class TemplateGenerator {
}
return false;
} else {
console.log(`Moved ${category} resources from ${this.getSourceToDestinationMessage(isRevert)} stack successfully`);
refactorResources.succeed(`Moved ${category} resources from ${this.getSourceToDestinationMessage(isRevert)} stack successfully`);
}
}
if (!isRevert) {
Expand Down Expand Up @@ -435,7 +437,6 @@ class TemplateGenerator {
},
});
}
console.log(`Moving ${category} resources from ${this.getSourceToDestinationMessage(isRevert)} stack...`);
const [success, failedRefactorMetadata] = await tryRefactorStack(this.cfnClient, {
StackDefinitions: [
{
Expand All @@ -458,10 +459,10 @@ class TemplateGenerator {
gen2StackParameters: Parameter[] | undefined,
oldGen2Template: CFNTemplate,
) {
console.log(`Rolling back Gen2 ${category} stack...`);
const rollingBackGen2Stack = ora(`Rolling back Gen2 ${category} stack...`).start();
const gen2StackUpdateStatus = await tryUpdateStack(this.cfnClient, gen2CategoryStackId, gen2StackParameters ?? [], oldGen2Template);
assert(gen2StackUpdateStatus === CFNStackStatus.UPDATE_COMPLETE, `Gen2 Stack in a failed state: ${gen2StackUpdateStatus}.`);
console.log(`Rolled back Gen2 ${category} stack successfully`);
rollingBackGen2Stack.succeed(`Rolled back Gen2 ${category} stack successfully`);
}

private async generateRefactorTemplatesForRevert(
Expand Down
1 change: 1 addition & 0 deletions yarn.lock
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1910,6 +1910,7 @@ __metadata:
"@aws-sdk/client-ssm": ^3.592.0
"@jest/globals": ^29.7.0
jest: ^29.5.0
ora: ^4.0.3
typescript: ^5.4.5
languageName: unknown
linkType: soft
Expand Down
Loading