fix(events-targets): add LogGroupTargetInput.fromObjectV2() method by paulhcsun · Pull Request #33720 · aws/aws-cdk

paulhcsun · 2025-03-10T16:51:54Z

Reason for this change

The LogGroupTargetInput.fromObject() function returns a RuleTargetInput instead of a LogGroupTargetInput. It can therefore not be passed into the following field:

export interface LogGroupProps extends TargetBaseProps {
  // ...
  readonly logEvent?: LogGroupTargetInput;
}

Because the types don't match.

This is a bug that hasn't shown up in TypeScript before because according to TypeScript's structural typing rules, the types RuleTargetInput and LogGroupTargetInput are compatible, but according to Java's nominal typing rules they are not.

Description of changes

Deprecated LogGroupTargetInput.fromObject() and created LogGroupTargetInput.fromObjectV2() which returns the correct type of LogGroupTargetInput.

Description of how you validated changes

integ test

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

(This review is outdated)

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

codecov · 2025-03-10T17:59:48Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 82.37%. Comparing base (3de0818) to head (c1dc834).

Additional details and impacted files

@@           Coverage Diff           @@
##             main   #33720   +/-   ##
=======================================
  Coverage   82.37%   82.37%           
=======================================
  Files         120      120           
  Lines        6933     6933           
  Branches     1169     1169           
=======================================
  Hits         5711     5711           
  Misses       1119     1119           
  Partials      103      103

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

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

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

🚀 New features to boost your workflow:

❄ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

aws-cdk-automation

(This review is outdated)

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

aws-cdk-automation

(This review is outdated)

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

5d · 2025-03-11T16:50:01Z

Just a general question, following the conventional approach, have you considered making logEvent in LogGroupProps an interface and then having RuleTargetInput and LogGroupTargetInput implement that interface?

gracelu0 · 2025-03-11T17:01:07Z

packages/aws-cdk-lib/aws-events-targets/lib/log-group.ts

+   * matched event.
+   */
+  public static fromObjectV2(options?: LogGroupTargetInputOptions): LogGroupTargetInput {
+    return RuleTargetInput.fromObjectV2({


should this be LogGroupTargetInput.fromObjectV2()?

Not necessarily but I don't think I need the duplicate V2 method in RuleTargetInput. I've updated this method in the latest commit.

packages/aws-cdk-lib/aws-events-targets/lib/log-group.ts

paulhcsun · 2025-03-11T17:06:19Z

Thanks for review @5d. I'm not able to change the type of logEvent because it's getting passed into the bind method here:

aws-cdk/packages/aws-cdk-lib/aws-events-targets/lib/log-group.ts

Line 137 in d1a8cbe

input: this.props.event ?? this.props.logEvent,

and if the type is changed then that call won't work anymore.

paulhcsun · 2025-03-11T21:50:53Z

@merigyfio update

paulhcsun · 2025-03-11T21:51:02Z

@Mergifyio update

mergify · 2025-03-11T21:51:25Z

update

✅ Branch has been successfully updated

aws-cdk-automation · 2025-03-11T22:22:03Z

AWS CodeBuild CI Report

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

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

mergify · 2025-03-11T22:22:31Z

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-03-11T22:22:47Z

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.

feat(events-targets): add LogGroupTargetInput.fromObjectV2() method

5e75377

github-actions bot added the p2 label Mar 10, 2025

aws-cdk-automation requested a review from a team March 10, 2025 16:52

mergify bot added the contribution/core This is a PR that came from AWS. label Mar 10, 2025

aws-cdk-automation previously requested changes Mar 10, 2025

View reviewed changes

paulhcsun added the pr-linter/exempt-readme The PR linter will not require README changes label Mar 10, 2025

paulhcsun changed the title ~~feat(events-targets): add LogGroupTargetInput.fromObjectV2() method~~ fix(events-targets): add LogGroupTargetInput.fromObjectV2() method Mar 10, 2025

paulhcsun removed the pr-linter/exempt-readme The PR linter will not require README changes label Mar 10, 2025

Merge branch 'main' into events-targets-log-group-from-objectv2

687518a

paulhcsun and others added 2 commits March 10, 2025 13:22

Merge branch 'main' into events-targets-log-group-from-objectv2

ae6125a

remove snapshots

4dc566b

aws-cdk-automation previously requested changes Mar 10, 2025

View reviewed changes

updated snpashots

511c3e1

remove snapshots again

79ab6c5

aws-cdk-automation previously requested changes Mar 10, 2025

View reviewed changes

snapshots

6a32e4c

aws-cdk-automation added the pr/needs-maintainer-review This PR needs a review from a Core Team Member label Mar 10, 2025

gracelu0 suggested changes Mar 11, 2025

View reviewed changes

aws-cdk-automation removed the pr/needs-maintainer-review This PR needs a review from a Core Team Member label Mar 11, 2025

paulhcsun and others added 4 commits March 11, 2025 10:08

Merge branch 'main' into events-targets-log-group-from-objectv2

221e737

update method + add unit tests

e76f213

fix linting

33876d0

update readme

942d95d

gracelu0 approved these changes Mar 11, 2025

View reviewed changes

Merge branch 'main' into events-targets-log-group-from-objectv2

c1dc834

mergify bot merged commit 584a58c into aws:main Mar 11, 2025
20 checks passed

github-actions bot locked as resolved and limited conversation to collaborators Mar 11, 2025

Conversation

paulhcsun commented Mar 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reason for this change

Description of changes

Description of how you validated changes

Checklist

Uh oh!

aws-cdk-automation left a comment • 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!

codecov bot commented Mar 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

aws-cdk-automation left a comment • 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!

aws-cdk-automation left a comment • 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!

5d commented Mar 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

gracelu0 Mar 11, 2025

Choose a reason for hiding this comment

Uh oh!

paulhcsun Mar 11, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

paulhcsun commented Mar 11, 2025

Uh oh!

paulhcsun commented Mar 11, 2025

Uh oh!

paulhcsun commented Mar 11, 2025

Uh oh!

mergify bot commented Mar 11, 2025

✅ Branch has been successfully updated

Uh oh!

aws-cdk-automation commented Mar 11, 2025

AWS CodeBuild CI Report

Uh oh!

mergify bot commented Mar 11, 2025

Uh oh!

Uh oh!

github-actions bot commented Mar 11, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

paulhcsun commented Mar 10, 2025 •

edited

Loading

aws-cdk-automation left a comment •

edited

Loading

codecov bot commented Mar 10, 2025 •

edited

Loading

aws-cdk-automation left a comment •

edited

Loading

aws-cdk-automation left a comment •

edited

Loading

5d commented Mar 11, 2025 •

edited

Loading