feat: physical names in the entire Construct Library #2878

skinny85 · 2019-06-15T01:28:23Z

This PR changes the xyzName attribute of all Resources in the Construct Library to be of type PhysicalName,
and adds an AWS linter rule that checks ensures conformance.

The name of the property can be any ending substring of the base name of the class with the Name
suffix - for example, if my resource is AwesomeFoobar, the name can be foobarName or awesomeFoobarName (that's because we often have Specialized1AwesomeFoobar and Specialized2AwesomeFoobar in our library, that share a base prop interface).

There were a few interesting cases in the library which I didn't change, as I wasn't sure of the semantics of the resources, or they would require class name changes. Would appreciate some guidance there. These were:

@aws-kms: AliasProps.name
@aws-ssm: ParameterOptions.name
@aws-applicationautoscaling: ScalableTargetProps.resourceId
@aws-route53: CommonHostedZoneProps.zoneName
@aws-route53: RecordSetOptions.recordName
@aws-apigateway: StageProps.stageName
@aws-servicediscovery: BaseNamespaceProps.name
@aws-config: CustomRuleProps.ruleName
@aws-config: ManagedRuleProps.ruleName
@aws-config: AccessKeysRotatedProps.ruleName
@aws-config: CloudFormationStackNotificationCheckProps.ruleName
@aws-config: CloudFormationStackDriftDetectionCheckProps.ruleName
@aws-rds: DatabaseClusterProps.databaseName / clusterIdentifier
@aws-rds: DatabaseInstanceSourceProps.databaseName

BREAKING CHANGE: all resourceName attributes have their type changed from string to cdk.PhysicalName.

Pull Request Checklist

Testing
- Unit test added (prefer not to modify an existing test, otherwise, it's probably a breaking change)
- CLI change?: coordinate update of integration tests with team
- cdk-init template change?: coordinated update of integration tests with team
Docs
- jsdocs: All public APIs documented
- README: README and/or documentation topic updated
- Design: For significant features, design document added to design folder
Title and Description
- Change type: title prefixed with fix, feat and module name in parens, which will appear in changelog
- Title: use lower-case and doesn't end with a period
- Breaking?: last paragraph: "BREAKING CHANGE: <describe what changed + link for details>"
- Issues: Indicate issues fixed via: "Fixes #xxx" or "Closes #xxx"
Sensitive Modules (requires 2 PR approvers)
- IAM Policy Document (in @aws-cdk/aws-iam)
- EC2 Security Groups and ACLs (in @aws-cdk/aws-ec2)
- Grant APIs (only if not based on official documentation with a reference)

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

…ral typing usages across the library).

… excludes.

…f the base class name.

…)" This reverts commit f0d8127.

rix0rrr · 2019-06-17T07:42:25Z

Oops, I over-eagerly merged this because I thought it was ready and was trying to get ahead of merge conflicts.

Only later did I realize the PR was still under discussion, so I undid the merge.

However, I can't seem to reopen the PR, so you're going to have to recreate it.

Sorry!

packages/@aws-cdk/aws-apigateway/lib/restapi.ts

packages/@aws-cdk/aws-apigateway/lib/vpc-link.ts

eladb · 2019-06-17T12:30:14Z

packages/@aws-cdk/aws-cloudtrail/lib/index.ts

+        resourceName: this.physicalName.value,
+      },
+    });
+    this.trailArn = resourceIdentifiers.arn;


How do we enforce using this and not just trail.trailArn? Seems voluntary... I am worried that most people will not know to do this.

That's fine; adding this later is a backwards-compatible change.

eladb · 2019-06-17T12:32:47Z

packages/@aws-cdk/aws-codecommit/test/test.codecommit.ts

-      const myRepository = new Repository(stack, 'MyRepository', props).notify('myTrigger');
+      const myRepository = new Repository(stack, 'MyRepository', {
+        repositoryName: PhysicalName.of('MyRepository'),
+      }).notify('myTrigger');


notify? is this an API we like?

Maybe not, but I don't feel like it's related to the physical name change.

skinny85 · 2019-06-17T22:42:11Z

Moved to #2894 after Rico rekt the PR 🙂

skinny85 requested a review from eladb June 15, 2019 01:28

skinny85 requested review from RomainMuller, SoManyHs and a team as code owners June 15, 2019 01:28

skinny85 added 26 commits June 16, 2019 10:59

Final form of the physical names linter rule.

5e25de2

Fix @aws-s3.

36685a5

Fix @aws-iam.

b22fb30

Fix @aws-cloudwatch.

a78cf61

Fix @aws-events.

aaeb328

Change ruleName in OnEventOptions to PhysicalName (needed for structu…

0cfe389

…ral typing usages across the library).

Fix @aws-kms.

371d4a8

Fix @aws-ssm.

6e40b9b

Fix @aws-applicationautoscaling.

4fa412c

Fix @aws-ec2.

4c02908

Fix @aws-ecr.

68ee714

Fix @aws-logs.

ce136e9

Fix @aws-stepfunctions.

f7f12b1

Fix @aws-cloudtrail.

f9d639b

Fix @aws-codepipeline.

9ca0e97

Fix @aws-dynamodb.

7b3364b

Fix @aws-elasticloadbalancing.

1b28bc3

Fix @aws-glue.

3cd21d4

Fix @aws-kinesis.

fb4b7da

Fix @aws-route53.

e758472

Fix @aws-sns.

13c81c4

Fix @aws-sqs.

d75b17f

Fix @aws-codecommit.

9393b69

Fix @aws-lambda.

2aa379f

Fix @aws-cloudformation.

ea5371c

Fix @aws-cognito.

06e746d

skinny85 added 20 commits June 16, 2019 10:59

Fix @aws-codedeploy.

45ed1ce

Fix @aws-eks.

8621711

Undo the chnages in @aws-servicediscovery for now, instead opting for…

5495b51

… excludes.

Fix @aws-ecs.

39ec5c5

Fix @aws-events-targets.

65f19cc

Fix @aws-codepipeline-actions.

7e540b5

Fix @aws-config.

3c09a2e

Fix @aws-ecs-patterns.

23fa6a6

Fix @aws-rds.

20b2484

Change the rule to accept property names that are ending substrings o…

8a9bbc2

…f the base class name.

Correct @aws-iam prop names.

b8756de

Correct @aws-lambda prop names.

eb11cdc

Correct @aws-cognito prop names.

11adb55

Correct @aws-elasticloadbalancingv2 prop names.

b47bfb5

Correct @aws-codedeploy prop names.

2e20289

Correct @aws-ecs prop names.

ae5a444

Correct @aws-codebuild prop names.

39a512f

Correct @aws-ec2 prop names.

eecc35d

Fix decdk.

6ec2ceb

Fix LoadBalancedFargateService.serviceName.

773da1b

skinny85 force-pushed the feature/physical-names-lint branch from e9babf4 to 773da1b Compare June 16, 2019 22:59

rix0rrr approved these changes Jun 17, 2019

View reviewed changes

rix0rrr merged commit f0d8127 into aws:master Jun 17, 2019

rix0rrr added a commit that referenced this pull request Jun 17, 2019

Revert "refactor: physical names in the entire Construct Library (#2878…

a798043

…)" This reverts commit f0d8127.

eladb reviewed Jun 17, 2019

View reviewed changes

skinny85 deleted the feature/physical-names-lint branch June 17, 2019 15:12

skinny85 mentioned this pull request Jun 17, 2019

feat: physical names in the entire Construct Library #2894

Merged

4 tasks

NGL321 added the contribution/core This is a PR that came from AWS. label Sep 27, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: physical names in the entire Construct Library #2878

feat: physical names in the entire Construct Library #2878

skinny85 commented Jun 15, 2019

rix0rrr commented Jun 17, 2019

eladb Jun 17, 2019

skinny85 Jun 17, 2019

eladb Jun 17, 2019

skinny85 Jun 17, 2019

skinny85 commented Jun 17, 2019

feat: physical names in the entire Construct Library #2878

feat: physical names in the entire Construct Library #2878

Conversation

skinny85 commented Jun 15, 2019

Pull Request Checklist

rix0rrr commented Jun 17, 2019

eladb Jun 17, 2019

Choose a reason for hiding this comment

skinny85 Jun 17, 2019

Choose a reason for hiding this comment

eladb Jun 17, 2019

Choose a reason for hiding this comment

skinny85 Jun 17, 2019

Choose a reason for hiding this comment

skinny85 commented Jun 17, 2019