Skip to content

Use the provided timeout option, if set, for the InfoReceiver. ⏰ #594

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

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Use the provided timeout option, if set, for the InfoReceiver. ⏰ #594

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6753610
Use the provided timeout option, if set, for the InfoReceiver. ⏰
tomconnell-wf Jul 8, 2022
8b10354
Add test of configurable timeout.
tomconnell-wf Jul 12, 2022
90dd919
Make the configured test faster, and remove my accidental configurati…
tomconnell-wf Jul 12, 2022
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
11 changes: 7 additions & 4 deletions lib/info-receiver.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,13 +16,13 @@ if (process.env.NODE_ENV !== 'production') {
debug = require('debug')('sockjs-client:info-receiver');
}

function InfoReceiver(baseUrl, urlInfo) {
function InfoReceiver(baseUrl, urlInfo, timeout) {
debug(baseUrl);
var self = this;
EventEmitter.call(this);

setTimeout(function() {
self.doXhr(baseUrl, urlInfo);
self.doXhr(baseUrl, urlInfo, timeout);
}, 0);
}

Expand All @@ -47,19 +47,22 @@ InfoReceiver._getReceiver = function(baseUrl, url, urlInfo) {
return new InfoAjax(url, XHRFake);
};

InfoReceiver.prototype.doXhr = function(baseUrl, urlInfo) {
InfoReceiver.prototype.doXhr = function(baseUrl, urlInfo, timeout) {
var self = this
, url = urlUtils.addPath(baseUrl, '/info')
;
debug('doXhr', url);

this.xo = InfoReceiver._getReceiver(baseUrl, url, urlInfo);

if (timeout === undefined) {
timeout = InfoReceiver.timeout
}
Copy link
Author

Choose a reason for hiding this comment

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

I think I saw in the documentation that SockJS will use the bigger timeout of either the "internally calculated" timeout, or the timeout option. Do you want this to apply here, too? Something like

if (timeout < InfoReceiver.timeout) {
  timeout = InfoReceiver.timeout
}

Copy link
Author

Choose a reason for hiding this comment

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

It's not really "calculated," though. 😉

Copy link
Author

Choose a reason for hiding this comment

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

timeout (number)

Specify a minimum timeout in milliseconds to use for the transport connections. By default this is dynamically calculated based on the measured RTT and the number of expected round trips. This setting will establish a minimum, but if the calculated timeout is higher, that will be used.

this.timeoutRef = setTimeout(function() {
debug('timeout');
self._cleanup(false);
self.emit('finish');
}, InfoReceiver.timeout);
}, timeout);

this.xo.once('finish', function(info, rtt) {
debug('finish', info, rtt);
Expand Down
2 changes: 1 addition & 1 deletion lib/main.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,7 @@ function SockJS(url, protocols, options) {
, sameScheme: urlUtils.isSchemeEqual(this.url, loc.href)
};

this._ir = new InfoReceiver(this.url, this._urlInfo);
this._ir = new InfoReceiver(this.url, this._urlInfo, options.timeout);
Copy link
Preview

Copilot AI Aug 7, 2025

Choose a reason for hiding this comment

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

Potential runtime error if 'options' is undefined or null. The code should safely access options.timeout with optional chaining or a fallback check.

Copilot uses AI. Check for mistakes.

this._ir.once('finish', this._receiveInfo.bind(this));
}

Expand Down
42 changes: 41 additions & 1 deletion tests/lib/receivers.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,8 @@ var expect = require('expect.js')
, XhrReceiver = require('../../lib/transport/receiver/xhr')
, XhrFake = require('../../lib/transport/sender/xhr-fake')
, utils = require('../../lib/utils/iframe')
;
, InfoAjax = require('../../lib/info-ajax')
, InfoReceiver = require('../../lib/info-receiver');

describe('Receivers', function () {
describe('jsonp', function () {
Expand Down Expand Up @@ -288,4 +289,43 @@ describe('Receivers', function () {
xhr.abort();
});
});
describe('info', function () {
it('will timeout - default timeout', function (done) {
this.timeout(10000);
InfoReceiver.prototype._getReceiver = function(baseUrl, url) {
return new InfoAjax(url, XhrFake);
};

var expectedWasClean = true;
InfoReceiver.prototype._cleanup = function(wasClean) {
expect(wasClean).to.equal(expectedWasClean);
if (expectedWasClean === false) {
// Cleanup was called because of a timeout
done();
}
expectedWasClean = false;
};

new InfoReceiver('test', {});
});

it('will timeout - configured timeout', function (done) {
this.timeout(2000);
InfoReceiver.prototype._getReceiver = function(baseUrl, url) {
return new InfoAjax(url, XhrFake);
};

var expectedWasClean = true;
InfoReceiver.prototype._cleanup = function(wasClean) {
expect(wasClean).to.equal(expectedWasClean);
if (expectedWasClean === false) {
// Cleanup was called because of a timeout
done();
}
expectedWasClean = false;
};

new InfoReceiver('test', {}, 1000);
});
});
Comment on lines +292 to +330
Copy link
Author

Choose a reason for hiding this comment

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

I apologize for these awkward tests - I do not fully understand all of the inheritance going on, so I overrode what I needed to test the override. The result is that the finish event is still emitted, and that is why I have the wasClean expectation change.

});