Redux Wait for Action

Redux middleware to make store.dispatch() return a promise which will be fulfilled when another specified action is dispatched, which is useful for universal(isomorphic) React Web Apps with redux and server-side rendering.

npm install --save redux-wait-for-action

Quick Start

Minimal starter kit for universal apps with redux and redux-saga

Basic Usage

To fire todos/get action and subscribe for todos/get/success action:

1import { WAIT_FOR_ACTION, ERROR_ACTION } from 'redux-wait-for-action';
2store.dispatch({
3  type: 'todos/get',
4  [ WAIT_FOR_ACTION ]: 'todos/get/success', // Specify which action we are waiting for
5  [ ERROR_ACTION ]: 'todos/get/failed', // Optional
6}).then( payload => console.log('Todos got!') )
7.catch( error => console.error('Failed!' + error.message) );

Alternatively, use conditional functions as WAIT_FOR_ACTION, which is useful when firing multiple actions with same action.type in parallel:

1store.dispatch({
2  type: 'profile/get',
3  [ WAIT_FOR_ACTION ]: action => action.type === 'profile/get/success' && action.id === 1,
4  // Only subscribe for profile/get/success action whose profile id equals 1
5  [ ERROR_ACTION ]: action => action.type === 'profile/get/failed' && action.id === 1,
6}).then( payload => console.log('ID #1 Profile got!') )
7.catch( error => console.error('Failed!' + error.message) );

For Isomorphic Apps

• For each React container, we define a static function fetchData() where we return a store.dispatch() call followed by automatic execution of side effects. We should call this store.dispatch() with an action that also contains information about which action we are waiting for.
• Use those fetchData()s to populate page data on both client and server side.
• On server side, we put the rendering logic in fetchData().then(() => { /* rendering logic here! */ }), where side effects are completed and an action with finishing flag is dispatched.
• If you are using redux-thunk, store.dispatch() already returns a promise and you probably don't need this middleware. However, side effects like redux-saga running separately from primitive Redux flow don't explicitly notify us when a specific async fetch is finished, in which case redux-wait-for-action does the trick and makes those async tasks subscribable.
• Although redux-saga added runSaga().done support which returns a promise to tell when a specific saga task is completed, it's quite tricky where saga tasks aren't started by a dispatch() call and it does't work when using sagas containing infinite loops.

Usage with react-router and redux-saga

configureStore() function where a Redux store is created on both client and server side:

1import createReduxWaitForMiddleware from 'redux-wait-for-action';
2
3function configureStore(initialState) {
4  const sagaMiddleware = createSagaMiddleware();
5  let enhancer = compose(
6    applyMiddleware(sagaMiddleware),
7    applyMiddleware(createReduxWaitForMiddleware()),
8  );
9  const store = createStore(rootReducer, initialState, enhancer);
10
11  // ...
12}

Assume we have saga effects like this:

1function* getTodosSaga() {
2  const payload = yield call(APIService.getTodos);
3  yield put({
4    type: 'todos/get/success',
5    payload
6  });
7}
8function* rootSaga() {
9  yield takeLatest('todos/get', getTodosSaga);
10}

Define a fetchData() for each of our containers:

1import { WAIT_FOR_ACTION } from 'redux-wait-for-action';
2
3class TodosContainer extends Component {
4  static fetchData(dispatch) {
5    return dispatch({
6      type: 'todos/get',
7      [ WAIT_FOR_ACTION ]: 'todos/get/success',
8    });
9  }
10  componentDidMount() {
11    // Populate page data on client side
12    TodosContainer.fetchData(this.props.dispatch);
13  }
14  // ...
15}

Here in our action we specify WAIT_FOR_ACTION as 'profile/get/success', which tells our promise to wait for another action 'profile/get/success'. WAIT_FOR_ACTION is a ES6 Symbol instance rather than a string, so feel free using it and it won't contaminate your action.

Next for server side rendering, we reuse those fetchData()s to get the data we need:

1//handler for Express.js
2app.use('*', handleRequest);
3function handleRequest(req, res, next) {
4  //...
5  match({history, routes, location: req.url}, (error, redirectLocation, renderProps) => {
6    //...handlers for redirection, error and null renderProps...
7
8    const getReduxPromise = () => {
9      const component = renderProps.components[renderProps.components.length - 1].WrappedComponent;
10      const promise = component.fetchData ?
11        component.fetchData(store.dispatch) :
12        Promise.resolve();
13      return promise;
14    };
15
16    getReduxPromise().then(() => {
17      const initStateString = JSON.stringify(store.getState());
18      const html = ReactDOMServer.renderToString(
19        <Provider store={store}>
20          { <RouterContext {...renderProps}/> }
21        </Provider>
22      );
23      res.status(200).send(renderFullPage(html, initStateString));
24    });
25  });
26}

Advanced Usage

Error Handling

Use try-catch clause in saga effects. The todos/get/failed action object should contain a top-level key error or err whose value is an error descriptor(An Error() instance or a string).

1function* getTodosSaga() {
2  yield take('todos/get');
3  try {
4    const payload = yield call(APIService.getTodos);
5    yield put({
6      type: 'todos/get/success',
7      payload
8    });
9  } catch (error) {
10    yield put({
11      type: 'todos/get/failed',
12      error
13    });
14  }
15}

Make sure both WAIT_FOR_ACTION and ERROR_ACTION symbols are specified in your todos/get action:

1import { WAIT_FOR_ACTION, ERROR_ACTION } from 'redux-wait-for-action';
2
3class TodosContainer extends Component {
4  static fetchData(dispatch) {
5    return dispatch({
6      type: 'todos/get',
7      [ WAIT_FOR_ACTION ]: 'todos/get/success',
8      [ ERROR_ACTION ]: 'todos/get/failed',
9    });
10  }
11  // ...
12}

Server side rendering logic:

1getReduxPromise().then(() => {
2  // ...
3  res.status(200).send(renderFullPage(html, initStateString));
4}).catch((error) => { //action.error is passed to here
5  res.status(500).send(error.message);
6});

Overriding the Default Promise Arguments

By default the payload or data field on the WAIT_FOR_ACTION action is provided to the promise when it is resolved, or rejected with the error or err field.

There are two additional symbols, CALLBACK_ARGUMENT and CALLBACK_ERROR_ARGUMENT, which can be used to override this behavior. If functions are stored on the action using these symbols, they will be invoked and passed the entire action. The result returned from either function is used to resolve or reject the promise based on which symbol was used.

1import { WAIT_FOR_ACTION, ERROR_ACTION, CALLBACK_ARGUMENT, CALLBACK_ERROR_ARGUMENT} from 'redux-wait-for-action';
2store.dispatch({
3  type: 'todos/get',
4  [ WAIT_FOR_ACTION ]: 'todos/get/success',
5  [ ERROR_ACTION ]: 'todos/get/failed',
6  [ CALLBACK_ARGUMENT ]: action => action.customData,
7  [ CALLBACK_ERROR_ARGUMENT ]: action => action.customError,
8}).then( customData => console.log('Custom Data: ', customData) )
9.catch( customError => console.error('Custom Error: ', customError) );