Add support for passing options to transports other than websockets. Useful if you need to pass headers for example to an XHR request

avistramer · avistramer · commit a4f636472b7b · 2020-12-28T23:11:10.000-06:00
diff --git a/lib/info-ajax.js b/lib/info-ajax.js
@@ -11,12 +11,12 @@ if (process.env.NODE_ENV !== 'production') {
   debug = require('debug')('sockjs-client:info-ajax');
 }
 
-function InfoAjax(url, AjaxObject) {
+function InfoAjax(url, AjaxObject, opts) {
   EventEmitter.call(this);
 
   var self = this;
   var t0 = +new Date();
-  this.xo = new AjaxObject('GET', url);
+  this.xo = new AjaxObject('GET', url, null, opts);
 
   this.xo.once('finish', function(status, text) {
     var info, rtt;
diff --git a/lib/info-iframe-receiver.js b/lib/info-iframe-receiver.js
@@ -7,11 +7,11 @@ var inherits = require('inherits')
   , InfoAjax = require('./info-ajax')
   ;
 
-function InfoReceiverIframe(transUrl) {
+function InfoReceiverIframe(transUrl, ignore, opts) {
   var self = this;
   EventEmitter.call(this);
 
-  this.ir = new InfoAjax(transUrl, XHRLocalObject);
+  this.ir = new InfoAjax(transUrl, XHRLocalObject, opts);
   this.ir.once('finish', function(info, rtt) {
     self.ir = null;
     self.emit('message', JSON3.stringify([info, rtt]));
diff --git a/lib/info-receiver.js b/lib/info-receiver.js
@@ -16,44 +16,44 @@ if (process.env.NODE_ENV !== 'production') {
   debug = require('debug')('sockjs-client:info-receiver');
 }
 
-function InfoReceiver(baseUrl, urlInfo) {
+function InfoReceiver(baseUrl, urlInfo, transportOptions) {
   debug(baseUrl);
   var self = this;
   EventEmitter.call(this);
 
   setTimeout(function() {
-    self.doXhr(baseUrl, urlInfo);
+    self.doXhr(baseUrl, urlInfo, transportOptions);
   }, 0);
 }
 
 inherits(InfoReceiver, EventEmitter);
 
 // TODO this is currently ignoring the list of available transports and the whitelist
 
-InfoReceiver._getReceiver = function(baseUrl, url, urlInfo) {
+InfoReceiver._getReceiver = function(baseUrl, url, urlInfo, transportOptions) {
   // determine method of CORS support (if needed)
   if (urlInfo.sameOrigin) {
-    return new InfoAjax(url, XHRLocal);
+    return new InfoAjax(url, XHRLocal, transportOptions['xhr-streaming'] || transportOptions['xhr-polling']);
   }
   if (XHRCors.enabled) {
-    return new InfoAjax(url, XHRCors);
+    return new InfoAjax(url, XHRCors, transportOptions['xhr-streaming'] || transportOptions['xhr-polling']);
   }
   if (XDR.enabled && urlInfo.sameScheme) {
-    return new InfoAjax(url, XDR);
+    return new InfoAjax(url, XDR, transportOptions['xdr-streaming'] || transportOptions['xdr-polling']);
   }
   if (InfoIframe.enabled()) {
-    return new InfoIframe(baseUrl, url);
+    return new InfoIframe(baseUrl, url, transportOptions['iframe']);
   }
   return new InfoAjax(url, XHRFake);
 };
 
-InfoReceiver.prototype.doXhr = function(baseUrl, urlInfo) {
+InfoReceiver.prototype.doXhr = function(baseUrl, urlInfo, transportOptions) {
   var self = this
     , url = urlUtils.addPath(baseUrl, '/info')
     ;
   debug('doXhr', url);
 
-  this.xo = InfoReceiver._getReceiver(baseUrl, url, urlInfo);
+  this.xo = InfoReceiver._getReceiver(baseUrl, url, urlInfo, transportOptions);
 
   this.timeoutRef = setTimeout(function() {
     debug('timeout');
diff --git a/lib/main.js b/lib/main.js
@@ -122,7 +122,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, this._transportOptions);
   this._ir.once('finish', this._receiveInfo.bind(this));
 }
 
diff --git a/lib/transport/eventsource.js b/lib/transport/eventsource.js
@@ -7,12 +7,12 @@ var inherits = require('inherits')
   , EventSourceDriver = require('eventsource')
   ;
 
-function EventSourceTransport(transUrl) {
+function EventSourceTransport(transUrl, ignore, opts) {
   if (!EventSourceTransport.enabled()) {
     throw new Error('Transport created when disabled');
   }
 
-  AjaxBasedTransport.call(this, transUrl, '/eventsource', EventSourceReceiver, XHRCorsObject);
+  AjaxBasedTransport.call(this, transUrl, '/eventsource', EventSourceReceiver, XHRCorsObject, opts);
 }
 
 inherits(EventSourceTransport, AjaxBasedTransport);
diff --git a/lib/transport/htmlfile.js b/lib/transport/htmlfile.js
@@ -6,11 +6,11 @@ var inherits = require('inherits')
   , AjaxBasedTransport = require('./lib/ajax-based')
   ;
 
-function HtmlFileTransport(transUrl) {
+function HtmlFileTransport(transUrl, ignore, opts) {
   if (!HtmlfileReceiver.enabled) {
     throw new Error('Transport created when disabled');
   }
-  AjaxBasedTransport.call(this, transUrl, '/htmlfile', HtmlfileReceiver, XHRLocalObject);
+  AjaxBasedTransport.call(this, transUrl, '/htmlfile', HtmlfileReceiver, XHRLocalObject, opts);
 }
 
 inherits(HtmlFileTransport, AjaxBasedTransport);
diff --git a/lib/transport/lib/ajax-based.js b/lib/transport/lib/ajax-based.js
@@ -10,15 +10,16 @@ if (process.env.NODE_ENV !== 'production') {
   debug = require('debug')('sockjs-client:ajax-based');
 }
 
-function createAjaxSender(AjaxObject) {
+function createAjaxSender(AjaxObject, opts) {
   return function(url, payload, callback) {
     debug('create ajax sender', url, payload);
-    var opt = {};
+    opts = opts || {};
     if (typeof payload === 'string') {
-      opt.headers = {'Content-type': 'text/plain'};
+      opts.headers = opts.headers || {};
+      opts.headers['Content-type'] = 'text/plain';
     }
     var ajaxUrl = urlUtils.addPath(url, '/xhr_send');
-    var xo = new AjaxObject('POST', ajaxUrl, payload, opt);
+    var xo = new AjaxObject('POST', ajaxUrl, payload, opts);
     xo.once('finish', function(status) {
       debug('finish', status);
       xo = null;
@@ -40,8 +41,8 @@ function createAjaxSender(AjaxObject) {
   };
 }
 
-function AjaxBasedTransport(transUrl, urlSuffix, Receiver, AjaxObject) {
-  SenderReceiver.call(this, transUrl, urlSuffix, createAjaxSender(AjaxObject), Receiver, AjaxObject);
+function AjaxBasedTransport(transUrl, urlSuffix, Receiver, AjaxObject, opts) {
+  SenderReceiver.call(this, transUrl, urlSuffix, createAjaxSender(AjaxObject, opts), Receiver, AjaxObject, opts);
 }
 
 inherits(AjaxBasedTransport, SenderReceiver);
diff --git a/lib/transport/lib/polling.js b/lib/transport/lib/polling.js
@@ -9,12 +9,13 @@ if (process.env.NODE_ENV !== 'production') {
   debug = require('debug')('sockjs-client:polling');
 }
 
-function Polling(Receiver, receiveUrl, AjaxObject) {
+function Polling(Receiver, receiveUrl, AjaxObject, opts) {
   debug(receiveUrl);
   EventEmitter.call(this);
   this.Receiver = Receiver;
   this.receiveUrl = receiveUrl;
   this.AjaxObject = AjaxObject;
+  this.opts = opts;
   this._scheduleReceiver();
 }
 
@@ -23,7 +24,7 @@ inherits(Polling, EventEmitter);
 Polling.prototype._scheduleReceiver = function() {
   debug('_scheduleReceiver');
   var self = this;
-  var poll = this.poll = new this.Receiver(this.receiveUrl, this.AjaxObject);
+  var poll = this.poll = new this.Receiver(this.receiveUrl, this.AjaxObject, this.opts);
 
   poll.on('message', function(msg) {
     debug('message', msg);
diff --git a/lib/transport/lib/sender-receiver.js b/lib/transport/lib/sender-receiver.js
@@ -11,13 +11,13 @@ if (process.env.NODE_ENV !== 'production') {
   debug = require('debug')('sockjs-client:sender-receiver');
 }
 
-function SenderReceiver(transUrl, urlSuffix, senderFunc, Receiver, AjaxObject) {
+function SenderReceiver(transUrl, urlSuffix, senderFunc, Receiver, AjaxObject, opts) {
   var pollUrl = urlUtils.addPath(transUrl, urlSuffix);
   debug(pollUrl);
   var self = this;
   BufferedSender.call(this, transUrl, senderFunc);
 
-  this.poll = new Polling(Receiver, pollUrl, AjaxObject);
+  this.poll = new Polling(Receiver, pollUrl, AjaxObject, opts);
   this.poll.on('message', function(msg) {
     debug('poll message', msg);
     self.emit('message', msg);
diff --git a/lib/transport/receiver/xhr.js b/lib/transport/receiver/xhr.js
@@ -9,14 +9,15 @@ if (process.env.NODE_ENV !== 'production') {
   debug = require('debug')('sockjs-client:receiver:xhr');
 }
 
-function XhrReceiver(url, AjaxObject) {
+function XhrReceiver(url, AjaxObject, opts) {
   debug(url);
   EventEmitter.call(this);
   var self = this;
 
   this.bufferPosition = 0;
 
-  this.xo = new AjaxObject('POST', url, null);
+  this.opts = opts;
+  this.xo = new AjaxObject('POST', url, null, opts);
   this.xo.on('chunk', this._chunkHandler.bind(this));
   this.xo.once('finish', function(status, text) {
     debug('finish', status, text);
diff --git a/lib/transport/sender/xhr-local.js b/lib/transport/sender/xhr-local.js
@@ -4,10 +4,10 @@ var inherits = require('inherits')
   , XhrDriver = require('../driver/xhr')
   ;
 
-function XHRLocalObject(method, url, payload /*, opts */) {
-  XhrDriver.call(this, method, url, payload, {
-    noCredentials: true
-  });
+function XHRLocalObject(method, url, payload, opts) {
+  opts = opts || {};
+  opts.noCredentials = true;
+  XhrDriver.call(this, method, url, payload, opts);
 }
 
 inherits(XHRLocalObject, XhrDriver);
diff --git a/lib/transport/xdr-polling.js b/lib/transport/xdr-polling.js
@@ -7,11 +7,11 @@ var inherits = require('inherits')
   , XDRObject = require('./sender/xdr')
   ;
 
-function XdrPollingTransport(transUrl) {
+function XdrPollingTransport(transUrl, ignore, opts) {
   if (!XDRObject.enabled) {
     throw new Error('Transport created when disabled');
   }
-  AjaxBasedTransport.call(this, transUrl, '/xhr', XhrReceiver, XDRObject);
+  AjaxBasedTransport.call(this, transUrl, '/xhr', XhrReceiver, XDRObject, opts);
 }
 
 inherits(XdrPollingTransport, AjaxBasedTransport);
diff --git a/lib/transport/xdr-streaming.js b/lib/transport/xdr-streaming.js
@@ -10,11 +10,11 @@ var inherits = require('inherits')
 //   http://stackoverflow.com/questions/1641507/detect-browser-support-for-cross-domain-xmlhttprequests
 //   http://hacks.mozilla.org/2009/07/cross-site-xmlhttprequest-with-cors/
 
-function XdrStreamingTransport(transUrl) {
+function XdrStreamingTransport(transUrl, ignore, opts) {
   if (!XDRObject.enabled) {
     throw new Error('Transport created when disabled');
   }
-  AjaxBasedTransport.call(this, transUrl, '/xhr_streaming', XhrReceiver, XDRObject);
+  AjaxBasedTransport.call(this, transUrl, '/xhr_streaming', XhrReceiver, XDRObject, opts);
 }
 
 inherits(XdrStreamingTransport, AjaxBasedTransport);
diff --git a/lib/transport/xhr-polling.js b/lib/transport/xhr-polling.js
@@ -7,11 +7,11 @@ var inherits = require('inherits')
   , XHRLocalObject = require('./sender/xhr-local')
   ;
 
-function XhrPollingTransport(transUrl) {
+function XhrPollingTransport(transUrl, ignore, opts) {
   if (!XHRLocalObject.enabled && !XHRCorsObject.enabled) {
     throw new Error('Transport created when disabled');
   }
-  AjaxBasedTransport.call(this, transUrl, '/xhr', XhrReceiver, XHRCorsObject);
+  AjaxBasedTransport.call(this, transUrl, '/xhr', XhrReceiver, XHRCorsObject, opts);
 }
 
 inherits(XhrPollingTransport, AjaxBasedTransport);
diff --git a/lib/transport/xhr-streaming.js b/lib/transport/xhr-streaming.js
@@ -8,11 +8,11 @@ var inherits = require('inherits')
   , browser = require('../utils/browser')
   ;
 
-function XhrStreamingTransport(transUrl) {
+function XhrStreamingTransport(transUrl, ignore, opts) {
   if (!XHRLocalObject.enabled && !XHRCorsObject.enabled) {
     throw new Error('Transport created when disabled');
   }
-  AjaxBasedTransport.call(this, transUrl, '/xhr_streaming', XhrReceiver, XHRCorsObject);
+  AjaxBasedTransport.call(this, transUrl, '/xhr_streaming', XhrReceiver, XHRCorsObject, opts);
 }
 
 inherits(XhrStreamingTransport, AjaxBasedTransport);
diff --git a/package.json b/package.json
@@ -1,5 +1,5 @@
 {
-  "name": "sockjs-client",
+  "name": "testable-sockjs-client",
   "description": "SockJS-client is a browser JavaScript library that provides a WebSocket-like object.",
   "version": "1.5.0",
   "author": "Bryce Kahle",

Original file line number	Diff line number	Diff line change
`@@ -122,7 +122,7 @@ function SockJS(url, protocols, options) {`
`122`	`122`	`, sameScheme: urlUtils.isSchemeEqual(this.url, loc.href)`
`123`	`123`	`};`
`124`	`124`
`125`		`- this._ir = new InfoReceiver(this.url, this._urlInfo);`
	`125`	`+ this._ir = new InfoReceiver(this.url, this._urlInfo, this._transportOptions);`
`126`	`126`	`this._ir.once('finish', this._receiveInfo.bind(this));`
`127`	`127`	`}`
`128`	`128`
Original file line number	Diff line number	Diff line change
`@@ -7,12 +7,12 @@ var inherits = require('inherits')`
`7`	`7`	`, EventSourceDriver = require('eventsource')`
`8`	`8`	`;`
`9`	`9`
`10`		`-function EventSourceTransport(transUrl) {`
	`10`	`+function EventSourceTransport(transUrl, ignore, opts) {`
`11`	`11`	`if (!EventSourceTransport.enabled()) {`
`12`	`12`	`throw new Error('Transport created when disabled');`
`13`	`13`	`}`
`14`	`14`
`15`		`- AjaxBasedTransport.call(this, transUrl, '/eventsource', EventSourceReceiver, XHRCorsObject);`
	`15`	`+ AjaxBasedTransport.call(this, transUrl, '/eventsource', EventSourceReceiver, XHRCorsObject, opts);`
`16`	`16`	`}`
`17`	`17`
`18`	`18`	`inherits(EventSourceTransport, AjaxBasedTransport);`
Original file line number	Diff line number	Diff line change
`@@ -6,11 +6,11 @@ var inherits = require('inherits')`
`6`	`6`	`, AjaxBasedTransport = require('./lib/ajax-based')`
`7`	`7`	`;`
`8`	`8`
`9`		`-function HtmlFileTransport(transUrl) {`
	`9`	`+function HtmlFileTransport(transUrl, ignore, opts) {`
`10`	`10`	`if (!HtmlfileReceiver.enabled) {`
`11`	`11`	`throw new Error('Transport created when disabled');`
`12`	`12`	`}`
`13`		`- AjaxBasedTransport.call(this, transUrl, '/htmlfile', HtmlfileReceiver, XHRLocalObject);`
	`13`	`+ AjaxBasedTransport.call(this, transUrl, '/htmlfile', HtmlfileReceiver, XHRLocalObject, opts);`
`14`	`14`	`}`
`15`	`15`
`16`	`16`	`inherits(HtmlFileTransport, AjaxBasedTransport);`