Merge pull request #606 from mareksuscak/fix-failing-promises-example

Fix failing Promises example from the documentation.

src/actions/index.js

@@ -12,22 +12,24 @@ export default function makeAction(alt, namespace, name, implementation, obj) {
 
   // the action itself
   const action = (...args) => {
-    const result = implementation.apply(obj, args)
+    const invocationResult = implementation.apply(obj, args)
+    let actionResult = invocationResult
 
     // async functions that return promises should not be dispatched
-    if (result !== undefined && !isPromise(result)) {
-      if (fn.isFunction(result)) {
-        result(dispatch, alt)
+    if (invocationResult !== undefined && !isPromise(invocationResult)) {
+      if (fn.isFunction(invocationResult)) {
+        // inner function result should be returned as an action result
+        actionResult = invocationResult(dispatch, alt)
       } else {
-        dispatch(result)
+        dispatch(invocationResult)
       }
     }
 
-    if (result === undefined) {
+    if (invocationResult === undefined) {
       utils.warn('An action was called but nothing was dispatched')
     }
 
-    return result
+    return actionResult
   }
   action.defer = (...args) => setTimeout(() => action.apply(null, args))
   action.id = id

test/async-action-test.js

@@ -1,5 +1,6 @@
 import Alt from '../'
 import { assert } from 'chai'
+import isPromise from 'is-promise'
 
 const alt = new Alt()
 
@@ -8,6 +9,13 @@ const actions = alt.createActions(class AsyncActions {
   fetch() {
     return Promise.resolve('foo')
   }
+
+  fetchAndDispatch() {
+    return (dispatch) => {
+      dispatch()
+      return Promise.resolve('foo')
+    }
+  }
 })
 
 const store = alt.createStore(class FooStore {
@@ -19,11 +27,26 @@ const store = alt.createStore(class FooStore {
   onFetch() {
     this.dispatched = true
   }
+  onFetchAndDispatch() {
+    this.dispatched = true
+  }
 })
 
 export default {
-  'async actions'() {
-    actions.fetch()
-    assert(store.state.dispatched === false, 'async action is not automatically dispatched')
-  }
+  'async actions': {
+    afterEach() {
+      alt.recycle(store)
+    },
+
+    'are not dispatched automatically'() {
+      actions.fetch()
+      assert(store.state.dispatched === false, 'async action is not automatically dispatched')
+    },
+
+    'return the result of inner function invocation'() {
+      const promise = actions.fetchAndDispatch()
+      assert(isPromise(promise), 'async action does not return the result of inner function invocation')
+      assert(store.state.dispatched === true, 'async action is dispatched when the dispatch is invoked manually')
+    },
+  },
 }