fix: prevent completion sound from replaying when reopening completed tasks (#4885)

- Add completionSoundPlayed flag to HistoryItem type
- Modify ChatView to prevent sound on task resumption
- Update Task.ts to persist the completion sound flag
- Update tests to match new behavior

Fixes #4885

Author: SannidhyaSah

packages/types/src/history.ts

@@ -16,6 +16,7 @@ export const historyItemSchema = z.object({
 	totalCost: z.number(),
 	size: z.number().optional(),
 	workspace: z.string().optional(),
+	completionSoundPlayed: z.boolean().optional(),
 })
 
 export type HistoryItem = z.infer<typeof historyItemSchema>

src/core/task/Task.ts

@@ -403,6 +403,16 @@ export class Task extends EventEmitter<ClineEvents> {
 
 			this.emit("taskTokenUsageUpdated", this.taskId, tokenUsage)
 
+			// Check if this is a completion save by looking for completion-related messages
+			const hasCompletionMessage = this.clineMessages.some(
+				(msg) => msg.ask === "completion_result" || msg.ask === "resume_completed_task",
+			)
+
+			// If we have a completion message, set the completionSoundPlayed flag
+			if (hasCompletionMessage) {
+				historyItem.completionSoundPlayed = true
+			}
+
 			await this.providerRef.deref()?.updateTaskHistory(historyItem)
 		} catch (error) {
 			console.error("Failed to save Roo messages:", error)

webview-ui/src/components/chat/ChatView.tsx

@@ -333,7 +333,7 @@ const ChatViewComponent: React.ForwardRefRenderFunction<ChatViewRef, ChatViewPro
 							break
 						case "completion_result":
 							// extension waiting for feedback. but we can just present a new task button
-							if (!isPartial) {
+							if (!isPartial && soundEnabled && !currentTaskItem?.completionSoundPlayed) {
 								playSound("celebration")
 							}
 							setSendingDisabled(isPartial)
@@ -354,9 +354,6 @@ const ChatViewComponent: React.ForwardRefRenderFunction<ChatViewRef, ChatViewPro
 							setDidClickCancel(false) // special case where we reset the cancel button state
 							break
 						case "resume_completed_task":
-							if (!isPartial) {
-								playSound("celebration")
-							}
 							setSendingDisabled(false)
 							setClineAsk("resume_completed_task")
 							setEnableButtons(true)

webview-ui/src/components/chat/__tests__/ChatView.spec.tsx

@@ -884,51 +884,81 @@ describe("ChatView - Sound Playing Tests", () => {
 		})
 	})
 
-	it("plays celebration sound for completion results", async () => {
+	it("plays celebration sound for completion results when completionSoundPlayed is not set", async () => {
 		renderChatView()
 
-		// First hydrate state with initial task and streaming
+		const taskItem = {
+			id: "task-1",
+			number: 1,
+			ts: Date.now() - 2000,
+			task: "Initial task",
+			tokensIn: 100,
+			tokensOut: 50,
+			totalCost: 0.01,
+		}
+
+		// Send completion result without completionSoundPlayed flag
 		mockPostMessage({
 			clineMessages: [
-				{
-					type: "say",
-					say: "task",
-					ts: Date.now() - 2000,
-					text: "Initial task",
-				},
-				{
-					type: "say",
-					say: "api_req_started",
-					ts: Date.now() - 1000,
-					text: JSON.stringify({}),
-					partial: true,
-				},
+				{ type: "say", say: "task", ts: taskItem.ts, text: taskItem.task },
+				{ type: "ask", ask: "completion_result", ts: Date.now(), text: "Task completed", partial: false },
 			],
+			currentTaskItem: taskItem,
+			soundEnabled: true,
 		})
 
-		// Then send the completion result message (streaming finished)
+		await waitFor(() => expect(mockPlayFunction).toHaveBeenCalled())
+	})
+
+	it("does not play celebration sound when completionSoundPlayed is true", async () => {
+		renderChatView()
+
+		const taskItem = {
+			id: "task-1",
+			number: 1,
+			ts: Date.now() - 2000,
+			task: "Initial task",
+			tokensIn: 100,
+			tokensOut: 50,
+			totalCost: 0.01,
+			completionSoundPlayed: true,
+		}
+
+		// Send completion result with completionSoundPlayed flag
 		mockPostMessage({
 			clineMessages: [
-				{
-					type: "say",
-					say: "task",
-					ts: Date.now() - 2000,
-					text: "Initial task",
-				},
-				{
-					type: "ask",
-					ask: "completion_result",
-					ts: Date.now(),
-					text: "Task completed successfully",
-					partial: false,
-				},
+				{ type: "say", say: "task", ts: taskItem.ts, text: taskItem.task },
+				{ type: "ask", ask: "completion_result", ts: Date.now(), text: "Task completed", partial: false },
 			],
+			currentTaskItem: taskItem,
+			soundEnabled: true,
 		})
 
-		// Verify celebration sound was played
-		await waitFor(() => {
-			expect(mockPlayFunction).toHaveBeenCalled()
+		expect(mockPlayFunction).not.toHaveBeenCalled()
+	})
+
+	it("does not play sound when resuming a completed task", async () => {
+		renderChatView()
+
+		mockPostMessage({
+			clineMessages: [
+				{ type: "say", say: "task", ts: Date.now() - 2000, text: "Initial task" },
+				{ type: "ask", ask: "resume_completed_task", ts: Date.now(), text: "Resume", partial: false },
+			],
+			currentTaskItem: {
+				id: "task-1",
+				number: 1,
+				ts: Date.now() - 2000,
+				task: "Initial task",
+				tokensIn: 100,
+				tokensOut: 50,
+				totalCost: 0.01,
+				completionSoundPlayed: true,
+			},
+			soundEnabled: true,
 		})
+
+		expect(mockPlayFunction).not.toHaveBeenCalled()
 	})
 
 	it("plays progress_loop sound for api failures", async () => {