Skip to content

Commit 077444b

Browse files
authored
fix(app): keep side panel tabs when a session moves (#53081)
1 parent 5589ca4 commit 077444b

3 files changed

Lines changed: 159 additions & 2 deletions

File tree

‎packages/app/e2e/regression/session-location-sync.spec.ts‎

Lines changed: 95 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,23 +23,30 @@ for (const endpoint of ["/api/location", "/api/agent"]) {
2323
let requests = 0
2424
await page.route("**/api/**", (route) => {
2525
const url = new URL(route.request().url())
26+
2627
if (url.pathname !== endpoint || url.searchParams.get("location[directory]") !== directory)
2728
return route.fallback()
2829
requests++
30+
2931
if (recover && requests > 1) return route.fallback()
32+
3033
return route.fulfill({ status: 500, body: "", headers: { "access-control-allow-origin": "*" } })
3134
})
35+
3236
const failure = page.waitForResponse(
3337
(response) => new URL(response.url()).pathname === endpoint && response.status() === 500,
3438
)
39+
3540
const settled = page.waitForResponse((response) => {
3641
const url = new URL(response.url())
42+
3743
return (
3844
url.pathname === endpoint &&
3945
url.searchParams.get("location[directory]") === directory &&
4046
(recover ? response.ok() : requests === 3 && response.status() === 500)
4147
)
4248
})
49+
4350
await page.goto(`/server/${base64Encode(fixture.serverKey)}/session/${sessionID}`)
4451
await failure
4552
await expect(page.getByText("Keep working in this worktree", { exact: true })).toBeVisible()
@@ -86,10 +93,12 @@ test("follows a live session move while the agent catalog is still loading", asy
8693
})
8794
await page.route("**/api/**", async (route) => {
8895
const url = new URL(route.request().url())
96+
8997
if (url.pathname === "/api/agent" && url.searchParams.get("location[directory]") === directory) {
9098
requested.resolve()
9199
await release.promise
92100
}
101+
93102
return route.fallback()
94103
})
95104
await page.goto(`/server/${base64Encode(fixture.serverKey)}/session/${sessionID}`)
@@ -99,10 +108,13 @@ test("follows a live session move while the agent catalog is still loading", asy
99108
await prompt.fill("Keep this draft")
100109
await expect(page.getByText("Session location unavailable", { exact: true })).toHaveCount(0)
101110
await transport.waitForConnection()
111+
102112
const resolved = page.waitForResponse((response) => {
103113
const url = new URL(response.url())
114+
104115
return url.pathname === "/api/agent" && url.searchParams.get("location[directory]") === destination && response.ok()
105116
})
117+
106118
session.directory = destination
107119
await transport.send({
108120
id: "evt_location_moved_while_loading",
@@ -112,10 +124,13 @@ test("follows a live session move while the agent catalog is still loading", asy
112124
data: { sessionID, location: { directory: destination }, projectID: fixture.project.id },
113125
})
114126
await resolved
127+
115128
const delayed = page.waitForResponse((response) => {
116129
const url = new URL(response.url())
130+
117131
return url.pathname === "/api/agent" && url.searchParams.get("location[directory]") === directory && response.ok()
118132
})
133+
119134
release.resolve()
120135
await delayed
121136
await expect(prompt).toBeEditable()
@@ -127,6 +142,76 @@ test("follows a live session move while the agent catalog is still loading", asy
127142
expect(recovery).toEqual([])
128143
})
129144

145+
test("keeps the side panel's tabs and selection when the session moves", async ({ page }) => {
146+
const directory = "/projects/tabs-before-move"
147+
const destination = "/projects/tabs-after-move"
148+
const sessionID = "ses_location_moved_tabs"
149+
const session = { id: sessionID, projectID: fixture.project.id, directory, title: "Moved tabs" }
150+
const transport = await installSseTransport(page, { server: fixture.serverKey })
151+
await mockOpenCodeServer(page, {
152+
directory: fixture.directory,
153+
project: fixture.project,
154+
provider: fixture.provider,
155+
sessions: [session],
156+
fileList: () => [],
157+
findFiles: (input) => ["README.md", "NOTES.md"].filter((name) => name.startsWith(input.query)),
158+
fileContent: (path) => ({ type: "text", content: `contents:${session.directory}:${path}` }),
159+
pageMessages: () => ({
160+
items: [{ id: "msg_saved", type: "user", text: "Keep my tabs", time: { created: 1 } }],
161+
}),
162+
})
163+
await page.goto(`/server/${base64Encode(fixture.serverKey)}/session/${sessionID}`)
164+
await expect(page.getByRole("textbox", { name: "Prompt", exact: true })).toBeEditable()
165+
166+
const panel = page.getByRole("complementary", { name: "Review and files" })
167+
const files = panel.getByRole("tab", { name: /\.md$/ })
168+
const notes = panel.getByRole("tab", { name: "NOTES.md", exact: true })
169+
170+
// A lost selection would fall back to the first file tab, README.md, so NOTES.md stays selected only if it carries.
171+
for (const name of ["README", "NOTES"]) {
172+
await page.keyboard.press("ControlOrMeta+Shift+P")
173+
174+
const dialog = page.getByRole("dialog")
175+
const search = dialog.getByRole("textbox")
176+
await search.fill(name)
177+
await expect(dialog.getByRole("option", { name: `/ ${name}.md`, exact: true })).toHaveAttribute(
178+
"aria-selected",
179+
"true",
180+
)
181+
await search.press("Enter")
182+
await expect(dialog).toHaveCount(0)
183+
await expect(panel.getByRole("tab", { name: `${name}.md`, exact: true })).toHaveAttribute("aria-selected", "true")
184+
}
185+
186+
await expect(files).toHaveText(["README.md", "NOTES.md"])
187+
await expect(panel.getByText(`contents:${directory}:NOTES.md`, { exact: true })).toBeVisible()
188+
189+
await transport.waitForConnection()
190+
191+
const resolved = page.waitForResponse((response) => {
192+
const url = new URL(response.url())
193+
194+
return (
195+
url.pathname === "/api/location" && url.searchParams.get("location[directory]") === destination && response.ok()
196+
)
197+
})
198+
199+
session.directory = destination
200+
await transport.send({
201+
id: "evt_location_moved_tabs",
202+
type: "session.moved",
203+
created: 2,
204+
durable: { aggregateID: sessionID, seq: 1, version: 1 },
205+
data: { sessionID, location: { directory: destination }, projectID: fixture.project.id },
206+
})
207+
await resolved
208+
await expect(page.locator('[data-type="location-switched"]').getByText(destination, { exact: true })).toBeVisible()
209+
await expect(files).toHaveText(["README.md", "NOTES.md"])
210+
await expect(notes).toHaveAttribute("aria-selected", "true")
211+
// The carried tab shows the file in the new directory.
212+
await expect(panel.getByText(`contents:${destination}:NOTES.md`, { exact: true })).toBeVisible()
213+
})
214+
130215
test("refreshes a session moved during disconnection without losing the draft", async ({ page }) => {
131216
const recovery = recoveryRequests(page)
132217
const directory = "/projects/before-reconnect"
@@ -149,12 +234,15 @@ test("refreshes a session moved during disconnection without losing the draft",
149234
await expect(prompt).toBeEditable()
150235
await prompt.fill("Draft before disconnect")
151236
const connection = await transport.waitForConnection()
237+
152238
const resolved = page.waitForResponse((response) => {
153239
const url = new URL(response.url())
240+
154241
return (
155242
url.pathname === "/api/location" && url.searchParams.get("location[directory]") === destination && response.ok()
156243
)
157244
})
245+
158246
session.directory = destination
159247
await transport.close()
160248
await transport.waitForConnection({ after: connection.id })
@@ -186,9 +274,11 @@ test("ignores an old failed location read after reconnecting", async ({ page })
186274
await page.route("**/api/location?**", async (route) => {
187275
if (new URL(route.request().url()).searchParams.get("location[directory]") !== directory) return route.fallback()
188276
requests++
277+
189278
if (requests > 1) return route.fallback()
190279
requested.resolve()
191280
await release.promise
281+
192282
return route.fulfill({
193283
status: 500,
194284
body: "",
@@ -202,12 +292,15 @@ test("ignores an old failed location read after reconnecting", async ({ page })
202292
await prompt.fill("Keep typing here")
203293
const connection = await transport.waitForConnection()
204294
const metadata = page.waitForResponse((response) => new URL(response.url()).pathname === `/api/session/${sessionID}`)
295+
205296
const resolved = page.waitForResponse((response) => {
206297
const url = new URL(response.url())
298+
207299
return (
208300
url.pathname === "/api/location" && url.searchParams.get("location[directory]") === directory && response.ok()
209301
)
210302
})
303+
211304
await transport.close()
212305
await transport.waitForConnection({ after: connection.id })
213306
await metadata
@@ -227,7 +320,9 @@ function recoveryRequests(page: Page) {
227320
const requests: string[] = []
228321
page.on("request", (request) => {
229322
const path = new URL(request.url()).pathname
323+
230324
if (request.method() === "POST" && /^\/api\/(session\/[^/]+\/move|worktree)$/.test(path)) requests.push(path)
231325
})
326+
232327
return requests
233328
}

‎packages/app/src/runtime/extension/host-apis.tsx‎

Lines changed: 41 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
import {
22
batch,
3+
createComputed,
34
createEffect,
45
createMemo,
56
createSignal,
@@ -373,6 +374,7 @@ export function createExtensionAttachment(apis: HostApis) {
373374
const refs = new Map<string, SessionRef>()
374375

375376
const connection = (id: string) => global.servers.list().find((item) => ServerConnection.key(item) === id)
377+
const servers = useServers()
376378

377379
// One ref per server id. A restarted server (e.g. an updated WSL server) gets a new controller under the same id,
378380
// so the ref follows the live controller instead of the one it was created with.
@@ -481,17 +483,55 @@ export function createExtensionAttachment(apis: HostApis) {
481483
return global.ensureServerCtx(conn).sdk.scope
482484
}
483485

486+
// The registry's scope is pure: an unlisted server's sessions (e.g. a stopped WSL server, whose tabs stay open) keep
487+
// their key, and no server controller starts for it.
484488
const stateKey = (session: SessionRef) => {
485489
const location = session.location
486490

487491
if (!location) return
488492

489493
return SessionStateKey.from(
490-
scope(session.server.id),
494+
servers.scope(ServerConnection.Key.make(session.server.id)),
491495
SessionRouteKey.fromRoute(base64Encode(location.directory), session.id),
492496
)
493497
}
494498

499+
// Each session's layout key, kept while its location is unknown (e.g. after the server re-authenticates).
500+
const stateKeys = createMemo<ReadonlyMap<string, string>>(
501+
(previous) =>
502+
new Map(
503+
sessions().flatMap((session) => {
504+
const value = stateKey(session) ?? previous.get(session.key)
505+
506+
return value ? [[session.key, value] as const] : []
507+
}),
508+
),
509+
new Map(),
510+
)
511+
512+
// The strip is stored per directory, so a session that moves copies its strip to its new key: its tabs look the same
513+
// before and after the move. Synchronous, so no region renders the new key before the copy lands. A layout write
514+
// before desktop layout storage loads would stop it loading, so `lastKeys` keeps each session's first key until then.
515+
const lastKeys = new Map<string, string>()
516+
createComputed(() => {
517+
const next = stateKeys()
518+
Array.from(lastKeys.keys()).forEach((key) => {
519+
if (!next.has(key)) lastKeys.delete(key)
520+
})
521+
next.forEach((to, key) => {
522+
if (!lastKeys.has(key)) lastKeys.set(key, to)
523+
})
524+
525+
if (!layout.ready()) return
526+
next.forEach((to, key) => {
527+
const from = lastKeys.get(key)
528+
529+
if (!from || from === to) return
530+
layout.panel.copy(from, to)
531+
lastKeys.set(key, to)
532+
})
533+
})
534+
495535
const shellTab = (session: SessionRef) =>
496536
findSessionTab(tabs.store, ServerConnection.Key.make(session.server.id), session.id)
497537

@@ -665,7 +705,6 @@ export function createExtensionAttachment(apis: HostApis) {
665705
}
666706

667707
// Open-project requests wait until their server is listed (e.g. an SSH server that just connected).
668-
const servers = useServers()
669708
const picker = useDirectoryPicker()
670709
const [projects, setProjects] = createSignal<readonly { server: string; title: string }[]>([])
671710
createEffect(() => {

‎packages/app/src/shell/state/layout.tsx‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -567,6 +567,29 @@ export const { use: useLayout, provider: LayoutProvider } = createSimpleContext(
567567
setEphemeral("sessionTabPreview", session, next.preview)
568568
})
569569
},
570+
/**
571+
* Replaces `to`'s strip, selection, preview tab and scroll offsets with copies of `from`'s, keeping `from`; a key
572+
* with nothing stored copies as empty. `to` counts as just used, then pruning runs as for any new key.
573+
*/
574+
copy(from: string, to: string) {
575+
const current = store.sessionTabs[from]
576+
usage.used.set(to, Date.now())
577+
batch(() => {
578+
scroll.flush(from)
579+
setStore("sessionTabs", to, { all: [...(current?.all ?? [])], active: current?.active })
580+
setEphemeral("sessionTabPreview", to, ephemeral.sessionTabPreview[from])
581+
scroll.drop([to])
582+
setStore("sessionView", to, {
583+
scroll: Object.fromEntries(
584+
Object.entries(store.sessionView[from]?.scroll ?? {}).map(([key, value]) => [
585+
key,
586+
{ x: value.x, y: value.y },
587+
]),
588+
),
589+
})
590+
prune(usage.active ?? to)
591+
})
592+
},
570593
scroll(session: string, tab: string) {
571594
return scroll.scroll(session, tab)
572595
},

0 commit comments

Comments
 (0)