@qvac/sdk 0.23.0 → 0.24.0
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/NOTICE +115 -58
- package/README.md +10 -13
- package/dist/examples/asr/parakeet-sortformer.js +24 -14
- package/dist/examples/asr/parakeet-transcribepsy-filesystem.js +40 -11
- package/dist/examples/asr/parakeet-unified-coreml.js +14 -9
- package/dist/examples/asr/whispercpp-prompt.js +9 -5
- package/dist/examples/assess-model-fit.d.ts +7 -9
- package/dist/examples/assess-model-fit.js +22 -43
- package/dist/examples/calc-tokens.d.ts +2 -0
- package/dist/examples/calc-tokens.js +21 -0
- package/dist/examples/classification/classify-image.js +11 -5
- package/dist/examples/completion-stop-reason.d.ts +3 -3
- package/dist/examples/completion-stop-reason.js +4 -4
- package/dist/examples/diffusion-flux3-klein.d.ts +2 -0
- package/dist/examples/diffusion-flux3-klein.js +102 -0
- package/dist/examples/diffusion-moss-image.d.ts +2 -0
- package/dist/examples/diffusion-moss-image.js +126 -0
- package/dist/examples/diffusion-qwen-image-21.js +15 -4
- package/dist/examples/embed-multimodal.d.ts +2 -0
- package/dist/examples/embed-multimodal.js +80 -0
- package/dist/examples/embed-p2p.js +2 -2
- package/dist/examples/image/megaloc.d.ts +2 -0
- package/dist/examples/image/megaloc.js +37 -0
- package/dist/examples/llamacpp-multimodal.js +18 -0
- package/dist/examples/rag/rag-hyperdb/pipeline.js +2 -2
- package/dist/examples/rag/rag-turbovec.js +2 -2
- package/dist/examples/sessions.d.ts +17 -0
- package/dist/examples/sessions.js +63 -0
- package/dist/examples/tools/llamacpp-deferred-tools.js +8 -4
- package/dist/scripts/check-resource-collectors-packaging.js +7 -6
- package/dist/scripts/contract/build-contract.d.ts +2 -1
- package/dist/scripts/contract/build-contract.js +13 -1
- package/dist/scripts/contract/constants-registry.d.ts +17 -0
- package/dist/scripts/contract/constants-registry.js +8 -2
- package/dist/scripts/contract/method-shapes.d.ts +4 -0
- package/dist/scripts/contract/method-shapes.js +4 -0
- package/dist/scripts/enforce-inference-versions.d.ts +1 -1
- package/dist/scripts/enforce-inference-versions.js +28 -18
- package/dist/scripts/generate-bare-kit-runtimes.js +101 -69
- package/dist/src/client/api/assess-model-fit.d.ts +17 -17
- package/dist/src/client/api/assess-model-fit.js +18 -31
- package/dist/src/client/api/audio-edit.d.ts +5 -3
- package/dist/src/client/api/audio-edit.js +5 -3
- package/dist/src/client/api/audio-gen-result.js +134 -45
- package/dist/src/client/api/audio-gen.d.ts +40 -3
- package/dist/src/client/api/audio-gen.js +40 -3
- package/dist/src/client/api/audio-understand.d.ts +2 -2
- package/dist/src/client/api/audio-understand.js +2 -2
- package/dist/src/client/api/batch-completion.js +2 -1
- package/dist/src/client/api/calc-tokens.d.ts +33 -0
- package/dist/src/client/api/calc-tokens.js +44 -0
- package/dist/src/client/api/cancel.d.ts +2 -2
- package/dist/src/client/api/cancel.js +2 -2
- package/dist/src/client/api/classify.d.ts +12 -5
- package/dist/src/client/api/classify.js +17 -5
- package/dist/src/client/api/client-request-id.d.ts +0 -15
- package/dist/src/client/api/client-request-id.js +15 -12
- package/dist/src/client/api/completion-stream.d.ts +8 -1
- package/dist/src/client/api/completion-stream.js +10 -1
- package/dist/src/client/api/delete-cache.d.ts +9 -2
- package/dist/src/client/api/delete-cache.js +13 -3
- package/dist/src/client/api/diffusion.d.ts +20 -4
- package/dist/src/client/api/diffusion.js +23 -5
- package/dist/src/client/api/embed.d.ts +82 -29
- package/dist/src/client/api/embed.js +64 -19
- package/dist/src/client/api/get-model-info.d.ts +2 -2
- package/dist/src/client/api/get-model-info.js +2 -2
- package/dist/src/client/api/get-system-resources.d.ts +2 -2
- package/dist/src/client/api/get-system-resources.js +2 -2
- package/dist/src/client/api/heartbeat.d.ts +3 -2
- package/dist/src/client/api/heartbeat.js +3 -2
- package/dist/src/client/api/index.d.ts +4 -3
- package/dist/src/client/api/index.js +2 -1
- package/dist/src/client/api/invoke-plugin.d.ts +8 -2
- package/dist/src/client/api/invoke-plugin.js +17 -2
- package/dist/src/client/api/load-model.js +5 -2
- package/dist/src/client/api/ocr.d.ts +5 -3
- package/dist/src/client/api/ocr.js +44 -21
- package/dist/src/client/api/rag.d.ts +1 -1
- package/dist/src/client/api/rag.js +1 -1
- package/dist/src/client/api/registry.d.ts +17 -7
- package/dist/src/client/api/registry.js +37 -12
- package/dist/src/client/api/resume.d.ts +2 -1
- package/dist/src/client/api/resume.js +2 -2
- package/dist/src/client/api/rpc-server.d.ts +4 -4
- package/dist/src/client/api/rpc-server.js +10 -10
- package/dist/src/client/api/state.d.ts +2 -2
- package/dist/src/client/api/state.js +2 -2
- package/dist/src/client/api/subscribe-logs.d.ts +2 -2
- package/dist/src/client/api/subscribe-logs.js +2 -2
- package/dist/src/client/api/suspend.d.ts +4 -2
- package/dist/src/client/api/suspend.js +4 -3
- package/dist/src/client/api/text-to-speech.d.ts +14 -5
- package/dist/src/client/api/text-to-speech.js +83 -29
- package/dist/src/client/api/transcribe.d.ts +6 -2
- package/dist/src/client/api/transcribe.js +7 -1
- package/dist/src/client/api/unload-model.d.ts +19 -7
- package/dist/src/client/api/unload-model.js +29 -11
- package/dist/src/client/api/upscale.d.ts +6 -3
- package/dist/src/client/api/upscale.js +9 -4
- package/dist/src/client/api/vector-index.d.ts +50 -16
- package/dist/src/client/api/vector-index.js +100 -48
- package/dist/src/client/api/video-request.d.ts +5 -5
- package/dist/src/client/api/video.d.ts +3 -2
- package/dist/src/client/api/video.js +3 -2
- package/dist/src/client/api/vla.d.ts +9 -5
- package/dist/src/client/api/vla.js +17 -8
- package/dist/src/client/api/world.d.ts +5 -5
- package/dist/src/client/api/world.js +4 -4
- package/dist/src/client/init-hooks.d.ts +6 -4
- package/dist/src/client/init-hooks.js +12 -15
- package/dist/src/client/logging-stream-registry.d.ts +6 -3
- package/dist/src/client/logging-stream-registry.js +31 -12
- package/dist/src/client/rpc/bundle-stamp.d.ts +29 -0
- package/dist/src/client/rpc/bundle-stamp.js +75 -0
- package/dist/src/client/rpc/expo-home-dir.d.ts +2 -0
- package/dist/src/client/rpc/expo-home-dir.js +4 -0
- package/dist/src/client/rpc/expo-rpc-client.js +189 -135
- package/dist/src/client/rpc/node-rpc-client.js +322 -413
- package/dist/src/client/rpc/pear-runtime.d.ts +12 -0
- package/dist/src/client/rpc/pear-runtime.js +12 -0
- package/dist/src/client/rpc/rpc-client.d.ts +5 -4
- package/dist/src/client/rpc/rpc-client.js +126 -23
- package/dist/src/client/rpc/rpc-error.js +21 -2
- package/dist/src/client/rpc/unbundled-harness.d.ts +16 -0
- package/dist/src/client/rpc/unbundled-harness.js +27 -0
- package/dist/src/client/rpc/worker-failure.d.ts +27 -0
- package/dist/src/client/rpc/worker-failure.js +61 -0
- package/dist/src/client/session-registry.d.ts +75 -0
- package/dist/src/client/session-registry.js +149 -0
- package/dist/src/client/session.d.ts +125 -0
- package/dist/src/client/session.js +148 -0
- package/dist/src/commands/bundle/addons.d.ts +14 -0
- package/dist/src/commands/bundle/addons.js +65 -0
- package/dist/src/commands/bundle/constants.js +1 -0
- package/dist/src/commands/bundle/entry-gen.d.ts +1 -5
- package/dist/src/commands/bundle/entry-gen.js +17 -50
- package/dist/src/commands/bundle/index.d.ts +59 -13
- package/dist/src/commands/bundle/index.js +345 -121
- package/dist/src/commands/bundle/link.d.ts +58 -0
- package/dist/src/commands/bundle/link.js +135 -0
- package/dist/src/commands/bundle/node-support.d.ts +13 -0
- package/dist/src/commands/bundle/node-support.js +23 -0
- package/dist/src/commands/bundle/read-bundle.d.ts +9 -0
- package/dist/src/commands/bundle/read-bundle.js +27 -0
- package/dist/src/commands/bundle/resolve-sdk-import.d.ts +6 -0
- package/dist/src/commands/bundle/resolve-sdk-import.js +24 -28
- package/dist/src/commands/bundle/scratch.d.ts +35 -0
- package/dist/src/commands/bundle/scratch.js +178 -0
- package/dist/src/commands/bundle/targets.d.ts +14 -0
- package/dist/src/commands/bundle/targets.js +37 -0
- package/dist/src/commands/host-prebuilds/index.d.ts +5 -4
- package/dist/src/commands/host-prebuilds/index.js +9 -7
- package/dist/src/commands/index.d.ts +4 -3
- package/dist/src/commands/verify/abi.d.ts +20 -14
- package/dist/src/commands/verify/abi.js +11 -79
- package/dist/src/commands/verify/bare-kit-runtime.d.ts +20 -22
- package/dist/src/commands/verify/bare-kit-runtime.js +102 -150
- package/dist/src/commands/verify/bare-kit-runtimes.d.ts +10 -9
- package/dist/src/commands/verify/bare-kit-runtimes.js +21 -21
- package/dist/src/commands/verify/bundle-source.js +25 -21
- package/dist/src/commands/verify/engines-advice.d.ts +2 -8
- package/dist/src/commands/verify/engines-advice.js +7 -54
- package/dist/src/commands/verify/index.d.ts +30 -29
- package/dist/src/commands/verify/index.js +92 -200
- package/dist/src/commands/verify/prebuilds.d.ts +3 -5
- package/dist/src/commands/verify/prebuilds.js +1 -2
- package/dist/src/commands/verify/resource-collectors.d.ts +0 -6
- package/dist/src/commands/verify/resource-collectors.js +1 -50
- package/dist/src/commands/verify/sidecar-runtime.d.ts +6 -0
- package/dist/src/commands/verify/sidecar-runtime.js +51 -0
- package/dist/src/expo/plugins/withBareKit.d.ts +59 -0
- package/dist/src/expo/plugins/withBareKit.js +204 -0
- package/dist/src/expo/plugins/withMobileBundle.d.ts +4 -11
- package/dist/src/expo/plugins/withMobileBundle.js +36 -57
- package/dist/src/expo/plugins/withQvacSDK.d.ts +1 -0
- package/dist/src/expo/plugins/withQvacSDK.js +3 -0
- package/dist/src/index.d.ts +6 -5
- package/dist/src/index.js +10 -14
- package/dist/src/logging/utils.js +10 -2
- package/dist/src/plugin-ids.d.ts +2 -1
- package/dist/src/plugin-ids.js +2 -0
- package/dist/src/schemas/public.d.ts +1 -1
- package/dist/src/schemas/public.js +1 -1
- package/dist/src/schemas/sdk-errors-client.d.ts +5 -6
- package/dist/src/schemas/sdk-errors-client.js +30 -36
- package/dist/src/schemas/sdk-errors-server.d.ts +11 -1
- package/dist/src/schemas/sdk-errors-server.js +60 -2
- package/dist/src/server/rpc/rpc-utils.d.ts +25 -4
- package/dist/src/server/rpc/rpc-utils.js +39 -5
- package/dist/src/utils/errors-client.d.ts +37 -29
- package/dist/src/utils/errors-client.js +50 -41
- package/dist/src/utils/errors-server.d.ts +59 -1
- package/dist/src/utils/errors-server.js +110 -1
- package/dist/src/utils/withTimeout.js +34 -17
- package/dist/src/worker/handle-request.js +25 -22
- package/dist/src/worker/handler-utils.d.ts +2 -6
- package/dist/src/worker/handler-utils.js +2 -20
- package/dist/src/worker/index.d.ts +2 -4
- package/dist/src/worker/index.js +23 -35
- package/dist/src/worker/plugins/ggml-image-embedding.d.ts +2 -0
- package/dist/src/worker/plugins/ggml-image-embedding.js +1 -0
- package/dist/src/worker/shim.d.ts +4 -0
- package/dist/src/worker/shim.js +7 -0
- package/dist/src/worker/start.d.ts +9 -0
- package/dist/src/worker/start.js +16 -0
- package/dist/src/worker/unbundled-shim.d.ts +2 -0
- package/dist/src/worker/unbundled-shim.js +4 -0
- package/docs/system-resources-support-matrix.md +27 -19
- package/package.json +62 -51
- package/src/electron-forge/index.cjs +65 -91
- package/dist/examples/model-fit-ui/server.d.ts +0 -24
- package/dist/examples/model-fit-ui/server.js +0 -221
- package/dist/src/client/rpc/ensure-worker-ready.d.ts +0 -9
- package/dist/src/client/rpc/ensure-worker-ready.js +0 -17
- package/dist/src/client/rpc/init-timeout.d.ts +0 -26
- package/dist/src/client/rpc/init-timeout.js +0 -25
- package/dist/src/client/rpc/ipc-socket-path.d.ts +0 -11
- package/dist/src/client/rpc/ipc-socket-path.js +0 -30
- package/dist/src/client/rpc/worker-startup-error.d.ts +0 -12
- package/dist/src/client/rpc/worker-startup-error.js +0 -13
- package/dist/src/commands/bundle/bare-pack.d.ts +0 -21
- package/dist/src/commands/bundle/bare-pack.js +0 -77
- package/dist/src/commands/bundle/manifest.d.ts +0 -25
- package/dist/src/commands/bundle/manifest.js +0 -192
- package/dist/src/expo/plugins/link-addons.d.ts +0 -18
- package/dist/src/expo/plugins/link-addons.js +0 -65
- package/dist/src/pear/pre.d.ts +0 -21
- package/dist/src/pear/pre.js +0 -450
- package/dist/src/server/env.d.ts +0 -22
- package/dist/src/server/env.js +0 -59
- package/dist/src/server/utils/qvac-paths.d.ts +0 -2
- package/dist/src/server/utils/qvac-paths.js +0 -5
- package/dist/src/server/utils/worker-lock.d.ts +0 -3
- package/dist/src/server/utils/worker-lock.js +0 -67
- package/dist/src/worker/create-server.d.ts +0 -8
- package/dist/src/worker/create-server.js +0 -51
- package/dist/src/worker/lifecycle.d.ts +0 -23
- package/dist/src/worker/lifecycle.js +0 -149
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
/** The part of a `pear-runtime` instance the worker harness uses. */
|
|
2
|
+
export interface PearRuntime {
|
|
3
|
+
run(path: string, args?: string[], opts?: object): unknown;
|
|
4
|
+
}
|
|
5
|
+
/**
|
|
6
|
+
* Starts the SDK worker through `pear` from then on, from the `pear-runtime`
|
|
7
|
+
* bundle that `qvac bundle sdk --target pear-runtime` writes. Call it before
|
|
8
|
+
* the first SDK call.
|
|
9
|
+
*/
|
|
10
|
+
export declare function usePearRuntime(pear: PearRuntime): void;
|
|
11
|
+
export declare function getPearRuntime(): PearRuntime | null;
|
|
12
|
+
//# sourceMappingURL=pear-runtime.d.ts.map
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
let pearRuntime = null;
|
|
2
|
+
/**
|
|
3
|
+
* Starts the SDK worker through `pear` from then on, from the `pear-runtime`
|
|
4
|
+
* bundle that `qvac bundle sdk --target pear-runtime` writes. Call it before
|
|
5
|
+
* the first SDK call.
|
|
6
|
+
*/
|
|
7
|
+
export function usePearRuntime(pear) {
|
|
8
|
+
pearRuntime = pear;
|
|
9
|
+
}
|
|
10
|
+
export function getPearRuntime() {
|
|
11
|
+
return pearRuntime;
|
|
12
|
+
}
|
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
import type RPC from 'bare-rpc';
|
|
2
2
|
import { type AbortableRPCOptions, type Request, type Response, type RPCOptions } from '@qvac/inference/surface';
|
|
3
|
-
export declare function send<T extends Request>(
|
|
4
|
-
/** `options.signal` ends the stream
|
|
5
|
-
export declare function stream<T extends Request>(
|
|
3
|
+
export declare function send<T extends Request>(input: T, options?: RPCOptions, rpc?: RPC): Promise<Response>;
|
|
4
|
+
/** `options.signal` ends the stream and cancels the request on the worker. */
|
|
5
|
+
export declare function stream<T extends Request>(input: T, options?: AbortableRPCOptions, rpc?: RPC): AsyncGenerator<Response>;
|
|
6
6
|
export interface DuplexWritable {
|
|
7
7
|
write(chunk: Uint8Array): void;
|
|
8
8
|
end(): void;
|
|
@@ -15,6 +15,7 @@ export interface DuplexSession {
|
|
|
15
15
|
requestStream: DuplexWritable;
|
|
16
16
|
responseStream: DuplexReadable;
|
|
17
17
|
}
|
|
18
|
-
export declare function duplex<T extends Request>(
|
|
18
|
+
export declare function duplex<T extends Request>(input: T, options?: RPCOptions): Promise<DuplexSession>;
|
|
19
|
+
/** Owner shutdown. Every session handle opened on this runtime ends with it. */
|
|
19
20
|
export declare function close(): Promise<void>;
|
|
20
21
|
//# sourceMappingURL=rpc-client.d.ts.map
|
|
@@ -4,6 +4,7 @@ import { withTimeout, withTimeoutStream, OperationTimeoutError } from '../../uti
|
|
|
4
4
|
import { getClientLogger, summarizeRequest } from '../../logging/index.js';
|
|
5
5
|
import { getRPC, close as closeRPC, createDuplexSession, getWorkerLifeSignal, notifyChannelClosed } from '#rpc';
|
|
6
6
|
import { WorkerCrashedError, RequestValidationFailedError } from '../../utils/errors-client.js';
|
|
7
|
+
import { assertOwnerModelUsable, assertSessionUsable, awaitSessionUsable, endAllSessions, sessionOf } from '../../client/session-registry.js';
|
|
7
8
|
import { formatZodError } from '../../utils/zod-error.js';
|
|
8
9
|
import { z } from 'zod';
|
|
9
10
|
import { createClientTimings, createClientStreamTimings, recordClientEvents, recordClientStreamEvents, cacheConnectionTime, flushConnectionTime, resetConnectionTracking } from './profiling/index.js';
|
|
@@ -30,7 +31,19 @@ function pinpointRequestError(request, fallback) {
|
|
|
30
31
|
if (memberDiscriminator(option) !== type)
|
|
31
32
|
continue;
|
|
32
33
|
const result = option.safeParse(request);
|
|
33
|
-
|
|
34
|
+
if (result.success)
|
|
35
|
+
return fallback;
|
|
36
|
+
// A method can itself accept several input shapes. Preserve field errors
|
|
37
|
+
// shared by every shape, such as an invalid modelId on either embed arm.
|
|
38
|
+
const union = result.error.issues.find((issue) => issue.code === 'invalid_union' && issue.path.length === 0);
|
|
39
|
+
if (union?.code === 'invalid_union' && union.errors.length > 0) {
|
|
40
|
+
const shared = union.errors[0].filter((issue) => union.errors.every((branch) => branch.some((other) => other.code === issue.code &&
|
|
41
|
+
other.message === issue.message &&
|
|
42
|
+
JSON.stringify(other.path) === JSON.stringify(issue.path))));
|
|
43
|
+
if (shared.length > 0)
|
|
44
|
+
return new z.ZodError(shared);
|
|
45
|
+
}
|
|
46
|
+
return result.error;
|
|
34
47
|
}
|
|
35
48
|
return fallback;
|
|
36
49
|
}
|
|
@@ -49,7 +62,7 @@ function parseRequest(request) {
|
|
|
49
62
|
// bare-rpc's `_onerror`/`_onclose` reject a pending reply or destroy a
|
|
50
63
|
// stream with its own generic `RPCError` (e.g. `CHANNEL_CLOSED`) as soon
|
|
51
64
|
// as the channel dies, which can beat the SDK's own crash detection
|
|
52
|
-
// (driven by the
|
|
65
|
+
// (driven by the worker IPC's `'close'` event). Since `req.reply()` and
|
|
53
66
|
// response streams never reject with an application-level error — those
|
|
54
67
|
// always arrive as a resolved payload handled by `checkAndThrowError` —
|
|
55
68
|
// any rejection reaching these helpers other than our own `withTimeout`
|
|
@@ -60,7 +73,7 @@ function parseRequest(request) {
|
|
|
60
73
|
// When we win that race, the life signal hasn't aborted yet, so nothing
|
|
61
74
|
// has invalidated the cached RPC connection — the next call would reuse
|
|
62
75
|
// the same dead channel and fail again. `notifyChannelClosed()` tears it
|
|
63
|
-
// down eagerly instead of waiting on the
|
|
76
|
+
// down eagerly instead of waiting on the `'close'` event; it's a no-op
|
|
64
77
|
// once the signal is already aborted, so this is safe to call every time.
|
|
65
78
|
function lifeSignalAbortError(signal) {
|
|
66
79
|
if (!signal.aborted)
|
|
@@ -70,15 +83,15 @@ function lifeSignalAbortError(signal) {
|
|
|
70
83
|
return new WorkerCrashedError(null, null);
|
|
71
84
|
}
|
|
72
85
|
async function awaitWithLifeSignal(p) {
|
|
73
|
-
// Null on Bare-direct
|
|
86
|
+
// Null on Bare-direct and before the worker starts.
|
|
74
87
|
const lifeSignal = getWorkerLifeSignal();
|
|
75
88
|
if (!lifeSignal)
|
|
76
89
|
return p;
|
|
77
90
|
if (lifeSignal.aborted) {
|
|
78
|
-
// `p` (e.g. `req.reply()`) may already be
|
|
79
|
-
//
|
|
80
|
-
//
|
|
81
|
-
//
|
|
91
|
+
// `p` (e.g. `req.reply()`) may already be rejected, since bare-rpc rejects
|
|
92
|
+
// once its channel is closed. It is discarded in favour of the life
|
|
93
|
+
// signal's classification, so it gets a handler or its rejection surfaces
|
|
94
|
+
// as an unhandled rejection.
|
|
82
95
|
p.catch(() => { });
|
|
83
96
|
throw lifeSignalAbortError(lifeSignal);
|
|
84
97
|
}
|
|
@@ -108,7 +121,7 @@ async function awaitWithLifeSignal(p) {
|
|
|
108
121
|
});
|
|
109
122
|
}
|
|
110
123
|
async function* iterateWithLifeSignal(source) {
|
|
111
|
-
// Null on Bare-direct
|
|
124
|
+
// Null on Bare-direct and before the worker starts.
|
|
112
125
|
const lifeSignal = getWorkerLifeSignal();
|
|
113
126
|
if (!lifeSignal) {
|
|
114
127
|
yield* source;
|
|
@@ -157,9 +170,21 @@ async function* iterateWithLifeSignal(source) {
|
|
|
157
170
|
void source.return?.(undefined).catch(() => { });
|
|
158
171
|
}
|
|
159
172
|
}
|
|
160
|
-
|
|
161
|
-
|
|
162
|
-
|
|
173
|
+
/** A reply that times out cancels the request, so the worker stops its work too. */
|
|
174
|
+
async function replyWithin(req, timeout) {
|
|
175
|
+
try {
|
|
176
|
+
return await withTimeout(req.reply('utf-8'), timeout);
|
|
177
|
+
}
|
|
178
|
+
catch (error) {
|
|
179
|
+
if (error instanceof OperationTimeoutError)
|
|
180
|
+
req.cancel(error);
|
|
181
|
+
throw error;
|
|
182
|
+
}
|
|
183
|
+
}
|
|
184
|
+
// Destroying the response stream before the reply ends cancels the request,
|
|
185
|
+
// and the worker cancels its work. Registered before `untilAborted`, so the
|
|
186
|
+
// destroyed stream's late rejection is dropped there instead of reaching
|
|
187
|
+
// `iterateWithLifeSignal` as a worker crash.
|
|
163
188
|
function destroyOnAbort(responseStream, signal) {
|
|
164
189
|
if (!signal)
|
|
165
190
|
return () => { };
|
|
@@ -186,20 +211,84 @@ function invalidateRPCInstance() {
|
|
|
186
211
|
firstConnectionPending = true;
|
|
187
212
|
resetConnectionTracking();
|
|
188
213
|
}
|
|
214
|
+
// The worker died under the sessions: every handle this process opened is
|
|
215
|
+
// now invalid, and later calls on them fail locally.
|
|
216
|
+
function onWorkerLost() {
|
|
217
|
+
invalidateRPCInstance();
|
|
218
|
+
endAllSessions('crashed');
|
|
219
|
+
}
|
|
220
|
+
/**
|
|
221
|
+
* A request made through a session handle carries the session id. The call
|
|
222
|
+
* waits for the session's `openSession` round trip, so a handle is usable the
|
|
223
|
+
* moment `openSession()` returns, and is refused locally once the session is
|
|
224
|
+
* closed or lost. The handle's id replaces any id the request carries, so a
|
|
225
|
+
* caller cannot send a request as another session; only the session methods
|
|
226
|
+
* themselves (`openSession`, `closeSession`) name the session they act on.
|
|
227
|
+
*
|
|
228
|
+
* An owner request is refused the same way when it names a model the owner
|
|
229
|
+
* loaded on a runtime that has since stopped.
|
|
230
|
+
*
|
|
231
|
+
* An owner request is stamped without a promise: it must claim the worker
|
|
232
|
+
* start in the tick it is made, so a `close()` called right after it sees
|
|
233
|
+
* that start and shuts it down.
|
|
234
|
+
*/
|
|
235
|
+
function stampSession(request, options) {
|
|
236
|
+
const sessionId = options?.sessionId;
|
|
237
|
+
const target = request;
|
|
238
|
+
if (sessionId === undefined) {
|
|
239
|
+
assertOwnerModelUsable(request);
|
|
240
|
+
return request;
|
|
241
|
+
}
|
|
242
|
+
return stampSessionRequest(request, sessionId, options, target);
|
|
243
|
+
}
|
|
244
|
+
async function stampSessionRequest(request, sessionId, options, target) {
|
|
245
|
+
// A bare `sessionId` with no handle behind it has no local state; the
|
|
246
|
+
// worker decides whether that session is open.
|
|
247
|
+
const record = sessionOf(options);
|
|
248
|
+
if (record)
|
|
249
|
+
await awaitSessionUsable(record, target);
|
|
250
|
+
if (request.type === 'openSession' || request.type === 'closeSession')
|
|
251
|
+
return request;
|
|
252
|
+
return { ...request, sessionId };
|
|
253
|
+
}
|
|
254
|
+
function isPromise(value) {
|
|
255
|
+
return value instanceof Promise;
|
|
256
|
+
}
|
|
257
|
+
/**
|
|
258
|
+
* The owner's `close()` can end a session while its request waits for the
|
|
259
|
+
* stamp. Each call checks again right before acquiring the connection, with
|
|
260
|
+
* no await in between, so such a call fails locally instead of starting a
|
|
261
|
+
* worker that never opened the session.
|
|
262
|
+
*/
|
|
263
|
+
function assertStampedSessionUsable(request, options) {
|
|
264
|
+
const record = sessionOf(options);
|
|
265
|
+
if (record)
|
|
266
|
+
assertSessionUsable(record, request);
|
|
267
|
+
}
|
|
189
268
|
async function getRPCInstance() {
|
|
190
269
|
if (rpcInstance)
|
|
191
270
|
return { rpc: await rpcInstance };
|
|
192
271
|
const connectionStart = firstConnectionPending ? nowMs() : null;
|
|
193
|
-
|
|
194
|
-
|
|
272
|
+
const connecting = getRPC();
|
|
273
|
+
rpcInstance = connecting;
|
|
274
|
+
let rpc;
|
|
275
|
+
try {
|
|
276
|
+
rpc = await connecting;
|
|
277
|
+
}
|
|
278
|
+
catch (error) {
|
|
279
|
+
// A failed start is not cached, so the next call starts a new worker.
|
|
280
|
+
if (rpcInstance === connecting)
|
|
281
|
+
rpcInstance = null;
|
|
282
|
+
throw error;
|
|
283
|
+
}
|
|
195
284
|
// Drop the cache on worker death so the next call respawns and
|
|
196
285
|
// records connectionMs again as a "first" connection.
|
|
197
286
|
const lifeSignal = getWorkerLifeSignal();
|
|
198
287
|
if (lifeSignal?.aborted) {
|
|
199
|
-
|
|
288
|
+
onWorkerLost();
|
|
200
289
|
}
|
|
201
290
|
else if (lifeSignal) {
|
|
202
|
-
lifeSignal.addEventListener('abort',
|
|
291
|
+
lifeSignal.addEventListener('abort', onWorkerLost, {
|
|
203
292
|
once: true
|
|
204
293
|
});
|
|
205
294
|
}
|
|
@@ -221,7 +310,10 @@ async function prepareRPCContext(requestType, perCallProfiling, rpc) {
|
|
|
221
310
|
}
|
|
222
311
|
return { rpc: rpcResult.rpc, profilingEnabled, signalDisable };
|
|
223
312
|
}
|
|
224
|
-
export async function send(
|
|
313
|
+
export async function send(input, options, rpc) {
|
|
314
|
+
const stamped = stampSession(input, options);
|
|
315
|
+
const request = isPromise(stamped) ? await stamped : stamped;
|
|
316
|
+
assertStampedSessionUsable(request, options);
|
|
225
317
|
const ctx = await prepareRPCContext(request.type, options?.profiling, rpc);
|
|
226
318
|
if (!ctx.profilingEnabled) {
|
|
227
319
|
return sendBase(request, ctx.rpc, options, ctx.signalDisable);
|
|
@@ -237,7 +329,7 @@ async function sendBase(request, rpc, options, signalDisable = false) {
|
|
|
237
329
|
: parsedRequest;
|
|
238
330
|
const payload = JSON.stringify(payloadObj);
|
|
239
331
|
req.send(payload, 'utf-8');
|
|
240
|
-
const response = await awaitWithLifeSignal(
|
|
332
|
+
const response = await awaitWithLifeSignal(replyWithin(req, options?.timeout));
|
|
241
333
|
const resPayload = responseSchema.parse(JSON.parse(response?.toString() || '{}'));
|
|
242
334
|
logger.debug('ResPayload', { type: resPayload.type });
|
|
243
335
|
checkAndThrowError(resPayload);
|
|
@@ -262,7 +354,7 @@ async function sendProfiled(request, rpc, options) {
|
|
|
262
354
|
timings.requestStringifyMs = nowMs() - stringifyStart;
|
|
263
355
|
timings.sendStart = nowMs();
|
|
264
356
|
req.send(payload, 'utf-8');
|
|
265
|
-
const response = await awaitWithLifeSignal(
|
|
357
|
+
const response = await awaitWithLifeSignal(replyWithin(req, options?.timeout));
|
|
266
358
|
timings.firstResponseAt = nowMs();
|
|
267
359
|
const parseStart = nowMs();
|
|
268
360
|
const rawParsed = JSON.parse(response?.toString() || '{}');
|
|
@@ -291,10 +383,13 @@ async function sendProfiled(request, rpc, options) {
|
|
|
291
383
|
throw error;
|
|
292
384
|
}
|
|
293
385
|
}
|
|
294
|
-
/** `options.signal` ends the stream
|
|
295
|
-
export async function* stream(
|
|
386
|
+
/** `options.signal` ends the stream and cancels the request on the worker. */
|
|
387
|
+
export async function* stream(input, options = {}, rpc) {
|
|
296
388
|
if (options.signal?.aborted)
|
|
297
389
|
return;
|
|
390
|
+
const stamped = stampSession(input, options);
|
|
391
|
+
const request = isPromise(stamped) ? await stamped : stamped;
|
|
392
|
+
assertStampedSessionUsable(request, options);
|
|
298
393
|
const ctx = await prepareRPCContext(request.type, options?.profiling, rpc);
|
|
299
394
|
if (options.signal?.aborted)
|
|
300
395
|
return;
|
|
@@ -341,6 +436,7 @@ async function* streamBase(request, rpc, options = {}, signalDisable = false) {
|
|
|
341
436
|
}
|
|
342
437
|
finally {
|
|
343
438
|
stopDestroyOnAbort();
|
|
439
|
+
responseStream.destroy();
|
|
344
440
|
}
|
|
345
441
|
}
|
|
346
442
|
async function* streamProfiled(request, rpc, options = {}) {
|
|
@@ -351,6 +447,7 @@ async function* streamProfiled(request, rpc, options = {}) {
|
|
|
351
447
|
const timings = createClientStreamTimings(profileId, requestType);
|
|
352
448
|
let profilingMeta = undefined;
|
|
353
449
|
let stopDestroyOnAbort = () => { };
|
|
450
|
+
let responseStream;
|
|
354
451
|
try {
|
|
355
452
|
const zodStart = nowMs();
|
|
356
453
|
const parsedRequest = parseRequest(request);
|
|
@@ -364,7 +461,7 @@ async function* streamProfiled(request, rpc, options = {}) {
|
|
|
364
461
|
timings.requestStringifyMs = nowMs() - stringifyStart;
|
|
365
462
|
timings.sendStart = nowMs();
|
|
366
463
|
req.send(payload, 'utf-8');
|
|
367
|
-
|
|
464
|
+
responseStream = req.createResponseStream({ encoding: 'utf-8' });
|
|
368
465
|
stopDestroyOnAbort = destroyOnAbort(responseStream, options.signal);
|
|
369
466
|
let buffer = '';
|
|
370
467
|
async function* processStream() {
|
|
@@ -417,6 +514,7 @@ async function* streamProfiled(request, rpc, options = {}) {
|
|
|
417
514
|
}
|
|
418
515
|
finally {
|
|
419
516
|
stopDestroyOnAbort();
|
|
517
|
+
responseStream?.destroy();
|
|
420
518
|
if (timings.chunkCount > 0) {
|
|
421
519
|
timings.requestEnd = nowMs();
|
|
422
520
|
recordClientStreamEvents(timings, profilingMeta);
|
|
@@ -444,7 +542,10 @@ function withLifeSignalDuplex(raw) {
|
|
|
444
542
|
}
|
|
445
543
|
};
|
|
446
544
|
}
|
|
447
|
-
export async function duplex(
|
|
545
|
+
export async function duplex(input, options) {
|
|
546
|
+
const stamped = stampSession(input, options);
|
|
547
|
+
const request = isPromise(stamped) ? await stamped : stamped;
|
|
548
|
+
assertStampedSessionUsable(request, options);
|
|
448
549
|
const ctx = await prepareRPCContext(request.type, options?.profiling);
|
|
449
550
|
if (!ctx.profilingEnabled) {
|
|
450
551
|
return duplexBase(request, ctx.signalDisable, options?.timeout);
|
|
@@ -576,7 +677,9 @@ async function duplexProfiled(request, options = {}) {
|
|
|
576
677
|
responseStream: wrappedResponseStream
|
|
577
678
|
};
|
|
578
679
|
}
|
|
680
|
+
/** Owner shutdown. Every session handle opened on this runtime ends with it. */
|
|
579
681
|
export async function close() {
|
|
682
|
+
endAllSessions('shutdown');
|
|
580
683
|
if (!rpcInstance)
|
|
581
684
|
return;
|
|
582
685
|
invalidateRPCInstance();
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { RpcServerOperationError, InferenceCancelledError, ContextOverflowError, ModelRegistryModelNotFoundError, RequestIdConflictError, RequestNotFoundError, RequestRejectedByPolicyError, TranslationFailedError } from '../../utils/errors-server.js';
|
|
1
|
+
import { RpcServerOperationError, InferenceCancelledError, ContextOverflowError, ModelRegistryModelNotFoundError, ModelRegistryBusyError, RequestIdConflictError, RequestNotFoundError, RequestRejectedByPolicyError, TranslationFailedError, AudioEncodeFailedError, InvalidSeedFromParamsError, KvCacheSeedSourceNotFoundError, KvCacheSeedSharingDisabledError, SessionIdConflictError, SessionNotOpenError, ModelLeasedError, ModelReconfiguredError, OwnerOnlyError, RAGWorkspaceBusyError } from '../../utils/errors-server.js';
|
|
2
2
|
export class RPCError extends Error {
|
|
3
3
|
timestamp;
|
|
4
4
|
remoteStack;
|
|
@@ -98,6 +98,9 @@ function readOptionalStringField(fields, key) {
|
|
|
98
98
|
* errors support both paths.
|
|
99
99
|
*/
|
|
100
100
|
const RECONSTRUCTORS = {
|
|
101
|
+
INVALID_SEED_FROM_PARAMS: (response) => new InvalidSeedFromParamsError(response.cause),
|
|
102
|
+
KV_CACHE_SEED_SOURCE_NOT_FOUND: (response) => new KvCacheSeedSourceNotFoundError(readStringField(response.typedFields, 'seedFrom', ''), readStringField(response.typedFields, 'modelId', ''), response.cause),
|
|
103
|
+
KV_CACHE_SEED_SHARING_DISABLED: (response) => new KvCacheSeedSharingDisabledError(readStringField(response.typedFields, 'modelId', ''), response.cause),
|
|
101
104
|
INFERENCE_CANCELLED: (response) => {
|
|
102
105
|
const partial = response.typedFields?.['partial'];
|
|
103
106
|
return new InferenceCancelledError(readStringField(response.typedFields, 'requestId', ''), partial && typeof partial === 'object' && !Array.isArray(partial)
|
|
@@ -111,6 +114,11 @@ const RECONSTRUCTORS = {
|
|
|
111
114
|
QVAC_MODEL_REGISTRY_MODEL_NOT_FOUND: (response) => {
|
|
112
115
|
return new ModelRegistryModelNotFoundError(readStringField(response.typedFields, 'registrySource', ''), readStringField(response.typedFields, 'registryPath', ''), response.cause);
|
|
113
116
|
},
|
|
117
|
+
QVAC_MODEL_REGISTRY_BUSY: (response) => {
|
|
118
|
+
return new ModelRegistryBusyError(readStringField(response.typedFields, 'holder', 'current') === 'legacy'
|
|
119
|
+
? 'legacy'
|
|
120
|
+
: 'current', readOptionalNumberField(response.typedFields, 'waitedMs') ?? 0, response.cause);
|
|
121
|
+
},
|
|
114
122
|
REQUEST_NOT_FOUND: (response) => {
|
|
115
123
|
return new RequestNotFoundError(readStringField(response.typedFields, 'requestId', ''), response.cause);
|
|
116
124
|
},
|
|
@@ -130,7 +138,18 @@ const RECONSTRUCTORS = {
|
|
|
130
138
|
// class -- matching the Python client's reconstructor.
|
|
131
139
|
TRANSLATION_FAILED: (response) => {
|
|
132
140
|
return new TranslationFailedError(response.message, response.cause);
|
|
133
|
-
}
|
|
141
|
+
},
|
|
142
|
+
// An encoder the inference host lacks fails an `outputFormat` request in the
|
|
143
|
+
// worker; the format and the encoder's own message come back as fields.
|
|
144
|
+
AUDIO_ENCODE_FAILED: (response) => {
|
|
145
|
+
return new AudioEncodeFailedError(readStringField(response.typedFields, 'format', ''), readOptionalStringField(response.typedFields, 'details'), response.cause);
|
|
146
|
+
},
|
|
147
|
+
SESSION_ID_CONFLICT: (response) => new SessionIdConflictError(readStringField(response.typedFields, 'sessionId', ''), response.cause),
|
|
148
|
+
SESSION_NOT_OPEN: (response) => new SessionNotOpenError(readStringField(response.typedFields, 'sessionId', ''), response.cause),
|
|
149
|
+
MODEL_LEASED: (response) => new ModelLeasedError(readStringField(response.typedFields, 'modelId', ''), readOptionalNumberField(response.typedFields, 'leaseCount') ?? 0, response.cause),
|
|
150
|
+
OWNER_ONLY: (response) => new OwnerOnlyError(readStringField(response.typedFields, 'operation', ''), readStringField(response.typedFields, 'sessionId', ''), response.cause),
|
|
151
|
+
MODEL_RECONFIGURED: (response) => new ModelReconfiguredError(readStringField(response.typedFields, 'modelId', ''), response.cause),
|
|
152
|
+
RAG_WORKSPACE_BUSY: (response) => new RAGWorkspaceBusyError(readStringField(response.typedFields, 'workspace', ''), response.cause)
|
|
134
153
|
};
|
|
135
154
|
/**
|
|
136
155
|
* Rebuild the original server-thrown typed error from its serialised
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
import { type IPC } from 'bare-stow-host';
|
|
2
|
+
import type { WorkerProcess } from './worker-failure.js';
|
|
3
|
+
/**
|
|
4
|
+
* Starts a worker entry without a bundle on bare-sidecar, wrapped by
|
|
5
|
+
* bare-stow-host. The worker's stderr goes to `onStderr`, and the spawned
|
|
6
|
+
* sidecar to `onSpawn`.
|
|
7
|
+
*/
|
|
8
|
+
export declare function start(entry: string, options?: {
|
|
9
|
+
timeout?: number;
|
|
10
|
+
grace?: number;
|
|
11
|
+
onStderr?: (chunk: unknown) => void;
|
|
12
|
+
onSpawn?: (sidecar: WorkerProcess) => void;
|
|
13
|
+
}): Promise<{
|
|
14
|
+
ipc: IPC;
|
|
15
|
+
}>;
|
|
16
|
+
//# sourceMappingURL=unbundled-harness.d.ts.map
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
import { wrap } from 'bare-stow-host';
|
|
2
|
+
import { fileURLToPath } from 'node:url';
|
|
3
|
+
function unbundledShim() {
|
|
4
|
+
const asset = import.meta.asset;
|
|
5
|
+
return fileURLToPath(asset
|
|
6
|
+
? asset('../../worker/unbundled-shim.js')
|
|
7
|
+
: new URL('../../worker/unbundled-shim.js', import.meta.url));
|
|
8
|
+
}
|
|
9
|
+
/**
|
|
10
|
+
* Starts a worker entry without a bundle on bare-sidecar, wrapped by
|
|
11
|
+
* bare-stow-host. The worker's stderr goes to `onStderr`, and the spawned
|
|
12
|
+
* sidecar to `onSpawn`.
|
|
13
|
+
*/
|
|
14
|
+
export async function start(entry, options = {}) {
|
|
15
|
+
const { onStderr, onSpawn, ...ipcOptions } = options;
|
|
16
|
+
const { default: Sidecar } = await import('bare-sidecar');
|
|
17
|
+
const sidecar = new Sidecar(unbundledShim(), [entry], {
|
|
18
|
+
stdio: ['inherit', 'inherit', onStderr ? 'pipe' : 'inherit']
|
|
19
|
+
});
|
|
20
|
+
if (onStderr)
|
|
21
|
+
sidecar.stderr?.on('data', onStderr);
|
|
22
|
+
onSpawn?.(sidecar);
|
|
23
|
+
const ipc = wrap(sidecar, { ...ipcOptions, kill: () => sidecar.kill('SIGKILL') });
|
|
24
|
+
sidecar.on('exit', (code, signal) => ipc.exited(code, signal));
|
|
25
|
+
await ipc.ready;
|
|
26
|
+
return { ipc };
|
|
27
|
+
}
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
import { WorkerCrashedError, WorkerStartupError } from '../../utils/errors-client.js';
|
|
2
|
+
/**
|
|
3
|
+
* How long a worker gets to start, from launch until it has applied its
|
|
4
|
+
* configuration, when `rpcInitTimeoutMs` is not set.
|
|
5
|
+
*/
|
|
6
|
+
export declare const DEFAULT_WORKER_START_TIMEOUT_MS = 60000;
|
|
7
|
+
/** How long a stopping worker gets to unload its engines before it is killed. */
|
|
8
|
+
export declare const WORKER_SHUTDOWN_GRACE_MS = 10000;
|
|
9
|
+
/** A worker process the client spawned. */
|
|
10
|
+
export interface WorkerProcess {
|
|
11
|
+
kill(signal: 'SIGKILL'): unknown;
|
|
12
|
+
}
|
|
13
|
+
export declare function workerCrashed(cause: unknown): WorkerCrashedError;
|
|
14
|
+
/** Rejects with the signal's reason once it aborts. */
|
|
15
|
+
export declare function rejectOnAbort(signal: AbortSignal): Promise<never>;
|
|
16
|
+
/** Rejects once `ms` have passed, for the part of the start after the worker is ready. */
|
|
17
|
+
export declare function startDeadline(ms: number): {
|
|
18
|
+
expired: Promise<never>;
|
|
19
|
+
clear: () => void;
|
|
20
|
+
};
|
|
21
|
+
export declare function workerStartupFailed(cause: unknown, stderrTail?: string): WorkerStartupError;
|
|
22
|
+
/** Keeps the end of a worker's stderr and passes each chunk to `log`. */
|
|
23
|
+
export declare function stderrTail(log: (text: string) => void): {
|
|
24
|
+
write: (chunk: unknown) => void;
|
|
25
|
+
read: () => string | undefined;
|
|
26
|
+
};
|
|
27
|
+
//# sourceMappingURL=worker-failure.d.ts.map
|
|
@@ -0,0 +1,61 @@
|
|
|
1
|
+
import { WorkerCrashedError, WorkerStartupError } from '../../utils/errors-client.js';
|
|
2
|
+
/**
|
|
3
|
+
* How long a worker gets to start, from launch until it has applied its
|
|
4
|
+
* configuration, when `rpcInitTimeoutMs` is not set.
|
|
5
|
+
*/
|
|
6
|
+
export const DEFAULT_WORKER_START_TIMEOUT_MS = 60_000;
|
|
7
|
+
/** How long a stopping worker gets to unload its engines before it is killed. */
|
|
8
|
+
export const WORKER_SHUTDOWN_GRACE_MS = 10_000;
|
|
9
|
+
function exitOf(cause) {
|
|
10
|
+
const exit = cause;
|
|
11
|
+
return {
|
|
12
|
+
exitCode: exit?.exitCode ?? null,
|
|
13
|
+
exitSignal: (exit?.signalCode ?? null)
|
|
14
|
+
};
|
|
15
|
+
}
|
|
16
|
+
export function workerCrashed(cause) {
|
|
17
|
+
const { exitCode, exitSignal } = exitOf(cause);
|
|
18
|
+
return new WorkerCrashedError(exitCode, exitSignal, cause);
|
|
19
|
+
}
|
|
20
|
+
/** Rejects with the signal's reason once it aborts. */
|
|
21
|
+
export function rejectOnAbort(signal) {
|
|
22
|
+
return new Promise((_, reject) => {
|
|
23
|
+
const fail = () => reject(signal.reason instanceof Error ? signal.reason : new WorkerCrashedError(null, null));
|
|
24
|
+
if (signal.aborted) {
|
|
25
|
+
fail();
|
|
26
|
+
return;
|
|
27
|
+
}
|
|
28
|
+
signal.addEventListener('abort', fail, { once: true });
|
|
29
|
+
});
|
|
30
|
+
}
|
|
31
|
+
/** Rejects once `ms` have passed, for the part of the start after the worker is ready. */
|
|
32
|
+
export function startDeadline(ms) {
|
|
33
|
+
let timer;
|
|
34
|
+
const expired = new Promise((_, reject) => {
|
|
35
|
+
timer = setTimeout(() => {
|
|
36
|
+
reject(new WorkerStartupError('Worker did not apply its configuration in time', {
|
|
37
|
+
exitCode: null,
|
|
38
|
+
exitSignal: null,
|
|
39
|
+
timedOut: true
|
|
40
|
+
}));
|
|
41
|
+
}, Math.max(ms, 0));
|
|
42
|
+
});
|
|
43
|
+
return { expired, clear: () => clearTimeout(timer) };
|
|
44
|
+
}
|
|
45
|
+
export function workerStartupFailed(cause, stderrTail) {
|
|
46
|
+
const timedOut = cause?.code === 'WORKER_TIMEOUT';
|
|
47
|
+
return new WorkerStartupError(timedOut ? 'Worker did not signal ready in time' : 'Worker failed before signalling ready', { ...exitOf(cause), timedOut, ...(stderrTail ? { stderrTail } : {}) }, cause);
|
|
48
|
+
}
|
|
49
|
+
const STDERR_TAIL_CHARS = 4096;
|
|
50
|
+
/** Keeps the end of a worker's stderr and passes each chunk to `log`. */
|
|
51
|
+
export function stderrTail(log) {
|
|
52
|
+
let tail = '';
|
|
53
|
+
return {
|
|
54
|
+
write(chunk) {
|
|
55
|
+
const text = String(chunk);
|
|
56
|
+
log(text.trimEnd());
|
|
57
|
+
tail = (tail + text).slice(-STDERR_TAIL_CHARS);
|
|
58
|
+
},
|
|
59
|
+
read: () => tail || undefined
|
|
60
|
+
};
|
|
61
|
+
}
|
|
@@ -0,0 +1,75 @@
|
|
|
1
|
+
import type { RPCOptions } from '@qvac/inference/surface';
|
|
2
|
+
/**
|
|
3
|
+
* Client-side state of the session handles this process opened, and of the
|
|
4
|
+
* models the owner loaded. The RPC layer consults it on each request: a
|
|
5
|
+
* session-stamped request waits for its session's `openSession` round trip,
|
|
6
|
+
* and a request on a session that was closed, shut down with the runtime or
|
|
7
|
+
* lost with the worker is refused locally with a typed error instead of
|
|
8
|
+
* reaching the wire. An owner request naming a model that was loaded before
|
|
9
|
+
* the runtime stopped is refused the same way until the model is loaded again.
|
|
10
|
+
*
|
|
11
|
+
* A session's state lives in its record, which the handle owns and binds to
|
|
12
|
+
* the options of every call it makes. The registry itself only tracks the
|
|
13
|
+
* sessions that are still open, so it needs no cap: an ended session's record
|
|
14
|
+
* goes away with its handle.
|
|
15
|
+
*/
|
|
16
|
+
export type SessionEndReason = 'closed' | 'shutdown' | 'crashed';
|
|
17
|
+
/** The owner's id in errors about its own model handles. It never goes on the wire. */
|
|
18
|
+
export declare const OWNER_HANDLE_ID = "owner";
|
|
19
|
+
export interface SessionRecord {
|
|
20
|
+
readonly sessionId: string;
|
|
21
|
+
readonly opened: Promise<void>;
|
|
22
|
+
/** Why the open failed; every later call on the handle fails with it. */
|
|
23
|
+
openError: unknown;
|
|
24
|
+
ended: SessionEndReason | undefined;
|
|
25
|
+
/**
|
|
26
|
+
* Model ids this session loaded and has not unloaded. Kept after the
|
|
27
|
+
* session ends, so a call naming one of them fails with
|
|
28
|
+
* `ModelHandleInvalidatedError` rather than the plain session error.
|
|
29
|
+
*/
|
|
30
|
+
readonly heldModels: Set<string>;
|
|
31
|
+
}
|
|
32
|
+
export declare function createSessionRecord(sessionId: string, opened: Promise<void>): SessionRecord;
|
|
33
|
+
export declare function endSession(record: SessionRecord, reason: SessionEndReason): void;
|
|
34
|
+
/**
|
|
35
|
+
* Runtime shutdown or worker loss: every open session is gone with it, and so
|
|
36
|
+
* is every model the owner had loaded.
|
|
37
|
+
*/
|
|
38
|
+
export declare function endAllSessions(reason: Exclude<SessionEndReason, 'closed'>): void;
|
|
39
|
+
/**
|
|
40
|
+
* Whether this client has a session open or still opening. A session counts
|
|
41
|
+
* from `openSession()`, before the worker has registered it; one whose open
|
|
42
|
+
* failed does not.
|
|
43
|
+
*/
|
|
44
|
+
export declare function hasClientSessions(): boolean;
|
|
45
|
+
export declare function isSessionEnded(record: SessionRecord): boolean;
|
|
46
|
+
/** Binds the session behind a call's options; the handle calls it for every option object it stamps. */
|
|
47
|
+
export declare function bindSession(options: object, record: SessionRecord): void;
|
|
48
|
+
/** The session behind a call's options, or undefined for an owner call or a bare `sessionId`. */
|
|
49
|
+
export declare function sessionOf(options: RPCOptions | undefined): SessionRecord | undefined;
|
|
50
|
+
/** A load resolved: the session behind the options, or the owner when there is no `sessionId`, holds the model. */
|
|
51
|
+
export declare function recordHeldModel(options: RPCOptions | undefined, modelId: string): void;
|
|
52
|
+
/** An unload released the caller's lease on the model. */
|
|
53
|
+
export declare function releaseHeldModel(options: RPCOptions | undefined, modelId: string): void;
|
|
54
|
+
export declare function isModelHeldBySession(record: SessionRecord, modelId: string): boolean;
|
|
55
|
+
/**
|
|
56
|
+
* Called by the RPC layer before a session-stamped request leaves the
|
|
57
|
+
* process. Resolves once the session is open on the worker; rejects with the
|
|
58
|
+
* typed local error when the session can no longer be used.
|
|
59
|
+
*/
|
|
60
|
+
export declare function awaitSessionUsable(record: SessionRecord, request: {
|
|
61
|
+
modelId?: string | undefined;
|
|
62
|
+
}): Promise<void>;
|
|
63
|
+
/** The check `awaitSessionUsable` makes, without waiting for the open. */
|
|
64
|
+
export declare function assertSessionUsable(record: SessionRecord, request: {
|
|
65
|
+
modelId?: string | undefined;
|
|
66
|
+
}): void;
|
|
67
|
+
export declare function assertOwnerModelUsable(request: {
|
|
68
|
+
type: string;
|
|
69
|
+
modelId?: string | undefined;
|
|
70
|
+
}): void;
|
|
71
|
+
/** Test seam: the number of sessions the registry tracks as open or opening. */
|
|
72
|
+
export declare function trackedSessionCount(): number;
|
|
73
|
+
/** Test seam: forget every open session and owner model. */
|
|
74
|
+
export declare function resetSessionRegistry(): void;
|
|
75
|
+
//# sourceMappingURL=session-registry.d.ts.map
|