@kylincloud/flamegraph 0.35.6

package/src/FlameGraph/FlameGraphComponent/index.tsx

@@ -0,0 +1,411 @@
+// src/FlameGraph/FlameGraphComponent/index.tsx
+/* eslint-disable no-unused-expressions, import/no-extraneous-dependencies */
+import React, { useCallback, useRef } from 'react';
+import clsx from 'clsx';
+import { FontAwesomeIcon } from '@fortawesome/react-fontawesome';
+import { faRedo } from '@fortawesome/free-solid-svg-icons/faRedo';
+import { faCopy } from '@fortawesome/free-solid-svg-icons/faCopy';
+import { faHighlighter } from '@fortawesome/free-solid-svg-icons/faHighlighter';
+import { faCompressAlt } from '@fortawesome/free-solid-svg-icons/faCompressAlt';
+import { MenuItem } from '../../shims/Menu';
+import useResizeObserver from '@react-hook/resize-observer';
+import { Maybe } from 'true-myth';
+import debounce from 'lodash.debounce';
+import { Flamebearer } from '../../models';
+import styles from './canvas.module.css';
+import Flamegraph from './Flamegraph';
+import Highlight from './Highlight';
+import ContextMenuHighlight from './ContextMenuHighlight';
+import FlamegraphTooltip from '../../Tooltip/FlamegraphTooltip';
+import ContextMenu from './ContextMenu';
+import LogoLink from './LogoLink';
+import { SandwichIcon, HeadFirstIcon, TailFirstIcon } from '../../Icons';
+import { PX_PER_LEVEL } from './constants';
+import Header from './Header';
+import { FlamegraphPalette } from './colorPalette';
+import type { ViewTypes } from './viewTypes';
+import { FitModes, HeadMode, TailMode } from '../../fitMode/fitMode';
+import indexStyles from './styles.module.scss';
+import { useFlamegraphI18n } from '../../i18n';
+
+interface FlamegraphProps {
+  flamebearer: Flamebearer;
+  focusedNode: ConstructorParameters<typeof Flamegraph>[2];
+  fitMode: ConstructorParameters<typeof Flamegraph>[3];
+  updateFitMode: (f: FitModes) => void;
+  highlightQuery: ConstructorParameters<typeof Flamegraph>[4];
+  zoom: ConstructorParameters<typeof Flamegraph>[5];
+  showCredit: boolean;
+  selectedItem: Maybe<string>;
+
+  onZoom: (bar: Maybe<{ i: number; j: number }>) => void;
+  onFocusOnNode: (i: number, j: number) => void;
+  setActiveItem: (item: { name: string }) => void;
+  updateView?: (v: ViewTypes) => void;
+
+  onReset: () => void;
+  isDirty: () => boolean;
+
+  ['data-testid']?: string;
+  palette: FlamegraphPalette;
+  setPalette: (p: FlamegraphPalette) => void;
+  toolbarVisible?: boolean;
+  headerVisible?: boolean;
+  disableClick?: boolean;
+  showSingleLevel?: boolean;
+}
+
+export default function FlameGraphComponent(props: FlamegraphProps) {
+  const canvasRef = React.useRef<HTMLCanvasElement>(null);
+  const flamegraph = useRef<Flamegraph>();
+  const i18n = useFlamegraphI18n();
+
+  const [rightClickedNode, setRightClickedNode] = React.useState<
+    Maybe<{ top: number; left: number; width: number }>
+  >(Maybe.nothing());
+
+  const {
+    flamebearer,
+    focusedNode,
+    fitMode,
+    updateFitMode,
+    highlightQuery,
+    zoom,
+    toolbarVisible,
+    headerVisible = true,
+    disableClick = false,
+    showSingleLevel = false,
+    showCredit,
+    setActiveItem,
+    selectedItem,
+    updateView,
+  } = props;
+
+  const { onZoom, onReset, isDirty, onFocusOnNode } = props;
+  const { 'data-testid': dataTestId } = props;
+  const { palette, setPalette } = props;
+
+  const debouncedRenderCanvas = useCallback(
+    debounce(() => {
+      renderCanvas();
+    }, 50),
+    []
+  );
+
+  useResizeObserver(canvasRef, () => {
+    if (flamegraph) {
+      debouncedRenderCanvas();
+    }
+  });
+
+  const onClick = (e: React.MouseEvent<HTMLCanvasElement>) => {
+    const opt = getFlamegraph().xyToBar(
+      e.nativeEvent.offsetX,
+      e.nativeEvent.offsetY
+    );
+
+    opt.match({
+      Nothing: () => {},
+      Just: (bar) => {
+        zoom.match({
+          Nothing: () => {
+            onZoom(opt);
+          },
+          Just: (z) => {
+            if (bar.i === z.i && bar.j === z.j) {
+              onZoom(Maybe.nothing());
+            } else {
+              onZoom(opt);
+            }
+          },
+        });
+      },
+    });
+  };
+
+  const xyToHighlightData = (x: number, y: number) => {
+    const opt = getFlamegraph().xyToBar(x, y);
+
+    return opt.map((bar) => {
+      return {
+        left: getCanvas().offsetLeft + bar.x,
+        top: getCanvas().offsetTop + bar.y,
+        width: bar.width,
+      };
+    });
+  };
+
+  const xyToTooltipData = (x: number, y: number) => {
+    return getFlamegraph().xyToBar(x, y);
+  };
+
+  const onContextMenuClose = () => {
+    setRightClickedNode(Maybe.nothing());
+  };
+
+  const onContextMenuOpen = (x: number, y: number) => {
+    setRightClickedNode(xyToHighlightData(x, y));
+  };
+
+  const xyToContextMenuItems = useCallback(
+    (x: number, y: number) => {
+      const dirty = isDirty();
+      const bar = getFlamegraph().xyToBar(x, y);
+      const barName = bar.isJust ? bar.value.name : '';
+
+      const CollapseItem = () => {
+        const hoveredOnValidNode = bar.mapOrElse(
+          () => false,
+          () => true
+        );
+
+        const onClick = bar.mapOrElse(
+          () => () => {},
+          (f) => onFocusOnNode.bind(null, f.i, f.j)
+        );
+
+        return (
+          <MenuItem
+            key="focus"
+            disabled={!hoveredOnValidNode}
+            onClick={onClick}
+          >
+            <FontAwesomeIcon icon={faCompressAlt} />
+            {i18n.collapseNodesAbove}
+          </MenuItem>
+        );
+      };
+
+      const CopyItem = () => {
+        const onClick = () => {
+          if (!navigator.clipboard) return;
+
+          navigator.clipboard.writeText(barName);
+        };
+
+        return (
+          <MenuItem key="copy" onClick={onClick}>
+            <FontAwesomeIcon icon={faCopy} />
+            {i18n.copyFunctionName}
+          </MenuItem>
+        );
+      };
+
+      const HighlightSimilarNodesItem = () => {
+        const onClick = () => {
+          setActiveItem({ name: barName });
+        };
+
+        const actionName =
+          selectedItem.isJust && selectedItem.value === barName
+            ? i18n.clearHighlight
+            : i18n.highlightSimilarNodes;
+
+        return (
+          <MenuItem key="highlight-similar-nodes" onClick={onClick}>
+            <FontAwesomeIcon icon={faHighlighter} />
+            {actionName}
+          </MenuItem>
+        );
+      };
+
+      const OpenInSandwichViewItem = () => {
+        if (!updateView) {
+          return null;
+        }
+
+        const handleClick = () => {
+          if (updateView) {
+            updateView('sandwich');
+            setActiveItem({ name: barName });
+          }
+        };
+
+        return (
+          <MenuItem
+            key="open-in-sandwich-view"
+            className={indexStyles.sandwichItem}
+            onClick={handleClick}
+          >
+            <SandwichIcon fill="black" />
+            {i18n.openInSandwichView}
+          </MenuItem>
+        );
+      };
+
+      const FitModeItem = () => {
+        const isHeadFirst = fitMode === HeadMode;
+
+        const handleClick = () => {
+          const newValues = isHeadFirst ? TailMode : HeadMode;
+          updateFitMode(newValues);
+        };
+
+        return (
+          <MenuItem
+            className={indexStyles.fitModeItem}
+            key="fit-mode"
+            onClick={handleClick}
+          >
+            {isHeadFirst ? <TailFirstIcon /> : <HeadFirstIcon />}
+            {isHeadFirst ? i18n.showTextTailFirst : i18n.showTextHeadFirst}
+          </MenuItem>
+        );
+      };
+
+      return [
+        <MenuItem key="reset" disabled={!dirty} onClick={onReset}>
+          <FontAwesomeIcon icon={faRedo} />
+          {i18n.resetView}
+        </MenuItem>,
+        CollapseItem(),
+        CopyItem(),
+        HighlightSimilarNodesItem(),
+        OpenInSandwichViewItem(),
+        FitModeItem(),
+      ].filter(Boolean) as JSX.Element[];
+    },
+    [
+      flamegraph,
+      selectedItem,
+      fitMode,
+      isDirty,
+      onReset,
+      onFocusOnNode,
+      setActiveItem,
+      updateView,
+      i18n,
+    ]
+  );
+
+  const constructCanvas = () => {
+    if (canvasRef.current) {
+      const f = new Flamegraph(
+        flamebearer,
+        canvasRef.current,
+        focusedNode,
+        fitMode,
+        highlightQuery,
+        zoom,
+        palette
+      );
+
+      flamegraph.current = f;
+    }
+  };
+
+  React.useEffect(() => {
+    constructCanvas();
+    renderCanvas();
+  }, [palette]);
+
+  React.useEffect(() => {
+    constructCanvas();
+    renderCanvas();
+  }, [
+    canvasRef.current,
+    flamebearer,
+    focusedNode,
+    fitMode,
+    highlightQuery,
+    zoom,
+  ]);
+
+  const renderCanvas = () => {
+    canvasRef?.current?.setAttribute('data-state', 'rendering');
+    flamegraph?.current?.render();
+    canvasRef?.current?.setAttribute('data-state', 'rendered');
+  };
+
+  const dataUnavailable =
+    !flamebearer || (flamebearer && flamebearer.names.length <= 1);
+
+  const getCanvas = () => {
+    if (!canvasRef.current) {
+      throw new Error('Missing canvas');
+    }
+    return canvasRef.current;
+  };
+
+  const getFlamegraph = () => {
+    if (!flamegraph.current) {
+      throw new Error('Missing canvas');
+    }
+    return flamegraph.current;
+  };
+
+  return (
+    <div
+      data-testid="flamegraph-view"
+      className={clsx(indexStyles.flamegraphPane, {
+        'vertical-orientation': flamebearer.format === 'double',
+      })}
+    >
+      {headerVisible && (
+        <Header
+          format={flamebearer.format}
+          units={flamebearer.units}
+          palette={palette}
+          setPalette={setPalette}
+          toolbarVisible={toolbarVisible}
+        />
+      )}
+      <div
+        data-testid={dataTestId}
+        style={{
+          opacity: dataUnavailable && !showSingleLevel ? 0 : 1,
+        }}
+      >
+        <canvas
+          height="0"
+          data-testid="flamegraph-canvas"
+          data-highlightquery={highlightQuery}
+          className={clsx('flamegraph-canvas', styles.canvas)}
+          ref={canvasRef}
+          onClick={!disableClick ? onClick : undefined}
+        />
+      </div>
+      {showCredit ? <LogoLink /> : ''}
+      {flamegraph && canvasRef && (
+        <Highlight
+          barHeight={PX_PER_LEVEL}
+          canvasRef={canvasRef}
+          zoom={zoom}
+          xyToHighlightData={xyToHighlightData}
+        />
+      )}
+      {flamegraph && (
+        <ContextMenuHighlight
+          barHeight={PX_PER_LEVEL}
+          node={rightClickedNode}
+        />
+      )}
+      {flamegraph && (
+        <FlamegraphTooltip
+          format={flamebearer.format}
+          canvasRef={canvasRef}
+          xyToData={xyToTooltipData as ShamefulAny}
+          numTicks={flamebearer.numTicks}
+          sampleRate={flamebearer.sampleRate}
+          leftTicks={
+            flamebearer.format === 'double' ? flamebearer.leftTicks : 0
+          }
+          rightTicks={
+            flamebearer.format === 'double' ? flamebearer.rightTicks : 0
+          }
+          units={flamebearer.units}
+          palette={palette}
+        />
+      )}
+
+      {!disableClick && flamegraph && canvasRef && (
+        <ContextMenu
+          canvasRef={canvasRef}
+          xyToMenuItems={xyToContextMenuItems}
+          onClose={onContextMenuClose}
+          onOpen={onContextMenuOpen}
+        />
+      )}
+    </div>
+  );
+}

package/src/FlameGraph/FlameGraphComponent/murmur3.ts

@@ -0,0 +1,97 @@
+// eslint-disable-next-line @typescript-eslint/ban-ts-comment
+// @ts-nocheck
+/* eslint-disable @typescript-eslint/restrict-plus-operands */
+/*
+
+Copyright (c) 2011 Gary Court
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+*/
+
+/* eslint-disable no-plusplus */
+/* eslint-disable prefer-const */
+/* eslint-disable no-bitwise */
+/* eslint-disable camelcase */
+
+export default function murmurhash3_32_gc(key: string, seed = 0) {
+  let remainder;
+  let bytes;
+  let h1;
+  let h1b;
+  let c1;
+  let c2;
+  let k1;
+  let i;
+
+  remainder = key.length & 3; // key.length % 4
+  bytes = key.length - remainder;
+  h1 = seed;
+  c1 = 0xcc9e2d51;
+  c2 = 0x1b873593;
+  i = 0;
+
+  while (i < bytes) {
+    k1 =
+      (key.charCodeAt(i) & 0xff) |
+      ((key.charCodeAt(++i) & 0xff) << 8) |
+      ((key.charCodeAt(++i) & 0xff) << 16) |
+      ((key.charCodeAt(++i) & 0xff) << 24);
+    ++i;
+
+    k1 =
+      ((k1 & 0xffff) * c1 + ((((k1 >>> 16) * c1) & 0xffff) << 16)) & 0xffffffff;
+    k1 = (k1 << 15) | (k1 >>> 17);
+    k1 =
+      ((k1 & 0xffff) * c2 + ((((k1 >>> 16) * c2) & 0xffff) << 16)) & 0xffffffff;
+
+    h1 ^= k1;
+    h1 = (h1 << 13) | (h1 >>> 19);
+    h1b =
+      ((h1 & 0xffff) * 5 + ((((h1 >>> 16) * 5) & 0xffff) << 16)) & 0xffffffff;
+    h1 = (h1b & 0xffff) + 0x6b64 + ((((h1b >>> 16) + 0xe654) & 0xffff) << 16);
+  }
+
+  k1 = 0;
+
+  switch (remainder) {
+    case 3:
+      k1 ^= (key.charCodeAt(i + 2) & 0xff) << 16;
+    // fall through
+    case 2:
+      k1 ^= (key.charCodeAt(i + 1) & 0xff) << 8;
+    // fall through
+    case 1:
+      k1 ^= key.charCodeAt(i) & 0xff;
+    // fall through
+    default:
+      k1 =
+        ((k1 & 0xffff) * c1 + ((((k1 >>> 16) * c1) & 0xffff) << 16)) &
+        0xffffffff;
+      k1 = (k1 << 15) | (k1 >>> 17);
+      k1 =
+        ((k1 & 0xffff) * c2 + ((((k1 >>> 16) * c2) & 0xffff) << 16)) &
+        0xffffffff;
+      h1 ^= k1;
+  }
+
+  h1 ^= key.length;
+
+  h1 ^= h1 >>> 16;
+  h1 =
+    ((h1 & 0xffff) * 0x85ebca6b +
+      ((((h1 >>> 16) * 0x85ebca6b) & 0xffff) << 16)) &
+    0xffffffff;
+  h1 ^= h1 >>> 13;
+  h1 =
+    ((h1 & 0xffff) * 0xc2b2ae35 +
+      ((((h1 >>> 16) * 0xc2b2ae35) & 0xffff) << 16)) &
+    0xffffffff;
+  h1 ^= h1 >>> 16;
+
+  return h1 >>> 0;
+}

package/src/FlameGraph/FlameGraphComponent/styles.module.scss

@@ -0,0 +1,10 @@
+.flamegraphPane {
+  flex: 1;
+  position: relative;
+
+  .fitModeItem svg,
+  .sandwichItem svg {
+    width: 1em;
+    margin-right: 10px;
+  }
+}