-
Notifications
You must be signed in to change notification settings - Fork 3.9k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
feat(cli): logging can be corked #25644
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
packages/aws-cdk/lib/logging.ts
Outdated
@@ -7,6 +7,11 @@ const { stdout, stderr } = process; | |||
|
|||
type WritableFactory = () => Writable; | |||
|
|||
// LOG_LOCK is an array rather than a boolean because it needs to be modified by other | |||
// parts of the CLI and imported variables are always immutable. | |||
export const LOG_LOCK = [false]; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
this is almost certainly the hackiest thing i've ever come up with. whats the better way to do something like this?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
ok i thought of a better way immediately lol
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I like the solution! Needs some changes before it can be merged but conditionally approved
AWS CodeBuild CI Report
Powered by github-codebuild-logs, available on the AWS Serverless Application Repository |
✅ Updated pull request passes all PRLinter validations. Dismissing previous PRLinter review.
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). |
🍾
This PR extends #25536 by fixing issues with logging.
AssetPublisher
and now we simply printBuilding
when building an asset andPublishing
when publishing an asset. No combos anymore.--require-approval
is set (which it is by default), sensitive stack deployments prompt the user for ay/n
response before deployment. Additional asset related messages may come in at this time, cluttering the log. The solution here is to implement a cork that is turned on when prompting the user and turned off after user input. When using the helper functionwithCorkedLogging(callback)
, logs will instead be stored in memory and released when the cork is popped.Testing:
There's not a great way to test these changes in code since they should only affect logging. Instead, I hope the following photos suffice:
Before the lock change, logging looked like this:
Now it looks like this in the same scenario:
The screenshots also show the logs that say
Building
andPublishing
separately rather thanBuilding and Publishing
as it did before.By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license