Modify getStackOutputs to be more centralized describeStack (#196)

Author: chrisqm-dev

src/handlers/StackHandler.ts

@@ -16,7 +16,7 @@ import {
     parseTemplateUriParams,
     parseGetStackEventsParams,
     parseClearStackEventsParams,
-    parseGetStackOutputsParams,
+    parseDescribeStackParams,
 } from '../stacks/actions/StackActionParser';
 import {
     TemplateUri,
@@ -42,8 +42,8 @@ import {
     GetStackEventsParams,
     GetStackEventsResult,
     ClearStackEventsParams,
-    GetStackOutputsParams,
-    GetStackOutputsResult,
+    DescribeStackParams,
+    DescribeStackResult,
     DescribeChangeSetParams,
     DescribeChangeSetResult,
 } from '../stacks/StackRequestType';
@@ -398,17 +398,17 @@ export function clearStackEventsHandler(
     };
 }
 
-export function getStackOutputsHandler(
+export function describeStackHandler(
     components: ServerComponents,
-): RequestHandler<GetStackOutputsParams, GetStackOutputsResult, void> {
-    return async (rawParams): Promise<GetStackOutputsResult> => {
+): RequestHandler<DescribeStackParams, DescribeStackResult, void> {
+    return async (rawParams): Promise<DescribeStackResult> => {
         try {
-            const params = parseWithPrettyError(parseGetStackOutputsParams, rawParams);
+            const params = parseWithPrettyError(parseDescribeStackParams, rawParams);
             const response = await components.cfnService.describeStacks({ StackName: params.stackName });
-            const outputs = response.Stacks?.[0]?.Outputs ?? [];
-            return { outputs };
+            const stack = response.Stacks?.[0];
+            return { stack };
         } catch (error) {
-            handleLspError(error, 'Failed to get stack outputs');
+            handleLspError(error, 'Failed to describe stack');
         }
     };
 }

src/protocol/LspStackHandlers.ts

@@ -45,9 +45,9 @@ import {
     GetStackEventsRequest,
     ClearStackEventsParams,
     ClearStackEventsRequest,
-    GetStackOutputsParams,
-    GetStackOutputsResult,
-    GetStackOutputsRequest,
+    DescribeStackParams,
+    DescribeStackResult,
+    DescribeStackRequest,
     DescribeChangeSetParams,
     DescribeChangeSetResult,
     DescribeChangeSetRequest,
@@ -133,7 +133,7 @@ export class LspStackHandlers {
         this.connection.onRequest(ClearStackEventsRequest.method, handler);
     }
 
-    onGetStackOutputs(handler: RequestHandler<GetStackOutputsParams, GetStackOutputsResult, void>) {
-        this.connection.onRequest(GetStackOutputsRequest.method, handler);
+    onDescribeStack(handler: RequestHandler<DescribeStackParams, DescribeStackResult, void>) {
+        this.connection.onRequest(DescribeStackRequest.method, handler);
     }
 }

src/server/CfnServer.ts

@@ -44,7 +44,7 @@ import {
     describeChangeSetDeletionStatusHandler,
     getStackEventsHandler,
     clearStackEventsHandler,
-    getStackOutputsHandler,
+    describeStackHandler,
     describeChangeSetHandler,
 } from '../handlers/StackHandler';
 import { LspComponents } from '../protocol/LspComponents';
@@ -125,7 +125,7 @@ export class CfnServer {
         this.lsp.stackHandlers.onGetStackTemplate(getManagedResourceStackTemplateHandler(this.components));
         this.lsp.stackHandlers.onGetStackEvents(getStackEventsHandler(this.components));
         this.lsp.stackHandlers.onClearStackEvents(clearStackEventsHandler(this.components));
-        this.lsp.stackHandlers.onGetStackOutputs(getStackOutputsHandler(this.components));
+        this.lsp.stackHandlers.onDescribeStack(describeStackHandler(this.components));
 
         this.lsp.environmentHandlers.onParseEnvironmentFiles(parseEnvironmentFilesHandler());
 

src/stacks/StackRequestType.ts

@@ -1,4 +1,4 @@
-import { StackSummary, StackStatus, StackResourceSummary, StackEvent, Output } from '@aws-sdk/client-cloudformation';
+import { StackSummary, StackStatus, StackResourceSummary, StackEvent, Stack } from '@aws-sdk/client-cloudformation';
 import { RequestType } from 'vscode-languageserver-protocol';
 import { ChangeSetReference, StackChange } from './actions/StackActionRequestType';
 
@@ -95,16 +95,16 @@ export const ClearStackEventsRequest = new RequestType<ClearStackEventsParams, v
     'aws/cfn/stack/events/clear',
 );
 
-export type GetStackOutputsParams = {
+export type DescribeStackParams = {
     stackName: string;
 };
 
-export type GetStackOutputsResult = {
-    outputs: Output[];
+export type DescribeStackResult = {
+    stack?: Stack;
 };
 
-export const GetStackOutputsRequest = new RequestType<GetStackOutputsParams, GetStackOutputsResult, void>(
-    'aws/cfn/stack/outputs',
+export const DescribeStackRequest = new RequestType<DescribeStackParams, DescribeStackResult, void>(
+    'aws/cfn/stack/describe',
 );
 
 export const DescribeChangeSetRequest = new RequestType<DescribeChangeSetParams, DescribeChangeSetResult, void>(

src/stacks/actions/StackActionParser.ts

@@ -4,7 +4,7 @@ import {
     ListStackResourcesParams,
     GetStackEventsParams,
     ClearStackEventsParams,
-    GetStackOutputsParams,
+    DescribeStackParams,
     DescribeChangeSetParams,
 } from '../StackRequestType';
 import {
@@ -89,7 +89,7 @@ const ClearStackEventsParamsSchema = z.object({
     stackName: z.string().min(1).max(128),
 });
 
-const GetStackOutputsParamsSchema = z.object({
+const DescribeStackParamsSchema = z.object({
     stackName: z.string().min(1).max(128),
 });
 
@@ -121,8 +121,8 @@ export function parseClearStackEventsParams(input: unknown): ClearStackEventsPar
     return ClearStackEventsParamsSchema.parse(input);
 }
 
-export function parseGetStackOutputsParams(input: unknown): GetStackOutputsParams {
-    return GetStackOutputsParamsSchema.parse(input);
+export function parseDescribeStackParams(input: unknown): DescribeStackParams {
+    return DescribeStackParamsSchema.parse(input);
 }
 
 export function parseDescribeChangeSetParams(input: unknown): DescribeChangeSetParams {

tst/unit/handlers/StackHandler.test.ts

@@ -28,7 +28,7 @@ import {
     deleteChangeSetHandler,
     describeChangeSetDeletionStatusHandler,
     getChangeSetDeletionStatusHandler,
-    getStackOutputsHandler,
+    describeStackHandler,
     describeChangeSetHandler,
 } from '../../../src/handlers/StackHandler';
 import { analyzeCapabilities } from '../../../src/stacks/actions/CapabilityAnalyzer';
@@ -45,7 +45,7 @@ import {
     ListStacksParams,
     ListStacksResult,
     ListStackResourcesResult,
-    GetStackOutputsResult,
+    DescribeStackResult,
     DescribeChangeSetParams,
     DescribeChangeSetResult,
 } from '../../../src/stacks/StackRequestType';
@@ -71,7 +71,7 @@ vi.mock('../../../src/stacks/actions/StackActionParser', () => ({
     parseCreateDeploymentParams: vi.fn((input) => input),
     parseDeleteChangeSetParams: vi.fn((input) => input),
     parseListStackResourcesParams: vi.fn((input) => input),
-    parseGetStackOutputsParams: vi.fn((input) => input),
+    parseDescribeStackParams: vi.fn((input) => input),
     parseDescribeChangeSetParams: vi.fn((input) => input),
 }));
 
@@ -713,56 +713,55 @@ describe('StackActionHandler', () => {
         });
     });
 
-    describe('getStackOutputsHandler', () => {
-        it('returns outputs for a stack', async () => {
+    describe('describeStackHandler', () => {
+        it('returns stack info', async () => {
             const params = { stackName: 'MyStack' };
             const mockOutputs = [
                 { OutputKey: 'BucketName', OutputValue: 'my-bucket', Description: 'S3 Bucket' },
                 { OutputKey: 'FunctionArn', OutputValue: 'arn:aws:lambda:...', ExportName: 'MyFunction' },
             ];
+            const mockParams = [
+                { ParameterKey: 'RoleName', ParameterValue: 'MyRole' },
+                { ParameterKey: 'LambdaName', ParameterValue: 'MyLambda' },
+            ];
+            const mockTags = [
+                { Key: 'Org', Value: 'Aws' },
+                { Key: 'CostCenter', Value: '123' },
+            ];
 
             mockComponents.cfnService.describeStacks.resolves({
-                Stacks: [{ StackName: 'MyStack', Outputs: mockOutputs }],
-            } as any);
-
-            const handler = getStackOutputsHandler(mockComponents);
-            const result = (await handler(params, {} as any)) as GetStackOutputsResult;
-
-            expect(result.outputs).toHaveLength(2);
-            expect(result.outputs[0].OutputKey).toBe('BucketName');
-            expect(result.outputs[1].ExportName).toBe('MyFunction');
-        });
-
-        it('returns empty array when stack has no outputs', async () => {
-            const params = { stackName: 'MyStack' };
-
-            mockComponents.cfnService.describeStacks.resolves({
-                Stacks: [{ StackName: 'MyStack', Outputs: undefined }],
+                Stacks: [{ StackName: 'MyStack', Outputs: mockOutputs, Parameters: mockParams, Tags: mockTags }],
             } as any);
 
-            const handler = getStackOutputsHandler(mockComponents);
-            const result = (await handler(params, {} as any)) as GetStackOutputsResult;
+            const handler = describeStackHandler(mockComponents);
+            const result = (await handler(params, {} as any)) as DescribeStackResult;
 
-            expect(result.outputs).toEqual([]);
+            expect(result.stack?.Outputs).toHaveLength(2);
+            expect(result.stack?.Outputs?.[0].OutputKey).toBe('BucketName');
+            expect(result.stack?.Outputs?.[1].ExportName).toBe('MyFunction');
+            expect(result.stack?.Parameters?.[0].ParameterKey).toBe('RoleName');
+            expect(result.stack?.Parameters?.[1].ParameterValue).toBe('MyLambda');
+            expect(result.stack?.Tags?.[0].Key).toBe('Org');
+            expect(result.stack?.Tags?.[1].Value).toBe('123');
         });
 
-        it('returns empty array when Stacks array is empty', async () => {
+        it('returns undefined when Stacks array is empty', async () => {
             const params = { stackName: 'MyStack' };
 
             mockComponents.cfnService.describeStacks.resolves({
                 Stacks: [],
             } as any);
 
-            const handler = getStackOutputsHandler(mockComponents);
-            const result = (await handler(params, {} as any)) as GetStackOutputsResult;
+            const handler = describeStackHandler(mockComponents);
+            const result = (await handler(params, {} as any)) as DescribeStackResult;
 
-            expect(result.outputs).toEqual([]);
+            expect(result.stack).toBeUndefined();
         });
 
         it('throws ResponseError for invalid stack name', async () => {
             const params = { stackName: '' };
 
-            const handler = getStackOutputsHandler(mockComponents);
+            const handler = describeStackHandler(mockComponents);
 
             await expect(handler(params, {} as any)).rejects.toThrow(ResponseError);
         });
@@ -772,7 +771,7 @@ describe('StackActionHandler', () => {
 
             mockComponents.cfnService.describeStacks.rejects(new Error('Stack not found'));
 
-            const handler = getStackOutputsHandler(mockComponents);
+            const handler = describeStackHandler(mockComponents);
 
             await expect(handler(params, {} as any)).rejects.toThrow(ResponseError);
         });