feat(toolkit-lib): can disable cloud assembly version and enum checks for sources (#202)

Fixes #201

Feature request was for `cli-lib-alpha`, however we are instead adding
this to the new package that should be used going forward.

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

Author: mrgrain

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

@@ -11,7 +11,7 @@ import { ToolkitServices } from '../../../toolkit/private';
 import { CODES } from '../../io/private';
 import { ActionAwareIoHost } from '../../shared-private';
 import { ToolkitError } from '../../shared-public';
-import type { AppSynthOptions } from '../source-builder';
+import type { AppSynthOptions, LoadAssemblyOptions } from '../source-builder';
 
 export { guessExecutable } from '../../../api/aws-cdk';
 
@@ -149,9 +149,11 @@ export async function checkContextOverflowSupport(assembly: cxapi.CloudAssembly,
 /**
  * Safely create an assembly from a cloud assembly directory
  */
-export async function assemblyFromDirectory(assemblyDir: string, ioHost: ActionAwareIoHost) {
+export async function assemblyFromDirectory(assemblyDir: string, ioHost: ActionAwareIoHost, loadOptions: LoadAssemblyOptions = {}) {
   try {
     const assembly = new cxapi.CloudAssembly(assemblyDir, {
+      skipVersionCheck: !(loadOptions.checkVersion ?? true),
+      skipEnumCheck: !(loadOptions.checkEnums ?? true),
       // We sort as we deploy
       topoSort: false,
     });

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

@@ -1,6 +1,6 @@
 import * as cxapi from '@aws-cdk/cx-api';
 import * as fs from 'fs-extra';
-import type { AssemblySourceProps, ICloudAssemblySource } from '../';
+import type { AssemblyDirectoryProps, AssemblySourceProps, ICloudAssemblySource } from '../';
 import { ContextAwareCloudAssembly, ContextAwareCloudAssemblyProps } from './context-aware-source';
 import { execInChildProcess } from './exec';
 import { assemblyFromDirectory, changeDir, determineOutputDirectory, guessExecutable, prepareDefaultEnvironment, withContext, withEnv } from './prepare-source';
@@ -52,7 +52,7 @@ export abstract class CloudAssemblySourceBuilder {
             return assembly;
           }
 
-          return new cxapi.CloudAssembly(assembly.directory);
+          return assemblyFromDirectory(assembly.directory, services.ioHost, props.loadAssemblyOptions);
         },
       },
       contextAssemblyProps,
@@ -64,7 +64,7 @@ export abstract class CloudAssemblySourceBuilder {
    * @param directory the directory of a already produced Cloud Assembly.
    * @returns the CloudAssembly source
    */
-  public async fromAssemblyDirectory(directory: string): Promise<ICloudAssemblySource> {
+  public async fromAssemblyDirectory(directory: string, props: AssemblyDirectoryProps = {}): Promise<ICloudAssemblySource> {
     const services: ToolkitServices = await this.sourceBuilderServices();
     const contextAssemblyProps: ContextAwareCloudAssemblyProps = {
       services,
@@ -77,7 +77,7 @@ export abstract class CloudAssemblySourceBuilder {
         produce: async () => {
           // @todo build
           await services.ioHost.notify(CODES.CDK_ASSEMBLY_I0150.msg('--app points to a cloud assembly, so we bypass synth'));
-          return assemblyFromDirectory(directory, services.ioHost);
+          return assemblyFromDirectory(directory, services.ioHost, props.loadAssemblyOptions);
         },
       },
       contextAssemblyProps,
@@ -136,7 +136,7 @@ export abstract class CloudAssemblySourceBuilder {
                 extraEnv: envWithContext,
                 cwd: props.workingDirectory,
               });
-              return assemblyFromDirectory(outdir, services.ioHost);
+              return assemblyFromDirectory(outdir, services.ioHost, props.loadAssemblyOptions);
             });
           } finally {
             await lock?.release();

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

@@ -17,6 +17,16 @@ export interface AssemblyBuilderProps {
 
 export type AssemblyBuilder = (props: AssemblyBuilderProps) => Promise<cxschema.ICloudAssembly>;
 
+/**
+ * Configuration for creating a CLI from an AWS CDK App directory
+ */
+export interface AssemblyDirectoryProps {
+  /**
+   * Options to configure loading of the assembly after it has been synthesized
+   */
+  readonly loadAssemblyOptions?: LoadAssemblyOptions;
+}
+
 /**
  * Configuration for creating a CLI from an AWS CDK App directory
  */
@@ -59,6 +69,11 @@ export interface AssemblySourceProps {
    * Options that are passed through the context to a CDK app on synth
    */
   readonly synthOptions?: AppSynthOptions;
+
+  /**
+   * Options to configure loading of the assembly after it has been synthesized
+   */
+  readonly loadAssemblyOptions?: LoadAssemblyOptions;
 }
 
 /**
@@ -123,3 +138,28 @@ export interface AppSynthOptions {
    */
   readonly bundlingForStacks?: string;
 }
+
+/**
+ * Options to configure loading of the assembly after it has been synthesized
+ */
+export interface LoadAssemblyOptions {
+  /**
+   * Check the Toolkit supports the Cloud Assembly Schema version
+   *
+   * When disabled, allows to Toolkit to read a newer cloud assembly than the CX API is designed
+   * to support. Your application may not be aware of all features that in use in the Cloud Assembly.
+   *
+   * @default true
+   */
+  readonly checkVersion?: boolean;
+
+  /**
+   * Validate enums to only have known values
+   *
+   * When disabled, the Toolkit may read enum values it doesn't know about yet.
+   * You will have to make sure to always check the values of enums you encounter in the manifest.
+   *
+   * @default true
+   */
+  readonly checkEnums?: boolean;
+}

packages/@aws-cdk/toolkit-lib/test/_fixtures/manifest-from-the-future/cdk.out/Stack1.assets.json

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