Merge pull request aws#6709 from aws/feature/stepfunctions-workflow

Merge feature/stepfunctions-workflow branch into master

Author: hayemaxi

packages/core/package.nls.json

@@ -34,6 +34,11 @@
     "AWS.stepFunctions.executeStateMachine.error.failedToStart": "There was an error starting execution for '{0}', check AWS Toolkit logs for more information.",
     "AWS.stepFunctions.asl.format.enable.desc": "Enables the default formatter used with Amazon States Language files",
     "AWS.stepFunctions.asl.maxItemsComputed.desc": "The maximum number of outline symbols and folding regions computed (limited for performance reasons).",
+    "AWS.stepFunctions.workflowStudio.actions.progressMessage": "Opening asl file in Workflow Studio",
+    "AWS.stepFunctions.workflowStudio.actions.saveSuccessMessage": "{0} has been saved",
+    "AWS.stepFunctions.workflowStudio.actions.InvalidJSONContent": "The Workflow Studio editor was not opened because the JSON in the file is invalid. To access Workflow Studio, please fix the JSON and manually reopen the integration.",
+    "AWS.stepFunctions.workflowStudio.actions.InvalidYAMLContent": "The Workflow Studio editor was not opened because the YAML in the file is invalid. To access Workflow Studio, please fix the YAML and manually reopen the integration.",
+    "AWS.stepFunctions.workflowStudio.actions.webviewFetchFailed": "Failed to load Workflow Studio editor. Please check your network connection and try again.",
     "AWS.configuration.description.awssam.debug.api": "API Gateway configuration",
     "AWS.configuration.description.awssam.debug.api.clientCertId": "The API Gateway client certificate ID",
     "AWS.configuration.description.awssam.debug.api.headers": "Additional HTTP headers",
@@ -177,7 +182,6 @@
     "AWS.command.viewSchemaItem": "View Schema",
     "AWS.command.searchSchema": "Search Schemas",
     "AWS.command.executeStateMachine": "Start Execution...",
-    "AWS.command.renderStateMachineGraph": "Render graph",
     "AWS.command.copyArn": "Copy ARN",
     "AWS.command.copyName": "Copy Name",
     "AWS.command.openAwsConsole": "Go to AWS management console",
@@ -219,7 +223,7 @@
     "AWS.command.s3.uploadFileToParent": "Upload to Parent...",
     "AWS.command.stepFunctions.createStateMachineFromTemplate": "Create a new Step Functions state machine",
     "AWS.command.stepFunctions.publishStateMachine": "Publish state machine to Step Functions",
-    "AWS.command.stepFunctions.previewStateMachine": "Render state machine graph",
+    "AWS.command.stepFunctions.openWithWorkflowStudio": "Open with Workflow Studio",
     "AWS.command.cdk.previewStateMachine": "Render state machine graph from CDK application",
     "AWS.command.copyLogResource": "Copy Log Stream or Group",
     "AWS.command.saveCurrentLogDataContent": "Save Log to File",

packages/core/src/awsexplorer/activation.ts

@@ -190,15 +190,6 @@ async function registerAwsExplorerCommands(
             'aws.executeStateMachine',
             async (node: StateMachineNode) => await executeStateMachine(context, node)
         ),
-        Commands.register(
-            'aws.renderStateMachineGraph',
-            async (node: StateMachineNode) =>
-                await downloadStateMachineDefinition({
-                    stateMachineNode: node,
-                    outputChannel: toolkitOutputChannel,
-                    isPreviewAndRender: true,
-                })
-        ),
         Commands.register('aws.copyArn', async (node: AWSResourceNode | TreeNode) => {
             const sourceNode = getSourceNode<AWSResourceNode>(node)
             await copyTextCommand(sourceNode, 'ARN')

packages/core/src/extensionNode.ts

@@ -28,6 +28,7 @@ import { activate as activateS3 } from './awsService/s3/activation'
 import * as filetypes from './shared/filetypes'
 import { activate as activateApiGateway } from './awsService/apigateway/activation'
 import { activate as activateStepFunctions } from './stepFunctions/activation'
+import { activate as activateStepFunctionsWorkflowStudio } from './stepFunctions/workflowStudio/activation'
 import { activate as activateSsmDocument } from './ssmDocument/activation'
 import { activate as activateDynamicResources } from './dynamicResources/activation'
 import { activate as activateEcs } from './awsService/ecs/activation'
@@ -198,6 +199,8 @@ export async function activate(context: vscode.ExtensionContext) {
 
         await activateStepFunctions(context, globals.awsContext, globals.outputChannel)
 
+        await activateStepFunctionsWorkflowStudio()
+
         await activateRedshift(extContext)
 
         await activateAppBuilder(extContext)

packages/core/src/feedback/vue/submitFeedback.ts

@@ -71,7 +71,7 @@ export class FeedbackWebview extends VueWebview {
     }
 }
 
-type FeedbackId = 'AWS Toolkit' | 'Amazon Q' | 'Infrastructure Composer' | 'Threat Composer'
+type FeedbackId = 'AWS Toolkit' | 'Amazon Q' | 'Infrastructure Composer' | 'Threat Composer' | 'Workflow Studio'
 
 let _submitFeedback:
     | RegisteredCommand<(_: VsCodeCommandArg, id: FeedbackId, commentData?: string) => Promise<void>>

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

@@ -67,6 +67,12 @@ export class DefaultStepFunctionsClient {
         return client.updateStateMachine(params).promise()
     }
 
+    public async testState(params: StepFunctions.TestStateInput): Promise<StepFunctions.TestStateOutput> {
+        const client = await this.createSdkClient()
+
+        return await client.testState(params).promise()
+    }
+
     private async createSdkClient(): Promise<StepFunctions> {
         return await globals.sdkClientBuilder.createAwsService(StepFunctions, undefined, this.regionCode)
     }

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

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

packages/core/src/shared/telemetry/vscodeTelemetry.json

@@ -22,6 +22,11 @@
             "allowedValues": ["Create", "Update"],
             "description": "SSM Publish Document operation type"
         },
+        {
+            "name": "isInvalidJson",
+            "type": "boolean",
+            "description": "Indicates whether the message contains an invalid JSON definition."
+        },
         {
             "name": "starterTemplate",
             "type": "string",
@@ -575,6 +580,47 @@
             "name": "stepfunctions_previewstatemachine",
             "description": ""
         },
+        {
+            "name": "stepfunctions_openWorkflowStudio",
+            "description": "Called after opening asl file in Step Functions Workflow Studio",
+            "metadata": [
+                {
+                    "type": "id",
+                    "required": true
+                }
+            ]
+        },
+        {
+            "name": "stepfunctions_closeWorkflowStudio",
+            "description": "Called after closing Step Functions Workflow Studio custom editor",
+            "metadata": [
+                {
+                    "type": "id",
+                    "required": true
+                }
+            ]
+        },
+        {
+            "name": "stepfunctions_saveFile",
+            "description": "Triggered when Workflow Studio auto-syncs to the local file or when unsaved local changes are saved from Workflow Studio or VSCode.",
+            "metadata": [
+                {
+                    "type": "id",
+                    "required": true
+                },
+                {
+                    "type": "saveType",
+                    "required": true
+                },
+                {
+                    "type": "source",
+                    "required": true
+                },
+                {
+                    "type": "isInvalidJson"
+                }
+            ]
+        },
         {
             "name": "vscode_activeRegions",
             "description": "Record the number of active regions at startup and when regions are added/removed",

packages/core/src/shared/vscode/setContext.ts

@@ -25,6 +25,7 @@ export type contextKey =
     | 'aws.explorer.showAuthView'
     | 'aws.toolkit.amazonq.dismissed'
     | 'aws.toolkit.amazonqInstall.dismissed'
+    | 'aws.stepFunctions.isWorkflowStudioFocused'
     | 'aws.toolkit.notifications.show'
     // Deprecated/legacy names. New keys should start with "aws.".
     | 'codewhisperer.activeLine'

packages/core/src/stepFunctions/activation.ts

@@ -13,7 +13,6 @@ import * as vscode from 'vscode'
 import { AwsContext } from '../shared/awsContext'
 import { createStateMachineFromTemplate } from './commands/createStateMachineFromTemplate'
 import { publishStateMachine } from './commands/publishStateMachine'
-import { AslVisualizationManager } from './commands/visualizeStateMachine/aslVisualizationManager'
 import { Commands } from '../shared/vscode/commands2'
 
 import { ASL_FORMATS, YAML_ASL, JSON_ASL } from './constants/aslFormats'
@@ -23,6 +22,9 @@ import { ToolkitError } from '../shared/errors'
 import { telemetry } from '../shared/telemetry/telemetry'
 import { PerfLog } from '../shared/logger/perfLogger'
 import { ASLLanguageClient } from './asl/client'
+import { WorkflowStudioEditorProvider } from './workflowStudio/workflowStudioEditorProvider'
+import { StateMachineNode } from './explorer/stepFunctionsNodes'
+import { downloadStateMachineDefinition } from './commands/downloadStateMachineDefinition'
 
 /**
  * Activate Step Functions related functionality for the extension.
@@ -54,28 +56,30 @@ export async function activate(
     }
 }
 
-/*
- * TODO: Determine behaviour when command is run against bad input, or
- * non-json files. Determine if we want to limit the command to only a
- * specifc subset of file types ( .json only, custom .states extension, etc...)
- * Ensure tests are written for this use case as well.
- */
 export const previewStateMachineCommand = Commands.declare(
     'aws.previewStateMachine',
-    (manager: AslVisualizationManager) => async (arg?: vscode.TextEditor | vscode.Uri) => {
-        try {
+    () => async (arg?: vscode.TextEditor | vscode.Uri | StateMachineNode) => {
+        await telemetry.run('stepfunctions_previewstatemachine', async () => {
+            if (arg instanceof StateMachineNode) {
+                return downloadStateMachineDefinition({
+                    stateMachineNode: arg,
+                    outputChannel: globals.outputChannel,
+                    isPreviewAndRender: true,
+                })
+            }
+
             arg ??= vscode.window.activeTextEditor
-            const input = arg instanceof vscode.Uri ? arg : arg?.document
+            const input = arg instanceof vscode.Uri ? arg : arg?.document.uri
 
             if (!input) {
                 throw new ToolkitError('No active text editor or document found')
             }
 
-            return await manager.visualizeStateMachine(input)
-        } finally {
-            // TODO: Consider making the metric reflect the success/failure of the above call
-            telemetry.stepfunctions_previewstatemachine.emit()
-        }
+            await WorkflowStudioEditorProvider.openWithWorkflowStudio(input, {
+                preserveFocus: true,
+                viewColumn: vscode.ViewColumn.Beside,
+            })
+        })
     }
 )
 
@@ -84,11 +88,10 @@ async function registerStepFunctionCommands(
     awsContext: AwsContext,
     outputChannel: vscode.OutputChannel
 ): Promise<void> {
-    const visualizationManager = new AslVisualizationManager(extensionContext)
     const cdkVisualizationManager = new AslVisualizationCDKManager(extensionContext)
 
     extensionContext.subscriptions.push(
-        previewStateMachineCommand.register(visualizationManager),
+        previewStateMachineCommand.register(),
         renderCdkStateMachineGraph.register(cdkVisualizationManager),
         Commands.register('aws.stepfunctions.createStateMachineFromTemplate', async () => {
             try {
@@ -144,8 +147,8 @@ function initializeCodeLens(context: vscode.ExtensionContext) {
         public async provideCodeLenses(document: vscode.TextDocument): Promise<vscode.CodeLens[]> {
             const topOfDocument = new vscode.Range(0, 0, 0, 0)
 
-            const renderCodeLens = previewStateMachineCommand.build().asCodeLens(topOfDocument, {
-                title: localize('AWS.stepFunctions.render', 'Render graph'),
+            const openCustomEditor = previewStateMachineCommand.build(document.uri).asCodeLens(topOfDocument, {
+                title: localize('AWS.command.stepFunctions.openWithWorkflowStudio', 'Open with Workflow Studio'),
             })
 
             if (ASL_FORMATS.includes(document.languageId)) {
@@ -155,9 +158,9 @@ function initializeCodeLens(context: vscode.ExtensionContext) {
                 }
                 const publishCodeLens = new vscode.CodeLens(topOfDocument, publishCommand)
 
-                return [publishCodeLens, renderCodeLens]
+                return [publishCodeLens, openCustomEditor]
             } else {
-                return [renderCodeLens]
+                return [openCustomEditor]
             }
         }
     }

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

@@ -15,9 +15,9 @@ import { DefaultStepFunctionsClient, StepFunctionsClient } from '../../shared/cl
 import { getLogger, Logger } from '../../shared/logger/logger'
 import { Result } from '../../shared/telemetry/telemetry'
 import { StateMachineNode } from '../explorer/stepFunctionsNodes'
-import { previewStateMachineCommand } from '../activation'
 import { telemetry } from '../../shared/telemetry/telemetry'
 import { fs } from '../../shared/fs/fs'
+import { WorkflowStudioEditorProvider } from '../workflowStudio/workflowStudioEditorProvider'
 
 export async function downloadStateMachineDefinition(params: {
     outputChannel: vscode.OutputChannel
@@ -40,7 +40,10 @@ export async function downloadStateMachineDefinition(params: {
             })
 
             const textEditor = await vscode.window.showTextDocument(doc)
-            await previewStateMachineCommand.execute(textEditor)
+            await WorkflowStudioEditorProvider.openWithWorkflowStudio(textEditor.document.uri, {
+                preserveFocus: true,
+                viewColumn: vscode.ViewColumn.Beside,
+            })
         } else {
             const wsPath = vscode.workspace.workspaceFolders
                 ? vscode.workspace.workspaceFolders[0].uri.fsPath