feat(toolkit-lib): fromAssemblyDirectory can ignore missing context (#611)

Previously `fromAssemblyDirectory` created a
`ContextAwareCloudAssemblySource` with lookups disabled. This would
always fail if there was any missing context in the assembly, because
you can't perform lookups with just the CloudAssembly directory.

This PR updates the logic to use a `CachedCloudAssembly` instead and
check for missing context. The missing context check can be disabled
using the new `failOnMissingContext` option (defaults to fail).

Resolves #549

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

---------

Co-authored-by: Momo Kornher <[email protected]>
Co-authored-by: Momo Kornher <[email protected]>

Author: corymhall

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

@@ -1,11 +1,11 @@
-import type { MissingContext } from '@aws-cdk/cloud-assembly-schema';
 import * as contextproviders from '../../../context-providers';
 import type { ToolkitServices } from '../../../toolkit/private';
 import { ToolkitError } from '../../../toolkit/toolkit-error';
 import type { IoHelper } from '../../io/private';
 import { IO } from '../../io/private';
 import type { IContextStore } from '../context-store';
 import type { ICloudAssemblySource, IReadableCloudAssembly } from '../types';
+import { missingContextKeys } from './helpers';
 
 export interface ContextAwareCloudAssemblyProps {
   /**
@@ -115,13 +115,6 @@ export class ContextAwareCloudAssemblySource implements ICloudAssemblySource {
   }
 }
 
-/**
- * Return all keys of missing context items
- */
-function missingContextKeys(missing?: MissingContext[]): Set<string> {
-  return new Set((missing || []).map(m => m.key));
-}
-
 /**
  * Are two sets equal to each other
  */

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

@@ -1,3 +1,4 @@
+import type { MissingContext } from '@aws-cdk/cloud-assembly-schema';
 import { ToolkitError } from '../../../toolkit/toolkit-error';
 
 /**
@@ -42,3 +43,10 @@ function detectSynthvarConflicts<A extends object>(obj: A) {
     },
   });
 }
+
+/**
+ * Return all keys of missing context items
+ */
+export function missingContextKeys(missing?: MissingContext[]): Set<string> {
+  return new Set((missing || []).map((m) => m.key));
+}

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

@@ -5,6 +5,7 @@ import * as cxapi from '@aws-cdk/cx-api';
 import * as fs from 'fs-extra';
 import { CdkAppMultiContext, MemoryContext, type IContextStore } from './context-store';
 import { RWLock } from '../rwlock';
+import { CachedCloudAssembly } from './cached-source';
 import type { ContextAwareCloudAssemblyProps } from './private/context-aware-source';
 import { ContextAwareCloudAssemblySource } from './private/context-aware-source';
 import { execInChildProcess } from './private/exec';
@@ -15,7 +16,7 @@ import type { ToolkitServices } from '../../toolkit/private';
 import { ToolkitError, AssemblyError } from '../../toolkit/toolkit-error';
 import { noUndefined } from '../../util';
 import { IO } from '../io/private';
-import { temporarilyWriteEnv } from './private/helpers';
+import { missingContextKeys, temporarilyWriteEnv } from './private/helpers';
 
 /**
  * Properties the builder function receives.
@@ -61,6 +62,14 @@ export interface AssemblyDirectoryProps {
    * Options to configure loading of the assembly after it has been synthesized
    */
   readonly loadAssemblyOptions?: LoadAssemblyOptions;
+
+  /**
+   * Whether or not to fail if the synthesized assembly contains
+   * missing context
+   *
+   * @default true
+   */
+  readonly failOnMissingContext?: boolean;
 }
 
 /**
@@ -379,30 +388,33 @@ export abstract class CloudAssemblySourceBuilder {
    */
   public async fromAssemblyDirectory(directory: string, props: AssemblyDirectoryProps = {}): Promise<ICloudAssemblySource> {
     const services: ToolkitServices = await this.sourceBuilderServices();
-    const contextAssemblyProps: ContextAwareCloudAssemblyProps = {
-      services,
-      contextStore: new MemoryContext(), // @todo We shouldn't be using a `ContextAwareCloudAssemblySource` at all.
-      lookups: false,
-    };
 
-    return new ContextAwareCloudAssemblySource(
-      {
-        produce: async () => {
-          // @todo build
-          await services.ioHelper.notify(IO.CDK_ASSEMBLY_I0150.msg('--app points to a cloud assembly, so we bypass synth'));
-
-          const readLock = await new RWLock(directory).acquireRead();
-          try {
-            const asm = await assemblyFromDirectory(directory, services.ioHelper, props.loadAssemblyOptions);
-            return new ReadableCloudAssembly(asm, readLock, { deleteOnDispose: false });
-          } catch (e) {
-            await readLock.release();
-            throw e;
+    return {
+      async produce() {
+        await services.ioHelper.notify(IO.CDK_ASSEMBLY_I0150.msg('--app points to a cloud assembly, so we bypass synth'));
+        const readLock = await new RWLock(directory).acquireRead();
+        try {
+          const asm = await assemblyFromDirectory(directory, services.ioHelper, props.loadAssemblyOptions);
+          const assembly = new ReadableCloudAssembly(asm, readLock, { deleteOnDispose: false });
+          if (assembly.cloudAssembly.manifest.missing && assembly.cloudAssembly.manifest.missing.length > 0) {
+            if (props.failOnMissingContext ?? true) {
+              const missingKeysSet = missingContextKeys(assembly.cloudAssembly.manifest.missing);
+              const missingKeys = Array.from(missingKeysSet);
+              throw AssemblyError.withCause(
+                'Assembly contains missing context. ' +
+                  "Make sure all necessary context is already in 'cdk.context.json' by running 'cdk synth' on a machine with sufficient AWS credentials and committing the result. " +
+                  `Missing context keys: '${missingKeys.join(', ')}'`,
+                'Error producing assembly',
+              );
+            }
           }
-        },
+          return new CachedCloudAssembly(assembly);
+        } catch (e) {
+          await readLock.release();
+          throw e;
+        }
       },
-      contextAssemblyProps,
-    );
+    };
   }
   /**
    * Use a directory containing an AWS CDK app as source.

packages/@aws-cdk/toolkit-lib/test/_fixtures/assembly-missing-context/cdk.out/assembly-Stage/StageStack130339B27.assets.json

@@ -0,0 +1,19 @@
+{
+  "version": "40.0.0",
+  "files": {
+    "7f4fb64a3afca08edbdbaa369e00317cb253697278406a83c78e849e89045f9d": {
+      "source": {
+        "path": "StageStack130339B27.template.json",
+        "packaging": "file"
+      },
+      "destinations": {
+        "current_account-current_region": {
+          "bucketName": "cdk-hnb659fds-assets-${AWS::AccountId}-${AWS::Region}",
+          "objectKey": "7f4fb64a3afca08edbdbaa369e00317cb253697278406a83c78e849e89045f9d.json",
+          "assumeRoleArn": "arn:${AWS::Partition}:iam::${AWS::AccountId}:role/cdk-hnb659fds-file-publishing-role-${AWS::AccountId}-${AWS::Region}"
+        }
+      }
+    }
+  },
+  "dockerImages": {}
+}