refactor: move Windows#active to CXP#activeWindow for convenience

BREAKING CHANGE: Use `CXP#activeWindow` instead of `Windows#active` to get the currently active window.

Author: sqs

src/extension/api.ts

@@ -34,6 +34,12 @@ export interface SourcegraphExtensionAPI<C = Settings> {
      */
     windows: Windows
 
+    /**
+     * The active window, or `null` if there is no active window. The active window is the window that was
+     * focused most recently.
+     */
+    activeWindow: Window | null
+
     /**
      * Command registration and execution.
      */
@@ -147,12 +153,6 @@ export interface Windows extends Observable<Window[]> {
      */
     all: Window[]
 
-    /**
-     * The active window, or `null` if there is no active window. The active window is the window that was
-     * focused most recently.
-     */
-    active: Window | null
-
     /**
      * Display a prompt and request text input from the user.
      *

src/extension/extension.ts

@@ -12,14 +12,17 @@ import { Commands, Configuration, ExtensionContext, Observable, SourcegraphExten
 import { createExtCommands } from './features/commands'
 import { createExtConfiguration } from './features/configuration'
 import { createExtContext } from './features/context'
-import { createExtWindows } from './features/windows'
+import { ExtWindows } from './features/windows'
 
 class ExtensionHandle<C> implements SourcegraphExtensionAPI<C> {
     public readonly configuration: Configuration<C> & Observable<C>
-    public readonly windows: Windows & Observable<Window[]>
+    public get windows(): Windows & Observable<Window[]> {
+        return this._windows
+    }
     public readonly commands: Commands
     public readonly context: ExtensionContext
 
+    private _windows: ExtWindows
     private subscription = new Subscription()
 
     constructor(public readonly rawConnection: MessageConnection, public readonly initializeParams: InitializeParams) {
@@ -29,7 +32,7 @@ class ExtensionHandle<C> implements SourcegraphExtensionAPI<C> {
             this,
             initializeParams.configurationCascade as ConfigurationCascade<C>
         )
-        this.windows = createExtWindows(this)
+        this._windows = new ExtWindows(this)
         this.commands = createExtCommands(this)
         this.context = createExtContext(this)
     }
@@ -38,6 +41,10 @@ class ExtensionHandle<C> implements SourcegraphExtensionAPI<C> {
         return this.initializeParams.root
     }
 
+    public get activeWindow(): Window | null {
+        return this._windows.activeWindow
+    }
+
     public close(): void {
         this.subscription.unsubscribe()
     }

src/extension/features/windows.test.ts

@@ -8,22 +8,22 @@ import {
     ShowInputParams,
     ShowInputRequest,
 } from '../../protocol'
-import { Observable, Window, Windows } from '../api'
+import { Window } from '../api'
 import { observableValue } from '../util'
-import { createExtWindows } from './windows'
+import { ExtWindows } from './windows'
 
 describe('ExtWindows', () => {
-    function create(): { extWindows: Windows & Observable<Window[]>; mockConnection: MockMessageConnection } {
+    function create(): { extWindows: ExtWindows; mockConnection: MockMessageConnection } {
         const mockConnection = new MockMessageConnection()
-        const extWindows = createExtWindows({ rawConnection: mockConnection })
+        const extWindows = new ExtWindows({ rawConnection: mockConnection })
         return { extWindows, mockConnection }
     }
 
     it('starts empty', () => {
         const { extWindows } = create()
         assert.deepStrictEqual(observableValue(extWindows), [{ isActive: true, activeComponent: null }] as Window[])
         assert.deepStrictEqual(extWindows.all, [{ isActive: true, activeComponent: null }] as Window[])
-        assert.deepStrictEqual(extWindows.active, { isActive: true, activeComponent: null } as Window)
+        assert.deepStrictEqual(extWindows.activeWindow, { isActive: true, activeComponent: null } as Window)
     })
 
     describe('component', () => {
@@ -37,7 +37,7 @@ describe('ExtWindows', () => {
             ]
             assert.deepStrictEqual(observableValue(extWindows), expectedWindows)
             assert.deepStrictEqual(extWindows.all, expectedWindows)
-            assert.deepStrictEqual(extWindows.active, expectedWindows[0])
+            assert.deepStrictEqual(extWindows.activeWindow, expectedWindows[0])
         })
 
         it('handles when the open resource is closed', () => {

src/extension/features/windows.ts

@@ -10,7 +10,13 @@ import {
 } from '../../protocol'
 import { Observable, SourcegraphExtensionAPI, Window, Windows } from '../api'
 
-class ExtWindows extends BehaviorSubject<Window[]> implements Windows, Observable<Window[]> {
+/**
+ * Implements the Sourcegraph extension API's {@link SourcegraphExtensionAPI#windows} value.
+ *
+ * @param ext The Sourcegraph extension API handle.
+ * @return The {@link SourcegraphExtensionAPI#windows} value.
+ */
+export class ExtWindows extends BehaviorSubject<Window[]> implements Windows, Observable<Window[]> {
     constructor(private ext: Pick<SourcegraphExtensionAPI<any>, 'rawConnection'>) {
         super([
             {
@@ -25,10 +31,10 @@ class ExtWindows extends BehaviorSubject<Window[]> implements Windows, Observabl
         })
         ext.rawConnection.onNotification(DidCloseTextDocumentNotification.type, params => {
             if (
-                this.active &&
-                this.active.activeComponent &&
-                this.active.activeComponent.resource &&
-                this.active.activeComponent.resource === params.textDocument.uri
+                this.activeWindow &&
+                this.activeWindow.activeComponent &&
+                this.activeWindow.activeComponent.resource &&
+                this.activeWindow.activeComponent.resource === params.textDocument.uri
             ) {
                 this.next([{ ...this.value[0], activeComponent: null }])
             }
@@ -39,7 +45,7 @@ class ExtWindows extends BehaviorSubject<Window[]> implements Windows, Observabl
         return this.value
     }
 
-    public get active(): Window | null {
+    public get activeWindow(): Window | null {
         return this.value.find(({ isActive }) => isActive) || null
     }
 
@@ -56,15 +62,3 @@ class ExtWindows extends BehaviorSubject<Window[]> implements Windows, Observabl
 
     public readonly [Symbol.observable] = () => this
 }
-
-/**
- * Creates the Sourcegraph extension API's {@link SourcegraphExtensionAPI#windows} value.
- *
- * @param ext The Sourcegraph extension API handle.
- * @return The {@link SourcegraphExtensionAPI#windows} value.
- */
-export function createExtWindows<C>(
-    ext: Pick<SourcegraphExtensionAPI<C>, 'rawConnection'>
-): Windows & Observable<Window[]> {
-    return new ExtWindows(ext)
-}