refactor: Updated message-shim to remove cognitive complexity violations. #1958
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
violations. Fixed jsdoc warnings as well.
bizob2828
force-pushed
the
message-shim-refactor
branch
from
4f192be
to
39158c2
Compare
Codecov ReportAttention:
Additional details and impacted files@@ Coverage Diff @@
## main #1958 +/- ##
=======================================
Coverage 97.03% 97.04%
=======================================
Files 215 218 +3
Lines 40372 40450 +78
=======================================
+ Hits 39176 39254 +78
Misses 1196 1196
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
jsumners-nr
previously approved these changes
Jan 22, 2024
| * @param {boolean} params.destNameIsArg flag to state if destination is an argument | ||
| * @returns {Function} wrapped subscribe function | ||
| */ | ||
| module.exports = function createSubscriberWrapper({ shim, fn, spec, destNameIsArg }) { |
There was a problem hiding this comment.
nit: I would refactor this to module.exports = createSubscriberWrapper at the top of the file. It makes it easier to see what the export is, where as the current declaration is easy to overlook.
jsumners-nr
approved these changes
Jan 22, 2024
|
confirmed the missing coverage existed before just calls it out because code was moved |
Node.js Engineering Board
automation
moved this from Needs PR Review
to Done: Issues recently completed
Jan 22, 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.
Fixed jsdoc warnings as well.
Description
I refactored message-shim by extracting inline functions into top level scope. I also moved some of the helper functions into their own files. I fixed all the jsdoc violations and lastly added the MessageSpec and MessageSubscribeSpec into specs instead of inline within file.
How to Test
npm testRelated Issues
Closes NR-134575