reactive · ntucker · Mar 20, 2025 · Mar 18, 2025
diff --git a/.changeset/brave-bats-itch.md b/.changeset/brave-bats-itch.md
@@ -0,0 +1,9 @@
+---
+'@data-client/normalizr': minor
+---
+
+BREAKING CHANGE: Denormalize always transforms immutablejs entities into the class
+
+Previously using ImmutableJS structures when calling denormalize() would maintain
+nested schemas as immutablejs structures still. Now everything is converted to normal JS.
+This is how the types have always been specified.
diff --git a/docs/core/concepts/normalization.md b/docs/core/concepts/normalization.md
@@ -392,15 +392,15 @@ xychart-beta
     title "Denormalize Single Entity"
     x-axis [normalizr, "Data Client", "Data Client (cached)"]
     y-axis "Operations per second" 0 --> 5618500
-    bar [212500, 1288500, 5618500]
+    bar [212500, 1341000, 5618500]
 ```
 
 ```mermaid
 xychart-beta
     title "Denormalize Large List"
     x-axis [normalizr, "Data Client", "Data Client (cached)"]
     y-axis "Operations per second" 0 --> 12962
-    bar [1151, 1807, 13182]
+    bar [1151, 1986, 13182]
 ```
 
 </Grid>

diff --git a/examples/benchmark/old-normalizr/normalizr.js b/examples/benchmark/old-normalizr/normalizr.js
@@ -46,8 +46,6 @@ function mergeWithStore({ entities, result }, storeState) {
 
 let curState = state;
 export default function addNormlizrSuite(suite) {
-  %OptimizeFunctionOnNextCall(normalize);
-  %OptimizeFunctionOnNextCall(denormalize);
   return suite
     .add('normalizeLong', () => {
       return mergeWithStore(normalize(data, ProjectSchema), state);
@@ -63,7 +61,7 @@ export default function addNormlizrSuite(suite) {
     })
     .add('denormalizeShort donotcache 500x', () => {
       for (let i = 0; i < 500; ++i) {
-        const user = denormalize('gnoff', User, githubState.entities);
+        var user = denormalize('gnoff', User, githubState.entities);
         // legacy normalizr doesn't convert this for us, so we must do manually afterward.
         user.createdAt = new Date(user.createdAt);
         user.updatedAt = new Date(user.updatedAt);

diff --git a/packages/endpoint/src/schemas/__tests__/Entity.test.ts b/packages/endpoint/src/schemas/__tests__/Entity.test.ts
@@ -812,10 +812,8 @@ describe(`${Entity.name} denormalization`, () => {
       },
     };
 
-    expect(denormalize(Menu, '1', entities)).toMatchSnapshot();
     expect(denormalize(Menu, '1', fromJS(entities))).toMatchSnapshot();
 
-    expect(denormalize(Menu, '2', entities)).toMatchSnapshot();
     expect(denormalize(Menu, '2', fromJS(entities))).toMatchSnapshot();
   });
 

diff --git a/packages/endpoint/src/schemas/__tests__/EntityMixin.test.ts b/packages/endpoint/src/schemas/__tests__/EntityMixin.test.ts
@@ -948,10 +948,8 @@ describe(`${schema.Entity.name} denormalization`, () => {
       },
     };
 
-    expect(denormalize(Menu, '1', entities)).toMatchSnapshot();
     expect(denormalize(Menu, '1', fromJS(entities))).toMatchSnapshot();
 
-    expect(denormalize(Menu, '2', entities)).toMatchSnapshot();
     expect(denormalize(Menu, '2', fromJS(entities))).toMatchSnapshot();
   });
 

diff --git a/packages/endpoint/src/schemas/__tests__/__snapshots__/Entity.test.ts.snap b/packages/endpoint/src/schemas/__tests__/__snapshots__/Entity.test.ts.snap
@@ -60,22 +60,6 @@ Menu {
 `;
 
 exports[`Entity denormalization denormalizes deep entities with records 2`] = `
-Menu {
-  "food": Food {
-    "id": "1",
-  },
-  "id": "1",
-}
-`;
-
-exports[`Entity denormalization denormalizes deep entities with records 3`] = `
-Menu {
-  "food": null,
-  "id": "2",
-}
-`;
-
-exports[`Entity denormalization denormalizes deep entities with records 4`] = `
 Menu {
   "food": null,
   "id": "2",
@@ -107,15 +91,15 @@ exports[`Entity denormalization denormalizes recursive dependencies 2`] = `
 Report {
   "draftedBy": User {
     "id": "456",
-    "reports": Immutable.List [
+    "reports": [
       [Circular],
     ],
     "role": "manager",
   },
   "id": "123",
   "publishedBy": User {
     "id": "456",
-    "reports": Immutable.List [
+    "reports": [
       [Circular],
     ],
     "role": "manager",
@@ -142,7 +126,7 @@ User {
 exports[`Entity denormalization denormalizes recursive dependencies 4`] = `
 User {
   "id": "456",
-  "reports": Immutable.List [
+  "reports": [
     Report {
       "draftedBy": [Circular],
       "id": "123",

diff --git a/packages/endpoint/src/schemas/__tests__/__snapshots__/EntityMixin.test.ts.snap b/packages/endpoint/src/schemas/__tests__/__snapshots__/EntityMixin.test.ts.snap
@@ -75,22 +75,6 @@ Menu {
 `;
 
 exports[`EntityMixin denormalization denormalizes deep entities with records 2`] = `
-Menu {
-  "food": Food {
-    "id": "1",
-  },
-  "id": "1",
-}
-`;
-
-exports[`EntityMixin denormalization denormalizes deep entities with records 3`] = `
-Menu {
-  "food": null,
-  "id": "2",
-}
-`;
-
-exports[`EntityMixin denormalization denormalizes deep entities with records 4`] = `
 Menu {
   "food": null,
   "id": "2",
@@ -148,15 +132,15 @@ exports[`EntityMixin denormalization nesting denormalizes recursive dependencies
 Report {
   "draftedBy": User {
     "id": "456",
-    "reports": Immutable.List [
+    "reports": [
       [Circular],
     ],
     "role": "manager",
   },
   "id": "123",
   "publishedBy": User {
     "id": "456",
-    "reports": Immutable.List [
+    "reports": [
       [Circular],
     ],
     "role": "manager",
@@ -183,7 +167,7 @@ User {
 exports[`EntityMixin denormalization nesting denormalizes recursive dependencies 4`] = `
 User {
   "id": "456",
-  "reports": Immutable.List [
+  "reports": [
     Report {
       "draftedBy": [Circular],
       "id": "123",

diff --git a/packages/endpoint/src/schemas/__tests__/__snapshots__/Values.test.js.snap b/packages/endpoint/src/schemas/__tests__/__snapshots__/Values.test.js.snap
@@ -461,69 +461,69 @@ exports[`input (immutable) ValuesSchema denormalization (current) works on compl
   "data": {
     "estimates": {
       "BTC": Estimate {
-        "coinbase_fees": Immutable.Map {
+        "coinbase_fees": {
           "amount": "0.00002270",
           "currency": "BTC",
         },
         "confirmation_duration": 900,
-        "exchange": Immutable.Map {
-          "rate": "6820.07",
-          "local": "USD",
+        "exchange": {
           "crypto": "BTC",
-        },
-        "exchange_to_proceeds": Immutable.Map {
+          "local": "USD",
           "rate": "6820.07",
-          "local": "EUR",
+        },
+        "exchange_to_proceeds": {
           "crypto": "BTC",
+          "local": "EUR",
+          "rate": "6820.07",
         },
-        "fee": Immutable.Map {
+        "fee": {
           "amount": "0.00002270",
           "currency": "BTC",
         },
-        "fee_per_kb": Immutable.Map {
+        "fee_per_kb": {
           "amount": "0.00016566",
           "currency": "BTC",
         },
-        "min_order_size": Immutable.Map {
+        "min_order_size": {
           "amount": "0.001",
           "currency": "BTC",
         },
         "priority": "fast",
-        "recipient_value": Immutable.Map {
+        "recipient_value": {
           "amount": "0.00054147",
           "currency": "BTC",
         },
       },
       "ETH": Estimate {
-        "coinbase_fees": Immutable.Map {
+        "coinbase_fees": {
           "amount": "0.00002270",
           "currency": "BTC",
         },
         "confirmation_duration": 900,
-        "exchange": Immutable.Map {
-          "rate": "197.07",
-          "local": "USD",
+        "exchange": {
           "crypto": "ETH",
+          "local": "USD",
+          "rate": "197.07",
         },
-        "exchange_to_proceeds": Immutable.Map {
-          "rate": "6820.07",
-          "local": "EUR",
+        "exchange_to_proceeds": {
           "crypto": "BTC",
+          "local": "EUR",
+          "rate": "6820.07",
         },
-        "fee": Immutable.Map {
+        "fee": {
           "amount": "0.03795",
           "currency": "ETH",
         },
-        "fee_per_kb": Immutable.Map {
+        "fee_per_kb": {
           "amount": "0.00086",
           "currency": "ETH",
         },
-        "min_order_size": Immutable.Map {
+        "min_order_size": {
           "amount": "0.001",
           "currency": "BTC",
         },
         "priority": "fast",
-        "recipient_value": Immutable.Map {
+        "recipient_value": {
           "amount": "2.53",
           "currency": "ETH",
         },

diff --git a/packages/normalizr/src/denormalize/denormalize.ts b/packages/normalizr/src/denormalize/denormalize.ts
@@ -2,6 +2,7 @@ import { getEntities } from './getEntities.js';
 import LocalCache from './localCache.js';
 import getUnvisit from './unvisit.js';
 import type { Schema } from '../interface.js';
+import { isImmutable } from '../schemas/ImmutableUtils.js';
 import type { DenormalizeNullable } from '../types.js';
 
 export function denormalize<S extends Schema>(
@@ -19,5 +20,6 @@ export function denormalize<S extends Schema>(
     getEntities(entities),
     new LocalCache(),
     args,
+    isImmutable(entities),
   )(schema, input).data;
 }