Merge branch 'master' of https://github.com/reduxjs/redux-toolkit into fix-size-limit-config

aryaemami59 · aryaemami59 · commit c107e687fd87 · 2024-06-28T17:35:19.000-05:00
diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml
@@ -92,9 +92,11 @@ jobs:
       - name: Install build artifact
         run: yarn workspace @reduxjs/toolkit add $(pwd)/package.tgz
 
-      - run: sed -i -e /@remap-prod-remove-line/d ./tsconfig.base.json ./vitest.config.mts ./src/tests/*.* ./src/query/tests/*.*
+      - run: sed -i -e /@remap-prod-remove-line/d ./tsconfig.base.json
 
       - name: Run tests, against dist
+        env:
+          TEST_DIST: true
         run: yarn test
 
   test-types:
@@ -134,9 +136,11 @@ jobs:
       - name: Show installed RTK versions
         run: yarn info @reduxjs/toolkit
 
-      - run: sed -i -e /@remap-prod-remove-line/d ./tsconfig.base.json ./vitest.config.mts ./src/tests/*.* ./src/query/tests/*.*
+      - run: sed -i -e /@remap-prod-remove-line/d ./tsconfig.base.json
 
       - name: Test types
+        env:
+          TEST_DIST: true
         run: |
           yarn tsc --version
           yarn type-tests
diff --git a/packages/toolkit/src/entities/sorted_state_adapter.ts b/packages/toolkit/src/entities/sorted_state_adapter.ts
@@ -1,4 +1,3 @@
-import { current, isDraft } from 'immer'
 import type {
   IdSelector,
   Comparer,
@@ -70,9 +69,7 @@ export function createSortedStateAdapter<T, Id extends EntityId>(
   ): void {
     newEntities = ensureEntitiesArray(newEntities)
 
-    const existingKeys = new Set<Id>(
-      existingIds ?? (current(state.ids) as Id[]),
-    )
+    const existingKeys = new Set<Id>(existingIds ?? getCurrent(state.ids))
 
     const models = newEntities.filter(
       (model) => !existingKeys.has(selectIdValue(model, selectId)),
@@ -176,7 +173,7 @@ export function createSortedStateAdapter<T, Id extends EntityId>(
       return false
     }
 
-    for (let i = 0; i < a.length && i < b.length; i++) {
+    for (let i = 0; i < a.length; i++) {
       if (a[i] === b[i]) {
         continue
       }
@@ -192,20 +189,20 @@ export function createSortedStateAdapter<T, Id extends EntityId>(
     replacedIds?: boolean,
   ) => void
 
-  const mergeInsertion: MergeFunction = (
+  const mergeFunction: MergeFunction = (
     state,
     addedItems,
     appliedUpdates,
     replacedIds,
   ) => {
-    const currentEntities = getCurrent(state.entities) as Record<Id, T>
-    const currentIds = getCurrent(state.ids) as Id[]
+    const currentEntities = getCurrent(state.entities)
+    const currentIds = getCurrent(state.ids)
 
     const stateEntities = state.entities as Record<Id, T>
 
-    let ids = currentIds
+    let ids: Iterable<Id> = currentIds
     if (replacedIds) {
-      ids = Array.from(new Set(currentIds))
+      ids = new Set(currentIds)
     }
 
     let sortedEntities: T[] = []
@@ -242,8 +239,6 @@ export function createSortedStateAdapter<T, Id extends EntityId>(
     }
   }
 
-  const mergeFunction: MergeFunction = mergeInsertion
-
   return {
     removeOne,
     removeMany,
diff --git a/packages/toolkit/src/entities/tests/sorted_state_adapter.test.ts b/packages/toolkit/src/entities/tests/sorted_state_adapter.test.ts
@@ -808,6 +808,31 @@ describe('Sorted State Adapter', () => {
     )
   })
 
+  it('should not throw an Immer `current` error when the adapter is called twice', () => {
+    const book1: BookModel = { id: 'a', title: 'First' }
+    const book2: BookModel = { id: 'b', title: 'Second' }
+    const initialState = adapter.getInitialState()
+    const booksSlice = createSlice({
+      name: 'books',
+      initialState,
+      reducers: {
+        testCurrentBehavior(state, action: PayloadAction<BookModel>) {
+          // Will overwrite `state.ids` with a plain array
+          adapter.removeAll(state)
+
+          // will call `splitAddedUpdatedEntities` and call `current(state.ids)`
+          adapter.addOne(state, book1)
+          adapter.addOne(state, book2)
+        },
+      },
+    })
+
+    booksSlice.reducer(
+      initialState,
+      booksSlice.actions.testCurrentBehavior(book1),
+    )
+  })
+
   describe('can be used mutably when wrapped in createNextState', () => {
     test('removeAll', () => {
       const withTwo = adapter.addMany(state, [TheGreatGatsby, AnimalFarm])
diff --git a/packages/toolkit/src/entities/unsorted_state_adapter.ts b/packages/toolkit/src/entities/unsorted_state_adapter.ts
@@ -145,9 +145,7 @@ export function createUnsortedStateAdapter<T, Id extends EntityId>(
           // Spreads ignore falsy values, so this works even if there isn't
           // an existing update already at this key
           changes: {
-            ...(updatesPerEntity[update.id]
-              ? updatesPerEntity[update.id].changes
-              : null),
+            ...updatesPerEntity[update.id]?.changes,
             ...update.changes,
           },
         }
diff --git a/packages/toolkit/src/entities/utils.ts b/packages/toolkit/src/entities/utils.ts
@@ -1,9 +1,10 @@
+import type { Draft } from 'immer'
 import { current, isDraft } from 'immer'
 import type {
+  DraftableEntityState,
+  EntityId,
   IdSelector,
   Update,
-  EntityId,
-  DraftableEntityState,
 } from './models'
 
 export function selectIdValue<T, Id extends EntityId>(
@@ -36,8 +37,8 @@ export function ensureEntitiesArray<T, Id extends EntityId>(
   return entities
 }
 
-export function getCurrent<T>(value: T): T {
-  return isDraft(value) ? current(value) : value
+export function getCurrent<T>(value: T | Draft<T>): T {
+  return (isDraft(value) ? current(value) : value) as T
 }
 
 export function splitAddedUpdatedEntities<T, Id extends EntityId>(
@@ -47,7 +48,7 @@ export function splitAddedUpdatedEntities<T, Id extends EntityId>(
 ): [T[], Update<T, Id>[], Id[]] {
   newEntities = ensureEntitiesArray(newEntities)
 
-  const existingIdsArray = getCurrent(state.ids) as Id[]
+  const existingIdsArray = getCurrent(state.ids)
   const existingIds = new Set<Id>(existingIdsArray)
 
   const added: T[] = []
diff --git a/packages/toolkit/src/tests/configureStore.test.ts b/packages/toolkit/src/tests/configureStore.test.ts
@@ -39,7 +39,11 @@ describe('configureStore', async () => {
         expect.any(Function),
       )
       expect(redux.applyMiddleware).toHaveBeenCalled()
-      expect(composeWithDevToolsSpy).toHaveBeenCalled() // @remap-prod-remove-line
+      if (process.env.TEST_DIST) {
+        expect(composeWithDevToolsSpy).not.toHaveBeenCalled()
+      } else {
+        expect(composeWithDevToolsSpy).toHaveBeenCalledTimes(2)
+      }
     })
   })
 
@@ -53,7 +57,11 @@ describe('configureStore', async () => {
       expect(configureStore({ reducer })).toBeInstanceOf(Object)
       expect(redux.combineReducers).toHaveBeenCalledWith(reducer)
       expect(redux.applyMiddleware).toHaveBeenCalled()
-      expect(composeWithDevToolsSpy).toHaveBeenCalled() // @remap-prod-remove-line
+      if (process.env.TEST_DIST) {
+        expect(composeWithDevToolsSpy).not.toHaveBeenCalled()
+      } else {
+        expect(composeWithDevToolsSpy).toHaveBeenCalledOnce()
+      }
       expect(redux.createStore).toHaveBeenCalledWith(
         expect.any(Function),
         undefined,
@@ -76,7 +84,11 @@ describe('configureStore', async () => {
         configureStore({ middleware: () => new Tuple(), reducer }),
       ).toBeInstanceOf(Object)
       expect(redux.applyMiddleware).toHaveBeenCalledWith()
-      expect(composeWithDevToolsSpy).toHaveBeenCalled() // @remap-prod-remove-line
+      if (process.env.TEST_DIST) {
+        expect(composeWithDevToolsSpy).not.toHaveBeenCalled()
+      } else {
+        expect(composeWithDevToolsSpy).toHaveBeenCalledOnce()
+      }
       expect(redux.createStore).toHaveBeenCalledWith(
         reducer,
         undefined,
@@ -105,7 +117,11 @@ describe('configureStore', async () => {
         expect.any(Function), // serializableCheck
         expect.any(Function), // actionCreatorCheck
       )
-      expect(composeWithDevToolsSpy).toHaveBeenCalled() // @remap-prod-remove-line
+      if (process.env.TEST_DIST) {
+        expect(composeWithDevToolsSpy).not.toHaveBeenCalled()
+      } else {
+        expect(composeWithDevToolsSpy).toHaveBeenCalledOnce()
+      }
       expect(redux.createStore).toHaveBeenCalledWith(
         reducer,
         undefined,
@@ -142,7 +158,11 @@ describe('configureStore', async () => {
         configureStore({ middleware: () => new Tuple(thank), reducer }),
       ).toBeInstanceOf(Object)
       expect(redux.applyMiddleware).toHaveBeenCalledWith(thank)
-      expect(composeWithDevToolsSpy).toHaveBeenCalled() // @remap-prod-remove-line
+      if (process.env.TEST_DIST) {
+        expect(composeWithDevToolsSpy).not.toHaveBeenCalled()
+      } else {
+        expect(composeWithDevToolsSpy).toHaveBeenCalledOnce()
+      }
       expect(redux.createStore).toHaveBeenCalledWith(
         reducer,
         undefined,
@@ -197,7 +217,13 @@ describe('configureStore', async () => {
         Object,
       )
       expect(redux.applyMiddleware).toHaveBeenCalled()
-      expect(composeWithDevToolsSpy).toHaveBeenCalledWith(options) // @remap-prod-remove-line
+      if (process.env.TEST_DIST) {
+        expect(composeWithDevToolsSpy).not.toHaveBeenCalled()
+      } else {
+        expect(composeWithDevToolsSpy).toHaveBeenCalledOnce()
+
+        expect(composeWithDevToolsSpy).toHaveBeenLastCalledWith(options)
+      }
       expect(redux.createStore).toHaveBeenCalledWith(
         reducer,
         undefined,
@@ -210,7 +236,11 @@ describe('configureStore', async () => {
     it('calls createStore with preloadedState', () => {
       expect(configureStore({ reducer })).toBeInstanceOf(Object)
       expect(redux.applyMiddleware).toHaveBeenCalled()
-      expect(composeWithDevToolsSpy).toHaveBeenCalled() // @remap-prod-remove-line
+      if (process.env.TEST_DIST) {
+        expect(composeWithDevToolsSpy).not.toHaveBeenCalled()
+      } else {
+        expect(composeWithDevToolsSpy).toHaveBeenCalledOnce()
+      }
       expect(redux.createStore).toHaveBeenCalledWith(
         reducer,
         undefined,
@@ -241,7 +271,11 @@ describe('configureStore', async () => {
         }),
       ).toBeInstanceOf(Object)
       expect(redux.applyMiddleware).toHaveBeenCalled()
-      expect(composeWithDevToolsSpy).toHaveBeenCalled() // @remap-prod-remove-line
+      if (process.env.TEST_DIST) {
+        expect(composeWithDevToolsSpy).not.toHaveBeenCalled()
+      } else {
+        expect(composeWithDevToolsSpy).toHaveBeenCalledOnce()
+      }
       expect(redux.createStore).toHaveBeenCalledWith(
         reducer,
         undefined,
diff --git a/packages/toolkit/vitest.config.mts b/packages/toolkit/vitest.config.mts
@@ -10,6 +10,14 @@ const __dirname = path.dirname(__filename)
 export default defineConfig({
   plugins: [tsconfigPaths({ root: __dirname })],
   test: {
+    alias: process.env.TEST_DIST
+      ? {
+          '@reduxjs/toolkit': new URL(
+            'node_modules/@reduxjs/toolkit',
+            import.meta.url,
+          ).pathname,
+        }
+      : undefined,
     globals: true,
     environment: 'jsdom',
     setupFiles: ['./vitest.setup.ts'],
