Skip to content

Conversation

@kaizencc
Copy link
Contributor

Issue # (if applicable)

Closes #.

Reason for this change

Description of changes

Describe any new or updated permissions being added

Description of how you validated changes

Checklist


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

@github-actions github-actions bot added the p2 label Jan 28, 2025
@aws-cdk-automation aws-cdk-automation requested a review from a team January 28, 2025 22:21
@mergify mergify bot added the contribution/core This is a PR that came from AWS. label Jan 28, 2025
@codecov
Copy link

codecov bot commented Jan 28, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 80.84%. Comparing base (a486bbc) to head (2d70332).

Additional details and impacted files
@@           Coverage Diff           @@
##             main   #33219   +/-   ##
=======================================
  Coverage   80.84%   80.84%           
=======================================
  Files         232      232           
  Lines       14135    14135           
  Branches     2460     2460           
=======================================
  Hits        11428    11428           
  Misses       2427     2427           
  Partials      280      280           
Flag Coverage Δ
suite.unit 80.84% <ø> (ø)

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

Components Coverage Δ
packages/aws-cdk 79.64% <ø> (ø)
packages/aws-cdk-lib/core 82.17% <ø> (ø)

@kaizencc kaizencc marked this pull request as ready for review January 29, 2025 22:55
@aws-cdk-automation aws-cdk-automation added the pr/needs-maintainer-review This PR needs a review from a Core Team Member label Jan 29, 2025
*
* @default - not monitoring CloudWatch logs
*/
readonly cloudWatchLogMonitor?: CloudWatchLogEventMonitor;
Copy link
Contributor

Choose a reason for hiding this comment

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

Do we really want to make this a public interface? What is the benefit of providing this as a customizable class?
Or would be better off turning this into a boolean option streamLogs?: boolean?

Copy link
Contributor

Choose a reason for hiding this comment

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

If we do want this as a public interface, it will have to be an ICloudWatchLogEventMonitor etc.

*
* @default - not monitoring CloudWatch logs
*/
readonly cloudWatchLogMonitor?: CloudWatchLogEventMonitor;
Copy link
Contributor

Choose a reason for hiding this comment

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

If we do want this as a public interface, it will have to be an ICloudWatchLogEventMonitor etc.

@aws-cdk-automation aws-cdk-automation removed the pr/needs-maintainer-review This PR needs a review from a Core Team Member label Jan 30, 2025
*
* @default - not monitoring CloudWatch logs
*/
readonly cloudWatchLogMonitor?: CloudWatchLogEventMonitor;
Copy link
Contributor Author

Choose a reason for hiding this comment

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

this is under ExtendedDeployOptions which is only used by watch and not used by customers. therefore i think it's fine/appropriate for it to be typed CloudWatchLogEventMonitor without the I because it is meant to always be the CloudWatchLogEventMonitor class.

Comment on lines 178 to 179
* Whether to show logs from all CloudWatch log groups in the template
* locally in the users terminal
Copy link
Contributor

@mrgrain mrgrain Jan 30, 2025

Choose a reason for hiding this comment

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

Not sure what, but the Toolkit doesn't really have a concept of a user terminal. It works with the IoHost instead (which or might not print).

I realize we copied this description from elsewhere. But hey, let's make it better now!

Copy link
Contributor Author

Choose a reason for hiding this comment

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

good call out

export { findCloudWatchLogGroups } from '../../../../aws-cdk/lib/api/logs/find-cloudwatch-logs';

// Test APIs
export { MockSdk } from '../../../../aws-cdk/test/util/mock-sdk';
Copy link
Contributor

Choose a reason for hiding this comment

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

Okay that import needs to go elsewhere. Apologies, I didn't explain the purpose of this file well enough.

Basically we are using it as bundling entrypoint. Everything in here will be bundled for distribution. We don't need to MockSdk bundled.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

your linter rule pointed me here :). but i'll make an exception for testing imports in that rule

@mrgrain mrgrain added the pr/do-not-merge This PR should not be merged at this time. label Jan 30, 2025
Copy link
Contributor

@mrgrain mrgrain left a comment

Choose a reason for hiding this comment

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

Approved in principle. We mainly need to fix the MockSdk import.

Copy link
Contributor

@mrgrain mrgrain left a comment

Choose a reason for hiding this comment

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

do-not-merge so you can do the fixups

@kaizencc kaizencc removed the pr/do-not-merge This PR should not be merged at this time. label Jan 30, 2025
@mergify
Copy link
Contributor

mergify bot commented Jan 30, 2025

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
Copy link
Contributor

mergify bot commented Jan 30, 2025

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

Pull request #33219 has been dequeued. The pull request rule doesn't match anymore

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

@kaizencc
Copy link
Contributor Author

@Mergifyio requeue

@mergify
Copy link
Contributor

mergify bot commented Jan 30, 2025

requeue

❌ This pull request head commit has not been previously disembarked from queue.

@aws-cdk-automation
Copy link
Collaborator

AWS CodeBuild CI Report

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

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

@mergify
Copy link
Contributor

mergify bot commented Jan 30, 2025

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 mergify bot merged commit 71c492a into main Jan 30, 2025
20 checks passed
@mergify mergify bot deleted the conroy/cwlogs branch January 30, 2025 21:50
@github-actions
Copy link
Contributor

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.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jan 30, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

contribution/core This is a PR that came from AWS. p2

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants