refactor(stepfunctions): use real code paths in test, address lint issues, adjust logger message

Author: anthonyting

packages/core/src/shared/logger/logger.ts

@@ -5,7 +5,14 @@
 
 import * as vscode from 'vscode'
 
-export type LogTopic = 'crashMonitoring' | 'dev/beta' | 'notifications' | 'test' | 'childProcess' | 'unknown'
+export type LogTopic =
+    | 'crashMonitoring'
+    | 'dev/beta'
+    | 'notifications'
+    | 'test'
+    | 'childProcess'
+    | 'unknown'
+    | 'stepfunctions'
 
 class ErrorLog {
     constructor(

packages/core/src/stepFunctions/workflowStudio/handleMessage.ts

@@ -200,9 +200,7 @@ async function autoSyncFileMessageHandler(request: SyncFileRequestMessage, conte
  * @param context The webview context used for returning the API response to the webview
  */
 function apiCallMessageHandler(request: ApiCallRequestMessage, context: WebviewContext) {
-    const logger = getLogger()
+    const logger = getLogger('stepfunctions')
     const apiHandler = new WorkflowStudioApiHandler(globals.awsContext.getCredentialDefaultRegion(), context)
-    apiHandler
-        .performApiCall(request)
-        .catch((error) => logger.error('StepFunctions %s API call failed: %O', request.apiName, error))
+    apiHandler.performApiCall(request).catch((error) => logger.error('%s API call failed: %O', request.apiName, error))
 }

packages/core/src/stepFunctions/workflowStudio/workflowStudioApiHandler.ts

@@ -7,7 +7,7 @@ import { IAM, StepFunctions } from 'aws-sdk'
 import { DefaultIamClient } from '../../shared/clients/iamClient'
 import { DefaultStepFunctionsClient } from '../../shared/clients/stepFunctionsClient'
 import { ApiAction, ApiCallRequestMessage, Command, MessageType, WebviewContext } from './types'
-import { telemetry } from '../../shared/telemetry'
+import { telemetry } from '../../shared/telemetry/telemetry'
 
 export class WorkflowStudioApiHandler {
     public constructor(

packages/core/src/stepFunctions/workflowStudio/workflowStudioEditor.ts

@@ -182,9 +182,9 @@ export class WorkflowStudioEditor {
                             this.isPanelDisposed = true
                             resolve()
                             this.onVisualizationDisposeEmitter.fire()
-                            this.disposables.forEach((disposable) => {
+                            for (const disposable of this.disposables) {
                                 disposable.dispose()
-                            })
+                            }
                             this.onVisualizationDisposeEmitter.dispose()
                         })
                     )

packages/core/src/test/stepFunctions/workflowStudio/workflowStudioApiHandler.test.ts

@@ -9,10 +9,32 @@ import { WorkflowStudioApiHandler } from '../../../stepFunctions/workflowStudio/
 import { MockDocument } from '../../fake/fakeDocument'
 import { ApiAction, Command, MessageType, WebviewContext } from '../../../stepFunctions/workflowStudio/types'
 import * as vscode from 'vscode'
+import { assertTelemetry } from '../../testUtil'
+import { DefaultStepFunctionsClient } from '../../../shared/clients/stepFunctionsClient'
+import { DefaultIamClient } from '../../../shared/clients/iamClient'
 
 describe('WorkflowStudioApiHandler', function () {
     let postMessageStub: sinon.SinonStub
     let apiHandler: WorkflowStudioApiHandler
+    let testState: sinon.SinonStub
+
+    async function assertTestApiResponse(expectedResponse: any) {
+        await apiHandler.performApiCall({
+            apiName: ApiAction.SFNTestState,
+            params: {
+                definition: '',
+                roleArn: '',
+            },
+            requestId: 'test-request-id',
+            command: Command.API_CALL,
+            messageType: MessageType.REQUEST,
+        })
+
+        assertTelemetry('ui_click', {
+            elementId: 'stepfunctions_testState',
+        })
+        assert(postMessageStub.firstCall.calledWithExactly(expectedResponse))
+    }
 
     beforeEach(() => {
         const panel = vscode.window.createWebviewPanel('WorkflowStudioMock', 'WorkflowStudioMockTitle', {
@@ -34,68 +56,46 @@ describe('WorkflowStudioApiHandler', function () {
             fileId: '',
         }
 
-        apiHandler = new WorkflowStudioApiHandler('us-east-1', context)
+        const sfnClient = new DefaultStepFunctionsClient('us-east-1')
+        apiHandler = new WorkflowStudioApiHandler('us-east-1', context, {
+            sfn: sfnClient,
+            iam: new DefaultIamClient('us-east-1'),
+        })
+
+        testState = sinon.stub(sfnClient, 'testState')
     })
 
     it('should handle request and response for success', async function () {
-        sinon.stub(apiHandler, 'testState').returns(
-            Promise.resolve({
-                output: 'Test state output',
-            })
-        )
+        testState.resolves({
+            output: 'Test state output',
+        })
 
-        await apiHandler.performApiCall({
+        await assertTestApiResponse({
+            messageType: MessageType.RESPONSE,
+            command: Command.API_CALL,
             apiName: ApiAction.SFNTestState,
-            params: {
-                definition: '',
-                roleArn: '',
+            response: {
+                output: 'Test state output',
             },
             requestId: 'test-request-id',
-            command: Command.API_CALL,
-            messageType: MessageType.REQUEST,
+            isSuccess: true,
         })
-
-        assert(
-            postMessageStub.firstCall.calledWithExactly({
-                messageType: MessageType.RESPONSE,
-                command: Command.API_CALL,
-                apiName: ApiAction.SFNTestState,
-                response: {
-                    output: 'Test state output',
-                },
-                requestId: 'test-request-id',
-                isSuccess: true,
-            })
-        )
     })
 
     it('should handle request and response for error', async function () {
-        sinon.stub(apiHandler, 'testState').returns(Promise.reject(new Error('Error testing state')))
+        testState.rejects(new Error('Error testing state'))
 
-        await apiHandler.performApiCall({
+        await assertTestApiResponse({
+            messageType: MessageType.RESPONSE,
+            command: Command.API_CALL,
             apiName: ApiAction.SFNTestState,
-            params: {
-                definition: '',
-                roleArn: '',
+            error: {
+                message: 'Error testing state',
+                name: 'Error',
+                stack: sinon.match.string,
             },
+            isSuccess: false,
             requestId: 'test-request-id',
-            command: Command.API_CALL,
-            messageType: MessageType.REQUEST,
         })
-
-        assert(
-            postMessageStub.firstCall.calledWithExactly({
-                messageType: MessageType.RESPONSE,
-                command: Command.API_CALL,
-                apiName: ApiAction.SFNTestState,
-                error: {
-                    message: 'Error testing state',
-                    name: 'Error',
-                    stack: sinon.match.string,
-                },
-                isSuccess: false,
-                requestId: 'test-request-id',
-            })
-        )
     })
 })