cherry-picked enforceAction changes

mobxjs · Aug 27, 2018 · 15a3eaf · 15a3eaf
1 parent 7b9cb35
commit 15a3eaf
Show file tree

Hide file tree

Showing 3 changed files with 30 additions and 9 deletions.
diff --git a/src/api/configure.ts b/src/api/configure.ts
@@ -1,9 +1,10 @@
 import { globalState, isolateGlobalState } from "../core/globalstate"
 import { reserveArrayBuffer } from "../types/observablearray"
 import { setReactionScheduler } from "../core/reaction"
+import { deprecated } from "../utils/utils"
 
 export function configure(options: {
-    enforceActions?: boolean | "strict"
+    enforceActions?: boolean | "strict" | "never" | "always" | "observed"
     computedRequiresReaction?: boolean
     isolateGlobalState?: boolean
     disableErrorBoundaries?: boolean
@@ -18,11 +19,31 @@ export function configure(options: {
         reactionScheduler
     } = options
     if (enforceActions !== undefined) {
-        if (typeof enforceActions !== "boolean" && enforceActions !== "strict")
-            return fail(`Invalid configuration for 'enforceActions': ${enforceActions}`)
-        globalState.enforceActions = enforceActions
-        globalState.allowStateChanges =
-            enforceActions === true || enforceActions === "strict" ? false : true
+        if (typeof enforceActions === "boolean" || enforceActions === "strict")
+            deprecated(
+                `Deprecated value for 'enforceActions', use 'false' => '"never"', 'true' => '"observed"', '"strict"' => "'always'" instead`
+            )
+        let ea
+        switch (enforceActions) {
+            case true:
+            case "observed":
+                ea = true
+                break
+            case false:
+            case "never":
+                ea = false
+                break
+            case "strict":
+            case "always":
+                ea = "strict"
+                break
+            default:
+                fail(
+                    `Invalid value for 'enforceActions': '${enforceActions}', expected 'never', 'always' or 'observed'`
+                )
+        }
+        globalState.enforceActions = ea
+        globalState.allowStateChanges = ea === true || ea === "strict" ? false : true
     }
     if (computedRequiresReaction !== undefined) {
         globalState.computedRequiresReaction = !!computedRequiresReaction

diff --git a/test/base/action.js b/test/base/action.js
@@ -273,7 +273,7 @@ test("#286 exceptions in actions should not affect global state", () => {
 })
 
 test("runInAction", () => {
-    mobx.configure({ enforceActions: true })
+    mobx.configure({ enforceActions: "observed" })
     var values = []
     var events = []
     var spyDisposer = mobx.spy(ev => {
@@ -309,7 +309,7 @@ test("runInAction", () => {
         { arguments: [], name: "<unnamed action>" }
     ])
 
-    mobx.configure({ enforceActions: false })
+    mobx.configure({ enforceActions: "never" })
     spyDisposer()
 
     d()

diff --git a/test/base/strict-mode.js b/test/base/strict-mode.js
@@ -188,7 +188,7 @@ test("strict mode checks", function() {
 
 test("enforceActions 'strict' does not allow changing unobserved observables", () => {
     try {
-        mobx.configure({ enforceActions: "strict" })
+        mobx.configure({ enforceActions: "always" })
         const x = mobx.observable({
             a: 1,
             b: 2