@spider-analyzer/timeline 5.0.6 → 5.0.9

package/CHANGELOG.md

@@ -1,3 +1,39 @@
+## 5.0.9
+
+- Perf: cursor edge now tracks the pointer during drag/resize/draw, as
+  it did in the pre-hooks class component. Drag/resize hot paths
+  (`moveTimeLine`, `onDragCursor`, `onResizeLeftCursor`,
+  `onResizeRightCursor`, `onDrawCursor`) commit state via a
+  `flushSync`-wrapped `patchStateSync`. React 18 otherwise batches
+  updates from d3-drag's native listeners to its scheduler, adding ~1
+  frame of latency between pointer and cursor border. Also wrapped
+  `Histogram`, `XAxis`, `XGrid` in `React.memo` so the synchronous
+  per-event render only reconciles the Cursor subtree; heavy
+  histogram/axis/grid trees are skipped when only `start`/`stop`
+  change.
+
+## 5.0.8
+
+- Perf: memoize the per-render histogram bar list and vertical scale.
+  Previously every cursor drag / resize / draw event (60×/sec) rebuilt
+  the entire bar list (~550 bars in Network-View's default view) from
+  scratch. Under the Luxon-backed shim each rebuild allocated 550 new
+  DateTime/MomentLike objects and re-ran d3's time scale — ~150 ms per
+  render, i.e. ≈6 fps drag. Wrap `prepareHistogram` and
+  `prepareVerticalScale` with `useMemo` keyed on the actual dependencies
+  (`domain`, `histoWidth`, `histo`) so they only recompute when those
+  change. Cursor drag returns to single-digit-ms render time.
+
+## 5.0.7
+
+- Fix: silence the `Invalid prop 'time' of type '_MomentLike', expected
+  instance of 'moment2'` React warnings that internal components
+  (Histogram, Cursor, XAxis, QualityLine, DragOverlay, CursorSelection,
+  HistoToolTip) emitted under every render. The Luxon-backed moment
+  shim is a factory function, not a class, so `PropTypes.instanceOf` is
+  the wrong check. Replaced with a `momentType` validator that uses
+  `moment.isMoment()`. No runtime behavior change — warnings only.
+
 ## 5.0.6
 
 - Fix: don't issue the first `onLoadHisto` with a stale `intervalMs`

package/dist/index.js

@@ -3,6 +3,7 @@
 Object.defineProperty(exports, '__esModule', { value: true });
 
 var react = require('react');
+var reactDom = require('react-dom');
 var luxon = require('luxon');
 var d3Scale = require('d3-scale');
 var PropTypes11 = require('prop-types');
@@ -172,6 +173,25 @@ moment.tz = (x, zone) => {
   const base = toDT(x);
   return new MomentLike(base.setZone(zone));
 };
+function validate(props, propName, componentName) {
+  const v = props[propName];
+  if (v == null) return null;
+  if (moment.isMoment(v)) return null;
+  return new Error(
+    `Invalid prop \`${propName}\` supplied to \`${componentName}\`, expected a moment-like object.`
+  );
+}
+var required = (props, propName, componentName) => {
+  const v = props[propName];
+  if (v == null) {
+    return new Error(
+      `The prop \`${propName}\` is marked as required in \`${componentName}\`, but its value is \`${v}\`.`
+    );
+  }
+  return validate(props, propName, componentName);
+};
+var momentType = validate;
+momentType.isRequired = required;
 var moment_shim_default = moment;
 
 // src/utils.ts
@@ -375,8 +395,8 @@ DragOverlay.propTypes = {
   width: PropTypes11__default.default.number.isRequired,
   marginBottom: PropTypes11__default.default.number,
   items: PropTypes11__default.default.arrayOf(PropTypes11__default.default.shape({
-    start: PropTypes11__default.default.instanceOf(moment_shim_default).isRequired,
-    end: PropTypes11__default.default.instanceOf(moment_shim_default).isRequired,
+    start: momentType.isRequired,
+    end: momentType.isRequired,
     x1: PropTypes11__default.default.number,
     x2: PropTypes11__default.default.number,
     metrics: PropTypes11__default.default.arrayOf(PropTypes11__default.default.number).isRequired,
@@ -686,8 +706,8 @@ CursorSelection.propTypes = {
   showToolTipLeft: PropTypes11__default.default.func.isRequired,
   showToolTipRight: PropTypes11__default.default.func.isRequired,
   items: PropTypes11__default.default.arrayOf(PropTypes11__default.default.shape({
-    start: PropTypes11__default.default.instanceOf(moment_shim_default).isRequired,
-    end: PropTypes11__default.default.instanceOf(moment_shim_default).isRequired,
+    start: momentType.isRequired,
+    end: momentType.isRequired,
     x1: PropTypes11__default.default.number,
     x2: PropTypes11__default.default.number,
     metrics: PropTypes11__default.default.arrayOf(PropTypes11__default.default.number).isRequired,
@@ -1273,8 +1293,8 @@ Cursor.propTypes = {
   overlayHeight: PropTypes11__default.default.number.isRequired,
   overlayWidth: PropTypes11__default.default.number.isRequired,
   items: PropTypes11__default.default.arrayOf(PropTypes11__default.default.shape({
-    start: PropTypes11__default.default.instanceOf(moment_shim_default).isRequired,
-    end: PropTypes11__default.default.instanceOf(moment_shim_default).isRequired,
+    start: momentType.isRequired,
+    end: momentType.isRequired,
     x1: PropTypes11__default.default.number,
     x2: PropTypes11__default.default.number,
     metrics: PropTypes11__default.default.arrayOf(PropTypes11__default.default.number).isRequired,
@@ -1383,8 +1403,8 @@ function Histogram({
 Histogram.propTypes = {
   classes: PropTypes11__default.default.object,
   items: PropTypes11__default.default.arrayOf(PropTypes11__default.default.shape({
-    start: PropTypes11__default.default.instanceOf(moment_shim_default).isRequired,
-    end: PropTypes11__default.default.instanceOf(moment_shim_default).isRequired,
+    start: momentType.isRequired,
+    end: momentType.isRequired,
     x1: PropTypes11__default.default.number,
     x2: PropTypes11__default.default.number,
     metrics: PropTypes11__default.default.arrayOf(PropTypes11__default.default.number).isRequired,
@@ -1410,6 +1430,7 @@ Histogram.propTypes = {
   barHovered: PropTypes11__default.default.number,
   tooltipVisible: PropTypes11__default.default.bool
 };
+var Histogram_default = react.memo(Histogram);
 
 // src/timeLineElements/axesStyles.jsx
 var arrow = `m 0,-5 5,5 -5,5`;
@@ -1484,8 +1505,8 @@ function XAxis({ min, max: max2, origin, axisWidth, marks, xAxis, classes, arrow
 XAxis.propTypes = {
   axisWidth: PropTypes11__default.default.number.isRequired,
   classes: PropTypes11__default.default.object,
-  min: PropTypes11__default.default.instanceOf(moment_shim_default),
-  max: PropTypes11__default.default.instanceOf(moment_shim_default),
+  min: momentType,
+  max: momentType,
   origin: PropTypes11__default.default.shape({
     x: PropTypes11__default.default.number.isRequired,
     y: PropTypes11__default.default.number.isRequired
@@ -1495,6 +1516,7 @@ XAxis.propTypes = {
   arrowPath: PropTypes11__default.default.string,
   onFormatTimeLegend: PropTypes11__default.default.func.isRequired
 };
+var XAxis_default = react.memo(XAxis);
 function YAxis({ classes, marks, yAxis, onFormatMetricLegend, maxHeight, origin, arrowPath = arrow }) {
   const className = (n) => cn(n, classes);
   return /* @__PURE__ */ jsxRuntime.jsxs(
@@ -1810,8 +1832,8 @@ function HistoTooltip({ metricsDefinition, item, onFormatTimeToolTips, onFormatM
 HistoTooltip.propTypes = {
   classes: PropTypes11__default.default.object,
   item: PropTypes11__default.default.shape({
-    start: PropTypes11__default.default.instanceOf(moment_shim_default).isRequired,
-    end: PropTypes11__default.default.instanceOf(moment_shim_default).isRequired,
+    start: momentType.isRequired,
+    end: momentType.isRequired,
     x1: PropTypes11__default.default.number,
     x2: PropTypes11__default.default.number,
     metrics: PropTypes11__default.default.arrayOf(PropTypes11__default.default.number).isRequired,
@@ -1879,7 +1901,7 @@ QualityLine.propTypes = {
   xAxis: PropTypes11__default.default.func.isRequired,
   quality: PropTypes11__default.default.shape({
     items: PropTypes11__default.default.arrayOf(PropTypes11__default.default.shape({
-      time: PropTypes11__default.default.instanceOf(moment_shim_default).isRequired,
+      time: momentType.isRequired,
       quality: PropTypes11__default.default.number.isRequired,
       tip: PropTypes11__default.default.node
     })),
@@ -1949,6 +1971,7 @@ XAxis2.propTypes = {
   xAxis: PropTypes11__default.default.func,
   yAxisHeight: PropTypes11__default.default.number
 };
+var XGrid_default = react.memo(XAxis2);
 
 // src/time.ts
 function toMoment(x, zone) {
@@ -1971,8 +1994,8 @@ function timeSpanToMoments(t, zone) {
   return { start: toMomentOpt(t.start, zone), stop: toMomentOpt(t.stop, zone) };
 }
 var Cursor2 = Cursor;
-var Histogram2 = Histogram;
-var XAxis3 = XAxis;
+var Histogram2 = Histogram_default;
+var XAxis3 = XAxis_default;
 var YAxis3 = YAxis;
 var Legend2 = Legend;
 var Tools2 = Tools;
@@ -2067,6 +2090,11 @@ var TimeLineInner = react.forwardRef(function TimeLine(props, ref) {
   const patchState = react.useCallback((patch) => {
     setStateRaw((s) => ({ ...s, ...typeof patch === "function" ? patch(s) : patch }));
   }, []);
+  const patchStateSync = react.useCallback((patch) => {
+    reactDom.flushSync(() => {
+      setStateRaw((s) => ({ ...s, ...typeof patch === "function" ? patch(s) : patch }));
+    });
+  }, []);
   const checkAndCorrectDomain = react.useCallback(({ domain: domain2 }) => {
     return checkAndCorrectDomainPure({
       domain: domain2,
@@ -2310,9 +2338,9 @@ var TimeLineInner = react.forwardRef(function TimeLine(props, ref) {
         movedSinceLastFetchedRef.current = 0;
         getItems(p, { min, max: max2 });
       }
-      patchState({ domain: { min, max: max2 }, minTime, maxTime, ticks: ticks2 });
+      patchStateSync({ domain: { min, max: max2 }, minTime, maxTime, ticks: ticks2 });
     }
-  }, [moveTimeLineCore, getItems, patchState]);
+  }, [moveTimeLineCore, getItems, patchStateSync]);
   const onResizeLeftCursor = react.useCallback((delta, mouse) => {
     const xAxis = xAxisRef.current;
     const s = stateRef.current;
@@ -2332,9 +2360,9 @@ var TimeLineInner = react.forwardRef(function TimeLine(props, ref) {
     }
     handleAutoSliding(mouse, onResizeLeftCursor);
     if (newStop !== s.stop && newStop.isSameOrBefore(s.domain.max) || newStart.isSameOrAfter(s.domain.min)) {
-      patchState({ start: newStart, stop: newStop, maxTimespan: maxTimespan2 });
+      patchStateSync({ start: newStart, stop: newStop, maxTimespan: maxTimespan2 });
     }
-  }, [handleAutoSliding, patchState]);
+  }, [handleAutoSliding, patchStateSync]);
   const onResizeRightCursor = react.useCallback((delta, mouse) => {
     const xAxis = xAxisRef.current;
     const s = stateRef.current;
@@ -2354,9 +2382,9 @@ var TimeLineInner = react.forwardRef(function TimeLine(props, ref) {
     }
     handleAutoSliding(mouse, onResizeRightCursor);
     if (newStop.isSameOrBefore(s.domain.max) && newStart.isSameOrAfter(s.domain.min)) {
-      patchState({ start: newStart, stop: newStop, maxTimespan: maxTimespan2 });
+      patchStateSync({ start: newStart, stop: newStop, maxTimespan: maxTimespan2 });
     }
-  }, [handleAutoSliding, patchState]);
+  }, [handleAutoSliding, patchStateSync]);
   const onDragCursor = react.useCallback((delta, mouse) => {
     const xAxis = xAxisRef.current;
     const s = stateRef.current;
@@ -2370,8 +2398,8 @@ var TimeLineInner = react.forwardRef(function TimeLine(props, ref) {
     if (maxDomain.min && newStart.isBefore(maxDomain.min)) newStart = moment_shim_default(maxDomain.min);
     if (maxDomain.max && newStop.isAfter(maxDomain.max)) newStop = moment_shim_default(maxDomain.max);
     handleAutoSliding(mouse, onDragCursor);
-    patchState({ start: newStart, stop: newStop });
-  }, [handleAutoSliding, patchState]);
+    patchStateSync({ start: newStart, stop: newStop });
+  }, [handleAutoSliding, patchStateSync]);
   const onStartDrawCursor = react.useCallback((pos) => {
     const xAxis = xAxisRef.current;
     patchState({
@@ -2399,9 +2427,9 @@ var TimeLineInner = react.forwardRef(function TimeLine(props, ref) {
     }
     handleAutoSliding(mouse, onDrawCursor);
     if (newStop.isSameOrBefore(s.domain.max) && newStart.isSameOrAfter(s.domain.min)) {
-      patchState({ start: newStart, stop: newStop, maxTimespan: maxTimespan2 });
+      patchStateSync({ start: newStart, stop: newStop, maxTimespan: maxTimespan2 });
     }
-  }, [handleAutoSliding, patchState]);
+  }, [handleAutoSliding, patchStateSync]);
   const onEndDrawCursor = react.useCallback(() => {
     stopAutoMove();
     const { onCustomRange, selectBarOnClick } = propsRef.current;
@@ -2564,13 +2592,17 @@ var TimeLineInner = react.forwardRef(function TimeLine(props, ref) {
     ticks,
     dragging
   } = state;
+  const verticalScaleData = react.useMemo(() => prepareVerticalScale(), [prepareVerticalScale]);
+  const items = react.useMemo(
+    () => prepareHistogram({ domain, verticalScale: verticalScaleData.verticalScale }),
+    [prepareHistogram, domain, verticalScaleData, histoWidth]
+  );
+  itemsRef.current = items;
   const xAxisHeight = xAxisProp.height || xAxisDefault.height;
   const pointZero = { x: 0, y: height - margin.bottom - xAxisHeight };
   const originCursor = { x: 0, y: margin.top - 5 };
   if (!isFunction(xAxisRef.current)) return null;
-  const { verticalScale, verticalMarks, maxHeight } = prepareVerticalScale();
-  const items = prepareHistogram({ domain, verticalScale });
-  itemsRef.current = items;
+  const { verticalScale, verticalMarks, maxHeight } = verticalScaleData;
   return /* @__PURE__ */ jsxRuntime.jsx(
     "svg",
     {
@@ -2590,7 +2622,7 @@ var TimeLineInner = react.forwardRef(function TimeLine(props, ref) {
           }
         ),
         xAxisProp.showGrid && /* @__PURE__ */ jsxRuntime.jsx(
-          XAxis2,
+          XGrid_default,
           {
             classes,
             origin: pointZero,