Repository navigation
fix(priority-queue): remove() should match items by value, not by priority - #2223
Open
renanmpimentel wants to merge 1 commit into
Open
renanmpimentel wants to merge 1 commit into
renanmpimentel wants to merge 1 commit into
Conversation
…ority
PriorityQueue.remove(item) was called without a finding comparator, so
Heap.remove fell back to this.compare, which compares priorities. As a
result, removing one item also removed every other item sharing its
priority:
pq.add('a', 1); pq.add('b', 1); pq.remove('a'); // 'b' is gone too
Default the finding comparator to value comparison (the same one
changePriority already uses) and add a regression test.
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
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.
Problem
PriorityQueue.remove(item)passescustomFindingComparatorstraight toHeap.remove. When it is omitted,Heap.removefalls back tothis.compare, which inPriorityQueuecompares priorities. So removing one item removes every item that shares its priority:Fix
Default the finding comparator of
remove()to value comparison (this.compareValue), the same comparatorchangePriority()already passes explicitly. Callers that pass a custom comparator are unaffected.Tests
should remove only the given item and keep items with the same priority: fails onmaster(hasValue(5)isfalse), passes with the fix.npm test: 178 suites / 588 tests pass;npm run lintclean.Found with supertest: mutation testing plus statement-removal analysis, with every finding confirmed by running the regression against the unmodified test.