Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Throttle with durationSelector #702

Closed
wants to merge 4 commits into from
Closed

Throttle with durationSelector #702

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
f81b566
test(throttleTime): add tests for throttleTime operator
staltz Nov 11, 2015
5bcd14c
fix(throttleTime): fix and rename throttleTime operator
staltz Nov 11, 2015
c1d04ac
test(throttle): add comprehensive tests for throttle operator
staltz Nov 11, 2015
e98d350
feat(throttle): add throttle operator with durationSelector
staltz Nov 11, 2015
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
329 changes: 309 additions & 20 deletions spec/operators/throttle-spec.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,25 +1,314 @@
/* globals describe, it, expect */
/* globals describe, it, expect, expectObservable, expectSubscription, hot, cold */
var Rx = require('../../dist/cjs/Rx');
var Observable = Rx.Observable;
var Scheduler = Rx.Scheduler;

describe('Observable.prototype.throttle()', function () {
it('should throttle events', function (done) {
Observable.of(1, 2, 3).throttle(50)
.subscribe(function (x) {
expect(x).toBe(1);
}, null, done);
});

it('should throttle events multiple times', function (done) {
var expected = ['1-0', '2-0'];
Observable.concat(
Observable.timer(0, 10).take(3).map(function (x) { return '1-' + x; }),
Observable.timer(80, 10).take(5).map(function (x) { return '2-' + x; })
)
.throttle(50)
.subscribe(function (x) {
expect(x).toBe(expected.shift());
}, null, done);
});
});
it('should simply mirror the source if values are not emitted often enough', function () {
var e1 = hot('-a--------b-----c----|');
var e1subs = '^ !';
var e2 = cold( '----| ');
var e2subs = [' ^ ! ',
' ^ ! ',
' ^ ! '];
var expected = '-a--------b-----c----|';

var result = e1.throttle(function () { return e2; });

expectObservable(result).toBe(expected);
expectSubscriptions(e1.subscriptions).toBe(e1subs);
expectSubscriptions(e2.subscriptions).toBe(e2subs);
});

it('should immediately emit the first value in each time window', function () {
var e1 = hot('-a-xy-----b--x--cxxx-|');
var e1subs = '^ !';
var e2 = cold( '----| ');
var e2subs = [' ^ ! ',
' ^ ! ',
' ^ ! '];
var expected = '-a--------b-----c----|';

var result = e1.throttle(function () { return e2; });

expectObservable(result).toBe(expected);
expectSubscriptions(e1.subscriptions).toBe(e1subs);
expectSubscriptions(e2.subscriptions).toBe(e2subs);
});

it('should throttle with duration Observable using next to close the duration', function () {
var e1 = hot('-a-xy-----b--x--cxxx-|');
var e1subs = '^ !';
var e2 = cold( '----x-y-z ');
var e2subs = [' ^ ! ',
' ^ ! ',
' ^ ! '];
var expected = '-a--------b-----c----|';

var result = e1.throttle(function () { return e2; });

expectObservable(result).toBe(expected);
expectSubscriptions(e1.subscriptions).toBe(e1subs);
expectSubscriptions(e2.subscriptions).toBe(e2subs);
});

it('should interrupt source and duration when result is unsubscribed early', function () {
var e1 = hot('-a-x-y-z-xyz-x-y-z----b--x-x-|');
var unsub = ' ! ';
var e1subs = '^ ! ';
var e2 = cold( '------------------| ');
var e2subs = ' ^ ! ';
var expected = '-a------------- ';

var result = e1.throttle(function () { return e2; });

expectObservable(result, unsub).toBe(expected);
expectSubscriptions(e1.subscriptions).toBe(e1subs);
expectSubscriptions(e2.subscriptions).toBe(e2subs);
});

it('should handle a busy producer emitting a regular repeating sequence', function () {
var e1 = hot('abcdefabcdefabcdefabcdefa|');
var e1subs = '^ !';
var e2 = cold('-----| ');
var e2subs = ['^ ! ',
' ^ ! ',
' ^ ! ',
' ^ ! ',
' ^!'];
var expected = 'a-----a-----a-----a-----a|';

var result = e1.throttle(function () { return e2; });

expectObservable(result).toBe(expected);
expectSubscriptions(e1.subscriptions).toBe(e1subs);
expectSubscriptions(e2.subscriptions).toBe(e2subs);
});

it('should mirror source if durations are always empty', function () {
var e1 = hot('abcdefabcdefabcdefabcdefa|');
var e1subs = '^ !';
var e2 = cold('|');
var expected = 'abcdefabcdefabcdefabcdefa|';

var result = e1.throttle(function () { return e2; });

expectObservable(result).toBe(expected);
expectSubscriptions(e1.subscriptions).toBe(e1subs);
});

it('should take only the first value emitted if duration is a never', function () {
var e1 = hot('----abcdefabcdefabcdefabcdefa|');
var e1subs = '^ !';
var e2 = cold('-');
var e2subs = ' ^ !';
var expected = '----a------------------------|';

var result = e1.throttle(function () { return e2; });

expectObservable(result).toBe(expected);
expectSubscriptions(e1.subscriptions).toBe(e1subs);
expectSubscriptions(e2.subscriptions).toBe(e2subs);
});

it('should unsubscribe duration Observable when source raise error', function () {
var e1 = hot('----abcdefabcdefabcdefabcdefa#');
var e1subs = '^ !';
var e2 = cold('-');
var e2subs = ' ^ !';
var expected = '----a------------------------#';

var result = e1.throttle(function () { return e2; });

expectObservable(result).toBe(expected);
expectSubscriptions(e1.subscriptions).toBe(e1subs);
expectSubscriptions(e2.subscriptions).toBe(e2subs);
});

it('should raise error as soon as just-throw duration is used', function () {
var e1 = hot('----abcdefabcdefabcdefabcdefa|');
var e1subs = '^ ! ';
var e2 = cold('#');
var e2subs = ' (^!) ';
var expected = '----(a#) ';

var result = e1.throttle(function () { return e2; });

expectObservable(result).toBe(expected);
expectSubscriptions(e1.subscriptions).toBe(e1subs);
expectSubscriptions(e2.subscriptions).toBe(e2subs);
});

it('should throttle using durations of varying lengths', function () {
var e1 = hot('abcdefabcdabcdefghabca| ');
var e1subs = '^ ! ';
var e2 = [cold('-----| '),
cold( '---| '),
cold( '-------| '),
cold( '--| '),
cold( '----|')];
var e2subs = ['^ ! ',
' ^ ! ',
' ^ ! ',
' ^ ! ',
' ^! '];
var expected = 'a-----a---a-------a--a| ';

var i = 0;
var result = e1.throttle(function () { return e2[i++]; });

expectObservable(result).toBe(expected);
expectSubscriptions(e1.subscriptions).toBe(e1subs);
for (var j = 0; j < e2.length; j++) {
expectSubscriptions(e2[j].subscriptions).toBe(e2subs[j]);
}
});

it('should propagate error from duration Observable', function () {
var e1 = hot('abcdefabcdabcdefghabca| ');
var e1subs = '^ ! ';
var e2 = [cold('-----| '),
cold( '---| '),
cold( '-------# ')];
var e2subs = ['^ ! ',
' ^ ! ',
' ^ ! '];
var expected = 'a-----a---a------# ';

var i = 0;
var result = e1.throttle(function () { return e2[i++]; });

expectObservable(result).toBe(expected);
expectSubscriptions(e1.subscriptions).toBe(e1subs);
for (var j = 0; j < e2.length; j++) {
expectSubscriptions(e2[j].subscriptions).toBe(e2subs[j]);
}
});

it('should propagate error thrown from durationSelector function', function () {
var e1 = hot('abcdefabcdabcdefghabca| ');
var e1subs = '^ ! ';
var e2 = [cold('-----| '),
cold( '---| '),
cold( '-------| ')];
var e2subs = ['^ ! ',
' ^ ! '];
var expected = 'a-----a---# ';

var i = 0;
var result = e1.throttle(function () {
if (i === 2) {
throw 'error';
}
return e2[i++];
});

expectObservable(result).toBe(expected);
expectSubscriptions(e1.subscriptions).toBe(e1subs);
for (var j = 0; j < e2subs.length; j++) {
expectSubscriptions(e2[j].subscriptions).toBe(e2subs[j]);
}
});

it('should complete when source does not emit', function () {
var e1 = hot('-----|');
var subs = '^ !';
var expected = '-----|';
function durationSelector() { return cold('-----|'); }

expectObservable(e1.throttle(durationSelector)).toBe(expected);
expectSubscriptions(e1.subscriptions).toBe(subs);
});

it('should raise error when source does not emit and raises error', function () {
var e1 = hot('-----#');
var subs = '^ !';
var expected = '-----#';
function durationSelector() { return cold('-----|'); }

expectObservable(e1.throttle(durationSelector)).toBe(expected);
expectSubscriptions(e1.subscriptions).toBe(subs);
});

it('should handle an empty source', function () {
var e1 = cold('|');
var subs = '(^!)';
var expected = '|';
function durationSelector() { return cold('-----|'); }

expectObservable(e1.throttle(durationSelector)).toBe(expected);
expectSubscriptions(e1.subscriptions).toBe(subs);
});

it('should handle a never source', function () {
var e1 = cold('-');
var subs = '^';
var expected = '-';
function durationSelector() { return cold('-----|'); }

expectObservable(e1.throttle(durationSelector)).toBe(expected);
expectSubscriptions(e1.subscriptions).toBe(subs);
});

it('should handle a throw source', function () {
var e1 = cold('#');
var subs = '(^!)';
var expected = '#';
function durationSelector() { return cold('-----|'); }

expectObservable(e1.throttle(durationSelector)).toBe(expected);
expectSubscriptions(e1.subscriptions).toBe(subs);
});

it('should throttle by promise resolves', function (done) {
var e1 = Observable.concat(Observable.of(1),
Observable.timer(10).mapTo(2),
Observable.timer(10).mapTo(3),
Observable.timer(50).mapTo(4)
);
var expected = [1,2,3,4];

e1.throttle(function () {
return new Promise(function (resolve) { resolve(42); });
}).subscribe(
function (x) {
expect(x).toEqual(expected.shift()); },
function () {
throw 'should not be called';
},
function () {
expect(expected.length).toBe(0);
done();
}
);
});

it('should raise error when promise rejects', function (done) {
var e1 = Observable.concat(Observable.of(1),
Observable.timer(10).mapTo(2),
Observable.timer(10).mapTo(3),
Observable.timer(50).mapTo(4)
);
var expected = [1,2,3];
var error = new Error('error');

e1.throttle(function (x) {
if (x === 3) {
return new Promise(function (resolve, reject) {reject(error);});
} else {
return new Promise(function (resolve) {resolve(42);});
}
}).subscribe(
function (x) {
expect(x).toEqual(expected.shift()); },
function (err) {
expect(err).toBe(error);
expect(expected.length).toBe(0);
done();
},
function () {
throw 'should not be called';
}
);
});
});
Loading