@kineticdata/react 5.1.2 → 6.0.0

package/lib/apis/socket/socket.js

@@ -1,350 +0,0 @@
-import _slicedToArray from "@babel/runtime/helpers/esm/slicedToArray";
-import _classCallCheck from "@babel/runtime/helpers/esm/classCallCheck";
-import _createClass from "@babel/runtime/helpers/esm/createClass";
-import { Topic, TOPIC_STATUS } from './topic';
-import { Timer } from './timer';
-export var TOPIC_HUB_TOPIC = 'topichub';
-export var TOPIC_HUB_ACTION_IDENTIFY = 'identify';
-export var TOPIC_HUB_ACTION_HEARTBEAT = 'heartbeat';
-export var TOPIC_HUB_ACTION_SUBSCRIBE = 'subscribe';
-export var TOPIC_HUB_ACTION_UNSUBSCRIBE = 'unsubscribe';
-export var TOPIC_HUB_EVENT_PRESENCE = 'presence';
-export var TOPIC_HUB_EVENT_ACK_OK = 'ack-ok';
-export var TOPIC_HUB_EVENT_ACK_ERROR = 'ack-error';
-export var TOPIC_HUB_HEARTBEAT_INTERVAL = 30000; // Heartbeat every 30s.
-
-export var VALID_EVENTS = ['connect', 'identify', 'disconnect', 'status'];
-export var PRESENCE_CREATE_OP = 'CREATED';
-export var PRESENCE_REMOVE_OP = 'REMOVED';
-export var PRESENCE_INIT_OP = 'INIT';
-export var SOCKET_STATUS = {
-  CLOSED: 'closed',
-  CONNECTING: 'connecting',
-  RECONNECTING: 'reconnecting',
-  IDENTIFYING: 'identifying',
-  UNIDENTIFIED: 'unidentified',
-  IDENTIFIED: 'identified'
-};
-export var SOCKET_STAGE = {
-  CLOSED: 'closed',
-  CONNECTING: 'connecting',
-  RECONNECTING: 'reconnecting',
-  IDENTIFIED: 'connected'
-};
-export var Socket = /*#__PURE__*/function () {
-  function Socket(uri) {
-    _classCallCheck(this, Socket);
-
-    this.uri = uri;
-    this.status = SOCKET_STATUS.CLOSED;
-    this.stage = SOCKET_STAGE.CLOSED;
-    this.socket = null;
-    this.token = '';
-    this.ref = 0;
-    this.topics = {};
-    this.eventCallbacks = VALID_EVENTS.reduce(function (ec, e) {
-      ec[e] = [];
-      return ec;
-    }, {}); // Bind functions that are used in callbacks.
-
-    this.handleReconnect = this.handleReconnect.bind(this);
-    this.handleIdentify = this.handleIdentify.bind(this);
-    this.refCallbacks = [];
-    this.heartbeatInterval = null; // Add our internal identify callback to keep track of whether we're identified.
-
-    this.eventCallbacks.identify.push(this.handleIdentify);
-    this.reconnectTimer = new Timer(this.handleReconnect);
-  }
-
-  _createClass(Socket, [{
-    key: "isIdentified",
-    value: function isIdentified() {
-      return this.identified;
-    }
-  }, {
-    key: "on",
-    value: function on(event, cb) {
-      if (!VALID_EVENTS.includes(event)) return this;
-      this.eventCallbacks[event].push(cb);
-      return this;
-    }
-  }, {
-    key: "connect",
-    value: function connect(token, uri) {
-      this.token = token;
-
-      if (uri) {
-        this.uri = uri;
-      }
-
-      this.setStatus(SOCKET_STATUS.CONNECTING);
-      this.doConnect();
-      return this;
-    }
-  }, {
-    key: "doConnect",
-    value: function doConnect() {
-      var _this = this;
-
-      this.socket = new WebSocket(this.uri);
-
-      this.socket.onopen = function (e) {
-        return _this.handleConnect(e);
-      };
-
-      this.socket.onclose = function (e) {
-        return _this.handleClose(e);
-      };
-
-      this.socket.onmessage = function (e) {
-        return _this.receive(e.data);
-      };
-    }
-  }, {
-    key: "reconnect",
-    value: function reconnect(token, uri) {
-      this.close();
-      this.token = token;
-
-      if (uri) {
-        this.uri = uri;
-      }
-
-      this.setStatus(SOCKET_STATUS.CONNECTING);
-      this.doConnect();
-      return this;
-    }
-  }, {
-    key: "close",
-    value: function close() {
-      this.setStatus(SOCKET_STATUS.CLOSED);
-      this.socket.close();
-      clearInterval(this.heartbeatInterval);
-      return this;
-    }
-  }, {
-    key: "topic",
-    value: function topic(topicId, cb) {
-      if (this.topics.hasOwnProperty(topicId)) {
-        console.warn('The client code attempted to join an already active topic.');
-        return this.topics[topicId];
-      }
-
-      var topic = new Topic(topicId, this, cb);
-      this.topics[topicId] = topic;
-      return topic;
-    }
-  }, {
-    key: "handleReconnect",
-    value: function handleReconnect() {
-      console.log('Trying to reconnect...');
-      delete this.socket;
-      this.doConnect();
-    }
-  }, {
-    key: "handleConnect",
-    value: function handleConnect(e) {
-      var _this2 = this;
-
-      // Identification callback.
-      var previousStatus = this.status;
-
-      var identCallback = function identCallback(message) {
-        _this2.eventCallbacks.identify.forEach(function (cb) {
-          return cb(message);
-        }); // If we were reconnecting...
-
-
-        if (previousStatus === SOCKET_STATUS.RECONNECTING) {
-          console.log('Reconnected and identified. Attempting to re-subscribe to topics.', _this2.topics);
-
-          _this2.forAllTopics(function (t) {
-            return t.subscribe();
-          });
-        }
-      }; // If I've just connected I am connected but not identified.
-
-
-      this.setStatus(SOCKET_STATUS.IDENTIFYING, e); // Reset the reconnect timer if it is running.
-
-      this.reconnectTimer.reset(); // Start our heartbeat interval.
-
-      this.heartbeatInterval = setInterval(function () {
-        return _this2.send(_this2.createMessage(TOPIC_HUB_TOPIC, TOPIC_HUB_ACTION_HEARTBEAT));
-      }, TOPIC_HUB_HEARTBEAT_INTERVAL); // Send the "identify" message.
-
-      var message = this.createMessage(TOPIC_HUB_TOPIC, TOPIC_HUB_ACTION_IDENTIFY, {
-        token: this.token
-      });
-      this.send(message, identCallback);
-    }
-  }, {
-    key: "handleClose",
-    value: function handleClose(e) {
-      if (this.status === SOCKET_STATUS.IDENTIFIED) {
-        // If we were connected (e.g. the close isn't due to explicitly requesting
-        // the socket to be closed) we should begin the reconnect process.
-        this.setStatus(SOCKET_STATUS.RECONNECTING, e);
-        this.forAllTopics(function (t) {
-          return t.setStatus(TOPIC_STATUS.reconnecting);
-        });
-        this.reconnectTimer.execute();
-      } else if (this.status === SOCKET_STATUS.RECONNECTING) {
-        // If we're getting a close event and we're reconnecting that indicates that a
-        // reconnect attempt failed and we will try again.
-        this.setStatus(SOCKET_STATUS.RECONNECTING, e);
-        this.reconnectTimer.execute();
-        return;
-      } else {
-        this.setStatus(SOCKET_STATUS.CLOSED, e);
-        this.forAllTopics(function (t) {
-          return t.setStatus(TOPIC_STATUS.closed);
-        });
-      } // Call all of the event callbacks for 'connect'.
-
-
-      this.eventCallbacks.disconnect.forEach(function (cb) {
-        return cb(e);
-      }); // TODO:MTR
-      // Also close all of the topics.
-      // this.topics.forEach(t => (t.topicStatus = TOPIC_STATUS.closed));
-
-      clearInterval(this.heartbeatInterval);
-    }
-  }, {
-    key: "handleIdentify",
-    value: function handleIdentify(message) {
-      if (message.event === TOPIC_HUB_EVENT_ACK_OK) {
-        this.setStatus(SOCKET_STATUS.IDENTIFIED);
-      } else {
-        this.setStatus(SOCKET_STATUS.UNIDENTIFIED);
-      }
-    }
-  }, {
-    key: "send",
-    value: function send(message, cb) {
-      if (typeof cb === 'function') {
-        this.refCallbacks.push({
-          ref: message.ref,
-          cb: cb
-        });
-      }
-
-      this.socket.send(JSON.stringify(message));
-    }
-  }, {
-    key: "receive",
-    value: function receive(data) {
-      try {
-        // Parse the incoming message.
-        var message = JSON.parse(data);
-
-        if (message.ref) {
-          // If the server sent a ref back then we should check for any ref callbacks.
-          // Apply all ref callbacks where the ref matches the one on the message.
-          this.refCallbacks.filter(function (r) {
-            return r.ref === message.ref;
-          }).forEach(function (r) {
-            return r.cb(message);
-          });
-        } // Filter out the ref callbacks for this message.
-
-
-        this.refCallbacks = this.refCallbacks.filter(function (r) {
-          return r.ref !== message.ref;
-        }); // If the message is a presence related message, lets handle it specially.
-
-        if (message.topic === TOPIC_HUB_TOPIC && message.event === TOPIC_HUB_EVENT_PRESENCE) {
-          this.receivePresence(message);
-        } // Delegate it to the relevant topic.
-
-
-        var topic = this.topics[message.event === 'unsubscribed' ? message.payload.topic : message.topic];
-
-        if (topic) {
-          topic.receive(message);
-        } // If the event is 'unsubscribed'  delete the topic.
-
-
-        if (message.event === 'unsubscribed') {
-          delete this.topics[message.payload.topic];
-        }
-      } catch (e) {
-        console.warn('Received invalid message from server: ', data, e);
-      }
-    }
-  }, {
-    key: "receivePresence",
-    value: function receivePresence(message) {
-      var _this3 = this;
-
-      if ([PRESENCE_CREATE_OP, PRESENCE_REMOVE_OP].includes(message.payload.op)) {
-        this.processPresence(message.payload.op, message.payload.presenceData);
-      } else if (message.payload.op === PRESENCE_INIT_OP) {
-        message.payload.presences.forEach(function (pd) {
-          _this3.processPresence(PRESENCE_CREATE_OP, pd);
-        });
-      }
-    }
-  }, {
-    key: "processPresence",
-    value: function processPresence(op, presenceData) {
-      // If it's a standard delta message, fetch the topic
-      var topic = this.topics[presenceData.topic];
-
-      if (topic) {
-        topic.receivePresence(op, presenceData);
-      }
-    }
-  }, {
-    key: "createMessage",
-    value: function createMessage(topic, action, payload) {
-      return {
-        topic: topic,
-        action: action,
-        payload: payload,
-        ref: this.makeRef()
-      };
-    }
-  }, {
-    key: "makeRef",
-    value: function makeRef() {
-      this.ref = this.ref === this.ref + 1 ? 0 : this.ref + 1;
-      return '' + this.ref;
-    }
-  }, {
-    key: "setStatus",
-    value: function setStatus(status, event) {
-      var stage = this.stage;
-
-      if (status === SOCKET_STATUS.CLOSED) {
-        stage = SOCKET_STAGE.CLOSED;
-      } else if (status === SOCKET_STATUS.CONNECTING) {
-        stage = SOCKET_STAGE.CONNECTING;
-      } else if (status === SOCKET_STATUS.RECONNECTING) {
-        stage = SOCKET_STAGE.RECONNECTING;
-      } else if (status === SOCKET_STATUS.IDENTIFIED) {
-        stage = SOCKET_STAGE.IDENTIFIED;
-      }
-
-      this.stage = stage;
-      this.status = status;
-      this.eventCallbacks.status.forEach(function (cb) {
-        return cb(status, stage, event);
-      });
-    }
-  }, {
-    key: "forAllTopics",
-    value: function forAllTopics(fn) {
-      Object.entries(this.topics).forEach(function (_ref) {
-        var _ref2 = _slicedToArray(_ref, 2),
-            _topicId = _ref2[0],
-            topic = _ref2[1];
-
-        return fn(topic);
-      });
-    }
-  }]);
-
-  return Socket;
-}();

package/lib/apis/socket/socket.test.js

@@ -1,90 +0,0 @@
-import _regeneratorRuntime from "@babel/runtime/regenerator";
-import _asyncToGenerator from "@babel/runtime/helpers/esm/asyncToGenerator";
-import WS from 'jest-websocket-mock';
-import { Socket, SOCKET_STAGE, SOCKET_STATUS } from './socket';
-var MOCK_SERVER = 'ws://localhost:1234';
-var MOCK_TOKEN = 'JWT_TOKEN';
-describe('socket', function () {
-  var socket;
-  var server;
-  beforeEach(function () {
-    server = new WS(MOCK_SERVER);
-    socket = new Socket(MOCK_SERVER);
-  });
-  afterEach(function () {
-    WS.clean();
-  });
-  describe('typical flow', function () {
-    test('connect', /*#__PURE__*/_asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee() {
-      var identifyCb, disconnectCb;
-      return _regeneratorRuntime.wrap(function _callee$(_context) {
-        while (1) {
-          switch (_context.prev = _context.next) {
-            case 0:
-              identifyCb = jest.fn();
-              disconnectCb = jest.fn();
-              socket.on('identify', identifyCb);
-              socket.on('disconnect', disconnectCb);
-              expect(socket.stage).toBe(SOCKET_STAGE.CLOSED);
-              expect(socket.status).toBe(SOCKET_STATUS.CLOSED);
-              socket.connect(MOCK_TOKEN);
-              expect(socket.stage).toBe(SOCKET_STAGE.CONNECTING);
-              expect(socket.status).toBe(SOCKET_STATUS.CONNECTING);
-              _context.next = 11;
-              return server.connected;
-
-            case 11:
-              expect(socket.stage).toBe(SOCKET_STAGE.CONNECTING);
-              expect(socket.status).toBe(SOCKET_STATUS.IDENTIFYING); // The Socket will send an identify automatically with the token.
-
-              _context.next = 15;
-              return expect(server).toReceiveMessage("{\"topic\":\"topichub\",\"action\":\"identify\",\"payload\":{\"token\":\"".concat(MOCK_TOKEN, "\"},\"ref\":\"").concat(socket.ref, "\"}"));
-
-            case 15:
-              _context.next = 17;
-              return server.send("{ \"event\": \"ack-ok\", \"ref\": \"".concat(socket.ref, "\" }"));
-
-            case 17:
-              expect(socket.stage).toBe(SOCKET_STAGE.IDENTIFIED);
-              expect(socket.status).toBe(SOCKET_STATUS.IDENTIFIED); // Close and restart the mock.
-
-              _context.next = 21;
-              return server.close();
-
-            case 21:
-              _context.next = 23;
-              return server.closed;
-
-            case 23:
-              WS.clean();
-              server = new WS(MOCK_SERVER);
-              expect(disconnectCb).toHaveBeenCalled();
-              expect(socket.stage).toBe(SOCKET_STAGE.RECONNECTING);
-              expect(socket.status).toBe(SOCKET_STATUS.RECONNECTING);
-              _context.next = 30;
-              return server.connected;
-
-            case 30:
-              expect(socket.stage).toBe(SOCKET_STAGE.RECONNECTING);
-              expect(socket.status).toBe(SOCKET_STATUS.IDENTIFYING);
-              _context.next = 34;
-              return expect(server).toReceiveMessage("{\"topic\":\"topichub\",\"action\":\"identify\",\"payload\":{\"token\":\"".concat(MOCK_TOKEN, "\"},\"ref\":\"").concat(socket.ref, "\"}"));
-
-            case 34:
-              _context.next = 36;
-              return server.send("{ \"event\": \"ack-ok\", \"ref\": \"".concat(socket.ref, "\" }"));
-
-            case 36:
-              expect(identifyCb).toHaveBeenCalled();
-              expect(socket.stage).toBe(SOCKET_STAGE.IDENTIFIED);
-              expect(socket.status).toBe(SOCKET_STATUS.IDENTIFIED);
-
-            case 39:
-            case "end":
-              return _context.stop();
-          }
-        }
-      }, _callee);
-    })));
-  });
-});

package/lib/apis/socket/timer.js

@@ -1,45 +0,0 @@
-import _classCallCheck from "@babel/runtime/helpers/esm/classCallCheck";
-import _createClass from "@babel/runtime/helpers/esm/createClass";
-
-var DEFAULT_TIMING_FN = function DEFAULT_TIMING_FN(attempts) {
-  return [500, 1000, 5000, 10000][attempts] || 10000;
-};
-
-export var Timer = /*#__PURE__*/function () {
-  function Timer(callback, timingFn) {
-    _classCallCheck(this, Timer);
-
-    this.callback = callback;
-    this.timingFn = timingFn || DEFAULT_TIMING_FN;
-    this.attempts = 0;
-    this.timeout = null;
-  }
-
-  _createClass(Timer, [{
-    key: "reset",
-    value: function reset() {
-      this.attempts = 0;
-      clearTimeout(this.timeout);
-      this.timeout = null;
-    }
-  }, {
-    key: "isRunning",
-    value: function isRunning() {
-      return this.timeout !== null;
-    }
-  }, {
-    key: "execute",
-    value: function execute() {
-      var _this = this;
-
-      clearTimeout(this.timeout);
-      this.timeout = setTimeout(function () {
-        _this.attempts = _this.attempts + 1;
-
-        _this.callback();
-      }, this.timingFn(this.attempts));
-    }
-  }]);
-
-  return Timer;
-}();

package/lib/apis/socket/timer.test.js

@@ -1,51 +0,0 @@
-import { Timer } from './timer';
-jest.useFakeTimers();
-describe('Timer', function () {
-  var callback;
-  beforeEach(function () {
-    callback = jest.fn();
-  });
-  test('callback is called after the timeout', function () {
-    var timer = new Timer(callback);
-    expect(timer.attempts).toBe(0);
-    expect(callback).not.toBeCalled();
-    timer.execute();
-    jest.runAllTimers();
-    expect(timer.attempts).toBe(1);
-    expect(callback).toBeCalled();
-    expect(callback).toHaveBeenCalledTimes(1);
-  });
-  test('callback is called each time', function () {
-    var timer = new Timer(callback);
-    timer.execute();
-    jest.runAllTimers();
-    timer.execute();
-    jest.runAllTimers();
-    expect(timer.attempts).toBe(2);
-    expect(callback).toBeCalled();
-    expect(callback).toHaveBeenCalledTimes(2);
-  });
-  test('gets the next timeout using attempts', function () {
-    var timingFn = jest.fn();
-    var timer = new Timer(callback, timingFn);
-    timer.attempts = 2;
-    timer.execute();
-    jest.runAllTimers();
-    expect(timingFn).toBeCalled();
-    expect(timingFn).toHaveBeenCalledTimes(1);
-    expect(timingFn).toBeCalledWith(2);
-    expect(timer.attempts).toBe(3);
-  });
-  test('reset sets clears the attempts and timeout', function () {
-    var timer = new Timer(callback, function () {
-      return 1000;
-    });
-    timer.attempts = 2;
-    timer.execute();
-    jest.runTimersToTime(500);
-    timer.reset();
-    jest.runAllTimers();
-    expect(callback).not.toHaveBeenCalled();
-    expect(timer.attempts).toBe(0);
-  });
-});