dash-renderer
Version:
render dash components in react
504 lines (488 loc) • 22.4 kB
JavaScript
;
Object.defineProperty(exports, "__esModule", {
value: true
});
exports.CallbackGraphContainer = void 0;
var _react = _interopRequireWildcard(require("react"));
var _propTypes = _interopRequireDefault(require("prop-types"));
var _reactRedux = require("react-redux");
var _cytoscape = _interopRequireDefault(require("cytoscape"));
var _reactCytoscapejs = _interopRequireDefault(require("react-cytoscapejs"));
var _cytoscapeDagre = _interopRequireDefault(require("cytoscape-dagre"));
var _cytoscapeFcose = _interopRequireDefault(require("cytoscape-fcose"));
var _reactJsonTree = require("react-json-tree");
var _ramda = require("ramda");
var _paths = require("../../../actions/paths");
var _dependencies = require("../../../actions/dependencies");
var _actions = require("../../../actions");
require("./CallbackGraphContainer.css");
var _CallbackGraphContainerStylesheet = _interopRequireDefault(require("./CallbackGraphContainerStylesheet"));
var _CallbackGraphEffects = require("./CallbackGraphEffects");
function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
function _interopRequireWildcard(e, t) { if ("function" == typeof WeakMap) var r = new WeakMap(), n = new WeakMap(); return (_interopRequireWildcard = function _interopRequireWildcard(e, t) { if (!t && e && e.__esModule) return e; var o, i, f = { __proto__: null, default: e }; if (null === e || "object" != _typeof(e) && "function" != typeof e) return f; if (o = t ? n : r) { if (o.has(e)) return o.get(e); o.set(e, f); } for (var _t in e) "default" !== _t && {}.hasOwnProperty.call(e, _t) && ((i = (o = Object.defineProperty) && Object.getOwnPropertyDescriptor(e, _t)) && (i.get || i.set) ? o(f, _t, i) : f[_t] = e[_t]); return f; })(e, t); }
function _classCallCheck(a, n) { if (!(a instanceof n)) throw new TypeError("Cannot call a class as a function"); }
function _defineProperties(e, r) { for (var t = 0; t < r.length; t++) { var o = r[t]; o.enumerable = o.enumerable || !1, o.configurable = !0, "value" in o && (o.writable = !0), Object.defineProperty(e, _toPropertyKey(o.key), o); } }
function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r), t && _defineProperties(e, t), Object.defineProperty(e, "prototype", { writable: !1 }), e; }
function _callSuper(t, o, e) { return o = _getPrototypeOf(o), _possibleConstructorReturn(t, _isNativeReflectConstruct() ? Reflect.construct(o, e || [], _getPrototypeOf(t).constructor) : o.apply(t, e)); }
function _possibleConstructorReturn(t, e) { if (e && ("object" == _typeof(e) || "function" == typeof e)) return e; if (void 0 !== e) throw new TypeError("Derived constructors may only return object or undefined"); return _assertThisInitialized(t); }
function _assertThisInitialized(e) { if (void 0 === e) throw new ReferenceError("this hasn't been initialised - super() hasn't been called"); return e; }
function _isNativeReflectConstruct() { try { var t = !Boolean.prototype.valueOf.call(Reflect.construct(Boolean, [], function () {})); } catch (t) {} return (_isNativeReflectConstruct = function _isNativeReflectConstruct() { return !!t; })(); }
function _getPrototypeOf(t) { return _getPrototypeOf = Object.setPrototypeOf ? Object.getPrototypeOf.bind() : function (t) { return t.__proto__ || Object.getPrototypeOf(t); }, _getPrototypeOf(t); }
function _inherits(t, e) { if ("function" != typeof e && null !== e) throw new TypeError("Super expression must either be null or a function"); t.prototype = Object.create(e && e.prototype, { constructor: { value: t, writable: !0, configurable: !0 } }), Object.defineProperty(t, "prototype", { writable: !1 }), e && _setPrototypeOf(t, e); }
function _setPrototypeOf(t, e) { return _setPrototypeOf = Object.setPrototypeOf ? Object.setPrototypeOf.bind() : function (t, e) { return t.__proto__ = e, t; }, _setPrototypeOf(t, e); }
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 _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 _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 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 _typeof(o) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (o) { return typeof o; } : function (o) { return o && "function" == typeof Symbol && o.constructor === Symbol && o !== Symbol.prototype ? "symbol" : typeof o; }, _typeof(o); }
_cytoscape.default.use(_cytoscapeDagre.default);
_cytoscape.default.use(_cytoscapeFcose.default);
/*
* Generates all the elements (nodes, edges) for the dependency graph.
*/
function generateElements(graphs, profile, extraLinks) {
var consumed = [];
var elements = [];
var structure = {};
function recordNode(id, rawProperty) {
var property = rawProperty.split('@')[0];
var idStr = (0, _dependencies.stringifyId)(id);
var idType = _typeof(id) === 'object' ? 'wildcard' : 'component';
// dagre layout has problems with eg `width` property - so prepend an X
var parentId = idStr;
var childId = "".concat(parentId, ".X").concat(property);
if (!consumed.includes(parentId)) {
consumed.push(parentId);
elements.push({
data: {
id: parentId,
label: idStr,
type: idType
}
});
structure[parentId] = [];
}
if (!consumed.includes(childId)) {
consumed.push(childId);
elements.push({
data: {
id: childId,
label: property,
parent: parentId,
type: 'property'
}
});
structure[parentId].push(childId);
}
return childId;
}
function recordEdge(source, target, type) {
elements.push({
data: {
source: source,
target: target,
type: type
}
});
}
(graphs.callbacks || []).reduce(function (visibleIndex, callback) {
if (callback.hidden) {
return visibleIndex;
}
var cb = "__dash_callback__.".concat(callback.output);
var cbProfile = profile.callbacks[callback.output] || {};
var count = cbProfile.count || 0;
var time = cbProfile.total || 0;
elements.push({
data: {
id: cb,
label: "callback.".concat(visibleIndex),
type: 'callback',
mode: callback.clientside_function ? 'client' : 'server',
count: count,
time: count > 0 ? Math.round(time / count) : 0,
loadingSet: Date.now(),
errorSet: Date.now()
}
});
callback.outputs.forEach(function (_ref) {
var id = _ref.id,
property = _ref.property;
var nodeId = recordNode(id, property);
recordEdge(cb, nodeId, 'output');
});
callback.inputs.forEach(function (_ref2) {
var id = _ref2.id,
property = _ref2.property;
var nodeId = recordNode(id, property);
recordEdge(nodeId, cb, 'input');
});
callback.state.forEach(function (_ref3) {
var id = _ref3.id,
property = _ref3.property;
var nodeId = recordNode(id, property);
recordEdge(nodeId, cb, 'state');
});
return visibleIndex + 1;
}, 0);
// pull together props in the same component
if (extraLinks) {
(0, _ramda.values)(structure).forEach(function (childIds) {
childIds.forEach(function (childFrom) {
childIds.forEach(function (childTo) {
if (childFrom !== childTo) {
recordEdge(childFrom, childTo, 'hidden');
}
});
});
});
}
return elements;
}
function reduceStatus(status) {
if ((0, _ramda.keys)(status).length === 2) {
return status.latest;
}
return status;
}
function flattenOutputs(res) {
var outputs = {};
for (var idStr in res) {
for (var prop in res[idStr]) {
outputs[idStr + '.' + prop] = res[idStr][prop];
}
}
return outputs;
}
function flattenInputs(inArray, final) {
(inArray || []).forEach(function (inItem) {
if (Array.isArray(inItem)) {
flattenInputs(inItem, final);
} else {
var id = inItem.id,
property = inItem.property,
value = inItem.value;
final[(0, _dependencies.stringifyId)(id) + '.' + property] = value;
}
});
return final;
}
function cleanOutputId(outputId) {
return outputId.replace(/(^\.\.|\.\.$)/g, '').split('...').reduce(function (agg, next) {
return agg.concat(next.replace(/(.*\..*)(@.+)$/, function (a, b) {
return b + ' (Duplicate)';
}));
}, []).join('...');
}
// len('__dash_callback__.')
var cbPrefixLen = 18;
var dagreLayout = {
name: 'dagre',
padding: 10,
ranker: 'tight-tree'
};
var forceLayout = {
name: 'fcose',
padding: 10,
animate: false
};
var layouts = {
'top-down': _objectSpread(_objectSpread({}, dagreLayout), {}, {
spacingFactor: 0.8
}),
'left-right': _objectSpread(_objectSpread({}, dagreLayout), {}, {
nodeSep: 0,
rankSep: 80,
rankDir: 'LR'
}),
force: forceLayout,
'force-loose': forceLayout
};
function CallbackGraph() {
// Grab items from the redux store.
var paths = (0, _reactRedux.useSelector)(function (state) {
return state.paths;
});
var layout = (0, _reactRedux.useSelector)(function (state) {
return state.layout;
});
var graphs = (0, _reactRedux.useSelector)(function (state) {
return state.graphs;
});
var profile = (0, _reactRedux.useSelector)(function (state) {
return state.profile;
});
var changed = (0, _reactRedux.useSelector)(function (state) {
return state.changed;
});
var lifecycleState = (0, _reactRedux.useSelector)(function (state) {
return state.appLifecycle;
});
// Keep track of cytoscape reference and user selected items.
var _useState = (0, _react.useState)(null),
_useState2 = _slicedToArray(_useState, 2),
selected = _useState2[0],
setSelected = _useState2[1];
var _useState3 = (0, _react.useState)(null),
_useState4 = _slicedToArray(_useState3, 2),
cytoscape = _useState4[0],
setCytoscape = _useState4[1];
var graphLayout = profile.graphLayout;
var chosenType = graphLayout === null || graphLayout === void 0 ? void 0 : graphLayout._chosenType;
var layoutSelector = (0, _react.useRef)(null);
var _useState5 = (0, _react.useState)(chosenType || 'top-down'),
_useState6 = _slicedToArray(_useState5, 2),
layoutType = _useState6[0],
setLayoutType = _useState6[1];
// Generate and memoize the elements.
var elements = (0, _react.useMemo)(function () {
return generateElements(graphs, profile, layoutType === 'force');
}, [graphs, layoutType]);
// Custom hook to make sure cytoscape is loaded.
var useCytoscapeEffect = function useCytoscapeEffect(effect, condition) {
(0, _react.useEffect)(function () {
return cytoscape && effect(cytoscape) || undefined;
}, condition);
};
function getComponent(id) {
// for now ignore pattern-matching IDs
// to do better we may need to store the *actual* IDs used for each
// callback invocation, since they need not match what's on the page now.
if (id.charAt(0) === '{') {
hasPatterns = true;
return undefined;
}
var idPath = (0, _paths.getPath)(paths, id);
return idPath ? (0, _ramda.path)(idPath, layout) : undefined;
}
function getPropValue(data) {
var parent = getComponent(data.parent);
return parent ? parent.props[data.label] : undefined;
}
function setPresetLayout(_ref4) {
var _layoutSelector$curre;
var cy = _ref4.cy;
var positions = {};
cy.nodes().each(function (n) {
positions[n.id()] = n.position();
});
// Hack! We're mutating the redux store directly here, rather than
// dispatching an action, because we don't want this to trigger a
// rerender, we just want the layout to persist when the callback graph
// is rerendered - either because there's new profile information to
// display or because the graph was closed and reopened. The latter is
// the reason we're not using component state to store the layout.
profile.graphLayout = {
name: 'preset',
fit: false,
positions,
zoom: cy.zoom(),
pan: cy.pan(),
_chosenType: (_layoutSelector$curre = layoutSelector.current) === null || _layoutSelector$curre === void 0 ? void 0 : _layoutSelector$curre.value
};
}
// Adds callbacks once cyctoscape is initialized.
useCytoscapeEffect(function (cy) {
cytoscape.on('tap', 'node', function (e) {
return setSelected(e.target);
});
cytoscape.on('tap', function (e) {
if (e.target === cy) {
setSelected(null);
}
});
cytoscape.on('zoom', setPresetLayout);
cytoscape.on('pan', setPresetLayout);
cytoscape.nodes().on('position', setPresetLayout);
}, [cytoscape]);
// Set node classes on selected.
useCytoscapeEffect(function (cy) {
return selected && (0, _CallbackGraphEffects.updateSelectedNode)(cy, selected.data().id);
}, [selected]);
// Flash classes when props change. Uses changed as a trigger. Also
// flash all input edges originating from this node and highlight
// the subtree that contains the selected node.
useCytoscapeEffect(function (cy) {
return changed && (0, _CallbackGraphEffects.updateChangedProps)(cy, changed.id, changed.props);
}, [changed]);
// Update callbacks from profiling information.
useCytoscapeEffect(function (cy) {
return profile.updated.forEach(function (cb) {
return (0, _CallbackGraphEffects.updateCallback)(cy, cb, profile.callbacks[cb]);
});
}, [profile.updated]);
if (lifecycleState !== 'HYDRATED') {
// If we get here too early - most likely during hot reloading - then
// we need to bail out and wait for the full state to be available
return /*#__PURE__*/_react.default.createElement("div", {
className: "dash-callback-dag--container"
}, /*#__PURE__*/_react.default.createElement("div", {
className: "dash-callback-dag--message"
}, /*#__PURE__*/_react.default.createElement("div", null, "Waiting for app to be ready...")));
}
// FIXME: Move to a new component?
// Generate the element introspection data.
var elementName = '';
var elementInfo = {};
var hasPatterns = false;
if (selected) {
var data = selected.data();
switch (data.type) {
case 'component':
{
var _getComponent;
var rest = (0, _ramda.omit)(['id'], (_getComponent = getComponent(data.id)) === null || _getComponent === void 0 ? void 0 : _getComponent.props);
elementInfo = rest;
elementName = data.id;
break;
}
case 'property':
{
elementName = data.parent;
elementInfo[data.label] = getPropValue(data);
break;
}
// callback
default:
{
elementInfo.type = data.mode;
// Remove uid and set profile.
var callbackOutputId = data.id.slice(cbPrefixLen);
elementName = cleanOutputId(callbackOutputId);
var cbProfile = profile.callbacks[callbackOutputId];
if (cbProfile) {
var count = cbProfile.count,
status = cbProfile.status,
network = cbProfile.network,
resources = cbProfile.resources,
total = cbProfile.total,
compute = cbProfile.compute,
result = cbProfile.result,
inputs = cbProfile.inputs,
state = cbProfile.state;
var avg = function avg(v) {
return Math.round(v / (count || 1));
};
elementInfo['call count'] = count;
elementInfo.status = reduceStatus(status);
var timing = elementInfo['time (avg milliseconds)'] = {
total: avg(total),
compute: avg(compute)
};
if (data.mode === 'server') {
timing.network = avg(network.time);
elementInfo['data transfer (avg bytes)'] = {
download: avg(network.download),
upload: avg(network.upload)
};
}
for (var key in resources) {
timing['user: ' + key] = avg(resources[key]);
}
elementInfo.outputs = flattenOutputs(result);
elementInfo.inputs = flattenInputs(inputs, {});
elementInfo.state = flattenInputs(state, {});
} else {
elementInfo['call count'] = 0;
}
}
}
}
var cyLayout = chosenType === layoutType ? graphLayout : (0, _ramda.mergeRight)(layouts[layoutType], {
ready: setPresetLayout
});
return /*#__PURE__*/_react.default.createElement("div", {
className: "dash-callback-dag--container"
}, /*#__PURE__*/_react.default.createElement(_reactCytoscapejs.default, {
style: {
width: '100%',
height: '100%'
},
cy: setCytoscape,
elements: elements,
layout: cyLayout,
stylesheet: _CallbackGraphContainerStylesheet.default
}), selected ? /*#__PURE__*/_react.default.createElement("div", {
className: "dash-callback-dag--info"
}, hasPatterns ? /*#__PURE__*/_react.default.createElement("div", null, "Info isn't supported for pattern-matching IDs at this time") : null, /*#__PURE__*/_react.default.createElement(_reactJsonTree.JSONTree, {
data: elementInfo,
theme: "summerfruit",
labelRenderer: function labelRenderer(_keys) {
return _keys.length === 1 ? elementName : _keys[0];
},
getItemString: function getItemString(type, data, itemType) {
return /*#__PURE__*/_react.default.createElement("span", null, itemType);
},
shouldExpandNode: function shouldExpandNode(keyName, data, level) {
return level < 1;
}
})) : null, /*#__PURE__*/_react.default.createElement("select", {
className: "dash-callback-dag--layoutSelector",
onChange: function onChange(e) {
return setLayoutType(e.target.value);
},
value: layoutType,
ref: layoutSelector
}, (0, _ramda.keys)(layouts).map(function (k) {
return /*#__PURE__*/_react.default.createElement("option", {
value: k,
key: k
}, k);
})));
}
CallbackGraph.propTypes = {};
var UnconnectedCallbackGraphContainer = /*#__PURE__*/function (_Component) {
function UnconnectedCallbackGraphContainer(props) {
var _this;
_classCallCheck(this, UnconnectedCallbackGraphContainer);
_this = _callSuper(this, UnconnectedCallbackGraphContainer, [props]);
_this.state = {
hasError: false
};
return _this;
}
_inherits(UnconnectedCallbackGraphContainer, _Component);
return _createClass(UnconnectedCallbackGraphContainer, [{
key: "componentDidCatch",
value: function componentDidCatch(error, info) {
var dispatch = this.props.dispatch;
dispatch((0, _actions.onError)({
myID: this.state.myID,
type: 'frontEnd',
error,
info
}));
}
}, {
key: "render",
value: function render() {
return this.state.hasError ? /*#__PURE__*/_react.default.createElement("div", {
className: "dash-callback-dag--container"
}, /*#__PURE__*/_react.default.createElement("div", {
className: "dash-callback-dag--message"
}, /*#__PURE__*/_react.default.createElement("div", null, "Oops! The callback graph threw an error."), /*#__PURE__*/_react.default.createElement("div", null, "Check the error list for details."))) : /*#__PURE__*/_react.default.createElement(CallbackGraph, null);
}
}], [{
key: "getDerivedStateFromError",
value: function getDerivedStateFromError(_) {
return {
hasError: true
};
}
}]);
}(_react.Component);
UnconnectedCallbackGraphContainer.propTypes = {
dispatch: _propTypes.default.func
};
var CallbackGraphContainer = exports.CallbackGraphContainer = (0, _reactRedux.connect)(null, function (dispatch) {
return {
dispatch
};
})(UnconnectedCallbackGraphContainer);