Merge pull request reduxjs#4055 from reduxjs/feature/update-error-messages

Author: markerikson

.codesandbox/ci.json

@@ -0,0 +1,7 @@
+{
+  "sandboxes": [
+    "vanilla",
+    "vanilla-ts"
+  ],
+  "node": "14"
+}

errors.json

@@ -1,19 +1,19 @@
 {
-  "0": "It looks like you are passing several store enhancers to createStore(). This is not supported. Instead, compose them together to a single function.",
-  "1": "Expected the enhancer to be a function.",
-  "2": "Expected the reducer to be a function.",
+  "0": "It looks like you are passing several store enhancers to createStore(). This is not supported. Instead, compose them together to a single function. See https://redux.js.org/tutorials/fundamentals/part-4-store#creating-a-store-with-enhancers for an example.",
+  "1": "Expected the enhancer to be a function. Instead, received: ''",
+  "2": "Expected the root reducer to be a function. Instead, received: ''",
   "3": "You may not call store.getState() while the reducer is executing. The reducer has already received the state as an argument. Pass it down from the top reducer instead of reading it from the store.",
-  "4": "Expected the listener to be a function.",
+  "4": "Expected the listener to be a function. Instead, received: ''",
   "5": "You may not call store.subscribe() while the reducer is executing. If you would like to be notified after the store has been updated, subscribe from a component and invoke store.getState() in the callback to access the latest state. See https://redux.js.org/api/store#subscribelistener for more details.",
   "6": "You may not unsubscribe from a store listener while the reducer is executing. See https://redux.js.org/api/store#subscribelistener for more details.",
-  "7": "Actions must be plain objects. Use custom middleware for async actions.",
-  "8": "Actions may not have an undefined \"type\" property. Have you misspelled a constant?",
+  "7": "Actions must be plain objects. Instead, the actual type was: ''. You may need to add middleware to your store setup to handle dispatching other values, such as 'redux-thunk' to handle dispatching functions. See https://redux.js.org/tutorials/fundamentals/part-4-store#middleware and https://redux.js.org/tutorials/fundamentals/part-6-async-logic#using-the-redux-thunk-middleware for examples.",
+  "8": "Actions may not have an undefined \"type\" property. You may have misspelled an action type string constant.",
   "9": "Reducers may not dispatch actions.",
-  "10": "Expected the nextReducer to be a function.",
-  "11": "Expected the observer to be an object.",
-  "12": "bindActionCreators expected an object or a function, instead received . Did you write \"import ActionCreators from\" instead of \"import * as ActionCreators from\"?",
-  "13": "Dispatching while constructing your middleware is not allowed. Other middleware would not be applied to this dispatch.",
-  "14": "Reducer \"\" returned undefined during initialization. If the state passed to the reducer is undefined, you must explicitly return the initial state. The initial state may not be undefined. If you don't want to set a value for this reducer, you can use null instead of undefined.",
-  "15": "Reducer \"\" returned undefined when probed with a random type. Don't try to handle  or other actions in \"redux/*\" namespace. They are considered private. Instead, you must return the current state for any unknown actions, unless it is undefined, in which case you must return the initial state, regardless of the action type. The initial state may not be undefined, but can be null.",
-  "16": "Super expression must either be null or a function"
+  "10": "Expected the nextReducer to be a function. Instead, received: '",
+  "11": "Expected the observer to be an object. Instead, received: ''",
+  "12": "The slice reducer for key \"\" returned undefined during initialization. If the state passed to the reducer is undefined, you must explicitly return the initial state. The initial state may not be undefined. If you don't want to set a value for this reducer, you can use null instead of undefined.",
+  "13": "The slice reducer for key \"\" returned undefined when probed with a random type. Don't try to handle '' or other actions in \"redux/*\" namespace. They are considered private. Instead, you must return the current state for any unknown actions, unless it is undefined, in which case you must return the initial state, regardless of the action type. The initial state may not be undefined, but can be null.",
+  "14": "When called with an action of type , the slice reducer for key \"\" returned undefined. To ignore an action, you must explicitly return the previous state. If you want this reducer to hold no value, you can return null instead of undefined.",
+  "15": "Dispatching while constructing your middleware is not allowed. Other middleware would not be applied to this dispatch.",
+  "16": "bindActionCreators expected an object or a function, but instead received: ''. Did you write \"import ActionCreators from\" instead of \"import * as ActionCreators from\"?"
 }

scripts/mangleErrors.js

@@ -89,6 +89,11 @@ module.exports = babel => {
 
           const errorMsgLiteral = evalToString(path.node.argument.arguments[0])
 
+          if (errorMsgLiteral.includes('Super expression')) {
+            // ignore Babel runtime error message
+            return
+          }
+
           // Attempt to get the existing index of the error. If it is not found, add it to the array as a new error.
           let errorIndex = errors.indexOf(errorMsgLiteral)
           if (errorIndex === -1) {

src/bindActionCreators.ts

@@ -4,6 +4,7 @@ import {
   ActionCreator,
   ActionCreatorsMapObject
 } from './types/actions'
+import { kindOf } from './utils/kindOf'
 
 function bindActionCreator<A extends AnyAction = AnyAction>(
   actionCreator: ActionCreator<A>,
@@ -64,9 +65,9 @@ export default function bindActionCreators(
 
   if (typeof actionCreators !== 'object' || actionCreators === null) {
     throw new Error(
-      `bindActionCreators expected an object or a function, instead received ${
-        actionCreators === null ? 'null' : typeof actionCreators
-      }. ` +
+      `bindActionCreators expected an object or a function, but instead received: '${kindOf(
+        actionCreators
+      )}'. ` +
         `Did you write "import ActionCreators from" instead of "import * as ActionCreators from"?`
     )
   }

src/combineReducers.ts

@@ -10,18 +10,7 @@ import { CombinedState } from './types/store'
 import ActionTypes from './utils/actionTypes'
 import isPlainObject from './utils/isPlainObject'
 import warning from './utils/warning'
-
-function getUndefinedStateErrorMessage(key: string, action: Action) {
-  const actionType = action && action.type
-  const actionDescription =
-    (actionType && `action "${String(actionType)}"`) || 'an action'
-
-  return (
-    `Given ${actionDescription}, reducer "${key}" returned undefined. ` +
-    `To ignore an action, you must explicitly return the previous state. ` +
-    `If you want this reducer to hold no value, you can return null instead of undefined.`
-  )
-}
+import { kindOf } from './utils/kindOf'
 
 function getUnexpectedStateShapeWarningMessage(
   inputState: object,
@@ -43,14 +32,10 @@ function getUnexpectedStateShapeWarningMessage(
   }
 
   if (!isPlainObject(inputState)) {
-    const match = Object.prototype.toString
-      .call(inputState)
-      .match(/\s([a-z|A-Z]+)/)
-    const matchType = match ? match[1] : ''
     return (
-      `The ${argumentName} has unexpected type of "` +
-      matchType +
-      `". Expected argument to be an object with the following ` +
+      `The ${argumentName} has unexpected type of "${kindOf(
+        inputState
+      )}". Expected argument to be an object with the following ` +
       `keys: "${reducerKeys.join('", "')}"`
     )
   }
@@ -82,7 +67,7 @@ function assertReducerShape(reducers: ReducersMapObject) {
 
     if (typeof initialState === 'undefined') {
       throw new Error(
-        `Reducer "${key}" returned undefined during initialization. ` +
+        `The slice reducer for key "${key}" returned undefined during initialization. ` +
           `If the state passed to the reducer is undefined, you must ` +
           `explicitly return the initial state. The initial state may ` +
           `not be undefined. If you don't want to set a value for this reducer, ` +
@@ -96,8 +81,8 @@ function assertReducerShape(reducers: ReducersMapObject) {
       }) === 'undefined'
     ) {
       throw new Error(
-        `Reducer "${key}" returned undefined when probed with a random type. ` +
-          `Don't try to handle ${ActionTypes.INIT} or other actions in "redux/*" ` +
+        `The slice reducer for key "${key}" returned undefined when probed with a random type. ` +
+          `Don't try to handle '${ActionTypes.INIT}' or other actions in "redux/*" ` +
           `namespace. They are considered private. Instead, you must return the ` +
           `current state for any unknown actions, unless it is undefined, ` +
           `in which case you must return the initial state, regardless of the ` +
@@ -197,8 +182,14 @@ export default function combineReducers(reducers: ReducersMapObject) {
       const previousStateForKey = state[key]
       const nextStateForKey = reducer(previousStateForKey, action)
       if (typeof nextStateForKey === 'undefined') {
-        const errorMessage = getUndefinedStateErrorMessage(key, action)
-        throw new Error(errorMessage)
+        const actionType = action && action.type
+        throw new Error(
+          `When called with an action of type ${
+            actionType ? `"${String(actionType)}"` : '(unknown type)'
+          }, the slice reducer for key "${key}" returned undefined. ` +
+            `To ignore an action, you must explicitly return the previous state. ` +
+            `If you want this reducer to hold no value, you can return null instead of undefined.`
+        )
       }
       nextState[key] = nextStateForKey
       hasChanged = hasChanged || nextStateForKey !== previousStateForKey

src/createStore.ts

@@ -12,6 +12,7 @@ import { Action } from './types/actions'
 import { Reducer } from './types/reducers'
 import ActionTypes from './utils/actionTypes'
 import isPlainObject from './utils/isPlainObject'
+import { kindOf } from './utils/kindOf'
 
 /**
  * Creates a Redux store that holds the state tree.
@@ -74,7 +75,7 @@ export default function createStore<
     throw new Error(
       'It looks like you are passing several store enhancers to ' +
         'createStore(). This is not supported. Instead, compose them ' +
-        'together to a single function.'
+        'together to a single function. See https://redux.js.org/tutorials/fundamentals/part-4-store#creating-a-store-with-enhancers for an example.'
     )
   }
 
@@ -85,7 +86,11 @@ export default function createStore<
 
   if (typeof enhancer !== 'undefined') {
     if (typeof enhancer !== 'function') {
-      throw new Error('Expected the enhancer to be a function.')
+      throw new Error(
+        `Expected the enhancer to be a function. Instead, received: '${kindOf(
+          enhancer
+        )}'`
+      )
     }
 
     return enhancer(createStore)(
@@ -95,7 +100,11 @@ export default function createStore<
   }
 
   if (typeof reducer !== 'function') {
-    throw new Error('Expected the reducer to be a function.')
+    throw new Error(
+      `Expected the root reducer to be a function. Instead, received: '${kindOf(
+        reducer
+      )}'`
+    )
   }
 
   let currentReducer = reducer
@@ -159,7 +168,11 @@ export default function createStore<
    */
   function subscribe(listener: () => void) {
     if (typeof listener !== 'function') {
-      throw new Error('Expected the listener to be a function.')
+      throw new Error(
+        `Expected the listener to be a function. Instead, received: '${kindOf(
+          listener
+        )}'`
+      )
     }
 
     if (isDispatching) {
@@ -225,15 +238,15 @@ export default function createStore<
   function dispatch(action: A) {
     if (!isPlainObject(action)) {
       throw new Error(
-        'Actions must be plain objects. ' +
-          'Use custom middleware for async actions.'
+        `Actions must be plain objects. Instead, the actual type was: '${kindOf(
+          action
+        )}'. You may need to add middleware to your store setup to handle dispatching other values, such as 'redux-thunk' to handle dispatching functions. See https://redux.js.org/tutorials/fundamentals/part-4-store#middleware and https://redux.js.org/tutorials/fundamentals/part-6-async-logic#using-the-redux-thunk-middleware for examples.`
       )
     }
 
     if (typeof action.type === 'undefined') {
       throw new Error(
-        'Actions may not have an undefined "type" property. ' +
-          'Have you misspelled a constant?'
+        'Actions may not have an undefined "type" property. You may have misspelled an action type string constant.'
       )
     }
 
@@ -271,7 +284,11 @@ export default function createStore<
     nextReducer: Reducer<NewState, NewActions>
   ): Store<ExtendState<NewState, StateExt>, NewActions, StateExt, Ext> & Ext {
     if (typeof nextReducer !== 'function') {
-      throw new Error('Expected the nextReducer to be a function.')
+      throw new Error(
+        `Expected the nextReducer to be a function. Instead, received: '${kindOf(
+          nextReducer
+        )}`
+      )
     }
 
     // TODO: do this more elegantly
@@ -314,7 +331,11 @@ export default function createStore<
        */
       subscribe(observer: unknown) {
         if (typeof observer !== 'object' || observer === null) {
-          throw new TypeError('Expected the observer to be an object.')
+          throw new TypeError(
+            `Expected the observer to be an object. Instead, received: '${kindOf(
+              observer
+            )}'`
+          )
         }
 
         function observeState() {

src/utils/kindOf.ts

@@ -0,0 +1,66 @@
+export function kindOf(val: any): string {
+  let typeOfVal: string = typeof val
+
+  if (process.env.NODE_ENV !== 'production') {
+    // Inlined / shortened version of `kindOf` from https://github.com/jonschlinkert/kind-of
+    function miniKindOf(val: any) {
+      if (val === void 0) return 'undefined'
+      if (val === null) return 'null'
+
+      const type = typeof val
+      switch (type) {
+        case 'boolean':
+        case 'string':
+        case 'number':
+        case 'symbol':
+        case 'function': {
+          return type
+        }
+      }
+
+      if (Array.isArray(val)) return 'array'
+      if (isDate(val)) return 'date'
+      if (isError(val)) return 'error'
+
+      const constructorName = ctorName(val)
+      switch (constructorName) {
+        case 'Symbol':
+        case 'Promise':
+        case 'WeakMap':
+        case 'WeakSet':
+        case 'Map':
+        case 'Set':
+          return constructorName
+      }
+
+      // other
+      return type.slice(8, -1).toLowerCase().replace(/\s/g, '')
+    }
+
+    function ctorName(val: any): string | null {
+      return typeof val.constructor === 'function' ? val.constructor.name : null
+    }
+
+    function isError(val: any) {
+      return (
+        val instanceof Error ||
+        (typeof val.message === 'string' &&
+          val.constructor &&
+          typeof val.constructor.stackTraceLimit === 'number')
+      )
+    }
+
+    function isDate(val: any) {
+      if (val instanceof Date) return true
+      return (
+        typeof val.toDateString === 'function' &&
+        typeof val.getDate === 'function' &&
+        typeof val.setDate === 'function'
+      )
+    }
+
+    typeOfVal = miniKindOf(val)
+  }
+
+  return typeOfVal
+}

test/bindActionCreators.spec.ts

@@ -77,17 +77,17 @@ describe('bindActionCreators', () => {
     expect(() => {
       bindActionCreators(undefined, store.dispatch)
     }).toThrow(
-      'bindActionCreators expected an object or a function, instead received undefined. ' +
-        'Did you write "import ActionCreators from" instead of "import * as ActionCreators from"?'
+      `bindActionCreators expected an object or a function, but instead received: 'undefined'. ` +
+        `Did you write "import ActionCreators from" instead of "import * as ActionCreators from"?`
     )
   })
 
   it('throws for a null actionCreator', () => {
     expect(() => {
       bindActionCreators(null, store.dispatch)
     }).toThrow(
-      'bindActionCreators expected an object or a function, instead received null. ' +
-        'Did you write "import ActionCreators from" instead of "import * as ActionCreators from"?'
+      `bindActionCreators expected an object or a function, but instead received: 'null'. ` +
+        `Did you write "import ActionCreators from" instead of "import * as ActionCreators from"?`
     )
   })
 
@@ -98,8 +98,8 @@ describe('bindActionCreators', () => {
         store.dispatch
       )
     }).toThrow(
-      'bindActionCreators expected an object or a function, instead received string. ' +
-        'Did you write "import ActionCreators from" instead of "import * as ActionCreators from"?'
+      `bindActionCreators expected an object or a function, but instead received: 'string'. ` +
+        `Did you write "import ActionCreators from" instead of "import * as ActionCreators from"?`
     )
   })
 })

test/combineReducers.spec.ts

@@ -264,7 +264,7 @@ describe('Utils', () => {
 
       createStore(reducer, (1 as unknown) as ShapeState)
       expect(spy.mock.calls[2][0]).toMatch(
-        /createStore has unexpected type of "Number".*keys: "foo", "baz"/
+        /createStore has unexpected type of "number".*keys: "foo", "baz"/
       )
 
       reducer(({ corge: 2 } as unknown) as ShapeState, nullAction)
@@ -279,7 +279,7 @@ describe('Utils', () => {
 
       reducer((1 as unknown) as ShapeState, nullAction)
       expect(spy.mock.calls[5][0]).toMatch(
-        /reducer has unexpected type of "Number".*keys: "foo", "baz"/
+        /reducer has unexpected type of "number".*keys: "foo", "baz"/
       )
 
       spy.mockClear()