File size: 26,358 Bytes
3144483 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 | // Command queue serializes and limits process execution for shared command lanes.
import { AsyncLocalStorage } from "node:async_hooks";
import { clampPositiveTimerTimeoutMs } from "@openclaw/normalization-core/number-coercion";
import { formatErrorMessage, readErrorName, toErrorObject } from "../infra/errors.js";
import {
diagnosticLogger as diag,
logLaneDequeue,
logLaneEnqueue,
} from "../logging/diagnostic-runtime.js";
import {
applyCommandLaneCapacity,
canAdmitInGroup,
type CommandLaneGroupSpec,
drainCommandLaneGroup,
getLaneGroup,
installCommandLaneGroup,
validateCommandLaneGroupSpec,
} from "./command-queue.capacity-groups.js";
import {
createLaneQueue,
dequeueLaneQueue,
enqueueLaneQueue,
type CommandLaneTaskMarker,
getQueueState,
type LaneGroupState,
type LaneState,
normalizeLane,
removeLaneQueueEntry,
type QueueEntry,
type QueuePriority,
} from "./command-queue.state.js";
import type {
CommandLaneSnapshot,
CommandQueueEnqueueOptions,
CommandQueueTaskDeadline,
} from "./command-queue.types.js";
import {
GatewayDrainingError,
type GatewayDrainReason,
isGatewaySubordinateWorkAdmissionClosed,
isGatewayWorkAdmissionClosed,
markGatewayRestartDraining,
resetGatewayWorkAdmission,
runWithGatewayRootWorkReadmission,
} from "./gateway-work-admission.js";
import { CommandLane } from "./lanes.js";
export { GatewayDrainingError } from "./gateway-work-admission.js";
export type { CommandLaneTaskMarker } from "./command-queue.state.js";
export type { CommandLaneSnapshot } from "./command-queue.types.js";
/**
* Dedicated error type thrown when a queued command is rejected because
* its lane was cleared. Callers that fire-and-forget enqueued tasks can
* catch (or ignore) this specific type to avoid unhandled-rejection noise.
*/
export class CommandLaneClearedError extends Error {
constructor(lane?: string) {
super(lane ? `Command lane "${lane}" cleared` : "Command lane cleared");
this.name = "CommandLaneClearedError";
}
}
/**
* Dedicated error type thrown when an active command exceeds its caller-owned
* lane timeout. The underlying task may still be unwinding, but the lane is
* released so queued work is not blocked forever.
*/
class CommandLaneTaskTimeoutError extends Error {
constructor(
lane: string,
details:
| { cause: "task-budget"; elapsedMs: number; taskBudgetMs: number }
| { cause: "owner-deadline"; elapsedMs: number; taskBudgetMs: number }
| { cause: "progress-idle"; elapsedMs: number; idleMs: number; taskBudgetMs: number }
| { cause: "abort-grace"; elapsedMs: number; graceMs: number; taskBudgetMs: number }
| { cause: "release-signal"; elapsedMs: number; taskBudgetMs: number },
) {
const message = (() => {
switch (details.cause) {
case "task-budget":
return `elapsed ${details.elapsedMs}ms reached task budget ${details.taskBudgetMs}ms`;
case "owner-deadline":
return `owner deadline reached after ${details.elapsedMs}ms`;
case "progress-idle":
return `no progress for ${details.idleMs}ms (task budget ${details.taskBudgetMs}ms, elapsed ${details.elapsedMs}ms)`;
case "abort-grace":
return `abort grace ${details.graceMs}ms elapsed (task budget ${details.taskBudgetMs}ms, elapsed ${details.elapsedMs}ms)`;
case "release-signal":
return `lane release requested after ${details.elapsedMs}ms (task budget ${details.taskBudgetMs}ms)`;
default:
throw new TypeError("Unsupported command lane timeout cause");
}
})();
super(`Command lane "${lane}" task timed out: ${message}`);
this.name = "CommandLaneTaskTimeoutError";
}
}
export function isCommandLaneTaskTimeoutError(err: unknown, lane?: string): boolean {
if (!(err instanceof Error)) {
return false;
}
if (!(err instanceof CommandLaneTaskTimeoutError || err.name === "CommandLaneTaskTimeoutError")) {
return false;
}
return lane === undefined || err.message.includes(`Command lane "${lane}" task timed out`);
}
function isExpectedNonErrorLaneFailure(err: unknown): boolean {
return err instanceof Error && err.name === "LiveSessionModelSwitchError";
}
function isQuietProbeLane(lane: string): boolean {
// setup-inference.ts retains its temp session key, so its derived session lane
// needs the same expected-failure treatment as the explicit probe lane.
return (
lane.startsWith("auth-probe:") ||
lane.startsWith("session:probe-") ||
lane.startsWith("session:temp:setup-inference:probe-setup-inference-")
);
}
function getLaneDepth(state: LaneState): number {
return state.queue.length + state.activeTaskIds.size;
}
function getLaneState(lane: string): LaneState {
const queueState = getQueueState();
const existing = queueState.lanes.get(lane);
if (existing) {
return existing;
}
const created: LaneState = {
lane,
queue: createLaneQueue(),
activeTaskIds: new Set(),
maxConcurrent: 1,
draining: false,
generation: 0,
};
queueState.lanes.set(lane, created);
return created;
}
function completeTask(state: LaneState, taskId: number, taskGeneration: number): boolean {
if (taskGeneration !== state.generation) {
return false;
}
state.activeTaskIds.delete(taskId);
return true;
}
function retireIdleScopedCommandLane(state: LaneState): void {
if (
state.draining ||
state.activeTaskIds.size > 0 ||
state.queue.length > 0 ||
state.maxConcurrent !== 1 ||
(!state.lane.startsWith("session:") &&
!state.lane.startsWith("nested:") &&
!state.lane.startsWith("context-engine-turn-maintenance:"))
) {
return;
}
const lanes = getQueueState().lanes;
// A completed generation may race a recreated lane. Only retire the exact
// idle scoped state after its pump has released the draining guard.
if (lanes.get(state.lane) === state) {
lanes.delete(state.lane);
}
}
function normalizeTaskTimeoutMs(value: number | undefined): number | undefined {
if (value === undefined || !Number.isFinite(value) || value <= 0) {
return undefined;
}
return clampPositiveTimerTimeoutMs(value);
}
function resolveQueuePriority(priority: CommandQueueEnqueueOptions["priority"]): QueuePriority {
switch (priority) {
case "foreground":
return 1;
case "background":
return -1;
default:
return 0;
}
}
function enqueueLaneEntry(state: LaneState, entry: QueueEntry): void {
entry.queuedAheadAtEnqueue = enqueueLaneQueue(state.queue, entry);
entry.activeAheadAtEnqueue = state.activeTaskIds.size;
}
async function runQueueEntryTask(
lane: string,
entry: QueueEntry,
marker: CommandLaneTaskMarker,
): Promise<unknown> {
const taskPromise = Promise.resolve().then(() => entry.task(marker));
const taskTimeoutMs = normalizeTaskTimeoutMs(entry.taskTimeoutMs);
if (taskTimeoutMs === undefined) {
return await taskPromise;
}
const taskTimeoutAbortGraceMs =
normalizeTaskTimeoutMs(entry.taskTimeoutAbortGraceMs) ?? taskTimeoutMs;
const startedAtMs = Date.now();
const readLastProgressAtMs = () => {
let value: number | undefined;
try {
value = entry.taskTimeoutProgressAtMs?.();
} catch (err) {
diag.warn(`lane task timeout progress callback failed: lane=${lane} error="${String(err)}"`);
}
return typeof value === "number" && Number.isFinite(value) && value > 0
? Math.max(startedAtMs, Math.floor(value))
: startedAtMs;
};
let timeoutHandle: ReturnType<typeof setTimeout> | undefined;
let removeAbortListener: (() => void) | undefined;
let removeReleaseListener: (() => void) | undefined;
let removeDeadlineListener: (() => void) | undefined;
let ownerDeadline: CommandQueueTaskDeadline | undefined;
let closed = false;
let timedOut = false;
const timeoutPromise = new Promise<never>((_, reject) => {
const elapsedSinceStartMs = () => Math.max(0, Date.now() - startedAtMs);
const rejectForTimeout = (
details:
| { cause: "task-budget" }
| { cause: "owner-deadline" }
| { cause: "progress-idle"; idleMs: number }
| { cause: "abort-grace"; graceMs: number }
| { cause: "release-signal" },
) => {
timedOut = true;
reject(
new CommandLaneTaskTimeoutError(lane, {
...details,
elapsedMs: elapsedSinceStartMs(),
taskBudgetMs: taskTimeoutMs,
}),
);
};
const armTimer = (delayMs: number, onTimeout: () => void) => {
if (timeoutHandle) {
clearTimeout(timeoutHandle);
}
if (delayMs <= 0) {
onTimeout();
return;
}
timeoutHandle = setTimeout(onTimeout, clampPositiveTimerTimeoutMs(delayMs));
timeoutHandle.unref?.();
};
const armProgressTimeout = () => {
if (ownerDeadline?.kind === "unlimited") {
return;
}
const elapsedMs = Math.max(0, Date.now() - readLastProgressAtMs());
const remainingMs = ownerDeadline
? ownerDeadline.deadlineAtMs - Date.now()
: taskTimeoutMs - elapsedMs;
if (remainingMs <= 0) {
rejectForTimeout(
ownerDeadline
? { cause: "owner-deadline" }
: entry.taskTimeoutProgressAtMs
? { cause: "progress-idle", idleMs: elapsedMs }
: { cause: "task-budget" },
);
return;
}
armTimer(remainingMs, armProgressTimeout);
};
const armAbortTimeout = () => {
const abortStartedAtMs = Date.now();
armTimer(taskTimeoutAbortGraceMs, () =>
rejectForTimeout({
cause: "abort-grace",
graceMs: Math.max(0, Date.now() - abortStartedAtMs),
}),
);
};
const abortSignal = entry.taskTimeoutAbortSignal;
const releaseSignal = entry.taskTimeoutReleaseSignal;
const onRelease = () => {
removeReleaseListener?.();
rejectForTimeout({ cause: "release-signal" });
};
if (releaseSignal?.aborted) {
onRelease();
return;
}
if (releaseSignal) {
releaseSignal.addEventListener("abort", onRelease, { once: true });
removeReleaseListener = () => releaseSignal.removeEventListener("abort", onRelease);
}
if (abortSignal?.aborted) {
armAbortTimeout();
return;
}
armProgressTimeout();
if (abortSignal) {
const onAbort = () => {
removeAbortListener?.();
armAbortTimeout();
};
abortSignal.addEventListener("abort", onAbort, { once: true });
removeAbortListener = () => abortSignal.removeEventListener("abort", onAbort);
}
removeDeadlineListener = entry.taskTimeoutSubscribe?.((deadline) => {
// The exact queue entry owns this handoff. Cancellation and cleanup always win.
if (closed || timedOut || abortSignal?.aborted || releaseSignal?.aborted) {
return;
}
if (timeoutHandle) {
clearTimeout(timeoutHandle);
}
ownerDeadline = deadline;
armProgressTimeout();
});
});
try {
return await Promise.race([taskPromise, timeoutPromise]);
} catch (err) {
if (timedOut) {
void taskPromise.catch((lateErr: unknown) => {
diag.warn(
`lane task rejected after timeout: lane=${lane} timeoutMs=${taskTimeoutMs} error="${String(lateErr)}"`,
);
});
}
throw err;
} finally {
closed = true;
if (timeoutHandle) {
clearTimeout(timeoutHandle);
}
removeAbortListener?.();
removeReleaseListener?.();
removeDeadlineListener?.();
}
}
function drainLane(
lane: string,
maxStarts = Number.POSITIVE_INFINITY,
state = getLaneState(lane),
): number {
if (state.draining) {
if (state.activeTaskIds.size === 0 && state.queue.length > 0) {
diag.warn(
`drainLane blocked: lane=${lane} draining=true active=0 queue=${state.queue.length}`,
);
}
return 0;
}
state.draining = true;
let started = 0;
try {
while (
started < maxStarts &&
state.activeTaskIds.size < state.maxConcurrent &&
state.queue.length > 0 &&
canAdmitInGroup(lane)
) {
const entry = dequeueLaneQueue(state.queue) as QueueEntry;
const waitedMs = Date.now() - entry.enqueuedAt;
const activeBeforeStart = state.activeTaskIds.size;
const taskId = getQueueState().nextTaskId++;
const taskGeneration = state.generation;
// Commit the admission before invoking callbacks or logging. Both can
// synchronously re-enter the queue, and the shared budget must already
// account for this task when that nested admission is evaluated.
state.activeTaskIds.add(taskId);
started += 1;
if (waitedMs >= entry.warnAfterMs) {
try {
entry.onWait?.(waitedMs, entry.queuedAheadAtEnqueue);
} catch (err) {
diag.error(`lane onWait callback failed: lane=${lane} error="${String(err)}"`);
}
diag.warn(
`lane wait exceeded: lane=${lane} waitedMs=${waitedMs} queueAhead=${entry.queuedAheadAtEnqueue} ` +
`activeAhead=${entry.activeAheadAtEnqueue} activeNow=${activeBeforeStart} queueBehind=${state.queue.length}`,
);
}
logLaneDequeue(lane, waitedMs, state.queue.length);
void (async () => {
const startTime = Date.now();
try {
const result = await runQueueEntryTask(lane, entry, {
lane,
taskId,
generation: taskGeneration,
});
const completedCurrentGeneration = completeTask(state, taskId, taskGeneration);
if (completedCurrentGeneration) {
diag.debug(
`lane task done: lane=${lane} durationMs=${Date.now() - startTime} active=${state.activeTaskIds.size} queued=${state.queue.length}`,
);
drainReadyCommandLane(lane, state);
}
entry.resolve(result);
} catch (err) {
const completedCurrentGeneration = completeTask(state, taskId, taskGeneration);
const isProbeLane = isQuietProbeLane(lane);
if (!isProbeLane && !isExpectedNonErrorLaneFailure(err)) {
diag.error(
`lane task error: lane=${lane} durationMs=${Date.now() - startTime} error="${formatErrorMessage(err)}"`,
{ errorName: readErrorName(err) || undefined },
);
} else if (!isProbeLane) {
diag.debug(
`lane task interrupted: lane=${lane} durationMs=${Date.now() - startTime} reason="${String(err)}"`,
);
}
if (completedCurrentGeneration) {
drainReadyCommandLane(lane, state);
}
entry.reject(err);
}
})();
}
} finally {
state.draining = false;
retireIdleScopedCommandLane(state);
}
return started;
}
function drainReadyCommandLane(lane: string, completedState?: LaneState): void {
if (getLaneGroup(lane)) {
drainCommandLaneGroup(lane, drainLane);
return;
}
// An idle scoped lane may have been retired and recreated while an older
// task was finishing. Preserve the completion's captured state so its drain
// cannot retire a newer registry entry that it never owned.
drainLane(lane, Number.POSITIVE_INFINITY, completedState);
}
/**
* Mark gateway as draining for restart so new enqueues fail fast with
* `GatewayDrainingError` instead of being silently killed on shutdown.
*/
export function markGatewayDraining(reason?: GatewayDrainReason): void {
markGatewayRestartDraining(reason);
}
export function isGatewayDraining(): boolean {
return isGatewayWorkAdmissionClosed();
}
/**
* Apply lane concurrencies and group definitions as ONE transaction.
*
* `setCommandLaneConcurrency` drains the instant a lane goes positive, and
* gateway publication is sequential — so applying lanes one at a time can widen
* a member and let it dispatch BEFORE its group exists, admitting work above
* the budget the group was meant to enforce. Suppressing drains until every
* lane max and every group definition is installed closes that window; a single
* commit-time drain pass then dispatches under the final configuration.
*
* Callers must route grouped lanes through here rather than the per-lane
* setter, which cannot know about a group that does not exist yet.
*/
export function publishLaneConfiguration(config: {
lanes?: Readonly<Record<string, number>>;
groups?: Readonly<Record<string, CommandLaneGroupSpec>>;
/** Groups to remove as part of the same transaction. */
clearGroups?: readonly string[];
}): void {
// Phase 0 — validate EVERYTHING before mutating anything. Validating inside
// the install loop would leave already-widened lanes behind on a throw:
// governed by no group, and dispatching their preserved queue on the next
// unrelated drain trigger. Rejection must be a no-op, not a partial apply.
const validated: LaneGroupState[] = [];
for (const [group, spec] of Object.entries(config.groups ?? {})) {
validated.push(validateCommandLaneGroupSpec(group, spec));
}
const touched = new Set<string>();
// Phase 1 — install state with dispatch suppressed. Nothing may start here.
for (const [rawLane, maxConcurrent] of Object.entries(config.lanes ?? {})) {
const lane = normalizeLane(rawLane);
const state = getLaneState(lane);
const minConcurrent = isQuietProbeLane(lane) ? 1 : 0;
state.maxConcurrent = Math.max(minConcurrent, Math.floor(maxConcurrent));
touched.add(lane);
}
for (const group of config.clearGroups ?? []) {
const { laneGroups: groups, laneGroupByLane: groupByLane } = getQueueState();
const existing = groups.get(group);
if (existing) {
for (const member of existing.members) {
groupByLane.delete(member);
touched.add(member);
}
groups.delete(group);
}
}
for (const next of validated) {
const { laneGroups: groups, laneGroupByLane: groupByLane } = getQueueState();
const previous = groups.get(next.group);
for (const member of previous?.members ?? []) {
touched.add(member);
}
for (const member of next.members) {
const previousOwner = groupByLane.get(member);
for (const previousSibling of groups.get(previousOwner ?? "")?.members ?? []) {
touched.add(previousSibling);
}
}
installCommandLaneGroup(next);
for (const member of next.members) {
touched.add(member);
}
}
// Phase 2 — commit. Group membership and budgets are now final, so every
// admission decision in this pass sees the configuration the caller intended.
for (const lane of touched) {
const state = getQueueState().lanes.get(lane);
if (state && state.maxConcurrent > 0 && state.queue.length > 0 && !state.draining) {
drainReadyCommandLane(lane);
}
}
}
export function setCommandLaneConcurrency(lane: string, maxConcurrent: number) {
const cleaned = normalizeLane(lane);
const state = getLaneState(cleaned);
const isProbeLane = isQuietProbeLane(cleaned);
const minConcurrent = isProbeLane ? 1 : 0;
state.maxConcurrent = Math.max(minConcurrent, Math.floor(maxConcurrent));
if (state.maxConcurrent > 0) {
drainReadyCommandLane(cleaned);
}
}
export function enqueueCommandInLane<T>(
lane: string,
task: (marker: CommandLaneTaskMarker) => Promise<T>,
opts?: CommandQueueEnqueueOptions,
): Promise<T> {
if (opts?.abortSignal?.aborted) {
return Promise.reject(toErrorObject(opts.abortSignal.reason, "Queued command aborted"));
}
const queueState = getQueueState();
if (isGatewaySubordinateWorkAdmissionClosed()) {
return Promise.reject(new GatewayDrainingError());
}
const runInAsyncContext = AsyncLocalStorage.snapshot();
const cleaned = normalizeLane(lane);
const warnAfterMs = opts?.warnAfterMs ?? 2_000;
const state = getLaneState(cleaned);
return new Promise<T>((resolve, reject) => {
const entry: QueueEntry = {
task: (marker) => runInAsyncContext(runWithGatewayRootWorkReadmission, () => task(marker)),
resolve: (value) => resolve(value as T),
reject,
enqueuedAt: Date.now(),
sequence: queueState.nextQueueSequence++,
priority: resolveQueuePriority(opts?.priority),
warnAfterMs,
queuedAheadAtEnqueue: 0,
activeAheadAtEnqueue: 0,
taskTimeoutMs: normalizeTaskTimeoutMs(opts?.taskTimeoutMs),
taskTimeoutProgressAtMs: opts?.taskTimeoutProgressAtMs,
taskTimeoutSubscribe: opts?.taskTimeoutSubscribe,
taskTimeoutAbortSignal: opts?.taskTimeoutAbortSignal,
taskTimeoutAbortGraceMs: normalizeTaskTimeoutMs(opts?.taskTimeoutAbortGraceMs),
taskTimeoutReleaseSignal: opts?.taskTimeoutReleaseSignal,
onWait: opts?.onWait,
};
enqueueLaneEntry(state, entry);
const signal = opts?.abortSignal;
if (signal) {
const onAbort = () => {
// The once-listener is already detached. Searching for it again scans
// the remaining listeners when many entries share one abort signal.
entry.releaseQueuedAbort = undefined;
if (removeLaneQueueEntry(state.queue, entry)) {
entry.reject(toErrorObject(signal.reason, "Queued command aborted"));
retireIdleScopedCommandLane(state);
}
};
signal.addEventListener("abort", onAbort, { once: true });
entry.releaseQueuedAbort = () => signal.removeEventListener("abort", onAbort);
}
logLaneEnqueue(cleaned, getLaneDepth(state));
drainReadyCommandLane(cleaned);
if (entry.queued) {
try {
opts?.onQueued?.();
} catch (err) {
diag.error(`lane onQueued callback failed: lane=${cleaned} error="${String(err)}"`);
}
}
});
}
export function getQueueSize(lane: string = CommandLane.Main) {
const resolved = normalizeLane(lane);
const state = getQueueState().lanes.get(resolved);
if (!state) {
return 0;
}
return getLaneDepth(state);
}
export function getCommandLaneSnapshot(lane: string = CommandLane.Main): CommandLaneSnapshot {
const resolved = normalizeLane(lane);
const state = getQueueState().lanes.get(resolved);
const snapshot: CommandLaneSnapshot = {
lane: state?.lane ?? resolved,
queuedCount: state?.queue.length ?? 0,
activeCount: state?.activeTaskIds.size ?? 0,
maxConcurrent: state?.maxConcurrent ?? 1,
draining: state?.draining ?? false,
generation: state?.generation ?? 0,
blockedBy: null,
};
// Missing or retired lanes can still be group members; never recreate them to read capacity.
applyCommandLaneCapacity(snapshot);
return snapshot;
}
/** Per-lane work totals for every live lane; diagnostics composition lives in command-lane-diagnostics.ts. */
export function listCommandLaneTotals(): Array<{
lane: string;
activeCount: number;
queuedCount: number;
}> {
return [...getQueueState().lanes.values()].map((state) => ({
lane: state.lane,
activeCount: state.activeTaskIds.size,
queuedCount: state.queue.length,
}));
}
/**
* Active task ids for a lane. Ids are process-monotonic, so recovery can
* detect a turn that started after a point in time it captured earlier.
*/
export function getCommandLaneActiveTaskIds(lane: string = CommandLane.Main): number[] {
const state = getQueueState().lanes.get(normalizeLane(lane));
return state ? [...state.activeTaskIds] : [];
}
/** Return whether this exact lane task still owns an active queue slot. */
export function isCommandLaneTaskMarkerCurrent(marker: CommandLaneTaskMarker | undefined): boolean {
if (!marker) {
return false;
}
const state = getQueueState().lanes.get(normalizeLane(marker.lane));
return state?.generation === marker.generation && state.activeTaskIds.has(marker.taskId);
}
export function getTotalQueueSize() {
let total = 0;
for (const s of getQueueState().lanes.values()) {
total += getLaneDepth(s);
}
return total;
}
export function clearCommandLane(lane: string = CommandLane.Main) {
const cleaned = normalizeLane(lane);
const state = getQueueState().lanes.get(cleaned);
if (!state) {
return 0;
}
const removed = state.queue.length;
let entry: QueueEntry | undefined;
while ((entry = dequeueLaneQueue(state.queue))) {
entry.reject(new CommandLaneClearedError(cleaned));
}
return removed;
}
/**
* Force a single lane back to idle and immediately pump any queued entries.
* Used only by recovery paths after the owner has already attempted to abort
* the active work; stale completions from the previous generation are ignored.
*/
export function resetCommandLane(lane: string = CommandLane.Main): number {
const cleaned = normalizeLane(lane);
const state = getQueueState().lanes.get(cleaned);
if (!state) {
return 0;
}
const released = state.activeTaskIds.size;
state.generation += 1;
state.activeTaskIds.clear();
state.draining = false;
// Clearing activeTaskIds may release multiple shared slots. Re-arbitrate the
// whole group so the reset lane cannot reclaim them ahead of older siblings.
drainReadyCommandLane(cleaned);
return released;
}
/**
* Reset all lane runtime state to idle. Used after SIGUSR1 in-process
* restarts where interrupted tasks' finally blocks may not run, leaving
* stale active task IDs that permanently block new work from draining.
*
* Bumps lane generation and clears execution counters so stale completions
* from old in-flight tasks are ignored. Queued entries are intentionally
* preserved — they represent pending user work that should still execute
* after restart.
*
* After resetting, drains any lanes that still have queued entries so
* preserved work is pumped immediately rather than waiting for a future
* `enqueueCommandInLane()` call (which may never come).
*/
export function resetAllLanes(): void {
const queueState = getQueueState();
resetGatewayWorkAdmission();
const lanesToDrain: string[] = [];
for (const state of queueState.lanes.values()) {
state.generation += 1;
state.activeTaskIds.clear();
state.draining = false;
if (state.queue.length > 0) {
lanesToDrain.push(state.lane);
}
}
// Drain after the full reset pass so all lanes are in a clean state first.
for (const lane of lanesToDrain) {
drainReadyCommandLane(lane);
}
}
|