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

Jump to bottom

Add transmit option flag #736

Merged
merged 2 commits into from
Jul 2, 2019
Merged

Add transmit option flag #736

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e60cab0
feat: add transmit option flag
waltjones Jun 3, 2019
a41ac93
fix: use callback for non-transmitted items
waltjones Jun 28, 2019
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
1 change: 1 addition & 0 deletions src/browser/rollbar.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -458,6 +458,7 @@ var defaultOptions = {
endpoint: __DEFAULT_ENDPOINT__,
verbose: false,
enabled: true,
transmit: true,
sendConfig: false,
includeItemsInTelemetry: true,
captureIp: true
Expand Down
3 changes: 3 additions & 0 deletions src/queue.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,9 @@ Queue.prototype.addItem = function(item, callback, originalError, originalItem)
}
this._maybeLog(item, originalError);
this.removePendingItem(originalItem);
if (!this.options.transmit) {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • This might be the right place, or perhaps this should go in _makeApiRequest - what do you think?
  • Looks like we are no longer calling the callback - is that intentional?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This location is (I believe) after everything the caller would want to execute without sending the request. At entry of _makeApiRequest is logically equivalent. Any later would engage rate limiting. (And maybe that's desired? I'm not sure, but I thought not.)

I skipped the callback, since this case neither has a response nor produces an error. But it probably needs to be called in order for async/Promise wrappers to work correctly. I imagine other situations as well. I'll add it.

return;
}
this.pendingRequests.push(item);
try {
this._makeApiRequest(item, function(err, resp) {
Expand Down
1 change: 1 addition & 0 deletions src/react-native/rollbar.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -314,6 +314,7 @@ Rollbar.defaultOptions = {
reportLevel: packageJson.defaults.reportLevel,
verbose: false,
enabled: true,
transmit: true,
sendConfig: false,
includeItemsInTelemetry: true
};
Expand Down
1 change: 1 addition & 0 deletions src/server/rollbar.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -615,6 +615,7 @@ Rollbar.defaultOptions = {
reportLevel: packageJson.defaults.reportLevel,
verbose: false,
enabled: true,
transmit: true,
sendConfig: false,
includeItemsInTelemetry: false,
captureEmail: false,
Expand Down
54 changes: 35 additions & 19 deletions test/queue.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,7 @@ describe('addItem', function() {
var rateLimiter = new (TestRateLimiterGenerator())();
var api = new (TestApiGenerator())();
var logger = new (TestLoggerGenerator())();
var options = {};
var options = {transmit: true};
var queue = new Queue(rateLimiter, api, logger, options);

var item = {mykey: 'myvalue'};
Expand All @@ -127,7 +127,7 @@ describe('addItem', function() {
var rateLimiter = new (TestRateLimiterGenerator())();
var api = new (TestApiGenerator())();
var logger = new (TestLoggerGenerator())();
var options = {};
var options = {transmit: true};
var queue = new Queue(rateLimiter, api, logger, options);

var item = {mykey: 'myvalue'};
Expand All @@ -148,7 +148,7 @@ describe('addItem', function() {
var rateLimiter = new (TestRateLimiterGenerator())();
var api = new (TestApiGenerator())();
var logger = new (TestLoggerGenerator())();
var options = {};
var options = {transmit: true};
var queue = new Queue(rateLimiter, api, logger, options);

var item = {mykey: 'myvalue'};
Expand All @@ -171,7 +171,7 @@ describe('addItem', function() {
var rateLimiter = new (TestRateLimiterGenerator())();
var api = new (TestApiGenerator())();
var logger = new (TestLoggerGenerator())();
var options = {verbose: true};
var options = {verbose: true, transmit: true};
var queue = new Queue(rateLimiter, api, logger, options);

var item = {body: {trace: {exception: {message: 'hello'}}}};
Expand All @@ -195,7 +195,7 @@ describe('addItem', function() {
var rateLimiter = new (TestRateLimiterGenerator())();
var api = new (TestApiGenerator())();
var logger = new (TestLoggerGenerator())();
var options = {verbose: true};
var options = {verbose: true, transmit: true};
var queue = new Queue(rateLimiter, api, logger, options);

var item = {body: {message: {body: 'hello'}}};
Expand All @@ -219,7 +219,7 @@ describe('addItem', function() {
var rateLimiter = new (TestRateLimiterGenerator())();
var api = new (TestApiGenerator())();
var logger = new (TestLoggerGenerator())();
var options = {verbose: false};
var options = {verbose: false, transmit: true};
var queue = new Queue(rateLimiter, api, logger, options);

var item = {body: {message: {body: 'hello'}}};
Expand All @@ -243,7 +243,7 @@ describe('addItem', function() {
var rateLimiter = new (TestRateLimiterGenerator())();
var api = new (TestApiGenerator())();
var logger = new (TestLoggerGenerator())();
var options = {};
var options = {transmit: true};
var queue = new Queue(rateLimiter, api, logger, options);

var item = {mykey: 'myvalue'};
Expand All @@ -269,7 +269,7 @@ describe('addItem', function() {
var rateLimiter = new (TestRateLimiterGenerator())();
var api = new (TestApiGenerator())();
var logger = new (TestLoggerGenerator())();
var options = {};
var options = {transmit: true};
var queue = new Queue(rateLimiter, api, logger, options);

var item = {mykey: 'myvalue'};
Expand Down Expand Up @@ -297,7 +297,7 @@ describe('addItem', function() {
var rateLimiter = new (TestRateLimiterGenerator())();
var api = new (TestApiGenerator())();
var logger = new (TestLoggerGenerator())();
var options = {};
var options = {transmit: true};
var queue = new Queue(rateLimiter, api, logger, options);

var item = {mykey: 'myvalue'};
Expand Down Expand Up @@ -329,7 +329,7 @@ describe('addItem', function() {
var rateLimiter = new (TestRateLimiterGenerator())();
var api = new (TestApiGenerator())();
var logger = new (TestLoggerGenerator())();
var options = {};
var options = {transmit: true};
var queue = new Queue(rateLimiter, api, logger, options);

var item = {mykey: 'myvalue'};
Expand All @@ -354,7 +354,7 @@ describe('addItem', function() {
var rateLimiter = new (TestRateLimiterGenerator())();
var api = new (TestApiGenerator())();
var logger = new (TestLoggerGenerator())();
var options = {};
var options = {transmit: true};
var queue = new Queue(rateLimiter, api, logger, options);

var item = {mykey: 'myvalue'};
Expand All @@ -376,7 +376,7 @@ describe('addItem', function() {
var rateLimiter = new (TestRateLimiterGenerator())();
var api = new (TestApiGenerator())();
var logger = new (TestLoggerGenerator())();
var options = {};
var options = {transmit: true};
var queue = new Queue(rateLimiter, api, logger, options);

var item = {mykey: 'myvalue'};
Expand Down Expand Up @@ -406,7 +406,7 @@ describe('addItem', function() {
var rateLimiter = new (TestRateLimiterGenerator())();
var api = new (TestApiGenerator())();
var logger = new (TestLoggerGenerator())();
var options = {};
var options = {transmit: true};
var queue = new Queue(rateLimiter, api, logger, options);

var item = {mykey: 'myvalue'};
Expand Down Expand Up @@ -434,7 +434,7 @@ describe('addItem', function() {
var rateLimiter = new (TestRateLimiterGenerator())();
var api = new (TestApiGenerator())();
var logger = new (TestLoggerGenerator())();
var options = {retryInterval: 1};
var options = {retryInterval: 1, transmit: true};
var queue = new Queue(rateLimiter, api, logger, options);

var item = {mykey: 'myvalue'};
Expand All @@ -456,7 +456,7 @@ describe('addItem', function() {
var rateLimiter = new (TestRateLimiterGenerator())();
var api = new (TestApiGenerator())();
var logger = new (TestLoggerGenerator())();
var options = {};
var options = {transmit: true};
var queue = new Queue(rateLimiter, api, logger, options);

var item = {mykey: 'myvalue'};
Expand All @@ -478,7 +478,7 @@ describe('addItem', function() {
var rateLimiter = new (TestRateLimiterGenerator())();
var api = new (TestApiGenerator())();
var logger = new (TestLoggerGenerator())();
var options = {retryInterval: 1};
var options = {retryInterval: 1, transmit: true};
var queue = new Queue(rateLimiter, api, logger, options);

var item = {mykey: 'myvalue'};
Expand All @@ -505,13 +505,30 @@ describe('addItem', function() {
});
});
});
describe('transmit disabled', function() {
it('should not attempt to send', function(done) {
var rateLimiter = new (TestRateLimiterGenerator())();
var api = new (TestApiGenerator())();
var logger = new (TestLoggerGenerator())();
var options = {transmit: false};
var queue = new Queue(rateLimiter, api, logger, options);
var makeApiRequestStub = sinon.stub(queue, '_makeApiRequest');

queue.addItem({mykey: 'myvalue'});

expect(makeApiRequestStub.called).to.eql(0);

queue._makeApiRequest.restore();
done();
});
});
});
describe('rate limited', function() {
it('should callback if the rate limiter says not to send and has an error', function(done) {
var rateLimiter = new (TestRateLimiterGenerator())();
var api = new (TestApiGenerator())();
var logger = new (TestLoggerGenerator())();
var options = {};
var options = {transmit: true};
var queue = new Queue(rateLimiter, api, logger, options);

var item = {mykey: 'myvalue'};
Expand Down Expand Up @@ -539,7 +556,7 @@ describe('addItem', function() {
var rateLimiter = new (TestRateLimiterGenerator())();
var api = new (TestApiGenerator())();
var logger = new (TestLoggerGenerator())();
var options = {};
var options = {transmit: true};
var queue = new Queue(rateLimiter, api, logger, options);

var item = {mykey: 'myvalue'};
Expand Down Expand Up @@ -567,4 +584,3 @@ describe('addItem', function() {
});
});
});