feat(stepfunctions): Add a setting to opt out of WFS + minor integrations adjustments

Vlad Nikolaenko · Vlad Nikolaenko · commit 590b319f4429 · 2025-02-06T09:42:00.000-08:00
diff --git a/packages/core/package.nls.json b/packages/core/package.nls.json
@@ -27,6 +27,7 @@
     "AWS.stepFunctions.workflowStudio.actions.progressMessage": "Opening asl file in Workflow Studio",
     "AWS.stepFunctions.workflowStudio.actions.saveSuccessMessage": "{0} has been saved",
     "AWS.stepFunctions.workflowStudio.actions.invalidJson": "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.enable.desc": "Open Amazon States Language files in Workflow Studio by default.",
     "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",
diff --git a/packages/core/src/shared/settings-toolkit.gen.ts b/packages/core/src/shared/settings-toolkit.gen.ts
@@ -19,6 +19,7 @@ export const toolkitSettings = {
     "aws.samcli.legacyDeploy": {},
     "aws.telemetry": {},
     "aws.stepfunctions.asl.format.enable": {},
+    "aws.stepfunctions.workflowStudio.enable": {},
     "aws.stepfunctions.asl.maxItemsComputed": {},
     "aws.ssmDocument.ssm.maxItemsComputed": {},
     "aws.cwl.limit": {},
diff --git a/packages/core/src/stepFunctions/workflowStudio/activation.ts b/packages/core/src/stepFunctions/workflowStudio/activation.ts
@@ -17,7 +17,11 @@ export async function activate(): Promise<void> {
     // Open the file with Workflow Studio editor in a new tab, or focus on the tab with WFS if it is already open
     globals.context.subscriptions.push(
         Commands.register('aws.stepfunctions.openWithWorkflowStudio', async (uri: vscode.Uri) => {
-            await vscode.commands.executeCommand('vscode.openWith', uri, WorkflowStudioEditorProvider.viewType)
+            await vscode.commands.executeCommand(
+                'vscode.openWith',
+                uri.with({ query: 'manual=true' }),
+                WorkflowStudioEditorProvider.viewType
+            )
         })
     )
 
@@ -26,7 +30,11 @@ export async function activate(): Promise<void> {
     globals.context.subscriptions.push(
         Commands.register('aws.stepfunctions.switchToWorkflowStudio', async (uri: vscode.Uri) => {
             await vscode.commands.executeCommand('workbench.action.closeActiveEditor')
-            await vscode.commands.executeCommand('vscode.openWith', uri, WorkflowStudioEditorProvider.viewType)
+            await vscode.commands.executeCommand(
+                'vscode.openWith',
+                uri.with({ query: 'manual=true' }),
+                WorkflowStudioEditorProvider.viewType
+            )
         })
     )
 }
diff --git a/packages/core/src/stepFunctions/workflowStudio/workflowStudioEditorProvider.ts b/packages/core/src/stepFunctions/workflowStudio/workflowStudioEditorProvider.ts
@@ -12,6 +12,7 @@ import { telemetry } from '../../shared/telemetry/telemetry'
 import globals from '../../shared/extensionGlobals'
 import { getRandomString, getStringHash } from '../../shared/utilities/textUtilities'
 import { ToolkitError } from '../../shared/errors'
+import { getTabSizeSetting } from '../../shared/utilities/editorUtilities'
 import { WorkflowStudioEditor } from './workflowStudioEditor'
 import { i18n } from '../../shared/i18n-helper'
 import { isInvalidJsonFile } from '../utils'
@@ -86,8 +87,9 @@ export class WorkflowStudioEditorProvider implements vscode.CustomTextEditorProv
         const localeTag = `<meta name='locale' content='${locale}'>`
         const theme = vscode.window.activeColorTheme.kind
         const isDarkMode = theme === vscode.ColorThemeKind.Dark || theme === vscode.ColorThemeKind.HighContrast
+        const tabSizeTag = `<meta name='tab-size' content='${getTabSizeSetting()}'>`
         const darkModeTag = `<meta name='dark-mode' content='${isDarkMode}'>`
-        let html = `${htmlFileSplit[0]} <head> ${baseTag} ${localeTag} ${darkModeTag} ${htmlFileSplit[1]}`
+        let html = `${htmlFileSplit[0]} <head> ${baseTag} ${localeTag} ${darkModeTag} ${tabSizeTag} ${htmlFileSplit[1]}`
 
         const nonce = getRandomString()
         htmlFileSplit = html.split("script-src 'self'")
@@ -115,6 +117,21 @@ export class WorkflowStudioEditorProvider implements vscode.CustomTextEditorProv
         _token: vscode.CancellationToken
     ): Promise<void> {
         await telemetry.stepfunctions_openWorkflowStudio.run(async () => {
+            // If the user opted out from Workflow Studio and this is not a manual open, launch default editor instead
+            const autoOpenWFS = vscode.workspace.getConfiguration().get('aws.stepfunctions.workflowStudio.enable', true)
+            const isManualAction = new URLSearchParams(document.uri.query).get('manual') === 'true'
+            if (!autoOpenWFS && !isManualAction) {
+                await vscode.commands.executeCommand('vscode.openWith', document.uri, 'default')
+                webviewPanel.dispose()
+                throw ToolkitError.chain(
+                    'User opted out',
+                    'The Workflow Studio editor was not opened because the user has opted out',
+                    {
+                        code: 'userOptOut',
+                    }
+                )
+            }
+
             // For invalid JSON, open default editor and show warning message
             if (isInvalidJsonFile(document)) {
                 await vscode.commands.executeCommand('vscode.openWith', document.uri, 'default')
diff --git a/packages/toolkit/package.json b/packages/toolkit/package.json
@@ -146,6 +146,11 @@
                     "default": true,
                     "description": "%AWS.stepFunctions.asl.format.enable.desc%"
                 },
+                "aws.stepfunctions.workflowStudio.enable": {
+                    "type": "boolean",
+                    "default": true,
+                    "description": "%AWS.stepFunctions.workflowStudio.enable.desc%"
+                },
                 "aws.stepfunctions.asl.maxItemsComputed": {
                     "type": "number",
                     "default": 5000,
@@ -1412,6 +1417,11 @@
                     "command": "aws.openInApplicationComposer",
                     "when": "isFileSystemResource && !(resourceFilename =~ /^.*\\.tc\\.json$/) && resourceFilename =~ /^.*\\.(json|yml|yaml|template)$/",
                     "group": "z_aws@1"
+                },
+                {
+                    "command": "aws.stepfunctions.openWithWorkflowStudio",
+                    "when": "isFileSystemResource && resourceFilename =~ /^.*\\.asl\\.(json|yml|yaml)$/",
+                    "group": "z_aws@1"
                 }
             ],
             "view/item/context": [
@@ -3838,6 +3848,16 @@
                     }
                 }
             },
+            {
+                "command": "aws.stepfunctions.openWithWorkflowStudio",
+                "title": "%AWS.command.stepFunctions.openWithWorkflowStudio%",
+                "category": "%AWS.title%",
+                "cloud9": {
+                    "cn": {
+                        "category": "%AWS.title.cn%"
+                    }
+                }
+            },
             {
                 "command": "aws.createNewThreatComposer",
                 "title": "%AWS.command.threatComposer.createNew%",
