fix(core-stage): Fix stage name check to be aligned with stack name

[yuyokk]

Hi folks,

I faced the following errors today:

• error 1

invalid stage name "Stage acme.example.com". Stage name must start with a letter and contain only alphanumeric characters, hypens ('-'), underscores ('_') and periods ('.')

• error 2 (after fixing error 1)

Stack name must match the regular expression: /^[A-Za-z][A-Za-z0-9-]*$/, got 'DeploymentStage_acme.example.com-TenantCore'

I believe there is discrepancy in stage and stack names checks.

Please check changes on the PR and let me know if they make sense.
Thank you

---

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license

[gitpod-io]

[aws-cdk-automation]

The pull request linter has failed. See the aws-cdk-automation comment below for failure reasons. If you believe this pull request should receive an exemption, please comment and provide a justification.

[aws-cdk-automation]

AWS CodeBuild CI Report

• CodeBuild project: AutoBuildv2Project1C6BFA3F-wQm2hXv2jqQv
• Commit ID: a7cfdc1
• Result: SUCCEEDED
• Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

[mrgrain]

Hi @yuyokk I think this makes sense, but am very concerned about the implications of introducing more restrictive checks.

Could you please provide a reproduction example of how you run into this error, ideally by creating a new bug report or by linking an existing issue.

[mrgrain]

Reproduction example required.

[yuyokk]

@mrgrain here is the bug #23098

[peterwoodworth]

@mrgrain the reproduction posted looks good to me. Since stack names are built in part from stage names, would there be any case in which a stage is defined with . or _ and wouldn't contain a stack with these characters in the stack name? I don't think so, but maybe there's some edge case or functionality that isn't being accounted for here.

Essentially, for this to not be a breaking change that means that EVERY stage defined in any application also necessarily contains at least one stack whose name contains the stage name.

[mrgrain]

Thanks @peterwoodworth I agree with that assessment. I just haven't had time to look into the code path to confirm yet.

[aws-cdk-automation]

This PR has been in the CHANGES REQUESTED state for 3 weeks, and looks abandoned. To keep this PR from being closed, please continue work on it. If not, it will automatically be closed in a week.

[mrgrain]

Okay @peterwoodworth and @yuyokk This will be a breaking change and I'm really not sure if it's a good idea to have this fixed at all.

More discussions on the issue please, but here's what makes this breaking. The following code works right now but won't with the suggested change.

// somewhere in the pipeline stack
pipeline.addStage(new AppStage(this, "Stage_per_acme.example.com "));

// This is the Stage, note the provided stack name
class AppStage extends Stage {
  constructor(scope: Construct, id: string, props?: StageProps) {
    super(scope, id, props);

    new HelloCdkStack(this, "HelloCdkStack", {
      stackName: "hello"
    });
  }
}

[aws-cdk-automation]

This PR has been deemed to be abandoned, and will be automatically closed. Please create a new PR for these changes if you think this decision has been made in error.

[aws-cdk-automation]

The pull request linter fails with the following errors:

❌ Fixes must contain a change to an integration test file and the resulting snapshot.

PRs must pass status checks before we can provide a meaningful review.