@gtkx/utils 1.6.0 → 2.0.0-beta.2

package/src/process/spawn-with-parent-death-signal.ts

@@ -4,22 +4,49 @@ import { Socket } from "node:net";
 import { dirname, extname, join } from "node:path";
 import { fileURLToPath } from "node:url";
 import { killMarkedProcesses, PROCESS_MARKER } from "./kill-marked-processes.ts";
+import {
+    type CleanupDirectoryIdentity,
+    cleanupDirectoryIdentity,
+    killProcessGroup,
+    type ProcessGroupIdentity,
+    processGroupIdentity,
+    removeCleanupDirectory,
+} from "./kill-process-group.ts";
 import { resolveExecutable } from "./resolve-executable.ts";
 
 type ParentDeathSpawnOptions = {
     stdio?: StdioOptions;
     env?: NodeJS.ProcessEnv;
+    cleanupDirectories?: string[];
+};
+
+type GuardJob = {
+    marker: string;
+    processGroup: ProcessGroupIdentity;
+    cleanupDirectories: CleanupDirectoryIdentity[];
 };
 
 type GuardState = {
     child?: ChildProcess | undefined;
+    jobs: Map<string, GuardJob>;
+};
+
+type SpawnRollback = {
+    child: ChildProcess;
+    marker: string;
+    processGroup?: ProcessGroupIdentity | undefined;
+    cleanupDirectories?: CleanupDirectoryIdentity[] | undefined;
 };
 
 const MODULE_PATH = fileURLToPath(import.meta.url);
 const GUARD_PATH = join(dirname(MODULE_PATH), `process-guard${extname(MODULE_PATH)}`);
 const RUN_ID = randomBytes(8).toString("hex");
 const RUN_PREFIX = `${PROCESS_MARKER}=${RUN_ID}/`;
-const guard: GuardState = {};
+const guard: GuardState = { jobs: new Map() };
+
+const writeGuardCommand = (child: ChildProcess, operation: "+" | "-", job: GuardJob): void => {
+    child.stdin?.write(`${operation}${JSON.stringify(job)}\n`);
+};
 
 const releaseGuard = (child: ChildProcess): void => {
     child.unref();
@@ -41,13 +68,62 @@ const startGuard = (): void => {
     });
 
     child.on("error", () => {
-        guard.child = undefined;
+        if (guard.child === child) {
+            guard.child = undefined;
+        }
+    });
+
+    child.on("exit", () => {
+        if (guard.child === child) {
+            guard.child = undefined;
+        }
+    });
+
+    child.stdin.on("error", () => {
+        if (guard.child === child) {
+            guard.child = undefined;
+        }
     });
 
     guard.child = child;
+
+    for (const job of guard.jobs.values()) {
+        writeGuardCommand(child, "+", job);
+    }
+
     releaseGuard(child);
 };
 
+const registerJob = (job: GuardJob): void => {
+    guard.jobs.set(job.marker, job);
+
+    if (guard.child) {
+        writeGuardCommand(guard.child, "+", job);
+    }
+};
+
+const unregisterJob = (job: GuardJob): void => {
+    guard.jobs.delete(job.marker);
+
+    if (guard.child) {
+        writeGuardCommand(guard.child, "-", job);
+    }
+};
+
+const rollbackSpawn = ({ child, marker, processGroup, cleanupDirectories = [] }: SpawnRollback): void => {
+    if (processGroup === undefined) {
+        child.kill("SIGKILL");
+    } else {
+        killProcessGroup(processGroup);
+    }
+
+    killMarkedProcesses(marker);
+
+    for (const identity of cleanupDirectories) {
+        removeCleanupDirectory(identity);
+    }
+};
+
 function spawnWithParentDeathSignal(
     command: string,
     args: string[],
@@ -56,6 +132,7 @@ function spawnWithParentDeathSignal(
     const executable = resolveExecutable(command);
     const setpriv = resolveExecutable("setpriv");
     const jobValue = `${RUN_ID}/${randomBytes(4).toString("hex")}`;
+    const marker = `${PROCESS_MARKER}=${jobValue}`;
     startGuard();
 
     const child = spawn(setpriv, ["--pdeathsig", "SIGKILL", executable, ...args], {
@@ -64,8 +141,34 @@ function spawnWithParentDeathSignal(
         env: { ...(options.env ?? process.env), [PROCESS_MARKER]: jobValue },
     });
 
+    const processGroupId = child.pid;
+    const group = processGroupId === undefined ? undefined : processGroupIdentity(processGroupId);
+
+    if (group === undefined) {
+        rollbackSpawn({ child, marker });
+        throw new Error(`Failed to identify process group for ${command}`);
+    }
+
+    const cleanupDirectories = (options.cleanupDirectories ?? []).map((path) => cleanupDirectoryIdentity(path));
+
+    if (cleanupDirectories.includes(undefined)) {
+        const captured = cleanupDirectories.filter(
+            (identity): identity is CleanupDirectoryIdentity => identity !== undefined,
+        );
+        rollbackSpawn({ child, marker, processGroup: group, cleanupDirectories: captured });
+        throw new Error(`Failed to identify a cleanup directory for ${command}`);
+    }
+
+    const job: GuardJob = {
+        marker,
+        processGroup: group,
+        cleanupDirectories: cleanupDirectories.filter((identity) => identity !== undefined),
+    };
+    registerJob(job);
+
     child.on("exit", () => {
-        killMarkedProcesses(`${PROCESS_MARKER}=${jobValue}`);
+        killMarkedProcesses(job.marker);
+        unregisterJob(job);
     });
 
     return child;

package/dist/map/get-or-insert.d.ts

@@ -1,8 +0,0 @@
-type GetSet<K, V> = {
-    get(key: K): V | undefined;
-    set(key: K, value: V): unknown;
-    has(key: K): boolean;
-};
-declare function getOrInsert<K, V>(map: GetSet<K, V>, key: K, factory: (key: K) => V): V;
-export { getOrInsert };
-//# sourceMappingURL=get-or-insert.d.ts.map

package/dist/map/get-or-insert.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"get-or-insert.d.ts","sourceRoot":"","sources":["../../src/map/get-or-insert.ts"],"names":[],"mappings":"AAAA,KAAK,MAAM,CAAC,CAAC,EAAE,CAAC,IAAI;IAChB,GAAG,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,GAAG,SAAS,CAAC;IAC3B,GAAG,CAAC,GAAG,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,OAAO,CAAC;IAC/B,GAAG,CAAC,GAAG,EAAE,CAAC,GAAG,OAAO,CAAC;CACxB,CAAC;AAEF,iBAAS,WAAW,CAAC,CAAC,EAAE,CAAC,EAAE,GAAG,EAAE,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,OAAO,EAAE,CAAC,GAAG,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAS/E;AAED,OAAO,EAAE,WAAW,EAAE,CAAC"}

package/dist/map/get-or-insert.js

@@ -1,10 +0,0 @@
-function getOrInsert(map, key, factory) {
-    if (map.has(key)) {
-        return map.get(key);
-    }
-    const value = factory(key);
-    map.set(key, value);
-    return value;
-}
-export { getOrInsert };
-//# sourceMappingURL=get-or-insert.js.map

package/dist/map/get-or-insert.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"get-or-insert.js","sourceRoot":"","sources":["../../src/map/get-or-insert.ts"],"names":[],"mappings":"AAMA,SAAS,WAAW,CAAO,GAAiB,EAAE,GAAM,EAAE,OAAsB;IACxE,IAAI,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC;QACf,OAAO,GAAG,CAAC,GAAG,CAAC,GAAG,CAAM,CAAC;IAC7B,CAAC;IAED,MAAM,KAAK,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;IAC3B,GAAG,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;IAEpB,OAAO,KAAK,CAAC;AACjB,CAAC;AAED,OAAO,EAAE,WAAW,EAAE,CAAC","sourcesContent":["type GetSet<K, V> = {\n    get(key: K): V | undefined;\n    set(key: K, value: V): unknown;\n    has(key: K): boolean;\n};\n\nfunction getOrInsert<K, V>(map: GetSet<K, V>, key: K, factory: (key: K) => V): V {\n    if (map.has(key)) {\n        return map.get(key) as V;\n    }\n\n    const value = factory(key);\n    map.set(key, value);\n\n    return value;\n}\n\nexport { getOrInsert };\n"]}

package/dist/map/index.d.ts

@@ -1,2 +0,0 @@
-export { getOrInsert } from "./get-or-insert.ts";
-//# sourceMappingURL=index.d.ts.map

package/dist/map/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/map/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC"}

package/dist/map/index.js

@@ -1,2 +0,0 @@
-export { getOrInsert } from "./get-or-insert.js";
-//# sourceMappingURL=index.js.map

package/dist/map/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/map/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC","sourcesContent":["export { getOrInsert } from \"./get-or-insert.ts\";\n"]}

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

@@ -1,18 +0,0 @@
-type GetSet<K, V> = {
-    get(key: K): V | undefined;
-    set(key: K, value: V): unknown;
-    has(key: K): boolean;
-};
-
-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 };

package/src/map/index.ts

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