Skip to content
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

chore(toolkit): fix logging statements #32922

Merged
merged 3 commits into from
Jan 14, 2025
Merged

chore(toolkit): fix logging statements #32922

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9089ea5
chore(toolkit): fix logging statements
kaizencc Jan 14, 2025
7b6ac68
timer
kaizencc Jan 14, 2025
b8a384d
timer
kaizencc Jan 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
40 changes: 19 additions & 21 deletions packages/@aws-cdk/toolkit/lib/toolkit.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@ import { StackCollection } from 'aws-cdk/lib/api/cxapp/cloud-assembly';
import { Deployments } from 'aws-cdk/lib/api/deployments';
import { HotswapMode } from 'aws-cdk/lib/api/hotswap/common';
import { StackActivityProgress } from 'aws-cdk/lib/api/util/cloudformation/stack-activity-monitor';
import { formatTime } from 'aws-cdk/lib/api/util/string-manipulation';
import { ResourceMigrator } from 'aws-cdk/lib/migrator';
import { serializeStructure } from 'aws-cdk/lib/serialize';
import { tagsForStack } from 'aws-cdk/lib/tags';
Expand All @@ -30,7 +29,7 @@ import { ICloudAssemblySource } from './api/cloud-assembly/types';
import { ToolkitError } from './api/errors';
import { IIoHost } from './io/io-host';
import { asSdkLogger, withAction } from './io/logger';
import { error, highlight, info, success, warning } from './io/messages';
import { data, error, highlight, info, success, warning } from './io/messages';
import { Timer } from './io/timer';
import { StackSelectionStrategy, ToolkitAction } from './types';

Expand Down Expand Up @@ -159,10 +158,10 @@ export class Toolkit {
const parameterMap = buildParameterMap(options.parameters?.parameters);

if (options.hotswap !== HotswapMode.FULL_DEPLOYMENT) {
warning(
await ioHost.notify(warning(
'⚠️ The --hotswap and --hotswap-fallback flags deliberately introduce CloudFormation drift to speed up deployments',
);
warning('⚠️ They should only be used for development - never use them for your production Stacks!\n');
));
await ioHost.notify(warning('⚠️ They should only be used for development - never use them for your production Stacks!\n'));
}

// @TODO
Expand Down Expand Up @@ -203,8 +202,7 @@ export class Toolkit {
const deployStack = async (stackNode: StackNode) => {
const stack = stackNode.stack;
if (stackCollection.stackCount !== 1) {

highlight(stack.displayName);
await ioHost.notify(highlight(stack.displayName));
}

if (!stack.environment) {
Expand All @@ -217,9 +215,9 @@ export class Toolkit {
if (Object.keys(stack.template.Resources || {}).length === 0) {
// The generated stack has no resources
if (!(await deployments.stackExists({ stack }))) {
warning('%s: stack has no resources, skipping deployment.', chalk.bold(stack.displayName));
await ioHost.notify(warning(`${chalk.bold(stack.displayName)}: stack has no resources, skipping deployment.`));
} else {
warning('%s: stack has no resources, deleting existing stack.', chalk.bold(stack.displayName));
await ioHost.notify(warning(`${chalk.bold(stack.displayName)}: stack has no resources, deleting existing stack.`));
kaizencc marked this conversation as resolved.
Show resolved Hide resolved
await this._destroy(assembly, 'deploy', {
selector: { patterns: [stack.hierarchicalId] },
exclusively: true,
Expand Down Expand Up @@ -260,16 +258,16 @@ export class Toolkit {

const stackIndex = stacks.indexOf(stack) + 1;
await ioHost.notify(
info('%s: deploying... [%s/%s]', chalk.bold(stack.displayName), stackIndex, stackCollection.stackCount),
info(`${chalk.bold(stack.displayName)}: deploying... [${stackIndex}/${stackCollection.stackCount}]`),
);
const startDeployTime = new Date().getTime();
const startDeployTime = Timer.start();

let tags = options.tags;
if (!tags || tags.length === 0) {
tags = tagsForStack(stack);
}

let elapsedDeployTime = 0;
let elapsedDeployTime;
try {
let deployResult: SuccessfulDeployStackResult | undefined;

Expand Down Expand Up @@ -337,7 +335,7 @@ export class Toolkit {
const motivation = 'Change includes a replacement which cannot be deployed with "--no-rollback"';

if (options.force) {
warning(`${motivation}. Proceeding with regular deployment (--force).`);
await ioHost.notify(warning(`${motivation}. Proceeding with regular deployment (--force).`));
} else {
await askUserConfirmation(
concurrency,
Expand All @@ -361,23 +359,23 @@ export class Toolkit {
: ` ✅ ${stack.displayName}`;

await ioHost.notify(success('\n' + message));
elapsedDeployTime = new Date().getTime() - startDeployTime;
print('\n✨ Deployment time: %ss\n', formatTime(elapsedDeployTime));
elapsedDeployTime = startDeployTime.end();
await ioHost.notify(info(`\n✨ Deployment time: ${elapsedDeployTime.asSec}s\n`));

if (Object.keys(deployResult.outputs).length > 0) {
print('Outputs:');
await ioHost.notify(info('Outputs:'));

stackOutputs[stack.stackName] = deployResult.outputs;
}

for (const name of Object.keys(deployResult.outputs).sort()) {
const value = deployResult.outputs[name];
print('%s.%s = %s', chalk.cyan(stack.id), chalk.cyan(name), chalk.underline(chalk.cyan(value)));
await ioHost.notify(info(`${chalk.cyan(stack.id)}.${chalk.cyan(name)} = ${chalk.underline(chalk.cyan(value))}`));
}

print('Stack ARN:');
await ioHost.notify(info('Stack ARN:'));

data(deployResult.stackArn);
await ioHost.notify(data(deployResult.stackArn));
} catch (e: any) {
// It has to be exactly this string because an integration test tests for
// "bold(stackname) failed: ResourceNotReady: <error>"
Expand All @@ -404,15 +402,15 @@ export class Toolkit {
});
}
}
print('\n✨ Total time: %ss\n', formatTime(elapsedSynthTime + elapsedDeployTime));
await ioHost.notify(info(`\n✨ Total time: ${synthTime.asSec + elapsedDeployTime.asSec}s\n`));
};

const assetBuildTime = options.assetBuildTime ?? AssetBuildTime.ALL_BEFORE_DEPLOY;
const prebuildAssets = assetBuildTime === AssetBuildTime.ALL_BEFORE_DEPLOY;
const concurrency = options.concurrency || 1;
const progress = concurrency > 1 ? StackActivityProgress.EVENTS : options.progress;
if (concurrency > 1 && options.progress && options.progress != StackActivityProgress.EVENTS) {
warning('⚠️ The --concurrency flag only supports --progress "events". Switching to "events".');
await ioHost.notify(warning('⚠️ The --concurrency flag only supports --progress "events". Switching to "events".'));
}

const stacksAndTheirAssetManifests = stacks.flatMap((stack) => [
Expand Down
Loading