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 80.83%. Comparing base (51e671f) to head (90b3efe).

Additional details and impacted files

@@           Coverage Diff           @@
##             main   #32862   +/-   ##
=======================================
  Coverage   80.83%   80.83%           
=======================================
  Files         236      236           
  Lines       14253    14253           
  Branches     2490     2490           
=======================================
  Hits        11522    11522           
  Misses       2446     2446           
  Partials      285      285

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

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

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

…-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 🙏.

aaythapa · 2025-02-04T00:37:01Z

@mergify update

mergify · 2025-02-04T00:37:14Z

update

✅ Branch has been successfully updated

aaythapa

Thanks for contributing! Left some comments, mostly nits and questions I had

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

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

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

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

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

…-add-analytics-configuration

ren-yamanashi · 2025-02-06T13:35:08Z

@aaythapa

Thanks for your review!

I have fixed, so please confirm.

aaythapa

Thank you for contributing! Everything LGTM

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

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

mergify · 2025-02-06T23:54:57Z

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).

mergify · 2025-02-07T00:05:30Z

This pull request has been removed from the queue for the following reason: pull request branch update failed.

The pull request can't be updated

You should look at the reason for the failure and decide if the pull request needs to be fixed or if you want to requeue it.

If you want to requeue this pull request, you need to post a comment with the text: @mergifyio requeue

mergify · 2025-02-07T00:15:16Z

refresh

✅ Pull request refreshed

aaythapa · 2025-02-07T00:15:30Z

@mergify requeue

mergify · 2025-02-07T00:15:35Z

This pull request has been removed from the queue for the following reason: pull request branch update failed.

The pull request can't be updated

You should look at the reason for the failure and decide if the pull request needs to be fixed or if you want to requeue it.

If you want to requeue this pull request, you need to post a comment with the text: @mergifyio requeue

mergify · 2025-02-07T00:15:37Z

requeue

✅ The queue state of this pull request has been cleaned. It can be re-embarked automatically

mergify · 2025-02-07T06:51:44Z

This pull request has been removed from the queue for the following reason: pull request manually updated.

The pull request #32862 has been manually updated

You should look at the reason for the failure and decide if the pull request needs to be fixed or if you want to requeue it.

If you want to requeue this pull request, you need to post a comment with the text: @mergifyio requeue

Pull request has been modified.

mergify · 2025-02-07T07:25:15Z

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 · 2025-02-07T10:38:13Z

AWS CodeBuild CI Report

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

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

mergify · 2025-02-07T10:38:39Z

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).

github-actions · 2025-02-07T10:38:55Z

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.

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

Merge branch 'main' into 32837-feat-add-analytics-configuration

e5fd2b2

aaythapa self-assigned this Feb 4, 2025

aaythapa reviewed Feb 4, 2025

View reviewed changes

ren-yamanashi added 6 commits February 6, 2025 18:17

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

2d8fa34

…-add-analytics-configuration

docs: update jsdoc

daa8895

docs: update jsdoc

70c2e7e

feat: update analyticsConfiguration

77148f5

test: add assertion test

2b086e9

chore: add comment

1d81f37

aaythapa previously approved these changes Feb 6, 2025

View reviewed changes

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

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

packages/aws-cdk-lib/aws-cognito/test/user-pool-client.test.ts Show resolved Hide resolved

Merge branch 'main' into 32837-feat-add-analytics-configuration

92afe07

moelasmar approved these changes Feb 7, 2025

View reviewed changes

Merge branch 'main' into 32837-feat-add-analytics-configuration

90b3efe

mergify bot merged commit 1c98881 into aws:main Feb 7, 2025
20 checks passed

github-actions bot locked as resolved and limited conversation to collaborators Feb 7, 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

aaythapa commented Feb 4, 2025

mergify bot commented Feb 4, 2025

aaythapa left a comment

ren-yamanashi commented Feb 6, 2025 •

edited

Loading

aaythapa left a comment •

edited

Loading

mergify bot commented Feb 6, 2025

mergify bot commented Feb 7, 2025

mergify bot commented Feb 7, 2025

aaythapa commented Feb 7, 2025

mergify bot commented Feb 7, 2025

mergify bot commented Feb 7, 2025

mergify bot commented Feb 7, 2025

mergify bot commented Feb 7, 2025

aws-cdk-automation commented Feb 7, 2025

mergify bot commented Feb 7, 2025

github-actions bot commented Feb 7, 2025

feat(cognito): add analyticsConfiguration to UserPoolClient #32862

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

aaythapa commented Feb 4, 2025

mergify bot commented Feb 4, 2025

✅ Branch has been successfully updated

aaythapa left a comment

Choose a reason for hiding this comment

ren-yamanashi commented Feb 6, 2025 • edited Loading

aaythapa left a comment • edited Loading

Choose a reason for hiding this comment

mergify bot commented Feb 6, 2025

mergify bot commented Feb 7, 2025

mergify bot commented Feb 7, 2025

✅ Pull request refreshed

aaythapa commented Feb 7, 2025

mergify bot commented Feb 7, 2025

mergify bot commented Feb 7, 2025

✅ The queue state of this pull request has been cleaned. It can be re-embarked automatically

mergify bot commented Feb 7, 2025

mergify bot commented Feb 7, 2025

aws-cdk-automation commented Feb 7, 2025

AWS CodeBuild CI Report

mergify bot commented Feb 7, 2025

github-actions bot commented Feb 7, 2025

codecov bot commented Jan 12, 2025 •

edited

Loading

ren-yamanashi commented Jan 12, 2025 •

edited

Loading

ren-yamanashi commented Feb 6, 2025 •

edited

Loading

aaythapa left a comment •

edited

Loading