improv(logger): streamline Logger types #3054
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
boring-cyborg
bot
added
logger
pull-request-size
bot
added
the
size/XXL
github-actions
bot
added
the
enhancement
|
I'll start reviewing it tomorrow morning and this will take longer to complete. If @am29d approves it before then, please go ahead and merge. |
|
No rush - thank you! |
leandrodamascena
requested changes
Sep 13, 2024
There was a problem hiding this comment.
Hi @dreamorosi! I made some small changes to the text/docstring to make it clearer for users. In this PR I didn't look too much at TypeScript code itself and things you renamed or moved from here to there, because that seems fine and you have much more context.
I tested this code locally and saw that the IDE hints are working as expected.
I'll ask for a Request Changes so you can check if the changes make sense.
Co-authored-by: Leandro Damascena <[email protected]>
|
leandrodamascena
approved these changes
Sep 13, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Changes
I started working on this PR to improve the work merged in #2736 and provide a better DX for customers using the feature.
The main goal was to have TypeScript suggest the possible values for log keys as well as accept arbitrary strings.
While working on this improvement, which I achieved (see screenshot below), I quickly realized that the types for the Logger had become convoluted.
Most of the types were not documented, and especially the types around log keys and contents of a log had become confused.
In this PR I have refactored, reorganized, and documented all the types for the Logger class - as well as some methods - to ensure that each one of them provides useful info for customers and maintainers alike.
The internal logic of the Logger remains unchanged, however due to having added many new comment blocks, the diff seems abnormally larger than it really is.
Issue number: closes #3053
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.
Disclaimer: We value your time and bandwidth. As such, any pull requests created on non-triaged issues might not be successful.