Update config options to always be false in prod

Update API docs with new options

Author: jordangarcia

docs/src/docs/07-api.md

@@ -19,7 +19,38 @@ var reactor = Nuclear.Reactor(config)
 
 **Configuration Options**
 
-`config.debug` Boolean - if true it will log the entire app state for every dispatch.
+`config.debug` Boolean - if true it will enabled logging for dispatches and throw Errors in various circumstances described below.
+
+**config.options** (added in 1.3)
+
+If `config.debug` is true then all of the options below will be enabled.
+
+`logDispatches` (default=`false`) console.logs for every action. If disabled `logAppState` and `logDirtyStores` will be ignored, as no dispatch logging is occurring.
+
+`logAppState` (default=`false`) console.logs a snapshot of the entire app state after every dispatch.  Disabling this can improve performance.
+
+`logDirtyStores` (default=`false`) console.logs what stores have changed after each dispatched action.
+
+`throwOnUndefinedDispatch` (default=`false`) if true, throws an Error if a store ever returns undefined.
+
+`throwOnNonImmutableStore` (default=`false`) if true, throws an Error if a store returns a non-immutable value. Javascript primitive such as `String`, `Boolean` and `Number` count as immutable.
+
+`throwOnDispatchInDispatch` (default=`true`) if true, throws an Error if a dispatch occurs in a change observer.
+
+**Example**
+
+```javascript
+var reactor = new Nuclear.Reactor({
+  debug: true,
+  options: {
+    // do not log entire app state
+    logAppState: false,
+    // allow dispatch in dispatch
+    throwOnDispatchInDispatch: false,
+  },
+})
+```
+
 
 #### `Reactor#dispatch(messageType, messagePayload)`
 

src/reactor.js

@@ -110,7 +110,7 @@ class Reactor {
    */
   dispatch(actionType, payload) {
     if (this.__batchDepth === 0) {
-      if (!fns.getOption(this.reactorState, 'allowDispatchInDispatch')) {
+      if (fns.getOption(this.reactorState, 'throwOnDispatchInDispatch')) {
         if (this.__isDispatching) {
           this.__isDispatching = false
           throw new Error('Dispatch may not be called while a dispatch is in progress')

src/reactor/fns.js

@@ -34,7 +34,7 @@ export function registerStores(reactorState, stores) {
 
       const initialState = store.getInitialState()
 
-      if (!getOption(reactorState, 'allowNonImmutableStores') && !isImmutableValue(initialState)) {
+      if (getOption(reactorState, 'throwOnNonImmutableStore') && !isImmutableValue(initialState)) {
         throw new Error('Store getInitialState() must return an immutable value, did you forget to call toImmutable')
       }
 
@@ -74,7 +74,7 @@ export function dispatch(reactorState, actionType, payload) {
         throw e
       }
 
-      if (!getOption(reactorState, 'allowUndefinedDispatch') && newState === undefined) {
+      if (getOption(reactorState, 'throwOnUndefinedDispatch') && newState === undefined) {
         const errorMsg = 'Store handler must return a value, did you forget a return statement'
         logging.dispatchError(reactorState, errorMsg)
         throw new Error(errorMsg)
@@ -275,10 +275,10 @@ export function reset(reactorState) {
     storeMap.forEach((store, id) => {
       const storeState = prevState.get(id)
       const resetStoreState = store.handleReset(storeState)
-      if (!getOption(reactorState, 'allowUndefinedDispatch') && resetStoreState === undefined) {
+      if (getOption(reactorState, 'throwOnUndefinedDispatch') && resetStoreState === undefined) {
         throw new Error('Store handleReset() must return a value, did you forget a return statement')
       }
-      if (!getOption(reactorState, 'allowNonImmutableStores') && !isImmutableValue(resetStoreState)) {
+      if (getOption(reactorState, 'throwOnNonImmutableStore') && !isImmutableValue(resetStoreState)) {
         throw new Error('Store reset state must be an immutable value, did you forget to call toImmutable')
       }
       reactorState.setIn(['state', id], resetStoreState)

src/reactor/records.js

@@ -7,12 +7,27 @@ export const PROD_OPTIONS = Map({
   logAppState: false,
   // logs what stores changed after a dispatch
   logDirtyStores: false,
-  // if false, throw an error if a store returns undefined
-  allowUndefinedDispatch: true,
-  // if false, throw an error if a store returns undefined
-  allowNonImmutableStores: true,
-  // if false throw when dispatching in dispatch
-  allowDispatchInDispatch: true,
+  // if true, throws an error if a store returns undefined
+  throwOnUndefinedDispatch: false,
+  // if true, throws an error if a store returns undefined
+  throwOnNonImmutableStore: false,
+  // if true, throws when dispatching in dispatch
+  throwOnDispatchInDispatch: false,
+})
+
+export const DEBUG_OPTIONS = Map({
+  // logs information for each dispatch
+  logDispatches: true,
+  // log the entire app state after each dispatch
+  logAppState: true,
+  // logs what stores changed after a dispatch
+  logDirtyStores: true,
+  // if true, throws an error if a store returns undefined
+  throwOnUndefinedDispatch: true,
+  // if true, throws an error if a store returns undefined
+  throwOnNonImmutableStore: true,
+  // if true, throws when dispatching in dispatch
+  throwOnDispatchInDispatch: true,
 })
 
 export const ReactorState = Record({
@@ -38,19 +53,3 @@ export const ObserverState = Record({
 
   nextId: 1,
 })
-
-export const DEBUG_OPTIONS = Map({
-  // logs information for each dispatch
-  logDispatches: true,
-  // log the entire app state after each dispatch
-  logAppState: true,
-  // logs what stores changed after a dispatch
-  logDirtyStores: true,
-  // if false, throw an error if a store returns undefined
-  allowUndefinedDispatch: false,
-  // if false, throw an error if a store returns undefined
-  allowNonImmutableStores: false,
-  // if false throw when dispatching in dispatch
-  allowDispatchInDispatch: false,
-})
-

tests/reactor-fns-tests.js

@@ -505,18 +505,18 @@ describe('reactor fns', () => {
     it('should parse the option value in a reactorState', () => {
       const reactorState = new ReactorState({
         options: Map({
-          allowUndefinedDispatch: true,
+          throwOnUndefinedDispatch: true,
         }),
       })
 
-      const result = fns.getOption(reactorState, 'allowUndefinedDispatch')
+      const result = fns.getOption(reactorState, 'throwOnUndefinedDispatch')
       expect(result).toBe(true)
     })
 
     it('should throw an error if the option doesn\'t', () => {
       const reactorState = new ReactorState({
         options: Map({
-          allowUndefinedDispatch: true,
+          throwOnUndefinedDispatch: true,
         }),
       })
 

tests/reactor-tests.js

@@ -33,24 +33,24 @@ describe('Reactor', () => {
       expect(getOption(reactor.reactorState, 'logDispatches')).toBe(true)
       expect(getOption(reactor.reactorState, 'logAppState')).toBe(false)
       expect(getOption(reactor.reactorState, 'logDirtyStores')).toBe(false)
-      expect(getOption(reactor.reactorState, 'allowUndefinedDispatch')).toBe(true)
-      expect(getOption(reactor.reactorState, 'allowNonImmutableStores')).toBe(true)
-      expect(getOption(reactor.reactorState, 'allowDispatchInDispatch')).toBe(true)
+      expect(getOption(reactor.reactorState, 'throwOnUndefinedDispatch')).toBe(false)
+      expect(getOption(reactor.reactorState, 'throwOnNonImmutableStore')).toBe(false)
+      expect(getOption(reactor.reactorState, 'throwOnDispatchInDispatch')).toBe(false)
     })
     it('should override DEBUG options', () => {
       var reactor = new Reactor({
         debug: true,
         options: {
           logDispatches: false,
-          allowDispatchInDispatch: true,
+          throwOnDispatchInDispatch: false,
         }
       })
       expect(getOption(reactor.reactorState, 'logDispatches')).toBe(false)
       expect(getOption(reactor.reactorState, 'logAppState')).toBe(true)
       expect(getOption(reactor.reactorState, 'logDirtyStores')).toBe(true)
-      expect(getOption(reactor.reactorState, 'allowUndefinedDispatch')).toBe(false)
-      expect(getOption(reactor.reactorState, 'allowNonImmutableStores')).toBe(false)
-      expect(getOption(reactor.reactorState, 'allowDispatchInDispatch')).toBe(true)
+      expect(getOption(reactor.reactorState, 'throwOnUndefinedDispatch')).toBe(true)
+      expect(getOption(reactor.reactorState, 'throwOnNonImmutableStore')).toBe(true)
+      expect(getOption(reactor.reactorState, 'throwOnDispatchInDispatch')).toBe(false)
     })
   })