refactor(stepfunctions): migrate to sdkv3 (#7560)

step functions still uses sdk v2

- Refactor `DefaultStepFunctionsClient` to `StepFunctionsClient` using
ClientWrapper.
- Refactor references to `DefaultStepFunctionsClient` with
`StepFunctionsClient` and reference sdk v3 types

- Verified CreateStateMachine, UpdateStateMachine works and
creates/updates StateMachine
- Verified AWS Explorer lists all StateMachines using ListStateMachine
- Verified StartExecution works
- Verified TestState, ListIAMRoles works in Workflow Studio, which also
fixes the bug that variables cannot be used in TestState in Workflow
Studio
- fixes #6819

![TestStateWithVariables](https://github.com/user-attachments/assets/ab981622-b773-4983-a9ce-a70c8fcfc711)
---

- Treat all work as PUBLIC. Private `feature/x` branches will not be
squash-merged at release time.
- Your code changes must meet the guidelines in
[CONTRIBUTING.md](https://github.com/aws/aws-toolkit-vscode/blob/master/CONTRIBUTING.md#guidelines).
- License: I confirm that my contribution is made under the terms of the
Apache 2.0 license.

Author: zelzhou

package-lock.json

@@ -517,6 +517,7 @@
         "@aws-sdk/client-ssm": "<3.731.0",
         "@aws-sdk/client-sso": "<3.731.0",
         "@aws-sdk/client-sso-oidc": "<3.731.0",
+        "@aws-sdk/client-sfn": "<3.731.0",
         "@aws-sdk/credential-provider-env": "<3.731.0",
         "@aws-sdk/credential-provider-process": "<3.731.0",
         "@aws-sdk/credential-provider-sso": "<3.731.0",

packages/core/package.json

@@ -0,0 +1,114 @@
+/*!
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+import {
+    CreateStateMachineCommand,
+    CreateStateMachineCommandInput,
+    CreateStateMachineCommandOutput,
+    DescribeStateMachineCommand,
+    DescribeStateMachineCommandInput,
+    DescribeStateMachineCommandOutput,
+    ListStateMachinesCommand,
+    ListStateMachinesCommandInput,
+    ListStateMachinesCommandOutput,
+    SFNClient,
+    StartExecutionCommand,
+    StartExecutionCommandInput,
+    StartExecutionCommandOutput,
+    StopExecutionCommand,
+    StopExecutionCommandInput,
+    StopExecutionCommandOutput,
+    RedriveExecutionCommand,
+    RedriveExecutionCommandInput,
+    RedriveExecutionCommandOutput,
+    GetExecutionHistoryCommand,
+    GetExecutionHistoryCommandInput,
+    GetExecutionHistoryCommandOutput,
+    GetMapRunCommand,
+    GetMapRunCommandInput,
+    GetMapRunCommandOutput,
+    DescribeExecutionCommand,
+    DescribeExecutionCommandInput,
+    DescribeExecutionCommandOutput,
+    DescribeStaeMachineForExecutionCmmand,
+    DescribeStateMachineForExecutionCommandInput,
+    DescribeStateMachineForExecutionCommandOutput,
+    StateMachineListItem,
+    TestStateCommand,
+    TestStateCommandInput,
+    TestStateCommandOutput,
+    UpdateStateMachineCommand,
+    UpdateStateMachineCommandInput,
+    UpdateStateMachineCommandOutput,
+} from '@aws-sdk/client-sfn'
+import { ClientWrapper } from './clientWrapper'
+
+export class StepFunctionsClient extends ClientWrapper<SFNClient> {
+    public constructor(regionCode: string) {
+        super(regionCode, SFNClient)
+    }
+
+    public async *listStateMachines(
+        request: ListStateMachinesCommandInput = {}
+    ): AsyncIterableIterator<StateMachineListItem> {
+        do {
+            const response: ListStateMachinesCommandOutput = await this.makeRequest(ListStateMachinesCommand, request)
+            if (response.stateMachines) {
+                yield* response.stateMachines
+            }
+            request.nextToken = response.nextToken
+        } while (request.nextToken)
+    }
+
+    public async getStateMachineDetails(
+        request: DescribeStateMachineCommandInput
+    ): Promise<DescribeStateMachineCommandOutput> {
+        return this.makeRequest(DescribeStateMachineCommand, request)
+    }
+
+    public async getStateMachineDetailsForExecution(
+        request: DescribeStateMachineForExecutionCommandInput
+    ): Promise<DescribeStateMachineForExecutionCommandOutput> {
+        return this.makeRequest(DescribeStaeMachineForExecutionCmmand, request)
+    }
+
+    public async getExecutionDetails(request: DescribeExecutionCommandInput): Promise<DescribeExecutionCommandOutput> {
+        return this.makeRequest(DescribeExecutionCommand, request)
+    }
+
+    public async getMapRunDetails(request: GetMapRunCommandInput): Promise<GetMapRunCommandOutput> {
+        return this.makeRequest(GetMapRunCommand, request)
+    }
+
+    public async getExecutionHistory(
+        request: GetExecutionHistoryCommandInput
+    ): Promise<GetExecutionHistoryCommandOutput> {
+        return this.makeRequest(GetExecutionHistoryCommand, request)
+    }
+
+    public async reDriveExecution(request: RedriveExecutionCommandInput): Promise<RedriveExecutionCommandOutput> {
+        return this.makeRequest(RedriveExecutionCommand, request)
+    }
+
+    public async stopExecution(request: StopExecutionCommandInput): Promise<StopExecutionCommandOutput> {
+        return this.makeRequest(StopExecutionCommand, request)
+    }
+
+    public async executeStateMachine(request: StartExecutionCommandInput): Promise<StartExecutionCommandOutput> {
+        return this.makeRequest(StartExecutionCommand, request)
+    }
+
+    public async createStateMachine(request: CreateStateMachineCommandInput): Promise<CreateStateMachineCommandOutput> {
+        return this.makeRequest(CreateStateMachineCommand, request)
+    }
+
+    public async updateStateMachine(request: UpdateStateMachineCommandInput): Promise<UpdateStateMachineCommandOutput> {
+        return this.makeRequest(UpdateStateMachineCommand, request)
+    }
+
+    public async testState(request: TestStateCommandInput): Promise<TestStateCommandOutput> {
+        return this.makeRequest(TestStateCommand, request)
+    }
+}

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

@@ -7,10 +7,10 @@ import * as nls from 'vscode-nls'
 import * as os from 'os'
 const localize = nls.loadMessageBundle()
 
-import { StepFunctions } from 'aws-sdk'
+import * as StepFunctions from '@aws-sdk/client-sfn'
 import * as path from 'path'
 import * as vscode from 'vscode'
-import { DefaultStepFunctionsClient, StepFunctionsClient } from '../../shared/clients/stepFunctionsClient'
+import { StepFunctionsClient } from '../../shared/clients/stepFunctions'
 
 import { getLogger, Logger } from '../../shared/logger/logger'
 import { Result } from '../../shared/telemetry/telemetry'
@@ -28,10 +28,11 @@ export async function downloadStateMachineDefinition(params: {
     let downloadResult: Result = 'Succeeded'
     const stateMachineName = params.stateMachineNode.details.name
     try {
-        const client: StepFunctionsClient = new DefaultStepFunctionsClient(params.stateMachineNode.regionCode)
-        const stateMachineDetails: StepFunctions.DescribeStateMachineOutput = await client.getStateMachineDetails(
-            params.stateMachineNode.details.stateMachineArn
-        )
+        const client: StepFunctionsClient = new StepFunctionsClient(params.stateMachineNode.regionCode)
+        const stateMachineDetails: StepFunctions.DescribeStateMachineCommandOutput =
+            await client.getStateMachineDetails({
+                stateMachineArn: params.stateMachineNode.details.stateMachineArn,
+            })
 
         if (params.isPreviewAndRender) {
             const doc = await vscode.workspace.openTextDocument({
@@ -53,7 +54,7 @@ export async function downloadStateMachineDefinition(params: {
 
             if (fileInfo) {
                 const filePath = fileInfo.fsPath
-                await fs.writeFile(filePath, stateMachineDetails.definition, 'utf8')
+                await fs.writeFile(filePath, stateMachineDetails.definition || '', 'utf8')
                 const openPath = vscode.Uri.file(filePath)
                 const doc = await vscode.workspace.openTextDocument(openPath)
                 await vscode.window.showTextDocument(doc)

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

@@ -7,7 +7,7 @@ import { load } from 'js-yaml'
 import * as vscode from 'vscode'
 import * as nls from 'vscode-nls'
 import { AwsContext } from '../../shared/awsContext'
-import { DefaultStepFunctionsClient, StepFunctionsClient } from '../../shared/clients/stepFunctionsClient'
+import { StepFunctionsClient } from '../../shared/clients/stepFunctions'
 import { getLogger, Logger } from '../../shared/logger/logger'
 import { showViewLogsMessage } from '../../shared/utilities/messages'
 import { VALID_SFN_PUBLISH_FORMATS, YAML_FORMATS } from '../constants/aslFormats'
@@ -64,7 +64,7 @@ export async function publishStateMachine(params: publishStateMachineParams) {
         if (!response) {
             return
         }
-        const client = new DefaultStepFunctionsClient(response.region)
+        const client = new StepFunctionsClient(response.region)
 
         if (response?.createResponse) {
             await createStateMachine(response.createResponse, text, params.outputChannel, response.region, client)
@@ -109,7 +109,7 @@ async function createStateMachine(
                 wizardResponse.name
             )
         )
-        outputChannel.appendLine(result.stateMachineArn)
+        outputChannel.appendLine(result.stateMachineArn || '')
         logger.info(`Created "${result.stateMachineArn}"`)
     } catch (err) {
         const msg = localize(

packages/core/src/stepFunctions/commands/downloadStateMachineDefinition.ts

@@ -7,9 +7,9 @@ import * as os from 'os'
 import * as nls from 'vscode-nls'
 const localize = nls.loadMessageBundle()
 
-import { StepFunctions } from 'aws-sdk'
+import * as StepFunctions from '@aws-sdk/client-sfn'
 import * as vscode from 'vscode'
-import { DefaultStepFunctionsClient } from '../../shared/clients/stepFunctionsClient'
+import { StepFunctionsClient } from '../../shared/clients/stepFunctions'
 
 import { AWSResourceNode } from '../../shared/treeview/nodes/awsResourceNode'
 import { AWSTreeNodeBase } from '../../shared/treeview/nodes/awsTreeNodeBase'
@@ -40,7 +40,7 @@ export class StepFunctionsNode extends AWSTreeNodeBase {
 
     public constructor(
         public override readonly regionCode: string,
-        private readonly client = new DefaultStepFunctionsClient(regionCode)
+        private readonly client = new StepFunctionsClient(regionCode)
     ) {
         super('Step Functions', vscode.TreeItemCollapsibleState.Collapsed)
         this.stateMachineNodes = new Map<string, StateMachineNode>()
@@ -101,7 +101,7 @@ export class StateMachineNode extends AWSTreeNodeBase implements AWSResourceNode
     }
 
     public get arn(): string {
-        return this.details.stateMachineArn
+        return this.details.stateMachineArn || ''
     }
 
     public get name(): string {

packages/core/src/stepFunctions/commands/publishStateMachine.ts

@@ -5,10 +5,10 @@
 import * as nls from 'vscode-nls'
 const localize = nls.loadMessageBundle()
 
-import { StepFunctions } from 'aws-sdk'
+import * as StepFunctions from '@aws-sdk/client-sfn'
 import * as yaml from 'js-yaml'
 import * as vscode from 'vscode'
-import { StepFunctionsClient } from '../shared/clients/stepFunctionsClient'
+import { StepFunctionsClient } from '../shared/clients/stepFunctions'
 import {
     DiagnosticSeverity,
     DocumentLanguageSettings,