From 51721f802d447de5244dbc0f7b8f37e9174991d6 Mon Sep 17 00:00:00 2001 From: Elliott de Launay Date: Sat, 31 Oct 2026 15:49:18 -0400 Subject: [PATCH] refactor(task): read abort and abortReason from run-state latches --- src/core/task/Task.ts | 15 ++++--- .../task/__tests__/Task.persistence.spec.ts | 3 +- .../task/__tests__/Task.run-shadow.spec.ts | 13 +++--- src/core/task/__tests__/Task.spec.ts | 11 ++--- .../task/__tests__/ask-abort-race.spec.ts | 11 ++--- .../task/__tests__/ask-allowlist-cwd.spec.ts | 3 +- src/core/task/__tests__/ask-auto-deny.spec.ts | 11 ++--- .../ask-clear-approval-buttons.spec.ts | 3 +- .../ask-queued-message-drain.spec.ts | 8 ++-- .../flushPendingToolResultsToHistory.spec.ts | 3 +- .../__tests__/runStateDivergence.spec.ts | 4 +- src/core/task/run-state/runStateDivergence.ts | 2 +- .../ClineProvider.flicker-free-cancel.spec.ts | 3 +- .../webview/__tests__/ClineProvider.spec.ts | 20 ++++----- src/eslint-suppressions.json | 4 +- src/test-utils/__tests__/run-state.spec.ts | 41 +++++++++++++++++++ src/test-utils/run-state.ts | 7 ++++ 17 files changed, 112 insertions(+), 50 deletions(-) create mode 100644 src/test-utils/__tests__/run-state.spec.ts create mode 100644 src/test-utils/run-state.ts diff --git a/src/core/task/Task.ts b/src/core/task/Task.ts index dd86cc7d44..23d4e05261 100644 --- a/src/core/task/Task.ts +++ b/src/core/task/Task.ts @@ -144,7 +144,7 @@ import { mergeConsecutiveApiMessages } from "./mergeConsecutiveApiMessages" import { prepareApiConversationMessage } from "./apiConversationHistory" import { shouldAddUserMessageToHistory } from "./messageCounting" import { type TaskExecutionContext } from "./providerHandoff" -import { initialRunState, type Ask, type RunEvent, type RunState } from "./run-state/runState" +import { abort, abortReason, initialRunState, type Ask, type RunEvent, type RunState } from "./run-state/runState" import { applyRunEvent, type RunRejection } from "./run-state/runStateShadow" import { divergenceKey, @@ -389,7 +389,6 @@ export class Task extends EventEmitter implements TaskLike { providerRef: WeakRef private readonly globalStoragePath: string - abort: boolean = false currentRequestAbortController?: AbortController /** * Controller for the waiter on an in-flight `ensureModelFetched()` call (see @@ -407,7 +406,6 @@ export class Task extends EventEmitter implements TaskLike { didFinishAbortingStream = false abandoned = false - abortReason?: ClineApiReqCancelReason isInitialized = false runState: RunState = initialRunState @@ -3528,8 +3526,15 @@ export class Task extends EventEmitter implements TaskLike { this.driveRunEvent({ tag: "completionAccepted", askTs }) } + get abort(): boolean { + return abort(this.runState) + } + + get abortReason(): ClineApiReqCancelReason | undefined { + return abortReason(this.runState) + } + setAbortReason(reason: ClineApiReqCancelReason): void { - this.abortReason ??= reason this.driveRunEvent({ tag: "reasonSet", reason }) } @@ -3537,7 +3542,6 @@ export class Task extends EventEmitter implements TaskLike { if (isAbandoned) { this.abandoned = true } - this.abort = true this.driveRunEvent({ tag: "abortRequested", abandoned: isAbandoned }) } @@ -3547,7 +3551,6 @@ export class Task extends EventEmitter implements TaskLike { } requestDispose(): void { - this.abort = true this.driveRunEvent({ tag: "disposeRequested" }) } diff --git a/src/core/task/__tests__/Task.persistence.spec.ts b/src/core/task/__tests__/Task.persistence.spec.ts index fb7a4e8cc6..b7c97a357e 100644 --- a/src/core/task/__tests__/Task.persistence.spec.ts +++ b/src/core/task/__tests__/Task.persistence.spec.ts @@ -21,6 +21,7 @@ import { ContextProxy } from "../../config/ContextProxy" import { providerIdentifiers } from "@roo-code/types/provider-identifiers" import { attemptCompletionTool, type AttemptCompletionCallbacks } from "../../tools/AttemptCompletionTool" import type { ToolUse } from "../../../shared/tools" +import { setAbortLatch } from "../../../test-utils/run-state" type TaskPersistenceAccess = { addToApiConversationHistory: (message: Anthropic.MessageParam) => Promise @@ -909,7 +910,7 @@ describe("Task persistence", () => { task: "test task", startTask: false, }) - task.abort = true + setAbortLatch(task, true) task.userMessageContent = [{ type: "tool_result", tool_use_id: "tool-1", content: "done" }] const waitForPersistence = vi.spyOn(task, "waitForCurrentAssistantMessagePersistence") diff --git a/src/core/task/__tests__/Task.run-shadow.spec.ts b/src/core/task/__tests__/Task.run-shadow.spec.ts index 59d89c96cc..5ddc4261a8 100644 --- a/src/core/task/__tests__/Task.run-shadow.spec.ts +++ b/src/core/task/__tests__/Task.run-shadow.spec.ts @@ -101,14 +101,14 @@ describe("Task run-state write helpers", () => { task.requestAbort(false) expect([task.abort, task.abandoned]).toEqual([true, false]) - expect(task.runState.latches).toMatchObject({ abort: true, abandoned: false }) + expect(task.runState.latches.abandoned).toBe(false) }) it("requestAbort(true) sets abort and abandoned", () => { task.requestAbort(true) expect([task.abort, task.abandoned]).toEqual([true, true]) - expect(task.runState.latches).toMatchObject({ abort: true, abandoned: true }) + expect(task.runState.latches.abandoned).toBe(true) }) it("requestAbandon sets abandoned after an abort", () => { @@ -124,7 +124,7 @@ describe("Task run-state write helpers", () => { task.requestDispose() expect(task.abort).toBe(true) - expect(task.runState.latches).toMatchObject({ abort: true, disposed: true }) + expect(task.runState.latches.disposed).toBe(true) }) it("drives the ask events", () => { @@ -149,12 +149,15 @@ describe("Task run-state write helpers", () => { expect(task.runRejections).toEqual([{ event: { tag: "abandonRequested" }, state: initialRunState }]) }) - it("keeps the first abort reason in the field and in the kernel", () => { + it("has no abort reason before one is set", () => { + expect(task.abortReason).toBeUndefined() + }) + + it("keeps the first abort reason", () => { task.setAbortReason("user_cancelled") task.setAbortReason("streaming_failed") expect(task.abortReason).toBe("user_cancelled") - expect(task.runState.latches.reason).toBe("user_cancelled") expect(task.runRejections).toEqual([]) }) }) diff --git a/src/core/task/__tests__/Task.spec.ts b/src/core/task/__tests__/Task.spec.ts index f52f29174c..947ca96d7c 100644 --- a/src/core/task/__tests__/Task.spec.ts +++ b/src/core/task/__tests__/Task.spec.ts @@ -99,6 +99,7 @@ vi.mock("delay", () => ({ import delay from "delay" import pWaitFor from "p-wait-for" +import { setAbortLatch } from "../../../test-utils/run-state" vi.mock("uuid", async (importOriginal) => { const actual = await importOriginal() @@ -1018,7 +1019,7 @@ describe("Cline", () => { const saySpy = vi.spyOn(task, "say").mockImplementation(async (...args) => { const [type, _text, _images, partial] = args if (type === "text" && partial === false) { - task.abort = true + setAbortLatch(task, true) throw new Error("presenter text failed while aborting") } return say(...args) @@ -4613,7 +4614,7 @@ describe("Cline", () => { const abortTaskSpy = vi.spyOn(task, "abortTask").mockResolvedValue(undefined) // Test Case 1: Stream failure should NOT abort task - task.abort = false + setAbortLatch(task, false) task.abandoned = false // Simulate the catch block behavior for stream failure @@ -4634,7 +4635,7 @@ describe("Cline", () => { expect(abortTaskSpy).not.toHaveBeenCalled() // Test Case 2: User cancellation SHOULD abort task - task.abort = true + setAbortLatch(task, true) // For user cancellation, abortTask SHOULD be called if (task.abort) { @@ -7035,7 +7036,7 @@ describe("Cline", () => { await flushMicrotasks() consoleErrorSpy.mockClear() - task.abort = true + setAbortLatch(task, true) getTaskTestAccess(task).presentAssistantMessageSafe() await flushMicrotasks() @@ -7089,7 +7090,7 @@ describe("Cline", () => { consoleErrorSpy.mockClear() // Simulate the TOCTOU race: abort flips between throw and catch. - task.abort = true + setAbortLatch(task, true) getTaskTestAccess(task).presentAssistantMessageSafe() await flushMicrotasks() diff --git a/src/core/task/__tests__/ask-abort-race.spec.ts b/src/core/task/__tests__/ask-abort-race.spec.ts index aa5dbe4a82..7edc8f6aea 100644 --- a/src/core/task/__tests__/ask-abort-race.spec.ts +++ b/src/core/task/__tests__/ask-abort-race.spec.ts @@ -3,6 +3,7 @@ import type { ClineMessage } from "@roo-code/types" import { checkAutoApproval } from "../../auto-approval" import { MessageQueueService } from "../../message-queue/MessageQueueService" import { Task } from "../Task" +import { setAbortLatch } from "../../../test-utils/run-state" vi.mock("../../auto-approval", async (importOriginal) => { const actual = await importOriginal() @@ -11,7 +12,7 @@ vi.mock("../../auto-approval", async (importOriginal) => { function buildTask(getState: () => Promise>) { const task = Object.create(Task.prototype) as Task - task["abort"] = false + setAbortLatch(task, false) task["clineMessages"] = [] task["lastMessageTs"] = undefined task["addToClineMessages"] = vi.fn(async () => {}) @@ -44,7 +45,7 @@ describe("Task.ask abort during the auto-approval await", () => { }) const askPromise = task.ask("tool", JSON.stringify({ tool: "readFile" }), partial) - task["abort"] = true + setAbortLatch(task, true) gate.release() await expect(askPromise).rejects.toThrow(/aborted/) @@ -62,7 +63,7 @@ describe("Task.ask abort during the auto-approval await", () => { const askPromise = task.ask("tool", JSON.stringify({ tool: "readFile" }), false) await vi.waitFor(() => expect(checkAutoApproval).toHaveBeenCalled()) - task["abort"] = true + setAbortLatch(task, true) gate.release() await expect(askPromise).rejects.toThrow(/aborted/) @@ -83,7 +84,7 @@ describe("Task.ask abort during the auto-approval await", () => { task["clineMessages"] = [{ ...original }] const askPromise = task.ask("followup", "new", partial) - task["abort"] = true + setAbortLatch(task, true) gate.release() await expect(askPromise).rejects.toThrow(/aborted/) @@ -102,7 +103,7 @@ describe("Task.ask abort during the auto-approval await", () => { task.messageQueueService.addMessage("queued feedback") const askPromise = task.ask("followup", "Q?", false) - task["abort"] = true + setAbortLatch(task, true) gate.release() await expect(askPromise).rejects.toThrow(/aborted/) diff --git a/src/core/task/__tests__/ask-allowlist-cwd.spec.ts b/src/core/task/__tests__/ask-allowlist-cwd.spec.ts index 3b3682f969..563e7e286e 100644 --- a/src/core/task/__tests__/ask-allowlist-cwd.spec.ts +++ b/src/core/task/__tests__/ask-allowlist-cwd.spec.ts @@ -3,6 +3,7 @@ import type { ExtensionState } from "@roo-code/types" import { Task } from "../Task" +import { setAbortLatch } from "../../../test-utils/run-state" // The allowlist patterns are resolved against a workspace root, and the path in // the tool message was made relative by `getReadablePath(task.cwd, ...)`. So the @@ -23,7 +24,7 @@ type ProviderStub = { function buildTask(provider: ProviderStub, taskCwd: string) { const task = Object.create(Task.prototype) as Task - task["abort"] = false + setAbortLatch(task, false) task["clineMessages"] = [] task["askResponse"] = undefined task["askResponseText"] = undefined diff --git a/src/core/task/__tests__/ask-auto-deny.spec.ts b/src/core/task/__tests__/ask-auto-deny.spec.ts index 4930668c46..0dc5071082 100644 --- a/src/core/task/__tests__/ask-auto-deny.spec.ts +++ b/src/core/task/__tests__/ask-auto-deny.spec.ts @@ -5,6 +5,7 @@ import { type ClineMessage, type ExtensionState, RooCodeEventName } from "@roo-c import * as autoApprovalModule from "../../auto-approval" import { createRateLimitClock } from "../RateLimitClock" import { Task } from "../Task" +import { setAbortLatch } from "../../../test-utils/run-state" // The streaming-loop drive below never asserts on environment details; the // real collector reaches into the VS Code window API, which this file's @@ -31,7 +32,7 @@ type ProviderStub = { function buildTask(provider: ProviderStub, taskCwd: string) { const task = Object.create(Task.prototype) as Task - task["abort"] = false + setAbortLatch(task, false) task["clineMessages"] = [] task["askResponse"] = undefined task["askResponseText"] = undefined @@ -743,7 +744,7 @@ describe("Task.ask queue path cannot bypass blanket deny", () => { await vi.waitFor(() => expect(getStateCalls).toBe(2)) expect(queue.hasUnclaimed()).toBe(false) - task["abort"] = true + setAbortLatch(task, true) // `ask()` must reject on abort; racing a deadline distinguishes a wrong // settle from a hang on the pending read. @@ -830,7 +831,7 @@ describe("Task.ask queue path cannot bypass blanket deny", () => { // longer this wait runs, the less event-loop-stall slack is left before // the 2 s timer could legitimately fire while the task is still live. await vi.waitFor(() => expect(Date.now() - armedAt).toBeGreaterThanOrEqual(300), { timeout: 2_000 }) - task["abort"] = true + setAbortLatch(task, true) const outcome = await toolAsk.then( () => "resolved", @@ -931,7 +932,7 @@ describe("Task.ask queue path cannot bypass blanket deny", () => { await vi.waitFor(() => expect(getStateCalls).toBe(2)) expect(queue.hasUnclaimed()).toBe(false) - task["abort"] = true + setAbortLatch(task, true) // `ask()` must reject on abort; racing a deadline distinguishes a wrong // settle from a hang on the pending read. @@ -993,7 +994,7 @@ describe("Task.ask queue path cannot bypass blanket deny", () => { await vi.waitFor(() => expect(getStateCalls).toBe(2)) expect(queue.hasUnclaimed()).toBe(false) - task["abort"] = true + setAbortLatch(task, true) // `ask()` must reject on abort; racing a deadline distinguishes a wrong // settle from a hang on the pending read. diff --git a/src/core/task/__tests__/ask-clear-approval-buttons.spec.ts b/src/core/task/__tests__/ask-clear-approval-buttons.spec.ts index 240dc9f22a..cc2268c23e 100644 --- a/src/core/task/__tests__/ask-clear-approval-buttons.spec.ts +++ b/src/core/task/__tests__/ask-clear-approval-buttons.spec.ts @@ -1,4 +1,5 @@ import { Task } from "../Task" +import { setAbortLatch } from "../../../test-utils/run-state" // When the backend auto-resolves an interactive ask, isAnswered:true is stamped // on the ClineMessage before it is added so the webview state snapshot already @@ -12,7 +13,7 @@ type ProviderStub = { function buildTask(provider: ProviderStub | undefined) { const task = Object.create(Task.prototype) as Task - ;(task as any).abort = false + setAbortLatch(task, false) ;(task as any).clineMessages = [] ;(task as any).askResponse = undefined ;(task as any).askResponseText = undefined diff --git a/src/core/task/__tests__/ask-queued-message-drain.spec.ts b/src/core/task/__tests__/ask-queued-message-drain.spec.ts index bb74531d45..cc58fde82c 100644 --- a/src/core/task/__tests__/ask-queued-message-drain.spec.ts +++ b/src/core/task/__tests__/ask-queued-message-drain.spec.ts @@ -1,11 +1,11 @@ import { Task } from "../Task" +import { setAbortLatch } from "../../../test-utils/run-state" type QueueTaskTestAccess = { say: Task["say"] saveClineMessages: () => Promise addToClineMessages: () => Promise lastMessageTs?: number - abort: boolean } const getQueueTaskTestAccess = (task: Task) => task as unknown as QueueTaskTestAccess @@ -16,7 +16,7 @@ const getQueueTaskTestAccess = (task: Task) => task as unknown as QueueTaskTestA describe("Task.ask queued message drain", () => { function createTask(provider?: { getState: () => Promise> }) { const task = Object.create(Task.prototype) as Task - ;(task as any).abort = false + setAbortLatch(task, false) ;(task as any).clineMessages = [] ;(task as any).askResponse = undefined ;(task as any).askResponseText = undefined @@ -346,7 +346,7 @@ describe("Task.ask queued message drain", () => { task.messageQueueService.addMessage("Persist me later") const ask = task.ask("completion_result", "Done", false) await Promise.resolve() - access.abort = true + setAbortLatch(task, true) finishAddingAsk() await expect(ask).rejects.toThrow("aborted") @@ -398,7 +398,7 @@ describe("Task.ask queued message drain", () => { await vi.advanceTimersByTimeAsync(0) expect(access.saveClineMessages).toHaveBeenCalledTimes(1) - access.abort = true + setAbortLatch(task, true) await vi.advanceTimersByTimeAsync(250) await expect(persistence).resolves.toBe(false) diff --git a/src/core/task/__tests__/flushPendingToolResultsToHistory.spec.ts b/src/core/task/__tests__/flushPendingToolResultsToHistory.spec.ts index f0df02865a..03b0e99324 100644 --- a/src/core/task/__tests__/flushPendingToolResultsToHistory.spec.ts +++ b/src/core/task/__tests__/flushPendingToolResultsToHistory.spec.ts @@ -12,6 +12,7 @@ import { Task } from "../Task" import { ClineProvider } from "../../webview/ClineProvider" import { ContextProxy } from "../../config/ContextProxy" import { providerIdentifiers } from "@roo-code/types/provider-identifiers" +import { setAbortLatch } from "../../../test-utils/run-state" // Mock delay before any imports that might use it vi.mock("delay", () => ({ @@ -458,7 +459,7 @@ describe("flushPendingToolResultsToHistory", () => { const waitForPersistence = vi.spyOn(task, "waitForCurrentAssistantMessagePersistence") - task.abort = true + setAbortLatch(task, true) await task.flushPendingToolResultsToHistory() diff --git a/src/core/task/run-state/__tests__/runStateDivergence.spec.ts b/src/core/task/run-state/__tests__/runStateDivergence.spec.ts index bd2b740e6d..a552868f2a 100644 --- a/src/core/task/run-state/__tests__/runStateDivergence.spec.ts +++ b/src/core/task/run-state/__tests__/runStateDivergence.spec.ts @@ -85,7 +85,7 @@ describe("findDivergences", () => { expect(divergence.raceId).toBeUndefined() }) - it("compares the latch and phase fields by default and skips the stream fields", () => { + it("compares the abandoned and phase fields by default and skips the kernel-read and stream fields", () => { const [divergence, ...rest] = findDivergences({ event: { tag: "initialized" }, state: initialRunState, @@ -101,7 +101,7 @@ describe("findDivergences", () => { }) expect(rest).toEqual([]) expect(divergence).toMatchObject({ kind: "mismatch" }) - expect([...divergence.mismatched].sort()).toEqual(["abandoned", "abort", "abortReason", "isInitialized"]) + expect([...divergence.mismatched].sort()).toEqual(["abandoned", "isInitialized"]) }) it("ignores a field that is not routed", () => { diff --git a/src/core/task/run-state/runStateDivergence.ts b/src/core/task/run-state/runStateDivergence.ts index a3e270d334..dc85fea2f7 100644 --- a/src/core/task/run-state/runStateDivergence.ts +++ b/src/core/task/run-state/runStateDivergence.ts @@ -15,7 +15,7 @@ export type Divergence = { mismatched: Array } -export const ROUTED_FIELDS: ReadonlyArray = ["abort", "abandoned", "abortReason", "isInitialized"] +export const ROUTED_FIELDS: ReadonlyArray = ["abandoned", "isInitialized"] export type KnownRace = { id: RaceId; matches: (divergence: Divergence) => boolean } diff --git a/src/core/webview/__tests__/ClineProvider.flicker-free-cancel.spec.ts b/src/core/webview/__tests__/ClineProvider.flicker-free-cancel.spec.ts index 44b55dbdcb..dbe6c3429a 100644 --- a/src/core/webview/__tests__/ClineProvider.flicker-free-cancel.spec.ts +++ b/src/core/webview/__tests__/ClineProvider.flicker-free-cancel.spec.ts @@ -10,8 +10,9 @@ import { ContextProxy } from "../../config/ContextProxy" import type { ProviderSettings, HistoryItem } from "@roo-code/types" import { providerIdentifiers } from "@roo-code/types/provider-identifiers" -type MockTask = Partial & +type MockTask = Omit, "abortReason"> & Pick & { + abortReason?: ClineApiReqCancelReason parentTaskId?: string rootTask?: { taskId: string } parentTask?: { taskId: string } diff --git a/src/core/webview/__tests__/ClineProvider.spec.ts b/src/core/webview/__tests__/ClineProvider.spec.ts index 3ccb5493b3..377e44cce3 100644 --- a/src/core/webview/__tests__/ClineProvider.spec.ts +++ b/src/core/webview/__tests__/ClineProvider.spec.ts @@ -1121,7 +1121,7 @@ describe("ClineProvider", () => { test("does not log when the active task is aborted", async () => { const task = new Task(defaultTaskOptions) Object.defineProperty(task, "taskId", { value: "aborted-task", writable: true }) - task.abort = true + Object.assign(task, { abort: true }) await provider.addClineToStack(task) Object.defineProperty(mockWebviewView, "visible", { value: false, configurable: true }) visibilityCallback() @@ -1315,7 +1315,7 @@ describe("ClineProvider", () => { async (interrupted) => { await provider.resolveWebviewView(mockWebviewView) const task = new Task(defaultTaskOptions) - task.abort = interrupted + Object.assign(task, { abort: interrupted }) provider["taskRegistry"].push(task) const evict = vi.spyOn(provider, "evictCurrentTask") const remove = vi.spyOn(provider, "removeClineFromStack") @@ -1381,7 +1381,7 @@ describe("ClineProvider", () => { async (reopened) => { await provider.resolveWebviewView(mockWebviewView) const task = new Task(defaultTaskOptions) - task.abort = true + Object.assign(task, { abort: true }) provider["taskRegistry"].push(task) const remove = vi.spyOn(provider, "removeClineFromStack") let choose: (value: string) => void = () => { @@ -1480,7 +1480,7 @@ describe("ClineProvider", () => { async (delay) => { await provider.resolveWebviewView(mockWebviewView) const task = new Task(defaultTaskOptions) - task.abort = true + Object.assign(task, { abort: true }) provider["taskRegistry"].push(task) const remove = vi.spyOn(provider, "removeClineFromStack") removeSidebarOnCommand() @@ -1510,7 +1510,7 @@ describe("ClineProvider", () => { async (stage) => { await provider.resolveWebviewView(mockWebviewView) const task = new Task(defaultTaskOptions) - task.abort = true + Object.assign(task, { abort: true }) provider["taskRegistry"].push(task) const remove = vi.spyOn(provider, "removeClineFromStack") provider["getWebviewHtml"] = vi.fn().mockResolvedValue("recovered-html") @@ -1619,7 +1619,7 @@ describe("ClineProvider", () => { test("retains recovery intent and remaining attempts while replacement HTML generation outlasts the wait", async () => { await provider.resolveWebviewView(mockWebviewView) const task = new Task(defaultTaskOptions) - task.abort = true + Object.assign(task, { abort: true }) provider["taskRegistry"].push(task) const remove = vi.spyOn(provider, "removeClineFromStack") removeSidebarOnCommand() @@ -1753,7 +1753,7 @@ describe("ClineProvider", () => { test("clears a failed focus incident before a manual sidebar open", async () => { await provider.resolveWebviewView(mockWebviewView) const task = new Task(defaultTaskOptions) - task.abort = true + Object.assign(task, { abort: true }) provider["taskRegistry"].push(task) const remove = vi.spyOn(provider, "removeClineFromStack") vi.mocked(vscode.commands.executeCommand).mockImplementation(async (command) => { @@ -2812,7 +2812,7 @@ describe("ClineProvider", () => { mockWebviewPanel.title = "Zoo Code task" await provider.resolveWebviewView(mockWebviewPanel) const task = new Task(defaultTaskOptions) - task.abort = interrupted + Object.assign(task, { abort: interrupted }) provider["taskRegistry"].push(task) const evict = vi.spyOn(provider, "evictCurrentTask") const remove = vi.spyOn(provider, "removeClineFromStack") @@ -2845,7 +2845,7 @@ describe("ClineProvider", () => { test("explicit retry replaces an exhausted tab without evicting its interrupted task", async () => { await provider.resolveWebviewView(mockWebviewPanel) const task = new Task(defaultTaskOptions) - task.abort = true + Object.assign(task, { abort: true }) provider["taskRegistry"].push(task) const remove = vi.spyOn(provider, "removeClineFromStack") provider["reportWebviewRecoveryFailure"]("Exhausted incident") @@ -2897,7 +2897,7 @@ describe("ClineProvider", () => { async (stage) => { await provider.resolveWebviewView(mockWebviewPanel) const task = new Task(defaultTaskOptions) - task.abort = true + Object.assign(task, { abort: true }) provider["taskRegistry"].push(task) const remove = vi.spyOn(provider, "removeClineFromStack") provider["getWebviewHtml"] = vi.fn().mockResolvedValue("recovered-html") diff --git a/src/eslint-suppressions.json b/src/eslint-suppressions.json index a06c73d8a9..d783122732 100644 --- a/src/eslint-suppressions.json +++ b/src/eslint-suppressions.json @@ -726,12 +726,12 @@ }, "core/task/__tests__/ask-clear-approval-buttons.spec.ts": { "@typescript-eslint/no-explicit-any": { - "count": 19 + "count": 18 } }, "core/task/__tests__/ask-queued-message-drain.spec.ts": { "@typescript-eslint/no-explicit-any": { - "count": 18 + "count": 17 } }, "core/task/__tests__/flushPendingToolResultsToHistory.spec.ts": { diff --git a/src/test-utils/__tests__/run-state.spec.ts b/src/test-utils/__tests__/run-state.spec.ts new file mode 100644 index 0000000000..cfd744556e --- /dev/null +++ b/src/test-utils/__tests__/run-state.spec.ts @@ -0,0 +1,41 @@ +import { describe, expect, it } from "vitest" + +import { initialRunState, type RunState } from "../../core/task/run-state/runState" +import { setAbortLatch } from "../run-state" + +const runningState = (abort = false): RunState => + Object.freeze({ + ...initialRunState, + phase: "running", + generation: 3, + stream: Object.freeze({ tag: "live", generation: 3, cleanupFinished: true }), + ask: Object.freeze({ tag: "other", askTs: 7 }), + turn: Object.freeze({ ...initialRunState.turn, toolUsed: true }), + latches: Object.freeze({ abort, abandoned: true, disposed: true, reason: "user_cancelled" }), + lastCompletionAskTs: 7, + }) + +describe("setAbortLatch", () => { + it("starts from the initial state when the task has no run state", () => { + const task: { runState?: RunState } = {} + setAbortLatch(task, true) + expect(task.runState).toEqual({ + ...initialRunState, + latches: { ...initialRunState.latches, abort: true }, + }) + }) + + it("keeps every other part of an existing run state and returns a new object", () => { + const before = runningState() + const task = { runState: before } + setAbortLatch(task, true) + expect(task.runState).not.toBe(before) + expect(task.runState).toEqual(runningState(true)) + }) + + it.each([true, false])("sets abort to %s from the opposite value", (aborted) => { + const task = { runState: runningState(!aborted) } + setAbortLatch(task, aborted) + expect(task.runState.latches.abort).toBe(aborted) + }) +}) diff --git a/src/test-utils/run-state.ts b/src/test-utils/run-state.ts new file mode 100644 index 0000000000..6767bd80dd --- /dev/null +++ b/src/test-utils/run-state.ts @@ -0,0 +1,7 @@ +import { initialRunState } from "../core/task/run-state/runState" +import type { Task } from "../core/task/Task" + +export function setAbortLatch(task: Partial>, aborted: boolean): void { + const state = task.runState ?? initialRunState + task.runState = { ...state, latches: { ...state.latches, abort: aborted } } +}