allow produce to be swapped out in createReducer/createSlice

Author: phryneas

packages/toolkit/src/createReducer.ts

@@ -82,7 +82,8 @@ export type ReducerWithInitialState<S extends NotFunction<any>> = Reducer<S> & {
 
 let hasWarnedAboutObjectNotation = false
 
-/**
+export type CreateReducer = {
+  /**
  * A utility function that allows defining a reducer as a mapping from action
  * type to *case reducer* functions that handle these action types. The
  * reducer's initial state is passed as the first argument.
@@ -146,12 +147,12 @@ const reducer = createReducer(
 ```
  * @public
  */
-export function createReducer<S extends NotFunction<any>>(
-  initialState: S | (() => S),
-  builderCallback: (builder: ActionReducerMapBuilder<S>) => void
-): ReducerWithInitialState<S>
+  <S extends NotFunction<any>>(
+    initialState: S | (() => S),
+    builderCallback: (builder: ActionReducerMapBuilder<S>) => void
+  ): ReducerWithInitialState<S>
 
-/**
+  /**
  * A utility function that allows defining a reducer as a mapping from action
  * type to *case reducer* functions that handle these action types. The
  * reducer's initial state is passed as the first argument.
@@ -203,104 +204,118 @@ const counterReducer = createReducer(0, {
 ```
  * @public
  */
-export function createReducer<
-  S extends NotFunction<any>,
-  CR extends CaseReducers<S, any> = CaseReducers<S, any>
->(
-  initialState: S | (() => S),
-  actionsMap: CR,
-  actionMatchers?: ActionMatcherDescriptionCollection<S>,
-  defaultCaseReducer?: CaseReducer<S>
-): ReducerWithInitialState<S>
-
-export function createReducer<S extends NotFunction<any>>(
-  initialState: S | (() => S),
-  mapOrBuilderCallback:
-    | CaseReducers<S, any>
-    | ((builder: ActionReducerMapBuilder<S>) => void),
-  actionMatchers: ReadonlyActionMatcherDescriptionCollection<S> = [],
-  defaultCaseReducer?: CaseReducer<S>
-): ReducerWithInitialState<S> {
-  if (process.env.NODE_ENV !== 'production') {
-    if (typeof mapOrBuilderCallback === 'object') {
-      if (!hasWarnedAboutObjectNotation) {
-        hasWarnedAboutObjectNotation = true
-        console.warn(
-          "The object notation for `createReducer` is deprecated, and will be removed in RTK 2.0. Please use the 'builder callback' notation instead: https://redux-toolkit.js.org/api/createReducer"
-        )
+  <
+    S extends NotFunction<any>,
+    CR extends CaseReducers<S, any> = CaseReducers<S, any>
+  >(
+    initialState: S | (() => S),
+    actionsMap: CR,
+    actionMatchers?: ActionMatcherDescriptionCollection<S>,
+    defaultCaseReducer?: CaseReducer<S>
+  ): ReducerWithInitialState<S>
+}
+
+export interface BuildCreateReducerConfiguration {
+  createNextState: <Base>(
+    base: Base,
+    recipe: (draft: Draft<Base>) => void | Base | Draft<Base>
+  ) => Base
+}
+
+export function buildCreateReducer({
+  createNextState,
+}: BuildCreateReducerConfiguration): CreateReducer {
+  return function createReducer<S extends NotFunction<any>>(
+    initialState: S | (() => S),
+    mapOrBuilderCallback:
+      | CaseReducers<S, any>
+      | ((builder: ActionReducerMapBuilder<S>) => void),
+    actionMatchers: ReadonlyActionMatcherDescriptionCollection<S> = [],
+    defaultCaseReducer?: CaseReducer<S>
+  ): ReducerWithInitialState<S> {
+    if (process.env.NODE_ENV !== 'production') {
+      if (typeof mapOrBuilderCallback === 'object') {
+        if (!hasWarnedAboutObjectNotation) {
+          hasWarnedAboutObjectNotation = true
+          console.warn(
+            "The object notation for `createReducer` is deprecated, and will be removed in RTK 2.0. Please use the 'builder callback' notation instead: https://redux-toolkit.js.org/api/createReducer"
+          )
+        }
       }
     }
-  }
 
-  let [actionsMap, finalActionMatchers, finalDefaultCaseReducer] =
-    typeof mapOrBuilderCallback === 'function'
-      ? executeReducerBuilderCallback(mapOrBuilderCallback)
-      : [mapOrBuilderCallback, actionMatchers, defaultCaseReducer]
-
-  // Ensure the initial state gets frozen either way (if draftable)
-  let getInitialState: () => S
-  if (isStateFunction(initialState)) {
-    getInitialState = () => freezeDraftable(initialState())
-  } else {
-    const frozenInitialState = freezeDraftable(initialState)
-    getInitialState = () => frozenInitialState
-  }
+    let [actionsMap, finalActionMatchers, finalDefaultCaseReducer] =
+      typeof mapOrBuilderCallback === 'function'
+        ? executeReducerBuilderCallback(mapOrBuilderCallback)
+        : [mapOrBuilderCallback, actionMatchers, defaultCaseReducer]
 
-  function reducer(state = getInitialState(), action: any): S {
-    let caseReducers = [
-      actionsMap[action.type],
-      ...finalActionMatchers
-        .filter(({ matcher }) => matcher(action))
-        .map(({ reducer }) => reducer),
-    ]
-    if (caseReducers.filter((cr) => !!cr).length === 0) {
-      caseReducers = [finalDefaultCaseReducer]
+    // Ensure the initial state gets frozen either way (if draftable)
+    let getInitialState: () => S
+    if (isStateFunction(initialState)) {
+      getInitialState = () => freezeDraftable(initialState())
+    } else {
+      const frozenInitialState = freezeDraftable(initialState)
+      getInitialState = () => frozenInitialState
     }
 
-    return caseReducers.reduce((previousState, caseReducer): S => {
-      if (caseReducer) {
-        if (isDraft(previousState)) {
-          // If it's already a draft, we must already be inside a `createNextState` call,
-          // likely because this is being wrapped in `createReducer`, `createSlice`, or nested
-          // inside an existing draft. It's safe to just pass the draft to the mutator.
-          const draft = previousState as Draft<S> // We can assume this is already a draft
-          const result = caseReducer(draft, action)
-
-          if (result === undefined) {
-            return previousState
-          }
+    function reducer(state = getInitialState(), action: any): S {
+      let caseReducers = [
+        actionsMap[action.type],
+        ...finalActionMatchers
+          .filter(({ matcher }) => matcher(action))
+          .map(({ reducer }) => reducer),
+      ]
+      if (caseReducers.filter((cr) => !!cr).length === 0) {
+        caseReducers = [finalDefaultCaseReducer]
+      }
 
-          return result as S
-        } else if (!isDraftable(previousState)) {
-          // If state is not draftable (ex: a primitive, such as 0), we want to directly
-          // return the caseReducer func and not wrap it with produce.
-          const result = caseReducer(previousState as any, action)
+      return caseReducers.reduce((previousState, caseReducer): S => {
+        if (caseReducer) {
+          if (isDraft(previousState)) {
+            // If it's already a draft, we must already be inside a `createNextState` call,
+            // likely because this is being wrapped in `createReducer`, `createSlice`, or nested
+            // inside an existing draft. It's safe to just pass the draft to the mutator.
+            const draft = previousState as Draft<S> // We can assume this is already a draft
+            const result = caseReducer(draft, action)
 
-          if (result === undefined) {
-            if (previousState === null) {
+            if (result === undefined) {
               return previousState
             }
-            throw Error(
-              'A case reducer on a non-draftable value must not return undefined'
-            )
-          }
 
-          return result as S
-        } else {
-          // @ts-ignore createNextState() produces an Immutable<Draft<S>> rather
-          // than an Immutable<S>, and TypeScript cannot find out how to reconcile
-          // these two types.
-          return createNextState(previousState, (draft: Draft<S>) => {
-            return caseReducer(draft, action)
-          })
+            return result as S
+          } else if (!isDraftable(previousState)) {
+            // If state is not draftable (ex: a primitive, such as 0), we want to directly
+            // return the caseReducer func and not wrap it with produce.
+            const result = caseReducer(previousState as any, action)
+
+            if (result === undefined) {
+              if (previousState === null) {
+                return previousState
+              }
+              throw Error(
+                'A case reducer on a non-draftable value must not return undefined'
+              )
+            }
+
+            return result as S
+          } else {
+            // @ts-ignore createNextState() produces an Immutable<Draft<S>> rather
+            // than an Immutable<S>, and TypeScript cannot find out how to reconcile
+            // these two types.
+            return createNextState(previousState, (draft: Draft<S>) => {
+              return caseReducer(draft, action)
+            })
+          }
         }
-      }
 
-      return previousState
-    }, state)
-  }
+        return previousState
+      }, state)
+    }
 
-  reducer.getInitialState = getInitialState
+    reducer.getInitialState = getInitialState
 
-  return reducer as ReducerWithInitialState<S>
+    return reducer as ReducerWithInitialState<S>
+  }
 }
+
+export const createReducer = buildCreateReducer({ createNextState })