refactor: move old self-executable extension API into 'old' dir

This makes room for the new extension API, where extensions merely export an `activate` function instead of being self-executing and being bundled with the extension side of the Sourcegraph extension API JSON-RPC protocol.

BREAKING CHANGE: The import paths for `activateExtension`, `SourcegraphExtensionAPI`, and other extension API types are now in `sourcegraph/module/extension/old/**`.

Author: sqs

src/extension/features/context.ts

@@ -1,9 +1,9 @@
 import { Subscription } from 'rxjs'
-import { Context } from '../environment/context/context'
-import { MessageConnection } from '../jsonrpc2/connection'
-import { InitializeParams, Settings, TextDocumentDecoration } from '../protocol'
-import { TextDocumentIdentifier } from '../types/textDocument'
-import { URI } from '../types/uri'
+import * as sourcegraph from 'sourcegraph'
+import { Context } from '../../environment/context/context'
+import { MessageConnection } from '../../jsonrpc2/connection'
+import { InitializeParams, Settings, TextDocumentDecoration } from '../../protocol'
+import { TextDocumentIdentifier } from '../../types/textDocument'
 
 /**
  * The Sourcegraph extension API, which extensions use to interact with the client.
@@ -188,7 +188,7 @@ export interface Component {
     /**
      * The URI of the resource (such as a file) that this component is displaying, or null if there is none.
      */
-    resource: URI | null
+    resource: sourcegraph.URI | null
 }
 
 /**

src/extension/api.ts src/extension/old/api.ts

@@ -1,16 +1,16 @@
 import * as assert from 'assert'
-import { createConnection as createClientConnection } from '../client/connection'
+import { createConnection as createClientConnection } from '../../client/connection'
 import {
     InitializedNotification,
     InitializeParams,
     InitializeRequest,
     InitializeResult,
     RegistrationRequest,
-} from '../protocol'
-import { createMessageTransports } from '../test/integration/helpers'
+} from '../../protocol'
+import { createMessageTransports } from '../../test/integration/helpers'
 import { activateExtension } from './extensionHost'
 
-describe('activateExtension', () => {
+describe('activateExtension (old)', () => {
     it('initialize request parameters and result', async () => {
         const [clientTransports, serverTransports] = createMessageTransports()
         const clientConnection = createClientConnection(clientTransports)

src/extension/extensionHost.test.ts src/extension/old/extensionHost.test.ts

@@ -1,6 +1,6 @@
 import { Subscription } from 'rxjs'
-import { createMessageConnection, Logger, MessageConnection, MessageTransports } from '../jsonrpc2/connection'
-import { createWebWorkerMessageTransports } from '../jsonrpc2/transports/webWorker'
+import { createMessageConnection, Logger, MessageConnection, MessageTransports } from '../../jsonrpc2/connection'
+import { createWebWorkerMessageTransports } from '../../jsonrpc2/transports/webWorker'
 import {
     ConfigurationCascade,
     InitializedNotification,
@@ -9,7 +9,7 @@ import {
     InitializeResult,
     RegistrationParams,
     RegistrationRequest,
-} from '../protocol'
+} from '../../protocol'
 import { Commands, Configuration, ExtensionContext, Observable, SourcegraphExtensionAPI, Window, Windows } from './api'
 import { createExtCommands } from './features/commands'
 import { createExtConfiguration } from './features/configuration'
@@ -31,12 +31,12 @@ class ExtensionHandle<C> implements SourcegraphExtensionAPI<C> {
         this.subscription.add(this.rawConnection)
 
         this.configuration = createExtConfiguration<C>(
-            this,
+            this.rawConnection,
             initializeParams.configurationCascade as ConfigurationCascade<C>
         )
-        this._windows = new ExtWindows(this)
-        this.commands = createExtCommands(this)
-        this.context = createExtContext(this)
+        this._windows = new ExtWindows(this.rawConnection)
+        this.commands = createExtCommands(this.rawConnection)
+        this.context = createExtContext(this.rawConnection)
     }
 
     public get activeWindow(): Window | null {

src/extension/extensionHost.ts src/extension/old/extensionHost.ts

@@ -1,5 +1,5 @@
 import assert from 'assert'
-import { MockMessageConnection } from '../../jsonrpc2/test/mockMessageConnection'
+import { MockMessageConnection } from '../../../jsonrpc2/test/mockMessageConnection'
 import {
     ExecuteCommandParams,
     ExecuteCommandRegistrationOptions,
@@ -8,7 +8,7 @@ import {
     RegistrationRequest,
     UnregistrationParams,
     UnregistrationRequest,
-} from '../../protocol'
+} from '../../../protocol'
 import { Commands } from '../api'
 import { createExtCommands } from './commands'
 
@@ -18,7 +18,7 @@ describe('ExtCommands', () => {
         mockConnection: MockMessageConnection
     } {
         const mockConnection = new MockMessageConnection()
-        const extCommands = createExtCommands({ rawConnection: mockConnection })
+        const extCommands = createExtCommands(mockConnection)
         return { extCommands, mockConnection }
     }
 

src/extension/features/commands.test.ts src/extension/old/features/commands.test.ts

@@ -1,33 +1,34 @@
 import { Subscription } from 'rxjs'
 import uuidv4 from 'uuid/v4'
-import { CommandRegistry } from '../../environment/providers/command'
+import { CommandRegistry } from '../../../environment/providers/command'
+import { MessageConnection } from '../../../jsonrpc2/connection'
 import {
     ExecuteCommandRegistrationOptions,
     ExecuteCommandRequest,
     RegistrationParams,
     RegistrationRequest,
     UnregistrationParams,
     UnregistrationRequest,
-} from '../../protocol'
-import { Commands, SourcegraphExtensionAPI } from '../api'
+} from '../../../protocol'
+import { Commands } from '../api'
 
 /**
  * Creates the Sourcegraph extension API's {@link SourcegraphExtensionAPI#commands} value.
  *
- * @param ext The Sourcegraph extension API handle.
+ * @param rawConnection The connection to the Sourcegraph API client.
  * @return The {@link Creates the Sourcegraph extension API extension API's#commands} value.
  */
-export function createExtCommands(ext: Pick<SourcegraphExtensionAPI<any>, 'rawConnection'>): Commands {
+export function createExtCommands(rawConnection: MessageConnection): Commands {
     // TODO: move CommandRegistry to somewhere general since it's now used by the controller AND extension
     const commandRegistry = new CommandRegistry()
-    ext.rawConnection.onRequest(ExecuteCommandRequest.type, params => commandRegistry.executeCommand(params))
+    rawConnection.onRequest(ExecuteCommandRequest.type, params => commandRegistry.executeCommand(params))
     return {
         register: (command: string, run: (...args: any[]) => Promise<any>): Subscription => {
             const subscription = new Subscription()
 
             const id = uuidv4()
             subscription.add(commandRegistry.registerCommand({ command, run }))
-            ext.rawConnection
+            rawConnection
                 .sendRequest(RegistrationRequest.type, {
                     registrations: [
                         {
@@ -40,7 +41,7 @@ export function createExtCommands(ext: Pick<SourcegraphExtensionAPI<any>, 'rawCo
                 .catch(err => console.error(err))
 
             subscription.add(() => {
-                ext.rawConnection
+                rawConnection
                     .sendRequest(UnregistrationRequest.type, {
                         unregisterations: [{ id, method: ExecuteCommandRequest.type.method }],
                     } as UnregistrationParams)

src/extension/features/commands.ts src/extension/old/features/commands.ts

@@ -1,12 +1,12 @@
 import assert from 'assert'
-import { MockMessageConnection } from '../../jsonrpc2/test/mockMessageConnection'
+import { MockMessageConnection } from '../../../jsonrpc2/test/mockMessageConnection'
 import {
     ConfigurationCascade,
     ConfigurationUpdateParams,
     ConfigurationUpdateRequest,
     DidChangeConfigurationNotification,
     DidChangeConfigurationParams,
-} from '../../protocol'
+} from '../../../protocol'
 import { Configuration, Observable } from '../api'
 import { observableValue } from '../util'
 import { createExtConfiguration, setValueAtKeyPath } from './configuration'
@@ -23,7 +23,7 @@ describe('ExtConfiguration', () => {
         mockConnection: MockMessageConnection
     } {
         const mockConnection = new MockMessageConnection()
-        const extConfiguration = createExtConfiguration({ rawConnection: mockConnection }, initial)
+        const extConfiguration = createExtConfiguration(mockConnection, initial)
         return { extConfiguration, mockConnection }
     }
 

src/extension/features/configuration.test.ts src/extension/old/features/configuration.test.ts

@@ -1,20 +1,21 @@
 import { BehaviorSubject } from 'rxjs'
 import { distinctUntilChanged } from 'rxjs/operators'
+import { MessageConnection } from '../../../jsonrpc2/connection'
 import {
     ConfigurationCascade,
     ConfigurationUpdateParams,
     ConfigurationUpdateRequest,
     DidChangeConfigurationNotification,
     KeyPath,
-} from '../../protocol'
-import { isEqual } from '../../util'
-import { Configuration, Observable, SourcegraphExtensionAPI } from '../api'
+} from '../../../protocol'
+import { isEqual } from '../../../util'
+import { Configuration, Observable } from '../api'
 
 class ExtConfiguration<C> extends BehaviorSubject<C> implements Configuration<C>, Observable<C> {
-    constructor(private ext: Pick<SourcegraphExtensionAPI<C>, 'rawConnection'>, initial: ConfigurationCascade<C>) {
+    constructor(private rawConnection: MessageConnection, initial: ConfigurationCascade<C>) {
         super(initial.merged as C)
 
-        ext.rawConnection.onNotification(DidChangeConfigurationNotification.type, params => {
+        rawConnection.onNotification(DidChangeConfigurationNotification.type, params => {
             this.next(params.configurationCascade.merged as C)
         })
     }
@@ -35,7 +36,7 @@ class ExtConfiguration<C> extends BehaviorSubject<C> implements Configuration<C>
         const cur = this.value
         this.next(setValueAtKeyPath(cur, path, value))
 
-        return this.ext.rawConnection.sendRequest(ConfigurationUpdateRequest.type, {
+        return this.rawConnection.sendRequest(ConfigurationUpdateRequest.type, {
             path,
             value,
         } as ConfigurationUpdateParams)
@@ -107,12 +108,12 @@ export function setValueAtKeyPath(source: any, path: KeyPath, value: any): any {
 /**
  * Creates the Sourcegraph extension API's {@link SourcegraphExtensionAPI#configuration} value.
  *
- * @param ext The Sourcegraph extension API handle.
+ * @param rawConnection The connection to the Sourcegraph API client.
  * @return The {@link SourcegraphExtensionAPI#configuration} value.
  */
 export function createExtConfiguration<C>(
-    ext: Pick<SourcegraphExtensionAPI<C>, 'rawConnection'>,
+    rawConnection: MessageConnection,
     initial: ConfigurationCascade<C>
 ): Configuration<C> & Observable<C> {
-    return new ExtConfiguration(ext, initial)
+    return new ExtConfiguration(rawConnection, initial)
 }

src/extension/features/configuration.ts src/extension/old/features/configuration.ts

@@ -1,13 +1,13 @@
 import assert from 'assert'
-import { MockMessageConnection } from '../../jsonrpc2/test/mockMessageConnection'
-import { ContextUpdateNotification, ContextUpdateParams } from '../../protocol/context'
+import { MockMessageConnection } from '../../../jsonrpc2/test/mockMessageConnection'
+import { ContextUpdateNotification, ContextUpdateParams } from '../../../protocol/context'
 import { ExtensionContext } from '../api'
 import { createExtContext } from './context'
 
 describe('ExtContext', () => {
     function create(): { extContext: ExtensionContext; mockConnection: MockMessageConnection } {
         const mockConnection = new MockMessageConnection()
-        const extContext = createExtContext({ rawConnection: mockConnection })
+        const extContext = createExtContext(mockConnection)
         return { extContext, mockConnection }
     }
 

src/extension/features/context.test.ts src/extension/old/features/context.test.ts

@@ -0,0 +1,18 @@
+import { Context } from '../../../environment/context/context'
+import { MessageConnection } from '../../../jsonrpc2/connection'
+import { ContextUpdateNotification, ContextUpdateParams } from '../../../protocol/context'
+import { ExtensionContext } from '../api'
+
+/**
+ * Creates the Sourcegraph extension API's {@link SourcegraphExtensionAPI#context} value.
+ *
+ * @param rawConnection The connection to the Sourcegraph API client.
+ * @return The {@link SourcegraphExtensionAPI#context} value.
+ */
+export function createExtContext(rawConnection: MessageConnection): ExtensionContext {
+    return {
+        updateContext: (updates: Context): void => {
+            rawConnection.sendNotification(ContextUpdateNotification.type, { updates } as ContextUpdateParams)
+        },
+    }
+}

src/extension/old/features/context.ts

@@ -1,21 +1,22 @@
 import assert from 'assert'
-import { MockMessageConnection } from '../../jsonrpc2/test/mockMessageConnection'
+import { MockMessageConnection } from '../../../jsonrpc2/test/mockMessageConnection'
 import {
     DidCloseTextDocumentNotification,
     DidCloseTextDocumentParams,
     DidOpenTextDocumentNotification,
     DidOpenTextDocumentParams,
     ShowInputParams,
     ShowInputRequest,
-} from '../../protocol'
+} from '../../../protocol'
+import { URI } from '../../../types/uri'
 import { Window } from '../api'
 import { observableValue } from '../util'
 import { ExtWindows } from './windows'
 
 describe('ExtWindows', () => {
     function create(): { extWindows: ExtWindows; mockConnection: MockMessageConnection } {
         const mockConnection = new MockMessageConnection()
-        const extWindows = new ExtWindows({ rawConnection: mockConnection })
+        const extWindows = new ExtWindows(mockConnection)
         return { extWindows, mockConnection }
     }
 
@@ -32,7 +33,7 @@ describe('ExtWindows', () => {
                 textDocument: { uri: 'file:///a', languageId: 'l', text: 't', version: 1 },
             } as DidOpenTextDocumentParams)
             const expectedWindows: Window[] = [
-                { isActive: true, activeComponent: { isActive: true, resource: 'file:///a' } },
+                { isActive: true, activeComponent: { isActive: true, resource: URI.parse('file:///a') } },
             ]
             assert.deepStrictEqual(observableValue(extWindows), expectedWindows)
             assert.deepStrictEqual(extWindows.activeWindow, expectedWindows[0])
@@ -58,7 +59,7 @@ describe('ExtWindows', () => {
                 textDocument: { uri: 'file:///b' },
             } as DidCloseTextDocumentParams)
             assert.deepStrictEqual(observableValue(extWindows), [
-                { isActive: true, activeComponent: { isActive: true, resource: 'file:///a' } },
+                { isActive: true, activeComponent: { isActive: true, resource: URI.parse('file:///a') } },
             ] as Window[])
         })
     })

src/extension/features/windows.test.ts src/extension/old/features/windows.test.ts

@@ -1,14 +1,16 @@
 import { BehaviorSubject } from 'rxjs'
+import { MessageConnection } from '../../../jsonrpc2/connection'
 import {
     DidCloseTextDocumentNotification,
     DidOpenTextDocumentNotification,
     ShowInputRequest,
     TextDocumentDecoration,
     TextDocumentPublishDecorationsNotification,
     TextDocumentPublishDecorationsParams,
-} from '../../protocol'
-import { TextDocumentIdentifier } from '../../types/textDocument'
-import { Observable, SourcegraphExtensionAPI, Window, Windows } from '../api'
+} from '../../../protocol'
+import { TextDocumentIdentifier } from '../../../types/textDocument'
+import { URI } from '../../../types/uri'
+import { Observable, Window, Windows } from '../api'
 
 /**
  * Implements the Sourcegraph extension API's {@link SourcegraphExtensionAPI#windows} value.
@@ -17,7 +19,7 @@ import { Observable, SourcegraphExtensionAPI, Window, Windows } from '../api'
  * @return The {@link SourcegraphExtensionAPI#windows} value.
  */
 export class ExtWindows extends BehaviorSubject<Window[]> implements Windows, Observable<Window[]> {
-    constructor(private ext: Pick<SourcegraphExtensionAPI<any>, 'rawConnection'>) {
+    constructor(private rawConnection: MessageConnection) {
         super([
             {
                 isActive: true,
@@ -26,15 +28,17 @@ export class ExtWindows extends BehaviorSubject<Window[]> implements Windows, Ob
         ])
 
         // Track last-opened text document.
-        ext.rawConnection.onNotification(DidOpenTextDocumentNotification.type, params => {
-            this.next([{ ...this.value[0], activeComponent: { isActive: true, resource: params.textDocument.uri } }])
+        rawConnection.onNotification(DidOpenTextDocumentNotification.type, params => {
+            this.next([
+                { ...this.value[0], activeComponent: { isActive: true, resource: URI.parse(params.textDocument.uri) } },
+            ])
         })
-        ext.rawConnection.onNotification(DidCloseTextDocumentNotification.type, params => {
+        rawConnection.onNotification(DidCloseTextDocumentNotification.type, params => {
             if (
                 this.activeWindow &&
                 this.activeWindow.activeComponent &&
                 this.activeWindow.activeComponent.resource &&
-                this.activeWindow.activeComponent.resource === params.textDocument.uri
+                this.activeWindow.activeComponent.resource.toString() === params.textDocument.uri
             ) {
                 this.next([{ ...this.value[0], activeComponent: null }])
             }
@@ -46,11 +50,11 @@ export class ExtWindows extends BehaviorSubject<Window[]> implements Windows, Ob
     }
 
     public showInputBox(message: string, defaultValue?: string): Promise<string | null> {
-        return this.ext.rawConnection.sendRequest(ShowInputRequest.type, { message, defaultValue })
+        return this.rawConnection.sendRequest(ShowInputRequest.type, { message, defaultValue })
     }
 
     public setDecorations(resource: TextDocumentIdentifier, decorations: TextDocumentDecoration[]): void {
-        return this.ext.rawConnection.sendNotification(TextDocumentPublishDecorationsNotification.type, {
+        return this.rawConnection.sendNotification(TextDocumentPublishDecorationsNotification.type, {
             textDocument: resource,
             decorations,
         } as TextDocumentPublishDecorationsParams)