feat(stepfunctions): Custom editor to view and edit ASL files - tracer bullet #5613
Conversation
|
This pull request modifies files in src/ but no tests were added/updated. Confirm whether tests should be added or ensure the PR description explains why tests are not required. |
|
This pull request modifies a feature or fixes a bug, but it does not include a changelog entry. All pull requests that introduce new features or bug fixes must have a corresponding changelog item describing the changes. |
witness-me
changed the title
witness-me
changed the base branch from
master
to
feature/stepfunctions-workflow
packages/core/src/stepFunctionsWorkflowStudio/WorkflowStudioEditor.ts
Outdated
Show resolved
Hide resolved
packages/core/src/stepFunctionsWorkflowStudio/WorkflowStudioEditor.ts
Outdated
Show resolved
Hide resolved
packages/core/src/stepFunctionsWorkflowStudio/WorkflowStudioEditor.ts
Outdated
Show resolved
Hide resolved
packages/core/src/stepFunctionsWorkflowStudio/WorkflowStudioEditor.ts
Outdated
Show resolved
Hide resolved
packages/core/src/stepFunctionsWorkflowStudio/WorkflowStudioEditor.ts
Outdated
Show resolved
Hide resolved
packages/core/src/stepFunctionsWorkflowStudio/WorkflowStudioEditor.ts
Outdated
Show resolved
Hide resolved
packages/core/src/stepFunctionsWorkflowStudio/WorkflowStudioEditorProvider.ts
Outdated
Show resolved
Hide resolved
packages/core/src/stepFunctionsWorkflowStudio/WorkflowStudioEditorProvider.ts
Outdated
Show resolved
Hide resolved
packages/core/src/stepFunctionsWorkflowStudio/WorkflowStudioEditorProvider.ts
Outdated
Show resolved
Hide resolved
packages/core/src/stepFunctionsWorkflowStudio/WorkflowStudioEditor.ts
Outdated
Show resolved
Hide resolved
|
This pull request modifies code in src/ but no tests were added/updated. Confirm whether tests should be added or ensure the PR description explains why tests are not required. |
|
This pull request implements a feature or fix, so it must include a changelog entry. See CONTRIBUTING.md#changelog for instructions. |
| }, | ||
| { | ||
| "name": "stepfunctions_cancelOpenWorkflowStudio", | ||
| "description": "Called after cancelling opening asl file in Step Functions Workflow Studio", |
There was a problem hiding this comment.
It's never necessary to have a separate cancel event. All events can have result=success/fail/cancel.
Please review https://github.com/aws/aws-toolkit-vscode/blob/master/docs/telemetry.md
This is a blocking comment.
| void vscode.window.showInformationMessage(i18n('AWS.stepFunctions.workflowStudio.errors.rendering')) | ||
| this.logger.error(`WorkflowStudio: Unable to open file. ${err}`) |
There was a problem hiding this comment.
If resolveCustomTextEditor is called as the result of a vscode command or a webview, then Toolkit already has a default handler that logs the error and shows a message. It's not necessary, and discouraged, to repeat that logic in this way, because it leads to an incosistent UX.
Please review the guidlines here: https://github.com/aws/aws-toolkit-vscode/blob/master/CONTRIBUTING.md#develop
| @@ -480,6 +480,16 @@ | |||
| "name": "stepfunctions_previewstatemachine", | |||
| "description": "" | |||
| }, | |||
| { | |||
| "name": "stepfunctions_openWorkflowStudio", | |||
There was a problem hiding this comment.
Please plan to upstream this to https://github.com/aws/aws-toolkit-common as you near launch.
justinmk3
merged commit 080bc07
into
aws:feature/stepfunctions-workflow
Problem
ASL files, represented as *.asl.json and *.asl.yaml, are rendered using the default JSON editor
Solution
Use existing SFN visual custom editor in VSCode to render ASL files in a visual builder, similar to how it would be displayed in SFN console in create/edit modes.
Current pull request is a tracer bullet implementation without support for local file editing - this functionality will be added in the following changes
License: I confirm that my contribution is made under the terms of the Apache 2.0 license.