refactor: update listStacks

Author: Hweinstock

packages/core/src/lambda/explorer/cloudFormationNodes.ts

@@ -9,7 +9,7 @@ const localize = nls.loadMessageBundle()
 import { CloudFormation, Lambda } from 'aws-sdk'
 import * as os from 'os'
 import * as vscode from 'vscode'
-import { CloudFormationClient } from '../../shared/clients/cloudFormation'
+import { CloudFormationClient, StackSummary } from '../../shared/clients/cloudFormation'
 import { DefaultLambdaClient } from '../../shared/clients/lambdaClient'
 
 import { AWSResourceNode } from '../../shared/treeview/nodes/awsResourceNode'
@@ -66,7 +66,7 @@ export class CloudFormationStackNode extends AWSTreeNodeBase implements AWSResou
     public constructor(
         public readonly parent: AWSTreeNodeBase,
         public override readonly regionCode: string,
-        private stackSummary: CloudFormation.StackSummary,
+        private stackSummary: StackSummary,
         private readonly lambdaClient = new DefaultLambdaClient(regionCode),
         private readonly cloudformationClient = new CloudFormationClient(regionCode)
     ) {
@@ -114,7 +114,7 @@ export class CloudFormationStackNode extends AWSTreeNodeBase implements AWSResou
         })
     }
 
-    public update(stackSummary: CloudFormation.StackSummary): void {
+    public update(stackSummary: StackSummary): void {
         this.stackSummary = stackSummary
         this.label = `${this.stackName} [${stackSummary.StackStatus}]`
         this.tooltip = `${this.stackName}${os.EOL}${this.stackId}`

packages/core/src/lambda/utils.ts

@@ -7,9 +7,9 @@ import * as nls from 'vscode-nls'
 const localize = nls.loadMessageBundle()
 
 import xml2js = require('xml2js')
-import { CloudFormation, Lambda } from 'aws-sdk'
+import { Lambda } from 'aws-sdk'
 import * as vscode from 'vscode'
-import { CloudFormationClient } from '../shared/clients/cloudFormation'
+import { CloudFormationClient, StackSummary } from '../shared/clients/cloudFormation'
 import { LambdaClient } from '../shared/clients/lambdaClient'
 import { getFamily, getNodeMajorVersion, RuntimeFamily } from './models/samLambdaRuntime'
 import { getLogger } from '../shared/logger/logger'
@@ -18,9 +18,7 @@ import { FileResourceFetcher } from '../shared/resourcefetcher/fileResourceFetch
 import { sampleRequestManifestPath } from './constants'
 import globals from '../shared/extensionGlobals'
 
-export async function* listCloudFormationStacks(
-    client: CloudFormationClient
-): AsyncIterableIterator<CloudFormation.StackSummary> {
+export async function* listCloudFormationStacks(client: CloudFormationClient): AsyncIterableIterator<StackSummary> {
     // TODO: this 'loading' message needs to go under each regional entry
     // in the explorer, and be removed when that region's query completes
     const status = vscode.window.setStatusBarMessage(

packages/core/src/shared/clients/cloudFormation.ts

@@ -8,9 +8,13 @@ import * as CloudFormationV3 from '@aws-sdk/client-cloudformation'
 import globals from '../extensionGlobals'
 import { AsyncCollection } from '../utilities/asyncCollection'
 import { pageableToCollection } from '../utilities/collectionUtils'
-import { isNonNullable } from '../utilities/tsUtils'
+import { hasProps, isNonNullable, RequiredProps } from '../utilities/tsUtils'
 import { ClientWrapper } from './clientWrapper'
 
+export interface StackSummary
+    extends RequiredProps<CloudFormationV3.StackSummary, 'StackName' | 'CreationTime' | 'StackStatus'> {
+    DriftInformation: RequiredProps<CloudFormationV3.StackDriftInformation, 'StackDriftStatus'>
+}
 export class CloudFormationClient extends ClientWrapper<CloudFormationV3.CloudFormationClient> {
     public constructor(regionCode: string) {
         super(regionCode, CloudFormationV3.CloudFormationClient)
@@ -33,22 +37,32 @@ export class CloudFormationClient extends ClientWrapper<CloudFormationV3.CloudFo
 
     public async *listStacks(
         statusFilter: string[] = ['CREATE_COMPLETE', 'UPDATE_COMPLETE']
-    ): AsyncIterableIterator<CloudFormation.StackSummary> {
-        const client = await this.createSdkClient()
-
+    ): AsyncIterableIterator<StackSummary> {
         const request: CloudFormation.ListStacksInput = {
             StackStatusFilter: statusFilter,
         }
 
         do {
-            const response: CloudFormation.ListStacksOutput = await client.listStacks(request).promise()
-
-            if (response.StackSummaries) {
-                yield* response.StackSummaries
+            const response: CloudFormationV3.ListStacksOutput = await this.makeRequest(
+                CloudFormationV3.ListStacksCommand,
+                request
+            )
+
+            const filteredResponse = response.StackSummaries?.filter(isStackSummary)
+            if (filteredResponse && filteredResponse.length > 0) {
+                yield* filteredResponse
             }
 
             request.NextToken = response.NextToken
         } while (request.NextToken)
+
+        function isStackSummary(s: CloudFormationV3.StackSummary | undefined): s is StackSummary {
+            return (
+                isNonNullable(s) &&
+                hasProps(s, 'StackName', 'CreationTime', 'StackStatus', 'DriftInformation') &&
+                hasProps(s.DriftInformation, 'StackDriftStatus')
+            )
+        }
     }
 
     public listAllStacks(request: CloudFormation.ListStacksInput = {}): AsyncCollection<CloudFormation.StackSummary[]> {

packages/core/src/test/lambda/explorer/cloudFormationNodes.test.ts

@@ -12,7 +12,7 @@ import {
     contextValueCloudformationLambdaFunction,
 } from '../../../lambda/explorer/cloudFormationNodes'
 import { LambdaFunctionNode } from '../../../lambda/explorer/lambdaFunctionNode'
-import { CloudFormationClient } from '../../../shared/clients/cloudFormation'
+import { CloudFormationClient, StackSummary } from '../../../shared/clients/cloudFormation'
 import { DefaultLambdaClient } from '../../../shared/clients/lambdaClient'
 import globals from '../../../shared/extensionGlobals'
 import { TestAWSTreeNode } from '../../shared/treeview/nodes/testAWSTreeNode'
@@ -44,6 +44,9 @@ function createCloudFormationClient(...stackNames: string[]) {
                     StackName: name,
                     CreationTime: new globals.clock.Date(),
                     StackStatus: 'CREATE_COMPLETE',
+                    DriftInformation: {
+                        StackDriftStatus: 'UNKNOWN',
+                    },
                 }
             })
         )
@@ -53,12 +56,15 @@ function createCloudFormationClient(...stackNames: string[]) {
 }
 
 describe('CloudFormationStackNode', function () {
-    function createStackSummary() {
+    function createStackSummary(): StackSummary {
         return {
             CreationTime: new globals.clock.Date(),
             StackId: '1',
             StackName: 'myStack',
             StackStatus: 'UPDATE_COMPLETE',
+            DriftInformation: {
+                StackDriftStatus: 'UNKNOWN',
+            },
         }
     }