pubsub-js-client 0.6.1 → 25.0.6

package/src/PubsubDriver.js

@@ -1,177 +0,0 @@
-
-import EventsDispatcher from "./events";
-import logging from "./log";
-import util from "./util";
-import IframeClient from "./IframeClient";
-import IframeHost from "./IframeHost";
-import WebsocketClient from "./WebsocketClient";
-import PubsubTest from "./PubsubTest";
-
-var logger = logging._getLogger("PubsubDriver");
-
-const SOCKET_CLOSED_RECONNECT_TIME = 1 * 1000; // 1 second
-const RESPONSE_TIMEOUT = 30 * 1000; // 30 seconds
-const ERR_RESPONSE_TIMEOUT = "response timeout";
-const NONCE_LENGTH = 30;
-const DEFER_TEST_TIME = 30 * 1000; // 30 seconds
-
-const twitchUrlRegexp = /^https?:\/\/([\w-]+\.)*twitch\.(tv|tech)(:\d+)?\/.*$/;
-
-var pctTester = 0.0;
-
-class PubsubDriver extends EventsDispatcher {
-
-  constructor (env) {
-    // opts should include: environment
-    super(env);
-
-    this._env = util.urlParams.pubsub_environment || env;
-
-    this._clientReady = false;
-    this._hasDisconnected = false;
-    this._queuedRequests = [];
-
-    this._numDisconnects = 0;
-
-    if (util.inIframe() && twitchUrlRegexp.test(document.referrer)) {
-      // check parent location, if ok, create iframe with specified domain
-      logger.debug("Driver is in an iframe");
-      this._client = new IframeClient({
-        parentUrl: document.referrer
-      });
-      this._clientType = "iframe-verified";
-    } else {
-      logger.debug("Driver is not in an iframe");
-      this._client = new WebsocketClient({
-        env: this._env
-      });
-      this._iframeHost = new IframeHost(this._client);
-      this._clientType = "ws";
-    }
-
-    // Pubsub Tester
-    if (util.urlParams.force_pubsub_tester === "true") {
-      pctTester = 1.0;
-    } else if (util.urlParams.force_pubsub_tester === "false") {
-      pctTester = 0.0;
-    }
-    if (Math.random() < pctTester) {
-      // Defer starting the test to avoid wasting resources during page load.
-      window.setTimeout(this.runTest.bind(this), DEFER_TEST_TIME);
-    }
-
-    this._client.on("unverified", this._clientUnverified, this);
-    this._client.on("verified", this._clientVerified, this);
-    this._client.verify();
-  }
-
-  runTest () {
-    this._tester = new PubsubTest({
-      env: this._env,
-      driver: this
-    });
-  }
-
-  connect () {
-    // return this._client.connect();
-  }
-
-  Listen (opts) {
-    if (this._clientReady) {
-      this._client.Listen(opts);
-    } else {
-      this._queuedRequests.push({type: "LISTEN", opts: opts});
-    }
-  }
-
-  Unlisten (opts) {
-    if (this._clientReady) {
-      this._client.Unlisten(opts);
-    } else {
-      this._queuedRequests.push({type: "UNLISTEN", opts: opts});
-    }
-  }
-
-  simulateReceivedMessage(topic, message) {
-    const msg = {
-      data: {message, topic},
-      type: "MESSAGE-SIMULATED"
-    };
-    this._client._onMessage(msg);
-  }
-
-  _flushQueuedRequests () {
-    logger.debug("Flushing " + this._queuedRequests.length + " queued requests");
-    while (this._queuedRequests.length > 0) {
-      var req = this._queuedRequests.shift();
-      switch (req.type) {
-      case "LISTEN":
-        this._client.Listen(req.opts);
-        break;
-      case "UNLISTEN":
-        this._client.Unlisten(req.opts);
-        break;
-      }
-    }
-  }
-
-  _clientConnected () {
-    logger.debug("Client connected");
-    this._client.on("disconnected", this._clientDisconnected, this);
-    this._trigger("connected");
-    if (this._hasDisconnected) {
-      this._trigger("reconnected");
-    }
-    this._clientReady = true;
-    this._flushQueuedRequests();
-  }
-
-  _clientDisconnected () {
-    logger.debug("Client disconnected");
-    this._trigger("disconnected");
-    this._clientReady = false;
-    this._numDisconnects += 1;
-    this._hasDisconnected = true;
-  }
-
-  _clientVerified () {
-    logger.debug("Client verified (type = " + this._clientType + ")");
-    this._client.on("connected", this._clientConnected, this);
-    this._client.connect();
-  }
-
-  _clientUnverified () {
-    // only triggered by iframe clients
-    logger.debug("Unverified IframeClient");
-    this._client.off("verified", this._clientVerified, this);
-    this._client.off("unverified", this._clientUnverified, this);
-
-    this._client = new WebsocketClient({
-        env: this._env
-      });
-    this._clientType = "iframe-unverified";
-
-    this._client.on("unverified", this._clientUnverified, this);
-    this._client.on("verified", this._clientVerified, this);
-    this._client.verify();
-  }
-}
-
-window.__Twitch__pubsubInstances = window.__Twitch__pubsubInstances || {
-  production: null,
-  staging: null,
-  darklaunch: null
-};
-
-function getInstance(env) {
-  if (env !== "production" && env !== "staging" && env !== "darklaunch") {
-    throw "Invalid Pubsub instance environment";
-  }
-  if (window.__Twitch__pubsubInstances[env] === null) {
-    // create driver
-    window.__Twitch__pubsubInstances[env] = new PubsubDriver(env);
-  }
-  return window.__Twitch__pubsubInstances[env];
-}
-
-export default {getInstance};

package/src/PubsubSocket.js

@@ -1,186 +0,0 @@
-import EventsDispatcher from "./events";
-import logging from "./log";
-import util from "./util";
-
-var logger = logging._getLogger("PubsubSocket");
-
-const MAX_CONNECTION_DELAY = 120;
-
-const ERR_SOCKET_CLOSED = "socket_closed";
-const ERR_PONG_TIMEOUT = "missed_pong";
-const ERR_CONNECTION_FAILED = "max_connection_attempts";
-const ERR_NOT_READY = "not_ready";
-const ERR_FAILED_SEND = "failed_send";
-
-const PONG_TIMEOUT = 30 * 1000; // 30 seconds
-const PING_INTERVAL = 4 * 60 * 1000; // 4 minutes
-
-/*
-PubsubSocket is responsible for managing the WebSocket connction to Pubsub Edge, hiding the details of ping/pong, connection retries, and parsing received message types from the PubsubDriver.
-It retries connecting with exponential backoff if it fails to connect.
-When it opens, it triggers an "open" event.
-If it closes unexpectedly, it triggers a "connection_failure" event.
-It handles pings/pongs, and triggers a "pong_timeout" event if a pong isn't received.
-If it is intentionally closed, it triggers a "closed" event when it closes.
-If it receives a RESPONSE type message from the Pubsub, it triggers a "response" event.
-If it receives a MESSAGE type message from the Pubsub, it triggers a "message" event.
-If it receives a RECONNECT type message from the Pubsub, it triggers a "reconnect" event.
-*/
-
-class PubsubSocket extends EventsDispatcher {
-  constructor (opts) {
-    super(opts);
-    this._opts = opts;
-    this._addr = opts.addr;
-
-    this._connectionAttempts = 0;
-    this._sentPing = this._receivedPong = false;
-
-    this._id = "[" + util.generateString(10) + "] ";
-
-    window.addEventListener("beforeunload", this._beforeUnload.bind(this));
-  }
-
-  connect () {
-    logger.debug(this._id + "connecting to " + this._addr);
-    this._connecting = true;
-    try {
-      this._socket = new WebSocket(this._addr);
-      this._socket.onmessage = this._onMessage.bind(this);
-      this._socket.onerror = this._onError.bind(this);
-      this._socket.onclose = this._onClose.bind(this);
-      this._socket.onopen = this._onOpen.bind(this);
-    } catch (e) {
-      this._trigger("connection_failure");
-    }
-  }
-
-  close () {
-    logger.debug(this._id + "closing");
-    this._closing = true;
-    this._clearTimeouts();
-    this._socket.close();
-  }
-
-  send (msg) {
-    logger.debug(this._id + "sending " + JSON.stringify(msg));
-    if (this._isReady()) {
-      this._socket.send(JSON.stringify(msg));
-    } else {
-      this._trigger("error", ERR_NOT_READY);
-    }
-  }
-
-  _isReady () {
-    logger.debug(this._id + "_isReady called");
-    if (this._socket) {
-      return (this._socket.readyState === WebSocket.OPEN);
-    } else {
-      return false;
-    }
-  }
-
-  _onMessage (event) {
-    logger.debug(this._id + "received message: " + event.data);
-    try {
-      var msg = JSON.parse(event.data);
-      switch (msg.type) {
-      case "RESPONSE":
-        this._trigger("response", msg);
-        break;
-      case "MESSAGE":
-        this._trigger("message", msg);
-        break;
-      case "PONG":
-        this._receivedPong = true;
-        break;
-      case "RECONNECT":
-        this._trigger("reconnect");
-        break;
-      }
-    } catch (e) {
-      // bad json parse
-      logger.debug("onMessage JSON Parse error: " + e);
-    }
-  }
-
-  _onError (event) {
-    // Irrelevant since the _onClose event is about to be triggered
-    logger.debug(this._id + "error: " + JSON.stringify(event));
-  }
-
-  _onClose (event) {
-    logger.debug(this._id + "onClose triggered with code " + event.code + "(closing = " + this._closing + ", connecting = " + this._connecting + ")");
-    this._clearTimeouts();
-    if (this._connecting) {
-      // Failed during connection, retry with exponential backoff
-      var connectionDelay = Math.pow(2, this._connectionAttempts);
-      if (connectionDelay > MAX_CONNECTION_DELAY) {
-        connectionDelay = MAX_CONNECTION_DELAY;
-      }
-      logger.debug(this._id + "reconnecting in " + connectionDelay + " seconds");
-      this._connectionAttempts += 1;
-      this._nextConnectionAttempt = setTimeout(this.connect.bind(this), 1000 * connectionDelay);
-    } else if (this._closing) {
-      // Intentionally closed itself (due to an error), don't send an 'unexpected_closed' error since the relevant error will have already been sent
-      this._closed = true;
-      this._trigger("connection_failure");
-    } else if (this._windowUnloading) {
-      // Closed because the browser window is being refreshed or redirected
-      // Don't trigger anything, whole object is going to be destroyed by the browser anyhow
-      return;
-    } else {
-      // Unintentionally closed, trigger an error so the Driver knows to re-fetch state
-      logger.debug(this._id + "unexpected close");
-      var line = "pubsub-js-client unexpected_close. code: " + event.code + ", reason: " + event.reason + ", wasClean: " + event.wasClean;
-      this._closed = true;
-      this._trigger("connection_failure");
-    }
-  }
-
-  _onOpen (event) {
-    logger.debug(this._id + " socket opened");
-    this._connectionAttempts = 0;
-    this._connecting = false;
-
-    this._ping();
-    this._pingInterval = window.setInterval(this._ping.bind(this), PING_INTERVAL);
-    this._trigger("open");
-  }
-
-  _ping () {
-    logger.debug(this._id + "sending PING");
-    try {
-      this._socket.send(JSON.stringify({type: "PING"}));
-      this._sentPing = true;
-      if (this._pongTimeout) {
-        clearTimeout(this._pongTimeout);
-      }
-      this._pongTimeout = setTimeout(this._pongTimedOut.bind(this), PONG_TIMEOUT);
-    } catch (e) {
-      this.close();
-    }
-  }
-
-  _pongTimedOut () {
-    if (this._sentPing && !this._receivedPong) {
-      logger.debug(this._id + "Pong timed out!");
-      // Close the socket; this will initiate the reconnection flow automatically
-      this.close();
-    }
-  }
-
-  _clearTimeouts () {
-    this._sentPing = this._receivedPong = false;
-    clearTimeout(this._pongTimeout);
-    clearInterval(this._pingInterval);
-    clearTimeout(this._nextConnectionAttempt);
-  }
-
-  _beforeUnload () {
-    this._windowUnloading = true;
-  }
-
-}
-
-export default PubsubSocket;

package/src/PubsubTest.js

@@ -1,189 +0,0 @@
-/* globals $ */
-
-import util from "./util";
-import logging from "./log";
-
-const pubsterAddrProduction = "https://pubster.twitch.tv/publish";
-const pubsterAddrDarklaunch = "https://pubster-darklaunch.twitch.tv/publish";
-
-const uniqueKey = "pubsubtest.unique.";
-const sharedKey = "pubsubtest.shared." + util.randomInt(10); // 10 topics
-const pctPublishShared = 0.0001;
-
-const publishIntervalTime = 60 * 1000; // 60 seconds
-const ajaxTimeout = 30 * 1000; // 30 seconds
-
-const sampleRateSuccess = 0.1;
-const sampleRateFailure = 1.0;
-
-var logger = logging._getLogger("PubsubTest");
-
-class PubsubTest {
-  constructor (opts) {
-    if (!window.$) {
-      logger.debug("PubsubTest could not be enabled. JQuery is undefined.");
-      return;
-    }
-
-    logger.debug("PubsubTest enabled");
-    this._env = opts.env;
-    this._driver = opts.driver;
-
-    switch (this._env) {
-    case "production":
-      this._addr = pubsterAddrProduction;
-      break;
-    case "darklaunch":
-      this._addr = pubsterAddrDarklaunch;
-      break;
-    default:
-      this._env = "production";
-      this._addr = pubsterAddrProduction;
-    }
-
-    this._statKeys = {
-      uniqueSuccess: "test.unique.success",
-      uniqueFailure: "test.unique.failure",
-      sharedSuccess: "test.shared.success",
-      sharedFailure: "test.shared.failure"
-    };
-
-    this._uniqueKey = uniqueKey + util.generateString(20);
-    this._sharedKey = sharedKey;
-
-    this._listeningUnique = this._listeningShared = false;
-    this.sendListens();
-  }
-
-  sendListens () {
-    this._driver.Listen({
-      topic: this._uniqueKey,
-      auth: "",
-      success: this._gotUniqueOk.bind(this),
-      failure: this._gotUniqueFail.bind(this),
-      message: this._gotUniqueMessage.bind(this)
-    });
-
-    this._driver.Listen({
-      topic: this._sharedKey,
-      auth: "",
-      success: this._gotSharedOk.bind(this),
-      failure: this._gotSharedFail.bind(this),
-      message: this._gotSharedMessage.bind(this)
-    });
-  }
-
-  _gotUniqueOk () {
-    this._listeningUnique = true;
-    if (this._listeningShared) {
-      this.startTesting();
-    }
-  }
-
-  _gotUniqueFail (err) {
-    // Ignore
-  }
-
-  _gotSharedOk () {
-    this._listeningShared = true;
-    if (this._listeningUnique) {
-      this.startTesting();
-    }
-  }
-
-  _gotSharedFail (err) {
-    // Ignore
-  }
-
-  startTesting() {
-    logger.debug("startTesting");
-    this._driver.on("connected", this.resumeTesting, this);
-    this._driver.on("disconnected", this.stopTesting, this);
-    this.checkAndSend();
-    this._publishInterval = window.setInterval(this.checkAndSend.bind(this), publishIntervalTime);
-  }
-
-  resumeTesting() {
-    logger.debug("resumeTesting");
-    this.checkAndSend();
-    this._publishInterval = window.setInterval(this.checkAndSend.bind(this), publishIntervalTime);
-  }
-
-  stopTesting() {
-    logger.debug("stopTesting");
-    clearInterval(this._publishInterval);
-    this._receivedUniqueMessage = this._sentUniqueMessage = false;
-    this._receivedSharedMessage = this._sentSharedMessage = false;
-  }
-
-  checkAndSend() {
-    logger.debug("checkAndSend: unique: sent = " + this._sentUniqueMessage + ", received = " + this._receivedUniqueMessage);
-    if (!this._receivedUniqueMessage && this._sentUniqueMessage) {
-      // log unique error
-      logger.debug("unique failure");
-    }
-    if (!this._receivedSharedMessage && this._sentSharedMessage) {
-      // log shared error
-      logger.debug("shared failure");
-    }
-
-    this._receivedUniqueMessage = this._sentUniqueMessage = false;
-    this._receivedSharedMessage = this._sentSharedMessage = false;
-
-    this._expectedMessage = util.generateString(30);
-
-    // publish unique message to testPub
-    $.ajax({
-      type: "POST",
-      url: this._addr,
-      contentType: "application/json",
-      timeout: ajaxTimeout,
-      data: JSON.stringify({
-        topics: [this._uniqueKey],
-        data: this._expectedMessage
-      }),
-      success: (function () {
-        logger.debug("unique message sent");
-        this._sentUniqueMessage = true;
-      }).bind(this)
-    });
-    this._sentUniqueMessageTime = util.time.now();
-
-    // potentially publish shared message
-    if (Math.random() < pctPublishShared) {
-      $.ajax({
-        type: "POST",
-        url: this._addr,
-        contentType: "application/json",
-        timeout: ajaxTimeout,
-        data: JSON.stringify({
-          topics: [this._sharedKey],
-          data: this._expectedMessage
-        }),
-        success: (function () {
-          logger.debug("shared message sent");
-          this._sentSharedMessage = true;
-        }).bind(this)
-      });
-      this._sentSharedMessageTime = util.time.now();
-    }
-  }
-
-  _gotUniqueMessage (msg) {
-    logger.debug("received unique message: " + msg);
-    if (msg === this._expectedMessage) {
-      var rtt = util.time.now() - this._sentUniqueMessageTime;
-      this._receivedUniqueMessage = true;
-    }
-  }
-
-  _gotSharedMessage (msg) {
-    if (msg === this._expectedMessage) {
-      var rtt = util.time.now() - this._sentSharedMessageTime;
-      this._receivedSharedMessage = true;
-    }
-  }
-
-}
-
-export default PubsubTest;