ilayanambi86 / serverless-plugin-resource-tagging Goto Github PK

I'll create a pull request to skip applying resource tags in this scenario. Documenting issue here for reference.

Issue: When an AWS resource has a root Properties-level CloudFormation conditional, this plugin still applies the Tags property, which breaks at deploy-time.

Sample in serverless.yml

provider:
  name: aws
  # ...
  stackTags:
    MyOrg:Name: github issue sample

custom:
  bucketProps:
    Fn::If:
      - IsOtherRegionDeployed
      - ${file(additional.yml):BucketProps.withReplication}
      - ${file(additional.yml):BucketProps.noReplication}

resources:
  # ...
  Resources:
    Bucket:
      Type: AWS::S3::Bucket
      Properties: ${self:custom.bucketProps}

Sample in cloudformation-template-update-stack.json

"Bucket": {
  "Type": "AWS::S3::Bucket",
  "Properties": {
    "Fn::If": [ // CloudFormation conditional evaluated at deploy-time
      "IsOtherRegionDeployed",
      {
        // with replication...
      },
      {
        // no replication
      }
    ],
    "Tags": [ // breaks the CloudFormation deploy due to conditional Fn::If
      {
        "Key": "MyOrg:Name",
        "Value": "github issue sample"
      }
    ]
  }
},

Upgrade underscore to version 1.12.1 or later. For example:

"dependencies": {
"underscore": ">=1.12.1"
}

This plugin works for every supported AWS resource listed here except Dynamo Tables. Any workaround to make it work against Dyanamo Tables?

I am using this plugin under the provider section of serverless like below.

plugins:
  - serverless-plugin-resource-tagging
  
provider:
  name: aws
  stackTags:
        STACK: "${self:service}"
        PRODUCT: "Produuct"
        PRODUCT_VERSION: "1.0"   

Although it works as expected with an S3 Bucket, CloudFormation, Kinesis, Lambda and API GATEWAYS.

I saw that this project has a dependency on the version 0.0.0 of the user package from npm: https://github.com/ilayanambi86/serverless-plugin-resource-tagging/blob/master/package.json#L29

Taking a look at its code in https://www.npmjs.com/package/user?activeTab=explore, we've found it to strangely contain absolutely nothing expect this:

module.exports = function() {
    return 'soon...';
};

Why exactly this was added as a dependency here?

Would it be possible to add support for some more common AWS resources, some possibilities might be:

• SNS Topics (AWS::SNS::Topic)
• Glue Jobs (AWS::Glue::Job)
• Glue Crawlers (AWS::Glue::Crawler)
• Glue ML Transform (AWS::Glue::MLTransform)
• Glue Trigger (AWS::Glue::Trigger)
• Glue Workflow (AWS::Glue::Workflow)

With multi-stack repository we have ApiGateway created in one stack and used in other stacks. So the "API" stack looks like this:

service: api

plugins:
  - serverless-plugin-resource-tagging

provider:
  name: aws
  stage: ${opt:stage}
  stackTags: ${file(../config.json):tags}

resources:
  Resources:

    ApiGateway:
      Type: AWS::ApiGateway::RestApi
      Properties:
        Name: ${self:custom.baseName}

After deployment process fails with error:

Stage dev on RestApi xxxxxxxxxx was not found

This looks like the plugin find that stack contains API Gateway and tries to find the Stage in it, and fails if it does not exist. Instead, it should just ignore it and not throw an error.

• For serverless >= 2.28.1, this.serverless.variables.options is undefined
• The plugin failed to check the stage in options
• We may need to use options instead, as suggested here