Skip to content
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

Update dependency immer to v10 #312

Closed
wants to merge 1 commit into from
Closed

Conversation

renovate[bot]
Copy link
Contributor

@renovate renovate bot commented Apr 17, 2023

Mend Renovate

This PR contains the following updates:

Package Change Age Adoption Passing Confidence
immer ^9.0.21 -> ^10.0.4 age adoption passing confidence

Release Notes

immerjs/immer (immer)

v10.0.4

Compare Source

Bug Fixes

v10.0.3

Compare Source

Bug Fixes

v10.0.2

Compare Source

Bug Fixes

v10.0.1

Compare Source

Bug Fixes

v10.0.0

Compare Source

Release notes

  • [breaking change] Immer 10 only supports modern browsers, that have support for Proxy, Reflect, Symbol and Map and Set.
  • [breaking change] There is no longer a UMD build exposed (thanks Mark Erikson for modernizing the build setup in #​1032!
  • [breaking change] getters and setters are ignored by default on plain object, as this is a very uncommon case and provides a significant performance boost (ca 33%, but depends a lot on the scenario). Fixes #​867, #​1012. Thanks hrsh7th for implementing it in #​941!
  • [breaking change] Promise based reducers are no longer supported. Conceptually it is an anti pattern to hold on to drafts over time. If needed the old behavior can still be achieved by leveraging createDraft and finishDraft.
  • [breaking change] ES5 mode (for legacy browsers) has been dropped. If your project relies on enableES5(), you SHOULD NOT upgrade Immer. enableES5 has been removed.
  • [breaking change] produce is no longer exposed as the default export. This improves eco system compatibility, and makes sure that there is only one correct way of doing things
  • [breaking change] enableAllPlugins has been removed, use enablePatches(); enableMapSet() instead
  • [breaking change] shortening the length of a JSON array now results in delete patches, rather than a mutation of the length property, in accordance with JSON spec. Thanks kshramt for implementing this in #​964!
  • Immer is now an ESM package that can be directly imported into the browser. CJS should still work, UMD support has been removed.

Overall, there is a rough performance increase of 33% for Immer (and in some cases significantly higher), and the (non gzipped) bundle size has reduced from 16 to 11.5 KB, while the the minimal gzipped import of just produce has remained roughly the same at 3.3 KB.

For more details, see #​1015

Migration steps

  1. If you have any enableES5() call, don't migrate
  2. When using getters/ setters icmw plain objects, call useStrictShallowCopy(true) at startup
  3. Replace all default imports: Replace import produce from "immer" with import {produce} from "immer"
  4. Replace all calls to enableAllPlugins() with enablePatches(); enableMapSet(); to be more specific and smoothen future migrations.
  5. If any producer returned a Promise, refactor it to leverage createDraft instead. Roughly:
const newState = await produce(oldState, recipe)

// becomes
const draft  = createDraft(oldState)
await recipe(draft)
const newState = finishDraft(draft)

Configuration

📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 Ignore: Close this PR and you won't be reminded about this update again.


  • If you want to rebase/retry this PR, check this box

This PR has been generated by Mend Renovate. View repository job log here.

@renovate renovate bot added the dependencies Pull requests that update a dependency file label Apr 17, 2023
@vercel
Copy link

vercel bot commented Apr 17, 2023

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
swiss-maps ❌ Failed (Inspect) Mar 21, 2024 0:33am

@renovate renovate bot force-pushed the renovate/major-immer branch from a67bb10 to 7eafc8c Compare April 17, 2023 20:22
@renovate renovate bot force-pushed the renovate/major-immer branch from 7eafc8c to 7eb14d8 Compare May 9, 2023 22:05
@renovate renovate bot force-pushed the renovate/major-immer branch from 7eb14d8 to 33c331d Compare June 20, 2023 06:11
@renovate renovate bot force-pushed the renovate/major-immer branch from 33c331d to b1c188a Compare October 2, 2023 08:08
@renovate renovate bot force-pushed the renovate/major-immer branch from b1c188a to de39390 Compare January 11, 2024 09:36
@renovate renovate bot force-pushed the renovate/major-immer branch from de39390 to 960f928 Compare January 11, 2024 12:35
@renovate renovate bot force-pushed the renovate/major-immer branch from 960f928 to 44dc4cd Compare January 11, 2024 15:33
@renovate renovate bot force-pushed the renovate/major-immer branch from 44dc4cd to 96802e7 Compare January 11, 2024 20:00
@renovate renovate bot force-pushed the renovate/major-immer branch 2 times, most recently from 3e62ba7 to 437fcf7 Compare March 1, 2024 08:47
@renovate renovate bot force-pushed the renovate/major-immer branch 2 times, most recently from 418a1d9 to 208f0a3 Compare March 1, 2024 09:06
@renovate renovate bot force-pushed the renovate/major-immer branch from 208f0a3 to 3d186db Compare March 1, 2024 09:21
@renovate renovate bot force-pushed the renovate/major-immer branch from 3d186db to 7c689d8 Compare March 1, 2024 09:26
@renovate renovate bot force-pushed the renovate/major-immer branch from 7c689d8 to 3662a25 Compare March 1, 2024 09:39
Copy link
Contributor Author

renovate bot commented Apr 6, 2024

Renovate Ignore Notification

Because you closed this PR without merging, Renovate will ignore this update. You will not get PRs for any future 10.x releases. But if you manually upgrade to 10.x then Renovate will re-enable minor and patch updates automatically.

If you accidentally closed this PR, or if you changed your mind: rename this PR to get a fresh replacement PR.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dependencies Pull requests that update a dependency file
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant