refactor(strict-mode): refactor strict mode with mutative

Author: unadlib

packages/reactant-model/package.json

@@ -21,11 +21,11 @@
   ],
   "license": "MIT",
   "peerDependencies": {
-    "mutative": "^0.4.1",
+    "mutative": "^0.4.2",
     "reactant-module": "*"
   },
   "devDependencies": {
-    "mutative": "^0.4.1",
+    "mutative": "^0.4.2",
     "reactant-module": "^0.71.0"
   }
 }

packages/reactant-model/src/model.ts

@@ -1,4 +1,4 @@
-import { create, Patch, Immutable } from 'mutative';
+import { create, Immutable } from 'mutative';
 import {
   storeKey,
   Service,
@@ -8,6 +8,8 @@ import {
   enableAutoFreezeKey,
   identifierKey,
   nameKey,
+  strictKey,
+  Patch,
 } from 'reactant-module';
 
 interface Scheme<S, A> {
@@ -32,8 +34,8 @@ export const model = <
     Object.assign(scheme.actions, {
       [key]: (...args: any[]) => {
         let state: Immutable<S> | S | undefined;
-        let patches: Patch<true>[] | undefined;
-        let inversePatches: Patch<true>[] | undefined;
+        let patches: Patch[] | undefined;
+        let inversePatches: Patch[] | undefined;
         if (module[enablePatchesKey]) {
           [state, patches, inversePatches] = create(
             module[stateKey] as S,
@@ -42,6 +44,7 @@ export const model = <
             },
             {
               enablePatches: true,
+              strict: module[strictKey],
               enableAutoFreeze: module[enableAutoFreezeKey],
             }
           );
@@ -52,6 +55,7 @@ export const model = <
               fn(...args)(draftState);
             },
             {
+              strict: module[strictKey],
               enableAutoFreeze: module[enableAutoFreezeKey],
             }
           );

packages/reactant-module/package.json

@@ -26,7 +26,7 @@
   ],
   "license": "MIT",
   "dependencies": {
-    "mutative": "^0.4.1",
+    "mutative": "^0.4.2",
     "reactant-di": "^0.71.0",
     "redux": "^4.1.0"
   },

packages/reactant-module/src/constants/reduxKeys.ts

@@ -6,5 +6,6 @@ export const stateKey: unique symbol = Symbol('state');
 export const defaultStateKey: unique symbol = Symbol('defaultState');
 export const enablePatchesKey: unique symbol = Symbol('enablePatches');
 export const enableAutoFreezeKey: unique symbol = Symbol('enableAutoFreeze');
+export const strictKey: unique symbol = Symbol('strict');
 export const enableInspectorKey: unique symbol = Symbol('enableInspector');
 export const actionIdentifier = 'REACTANT_ACTION' as const;

packages/reactant-module/src/core/createStore.ts

@@ -37,6 +37,7 @@ import {
   subscriptionsKey,
   enableInspectorKey,
   dynamicModulesKey,
+  strictKey,
 } from '../constants';
 import { getStagedState } from '../decorators';
 import type {
@@ -91,6 +92,7 @@ export function createStore<T = any>({
   const enableReduxDevTools = devOptions.reduxDevTools ?? __DEV__;
   const enablePatches = devOptions.enablePatches ?? false;
   const enableInspector = devOptions.enableInspector ?? false;
+  const strict = devOptions.strict ?? false;
 
   dynamicModules.forEach((module, key) => {
     try {
@@ -314,6 +316,12 @@ export function createStore<T = any>({
                 load(...args);
               },
             },
+            // use strict mode for mutative
+            [strictKey]: {
+              enumerable: false,
+              configurable: false,
+              value: strict,
+            },
             // enableAutoFreeze options for mutative
             [enableAutoFreezeKey]: {
               enumerable: false,
@@ -326,6 +334,7 @@ export function createStore<T = any>({
               configurable: false,
               value: enablePatches,
             },
+
             // enableInspector options for state changing check before dispatching
             [enableInspectorKey]: {
               enumerable: false,

packages/reactant-module/src/decorators/action.ts

@@ -1,14 +1,15 @@
 /* eslint-disable no-console */
 /* eslint-disable func-names */
-import { create, Patch } from 'mutative';
-import { ReactantAction, Service } from '../interfaces';
+import { create } from 'mutative';
+import { Patch, ReactantAction, Service } from '../interfaces';
 import {
   storeKey,
   actionIdentifier,
   enablePatchesKey,
   enableAutoFreezeKey,
   identifierKey,
   enableInspectorKey,
+  strictKey,
 } from '../constants';
 
 let stagedState: Record<string, unknown> | undefined;
@@ -82,6 +83,7 @@ const action = (
             },
             {
               enablePatches: true,
+              strict: this[strictKey],
               enableAutoFreeze: this[enableAutoFreezeKey],
             }
           );
@@ -98,6 +100,7 @@ const action = (
               }
             },
             {
+              strict: this[strictKey],
               enableAutoFreeze: this[enableAutoFreezeKey],
             }
           );

packages/reactant-module/src/index.ts

@@ -1,4 +1,5 @@
-export { apply as applyPatches } from 'mutative';
+export { apply as applyPatches, current, original, unsafe } from 'mutative';
+
 export {
   inject,
   optional,

packages/reactant-module/src/interfaces.ts

@@ -9,7 +9,7 @@ import type {
   Unsubscribe,
   ReducersMapObject,
 } from 'redux';
-import type { Patch } from 'mutative';
+import type { Patch as IPatch, Patches as IPatches } from 'mutative';
 import type { EnhancerOptions } from 'redux-devtools-extension';
 import type {
   Container,
@@ -32,12 +32,17 @@ import {
   initStateKey,
   unsubscriptionsKey,
   enableInspectorKey,
+  strictKey,
 } from './constants';
 import { PluginModule } from './core';
 
+export type Patch = IPatch<true>;
+
+export type Patches = IPatches<true>;
+
 export interface DevOptions {
   /**
-   * Enable react strict mode.
+   * Enable strict mode for React and Mutative.
    */
   strict?: boolean;
   /**
@@ -78,6 +83,7 @@ export interface Service<T extends Record<string, any> = Record<string, any>> {
   readonly [loaderKey]?: Loader;
   readonly [enablePatchesKey]?: boolean;
   readonly [enableAutoFreezeKey]?: boolean;
+  readonly [strictKey]?: boolean;
   readonly [enableInspectorKey]?: boolean;
   readonly [subscriptionsKey]?: Subscriptions;
   readonly [unsubscriptionsKey]?: Set<Unsubscribe>;
@@ -103,8 +109,8 @@ export interface ReactantAction<T = any> extends Action<string | symbol> {
   state: Record<string, T>;
   params: any[];
   _reactant: typeof actionIdentifier;
-  _patches?: Patch<true>[];
-  _inversePatches?: Patch<true>[];
+  _patches?: Patch[];
+  _inversePatches?: Patch[];
 }
 
 export type StateMapObject<T extends Record<string, Function>> = {

yarn.lock

@@ -9076,10 +9076,10 @@ multimatch@^5.0.0:
     arrify "^2.0.1"
     minimatch "^3.0.4"
 
-mutative@^0.4.1:
-  version "0.4.1"
-  resolved "https://registry.yarnpkg.com/mutative/-/mutative-0.4.1.tgz#7e71eb01ec24e5a8b031079588d5455fa16786e7"
-  integrity sha512-V3z99IFyMfmGoEFoYWXgyEzPis3nsqu8SceQFgR2dKm+Rzn8lQBle/VjPF9sEh1xABxgJvCicQ82q0iwdj4E+A==
+mutative@^0.4.2:
+  version "0.4.2"
+  resolved "https://registry.yarnpkg.com/mutative/-/mutative-0.4.2.tgz#dacdae80c32f09b380979cfc534c4274f5a46079"
+  integrity sha512-zAWi/R6mShx7Dr6SnT61Z2Wf2TKVbAVGPzoS8vbr/fK5X0e7hD4pglpLSCWNtA0jh3RoS0QsdjJCywbQpwef5g==
 
 mute-stream@0.0.7:
   version "0.0.7"