-
-
Notifications
You must be signed in to change notification settings - Fork 852
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[breaking change] implement and default to useStrictShallowCopy, omitting getters #941
Merged
Merged
Changes from 5 commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
31e61bf
feat: implement useStrictShallowCopy
de9569f
breaking change: Change useStrictShallowCopy to enabled by default
hrsh7th a9bc548
doc: Add setUseStrictShallowCopy to api.md
hrsh7th 3c199a3
Add todo comment
hrsh7th 3819609
Change comment
hrsh7th 99efdef
Improve documents
hrsh7th 3cabd7b
Fix flowtype doc comment
hrsh7th da3de76
Fix test case comment
hrsh7th File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,62 @@ | ||
import {measure} from "./measure" | ||
import produce, { | ||
setUseProxies, | ||
setUseStrictShallowCopy, | ||
enableAllPlugins | ||
} from "../dist/immer.cjs.production.min.js" | ||
|
||
enableAllPlugins() | ||
|
||
console.log("\n# large-obj - mutate large object\n") | ||
|
||
const MAX = 50 | ||
|
||
const baseState = Object.fromEntries( | ||
Array(10000) | ||
.fill(0) | ||
.map((_, i) => [i, i]) | ||
) | ||
|
||
measure("immer (proxy) - with setUseStrictShallowCopy", () => { | ||
setUseStrictShallowCopy(true) | ||
setUseProxies(true) | ||
|
||
for (let i = 0; i < MAX; i++) { | ||
produce(baseState, draft => { | ||
draft[5000]++ | ||
}) | ||
} | ||
}) | ||
|
||
measure("immer (proxy) - without setUseStrictShallowCopy", () => { | ||
setUseStrictShallowCopy(false) | ||
setUseProxies(true) | ||
|
||
for (let i = 0; i < MAX; i++) { | ||
produce(baseState, draft => { | ||
draft[5000]++ | ||
}) | ||
} | ||
}) | ||
|
||
measure("immer (es5) - with setUseStrictShallowCopy", () => { | ||
setUseStrictShallowCopy(true) | ||
setUseProxies(false) | ||
|
||
for (let i = 0; i < MAX; i++) { | ||
produce(baseState, draft => { | ||
draft[5000]++ | ||
}) | ||
} | ||
}) | ||
|
||
measure("immer (es5) - without setUseStrictShallowCopy", () => { | ||
setUseStrictShallowCopy(false) | ||
setUseProxies(false) | ||
|
||
for (let i = 0; i < MAX; i++) { | ||
produce(baseState, draft => { | ||
draft[5000]++ | ||
}) | ||
} | ||
}) |
Large diffs are not rendered by default.
Oops, something went wrong.
Large diffs are not rendered by default.
Oops, something went wrong.
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,39 @@ | ||
import produce, {enableAllPlugins, setUseStrictShallowCopy} from "../src/immer" | ||
|
||
enableAllPlugins() | ||
|
||
describe("setUseStrictShallowCopy(true)", () => { | ||
test("keep descriptors", () => { | ||
setUseStrictShallowCopy(true) | ||
|
||
const base: Record<string, unknown> = {} | ||
Object.defineProperty(base, "foo", { | ||
value: "foo", | ||
writable: false, | ||
configurable: false | ||
}) | ||
const copy = produce(base, (draft: any) => { | ||
draft.bar = "bar" | ||
}) | ||
expect(Object.getOwnPropertyDescriptor(copy, "foo")).toStrictEqual( | ||
Object.getOwnPropertyDescriptor(base, "foo") | ||
) | ||
}) | ||
}) | ||
|
||
describe("setUseStrictShallowCopy(false)", () => { | ||
test("ignore descriptors", () => { | ||
setUseStrictShallowCopy(false) | ||
|
||
const base: Record<string, unknown> = {} | ||
Object.defineProperty(base, "foo", { | ||
value: "foo", | ||
writable: false, | ||
configurable: false | ||
}) | ||
const copy = produce(base, (draft: any) => { | ||
draft.bar = "bar" | ||
}) | ||
expect(Object.getOwnPropertyDescriptor(copy, "foo")).toBeUndefined() | ||
}) | ||
}) |
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
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
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
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
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
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
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
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
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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This test is ugly, but after some consideration, I think it should be the spec.
First, I thought that non-enumerable properties should not be visible from drafts when useStrictShallowCopy is false.
However, achieving this behavior requires checking whether the referenced property is non-enumerable, which introduces new overhead.