serverless-operations / serverless-operations/serverless-step-functions
Validate as a standalone command or earlier in process
Open
Nobody has claimed this yet.
enhancement
help wanted
- Dominant language
- JavaScript
- Stars
- 1k
- Forks
- 220
- PR merge metrics
- No merged PRs in 30d
Description
This is a Feature Proposal
Description
For feature proposals:
- Currently, it appears that the step function definition validation only occurs when executing
sls package. This is a long executing step, and it would be easier if we could have a way to validate the step function without going throughsls package. - Recently, while writing a step function definition, I misspelled the key word "Resource" within a task definition. Although I had the validate flag set to true, the
sls packagecommand exited before it got to validate because the misspelling caused issues with the IAM role creation. This led to a long period of debugging to discover that the cause was a misspelled word, when, in theory, the validate step would have caught the problem well ahead of that stage and described the problem to us, thus saving us a lot of time. - Barring a standalone command for validate, moving the validate check to the start of the sequence of
sls packagesteps would be equally useful. The earlier we can get a more human readable version of potential definition errors, the better.
Additional Data
- Serverless Framework Core Version you're using: 1.46.1
- The Plugin Version you're using: 2.7.0
- Operating System: Mac OS
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by tracing the validation flow triggered by the validate flag during sls package, including the point where IAM role creation can fail first. Define whether completion means adding a standalone validation command or moving validation earlier in sls package, then verify that misspelled Step Functions definitions produce a readable error before the longer packaging steps.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- aws, javascript
- Domain
- cli, cloud
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100