Replace CreateChangeSet parameter CompareWith with DeploymentMode (#233)

Author: atennak1

src/cfnEnvironments/CfnEnvironmentRequestType.ts

@@ -1,6 +1,7 @@
 import { OnStackFailure } from '@aws-sdk/client-cloudformation';
 import { RequestType } from 'vscode-languageserver';
 import { DocumentType } from '../document/Document';
+import { DeploymentMode } from '../stacks/actions/StackActionRequestType';
 
 export type DocumentInfo = {
     type: DocumentType;
@@ -15,6 +16,7 @@ export type DeploymentConfig = {
     includeNestedStacks?: boolean;
     importExistingResources?: boolean;
     onStackFailure?: OnStackFailure;
+    deploymentMode?: DeploymentMode;
 };
 
 export type ParsedCfnEnvironmentFile = {

src/services/CfnService.ts

@@ -55,8 +55,10 @@ import {
     waitUntilStackDeleteComplete,
     Tag,
     OnStackFailure,
+    ChangeSetType,
 } from '@aws-sdk/client-cloudformation';
 import { WaiterConfiguration, WaiterResult } from '@smithy/util-waiter';
+import { DeploymentMode } from '../stacks/actions/StackActionRequestType';
 import { Count } from '../telemetry/TelemetryDecorator';
 import { AwsClient } from './AwsClient';
 
@@ -126,13 +128,13 @@ export class CfnService {
         TemplateURL?: string;
         Parameters?: Parameter[];
         Capabilities?: Capability[];
-        ChangeSetType?: 'CREATE' | 'UPDATE' | 'IMPORT';
+        ChangeSetType?: ChangeSetType;
         ResourcesToImport?: ResourceToImport[];
-        CompareWith?: string;
         OnStackFailure?: OnStackFailure;
         IncludeNestedStacks?: boolean;
         Tags?: Tag[];
         ImportExistingResources?: boolean;
+        DeploymentMode?: DeploymentMode;
     }): Promise<CreateChangeSetCommandOutput> {
         return await this.withClient((client) => client.send(new CreateChangeSetCommand(params)));
     }

src/services/CfnServiceV2.ts

@@ -9,7 +9,9 @@ import {
     ResourceTargetDefinition,
     Change,
     ResourceChangeDetail,
+    ChangeSetType,
 } from '@aws-sdk/client-cloudformation';
+import { DeploymentMode } from '../stacks/actions/StackActionRequestType';
 import { Measure } from '../telemetry/TelemetryDecorator';
 import { CFN_CLIENT_PATH } from '../utils/ClientUtil';
 import { DynamicModuleLoader } from '../utils/DynamicModuleLoader';
@@ -65,9 +67,9 @@ export class CfnServiceV2 extends CfnService {
         TemplateURL?: string;
         Parameters?: Parameter[];
         Capabilities?: Capability[];
-        ChangeSetType?: 'CREATE' | 'UPDATE' | 'IMPORT';
+        ChangeSetType?: ChangeSetType;
         ResourcesToImport?: ResourceToImport[];
-        CompareWith?: string;
+        DeploymentMode?: DeploymentMode;
     }): Promise<CreateChangeSetCommandOutput> {
         type CfnClient = typeof import('@aws-sdk/client-cloudformation') & {
             CreateChangeSetCommand: new (input: any) => any;

src/stacks/actions/StackActionOperations.ts

@@ -1,4 +1,4 @@
-import { Change, ChangeSetType, StackStatus } from '@aws-sdk/client-cloudformation';
+import { Change, ChangeSetType, StackStatus, OnStackFailure } from '@aws-sdk/client-cloudformation';
 import { WaiterState } from '@smithy/util-waiter';
 import { dump } from 'js-yaml';
 import { DateTime } from 'luxon';
@@ -24,6 +24,8 @@ import {
     StackActionState,
     CreateValidationParams,
     ValidationDetail,
+    DeploymentMode,
+    ResourceToImport,
 } from './StackActionRequestType';
 import {
     StackActionWorkflowState,
@@ -39,6 +41,43 @@ function logCleanupError(error: unknown, workflowId: string, changeSetName: stri
     logger.warn(error, `Failed to cleanup ${operation} ${workflowId} ${changeSetName}`);
 }
 
+export function computeEligibleDeploymentMode(
+    changeSetType: ChangeSetType,
+    deploymentMode?: DeploymentMode,
+    importExistingResources?: boolean,
+    resourcesToImport?: ResourceToImport[],
+    includeNestedStacks?: boolean,
+    onStackFailure?: OnStackFailure,
+): DeploymentMode | undefined {
+    if (!deploymentMode) {
+        return undefined;
+    }
+
+    if (deploymentMode === DeploymentMode.REVERT_DRIFT) {
+        // import is not supported
+        if (importExistingResources || (resourcesToImport && resourcesToImport.length > 0)) {
+            return undefined;
+        }
+
+        // nested stacks is not supported
+        if (includeNestedStacks) {
+            return undefined;
+        }
+
+        // only UPDATE is supported
+        if (changeSetType !== ChangeSetType.UPDATE) {
+            return undefined;
+        }
+
+        // only ROLLBACK is supported
+        if (onStackFailure && onStackFailure !== OnStackFailure.ROLLBACK) {
+            return undefined;
+        }
+    }
+
+    return deploymentMode;
+}
+
 export async function processChangeSet(
     cfnService: CfnService,
     documentManager: DocumentManager,
@@ -77,6 +116,15 @@ export async function processChangeSet(
 
     const changeSetName = `${changeSetNamePrefix}-${params.id}-${uuidv4()}`;
 
+    const deploymentMode = computeEligibleDeploymentMode(
+        changeSetType,
+        params.deploymentMode,
+        params.importExistingResources,
+        params.resourcesToImport,
+        params.includeNestedStacks,
+        params.onStackFailure,
+    );
+
     await cfnService.createChangeSet({
         StackName: params.stackName,
         ChangeSetName: changeSetName,
@@ -86,11 +134,11 @@ export async function processChangeSet(
         Capabilities: params.capabilities,
         ChangeSetType: changeSetType,
         ResourcesToImport: params.resourcesToImport,
-        CompareWith: changeSetType === 'UPDATE' ? 'LIVE_STATE' : undefined,
         OnStackFailure: params.onStackFailure,
         IncludeNestedStacks: params.includeNestedStacks,
         Tags: params.tags,
         ImportExistingResources: params.importExistingResources,
+        DeploymentMode: deploymentMode,
     });
 
     return changeSetName;

src/stacks/actions/StackActionParser.ts

@@ -11,6 +11,7 @@ import {
     CreateDeploymentParams,
     CreateValidationParams,
     DeleteChangeSetParams,
+    DeploymentMode,
     TemplateUri,
 } from './StackActionRequestType';
 
@@ -40,6 +41,8 @@ const ResourceToImportSchema = z.object({
     ResourceIdentifier: z.record(z.string(), z.string()),
 });
 
+const DeploymentModeSchema = z.enum([DeploymentMode.REVERT_DRIFT]);
+
 const CreateValidationParamsSchema = z.object({
     id: z.string().min(1),
     uri: z.string().min(1),
@@ -52,6 +55,7 @@ const CreateValidationParamsSchema = z.object({
     includeNestedStacks: z.boolean().optional(),
     tags: z.array(TagSchema).optional(),
     importExistingResources: z.boolean().optional(),
+    deploymentMode: DeploymentModeSchema.optional(),
     s3Bucket: z.string().optional(),
     s3Key: z.string().optional(),
 });

src/stacks/actions/StackActionRequestType.ts

@@ -17,6 +17,10 @@ export type ResourceToImport = {
     ResourceIdentifier: Record<string, string>;
 };
 
+export enum DeploymentMode {
+    REVERT_DRIFT = 'REVERT_DRIFT',
+}
+
 export type CreateValidationParams = Identifiable & {
     uri: string;
     stackName: string;
@@ -28,6 +32,7 @@ export type CreateValidationParams = Identifiable & {
     includeNestedStacks?: boolean;
     tags?: Tag[];
     importExistingResources?: boolean;
+    deploymentMode?: DeploymentMode;
     s3Bucket?: string;
     s3Key?: string;
 };

src/stacks/actions/ValidationWorkflowV2.ts

@@ -8,7 +8,6 @@ import { CfnInfraCore } from '../../server/CfnInfraCore';
 import { CfnServiceV2 } from '../../services/CfnServiceV2';
 import { DiagnosticCoordinator } from '../../services/DiagnosticCoordinator';
 import { S3Service } from '../../services/S3Service';
-import { LoggerFactory } from '../../telemetry/LoggerFactory';
 import { extractErrorMessage } from '../../utils/Errors';
 import {
     waitForChangeSetValidation,
@@ -23,8 +22,6 @@ import { ValidationWorkflow } from './ValidationWorkflow';
 export const VALIDATION_V2_NAME = 'Enhanced Validation';
 
 export class ValidationWorkflowV2 extends ValidationWorkflow {
-    protected override readonly log = LoggerFactory.getLogger(ValidationWorkflowV2);
-
     constructor(
         protected cfnServiceV2: CfnServiceV2,
         documentManager: DocumentManager,

tst/unit/stackActions/StackActionWorkflowOperations.test.ts

@@ -1,4 +1,4 @@
-import { Change, ChangeSetType, StackStatus } from '@aws-sdk/client-cloudformation';
+import { Change, ChangeSetType, StackStatus, OnStackFailure } from '@aws-sdk/client-cloudformation';
 import { WaiterState } from '@smithy/util-waiter';
 import { DateTime } from 'luxon';
 import { stubInterface } from 'ts-sinon';
@@ -18,12 +18,14 @@ import {
     parseValidationEvents,
     publishValidationDiagnostics,
     isStackInReview,
+    computeEligibleDeploymentMode,
 } from '../../../src/stacks/actions/StackActionOperations';
 import {
     CreateValidationParams,
     StackActionPhase,
     StackActionState,
     ValidationDetail,
+    DeploymentMode,
 } from '../../../src/stacks/actions/StackActionRequestType';
 import { StackActionWorkflowState } from '../../../src/stacks/actions/StackActionWorkflowType';
 import { ExtensionName } from '../../../src/utils/ExtensionConfig';
@@ -578,4 +580,63 @@ describe('StackActionWorkflowOperations', () => {
             expect(result).toBe(true);
         });
     });
+
+    describe('computeEligibleDeploymentMode', () => {
+        it('should return undefined when deploymentMode is not provided', () => {
+            const result = computeEligibleDeploymentMode(ChangeSetType.UPDATE, undefined);
+            expect(result).toBeUndefined();
+        });
+
+        it('should return deploymentMode when all conditions are met for REVERT_DRIFT', () => {
+            const result = computeEligibleDeploymentMode(
+                ChangeSetType.UPDATE,
+                DeploymentMode.REVERT_DRIFT,
+                false,
+                undefined,
+                false,
+                OnStackFailure.ROLLBACK,
+            );
+            expect(result).toBe(DeploymentMode.REVERT_DRIFT);
+        });
+
+        it('should return undefined when changeSetType is CREATE', () => {
+            const result = computeEligibleDeploymentMode(ChangeSetType.CREATE, DeploymentMode.REVERT_DRIFT);
+            expect(result).toBeUndefined();
+        });
+
+        it('should return undefined when importExistingResources is true', () => {
+            const result = computeEligibleDeploymentMode(ChangeSetType.UPDATE, DeploymentMode.REVERT_DRIFT, true);
+            expect(result).toBeUndefined();
+        });
+
+        it('should return undefined when resourcesToImport has items', () => {
+            const result = computeEligibleDeploymentMode(ChangeSetType.UPDATE, DeploymentMode.REVERT_DRIFT, false, [
+                { LogicalResourceId: 'test', ResourceType: 'AWS::S3::Bucket', ResourceIdentifier: {} },
+            ]);
+            expect(result).toBeUndefined();
+        });
+
+        it('should return undefined when includeNestedStacks is true', () => {
+            const result = computeEligibleDeploymentMode(
+                ChangeSetType.UPDATE,
+                DeploymentMode.REVERT_DRIFT,
+                false,
+                undefined,
+                true,
+            );
+            expect(result).toBeUndefined();
+        });
+
+        it('should return undefined when onStackFailure is DO_NOTHING', () => {
+            const result = computeEligibleDeploymentMode(
+                ChangeSetType.UPDATE,
+                DeploymentMode.REVERT_DRIFT,
+                false,
+                undefined,
+                false,
+                OnStackFailure.DO_NOTHING,
+            );
+            expect(result).toBeUndefined();
+        });
+    });
 });