dash-renderer/lib/utils/workerClient.js

render dash components in react

"use strict";

Object.defineProperty(exports, "__esModule", {
  value: true
});
exports.WorkerMessageType = void 0;
exports.getWorkerClient = getWorkerClient;
exports.isWebSocketAvailable = isWebSocketAvailable;
exports.isWebSocketEnabled = isWebSocketEnabled;
var _rendererId = require("./rendererId");
function _slicedToArray(r, e) { return _arrayWithHoles(r) || _iterableToArrayLimit(r, e) || _unsupportedIterableToArray(r, e) || _nonIterableRest(); }
function _nonIterableRest() { throw new TypeError("Invalid attempt to destructure non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); }
function _iterableToArrayLimit(r, l) { var t = null == r ? null : "undefined" != typeof Symbol && r[Symbol.iterator] || r["@@iterator"]; if (null != t) { var e, n, i, u, a = [], f = !0, o = !1; try { if (i = (t = t.call(r)).next, 0 === l) { if (Object(t) !== t) return; f = !1; } else for (; !(f = (e = i.call(t)).done) && (a.push(e.value), a.length !== l); f = !0); } catch (r) { o = !0, n = r; } finally { try { if (!f && null != t.return && (u = t.return(), Object(u) !== u)) return; } finally { if (o) throw n; } } return a; } }
function _arrayWithHoles(r) { if (Array.isArray(r)) return r; }
function _createForOfIteratorHelper(r, e) { var t = "undefined" != typeof Symbol && r[Symbol.iterator] || r["@@iterator"]; if (!t) { if (Array.isArray(r) || (t = _unsupportedIterableToArray(r)) || e && r && "number" == typeof r.length) { t && (r = t); var _n = 0, F = function F() {}; return { s: F, n: function n() { return _n >= r.length ? { done: !0 } : { done: !1, value: r[_n++] }; }, e: function e(r) { throw r; }, f: F }; } throw new TypeError("Invalid attempt to iterate non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); } var o, a = !0, u = !1; return { s: function s() { t = t.call(r); }, n: function n() { var r = t.next(); return a = r.done, r; }, e: function e(r) { u = !0, o = r; }, f: function f() { try { a || null == t.return || t.return(); } finally { if (u) throw o; } } }; }
function _unsupportedIterableToArray(r, a) { if (r) { if ("string" == typeof r) return _arrayLikeToArray(r, a); var t = {}.toString.call(r).slice(8, -1); return "Object" === t && r.constructor && (t = r.constructor.name), "Map" === t || "Set" === t ? Array.from(r) : "Arguments" === t || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(t) ? _arrayLikeToArray(r, a) : void 0; } }
function _arrayLikeToArray(r, a) { (null == a || a > r.length) && (a = r.length); for (var e = 0, n = Array(a); e < a; e++) n[e] = r[e]; return n; }
function _regenerator() { /*! regenerator-runtime -- Copyright (c) 2014-present, Facebook, Inc. -- license (MIT): https://github.com/babel/babel/blob/main/packages/babel-helpers/LICENSE */ var e, t, r = "function" == typeof Symbol ? Symbol : {}, n = r.iterator || "@@iterator", o = r.toStringTag || "@@toStringTag"; function i(r, n, o, i) { var c = n && n.prototype instanceof Generator ? n : Generator, u = Object.create(c.prototype); return _regeneratorDefine2(u, "_invoke", function (r, n, o) { var i, c, u, f = 0, p = o || [], y = !1, G = { p: 0, n: 0, v: e, a: d, f: d.bind(e, 4), d: function d(t, r) { return i = t, c = 0, u = e, G.n = r, a; } }; function d(r, n) { for (c = r, u = n, t = 0; !y && f && !o && t < p.length; t++) { var o, i = p[t], d = G.p, l = i[2]; r > 3 ? (o = l === n) && (u = i[(c = i[4]) ? 5 : (c = 3, 3)], i[4] = i[5] = e) : i[0] <= d && ((o = r < 2 && d < i[1]) ? (c = 0, G.v = n, G.n = i[1]) : d < l && (o = r < 3 || i[0] > n || n > l) && (i[4] = r, i[5] = n, G.n = l, c = 0)); } if (o || r > 1) return a; throw y = !0, n; } return function (o, p, l) { if (f > 1) throw TypeError("Generator is already running"); for (y && 1 === p && d(p, l), c = p, u = l; (t = c < 2 ? e : u) || !y;) { i || (c ? c < 3 ? (c > 1 && (G.n = -1), d(c, u)) : G.n = u : G.v = u); try { if (f = 2, i) { if (c || (o = "next"), t = i[o]) { if (!(t = t.call(i, u))) throw TypeError("iterator result is not an object"); if (!t.done) return t; u = t.value, c < 2 && (c = 0); } else 1 === c && (t = i.return) && t.call(i), c < 2 && (u = TypeError("The iterator does not provide a '" + o + "' method"), c = 1); i = e; } else if ((t = (y = G.n < 0) ? u : r.call(n, G)) !== a) break; } catch (t) { i = e, c = 1, u = t; } finally { f = 1; } } return { value: t, done: y }; }; }(r, o, i), !0), u; } var a = {}; function Generator() {} function GeneratorFunction() {} function GeneratorFunctionPrototype() {} t = Object.getPrototypeOf; var c = [][n] ? t(t([][n]())) : (_regeneratorDefine2(t = {}, n, function () { return this; }), t), u = GeneratorFunctionPrototype.prototype = Generator.prototype = Object.create(c); function f(e) { return Object.setPrototypeOf ? Object.setPrototypeOf(e, GeneratorFunctionPrototype) : (e.__proto__ = GeneratorFunctionPrototype, _regeneratorDefine2(e, o, "GeneratorFunction")), e.prototype = Object.create(u), e; } return GeneratorFunction.prototype = GeneratorFunctionPrototype, _regeneratorDefine2(u, "constructor", GeneratorFunctionPrototype), _regeneratorDefine2(GeneratorFunctionPrototype, "constructor", GeneratorFunction), GeneratorFunction.displayName = "GeneratorFunction", _regeneratorDefine2(GeneratorFunctionPrototype, o, "GeneratorFunction"), _regeneratorDefine2(u), _regeneratorDefine2(u, o, "Generator"), _regeneratorDefine2(u, n, function () { return this; }), _regeneratorDefine2(u, "toString", function () { return "[object Generator]"; }), (_regenerator = function _regenerator() { return { w: i, m: f }; })(); }
function _regeneratorDefine2(e, r, n, t) { var i = Object.defineProperty; try { i({}, "", {}); } catch (e) { i = 0; } _regeneratorDefine2 = function _regeneratorDefine(e, r, n, t) { function o(r, n) { _regeneratorDefine2(e, r, function (e) { return this._invoke(r, n, e); }); } r ? i ? i(e, r, { value: n, enumerable: !t, configurable: !t, writable: !t }) : e[r] = n : (o("next", 0), o("throw", 1), o("return", 2)); }, _regeneratorDefine2(e, r, n, t); }
function asyncGeneratorStep(n, t, e, r, o, a, c) { try { var i = n[a](c), u = i.value; } catch (n) { return void e(n); } i.done ? t(u) : Promise.resolve(u).then(r, o); }
function _asyncToGenerator(n) { return function () { var t = this, e = arguments; return new Promise(function (r, o) { var a = n.apply(t, e); function _next(n) { asyncGeneratorStep(a, r, o, _next, _throw, "next", n); } function _throw(n) { asyncGeneratorStep(a, r, o, _next, _throw, "throw", n); } _next(void 0); }); }; }
function _defineProperty(e, r, t) { return (r = _toPropertyKey(r)) in e ? Object.defineProperty(e, r, { value: t, enumerable: !0, configurable: !0, writable: !0 }) : e[r] = t, e; }
function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == typeof i ? i : i + ""; }
function _toPrimitive(t, r) { if ("object" != typeof t || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != typeof i) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); } /**
 * Client for communicating with the Dash WebSocket SharedWorker.
 */
/** Message types for worker communication */
var WorkerMessageType = exports.WorkerMessageType = /*#__PURE__*/function (WorkerMessageType) {
  WorkerMessageType["CONNECT"] = "connect";
  WorkerMessageType["DISCONNECT"] = "disconnect";
  WorkerMessageType["CALLBACK_REQUEST"] = "callback_request";
  WorkerMessageType["GET_PROPS_RESPONSE"] = "get_props_response";
  WorkerMessageType["TAB_VISIBLE"] = "tab_visible";
  WorkerMessageType["CONNECTED"] = "connected";
  WorkerMessageType["DISCONNECTED"] = "disconnected";
  WorkerMessageType["CALLBACK_RESPONSE"] = "callback_response";
  WorkerMessageType["SET_PROPS"] = "set_props";
  WorkerMessageType["SET_PROPS_BATCH"] = "set_props_batch";
  WorkerMessageType["GET_PROPS_REQUEST"] = "get_props_request";
  WorkerMessageType["ERROR"] = "error";
  return WorkerMessageType;
}({});
/** Callback response structure */
/** Set props message payload */
/** Get props request payload */
/** Pending callback request */
/**
 * Client for the Dash WebSocket SharedWorker.
 */
class WorkerClient {
  constructor() {
    _defineProperty(this, "worker", null);
    _defineProperty(this, "rendererId", void 0);
    _defineProperty(this, "pendingCallbacks", new Map());
    _defineProperty(this, "requestCounter", 0);
    _defineProperty(this, "isConnected", false);
    _defineProperty(this, "connectionPromise", null);
    _defineProperty(this, "connectionResolve", null);
    /** Callback when SET_PROPS message is received */
    _defineProperty(this, "onSetProps", null);
    /** Callback when SET_PROPS_BATCH message is received */
    _defineProperty(this, "onSetPropsBatch", null);
    /** Callback when GET_PROPS_REQUEST message is received */
    _defineProperty(this, "onGetPropsRequest", null);
    /** Callback when connection is established */
    _defineProperty(this, "onConnected", null);
    /** Callback when connection is lost */
    _defineProperty(this, "onDisconnected", null);
    /** Callback when an error occurs */
    _defineProperty(this, "onError", null);
    this.rendererId = (0, _rendererId.getRendererId)();
  }

  /**
   * Initialize the worker connection.
   * @param workerUrl URL to the SharedWorker script
   * @param serverUrl WebSocket server URL
   * @param inactivityTimeout Optional inactivity timeout in ms
   * @param heartbeatInterval Optional heartbeat interval in ms
   */
  connect(workerUrl, serverUrl, inactivityTimeout, heartbeatInterval) {
    var _this = this;
    return _asyncToGenerator(/*#__PURE__*/_regenerator().m(function _callee() {
      return _regenerator().w(function (_context) {
        while (1) switch (_context.n) {
          case 0:
            if (!_this.worker) {
              _context.n = 1;
              break;
            }
            return _context.a(2);
          case 1:
            // Create the SharedWorker
            _this.worker = new SharedWorker(workerUrl, {
              name: 'dash-ws-worker'
            });

            // Set up message handling
            _this.worker.port.onmessage = _this.handleMessage.bind(_this);

            // Create promise for connection
            _this.connectionPromise = new Promise(resolve => {
              _this.connectionResolve = resolve;
            });

            // Start the port
            _this.worker.port.start();

            // Send connect message
            _this.worker.port.postMessage({
              type: WorkerMessageType.CONNECT,
              rendererId: _this.rendererId,
              payload: {
                serverUrl,
                inactivityTimeout,
                heartbeatInterval
              }
            });

            // Wait for connection
            _context.n = 2;
            return _this.connectionPromise;
          case 2:
            return _context.a(2);
        }
      }, _callee);
    }))();
  }

  /**
   * Disconnect from the worker.
   */
  disconnect() {
    if (this.worker) {
      this.worker.port.postMessage({
        type: WorkerMessageType.DISCONNECT,
        rendererId: this.rendererId
      });
      this.worker.port.close();
      this.worker = null;
    }
    this.isConnected = false;
    this.connectionPromise = null;
    this.connectionResolve = null;

    // Resolve pending callbacks with prevent_update so loading states clear
    var _iterator = _createForOfIteratorHelper(this.pendingCallbacks),
      _step;
    try {
      for (_iterator.s(); !(_step = _iterator.n()).done;) {
        var _step$value = _slicedToArray(_step.value, 2),
          pending = _step$value[1];
        pending.resolve({
          status: 'prevent_update'
        });
      }
    } catch (err) {
      _iterator.e(err);
    } finally {
      _iterator.f();
    }
    this.pendingCallbacks.clear();
  }

  /**
   * Ensure the worker is connected, initiating connection if needed.
   * @param config The Dash config with websocket settings
   */
  ensureConnected(config) {
    var _this2 = this;
    return _asyncToGenerator(/*#__PURE__*/_regenerator().m(function _callee2() {
      var _config$websocket, _config$websocket2;
      var wsProtocol, host, wsUrl;
      return _regenerator().w(function (_context2) {
        while (1) switch (_context2.n) {
          case 0:
            if (!_this2.isConnected) {
              _context2.n = 1;
              break;
            }
            return _context2.a(2);
          case 1:
            if (!_this2.connectionPromise) {
              _context2.n = 3;
              break;
            }
            _context2.n = 2;
            return _this2.connectionPromise;
          case 2:
            return _context2.a(2);
          case 3:
            if (!(!((_config$websocket = config.websocket) !== null && _config$websocket !== void 0 && _config$websocket.url) || !((_config$websocket2 = config.websocket) !== null && _config$websocket2 !== void 0 && _config$websocket2.worker_url))) {
              _context2.n = 4;
              break;
            }
            throw new Error('WebSocket config not available');
          case 4:
            if (!(typeof SharedWorker === 'undefined')) {
              _context2.n = 5;
              break;
            }
            throw new Error('SharedWorker not supported');
          case 5:
            // Build WebSocket URL
            wsProtocol = window.location.protocol === 'https:' ? 'wss:' : 'ws:';
            host = window.location.host;
            wsUrl = "".concat(wsProtocol, "//").concat(host).concat(config.websocket.url);
            _context2.n = 6;
            return _this2.connect(config.websocket.worker_url, wsUrl, config.websocket.inactivity_timeout, config.websocket.heartbeat_interval);
          case 6:
            return _context2.a(2);
        }
      }, _callee2);
    }))();
  }

  /**
   * Send a callback request to the server via the worker.
   * @param payload The callback payload
   * @returns Promise that resolves with the callback response
   */
  sendCallback(payload) {
    var _this3 = this;
    return _asyncToGenerator(/*#__PURE__*/_regenerator().m(function _callee3() {
      var requestId;
      return _regenerator().w(function (_context3) {
        while (1) switch (_context3.n) {
          case 0:
            if (!(_this3.connectionPromise && !_this3.isConnected)) {
              _context3.n = 1;
              break;
            }
            _context3.n = 1;
            return _this3.connectionPromise;
          case 1:
            if (_this3.worker) {
              _context3.n = 2;
              break;
            }
            throw new Error('Worker not connected');
          case 2:
            requestId = "".concat(_this3.rendererId, "-").concat(++_this3.requestCounter);
            return _context3.a(2, new Promise((resolve, reject) => {
              _this3.pendingCallbacks.set(requestId, {
                resolve,
                reject
              });
              _this3.worker.port.postMessage({
                type: WorkerMessageType.CALLBACK_REQUEST,
                rendererId: _this3.rendererId,
                requestId,
                payload
              });
            }));
        }
      }, _callee3);
    }))();
  }

  /**
   * Send a get_props response back to the server.
   * @param requestId The request ID from the get_props request
   * @param props The property values
   */
  sendGetPropsResponse(requestId, props) {
    if (!this.worker || !this.isConnected) {
      return;
    }
    this.worker.port.postMessage({
      type: WorkerMessageType.GET_PROPS_RESPONSE,
      rendererId: this.rendererId,
      requestId,
      payload: props
    });
  }

  /**
   * Check if the worker is connected.
   */
  get connected() {
    return this.isConnected;
  }

  /**
   * Notify the worker that the tab is now visible.
   * This resets the inactivity timer to prevent timeout while user is viewing.
   */
  notifyTabVisible() {
    if (this.worker && this.isConnected) {
      this.worker.port.postMessage({
        type: WorkerMessageType.TAB_VISIBLE,
        rendererId: this.rendererId
      });
    }
  }
  handleMessage(event) {
    var message = event.data;
    switch (message.type) {
      case WorkerMessageType.CONNECTED:
        this.isConnected = true;
        if (this.connectionResolve) {
          this.connectionResolve();
          this.connectionResolve = null;
        }
        if (this.onConnected) {
          this.onConnected();
        }
        break;
      case WorkerMessageType.DISCONNECTED:
        this.isConnected = false;
        // Resolve pending callbacks with prevent_update so loading states clear
        var _iterator2 = _createForOfIteratorHelper(this.pendingCallbacks),
          _step2;
        try {
          for (_iterator2.s(); !(_step2 = _iterator2.n()).done;) {
            var _step2$value = _slicedToArray(_step2.value, 2),
              pending = _step2$value[1];
            pending.resolve({
              status: 'prevent_update'
            });
          }
        } catch (err) {
          _iterator2.e(err);
        } finally {
          _iterator2.f();
        }
        this.pendingCallbacks.clear();
        if (this.onDisconnected) {
          var _message$payload;
          this.onDisconnected((_message$payload = message.payload) === null || _message$payload === void 0 ? void 0 : _message$payload.reason);
        }
        break;
      case WorkerMessageType.CALLBACK_RESPONSE:
        {
          var requestId = message.requestId;
          var _pending = this.pendingCallbacks.get(requestId);
          if (_pending) {
            this.pendingCallbacks.delete(requestId);
            _pending.resolve(message.payload);
          }
          break;
        }
      case WorkerMessageType.SET_PROPS:
        if (this.onSetProps) {
          this.onSetProps(message.payload);
        }
        break;
      case WorkerMessageType.SET_PROPS_BATCH:
        if (this.onSetPropsBatch) {
          this.onSetPropsBatch(message.payload);
        }
        break;
      case WorkerMessageType.GET_PROPS_REQUEST:
        if (this.onGetPropsRequest) {
          this.onGetPropsRequest(message.requestId, message.payload);
        }
        break;
      case WorkerMessageType.ERROR:
        if (this.onError) {
          var _message$payload2, _message$payload3;
          this.onError(((_message$payload2 = message.payload) === null || _message$payload2 === void 0 ? void 0 : _message$payload2.message) || 'Unknown error', (_message$payload3 = message.payload) === null || _message$payload3 === void 0 ? void 0 : _message$payload3.code);
        }
        break;
    }
  }
}

// Singleton instance
var workerClientInstance = null;

/**
 * Get the singleton WorkerClient instance.
 */
function getWorkerClient() {
  if (!workerClientInstance) {
    workerClientInstance = new WorkerClient();
  }
  return workerClientInstance;
}

/**
 * Check if WebSocket callbacks are globally enabled and supported.
 * @param config The Dash config
 */
function isWebSocketEnabled(config) {
  var _config$websocket3;
  return !!((_config$websocket3 = config.websocket) !== null && _config$websocket3 !== void 0 && _config$websocket3.enabled && typeof SharedWorker !== 'undefined');
}

/**
 * Check if WebSocket infrastructure is available (for per-callback websocket).
 * @param config The Dash config
 */
function isWebSocketAvailable(config) {
  var _config$websocket4, _config$websocket5;
  return !!((_config$websocket4 = config.websocket) !== null && _config$websocket4 !== void 0 && _config$websocket4.url && (_config$websocket5 = config.websocket) !== null && _config$websocket5 !== void 0 && _config$websocket5.worker_url && typeof SharedWorker !== 'undefined');
}