@kylincloud/flamegraph 0.35.6

package/src/index.spec.tsx

@@ -0,0 +1,383 @@
+import React from 'react';
+import { render, screen } from '@testing-library/react';
+import { FlamegraphRenderer } from './index';
+
+const RawProfile = {
+  version: 1,
+  flamebearer: {
+    names: [
+      'total',
+      'runtime.mcall',
+      'runtime.park_m',
+      'runtime.schedule',
+      'runtime.resetspinning',
+      'runtime.wakep',
+      'runtime.startm',
+      'runtime.notewakeup',
+      'runtime.futexwakeup',
+      'runtime.futex',
+      'runtime.findrunnable',
+      'runtime.write',
+      'runtime.write1',
+      'runtime.stopm',
+      'runtime.mput',
+      'runtime.mPark',
+      'runtime.notesleep',
+      'runtime.futexsleep',
+      'runtime.stealWork',
+      'runtime.checkTimers',
+      'runtime.runtimer',
+      'runtime.runOneTimer',
+      'time.sendTime',
+      'runtime.selectnbsend',
+      'runtime.chansend',
+      'runtime.adjusttimers',
+      'runtime.netpoll',
+      'runtime.read',
+      'runtime.epollwait',
+      'runtime.siftdownTimer',
+      'runtime.gosched_m',
+      'runtime.unlockWithRank',
+      'runtime.unlock2',
+      'runtime.lockWithRank',
+      'runtime.lock2',
+      'runtime.procyield',
+      'runtime.goschedImpl',
+      'runtime.nanotime',
+      'runtime.globrunqget',
+      'runtime.(*gQueue).pop',
+      'runtime.execute',
+      'runtime.casgstatus',
+      'runtime.gcBgMarkWorker',
+      'runtime.systemstack',
+      'runtime.gcBgMarkWorker.func2',
+      'runtime.gcDrain',
+      'runtime.spanOfUnchecked',
+      'runtime.scanobject',
+      'runtime.spanOf',
+      'runtime.pageIndexOf',
+      'runtime.markBits.isMarked',
+      'runtime.greyobject',
+      'runtime.findObject',
+      'runtime.arenaIndex',
+      'runtime.(*mspan).divideByElemSize',
+      'runtime.(*gcWork).putFast',
+      'runtime.heapBitsForAddr',
+      'runtime.heapBits.next',
+      'runtime.heapBits.bits',
+      'runtime.gcFlushBgCredit',
+      'runtime.bgsweep',
+      'runtime.sweepone',
+      'runtime.(*sweepLocked).sweep',
+      'runtime.(*gcBitsArena).tryAlloc',
+      'runtime.(*sweepLocker).dispose',
+      'runtime.(*sweepLocker).blockCompletion',
+      'net/http.(*conn).serve',
+      'net/http.serverHandler.ServeHTTP',
+      'net/http.HandlerFunc.ServeHTTP',
+      'github.com/klauspost/compress/gzhttp.NewWrapper.func1.1',
+      'github.com/gorilla/mux.(*Router).ServeHTTP',
+      'github.com/pyroscope-io/pyroscope/pkg/server.(*Controller).drainMiddleware.func1',
+      'github.com/pyroscope-io/pyroscope/pkg/server.ingestHandler.ServeHTTP',
+      'github.com/pyroscope-io/pyroscope/pkg/structs/transporttrie.IterateRaw',
+      'io.LimitReader',
+      'runtime.newobject',
+      'runtime.nextFreeFast',
+      'io.Copy',
+      'io.copyBuffer',
+      'bytes.(*Buffer).ReadFrom',
+      'io.(*LimitedReader).Read',
+      'net/http.(*response).finishRequest',
+      'bufio.(*Writer).Flush',
+      'net/http.checkConnErrorWriter.Write',
+      'net.(*conn).Write',
+      'net.(*netFD).Write',
+      'syscall.Write',
+      'syscall.write',
+      'syscall.Syscall',
+      'github.com/pyroscope-io/pyroscope/pkg/agent/upstream/direct.(*Direct).uploadLoop',
+      'github.com/pyroscope-io/pyroscope/pkg/agent/upstream/direct.(*Direct).safeUpload',
+      'github.com/pyroscope-io/pyroscope/pkg/agent/upstream/direct.(*Direct).uploadProfile',
+      'github.com/pyroscope-io/pyroscope/pkg/structs/transporttrie.(*Trie).Iterate',
+      'runtime.growslice',
+      'runtime.mallocgc',
+      'github.com/pyroscope-io/pyroscope/pkg/agent.(*ProfileSession).takeSnapshots',
+      'runtime.selectgo',
+      'runtime.gopark',
+      'runtime.(*mcache).nextFree',
+      'runtime.(*mcache).refill',
+      'runtime.(*mcentral).cacheSpan',
+      'runtime.mapiterinit',
+      'runtime.makemap_small',
+      'github.com/pyroscope-io/pyroscope/pkg/agent/gospy.(*GoSpy).Snapshot',
+      'runtime/pprof.writeHeap',
+      'runtime/pprof.writeHeapInternal',
+      'runtime/pprof.writeHeapProto',
+      'runtime/pprof.(*profileBuilder).pbSample',
+      'runtime/pprof.(*profileBuilder).flush',
+      'compress/flate.(*Writer).Write',
+      'compress/flate.(*compressor).write',
+      'compress/flate.(*compressor).encSpeed',
+      'compress/flate.(*deflateFast).encode',
+      'compress/flate.emitLiteral',
+      'runtime/pprof.(*profileBuilder).appendLocsForStack',
+      'runtime/pprof.allFrames',
+      'runtime.(*Frames).Next',
+      'runtime.funcline1',
+      'runtime.pcvalue',
+      'runtime.step',
+      'runtime.GC',
+      'runtime.(*spanSet).push',
+      'runtime.(*headTailIndex).incTail',
+      'runtime.(*mheap).freeSpan',
+      'runtime.(*mheap).nextSpanForSweep',
+      'runtime.(*spanSet).pop',
+      'github.com/pyroscope-io/pyroscope/pkg/storage/tree.(*Profile).Get',
+      'github.com/pyroscope-io/pyroscope/pkg/storage/tree.FindFunctionName',
+      'runtime.asyncPreempt',
+      'github.com/pyroscope-io/pyroscope/pkg/storage/tree.FindLocation',
+      'sort.Search',
+      'github.com/pyroscope-io/pyroscope/pkg/storage/tree.FindFunction',
+      'github.com/pyroscope-io/pyroscope/pkg/storage/tree.FindFunction.func1',
+      'github.com/pyroscope-io/pyroscope/pkg/agent/gospy.(*GoSpy).Snapshot.func3',
+      'github.com/pyroscope-io/pyroscope/pkg/agent.(*ProfileSession).takeSnapshots.func1',
+      'github.com/pyroscope-io/pyroscope/pkg/structs/transporttrie.(*Trie).Insert',
+      'github.com/pyroscope-io/pyroscope/pkg/structs/transporttrie.(*trieNode).findNodeAt',
+      'runtime.(*mcentral).grow',
+      'runtime.(*mheap).alloc',
+      'runtime.(*mheap).alloc.func1',
+      'runtime.(*mheap).allocSpan',
+      'runtime.(*mheap).allocMSpanLocked',
+      'runtime.(*fixalloc).alloc',
+      'github.com/pyroscope-io/pyroscope/pkg/agent/gospy.getHeapProfile',
+      'github.com/pyroscope-io/pyroscope/pkg/convert.ParsePprof',
+      'google.golang.org/protobuf/proto.Unmarshal',
+      'google.golang.org/protobuf/proto.UnmarshalOptions.unmarshal',
+      'google.golang.org/protobuf/internal/impl.(*MessageInfo).unmarshal',
+      'google.golang.org/protobuf/internal/impl.(*MessageInfo).unmarshalPointer',
+      'google.golang.org/protobuf/internal/impl.consumeMessageSliceInfo',
+      'github.com/pyroscope-io/pyroscope/pkg/agent.(*ProfileSession).isDueForReset',
+      'time.Time.Truncate',
+      'github.com/dgraph-io/badger/v2.(*levelsController).runCompactor',
+      'github.com/dgraph-io/badger/v2.(*levelsController).pickCompactLevels',
+      'sort.Slice',
+      'github.com/dgraph-io/badger/v2.(*DB).doWrites.func1',
+      'github.com/dgraph-io/badger/v2.(*DB).writeRequests',
+      'github.com/dgraph-io/badger/v2.(*valueLog).write',
+      'github.com/dgraph-io/badger/v2.(*logFile).encodeEntry',
+      'hash/crc32.New',
+      'runtime.heapBitsSetType',
+      'runtime.newstack',
+      'runtime.copystack',
+      'runtime.memmove',
+    ],
+    levels: [
+      [0, 236, 0, 0],
+      [
+        0, 1, 0, 155, 0, 1, 0, 152, 0, 29, 0, 95, 0, 1, 0, 89, 0, 3, 0, 66, 0,
+        11, 0, 60, 0, 154, 0, 42, 0, 36, 0, 1,
+      ],
+      [
+        0, 1, 0, 156, 0, 1, 0, 153, 0, 1, 0, 150, 0, 23, 0, 103, 0, 1, 0, 102,
+        0, 1, 1, 101, 0, 1, 0, 75, 0, 2, 1, 96, 0, 1, 0, 90, 0, 1, 0, 81, 0, 2,
+        0, 67, 0, 2, 2, 65, 0, 3, 3, 64, 0, 6, 3, 61, 0, 154, 0, 43, 0, 19, 0,
+        30, 0, 17, 0, 2,
+      ],
+      [
+        0, 1, 0, 157, 0, 1, 1, 154, 0, 1, 1, 151, 0, 1, 0, 143, 0, 12, 0, 126,
+        0, 7, 0, 120, 0, 3, 0, 104, 0, 1, 0, 75, 1, 1, 0, 94, 1, 1, 1, 97, 0, 1,
+        0, 91, 0, 1, 0, 82, 0, 2, 0, 68, 8, 3, 2, 62, 0, 154, 0, 44, 0, 15, 0,
+        36, 0, 2, 0, 33, 0, 2, 0, 31, 0, 17, 0, 3,
+      ],
+      [
+        0, 1, 0, 158, 2, 1, 0, 144, 0, 7, 0, 133, 0, 5, 0, 127, 0, 7, 1, 61, 0,
+        3, 0, 105, 0, 1, 1, 94, 1, 1, 0, 98, 2, 1, 0, 92, 0, 1, 0, 83, 0, 2, 0,
+        69, 10, 1, 1, 63, 0, 154, 14, 45, 0, 1, 1, 41, 0, 14, 0, 3, 0, 2, 0, 34,
+        0, 2, 2, 32, 0, 16, 1, 10, 0, 1, 0, 4,
+      ],
+      [
+        0, 1, 0, 159, 2, 1, 0, 145, 0, 7, 0, 134, 0, 3, 0, 131, 0, 1, 0, 129, 0,
+        1, 1, 128, 1, 1, 0, 124, 0, 5, 0, 62, 0, 3, 0, 106, 2, 1, 0, 99, 2, 1,
+        0, 93, 0, 1, 0, 84, 0, 2, 0, 70, 25, 1, 1, 59, 0, 7, 7, 58, 0, 5, 5, 57,
+        0, 6, 6, 56, 0, 119, 61, 47, 0, 2, 2, 46, 1, 2, 1, 40, 0, 4, 0, 10, 0,
+        3, 0, 33, 0, 2, 2, 37, 0, 3, 0, 31, 0, 2, 2, 35, 3, 1, 0, 19, 0, 5, 0,
+        26, 0, 2, 0, 18, 0, 6, 0, 13, 0, 1, 0, 11, 0, 1, 0, 5,
+      ],
+      [
+        0, 1, 0, 75, 2, 1, 0, 146, 0, 7, 0, 135, 0, 3, 2, 130, 0, 1, 1, 130, 2,
+        1, 1, 125, 0, 1, 0, 123, 0, 4, 3, 121, 0, 1, 0, 114, 0, 2, 0, 107, 2, 1,
+        1, 100, 2, 1, 1, 94, 0, 1, 0, 85, 0, 2, 0, 68, 105, 2, 2, 55, 0, 3, 3,
+        54, 0, 1, 1, 53, 0, 17, 17, 52, 0, 3, 3, 51, 0, 5, 5, 50, 0, 11, 11, 49,
+        0, 16, 16, 48, 4, 1, 1, 41, 0, 1, 1, 39, 0, 1, 1, 38, 0, 1, 1, 37, 0, 1,
+        0, 26, 0, 3, 0, 34, 2, 3, 3, 32, 5, 1, 0, 20, 0, 4, 4, 28, 0, 1, 1, 27,
+        0, 2, 0, 19, 0, 5, 0, 15, 0, 1, 1, 14, 0, 1, 1, 12, 0, 1, 0, 6,
+      ],
+      [
+        0, 1, 0, 94, 2, 1, 0, 147, 0, 7, 6, 136, 2, 1, 1, 132, 4, 1, 0, 43, 3,
+        1, 1, 122, 0, 1, 0, 115, 0, 2, 0, 108, 6, 1, 0, 86, 0, 2, 0, 71, 171, 1,
+        1, 28, 0, 3, 3, 35, 10, 1, 0, 21, 5, 1, 1, 25, 0, 1, 0, 20, 0, 5, 0, 16,
+        2, 1, 0, 7,
+      ],
+      [
+        0, 1, 0, 160, 2, 1, 0, 148, 6, 1, 0, 94, 7, 1, 0, 33, 4, 1, 0, 116, 0,
+        2, 0, 109, 6, 1, 0, 87, 0, 2, 0, 72, 185, 1, 1, 29, 6, 1, 0, 21, 0, 5,
+        0, 17, 2, 1, 0, 8,
+      ],
+      [
+        0, 1, 0, 161, 2, 1, 0, 149, 6, 1, 0, 98, 7, 1, 1, 34, 4, 1, 0, 117, 0,
+        2, 0, 110, 6, 1, 1, 88, 0, 2, 0, 73, 192, 1, 0, 22, 0, 5, 5, 9, 2, 1, 1,
+        9,
+      ],
+      [
+        0, 1, 0, 162, 2, 1, 1, 148, 6, 1, 0, 99, 12, 1, 0, 118, 0, 2, 0, 111, 7,
+        1, 0, 77, 0, 1, 0, 74, 192, 1, 0, 23,
+      ],
+      [
+        0, 1, 1, 163, 9, 1, 0, 100, 12, 1, 1, 119, 0, 2, 1, 112, 7, 1, 0, 78, 0,
+        1, 0, 75, 192, 1, 1, 24,
+      ],
+      [10, 1, 0, 137, 14, 1, 1, 113, 7, 1, 0, 79, 0, 1, 1, 76],
+      [10, 1, 0, 138, 22, 1, 1, 80],
+      [10, 1, 0, 43],
+      [10, 1, 0, 139],
+      [10, 1, 0, 140],
+      [10, 1, 0, 141],
+      [10, 1, 1, 142],
+    ],
+    numTicks: 236,
+    maxSelf: 61,
+  },
+  timeline: {
+    startTime: 1646760440,
+    samples: [237],
+    durationDelta: 10,
+    watermarks: {},
+  },
+  metadata: {
+    format: 'single' as const,
+    spyName: 'gospy' as const,
+    sampleRate: 100,
+    units: 'samples' as const,
+    name: 'pyroscope.server.cpu 2022-03-08T17:27:23Z',
+    appName: 'pyroscope.server.cpu',
+    startTime: 1646760443,
+    endTime: 1646760446,
+    query: 'pyroscope.server.cpu{}',
+    maxNodes: 1024,
+  },
+};
+
+const SimpleTree = {
+  topLevel: 0,
+  rangeMin: 0,
+  format: 'single' as const,
+  numTicks: 988,
+  sampleRate: 100,
+  names: [
+    'total',
+    'runtime.main',
+    'main.slowFunction',
+    'main.work',
+    'main.main',
+    'main.fastFunction',
+  ],
+  levels: [
+    [0, 988, 0, 0],
+    [0, 988, 0, 1],
+    [0, 214, 0, 5, 214, 3, 2, 4, 217, 771, 0, 2],
+    [0, 214, 214, 3, 216, 1, 1, 5, 217, 771, 771, 3],
+  ],
+
+  rangeMax: 1,
+  units: 'samples',
+  fitMode: 'HEAD',
+
+  spyName: 'gospy',
+};
+
+// describe.skip('Pyroscope Library', () => {
+//  it('should not be possible to override the pyroscope logo using props', () => {
+//    render(
+//      <FlamegraphRenderer
+//        flamebearer={SimpleTree}
+//        display="flamegraph"
+//        viewType="single"
+//        showPyroscopeLogo={false}
+//      />
+//    );
+//
+//    expect(
+//      screen.getByRole('link', { name: /pyroscope/i })
+//    ).toBeInTheDocument();
+//  });
+// });
+//
+//
+// TODO a test saying going over rendering an empty flamegraph
+describe.only('positions', () => {
+  beforeAll(() => {
+    window.HTMLElement.prototype.getBoundingClientRect = function () {
+      return {
+        x: 0,
+        y: 0,
+        bottom: 0,
+        right: 0,
+        toJSON: () => {},
+        height: 0,
+        top: 0,
+        left: 0,
+        width: 900,
+      };
+    };
+  });
+
+  describe('Allow changing visualization mode', () => {
+    it('should allow changing view when "onlyDisplay" is not set', () => {
+      const { getByTestId, queryByRole } = render(
+        <FlamegraphRenderer profile={RawProfile} />
+      );
+
+      expect(getByTestId('table-ui')).toBeInTheDocument();
+      expect(getByTestId('flamegraph-view')).toBeInTheDocument();
+      expect(getByTestId('flamegraph')).toBeInTheDocument();
+      expect(getByTestId('both')).toBeInTheDocument();
+      expect(getByTestId('table')).toBeInTheDocument();
+    });
+
+    it('should restrict changing view when "onlyDisplay" is set', () => {
+      const { getByTestId, queryByRole } = render(
+        <FlamegraphRenderer profile={RawProfile} onlyDisplay="both" />
+      );
+
+      expect(getByTestId('table-ui')).toBeInTheDocument();
+      expect(getByTestId('flamegraph-view')).toBeInTheDocument();
+      expect(queryByRole('combobox', { name: 'view' })).not.toBeInTheDocument();
+    });
+  });
+
+  it('should display only the flamegraph when specified', () => {
+    const { getByTestId, queryByTestId } = render(
+      <FlamegraphRenderer profile={RawProfile} onlyDisplay="flamegraph" />
+    );
+
+    expect(queryByTestId('table-ui')).not.toBeInTheDocument();
+    expect(getByTestId('flamegraph-view')).toBeInTheDocument();
+  });
+
+  it('should display only the table when specified', () => {
+    const { getByTestId, queryByTestId } = render(
+      <FlamegraphRenderer profile={RawProfile} onlyDisplay="table" />
+    );
+
+    expect(getByTestId('table-ui')).toBeInTheDocument();
+    expect(queryByTestId('flamegraph-view')).not.toBeInTheDocument();
+  });
+});
+
+it('should work', () => {
+  render(<FlamegraphRenderer flamebearer={SimpleTree as any} />);
+});
+
+it('should work with raw profile from /render endpoint', () => {
+  render(<FlamegraphRenderer profile={RawProfile} />);
+});

package/src/index.tsx

@@ -0,0 +1,10 @@
+// src/index.tsx
+
+// 主渲染组件
+export { default as FlamegraphRenderer } from './FlameGraph/FlameGraphRenderer';
+
+// 容器组件
+export { default as Box } from './shims/Box';
+
+// i18n（包含 flamegraphZhCNMessages 等）
+export * from './i18n';

package/src/logo-v3-small.svg

@@ -0,0 +1,32 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<svg width="1024px" height="1024px" viewBox="0 0 1024 1024" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">
+    <title>Artboard@2x</title>
+    <defs>
+        <radialGradient cx="49.4236252%" cy="92.6627823%" fx="49.4236252%" fy="92.6627823%" r="195.066755%" gradientTransform="translate(0.494236,0.926628),scale(1.000000,0.735610),rotate(-90.000000),translate(-0.494236,-0.926628)" id="radialGradient-1">
+            <stop stop-color="#FFB90C" offset="0%"></stop>
+            <stop stop-color="#F9243A" offset="38.390924%"></stop>
+            <stop stop-color="#F9243A" offset="50.5405%"></stop>
+            <stop stop-color="#B51424" offset="73.98091%"></stop>
+            <stop stop-color="#B51424" offset="100%"></stop>
+        </radialGradient>
+    </defs>
+    <g id="Artboard" stroke="none" stroke-width="1" fill="none" fill-rule="evenodd">
+        <g id="fire-part" transform="translate(148.516736, 0.000000)" fill-rule="nonzero">
+            <g id="whole-thing" transform="translate(363.983264, 495.000000) scale(-1, 1) rotate(-180.000000) translate(-363.983264, -495.000000) translate(0.483264, 0.000000)">
+                <g id="g70" transform="translate(-0.000091, 0.685815)" fill="url(#radialGradient-1)">
+                    <path d="M65.3646667,571.739321 L65.4492471,571.698868 C19.5139147,505.999969 -5.32464048,424.477859 1.04305801,336.877516 L1.04305801,336.877516 C14.0321963,158.179446 159.192462,13.7596653 338.059844,1.5917266 L338.059844,1.5917266 C419.418369,-3.93888015 495.500283,17.3823334 558.456522,57.4611191 L558.456522,57.4611191 L481.301947,162.097965 C437.516468,136.521928 399.367671,129.590556 363.486536,130.155994 L363.486536,130.155994 C234.497143,130.155994 129.556988,235.032238 129.556988,363.946998 L129.556988,363.946998 C129.556988,492.865683 234.497143,597.738003 363.486536,597.738003 L363.486536,597.738003 C492.483783,597.738003 597.427864,492.865683 597.427864,363.946998 L597.427864,363.946998 C597.41276,304.634864 581.39383,255.677522 530.630465,199.668053 L607.770843,95.1329436 C680.936847,161.576603 726.932594,257.364176 726.932594,363.946998 L726.932594,363.946998 C726.932594,458.031616 691.13483,543.75602 632.416071,608.271816 L632.416071,608.271816 L632.416071,608.275741 L533.597728,748.122808 L428.601388,617.203806 L434.703262,646.563419 C459.453008,765.59222 433.664131,889.543925 363.49439,988.853335 L363.49439,988.853335 L65.3646667,571.723019 L65.3646667,571.739321 Z" id="path84"></path>
+                </g>
+                <g id="blue" transform="translate(191.447039, 191.331780)">
+                    <g id="g88" transform="translate(-0.000063, 0.685930)">
+                        <g id="g94" transform="translate(0.177296, 0.699054)" fill="#3EC1D3">
+                            <path d="M171.862466,343.697728 C77.0961324,343.697728 -0.00497405932,266.647602 -0.00497405932,171.934957 C-0.00497405932,77.2182874 77.0961324,0.168162396 171.862466,0.168162396 C266.632828,0.168162396 343.741988,77.2182874 343.741988,171.934957 C343.741988,266.647602 266.632828,343.697728 171.862466,343.697728" id="path96"></path>
+                        </g>
+                        <g id="g98" transform="translate(29.362379, 172.629585)" fill="#FFFFFF">
+                            <path d="M22.8397982,0 L0.671669409,0 C0.671669409,78.2496309 64.380874,141.920035 142.678189,141.920035 L142.678189,119.765407 C76.6007327,119.765407 22.8397982,66.0372141 22.8397982,0" id="path100"></path>
+                        </g>
+                    </g>
+                </g>
+            </g>
+        </g>
+    </g>
+</svg>

package/src/models/decode.ts

@@ -0,0 +1,45 @@
+import { Profile } from './profile';
+
+// TODO: ideally this should be moved into the FlamegraphRenderer component
+// but since it will require too many changes for now
+function deltaDiffWrapper(
+  format: Profile['metadata']['format'],
+  levels: Profile['flamebearer']['levels']
+) {
+  const mutableLevels = [...levels];
+
+  function deltaDiff(
+    lvls: Profile['flamebearer']['levels'],
+    start: number,
+    step: number
+  ) {
+    // eslint-disable-next-line no-restricted-syntax
+    for (const level of lvls) {
+      let prev = 0;
+      for (let i = start; i < level.length; i += step) {
+        level[i] += prev;
+        prev = level[i] + level[i + 1];
+      }
+    }
+  }
+
+  if (format === 'double') {
+    deltaDiff(mutableLevels, 0, 7);
+    deltaDiff(mutableLevels, 3, 7);
+  } else {
+    deltaDiff(mutableLevels, 0, 4);
+  }
+
+  return mutableLevels;
+}
+
+// eslint-disable-next-line import/prefer-default-export
+export function decodeFlamebearer(fb: Profile): Profile {
+  // TODO: make this immutable
+  // eslint-disable-next-line no-param-reassign
+  fb.flamebearer.levels = deltaDiffWrapper(
+    fb.metadata.format,
+    fb.flamebearer.levels
+  );
+  return fb;
+}

package/src/models/flamebearer.ts

@@ -0,0 +1,86 @@
+import { SpyName } from './spyName';
+import { Units } from './units';
+/**
+ * @deprecated one should use the Profile model
+ */
+export type Flamebearer = {
+  /**
+   * List of names
+   */
+  names: string[];
+  /**
+   * List of level
+   *
+   * This is NOT the same as in the flamebearer
+   * that we receive from the server.
+   * As in there are some transformations required
+   * (see deltaDiffWrapper)
+   */
+  levels: number[][];
+  numTicks: number;
+  maxSelf: number;
+
+  /**
+   * Sample Rate, used in text information
+   */
+  sampleRate: number;
+  units: Units;
+
+  spyName: SpyName;
+  // format: 'double' | 'single';
+  //  leftTicks?: number;
+  //  rightTicks?: number;
+} & addTicks;
+
+export type addTicks =
+  | { format: 'double'; leftTicks: number; rightTicks: number }
+  | { format: 'single' };
+
+export const singleFF = {
+  format: 'single' as const,
+  jStep: 4,
+  jName: 3,
+  getBarOffset: (level: number[], j: number) => level[j],
+  getBarTotal: (level: number[], j: number) => level[j + 1],
+  getBarTotalDiff: (level: number[], j: number) => 0,
+  getBarSelf: (level: number[], j: number) => level[j + 2],
+  getBarSelfDiff: (level: number[], j: number) => 0,
+  getBarName: (level: number[], j: number) => level[j + 3],
+};
+
+export const doubleFF = {
+  format: 'double' as const,
+  jStep: 7,
+  jName: 6,
+  getBarOffset: (level: number[], j: number) => level[j] + level[j + 3],
+  getBarTotal: (level: number[], j: number) => level[j + 4] + level[j + 1],
+  getBarTotalLeft: (level: number[], j: number) => level[j + 1],
+  getBarTotalRght: (level: number[], j: number) => level[j + 4],
+  getBarTotalDiff: (level: number[], j: number) => {
+    return level[j + 4] - level[j + 1];
+  },
+  getBarSelf: (level: number[], j: number) => level[j + 5] + level[j + 2],
+  getBarSelfLeft: (level: number[], j: number) => level[j + 2],
+  getBarSelfRght: (level: number[], j: number) => level[j + 5],
+  getBarSelfDiff: (level: number[], j: number) => level[j + 5] - level[j + 2],
+  getBarName: (level: number[], j: number) => level[j + 6],
+};
+
+// createFF returns an accesser for flamebearer
+// TODO: rename it?
+export function createFF(
+  viewType: 'single' | 'double'
+): typeof singleFF | typeof doubleFF {
+  switch (viewType) {
+    case 'single': {
+      return singleFF;
+    }
+    case 'double': {
+      return doubleFF;
+    }
+
+    default: {
+      throw new Error(`Unsupported type: '${viewType}'`);
+    }
+  }
+}

package/src/models/groups.ts

@@ -0,0 +1,14 @@
+import { z } from 'zod';
+
+const GroupSchema = z.object({
+  watermark: z.object({}).optional(),
+  // timeline data
+  startTime: z.number(),
+  samples: z.array(z.number()),
+  durationDelta: z.number(),
+});
+
+export const GroupsSchema = z.record(z.string(), GroupSchema);
+
+export type Groups = z.infer<typeof GroupsSchema>;
+export type Group = z.infer<typeof GroupSchema>;

package/src/models/index.ts

@@ -0,0 +1,7 @@
+export * from './profile';
+export * from './flamebearer';
+export * from './trace';
+export * from './groups';
+export * from './decode';
+export * from './spyName';
+export * from './units';

package/src/models/profile.spec.ts

@@ -0,0 +1,32 @@
+import { MetadataSchema, FlamebearerSchema } from './profile';
+
+describe('Profile', () => {
+  describe('FlamebearerSchema', () => {
+    describe('Names', () => {
+      it('defaults to "unknown" when name is empty', () => {
+        const fb = {
+          names: ['', ''],
+          levels: [],
+          numTicks: 100,
+          maxSelf: 100,
+        };
+        expect(FlamebearerSchema.parse(fb)).toStrictEqual({
+          names: ['unknown', 'unknown'],
+          levels: [],
+          numTicks: 100,
+          maxSelf: 100,
+        });
+      });
+
+      it('uses correct name when not empty', () => {
+        const fb = {
+          names: ['myname', 'myname2'],
+          levels: [],
+          numTicks: 100,
+          maxSelf: 100,
+        };
+        expect(FlamebearerSchema.parse(fb)).toStrictEqual(fb);
+      });
+    });
+  });
+});

package/src/models/profile.ts

@@ -0,0 +1,48 @@
+import { z } from 'zod';
+import { SpyNameSchema } from './spyName';
+import { UnitsSchema } from './units';
+
+export const FlamebearerSchema = z.object({
+  names: z.array(
+    z.preprocess((n) => {
+      if (!n) {
+        return 'unknown';
+      }
+
+      return n;
+    }, z.string().min(1))
+  ),
+  levels: z.array(z.array(z.number())),
+  numTicks: z.number(),
+  maxSelf: z.number(),
+});
+
+export const MetadataSchema = z.object({
+  // Optional fields since adhoc may be missing them
+  // they are added on /render and /render-diff response
+  // https://github.com/pyroscope-io/pyroscope/blob/main/pkg/server/render.go#L114-L131
+  appName: z.string().optional(),
+  name: z.string().optional(),
+  startTime: z.number().optional(),
+  endTime: z.number().optional(),
+  query: z.string().optional(),
+  maxNodes: z.number().optional(),
+
+  format: z.enum(['single', 'double']),
+  sampleRate: z.number(),
+  spyName: SpyNameSchema,
+
+  units: UnitsSchema,
+});
+
+export const FlamebearerProfileSchema = z.object({
+  version: z.number().min(1).max(1).default(1),
+  flamebearer: FlamebearerSchema,
+  metadata: MetadataSchema,
+
+  // TODO make thee dependent on format === 'double'
+  leftTicks: z.number().optional(),
+  rightTicks: z.number().optional(),
+});
+
+export type Profile = z.infer<typeof FlamebearerProfileSchema>;

package/src/models/spyName.spec.ts

@@ -0,0 +1,18 @@
+import { SpyNameSchema, AllSpyNames } from './spyName';
+
+describe('SpyName', () => {
+  it('defaults to "unknown" when absent', () => {
+    expect(SpyNameSchema.parse('')).toBe('unknown');
+  });
+
+  it('defaults to "unknown" when value is not in the allowlist', () => {
+    expect(SpyNameSchema.parse('other')).toBe('unknown');
+  });
+
+  test.each(AllSpyNames.map((a) => [a, a]))(
+    'parse("%s") should return "%s"',
+    (spyName) => {
+      expect(SpyNameSchema.parse(spyName)).toBe(spyName);
+    }
+  );
+});