feat(cognito): add analyticsConfiguration to UserPoolClient #32862

ren-yamanashi · 2025-01-12T09:13:15Z

Issue # (if applicable)

Closes #32837

Reason for this change

UserPoolClient in Cognito did not support the analyticsConfiguration property.

Description of changes

add analytics property to UserPoolClientProps(interface)
add validationAnalytics method to UserPoolClient(Class / L2 Construct)

Description of how you validated changes

Added both unit and integration tests.

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

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.

A comment requesting an exemption should contain the text Exemption Request. Additionally, if clarification is needed add Clarification Request to a comment.

✅ Updated pull request passes all PRLinter validations. Dismissing previous PRLinter review.

…-add-analytics-configuration

codecov · 2025-01-12T10:20:51Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 81.38%. Comparing base (a734841) to head (5ca76ad).
Report is 1 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main   #32862   +/-   ##
=======================================
  Coverage   81.38%   81.38%           
=======================================
  Files         222      222           
  Lines       13695    13695           
  Branches     2412     2412           
=======================================
  Hits        11145    11145           
  Misses       2271     2271           
  Partials      279      279

Flag	Coverage Δ
suite.unit	`81.38% <ø> (ø)`

Flags with carried forward coverage won't be shown. Click here to find out more.

Components	Coverage Δ
packages/aws-cdk	`80.69% <ø> (ø)`
packages/aws-cdk-lib/core	`82.09% <ø> (ø)`

…-add-analytics-configuration

wladyslawczyzewski

hi @ren-yamanashi , thank you for this contribution, could you please adjust the validation and tests as described in the comments? thank you in advance!

wladyslawczyzewski · 2025-01-12T13:15:54Z

packages/aws-cdk-lib/aws-cognito/lib/user-pool-client.ts

@@ -618,4 +667,13 @@ export class UserPoolClient extends Resource implements IUserPoolClient {
      throw new Error(`${name}: Must be a duration between ${min.toHumanString()} and ${max.toHumanString()} (inclusive); received ${value.toHumanString()}.`);
    }
  }
+
+  private validateAnalytics(analytics: AnalyticsConfiguration) {


the CloudFormation expects either ApplicationArn or all of ApplicationId, ExternalId and RoleArn to be provided. Could you please adjust the validation for this?

wladyslawczyzewski · 2025-01-12T13:17:13Z

...s/@aws-cdk-testing/framework-integ/test/aws-cognito/test/integ.user-pool-client-analytics.ts

+//   resources: [pinpointApp.attrArn],
+// }));
+
+new UserPoolClient(stack, 'Client', {


cloud you please provide more test cases for 1) providing only ApplicationArn and using the Cognito's service role and 2) providing all of ApplicationId, ExternalId and RoleArn?

ren-yamanashi · 2025-01-12T13:31:08Z

hi @ren-yamanashi , thank you for this contribution, could you please adjust the validation and tests as described in the comments? thank you in advance!

@wladyslawczyzewski

Thank you comment !

I will adjust the PR content based on your comment and #32865 🙏.

…-add-analytics-configuration

ren-yamanashi · 2025-01-12T15:26:15Z

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

+If you specify the `applicationArn` property, do not specify the `applicationId`, `externalId`, or `roleArn` properties.
+
+```ts
+import * as pinpoint from 'aws-cdk-lib/aws-pinpoint';


The following error occurs at build time, so the import statement is added.

aws-cdk-lib.aws_cognito-README-L1123.ts:4:28 - error TS2503: Cannot find namespace 'pinpoint'. 4 declare const pinpointApp: pinpoint.CfnApp;

mergify · 2025-01-13T02:52:26Z

update

☑️ Nothing to do

#commits-behind > 0 [📌 update requirement]
-closed [📌 update requirement]
-conflict [📌 update requirement]
queue-position = -1 [📌 update requirement]

…-add-analytics-configuration

aws-cdk-automation · 2025-01-13T04:58:45Z

AWS CodeBuild CI Report

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

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

wladyslawczyzewski

thank you for your work on this! all looks good to me, now waiting for someone from maintainers to review and merge 🤞

lpizzinidev

Thanks 👍 Left comments for some initial adjustments.

lpizzinidev · 2025-01-27T17:52:15Z

packages/aws-cdk-lib/aws-cognito/lib/user-pool-client.ts

+      analytics.applicationArn &&
+        (analytics.applicationId || analytics.externalId || analytics.role)
+    ) {
+      throw new Error('Either `applicationArn` or all of `applicationId`, `externalId` and `role` must be specified.');


Can you please provide some docs/explanation about this validation?

lpizzinidev · 2025-01-27T17:56:02Z

packages/aws-cdk-lib/aws-cognito/lib/user-pool-client.ts

+ * The settings for Amazon Pinpoint analytics configuration.\
+ * With an analytics configuration, your application can collect user-activity metrics for user notifications with a Amazon Pinpoint campaign.\
+ * Amazon Pinpoint isn't available in all AWS Regions. For a list of available Regions, see [Amazon Cognito and Amazon Pinpoint Region availability](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-pinpoint-integration.html#cognito-user-pools-find-region-mappings).


Suggested change

* The settings for Amazon Pinpoint analytics configuration.\

* With an analytics configuration, your application can collect user-activity metrics for user notifications with a Amazon Pinpoint campaign.\

* Amazon Pinpoint isn't available in all AWS Regions. For a list of available Regions, see [Amazon Cognito and Amazon Pinpoint Region availability](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-pinpoint-integration.html#cognito-user-pools-find-region-mappings).

* The settings for Amazon Pinpoint analytics configuration.

* With an analytics configuration, your application can collect user-activity metrics for user notifications with an Amazon Pinpoint campaign.

* Amazon Pinpoint isn't available in all AWS Regions.

* For a list of available Regions, see [Amazon Cognito and Amazon Pinpoint Region availability](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-pinpoint-integration.html#cognito-user-pools-find-region-mappings).

Formatting.

lpizzinidev · 2025-01-27T17:56:40Z

packages/aws-cdk-lib/aws-cognito/lib/user-pool-client.ts

+   * The Amazon Resource Name (ARN) of an Amazon Pinpoint project that you want to connect to your user pool app client.\
+   * Amazon Cognito publishes events to the Amazon Pinpoint project that `ApplicationArn` declares. You can also configure your application to pass an endpoint ID in the `AnalyticsMetadata` parameter of sign-in operations. The endpoint ID is information about the destination for push notifications


Suggested change

* The Amazon Resource Name (ARN) of an Amazon Pinpoint project that you want to connect to your user pool app client.\

* Amazon Cognito publishes events to the Amazon Pinpoint project that `ApplicationArn` declares. You can also configure your application to pass an endpoint ID in the `AnalyticsMetadata` parameter of sign-in operations. The endpoint ID is information about the destination for push notifications

* The Amazon Resource Name (ARN) of an Amazon Pinpoint project that you want to connect to your user pool app client.

* Amazon Cognito publishes events to the Amazon Pinpoint project that `ApplicationArn` declares.

* You can also configure your application to pass an endpoint ID in the `AnalyticsMetadata` parameter of sign-in operations.

* The endpoint ID is information about the destination for push notifications.

Formatting

lpizzinidev · 2025-01-27T17:57:23Z

packages/aws-cdk-lib/aws-cognito/lib/user-pool-client.ts

+  readonly role?: IRole;
+
+  /**
+   * If `UserDataShared` is `true` , Amazon Cognito includes user data in the events that it publishes to Amazon Pinpoint analytics.


Suggested change

* If `UserDataShared` is `true` , Amazon Cognito includes user data in the events that it publishes to Amazon Pinpoint analytics.

* If `true`, Amazon Cognito includes user data in the events that it publishes to Amazon Pinpoint analytics.

Formatting.

ren-yamanashi added 4 commits January 12, 2025 17:50

feat: add analyticsConfiguration to UserPoolClient

d4ba257

feat: change property name

2444316

feat: add unit test

06842c4

docs: add documents

012183d

aws-cdk-automation requested a review from a team January 12, 2025 09:13

github-actions bot added effort/small Small work item – less than a day of effort feature-request A feature should be added or improved. p2 repeat-contributor [Pilot] contributed between 3-5 PRs to the CDK labels Jan 12, 2025

feat: change method name

67b914f

ren-yamanashi changed the title ~~feat: add analyticsConfiguration to UserPoolClient~~ feat(cognito): add analyticsConfiguration to UserPoolClient Jan 12, 2025

aws-cdk-automation previously requested changes Jan 12, 2025

View reviewed changes

feat: add integ test

6531be3

ren-yamanashi added 6 commits January 12, 2025 18:35

feat: update unit test

73ca9d9

chore: add jsdoc comment

3c7a594

docs: update README.md

0dcb1e2

feat: update integ test

c31198e

Merge branch 'main' of https://github.com/aws/aws-cdk into 32837-feat…

114fa85

…-add-analytics-configuration

feat: update jsDoc

228177a

ren-yamanashi added 5 commits January 12, 2025 19:26

Merge branch 'main' of https://github.com/aws/aws-cdk into 32837-feat…

8319091

…-add-analytics-configuration

feat: update integ test

9d26e09

feat: update integ test

080d156

Merge branch 'main' of https://github.com/aws/aws-cdk into 32837-feat…

0bc7aac

…-add-analytics-configuration

feat: update integ test

415929d

ren-yamanashi changed the title ~~feat(cognito): add analyticsConfiguration to UserPoolClient~~ feat(cognito): add analyticsConfiguration to UserPoolClient [WIP] Jan 12, 2025

wladyslawczyzewski reviewed Jan 12, 2025

View reviewed changes

feat: implementation modification at user-pool-client.ts

407ee7e

ren-yamanashi added 5 commits January 12, 2025 22:51

test: fix test

c12092d

test: update unit test

47e8800

docs: update README.md

73ddec4

docs: update README.md

bed1061

test: update integ test

91569e3

ren-yamanashi changed the title ~~feat(cognito): add analyticsConfiguration to UserPoolClient [WIP]~~ feat(cognito): add analyticsConfiguration to UserPoolClient Jan 12, 2025

ren-yamanashi added 9 commits January 12, 2025 23:43

Merge branch 'main' of https://github.com/aws/aws-cdk into 32837-feat…

73b368c

…-add-analytics-configuration

docs: update README.md

b1098de

docs: update README.md

436a666

feat: change property name

af90b5c

feat: change import order

4c548c2

feat: update property type

0cf0934

test: update integ test

2804b8c

docs: update README.md

5959b3e

Merge branch 'main' of https://github.com/aws/aws-cdk into 32837-feat…

2c82f2e

…-add-analytics-configuration

ren-yamanashi commented Jan 13, 2025

View reviewed changes

aws-cdk-automation added the pr/needs-community-review This PR needs a review from a Trusted Community Member or Core Team Member. label Jan 13, 2025

test: update integ test

03948d8

ren-yamanashi added 5 commits January 13, 2025 11:57

test: update integ test

f16fa90

test: update integ test

0c03d77

Merge branch 'main' of https://github.com/aws/aws-cdk into 32837-feat…

683ddf0

…-add-analytics-configuration

test: update integ test

a3904fd

Merge branch 'main' of https://github.com/aws/aws-cdk into 32837-feat…

5ca76ad

…-add-analytics-configuration

wladyslawczyzewski approved these changes Jan 13, 2025

View reviewed changes

lpizzinidev suggested changes Jan 27, 2025

View reviewed changes

aws-cdk-automation removed the pr/needs-community-review This PR needs a review from a Trusted Community Member or Core Team Member. label Jan 27, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(cognito): add analyticsConfiguration to UserPoolClient #32862

feat(cognito): add analyticsConfiguration to UserPoolClient #32862

ren-yamanashi commented Jan 12, 2025

aws-cdk-automation left a comment

codecov bot commented Jan 12, 2025 •

edited

Loading

wladyslawczyzewski left a comment

wladyslawczyzewski Jan 12, 2025

wladyslawczyzewski Jan 12, 2025

ren-yamanashi commented Jan 12, 2025 •

edited

Loading

ren-yamanashi Jan 12, 2025

mergify bot commented Jan 13, 2025

aws-cdk-automation commented Jan 13, 2025

wladyslawczyzewski left a comment

lpizzinidev left a comment

lpizzinidev Jan 27, 2025

lpizzinidev Jan 27, 2025

lpizzinidev Jan 27, 2025

lpizzinidev Jan 27, 2025

		* The Amazon Resource Name (ARN) of an Amazon Pinpoint project that you want to connect to your user pool app client.\
		* Amazon Cognito publishes events to the Amazon Pinpoint project that `ApplicationArn` declares. You can also configure your application to pass an endpoint ID in the `AnalyticsMetadata` parameter of sign-in operations. The endpoint ID is information about the destination for push notifications

	* If `UserDataShared` is `true` , Amazon Cognito includes user data in the events that it publishes to Amazon Pinpoint analytics.
	* If `true`, Amazon Cognito includes user data in the events that it publishes to Amazon Pinpoint analytics.

feat(cognito): add analyticsConfiguration to UserPoolClient #32862

Are you sure you want to change the base?

feat(cognito): add analyticsConfiguration to UserPoolClient #32862

Conversation

ren-yamanashi commented Jan 12, 2025

Issue # (if applicable)

Reason for this change

Description of changes

Description of how you validated changes

Checklist

aws-cdk-automation left a comment

Choose a reason for hiding this comment

codecov bot commented Jan 12, 2025 • edited Loading

Codecov Report

wladyslawczyzewski left a comment

Choose a reason for hiding this comment

wladyslawczyzewski Jan 12, 2025

Choose a reason for hiding this comment

wladyslawczyzewski Jan 12, 2025

Choose a reason for hiding this comment

ren-yamanashi commented Jan 12, 2025 • edited Loading

ren-yamanashi Jan 12, 2025

Choose a reason for hiding this comment

mergify bot commented Jan 13, 2025

☑️ Nothing to do

aws-cdk-automation commented Jan 13, 2025

AWS CodeBuild CI Report

wladyslawczyzewski left a comment

Choose a reason for hiding this comment

lpizzinidev left a comment

Choose a reason for hiding this comment

lpizzinidev Jan 27, 2025

Choose a reason for hiding this comment

lpizzinidev Jan 27, 2025

Choose a reason for hiding this comment

lpizzinidev Jan 27, 2025

Choose a reason for hiding this comment

lpizzinidev Jan 27, 2025

Choose a reason for hiding this comment

codecov bot commented Jan 12, 2025 •

edited

Loading

ren-yamanashi commented Jan 12, 2025 •

edited

Loading