New ${aws:xxx} variables added in serverless 2.50.0 and this plugin breaks packaging / deployment

[herebebogans]

minimal example to reproduce

service:
  name: aws-region-variable-test
plugins:
  - serverless-step-functions
provider:
  name: aws
  region: us-east-1
functions:
  example:
    handler: src/test.handler
    environment:
      AWS_REGION_TEST: ${aws:region}
      AWS_ACCOUNTID_TEST: ${aws:region}

$ sls package
Serverless Error ----------------------------------------
 
  Invalid variable reference syntax for variable aws:region. You can only reference env vars, options, & files. You can check our docs for more info.
 
  Get Support --------------------------------------------
     Docs:          docs.serverless.com
     Bugs:          github.com/serverless/serverless/issues
     Issues:        forum.serverless.com
 
  Your Environment Information ---------------------------
     Operating System:          darwin
     Node Version:              14.15.4
     Framework Version:         2.50.0
     Plugin Version:            5.4.3
     SDK Version:               4.2.3
     Components Version:        3.13.3

commenting serverless-step-functions results in packaging or deployment success

[pgrzesik]

Hello, after investigating as a part of serverless/serverless#9729, we've determined that the issue stems from the fact that the plugin uses old variable resolver (

serverless-step-functions/lib/yamlParser.js

Line 26 in da08c31

.then(serverlessFileParam => this.serverless.variables.populateObject(serverlessFileParam)

) which does not recognize sources such as aws and sls and additionally, it will be removed with v3 major release of the Serverless Framework. Given that fact, the best way to move forward would be to drop reliance on yamlParser and forcing variable resolution in plugin, but instead, use new resolver and rely on resolved configuration from serverless.configurationInput. That change would require a major release of the plugin, as not all Framework versions have support for new variable resolver.

We (me and @medikoo) will do our best to address this issue before v3 release of Serverless Framework.

[medikoo]

@horike37 we will be happy to propose PR's that fixes that.

Problem is related to fact that with recent versions of Framework new variable resolver was introduced and this plugin is not compatible with it.

Proposed solution:

1. Remove any variables resolution logic from plugin, as it's not needed with new variables resolver (it resolves variables in all configuration properties, so there's no need to introduce an additional patch that will resolve them with stepFunctions property)
2. Relaese it with a new major (v3) release of a plugin, which will be compatible only with latest Framework versions (minimum required version of serverless will be configured in plugin peerDependencies)
3. Introduce a maintenance release to v2 plugin version, which marks it as not compatible (via peerDependencies setting) with Framework versions where new variables resolver is working

Let us know, are you ok with that?

[medikoo]

Proposed a fix at #451

[horike37]

🎉 This issue has been resolved in version 3.0.0 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀