@gtkx/utils 0.21.0 → 1.0.0-rc.2

package/src/log/logger.ts

@@ -0,0 +1,142 @@
+import pc from "picocolors";
+
+type Colors = ReturnType<typeof pc.createColors>;
+
+/**
+ * Minimal writable-stream shape a {@link Logger} writes formatted lines to.
+ */
+type OutputStream = {
+    write(chunk: string): unknown;
+    /** Whether the stream is a terminal, used to decide if colored output is emitted. */
+    isTTY?: boolean | undefined;
+};
+
+/**
+ * Options for constructing a {@link Logger}.
+ */
+type LoggerOptions = {
+    /** Namespace appended to the log prefix and matched against debug configuration. */
+    namespace?: string | undefined;
+    /** Stream to write log lines to; defaults to `process.stderr`. */
+    stream?: OutputStream | undefined;
+    /** Forces debug output on or off; when omitted it is resolved from `--debug` and `GTKX_DEBUG`. */
+    debugEnabled?: boolean | undefined;
+};
+
+const BASE_PREFIX = "[gtkx]";
+
+function getColors(stream: OutputStream): Colors {
+    return pc.createColors(pc.isColorSupported && stream.isTTY === true);
+}
+
+function formatValue(value: unknown): string {
+    if (typeof value === "string") {
+        return value;
+    }
+
+    if (value instanceof Error) {
+        return value.stack ?? value.message;
+    }
+
+    try {
+        return JSON.stringify(value);
+    } catch {
+        return String(value);
+    }
+}
+
+function isDebugEnabled(namespace: string | undefined, argv: string[], env: NodeJS.ProcessEnv): boolean {
+    if (argv.includes("--debug")) {
+        return true;
+    }
+
+    const spec = env.GTKX_DEBUG;
+
+    if (!spec) {
+        return false;
+    }
+
+    const names = new Set(spec.split(/[\s,]+/).filter((name) => name.length > 0));
+
+    if (names.has("1") || names.has("*")) {
+        return true;
+    }
+
+    return namespace !== undefined && names.has(namespace);
+}
+
+function getPrefix(namespace: string | undefined): string {
+    return namespace === undefined ? BASE_PREFIX : `[gtkx:${namespace}]`;
+}
+
+/**
+ * Writes prefixed, optionally colored log lines to an output stream, with debug lines gated by
+ * command-line and environment configuration.
+ */
+class Logger {
+    private stream: OutputStream;
+    private prefix: string;
+    private debugEnabled: boolean;
+    private colors: Colors;
+
+    /**
+     * @param options - Namespace, target stream, and debug configuration for the logger.
+     */
+    constructor(options: LoggerOptions = {}) {
+        this.stream = options.stream ?? process.stderr;
+        this.prefix = getPrefix(options.namespace);
+        this.debugEnabled = options.debugEnabled ?? isDebugEnabled(options.namespace, process.argv, process.env);
+        this.colors = getColors(this.stream);
+    }
+
+    private write(message: string, rest: unknown[]): void {
+        const suffix = rest.length === 0 ? "" : ` ${rest.map((value) => formatValue(value)).join(" ")}`;
+        this.stream.write(`${this.prefix} ${message}${suffix}\n`);
+    }
+
+    /**
+     * Writes an informational line.
+     *
+     * @param message - The message text.
+     * @param rest - Extra values appended after the message, formatted for display.
+     */
+    info(message: string, ...rest: unknown[]): void {
+        this.write(message, rest);
+    }
+
+    /**
+     * Writes a line marked as a warning.
+     *
+     * @param message - The message text.
+     * @param rest - Extra values appended after the message, formatted for display.
+     */
+    warn(message: string, ...rest: unknown[]): void {
+        this.write(`${this.colors.yellow("warn")} ${message}`, rest);
+    }
+
+    /**
+     * Writes a line marked as an error.
+     *
+     * @param message - The message text.
+     * @param rest - Extra values appended after the message, formatted for display.
+     */
+    error(message: string, ...rest: unknown[]): void {
+        this.write(`${this.colors.red("error")} ${message}`, rest);
+    }
+
+    /**
+     * Writes a line only when debug output is enabled for this logger.
+     *
+     * @param message - The message text.
+     * @param rest - Extra values appended after the message, formatted for display.
+     */
+    debug(message: string, ...rest: unknown[]): void {
+        if (!this.debugEnabled) {
+            return;
+        }
+
+        this.write(message, rest);
+    }
+}
+
+export { Logger, type OutputStream, type LoggerOptions };

package/src/map/get-or-insert.ts

@@ -0,0 +1,33 @@
+type GetSet<K, V> = {
+    get(key: K): V | undefined;
+    set(key: K, value: V): unknown;
+    has(key: K): boolean;
+};
+
+/**
+ * Returns the value stored under `key`, or inserts and returns the value produced by `factory` when
+ * the key is absent. Works with both `Map` and `WeakMap`, and caches a computed `undefined` value.
+ *
+ * @template K - The key type.
+ * @template V - The value type.
+ * @param map - The `Map` or `WeakMap` to read from and populate.
+ * @param key - The key to look up.
+ * @param factory - Produces the value to insert when `key` is absent; called at most once.
+ * @returns The existing or newly-inserted value.
+ *
+ * @example
+ * const counts = new Map<string, number[]>();
+ * getOrInsert(counts, "a", () => []).push(1); // counts is Map { "a" => [1] }
+ */
+function getOrInsert<K, V>(map: GetSet<K, V>, key: K, factory: (key: K) => V): V {
+    if (map.has(key)) {
+        return map.get(key) as V;
+    }
+
+    const value = factory(key);
+    map.set(key, value);
+
+    return value;
+}
+
+export { getOrInsert, type GetSet };

package/src/map/index.ts

@@ -0,0 +1 @@
+export { getOrInsert } from "./get-or-insert.js";

package/src/object/index.ts

@@ -0,0 +1,3 @@
+export { omit } from "./omit.js";
+export { pickBy } from "./pick-by.js";
+export { structuredClone } from "./structured-clone.js";

package/src/object/omit.ts

@@ -0,0 +1,26 @@
+/**
+ * Creates a new object holding every entry of `obj` except the named keys.
+ *
+ * @template T - The type of the source object.
+ * @template K - The keys to leave out.
+ * @param obj - The object to copy entries from.
+ * @param keys - The keys to leave out of the result.
+ * @returns A new object without the named keys.
+ *
+ * @example
+ * omit({ a: 1, b: 2 }, ["a"]); // { b: 2 }
+ */
+function omit<T extends object, K extends keyof T>(obj: T, keys: K[]): Omit<T, K> {
+    const excluded: Set<PropertyKey> = new Set(keys);
+    const result: Record<string, unknown> = {};
+
+    for (const [key, value] of Object.entries(obj)) {
+        if (!excluded.has(key)) {
+            result[key] = value;
+        }
+    }
+
+    return result as Omit<T, K>;
+}
+
+export { omit };

package/src/object/pick-by.ts

@@ -0,0 +1,30 @@
+/**
+ * Creates a new object of the entries of `obj` that satisfy the predicate.
+ *
+ * @template T - The type of the source object.
+ * @param obj - The object to pick entries from.
+ * @param shouldPick - Called with each value and key; return `true` to keep the entry.
+ * @returns A new object holding only the entries the predicate kept.
+ *
+ * @example
+ * pickBy({ a: 1, b: 2 }, (value) => value > 1); // { b: 2 }
+ * pickBy({ a: 1, b: 2 }, (_value, key) => key !== "a"); // { b: 2 }
+ */
+function pickBy<T extends Record<string, unknown>>(
+    obj: T,
+    shouldPick: (value: T[keyof T], key: keyof T) => boolean,
+): Partial<T> {
+    const result: Partial<T> = {};
+
+    for (const key of Object.keys(obj) as (keyof T)[]) {
+        const value = obj[key];
+
+        if (shouldPick(value, key)) {
+            result[key] = value;
+        }
+    }
+
+    return result;
+}
+
+export { pickBy };

package/src/object/structured-clone.ts

@@ -0,0 +1,31 @@
+import { isPlainObject } from "../predicate/is-plain-object.js";
+
+/**
+ * Recursively copies arrays and plain objects, sharing every other value by reference. The result
+ * mirrors exactly the structure `isDeepEqual` traverses, so comparing a value against its earlier
+ * clone detects in-place mutations of the original. Unlike the global of the same name, class
+ * instances such as `Date` and `Map` are shared rather than copied, and no value is ever rejected.
+ *
+ * @template T - The type of the value.
+ * @param value - The value to clone.
+ * @returns A clone whose arrays and plain objects are fresh and whose other values are shared.
+ *
+ * @example
+ * const source = { a: [{ b: 1 }] };
+ * const copy = structuredClone(source);
+ * source.a[0].b = 2;
+ * copy.a[0].b; // 1
+ */
+function structuredClone<T>(value: T): T {
+    if (Array.isArray(value)) {
+        return value.map((item: unknown) => structuredClone(item)) as T;
+    }
+
+    if (isPlainObject(value)) {
+        return Object.fromEntries(Object.entries(value).map(([key, entry]) => [key, structuredClone(entry)])) as T;
+    }
+
+    return value;
+}
+
+export { structuredClone };

package/src/predicate/are-object-keys-equal.ts

@@ -0,0 +1,15 @@
+const areObjectKeysEqual = (
+    a: Record<string, unknown>,
+    b: Record<string, unknown>,
+    isValueEqual: (a: unknown, b: unknown) => boolean,
+): boolean => {
+    const keysA = Object.keys(a);
+
+    if (keysA.length !== Object.keys(b).length) {
+        return false;
+    }
+
+    return keysA.every((key) => Object.hasOwn(b, key) && isValueEqual(a[key], b[key]));
+};
+
+export { areObjectKeysEqual };

package/src/predicate/index.ts

@@ -0,0 +1,6 @@
+export { isDeepEqual } from "./is-deep-equal.js";
+export { isPlainObject } from "./is-plain-object.js";
+export { isRecord } from "./is-record.js";
+export { isSameArrayBy } from "./is-same-array-by.js";
+export { isSameArray } from "./is-same-array.js";
+export { isShallowEqual } from "./is-shallow-equal.js";

package/src/predicate/is-deep-equal.ts

@@ -0,0 +1,41 @@
+import { areObjectKeysEqual } from "./are-object-keys-equal.js";
+import { isPlainObject } from "./is-plain-object.js";
+
+/**
+ * Checks whether two values are deeply equal: identical, arrays of the same length whose elements
+ * are deeply equal in order, or plain objects with the same own enumerable keys and deeply equal
+ * values. Values that are neither both arrays nor both plain objects are equal only when identical.
+ *
+ * @param a - The first value.
+ * @param b - The second value.
+ * @returns `true` when the values are deeply equal.
+ *
+ * @example
+ * isDeepEqual({ a: [1, { b: 2 }] }, { a: [1, { b: 2 }] }); // true
+ * isDeepEqual({ a: [1] }, { a: [2] }); // false
+ */
+const isDeepArrayEqual = (a: unknown, b: unknown): boolean => {
+    if (!Array.isArray(a) || !Array.isArray(b) || a.length !== b.length) {
+        return false;
+    }
+
+    return a.every((item, index) => isDeepEqual(item, b[index]));
+};
+
+function isDeepEqual(a: unknown, b: unknown): boolean {
+    if (a === b) {
+        return true;
+    }
+
+    if (Array.isArray(a) || Array.isArray(b)) {
+        return isDeepArrayEqual(a, b);
+    }
+
+    if (isPlainObject(a) && isPlainObject(b)) {
+        return areObjectKeysEqual(a, b, isDeepEqual);
+    }
+
+    return false;
+}
+
+export { isDeepEqual };

package/src/predicate/is-plain-object.ts

@@ -0,0 +1,25 @@
+/**
+ * Checks whether a value is a plain object, i.e. one whose prototype is `Object.prototype` or `null`.
+ *
+ * Class instances, arrays, and other exotic objects return `false`.
+ *
+ * @param value - The value to test.
+ * @returns `true` when `value` is a plain object.
+ *
+ * @example
+ * isPlainObject({ a: 1 }); // true
+ * isPlainObject(Object.create(null)); // true
+ * isPlainObject([1, 2]); // false
+ * isPlainObject(new Date()); // false
+ */
+function isPlainObject(value: unknown): value is Record<string, unknown> {
+    if (typeof value !== "object" || value === null) {
+        return false;
+    }
+
+    const proto: unknown = Object.getPrototypeOf(value);
+
+    return proto === Object.prototype || proto === null;
+}
+
+export { isPlainObject };

package/src/predicate/is-record.ts

@@ -0,0 +1,16 @@
+/**
+ * Checks whether a value is a non-null object (including arrays and class instances, excluding `null`).
+ *
+ * @param value - The value to test.
+ * @returns `true` when `value` is a non-null object.
+ *
+ * @example
+ * isRecord({ a: 1 }); // true
+ * isRecord(null); // false
+ * isRecord("x"); // false
+ */
+function isRecord(value: unknown): value is Record<string, unknown> {
+    return typeof value === "object" && value !== null;
+}
+
+export { isRecord };

package/src/predicate/is-same-array-by.ts

@@ -0,0 +1,21 @@
+/**
+ * Checks whether two arrays have the same length and elements the comparator treats as equal, in order.
+ *
+ * @template T - The type of the array elements.
+ * @param a - The first array.
+ * @param b - The second array.
+ * @param isEqual - Compares elements at the same index; return `true` when they are equal.
+ * @returns `true` when the arrays are element-wise equal under `isEqual`.
+ *
+ * @example
+ * isSameArrayBy([{ id: 1 }], [{ id: 1 }], (x, y) => x.id === y.id); // true
+ */
+function isSameArrayBy<T>(a: T[], b: T[], isEqual: (x: T, y: T) => boolean): boolean {
+    if (a.length !== b.length) {
+        return false;
+    }
+
+    return a.every((item, index) => isEqual(item, b[index] as T));
+}
+
+export { isSameArrayBy };

package/src/predicate/is-same-array.ts

@@ -0,0 +1,19 @@
+import { isSameArrayBy } from "./is-same-array-by.js";
+
+/**
+ * Checks whether two arrays have the same length and strictly equal (`===`) elements in order.
+ *
+ * @template T - The type of the array elements.
+ * @param a - The first array.
+ * @param b - The second array.
+ * @returns `true` when the arrays are element-wise strictly equal.
+ *
+ * @example
+ * isSameArray([1, 2], [1, 2]); // true
+ * isSameArray([1, 2], [2, 1]); // false
+ */
+function isSameArray<T>(a: T[], b: T[]): boolean {
+    return isSameArrayBy(a, b, (x, y) => x === y);
+}
+
+export { isSameArray };

package/src/predicate/is-shallow-equal.ts

@@ -0,0 +1,32 @@
+import { areObjectKeysEqual } from "./are-object-keys-equal.js";
+import { isPlainObject } from "./is-plain-object.js";
+
+/**
+ * Checks whether two values are shallowly equal: identical, or plain objects with the same own
+ * enumerable keys and strictly equal (`===`) values. Values that are not both plain objects are
+ * equal only when identical.
+ *
+ * @param a - The first value.
+ * @param b - The second value.
+ * @returns `true` when the values are shallowly equal.
+ *
+ * @example
+ * isShallowEqual({ a: 1 }, { a: 1 }); // true
+ * isShallowEqual({ a: 1 }, { a: 2 }); // false
+ * isShallowEqual(3, 3); // true
+ */
+const isStrictEqual = (a: unknown, b: unknown): boolean => a === b;
+
+function isShallowEqual(a: unknown, b: unknown): boolean {
+    if (a === b) {
+        return true;
+    }
+
+    if (isPlainObject(a) && isPlainObject(b)) {
+        return areObjectKeysEqual(a, b, isStrictEqual);
+    }
+
+    return false;
+}
+
+export { isShallowEqual };

package/src/process/exit-code-for-signal.ts

@@ -0,0 +1,20 @@
+/**
+ * Maps a terminating signal to its conventional process exit code (130 for `SIGINT`, 143 otherwise),
+ * or 0 when no signal is given.
+ *
+ * @param signal - The signal that triggered termination, or `null`.
+ * @returns The conventional exit code for the signal.
+ *
+ * @example
+ * exitCodeForSignal("SIGINT"); // 130
+ * exitCodeForSignal(null); // 0
+ */
+function exitCodeForSignal(signal: NodeJS.Signals | null): number {
+    if (!signal) {
+        return 0;
+    }
+
+    return signal === "SIGINT" ? 130 : 143;
+}
+
+export { exitCodeForSignal };

package/src/process/index.ts

@@ -0,0 +1,3 @@
+export { exitCodeForSignal } from "./exit-code-for-signal.js";
+export { installGracefulShutdown } from "./install-graceful-shutdown.js";
+export { resolveExecutable } from "./resolve-executable.js";

package/src/process/install-graceful-shutdown.ts

@@ -0,0 +1,126 @@
+import { error } from "../log/default-logger.js";
+import { exitCodeForSignal } from "./exit-code-for-signal.js";
+
+type GracefulShutdownOptions = {
+    onSignal: (signal: NodeJS.Signals) => void | Promise<void>;
+    onForce?: () => void;
+    forceKillAfterMs?: number;
+    coalesceWindowMs?: number;
+    exitCode?: (signal: NodeJS.Signals, isGraceful: boolean) => number;
+};
+
+type ShutdownState = {
+    options: GracefulShutdownOptions;
+    forceKillMs: number;
+    coalesceWindowMs: number;
+    firstSignal: NodeJS.Signals | null;
+    exited: boolean;
+    coalescing: boolean;
+    forceTimer: NodeJS.Timeout | null;
+    coalesceTimer: NodeJS.Timeout | null;
+};
+
+const HANDLED_SIGNALS = ["SIGINT", "SIGTERM", "SIGHUP"] as const satisfies NodeJS.Signals[];
+const DEFAULT_FORCE_KILL_TIMEOUT_MS = 5000;
+const DEFAULT_COALESCE_WINDOW_MS = 500;
+
+const clearTimers = (state: ShutdownState): void => {
+    if (state.forceTimer) {
+        clearTimeout(state.forceTimer);
+        state.forceTimer = null;
+    }
+
+    if (state.coalesceTimer) {
+        clearTimeout(state.coalesceTimer);
+        state.coalesceTimer = null;
+    }
+};
+
+const finish = (state: ShutdownState, signal: NodeJS.Signals, isGraceful: boolean): void => {
+    if (state.exited) {
+        return;
+    }
+
+    state.exited = true;
+    clearTimers(state);
+    const { exitCode } = state.options;
+    const defaultCode = isGraceful ? 0 : exitCodeForSignal(signal);
+    process.exit(exitCode ? exitCode(signal, isGraceful) : defaultCode);
+};
+
+const runShutdown = async (state: ShutdownState, signal: NodeJS.Signals): Promise<void> => {
+    try {
+        await state.options.onSignal(signal);
+        finish(state, signal, true);
+    } catch (error_) {
+        error("graceful shutdown failed", error_);
+        finish(state, signal, false);
+    }
+};
+
+const beginShutdown = (state: ShutdownState, signal: NodeJS.Signals): void => {
+    state.firstSignal = signal;
+
+    if (state.coalesceWindowMs > 0) {
+        state.coalescing = true;
+
+        state.coalesceTimer = setTimeout(() => {
+            state.coalescing = false;
+        }, state.coalesceWindowMs);
+
+        state.coalesceTimer.unref();
+    }
+
+    if (state.options.onForce && state.forceKillMs > 0) {
+        state.forceTimer = setTimeout(() => {
+            state.options.onForce?.();
+            finish(state, signal, false);
+        }, state.forceKillMs);
+
+        state.forceTimer.unref();
+    }
+
+    void runShutdown(state, signal);
+};
+
+const handle = (state: ShutdownState, signal: NodeJS.Signals): void => {
+    if (state.firstSignal === null) {
+        beginShutdown(state, signal);
+
+        return;
+    }
+
+    if (state.coalescing) {
+        return;
+    }
+
+    state.options.onForce?.();
+    finish(state, signal, false);
+};
+
+/**
+ * Registers handlers for `SIGINT`, `SIGTERM`, and `SIGHUP` that run the given cleanup callback once
+ * and then exit, forcing exit if a repeated signal arrives or the cleanup exceeds its timeout.
+ *
+ * @param options - The shutdown callbacks and timing configuration.
+ */
+function installGracefulShutdown(options: GracefulShutdownOptions): void {
+    const state: ShutdownState = {
+        options,
+        forceKillMs: options.forceKillAfterMs ?? DEFAULT_FORCE_KILL_TIMEOUT_MS,
+        coalesceWindowMs: options.coalesceWindowMs ?? DEFAULT_COALESCE_WINDOW_MS,
+        firstSignal: null,
+        exited: false,
+        coalescing: false,
+        forceTimer: null,
+        coalesceTimer: null,
+    };
+
+    for (const sig of HANDLED_SIGNALS) {
+        process.on(sig, () => {
+            handle(state, sig);
+        });
+    }
+}
+
+export { installGracefulShutdown, type GracefulShutdownOptions };

package/src/process/resolve-executable.ts

@@ -0,0 +1,57 @@
+import { accessSync, constants } from "node:fs";
+import { delimiter, isAbsolute, join, resolve } from "node:path";
+
+const isExecutable = (path: string): boolean => {
+    try {
+        accessSync(path, constants.X_OK);
+
+        return true;
+    } catch {
+        return false;
+    }
+};
+
+const findOnPath = (command: string): string | undefined => {
+    const searchPaths = (process.env.PATH ?? "").split(delimiter).filter((entry) => entry.length > 0);
+
+    for (const directory of searchPaths) {
+        const candidate = join(directory, command);
+
+        if (isExecutable(candidate)) {
+            return candidate;
+        }
+    }
+
+    return undefined;
+};
+
+/**
+ * Resolves an executable to an absolute path, searching `PATH` only for a bare command name, so
+ * spawning it never re-runs a lookup against a `PATH` that may have changed.
+ *
+ * @param command - An executable name, or a path to one.
+ * @returns The absolute path of the executable.
+ * @throws When a bare command name is not found on `PATH`.
+ *
+ * @example
+ * resolveExecutable("weston"); // "/usr/bin/weston"
+ */
+function resolveExecutable(command: string): string {
+    if (isAbsolute(command)) {
+        return command;
+    }
+
+    if (command.includes("/")) {
+        return resolve(command);
+    }
+
+    const found = findOnPath(command);
+
+    if (found === undefined) {
+        throw new Error(`Cannot find the "${command}" executable on PATH`);
+    }
+
+    return found;
+}
+
+export { resolveExecutable };

package/src/set/drain.ts

@@ -0,0 +1,17 @@
+/**
+ * Iterates every item currently in `set`, then clears it. Use it to drain a set of pending work
+ * accumulated since the last drain.
+ *
+ * @template T - The set item type.
+ * @param set - The set to drain and clear.
+ * @param visit - Called with each item before the set is cleared.
+ */
+const drain = <T>(set: Set<T>, visit: (item: T) => void): void => {
+    for (const item of set) {
+        visit(item);
+    }
+
+    set.clear();
+};
+
+export { drain };