feat(cli): assets can now depend on stacks

packages/aws-cdk-lib/cx-api/lib/artifacts/cloudformation-artifact.ts

@@ -5,7 +5,30 @@ import { CloudArtifact } from '../cloud-artifact';
 import type { CloudAssembly } from '../cloud-assembly';
 import { Environment, EnvironmentUtils } from '../environment';
 
+const CLOUDFORMATION_STACK_ARTIFACT_SYM = Symbol.for('@aws-cdk/cx-api.CloudFormationStackArtifact');
+
 export class CloudFormationStackArtifact extends CloudArtifact {
+  /**
+   * Checks if `art` is an instance of this class.
+   *
+   * Use this method instead of `instanceof` to properly detect `CloudFormationStackArtifact`
+   * instances, even when the construct library is symlinked.
+   *
+   * Explanation: in JavaScript, multiple copies of the `cx-api` library on
+   * disk are seen as independent, completely different libraries. As a
+   * consequence, the class `CloudFormationStackArtifact` in each copy of the `cx-api` library
+   * is seen as a different class, and an instance of one class will not test as
+   * `instanceof` the other class. `npm install` will not create installations
+   * like this, but users may manually symlink construct libraries together or
+   * use a monorepo tool: in those cases, multiple copies of the `cx-api`
+   * library can be accidentally installed, and `instanceof` will behave
+   * unpredictably. It is safest to avoid using `instanceof`, and using
+   * this type-testing method instead.
+   */
+  public static isCloudFormationStackArtifact(art: any): art is CloudFormationStackArtifact {
+    return art && typeof art === 'object' && art[CLOUDFORMATION_STACK_ARTIFACT_SYM];
+  }
+
   /**
    * The file name of the template.
    */
@@ -183,3 +206,15 @@ export class CloudFormationStackArtifact extends CloudArtifact {
     return ret;
   }
 }
+
+/**
+ * Mark all instances of 'CloudFormationStackArtifact'
+ *
+ * Why not put this in the constructor? Because this is a class property,
+ * not an instance property. It applies to all instances of the class.
+ */
+Object.defineProperty(CloudFormationStackArtifact.prototype, CLOUDFORMATION_STACK_ARTIFACT_SYM, {
+  value: true,
+  enumerable: false,
+  writable: false,
+});

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

@@ -3,10 +3,33 @@ import * as cxschema from '../../../cloud-assembly-schema';
 import { CloudArtifact } from '../cloud-artifact';
 import type { CloudAssembly } from '../cloud-assembly';
 
+const NESTED_CLOUD_ASSEMBLY_SYM = Symbol.for('@aws-cdk/cx-api.NestedCloudAssemblyArtifact');
+
 /**
  * Asset manifest is a description of a set of assets which need to be built and published
  */
 export class NestedCloudAssemblyArtifact extends CloudArtifact {
+  /**
+   * Checks if `art` is an instance of this class.
+   *
+   * Use this method instead of `instanceof` to properly detect `NestedCloudAssemblyArtifact`
+   * instances, even when the construct library is symlinked.
+   *
+   * Explanation: in JavaScript, multiple copies of the `cx-api` library on
+   * disk are seen as independent, completely different libraries. As a
+   * consequence, the class `NestedCloudAssemblyArtifact` in each copy of the `cx-api` library
+   * is seen as a different class, and an instance of one class will not test as
+   * `instanceof` the other class. `npm install` will not create installations
+   * like this, but users may manually symlink construct libraries together or
+   * use a monorepo tool: in those cases, multiple copies of the `cx-api`
+   * library can be accidentally installed, and `instanceof` will behave
+   * unpredictably. It is safest to avoid using `instanceof`, and using
+   * this type-testing method instead.
+   */
+  public static isNestedCloudAssemblyArtifact(art: any): art is NestedCloudAssemblyArtifact {
+    return art && typeof art === 'object' && art[NESTED_CLOUD_ASSEMBLY_SYM];
+  }
+
   /**
    * The relative directory name of the asset manifest
    */
@@ -40,4 +63,16 @@ export interface NestedCloudAssemblyArtifact {
   readonly nestedAssembly: CloudAssembly;
 
   // Declared in a different file
-}
+}
+
+/**
+ * Mark all instances of 'NestedCloudAssemblyArtifact'
+ *
+ * Why not put this in the constructor? Because this is a class property,
+ * not an instance property. It applies to all instances of the class.
+ */
+Object.defineProperty(NestedCloudAssemblyArtifact.prototype, NESTED_CLOUD_ASSEMBLY_SYM, {
+  value: true,
+  enumerable: false,
+  writable: false,
+});

packages/aws-cdk-lib/cx-api/lib/artifacts/tree-cloud-artifact.ts

@@ -2,7 +2,30 @@ import * as cxschema from '../../../cloud-assembly-schema';
 import { CloudArtifact } from '../cloud-artifact';
 import { CloudAssembly } from '../cloud-assembly';
 
+const TREE_CLOUD_ARTIFACT_SYM = Symbol.for('@aws-cdk/cx-api.TreeCloudArtifact');
+
 export class TreeCloudArtifact extends CloudArtifact {
+  /**
+   * Checks if `art` is an instance of this class.
+   *
+   * Use this method instead of `instanceof` to properly detect `TreeCloudArtifact`
+   * instances, even when the construct library is symlinked.
+   *
+   * Explanation: in JavaScript, multiple copies of the `cx-api` library on
+   * disk are seen as independent, completely different libraries. As a
+   * consequence, the class `TreeCloudArtifact` in each copy of the `cx-api` library
+   * is seen as a different class, and an instance of one class will not test as
+   * `instanceof` the other class. `npm install` will not create installations
+   * like this, but users may manually symlink construct libraries together or
+   * use a monorepo tool: in those cases, multiple copies of the `cx-api`
+   * library can be accidentally installed, and `instanceof` will behave
+   * unpredictably. It is safest to avoid using `instanceof`, and using
+   * this type-testing method instead.
+   */
+  public static isTreeCloudArtifact(art: any): art is TreeCloudArtifact {
+    return art && typeof art === 'object' && art[TREE_CLOUD_ARTIFACT_SYM];
+  }
+
   public readonly file: string;
 
   constructor(assembly: CloudAssembly, name: string, artifact: cxschema.ArtifactManifest) {
@@ -14,4 +37,16 @@ export class TreeCloudArtifact extends CloudArtifact {
     }
     this.file = properties.file;
   }
-}
+}
+
+/**
+ * Mark all instances of 'TreeCloudArtifact'
+ *
+ * Why not put this in the constructor? Because this is a class property,
+ * not an instance property. It applies to all instances of the class.
+ */
+Object.defineProperty(TreeCloudArtifact.prototype, TREE_CLOUD_ARTIFACT_SYM, {
+  value: true,
+  enumerable: false,
+  writable: false,
+});

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

@@ -228,7 +228,7 @@ export class CloudAssembly {
       }
     }
 
-    return topologicalSort(result, x => x.id, x => x._dependencyIDs);
+    return topologicalSort(result, x => x.id, x => x._dependencyIDs); // TODO: remove redundant toposort
   }
 }
 
@@ -357,6 +357,13 @@ export class CloudAssemblyBuilder {
       parentBuilder: this,
     });
   }
+
+  /**
+   * Delete the cloud assembly directory
+   */
+  public delete() {
+    fs.rmSync(this.outdir, { recursive: true, force: true });
+  }
 }
 
 /**

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

@@ -168,6 +168,13 @@ test('can read assembly with asset manifest', () => {
   expect(assembly.artifacts).toHaveLength(2);
 });
 
+test('can toposort assembly with asset dependency', () => {
+  const assembly = new CloudAssembly(path.join(FIXTURES, 'asset-depends'));
+  expect(assembly.stacks).toHaveLength(2);
+  expect(assembly.artifacts).toHaveLength(3);
+  expect(assembly.artifacts[0].id).toEqual('StagingStack');
+});
+
 test('getStackArtifact retrieves a stack by artifact id from a nested assembly', () => {
   const assembly = new CloudAssembly(path.join(FIXTURES, 'nested-assemblies'));
 

packages/aws-cdk-lib/cx-api/test/fixtures/asset-depends/manifest.json

@@ -0,0 +1,29 @@
+{
+  "version": "0.0.0",
+  "artifacts": {
+    "MyStackName": {
+      "type": "aws:cloudformation:stack",
+      "environment": "aws://37736633/us-region-1",
+      "properties": {
+        "templateFile": "template.json"
+      },
+      "dependencies": ["AssetManifest"],
+      "metadata": {
+      }
+    },
+    "AssetManifest": {
+      "type": "cdk:asset-manifest",
+      "properties": {
+        "file": "asset.json"
+      },
+      "dependencies": ["StagingStack"]
+    },
+    "StagingStack": {
+      "type": "aws:cloudformation:stack",
+      "environment": "aws://1111/us-region-1",
+      "properties": {
+        "templateFile": "template.json"
+      }
+    }
+  }
+}

packages/aws-cdk-lib/cx-api/test/fixtures/asset-depends/template.json

@@ -0,0 +1,7 @@
+{
+  "Resources": {
+    "MyBucket": {
+      "Type": "AWS::S3::Bucket"
+    }
+  }
+}

packages/aws-cdk/lib/api/aws-auth/sdk-provider.ts

@@ -176,6 +176,7 @@ export class SdkProvider {
     options?: CredentialsOptions,
   ): Promise<SdkForEnvironment> {
     const env = await this.resolveEnvironment(environment);
+
     const baseCreds = await this.obtainBaseCredentials(env.account, mode);
 
     // At this point, we need at least SOME credentials