feat(stepfunctions): allow starting execution with no input provided (aws#6708)

## Problem
1. Currently when customer starts step function execution with no input
provided, they execution fails to start because of the blank input. It's
not intuitive why it failed and error message is not very descriptive.
2. Multiple SFN localization strings are missing in `package.nls.json`
3. Blank lines added after SFN outputs are misleading and may imply that
the process is not completed yet

## Solution
1. Allow starting execution with blank input - in that case we provide
empty object as an input. Also improving error message wording to be
more clear
2. Adding missing SFN strings to `package.nls.json`
3. Adding empty line only before logging command outputs. This way there
is still a clear separation but no misleading empty line at the end
---

- 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.

---------

Co-authored-by: Vlad Nikolaenko <[email protected]>
Co-authored-by: Maxim Hayes <[email protected]>

Author: 3 people

packages/core/package.nls.json

@@ -22,6 +22,16 @@
     "AWS.configuration.description.resources.enabledResources": "AWS resources to display in the 'Resources' portion of the explorer.",
     "AWS.configuration.description.featureDevelopment.allowRunningCodeAndTests": "Allow /dev to run code and test commands",
     "AWS.configuration.description.experiments": "Try experimental features and give feedback. Note that experimental features may be removed at any time.\n * `jsonResourceModification` - Enables basic create, update, and delete support for cloud resources via the JSON Resources explorer component.",
+    "AWS.stepFunctions.publishStateMachine.error.invalidYAML": "Cannot publish invalid YAML file",
+    "AWS.stepFunctions.publishStateMachine.info.creating": "Creating state machine '{0}' in {1}...",
+    "AWS.stepFunctions.publishStateMachine.info.createSuccess": "Created state machine '{0}'",
+    "AWS.stepFunctions.publishStateMachine.error.createFailure": "Failed to create state machine: {0}",
+    "AWS.stepFunctions.publishStateMachine.info.updating": "Updating state machine '{0}' in {1}...",
+    "AWS.stepFunctions.publishStateMachine.info.updateSuccess": "Updated state machine '{0}'",
+    "AWS.stepFunctions.publishStateMachine.error.updateFailure": "Failed to update state machine: {0}",
+    "AWS.stepFunctions.executeStateMachine.info.executing": "Starting execution of '{0}' in {1}...",
+    "AWS.stepFunctions.executeStateMachine.info.started": "Execution started",
+    "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.configuration.description.awssam.debug.api": "API Gateway configuration",

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

@@ -42,7 +42,7 @@ export async function publishStateMachine(
             text = JSON.stringify(load(text), undefined, '  ')
         } catch (error) {
             const localizedMsg = localize(
-                'AWS.message.error.stepFunctions.publishStateMachine.invalidYAML',
+                'AWS.stepFunctions.publishStateMachine.error.invalidYAML',
                 'Cannot publish invalid YAML file'
             )
 
@@ -80,9 +80,10 @@ async function createStateMachine(
     const logger: Logger = getLogger()
     logger.info(`Creating state machine '${wizardResponse.name}'`)
     outputChannel.show()
+    outputChannel.appendLine('')
     outputChannel.appendLine(
         localize(
-            'AWS.message.info.stepFunctions.publishStateMachine.creating',
+            'AWS.stepFunctions.publishStateMachine.info.creating',
             "Creating state machine '{0}' in {1}...",
             wizardResponse.name,
             region
@@ -96,23 +97,21 @@ async function createStateMachine(
         })
         outputChannel.appendLine(
             localize(
-                'AWS.message.info.stepFunctions.publishStateMachine.createSuccess',
-                'Created state machine "{0}"',
+                'AWS.stepFunctions.publishStateMachine.info.createSuccess',
+                "Created state machine '{0}'",
                 wizardResponse.name
             )
         )
         outputChannel.appendLine(result.stateMachineArn)
         logger.info(`Created "${result.stateMachineArn}"`)
-        outputChannel.appendLine('')
     } catch (err) {
         const msg = localize(
-            'AWS.message.error.stepFunctions.publishStateMachine.createFailure',
+            'AWS.stepFunctions.publishStateMachine.error.createFailure',
             'Failed to create state machine: {0}',
             wizardResponse.name
         )
         void showViewLogsMessage(msg)
         outputChannel.appendLine(msg)
-        outputChannel.appendLine('')
         logger.error(`Failed to create state machine '${wizardResponse.name}': %O`, err as Error)
     }
 }
@@ -127,9 +126,10 @@ async function updateStateMachine(
     const logger: Logger = getLogger()
     logger.info(`Updating state machine ${wizardResponse.stateMachineArn}`)
     outputChannel.show()
+    outputChannel.appendLine('')
     outputChannel.appendLine(
         localize(
-            'AWS.message.info.stepFunctions.publishStateMachine.updating',
+            'AWS.stepFunctions.publishStateMachine.info.updating',
             "Updating state machine '{0}' in {1}...",
             wizardResponse.stateMachineArn,
             region
@@ -142,22 +142,20 @@ async function updateStateMachine(
         })
         outputChannel.appendLine(
             localize(
-                'AWS.message.info.stepFunctions.publishStateMachine.updateSuccess',
+                'AWS.stepFunctions.publishStateMachine.info.updateSuccess',
                 'Updated state machine: {0}',
                 wizardResponse.stateMachineArn
             )
         )
         logger.info(`Updated ${wizardResponse.stateMachineArn}`)
-        outputChannel.appendLine('')
     } catch (err) {
         const msg = localize(
-            'AWS.message.error.stepFunctions.publishStateMachine.updateFailure',
+            'AWS.stepFunctions.publishStateMachine.error.updateFailure',
             'Failed to update state machine: {0}',
             wizardResponse.stateMachineArn
         )
         void showViewLogsMessage(msg)
         outputChannel.appendLine(msg)
-        outputChannel.appendLine('')
         logger.error(`Failed to update state machine '${wizardResponse.stateMachineArn}': %O`, err as Error)
     }
 }

packages/core/src/stepFunctions/vue/executeStateMachine/executeStateMachine.ts

@@ -44,10 +44,11 @@ export class ExecuteStateMachineWebview extends VueWebview {
         this.logger.info('Starting Step Functions State Machine execution')
 
         this.channel.show()
+        this.channel.appendLine('')
         this.channel.appendLine(
             localize(
-                'AWS.message.info.stepFunctions.executeStateMachine.executing',
-                'Executing {0} in {1}...',
+                'AWS.stepFunctions.executeStateMachine.info.executing',
+                'Starting execution of {0} in {1}...',
                 this.stateMachine.name,
                 this.stateMachine.region
             )
@@ -58,22 +59,19 @@ export class ExecuteStateMachineWebview extends VueWebview {
             const client = new DefaultStepFunctionsClient(this.stateMachine.region)
             const startExecResponse = await client.executeStateMachine(this.stateMachine.arn, input)
             this.logger.info('started execution for Step Functions State Machine')
-            this.channel.appendLine(
-                localize('AWS.message.info.stepFunctions.executeStateMachine.started', 'Execution started')
-            )
+            this.channel.appendLine(localize('AWS.stepFunctions.executeStateMachine.info.started', 'Execution started'))
             this.channel.appendLine(startExecResponse.executionArn)
         } catch (e) {
             executeResult = 'Failed'
             const error = e as Error
             this.logger.error('Error starting execution for Step Functions State Machine: %s', error)
             this.channel.appendLine(
                 localize(
-                    'AWS.message.error.stepFunctions.executeStateMachine.failed_to_start',
-                    'There was an error starting execution for {0}, check logs for more information.',
+                    'AWS.stepFunctions.executeStateMachine.error.failedToStart',
+                    'There was an error starting execution for {0}, check AWS Toolkit logs for more information.',
                     this.stateMachine.arn
                 )
             )
-            this.channel.appendLine('')
         } finally {
             telemetry.stepfunctions_executeStateMachine.emit({ result: executeResult })
         }

packages/core/src/stepFunctions/vue/executeStateMachine/executeStateMachine.vue

@@ -101,13 +101,13 @@ export default defineComponent({
             // const self = this
             if (inputFile.files && inputFile.files.length > 0) {
                 const reader = new FileReader()
-                reader.onload = event => {
+                reader.onload = (event) => {
                     if (event.target) {
                         const result = event.target.result
                         this.executionInput = result as string
                     }
                 } // desired file content
-                reader.onerror = error => {
+                reader.onerror = (error) => {
                     throw error
                 }
                 reader.readAsText(inputFile.files[0])
@@ -116,7 +116,7 @@ export default defineComponent({
             }
         },
         sendInput: function () {
-            client.executeStateMachine(this.executionInput)
+            client.executeStateMachine(this.executionInput || '{}')
         },
     },
     mixins: [saveData],

packages/toolkit/.changes/next-release/Feature-ea2a3511-72fa-4151-97c6-70f9b1dfb189.json

@@ -0,0 +1,4 @@
+{
+	"type": "Feature",
+	"description": "Step Functions: Allow starting state machine execution with no input provided"
+}