fix(core): asset names for nested stacks contain Tokens (#33966)

Since Nested Stack names are Tokens (resolving to `{ Ref: 'AWS::StackName' }`), if we use `this.stackName` as the asset name just like we do for regular stacks, we end up with Tokens in the display name of the nested stack template asset.

This is pointless because the token will not be resolved and look like `${Token[TOKEN.639]}`; plus, it breaks tests because the Token numbers are different on every run. In CDK Pipelines, it would also lead to the pipeline restarting on every pipeline run.

Instead, test for and reject Tokens, and use the nested stack's construct path instead just like we do for other assets.

----

*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/core/lib/nested-stack.ts

@@ -226,7 +226,8 @@ export class NestedStack extends Stack {
       packaging: FileAssetPackaging.FILE,
       sourceHash: templateHash,
       fileName: this.templateFile,
-      displayName: `${this.stackName} Template`,
+      // this.stackName is a Token for nested stacks, so use something else
+      displayName: `${Names.stackRelativeConstructPath(this)} Nested Stack Template`,
     });
 
     this.addResourceMetadata(this.resource, 'TemplateURL');

packages/aws-cdk-lib/core/lib/stack-synthesizers/asset-manifest-builder.ts

@@ -5,6 +5,7 @@ import * as cxschema from '../../../cloud-assembly-schema';
 import { FileAssetSource, FileAssetPackaging, DockerImageAssetSource } from '../assets';
 import { resolvedOr } from '../helpers-internal/string-specializer';
 import { Stack } from '../stack';
+import { Token } from '../token';
 
 /**
  * Build an asset manifest from assets added to a stack
@@ -289,13 +290,21 @@ function validateFileAssetSource(asset: FileAssetSource) {
   if (!!asset.packaging !== !!asset.fileName) {
     throw new Error(`'packaging' is expected in combination with 'fileName', got: ${JSON.stringify(asset)}`);
   }
+
+  if (Token.isUnresolved(asset.displayName)) {
+    throw new Error(`'displayName' may not contain a Token, got: ${JSON.stringify(asset.displayName)}`);
+  }
 }
 
 function validateDockerImageAssetSource(asset: DockerImageAssetSource) {
   if (!!asset.executable === !!asset.directoryName) {
     throw new Error(`Exactly one of 'directoryName' or 'executable' is required, got: ${JSON.stringify(asset)}`);
   }
 
+  if (Token.isUnresolved(asset.displayName)) {
+    throw new Error(`'displayName' may not contain a Token, got: ${JSON.stringify(asset.displayName)}`);
+  }
+
   check('dockerBuildArgs');
   check('dockerBuildTarget');
   check('dockerOutputs');

packages/aws-cdk-lib/core/test/stack-synthesis/all-synthesizers.test.ts

@@ -1,6 +1,6 @@
 import { FileAssetPackaging } from '@aws-cdk/cloud-assembly-schema';
 import { getAssetManifest, readAssetManifest } from './_helpers';
-import { CliCredentialsStackSynthesizer, LegacyStackSynthesizer } from '../../lib';
+import { Aws, CliCredentialsStackSynthesizer, LegacyStackSynthesizer } from '../../lib';
 import { App } from '../../lib/app';
 import { Stack } from '../../lib/stack';
 import { DefaultStackSynthesizer } from '../../lib/stack-synthesizers/default-synthesizer';
@@ -45,3 +45,29 @@ test.each([
   });
 });
 
+test.each([
+  ['DefaultStackSynthesizer', () => new DefaultStackSynthesizer()],
+  ['CliCredentialsStackSynthesizer', () => new CliCredentialsStackSynthesizer()],
+])('%p: displayName may not contain tokens', (_name, factory) => {
+  // GIVEN
+  const app = new App();
+  const stack = new Stack(app, 'Stack', {
+    synthesizer: factory(),
+    env: {
+      account: '111111111111', region: 'us-east-1',
+    },
+  });
+
+  expect(() => stack.synthesizer.addFileAsset({
+    fileName: __filename,
+    packaging: FileAssetPackaging.FILE,
+    sourceHash: 'fileHash',
+    displayName: Aws.STACK_NAME,
+  })).toThrow(/may not contain a Token/);
+
+  expect(() => stack.synthesizer.addDockerImageAsset({
+    directoryName: '.',
+    sourceHash: 'dockerHash',
+    displayName: Aws.STACK_NAME,
+  })).toThrow(/may not contain a Token/);
+});