Composable, testable and typable side effects for Redux
Redux Ship is a side effects handler for Redux which focuses on:
- composability: you can reuse and compose sub-stores, thanks to the
Ship.mapprimitive; - testing: you can run unit tests of your side effects, by taking snapshots of their live execution traces;
- typing: you can type check your code with (almost) full coverage in Flow.
Inspired by:
- Elm for the composition mechanism and type checking;
- Redux Saga for the use of generators to test side-effects;
- Jest for the idea of snapshot testing.
See an online demo 🚀 with the redux-ship-devtools:
Run:
npm install --save redux-ship
or
yarn add redux-ship
You can optionally install Flow to get type checking and redux-ship-logger to get logging.
Write side effects with the generator notation as in Redux Saga:
const gifUrls = yield* Ship.all(['cat', 'minion', 'dog'].map(function* (tag) {
const result = yield* Effect.httpRequest(
`http://api.giphy.com/v1/gifs/random?api_key=dc6zaTOxFJmzC&tag=${tag}`
);
return JSON.parse(result).data.image_url;
}));Compose and type-check components with side effects as in Elm:
// 100% Flow type coverage in this example
return yield* Ship.map(
commit => ({type: 'Movies', commit}),
state => state.movies,
MoviesController.control(action.action)
);Test side effects with snapshots of their complete execution:
// Obtained from the Redux Ship logger
const liveSnapshot =
{"action":{"type":"Load"},"snapshot":[{"type":"Commit","commit":{"type":"LoadStart"}},{"type":"Effect","effect":{"type":"HttpRequest","url":"http://swapi.co/api/people/3/"},"result":"{\"name\":\"R2-D2\",\"height\":\"96\",\"mass\":\"32\",\"hair_color\":\"n/a\",\"skin_color\":\"white, blue\",\"eye_color\":\"red\",\"birth_year\":\"33BBY\",\"gender\":\"n/a\",\"homeworld\":\"http://swapi.co/api/planets/8/\",\"films\":[\"http://swapi.co/api/films/5/\",\"http://swapi.co/api/films/4/\",\"http://swapi.co/api/films/6/\",\"http://swapi.co/api/films/3/\",\"http://swapi.co/api/films/2/\",\"http://swapi.co/api/films/1/\",\"http://swapi.co/api/films/7/\"],\"species\":[\"http://swapi.co/api/species/2/\"],\"vehicles\":[],\"starships\":[],\"created\":\"2014-12-10T15:11:50.376000Z\",\"edited\":\"2014-12-20T21:17:50.311000Z\",\"url\":\"http://swapi.co/api/people/3/\"}"},{"type":"Commit","commit":{"type":"LoadSuccess","color":"red"}}]};
test('controller with live snapshot', () => {
const {action, snapshot} = liveSnapshot;
expect(Ship.simulate(Controller.control(action), snapshot)).toEqual(snapshot);
});MIT