feat(ses): allow VDM settings at the configuration set level by mazyu36 · Pull Request #30051 · aws/aws-cdk

mazyu36 · 2024-05-03T12:53:45Z

Issue # (if applicable)

Closes #30041 .

Reason for this change

As described in the issue.

Description of changes

To allow VDM settings at the configuration set level, vdmOptions property has been added to the ConfigurationSet Construct.

new ses.ConfigurationSet(this, 'ConfigurationSetWithVdmOptions', {
  vdmOptions: { // Add
    engagementMetrics: true,
    optimizedSharedDelivery: true,
  },
});

Description of how you validated changes

I implemented unit tests and integration tests for the three cases.

Configuration set with both engagement metrics and optimized shared delivery enabled.
Configuration set with only engagement metrics enabled and optimized shared delivery not configured.
Configuration set with only optimized shared delivery enabled and engagement metrics not configured.

Checklist

My code adheres to the CONTRIBUTING GUIDE and DESIGN GUIDELINES

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

nmussy

Just minor issues, good work overall 👍

packages/aws-cdk-lib/aws-ses/README.md

nmussy · 2024-05-03T13:09:59Z

packages/aws-cdk-lib/aws-ses/lib/configuration-set.ts

+  /**
+   * The Virtual Deliverability Manager (VDM) options that apply to the configuration set
+   *
+   * @default - use account level settings


We should probably indicate what the default values are first, and mention that this can be overridden by account level settings

Thank you for the review.
I've stated that "default" indicates the absence of settings at the Configuration level, and in such cases, settings at the account level will be applied.

Sorry, I should have made myself clearer. I think it's more important to tell the users that by default, VDM options are disabled, unless there are account level settings. Your current documentation only states that if they happen to have account level settings, those will be used. I would expect most of the CDK users will not be using account level settings.

I understand. Sorry for the lack of explanation.

However, my understanding is that the configuration set level settings need to be used together with the account level settings. (Deploying with only the configuration set level settings enabled is possible, but VDM itself cannot be used until the account level settings are enabled.)

That's why I tried to include the above as a Note in the README, but I would like your opinion.
I'm a little unsure about how it should be written...

Oh, got it. The AWS documentation doesn't really make it explicit that they need to be enabled account wide first:

Virtual Deliverability Manager options are also provided at the configuration set level so you can define custom settings for how a configuration set will use engagement tracking and optimized shared delivery by overriding how they’ve been defined in Virtual Deliverability Manager.

I would really emphasize it in the TSDoc as well, the README seems to have it covered

@nmussy
Thank you. I have added a note to the README and docs that when setting Account Level settings with CDK, VdmAttributes should be used.

nmussy · 2024-05-03T13:10:32Z

packages/aws-cdk-lib/aws-ses/lib/configuration-set.ts

+  /**
+   * Whether engagement metrics are enabled for the configuration set
+   *
+   * @default - use account level settings


It's the same as the comment above.

nmussy · 2024-05-03T13:10:36Z

packages/aws-cdk-lib/aws-ses/lib/configuration-set.ts

+  /**
+   * Whether optimized shared delivery is enabled for the configuration set
+   *
+   * @default - use account level settings


It's the same as the comment above.

packages/aws-cdk-lib/aws-ses/test/configuration-set.test.ts

nmussy · 2024-05-03T13:14:46Z

packages/aws-cdk-lib/aws-ses/test/configuration-set.test.ts

+test('configuration set with engagement metrics only', () => {
+  new ConfigurationSet(stack, 'ConfigurationSet', {
+    vdmOptions: {
+      engagementMetrics: true,
+    },
+  });
+
+  Template.fromStack(stack).hasResourceProperties('AWS::SES::ConfigurationSet', {
+    VdmOptions: {
+      DashboardOptions: {
+        EngagementMetrics: 'ENABLED',
+      },
+      GuardianOptions: Match.absent(),
+    },
+  });
+});
+
+test('configuration set with optimized shared delivery only', () => {
+  new ConfigurationSet(stack, 'ConfigurationSet', {
+    vdmOptions: {
+      optimizedSharedDelivery: true,
+    },
+  });
+
+  Template.fromStack(stack).hasResourceProperties('AWS::SES::ConfigurationSet', {
+    VdmOptions: {
+      DashboardOptions: Match.absent(),
+      GuardianOptions: {
+        OptimizedSharedDelivery: 'ENABLED',
+      },
+    },
+  });
+});


These tests seem a bit superfluous, given they're already being covered by the first one. It'd be more appropriate to test vdmOptions: {false, false} and vdmOptions: {},

I've added test cases for when both options in vdmOptions are set to "DISABLED" and when vdmOptions itself is not configured.

Additionally, I'm sorry to say that I've realized from the results of these tests that the "DISABLED" setting cannot be implemented. Therefore, I'm revisiting the implementation of vdmOptions.

Have you tried setting it to DISABLED with ENABLED account wide settings? That might be the only allowed use case

Yes, I did and I could.

As I mentioned in a separate comment, the configuration set level settings can be deployed on their own, but to enable VDM, it is appropriate to configure them together with the account level settings.
Therefore, I also added the account level settings to the integration tests.

packages/aws-cdk-lib/aws-ses/lib/configuration-set.ts

Co-authored-by: Jimmy Gaussen <jimmy.gaussen@gmail.com>

packages/aws-cdk-lib/aws-ses/lib/configuration-set.ts

mazyu36 · 2024-05-03T16:32:48Z

@nmussy
Thank you for your review! I have addressed the comments you provided.

packages/aws-cdk-lib/aws-ses/README.md

nmussy · 2024-05-04T13:27:27Z

...ges/@aws-cdk-testing/framework-integ/test/aws-ses/test/integ.configuration-set-vdmoptions.ts

+    new ses.VdmAttributes(this, 'VdmAccountLevelSettings', {
+      engagementMetrics: true,
+      optimizedSharedDelivery: true,
+    });


So there are the account-wide settings? I would indicate the construct name in the README and the TSDoc if that's the case

As per the other comments, the README and docs have been updated.

nmussy · 2024-05-04T13:28:44Z

...ges/@aws-cdk-testing/framework-integ/test/aws-ses/test/integ.configuration-set-vdmoptions.ts

+new integ.IntegTest(app, 'ConfigurationSetVdmOptionsInteg', {
+  testCases: [new TestStack(app, 'cdk-ses-configuration-set-vdmoptions-integ')],
+});


It's probably a good idea to run some assertions to make sure that the configuration sets and VdmAttributes are created with the expected values, see integ-tests. Let me know if you need some guidance

@nmussy
Thank you for your comments. I have added assertions using AwsApiCall for integration testing. Please let me know if there are any inappropriate parts.

Co-authored-by: Jimmy Gaussen <jimmy.gaussen@gmail.com>

nmussy

LGTM, thanks for the changes 👍

GavinZZ

Nice work, thanks for contributing!

mergify · 2024-06-18T20:34:51Z

Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

aws-cdk-automation · 2024-06-18T21:10:07Z

AWS CodeBuild CI Report

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

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

mergify · 2024-06-18T21:10:28Z

Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

### Issue # (if applicable) Closes aws#30041 . ### Reason for this change As described in the issue. ### Description of changes To allow VDM settings at the configuration set level, `vdmOptions` property has been added to the `ConfigurationSet` Construct. ```ts new ses.ConfigurationSet(this, 'ConfigurationSetWithVdmOptions', { vdmOptions: { // Add engagementMetrics: true, optimizedSharedDelivery: true, }, }); ``` ### Description of how you validated changes I implemented unit tests and integration tests for the three cases. 1. Configuration set with both engagement metrics and optimized shared delivery enabled. 2. Configuration set with only engagement metrics enabled and optimized shared delivery not configured. 3. Configuration set with only optimized shared delivery enabled and engagement metrics not configured. ### Checklist - [x] My code adheres to the [CONTRIBUTING GUIDE](https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md) and [DESIGN GUIDELINES](https://github.com/aws/aws-cdk/blob/main/docs/DESIGN_GUIDELINES.md) ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*

aws-cdk-automation · 2024-07-25T21:11:35Z

Comments on closed issues and PRs are hard for our team to see. If you need help, please open a new issue that references this one.

allow VDM settings at the configuration set level

7c1e6cd

github-actions bot added beginning-contributor [Pilot] contributed between 0-2 PRs to the CDK effort/small Small work item – less than a day of effort feature-request A feature should be added or improved. p2 labels May 3, 2024

aws-cdk-automation requested a review from a team May 3, 2024 12:54

mazyu36 changed the title ~~(ses): allow VDM settings at the configuration set level~~ feat(ses): allow VDM settings at the configuration set level May 3, 2024

nmussy suggested changes May 3, 2024

View reviewed changes

mazyu36 and others added 6 commits May 3, 2024 22:29

Update packages/aws-cdk-lib/aws-ses/README.md

d1faf01

Co-authored-by: Jimmy Gaussen <jimmy.gaussen@gmail.com>

Update packages/aws-cdk-lib/aws-ses/test/configuration-set.test.ts

f2d96f2

Co-authored-by: Jimmy Gaussen <jimmy.gaussen@gmail.com>

Update packages/aws-cdk-lib/aws-ses/lib/configuration-set.ts

4272bbb

Co-authored-by: Jimmy Gaussen <jimmy.gaussen@gmail.com>

Update packages/aws-cdk-lib/aws-ses/lib/configuration-set.ts

8618f25

Co-authored-by: Jimmy Gaussen <jimmy.gaussen@gmail.com>

Merge branch 'main' into ses-vdmoptions

1b651a7

fix: vdmOptions setting logic

35c80fd

mazyu36 commented May 3, 2024

View reviewed changes

packages/aws-cdk-lib/aws-ses/lib/configuration-set.ts Show resolved Hide resolved

mazyu36 commented May 3, 2024

View reviewed changes

packages/aws-cdk-lib/aws-ses/lib/configuration-set.ts Show resolved Hide resolved

fix: comment and integ test

e00cd46

nmussy reviewed May 4, 2024

View reviewed changes

packages/aws-cdk-lib/aws-ses/README.md Outdated Show resolved Hide resolved

nmussy reviewed May 4, 2024

View reviewed changes

mazyu36 and others added 4 commits May 5, 2024 11:05

Update packages/aws-cdk-lib/aws-ses/README.md

5479acc

Co-authored-by: Jimmy Gaussen <jimmy.gaussen@gmail.com>

fix: revert

74a02d8

fix: docs and integ test update

736e0a0

Merge branch 'main' into ses-vdmoptions

e4b2ddd

nmussy approved these changes May 6, 2024

View reviewed changes

aws-cdk-automation added the pr/needs-maintainer-review This PR needs a review from a Core Team Member label May 6, 2024

github-actions bot mentioned this pull request May 6, 2024

Weekly PR metrics report #30073

Closed

Merge branch 'main' into ses-vdmoptions

aea1d72

github-actions bot mentioned this pull request Jun 1, 2024

Monthly PR metrics report #30414

Closed

GavinZZ approved these changes Jun 18, 2024

View reviewed changes

Merge branch 'main' into ses-vdmoptions

0059d36

aws-cdk-automation removed the pr/needs-maintainer-review This PR needs a review from a Core Team Member label Jun 18, 2024

mergify bot merged commit 49a98ac into aws:main Jun 18, 2024

mazyu36 deleted the ses-vdmoptions branch June 21, 2024 03:23

This was referenced Jul 12, 2024

[Snyk] Upgrade: , aws-cdk NOUIY/aws-solutions-constructs#108

Open

[Snyk] Upgrade: , aws-cdk NOUIY/aws-solutions-constructs#109

Open

This was referenced Jul 19, 2024

[Snyk] Upgrade: , aws-cdk NOUIY/aws-solutions-constructs#110

Open

[Snyk] Upgrade: , aws-cdk NOUIY/aws-solutions-constructs#111

Open

aws locked as resolved and limited conversation to collaborators Jul 25, 2024

Conversation

mazyu36 commented May 3, 2024

Issue # (if applicable)

Reason for this change

Description of changes

Description of how you validated changes

Checklist

Uh oh!

nmussy left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

nmussy May 3, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

mazyu36 commented May 3, 2024

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

nmussy left a comment

Choose a reason for hiding this comment

Uh oh!

GavinZZ left a comment

Choose a reason for hiding this comment

Uh oh!

mergify bot commented Jun 18, 2024

Uh oh!

aws-cdk-automation commented Jun 18, 2024

AWS CodeBuild CI Report

Uh oh!

mergify bot commented Jun 18, 2024

Uh oh!

aws-cdk-automation commented Jul 25, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

nmussy May 3, 2024 •

edited

Loading