Sort when items are removed

Author: markerikson

src/entities/sorted_state_adapter.test.ts

@@ -1,4 +1,4 @@
-import { EntityStateAdapter, EntityState } from './models'
+import { EntityStateAdapter, EntityState, EntityAdapter } from './models'
 import { createEntityAdapter } from './create_adapter'
 import { createAction } from '../createAction'
 import {
@@ -753,4 +753,75 @@ describe('Sorted State Adapter', () => {
       `)
     })
   })
+
+  describe('Sorted adapter indices', () => {
+    const booksAdapter = createEntityAdapter<BookModel>({
+      selectId: (book: BookModel) => book.id,
+      sortComparer: (a, b) => {
+        return a.title.localeCompare(b.title)
+      },
+      indices: {
+        byId: (a, b) => a.id.localeCompare(b.id),
+        byTitleLength: (a, b) => a.title.length - b.title.length
+      }
+    })
+
+    const initialState = booksAdapter.getInitialState()
+    beforeEach(() => {})
+
+    it('Does some initial sorting', () => {
+      const loadedState = booksAdapter.setAll(initialState, [
+        TheGreatGatsby,
+        AClockworkOrange,
+        AnimalFarm
+      ])
+      expect(loadedState.indices.byId.length).toBe(3)
+    })
+
+    it('Resorts only updated indices', () => {
+      const loadedState = booksAdapter.setAll(initialState, [
+        TheGreatGatsby,
+        AClockworkOrange,
+        AnimalFarm
+      ])
+
+      const updatedState = booksAdapter.updateOne(loadedState, {
+        id: AnimalFarm.id,
+        changes: {
+          title: 'This is a really long title, very long indeed'
+        }
+      })
+
+      expect(updatedState.indices.byTitleLength[2]).toBe(AnimalFarm.id)
+      expect(updatedState.indices.byId).toBe(loadedState.indices.byId)
+    })
+
+    it('Updates indices when items are removed', () => {
+      const loadedState = booksAdapter.setAll(initialState, [
+        TheGreatGatsby,
+        AClockworkOrange,
+        AnimalFarm
+      ])
+
+      const updatedState1 = booksAdapter.removeOne(
+        loadedState,
+        AClockworkOrange.id
+      )
+
+      expect(updatedState1.indices.byId.length).toBe(2)
+      expect(updatedState1.indices.byTitleLength.length).toBe(2)
+
+      const updatedState2 = booksAdapter.removeMany(loadedState, [
+        AClockworkOrange.id
+      ])
+
+      expect(updatedState2.indices.byId.length).toBe(2)
+      expect(updatedState2.indices.byTitleLength.length).toBe(2)
+
+      const updatedState3 = booksAdapter.removeAll(loadedState)
+
+      expect(updatedState3.indices.byId.length).toBe(0)
+      expect(updatedState3.indices.byTitleLength.length).toBe(0)
+    })
+  })
 })

src/entities/sorted_state_adapter.ts

@@ -7,7 +7,10 @@ import {
   EntityId,
   IndexComparers
 } from './models'
-import { createStateOperator } from './state_adapter'
+import {
+  createStateOperator,
+  createSingleArgumentStateOperator
+} from './state_adapter'
 import { createUnsortedStateAdapter } from './unsorted_state_adapter'
 import {
   selectIdValue,
@@ -141,6 +144,34 @@ export function createSortedStateAdapter<T>(
       state.entities[selectId(model)] = model
     })
 
+    updateSortedIndices(state)
+  }
+
+  function removeOneSortedIndices(key: EntityId, state: R): void {
+    removeOne(state, key)
+    updateSortedIndices(state)
+  }
+
+  function removeManySortedIndices(keys: EntityId[], state: R): void {
+    removeMany(state, keys)
+    updateSortedIndices(state)
+  }
+
+  function removeAllSortedIndices(state: R): void {
+    const newIndices = {} as any
+
+    for (let key in indices) {
+      newIndices[key] = []
+    }
+
+    Object.assign(state, {
+      ids: [],
+      entities: {},
+      indices: newIndices
+    })
+  }
+
+  function updateSortedIndices(state: EntityState<T>) {
     const allEntities = Object.values(state.entities) as T[]
     updateSortedIds(
       (state as unknown) as Record<string, EntityId[]>,
@@ -155,9 +186,9 @@ export function createSortedStateAdapter<T>(
   }
 
   return {
-    removeOne,
-    removeMany,
-    removeAll,
+    removeOne: createStateOperator(removeOneSortedIndices),
+    removeMany: createStateOperator(removeManySortedIndices),
+    removeAll: createSingleArgumentStateOperator(removeAllSortedIndices),
     addOne: createStateOperator(addOneMutably),
     updateOne: createStateOperator(updateOneMutably),
     upsertOne: createStateOperator(upsertOneMutably),