feat: support throttle effect type

iwege · Oct 9, 2016 · a2e887c · a2e887c
1 parent e85564b
commit a2e887c
Show file tree

Hide file tree

Showing 2 changed files with 61 additions and 2 deletions.
diff --git a/src/createDva.js b/src/createDva.js
@@ -1,7 +1,7 @@
 import React from 'react';
 import { Provider } from 'react-redux';
 import { createStore, applyMiddleware, compose, combineReducers } from 'redux';
-import createSagaMiddleware, { takeEvery, takeLatest } from 'redux-saga';
+import createSagaMiddleware, { takeEvery, takeLatest, throttle } from 'redux-saga';
 import handleActions from 'redux-actions/lib/handleActions';
 import * as sagaEffects from 'redux-saga/effects';
 import isPlainObject from 'is-plain-object';
@@ -251,13 +251,25 @@ export default function createDva(createOpts) {
     function getWatcher(key, _effect, model, onError) {
       let effect = _effect;
       let type = 'takeEvery';
+      let ms;
+
       if (Array.isArray(_effect)) {
         effect = _effect[0];
         const opts = _effect[1];
         if (opts && opts.type) {
           type = opts.type;
+          if (type === 'throttle') {
+            invariant(
+              opts.ms,
+              'app.start: opts.ms should be defined if type is throttle'
+            );
+            ms = opts.ms;
+          }
         }
-        invariant(['watcher', 'takeEvery', 'takeLatest'].indexOf(type) > -1, 'app.start: effect type should be takeEvery, takeLatest or watcher')
+        invariant(
+          ['watcher', 'takeEvery', 'takeLatest', 'throttle'].indexOf(type) > -1,
+          'app.start: effect type should be takeEvery, takeLatest, throttle or watcher'
+        );
       }
 
       function *sagaWithCatch(...args) {
@@ -278,6 +290,10 @@ export default function createDva(createOpts) {
           return function*() {
             yield takeLatest(key, sagaWithOnEffect);
           };
+        case 'throttle':
+          return function*() {
+            yield throttle(ms, key, sagaWithOnEffect);
+          };
         // takeEvery
         default:
           return function*() {

diff --git a/test/effects-test.js b/test/effects-test.js
@@ -153,6 +153,49 @@ describe('effects', () => {
     }, 200);
   });
 
+  xit('type: throttle throw error if no ms', () => {
+    const app = dva();
+    app.model({
+      namespace: 'count',
+      state: 0,
+      effects: {
+        addDelay: [function*() {}, { type: 'throttle' }],
+      },
+    });
+    app.router(_ => 1);
+    expect(() => {
+      app.start();
+    }).toThrow(/app.start: opts.ms should be defined if type is throttle/);
+  });
+
+  it('type: throttle', (done) => {
+    const app = dva();
+    app.model({
+      namespace: 'count',
+      state: 0,
+      reducers: {
+        add(state, { payload }) { return state + payload || 1 },
+      },
+      effects: {
+        addDelay: [function*({ payload }, { call, put }) {
+          yield call(delay, 100);
+          yield put({ type: 'add', payload });
+        }, { type: 'throttle', ms: 100 }],
+      },
+    });
+    app.router(_ => 1);
+    app.start();
+
+    // Only catch the last one.
+    app._store.dispatch({ type: 'count/addDelay', payload: 2 });
+    app._store.dispatch({ type: 'count/addDelay', payload: 3 });
+
+    setTimeout(() => {
+      expect(app._store.getState().count).toEqual(2);
+      done();
+    }, 200);
+  });
+
 
   it('type: watcher', (done) => {
     const watcher = { type: 'watcher' };