Skip to content

Commit 4d13b64

Browse files
committed
fix(webview): keep message metadata fresh and identify originals by messageId
Cache only the stripped text so isAnswered/partial changes are not served stale, and request originalContent by messageId and taskId instead of ts alone, which can collide within a millisecond and across tasks.
1 parent 2ece75b commit 4d13b64

9 files changed

Lines changed: 203 additions & 50 deletions

File tree

‎packages/types/src/vscode-extension-host.ts‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -112,8 +112,8 @@ export interface ExtensionMessage {
112112
text?: string
113113
/** For fileContent: { path, content, error? } */
114114
fileContent?: { path: string; content: string | null; error?: string }
115-
/** For originalContent: the pre-edit file content of the tool message with this ts (null when unavailable) */
116-
originalContentInfo?: { ts: number; content: string | null }
115+
/** For originalContent: the pre-edit file content of the requested tool message (null when unavailable) */
116+
originalContentInfo?: { ts: number; messageId?: string; taskId?: string; content: string | null }
117117
payload?: any // eslint-disable-line @typescript-eslint/no-explicit-any
118118
checkpointWarning?: {
119119
type: "WAIT_TIMEOUT" | "INIT_TIMEOUT"
@@ -700,6 +700,7 @@ export interface WebviewMessage {
700700
ids?: string[]
701701
terminalOperation?: "continue" | "abort"
702702
messageTs?: number
703+
messageId?: string
703704
restoreCheckpoint?: boolean
704705
historyPreviewCollapsed?: boolean
705706
filters?: { type?: string; search?: string; tags?: string[] }

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

Lines changed: 41 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,7 @@ describe("omitOriginalContent", () => {
101101
const first = omitOriginalContent(message)
102102
const second = omitOriginalContent(message)
103103

104-
expect(second).toBe(first)
104+
expect(second).toEqual(first)
105105
expect(parse).toHaveBeenCalledTimes(1)
106106
parse.mockRestore()
107107

@@ -112,6 +112,24 @@ describe("omitOriginalContent", () => {
112112
expect(JSON.parse(third.text!)).toMatchObject({ path: "b.ts", originalContentLength: bigOriginal.length + 4 })
113113
})
114114

115+
it("takes metadata from the current message when the cached text is reused", () => {
116+
const message = toolAsk(
117+
{ tool: "appliedDiff", path: "a.ts", originalContent: bigOriginal },
118+
{ partial: false, isAnswered: false },
119+
)
120+
121+
expect(omitOriginalContent(message).isAnswered).toBe(false)
122+
123+
// approval only flips metadata; the text is unchanged
124+
message.isAnswered = true
125+
message.partial = true
126+
const result = omitOriginalContent(message)
127+
128+
expect(result).toMatchObject({ isAnswered: true, partial: true })
129+
expect(JSON.parse(result.text!)).toMatchObject({ originalContentLength: bigOriginal.length })
130+
expect(result.text).not.toContain(bigOriginal.slice(0, 50))
131+
})
132+
115133
it("is idempotent", () => {
116134
const once = omitOriginalContent(toolAsk({ tool: "appliedDiff", path: "a.ts", originalContent: bigOriginal }))
117135

@@ -126,8 +144,23 @@ describe("findOriginalContent", () => {
126144
toolAsk({ tool: "appliedDiff", path: "b.ts", originalContent: "other" }),
127145
]
128146

129-
expect(findOriginalContent(messages, messages[0]!.ts)).toBe(bigOriginal)
130-
expect(findOriginalContent(messages, messages[1]!.ts)).toBe("other")
147+
expect(findOriginalContent(messages, { ts: messages[0]!.ts })).toBe(bigOriginal)
148+
expect(findOriginalContent(messages, { ts: messages[1]!.ts })).toBe("other")
149+
})
150+
151+
it("tells messages created in the same millisecond apart by messageId", () => {
152+
const first = toolAsk({ tool: "appliedDiff", path: "a.ts", originalContent: "first" }, { messageId: "id-1" })
153+
const second = toolAsk(
154+
{ tool: "appliedDiff", path: "b.ts", originalContent: "second" },
155+
{ messageId: "id-2", ts: first.ts },
156+
)
157+
const messages = [first, second]
158+
159+
expect(findOriginalContent(messages, { messageId: "id-2", ts: first.ts })).toBe("second")
160+
expect(findOriginalContent(messages, { messageId: "id-1", ts: first.ts })).toBe("first")
161+
expect(findOriginalContent(messages, { messageId: "missing", ts: first.ts })).toBeNull()
162+
// messages persisted without an id are still found by ts
163+
expect(findOriginalContent(messages, { ts: first.ts })).toBe("first")
131164
})
132165

133166
it("finds say tool messages too", () => {
@@ -138,7 +171,7 @@ describe("findOriginalContent", () => {
138171
text: JSON.stringify({ tool: "editedExistingFile", originalContent: bigOriginal }),
139172
}
140173

141-
expect(findOriginalContent([message], message.ts)).toBe(bigOriginal)
174+
expect(findOriginalContent([message], { ts: message.ts })).toBe(bigOriginal)
142175
})
143176

144177
it("returns null when there is nothing to return", () => {
@@ -155,17 +188,17 @@ describe("findOriginalContent", () => {
155188
const all = [noOriginal, notTool, unparsable, notAString, noText]
156189

157190
for (const message of all) {
158-
expect(findOriginalContent(all, message.ts)).toBeNull()
191+
expect(findOriginalContent(all, { ts: message.ts })).toBeNull()
159192
}
160193

161-
expect(findOriginalContent(all, -1)).toBeNull()
162-
expect(findOriginalContent(undefined, 1)).toBeNull()
194+
expect(findOriginalContent(all, { ts: -1 })).toBeNull()
195+
expect(findOriginalContent(undefined, { ts: 1 })).toBeNull()
163196
})
164197

165198
it("returns an empty original as an empty string", () => {
166199
const message = toolAsk({ tool: "newFileCreated", content: "x", originalContent: "" })
167200

168-
expect(findOriginalContent([message], message.ts)).toBe("")
201+
expect(findOriginalContent([message], { ts: message.ts })).toBe("")
169202
})
170203
})
171204

‎src/core/webview/__tests__/webviewMessageHandler.readOriginalContent.spec.ts‎

Lines changed: 49 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -65,17 +65,17 @@ import type { ClineMessage } from "@roo-code/types"
6565

6666
const originalFile = "const a = 1\nconst b = 2\n"
6767

68-
const toolMessage = (ts: number, payload: unknown, type: "ask" | "say" = "ask"): ClineMessage =>
68+
const toolMessage = (ts: number, payload: unknown, type: "ask" | "say" = "ask", messageId?: string): ClineMessage =>
6969
type === "ask"
70-
? { ts, type: "ask", ask: "tool", text: JSON.stringify(payload) }
71-
: { ts, type: "say", say: "tool", text: JSON.stringify(payload) }
70+
? { ts, type: "ask", ask: "tool", text: JSON.stringify(payload), ...(messageId && { messageId }) }
71+
: { ts, type: "say", say: "tool", text: JSON.stringify(payload), ...(messageId && { messageId }) }
7272

7373
function createProvider(clineMessages: ClineMessage[] | undefined) {
7474
const postMessageToWebview = vi.fn()
7575
// Only the members the handler touches for this message type.
7676
const provider = {
7777
postMessageToWebview,
78-
getCurrentTask: vi.fn().mockReturnValue(clineMessages ? { clineMessages } : undefined),
78+
getCurrentTask: vi.fn().mockReturnValue(clineMessages ? { taskId: "task-1", clineMessages } : undefined),
7979
} as unknown as ClineProvider
8080

8181
return { provider, postMessageToWebview }
@@ -96,7 +96,7 @@ describe("webviewMessageHandler - readOriginalContent", () => {
9696

9797
expect(postMessageToWebview).toHaveBeenCalledWith({
9898
type: "originalContent",
99-
originalContentInfo: { ts: 10, content: originalFile },
99+
originalContentInfo: { ts: 10, messageId: undefined, taskId: undefined, content: originalFile },
100100
})
101101
})
102102

@@ -105,14 +105,56 @@ describe("webviewMessageHandler - readOriginalContent", () => {
105105
await webviewMessageHandler(unknown.provider, { type: "readOriginalContent", messageTs: 999 })
106106
expect(unknown.postMessageToWebview).toHaveBeenCalledWith({
107107
type: "originalContent",
108-
originalContentInfo: { ts: 999, content: null },
108+
originalContentInfo: { ts: 999, messageId: undefined, taskId: undefined, content: null },
109109
})
110110

111111
const noTask = createProvider(undefined)
112112
await webviewMessageHandler(noTask.provider, { type: "readOriginalContent", messageTs: 10 })
113113
expect(noTask.postMessageToWebview).toHaveBeenCalledWith({
114114
type: "originalContent",
115-
originalContentInfo: { ts: 10, content: null },
115+
originalContentInfo: { ts: 10, messageId: undefined, taskId: undefined, content: null },
116+
})
117+
})
118+
119+
it("picks the message by messageId when two messages share a ts", async () => {
120+
const { provider, postMessageToWebview } = createProvider([
121+
toolMessage(10, { tool: "appliedDiff", path: "a.ts", originalContent: "first" }, "ask", "id-1"),
122+
toolMessage(10, { tool: "appliedDiff", path: "b.ts", originalContent: "second" }, "ask", "id-2"),
123+
])
124+
125+
await webviewMessageHandler(provider, { type: "readOriginalContent", messageTs: 10, messageId: "id-2" })
126+
127+
expect(postMessageToWebview).toHaveBeenCalledWith({
128+
type: "originalContent",
129+
originalContentInfo: { ts: 10, messageId: "id-2", taskId: undefined, content: "second" },
130+
})
131+
})
132+
133+
it("echoes the task id and answers null for a request made for another task", async () => {
134+
const { provider, postMessageToWebview } = createProvider([
135+
toolMessage(10, { tool: "appliedDiff", originalContent: originalFile }, "ask", "id-1"),
136+
])
137+
138+
await webviewMessageHandler(provider, {
139+
type: "readOriginalContent",
140+
messageTs: 10,
141+
messageId: "id-1",
142+
taskId: "task-1",
143+
})
144+
await webviewMessageHandler(provider, {
145+
type: "readOriginalContent",
146+
messageTs: 10,
147+
messageId: "id-1",
148+
taskId: "task-2",
149+
})
150+
151+
expect(postMessageToWebview).toHaveBeenNthCalledWith(1, {
152+
type: "originalContent",
153+
originalContentInfo: { ts: 10, messageId: "id-1", taskId: "task-1", content: originalFile },
154+
})
155+
expect(postMessageToWebview).toHaveBeenNthCalledWith(2, {
156+
type: "originalContent",
157+
originalContentInfo: { ts: 10, messageId: "id-1", taskId: "task-2", content: null },
116158
})
117159
})
118160

‎src/core/webview/stripOriginalContent.ts‎

Lines changed: 23 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
import type { ClineMessage, ExtensionMessage } from "@roo-code/types"
22

3-
// Keyed by message object; only valid while the text is unchanged (partial messages are updated in place).
4-
const cache = new WeakMap<ClineMessage, { source: string; result: ClineMessage }>()
3+
// Keyed by message object; only the transformed text is cached (valid while the source text is unchanged), so
4+
// metadata such as `isAnswered` and `partial` is always taken from the current message.
5+
const cache = new WeakMap<ClineMessage, { source: string; strippedText: string | undefined }>()
56

67
function isToolMessage(message: ClineMessage): boolean {
78
return (message.type === "ask" && message.ask === "tool") || (message.type === "say" && message.say === "tool")
@@ -15,32 +16,42 @@ export function omitOriginalContent(message: ClineMessage): ClineMessage {
1516
return message
1617
}
1718

18-
const cached = cache.get(message)
19+
let entry = cache.get(message)
1920

20-
if (cached && cached.source === text) {
21-
return cached.result
21+
if (!entry || entry.source !== text) {
22+
entry = { source: text, strippedText: stripOriginalContentFromText(text) }
23+
cache.set(message, entry)
2224
}
2325

24-
let result = message
26+
return entry.strippedText === undefined ? message : { ...message, text: entry.strippedText }
27+
}
2528

29+
function stripOriginalContentFromText(text: string): string | undefined {
2630
try {
2731
const { originalContent, ...rest } = JSON.parse(text) as Record<string, unknown>
2832

2933
// An empty original (new file) is free and still means "has an original" to the webview, so it stays.
3034
if (typeof originalContent === "string" && originalContent.length > 0) {
31-
result = { ...message, text: JSON.stringify({ ...rest, originalContentLength: originalContent.length }) }
35+
return JSON.stringify({ ...rest, originalContentLength: originalContent.length })
3236
}
3337
} catch {
3438
// Not valid JSON (e.g. a truncated partial message): leave it untouched.
3539
}
3640

37-
cache.set(message, { source: text, result })
38-
return result
41+
return undefined
3942
}
4043

41-
/** The `originalContent` of the tool message with this `ts`, or null when there is none. */
42-
export function findOriginalContent(messages: ClineMessage[] | undefined, ts: number): string | null {
43-
const message = messages?.find((m) => m.ts === ts && isToolMessage(m))
44+
/**
45+
* The `originalContent` of a tool message, or null when there is none. `ts` is not unique (two messages can be
46+
* created in the same millisecond), so `messageId` is preferred; `ts` only serves messages persisted without one.
47+
*/
48+
export function findOriginalContent(
49+
messages: ClineMessage[] | undefined,
50+
id: { messageId?: string; ts: number },
51+
): string | null {
52+
const message = messages?.find(
53+
(m) => isToolMessage(m) && (id.messageId !== undefined ? m.messageId === id.messageId : m.ts === id.ts),
54+
)
4455

4556
if (!message?.text) {
4657
return null

‎src/core/webview/webviewMessageHandler.ts‎

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1625,9 +1625,19 @@ export const webviewMessageHandler = async (
16251625
break
16261626
}
16271627

1628+
const task = provider.getCurrentTask()
1629+
// A request made for another task must not be answered from the current one.
1630+
const isRequestedTask = message.taskId === undefined || message.taskId === task?.taskId
1631+
const id = { messageId: message.messageId, ts }
1632+
16281633
await provider.postMessageToWebview({
16291634
type: "originalContent",
1630-
originalContentInfo: { ts, content: findOriginalContent(provider.getCurrentTask()?.clineMessages, ts) },
1635+
originalContentInfo: {
1636+
ts,
1637+
messageId: message.messageId,
1638+
taskId: message.taskId,
1639+
content: isRequestedTask ? findOriginalContent(task?.clineMessages, id) : null,
1640+
},
16311641
})
16321642
break
16331643
}

‎webview-ui/src/__tests__/FileChangesPanel.spec.tsx‎

Lines changed: 44 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -68,10 +68,10 @@ function createFileEditMessage(
6868
}
6969
}
7070

71-
function renderPanel(messages: ClineMessage[] | undefined) {
71+
function renderPanel(messages: ClineMessage[] | undefined, taskId?: string) {
7272
return render(
7373
<TranslationProvider>
74-
<FileChangesPanel clineMessages={messages} />
74+
<FileChangesPanel clineMessages={messages} taskId={taskId} />
7575
</TranslationProvider>,
7676
)
7777
}
@@ -242,7 +242,9 @@ describe("FileChangesPanel", () => {
242242
fireEvent.click(screen.getByTestId("accordian-toggle"))
243243

244244
expect(requestsOfType("readFileContent")).toEqual([{ type: "readFileContent", text: "src/foo.ts" }])
245-
expect(requestsOfType("readOriginalContent")).toEqual([{ type: "readOriginalContent", messageTs: TS }])
245+
expect(requestsOfType("readOriginalContent")).toEqual([
246+
{ type: "readOriginalContent", messageTs: TS, messageId: undefined, taskId: undefined },
247+
])
246248
})
247249

248250
it("shows the merged diff once both the original and the final content arrive", () => {
@@ -288,6 +290,45 @@ describe("FileChangesPanel", () => {
288290
expect(mockPostMessage).not.toHaveBeenCalled()
289291
})
290292

293+
it("requests and matches originals by messageId when messages share a ts", () => {
294+
const edit = (path: string, messageId: string): ClineMessage => ({
295+
...createEditWithOriginal({ path, originalContentLength: 5000 }),
296+
messageId,
297+
})
298+
renderPanel([edit("src/a.ts", "id-a"), edit("src/b.ts", "id-b")], "task-1")
299+
fireEvent.click(screen.getByText("2 file(s) changed in this conversation").closest("button")!)
300+
screen.getAllByTestId("accordian-toggle").forEach((toggle) => fireEvent.click(toggle))
301+
302+
expect(requestsOfType("readOriginalContent")).toEqual([
303+
{ type: "readOriginalContent", messageTs: TS, messageId: "id-a", taskId: "task-1" },
304+
{ type: "readOriginalContent", messageTs: TS, messageId: "id-b", taskId: "task-1" },
305+
])
306+
307+
respond({ type: "fileContent", fileContent: { path: "src/a.ts", content: "new a\n" } })
308+
respond({ type: "fileContent", fileContent: { path: "src/b.ts", content: "new b\n" } })
309+
respond({
310+
type: "originalContent",
311+
originalContentInfo: { ts: TS, messageId: "id-b", taskId: "task-1", content: "old b\n" },
312+
})
313+
314+
const [a, b] = screen.getAllByTestId("accordian-code")
315+
expect(a).toHaveTextContent("the recorded diff")
316+
expect(b).toHaveTextContent("-old b")
317+
})
318+
319+
it("ignores an original answered for a different task", () => {
320+
renderPanel([createEditWithOriginal({ originalContentLength: 5000 })], "task-1")
321+
expandRow()
322+
323+
respond({ type: "fileContent", fileContent: { path: "src/foo.ts", content: "new line\n" } })
324+
respond({
325+
type: "originalContent",
326+
originalContentInfo: { ts: TS, taskId: "task-2", content: "old line\n" },
327+
})
328+
329+
expect(screen.getByTestId("accordian-code")).toHaveTextContent("the recorded diff")
330+
})
331+
291332
it("ignores an original for a different message", () => {
292333
renderPanel([createEditWithOriginal({ originalContentLength: 5000 })])
293334
expandRow()

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1738,7 +1738,7 @@ const ChatViewComponent: React.ForwardRefRenderFunction<ChatViewRef, ChatViewPro
17381738
atBottomThreshold={10}
17391739
/>
17401740
</div>
1741-
<FileChangesPanel clineMessages={messages} />
1741+
<FileChangesPanel clineMessages={messages} taskId={currentTaskItem?.id} />
17421742
{areButtonsVisible && (
17431743
<div
17441744
className={`flex h-9 items-center mb-1 px-[15px] ${

0 commit comments

Comments
 (0)