feat(stepfunctions): enable hardcoded execution details page

Author: Diler Zaza

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

@@ -26,6 +26,7 @@ import {
     UpdateStateMachineCommandOutput,
 } from '@aws-sdk/client-sfn'
 import { ClientWrapper } from './clientWrapper'
+// import { StopExecutionInput } from 'aws-sdk/clients/stepfunctions'
 
 export class StepFunctionsClient extends ClientWrapper<SFNClient> {
     public constructor(regionCode: string) {

packages/core/src/stepFunctions/commands/visualizeStateMachine/renderStateMachineGraphCDK.ts

@@ -12,7 +12,7 @@ import { isTreeNode } from '../../../shared/treeview/resourceTreeDataProvider'
 import { unboxTreeNode } from '../../../shared/treeview/utils'
 import { Commands } from '../../../shared/vscode/commands2'
 import { PreviewStateMachineCDKWizard } from '../../wizards/previewStateMachineCDKWizard'
-import { WorkflowMode } from '../../workflowStudio/types'
+import { WorkflowMode } from '../../messageHandlers/types'
 import { WorkflowStudioEditorProvider } from '../../workflowStudio/workflowStudioEditorProvider'
 import { getStateMachineDefinitionFromCfnTemplate } from './getStateMachineDefinitionFromCfnTemplate'
 

packages/core/src/stepFunctions/executionDetails/executionDetailProvider.ts

@@ -8,9 +8,10 @@ import { getLogger } from '../../shared/logger/logger'
 import request from '../../shared/request'
 import { ToolkitError } from '../../shared/errors'
 import { i18n } from '../../shared/i18n-helper'
-import { ComponentType, WorkflowMode } from '../workflowStudio/types'
+import { ComponentType } from '../messageHandlers/types'
 import { isLocalDev, localhost, cdn } from '../constants/webviewResources'
-import { handleMessage, ExecutionDetailsContext } from './handleMessage'
+import { handleMessage } from './handleMessage'
+import { ExecutionDetailsContext } from '../messageHandlers/types'
 
 /**
  * Provider for Execution Details panels.
@@ -99,6 +100,13 @@ export class ExecutionDetailProvider {
 
             // Set up the content
             panel.webview.html = await this.getWebviewContent()
+            const context: ExecutionDetailsContext = {
+                stateMachineName: executionArn.split(':').pop() || 'Unknown',
+                panel,
+                loaderNotification: undefined,
+                fileId: executionArn,
+                executionArn,
+            }
 
             // Create execution details context
             const context: ExecutionDetailsContext = {

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

@@ -8,20 +8,15 @@ import {
     Command,
     Message,
     MessageType,
-    WebviewContext,
+    ExecutionDetailsContext,
     ApiCallRequestMessage,
-    UnsupportedMessage,
     InitResponseMessage,
-} from '../workflowStudio/types'
-
-import { WorkflowStudioApiHandler } from '../workflowStudio/workflowStudioApiHandler'
-import globals from '../../shared/extensionGlobals'
-import { getLogger } from '../../shared/logger/logger'
-
-// Extended context for execution details
-export interface ExecutionDetailsContext extends WebviewContext {
-    executionArn?: string
-}
+} from '../messageHandlers/types'
+import {
+    loadStageMessageHandler,
+    handleUnsupportedMessage,
+    apiCallMessageHandler,
+} from '../messageHandlers/handleMessageHelpers'
 
 /**
  * Handles messages received from the ExecutionDetails webview. Depending on the message type and command,
@@ -78,6 +73,7 @@ async function initMessageHandler(context: ExecutionDetailsContext) {
         } as InitResponseMessage)
     }
 }
+<<<<<<< HEAD
 
 /**
  * Handler for managing webview stage load, which updates load notifications.
@@ -118,3 +114,5 @@ async function handleUnsupportedMessage(context: ExecutionDetailsContext, origin
         originalMessage,
     } as UnsupportedMessage)
 }
+=======
+>>>>>>> 5aa458d7d (feat(stepfunctions): enable hardcoded execution details page)

packages/core/src/stepFunctions/messageHandlers/handleMessageHelpers.ts

@@ -0,0 +1,61 @@
+/*
+/*!
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+import {
+    Command,
+    Message,
+    MessageType,
+    WebviewContext,
+    ExecutionDetailsContext,
+    ApiCallRequestMessage,
+    UnsupportedMessage,
+} from './types'
+import { stepFunctionApiHandler } from './stepFunctionApiHandler'
+import globals from '../../shared/extensionGlobals'
+import { getLogger } from '../../shared/logger/logger'
+
+/**
+ * Handler for managing webview stage load, which updates load notifications.
+ * @param context The context object containing the necessary information for the webview.
+ */
+export async function loadStageMessageHandler(context: WebviewContext | ExecutionDetailsContext) {
+    context.loaderNotification?.progress.report({ increment: 25 })
+    setTimeout(() => {
+        context.loaderNotification?.resolve()
+    }, 100)
+}
+
+/**
+ * Handler for making API calls from the webview and returning the response.
+ * @param request The request message containing the API to call and the parameters
+ * @param context The webview context used for returning the API response to the webview
+ */
+export function apiCallMessageHandler(
+    request: ApiCallRequestMessage,
+    context: WebviewContext | ExecutionDetailsContext
+) {
+    const logger = getLogger('stepfunctions')
+    const apiHandler = new stepFunctionApiHandler(globals.awsContext.getCredentialDefaultRegion(), context)
+    apiHandler.performApiCall(request).catch((error) => logger.error('%s API call failed: %O', request.apiName, error))
+}
+
+/**
+ * Handles unsupported or unrecognized messages by sending a response to the webview. Ensures compatibility with future
+ * commands and message types, preventing issues if the user has an outdated extension version.
+ * @param context The context object containing information about the webview environment
+ * @param command The command received from the webview
+ * @param messageType The type of the message received
+ */
+export async function handleUnsupportedMessage(
+    context: WebviewContext | ExecutionDetailsContext,
+    originalMessage: Message
+) {
+    await context.panel.webview.postMessage({
+        messageType: MessageType.RESPONSE,
+        command: Command.UNSUPPORTED_COMMAND,
+        originalMessage,
+    } as UnsupportedMessage)
+}

packages/core/src/stepFunctions/workflowStudio/workflowStudioApiHandler.ts renamed to packages/core/src/stepFunctions/messageHandlers/stepFunctionApiHandler.ts

@@ -6,14 +6,21 @@
 import * as StepFunctions from '@aws-sdk/client-sfn'
 import { IamClient, IamRole } from '../../shared/clients/iam'
 import { StepFunctionsClient } from '../../shared/clients/stepFunctions'
-import { ApiAction, ApiCallRequestMessage, Command, MessageType, WebviewContext } from './types'
+import {
+    ApiAction,
+    ApiCallRequestMessage,
+    Command,
+    MessageType,
+    WebviewContext,
+    ExecutionDetailsContext,
+} from './types'
 import { telemetry } from '../../shared/telemetry/telemetry'
 import { ListRolesRequest } from '@aws-sdk/client-iam'
 
-export class WorkflowStudioApiHandler {
+export class stepFunctionApiHandler {
     public constructor(
         region: string,
-        private readonly context: WebviewContext,
+        private readonly context: WebviewContext | ExecutionDetailsContext,
         private readonly clients = {
             sfn: new StepFunctionsClient(region),
             iam: new IamClient(region),

packages/core/src/stepFunctions/workflowStudio/types.ts renamed to packages/core/src/stepFunctions/messageHandlers/types.ts

@@ -30,6 +30,14 @@ export type WebviewContext = {
     fileId: string
 }
 
+export type ExecutionDetailsContext = {
+    stateMachineName: string
+    panel: vscode.WebviewPanel
+    fileId: string
+    loaderNotification: undefined | LoaderNotification
+    executionArn: string
+}
+
 export type LoaderNotification = {
     progress: vscode.Progress<{
         message?: string | undefined

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

@@ -14,23 +14,25 @@ import {
     FileChangeEventTrigger,
     SyncFileRequestMessage,
     ApiCallRequestMessage,
-    UnsupportedMessage,
     WorkflowMode,
-} from './types'
+} from '../messageHandlers/types'
 import { submitFeedback } from '../../feedback/vue/submitFeedback'
 import { placeholder } from '../../shared/vscode/commands2'
 import * as nls from 'vscode-nls'
 import vscode from 'vscode'
 import { telemetry } from '../../shared/telemetry/telemetry'
 import { ToolkitError } from '../../shared/errors'
-import { WorkflowStudioApiHandler } from './workflowStudioApiHandler'
 import globals from '../../shared/extensionGlobals'
-import { getLogger } from '../../shared/logger/logger'
 import { publishStateMachine } from '../commands/publishStateMachine'
 import {
     getStateMachineDefinitionFromCfnTemplate,
     toUnescapedAslJsonString,
 } from '../commands/visualizeStateMachine/getStateMachineDefinitionFromCfnTemplate'
+import {
+    loadStageMessageHandler,
+    handleUnsupportedMessage,
+    apiCallMessageHandler,
+} from '../messageHandlers/handleMessageHelpers'
 
 const localize = nls.loadMessageBundle()
 
@@ -143,18 +145,6 @@ export async function broadcastFileChange(context: WebviewContext, trigger: File
     } as FileChangedMessage)
 }
 
-/**
- * Handler for managing webview stage load, which updates load notifications.
- * @param message The message containing the load stage.
- * @param context The context object containing the necessary information for the webview.
- */
-async function loadStageMessageHandler(context: WebviewContext) {
-    context.loaderNotification?.progress.report({ increment: 25 })
-    setTimeout(() => {
-        context.loaderNotification?.resolve()
-    }, 100)
-}
-
 /**
  * Handler for closing WFS custom editor. When called, disposes webview panel and opens default VSCode editor
  * @param context The context object containing the necessary information for the webview.
@@ -250,29 +240,3 @@ async function autoSyncFileMessageHandler(request: SyncFileRequestMessage, conte
         }
     })
 }
-
-/**
- * Handler for making API calls from the webview and returning the response.
- * @param request The request message containing the API to call and the parameters
- * @param context The webview context used for returning the API response to the webview
- */
-function apiCallMessageHandler(request: ApiCallRequestMessage, context: WebviewContext) {
-    const logger = getLogger('stepfunctions')
-    const apiHandler = new WorkflowStudioApiHandler(globals.awsContext.getCredentialDefaultRegion(), context)
-    apiHandler.performApiCall(request).catch((error) => logger.error('%s API call failed: %O', request.apiName, error))
-}
-
-/**
- * Handles unsupported or unrecognized messages by sending a response to the webview. Ensures compatibility with future
- * commands and message types, preventing issues if the user has an outdated extension version.
- * @param context The context object containing information about the webview environment
- * @param command The command received from the webview
- * @param messageType The type of the message received
- */
-async function handleUnsupportedMessage(context: WebviewContext, originalMessage: Message) {
-    await context.panel.webview.postMessage({
-        messageType: MessageType.RESPONSE,
-        command: Command.UNSUPPORTED_COMMAND,
-        originalMessage,
-    } as UnsupportedMessage)
-}

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

@@ -8,7 +8,7 @@ import * as vscode from 'vscode'
 import { telemetry } from '../../shared/telemetry/telemetry'
 import { i18n } from '../../shared/i18n-helper'
 import { broadcastFileChange } from './handleMessage'
-import { FileWatchInfo, WebviewContext, WorkflowMode } from './types'
+import { FileWatchInfo, WebviewContext, WorkflowMode } from '../messageHandlers/types'
 import { CancellationError } from '../../shared/utilities/timeoutUtils'
 import { handleMessage } from './handleMessage'
 import { isInvalidJsonFile } from '../utils'

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

@@ -15,7 +15,7 @@ import { getTabSizeSetting } from '../../shared/utilities/editorUtilities'
 import { WorkflowStudioEditor } from './workflowStudioEditor'
 import { i18n } from '../../shared/i18n-helper'
 import { isInvalidJsonFile, isInvalidYamlFile } from '../utils'
-import { ComponentType, WorkflowMode } from './types'
+import { ComponentType, WorkflowMode } from '../messageHandlers/types'
 import { isLocalDev, localhost, cdn } from '../constants/webviewResources'
 
 let clientId = ''