fix(cx-api): cannot detect CloudAssembly across different libraries

packages/@aws-cdk/cx-api/package.json

@@ -62,7 +62,7 @@
     "gen": "cdk-copy cx-api",
     "watch": "cdk-watch",
     "lint": "cdk-lint && madge --circular --extensions js lib",
-    "test": "cdk-test",
+    "test": "jest",
     "pkglint": "pkglint -f",
     "package": "cdk-package",
     "awslint": "cdk-awslint",
@@ -82,12 +82,12 @@
     "semver": "^7.6.3"
   },
   "peerDependencies": {
-    "@aws-cdk/cloud-assembly-schema": "^39.0.0"
+    "@aws-cdk/cloud-assembly-schema": "^39.2.0"
   },
   "license": "Apache-2.0",
   "devDependencies": {
     "@aws-cdk/cdk-build-tools": "0.0.0",
-    "@aws-cdk/cloud-assembly-schema": "^39.0.1",
+    "@aws-cdk/cloud-assembly-schema": "^39.2.0",
     "@aws-cdk/pkglint": "0.0.0",
     "@types/jest": "^29.5.14",
     "@types/mock-fs": "^4.13.4",
@@ -120,4 +120,4 @@
   "publishConfig": {
     "tag": "latest"
   }
-}
+}

packages/@aws-cdk/integ-runner/package.json

@@ -72,7 +72,7 @@
   },
   "dependencies": {
     "chokidar": "^3.6.0",
-    "@aws-cdk/cloud-assembly-schema": "^39.0.0",
+    "@aws-cdk/cloud-assembly-schema": "^39.2.0",
     "@aws-cdk/cloudformation-diff": "0.0.0",
     "@aws-cdk/cx-api": "0.0.0",
     "@aws-cdk/aws-service-spec": "^0.1.49",
@@ -109,4 +109,4 @@
   "publishConfig": {
     "tag": "latest"
   }
-}
+}

packages/@aws-cdk/toolkit/lib/api/cloud-assembly/private/source-builder.ts

@@ -1,3 +1,4 @@
+import * as cxapi from '@aws-cdk/cx-api';
 import * as fs from 'fs-extra';
 import type { ICloudAssemblySource } from '../';
 import { ContextAwareCloudAssembly, ContextAwareCloudAssemblyProps } from './context-aware-source';
@@ -9,6 +10,12 @@ import { ToolkitError } from '../../errors';
 import { debug } from '../../io/private';
 import { AssemblyBuilder, CdkAppSourceProps } from '../source-builder';
 
+// bypass loading from disk if we already have a supported object
+const CLOUD_ASSEMBLY_SYMBOL = Symbol.for('@aws-cdk/cx-api.CloudAssembly');
+function isCloudAssembly(x: any): x is cxapi.CloudAssembly {
+  return x !== null && typeof(x) === 'object' && CLOUD_ASSEMBLY_SYMBOL in x;
+}
+
 export abstract class CloudAssemblySourceBuilder {
 
   /**
@@ -40,13 +47,19 @@ export abstract class CloudAssemblySourceBuilder {
         produce: async () => {
           const outdir = determineOutputDirectory(props.outdir);
           const env = await prepareDefaultEnvironment(services, { outdir });
-          return changeDir(async () =>
+          const assembly = await changeDir(async () =>
             withContext(context.all, env, props.synthOptions ?? {}, async (envWithContext, ctx) =>
               withEnv(envWithContext, () => builder({
                 outdir,
                 context: ctx,
               })),
             ), props.workingDirectory);
+
+          if (isCloudAssembly(assembly)) {
+            return assembly;
+          }
+
+          return new cxapi.CloudAssembly(assembly.directory);
         },
       },
       contextAssemblyProps,

packages/@aws-cdk/toolkit/lib/api/cloud-assembly/source-builder.ts

@@ -1,4 +1,4 @@
-import type * as cxapi from '@aws-cdk/cx-api';
+import type * as cxschema from '@aws-cdk/cloud-assembly-schema';
 
 export interface AppProps {
   /**
@@ -12,7 +12,7 @@ export interface AppProps {
   readonly context?: { [key: string]: any };
 }
 
-export type AssemblyBuilder = (props: AppProps) => Promise<cxapi.CloudAssembly>;
+export type AssemblyBuilder = (props: AppProps) => Promise<cxschema.ICloudAssembly>;
 
 /**
  * Configuration for creating a CLI from an AWS CDK App directory

packages/@aws-cdk/toolkit/package.json

@@ -57,7 +57,7 @@
     "typescript": "~5.6.3"
   },
   "dependencies": {
-    "@aws-cdk/cloud-assembly-schema": "^39.0.1",
+    "@aws-cdk/cloud-assembly-schema": "^39.2.0",
     "@aws-cdk/cloudformation-diff": "0.0.0",
     "@aws-cdk/cx-api": "0.0.0",
     "@aws-cdk/region-info": "0.0.0",

packages/@aws-cdk/toolkit/test/_fixtures/external-context/index.ts

@@ -7,5 +7,5 @@ export default async () => {
   new s3.Bucket(stack, 'MyBucket', {
     bucketName: app.node.tryGetContext('externally-provided-bucket-name'),
   });
-  return app.synth() as any;
+  return app.synth();
 };

packages/@aws-cdk/toolkit/test/_fixtures/stack-with-bucket/index.ts

@@ -5,5 +5,5 @@ export default async () => {
   const app = new core.App();
   const stack = new core.Stack(app, 'Stack1');
   new s3.Bucket(stack, 'MyBucket');
-  return app.synth() as any;
+  return app.synth();
 };

packages/@aws-cdk/toolkit/test/_fixtures/two-empty-stacks/index.ts

@@ -5,6 +5,5 @@ export default async () => {
   new core.Stack(app, 'Stack1');
   new core.Stack(app, 'Stack2');
 
-  // @todo fix api
-  return app.synth() as any;
+  return app.synth();
 };

packages/aws-cdk-lib/cx-api/lib/cloud-assembly.ts

@@ -1,13 +1,19 @@
 import * as fs from 'fs';
 import * as os from 'os';
 import * as path from 'path';
+// This is deliberately importing the interface from the external package.
+// We want this, so that jsii language packages can depend on @aws-cdk/cloud-assembly-schema
+// instead of being forced to take a dependency on the much larger aws-cdk-lib.
+import type { ICloudAssembly } from '@aws-cdk/cloud-assembly-schema';
 import { CloudFormationStackArtifact } from './artifacts/cloudformation-artifact';
 import { NestedCloudAssemblyArtifact } from './artifacts/nested-cloud-assembly-artifact';
 import { TreeCloudArtifact } from './artifacts/tree-cloud-artifact';
 import { CloudArtifact } from './cloud-artifact';
 import { topologicalSort } from './toposort';
 import * as cxschema from '../../cloud-assembly-schema';
 
+const CLOUD_ASSEMBLY_SYMBOL = Symbol.for('@aws-cdk/cx-api.CloudAssembly');
+
 /**
  * The name of the root manifest file of the assembly.
  */
@@ -16,7 +22,16 @@ const MANIFEST_FILE = 'manifest.json';
 /**
  * Represents a deployable cloud application.
  */
-export class CloudAssembly {
+export class CloudAssembly implements ICloudAssembly {
+  /**
+   * Return whether the given object is a CloudAssembly.
+   *
+   * We do attribute detection since we can't reliably use 'instanceof'.
+   */
+  public static isCloudAssembly(x: any): x is CloudAssembly {
+    return x !== null && typeof(x) === 'object' && CLOUD_ASSEMBLY_SYMBOL in x;
+  }
+
   /**
    * The root directory of the cloud assembly.
    */
@@ -54,6 +69,8 @@ export class CloudAssembly {
     this.artifacts = this.renderArtifacts(loadOptions?.topoSort ?? true);
     this.runtime = this.manifest.runtime || { libraries: { } };
 
+    Object.defineProperty(this, CLOUD_ASSEMBLY_SYMBOL, { value: true });
+
     // force validation of deps by accessing 'depends' on all artifacts
     this.validateDeps();
   }

packages/aws-cdk-lib/cx-api/test/cloud-assembly.test.ts

@@ -185,3 +185,12 @@ test('getStackArtifact retrieves a stack by artifact id from a nested assembly',
   expect(assembly.getStackArtifact('stack1').id).toEqual('stack1');
   expect(assembly.getStackArtifact('stack2').id).toEqual('stack2');
 });
+
+test('isCloudAssembly correctly detects Cloud Assemblies', () => {
+  const assembly = new CloudAssembly(path.join(FIXTURES, 'nested-assemblies'));
+  const inheritedAssembly = new (class extends CloudAssembly {})(path.join(FIXTURES, 'nested-assemblies'));
+
+  expect(CloudAssembly.isCloudAssembly(assembly)).toBe(true);
+  expect(CloudAssembly.isCloudAssembly(inheritedAssembly)).toBe(true);
+  expect(CloudAssembly.isCloudAssembly({})).toBe(false);
+});

packages/aws-cdk-lib/package.json

@@ -122,7 +122,7 @@
     "@aws-cdk/asset-awscli-v1": "^2.2.208",
     "@aws-cdk/asset-kubectl-v20": "^2.1.3",
     "@aws-cdk/asset-node-proxy-agent-v6": "^2.1.0",
-    "@aws-cdk/cloud-assembly-schema": "^39.0.1",
+    "@aws-cdk/cloud-assembly-schema": "^39.2.0",
     "@balena/dockerignore": "^1.0.2",
     "case": "1.6.3",
     "fs-extra": "^11.2.0",

packages/aws-cdk/package.json

@@ -140,7 +140,7 @@
     "xml-js": "^1.6.11"
   },
   "dependencies": {
-    "@aws-cdk/cloud-assembly-schema": "^39.0.0",
+    "@aws-cdk/cloud-assembly-schema": "^39.2.0",
     "@aws-cdk/cloudformation-diff": "0.0.0",
     "@aws-cdk/cx-api": "0.0.0",
     "@aws-cdk/region-info": "0.0.0",

yarn.lock

@@ -71,15 +71,15 @@
     "@aws-cdk/service-spec-types" "^0.0.115"
     "@cdklabs/tskb" "^0.0.3"
 
-"@aws-cdk/cloud-assembly-schema@^39.0.0", "@aws-cdk/cloud-assembly-schema@^39.0.1", "@aws-cdk/cloud-assembly-schema@^39.1.34":
+"@aws-cdk/cloud-assembly-schema@^39.1.34":
   version "39.1.34"
   resolved "https://registry.npmjs.org/@aws-cdk/cloud-assembly-schema/-/cloud-assembly-schema-39.1.34.tgz#06bfc07cd892bf431f97c8ff784c8b001480c134"
   integrity sha512-/uDvlrOD67PAaMxEX/gbWA8tce9SdVkGBtxEXV/R+DN7z6T4BztX3aZhkjMP/mzWu0UbkgOkwbOzqD4terCGwg==
   dependencies:
     jsonschema "^1.4.1"
     semver "^7.6.3"
 
-"@aws-cdk/cloud-assembly-schema@^39.1.49":
+"@aws-cdk/cloud-assembly-schema@^39.1.49", "@aws-cdk/cloud-assembly-schema@^39.2.0":
   version "39.2.0"
   resolved "https://registry.npmjs.org/@aws-cdk/cloud-assembly-schema/-/cloud-assembly-schema-39.2.0.tgz#2abf4afb91c873a0206b5b6467fe53e505f7a9b7"
   integrity sha512-ymGG+ab4xN40iPx9O0zuuvu6qZi4RY+hr3YScSg5Ye0dkcchQ49RBINHrqqy7fZvcMbV7bkxf/Cxj9yxSF3BnA==