feat(cli): notices on bootstrap version

packages/aws-cdk/lib/api/environment-resources.ts

@@ -2,6 +2,7 @@ import * as cxapi from '@aws-cdk/cx-api';
 import { ISDK } from './aws-auth';
 import { EcrRepositoryInfo, ToolkitInfo } from './toolkit-info';
 import { debug, warning } from '../logging';
+import { Notices } from '../notices';
 
 /**
  * Registry class for `EnvironmentResources`.
@@ -108,6 +109,8 @@ export class EnvironmentResources {
  if (defExpectedVersion > version) {
  throw new Error(`This CDK deployment requires bootstrap stack version '${expectedVersion}', found '${version}'. Please run 'cdk bootstrap'.`);
  }
+ const notices = Notices.get();
+ notices.enqueuePrint(notices.forBootstrapVersion({ bootstrapVersion: version }));
  }
  }
 

packages/aws-cdk/lib/cli.ts

@@ -26,7 +26,7 @@ import { MIGRATE_SUPPORTED_LANGUAGES, getMigrateScanType } from '../lib/commands
 import { RequireApproval } from '../lib/diff';
 import { availableInitLanguages, cliInit, printAvailableTemplates } from '../lib/init';
 import { data, debug, error, print, setLogLevel, setCI } from '../lib/logging';
-import { displayNotices, refreshNotices } from '../lib/notices';
+import { Notices } from '../lib/notices';
 import { Command, Configuration, Settings } from '../lib/settings';
 import * as version from '../lib/version';
 
@@ -367,9 +367,9 @@ export async function exec(args: string[], synthesizer?: Synthesizer): Promise<n
  });
  await configuration.load();
 
- if (shouldDisplayNotices()) {
-  void refreshNotices()
-  .catch(e => debug(`Could not refresh notices: ${e}`));
+ const notices = Notices.create({ configuration });
+ if (notices.shouldDisplay()) {
+ void notices.refresh().catch(e => debug(`Could not refresh notices: ${e}`));
  }
 
  const sdkProvider = await SdkProvider.withAwsCliCompatibleDefaults({
@@ -440,34 +440,38 @@ export async function exec(args: string[], synthesizer?: Synthesizer): Promise<n
  // Do PSAs here
  await version.displayVersionMessage();
 
- if (shouldDisplayNotices()) {
- if (cmd === 'notices' && argv.unacknowledged === true) {
- await displayNotices({
- outdir: configuration.settings.get(['output']) ?? 'cdk.out',
- acknowledgedIssueNumbers: configuration.context.get('acknowledged-issue-numbers') ?? [],
- ignoreCache: true,
- unacknowledged: true,
- });
- } else if (cmd === 'notices') {
- await displayNotices({
- outdir: configuration.settings.get(['output']) ?? 'cdk.out',
- acknowledgedIssueNumbers: [],
- ignoreCache: true,
- });
+ if (notices.shouldDisplay()) {
+
+ // note that any bootstrap version related notices are not enqueued here (because we don't know the bootstrap version number here).
+ // they are enqueued to the same `Notices` instance deep inside our 'cdk deploy' call stack.
+
+ if (cmd === 'notices') {
+ // we force cache refresh because when user explicitly asks
+ // to see notices, we assume they want us to consider ALL possible notices.
+ await notices.refresh({ force: true });
+ notices.enqueuePrint([
+ ...notices.forCliVersion({ onlyUnacknowledged: argv.unacknowledged }),
+ ...notices.forFrameworkVersion({ onlyUnacknowledged: argv.unacknowledged }),
+ ]);
+
+ // we only show the total in this case because the message it prints is specific for "unacknowledged" notices.
+ // unfortunate, but it was introduced this way so we preserve it for now.
+ // see https:/aws/aws-cdk/issues/31250
+ notices.print({ showTotal: argv.unacknowledged });
+
  } else if (cmd !== 'version') {
- await displayNotices({
- outdir: configuration.settings.get(['output']) ?? 'cdk.out',
- acknowledgedIssueNumbers: configuration.context.get('acknowledged-issue-numbers') ?? [],
- ignoreCache: false,
- });
+ // here we don't force refresh because its not an explicit ask
+ // to see notices - so we let the cache play its part.
+ await notices.refresh();
+ notices.enqueuePrint([
+ ...notices.forCliVersion({ onlyUnacknowledged: true }),
+ ...notices.forFrameworkVersion({ onlyUnacknowledged: true }),
+ ]);
+ notices.print();
  }
  }
  }
 
- function shouldDisplayNotices(): boolean {
- return configuration.settings.get(['notices']) ?? true;
- }
-
  async function main(command: string, args: any): Promise<number | void> {
  const toolkitStackName: string = ToolkitInfo.determineName(configuration.settings.get(['toolkitStackName']));
  debug(`Toolkit stack: ${chalk.bold(toolkitStackName)}`);