Skip to content

Commit 7d135f9

Browse files
committed
test(task): cover multi-task shutdown disposal
1 parent bd19346 commit 7d135f9

2 files changed

Lines changed: 93 additions & 14 deletions

File tree

‎src/core/webview/ClineProvider.ts‎

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -810,6 +810,17 @@ export class ClineProvider
810810
}
811811
}
812812

813+
/** Drain one task's memoized cleanup without preventing the remaining provider shutdown work. */
814+
private async drainTaskDisposal(task: Task): Promise<void> {
815+
try {
816+
await task.dispose()
817+
} catch (error) {
818+
this.log(
819+
`[ClineProvider#dispose] Task cleanup failed for ${task.taskId}.${task.instanceId}: ${error instanceof Error ? error.message : String(error)}`,
820+
)
821+
}
822+
}
823+
813824
async dispose() {
814825
if (this._disposed) {
815826
return
@@ -829,12 +840,12 @@ export class ClineProvider
829840
if (this.taskRegistry.length > 0) {
830841
const task = this.taskRegistry.current!
831842
await this.evictCurrentTask()
832-
await task.dispose()
843+
await this.drainTaskDisposal(task)
833844
}
834845
while (this.taskRegistry.length > 0) {
835846
const task = this.taskRegistry.current!
836847
await this.removeClineFromStack()
837-
await task.dispose()
848+
await this.drainTaskDisposal(task)
838849
}
839850

840851
this.log("Cleared all tasks")

‎src/core/webview/__tests__/ClineProvider.spec.ts‎

Lines changed: 80 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1140,33 +1140,101 @@ describe("ClineProvider", () => {
11401140
expect(disposeCalls).toHaveLength(1)
11411141
})
11421142

1143-
test("dispose drains task cleanup after abort completes", async () => {
1144-
let resolveCleanup!: () => void
1145-
const cleanup = new Promise<void>((resolve) => {
1146-
resolveCleanup = resolve
1147-
})
1148-
const task = {
1149-
taskId: "shutdown-task",
1143+
test("dispose drains every task in abort-then-cleanup order", async () => {
1144+
let resolveCurrentAbort!: () => void
1145+
let resolveCurrentCleanup!: () => void
1146+
let resolveRemainingAbort!: () => void
1147+
let resolveRemainingCleanup!: () => void
1148+
const currentTask = {
1149+
taskId: "current-task",
1150+
instanceId: "current-instance",
11501151
emit: vi.fn(),
1151-
abortTask: vi.fn().mockResolvedValue(undefined),
1152-
dispose: vi.fn().mockReturnValue(cleanup),
1152+
abortTask: vi.fn().mockReturnValue(
1153+
new Promise<void>((resolve) => {
1154+
resolveCurrentAbort = resolve
1155+
}),
1156+
),
1157+
dispose: vi.fn().mockReturnValue(
1158+
new Promise<void>((resolve) => {
1159+
resolveCurrentCleanup = resolve
1160+
}),
1161+
),
1162+
}
1163+
const remainingTask = {
1164+
taskId: "remaining-task",
1165+
instanceId: "remaining-instance",
1166+
emit: vi.fn(),
1167+
abortTask: vi.fn().mockReturnValue(
1168+
new Promise<void>((resolve) => {
1169+
resolveRemainingAbort = resolve
1170+
}),
1171+
),
1172+
dispose: vi.fn().mockReturnValue(
1173+
new Promise<void>((resolve) => {
1174+
resolveRemainingCleanup = resolve
1175+
}),
1176+
),
11531177
}
11541178
Object.assign(provider, { taskRegistry: new TaskRegistry() })
1155-
provider["taskRegistry"].push(task as unknown as Task)
1179+
provider["taskRegistry"].push(remainingTask as unknown as Task)
1180+
provider["taskRegistry"].push(currentTask as unknown as Task)
11561181
let shutdownComplete = false
11571182

11581183
const shutdown = provider.dispose()
11591184
void shutdown.then(() => {
11601185
shutdownComplete = true
11611186
})
1162-
await vi.waitFor(() => expect(task.dispose).toHaveBeenCalledOnce())
1187+
await vi.waitFor(() => expect(currentTask.abortTask).toHaveBeenCalledOnce())
1188+
expect(currentTask.dispose).not.toHaveBeenCalled()
1189+
expect(remainingTask.abortTask).not.toHaveBeenCalled()
1190+
1191+
resolveCurrentAbort()
1192+
await vi.waitFor(() => expect(currentTask.dispose).toHaveBeenCalledOnce())
1193+
expect(remainingTask.abortTask).not.toHaveBeenCalled()
1194+
1195+
resolveCurrentCleanup()
1196+
await vi.waitFor(() => expect(remainingTask.abortTask).toHaveBeenCalledOnce())
1197+
expect(remainingTask.dispose).not.toHaveBeenCalled()
1198+
1199+
resolveRemainingAbort()
1200+
await vi.waitFor(() => expect(remainingTask.dispose).toHaveBeenCalledOnce())
11631201

11641202
expect(shutdownComplete).toBe(false)
1165-
resolveCleanup()
1203+
resolveRemainingCleanup()
11661204
await shutdown
11671205
expect(shutdownComplete).toBe(true)
11681206
})
11691207

1208+
test("dispose continues draining tasks after cleanup rejects", async () => {
1209+
const cleanupError = new Error("cleanup failed")
1210+
const logSpy = vi.spyOn(provider, "log")
1211+
const remainingTask = {
1212+
taskId: "remaining-task",
1213+
instanceId: "remaining-instance",
1214+
emit: vi.fn(),
1215+
abortTask: vi.fn().mockResolvedValue(undefined),
1216+
dispose: vi.fn().mockResolvedValue(undefined),
1217+
}
1218+
const currentTask = {
1219+
taskId: "current-task",
1220+
instanceId: "current-instance",
1221+
emit: vi.fn(),
1222+
abortTask: vi.fn().mockResolvedValue(undefined),
1223+
dispose: vi.fn().mockRejectedValue(cleanupError),
1224+
}
1225+
Object.assign(provider, { taskRegistry: new TaskRegistry() })
1226+
provider["taskRegistry"].push(remainingTask as unknown as Task)
1227+
provider["taskRegistry"].push(currentTask as unknown as Task)
1228+
1229+
await expect(provider.dispose()).resolves.toBeUndefined()
1230+
1231+
expect(currentTask.dispose).toHaveBeenCalledOnce()
1232+
expect(remainingTask.dispose).toHaveBeenCalledOnce()
1233+
expect(logSpy).toHaveBeenCalledWith(
1234+
"[ClineProvider#dispose] Task cleanup failed for current-task.current-instance: cleanup failed",
1235+
)
1236+
})
1237+
11701238
test("handles webviewDidLaunch message", async () => {
11711239
await provider.resolveWebviewView(mockWebviewView)
11721240

0 commit comments

Comments
 (0)