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.
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 as customChatTitle:<defaultChatUri>); it must be seeded back on restore via restoreSession/_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 _title observable, 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.capabilities must 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 first SessionState). A plain getter cannot be tracked by the context-key autorun (setActiveSessionContextKeys reads it inside an autorun), so supportsMultipleChats/sessionSupportsFork would stay stale, and a multi-chat catalog processed while supportsMultipleChats was still false would stay collapsed to [defaultChat]. Expose capabilities as IObservable<ISessionCapabilities> (agent host derives it from connection.rootState via observableFromEvent + derivedOpts with structuralEquals; static providers use constObservable), have consumers read .read(reader)/.get(), and re-apply the chat catalog from the last SessionState in an autorun on 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 a Set of 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-once Set. Also: IEditorService.openEditor(input, group) on a typed EditorInput binds group to the options param (overload is (editor, options?, group?)); pass openEditor(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 off onDidChangePartVisibility/an editorVisibleObs. onWillOpenEditor reveals the editor before the opened file becomes the active editor, and toggling the detail panel off reveals the empty editor via setAuxiliaryBarHidden โ 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 with setSuppressDockedEditorRevealSync(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 on onWillOpenEditor and 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 exposes isEditorRevealedExplicitly(); 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/_detailWidthGrownForSidebarHide snapshot 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 :hover outline 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:hover that 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-hoverBackground hover.)
-
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 via editorGroupView.doCloseActiveEditor โ doOpenEditor, or clicking the tab) fires onWillOpenEditor unsuppressed and would otherwise reveal the hidden editor area. Both inputs extend the abstract base DockedEditorInput (src/vs/sessions/common/dockedEditorInput.ts, extends EditorInput). The base Workbench.revealEditorOnOpen(e) (the onWillOpenEditor handler โ a protected method, renamed from _handleWillOpenEditor) does the generic reveal; SinglePaneWorkbench overrides revealEditorOnOpen and returns early (no reveal) when e.editor instanceof DockedEditorInput && partVisibility.auxiliaryBar && !partVisibility.editor โ i.e. only when the detail panel is open and the editor area is closed โ otherwise it calls super.revealEditorOnOpen(e). So the docked-editor policy lives in SinglePaneWorkbench (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 pill ViewAllChangesAction) or a file diff (_openMultiFileDiffEditor) while the detail panel is open is still suppressed by this rule, so those must explicitly reveal via revealEditorPartExplicitly() before opening (revealing before the open also avoids the multi-diff hanging while laid out in a hidden 0-size editor part). Keep revealEditorOnOpen a named protected method so it is unit-testable via Reflect.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 include MainEditorAreaVisibleContext so 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 to Menus.TitleBarSessionMenu (the sessions title bar's session-actions area) by ChangesHeaderActionsAction in changesViewActions.ts, gated on IsSessionsWindowContext + IsAuxiliaryWindowContext.toNegated() + config.<DOCK_DETAIL_PANEL_SETTING> + SessionHasChangesContext (independent of editor-area visibility), and its ChangesActionsBar view item is registered for (Menus.TitleBarSessionMenu, CHANGES_HEADER_ACTIONS_ID) via IActionViewItemService. The docked reveal-sync (_syncDockedEditorVisibility) must be symmetric: it reveals when the node widens past the detail width and hides (sets partVisibility.editor=false, flips MainEditorAreaVisibleContext) 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: ChangesTabController shows 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 an autorun that 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 under suppressEditorPartAutoVisibility().
-
A per-session aux-bar (detail) capture must be skipped during a session-switch restore: the D2 onDidChangePartVisibility listener that records a created session's detail visibility must bail while _isRestoringSessionLayout is 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._syncForcedTarget reveals the docked detail (aux bar) when a Changes/File editor becomes active while the detail is hidden. That reveal must additionally require isVisible(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: ChangesTabController re-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-preview pinEditor, NOT sticky โ they do have close buttons; the blocker is the re-ensure, not a missing button). Track user-initiated closes in a _dismissedManagedTabs set (via onDidCloseEditor, ignoring the controller's own closes tracked in an _internallyClosingEditors set) 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 the setActiveSessionContextKeys autorun reading the session's async workspace) after a session activates/reloads. So right after D3b/DetailPanelController/a manual toggle reveals the aux bar, isViewContainerActive(Files/Changes) is transiently false (context keys not settled) even for a real workspace session. The D10 reconcile (_syncAuxiliaryBarPartVisibility, which runs synchronously on the onDidChangePartVisibility(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.
-
DetailPanelController must not hide the detail on an empty editor group in the new-session view: _computeTarget returns Hidden when 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-group Hidden on activeSession.isCreated avoids a transient hide that the D2 visibility listener would otherwise capture as the new-session preference โ making every subsequent cmd+n open 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).
-
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 toolSpecificData on the ChatToolInvocation in stateToProgressAdapter.ts (keyed on the tool name + parsed result) and add a custom subpart in chatToolInvocationPart.ts โ the completed-state section already routes custom toolSpecificData kinds (see resources/simpleToolInvocation). Follow the agentFeedbackReviewConfirmation pattern.
-
Managed-tab reconciliation must run entirely under suppressEditorPartAutoVisibility(): ChangesTabController._syncChangesEditor closes 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 workbench handleDidCloseEditor docked 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 handleDidCloseEditor docked branch saw an empty group and closed the whole side pane (reload/Cmd+N flicker: pane/Files-tab appears then vanishes); (2) ChangesTabController._handleEditorClosed recorded the external close as a user dismissal, poisoning _dismissedManagedTabs so the Files tab toggled on/off on alternate Cmd+N presses. Fix: _withSessionLayoutRestore (base controller) holds suppressEditorPartAutoVisibility() for the whole (async) restore only when isSinglePaneLayoutEnabled (OFF layout unchanged), so layout-driven closes never reach handleDidCloseEditor; and _handleEditorClosed ignores closes while layoutService.isEditorPartAutoVisibilitySuppressed() is true, so only a genuine user close dismisses a managed tab. Added isEditorPartAutoVisibilitySuppressed() to IAgentWorkbenchLayoutService as the shared "this close is layout-driven, not a user action" signal.
-
DetailPanelController must not force-reveal the detail during a layout-driven restore: _syncForcedTarget reveals 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 _withSessionLayoutRestore the base controller holds suppressEditorPartAutoVisibility() (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._syncEditorVisibility reveals/hides the docked editor purely from the node width (for user sash drags). A session-switch / reload layout restore holds suppressEditorPartAutoVisibility while 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 _syncEditorVisibility on !this._isEditorPartAutoVisibilitySuppressed (alongside the existing _syncingEditorVisibility reentrancy guard) so only a real user sash drag (unsuppressed) drives width-based visibility. Relatedly, baseSessionLayoutController._applyWorkingSet's isInitialRestore branch 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. SinglePaneDetailVisibilityStrategy owns 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]). SinglePaneDetailPanelStrategy owns 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 separate EmptyAuxCleanup/D10 strategy or desktop's saved-container machinery (auxiliaryBarActiveViewContainerId restore, _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 to Restored like 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 (file contrib/layout/browser/singlePaneLayoutController.ts) extends BaseLayoutController directly, NOT the classic desktop LayoutController, so the desktop controller can be deprecated/deleted without touching single-pane. Its behaviour is composed from strategy objects under contrib/layout/browser/singlePane/ (each a Disposable, created via createInstance with a leading ISinglePaneLayoutContext arg): SinglePaneDetailVisibilityStrategy (per-session detail shown/hidden: D1/D2/D3/D4) and SinglePaneDetailPanelStrategy (container + maximize + browser-hide + nothing-to-show hide) โ the detail split above; SinglePaneManagedTabsStrategy + SinglePaneEditorAreaCollapseStrategy (share a SinglePaneDockedTabsCoordinator holding the tab Sequencer, internallyClosingEditors, collapsedEditors, and the getChangesEditorResource helper; docked (managed) tabs are identified by instanceof 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 through ISinglePaneLayoutContext (built lazily in the controller because base's constructor calls the _registerViewStateManagement/_registerAuxiliaryControllers hooks 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 _registerAuxiliaryControllers deferred to LifecyclePhase.Restored. Fresh storage: single-pane persists to sessions.singlePane.layoutState + sessions.singlePane.newSessionViewState (base _layoutStateStorageKey/_legacyWorkingSetsStorageKey are 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: SinglePaneLayoutController owns 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 previously ChangesTabController/DetailPanelController (registered by a SinglePaneModeController contribution) coordinating via global IAgentWorkbenchLayoutService flags, then briefly via an ISessionLayoutCoordinatorService. Both were removed: "is a session-switch restore in progress?" is just the base protected getter this._isRestoringSessionLayout (set by _withSessionLayoutRestore) โ surfaced to the strategies via ISinglePaneLayoutContext.isRestoringSessionLayout โ so a restore-driven editor change never force-reveals the detail or dismisses a managed tab. The base controller has IChangesViewService + IContextKeyService deps 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 got activeGroupEditors/closeSuppressionFlags, a real mainPart.activeGroup, an activateAux opt-in that resolves the lifecycle, and a TestSinglePaneController.runWithRestore(...) seam to hold _isRestoringSessionLayout across an async editor change; changesTabController.test.ts was deleted and its scenarios moved into desktopSessionLayoutController.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._syncForcedDetailTarget reveals 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 dedicated onDidActiveEditorChange listener in the strategy that reveals the aux bar when the placeholder becomes the active editor โ NOT reactive logic inside the detail autorun (which re-reads auxBarVisibleObs, 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 (not onWillOpenEditor) 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 the NewFileTabAction instead: that misses tab-selection and other activation paths (tried and rejected โ "does not work"). The listener is guarded by isVisible(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 fires onDidChangePartVisibility, not onDidActiveEditorChange, the user's hide sticks while the placeholder stays active. Do NOT reintroduce a DetailPanelTarget.FilesReveal in the autorun or an isEditorPartAutoVisibilitySuppressed() 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 active and [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 its when includes EditorMaximizedContext.negate() (in addition to MainEditorAreaVisibleContext + 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). Track previousEditorVisible + previousInNewSessionView in the autorun and hide only on (editorJustRevealed || justEnteredNewSessionView) && !isEditorRevealedExplicitly(). The two workbench methods setSuppressDockedEditorRevealSync (blocks width-based reveals at the source, avoiding flicker) and isEditorRevealedExplicitly (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 isModal gate in _applyWorkingSet skips it: baseSessionLayoutController._applyWorkingSet only 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 when useModal is '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: compute revealEditorPart = !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-session editorPartHidden (Detail-only / side-pane-closed) state and excluding new-session views (R1 keeps their editor closed). Note the layout test harness leaves isSinglePaneLayoutEnabled falsy by default, so base single-pane branches are inert in tests unless a test opts in via the singlePaneLayoutEnabled create option.
-
A draft replaced by a committed session must inherit the draft's side-pane layout before _applyWorkingSet runs: some providers commit a new-session draft by firing onDidReplaceSession with a new session resource, not by flipping isCreated on the same resource. Without transferring the active draft's _editorPartHiddenBySession and 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._syncDetailVisibility D3c) must only act when viewStateBySession has 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 and previousIsCreated already true (the intrinsic !previousIsCreated && isCreated submit 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 _onNewSessionSubmitted is 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. sessionsService listens to onDidReplaceSession first (it's a core service) and its handler calls updateSession โ sets activeSession in a transaction โ the single-pane SinglePaneDetailVisibilityStrategy D3 restore autorun fires synchronously inside that handler. The layout controller's _onSessionReplaced (registered later, at BlockRestore) runs after โ so any aux-state transfer it does is too late: the autorun has already run D3c. The classic same-resource isSubmit guard (!isSessionSwitch && !previousIsCreated && isCreated) misses this because the agent-host/Copilot provider commits by replacing the draft with a new resource (isSessionSwitch is true). Fix: relax isSubmit to previousSessionResource && !previousIsCreated && isCreated && !viewStateBySession.has(activeSessionResource) โ detect the submit purely from the transition, independent of _onSessionReplaced ordering. The !has(state) guard keeps a genuine navigation from a draft to an existing created session on the normal D3 restore path. _onSessionReplaced then 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-registered onDidReplaceSession listener.
-
onDidReplaceSession always means submit โ never re-check from.status === Untitled, and never try to preserve visibility via a flag consumed by runOnChange: two related traps when suppressing the docked-editor reveal on new-session submit. (1) By the time onDidReplaceSession fires, the draft has already transitioned UntitledโCompleted, so a _isNewSessionReplacement(from,to) guard checking from.status === SessionStatus.Untitled is 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 every onDidReplaceSession as a submit โ no status guard. (2) The B2 working-set runOnChange (on the workspace-gated activeSessionForWorkingSet derive) fires before the synchronous onDidReplaceSession handler, so a boolean flag set in _onSessionReplaced and read synchronously in runOnChange is captured stale (false) and cannot suppress the reveal. The correct, ordering-robust mechanism is to have _onSessionReplaced write the draft's live editor-part visibility into _editorPartHiddenBySession[to] synchronously; because _applyWorkingSet reads that map inside its Sequencer.queue async microtask body (which runs after the sync replace handler), the reveal decision (_shouldRevealEditorPartOnApply/_shouldRevealEditorPartForEmptyWorkingSet) sees editorPartHidden=true and skips. Do NOT add a preserveEditorPartVisibility apply 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 _editorRevealedExplicitly on entering the view so R1 re-hides an inherited-explicit editor across a session switch (the working-set apply runs under suppressEditorPartAutoVisibility, so handleDidCloseEditor doesn'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 condition justEnteredNewSessionView || (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). isEditorRevealedExplicitly is 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._shouldRevealEditorPartOnApply must 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-panel Hidden target.
-
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 _registerResponsiveSidebar on an observableFromEvent(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 _sidebarAutoHidden is true, so a list the user closed manually stays closed.
-
Single-pane per-session editor-part visibility must be restored both ways โ _applyWorkingSet only ever revealed it: baseSessionLayoutController._applyWorkingSet revealed 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 _editorPartHiddenBySession state was only consumed to suppress the reveal (!editorPartHidden), never to actively hide. Fix: add a symmetric Template-Method hook _shouldHideEditorPartOnApply(editorPartHidden) (base returns false โ classic layout doesn't treat editor-part visibility as per-session; single-pane returns editorPartHidden && isCreated && !isQuickChat) and, in both the empty and non-empty _applyWorkingSet branches, hide the editor part (mutually exclusive with revealing, skipped on isInitialRestore which preserves the workbench-restored visibility). The hide runs inside _withSessionLayoutRestore's suppressEditorPartAutoVisibility window 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 by SinglePaneWorkbench.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 pill ViewAllChangesAction, opening a file diff in _openMultiFileDiffEditor) must reveal the editor part before opening the managed editor via IAgentWorkbenchLayoutService.revealEditorPartExplicitly() โ not the generic setPartHidden(false, EDITOR_PART). The generic call routes to setEditorHidden(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, since setEditorHidden early-returns when the part is already visible). Do not weaken the DockedEditorInput reveal suppression or add timing delays.
-
A MutableDisposable-backed content slot must not clearNode its shared container on cleanup: EditorGroupView.setHeaderContent appends a new content node into the shared headerContainer, then assigns the new store to _headerContent (a MutableDisposable) โ which synchronously disposes the previous store. If that store's cleanup calls clearNode(headerContainer), it wipes the freshly-appended new content (blank header, height stuck at 0, orphaned ResizeObserver). 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._saveWorkingSet used to record _editorPartHiddenBySession[prev] = !isVisible(EDITOR_PART) at the moment it saved the outgoing session. That races: the working-set derive (activeSessionForWorkingSet) lags the raw activeSession (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 as editorPartHidden=false and its closed side pane reopens on return (symptom: only the editor content re-appears, details stay closed, and no setEditorHidden fires 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 _saveWorkingSet entirely (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 _withSessionLayoutRestore to 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 auxBarVisible value captured before the queue boundary; read isVisible(AUXILIARYBAR_PART) inside the queued sync, otherwise openViewContainer can 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._applyWorkingSet restores the session's editor working set including which editor was active (e.g. package.json). SinglePaneManagedTabsStrategy then idempotently re-ensures the pinned Changes tab โ but if changesEditorOptions opens it as active (no inactive / activation), it steals active state from the just-restored editor, so the wrong tab is active after the switch. Give changesEditorOptions inactive: true + activation: EditorActivation.PRESERVE (matching fileTabOptions); 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 activeSessionForWorkingSet derive: the derive (baseSessionLayoutController) holds back while the incoming session's workspace folders resolve, and other autoruns driven by the raw ISessionsService.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 apply runOnChange (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 a saveWorkingSet for 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 _persistedEditorWidth to 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.partSizes via _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_RATIO in parts/editorPartSizing.ts, applied by the single-pane _applyEditorSplitSize override 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.