Graphorin API reference v0.7.0

---

Graphorin API reference / @graphorin/server / / RunStateTracker

Class: RunStateTracker

Defined in: packages/server/src/runtime/run-state.ts:134

Pluggable tracker. The default in-memory implementation is the only one shipped in Phase 14a; future phases plug in a SQLite-backed variant so durable resume survives process restarts.

Stable

Constructors

Constructor

new RunStateTracker(options?): RunStateTracker;

Defined in: packages/server/src/runtime/run-state.ts:139

Parameters

Parameter	Type	Description
options	{ now?: () => number; onTerminal?: (info) => void; }	-
options.now?	() => number	-
options.onTerminal?	(info) => void	IP-15: invoked exactly once per run, the first time it settles into a terminal state. Used to drive the run-count + duration metrics. Never throws into the tracker - wrap your handler if it might.

Returns

RunStateTracker

Methods

abort()

abort(runId, reason?): boolean;

Defined in: packages/server/src/runtime/run-state.ts:227

Cancel a run via its AbortController.

Parameters

Parameter	Type
runId	string
reason?	unknown

Returns

boolean

---

abortAll()

abortAll(reason?): number;

Defined in: packages/server/src/runtime/run-state.ts:329

Cancel every in-flight run. Used during graceful shutdown.

Parameters

Parameter	Type
reason?	unknown

Returns

number

---

abortPending()

abortPending(reason?): number;

Defined in: packages/server/src/runtime/run-state.ts:297

Drop every reserved-but-not-yet-started run. Called by the server lifecycle at the start of stop() so the drain only waits for actual work in flight.

Parameters

Parameter	Type
reason?	unknown

Returns

number

---

complete()

complete(
   runId, 
   status, 
   err?): void;

Defined in: packages/server/src/runtime/run-state.ts:206

Mark a run as terminal.

Parameters

Parameter	Type
runId	string
status	"completed" | "failed" | "aborted"
err?	unknown

Returns

void

---

declare()

declare(runId, descriptor): void;

Defined in: packages/server/src/runtime/run-state.ts:169

Reserve a run id without taking ownership of an AbortSignal.

Parameters

Parameter	Type
runId	string
descriptor	RunDescriptor

Returns

void

---

inflightCount()

inflightCount(): number;

Defined in: packages/server/src/runtime/run-state.ts:270

Number of runs currently in pending or running. Useful for snapshots / metrics. Note that pending runs hold a reservation but have not yet started any work - see runningCount for the drain-blocking subset.

Returns

number

---

prune()

prune(olderThan): number;

Defined in: packages/server/src/runtime/run-state.ts:312

Drop terminal records older than olderThan.

Parameters

Parameter	Type
olderThan	number

Returns

number

---

runningCount()

runningCount(): number;

Defined in: packages/server/src/runtime/run-state.ts:284

Number of runs with active work in progress (running). The lifecycle drain blocks on this counter only - pending runs are a pure reservation (e.g. an awaited WS subscription) and can be aborted immediately when SIGTERM arrives.

Returns

number

---

snapshot()

snapshot(runId): 
  | RunStateSnapshot
  | undefined;

Defined in: packages/server/src/runtime/run-state.ts:242

Read-only snapshot, safe to JSON.stringify.

Parameters

Parameter	Type
runId	string

Returns

| RunStateSnapshot | undefined

---

start()

start(runId, descriptor): RunHandle;

Defined in: packages/server/src/runtime/run-state.ts:182

Promote a previously-declared run to running (or declare it).

Parameters

Parameter	Type
runId	string
descriptor	RunDescriptor

Returns

RunHandle