Erik/timerify

[erik-dunteman]

What does this PR do?

• Adds performance.timerify() https://nodejs.org/api/perf_hooks.html#performancetimerifyfn-options to partially address performance.timerify is not a function #9271
• Adds HDR Histogram algorithm for use by users in timerify.

Note that timerify records durations in two ways, through a Histogram and through sending events to PerformanceObserver, and this PR only addresses Histogram use.

The specific issue #9271 should remain open until PerformanceObserver is implemented.

• Documentation or TypeScript types (it's okay to leave the rest blank in this case)
• Code changes

How did you verify your code works?

Histogram: added plenty of tests in hdr_histogram.zig, all pass
Timerify: local sanity checks, below:

const { performance, createHistogram } = require("perf_hooks");

const fn = () => {
  console.log("hello world");
};

// test manual recording
let h = createHistogram();
h.record(100, 1);
h.record(200, 100);
h.record(1000, 1000);
h.record(2000, 1000);
h.record(3000, 1000);
h.record(5000, 1000);
h.record(1000000, 1);

// test add
let otherH = createHistogram();
otherH.record(1, 300);
h.add(otherH);

// test reset
h.reset();

// test timerify
let wrapped = performance.timerify(fn, { histogram: h });
for (let i = 0; i < 1000; i++) {
  wrapped();
}
console.log(h);

all behave as expected

"I wrote automated tests", though curious if all zig tests are ran in CI. we'll see.

• I included a test for the new code, or existing tests cover it
• I ran my tests locally and they pass (bun-debug test test-file-name.test)

Zig changes

• I checked the lifetime of memory allocated to verify it's (1) freed and (2) only freed when it should be
• I included a test for the new code, or an existing test covers it
• JSValue used outside outside of the stack is either wrapped in a JSC.Strong or is JSValueProtect'ed
• I wrote TypeScript/JavaScript tests and they pass locally (bun-debug test test-file-name.test)

Types

• I added TypeScript types for the new methods, getters, or setters -> matches node type interface

[paperdave]

overall alright. most of my worry is in the messy binding for creating the JSMap, and then a handful of simple to fix zig nitpicks. nice work on HDRHistogram.

also if youre writing documentation comments in zig code, that can use ///, ref

[paperdave]

nitpick: this This is kind of silly to have. you can just refer to HDRHistogram, and in init you can use .{ instead of This{

[paperdave]

should this start as highest_trackable_value? or std.math.maxInt(u64)?

[erik-dunteman]

std.math.maxInt is probably better choice, whole point is to guarantee it gets overridden on next record

[paperdave]

lol the readme got nuked. please revert

[erik-dunteman]

Still need to

• rebase to current main
• look at Callconv stuff
• implement bigInt getters

[github-actions]

❌ @erik-dunteman, your commit has failing tests :(

💻 2 failing tests Darwin x64 baseline

• test/js/node/http/node-http.test.ts 1 failing
• test/js/web/streams/streams.test.js 1 failing

💻 1 failing tests Darwin x64

• test/js/node/http/node-http.test.ts 1 failing

🪟💻 5 failing tests Windows x64 baseline

• test/cli/install/registry/bun-install-registry.test.ts 1 failing
• test/cli/install/registry/bun-install-windowsshim.test.ts code 1
• test/js/bun/util/fuzzy-wuzzy.test.ts STATUS_SEVERITY_ERROR
• test/js/node/child_process/child_process.test.ts 1 failing
• test/js/node/perf_hooks/perf_hooks.test.ts STATUS_SEVERITY_ERROR

🪟💻 5 failing tests Windows x64

• test/cli/install/registry/bun-install-registry.test.ts 1 failing
• test/cli/install/registry/bun-install-windowsshim.test.ts code 1
• test/js/bun/util/fuzzy-wuzzy.test.ts STATUS_SEVERITY_ERROR
• test/js/node/child_process/child_process.test.ts 1 failing
• test/js/node/perf_hooks/perf_hooks.test.ts STATUS_SEVERITY_ERROR

View logs

[erik-dunteman]

Working on PerformanceObserver stuff now, but can make that a separate PR. This PR should be ready to go whenever CI passes and code review approved @Jarred-Sumner @paperdave

[Jarred-Sumner]

test/js/node/perf_hooks/perf_hooks.test.ts STATUS_INTEGER_DIVIDE_BY_ZERO
test/js/bun/util/fuzzy-wuzzy.test.ts STATUS_SEVERITY_ERROR

These are new test failures