sessions: show welcome overlay on explicit sign-out (#307191)

* sessions: show welcome overlay on explicit sign-out

When the user signs out via the account menu, show the welcome/login
overlay immediately instead of waiting for the next app launch.

Listen to IDefaultAccountService.onDidChangeDefaultAccount for the
account becoming null, which reliably indicates a user-initiated
sign-out. Token refreshes keep the account non-null so there is no
false-positive risk.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* fix: stub IDefaultAccountService in welcome contribution tests

The tests were missing a mock for IDefaultAccountService which was
newly injected. Add an emitter-based stub and a test that verifies
the explicit sign-out flow shows the overlay.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

---------

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Author: joshspicer

src/vs/sessions/contrib/welcome/browser/welcome.contribution.ts

@@ -7,7 +7,7 @@ import './media/welcomeOverlay.css';
 import { Disposable, DisposableStore, MutableDisposable, toDisposable } from '../../../../base/common/lifecycle.js';
 import { SessionsWelcomeVisibleContext } from '../../../common/contextkeys.js';
 import { $, append } from '../../../../base/browser/dom.js';
-import { autorun } from '../../../../base/common/observable.js';
+import { autorun, observableValue } from '../../../../base/common/observable.js';
 import { Codicon } from '../../../../base/common/codicons.js';
 import { renderIcon } from '../../../../base/browser/ui/iconLabel/iconLabels.js';
 import { Button } from '../../../../base/browser/ui/button/button.js';
@@ -28,6 +28,7 @@ import { IStorageService, StorageScope, StorageTarget } from '../../../../platfo
 import { IContextKeyService } from '../../../../platform/contextkey/common/contextkey.js';
 import { IWorkbenchEnvironmentService } from '../../../../workbench/services/environment/common/environmentService.js';
 import { IQuickInputService } from '../../../../platform/quickinput/common/quickInput.js';
+import { IDefaultAccountService } from '../../../../platform/defaultAccount/common/defaultAccount.js';
 
 const WELCOME_COMPLETE_KEY = 'workbench.agentsession.welcomeComplete';
 
@@ -136,6 +137,14 @@ export class SessionsWelcomeContribution extends Disposable implements IWorkbenc
 	private readonly overlayRef = this._register(new MutableDisposable<DisposableStore>());
 	private readonly watcherRef = this._register(new MutableDisposable());
 
+	/**
+	 * Tracks whether the user has explicitly signed out. Used to include
+	 * {@link ChatEntitlement.Unknown} in setup checks only after a genuine
+	 * sign-out (account removed), avoiding false positives from token refreshes
+	 * where the account stays non-null.
+	 */
+	private readonly signedOut = observableValue(this, false);
+
 	constructor(
 		@IChatEntitlementService private readonly chatEntitlementService: ChatEntitlementService,
 		@IWorkbenchLayoutService private readonly layoutService: IWorkbenchLayoutService,
@@ -144,6 +153,7 @@ export class SessionsWelcomeContribution extends Disposable implements IWorkbenc
 		@IStorageService private readonly storageService: IStorageService,
 		@IContextKeyService private readonly contextKeyService: IContextKeyService,
 		@IWorkbenchEnvironmentService private readonly environmentService: IWorkbenchEnvironmentService,
+		@IDefaultAccountService private readonly defaultAccountService: IDefaultAccountService,
 	) {
 		super();
 
@@ -183,23 +193,33 @@ export class SessionsWelcomeContribution extends Disposable implements IWorkbenc
 	 * completed. If the user's state changes such that setup is needed again
 	 * (e.g. extension uninstalled/disabled), shows the welcome overlay.
 	 *
-	 * {@link ChatEntitlement.Unknown} is intentionally ignored here: it is
-	 * almost always a transient state caused by a stale OAuth token being
-	 * refreshed after an update. A genuine sign-out will be caught on the
-	 * next app launch via the initial {@link showOverlayIfNeeded} check.
+	 * {@link ChatEntitlement.Unknown} is intentionally ignored unless the
+	 * default account has been removed, which reliably indicates a genuine
+	 * user-initiated sign-out rather than a transient token refresh (where
+	 * the account object stays non-null).
 	 */
 	private watchEntitlementState(): void {
+		this.signedOut.set(false, undefined);
 		let setupComplete = !this._needsChatSetup(false);
-		this.watcherRef.value = autorun(reader => {
+		const store = new DisposableStore();
+
+		store.add(this.defaultAccountService.onDidChangeDefaultAccount(account => {
+			this.signedOut.set(account === null, undefined);
+		}));
+
+		store.add(autorun(reader => {
 			this.chatEntitlementService.sentimentObs.read(reader);
 			this.chatEntitlementService.entitlementObs.read(reader);
+			const isSignedOut = this.signedOut.read(reader);
 
-			const needsSetup = this._needsChatSetup(false);
+			const needsSetup = this._needsChatSetup(isSignedOut);
 			if (setupComplete && needsSetup) {
 				this.showOverlay();
 			}
 			setupComplete = !needsSetup;
-		});
+		}));
+
+		this.watcherRef.value = store;
 	}
 
 	private _needsChatSetup(includeUnknown: boolean = true): boolean {

src/vs/sessions/contrib/welcome/test/browser/welcome.contribution.test.ts

@@ -4,9 +4,10 @@
  *--------------------------------------------------------------------------------------------*/
 
 import assert from 'assert';
-import { Event } from '../../../../../base/common/event.js';
+import { Emitter, Event } from '../../../../../base/common/event.js';
 import { DisposableStore } from '../../../../../base/common/lifecycle.js';
 import { ISettableObservable, observableValue, transaction } from '../../../../../base/common/observable.js';
+import { IDefaultAccountService } from '../../../../../platform/defaultAccount/common/defaultAccount.js';
 import { ensureNoDisposablesAreLeakedInTestSuite } from '../../../../../base/test/common/utils.js';
 import { TestInstantiationService } from '../../../../../platform/instantiation/test/common/instantiationServiceMock.js';
 import { IProductService } from '../../../../../platform/product/common/productService.js';
@@ -53,12 +54,16 @@ suite('SessionsWelcomeContribution', () => {
 	const disposables = new DisposableStore();
 	let instantiationService: TestInstantiationService;
 	let mockEntitlementService: MockChatEntitlementService;
+	let defaultAccountEmitter: Emitter<unknown>;
 
 	setup(() => {
 		instantiationService = workbenchInstantiationService(undefined, disposables);
 		mockEntitlementService = new MockChatEntitlementService();
 		instantiationService.stub(IChatEntitlementService, mockEntitlementService as unknown as IChatEntitlementService);
 
+		defaultAccountEmitter = disposables.add(new Emitter<unknown>());
+		instantiationService.stub(IDefaultAccountService, { onDidChangeDefaultAccount: defaultAccountEmitter.event } as Partial<IDefaultAccountService> as IDefaultAccountService);
+
 		// Ensure product has a defaultChatAgent so the contribution activates
 		const productService = instantiationService.get(IProductService);
 		instantiationService.stub(IProductService, {
@@ -206,4 +211,22 @@ suite('SessionsWelcomeContribution', () => {
 
 		assert.strictEqual(isOverlayVisible(), true, 'should show overlay for Available entitlement');
 	});
+
+	test('returning user: explicit sign-out shows overlay', () => {
+		markReturningUser();
+		mockEntitlementService.entitlementObs.set(ChatEntitlement.Free, undefined);
+		mockEntitlementService.sentimentObs.set({ completed: true } as IChatSentiment, undefined);
+
+		const contribution = disposables.add(instantiationService.createInstance(SessionsWelcomeContribution));
+		assert.ok(contribution);
+		assert.strictEqual(isOverlayVisible(), false, 'should not show initially');
+
+		// Simulate explicit sign-out: account removed then entitlement goes Unknown
+		defaultAccountEmitter.fire(null);
+		transaction(tx => {
+			mockEntitlementService.entitlementObs.set(ChatEntitlement.Unknown, tx);
+		});
+
+		assert.strictEqual(isOverlayVisible(), true, 'should show overlay after explicit sign-out');
+	});
 });