sst 2.14.0 → 2.16.0

package/cdk/deploy-stack.d.ts

@@ -2,6 +2,7 @@ import * as cxapi from "@aws-cdk/cx-api";
 import { Tag } from "sst-aws-cdk/lib/cdk-toolkit.js";
 import { AssetManifestBuilder } from "sst-aws-cdk/lib/util/asset-manifest-builder.js";
 import { ISDK, SdkProvider } from "sst-aws-cdk/lib/api/aws-auth/index.js";
+import { HotswapMode } from "sst-aws-cdk/lib/api/hotswap/common.js";
 import { ToolkitInfo } from "sst-aws-cdk/lib/api/toolkit-info.js";
 import { ResourcesToImport } from "sst-aws-cdk/lib/api/util/cloudformation.js";
 import { StackActivityProgress } from "sst-aws-cdk/lib/api/util/cloudformation/stack-activity-monitor.js";
@@ -142,7 +143,7 @@ export interface DeployStackOptions {
      * @default true
      */
     readonly rollback?: boolean;
-    readonly hotswap?: boolean;
+    readonly hotswap?: HotswapMode;
     /**
      * The extra string to append to the User-Agent header when performing AWS SDK calls.
      *

package/cdk/deploy-stack.js

@@ -8,6 +8,7 @@ import { AssetManifestBuilder } from "sst-aws-cdk/lib/util/asset-manifest-builde
 import { publishAssets } from "sst-aws-cdk/lib/util/asset-publishing.js";
 import { contentHash } from "sst-aws-cdk/lib/util/content-hash.js";
 import { CfnEvaluationException } from "sst-aws-cdk/lib/api/evaluate-cloudformation-template.js";
+import { HotswapMode } from "sst-aws-cdk/lib/api/hotswap/common.js";
 import { tryHotswapDeployment } from "sst-aws-cdk/lib/api/hotswap-deployments.js";
 import { changeSetHasNoChanges, CloudFormationStack, TemplateParameters, waitForChangeSet, waitForStackDeploy, waitForStackDelete, } from "sst-aws-cdk/lib/api/util/cloudformation.js";
 import { blue } from "colorette";
@@ -61,10 +62,11 @@ export async function deployStack(options) {
     await publishAssets(legacyAssets.toManifest(stackArtifact.assembly.directory), options.sdkProvider, stackEnv, {
         parallel: options.assetParallelism,
     });
-    if (options.hotswap) {
+    const hotswapMode = options.hotswap;
+    if (hotswapMode && hotswapMode !== HotswapMode.FULL_DEPLOYMENT) {
         // attempt to short-circuit the deployment if possible
         try {
-            const hotswapDeploymentResult = await tryHotswapDeployment(options.sdkProvider, assetParams, cloudFormationStack, stackArtifact);
+            const hotswapDeploymentResult = await tryHotswapDeployment(options.sdkProvider, stackParams.values, cloudFormationStack, stackArtifact, hotswapMode);
             if (hotswapDeploymentResult) {
                 return hotswapDeploymentResult;
             }
@@ -76,8 +78,17 @@ export async function deployStack(options) {
             }
             print("Could not perform a hotswap deployment, because the CloudFormation template could not be resolved: %s", e.message);
         }
-        print("Falling back to doing a full deployment");
-        options.sdk.appendCustomUserAgent("cdk-hotswap/fallback");
+        if (hotswapMode === HotswapMode.FALL_BACK) {
+            print("Falling back to doing a full deployment");
+            options.sdk.appendCustomUserAgent("cdk-hotswap/fallback");
+        }
+        else {
+            return {
+                noOp: true,
+                stackArn: cloudFormationStack.stackId,
+                outputs: cloudFormationStack.outputs,
+            };
+        }
     }
     // could not short-circuit the deployment, perform a full CFN deploy instead
     const fullDeployment = new FullCloudFormationDeployment(options, cloudFormationStack, stackArtifact, stackParams, bodyParameter);

package/cdk/{cloudformation-deployments-wrapper.d.ts → deployments-wrapper.d.ts}

@@ -1,3 +1,3 @@
 import { SdkProvider } from "sst-aws-cdk/lib/api/aws-auth/sdk-provider.js";
-import { DeployStackOptions as PublishStackAssetsOptions } from "./cloudformation-deployments.js";
+import { DeployStackOptions as PublishStackAssetsOptions } from "./deployments.js";
 export declare function publishDeployAssets(sdkProvider: SdkProvider, options: PublishStackAssetsOptions): Promise<any>;

package/cdk/{cloudformation-deployments-wrapper.js → deployments-wrapper.js}

@@ -1,21 +1,38 @@
+import * as cxapi from "@aws-cdk/cx-api";
+import { AssetManifest } from "cdk-assets";
 import { debug } from "sst-aws-cdk/lib/logging.js";
 import { CloudFormationStack, TemplateParameters, waitForStackDelete, } from "sst-aws-cdk/lib/api/util/cloudformation.js";
+import { Mode } from "sst-aws-cdk/lib/api/aws-auth/credentials.js";
 import { ToolkitInfo } from "sst-aws-cdk/lib/api/toolkit-info.js";
 import { addMetadataAssetsToManifest } from "sst-aws-cdk/lib/assets.js";
 import { publishAssets } from "sst-aws-cdk/lib/util/asset-publishing.js";
 import { AssetManifestBuilder } from "sst-aws-cdk/lib/util/asset-manifest-builder.js";
-import { CloudFormationDeployments, } from "./cloudformation-deployments.js";
+import { Deployments, } from "./deployments.js";
 import { makeBodyParameter } from "./deploy-stack.js";
 import { Context } from "../context/context.js";
 export async function publishDeployAssets(sdkProvider, options) {
     const { deployment, toolkitInfo, stackSdk, resolvedEnvironment, cloudFormationRoleArn, } = await useDeployment().get(sdkProvider, options);
-    await deployment.publishStackAssets(options.stack, toolkitInfo, {
-        buildAssets: options.buildAssets ?? true,
-        publishOptions: {
+    // TODO
+    // old
+    //await deployment.publishStackAssets(options.stack, toolkitInfo, {
+    //  buildAssets: options.buildAssets ?? true,
+    //  publishOptions: {
+    //    quiet: options.quiet,
+    //    parallel: options.assetParallelism,
+    //  },
+    //});
+    // new
+    const assetArtifacts = options.stack.dependencies.filter(cxapi.AssetManifestArtifact.isAssetManifestArtifact);
+    for (const asset of assetArtifacts) {
+        const manifest = AssetManifest.fromFile(asset.file);
+        //await buildAssets(manifest, sdkProvider, resolvedEnvironment, {
+        //});
+        await publishAssets(manifest, sdkProvider, resolvedEnvironment, {
+            buildAssets: true,
             quiet: options.quiet,
             parallel: options.assetParallelism,
-        },
-    });
+        });
+    }
     return deployStack({
         stack: options.stack,
         noMonitor: true,
@@ -49,8 +66,8 @@ const useDeployment = Context.memo(() => {
         async get(sdkProvider, options) {
             const region = options.stack.environment.region;
             if (!state.has(region)) {
-                const deployment = new CloudFormationDeployments({ sdkProvider });
-                const { stackSdk, resolvedEnvironment, cloudFormationRoleArn } = await deployment.prepareSdkFor(options.stack, options.roleArn);
+                const deployment = new Deployments({ sdkProvider });
+                const { stackSdk, resolvedEnvironment, cloudFormationRoleArn } = await deployment.prepareSdkFor(options.stack, options.roleArn, Mode.ForWriting);
                 const toolkitInfo = await ToolkitInfo.lookup(resolvedEnvironment, stackSdk, options.toolkitStackName);
                 // Do a verification of the bootstrap stack version
                 await deployment.validateBootstrapStackVersion(options.stack.stackName, options.stack.requiresBootstrapStackVersion, options.stack.bootstrapStackVersionSsmParameter, toolkitInfo);

package/cdk/{cloudformation-deployments.d.ts → deployments.d.ts}

@@ -1,4 +1,5 @@
 import * as cxapi from "@aws-cdk/cx-api";
+import { AssetManifest, IManifestEntry } from "cdk-assets";
 import { Tag } from "sst-aws-cdk/lib/cdk-toolkit.js";
 import { BuildAssetsOptions, PublishAssetsOptions } from "sst-aws-cdk/lib/util/asset-publishing.js";
 import { Mode } from "sst-aws-cdk/lib/api/aws-auth/credentials.js";
@@ -8,6 +9,7 @@ import { DeployStackResult, DeploymentMethod } from "./deploy-stack.js";
 import { ToolkitInfo } from "sst-aws-cdk/lib/api/toolkit-info.js";
 import { Template, ResourcesToImport, ResourceIdentifierSummaries } from "sst-aws-cdk/lib/api/util/cloudformation.js";
 import { StackActivityProgress } from "sst-aws-cdk/lib/api/util/cloudformation/stack-activity-monitor.js";
+import { HotswapMode } from "sst-aws-cdk/lib/api/hotswap/common.js";
 /**
  * SDK obtained by assuming the lookup role
  * for a given environment
@@ -30,25 +32,6 @@ export interface PreparedSdkWithLookupRoleForEnvironment {
      */
     readonly didAssumeRole: boolean;
 }
-/**
- * Try to use the bootstrap lookupRole. There are two scenarios that are handled here
- *  1. The lookup role may not exist (it was added in bootstrap stack version 7)
- *  2. The lookup role may not have the correct permissions (ReadOnlyAccess was added in
- *      bootstrap stack version 8)
- *
- * In the case of 1 (lookup role doesn't exist) `forEnvironment` will either:
- *   1. Return the default credentials if the default credentials are for the stack account
- *   2. Throw an error if the default credentials are not for the stack account.
- *
- * If we successfully assume the lookup role we then proceed to 2 and check whether the bootstrap
- * stack version is valid. If it is not we throw an error which should be handled in the calling
- * function (and fallback to use a different role, etc)
- *
- * If we do not successfully assume the lookup role, but do get back the default credentials
- * then return those and note that we are returning the default credentials. The calling
- * function can then decide to use them or fallback to another role.
- */
-export declare function prepareSdkWithLookupRoleFor(sdkProvider: SdkProvider, stack: cxapi.CloudFormationStackArtifact): Promise<PreparedSdkWithLookupRoleForEnvironment>;
 export interface DeployStackOptions {
     /**
      * Stack to deploy
@@ -153,7 +136,7 @@ export interface DeployStackOptions {
      * @default true
      */
     readonly rollback?: boolean;
-    readonly hotswap?: boolean;
+    readonly hotswap?: HotswapMode;
     /**
      * The extra string to append to the User-Agent header when performing AWS SDK calls.
      *
@@ -170,12 +153,6 @@ export interface DeployStackOptions {
      * @default - Use the stored template
      */
     readonly overrideTemplate?: any;
-    /**
-     * Whether to build assets before publishing.
-     *
-     * @default true To remain backward compatible.
-     */
-    readonly buildAssets?: boolean;
     /**
      * Whether to build/publish assets in parallel
      *
@@ -183,7 +160,7 @@ export interface DeployStackOptions {
      */
     readonly assetParallelism?: boolean;
 }
-export interface BuildStackAssetsOptions {
+interface AssetOptions {
     /**
      * Stack with assets to build.
      */
@@ -200,22 +177,26 @@ export interface BuildStackAssetsOptions {
      * @default - Current role
      */
     readonly roleArn?: string;
+}
+export interface BuildStackAssetsOptions extends AssetOptions {
     /**
      * Options to pass on to `buildAsests()` function
      */
     readonly buildOptions?: BuildAssetsOptions;
-}
-interface PublishStackAssetsOptions {
     /**
-     * Whether to build assets before publishing.
-     *
-     * @default true To remain backward compatible.
+     * Stack name this asset is for
      */
-    readonly buildAssets?: boolean;
+    readonly stackName?: string;
+}
+interface PublishStackAssetsOptions extends AssetOptions {
     /**
      * Options to pass on to `publishAsests()` function
      */
     readonly publishOptions?: Omit<PublishAssetsOptions, "buildAssets">;
+    /**
+     * Stack name this asset is for
+     */
+    readonly stackName?: string;
 }
 export interface DestroyStackOptions {
     stack: cxapi.CloudFormationStackArtifact;
@@ -229,8 +210,9 @@ export interface StackExistsOptions {
     stack: cxapi.CloudFormationStackArtifact;
     deployName?: string;
 }
-export interface ProvisionerProps {
+export interface DeploymentsProps {
     sdkProvider: SdkProvider;
+    readonly quiet?: boolean;
 }
 /**
  * SDK obtained by assuming the deploy role
@@ -254,14 +236,17 @@ export interface PreparedSdkForEnvironment {
     readonly cloudFormationRoleArn?: string;
 }
 /**
- * Helper class for CloudFormation deployments
+ * Scope for a single set of deployments from a set of Cloud Assembly Artifacts
  *
- * Looks us the right SDK and Bootstrap stack to deploy a given
- * stack artifact.
+ * Manages lookup of SDKs, Bootstrap stacks, etc.
  */
-export declare class CloudFormationDeployments {
+export declare class Deployments {
+    private readonly props;
     private readonly sdkProvider;
-    constructor(props: ProvisionerProps);
+    private readonly toolkitInfoCache;
+    private readonly sdkCache;
+    private readonly publisherCache;
+    constructor(props: DeploymentsProps);
     readCurrentTemplateWithNestedStacks(rootStackArtifact: cxapi.CloudFormationStackArtifact, retrieveProcessedTemplate?: boolean): Promise<Template>;
     readCurrentTemplate(stackArtifact: cxapi.CloudFormationStackArtifact): Promise<Template>;
     resourceIdentifierSummaries(stackArtifact: cxapi.CloudFormationStackArtifact, toolkitStackName?: string): Promise<ResourceIdentifierSummaries>;
@@ -278,18 +263,65 @@ export declare class CloudFormationDeployments {
      * - SDK loaded with the right credentials for calling `CreateChangeSet`.
      * - The Execution Role that should be passed to CloudFormation.
      */
-    prepareSdkFor(stack: cxapi.CloudFormationStackArtifact, roleArn?: string, mode?: Mode): Promise<PreparedSdkForEnvironment>;
+    prepareSdkFor(stack: cxapi.CloudFormationStackArtifact, roleArn: string | undefined, mode: Mode): Promise<PreparedSdkForEnvironment>;
     /**
-     * Build a stack's assets.
+     * Try to use the bootstrap lookupRole. There are two scenarios that are handled here
+     *  1. The lookup role may not exist (it was added in bootstrap stack version 7)
+     *  2. The lookup role may not have the correct permissions (ReadOnlyAccess was added in
+     *      bootstrap stack version 8)
+     *
+     * In the case of 1 (lookup role doesn't exist) `forEnvironment` will either:
+     *   1. Return the default credentials if the default credentials are for the stack account
+     *   2. Throw an error if the default credentials are not for the stack account.
+     *
+     * If we successfully assume the lookup role we then proceed to 2 and check whether the bootstrap
+     * stack version is valid. If it is not we throw an error which should be handled in the calling
+     * function (and fallback to use a different role, etc)
+     *
+     * If we do not successfully assume the lookup role, but do get back the default credentials
+     * then return those and note that we are returning the default credentials. The calling
+     * function can then decide to use them or fallback to another role.
      */
-    buildStackAssets(options: BuildStackAssetsOptions): Promise<void>;
+    prepareSdkWithLookupRoleFor(stack: cxapi.CloudFormationStackArtifact): Promise<PreparedSdkWithLookupRoleForEnvironment>;
     /**
-     * Publish all asset manifests that are referenced by the given stack
+     * Look up the toolkit for a given environment, using a given SDK
+     */
+    lookupToolkit(resolvedEnvironment: cxapi.Environment, sdk: ISDK, toolkitStackName?: string): Promise<ToolkitInfo>;
+    private prepareAndValidateAssets;
+    /**
+     * Build all assets in a manifest
+     *
+     * @deprecated Use `buildSingleAsset` instead
      */
-    publishStackAssets(stack: cxapi.CloudFormationStackArtifact, toolkitInfo: ToolkitInfo, options?: PublishStackAssetsOptions): Promise<void>;
+    buildAssets(asset: cxapi.AssetManifestArtifact, options: BuildStackAssetsOptions): Promise<void>;
+    /**
+     * Publish all assets in a manifest
+     *
+     * @deprecated Use `publishSingleAsset` instead
+     */
+    publishAssets(asset: cxapi.AssetManifestArtifact, options: PublishStackAssetsOptions): Promise<void>;
+    /**
+     * Build a single asset from an asset manifest
+     */
+    buildSingleAsset(assetArtifact: cxapi.AssetManifestArtifact, assetManifest: AssetManifest, asset: IManifestEntry, options: BuildStackAssetsOptions): Promise<void>;
+    /**
+     * Publish a single asset from an asset manifest
+     */
+    publishSingleAsset(assetManifest: AssetManifest, asset: IManifestEntry, options: PublishStackAssetsOptions): Promise<void>;
+    /**
+     * Return whether a single asset has been published already
+     */
+    isSingleAssetPublished(assetManifest: AssetManifest, asset: IManifestEntry, options: PublishStackAssetsOptions): Promise<boolean>;
     /**
      * Validate that the bootstrap stack has the right version for this stack
      */
     validateBootstrapStackVersion(stackName: string, requiresBootstrapStackVersion: number | undefined, bootstrapStackVersionSsmParameter: string | undefined, toolkitInfo: ToolkitInfo): Promise<void>;
+    private cachedSdkForEnvironment;
+    private cachedPublisher;
+}
+/**
+ * @deprecated Use 'Deployments' instead
+ */
+export declare class CloudFormationDeployments extends Deployments {
 }
 export {};