Allow passing a custom handler to flushDeprecations #207
Conversation
This file contains 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
simonihmig
commented
Mar 4, 2025
| @@ -107,8 +111,7 @@ export function deprecationCollector(message, options, next) { | |||
| let key = (options && options.id) || message; | |||
| let matchKey = options && key === options.id ? 'matchId' : 'matchMessage'; | |||
|
|
|||
| self.deprecationWorkflow.deprecationLog.messages[key] = | |||
| ' { handler: "silence", ' + matchKey + ': ' + JSON.stringify(key) + ' }'; | |||
There was a problem hiding this comment.
This has been refactored as it was collecting deprecations but also formatting them for final output. With that it was hard-coding handler: 'silence' in a place where we cannot customize it. But IMO it should have only one responsibility: collecting the raw minimal data, which is what it does now. Formatting happens in flushDeprecations.
Simplifies the internal collector logic, to just collect a `Set` of ids.
|
@mansona applied your suggestion as discussed yesterday! Ready for another review! |
Merged
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.
Running
flushDeprecations()will always emit a config where all detected deprecations are silenced. But that is not always what you want. E.g. when you want your config to havethrowOnUnhandledenabled, you might want to have all known deprecations to be listed (so they don't throw), but with aloghandler.This is now possible by running
flushDeprecations({ handler: 'log' })instead. The default remainssilence, so this is a non-breaking change.--
Edit:
Internally, this is removing support for deprecations that don't have an ID. Having an ID is asserted for since this PR, which landed way before the earliest version of 3.28 which we support here.
This simplifies the internal collector logic, to just add IDs to a
Setand always emitting a config withmatchId, instead of having to support bothmatchIdandmatchMessage(which was only used when no ID was present)