Add onDidChangeActiveTab

Author: lramos15

src/vs/workbench/api/common/extHostEditorTabs.ts

@@ -3,7 +3,7 @@
  *  Licensed under the MIT License. See License.txt in the project root for license information.
  *--------------------------------------------------------------------------------------------*/
 
-import type * as vscode from 'vscode';
+import * as vscode from 'vscode';
 import * as typeConverters from 'vs/workbench/api/common/extHostTypeConverters';
 import { IEditorTabDto, IEditorTabGroupDto, IExtHostEditorTabsShape, MainContext, MainThreadEditorTabsShape, TabInputKind } from 'vs/workbench/api/common/extHost.protocol';
 import { URI } from 'vs/base/common/uri';
@@ -162,6 +162,11 @@ class ExtHostEditorTabGroup {
 		}
 		if (dto.isActive) {
 			this._activeTabId = dto.id;
+		} else if (this._activeTabId === dto.id && !dto.isActive) {
+			// Events aren't guaranteed to be in order so if we receive a dto that matches the active tab id
+			// but isn't active we mark the active tab id as empty. This prevent onDidActiveTabChange frorm
+			// firing incorrectly
+			this._activeTabId = '';
 		}
 		tab.acceptDtoUpdate(dto);
 		return tab;
@@ -177,8 +182,9 @@ export class ExtHostEditorTabs implements IExtHostEditorTabs {
 	readonly _serviceBrand: undefined;
 
 	private readonly _proxy: MainThreadEditorTabsShape;
-	private readonly _onDidChangeTab = new Emitter<vscode.Tab[]>();
-	private readonly _onDidChangeTabGroup = new Emitter<void>();
+	private readonly _onDidChangeTabs = new Emitter<vscode.Tab[]>();
+	private readonly _onDidChangeActiveTab = new Emitter<vscode.Tab>();
+	private readonly _onDidChangeTabGroups = new Emitter<vscode.TabGroup[]>();
 	private readonly _onDidChangeActiveTabGroup = new Emitter<vscode.TabGroup>();
 
 	// Have to use ! because this gets initialized via an RPC proxy
@@ -197,9 +203,10 @@ export class ExtHostEditorTabs implements IExtHostEditorTabs {
 			const that = this;
 			const obj: vscode.TabGroups = {
 				// never changes -> simple value
-				onDidChangeTabGroup: that._onDidChangeTabGroup.event,
+				onDidChangeTabGroups: that._onDidChangeTabGroups.event,
 				onDidChangeActiveTabGroup: that._onDidChangeActiveTabGroup.event,
-				onDidChangeTabs: that._onDidChangeTab.event,
+				onDidChangeTabs: that._onDidChangeTabs.event,
+				onDidChangeActiveTab: that._onDidChangeActiveTab.event,
 				// dynamic -> getters
 				get groups() {
 					return Object.freeze(that._extHostTabGroups.map(group => group.apiObject));
@@ -259,7 +266,7 @@ export class ExtHostEditorTabs implements IExtHostEditorTabs {
 			this._activeGroupId = activeTabGroupId;
 			this._onDidChangeActiveTabGroup.fire(this.tabGroups.activeTabGroup);
 		}
-		this._onDidChangeTabGroup.fire();
+		this._onDidChangeTabGroups.fire(this._extHostTabGroups.map(g => g.apiObject));
 	}
 
 	$acceptTabGroupUpdate(groupDto: IEditorTabGroupDto) {
@@ -275,7 +282,7 @@ export class ExtHostEditorTabs implements IExtHostEditorTabs {
 				this._onDidChangeActiveTabGroup.fire(group.apiObject);
 			}
 		}
-		this._onDidChangeTabGroup.fire();
+		this._onDidChangeTabGroups.fire([group.apiObject]);
 	}
 
 	$acceptTabUpdate(groupId: number, tabDto: IEditorTabDto) {
@@ -284,6 +291,9 @@ export class ExtHostEditorTabs implements IExtHostEditorTabs {
 			throw new Error('Update Tabs IPC call received before group creation.');
 		}
 		const tab = group.acceptTabDtoUpdate(tabDto);
-		this._onDidChangeTab.fire([tab.apiObject]);
+		this._onDidChangeTabs.fire([tab.apiObject]);
+		if (tab.apiObject.isActive) {
+			this._onDidChangeActiveTab.fire(tab.apiObject);
+		}
 	}
 }

src/vs/workbench/api/test/browser/extHostEditorTabs.test.ts

@@ -109,7 +109,7 @@ suite('ExtHostEditorTabs', function () {
 		);
 
 		let count = 0;
-		extHostEditorTabs.tabGroups.onDidChangeTabGroup(() => count++);
+		extHostEditorTabs.tabGroups.onDidChangeTabGroups(() => count++);
 
 		assert.strictEqual(count, 0);
 
@@ -339,7 +339,7 @@ suite('ExtHostEditorTabs', function () {
 		});
 		assert.throws(() => {
 			// @ts-expect-error write to readonly prop
-			extHostEditorTabs.tabGroups.onDidChangeTabGroup = undefined;
+			extHostEditorTabs.tabGroups.onDidChangeTabGroups = undefined;
 		});
 	});
 
@@ -493,4 +493,72 @@ suite('ExtHostEditorTabs', function () {
 		assert.strictEqual(extHostEditorTabs.tabGroups.groups.map(g => g.tabs).flat().length, 0);
 		assert.strictEqual(extHostEditorTabs.tabGroups.activeTabGroup?.activeTab, undefined);
 	});
+
+	test('Active tab change event', function () {
+
+		const extHostEditorTabs = new ExtHostEditorTabs(
+			SingleProxyRPCProtocol(new class extends mock<MainThreadEditorTabsShape>() {
+				// override/implement $moveTab or $closeTab
+			})
+		);
+
+		let activeTabChangeCount = 0;
+		extHostEditorTabs.tabGroups.onDidChangeActiveTab((activeTab) => {
+			if (activeTab.isActive === false) {
+				throw new Error('Active tab changed fired on inactive tab');
+			}
+			activeTabChangeCount++;
+		});
+
+		const tab1: IEditorTabDto = createTabDto({
+			id: 'uniquestring',
+			isActive: true,
+			label: 'label1',
+		});
+
+		const tab2: IEditorTabDto = createTabDto({
+			isActive: false,
+			id: 'uniquestring2',
+			label: 'label2',
+		});
+
+		const tab3: IEditorTabDto = createTabDto({
+			isActive: false,
+			id: 'uniquestring3',
+			label: 'label3',
+		});
+
+		extHostEditorTabs.$acceptEditorTabModel([{
+			isActive: true,
+			viewColumn: 0,
+			groupId: 12,
+			tabs: [tab1, tab2, tab3]
+		}]);
+
+		// Accepting a model doesn't fire an active tab change event
+		assert.strictEqual(activeTabChangeCount, 0);
+
+		// Switching active tab works
+		tab1.isActive = false;
+		tab2.isActive = true;
+		extHostEditorTabs.$acceptTabUpdate(12, tab1);
+		extHostEditorTabs.$acceptTabUpdate(12, tab2);
+		// The active tab changed so it is fired once
+		assert.strictEqual(activeTabChangeCount, 1);
+
+		//Closing tabs out works
+		tab3.isActive = true;
+		extHostEditorTabs.$acceptEditorTabModel([{
+			isActive: true,
+			viewColumn: 0,
+			groupId: 12,
+			tabs: [tab3]
+		}]);
+		// Accepting a model doesn't fire an active tab change event
+		assert.strictEqual(activeTabChangeCount, 1);
+		tab3.label = 'Foobar';
+		extHostEditorTabs.$acceptTabUpdate(12, tab3);
+		// Something related to the active tab changed
+		assert.strictEqual(activeTabChangeCount, 2);
+	});
 });

src/vscode-dts/vscode.proposed.tabs.d.ts

@@ -71,8 +71,8 @@ declare module 'vscode' {
 		readonly kind: TabKindText | TabKindTextDiff | TabKindCustom | TabKindWebview | TabKindNotebook | TabKindNotebookDiff | TabKindTerminal | unknown;
 
 		/**
-		 * Whether or not the tab is currently active
-		 * Dictated by being the selected tab in the group
+		 * Whether or not the tab is currently active.
+		 * This is dictated by being the selected tab in the group
 		 */
 		readonly isActive: boolean;
 
@@ -137,14 +137,20 @@ declare module 'vscode' {
 		/**
 		 * An {@link Event} which fires when a group changes.
 		 */
-		// TODO@API add TabGroup instance
-		readonly onDidChangeTabGroup: Event<void>;
+		readonly onDidChangeTabGroups: Event<TabGroup[]>;
 
 		/**
 		 * An {@link Event} which fires when a tab changes.
 		 */
 		readonly onDidChangeTabs: Event<Tab[]>;
 
+		/**
+		 * An {@link Event} which fires when an active tab changes.
+		 * Similar to {@link TabGroup.onDidChangeTabs} but only on tabs
+		 * with isActive equal to true.
+		 */
+		readonly onDidChangeActiveTab: Event<Tab>;
+
 		/**
 		 * An {@link Event} which fires when the active group changes.
 		 * This does not fire when the properties within the group change.