Logical ID naming is not following the convention with `-` or `_`

[kayhide]

This is a Bug Report

Logical ID naming is not following the convention if lambda function name contains - or _.

Description

With this settings:

service: dash

provider:
  name: aws
  runtime: nodejs6.10

functions:
  photo-resize:
    handler: handler.hello
  photo_recolor:
    handler: handler.hi

sls package produced cloudformation-template-update-stack.json including folloings:

• PhotoDashresizeLambdaFunction
• PhotoDashresizeLambdaVersionPSzzisjnTvvYknuXwQOlAvdkQZ67qXYSvgoAi9T8W0
• PhotoDashresizeLambdaFunctionQualifiedArn
• PhotoUnderscorerecolorLambdaFunction
• PhotoUnderscorerecolorLambdaVersionPSzzisjnTvvYknuXwQOlAvdkQZ67qXYSvgoAi9T8W0
• PhotoUnderscorerecolorLambdaFunctionQualifiedArn

Expected is like:

• PhotoDashResizeLambdaFunction
• PhotoUnderscoreRecolorLambdaFunction

as the document says:

https://github.com/serverless/serverless/blob/master/docs/providers/aws/guide/resources.md#override-aws-cloudformation-resource

This cause trouble when trying to hook S3 event, because we need to overwrite some auto generated resource.

https://github.com/serverless/serverless/blob/master/docs/providers/aws/events/s3.md#custom-bucket-configuration

Related to:

• 2717

Additional Data

  Your Environment Information -----------------------------
     OS:                     darwin
     Node Version:           6.10.3
     Serverless Version:     1.23.0

[HyperBrain]

Hey @kayhide - good find 👍

Normally, I would propose to fix the issue and do it right. But in this case it would break all existing deployments with resource names that include dashes or underscores if we fix the generation of the logical ids and lead to unusable stacks, or deployment failures.

I would go for a documentation change at the moment that explicitly states that Dash and Underscore will not camelcase the next text in the normalized name.

How does that sound?

[kayhide]

Hi @HyperBrain, thank you for your quick reply.

Yeah, I understand the situation. I am fine with leaving it as it is, and updating the document.

Just I hope the naming itself is fixed some day 😉

[kayhide]

About this documentation, I have a suggestion. https://github.com/serverless/serverless/blob/master/docs/providers/aws/events/s3.md#custom-bucket-configuration

functions:
  resize:
    handler: resize.handler
    events:
      - s3: photos

How about making it clear of the rule of bucket, like:

---

• If there is a resource defined with logical id of S3BucketPhotos, it is to be taken.
• If not, S3 bucket is to be created with the bucket name of photos.
• And if there is a resource whose bucket name is photos and logical id is NOT S3BucketPhotos, causes an ERROR trying to create another photos bucket.

---

Actually, I hit the third case and caused a problem. Bacause there is no support to change logical id of existing resource by AWS officially. https://forums.aws.amazon.com/thread.jspa?threadID=231788

So I needed some extra work to make its logical id to follow the serverless naming convention.

[kayhide]

Or more specifically, if we could write this way, it would be nicer.

functions:
  resize:
    handler: resize.handler
    events:
      - s3:
          logical_id: S3BucketPhotos

In this way, we get no need to explain the complicated meaning of bucket, and support any logical id. Just an idea.

[HyperBrain]

@kayhide Thank you for the suggestions.

@serverless/framework-maintainers What is your opinion on this?

[hassankhan]

Perhaps we could add this issue to the v2 milestone?

[horike37]

It may add this to v2 milestone if we would change the convention.