dash-renderer
Version:
render dash components in react
268 lines (252 loc) • 17.1 kB
JavaScript
;
Object.defineProperty(exports, "__esModule", {
value: true
});
exports.disconnectWebSocket = disconnectWebSocket;
exports.initializeWebSocket = initializeWebSocket;
var _ramda = require("ramda");
var _actions = require("../actions");
var _patch = require("../actions/patch");
var _paths = require("../actions/paths");
var _reactRedux = require("react-redux");
var _workerClient = require("../utils/workerClient");
var _callbacks = require("../actions/callbacks");
var _dependencies_ts = require("../actions/dependencies_ts");
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 _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 ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
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); }
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); }); }; } /**
* Observer for handling incoming WebSocket messages (SET_PROPS, GET_PROPS_REQUEST).
*/ /* eslint-disable no-console */
/**
* Parse a component ID that may be a stringified JSON object.
* This handles dict IDs like '{"index":0,"type":"output"}' that need
* to be parsed back to objects for getPath to work correctly.
*/
function parseComponentId(componentId) {
if (componentId.startsWith('{') && componentId.endsWith('}')) {
try {
return JSON.parse(componentId);
} catch (_unused) {
// Not valid JSON, return as-is
return componentId;
}
}
return componentId;
}
/**
* Initialize the WebSocket observer.
*
* Sets up handlers for:
* - SET_PROPS: Update component props when received from server
* - GET_PROPS_REQUEST: Send current prop values back to server
*
* @param store Redux store
* @param config Dash configuration
*/
function initializeWebSocket(_x, _x2) {
return _initializeWebSocket.apply(this, arguments);
}
/**
* Build the WebSocket URL from config.
*/
function _initializeWebSocket() {
_initializeWebSocket = _asyncToGenerator(/*#__PURE__*/_regenerator().m(function _callee(store, config) {
var _config$websocket2, _config$websocket3;
var wsAvailable, workerClient, processSetProps, wasDisconnected, wsUrl, _t;
return _regenerator().w(function (_context) {
while (1) switch (_context.p = _context.n) {
case 0:
// Initialize WebSocket if:
// 1. Global websocket is enabled, OR
// 2. WebSocket config is available (for per-callback websocket=True)
wsAvailable = !!((_config$websocket2 = config.websocket) !== null && _config$websocket2 !== void 0 && _config$websocket2.url && (_config$websocket3 = config.websocket) !== null && _config$websocket3 !== void 0 && _config$websocket3.worker_url);
if (wsAvailable) {
_context.n = 1;
break;
}
return _context.a(2);
case 1:
if (!(typeof SharedWorker === 'undefined')) {
_context.n = 2;
break;
}
console.warn('SharedWorker not supported in this browser. ' + 'WebSocket callbacks will fall back to HTTP.');
return _context.a(2);
case 2:
workerClient = (0, _workerClient.getWorkerClient)(); // Helper to process a single set_props payload
processSetProps = payload => {
var componentId = payload.componentId,
rawProps = payload.props;
var parsedId = parseComponentId(componentId);
var state = store.getState();
var componentPath = (0, _paths.getPath)(state.paths, parsedId);
if (!componentPath) {
console.warn("SET_PROPS: Component ".concat(componentId, " not found in layout"));
return;
}
// Get old component for Patch processing and path recomputation
var oldComponent = (0, _ramda.path)(componentPath, state.layout);
var oldProps = (oldComponent === null || oldComponent === void 0 ? void 0 : oldComponent.props) || {};
// Process props to handle Patch objects
var processedProps = (0, _patch.parsePatchProps)(rawProps, oldProps);
// Update the component props
store.dispatch((0, _actions.updateProps)({
props: processedProps,
itempath: componentPath,
renderType: 'websocket'
}));
// Notify observers
store.dispatch((0, _actions.notifyObservers)({
id: parsedId,
props: processedProps
}));
// Recompute paths for any new child components
if (oldComponent) {
var updatedState = store.getState();
store.dispatch((0, _actions.setPaths)((0, _paths.computePaths)(_objectSpread(_objectSpread({}, oldComponent), {}, {
props: _objectSpread(_objectSpread({}, oldProps), processedProps)
}), [...componentPath], updatedState.paths, updatedState.paths.events)));
}
}; // Handle single SET_PROPS message
workerClient.onSetProps = processSetProps;
// Handle batched SET_PROPS_BATCH message
workerClient.onSetPropsBatch = payloads => {
(0, _reactRedux.batch)(() => {
var _iterator = _createForOfIteratorHelper(payloads),
_step;
try {
for (_iterator.s(); !(_step = _iterator.n()).done;) {
var payload = _step.value;
processSetProps(payload);
}
} catch (err) {
_iterator.e(err);
} finally {
_iterator.f();
}
});
};
// Handle GET_PROPS_REQUEST messages
workerClient.onGetPropsRequest = (requestId, payload) => {
var componentId = payload.componentId,
properties = payload.properties;
var parsedId = parseComponentId(componentId);
var state = store.getState();
var componentPath = (0, _paths.getPath)(state.paths, parsedId);
var result = {};
if (componentPath) {
var componentProps = (0, _ramda.path)([...componentPath, 'props'], state.layout);
if (componentProps) {
var _iterator2 = _createForOfIteratorHelper(properties),
_step2;
try {
for (_iterator2.s(); !(_step2 = _iterator2.n()).done;) {
var propName = _step2.value;
result[propName] = componentProps[propName];
}
} catch (err) {
_iterator2.e(err);
} finally {
_iterator2.f();
}
}
} else {
console.warn("GET_PROPS_REQUEST: Component ".concat(componentId, " not found in layout"));
}
// Send the response
workerClient.sendGetPropsResponse(requestId, result);
};
// Track connection state for reconnection handling
wasDisconnected = false; // Handle connection events
workerClient.onConnected = () => {
console.log('[Dash] WebSocket connected');
// On reconnect (not initial connect), re-trigger persistent callbacks
if (wasDisconnected) {
console.log('[Dash] Reconnected - re-triggering persistent callbacks');
var state = store.getState();
var graphs = state.graphs;
if (graphs !== null && graphs !== void 0 && graphs.callbacks) {
var persistentCallbacks = graphs.callbacks.reduce((acc, cb) => {
// Only re-trigger no-output callbacks with no inputs
// These are the "persistent" callbacks that should restart
if (cb.noOutput && cb.inputs.length === 0) {
var resolved = (0, _dependencies_ts.makeResolvedCallback)(cb, (0, _dependencies_ts.resolveDeps)(), '');
resolved.initialCall = true;
acc.push(resolved);
}
return acc;
}, []);
if (persistentCallbacks.length > 0) {
console.log("[Dash] Re-triggering ".concat(persistentCallbacks.length, " persistent callback(s)"));
store.dispatch((0, _callbacks.addRequestedCallbacks)(persistentCallbacks));
}
}
}
};
workerClient.onDisconnected = reason => {
console.log("[Dash] WebSocket disconnected: ".concat(reason));
wasDisconnected = true;
};
workerClient.onError = (message, code) => {
console.error("[Dash] WebSocket error: ".concat(message), code);
};
// Connect to the worker
wsUrl = buildWebSocketUrl(config);
_context.p = 3;
_context.n = 4;
return workerClient.connect(config.websocket.worker_url, wsUrl, config.websocket.inactivity_timeout);
case 4:
_context.n = 6;
break;
case 5:
_context.p = 5;
_t = _context.v;
console.error('[Dash] Failed to connect to WebSocket worker:', _t);
case 6:
// Handle tab visibility changes
document.addEventListener('visibilitychange', () => {
if (document.visibilityState === 'visible') {
if (workerClient.connected) {
// Tab visible and connected - reset inactivity timer
workerClient.notifyTabVisible();
} else {
// Tab visible but disconnected - reconnect
console.log('[Dash] Tab visible, reconnecting WebSocket...');
workerClient.ensureConnected(config).catch(err => console.error('[Dash] Failed to reconnect:', err));
}
}
});
case 7:
return _context.a(2);
}
}, _callee, null, [[3, 5]]);
}));
return _initializeWebSocket.apply(this, arguments);
}
function buildWebSocketUrl(config) {
var _config$websocket;
if (!((_config$websocket = config.websocket) !== null && _config$websocket !== void 0 && _config$websocket.url)) {
throw new Error('WebSocket URL not configured');
}
// Convert HTTP(S) URL to WS(S)
var wsProtocol = window.location.protocol === 'https:' ? 'wss:' : 'ws:';
var host = window.location.host;
// The config.websocket.url is a path like "/_dash-ws-callback"
return "".concat(wsProtocol, "//").concat(host).concat(config.websocket.url);
}
/**
* Disconnect from the WebSocket.
*/
function disconnectWebSocket() {
var workerClient = (0, _workerClient.getWorkerClient)();
workerClient.disconnect();
}