refactor: refactor the handling of the options

Author: darrachequesne

lib/socket.js

@@ -42,7 +42,6 @@ class Socket extends Emitter {
       opts.port = this.secure ? "443" : "80";
     }
 
-    this.agent = opts.agent || false;
     this.hostname =
       opts.hostname ||
       (typeof location !== "undefined" ? location.hostname : "localhost");
@@ -53,62 +52,42 @@ class Socket extends Emitter {
         : this.secure
         ? 443
         : 80);
-    this.query = opts.query || {};
-    if ("string" === typeof this.query) this.query = parseqs.decode(this.query);
-    this.upgrade = false !== opts.upgrade;
-    this.path = (opts.path || "/engine.io").replace(/\/$/, "") + "/";
-    this.forceJSONP = !!opts.forceJSONP;
-    this.jsonp = false !== opts.jsonp;
-    this.forceBase64 = !!opts.forceBase64;
-    this.enablesXDR = !!opts.enablesXDR;
-    this.withCredentials = false !== opts.withCredentials;
-    this.timestampParam = opts.timestampParam || "t";
-    this.timestampRequests = opts.timestampRequests;
+
     this.transports = opts.transports || ["polling", "websocket"];
-    this.transportOptions = opts.transportOptions || {};
     this.readyState = "";
     this.writeBuffer = [];
     this.prevBufferLen = 0;
-    this.policyPort = opts.policyPort || 843;
-    this.rememberUpgrade = opts.rememberUpgrade || false;
-    this.binaryType = null;
-    this.onlyBinaryUpgrades = opts.onlyBinaryUpgrades;
-    this.perMessageDeflate =
-      false !== opts.perMessageDeflate ? opts.perMessageDeflate || {} : false;
-
-    if (true === this.perMessageDeflate) this.perMessageDeflate = {};
-    if (this.perMessageDeflate && null == this.perMessageDeflate.threshold) {
-      this.perMessageDeflate.threshold = 1024;
-    }
 
-    // SSL options for Node.js client
-    this.pfx = opts.pfx || null;
-    this.key = opts.key || null;
-    this.passphrase = opts.passphrase || null;
-    this.cert = opts.cert || null;
-    this.ca = opts.ca || null;
-    this.ciphers = opts.ciphers || null;
-    this.rejectUnauthorized =
-      opts.rejectUnauthorized === undefined ? true : opts.rejectUnauthorized;
-    this.forceNode = !!opts.forceNode;
+    this.opts = Object.assign(
+      {
+        path: "/engine.io",
+        agent: false,
+        upgrade: true,
+        jsonp: true,
+        timestampParam: "t",
+        policyPort: 843,
+        rememberUpgrade: false,
+        rejectUnauthorized: true,
+        perMessageDeflate: {
+          threshold: 1024
+        },
+        transportOptions: {}
+      },
+      opts
+    );
+
+    this.opts.path = this.opts.path.replace(/\/$/, "") + "/";
+
+    if (typeof this.opts.query === "string") {
+      this.opts.query = parseqs.decode(this.opts.query);
+    }
 
     // detect ReactNative environment
-    this.isReactNative =
+    this.opts.isReactNative =
       typeof navigator !== "undefined" &&
       typeof navigator.product === "string" &&
       navigator.product.toLowerCase() === "reactnative";
 
-    // other options for Node.js or ReactNative client
-    if (typeof self === "undefined" || this.isReactNative) {
-      if (opts.extraHeaders && Object.keys(opts.extraHeaders).length > 0) {
-        this.extraHeaders = opts.extraHeaders;
-      }
-
-      if (opts.localAddress) {
-        this.localAddress = opts.localAddress;
-      }
-    }
-
     // set on handshake
     this.id = null;
     this.upgrades = null;
@@ -130,53 +109,33 @@ class Socket extends Emitter {
    */
   createTransport(name) {
     debug('creating transport "%s"', name);
-    const query = clone(this.query);
+    const query = clone(this.opts.query);
 
     // append engine.io protocol identifier
     query.EIO = parser.protocol;
 
     // transport name
     query.transport = name;
 
-    // per-transport options
-    const options = this.transportOptions[name] || {};
-
     // session id if we already have one
     if (this.id) query.sid = this.id;
 
-    const transport = new transports[name]({
-      query: query,
-      socket: this,
-      agent: options.agent || this.agent,
-      hostname: options.hostname || this.hostname,
-      port: options.port || this.port,
-      secure: options.secure || this.secure,
-      path: options.path || this.path,
-      forceJSONP: options.forceJSONP || this.forceJSONP,
-      jsonp: options.jsonp || this.jsonp,
-      forceBase64: options.forceBase64 || this.forceBase64,
-      enablesXDR: options.enablesXDR || this.enablesXDR,
-      withCredentials: options.withCredentials || this.withCredentials,
-      timestampRequests: options.timestampRequests || this.timestampRequests,
-      timestampParam: options.timestampParam || this.timestampParam,
-      policyPort: options.policyPort || this.policyPort,
-      pfx: options.pfx || this.pfx,
-      key: options.key || this.key,
-      passphrase: options.passphrase || this.passphrase,
-      cert: options.cert || this.cert,
-      ca: options.ca || this.ca,
-      ciphers: options.ciphers || this.ciphers,
-      rejectUnauthorized: options.rejectUnauthorized || this.rejectUnauthorized,
-      perMessageDeflate: options.perMessageDeflate || this.perMessageDeflate,
-      extraHeaders: options.extraHeaders || this.extraHeaders,
-      forceNode: options.forceNode || this.forceNode,
-      localAddress: options.localAddress || this.localAddress,
-      requestTimeout: options.requestTimeout || this.requestTimeout,
-      protocols: options.protocols || void 0,
-      isReactNative: this.isReactNative
-    });
-
-    return transport;
+    const opts = Object.assign(
+      {
+        query,
+        socket: this,
+        hostname: this.hostname,
+        secure: this.secure,
+        port: this.port
+      },
+      this.opts.transportOptions[name],
+      this.opts
+    );
+
+    // console.log(opts);
+    debug("options: %j", opts);
+
+    return new transports[name](opts);
   }
 
   /**
@@ -187,7 +146,7 @@ class Socket extends Emitter {
   open() {
     let transport;
     if (
-      this.rememberUpgrade &&
+      this.opts.rememberUpgrade &&
       Socket.priorWebsocketSuccess &&
       this.transports.indexOf("websocket") !== -1
     ) {
@@ -208,6 +167,7 @@ class Socket extends Emitter {
     try {
       transport = this.createTransport(transport);
     } catch (e) {
+      debug("error while creating transport: %s", e);
       this.transports.shift();
       this.open();
       return;
@@ -381,7 +341,11 @@ class Socket extends Emitter {
 
     // we check for `readyState` in case an `open`
     // listener already closed the socket
-    if ("open" === this.readyState && this.upgrade && this.transport.pause) {
+    if (
+      "open" === this.readyState &&
+      this.opts.upgrade &&
+      this.transport.pause
+    ) {
       debug("starting upgrade probes");
       let i = 0;
       const l = this.upgrades.length;

lib/transport.js

@@ -11,35 +11,10 @@ class Transport extends Emitter {
   constructor(opts) {
     super();
 
-    this.path = opts.path;
-    this.hostname = opts.hostname;
-    this.port = opts.port;
-    this.secure = opts.secure;
+    this.opts = opts;
     this.query = opts.query;
-    this.timestampParam = opts.timestampParam;
-    this.timestampRequests = opts.timestampRequests;
     this.readyState = "";
-    this.agent = opts.agent || false;
     this.socket = opts.socket;
-    this.enablesXDR = opts.enablesXDR;
-    this.withCredentials = opts.withCredentials;
-
-    // SSL options for Node.js client
-    this.pfx = opts.pfx;
-    this.key = opts.key;
-    this.passphrase = opts.passphrase;
-    this.cert = opts.cert;
-    this.ca = opts.ca;
-    this.ciphers = opts.ciphers;
-    this.rejectUnauthorized = opts.rejectUnauthorized;
-    this.forceNode = opts.forceNode;
-
-    // results of ReactNative environment detection
-    this.isReactNative = opts.isReactNative;
-
-    // other options for Node.js client
-    this.extraHeaders = opts.extraHeaders;
-    this.localAddress = opts.localAddress;
   }
 
   /**