Implemented common context for both WebviewContext and ExecutionDetailsContext

Author: Diler Zaza

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

@@ -4,15 +4,7 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-import {
-    Command,
-    Message,
-    MessageType,
-    WebviewContext,
-    ExecutionDetailsContext,
-    ApiCallRequestMessage,
-    UnsupportedMessage,
-} from './types'
+import { Command, Message, MessageType, BaseContext, ApiCallRequestMessage, UnsupportedMessage } from './types'
 import { StepFunctionApiHandler } from './stepFunctionApiHandler'
 import globals from '../../shared/extensionGlobals'
 import { getLogger } from '../../shared/logger/logger'
@@ -21,7 +13,7 @@ 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) {
+export async function loadStageMessageHandler(context: BaseContext) {
     context.loaderNotification?.progress.report({ increment: 25 })
     setTimeout(() => {
         context.loaderNotification?.resolve()
@@ -33,10 +25,7 @@ export async function loadStageMessageHandler(context: WebviewContext | Executio
  * @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
-) {
+export function apiCallMessageHandler(request: ApiCallRequestMessage, context: BaseContext) {
     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))
@@ -49,10 +38,7 @@ export function apiCallMessageHandler(
  * @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
-) {
+export async function handleUnsupportedMessage(context: BaseContext, originalMessage: Message) {
     await context.panel.webview.postMessage({
         messageType: MessageType.RESPONSE,
         command: Command.UNSUPPORTED_COMMAND,

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

@@ -6,21 +6,14 @@
 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,
-    ExecutionDetailsContext,
-} from './types'
+import { ApiAction, ApiCallRequestMessage, Command, MessageType, BaseContext } from './types'
 import { telemetry } from '../../shared/telemetry/telemetry'
 import { ListRolesRequest } from '@aws-sdk/client-iam'
 
 export class StepFunctionApiHandler {
     public constructor(
         region: string,
-        private readonly context: WebviewContext | ExecutionDetailsContext,
+        private readonly context: BaseContext,
         private readonly clients = {
             sfn: new StepFunctionsClient(region),
             iam: new IamClient(region),

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

@@ -16,23 +16,24 @@ export enum WorkflowMode {
     Readonly = 'readonly',
 }
 
-export type WebviewContext = {
+export interface BaseContext {
+    panel: vscode.WebviewPanel
+    loaderNotification: undefined | LoaderNotification
+}
+
+export interface WebviewContext extends BaseContext {
     stateMachineName: string
     mode: WorkflowMode
-    panel: vscode.WebviewPanel
     textDocument: vscode.TextDocument
     disposables: vscode.Disposable[]
     workSpacePath: string
     defaultTemplatePath: string
     defaultTemplateName: string
     fileStates: Record<string, FileWatchInfo>
-    loaderNotification: undefined | LoaderNotification
     fileId: string
 }
 
-export type ExecutionDetailsContext = {
-    panel: vscode.WebviewPanel
-    loaderNotification: undefined | LoaderNotification
+export interface ExecutionDetailsContext extends BaseContext {
     executionArn: string
 }