sessions
Agents window architecture — covers the agents-first app, layering, folder structure, chat widget, menus, contributions, entry points, and development guidelines. Use when implementing features or fixing issues in the Agents window.
How do I install this agent skill?
npx skills add https://github.com/microsoft/vscode --skill sessionsIs this agent skill safe to install?
- Gen Agent Trust Hubpass
This skill provides architectural and development guidelines for the Agents window in a specific codebase. It outlines project structure, dependency rules, and standard validation procedures. The instructions focus on maintaining code quality and following established project conventions, with no security considerations identified.
- Socketpass
No alerts
- Snykpass
Risk: LOW · No issues
- Runlayerpass
1 file scanned · No issues
- ZeroLeakspass
Score: 93/100 · 2 sections analyzed
What does this agent skill do?
Before Making Any Changes
MANDATORY: Before writing or modifying any code in src/vs/sessions/, you must read these documents:
.github/instructions/coding-guidelines.instructions.md— Naming conventions, code style, string localization, disposable management, and DI patterns..github/instructions/source-code-organization.instructions.md— Layers, target environments, dependency injection, and folder structure conventions.
Then read the relevant spec for the area you are changing (see table below). If you modify the implementation, you must update the corresponding spec to keep it in sync.
Specification Documents
| Document | Path | When to read |
|---|---|---|
| Layer rules | src/vs/sessions/LAYERS.md | Before adding any cross-module imports. Defines the internal layer hierarchy (core → services → contrib → providers) with ESLint-enforced import restrictions. Key rule: contrib/* must NOT import from contrib/providers/*. |
| Layout spec | src/vs/sessions/LAYOUT.md | Before changing any part, grid structure, titlebar, or CSS. Documents the fixed grid layout (Sidebar | ChatBar | AuxiliaryBar), part positions, the modal editor system, per-session layout state persistence, and the titlebar's three-section design. |
| Layout controller spec | src/vs/sessions/LAYOUT_CONTROLLER.md | Before changing LayoutController or per-session layout state. Details how the auxiliary bar, panel, and editor working sets are captured/restored when switching sessions, multi-session suppression, the auto-reveal-on-changes flow, workspace-folder ordering, and storage/migration. |
| Sessions spec | src/vs/sessions/SESSIONS.md | Before changing session/provider interfaces or data flow. Covers the pluggable provider model (ISessionsProvider → ISessionsProvidersService → ISessionsManagementService), ISession/IChat interfaces, observable state propagation, workspace/folder model, and session type system. |
| Sessions list spec | src/vs/sessions/SESSIONS_LIST.md | Before changing the sessions sidebar list. Covers the tree widget (WorkbenchObjectTree), renderers, grouping (workspace/date), filtering (type/status/archived/read), pinning, read/unread state, workspace capping, mobile adaptations, storage keys, and registered actions. |
| Mobile spec | src/vs/sessions/MOBILE.md | Before adding any phone-specific UI. Covers the mobile part subclass architecture, viewport classification (phone < 640px), MobileTitlebarPart, drawer-based sidebar, MobilePickerSheet, view/action gating with IsPhoneLayoutContext, and the desktop → mobile component mapping. |
| AI Customizations | src/vs/sessions/AI_CUSTOMIZATIONS.md | Before working on the customization editor or tree view. Documents the management editor (in vs/workbench) and the tree view/overview (in vs/sessions/contrib/aiCustomizationTreeView). |
Common Pitfalls
- Wrong menu IDs: Never use
MenuId.*fromvs/platform/actionsfor Agents window UI. Always useMenus.*frombrowser/menus.ts. - Sessions menu ids must live in the shared menu registry: Do not declare sessions-owned
new MenuId(...)constants ad hoc inside individual parts. Add them tobrowser/menus.tsunderMenuswith discoverableSessionsEditor...names so ownership and reuse stay obvious. - Events instead of observables: Session state must flow through
IObservable, notEvent. Useautorun/derivedfor reactive UI, notonDid*event listeners. - Importing from providers: Non-provider
contrib/*code must never import fromcontrib/providers/*. Extract shared interfaces toservices/orcommon/. IAgentSessionsServicein shared code:IAgentSessionsService(vs/workbench/contrib/chat/browser/agentSessions/agentSessionsService) is a Copilot-provider internal and may be imported only by the Copilot chat sessions provider (contrib/providers/copilotChatSessions/). Shared sessions code (core/services/non-provider contribs, e.g. the sessions list or visible-sessions grid) must stay provider-agnostic and go throughISession/ISessionsManagementService— never reach intomodel.observeSession(...)etc. for lazy loading. This is enforced by an ESLintno-restricted-importsban scoped tosrc/vs/sessions/**(Copilot provider exempted).- Missing entry point import: New contribution files must be imported in the appropriate
sessions.*.main.tsentry point to be loaded (for examplesessions.common.main.ts,sessions.desktop.main.ts,sessions.web.main.ts, orsessions.web.main.internal.ts). - Modifying workbench code: Prefer extending/wrapping workbench classes in the sessions layer over modifying shared workbench components.
- Timeouts as fixes: Never use
setTimeout/disposableTimeout/arbitrary delays to fix bugs or implement behaviour. They are race-prone guesses that mask the real ordering/state problem. Drive logic off deterministic signals instead — observables (autorun/derived), explicit events (onDidChange*), lifecycle phases, or awaiting the actual async operation. - Grid
onDidChangeis not a sash-drag signal: the workbenchSerializableGrid/GridViewonDidChangefires for size changes and view add/remove, but not internal splitview sash drags. If logic must react to a part node being resized by a sash, route it through that part'slayout(width, ...)callback, which receives the in-progress node width. - Docked detail collapse must use the raw sash width before clamping: the docked auxiliary bar keeps a minimum visible width, so checking the clamped width can never detect a drag-to-zero collapse. Decide collapse from the raw requested sash width, then route the hide through
setPartHidden(AUXILIARYBAR_PART)so context keys and per-session capture stay in sync. - Stashed state read back later (side-channels): Never stash a value on a service during one method call and read it back from a separate query later, assuming it is still valid (e.g. a
Set/flag set inopenSessionand consumed by ashouldX()pull-API). This is fragile temporal coupling. Instead, make it reactive state that is set atomically together with its source of truth and consumed reactively. Example: per-activation intent like "open in background / preserve focus" is exposed as anIObservableset in the same transaction asactiveSession(via a single internal setter so it can never go stale), and read with.read(reader)in the consumer'sautorun— never via a consume-once getter. - Provider-owned model/mode selection belongs in the loaded chat model, with draft persistence driven by debounce: For AHP-backed chats,
setModel/setAgentmust push the selection into the loadedIChatModel.inputModel(like_updateChatSessionState) and let the draft-sync debounce emitchat/draftChanged. Do not immediately dispatch a model/agent-only draft from the provider, because it can overwrite unsaved typed text before the debounced full input-state draft is persisted. - Blocking on a "pending/waiting" state instead of creating + upgrading: When an entity (e.g. a draft session) depends on something that registers asynchronously, don't withhold creation behind a pending/waiting state. Prefer creating immediately with the best available data, then replace/upgrade it once the awaited dependency arrives (driven by an
onDidChange*/observable signal), cancelling the upgrade if the user changes the inputs meanwhile. Do not bound the upgrade with a timeout or even a lifecycle milestone likeLifecyclePhase.Eventually— an agent host connects lazily and can surface its session types arbitrarily late, which would lock in the wrong fallback. Let the upgrade listener live for the consumer's lifetime instead. - Over-commenting: Don't write long explanatory comments narrating what the code does or justifying ordinary patterns. Hard rules: JSDoc = 1–2 short sentences max (never enumerate every branch/feature, restate the signature, or list what the function does NOT do); inline method comments = 1 line max, only for a genuine workaround/non-obvious constraint, never to narrate the next statement. Default to no comment — if code needs a paragraph to explain, rename/extract instead. Before writing any comment longer than one line, delete it or shorten it to one line.
- Inserting/removing DOM on demand for transient UI (e.g. inline rename inputs): Don't
insertBefore/appendChild+remove()a widget on the tab/row element itself when an interaction starts/ends — that churns the parent's child list and depends on event ordering during teardown. Also don't eagerly build a heavy widget (e.g. anInputBox) per row "just in case", since most rows never use it. Instead, create a stable, empty container alongside the label once, toggle its visibility via a CSS class on the row (e.g..editing), and create the widget inside that container lazily only while editing — disposing it and emptying the container (reset(container)) when done (InputBox.dispose()does not detach its own node). Prefer the shared themed widget (InputBox+defaultInputBoxStyles) over a hand-rolled<input>. - Collapsing distinct provider identities in pickers: Do not collapse extension-backed chat session ids (e.g.
copilotcli) and agent-host ids (e.g.agent-host-copilotcli) based only on friendly names or well-known provider enums. They can coexist in the Agents window and route to different infrastructure; keep the exact session type id through selection/delegation and hide ambiguous legacy targets when an agent-host target supersedes them. - Resolving a session's provider via the create-only tracking map: On the agent host, resolve the owning provider for any per-session operation (createChat, disposeChat, sendMessage, …) through
AgentService._findProviderForSession, never the raw_sessionToProvidermap. That map is populated only bycreateSession, so a restored session (alive in the state manager after a host restart but never created in this process) is absent from it — a direct lookup throwsno provider for sessionand silently breaks the feature (e.g. Add Chat did nothing for restored sessions while messaging worked, because messaging already used the fallback)._findProviderForSessionfalls back to the session URI's scheme provider, which is what makes restored sessions work. - Dispatching per-chat side-channel actions (agent/model) to the session URI: An agent-host session can own multiple peer chats, each with its own backend conversation (
CopilotAgent._chatSessions). Conversation side-channel actions likeSessionAgentChanged/SessionModelChangedmust be dispatched to the per-chat turn channel (_resolveTurnDispatchChannel, which carries achatIdfragment for peer chats), notsession.toString(). The session URI resolves to the session's default chat (_sessions), so dispatching there silently applies the change to the wrong conversation and an additional chat never sees the agent/model swap. The host must also forward thechatChannelthroughagentSideEffects.handleAction→changeAgent/changeModel, which apply it to_chatSessionswhen present. The protocol modelssummary.agent/summary.modelat session level only, so equality guards comparing against session summary are valid for the default chat but must be skipped for peer chats. - Do not infer or fall back from a peer chat channel after progress was emitted: Agent progress signals for chat-scoped actions, especially tool-call readiness and permission requests, must be emitted with the exact
ahp-chat://...channel that owns the tool. Do not recover by scanning active turns, remappingChatToolCallConfirmed, or usingparseDefaultChatUri(...) ?? sessionUriinAgentSideEffects; malformed/misrouted chat channels should fail loudly so the producer or dispatch path is fixed.handleToolCallConfirmedand_toolCallAgentsmust use the chat channel URI containing the tool call; keying by the parent session URI makes confirmations miss the pending SDK request. - Do not synthesize default chat URIs in the workbench handler:
AgentHostSessionHandlermust source the upstream default chat URI from hydratedSessionState.defaultChat/SessionState.chatsand store that mapping in its chat-resource-to-upstream-URI map. CallingbuildDefaultChatUri(session)in the handler assumes one server URI shape and hides protocol/provider bugs; dispatch turn lifecycle and pending/input actions through the mapped upstream chat URI instead. - Model subagents as chats, not sessions: A subagent spawned from a tool call belongs to the parent session as an additional chat with
origin.kind === "tool", hidden from the chat tab strip. Do not callrestoreSessionfor subagents; that creates_sessionStateswithout a matching_chatStatesentry, so later chat actions hit "Action for unknown chat". Add a chat on the parent session and dispatch the subagent turn to that chat URI. - Keep case-sensitive ids out of URI authority: URI authorities are case-insensitive, so do not place tool call ids in the
ahp-chatauthority. Subagent chat URIs use a stablesubagentauthority and put the encoded tool call id in the path; usebuildSubagentChatUri(...)instead ofbuildChatUri(..., \subagent-${toolCallId}`)`. - Selected custom agent must be in the SDK's
customAgents, not justpluginDirectories: The Copilot SDK validates the session-startagent:option (passed tocreateSession/resumeSession) against thecustomAgentslist by name only — it does NOT consultpluginDirectories.copilotSessionLauncher._buildSessionConfigdeliberately omits agents from file-dir plugins fromcustomAgents(relying on the SDK'spluginDirectoriesdiscovery to avoid duplicates), so selecting a plugin/extension-contributed agent (e.g. "Inbox") otherwise fails withCustom agent '<name>' not found. The fix (toSdkSessionCustomAgents) force-adds the resolved selected agent intocustomAgentswhile every other file-dir agent still loads viapluginDirectories. Note the agent picker offers VS Code chat modes fromIChatModeService, but onlyplugin/extensionstorage agents are synced to the host (SYNCABLE_STORAGE_SOURCES);user/localagents are never synced, so_resolveAgentNamereturnsundefinedfor them and noagent:is sent. - Derive SDK custom-agent names exactly like
parseAgentFile:_resolveAgentNameresolves the selected agent through the plugin parser, which trims the frontmattername(getStringValue('name')?.trim() || nameFromFile). When building the SDKcustomAgentslist (toSdkCustomAgents), derive the name the same way (?.trim() || agent.name); reading the raw frontmatternamewithout trimming yields a config name that won't match the trimmedresolvedAgentName, so the SDK still rejects the session withCustom agent '<name>' not found. - Peer chats have no server
summary, so dedup side-channel dispatch against the last value sent for that chat: equality guards before dispatchingSessionModelChanged/SessionAgentChangedcompare againstsummary.model/summary.agent, which only exist for the session's default chat. For peer chats, track the last-dispatched model/agent on theAgentHostChatSessioninstance (auto-cleaned on dispose) and diff against that — otherwise every peer-chat turn redundantly re-dispatches (and re-resolves the agent), and an intentional "clear selection" (undefined) can't be detected. - Scrollable transcript surfaces must use workbench scrollbars: Don't make Agents/voice transcript regions scrollable with native
overflow-y: autoon the content node. Wrap transcript content inDomScrollableElement/list widgets so scrollbars match VS Code theming and remain usable in narrow auxiliary-window layouts. - Background-sending a multi-chat composer must reset the composer before dispatching the send, not concurrently: in
NewChatInSessionWidget._send, creating the replacement untitled chat (openNewChatInSession({ forceNew: true })→provider.createNewChat) and the fire-and-forget backgroundsendRequestboth reach into shared chat-session state (acquireOrLoadSession/getOrCreateChatSession) for chats in the same group. Running them concurrently (send first, reset second) raced and left the sent chat stuck spinning with its message never dispatched, plus a second empty "New Chat" tab. Fullyawaitthe composer reset first, then fire the background send so it runs on its own. - Chat tab order is the provider's stable creation order; don't reorder in the renderer: the agent host delivers
state.chatsin stable creation order (append on add, replace-in-place on update — seeagentHostStateManager/the session reducer), and a genuinely new chat is appended last. The renderer's rebuild autorun (chatCompositeBar.ts) must render that order as-is. Do not partition/move in-composerUntitledchats to the end: a draft is already last, and reordering by status makes a tab jump when a draft commits out of creation order (e.g. sending the 3rd of three drafts first moved it to the front). A chat'sUntitledpresentation (viaAdditionalChat._isNew, needed sosessionView.tsshows the composer) is independent of tab order and must not drive it. Also note_restorePeerChats(agentService.ts) must seed restored chats ingetChats()order, not inPromise.allresolution order, or the catalog scrambles on reload. - A new chat must report
SessionStatus.Untitleduntil its first request is sent, regardless of how the provider creates it:sessionView.tsonly shows the new-chat composer (which owns the Alt+Enter background-send handler) whenactiveChat.status === Untitled. The agent host commits a new peer chat eagerly, so its host status isCompleted— surfacing the standard chat widget and breaking background send. Gate the chat's presented status on a provider-sideisNewflag (AdditionalChat.markNew/markSent, set increateNewChatand cleared insendRequest's committed-chat branch), not on the host-reported status. - Service operations should return a result or throw, not
undefinedfor unsupported cases: capability-gated operations likeforkChatInSessionmust throw when the provider/session cannot perform them. Keep fallback decisions in the caller before invoking the service instead of encoding fallback as anundefinedservice result. - A provisional session abandoned during commit detection must not be returned as successful: its status can remain
InProgressafter its lifecycle owner is disposed, so consumers waiting for a terminal status never settle. Clean up the provisional session and reject the send when commit detection times out or the connection is lost. - Drop a fork when its turn point is unknown, don't forward it empty: in
AgentService.createChat/createSession, if the requested forkturnId/turnIndexresolves to no source turns, setfork: undefinedand fall through to a fresh create. Forwarding the fork with an empty turn slice makes the Copilot provider callsessions.forkwith notoEventId, inheriting the entire backend conversation while the new chat UI is seeded with zero turns — an inconsistent hidden-history chat. - A responsive-layout autorun must re-baseline (not react) to controller-driven restores, holding the flag across the async reveal: the desktop [D7] responsive sidebar hides the sessions sidebar when small + editor + aux-bar are all open. Switching sessions restores layout via two async paths — the desktop aux-bar restore (
openView/openViewContainer) and the base controller's editor working-set apply (_applyWorkingSet, which reveals the editor part after anawaitand runs on aSequencermicrotask). Both reveal parts in a later autorun run, so an inline "same-run session changed" check only absorbs the synchronous transition and the async reveal still auto-hid the sidebar on navigation. Fix: a shared base-controller_withSessionLayoutRestore(work)epoch wraps both restore paths (the working-set wrap is the critical one for non-modal editors); the D7 autorun re-baselines_previousSpaceConstrainedwhile_isRestoringSessionLayoutis true. Also gate the constrained derivation on!multipleSessionsVisibleObsso the feature is disabled with multiple sessions visible. Never use asetTimeoutto bridge the async reveal — tie the flag to the actual promise. - A promise-tied "epoch" helper must decrement synchronously for void/sync work, only deferring for real Promises:
_withSessionLayoutRestoreincrements a depth counter, runswork(), and decrements when done. If it always schedules the decrement on a microtask (Promise.resolve(result).finally(...)) — even whenwork()returnsundefined(the common no-op restore, e.g. a session with no workspace) — the depth stays elevated for the entire synchronous caller/test body, so_isRestoringSessionLayoutreadstrueforever and the consumer (D7) silently stops acting. Only defer the decrement whenwork()returns a thenable; for void/sync (or throwing) work, decrement in thefinally. - A quick-chat's workspace-less kind is fixed at adapter construction — every construction path must carry
_meta:AgentHostSessionAdapterresolves its session-kind (QuickChatSessionKindvsWorkspaceSessionKind) once, fromreadSessionWorkspaceless(metadata._meta)in the constructor;_computeWorkspace()andisQuickChatdelegate to that fixed kind and cannot be flipped by a laterupdate/setMeta. So the_meta.workspacelesstag must be present in the metadata passed to every adapter-construction path:_refreshSessions()/listSessionsand the live_handleSessionAdded(summary)notification (carrysummary._meta). Dropping_metaon either locks a committed quick chat intoWorkspaceSessionKindand leaks its<userHome>/.copilot/chats/<id>scratch dir as aworkspace(breaking the archive-on-delete fallback, list badges, changes/files). On the host,CopilotAgent.listSessions()must re-emit_meta.workspacelessfrom persistedcopilot.workspacelessmetadata (mirroringgetSessionMetadata) so restored sessions carry the tag once the state-manager live summary is gone. The host still keeps the tag on both the summary_metaandSessionState._meta(createSessionState(summary)copies it) so the channels stay consistent. - Don't infer "quick chat" from
workspace === undefined: a session's workspace observable isundefinedfor genuine quick chats but also transiently/edge-case for workspace-bound sessions, so keying quick-chat UI (context keys, list grouping) on it is imprecise. Expose the intent explicitly via the optionalISession.isQuickChat: IObservable<boolean>(only quick-chat-capable providers set it; absent ⇒false). The agent-host adapter derives it fromreadSessionWorkspaceless(_metaObs); non-quick-chat providers omit it. Consume it throughisQuickChatSession(session)/session.isQuickChat?.read(reader) ?? false. - Workspace-less is inferred from absent
workingDirectory— exclude forks from that inference: inCopilotAgent.createSession,isWorkspacelessmust be!sessionConfig.fork && !sessionConfig.workingDirectory. A fork that arrives without an explicitworkingDirectoryshould inherit the source session's context, not be taggedcopilot.workspacelessand dropped into a scratch dir + quick-chat system prompt. - On a failed quick-chat create, don't activate an unrelated draft:
SessionsService.openQuickChatmust, oncreateQuickChatthrowing, log and returnundefinedwithout falling back to_activate(newSession.get())— that observable can hold a workspace-bound draft from a different call site, so activating it is surprising. Return the activatedIActiveSessionfrom_activate/openQuickChat(setActive is synchronous and yields the wrapper) and have the caller focus that exact value, rather than re-readingactiveSession.get()afterwards. - Hide an aux-bar view CONTAINER via
hideIfEmpty: true+ a viewwhen, not a containerwhen:IViewContainerDescriptorhas nowhenproperty (onlyIViewDescriptordoes). To conditionally hide a whole container (its tab/title) — e.g. the Agents-window Changes/Files containers for workspace-less sessions — put the context-keywhenon the inner view(s) and sethideIfEmpty: trueon the container. Container visibility ishideIfEmpty && activeViewDescriptors.length === 0(viewsService.updateViewContainerEnablementContextKey), andactiveViewDescriptorsalready respects each view'swhen, so the container hides reactively when all its views'whengo false. - Don't gate "is this a quick chat?" routing on
isCreated && isQuickChat: a quick-chat draft isUntitled, soisCreated(= status !== Untitled,visibleSessions.ts) isfalse— yet it is still a quick chat. Gating quick-chat routing onisCreated && isQuickChat(e.g. the "New" action) makes a draft fall through to the workspace path (scratch-dir composer, no session-type picker, "No models available"). Route onisQuickChatalone so drafts and committed quick chats behave identically; useisCreatedonly when you genuinely need to distinguish a committed session from an in-composer draft. - Cmd+N in the Agents window is a new-session gesture only — don't fold quick-chat/peer-chat creation into it: session creation (Cmd+N,
NewChatInSessionsWindowAction/workbench.action.sessions.newChat→ alwaysopenNewSession), quick-chat creation (Chats-section "+", Cmd+K Cmd+N,NewQuickChatAction→openQuickChat), and peer-chat creation (chat "+", Cmd+T,AddChatToSessionAction) are three distinct keybindable actions. Keep them separate — Cmd+N must not become context-aware/mirror-route to a quick chat based on the active session's kind. - The New action must never inherit a quick chat's folder into the workspace composer:
openNewSessionFromActiveseeds the new-session composer withactiveSession.workspace.get()?.uri. A quick chat is workspace-less by intent, but if itsworkspaceobservable is ever non-undefined (e.g. a stale-build/coupling leak where_kindresolved toWorkspaceSessionKindbecause_meta.workspacelesswas dropped, exposing the host's scratch~/.copilot/chats/<id>cwd as a workspace), Cmd+N would carry that scratch dir intocreateNewSession→ "New session in<scratch>", single/no session type, no picker, "No models available". Gate the folder inheritance onactiveSession.isQuickChatso a quick chat always falls to the clean folder-picker composer regardless of any leaked workspace value. - A reused new-session composer must re-seed its workspace draft when it swaps out of quick-chat mode: the session-type picker hides itself when it has no folder types (
sessionTypePicker_folderSessionTypes.length === 0), which is the case whenever the composer has no active session (refresh(undefined)clears the types). A freshly opened new-session composer avoids this by seeding a workspace draft from the restored folder in its constructor — but the sameNewChatWidgetinstance is reused across the quick-chat→new-session transition (sessionView.tskeepskind==='newSession'), and Cmd+N'sopenNewSessiondiscard branch only_activate(undefined), leaving the reused composer session-less → picker hidden. Fix by re-running the constructor's seed (_seedWorkspaceDraft()) from an autorun when_isQuickChatComposerflips true→false with no active session, so the reused composer matches a fresh one (folder + visible picker). Don't assume the constructor-time restore covers a reused composer. - Every untitled-session-title fallback must be quick-chat aware: an untitled session's title observable is
'', so a hardcodedlocalize(…, "New Session")fallback shows "New Session" even for a quick chat (whose composer says "New Chat"). Route all such fallbacks through the sharedgetUntitledSessionTitle(isQuickChat)helper (services/sessions/common/session.ts, boolean param so each caller controls reader-tracked.read(reader)vs.get()). There are ≥5 sites — titlebar (sessionsTitleBarWidget), session header (×2: title + rename placeholder), list-row hover (sessionHoverContent), sessions picker (sessionsActions) — keep them on the helper; never hardcode "New Session". (The Cmd+N action title stays "New Session" — that action creates a session, unrelated to a session's own title.)
Capturing Feedback (meta-rule)
Whenever the user flags a wrong pattern, rejects an approach, or gives design/rules feedback, automatically add it as a concise pitfall/learning to this Common Pitfalls section (or the most relevant spec doc) in the same change — without being asked again. Keep each entry 1–3 sentences: the anti-pattern, why it is wrong, and the preferred pattern.
-
Default/main chat title persistence differs per provider — don't unify them: For the agent host, the default (main) chat title is independent of the session title (
AgentHostSessionAdapter._defaultChatTitleOverride, persisted on the host ascustomChatTitle:<defaultChatUri>); it must be seeded back on restore viarestoreSession/_ensureDefaultChat(mirroring_restorePeerChats), or it reverts to the session title after a process restart / idle eviction. For the local chat sessions provider (localChatSessionsProvider), the primary chat and the session intentionally share one_titleobservable, so renaming the first/main chat updates the session title live — this is by design; do not "fix" it to be independent. Only additional (non-primary) local chats have their own title. -
ISession.capabilitiesmust be observable, not a live plain getter: capabilities can hydrate/change after a session first surfaces (e.g. an agent host whose root state arrives after the session's firstSessionState). A plain getter cannot be tracked by the context-key autorun (setActiveSessionContextKeysreads it inside anautorun), sosupportsMultipleChats/sessionSupportsForkwould stay stale, and a multi-chat catalog processed whilesupportsMultipleChatswas stillfalsewould stay collapsed to[defaultChat]. ExposecapabilitiesasIObservable<ISessionCapabilities>(agent host derives it fromconnection.rootStateviaobservableFromEvent+derivedOptswithstructuralEquals; static providers useconstObservable), have consumers read.read(reader)/.get(), and re-apply the chat catalog from the lastSessionStatein anautorunon capability change. Do not fix this by firing_onDidChangeSessions— the active-session context autorun tracks the session's own observables, not the provider's session-list event. -
A managed/default editor tab must be re-ensured every sync, not opened once: the per-session editor working-set restore (
baseSessionLayoutController[B2]_applyWorkingSet) runs on session activation and is not docked-gated, so it reinstates the session's saved editor set and will close any tab not in it (e.g. a set persisted before a new tab existed). A controller that opens a default tab once (guarded by aSetof initialized sessions) therefore loses it permanently after the restore. Ensure managed tabs (the pinned Changes tab, the default File tab) idempotently on every sync (group.editors.some(e => e instanceof X)→ open if absent), exactly like the Changes tab — never with an open-onceSet. Also:IEditorService.openEditor(input, group)on a typedEditorInputbindsgroupto theoptionsparam (overload is(editor, options?, group?)); passopenEditor(input, undefined, group). -
A "keep the editor closed" rule must not react to the editor's visibility transition: the single-pane new-session rule (R1,
_registerSinglePaneNewSessionRules) must drive its hide off the session + active editor, never offonDidChangePartVisibility/aneditorVisibleObs.onWillOpenEditorreveals the editor before the opened file becomes the active editor, and toggling the detail panel off reveals the empty editor viasetAuxiliaryBarHidden— both fire the visibility event synchronously with the active editor still stale (managed empty tab). A rule that re-runs on that transition re-hides the editor the user just asked to show (file never appears; the whole side pane vanishes on detail-toggle). Hide only when the active editor is non-real content, read the current visibility untracked when deciding to hide, and block spurious width-based reveals at the source withsetSuppressDockedEditorRevealSync(true)rather than a visibility backstop. Refinement: dropping the visibility trigger entirely loses the backstop for automatic post-activation reveals (working-set restore, an editor left visible across a session switch), so the editor can appear in a fresh new-session view. Keep the visibility trigger but gate the hide on an explicit-reveal flag: the workbench records_editorRevealedExplicitly(set true only ononWillOpenEditorand the detail-toggle reveal, cleared on any hide and on the suppress false->true transition so a stale cross-session flag can't leak) and exposesisEditorRevealedExplicitly(); R1 re-hides only when the editor is visible and the reveal was not explicit. -
When the docked editor is hidden while the detail stays visible, clear the sidebar-grow snapshots: hiding the editor resizes the docked node down to the detail width (
_dockedAuxiliaryBarWidth). Any_editorSizeGrownForSidebarHide/_detailWidthGrownForSidebarHidesnapshot captured earlier (while the editor was visible and the sessions list was hidden) is now stale — restoring it when the sessions list is later shown re-inflates the node so the detail fills the whole side pane instead of the chat reclaiming the freed editor width.setEditorHidden(true)must drop both snapshots in the detail-still-visible branch. -
Overriding a workbench toolbar hover needs matching specificity: the core rule
.monaco-workbench .monaco-action-bar:not(.vertical) .action-label:not(.disabled):hover(and the:hoveroutline rule) sets the toolbar hover background/outline at ~6-7 class specificity. An action-item label that needs to override that hover (either to suppress it for a non-interactive label, or to re-skin it) must use an equal-or-higher-specificity selector (prefix.monaco-workbench ... .monaco-action-bar:not(.vertical) .action-item.<class> .action-label:hover), not a short.<class> .action-label:hoverthat loses the cascade. (The single-pane diff-stats pill was once suppressed this way while static; it is now a clickable action that opens the multi-file diff, so it keeps the standard--vscode-toolbar-hoverBackgroundhover.) -
A docked-detail editor must not reveal the editor area while the detail panel is already showing its content — model it as a base editor input the single-pane workbench recognises: the empty Files placeholder (
EmptyFileEditorInput) and the Changes multi-diff (SessionChangesEditorInput) surface their content in the docked detail panel (auxiliary bar). Activating one (closing a neighbouring tab so the workbench auto-opens the next editor viaeditorGroupView.doCloseActiveEditor→doOpenEditor, or clicking the tab) firesonWillOpenEditorunsuppressed and would otherwise reveal the hidden editor area. Both inputs extend the abstract baseDockedEditorInput(src/vs/sessions/common/dockedEditorInput.ts, extendsEditorInput). The baseWorkbench.revealEditorOnOpen(e)(theonWillOpenEditorhandler — a protected method, renamed from_handleWillOpenEditor) does the generic reveal;SinglePaneWorkbenchoverridesrevealEditorOnOpenand returns early (no reveal) whene.editor instanceof DockedEditorInput && partVisibility.auxiliaryBar && !partVisibility.editor— i.e. only when the detail panel is open and the editor area is closed — otherwise it callssuper.revealEditorOnOpen(e). So the docked-editor policy lives inSinglePaneWorkbench(the only workbench with a docked detail panel) via a proper type + the current part visibility, not a per-input marker, a contrib-registered predicate, or a remembered set. Note the condition means that when the detail panel is closed (whole side pane closed), opening a docked editor does reveal the editor area so its content is visible. Caveat: a deliberate open of the already-open Changes tab (session-header pillViewAllChangesAction) or a file diff (_openMultiFileDiffEditor) while the detail panel is open is still suppressed by this rule, so those must explicitly reveal viarevealEditorPartExplicitly()before opening (revealing before the open also avoids the multi-diff hanging while laid out in a hidden 0-size editor part). KeeprevealEditorOnOpena named protected method so it is unit-testable viaReflect.get(...prototype, ...). -
Gate single-pane editor-title layout/view actions on
MainEditorAreaVisibleContext; the Create Pull Request bar lives in the title bar, not the editor: single-pane (config.<DOCK_DETAIL_PANEL_SETTING>-gated) editor-title layout/view items (Maximize/Restore, Toggle Details, Hide Editor, Open in Modal, the diff-view actions collapse/expand/toggle-inline/list-tree) must includeMainEditorAreaVisibleContextso they disappear when the editor content is closed. The Create Pull Request anchor (CHANGES_HEADER_ACTIONS_ID) is not an editor-title action: it is contributed toMenus.TitleBarSessionMenu(the sessions title bar's session-actions area) byChangesHeaderActionsActioninchangesViewActions.ts, gated onIsSessionsWindowContext+IsAuxiliaryWindowContext.toNegated()+config.<DOCK_DETAIL_PANEL_SETTING>+SessionHasChangesContext(independent of editor-area visibility), and itsChangesActionsBarview item is registered for(Menus.TitleBarSessionMenu, CHANGES_HEADER_ACTIONS_ID)viaIActionViewItemService. The docked reveal-sync (_syncDockedEditorVisibility) must be symmetric: it reveals when the node widens past the detail width and hides (setspartVisibility.editor=false, flipsMainEditorAreaVisibleContext) when a sash drag squeezes the editor content back down to the detail width — same guards (_syncingDockedEditorVisibility,_suppressDockedEditorRevealSync,_dockDetailPanel, and only while the detail is visible). -
The managed Files placeholder tab is conditional, not always-on:
ChangesTabControllershows the empty Files tab only when the editor area is closed OR no real (non-managed) editor is open; once a real file/diff is open in a visible editor area it removes the placeholder (and re-adds it when the area closes). Drive this off anautorunthat also reads the editor-area visibility (observableFromEvent(onDidChangePartVisibility, () => isVisible(EDITOR_PART, mainWindow))) and an editor-change signal (observableSignalFromEvent(this, Event.any(onDidActiveEditorChange, onDidEditorsChange))), and keep the ensure/remove idempotent so it settles instead of looping. Close/open the placeholder undersuppressEditorPartAutoVisibility(). -
A per-session aux-bar (detail) capture must be skipped during a session-switch restore: the D2
onDidChangePartVisibilitylistener that records a created session's detail visibility must bail while_isRestoringSessionLayoutis true. During restore an external component (e.g.DetailPanelController) can transiently reveal the aux bar for the incoming active editor; capturing that overwrites the session's saved detail-hidden state, so switching back shows the detail even though the user had closed it. Keep the aux-bar sync work synchronous (fire-and-forget the view-open calls) so the restore epoch ends promptly and legitimate post-restore user toggles are still captured. -
The detail-panel forced reveal must be gated on the editor content being visible:
DetailPanelController._syncForcedTargetreveals the docked detail (aux bar) when a Changes/File editor becomes active while the detail is hidden. That reveal must additionally requireisVisible(EDITOR_PART, mainWindow)— otherwise, on a window reload where the user had closed the whole side pane (editor + detail both hidden, persisted), the restored managed tab becoming active re-reveals the detail and the closed state is lost. Reveal the detail only to accompany a visible editor; when the whole pane is intentionally closed, leave it closed. -
Auto-managed tabs must still be user-closable — remember user dismissals instead of blindly re-ensuring:
ChangesTabControllerre-ensures the managed Changes/Files tabs on many signals (session state, editor visibility, editor changes). Without care this re-creates a tab the instant the user closes it, so the tab feels un-closable (the managed tabs are non-previewpinEditor, NOT sticky — they do have close buttons; the blocker is the re-ensure, not a missing button). Track user-initiated closes in a_dismissedManagedTabsset (viaonDidCloseEditor, ignoring the controller's own closes tracked in an_internallyClosingEditorsset) and skip ensuring a dismissed kind. Clear the set only on a session change or when the side pane is reopened from fully closed (edge-detected via a stored_sidePaneWasVisible), so closes stick within the session while reopening/switching re-populates (Scenario B). -
D10 (empty aux-bar cleanup) must gate on quick-chat, not the racy container-active check, or it flickers the side pane closed on reload: the Agents-window Changes/Files aux-bar views gate on
SessionHasWorkspaceContext+WorkspaceFolderCountContext, which are set asynchronously (via thesetActiveSessionContextKeysautorun reading the session's asyncworkspace) after a session activates/reloads. So right after D3b/DetailPanelController/a manual toggle reveals the aux bar,isViewContainerActive(Files/Changes)is transientlyfalse(context keys not settled) even for a real workspace session. The D10 reconcile (_syncAuxiliaryBarPartVisibility, which runs synchronously on theonDidChangePartVisibility(visible)signal and only ever hides) then closes the just-opened side pane, and since it never re-reveals, it stays closed — the reload "side pane opens then closes" flicker, "Files not shown when opening the side pane", and "new-session side-pane state not remembered". Fix: D10 hides only when the aux is genuinely empty for the active session's lifetime — no active session, or a workspace-less quick chat (activeSession.isQuickChat?.get() === true, its Changes+Files permanently gated off) — never for a workspace-backed session whose gating context keys are merely still settling. Do NOT use the transient_hasActiveAuxViewContainers()result to hide a workspace session's aux. -
DetailPanelControllermust not hide the detail on an empty editor group in the new-session view:_computeTargetreturnsHiddenwhen the main editor part is empty (a created session's all-tabs-closed → whole side pane closed). But the new-session (uncreated) view's editor group is transiently empty while its Files tab is (re)ensured, and its Files detail is open by default and owned by the layout controller's D3b. Gating the empty-groupHiddenonactiveSession.isCreatedavoids a transient hide that the D2 visibility listener would otherwise capture as the new-session preference — making every subsequentcmd+nopen with the side pane hidden. Combined with the editor-visibility reveal gate, the new-session default stays open while a user's explicit hide is still remembered (D3b_newSessionViewState).
Validating Changes
You must run these checks before declaring work complete:
npm run typecheck-client— TypeScript compilation check. Do not runtscdirectly.npm run valid-layers-check— MANDATORY. Catches layering violations. If this fails, fix the imports before proceeding.scripts/test.sh --grep <pattern>— unit tests for affected areas
Progress dashboards / local HTML in the integrated browser
- The integrated browser blocks
file://outside trusted workspace folders (403 "File does not reside within a trusted folder"). To preview session-folder HTML (e.g. a live progress dashboard), serve it overhttp://127.0.0.1:<port>with a backgroundpython3 -m http.serverand open that URL instead. - For a self-updating dashboard, embed
<meta http-equiv="refresh" content="5">and keep the HTML task data in lockstep with the todo store — update both at every task transition so they never drift.
Don't rely on the LLM to render links/actions from tool result text
-
Tool result text is fed to the model, which may drop or reformat markdown links (e.g. render a session URI as an inline code span), so an explicit
[label](uri)in a tool result is NOT a reliable way to give the user a clickable action. -
For a deterministic, client-rendered action (a "pill"/button) tied to a specific tool call, set
toolSpecificDataon theChatToolInvocationinstateToProgressAdapter.ts(keyed on the tool name + parsed result) and add a custom subpart inchatToolInvocationPart.ts— the completed-state section already routes customtoolSpecificDatakinds (seeresources/simpleToolInvocation). Follow theagentFeedbackReviewConfirmationpattern. -
Managed-tab reconciliation must run entirely under
suppressEditorPartAutoVisibility():ChangesTabController._syncChangesEditorcloses stale managed tabs (e.g. a restored Changes tab whose session's workspace hasn't resolved yet on reload) before ensuring the current ones. If any close (esp._closeInactiveChangesEditors) runs unsuppressed and empties the group, the workbenchhandleDidCloseEditordocked branch treats it as "user closed all tabs" and closes the whole side pane — the reload flicker where the side pane appears then vanishes. Wrap the full reconciliation body in one suppression window so transient empty states are never mistaken for a user action; don't rely on per-open suppressions alone. Relatedly, the managed Files placeholder tab must NOT be auto-removed based on editor-area visibility (old Scenario 9 auto-remove) — that removal also emptied the group on reload; only remove it on an explicit user close (tracked via_dismissedManagedTabs). -
Layout-driven editor closes (working-set apply) must not be mistaken for user closes: On any single-pane session switch (incl. Cmd+N to a new untitled session and reload), the base controller applies the target session's editor working set — an empty working set closes the managed Changes/Files tabs externally. Two bugs resulted: (1) the workbench
handleDidCloseEditordocked branch saw an empty group and closed the whole side pane (reload/Cmd+N flicker: pane/Files-tab appears then vanishes); (2)ChangesTabController._handleEditorClosedrecorded the external close as a user dismissal, poisoning_dismissedManagedTabsso the Files tab toggled on/off on alternate Cmd+N presses. Fix:_withSessionLayoutRestore(base controller) holdssuppressEditorPartAutoVisibility()for the whole (async) restore only whenisSinglePaneLayoutEnabled(OFF layout unchanged), so layout-driven closes never reachhandleDidCloseEditor; and_handleEditorClosedignores closes whilelayoutService.isEditorPartAutoVisibilitySuppressed()is true, so only a genuine user close dismisses a managed tab. AddedisEditorPartAutoVisibilitySuppressed()toIAgentWorkbenchLayoutServiceas the shared "this close is layout-driven, not a user action" signal. -
DetailPanelController must not force-reveal the detail during a layout-driven restore:
_syncForcedTargetreveals the aux-bar detail to accompany the active Changes/Files editor. On a session switch the target session's editor working set is restored, making its Changes/Files editor active — an editor change that is NOT a user open. If the user had hidden the detail for that session, that restore-driven editor change would force-reveal it, losing the per-session detail-hidden state. Gate the reveal (setPartHidden(false, AUXILIARYBAR)) on!isEditorPartAutoVisibilitySuppressed()(in addition to the existing editor-visible guard): during_withSessionLayoutRestorethe base controller holdssuppressEditorPartAutoVisibility()(single-pane), so a restore-driven forced target skips the reveal while a genuine user editor open (unsuppressed) still reveals. Note the existing[D3c/single-pane]test passed because it simulated the reveal synchronously during apply (so D3 re-hid last); the real bug is the async DetailPanelController reveal firing on the editor-change after D3 already hid. -
The width-based docked reveal-sync (
_syncEditorVisibility) must bail while editor-part auto-visibility is suppressed:SinglePaneWorkbench._syncEditorVisibilityreveals/hides the docked editor purely from the node width (for user sash drags). A session-switch / reload layout restore holdssuppressEditorPartAutoVisibilitywhile it applies the working set, which can widen the docked node before the controller has set the target editor-part visibility. Because the width-sync ran regardless of suppression, restoring a Detail-only session (aux open, editor closed) flickered the editor open on switch (the working-set apply widened the node → reveal → the controller then re-hid it) and could persist it open on reload. Gate_syncEditorVisibilityon!this._isEditorPartAutoVisibilitySuppressed(alongside the existing_syncingEditorVisibilityreentrancy guard) so only a real user sash drag (unsuppressed) drives width-based visibility. Relatedly,baseSessionLayoutController._applyWorkingSet'sisInitialRestorebranch must, for single-pane, apply_shouldHideEditorPartOnApply(editorPartHidden)after the working-set apply (a no-op for the classic layout) — otherwise a Detail-only session's persisted editor-hidden state is not re-applied on reload and the editor is left visible. -
Single-pane detail (aux bar) ownership is split cleanly in two — visibility vs content — never three overlapping aux strategies: in single-pane the auxiliary bar is the detail panel, so exactly two strategies touch it, with non-overlapping responsibilities.
SinglePaneDetailVisibilityStrategyowns only per-session shown/hidden memory: it captures the user's choice ([D1]/[D2]), restores it on switch ([D3]) by revealing/hiding the aux part (setPartHidden/hideAuxiliaryBarForRestore), and handles the submit transition ([D4]).SinglePaneDetailPanelStrategyowns everything about content: which container (Changes/Files, mapped from the active editor), the transient browser-tab hide, editor-maximize → Changes, and the "nothing to show" hide (quick chat / no workspace / empty group →Hidden). Do NOT reintroduce a separateEmptyAuxCleanup/D10 strategy or desktop's saved-container machinery (auxiliaryBarActiveViewContainerIdrestore,_openDefaultAuxiliaryBarContainer,_restoreSavedAuxiliaryBarContainerOnReveal, pinned-container checks) into the visibility strategy — the container always follows the active editor, so a stored container preference is redundant and races the detail-panel mapping. Because the visibility strategy reveals the part and the detail-panel strategy fills it, the detail-panel strategy registers immediately in_registerViewStateManagement(not deferred toRestoredlike the managed tabs), so a reveal and its container open happen in the same turn. -
Single-pane is a sibling of the desktop controller and composes strategy objects — it does not extend
LayoutController:SinglePaneLayoutController(filecontrib/layout/browser/singlePaneLayoutController.ts) extendsBaseLayoutControllerdirectly, NOT the classic desktopLayoutController, so the desktop controller can be deprecated/deleted without touching single-pane. Its behaviour is composed from strategy objects undercontrib/layout/browser/singlePane/(each aDisposable, created viacreateInstancewith a leadingISinglePaneLayoutContextarg):SinglePaneDetailVisibilityStrategy(per-session detail shown/hidden: D1/D2/D3/D4) andSinglePaneDetailPanelStrategy(container + maximize + browser-hide + nothing-to-show hide) — the detail split above;SinglePaneManagedTabsStrategy+SinglePaneEditorAreaCollapseStrategy(share aSinglePaneDockedTabsCoordinatorholding the tabSequencer,internallyClosingEditors,collapsedEditors, and thegetChangesEditorResourcehelper; docked (managed) tabs are identified byinstanceof DockedEditorInput);SinglePaneQuickChatEditorHideStrategy;SinglePaneResponsiveSidebarStrategy(owns the Toggle Details action + sidebar auto-hide);SinglePaneNewSessionRulesStrategy(R1). Shared controller state (isRestoringSessionLayout,withSessionLayoutRestore,togglingSidePane, the obs,viewStateBySession,hidingAuxiliaryBarForRestore/hideAuxiliaryBarForRestore) is exposed to strategies throughISinglePaneLayoutContext(built lazily in the controller because base's constructor calls the_registerViewStateManagement/_registerAuxiliaryControllershooks before subclass field initializers run). The detail-visibility/detail-panel/responsive/R1 strategies register in_registerViewStateManagement; the managed-tab/collapse/quick-chat strategies register in_registerAuxiliaryControllersdeferred toLifecyclePhase.Restored. Fresh storage: single-pane persists tosessions.singlePane.layoutState+sessions.singlePane.newSessionViewState(base_layoutStateStorageKey/_legacyWorkingSetsStorageKeyare overridable; single-pane skips legacy migration), so it never shares state with the classic desktop controller — the test harness seeds both keys. -
Single-pane detail/tab behaviour lives ON the layout controller (or its strategies), not in separate contribution controllers or a shared service:
SinglePaneLayoutControllerowns both the managed docked tabs (pinned Changes multi-diff + empty Files placeholder) and the detail-panel mapping (active editor → Changes/Files container, aux-bar reveal/hide). They were previouslyChangesTabController/DetailPanelController(registered by aSinglePaneModeControllercontribution) coordinating via globalIAgentWorkbenchLayoutServiceflags, then briefly via anISessionLayoutCoordinatorService. Both were removed: "is a session-switch restore in progress?" is just the base protected getterthis._isRestoringSessionLayout(set by_withSessionLayoutRestore) — surfaced to the strategies viaISinglePaneLayoutContext.isRestoringSessionLayout— so a restore-driven editor change never force-reveals the detail or dismisses a managed tab. The base controller hasIChangesViewService+IContextKeyServicedeps and a protected_editorGroupsService(a subclass can't add DI ctor params without redeclaring all base params, so shared services live on the base). Tests: the layout harness gotactiveGroupEditors/closeSuppressionFlags, a realmainPart.activeGroup, anactivateAuxopt-in that resolves the lifecycle, and aTestSinglePaneController.runWithRestore(...)seam to hold_isRestoringSessionLayoutacross an async editor change;changesTabController.test.tswas deleted and its scenarios moved intodesktopSessionLayoutController.test.ts. -
Single-pane created-session default is Editor-only (Changes editor, detail closed) — the detail is not force-opened by editor activation: a Changes/file editor becoming active must NOT auto-reveal the docked detail (aux bar).
SinglePaneDetailPanelStrategy._syncForcedDetailTargetreveals a hidden detail ONLY when it was transiently hidden by a browser tab (_hiddenByBrowser), never when it is hidden by the per-session default or an explicit user hide; when the detail is visible it still switches the container (Changes/Files) to match the active editor. Exception — opening the empty Files placeholder (EmptyFileEditorInput) reveals the Files detail (its content, the Files tree, lives in the aux bar). This is a dedicatedonDidActiveEditorChangelistener in the strategy that reveals the aux bar when the placeholder becomes the active editor — NOT reactive logic inside the detail autorun (which re-readsauxBarVisibleObs, so it would re-reveal the instant the user hides the detail — bug: "can't hide the details view in the empty file editor at all"). Keying on active editor (notonWillOpenEditor) is deliberate: the managed auto-ensured Files tab is opened inactive as a background tab (fileTabOptions), so it never becomes active and never reveals — preserving the Editor-only default — while the+Files action and selecting the Files tab both make it active and reveal. Do NOT reveal from theNewFileTabActioninstead: that misses tab-selection and other activation paths (tried and rejected — "does not work"). The listener is guarded byisVisible(EDITOR_PART)(don't reveal the detail alone while the whole side pane is closed, e.g. Scenario C reload) and!ctx.isRestoringSessionLayout(a restore-driven activation must not reveal). Because hiding the aux bar firesonDidChangePartVisibility, notonDidActiveEditorChange, the user's hide sticks while the placeholder stays active. Do NOT reintroduce aDetailPanelTarget.FilesRevealin the autorun or anisEditorPartAutoVisibilitySuppressed()layout-service API — the active-editor listener needs neither. The reopen default is layout-aware via the base_defaultReopenSidePaneParts()hook. When changing this, update the[single-pane] reveals the Files detail when the empty Files placeholder becomes activeand[Scenario C]tests together. -
Editor-title actions that only make sense with a restorable editor must also gate on
EditorMaximizedContext.negate(): the single-pane "Hide Editor" action is meaningless while the editor area is maximized, so itswhenincludesEditorMaximizedContext.negate()(in addition toMainEditorAreaVisibleContext+HasDockedDetailsContext). -
R1 (new-session editor hide) must be transition-triggered, not level-triggered on the active editor: hiding the editor in the new-session view must fire only when the editor just became visible (visibility false→true) or when the view was just entered with the editor already visible (inherited-visible editor) — never merely because the active editor changed to a managed placeholder while the editor is already visible. A level-triggered rule ("hide whenever active editor is non-real content and editor visible") wrongly hides the editor when the user switches to the Files tab with a file already open (the reveal-sync suppression re-arm clears
isEditorRevealedExplicitly, so the level rule then hides). TrackpreviousEditorVisible+previousInNewSessionViewin the autorun and hide only on(editorJustRevealed || justEnteredNewSessionView) && !isEditorRevealedExplicitly(). The two workbench methodssetSuppressDockedEditorRevealSync(blocks width-based reveals at the source, avoiding flicker) andisEditorRevealedExplicitly(distinguishes an explicit toggle-details-off/file-open reveal that must stick) are still required by R1 — they are independent of the ChangesTab/DetailPanel controller merge. -
Single-pane created sessions need the docked editor part revealed on switch — the
isModalgate in_applyWorkingSetskips it:baseSessionLayoutController._applyWorkingSetonly reveals the editor part when!isModal(i.e.workbench.editor.useModal !== 'all'), because in the classic layout editors open in a modal part. But in single-pane the docked editor lives in the grid even whenuseModalis'all'(the default), so that gate wrongly skips the reveal and a created session's side pane looks fully closed (worse once the Changes editor no longer force-reveals the detail). Fix: computerevealEditorPart = !editorPartHidden && !isInitialRestore && (isSinglePaneLayoutEnabled ? isCreatedSession : !isModal)and also reveal for the'empty'working-set case in single-pane (a first-visit created session has no saved editors but still shows its managed Changes editor). This restores the Editor-only default while respecting the per-sessioneditorPartHidden(Detail-only / side-pane-closed) state and excluding new-session views (R1 keeps their editor closed). Note the layout test harness leavesisSinglePaneLayoutEnabledfalsy by default, so base single-pane branches are inert in tests unless a test opts in via thesinglePaneLayoutEnabledcreate option. -
A draft replaced by a committed session must inherit the draft's side-pane layout before
_applyWorkingSetruns: some providers commit a new-session draft by firingonDidReplaceSessionwith a new session resource, not by flippingisCreatedon the same resource. Without transferring the active draft's_editorPartHiddenBySessionand aux-bar state, the committed resource has no saved layout, so the delayed B2 working-set apply treats it as a first-visit created session and reveals the editor (Editor-only default) even though the user submitted from the new-session Detail-only view. Handle the replacement event as D4 submit: copy the active draft's editor-hidden state to the committed resource, record Changes as the committed aux container, and open Changes only if the draft detail was visible; switching to an unrelated existing created session still uses the Editor-only default. -
Single-pane D3c: a created session with NO saved detail state must be left in its current on-screen state — never force-hidden: the detail (aux-bar) restore for a created single-pane session (
SinglePaneDetailVisibilityStrategy._syncDetailVisibilityD3c) must only act whenviewStateBySessionhas a saved entry — hide when it says hidden, reveal when it says visible. When there is no saved state (savedState === undefined), return without touching the aux bar. Force-hiding on the no-state path re-closes the detail the user had open in the new-session view on submit: the committed session's resource can change again after the initial draft→committed transition, so a later restore run lands in D3c with no saved state andpreviousIsCreatedalreadytrue(the intrinsic!previousIsCreated && isCreatedsubmit detection ([D4]) no longer matches), and would re-hide. Leaving the current state also covers a first-time-seen created session gracefully; the detail-panel strategy keeps the container in sync, and the visibility is captured on the next switch-away or user toggle. (The intrinsic [D4] submit routing to_onNewSessionSubmittedis still kept for the clean first transition — it records the state and opens Changes — but D3c-leave-current is the backstop for every follow-up run.) -
A replace-based submit must be detected intrinsically in the aux/detail restore autorun (
!previousIsCreated && isCreated), not via_onSessionReplaced: the same ordering trap as the editor reveal, but for the detail (aux-bar) visibility.sessionsServicelistens toonDidReplaceSessionfirst (it's a core service) and its handler callsupdateSession→ setsactiveSessionin a transaction → the single-paneSinglePaneDetailVisibilityStrategyD3 restore autorun fires synchronously inside that handler. The layout controller's_onSessionReplaced(registered later, atBlockRestore) runs after — so any aux-state transfer it does is too late: the autorun has already run D3c. The classic same-resourceisSubmitguard (!isSessionSwitch && !previousIsCreated && isCreated) misses this because the agent-host/Copilot provider commits by replacing the draft with a new resource (isSessionSwitchis true). Fix: relaxisSubmittopreviousSessionResource && !previousIsCreated && isCreated && !viewStateBySession.has(activeSessionResource)— detect the submit purely from the transition, independent of_onSessionReplacedordering. The!has(state)guard keeps a genuine navigation from a draft to an existing created session on the normal D3 restore path._onSessionReplacedthen only needs to cover the background submit (a session committed while a different session is active, so the autorun never fires for it). Because the committed resource can still change again after the first transition, this intrinsic detection alone isn't enough — pair it with the D3c-leave-current rule above. General rule: for any "on submit, preserve/transfer layout" logic, detect the submit from the reactive transition the consumer already observes — never from a flag/transfer set by a separately-registeredonDidReplaceSessionlistener. -
onDidReplaceSessionalways means submit — never re-checkfrom.status === Untitled, and never try to preserve visibility via a flag consumed byrunOnChange: two related traps when suppressing the docked-editor reveal on new-session submit. (1) By the timeonDidReplaceSessionfires, the draft has already transitionedUntitled→Completed, so a_isNewSessionReplacement(from,to)guard checkingfrom.status === SessionStatus.Untitledis always false and silently skips the whole editor-hidden/aux transfer. The event is documented to fire only when an untitled draft is atomically replaced by its committed session, so treat everyonDidReplaceSessionas a submit — no status guard. (2) The B2 working-setrunOnChange(on the workspace-gatedactiveSessionForWorkingSetderive) fires before the synchronousonDidReplaceSessionhandler, so a boolean flag set in_onSessionReplacedand read synchronously inrunOnChangeis captured stale (false) and cannot suppress the reveal. The correct, ordering-robust mechanism is to have_onSessionReplacedwrite the draft's live editor-part visibility into_editorPartHiddenBySession[to]synchronously; because_applyWorkingSetreads that map inside itsSequencer.queueasync microtask body (which runs after the sync replace handler), the reveal decision (_shouldRevealEditorPartOnApply/_shouldRevealEditorPartForEmptyWorkingSet) seeseditorPartHidden=trueand skips. Do NOT add apreserveEditorPartVisibilityapply option keyed off event ordering — it's impossible to set in time. -
R1 can drop
setSuppressDockedEditorRevealSync— always hide on new-session-view entry instead: the width-based reveal-sync suppression (setSuppressDockedEditorRevealSync/_suppressDockedEditorRevealSync) was removed. It did two jobs: (1) block a momentary width-reveal of the editor in the new-session view, and (2) clear_editorRevealedExplicitlyon entering the view so R1 re-hides an inherited-explicit editor across a session switch (the working-set apply runs undersuppressEditorPartAutoVisibility, sohandleDidCloseEditordoesn't clear the flag naturally). Job (1) is now handled by R1 re-hiding any non-explicit reveal (a sash-drag reveal flickers then re-hides — acceptable). Job (2) is handled by making R1's hide conditionjustEnteredNewSessionView || (editorJustRevealed && !isEditorRevealedExplicitly())— i.e. entering the new-session view always resets to editor-closed (a stale cross-session explicit flag can't keep the editor open), while the explicit flag is only honored for in-session reveals (toggle-details-off revealing the empty editor).isEditorRevealedExplicitlyis still needed for that in-session case. -
Quick chats have no side pane — don't auto-reveal the editor part, and hide it when switching in from a session that had it open: in single-pane,
SinglePaneLayoutController._shouldRevealEditorPartOnApplymust exclude quick chats (!editorPartHidden && isCreatedSession && !isQuickChat); a created quick chat would otherwise reveal the docked editor part on switch (bug: "side pane opened automatically for quick chat"). Excluding the reveal is not enough — switching in from a workspace session leaves the editor part visible (the working-set apply is suppressed and never hides it), so a dedicated_registerQuickChatEditorHide()autorun hides the editor part while a quick chat's editor group is empty (gated on_isMainPartEmpty()so a real editor, e.g. the integrated browser, opened in a quick chat is never hidden). The aux bar is already handled by D10 + the detail-panelHiddentarget. -
An auto-collapsed sessions list must be restored once the side pane is fully hidden: the single-pane responsive rule auto-collapses the sessions list to free width for a visible side pane (Toggle Details, opening a file). It must also restore an auto-hidden list when the side pane becomes fully hidden (both editor and aux bar closed) — e.g. switching to a quick chat (no side pane) — otherwise the list is left collapsed with nothing to make room for (bug: "sessions list closed even though the side pane is hidden"). Implement as an autorun in
_registerResponsiveSidebaron anobservableFromEvent(onDidChangePartVisibility, () => editorVisible || auxVisible)(the value-dedup is essential: hiding the sidebar itself doesn't change the computed side-pane visibility, so the pre-reveal auto-hide from opening an editor is never undone). Restore only when_sidebarAutoHiddenis true, so a list the user closed manually stays closed. -
Single-pane per-session editor-part visibility must be restored both ways —
_applyWorkingSetonly ever revealed it:baseSessionLayoutController._applyWorkingSetrevealed the editor part when a session wanted it visible but never hid it, so returning to a session whose docked editor was closed (Detail-only or whole side pane closed) left the editor visible/inherited from the previously-active session (bug: "side pane opened when returning to a session where it was closed"). The per-session_editorPartHiddenBySessionstate was only consumed to suppress the reveal (!editorPartHidden), never to actively hide. Fix: add a symmetric Template-Method hook_shouldHideEditorPartOnApply(editorPartHidden)(base returnsfalse— classic layout doesn't treat editor-part visibility as per-session; single-pane returnseditorPartHidden && isCreated && !isQuickChat) and, in both the empty and non-empty_applyWorkingSetbranches, hide the editor part (mutually exclusive with revealing, skipped onisInitialRestorewhich preserves the workbench-restored visibility). The hide runs inside_withSessionLayoutRestore'ssuppressEditorPartAutoVisibilitywindow so it is never mistaken for a user close. Note the aux bar was already restored both ways by the inherited D3_syncAuxiliaryBarVisibility; only the editor part lacked the hide. -
Explicit managed-editor opens must reveal outside the auto-reveal path — and mark the reveal explicit: docked-detail Changes/Files editors (
DockedEditorInput) are kept from revealing the docked editor bySinglePaneWorkbench.revealEditorOnOpen(see the entry above), so tab activation and layout-driven restores do not reveal it. A deliberate user gesture that should show managed editor content (session-header Changes pillViewAllChangesAction, opening a file diff in_openMultiFileDiffEditor) must reveal the editor part before opening the managed editor viaIAgentWorkbenchLayoutService.revealEditorPartExplicitly()— not the genericsetPartHidden(false, EDITOR_PART). The generic call routes tosetEditorHidden(hidden, explicit=false), leaving_editorRevealedExplicitly = false, so R1 / the working-set apply (_shouldHideEditorPartOnApply) can re-hide it (especially across a session-switch race).revealEditorPartExplicitly()sets the explicit flag (and re-asserts it even when already visible, sincesetEditorHiddenearly-returns when the part is already visible). Do not weaken theDockedEditorInputreveal suppression or add timing delays. -
A
MutableDisposable-backed content slot must notclearNodeits shared container on cleanup:EditorGroupView.setHeaderContentappends a new content node into the sharedheaderContainer, then assigns the new store to_headerContent(aMutableDisposable) — which synchronously disposes the previous store. If that store's cleanup callsclearNode(headerContainer), it wipes the freshly-appended new content (blank header, height stuck at 0, orphanedResizeObserver). Fix: clear the previous content before appending the new one (this._headerContent.clear()at the top), and have each store's cleanup remove only its own node (content.remove()), never the shared container. This bug surfaces on consecutive header→header renders (e.g.Changes(sessionA)→Changes(sessionB)). -
Per-session editor-part (side-pane) hidden state must be captured eagerly on the visibility change, not lazily re-read at switch-away:
baseSessionLayoutController._saveWorkingSetused to record_editorPartHiddenBySession[prev] = !isVisible(EDITOR_PART)at the moment it saved the outgoing session. That races: the working-set derive (activeSessionForWorkingSet) lags the rawactiveSession(it gates on workspace-folder readiness), so other autoruns driven by the raw active session (managed-tab open, D3 aux sync) have already revealed the editor for the incoming session by the time_saveWorkingSet(prev)runs — so the previous session gets recorded aseditorPartHidden=falseand its closed side pane reopens on return (symptom: only the editor content re-appears, details stay closed, and nosetEditorHiddenfires on the switch because nothing on the switch path toggles it). Fix: capture it in a[B2]onDidChangePartVisibility(EDITOR_PART)listener (mirroring the existing[B1]panel-visibility capture) guarded by!multipleSessionsVisibleObs && !_isRestoringSessionLayout, so the value is written the instant the user closes/opens the side pane and layout-driven restore changes are ignored. Remove the lazy read from_saveWorkingSetentirely (keeping it would let the racy switch-time value overwrite the good eager one). The unit harness can't reproduce the derive-lag, so add a focused test that fires the EDITOR_PART event to assert eager capture, plus one that fires a reveal inside_withSessionLayoutRestoreto assert the captured closed state is preserved. -
Single-pane detail sync must re-read aux-bar visibility when queued work runs: the detail-panel autorun queues container opens through a sequencer, so a task can be computed while the previous session's detail is visible and run after D3 has restored the incoming session's detail to hidden. Do not trust an
auxBarVisiblevalue captured before the queue boundary; readisVisible(AUXILIARYBAR_PART)inside the queued sync, otherwiseopenViewContainercan re-reveal the detail and overwrite the incoming session's saved hidden state. -
The managed Changes tab must open non-stealing so the working-set-restored active editor is preserved: on a single-pane session switch,
baseSessionLayoutController._applyWorkingSetrestores the session's editor working set including which editor was active (e.g.package.json).SinglePaneManagedTabsStrategythen idempotently re-ensures the pinned Changes tab — but ifchangesEditorOptionsopens it as active (noinactive/activation), it steals active state from the just-restored editor, so the wrong tab is active after the switch. GivechangesEditorOptionsinactive: true+activation: EditorActivation.PRESERVE(matchingfileTabOptions); the workbench still makes it active when the group is empty (active: this.count === 0 || !options?.inactive,editorGroupView.doOpenEditor), so the first-visit created-session default (Changes active) is preserved while a restored session keeps its own active editor. -
Save the outgoing session's working set eagerly on the raw active session change, not on the workspace-gated
activeSessionForWorkingSetderive: the derive (baseSessionLayoutController) holds back while the incoming session's workspace folders resolve, and other autoruns driven by the rawISessionsService.activeSession(e.g. the single-pane managed-tabs sync) async-close the outgoing session's docked editors (_closeInactiveChangesEditors) during that lag. If the working-set save is on the lagged derive it runs after those closes, so the outgoing session's Changes tab (or whichever editor was active) is already gone and its active state is lost — on return the working set restores the wrong active editor (symptom: switching back to a session whose Changes tab was active shows a different tab active). Fix: a dedicated[B2] runOnChange(activeSession, …)saves the previous session's working set synchronously (guarded by resource-inequality,!Untitled,!_isRestoringSessionLayout) — this runs before the managed-tab sequencer microtask closes anything — and the save is removed from the gated applyrunOnChange(which now only applies). Save doesn't need workspace readiness; only apply does. Pairs with making the managed Changes tab open non-stealing (inactive: true+EditorActivation.PRESERVE) so the restored active editor is preserved. The unit harness can't reproduce the derive-lag directly, so assert the decoupling: switching to a session whose workspace isn't in the folders (gated apply holds back) still records asaveWorkingSetfor the outgoing session. -
Docked side-pane width persistence must be symmetric about the detail (aux) width: in single-pane the docked detail (auxiliary bar) lives inside the editor grid node, so the workbench persists the pure editor-content width (
_persistedEditorWidth= node − detail) and the grid descriptor reconstructs node = editor-content + detail. These must use the same condition for including the detail: only when the detail is visible (partVisibility.auxiliaryBar). Subtracting the detail width unconditionally at save while adding it back only when the detail is visible shrank an Editor-only session's side pane by the detail width on every reload, compounding toward zero ("side pane always tiny on reload"). Fix_persistedEditorWidthto subtract only when the detail is visible. -
Side-pane (editor grid node) size is workbench-level, not per session: the editor grid node width is owned by the workbench grid and persisted globally (
workbench.sessions.partSizesvia_savePartSizes/createDesktopGridDescriptor), so switching sessions keeps the same width and reload restores it in one paint. Do not add a per-session width map in the layout controller that re-applies a width on session switch/reveal — it makes switching sessions jump the side pane around, and a post-paint restore on reload flickers. The 60% first-open default (SIDE_PANE_WIDTH_RATIOinparts/editorPartSizing.ts, applied by the single-pane_applyEditorSplitSizeoverride on the first reveal that has no size to restore) is the only width the layout intentionally sets; everything else is the user's persisted grid size.
How can the creator link this skill?
Add the canonical catalog link to the repository README so users can inspect current installs and available audits. The publishing guide covers the complete discovery path.
<a href="https://skillzs.dev/skills/microsoft/vscode/sessions">View sessions on skillZs</a>