fix(core): write Metadata resource in core framework

packages/@aws-cdk/cloud-assembly-schema/schema/cloud-assembly.version.json

@@ -1 +1 @@
-{"version":"5.0.0"}
+{"version":"6.0.0"}

packages/@aws-cdk/core/lib/app.ts

@@ -35,11 +35,20 @@ export interface AppProps {
   readonly stackTraces?: boolean;
 
   /**
-   * Include runtime versioning information in cloud assembly manifest
-   * @default true runtime info is included unless `aws:cdk:disable-runtime-info` is set in the context.
+   * Include runtime versioning information in the Stacks of this app
+   *
+   * @depreacted use `versionReporting` instead
+   * @default Value of 'aws:cdk:version-reporting' context key
    */
   readonly runtimeInfo?: boolean;
 
+  /**
+   * Include runtime versioning information in the Stacks of this app
+   *
+   * @default Value of 'aws:cdk:version-reporting' context key
+   */
+  readonly versionReporting?: boolean;
+
   /**
    * Additional context values for the application.
    *
@@ -101,8 +110,10 @@ export class App extends Stage {
       this.node.setContext(cxapi.DISABLE_METADATA_STACK_TRACE, true);
     }
 
-    if (props.runtimeInfo === false) {
-      this.node.setContext(cxapi.DISABLE_VERSION_REPORTING, true);
+    const versionReporting = props.versionReporting ?? props.runtimeInfo;
+
+    if (versionReporting !== undefined) {
+      this.node.setContext(cxapi.VERSION_REPORTING_ENABLED_CONTEXT, versionReporting);
     }
 
     const autoSynth = props.autoSynth !== undefined ? props.autoSynth : cxapi.OUTDIR_ENV in process.env;

packages/@aws-cdk/core/lib/cfn-fn.ts

@@ -752,7 +752,6 @@ class FnJoin implements IResolvable {
   }
 }
 
-
 function _inGroupsOf<T>(array: T[], maxGroup: number): T[][] {
   const result = new Array<T[]>();
   for (let i = 0; i < array.length; i += maxGroup) {

packages/@aws-cdk/core/lib/private/metadata-resource.ts

@@ -80,7 +80,6 @@ function formatModules(runtime: cxapi.RuntimeInfo): string {
   const modules = new Array<string>();
 
   // inject toolkit version to list of modules
-  // eslint-disable-next-line @typescript-eslint/no-require-imports
   const cliVersion = process.env[cxapi.CLI_VERSION_ENV];
   if (cliVersion) {
     modules.push(`aws-cdk=${cliVersion}`);

packages/@aws-cdk/core/lib/private/synthesis.ts

@@ -129,20 +129,15 @@ function prepareTree(root: IConstruct) {
  */
 function injectMetadataResources(root: IConstruct) {
   visit(root, 'post', construct => {
-    // Only on top-level stacks
-    if (!Stack.isStack(construct)
-      || construct.parentStack
-      // Unless disabled
-      || construct.node.tryGetContext(cxapi.DISABLE_VERSION_REPORTING)
-      // While running via CLI
-      || !process.env[cxapi.CLI_VERSION_ENV]) { return; }
+    if (!Stack.isStack(construct) || !construct._versionReportingEnabled) { return; }
 
     // Because of https://github.com/aws/aws-cdk/blob/master/packages/@aws-cdk/assert/lib/synth-utils.ts#L74
     // synthesize() may be called more than once on a stack in unit tests, and the below would break
     // if we execute it a second time. Guard against the constructs already existing.
-    if (construct.node.tryFindChild('CDKMetadata')) { return; }
+    const CDKMetadata = 'CDKMetadata';
+    if (construct.node.tryFindChild(CDKMetadata)) { return; }
 
-    new MetadataResource(construct, 'CDKMetadata');
+    new MetadataResource(construct, CDKMetadata);
   });
 }
 

packages/@aws-cdk/core/lib/stack.ts

@@ -126,6 +126,14 @@ export interface StackProps {
    * @default false
    */
   readonly terminationProtection?: boolean;
+
+  /**
+   * Include runtime versioning information in this Stack
+   *
+   * @default `versionReporting setting of containing `App`, or value of
+   * 'aws:cdk:version-reporting' context key
+   */
+  readonly versionReporting?: boolean;
 }
 
 /**
@@ -279,6 +287,15 @@ export class Stack extends Construct implements ITaggable {
    */
   public readonly synthesizer: IStackSynthesizer;
 
+  /**
+   * Whether version reporting is enabled for this stack
+   *
+   * Controls whether the CDK Metadata resource is injected
+   *
+   * @internal
+   */
+  public readonly _versionReportingEnabled: boolean;
+
   /**
    * Logical ID generation strategy
    */
@@ -368,6 +385,10 @@ export class Stack extends Construct implements ITaggable {
 
     this.templateFile = `${this.artifactId}.template.json`;
 
+    // Not for nested stacks
+    this._versionReportingEnabled = (props.versionReporting ?? this.node.tryGetContext(cxapi.VERSION_REPORTING_ENABLED_CONTEXT))
+      && !this.nestedStackParent;
+
     this.synthesizer = props.synthesizer ?? (newStyleSynthesisContext
       ? new DefaultStackSynthesizer()
       : new LegacyStackSynthesizer());

packages/@aws-cdk/core/test/test.app.ts

@@ -3,12 +3,11 @@ import * as cxapi from '@aws-cdk/cx-api';
 import { Test } from 'nodeunit';
 import { CfnResource, Construct, Stack, StackProps } from '../lib';
 import { Annotations } from '../lib/annotations';
-import { MetadataResource } from '../lib/private/metadata-resource';
 import { App, AppProps } from '../lib/app';
+import { MetadataResource } from '../lib/private/metadata-resource';
 
 function withApp(props: AppProps, block: (app: App) => void): cxapi.CloudAssembly {
   const app = new App({
-    runtimeInfo: false,
     stackTraces: false,
     ...props,
   });
@@ -252,24 +251,40 @@ export = {
    * The are not emitted into Cloud Assembly metadata anymore
    */
   'runtime library versions are not emitted in asm anymore'(test: Test) {
-    withCliVersion(() => {
-      const context: any = {};
+    const assembly = withApp({ versionReporting: true }, app => {
+      const stack = new Stack(app, 'stack1');
+      new CfnResource(stack, 'MyResource', { type: 'Resource::Type' });
+    });
 
-      const assembly = withApp(context, app => {
-        const stack = new Stack(app, 'stack1');
-        new CfnResource(stack, 'MyResource', { type: 'Resource::Type' });
-      });
+    test.deepEqual(assembly.runtime, { libraries: {} });
+    test.done();
+  },
 
-      test.deepEqual(assembly.runtime, { libraries: {} });
+  'runtime library versions'(test: Test) {
+    MetadataResource.clearModulesCache();
+
+    const response = withApp({ versionReporting: true }, app => {
+      const stack = new Stack(app, 'stack1');
+      new CfnResource(stack, 'MyResource', { type: 'Resource::Type' });
     });
+
+    const stackTemplate = response.getStackByName('stack1').template;
+    const libs = parseModules(stackTemplate.Resources?.CDKMetadata?.Properties?.Modules);
+
+    // eslint-disable-next-line @typescript-eslint/no-require-imports
+    const version = require('../package.json').version;
+    test.deepEqual(libs['@aws-cdk/core'], version);
+    test.deepEqual(libs['@aws-cdk/cx-api'], version);
+    test.deepEqual(libs['jsii-runtime'], `node.js/${process.version}`);
+
     test.done();
   },
 
-  'runtime library versions'(test: Test) {
+  'CDK version'(test: Test) {
     MetadataResource.clearModulesCache();
 
     withCliVersion(() => {
-      const response = withApp({ runtimeInfo: true }, app => {
+      const response = withApp({ versionReporting: true }, app => {
         const stack = new Stack(app, 'stack1');
         new CfnResource(stack, 'MyResource', { type: 'Resource::Type' });
       });
@@ -278,10 +293,7 @@ export = {
       const libs = parseModules(stackTemplate.Resources?.CDKMetadata?.Properties?.Modules);
 
       // eslint-disable-next-line @typescript-eslint/no-require-imports
-      const version = require('../package.json').version;
-      test.deepEqual(libs['@aws-cdk/core'], version);
-      test.deepEqual(libs['@aws-cdk/cx-api'], version);
-      test.deepEqual(libs['jsii-runtime'], `node.js/${process.version}`);
+      test.deepEqual(libs['aws-cdk'], '1.2.3');
     });
 
     test.done();
@@ -292,7 +304,7 @@ export = {
     MetadataResource.clearModulesCache();
 
     withCliVersion(() => {
-      const response = withApp({ runtimeInfo: true }, app => {
+      const response = withApp({ versionReporting: true }, app => {
         const stack = new Stack(app, 'stack1');
         new CfnResource(stack, 'MyResource', { type: 'Resource::Type' });
       });
@@ -309,27 +321,24 @@ export = {
 
   'version reporting includes only @aws-cdk, aws-cdk and jsii libraries'(test: Test) {
     MetadataResource.clearModulesCache();
-    withCliVersion(() => {
-      const response = withApp({ runtimeInfo: true }, app => {
-        const stack = new Stack(app, 'stack1');
-        new CfnResource(stack, 'MyResource', { type: 'Resource::Type' });
-      });
-
-      const stackTemplate = response.getStackByName('stack1').template;
-      const libs = parseModules(stackTemplate.Resources?.CDKMetadata?.Properties?.Modules);
 
-      // eslint-disable-next-line @typescript-eslint/no-require-imports
-      const version = require('../package.json').version;
-      test.deepEqual(libs, {
-        'aws-cdk': '1.2.3',
-        '@aws-cdk/core': version,
-        '@aws-cdk/cx-api': version,
-        '@aws-cdk/region-info': version,
-        '@aws-cdk/cloud-assembly-schema': version,
-        'jsii-runtime': `node.js/${process.version}`,
-      });
+    const response = withApp({ versionReporting: true }, app => {
+      const stack = new Stack(app, 'stack1');
+      new CfnResource(stack, 'MyResource', { type: 'Resource::Type' });
     });
 
+    const stackTemplate = response.getStackByName('stack1').template;
+    const libs = parseModules(stackTemplate.Resources?.CDKMetadata?.Properties?.Modules);
+    const libNames = Object.keys(libs).sort();
+
+    test.deepEqual(libNames, [
+      '@aws-cdk/cloud-assembly-schema',
+      '@aws-cdk/core',
+      '@aws-cdk/cx-api',
+      '@aws-cdk/region-info',
+      'jsii-runtime',
+    ]);
+
     test.done();
   },
 

packages/@aws-cdk/core/test/test.stack.ts

@@ -975,6 +975,24 @@ export = {
 
     test.done();
   },
+
+  'version reporting can be configured on the app'(test: Test) {
+    const app = new App({ versionReporting: true });
+    test.ok(new Stack(app, 'Stack')._versionReportingEnabled);
+    test.done();
+  },
+
+  'version reporting can be configured with context'(test: Test) {
+    const app = new App({ context: { 'aws:cdk:version-reporting': true } });
+    test.ok(new Stack(app, 'Stack')._versionReportingEnabled);
+    test.done();
+  },
+
+  'version reporting can be configured on the stack'(test: Test) {
+    const app = new App();
+    test.ok(new Stack(app, 'Stack', { versionReporting: true })._versionReportingEnabled);
+    test.done();
+  },
 };
 
 class StackWithPostProcessor extends Stack {

packages/@aws-cdk/core/test/test.stage.ts

@@ -209,7 +209,7 @@ export = {
 
   'Assemblies can be deeply nested'(test: Test) {
     // GIVEN
-    const app = new App({ runtimeInfo: false, treeMetadata: false });
+    const app = new App({ treeMetadata: false });
 
     const level1 = new Stage(app, 'StageLevel1');
     const level2 = new Stage(level1, 'StageLevel2');

packages/@aws-cdk/core/test/util.ts

@@ -1,15 +1,6 @@
-import * as cxapi from '@aws-cdk/cx-api';
-import { Stack, Construct, StackProps, App } from '../lib';
+import { Stack } from '../lib';
 import { synthesize } from '../lib/private/synthesis';
 
-export class TestStack extends Stack {
-  constructor(scope: Construct, id: string, props?: StackProps) {
-    super(scope ?? new App({
-      context: { [cxapi.DISABLE_VERSION_REPORTING]: true },
-    }), id, props);
-  }
-}
-
 export function toCloudFormation(stack: Stack): any {
   return synthesize(stack, { skipValidation: true }).getStackByName(stack.stackName).template;
 }

packages/@aws-cdk/cx-api/lib/app.ts

@@ -12,9 +12,16 @@ export const PATH_METADATA_ENABLE_CONTEXT = 'aws:cdk:enable-path-metadata';
 
 /**
  * Disable the collection and reporting of version information.
+ *
+ * @deprecated Use ENABLE_VERSION_REPORTING instead
  */
 export const DISABLE_VERSION_REPORTING = 'aws:cdk:disable-version-reporting';
 
+/**
+ * Enable the collection and reporting of version information.
+ */
+export const VERSION_REPORTING_ENABLED_CONTEXT = 'aws:cdk:version-reporting';
+
 /**
  * If this is set, asset staging is disabled. This means that assets will not be copied to
  * the output directory and will be referenced with absolute source paths.

packages/@aws-cdk/pipelines/test/testutil.ts

@@ -20,7 +20,6 @@ export class TestApp extends App {
       },
       stackTraces: false,
       autoSynth: false,
-      runtimeInfo: false,
       treeMetadata: false,
       ...props,
     });

packages/aws-cdk/lib/api/cxapp/exec.ts

@@ -16,25 +16,21 @@ export async function execProgram(aws: SdkProvider, config: Configuration): Prom
   await populateDefaultEnvironmentIfNeeded(aws, env);
 
   const pathMetadata: boolean = config.settings.get(['pathMetadata']) ?? true;
-
   if (pathMetadata) {
     context[cxapi.PATH_METADATA_ENABLE_CONTEXT] = true;
   }
 
   const assetMetadata: boolean = config.settings.get(['assetMetadata']) ?? true;
-
   if (assetMetadata) {
     context[cxapi.ASSET_RESOURCE_METADATA_ENABLED_CONTEXT] = true;
   }
 
   const versionReporting: boolean = config.settings.get(['versionReporting']) ?? true;
-
-  if (!versionReporting) {
-    context[cxapi.DISABLE_VERSION_REPORTING] = true;
-  }
+  if (versionReporting) { context[cxapi.VERSION_REPORTING_ENABLED_CONTEXT] = true; }
+  // We need to keep on doing this for framework version from before this flag was deprecated.
+  if (!versionReporting) { context[cxapi.DISABLE_VERSION_REPORTING] = true; }
 
   const stagingEnabled = config.settings.get(['staging']) ?? true;
-
   if (!stagingEnabled) {
     context[cxapi.DISABLE_ASSET_STAGING_CONTEXT] = true;
   }