feature: optimize Immer bundling #536

mweststrate · 2020-02-17T22:26:19Z

BREAKING CHANGE: need to enable features

BREAKING CHANGE: custom hooks are no longer supporterd

Import size report for immer: ┌───────────────────────┬───────────┬────────────┬───────────┐ │ (index) │ just this │ cumulative │ increment │ ├───────────────────────┼───────────┼────────────┼───────────┤ │ import * from 'immer' │ 6761 │ 0 │ 0 │ │ produce │ 4048 │ 4048 │ 0 │ │ enableES5 │ 4908 │ 4916 │ 868 │ │ enableMapSet │ 5007 │ 5769 │ 853 │ │ enablePatches │ 4836 │ 6544 │ 775 │ └───────────────────────┴───────────┴────────────┴───────────┘ (this report was generated by npmjs.com/package/import-size)

codesandbox-ci · 2020-02-17T22:27:44Z

This pull request is automatically built and testable in CodeSandbox.

To see build info of the built libraries, click here or the icon next to each commit SHA.

Latest deployment of this branch, based on commit d676e61:

Sandbox	Source
Immer sandbox	Configuration

danielkcz · 2020-02-19T18:35:33Z

__performance_tests__/add-data.js

+	setAutoFreeze,
+	setUseProxies,
+	enableAllPlugins
+} from "../dist/immer.cjs.production.min.js"


Do you see some benefit to refer minified prod build in tests? For once it might be harder to run debugger with it. You could simply refer to ../dist here which will pickup dev build so it would be less verbose.

no, these are the performance test, not the unit tests. So they won't really assert anything and arent to be relied upon for correctness. Using a prod build to better reflect raw production performance

danielkcz · 2020-02-19T18:38:02Z

jest.config.build.js

@@ -0,0 +1,17 @@
+module.exports = {
+	moduleNameMapper: {
+		"src/.*": "<rootDir>/dist/immer.esm.js"


Interesting. Shouldn't you refer to src in test files and let it translated to dist with this?

yeah, this makes the tests behave as if immer was a dependency. So if anything is referred from src that is also exported from the index, it is fine, otherwise it will become undefined, so any graybox tests are marked to be not included in this build config

danielkcz · 2020-02-19T18:39:21Z

package.json

@@ -1,27 +1,30 @@
 {
  "name": "immer",
-  "version": "5.3.2",
+  "version": "6.0.0-alpha.2",
  "description": "Create your next immutable state by mutating the current one",
  "main": "dist/immer.js",


Suggested change

"main": "dist/immer.js",

"main": "dist/index.js",

Nice catch 😅

danielkcz · 2020-02-21T19:57:17Z

@mweststrate Have you noticed my review comments above? :)

mweststrate · 2020-02-21T20:06:33Z

yes, will look into it once done :) this is still a draft, just coudn't find that draft button anymore :P

…

On Fri, Feb 21, 2020 at 7:57 PM Daniel K. ***@***.***> wrote: @mweststrate <https://github.com/mweststrate> Have you noticed my review comments above? :) — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#536?email_source=notifications&email_token=AAN4NBEUESXAKFBKW76P4WLREAWZ5A5CNFSM4KWZNJB2YY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGOEMT44BI#issuecomment-589811205>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAN4NBCR6HIXFVXY6JPIUDLREAWZ5ANCNFSM4KWZNJBQ> .

mweststrate · 2020-02-25T20:38:15Z

@markerikson (and others) the new version can be tried as [email protected]. Installation instructions can be found here: https://github.com/immerjs/immer/blob/multi-bundle/docs/installation.md#pick-your-immer-version

danielkcz · 2020-02-25T21:18:33Z

@mweststrate You should definitely fix that main field I pointed above, it won't work like that in any nonESM environment. You can see here there is no "immer.js" dist file with TSDX: https://unpkg.com/browse/[email protected]/dist/

markerikson · 2020-02-26T03:18:55Z

Can confirm the entry point issue broke things. I just tried alpha.3, and yeah, all our tests blew up with Jest saying it can't find Immer. Hand-editing node_modules/immer/package.json let them run okay.

@mweststrate , can you put out another alpha? (Given the time zone difference, you're probably asleep now, so I'll have to try this again tomorrow night.)

Having said that, I also tried a local test build of RTK with the hand-edited copy of Immer 6, and I can confirm that the size of Immer in a demo app bundle is smaller.

Webpack reports the demo app's main.js went from 19.1K down to 11.5K for Immer 6 with no plugins, and 13.5K with the ES5 plugin.

source-map-explorer was previously showing Immer as being around 12K by itself, I think. It now shows 6.64K with no plugins and 8.61K with the ES5 plugin.

So, looks like that plugin adds about 2K in this example, but overall, a definite win.

mweststrate · 2020-02-26T04:48:57Z

I'm actually in CA at the moment :) Just pushed an update (didn't test it, let me know if it isn't ok) Yeah those numbers align with my expectations for non-gzipped code. I think the ES5 plugin could actually be pruned a little bit more as there seems to be some almost-duplication, maybe in a next version.

…

On Tue, Feb 25, 2020 at 7:18 PM Mark Erikson ***@***.***> wrote: Can confirm the entry point issue broke things. I just tried alpha.3, and yeah, all our tests blew up with Jest saying it can't find Immer. Hand-editing node_modules/immer/package.json let them run okay. @mweststrate <https://github.com/mweststrate> , can you put out another alpha? (Given the time zone difference, you're probably asleep now, so I'll have to try this again tomorrow night.) Having said that, I also tried a local test build of RTK with the hand-edited copy of Immer 6, and I can confirm that the size of Immer in a demo app bundle is smaller. Webpack reports the demo app's main.js went from 19.1K down to 11.5K for Immer 6 with no plugins, and 13.5K with the ES5 plugin. source-map-explorer was previously showing Immer as being around 12K by itself, I think. It now shows 6.64K with no plugins and 8.61K with the ES5 plugin. So, looks like that plugin adds about 2K in this example, but overall, a definite win. — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#536?email_source=notifications&email_token=AAN4NBAYCX2FRXCHZXJJZ6LREXNSBA5CNFSM4KWZNJB2YY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGOEM6UI6I#issuecomment-591217785>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAN4NBFZZEIAF2QARWWLFOLREXNSBANCNFSM4KWZNJBQ> .

markerikson · 2020-02-26T05:01:37Z

Yep, alpha.4 builds cleanly. Thanks!

add 5.0.2 type definitions as fallback for TS<3.7

aleclarson · 2020-03-03T19:39:34Z

🎉 This PR is included in version 6.0.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

Summary: ## The dependency [immer](https://github.com/immerjs/immer) was updated from `5.3.6` to `6.0.0`. This version is **not covered** by your **current version range**. If you don’t accept this pull request, your project will work just like it did before. However, you might be missing out on a bunch of new features, fixes and/or performance improvements from the dependency update. --- **Publisher:** [aleclarson](https://www.npmjs.com/~aleclarson) **License:** MIT <details> <summary>Release Notes for v6.0.0</summary> <h1><a href="https://urls.greenkeeper.io/immerjs/immer/compare/v5.3.6...v6.0.0">6.0.0</a> (2020-03-03)</h1> <ul> <li>Merge pull request <a class="issue-link js-issue-link" data-error-text="Failed to load title" data-id="566542863" data-permission-text="Title is private" data-url="immerjs/immer#536" data-hovercard-type="pull_request" data-hovercard-url="/immerjs/immer/pull/536/hovercard" href="https://urls.greenkeeper.io/immerjs/immer/pull/536">https://github.com/facebook/flipper/issues/536</a> from immerjs/multi-bundle (<a href="https://urls.greenkeeper.io/immerjs/immer/commit/0d87fc88e8efffdacbb5db295cb9efd624cd2757">0d87fc8</a>), closes <a href="https://urls.greenkeeper.io/immerjs/immer/issues/536" data-hovercard-type="pull_request" data-hovercard-url="/immerjs/immer/pull/536/hovercard">https://github.com/facebook/flipper/issues/536</a></li> </ul> <h3>BREAKING CHANGES</h3> <ul> <li>Support for ES5, patches and Map/Set collections has to be <em>explicitly</em> enable now: <a href="https://immerjs.github.io/immer/docs/installation" rel="nofollow">https://immerjs.github.io/immer/docs/installation</a></li> <li>Custom serialization hooks are no longer supported</li> </ul> <p>feat: Adding large data sets to a draft has been optimized (in case autofreeze is disabled)</p> </details> <details> <summary>Commits</summary> <p>The new version differs by 41 commits.</p> <ul> <li><a href="https://urls.greenkeeper.io/immerjs/immer/commit/0d87fc88e8efffdacbb5db295cb9efd624cd2757"><code>0d87fc8</code></a> <code>Merge pull request #536 from immerjs/multi-bundle</code></li> <li><a href="https://urls.greenkeeper.io/immerjs/immer/commit/d676e61b638a0611bc105e62523c2c6fc7f97531"><code>d676e61</code></a> <code>removed notes file</code></li> <li><a href="https://urls.greenkeeper.io/immerjs/immer/commit/3cfd62103b144057289c0eff9269bedd09265895"><code>3cfd621</code></a> <code>backported new API's</code></li> <li><a href="https://urls.greenkeeper.io/immerjs/immer/commit/0d7f883067dc30320a52e9df4e324abfec12f8dc"><code>0d7f883</code></a> <code>Merge pull request #541 from phryneas/typesversions-compat</code></li> <li><a href="https://urls.greenkeeper.io/immerjs/immer/commit/f215409d2ea6249fea1bab907f87c7a25a231f68"><code>f215409</code></a> <code>Merge branch 'multi-bundle' into typesversions-compat</code></li> <li><a href="https://urls.greenkeeper.io/immerjs/immer/commit/5f86272a3a8fe6c6f3edd0e48a4edd4e912b3748"><code>5f86272</code></a> <code>Fixed entry point</code></li> <li><a href="https://urls.greenkeeper.io/immerjs/immer/commit/b94c34fc81f2de4b40c181fa221e2daef16ff34d"><code>b94c34f</code></a> <code>Merge pull request #544 from delanni/patch-1</code></li> <li><a href="https://urls.greenkeeper.io/immerjs/immer/commit/30e0f54d306ea28c895d8e34d9a30a372a43ffc3"><code>30e0f54</code></a> <code>Add section about using classes with immer</code></li> <li><a href="https://urls.greenkeeper.io/immerjs/immer/commit/e6c3f13479fe2407b4d06decbb8c2440e4e92811"><code>e6c3f13</code></a> <code>stricter compression</code></li> <li><a href="https://urls.greenkeeper.io/immerjs/immer/commit/7a38af91d2e9b1fe359c1671942057ebff9be824"><code>7a38af9</code></a> <code>unclassed scope</code></li> <li><a href="https://urls.greenkeeper.io/immerjs/immer/commit/cb3b9d68397e111272cbb3039717255b278f6bb9"><code>cb3b9d6</code></a> <code>Processed some todo's</code></li> <li><a href="https://urls.greenkeeper.io/immerjs/immer/commit/895e0cc9f885cb88086cf6d1515e33e9993cad25"><code>895e0cc</code></a> <code>Updated docs</code></li> <li><a href="https://urls.greenkeeper.io/immerjs/immer/commit/edb1cad865c405bb34823afb056cfc6d73fc32de"><code>edb1cad</code></a> <code>Renamed utils dir</code></li> <li><a href="https://urls.greenkeeper.io/immerjs/immer/commit/db1652018ac6f40dea9e090a4d589cc072d7e456"><code>db16520</code></a> <code>Tests for plugins</code></li> <li><a href="https://urls.greenkeeper.io/immerjs/immer/commit/ab49edc11cd40dc8e441e42e67e92596bf9abecf"><code>ab49edc</code></a> <code>Moving files into folders</code></li> </ul> <p>There are 41 commits in total.</p> <p>See the <a href="https://urls.greenkeeper.io/immerjs/immer/compare/21c1597f1721f0ff34f83121c87ad8ee19227c55...0d87fc88e8efffdacbb5db295cb9efd624cd2757">full diff</a></p> </details> --- <details> <summary>FAQ and help</summary> There is a collection of [frequently asked questions](https://greenkeeper.io/faq.html). If those don’t help, you can always [ask the humans behind Greenkeeper](https://github.com/greenkeeperio/greenkeeper/issues/new). </details> --- Your [Greenkeeper](https://greenkeeper.io) bot 🌴 Pull Request resolved: #853 Reviewed By: passy Differential Revision: D20303311 Pulled By: mweststrate fbshipit-source-id: ba6ab68246144c858490fbffca8bcff641b930ad

mweststrate added 13 commits February 12, 2020 12:41

separating plugins from core

124518b

Small code cleanup

9217809

Removed some coupling

70e77aa

More WIP

ee1c977

TSDX

4c4fecc

Some measurements fixes

737432a

use invariant -321 bytes

ac57da5

fixes

472ab66

Mangle properties, -114 bytes

bfa7ddd

Killed die, -14 bytes

d77a5c1

killed hooks, as they leaked mangled properties. Also -145 bytes

f1918cb

Some notes

746dc6f

mweststrate mentioned this pull request Feb 17, 2020

Possible improvements to tree shaking and bundle size #500

Closed

mweststrate and others added 9 commits February 18, 2020 19:37

Small improvements

712af5c

Fixed performance tests

c2d7617

add 5.0.2 type definitions as fallback for TS<3.7

4a0473d

Initial finalize cleanup

67ab3ab

added base tests for autofreeze + patch listeners

9f07525

Cleanup. Don't recurse into frozen data structures

d32cb97

Cleanup finalize, -57

530d81b

Killed enumerations -145 (!)

fdc78db

scramble plugin names, -56

037b474

danielkcz reviewed Feb 19, 2020

View reviewed changes

mweststrate added 5 commits February 19, 2020 21:56

Optimization: stop recursing if there are no drafts left

ebda6f8

Some minor cleanup

718b7f6

Preserve error codes in production

d005fab

Errors for prod

67565dd

Moving files into folders

ab49edc

mweststrate added 6 commits February 22, 2020 15:08

Tests for plugins

db16520

Renamed utils dir

edb1cad

Updated docs

895e0cc

Processed some todo's

cb3b9d6

unclassed scope

7a38af9

stricter compression

e6c3f13

Fixed entry point

5f86272

ctrlplusb mentioned this pull request Feb 26, 2020

Support Map and Set with immer and/or immer-peasy ctrlplusb/easy-peasy#440

Closed

This was referenced Feb 27, 2020

Roadmap: RTK v1.3.0 reduxjs/redux-toolkit#373

Closed

Use Immer 6 alpha reduxjs/redux-toolkit#396

Merged

mweststrate and others added 4 commits March 3, 2020 11:20

Merge branch 'multi-bundle' into typesversions-compat

f215409

Merge pull request #541 from phryneas/typesversions-compat

0d7f883

add 5.0.2 type definitions as fallback for TS<3.7

backported new API's

3cfd621

removed notes file

d676e61

mweststrate merged commit 0d87fc8 into master Mar 3, 2020

aleclarson added the released label Mar 3, 2020

agilgur5 mentioned this pull request Mar 20, 2020

Revert #812 mobxjs/mobx-react#820

Closed

snyk-bot mentioned this pull request Mar 30, 2020

[Snyk] Upgrade immer from 6.0.0 to 6.0.2 TyrealGray/Qin.js#111

Merged

This was referenced Apr 16, 2020

[Snyk] Upgrade @reduxjs/toolkit from 1.2.5 to 1.3.0 electrified/music-frontend#18

Merged

[Snyk] Upgrade @reduxjs/toolkit from 1.2.5 to 1.3.0 emyann/matron#69

Merged

snyk-bot mentioned this pull request May 1, 2020

[Snyk] Upgrade @reduxjs/toolkit from 1.3.0 to 1.3.4 electrified/music-frontend#22

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feature: optimize Immer bundling #536

feature: optimize Immer bundling #536

mweststrate commented Feb 17, 2020

codesandbox-ci bot commented Feb 17, 2020 •

edited

Loading

danielkcz Feb 19, 2020

mweststrate Feb 25, 2020

danielkcz Feb 19, 2020

mweststrate Feb 25, 2020

danielkcz Feb 19, 2020

mweststrate Feb 25, 2020

danielkcz commented Feb 21, 2020

mweststrate commented Feb 21, 2020 via email

mweststrate commented Feb 25, 2020

danielkcz commented Feb 25, 2020 •

edited

Loading

markerikson commented Feb 26, 2020

mweststrate commented Feb 26, 2020 via email

markerikson commented Feb 26, 2020

aleclarson commented Mar 3, 2020

feature: optimize Immer bundling #536

feature: optimize Immer bundling #536

Conversation

mweststrate commented Feb 17, 2020

codesandbox-ci bot commented Feb 17, 2020 • edited Loading

danielkcz Feb 19, 2020

Choose a reason for hiding this comment

mweststrate Feb 25, 2020

Choose a reason for hiding this comment

danielkcz Feb 19, 2020

Choose a reason for hiding this comment

mweststrate Feb 25, 2020

Choose a reason for hiding this comment

danielkcz Feb 19, 2020

Choose a reason for hiding this comment

mweststrate Feb 25, 2020

Choose a reason for hiding this comment

danielkcz commented Feb 21, 2020

mweststrate commented Feb 21, 2020 via email

mweststrate commented Feb 25, 2020

danielkcz commented Feb 25, 2020 • edited Loading

markerikson commented Feb 26, 2020

mweststrate commented Feb 26, 2020 via email

markerikson commented Feb 26, 2020

aleclarson commented Mar 3, 2020

codesandbox-ci bot commented Feb 17, 2020 •

edited

Loading

danielkcz commented Feb 25, 2020 •

edited

Loading