fix(mock): restore single-arg MockCallHistory.filterCallsByX#5328
Open
youcefzemmar wants to merge 1 commit into
Open
fix(mock): restore single-arg MockCallHistory.filterCallsByX#5328youcefzemmar wants to merge 1 commit into
youcefzemmar wants to merge 1 commit into
Conversation
The internal `handleFilterCallsWithOptions` refactor in 8.2.0 added a
required `logs` parameter to the helper returned by `makeFilterCalls`,
breaking the documented public API: callers using
`mockCallHistory.filterCallsByPath('/foo')` hit
`Cannot read properties of undefined (reading 'filter')`.
Default `logs` to `this.logs` so the external single-argument form works
again. The internal callers in `filterCalls` still pass an explicit
`logs` argument, so the AND/OR behavior from nodejs#5045 is unaffected.
Fixes nodejs#5324.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
What
Restores the documented
mockCallHistory.filterCallsByX(value)single-argument form. The helper returned bymakeFilterCallsnow defaultslogstothis.logs, so external callers work again. Internal callers infilterCallsstill passlogsexplicitly, so the AND/OR semantics from #5045 are unchanged.Why
In 8.2.0, the
makeFilterCallshelper was refactored to take a secondlogsargument used by the new AND/OR filter operators. The internalhandleFilterCallsWithOptionsalways passes it, but the public methods (filterCallsByPath,filterCallsByMethod, etc.) are still documented to accept a single argument. Calling anyfilterCallsByX('value')since 8.2.0 throwsCannot read properties of undefined (reading 'filter').Testing
node --test test/mock-call-history.js— 46/46 green (10 new tests in theMockCallHistory - filterCallsByXblock exercising each public filter helper plus a regression for "logs added after the method was bound")node_modules/.bin/eslint --cache lib/mock/mock-call-history.js test/mock-call-history.js— cleanNotes
The optional second
logsparameter on the public methods wasn't documented, so no type-definition change is needed.Fixes #5324.