Require cache.reset({ discardWatches: true }) to clear cache.watches
#8852
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
As reported in issue #8851, PR #8826 was a breaking change for code expecting cache.watches to be restarted after cache.reset() is called. This commit establishes a small but extensible Cache.ResetOptions API for the cache.reset method, which allows the handling of watches to be configured via options.discardWatches, which defaults to false, thus restoring the behavior of cache.reset() from before #8826. If you need the behavior introduced by #8826, you can now opt (back) into that behavior by calling cache.reset({ discardWatches: true }).
benjamn
added
📟 regression
🧪 has-tests
💸 caching
size/small
⏮ compatibility
benjamn
changed the title
cache.reset({ discardWatches: true }) to clear cache.watches
brainkim
approved these changes
Sep 27, 2021
benjamn
deleted the
issue-8851-revert-clearing-watches-in-cache.reset
branch
benjamn
added a commit
that referenced
this pull request
Sep 30, 2021
Follow-up to PR #8852, inspired by this discussion: #8872
benjamn
added a commit
that referenced
this pull request
Sep 30, 2021
Follow-up to PR #8852, inspired by this discussion: #8872
benjamn
added a commit
that referenced
this pull request
Oct 4, 2021
Follow-up to PR #8852, inspired by this discussion: #8872
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
As reported in issue #8851 by @tm1000, PR #8826 (shipped in v3.4.14) was a breaking change for code expecting
cache.watchesto be restarted aftercache.reset()is called.This commit establishes a small but extensible
Cache.ResetOptionsAPI for thecache.resetmethod, which allows the handling of watches to be configured viaoptions.discardWatches, which defaults tofalse, thus restoring the behavior ofcache.reset()from before #8826.If you need the behavior introduced by #8826, you can now opt (back) into that behavior by calling