Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 2 additions & 11 deletions ts/packages/dispatcher/dispatcher/src/dispatcher.ts
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ import {
DispatcherOptions,
initializeCommandHandlerContext,
} from "./context/commandHandlerContext.js";
import { cancelQueuedRequest } from "./queue/requestQueue.js";
import { randomUUID } from "node:crypto";
import { context as otelContext } from "@opentelemetry/api";
import { getAgentSchemas } from "./context/system/describe/agentSchemaInfo.js";
Expand Down Expand Up @@ -413,17 +414,7 @@ export function createDispatcherFromContext(
structuredExecution.continueAction(request),
cancelAction: (request) => structuredExecution.cancelAction(request),
async cancelCommand(requestId: string): Promise<CancelResult> {
const kind = context.requestQueue.classifyCancel(requestId, "user");
if (kind === "queued") {
return { kind: "cancelled_queued", requestId };
}
if (kind === "running") {
context.requestQueue.cancelRunning(requestId, "user");
const controller = context.activeRequests.get(requestId);
controller?.abort();
return { kind: "cancelled_running", requestId };
}
return { kind: "not_found", requestId };
return cancelQueuedRequest(context, requestId, "user");
},
async promoteCommand(requestId: string): Promise<boolean> {
return context.requestQueue.promote(requestId);
Expand Down
26 changes: 26 additions & 0 deletions ts/packages/dispatcher/dispatcher/src/queue/requestQueue.ts
Original file line number Diff line number Diff line change
Expand Up @@ -750,5 +750,31 @@ export function entryCompletion(
return entry.completion;
}

type RequestCancellationContext = {
requestQueue: RequestQueue;
activeRequests: ReadonlyMap<string, AbortController>;
};

/**
* Cancel a queue-managed request by its server request id.
* Running cancellation is published before its controller is aborted.
*/
export function cancelQueuedRequest(
context: RequestCancellationContext,
requestId: string,
reason: QueueCancelReason,
): CancelResult {
const kind = context.requestQueue.classifyCancel(requestId, reason);
if (kind === "queued") {
return { kind: "cancelled_queued", requestId };
}
if (kind === "running") {
context.requestQueue.cancelRunning(requestId, reason);
context.activeRequests.get(requestId)?.abort();
return { kind: "cancelled_running", requestId };
}
return { kind: "not_found", requestId };
}

/** Re-export for consumers that build CancelResult without going via the queue. */
export type { CancelResult };
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ import {
import type { CommandHandlerContext } from "../context/commandHandlerContext.js";
import type { executeActions } from "../execute/actionHandlers.js";
import type { getActionContext } from "../execute/actionContext.js";
import { cancelQueuedRequest } from "../queue/requestQueue.js";
import { getAppAgentName } from "../translation/agentTranslators.js";
import type { StructuredActionDiscovery } from "./discovery.js";
import {
Expand Down Expand Up @@ -675,11 +676,7 @@ class Operation implements StructuredExecutionHooks {
this.possibleEffects ? "execution_uncertain" : "cancelled",
),
);
const queue = this.context.requestQueue;
if (!queue.cancelQueued(this.id, "user")) {
queue.cancelRunning(this.id, "user");
this.context.activeRequests.get(this.id)?.abort();
}
cancelQueuedRequest(this.context, this.id, "user");
}

retire(): void {
Expand Down
82 changes: 82 additions & 0 deletions ts/packages/dispatcher/dispatcher/test/queue/requestQueue.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ import {
import { context, createContextKey, type Context } from "@opentelemetry/api";

import {
cancelQueuedRequest,
RequestQueue,
MAX_QUEUE_DEPTH,
QueueBroadcaster,
Expand Down Expand Up @@ -244,6 +245,87 @@ describe("RequestQueue", () => {
expect(queue.cancelQueued("does-not-exist", "user")).toBe(false);
});

it("cancelQueuedRequest maps queued and unknown request ids", async () => {
const dispatcher = new ControllableDispatcher();
const { queue } = makeQueue(dispatcher);
const activeRequests = new Map<string, AbortController>();
const running = queue.submit({
text: "running",
originatorConnectionId: "c1",
});
const queued = queue.submit({
text: "queued",
originatorConnectionId: "c1",
});
await flush();

expect(
cancelQueuedRequest(
{ requestQueue: queue, activeRequests },
queued.requestId,
"user",
),
).toEqual({
kind: "cancelled_queued",
requestId: queued.requestId,
});
expect(
cancelQueuedRequest(
{ requestQueue: queue, activeRequests },
queued.requestId,
"user",
),
).toEqual({ kind: "not_found", requestId: queued.requestId });

dispatcher.calls[0].resolve({});
await running.completion;
});

it("cancelQueuedRequest broadcasts before abort and is idempotent", async () => {
const dispatcher = new ControllableDispatcher();
const { queue, events } = makeQueue(dispatcher);
const running = queue.submit({
text: "running",
originatorConnectionId: "c1",
});
await flush();
const controller = new AbortController();
const activeRequests = new Map([[running.requestId, controller]]);
let cancelEventsAtAbort = 0;
controller.signal.addEventListener("abort", () => {
cancelEventsAtAbort = events.filter(
(event) =>
event.type === "cancelled" &&
event.requestId === running.requestId,
).length;
});

const context = { requestQueue: queue, activeRequests };
expect(cancelQueuedRequest(context, running.requestId, "user")).toEqual(
{
kind: "cancelled_running",
requestId: running.requestId,
},
);
expect(cancelEventsAtAbort).toBe(1);
expect(cancelQueuedRequest(context, running.requestId, "user")).toEqual(
{
kind: "cancelled_running",
requestId: running.requestId,
},
);
expect(
events.filter(
(event) =>
event.type === "cancelled" &&
event.requestId === running.requestId,
),
).toHaveLength(1);

dispatcher.calls[0].resolve({});
await running.completion;
});

it("promote moves a queued entry to the front so it runs next", async () => {
const dispatcher = new ControllableDispatcher();
const { queue, events } = makeQueue(dispatcher);
Expand Down
Loading