Fix #1801: spied fakeTimers are not restored correctly #1802
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
When sandbox.useFakeTimers() is called, the original setTimeout and other methods are replaced with fake methods. When such fake method is spied it's replaced again with another fake. To make sure that sandbox.restore() reverts setTimeout and other methods to the original state these fakes should be restored in reverse order to make sure each fake is restored to its predecessor when calling fake.restore().
This is to allow restoring spied fakeTimers in default sandbox.
fatso83
reviewed
May 24, 2018
| @@ -24,11 +24,8 @@ var apiMethods = { | |||
| setFormatter: format.setFormatter, | |||
|
|
|||
| // fake timers | |||
| useFakeTimers: fakeTimers.useFakeTimers, | |||
There was a problem hiding this comment.
So these lines that were hanging around from earlier versions essentially shadowed the new sandbox functions on the prototype. Good find!
|
Thanks for the fix and the work put in! Out as 5.0.10 |
|
Thank you for the contribution @ifrost 💯 |
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.
Purpose (TL;DR) - mandatory
When a fakeTimer is spied, sandbox.restore()/sinon.restore() does not restore setTimeout to the original function.
Background (Problem in detail)
See #1801
When
sandbox.useFakeTimers()is called, the originalsetTimeoutand other methods are replaced with fake methods. When such fake method is spied it's replaced again with another fake. To make sure thatsandbox.restore()revertssetTimeoutand other methods to the original state these fakes should be restored in reverse order to make sure each fake is restored to its predecessor when calling fake.restore().What is more the default sandbox doesn't use
sandbox.useFakeTimers(see also #1775) andsandbox.clock(see #1780). To make the fix work in default sandbox it should passuseFakeTimersthrough to the sandbox method. Usingsandbox.clockin the default sandbox added for consistency.How to verify - mandatory
npm installnpm test