Skip to content
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

refactor(sns): move subscribers to aws-sns-subscribers #2804

Merged
merged 6 commits into from Jun 11, 2019

Conversation

rix0rrr
Copy link
Contributor

@rix0rrr rix0rrr commented Jun 10, 2019

In accordance with new guidelines, we're centralizing cross-service
integrations into their own package. In this case, centralizing
SNS Subscribers into @aws-cdk/aws-sns-subscribers.

BREAKING CHANGE: using a queue, lambda, email, URL as SNS Subscriber now
requires an integration object from the @aws-cdk/aws-sns-subscribers
package.


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.

In accordance with new guidelines, we're centralizing cross-service
integrations into their own package. In this case, centralizing
SNS Subscribers into @aws-cdk/aws-sns-subscribers.

BREAKING CHANGE: using a queue, lambda, email, URL as SNS Subscriber now
requires an integration object from the `@aws-cdk/aws-sns-subscribers`
package.
@rix0rrr rix0rrr requested review from RomainMuller, skinny85 and a team as code owners June 10, 2019 09:21
@rix0rrr rix0rrr added the p0 label Jun 10, 2019
Copy link
Contributor

@eladb eladb left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this should be “subscriptions” or “targets”, otherwise looks good!

@@ -62,7 +63,7 @@ export class ManualApprovalAction extends codepipeline.Action {
if (this._notificationTopic) {
this._notificationTopic.grantPublish(info.role);
for (const notifyEmail of this.props.notifyEmails || []) {
this._notificationTopic.subscribeEmail(`Subscription-${notifyEmail}`, notifyEmail);
this._notificationTopic.subscribe(new subs.EmailSubscriber(notifyEmail));
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Rename to addSubscriber

"@aws-cdk/cdk": "^0.33.0"
},
"engines": {
"node": ">= 8.10.0"
},
"awslint": {
"exclude": [
"construct-base-is-private:@aws-cdk/aws-sns.TopicBase"
"construct-base-is-private:@aws-cdk/aws-sns.TopicBase",
"integ-return-type:@aws-cdk/aws-sns.ITopicSubscription.bind"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we should update the awslint rule to allow void as a return type for bind

@@ -530,7 +530,7 @@ export class Construct implements IConstruct {
* Return whether the given object is a Construct
*/
public static isConstruct(x: any): x is Construct {
return CONSTRUCT_SYMBOL in x;
return typeof x === 'object' && x !== null && CONSTRUCT_SYMBOL in x;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ouch!

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should make sure all of our isXxx methods are implemented like this.

@@ -20,7 +21,7 @@ public HelloStack(Construct parent, string id, IStackProps props) : base(parent,
DisplayName = "My First Topic Yeah"
});

topic.SubscribeQueue(queue, null);
topic.AddSubscription(new SqsSubscription(queue, null));
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

what's this null?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I believe .NET does not support optional arguments

@rix0rrr rix0rrr requested a review from SoManyHs as a code owner June 11, 2019 08:58
@rix0rrr rix0rrr merged commit 9ef899c into master Jun 11, 2019
@rix0rrr rix0rrr deleted the huijbers/sns-subs branch June 11, 2019 09:45
@NGL321 NGL321 added the contribution/core This is a PR that came from AWS. label Sep 27, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
contribution/core This is a PR that came from AWS. p0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants