toolkit-lib

mrgrain · mrgrain · commit 824e2d21691a · 2025-04-03T18:58:47.000+01:00
diff --git a/.projenrc.ts b/.projenrc.ts
@@ -720,6 +720,7 @@ const tmpToolkitHelpers = configureProject(
       'chalk@4',
       'fs-extra@^9',
       'glob',
+      'minimatch',
       'p-limit@^3',
       'promptly', // @todo remove this should only be in CLI
       'proxy-agent', // @todo remove this should only be in CLI
@@ -870,10 +871,10 @@ const cli = configureProject(
           // We want to improve our test coverage
           // DO NOT LOWER THESE VALUES!
           // If you need to break glass, open an issue to re-up the values with additional test coverage
-          statements: 84,
-          branches: 74,
+          statements: 80,
+          branches: 76,
           functions: 87,
-          lines: 84,
+          lines: 82,
         },
         // We have many tests here that commonly time out
         testTimeout: 60_000,
diff --git a/packages/@aws-cdk/toolkit-lib/.projen/deps.json b/packages/@aws-cdk/toolkit-lib/.projen/deps.json
diff --git a/packages/@aws-cdk/toolkit-lib/.projen/tasks.json b/packages/@aws-cdk/toolkit-lib/.projen/tasks.json
diff --git a/packages/@aws-cdk/toolkit-lib/lib/actions/bootstrap/index.ts b/packages/@aws-cdk/toolkit-lib/lib/actions/bootstrap/index.ts
@@ -1,8 +1,9 @@
 import type * as cxapi from '@aws-cdk/cx-api';
 import { environmentsFromDescriptors } from './private';
 import type { Tag } from '../../api/aws-cdk';
-import type { ICloudAssemblySource, IIoHost } from '../../api/cloud-assembly';
+import type { ICloudAssemblySource } from '../../api/cloud-assembly';
 import { ALL_STACKS } from '../../api/cloud-assembly/private';
+import type { IIoHost } from '../../api/io';
 import { asIoHelper } from '../../api/shared-private';
 import { assemblyFromSource } from '../../toolkit/private';
 
diff --git a/packages/@aws-cdk/toolkit-lib/lib/api/aws-cdk.ts b/packages/@aws-cdk/toolkit-lib/lib/api/aws-cdk.ts
@@ -1,30 +1,11 @@
 /* eslint-disable import/no-restricted-paths */
 
-// APIs
-export { SdkProvider } from '../../../../aws-cdk/lib/api/aws-auth';
-export { Context, PROJECT_CONTEXT } from '../../../../aws-cdk/lib/api/context';
-export { createDiffChangeSet, Deployments, type SuccessfulDeployStackResult, type DeployStackOptions, type DeployStackResult } from '../../../../aws-cdk/lib/api/deployments';
-export { Settings } from '../../../../aws-cdk/lib/api/settings';
-export { type Tag, tagsForStack } from '../../../../aws-cdk/lib/api/tags';
-export { DEFAULT_TOOLKIT_STACK_NAME } from '../../../../aws-cdk/lib/api/toolkit-info';
-export { ResourceMigrator } from '../../../../aws-cdk/lib/api/resource-import';
-export { CloudWatchLogEventMonitor, findCloudWatchLogGroups } from '../../../../aws-cdk/lib/api/logs';
-export { type WorkGraph, WorkGraphBuilder, AssetBuildNode, AssetPublishNode, StackNode, Concurrency } from '../../../../aws-cdk/lib/api/work-graph';
-export { Bootstrapper } from '../../../../aws-cdk/lib/api/bootstrap';
-export { loadTree, some } from '../../../../aws-cdk/lib/api/tree';
+export * from '../../../tmp-toolkit-helpers/src/api';
+export * as contextproviders from '../../../tmp-toolkit-helpers/src/context-providers';
 
-// Context Providers
-export * as contextproviders from '../../../../aws-cdk/lib/context-providers';
+// // @todo Cloud Assembly and Executable - this is a messy API right now
+// export { prepareDefaultEnvironment, prepareContext, spaceAvailableForContext } from '../../../../aws-cdk/lib/api/cxapp/exec';
+// export { guessExecutable } from '../../../../aws-cdk/lib/api/cxapp/exec';
 
-// @todo APIs not clean import
-export { HotswapMode } from '../../../../aws-cdk/lib/api/hotswap';
-export { HotswapPropertyOverrides, EcsHotswapProperties } from '../../../../aws-cdk/lib/api/hotswap';
-export { RWLock, type ILock } from '../../../../aws-cdk/lib/api/util/rwlock';
-
-// @todo Cloud Assembly and Executable - this is a messy API right now
-export { CloudAssembly, sanitizePatterns, StackCollection, ExtendedStackSelection } from '../../../../aws-cdk/lib/api/cxapp/cloud-assembly';
-export { prepareDefaultEnvironment, prepareContext, spaceAvailableForContext } from '../../../../aws-cdk/lib/api/cxapp/exec';
-export { guessExecutable } from '../../../../aws-cdk/lib/api/cxapp/exec';
-
-// @todo Should not use! investigate how to replace
-export { versionNumber } from '../../../../aws-cdk/lib/cli/version';
+// // @todo Should not use! investigate how to replace
+// export { versionNumber } from '../../../../aws-cdk/lib/cli/version';
diff --git a/packages/@aws-cdk/toolkit-lib/lib/api/cloud-assembly/index.ts b/packages/@aws-cdk/toolkit-lib/lib/api/cloud-assembly/index.ts
@@ -1,4 +1,3 @@
-export * from '../../api/shared-public';
 export * from './source-builder';
 export * from './types';
-
+export { StackSelector, StackSelectionStrategy } from '../shared-public';
diff --git a/packages/@aws-cdk/toolkit-lib/lib/api/cloud-assembly/private/prepare-source.ts b/packages/@aws-cdk/toolkit-lib/lib/api/cloud-assembly/private/prepare-source.ts
@@ -6,8 +6,8 @@ import * as cxapi from '@aws-cdk/cx-api';
 import * as fs from 'fs-extra';
 import { lte } from 'semver';
 import type { SdkProvider } from '../../../api/aws-cdk';
-import { prepareDefaultEnvironment as oldPrepare, prepareContext, spaceAvailableForContext, Settings, loadTree, some, versionNumber, guessExecutable } from '../../../api/aws-cdk';
-import { splitBySize } from '../../../private/util';
+import { prepareDefaultEnvironment as oldPrepare, prepareContext, spaceAvailableForContext, Settings, loadTree, some, guessExecutable } from '../../../api/aws-cdk';
+import { splitBySize, versionNumber } from '../../../private/util';
 import type { ToolkitServices } from '../../../toolkit/private';
 import { IO } from '../../io/private';
 import type { IoHelper } from '../../shared-private';
diff --git a/packages/@aws-cdk/toolkit-lib/lib/api/cloud-assembly/private/stack-assembly.ts b/packages/@aws-cdk/toolkit-lib/lib/api/cloud-assembly/private/stack-assembly.ts
@@ -1,6 +1,6 @@
 import type * as cxapi from '@aws-cdk/cx-api';
 import { major } from 'semver';
-import { CloudAssembly, sanitizePatterns, StackCollection, ExtendedStackSelection as CliExtendedStackSelection } from '../../aws-cdk';
+import { StackCollection, ExtendedStackSelection as CliExtendedStackSelection, BaseStackAssembly } from '../../aws-cdk';
 import { ToolkitError } from '../../shared-public';
 import type { StackSelector } from '../stack-selector';
 import { ExpandStackSelection, StackSelectionStrategy } from '../stack-selector';
@@ -9,7 +9,7 @@ import type { ICloudAssemblySource } from '../types';
 /**
  * A single Cloud Assembly wrapped to provide additional stack operations.
  */
-export class StackAssembly extends CloudAssembly implements ICloudAssemblySource {
+export class StackAssembly extends BaseStackAssembly implements ICloudAssemblySource {
   public async produce(): Promise<cxapi.CloudAssembly> {
     return this.assembly;
   }
@@ -29,7 +29,7 @@ export class StackAssembly extends CloudAssembly implements ICloudAssemblySource
     }
 
     const extend = expandToExtendEnum(selector.expand);
-    const patterns = sanitizePatterns(selector.patterns ?? []);
+    const patterns = StackAssembly.sanitizePatterns(selector.patterns ?? []);
 
     switch (selector.strategy) {
       case StackSelectionStrategy.ALL_STACKS:
@@ -43,7 +43,7 @@ export class StackAssembly extends CloudAssembly implements ICloudAssemblySource
       case StackSelectionStrategy.ONLY_SINGLE:
         if (topLevelStacks.length !== 1) {
           // @todo text should probably be handled in io host
-          throw new ToolkitError('Since this app includes more than a single stack, specify which stacks to use (wildcards are supported) or specify `--all`\n' +
+          throw new ToolkitError('Since this app includes more than a single stack, specsify which stacks to use (wildcards are supported) or specify `--all`\n' +
           `Stacks: ${allStacks.map(x => x.hierarchicalId).join(' · ')}`);
         }
         return new StackCollection(this, topLevelStacks);
diff --git a/packages/@aws-cdk/toolkit-lib/lib/api/shared-public.ts b/packages/@aws-cdk/toolkit-lib/lib/api/shared-public.ts
@@ -1,3 +1,17 @@
 /* eslint-disable import/no-restricted-paths */
 
-export * from '../../../tmp-toolkit-helpers/src/api';
+export {
+  ToolkitError,
+  AssemblyError,
+  StackSelector,
+  ExpandStackSelection,
+  StackSelectionStrategy,
+  IoMessageLevel,
+  IoMessageCode,
+  IIoHost,
+  IoMessage,
+  IoRequest,
+  ToolkitAction,
+} from '../../../tmp-toolkit-helpers/src/api';
+
+export * from '../../../tmp-toolkit-helpers/src/payloads';
diff --git a/packages/@aws-cdk/toolkit-lib/lib/toolkit/index.ts b/packages/@aws-cdk/toolkit-lib/lib/toolkit/index.ts
@@ -1,3 +1,2 @@
 export * from './toolkit';
 export * from './non-interactive-io-host';
-export * from '../api/shared-public';
diff --git a/packages/@aws-cdk/toolkit-lib/lib/toolkit/non-interactive-io-host.ts b/packages/@aws-cdk/toolkit-lib/lib/toolkit/non-interactive-io-host.ts
@@ -1,7 +1,7 @@
 import * as chalk from 'chalk';
+import type { IIoHost, IoMessage, IoMessageLevel, IoRequest } from '../api/io';
 import type { IActivityPrinter } from '../api/shared-private';
 import { HistoryActivityPrinter, isMessageRelevantForLevel } from '../api/shared-private';
-import type { IIoHost, IoMessage, IoMessageLevel, IoRequest } from '../api/shared-public';
 import { isCI, isTTY } from '../util/shell-env';
 
 export interface NonInteractiveIoHostProps {
diff --git a/packages/@aws-cdk/toolkit-lib/lib/toolkit/toolkit.ts b/packages/@aws-cdk/toolkit-lib/lib/toolkit/toolkit.ts
@@ -22,17 +22,15 @@ import type { WatchOptions } from '../actions/watch';
 import { patternsArrayForWatch } from '../actions/watch/private';
 import { type SdkConfig } from '../api/aws-auth';
 import type { SuccessfulDeployStackResult, StackCollection, Concurrency, AssetBuildNode, AssetPublishNode, StackNode } from '../api/aws-cdk';
-import { DEFAULT_TOOLKIT_STACK_NAME, Bootstrapper, SdkProvider, Deployments, HotswapMode, ResourceMigrator, tagsForStack, WorkGraphBuilder, CloudWatchLogEventMonitor, findCloudWatchLogGroups, createDiffChangeSet } from '../api/aws-cdk';
+import { DEFAULT_TOOLKIT_STACK_NAME, Bootstrapper, SdkProvider, Deployments, HotswapMode, ResourceMigrator, tagsForStack, WorkGraphBuilder, CloudWatchLogEventMonitor, findCloudWatchLogGroups, createDiffChangeSet, DiffFormatter, RequireApproval, ToolkitError, removeNonImportResources } from '../api/aws-cdk';
 import type { ICloudAssemblySource } from '../api/cloud-assembly';
 import { StackSelectionStrategy } from '../api/cloud-assembly';
 import type { StackAssembly } from '../api/cloud-assembly/private';
 import { ALL_STACKS, CloudAssemblySourceBuilder, IdentityCloudAssemblySource } from '../api/cloud-assembly/private';
 import type { IIoHost, IoMessageLevel } from '../api/io';
 import { IO, SPAN, asSdkLogger, withoutColor, withoutEmojis, withTrimmedWhitespace } from '../api/io/private';
-import type { IoHelper } from '../api/shared-private';
-import { asIoHelper } from '../api/shared-private';
+import { asIoHelper, type IoHelper } from '../api/shared-private';
 import type { AssemblyData, StackDetails, ToolkitAction } from '../api/shared-public';
-import { DiffFormatter, RequireApproval, ToolkitError, removeNonImportResources } from '../api/shared-public';
 import { obscureTemplate, serializeStructure, validateSnsTopicArn, formatTime, formatErrorMessage, deserializeStructure } from '../private/util';
 import { pLimit } from '../util/concurrency';
 
diff --git a/packages/@aws-cdk/toolkit-lib/package.json b/packages/@aws-cdk/toolkit-lib/package.json
diff --git a/packages/aws-cdk/jest.config.json b/packages/aws-cdk/jest.config.json
diff --git a/packages/aws-cdk/lib/cxapp/cloud-assembly.ts b/packages/aws-cdk/lib/cxapp/cloud-assembly.ts
@@ -1,10 +1,7 @@
 import type * as cxapi from '@aws-cdk/cx-api';
-import * as chalk from 'chalk';
 import { minimatch } from 'minimatch';
 import * as semver from 'semver';
-import { StackCollection, ToolkitError } from '../api';
-import type { IStackAssembly } from '../api';
-import { IO, type IoHelper } from '../api-private';
+import { BaseStackAssembly, StackCollection, ToolkitError } from '../api';
 import { flatten } from '../util';
 
 export enum DefaultSelection {
@@ -90,25 +87,13 @@ export interface StackSelector {
 /**
  * A single Cloud Assembly and the operations we do on it to deploy the artifacts inside
  */
-export class CloudAssembly implements IStackAssembly {
-  /**
-   * The directory this CloudAssembly was read from
-   */
-  public readonly directory: string;
-
-  private readonly ioHelper: IoHelper;
-
-  constructor(public readonly assembly: cxapi.CloudAssembly, ioHelper: IoHelper) {
-    this.directory = assembly.directory;
-    this.ioHelper = ioHelper;
-  }
-
+export class CloudAssembly extends BaseStackAssembly {
   public async selectStacks(selector: StackSelector, options: SelectStacksOptions): Promise<StackCollection> {
     const asm = this.assembly;
     const topLevelStacks = asm.stacks;
     const stacks = semver.major(asm.version) < 10 ? asm.stacks : asm.stacksRecursively;
     const allTopLevel = selector.allTopLevel ?? false;
-    const patterns = sanitizePatterns(selector.patterns);
+    const patterns = CloudAssembly.sanitizePatterns(selector.patterns);
 
     if (stacks.length === 0) {
       if (options.ignoreNoStacks) {
@@ -172,140 +157,4 @@ export class CloudAssembly implements IStackAssembly {
         throw new ToolkitError(`invalid default behavior: ${defaultSelection}`);
     }
   }
-
-  protected async extendStacks(
-    matched: cxapi.CloudFormationStackArtifact[],
-    all: cxapi.CloudFormationStackArtifact[],
-    extend: ExtendedStackSelection = ExtendedStackSelection.None,
-  ) {
-    const allStacks = new Map<string, cxapi.CloudFormationStackArtifact>();
-    for (const stack of all) {
-      allStacks.set(stack.hierarchicalId, stack);
-    }
-
-    const index = indexByHierarchicalId(matched);
-
-    switch (extend) {
-      case ExtendedStackSelection.Downstream:
-        await includeDownstreamStacks(this.ioHelper, index, allStacks);
-        break;
-      case ExtendedStackSelection.Upstream:
-        await includeUpstreamStacks(this.ioHelper, index, allStacks);
-        break;
-    }
-
-    // Filter original array because it is in the right order
-    const selectedList = all.filter(s => index.has(s.hierarchicalId));
-
-    return new StackCollection(this, selectedList);
-  }
-
-  /**
-   * Select a single stack by its ID
-   */
-  public stackById(stackId: string) {
-    return new StackCollection(this, [this.assembly.getStackArtifact(stackId)]);
-  }
-}
-
-export interface MetadataMessageOptions {
-  /**
-   * Whether to be verbose
-   *
-   * @default false
-   */
-  verbose?: boolean;
-
-  /**
-   * Don't stop on error metadata
-   *
-   * @default false
-   */
-  ignoreErrors?: boolean;
-
-  /**
-   * Treat warnings in metadata as errors
-   *
-   * @default false
-   */
-  strict?: boolean;
-}
-
-function indexByHierarchicalId(stacks: cxapi.CloudFormationStackArtifact[]): Map<string, cxapi.CloudFormationStackArtifact> {
-  const result = new Map<string, cxapi.CloudFormationStackArtifact>();
-
-  for (const stack of stacks) {
-    result.set(stack.hierarchicalId, stack);
-  }
-
-  return result;
-}
-
-/**
- * Calculate the transitive closure of stack dependents.
- *
- * Modifies `selectedStacks` in-place.
- */
-async function includeDownstreamStacks(
-  ioHelper: IoHelper,
-  selectedStacks: Map<string, cxapi.CloudFormationStackArtifact>,
-  allStacks: Map<string, cxapi.CloudFormationStackArtifact>,
-) {
-  const added = new Array<string>();
-
-  let madeProgress;
-  do {
-    madeProgress = false;
-
-    for (const [id, stack] of allStacks) {
-      // Select this stack if it's not selected yet AND it depends on a stack that's in the selected set
-      if (!selectedStacks.has(id) && (stack.dependencies || []).some(dep => selectedStacks.has(dep.id))) {
-        selectedStacks.set(id, stack);
-        added.push(id);
-        madeProgress = true;
-      }
-    }
-  } while (madeProgress);
-
-  if (added.length > 0) {
-    await ioHelper.notify(IO.DEFAULT_ASSEMBLY_INFO.msg(`Including depending stacks: ${chalk.bold(added.join(', '))}`));
-  }
-}
-
-/**
- * Calculate the transitive closure of stack dependencies.
- *
- * Modifies `selectedStacks` in-place.
- */
-async function includeUpstreamStacks(
-  ioHelper: IoHelper,
-  selectedStacks: Map<string, cxapi.CloudFormationStackArtifact>,
-  allStacks: Map<string, cxapi.CloudFormationStackArtifact>,
-) {
-  const added = new Array<string>();
-  let madeProgress = true;
-  while (madeProgress) {
-    madeProgress = false;
-
-    for (const stack of selectedStacks.values()) {
-      // Select an additional stack if it's not selected yet and a dependency of a selected stack (and exists, obviously)
-      for (const dependencyId of stack.dependencies.map(x => x.manifest.displayName ?? x.id)) {
-        if (!selectedStacks.has(dependencyId) && allStacks.has(dependencyId)) {
-          added.push(dependencyId);
-          selectedStacks.set(dependencyId, allStacks.get(dependencyId)!);
-          madeProgress = true;
-        }
-      }
-    }
-  }
-
-  if (added.length > 0) {
-    await ioHelper.notify(IO.DEFAULT_ASSEMBLY_INFO.msg(`Including dependency stacks: ${chalk.bold(added.join(', '))}`));
-  }
-}
-
-export function sanitizePatterns(patterns: string[]): string[] {
-  let sanitized = patterns.filter(s => s != null); // filter null/undefined
-  sanitized = [...new Set(sanitized)]; // make them unique
-  return sanitized;
 }
diff --git a/packages/aws-cdk/lib/cxapp/exec.ts b/packages/aws-cdk/lib/cxapp/exec.ts

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,2 @@`
`1`	`1`	`export * from './toolkit';`
`2`	`2`	`export * from './non-interactive-io-host';`
`3`		`-export * from '../api/shared-public';`