feat: make sinon.restoreObject idempotent#2737
Open
icholy wants to merge 1 commit into
Open
Conversation
hexeberlin
reviewed
Jun 30, 2026
hexeberlin
left a comment
hexeberlin
left a comment
Contributor
There was a problem hiding this comment.
@icholy thanks for your PR!
We are not huge fans of using booleans as parameters (here is a nice article about the why).
What do you think? Is there a better way to make this improvement to sinon?
Author
|
@hexeberlin just tell me what you want the Line 341 in 544985b |
Contributor
|
@icholy that is a fair point! We are definitely not consistent ... yet :) Could you please create a new method for the strict version? E.g. export walkObject;
export walkObjectStrict;... and then fix the usage sites to chose the desired version. |
Passing an object with no live fakes to restoreObject now restores nothing instead of throwing, giving it symmetry with sinon.restore() and sandbox.restore(). The strict "found no methods" check is retained for spy(object) and stub(object), which now use a dedicated walkObjectStrict export, while restoreObject uses the loose walkObject. Passing a falsy value still throws. Fixes sinonjs#2736
icholy
force-pushed
the
restore-object-idempotent
branch
from
544985b to
f588236
Compare
Author
|
@hexeberlin done |
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
2 participants
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
Fix #2736 by making
sinon.restoreObjecta no-op on empty/stub-less objects.How to verify - mandatory
npm installnpm testChecklist for author
npm run lintpasses