non-enumerable (immutable) methods on Map/Set #1069
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 an immer object includes a Map/Set, the mutating methods are replaced with ones that prevent mutation outside of the procude function. to prevent cluttering the console when inspecting the Map/Set, these methods are set to non-enumerable. this behavior also matches that of the original methods that are replaced.
mweststrate
approved these changes
Sep 19, 2023
mweststrate
reviewed
Sep 19, 2023
| @@ -188,7 +188,12 @@ export function freeze<T>(obj: T, deep?: boolean): T | |||
| export function freeze<T>(obj: any, deep: boolean = false): T { | |||
| if (isFrozen(obj) || isDraft(obj) || !isDraftable(obj)) return obj | |||
| if (getArchtype(obj) > 1 /* Map or Set */) { | |||
| obj.set = obj.add = obj.clear = obj.delete = dontMutateFrozenCollections as any | |||
| Object.defineProperties(obj, { | |||
There was a problem hiding this comment.
Looking good to me! As a nit optimisation, since the property map is constant, it could be lifted outside the function (usually that really doesn't matter, but with freeze potentially touching a gazillion of objects it might)
There was a problem hiding this comment.
Thanks! I'm waiting with sending the updated PR because the current state of the repo is failing some tests, both locally and using 'Open in Gitpod' (albeit a bit differently – locally tests/produce.ts, tests/draft.ts, and tests/redux.ts suits are failing, while in Gitpod the tests/immutable.ts is failing in addition to the other three).
1 task
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.
when an immer object includes a Map/Set, the mutating methods are replaced with ones that prevent mutation outside of the produce function. to prevent cluttering the console when inspecting the Map/Set, these methods are set to non-enumerable. this behavior also matches that of the original methods that are replaced.