|
| 1 | +import { describe, it, expect, vi, beforeEach } from "vitest" |
| 2 | +import type { ProviderSettings, HistoryItem } from "@roo-code/types" |
| 3 | +import { providerIdentifiers } from "@roo-code/types" |
| 4 | + |
| 5 | +import { Task } from "../Task" |
| 6 | +import * as taskTitleGen from "../taskTitleGenerator" |
| 7 | + |
| 8 | +vi.mock("../taskTitleGenerator", () => ({ |
| 9 | + generateTaskTitle: vi.fn(), |
| 10 | +})) |
| 11 | + |
| 12 | +type TaskTitleAccess = { |
| 13 | + generateTitleInBackground(taskText: string): Promise<void> |
| 14 | + startTask(task?: string, images?: string[]): Promise<void> |
| 15 | + cancelCurrentRequest(): void |
| 16 | + requestAbort(isAbandoned: boolean): void |
| 17 | + titleAbortController?: AbortController |
| 18 | + abort: boolean |
| 19 | + abandoned: boolean |
| 20 | + taskId: string |
| 21 | + instanceId: string |
| 22 | + apiConfiguration: ProviderSettings |
| 23 | + parentTask?: Task |
| 24 | + metadata: { task?: string; images?: string[] } |
| 25 | +} |
| 26 | + |
| 27 | +const getTaskTitleAccess = (task: Task) => task as unknown as TaskTitleAccess |
| 28 | + |
| 29 | +describe("Task title generation", () => { |
| 30 | + const mockApiConfig: ProviderSettings = { |
| 31 | + apiProvider: providerIdentifiers.anthropic, |
| 32 | + apiKey: "test-key", |
| 33 | + } |
| 34 | + |
| 35 | + let mockHistoryStore: Map<string, HistoryItem> |
| 36 | + let mockRenameTaskWithId: ReturnType<typeof vi.fn> |
| 37 | + let mockProvider: { |
| 38 | + renameTaskWithId: ReturnType<typeof vi.fn> |
| 39 | + taskHistoryStore: { |
| 40 | + get: (id: string) => HistoryItem | undefined |
| 41 | + } |
| 42 | + postStateToWebviewWithoutTaskHistory: ReturnType<typeof vi.fn> |
| 43 | + } |
| 44 | + |
| 45 | + beforeEach(() => { |
| 46 | + vi.clearAllMocks() |
| 47 | + mockHistoryStore = new Map() |
| 48 | + mockRenameTaskWithId = vi.fn().mockResolvedValue(undefined) |
| 49 | + mockProvider = { |
| 50 | + renameTaskWithId: mockRenameTaskWithId, |
| 51 | + taskHistoryStore: { |
| 52 | + get: (id: string) => mockHistoryStore.get(id), |
| 53 | + }, |
| 54 | + postStateToWebviewWithoutTaskHistory: vi.fn().mockResolvedValue(undefined), |
| 55 | + } |
| 56 | + }) |
| 57 | + |
| 58 | + function createTestTask(options: { parentTask?: Task; initialTitle?: string } = {}) { |
| 59 | + const task = Object.create(Task.prototype) as Task |
| 60 | + const taskId = "task-title-1" |
| 61 | + mockHistoryStore.set(taskId, { |
| 62 | + id: taskId, |
| 63 | + ts: Date.now(), |
| 64 | + task: "Initial prompt message", |
| 65 | + title: options.initialTitle, |
| 66 | + } as HistoryItem) |
| 67 | + |
| 68 | + Object.assign(task, { |
| 69 | + taskId, |
| 70 | + instanceId: "inst-1", |
| 71 | + apiConfiguration: mockApiConfig, |
| 72 | + providerRef: { deref: () => mockProvider }, |
| 73 | + abort: false, |
| 74 | + abandoned: false, |
| 75 | + parentTask: options.parentTask, |
| 76 | + metadata: { task: "Initial prompt message" }, |
| 77 | + say: vi.fn().mockResolvedValue(undefined), |
| 78 | + getEnabledMcpToolsCount: vi.fn().mockResolvedValue({ enabledToolCount: 0, enabledServerCount: 0 }), |
| 79 | + markInitialized: vi.fn(), |
| 80 | + initiateTaskLoop: vi.fn().mockResolvedValue(undefined), |
| 81 | + driveRunEvent: vi.fn(), |
| 82 | + }) |
| 83 | + |
| 84 | + return task |
| 85 | + } |
| 86 | + |
| 87 | + describe("generateTitleInBackground", () => { |
| 88 | + it("calls generateTaskTitle and updates task title via renameTaskWithId", async () => { |
| 89 | + vi.mocked(taskTitleGen.generateTaskTitle).mockResolvedValueOnce("Summarized Title") |
| 90 | + const task = createTestTask() |
| 91 | + |
| 92 | + await getTaskTitleAccess(task).generateTitleInBackground("Initial prompt message") |
| 93 | + |
| 94 | + expect(taskTitleGen.generateTaskTitle).toHaveBeenCalledWith( |
| 95 | + "Initial prompt message", |
| 96 | + mockApiConfig, |
| 97 | + expect.objectContaining({ |
| 98 | + taskId: "task-title-1", |
| 99 | + timeoutMs: 10000, |
| 100 | + }), |
| 101 | + ) |
| 102 | + expect(mockRenameTaskWithId).toHaveBeenCalledWith("task-title-1", "Summarized Title") |
| 103 | + }) |
| 104 | + |
| 105 | + it("does not call renameTaskWithId when generateTaskTitle returns undefined", async () => { |
| 106 | + vi.mocked(taskTitleGen.generateTaskTitle).mockResolvedValueOnce(undefined) |
| 107 | + const task = createTestTask() |
| 108 | + |
| 109 | + await getTaskTitleAccess(task).generateTitleInBackground("Initial prompt message") |
| 110 | + |
| 111 | + expect(mockRenameTaskWithId).not.toHaveBeenCalled() |
| 112 | + }) |
| 113 | + |
| 114 | + it("does not overwrite if the task already has a custom title set", async () => { |
| 115 | + vi.mocked(taskTitleGen.generateTaskTitle).mockResolvedValueOnce("Summarized Title") |
| 116 | + const task = createTestTask({ initialTitle: "User Custom Title" }) |
| 117 | + |
| 118 | + await getTaskTitleAccess(task).generateTitleInBackground("Initial prompt message") |
| 119 | + |
| 120 | + expect(mockRenameTaskWithId).not.toHaveBeenCalled() |
| 121 | + }) |
| 122 | + |
| 123 | + it("does not call renameTaskWithId if task is aborted during generation", async () => { |
| 124 | + const task = createTestTask() |
| 125 | + vi.mocked(taskTitleGen.generateTaskTitle).mockImplementationOnce(async () => { |
| 126 | + task.abort = true |
| 127 | + return "Summarized Title" |
| 128 | + }) |
| 129 | + |
| 130 | + await getTaskTitleAccess(task).generateTitleInBackground("Initial prompt message") |
| 131 | + |
| 132 | + expect(mockRenameTaskWithId).not.toHaveBeenCalled() |
| 133 | + }) |
| 134 | + |
| 135 | + it("does not call renameTaskWithId if task is abandoned during generation", async () => { |
| 136 | + const task = createTestTask() |
| 137 | + vi.mocked(taskTitleGen.generateTaskTitle).mockImplementationOnce(async () => { |
| 138 | + task.abandoned = true |
| 139 | + return "Summarized Title" |
| 140 | + }) |
| 141 | + |
| 142 | + await getTaskTitleAccess(task).generateTitleInBackground("Initial prompt message") |
| 143 | + |
| 144 | + expect(mockRenameTaskWithId).not.toHaveBeenCalled() |
| 145 | + }) |
| 146 | + |
| 147 | + it("cleans up titleAbortController when finished", async () => { |
| 148 | + vi.mocked(taskTitleGen.generateTaskTitle).mockResolvedValueOnce("Summarized Title") |
| 149 | + const task = createTestTask() |
| 150 | + |
| 151 | + await getTaskTitleAccess(task).generateTitleInBackground("Initial prompt message") |
| 152 | + |
| 153 | + expect(getTaskTitleAccess(task).titleAbortController).toBeUndefined() |
| 154 | + }) |
| 155 | + }) |
| 156 | + |
| 157 | + describe("cancellation and abort handling", () => { |
| 158 | + it("aborts titleAbortController in cancelCurrentRequest", () => { |
| 159 | + const task = createTestTask() |
| 160 | + const access = getTaskTitleAccess(task) |
| 161 | + const controller = new AbortController() |
| 162 | + const abortSpy = vi.spyOn(controller, "abort") |
| 163 | + access.titleAbortController = controller |
| 164 | + |
| 165 | + access.cancelCurrentRequest() |
| 166 | + |
| 167 | + expect(abortSpy).toHaveBeenCalled() |
| 168 | + expect(access.titleAbortController).toBeUndefined() |
| 169 | + }) |
| 170 | + |
| 171 | + it("aborts titleAbortController in requestAbort", () => { |
| 172 | + const task = createTestTask() |
| 173 | + const access = getTaskTitleAccess(task) |
| 174 | + const controller = new AbortController() |
| 175 | + const abortSpy = vi.spyOn(controller, "abort") |
| 176 | + access.titleAbortController = controller |
| 177 | + |
| 178 | + access.requestAbort(false) |
| 179 | + |
| 180 | + expect(abortSpy).toHaveBeenCalled() |
| 181 | + expect(access.titleAbortController).toBeUndefined() |
| 182 | + }) |
| 183 | + }) |
| 184 | + |
| 185 | + describe("startTask background trigger", () => { |
| 186 | + it("starts background title generation for top-level task with prompt", async () => { |
| 187 | + const task = createTestTask() |
| 188 | + const access = getTaskTitleAccess(task) |
| 189 | + const titleBgSpy = vi.spyOn(access, "generateTitleInBackground").mockResolvedValue(undefined) |
| 190 | + |
| 191 | + await access.startTask("Initial prompt message") |
| 192 | + |
| 193 | + expect(titleBgSpy).toHaveBeenCalledWith("Initial prompt message") |
| 194 | + }) |
| 195 | + |
| 196 | + it("does not start title generation for child/subtasks", async () => { |
| 197 | + const parent = createTestTask() |
| 198 | + const child = createTestTask({ parentTask: parent }) |
| 199 | + const access = getTaskTitleAccess(child) |
| 200 | + const titleBgSpy = vi.spyOn(access, "generateTitleInBackground").mockResolvedValue(undefined) |
| 201 | + |
| 202 | + await access.startTask("Child subtask prompt") |
| 203 | + |
| 204 | + expect(titleBgSpy).not.toHaveBeenCalled() |
| 205 | + }) |
| 206 | + |
| 207 | + it("does not start title generation when prompt is omitted", async () => { |
| 208 | + const task = createTestTask() |
| 209 | + const access = getTaskTitleAccess(task) |
| 210 | + const titleBgSpy = vi.spyOn(access, "generateTitleInBackground").mockResolvedValue(undefined) |
| 211 | + |
| 212 | + await access.startTask(undefined) |
| 213 | + |
| 214 | + expect(titleBgSpy).not.toHaveBeenCalled() |
| 215 | + }) |
| 216 | + }) |
| 217 | +}) |
0 commit comments