-
Notifications
You must be signed in to change notification settings - Fork 3.9k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
feat(cloudfront-origins): OriginGroup
supports custom originId
#31514
base: main
Are you sure you want to change the base?
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
A comment requesting an exemption should contain the text Exemption Request
. Additionally, if clarification is needed add Clarification Request
to a comment.
OriginGroup
supports custom originId
Exemption Request
Just adding originId; other existing origins I checked do not document these properties in the readme and do not include customizing originId in the integration tests. |
AWS CodeBuild CI Report
Powered by github-codebuild-logs, available on the AWS Serverless Application Repository |
The pull request linter fails with the following errors:
PRs must pass status checks before we can provide a meaningful review. If you would like to request an exemption from the status checks or clarification on feedback, please leave a comment on this PR containing ✅ A exemption request has been requested. Please wait for a maintainer's review. |
Issue # (if applicable)
Closes #31468.
Reason for this change
OriginGroup allows users to specify a custom originId for better readability and descriptiveness compared to the auto generated IDs.
Description of changes
Adding originId to OriginGroupProps was straightforward. Unfortunately, the existing design of the Distribution binding interfaces makes some assumptions that don't model the underlying domain accurately. Specifically, while it is convenient for all origins to implement IOrigin so they can be used with any Behavior, the IOrigin interface specifies a bind method that returns an OriginBindConfig having a CfnDistribution.OriginProperty and a failoverConfig. This is not an accurate way to model origin groups, as it treats a group as a singular origin (is-a relationship) that has a failover origin. Actually, an origin group is not a singular origin, but has a primary origin and failover origin. The difference is the current model implies only 2 origin IDs, while the latter more accurate model implies 3. I would have to make a lot of breaking changes to these interfaces to fix this design, so I just added an originGroupId property to OriginBindConfig to provide a way to return the 3rd ID needed. I consider it a bit messy but could not find another way without completely redesigning the binding object model.
Additionally, the duplicate ID checking is now more complicated. Since the existing model incorrectly treats the primary origin as the originId of the group, there was already a separate originGroupId property in the BoundOrigin. I guess that was a previous workaround for the problems with the model. As a result, adding an OriginGroup requires 4 comparisons with each existing Origin (cross product of originId and originGroupId, as there is really only one ID scope and they must be unique).
Description of how you validated changes
Unit tests added in origin-group.test.ts.
Checklist
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license