@orkestrel/process 0.0.9 → 0.0.11
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +18 -23
- package/dist/src/core/index.cjs +33 -17
- package/dist/src/core/index.cjs.map +1 -1
- package/dist/src/core/index.d.cts +171 -148
- package/dist/src/core/index.d.ts +171 -148
- package/dist/src/core/index.js +33 -17
- package/dist/src/core/index.js.map +1 -1
- package/dist/src/server/index.cjs +157 -97
- package/dist/src/server/index.cjs.map +1 -1
- package/dist/src/server/index.d.cts +316 -93
- package/dist/src/server/index.d.ts +316 -93
- package/dist/src/server/index.js +157 -98
- package/dist/src/server/index.js.map +1 -1
- package/package.json +11 -12
package/dist/src/core/index.js
CHANGED
|
@@ -1,12 +1,12 @@
|
|
|
1
1
|
import { holds, isError } from "@orkestrel/contract";
|
|
2
2
|
//#region src/core/constants.ts
|
|
3
|
-
/**
|
|
3
|
+
/** Names the default cooperative POSIX window, 5000 ms, between `SIGTERM` and `SIGKILL` during termination. */
|
|
4
4
|
var PROCESS_GRACE = 5e3;
|
|
5
|
-
/**
|
|
5
|
+
/** Names the window, 5000 ms, a termination waits for the child's native exit after the final kill. */
|
|
6
6
|
var PROCESS_CONFIRMATION = 5e3;
|
|
7
7
|
/**
|
|
8
|
-
*
|
|
9
|
-
*
|
|
8
|
+
* Names the default window, 1000 ms, the package waits for the child's read ends to close after the
|
|
9
|
+
* child's native exit or after a termination this package initiated, before cutting them off.
|
|
10
10
|
*
|
|
11
11
|
* @remarks
|
|
12
12
|
* Measured on Windows 11 with Node v24.18.1 on 2026-08-21, spawning the `tests/src/server/fixtures`
|
|
@@ -20,17 +20,20 @@ var PROCESS_CONFIRMATION = 5e3;
|
|
|
20
20
|
* finite close measured, and it keeps an unreachable descendant from stretching a shutdown.
|
|
21
21
|
*/
|
|
22
22
|
var PROCESS_DRAIN = 1e3;
|
|
23
|
-
/**
|
|
23
|
+
/** Names the default maximum retained stderr tail, 2048 bytes, for a supervised {@link ProcessInterface}. */
|
|
24
24
|
var PROCESS_EVIDENCE = 2048;
|
|
25
|
-
/**
|
|
25
|
+
/** Names the default soft high-water mark, 10485760 bytes, for a supervised {@link ProcessInterface} line backlog. */
|
|
26
26
|
var PROCESS_BACKLOG = 10485760;
|
|
27
|
-
/**
|
|
27
|
+
/** Names the default maximum captured bytes, 10485760 each, for a one-shot run's stdout and stderr. */
|
|
28
28
|
var PROCESS_OUTPUT = 10485760;
|
|
29
|
-
/**
|
|
29
|
+
/** Names the largest timer delay, 2147483647 ms, the host schedules without truncating it to one. */
|
|
30
30
|
var PROCESS_TIMER = 2147483647;
|
|
31
|
-
/**
|
|
31
|
+
/** Lists the executable extensions a Windows lookup applies when the environment declares no `PATHEXT`, `.COM;.EXE;.BAT;.CMD`. */
|
|
32
32
|
var PROCESS_PATHEXT = ".COM;.EXE;.BAT;.CMD";
|
|
33
|
-
/**
|
|
33
|
+
/**
|
|
34
|
+
* Lists the machine-readable failure categories a {@link ProcessError} carries, in declaration order:
|
|
35
|
+
* `spawn`, `timeout`, `input`, `duplicate`, `protocol`, and `invalid`.
|
|
36
|
+
*/
|
|
34
37
|
var PROCESS_ERROR_CODES = Object.freeze([
|
|
35
38
|
"spawn",
|
|
36
39
|
"timeout",
|
|
@@ -41,15 +44,26 @@ var PROCESS_ERROR_CODES = Object.freeze([
|
|
|
41
44
|
]);
|
|
42
45
|
//#endregion
|
|
43
46
|
//#region src/core/errors.ts
|
|
44
|
-
/**
|
|
47
|
+
/**
|
|
48
|
+
* Represents a child-process failure with a stable machine-readable category.
|
|
49
|
+
*
|
|
50
|
+
* @example
|
|
51
|
+
* ```ts
|
|
52
|
+
* const error = new ProcessError('git status refused', {
|
|
53
|
+
* code: 'invalid',
|
|
54
|
+
* context: { command: 'git status' },
|
|
55
|
+
* })
|
|
56
|
+
* error.code // 'invalid'
|
|
57
|
+
* ```
|
|
58
|
+
*/
|
|
45
59
|
var ProcessError = class extends Error {
|
|
46
60
|
name = "ProcessError";
|
|
47
61
|
code;
|
|
48
62
|
context;
|
|
49
|
-
/**
|
|
63
|
+
/** Carries the buffered run outcome, present when a one-shot run produced the failure. */
|
|
50
64
|
result;
|
|
51
65
|
/**
|
|
52
|
-
*
|
|
66
|
+
* Creates a process error.
|
|
53
67
|
*
|
|
54
68
|
* @param message - Human-readable failure description
|
|
55
69
|
* @param options - Machine-readable category, optional context, optional cause, and optional run result
|
|
@@ -74,7 +88,7 @@ var ProcessError = class extends Error {
|
|
|
74
88
|
* plain or property-only lookalike.
|
|
75
89
|
*
|
|
76
90
|
* @param value - The value to inspect
|
|
77
|
-
* @returns True
|
|
91
|
+
* @returns True if the value is a `ProcessError` instance; false otherwise
|
|
78
92
|
*
|
|
79
93
|
* @example
|
|
80
94
|
* ```ts
|
|
@@ -93,7 +107,7 @@ function isProcessError(value) {
|
|
|
93
107
|
});
|
|
94
108
|
}
|
|
95
109
|
/**
|
|
96
|
-
* Creates the failure raised when a manager launch reuses a live id.
|
|
110
|
+
* Creates the `duplicate`-coded failure raised when a manager launch reuses a live id.
|
|
97
111
|
*
|
|
98
112
|
* @param id - The id already occupied by a live child
|
|
99
113
|
* @returns A typed duplicate-id failure
|
|
@@ -105,7 +119,8 @@ function createDuplicateError(id) {
|
|
|
105
119
|
});
|
|
106
120
|
}
|
|
107
121
|
/**
|
|
108
|
-
* Creates the failure raised when a launch is attempted on a registry that is
|
|
122
|
+
* Creates the `protocol`-coded failure raised when a launch is attempted on a registry that is
|
|
123
|
+
* being destroyed.
|
|
109
124
|
*
|
|
110
125
|
* @param id - The id the refused launch asked for
|
|
111
126
|
* @returns A typed protocol failure
|
|
@@ -117,7 +132,8 @@ function createProtocolError(id) {
|
|
|
117
132
|
});
|
|
118
133
|
}
|
|
119
134
|
/**
|
|
120
|
-
* Creates the failure raised when a public input is refused before anything is
|
|
135
|
+
* Creates the `invalid`-coded failure raised when a public input is refused before anything is
|
|
136
|
+
* spawned.
|
|
121
137
|
*
|
|
122
138
|
* @param subject - The rejected input named as the caller wrote it, such as `option 'grace'`
|
|
123
139
|
* @param value - The rejected value, carried as `context.value`
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","names":[],"sources":["../../../src/core/constants.ts","../../../src/core/errors.ts"],"sourcesContent":["/**
|
|
1
|
+
{"version":3,"file":"index.js","names":[],"sources":["../../../src/core/constants.ts","../../../src/core/errors.ts"],"sourcesContent":["/** Names the default cooperative POSIX window, 5000 ms, between `SIGTERM` and `SIGKILL` during termination. */\nexport const PROCESS_GRACE = 5_000\n\n/** Names the window, 5000 ms, a termination waits for the child's native exit after the final kill. */\nexport const PROCESS_CONFIRMATION = 5_000\n\n/**\n * Names the default window, 1000 ms, the package waits for the child's read ends to close after the\n * child's native exit or after a termination this package initiated, before cutting them off.\n *\n * @remarks\n * Measured on Windows 11 with Node v24.18.1 on 2026-08-21, spawning the `tests/src/server/fixtures`\n * child modes as real children and timing the host `close` event against the host `exit` event.\n * Every ordinary run closed within 0.02ms of the native exit, whether the child ended itself or a\n * kill ended it, and a `taskkill /F /T` that reaped a descendant while the root was still alive\n * closed within 0.01ms. The only finite late close came from a descendant that outlived its root and\n * then ended on its own, at 127.44ms to 193.41ms — that lag is the descendant's own remaining life\n * rather than a flush cost. A descendant that never ends never closes, so the distribution has no\n * finite tail to cover and this value bounds it instead: 1000ms is over five times the slowest\n * finite close measured, and it keeps an unreachable descendant from stretching a shutdown.\n */\nexport const PROCESS_DRAIN = 1_000\n\n/** Names the default maximum retained stderr tail, 2048 bytes, for a supervised {@link ProcessInterface}. */\nexport const PROCESS_EVIDENCE = 2_048\n\n/** Names the default soft high-water mark, 10485760 bytes, for a supervised {@link ProcessInterface} line backlog. */\nexport const PROCESS_BACKLOG = 10_485_760\n\n/** Names the default maximum captured bytes, 10485760 each, for a one-shot run's stdout and stderr. */\nexport const PROCESS_OUTPUT = 10_485_760\n\n/** Names the largest timer delay, 2147483647 ms, the host schedules without truncating it to one. */\nexport const PROCESS_TIMER = 2_147_483_647\n\n/** Lists the executable extensions a Windows lookup applies when the environment declares no `PATHEXT`, `.COM;.EXE;.BAT;.CMD`. */\nexport const PROCESS_PATHEXT = '.COM;.EXE;.BAT;.CMD'\n\n/**\n * Lists the machine-readable failure categories a {@link ProcessError} carries, in declaration order:\n * `spawn`, `timeout`, `input`, `duplicate`, `protocol`, and `invalid`.\n */\nexport const PROCESS_ERROR_CODES = Object.freeze([\n\t'spawn',\n\t'timeout',\n\t'input',\n\t'duplicate',\n\t'protocol',\n\t'invalid',\n] as const)\n","import type {\n\tProcessErrorCode,\n\tProcessErrorContext,\n\tProcessErrorOptions,\n\tExecuteResult,\n} from './types.js'\nimport { holds, isError } from '@orkestrel/contract'\nimport { PROCESS_ERROR_CODES } from './constants.js'\n\n/**\n * Represents a child-process failure with a stable machine-readable category.\n *\n * @example\n * ```ts\n * const error = new ProcessError('git status refused', {\n * \tcode: 'invalid',\n * \tcontext: { command: 'git status' },\n * })\n * error.code // 'invalid'\n * ```\n */\nexport class ProcessError extends Error {\n\toverride readonly name = 'ProcessError'\n\treadonly code: ProcessErrorCode\n\treadonly context?: ProcessErrorContext\n\t/** Carries the buffered run outcome, present when a one-shot run produced the failure. */\n\treadonly result?: ExecuteResult\n\n\t/**\n\t * Creates a process error.\n\t *\n\t * @param message - Human-readable failure description\n\t * @param options - Machine-readable category, optional context, optional cause, and optional run result\n\t */\n\tconstructor(message: string, options: ProcessErrorOptions) {\n\t\tconst cause = options.cause\n\t\tsuper(message, cause === undefined ? undefined : { cause })\n\t\tObject.defineProperty(this, Symbol.for('@orkestrel/process.error'), { value: true })\n\t\tthis.code = options.code\n\t\tif (options.context !== undefined) this.context = options.context\n\t\tif (options.result !== undefined) this.result = options.result\n\t}\n}\n\n/**\n * Checks whether an unknown value is a {@link ProcessError}.\n *\n * @remarks\n * Recognition combines a global own-property brand with the native `Error` base, the subclass\n * prototype, the fixed name, and a code {@link PROCESS_ERROR_CODES} declares. The brand is\n * recognized across duplicate installations and ESM/CommonJS module copies at 0.0.4 or later. A copy\n * earlier than 0.0.4 stamps no brand, so an error it throws stays outside the type, and so does a\n * plain or property-only lookalike.\n *\n * @param value - The value to inspect\n * @returns True if the value is a `ProcessError` instance; false otherwise\n *\n * @example\n * ```ts\n * isProcessError(new ProcessError('spawn failed', { code: 'spawn' })) // true\n * isProcessError(new Error('spawn failed')) // false\n * ```\n */\nexport function isProcessError(value: unknown): value is ProcessError {\n\tif (!isError(value)) return false\n\treturn holds(() => {\n\t\tif (Object.getPrototypeOf(value) === Error.prototype) return false\n\t\tif (value.name !== 'ProcessError' || !('code' in value)) return false\n\t\tconst descriptor = Object.getOwnPropertyDescriptor(\n\t\t\tvalue,\n\t\t\tSymbol.for('@orkestrel/process.error'),\n\t\t)\n\t\tif (descriptor?.value !== true) return false\n\t\tconst code: unknown = value.code\n\t\treturn PROCESS_ERROR_CODES.some((declared) => declared === code)\n\t})\n}\n\n/**\n * Creates the `duplicate`-coded failure raised when a manager launch reuses a live id.\n *\n * @param id - The id already occupied by a live child\n * @returns A typed duplicate-id failure\n */\nexport function createDuplicateError(id: string): ProcessError {\n\treturn new ProcessError(`Process '${id}' is already live`, {\n\t\tcode: 'duplicate',\n\t\tcontext: { id },\n\t})\n}\n\n/**\n * Creates the `protocol`-coded failure raised when a launch is attempted on a registry that is\n * being destroyed.\n *\n * @param id - The id the refused launch asked for\n * @returns A typed protocol failure\n */\nexport function createProtocolError(id: string): ProcessError {\n\treturn new ProcessError(`Process '${id}' cannot launch: the registry is destroyed`, {\n\t\tcode: 'protocol',\n\t\tcontext: { id },\n\t})\n}\n\n/**\n * Creates the `invalid`-coded failure raised when a public input is refused before anything is\n * spawned.\n *\n * @param subject - The rejected input named as the caller wrote it, such as `option 'grace'`\n * @param value - The rejected value, carried as `context.value`\n * @returns A typed validation failure\n *\n * @example\n * ```ts\n * createInvalidError(\"option 'grace'\", -1).code // 'invalid'\n * ```\n */\nexport function createInvalidError(subject: string, value: unknown): ProcessError {\n\treturn new ProcessError(`Invalid ${subject}`, { code: 'invalid', context: { value } })\n}\n\n/**\n * Creates the failure raised when a run does not complete successfully and rejection is requested.\n *\n * @remarks\n * The category is `timeout` only when the run's own timeout elapsed; every other failure,\n * including an abort and an output overflow, is a `spawn` failure carrying its\n * {@link ExecuteResult}.\n *\n * @param result - The buffered run outcome that failed\n * @param cause - The underlying host fault, when one ended the run\n * @returns A typed run failure carrying its {@link ExecuteResult}\n */\nexport function createExecuteError(result: ExecuteResult, cause?: unknown): ProcessError {\n\tlet reason = `exited with code ${String(result.code)}`\n\tif (result.signal !== null) reason = `was killed by ${result.signal}`\n\tif (result.truncated) reason = 'exceeded its output limit'\n\tif (result.aborted) reason = 'was aborted'\n\tif (result.expired) reason = 'timed out'\n\treturn new ProcessError(`Command '${result.command}' ${reason}`, {\n\t\tcode: result.expired ? 'timeout' : 'spawn',\n\t\tcontext: { command: result.command, code: result.code, signal: result.signal },\n\t\t...(cause === undefined ? {} : { cause }),\n\t\tresult,\n\t})\n}\n"],"mappings":";;;AACA,IAAa,gBAAgB;;AAG7B,IAAa,uBAAuB;;;;;;;;;;;;;;;;AAiBpC,IAAa,gBAAgB;;AAG7B,IAAa,mBAAmB;;AAGhC,IAAa,kBAAkB;;AAG/B,IAAa,iBAAiB;;AAG9B,IAAa,gBAAgB;;AAG7B,IAAa,kBAAkB;;;;;AAM/B,IAAa,sBAAsB,OAAO,OAAO;CAChD;CACA;CACA;CACA;CACA;CACA;AACD,CAAU;;;;;;;;;;;;;;;AC5BV,IAAa,eAAb,cAAkC,MAAM;CACvC,OAAyB;CACzB;CACA;;CAEA;;;;;;;CAQA,YAAY,SAAiB,SAA8B;EAC1D,MAAM,QAAQ,QAAQ;EACtB,MAAM,SAAS,UAAU,KAAA,IAAY,KAAA,IAAY,EAAE,MAAM,CAAC;EAC1D,OAAO,eAAe,MAAM,OAAO,IAAI,0BAA0B,GAAG,EAAE,OAAO,KAAK,CAAC;EACnF,KAAK,OAAO,QAAQ;EACpB,IAAI,QAAQ,YAAY,KAAA,GAAW,KAAK,UAAU,QAAQ;EAC1D,IAAI,QAAQ,WAAW,KAAA,GAAW,KAAK,SAAS,QAAQ;CACzD;AACD;;;;;;;;;;;;;;;;;;;;AAqBA,SAAgB,eAAe,OAAuC;CACrE,IAAI,CAAC,QAAQ,KAAK,GAAG,OAAO;CAC5B,OAAO,YAAY;EAClB,IAAI,OAAO,eAAe,KAAK,MAAM,MAAM,WAAW,OAAO;EAC7D,IAAI,MAAM,SAAS,kBAAkB,EAAE,UAAU,QAAQ,OAAO;EAKhE,IAJmB,OAAO,yBACzB,OACA,OAAO,IAAI,0BAA0B,CAElC,CAAA,EAAY,UAAU,MAAM,OAAO;EACvC,MAAM,OAAgB,MAAM;EAC5B,OAAO,oBAAoB,MAAM,aAAa,aAAa,IAAI;CAChE,CAAC;AACF;;;;;;;AAQA,SAAgB,qBAAqB,IAA0B;CAC9D,OAAO,IAAI,aAAa,YAAY,GAAG,oBAAoB;EAC1D,MAAM;EACN,SAAS,EAAE,GAAG;CACf,CAAC;AACF;;;;;;;;AASA,SAAgB,oBAAoB,IAA0B;CAC7D,OAAO,IAAI,aAAa,YAAY,GAAG,6CAA6C;EACnF,MAAM;EACN,SAAS,EAAE,GAAG;CACf,CAAC;AACF;;;;;;;;;;;;;;AAeA,SAAgB,mBAAmB,SAAiB,OAA8B;CACjF,OAAO,IAAI,aAAa,WAAW,WAAW;EAAE,MAAM;EAAW,SAAS,EAAE,MAAM;CAAE,CAAC;AACtF;;;;;;;;;;;;;AAcA,SAAgB,mBAAmB,QAAuB,OAA+B;CACxF,IAAI,SAAS,oBAAoB,OAAO,OAAO,IAAI;CACnD,IAAI,OAAO,WAAW,MAAM,SAAS,iBAAiB,OAAO;CAC7D,IAAI,OAAO,WAAW,SAAS;CAC/B,IAAI,OAAO,SAAS,SAAS;CAC7B,IAAI,OAAO,SAAS,SAAS;CAC7B,OAAO,IAAI,aAAa,YAAY,OAAO,QAAQ,IAAI,UAAU;EAChE,MAAM,OAAO,UAAU,YAAY;EACnC,SAAS;GAAE,SAAS,OAAO;GAAS,MAAM,OAAO;GAAM,QAAQ,OAAO;EAAO;EAC7E,GAAI,UAAU,KAAA,IAAY,CAAC,IAAI,EAAE,MAAM;EACvC;CACD,CAAC;AACF"}
|