fix(pipelines): self-mutate always adds analytics (#19010)

When we moved analytics generation from the CLI to the framework, we
kept a fallback in the CLI for backwards compatibility: if there were no
analytics in the templates but analytics were requested, they would
still be added in the CLI.

This breaks in the case of CDK Pipelines self-mutate step, if analytics
have been disabled: there are no analytics in the template, and the
default setting for analytics is `true`, since there is no `cdk.json`
to opt out, so they will always be added back in.

A better solution to check whether the CLI needs to do the fallback
is to go off of the cx schema version number: the CLI can know that
it never needs to do anything for cloud assemblies generated starting
at a certain version.

Fixes #18933.


----

*By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*

Author: rix0rrr

packages/aws-cdk/lib/api/cxapp/cloud-executable.ts

@@ -6,12 +6,20 @@ import { debug, warning } from '../../logging';
 import { Configuration } from '../../settings';
 import { SdkProvider } from '../aws-auth';
 import { CloudAssembly } from './cloud-assembly';
+import * as semver from 'semver';
 
 /**
  * @returns output directory
  */
 type Synthesizer = (aws: SdkProvider, config: Configuration) => Promise<cxapi.CloudAssembly>;
 
+/**
+ * The Cloud Assembly schema version where the framework started to generate analytics itself
+ *
+ * See https://github.com/aws/aws-cdk/pull/10306
+ */
+const TEMPLATE_INCLUDES_ANALYTICS_SCHEMA_VERSION = '6.0.0';
+
 export interface CloudExecutableProps {
   /**
    * Application configuration (settings and context)
@@ -104,13 +112,10 @@ export class CloudExecutable {
         }
       }
 
-      if (trackVersions) {
-        // @deprecated(v2): remove this 'if' block and all code referenced by it.
-        // This should honestly not be done here. The framework
-        // should (and will, shortly) synthesize this information directly into
-        // the template. However, in order to support old framework versions
-        // that don't synthesize this info yet, we can only remove this code
-        // once we break backwards compatibility.
+      if (trackVersions && !semver.gte(assembly.version, TEMPLATE_INCLUDES_ANALYTICS_SCHEMA_VERSION)) {
+        // @deprecate(v2): the framework now manages its own analytics. For
+        // Cloud Assemblies *older* than when we introduced this feature, have
+        // the CLI add it. Otherwise, do nothing.
         await this.addMetadataResource(assembly);
       }
 

packages/aws-cdk/test/api/cloud-executable.test.ts

@@ -5,46 +5,63 @@ import { registerContextProvider } from '../../lib/context-providers';
 import { MockCloudExecutable } from '../util';
 
 describe('AWS::CDK::Metadata', () => {
-  test('is generated for relocatable stacks', async () => {
-    const cx = await testCloudExecutable({ env: `aws://${cxapi.UNKNOWN_ACCOUNT}/${cxapi.UNKNOWN_REGION}`, versionReporting: true });
-    const cxasm = await cx.synthesize();
-
-    const result = cxasm.stackById('withouterrors').firstStack;
-    const metadata = result.template.Resources && result.template.Resources.CDKMetadata;
-    expect(metadata).toEqual({
-      Type: 'AWS::CDK::Metadata',
-      Properties: {
-        // eslint-disable-next-line @typescript-eslint/no-require-imports
-        Modules: `${require('../../package.json').name}=${require('../../package.json').version}`,
-      },
-      Condition: 'CDKMetadataAvailable',
+  test('is generated for relocatable stacks from old frameworks', async () => {
+    await withFakeCurrentCxVersion('2.0.0', async () => {
+      const cx = await testCloudExecutable({ env: `aws://${cxapi.UNKNOWN_ACCOUNT}/${cxapi.UNKNOWN_REGION}`, versionReporting: true });
+      const cxasm = await cx.synthesize();
+
+      const result = cxasm.stackById('withouterrors').firstStack;
+      const metadata = result.template.Resources && result.template.Resources.CDKMetadata;
+      expect(metadata).toEqual({
+        Type: 'AWS::CDK::Metadata',
+        Properties: {
+          // eslint-disable-next-line @typescript-eslint/no-require-imports
+          Modules: `${require('../../package.json').name}=${require('../../package.json').version}`,
+        },
+        Condition: 'CDKMetadataAvailable',
+      });
+
+      expect(result.template.Conditions?.CDKMetadataAvailable).toBeDefined();
     });
+  });
 
-    expect(result.template.Conditions?.CDKMetadataAvailable).toBeDefined();
+  test('is generated for stacks in supported regions from old frameworks', async () => {
+    await withFakeCurrentCxVersion('2.0.0', async () => {
+      const cx = await testCloudExecutable({ env: 'aws://012345678912/us-east-1', versionReporting: true });
+      const cxasm = await cx.synthesize();
+
+      const result = cxasm.stackById('withouterrors').firstStack;
+      const metadata = result.template.Resources && result.template.Resources.CDKMetadata;
+      expect(metadata).toEqual({
+        Type: 'AWS::CDK::Metadata',
+        Properties: {
+          // eslint-disable-next-line @typescript-eslint/no-require-imports
+          Modules: `${require('../../package.json').name}=${require('../../package.json').version}`,
+        },
+      });
+    });
   });
 
-  test('is generated for stacks in supported regions', async () => {
-    const cx = await testCloudExecutable({ env: 'aws://012345678912/us-east-1', versionReporting: true });
-    const cxasm = await cx.synthesize();
-
-    const result = cxasm.stackById('withouterrors').firstStack;
-    const metadata = result.template.Resources && result.template.Resources.CDKMetadata;
-    expect(metadata).toEqual({
-      Type: 'AWS::CDK::Metadata',
-      Properties: {
-        // eslint-disable-next-line @typescript-eslint/no-require-imports
-        Modules: `${require('../../package.json').name}=${require('../../package.json').version}`,
-      },
+  test('is not generated for stacks in unsupported regions from old frameworks', async () => {
+    await withFakeCurrentCxVersion('2.0.0', async () => {
+      const cx = await testCloudExecutable({ env: 'aws://012345678912/bermuda-triangle-1337', versionReporting: true });
+      const cxasm = await cx.synthesize();
+
+      const result = cxasm.stackById('withouterrors').firstStack;
+      const metadata = result.template.Resources && result.template.Resources.CDKMetadata;
+      expect(metadata).toBeUndefined();
     });
   });
 
-  test('is not generated for stacks in unsupported regions', async () => {
-    const cx = await testCloudExecutable({ env: 'aws://012345678912/bermuda-triangle-1337', versionReporting: true });
-    const cxasm = await cx.synthesize();
+  test('is not generated for new frameworks', async () => {
+    await withFakeCurrentCxVersion('8.0.0', async () => {
+      const cx = await testCloudExecutable({ env: 'aws://012345678912/us-east-1', versionReporting: true });
+      const cxasm = await cx.synthesize();
 
-    const result = cxasm.stackById('withouterrors').firstStack;
-    const metadata = result.template.Resources && result.template.Resources.CDKMetadata;
-    expect(metadata).toBeUndefined();
+      const result = cxasm.stackById('withouterrors').firstStack;
+      const metadata = result.template.Resources && result.template.Resources.CDKMetadata;
+      expect(metadata).toBeUndefined();
+    });
   });
 });
 
@@ -117,3 +134,14 @@ async function testCloudExecutable({ env, versionReporting = true }: { env?: str
 
   return cloudExec;
 }
+
+
+async function withFakeCurrentCxVersion<A>(version: string, block: () => Promise<A>): Promise<A> {
+  const currentVersionFn = cxschema.Manifest.version;
+  cxschema.Manifest.version = () => version;
+  try {
+    return await block();
+  } finally {
+    cxschema.Manifest.version = currentVersionFn;
+  }
+}