feat(tools-performance): Add @rnx-kit/tools-performance package

[JasonVMo]

Description

This adds a framework for doing lightweight performance tracing, some basic reporting, and enabling tracing at a global level.

Usage

In packages, to add instrumentation:

import { getTrace } from "@rnx-kit/tools-performance";

async function myFunction() {
  // will return a logging tracer if "transform" is enabled, a passthrough if not
  const trace = getTrace("transform");
  // trace a sync closure
  const result1 = trace("func1", () => doSomething(p1, p2));
  // trace a sync function without creating a closure
  const result2 = trace("process result, doSomethingElse, result1, options);
  // trace an async function and return
  const final = await trace("call async", finalCall, result2);
  return final;
}

Right now, to enable this for metro bundling a user would add in their metro.config.js:

import { trackPerformance } from "@rnx-kit/tools-performance";

// these would all work
trackPerformance("transform"); // only turn on this one area
trackPerformance(["transform", "metro"]); // turn on a set of areas
trackPerformance(/* or true */); // turn on all performance tracing

Future things to add (or consider)

• instrument various parts of our infrastructure
• add an implementation of unstable_perfLoggerFactory that hooks into this
• have our metro config automatically add the unstable_perfLoggerFactory if "metro" is enabled
• consider adding a cli option that will enable perf logging for our tools automatically

Other notes

• text is styled using the formatting from node:utils
• simple table formatting in the same format as console.table is added, except with support for formatted text.

[tido64]

We should probably also check that category is an actual array:

Suggested change

	} else {
	for (const cat of category) {
	this.enabled.add(cat);
	}
	}
	} else if (Array.isArray(category)) {
	for (const cat of category) {
	this.enabled.add(cat);
	}
	} else {
	throw new Error(`invalid category: ${category}`);
	}

[tido64]

Mostly minor issues/nits

[tido64]

Suggested change

	import { styleText } from "util";
	import { styleText } from "node:util";

[tido64]

Suggested change

	if (this.exitHandlers) {
	this.exitHandlers.delete(callback);
	}
	this.exitHandlers?.delete(callback);

[tido64]

This supports both null/undefined and is shorter:

Suggested change

	if (this.startVal !== undefined) {
	if (this.startVal != null) {

[tido64]

Suggested change

	if (startTime === undefined) {
	if (startTime == null) {

[tido64]

Suggested change

	if (startMark === undefined) {
	if (startMark == null) {

[tido64]

Suggested change

	text = digits !== undefined ? value.toFixed(digits) : String(value);
	text = digits != null ? value.toFixed(digits) : String(value);

[tido64]

Suggested change

	if (maxWidth !== undefined && text.length > maxWidth) {
	if (maxWidth != null && text.length > maxWidth) {

[tido64]

Suggested change

	if (duration !== undefined) {
	if (duration != null) {

[tido64]

Ensure positive index:

Suggested change

	if (index !== -1) {
	if (index >= 0) {

[tido64]

Can we use .forEach instead of Array.from to avoid the temporary array?