@@ -248,9 +261,13 @@ const TabbedObjectTemplateFactory = (options: {
})}
- {manager.specs.has(tab as TLanguageServerId)
+ {(manager as LanguageServerManager).specs.has(
+ tab as TLanguageServerId
+ )
? renderServerMetadata(
- manager.specs.get(tab as TLanguageServerId)!
+ (manager as LanguageServerManager).specs.get(
+ tab as TLanguageServerId
+ )!
)
: null}
{props.properties
diff --git a/packages/jupyterlab-lsp/src/components/statusbar.tsx b/packages/jupyterlab-lsp/src/components/statusbar.tsx
index f67525858..c448f6aff 100644
--- a/packages/jupyterlab-lsp/src/components/statusbar.tsx
+++ b/packages/jupyterlab-lsp/src/components/statusbar.tsx
@@ -2,6 +2,7 @@
// Distributed under the terms of the Modified BSD License.
// Based on the @jupyterlab/codemirror-extension statusbar
+import { JupyterFrontEnd } from '@jupyterlab/application';
import {
VDomModel,
VDomRenderer,
@@ -9,14 +10,16 @@ import {
showDialog
} from '@jupyterlab/apputils';
import { DocumentRegistry, IDocumentWidget } from '@jupyterlab/docregistry';
-import { INotebookModel, NotebookPanel } from '@jupyterlab/notebook';
import {
- GroupItem,
- Popup,
- TextItem,
- interactiveItem,
- showPopup
-} from '@jupyterlab/statusbar';
+ ILSPConnection,
+ collectDocuments,
+ ILSPDocumentConnectionManager,
+ VirtualDocument,
+ WidgetLSPAdapter,
+ ILanguageServerManager
+} from '@jupyterlab/lsp';
+import { INotebookModel, NotebookPanel } from '@jupyterlab/notebook';
+import { GroupItem, Popup, TextItem, showPopup } from '@jupyterlab/statusbar';
import { TranslationBundle } from '@jupyterlab/translation';
import {
LabIcon,
@@ -30,19 +33,8 @@ import React from 'react';
import '../../style/statusbar.css';
import * as SCHEMA from '../_schema';
-import { WidgetAdapter } from '../adapters/adapter';
-import { LSPConnection } from '../connection';
-import { DocumentConnectionManager } from '../connection_manager';
import { SERVER_EXTENSION_404 } from '../errors';
-import { LanguageServerManager } from '../manager';
-import {
- ILSPAdapterManager,
- ILanguageServerManager,
- TSessionMap,
- TLanguageServerId,
- TSpecsMap
-} from '../tokens';
-import { VirtualDocument, collect_documents } from '../virtual/document';
+import { TSessionMap, TLanguageServerId, TSpecsMap } from '../tokens';
import { codeCheckIcon, codeClockIcon, codeWarningIcon } from './icons';
import { DocumentLocator, ServerLinksList } from './utils';
@@ -384,55 +376,25 @@ class LSPPopup extends VDomRenderer
{
}
}
-const SELECTED_CLASS = 'jp-mod-selected';
-
/**
* StatusBar item.
*/
export class LSPStatus extends VDomRenderer {
protected _popup: Popup | null = null;
- private interactiveStateObserver: MutationObserver;
private trans: TranslationBundle;
/**
* Construct a new VDomRenderer for the status item.
*/
constructor(
- widget_manager: ILSPAdapterManager,
protected displayText: boolean = true,
+ shell: JupyterFrontEnd.IShell,
trans: TranslationBundle
) {
- super(new LSPStatus.Model(widget_manager, trans));
- this.addClass(interactiveItem);
+ super(new LSPStatus.Model(shell, trans));
+ this.addClass('jp-mod-highlighted');
this.addClass('lsp-statusbar-item');
this.trans = trans;
this.title.caption = this.trans.__('LSP status');
-
- // add human-readable (and stable) class name reflecting otherwise obfuscated typestyle interactiveItem
- this.interactiveStateObserver = new MutationObserver(() => {
- const has_selected = this.node.classList.contains(SELECTED_CLASS);
- if (!this.node.classList.contains(interactiveItem)) {
- if (!has_selected) {
- this.addClass(SELECTED_CLASS);
- }
- } else {
- if (has_selected) {
- this.removeClass(SELECTED_CLASS);
- }
- }
- });
- }
-
- protected onAfterAttach(msg: any) {
- super.onAfterAttach(msg);
- this.interactiveStateObserver.observe(this.node, {
- attributes: true,
- attributeFilter: ['class']
- });
- }
-
- protected onBeforeDetach(msg: any) {
- super.onBeforeDetach(msg);
- this.interactiveStateObserver.disconnect();
}
/**
@@ -454,7 +416,7 @@ export class LSPStatus extends VDomRenderer {
>
{this.displayText ? (
@@ -465,7 +427,6 @@ export class LSPStatus extends VDomRenderer {
) : (
<>
)}
-
);
}
@@ -484,7 +445,8 @@ export class LSPStatus extends VDomRenderer {
this._popup = showPopup({
body: new LSPPopup(this.model),
anchor: this,
- align: 'left'
+ align: 'left',
+ hasDynamicSize: true
});
}
};
@@ -495,10 +457,10 @@ export class StatusButtonExtension
{
constructor(
private options: {
- language_server_manager: LanguageServerManager;
- connection_manager: DocumentConnectionManager;
- adapter_manager: ILSPAdapterManager;
- translator_bundle: TranslationBundle;
+ languageServerManager: ILanguageServerManager;
+ connectionManager: ILSPDocumentConnectionManager;
+ shell: JupyterFrontEnd.IShell;
+ translatorBundle: TranslationBundle;
}
) {}
@@ -506,15 +468,15 @@ export class StatusButtonExtension
* For statusbar registration and for internal use.
*/
createItem(displayText: boolean = true): LSPStatus {
- const status_bar_item = new LSPStatus(
- this.options.adapter_manager,
+ const statusBarItem = new LSPStatus(
displayText,
- this.options.translator_bundle
+ this.options.shell,
+ this.options.translatorBundle
);
- status_bar_item.model.language_server_manager =
- this.options.language_server_manager;
- status_bar_item.model.connection_manager = this.options.connection_manager;
- return status_bar_item;
+ statusBarItem.model.language_server_manager =
+ this.options.languageServerManager;
+ statusBarItem.model.connection_manager = this.options.connectionManager;
+ return statusBarItem;
}
/**
@@ -543,13 +505,13 @@ type StatusCode =
export interface IStatus {
connected_documents: Set;
initialized_documents: Set;
- open_connections: Array;
+ open_connections: Array;
detected_documents: Set;
status: StatusCode;
}
-function collect_languages(virtual_document: VirtualDocument): Set {
- let documents = collect_documents(virtual_document);
+function collect_languages(virtualDocument: VirtualDocument): Set {
+ let documents = collectDocuments(virtualDocument);
return new Set(
[...documents].map(document => document.language.toLocaleLowerCase())
);
@@ -576,15 +538,6 @@ const iconByStatus: Record = {
connecting: codeClockIcon
};
-const shortMessageByStatus: StatusMap = {
- no_server_extension: 'Server extension missing',
- waiting: 'Waiting...',
- initialized: 'Fully initialized',
- initialized_but_some_missing: 'Initialized (additional servers needed)',
- initializing: 'Initializing...',
- connecting: 'Connecting...'
-};
-
export namespace LSPStatus {
/**
* A VDomModel for the LSP of current file editor/notebook.
@@ -593,22 +546,25 @@ export namespace LSPStatus {
server_extension_status: SCHEMA.ServersResponse | null = null;
language_server_manager: ILanguageServerManager;
trans: TranslationBundle;
- private _connection_manager: DocumentConnectionManager;
+ private _connection_manager: ILSPDocumentConnectionManager;
+ private _shortMessageByStatus: StatusMap;
constructor(
- widget_adapter_manager: ILSPAdapterManager,
+ private _shell: JupyterFrontEnd.IShell,
trans: TranslationBundle
) {
super();
this.trans = trans;
- widget_adapter_manager.adapterChanged.connect((manager, adapter) => {
- this.change_adapter(adapter);
- }, this);
- widget_adapter_manager.adapterDisposed.connect((manager, adapter) => {
- if (this.adapter === adapter) {
- this.change_adapter(null);
- }
- }, this);
+ this._shortMessageByStatus = {
+ no_server_extension: trans.__('Server extension missing'),
+ waiting: trans.__('Waiting…'),
+ initialized: trans.__('Fully initialized'),
+ initialized_but_some_missing: trans.__(
+ 'Initialized (additional servers needed)'
+ ),
+ initializing: trans.__('Initializing…'),
+ connecting: trans.__('Connecting…')
+ };
}
get available_servers(): TSessionMap {
@@ -650,17 +606,17 @@ export namespace LSPStatus {
SCHEMA.LanguageServerSession,
Map
>();
- if (!this.adapter?.virtual_editor) {
+ if (!this.adapter?.virtualDocument) {
return data;
}
- let main_document = this.adapter.virtual_editor.virtual_document;
- let documents = collect_documents(main_document);
+ let main_document = this.adapter.virtualDocument;
+ let documents = collectDocuments(main_document);
for (let document of documents.values()) {
let language = document.language.toLocaleLowerCase();
let server_ids =
- this._connection_manager.language_server_manager.getMatchingServers({
+ this._connection_manager.languageServerManager.getMatchingServers({
language: document.language
});
if (server_ids.length === 0) {
@@ -692,11 +648,11 @@ export namespace LSPStatus {
}
get detected_languages(): Set {
- if (!this.adapter?.virtual_editor) {
+ if (!this.adapter?.virtualDocument) {
return new Set();
}
- let document = this.adapter.virtual_editor.virtual_document;
+ let document = this.adapter.virtualDocument;
return collect_languages(document);
}
@@ -710,13 +666,13 @@ export namespace LSPStatus {
get status(): IStatus {
let detected_documents: Map;
- if (!this.adapter?.virtual_editor) {
+ if (!this.adapter?.virtualDocument) {
detected_documents = new Map();
} else {
- let main_document = this.adapter.virtual_editor.virtual_document;
+ let main_document = this.adapter.virtualDocument;
const all_documents = this._connection_manager.documents;
// detected documents that are open in the current virtual editor
- const detected_documents_set = collect_documents(main_document);
+ const detected_documents_set = collectDocuments(main_document);
detected_documents = new Map(
[...all_documents].filter(([id, doc]) =>
detected_documents_set.has(doc)
@@ -735,7 +691,7 @@ export namespace LSPStatus {
detected_documents.forEach((document, uri) => {
let connection = this._connection_manager.connections.get(uri);
let server_ids =
- this._connection_manager.language_server_manager.getMatchingServers({
+ this._connection_manager.languageServerManager.getMatchingServers({
language: document.language
});
@@ -759,7 +715,7 @@ export namespace LSPStatus {
// there may be more open connections than documents if a document was recently closed
// and the grace period has not passed yet
- let open_connections = new Array();
+ let open_connections = new Array();
this._connection_manager.connections.forEach((connection, path) => {
if (connection.isConnected) {
open_connections.push(connection);
@@ -806,13 +762,9 @@ export namespace LSPStatus {
get short_message(): string {
if (!this.adapter) {
- return this.trans.__('not initialized');
+ return this.trans.__('Not initialized');
}
- return this.trans.__(shortMessageByStatus[this.status.status]);
- }
-
- get feature_message(): string {
- return this.adapter?.status_message?.message || '';
+ return this._shortMessageByStatus[this.status.status];
}
get long_message(): string {
@@ -845,7 +797,7 @@ export namespace LSPStatus {
status.detected_documents.size,
uninitialized.size,
status.detected_documents.size,
- [...uninitialized].map(document => document.id_path).join(', ')
+ [...uninitialized].map(document => document.idPath).join(', ')
);
} else {
const unconnected = new Set(status.detected_documents);
@@ -861,26 +813,17 @@ export namespace LSPStatus {
status.connected_documents.size,
status.detected_documents.size,
status.open_connections.length,
- [...unconnected].map(document => document.id_path).join(', ')
+ [...unconnected].map(document => document.idPath).join(', ')
);
}
return msg;
}
- get adapter(): WidgetAdapter | null {
- return this._adapter;
- }
-
- change_adapter(adapter: WidgetAdapter | null) {
- if (this._adapter != null) {
- this._adapter.status_message.changed.disconnect(this._onChange);
- }
-
- if (adapter != null) {
- adapter.status_message.changed.connect(this._onChange);
- }
-
- this._adapter = adapter;
+ get adapter(): WidgetLSPAdapter | null {
+ const adapter = [...this.connection_manager.adapters.values()].find(
+ adapter => adapter.widget == this._shell.currentWidget
+ );
+ return adapter ?? null;
}
get connection_manager() {
@@ -896,7 +839,7 @@ export namespace LSPStatus {
this._connection_manager.initialized.connect(this._onChange);
this._connection_manager.disconnected.disconnect(this._onChange);
this._connection_manager.closed.disconnect(this._onChange);
- this._connection_manager.documents_changed.disconnect(this._onChange);
+ this._connection_manager.documentsChanged.disconnect(this._onChange);
}
if (connection_manager != null) {
@@ -904,7 +847,7 @@ export namespace LSPStatus {
connection_manager.initialized.connect(this._onChange);
connection_manager.disconnected.connect(this._onChange);
connection_manager.closed.connect(this._onChange);
- connection_manager.documents_changed.connect(this._onChange);
+ connection_manager.documentsChanged.connect(this._onChange);
}
this._connection_manager = connection_manager;
@@ -913,7 +856,5 @@ export namespace LSPStatus {
private _onChange = () => {
this.stateChanged.emit(void 0);
};
-
- private _adapter: WidgetAdapter | null = null;
}
}
diff --git a/packages/jupyterlab-lsp/src/components/utils.spec.ts b/packages/jupyterlab-lsp/src/components/utils.spec.ts
index bb6212f78..78efe7865 100644
--- a/packages/jupyterlab-lsp/src/components/utils.spec.ts
+++ b/packages/jupyterlab-lsp/src/components/utils.spec.ts
@@ -1,8 +1,7 @@
import { IDocumentWidget } from '@jupyterlab/docregistry';
+import { CodeExtractorsManager, WidgetLSPAdapter } from '@jupyterlab/lsp';
import { nullTranslator } from '@jupyterlab/translation';
-import { WidgetAdapter } from '../adapters/adapter';
-import { BrowserConsole } from '../virtual/console';
import { VirtualDocument } from '../virtual/document';
import { getBreadcrumbs } from './utils';
@@ -10,12 +9,11 @@ import { getBreadcrumbs } from './utils';
function create_dummy_document(options: Partial) {
return new VirtualDocument({
language: 'python',
- foreign_code_extractors: {},
- overrides_registry: {},
+ overridesRegistry: {},
+ foreignCodeExtractors: new CodeExtractorsManager(),
path: 'Untitled.ipynb.py',
- file_extension: 'py',
- has_lsp_supported_file: false,
- console: new BrowserConsole(),
+ fileExtension: 'py',
+ hasLspSupportedFile: false,
...options
});
}
@@ -29,8 +27,8 @@ describe('getBreadcrumbs', () => {
let breadcrumbs = getBreadcrumbs(
document,
{
- has_multiple_editors: false
- } as WidgetAdapter,
+ hasMultipleEditors: false
+ } as WidgetLSPAdapter,
trans
);
expect(breadcrumbs[0].props['title']).toBe('dir1/dir2/Test.ipynb');
@@ -40,14 +38,14 @@ describe('getBreadcrumbs', () => {
it('should trim the extra filename suffix for files created out of notebooks', () => {
let document = create_dummy_document({
path: 'Test.ipynb.py',
- file_extension: 'py',
- has_lsp_supported_file: false
+ fileExtension: 'py',
+ hasLspSupportedFile: false
});
let breadcrumbs = getBreadcrumbs(
document,
{
- has_multiple_editors: false
- } as WidgetAdapter,
+ hasMultipleEditors: false
+ } as WidgetLSPAdapter,
trans
);
expect(breadcrumbs[0].props['children']).toBe('Test.ipynb');
@@ -56,14 +54,14 @@ describe('getBreadcrumbs', () => {
it('should not trim the filename suffix for standalone files', () => {
let document = create_dummy_document({
path: 'test.py',
- file_extension: 'py',
- has_lsp_supported_file: true
+ fileExtension: 'py',
+ hasLspSupportedFile: true
});
let breadcrumbs = getBreadcrumbs(
document,
{
- has_multiple_editors: false
- } as WidgetAdapter,
+ hasMultipleEditors: false
+ } as WidgetLSPAdapter,
trans
);
expect(breadcrumbs[0].props['children']).toBe('test.py');
diff --git a/packages/jupyterlab-lsp/src/components/utils.tsx b/packages/jupyterlab-lsp/src/components/utils.tsx
index cb6d8cdd7..8532c348e 100644
--- a/packages/jupyterlab-lsp/src/components/utils.tsx
+++ b/packages/jupyterlab-lsp/src/components/utils.tsx
@@ -1,14 +1,13 @@
import { IDocumentWidget } from '@jupyterlab/docregistry';
+import { VirtualDocument, WidgetLSPAdapter, Document } from '@jupyterlab/lsp';
import { nullTranslator, TranslationBundle } from '@jupyterlab/translation';
import React from 'react';
-import { WidgetAdapter } from '../adapters/adapter';
import { TLanguageServerSpec } from '../tokens';
-import { VirtualDocument } from '../virtual/document';
export function getBreadcrumbs(
document: VirtualDocument,
- adapter: WidgetAdapter,
+ adapter: WidgetLSPAdapter,
trans?: TranslationBundle,
collapse = true
): JSX.Element[] {
@@ -19,11 +18,11 @@ export function getBreadcrumbs(
if (!document.parent) {
let path = document.path;
if (
- !document.has_lsp_supported_file &&
- document.file_extension &&
- path.endsWith(document.file_extension)
+ !document.hasLspSupportedFile &&
+ document.fileExtension &&
+ path.endsWith(document.fileExtension)
) {
- path = path.slice(0, -document.file_extension.length - 1);
+ path = path.slice(0, -document.fileExtension.length - 1);
}
const full_path = path;
if (collapse) {
@@ -38,18 +37,20 @@ export function getBreadcrumbs(
);
}
- if (!document.virtual_lines.size) {
+ // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+ // @ts-ignore
+ const virtualLines = document.virtualLines;
+
+ if (!virtualLines.size) {
return Empty document;
}
try {
- if (adapter.has_multiple_editors) {
- let first_line = document.virtual_lines.get(0)!;
- let last_line = document.virtual_lines.get(
- document.last_virtual_line - 1
- )!;
+ if (adapter.hasMultipleEditors) {
+ let first_line = virtualLines.get(0)!;
+ let last_line = virtualLines.get(document.lastVirtualLine - 1)!;
- let first_cell = adapter.get_editor_index(first_line.editor);
- let last_cell = adapter.get_editor_index(last_line.editor);
+ let first_cell = adapter.getEditorIndex(first_line.editor);
+ let last_cell = adapter.getEditorIndex(last_line.editor);
let cell_locator =
first_cell === last_cell
@@ -69,36 +70,28 @@ export function getBreadcrumbs(
});
}
-/**
- * @deprecated please use getBreadcrumbs instead; `get_breadcrumbs` will be removed in 4.0
- */
-export function get_breadcrumbs(
- document: VirtualDocument,
- adapter: WidgetAdapter,
- collapse = true
-) {
- return getBreadcrumbs(document, adapter, undefined, collapse);
-}
-
-export function focus_on(node: HTMLElement) {
- if (!node) {
+async function focusEditor(accessor: Document.IEditor) {
+ if (!accessor) {
return;
}
- node.scrollIntoView();
- node.focus();
+ await accessor.reveal();
+ const editor = accessor.getEditor();
+ editor!.focus();
}
export function DocumentLocator(props: {
document: VirtualDocument;
- adapter: WidgetAdapter;
+ adapter: WidgetLSPAdapter;
trans?: TranslationBundle;
}) {
let { document, adapter } = props;
- let target: HTMLElement | null = null;
- if (adapter.has_multiple_editors) {
- let first_line = document.virtual_lines.get(0);
+ let target: Document.IEditor | null = null;
+ if (adapter.hasMultipleEditors) {
+ // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+ // @ts-ignore
+ let first_line = document.virtualLines.get(0);
if (first_line) {
- target = adapter.get_editor_wrapper(first_line.editor);
+ target = first_line.editor;
} else {
console.warn('Could not get first line of ', document);
}
@@ -107,7 +100,7 @@ export function DocumentLocator(props: {
return (
(target ? focus_on(target) : null)}
+ onClick={() => (target ? focusEditor(target) : null)}
>
{breadcrumbs}
diff --git a/packages/jupyterlab-lsp/src/connection.ts b/packages/jupyterlab-lsp/src/connection.ts
deleted file mode 100644
index 0326dccbf..000000000
--- a/packages/jupyterlab-lsp/src/connection.ts
+++ /dev/null
@@ -1,647 +0,0 @@
-// Disclaimer/acknowledgement: Fragments are based on LspWsConnection, which is copyright of wylieconlon and contributors and ISC licenced.
-// ISC licence is, quote, "functionally equivalent to the simplified BSD and MIT licenses,
-// but without language deemed unnecessary following the Berne Convention." (Wikipedia).
-// Introduced modifications are BSD licenced, copyright JupyterLab development team.
-import { ISignal, Signal } from '@lumino/signaling';
-import {
- AnyCompletion,
- AnyLocation,
- IDocumentInfo,
- ILspOptions,
- IPosition,
- LspWsConnection
-} from 'lsp-ws-connection';
-import {
- registerServerCapability,
- unregisterServerCapability
-} from 'lsp-ws-connection/lib/server-capability-registration';
-import type * as rpc from 'vscode-jsonrpc';
-import type * as lsp from 'vscode-languageserver-protocol';
-import type { MessageConnection } from 'vscode-ws-jsonrpc';
-
-import { ClientCapabilities } from './lsp';
-import { ILSPLogConsole } from './tokens';
-import { until_ready } from './utils';
-
-interface ILSPOptions extends ILspOptions {
- capabilities: ClientCapabilities;
- serverIdentifier?: string;
- console: ILSPLogConsole;
-}
-
-/**
- * Method strings are reproduced here because a non-typing import of
- * `vscode-languageserver-protocol` is ridiculously expensive.
- */
-export namespace Method {
- /** Server notifications */
- export enum ServerNotification {
- PUBLISH_DIAGNOSTICS = 'textDocument/publishDiagnostics',
- SHOW_MESSAGE = 'window/showMessage',
- LOG_TRACE = '$/logTrace',
- LOG_MESSAGE = 'window/logMessage'
- }
-
- /** Client notifications */
- export enum ClientNotification {
- DID_CHANGE = 'textDocument/didChange',
- DID_CHANGE_CONFIGURATION = 'workspace/didChangeConfiguration',
- DID_OPEN = 'textDocument/didOpen',
- DID_SAVE = 'textDocument/didSave',
- INITIALIZED = 'initialized',
- SET_TRACE = '$/setTrace'
- }
-
- /** Server requests */
- export enum ServerRequest {
- REGISTER_CAPABILITY = 'client/registerCapability',
- SHOW_MESSAGE_REQUEST = 'window/showMessageRequest',
- UNREGISTER_CAPABILITY = 'client/unregisterCapability',
- WORKSPACE_CONFIGURATION = 'workspace/configuration'
- }
-
- /** Client requests */
- export enum ClientRequest {
- COMPLETION = 'textDocument/completion',
- COMPLETION_ITEM_RESOLVE = 'completionItem/resolve',
- DEFINITION = 'textDocument/definition',
- DOCUMENT_HIGHLIGHT = 'textDocument/documentHighlight',
- DOCUMENT_SYMBOL = 'textDocument/documentSymbol',
- HOVER = 'textDocument/hover',
- IMPLEMENTATION = 'textDocument/implementation',
- INITIALIZE = 'initialize',
- REFERENCES = 'textDocument/references',
- RENAME = 'textDocument/rename',
- SIGNATURE_HELP = 'textDocument/signatureHelp',
- TYPE_DEFINITION = 'textDocument/typeDefinition'
- }
-}
-
-export interface IServerNotifyParams {
- [Method.ServerNotification.LOG_MESSAGE]: lsp.LogMessageParams;
- [Method.ServerNotification.LOG_TRACE]: rpc.LogTraceParams;
- [Method.ServerNotification.PUBLISH_DIAGNOSTICS]: lsp.PublishDiagnosticsParams;
- [Method.ServerNotification.SHOW_MESSAGE]: lsp.ShowMessageParams;
-}
-
-export interface IClientNotifyParams {
- [Method.ClientNotification
- .DID_CHANGE_CONFIGURATION]: lsp.DidChangeConfigurationParams;
- [Method.ClientNotification.DID_CHANGE]: lsp.DidChangeTextDocumentParams;
- [Method.ClientNotification.DID_OPEN]: lsp.DidOpenTextDocumentParams;
- [Method.ClientNotification.DID_SAVE]: lsp.DidSaveTextDocumentParams;
- [Method.ClientNotification.INITIALIZED]: lsp.InitializedParams;
- [Method.ClientNotification.SET_TRACE]: rpc.SetTraceParams;
-}
-
-export interface IServerRequestParams {
- [Method.ServerRequest.REGISTER_CAPABILITY]: lsp.RegistrationParams;
- [Method.ServerRequest.SHOW_MESSAGE_REQUEST]: lsp.ShowMessageRequestParams;
- [Method.ServerRequest.UNREGISTER_CAPABILITY]: lsp.UnregistrationParams;
- [Method.ServerRequest.WORKSPACE_CONFIGURATION]: lsp.ConfigurationParams;
-}
-
-export interface IServerResult {
- [Method.ServerRequest.REGISTER_CAPABILITY]: void;
- [Method.ServerRequest.SHOW_MESSAGE_REQUEST]: lsp.MessageActionItem | null;
- [Method.ServerRequest.UNREGISTER_CAPABILITY]: void;
- [Method.ServerRequest.WORKSPACE_CONFIGURATION]: any[];
-}
-
-export interface IClientRequestParams {
- [Method.ClientRequest.COMPLETION_ITEM_RESOLVE]: lsp.CompletionItem;
- [Method.ClientRequest.COMPLETION]: lsp.CompletionParams;
- [Method.ClientRequest.DEFINITION]: lsp.TextDocumentPositionParams;
- [Method.ClientRequest.DOCUMENT_HIGHLIGHT]: lsp.TextDocumentPositionParams;
- [Method.ClientRequest.DOCUMENT_SYMBOL]: lsp.DocumentSymbolParams;
- [Method.ClientRequest.HOVER]: lsp.TextDocumentPositionParams;
- [Method.ClientRequest.IMPLEMENTATION]: lsp.TextDocumentPositionParams;
- [Method.ClientRequest.INITIALIZE]: lsp.InitializeParams;
- [Method.ClientRequest.REFERENCES]: lsp.ReferenceParams;
- [Method.ClientRequest.RENAME]: lsp.RenameParams;
- [Method.ClientRequest.SIGNATURE_HELP]: lsp.TextDocumentPositionParams;
- [Method.ClientRequest.TYPE_DEFINITION]: lsp.TextDocumentPositionParams;
-}
-
-export interface IClientResult {
- [Method.ClientRequest.COMPLETION_ITEM_RESOLVE]: lsp.CompletionItem;
- [Method.ClientRequest.COMPLETION]: AnyCompletion;
- [Method.ClientRequest.DEFINITION]: AnyLocation;
- [Method.ClientRequest.DOCUMENT_HIGHLIGHT]: lsp.DocumentHighlight[];
- [Method.ClientRequest.DOCUMENT_SYMBOL]: lsp.DocumentSymbol[];
- [Method.ClientRequest.HOVER]: lsp.Hover | null;
- [Method.ClientRequest.IMPLEMENTATION]: AnyLocation;
- [Method.ClientRequest.INITIALIZE]: lsp.InitializeResult;
- [Method.ClientRequest.REFERENCES]: lsp.Location[] | null;
- [Method.ClientRequest.RENAME]: lsp.WorkspaceEdit;
- [Method.ClientRequest.SIGNATURE_HELP]: lsp.SignatureHelp;
- [Method.ClientRequest.TYPE_DEFINITION]: AnyLocation;
-}
-
-export type ServerNotifications<
- T extends keyof IServerNotifyParams = keyof IServerNotifyParams
-> = {
- readonly // ISignal does not have emit, which is intended - client cannot emit server notifications.
- [key in T]: ISignal;
-};
-
-export type ClientNotifications<
- T extends keyof IClientNotifyParams = keyof IClientNotifyParams
-> = {
- readonly // Signal has emit.
- [key in T]: Signal;
-};
-
-export interface IClientRequestHandler<
- T extends keyof IClientRequestParams = keyof IClientRequestParams
-> {
- request(params: IClientRequestParams[T]): Promise;
-}
-
-export interface IServerRequestHandler<
- T extends keyof IServerRequestParams = keyof IServerRequestParams
-> {
- setHandler(
- handler: (
- params: IServerRequestParams[T],
- connection?: LSPConnection
- ) => Promise
- ): void;
- clearHandler(): void;
-}
-
-export type ClientRequests<
- T extends keyof IClientRequestParams = keyof IClientRequestParams
-> = {
- readonly // has async request(params) returning a promise with result.
- [key in T]: IClientRequestHandler;
-};
-
-export type ServerRequests<
- T extends keyof IServerRequestParams = keyof IServerRequestParams
-> = {
- readonly // has async request(params) returning a promise with result.
- [key in T]: IServerRequestHandler;
-};
-
-class ClientRequestHandler<
- T extends keyof IClientRequestParams = keyof IClientRequestParams
-> implements IClientRequestHandler
-{
- constructor(
- protected connection: MessageConnection,
- protected method: T,
- protected emitter: LSPConnection
- ) {}
- request(params: IClientRequestParams[T]): Promise {
- // TODO check if is ready?
- this.emitter.log(MessageKind.client_requested, {
- method: this.method,
- message: params
- });
- return this.connection
- .sendRequest(this.method, params)
- .then((result: IClientResult[T]) => {
- this.emitter.log(MessageKind.result_for_client, {
- method: this.method,
- message: params
- });
- return result;
- });
- }
-}
-
-class ServerRequestHandler<
- T extends keyof IServerRequestParams = keyof IServerRequestParams
-> implements IServerRequestHandler
-{
- private _handler:
- | ((
- params: IServerRequestParams[T],
- connection?: LSPConnection
- ) => Promise)
- | null;
-
- constructor(
- protected connection: MessageConnection,
- protected method: T,
- protected emitter: LSPConnection
- ) {
- // on request accepts "thenable"
- this.connection.onRequest(method, this.handle.bind(this));
- this._handler = null;
- }
-
- private handle(
- request: IServerRequestParams[T]
- ): Promise {
- this.emitter.log(MessageKind.server_requested, {
- method: this.method,
- message: request
- });
- if (!this._handler) {
- return new Promise(() => undefined);
- }
- return this._handler(request, this.emitter).then(result => {
- this.emitter.log(MessageKind.response_for_server, {
- method: this.method,
- message: result
- });
- return result;
- });
- }
-
- setHandler(
- handler: (
- params: IServerRequestParams[T],
- connection?: LSPConnection
- ) => Promise
- ) {
- this._handler = handler;
- }
-
- clearHandler() {
- this._handler = null;
- }
-}
-
-export const Provider: { [key: string]: keyof lsp.ServerCapabilities } = {
- TEXT_DOCUMENT_SYNC: 'textDocumentSync',
- COMPLETION: 'completionProvider',
- HOVER: 'hoverProvider',
- SIGNATURE_HELP: 'signatureHelpProvider',
- DECLARATION: 'declarationProvider',
- DEFINITION: 'definitionProvider',
- TYPE_DEFINITION: 'typeDefinitionProvider',
- IMPLEMENTATION: 'implementationProvider',
- REFERENCES: 'referencesProvider',
- DOCUMENT_HIGHLIGHT: 'documentHighlightProvider',
- DOCUMENT_SYMBOL: 'documentSymbolProvider',
- CODE_ACTION: 'codeActionProvider',
- CODE_LENS: 'codeLensProvider',
- DOCUMENT_LINK: 'documentLinkProvider',
- COLOR: 'colorProvider',
- DOCUMENT_FORMATTING: 'documentFormattingProvider',
- DOCUMENT_RANGE_FORMATTING: 'documentRangeFormattingProvider',
- DOCUMENT_ON_TYPE_FORMATTING: 'documentOnTypeFormattingProvider',
- RENAME: 'renameProvider',
- FOLDING_RANGE: 'foldingRangeProvider',
- EXECUTE_COMMAND: 'executeCommandProvider',
- SELECTION_RANGE: 'selectionRangeProvider',
- WORKSPACE_SYMBOL: 'workspaceSymbolProvider',
- WORKSPACE: 'workspace'
-};
-
-type AnyMethodType =
- | typeof Method.ServerNotification
- | typeof Method.ClientNotification
- | typeof Method.ClientRequest
- | typeof Method.ServerRequest;
-type AnyMethod =
- | Method.ServerNotification
- | Method.ClientNotification
- | Method.ClientRequest
- | Method.ServerRequest;
-
-function createMethodMap(
- methods: AnyMethodType,
- handlerFactory: (method: U) => H
-) {
- const result: { [key in U]?: H } = {};
- for (let method of Object.values(methods)) {
- result[method as U] = handlerFactory(method as U);
- }
- return result as T;
-}
-
-enum MessageKind {
- client_notified_server,
- server_notified_client,
- server_requested,
- client_requested,
- result_for_client,
- response_for_server
-}
-
-interface IMessageLog {
- method: T;
- message: any;
-}
-
-export class LSPConnection extends LspWsConnection {
- protected documentsToOpen: IDocumentInfo[];
- public serverIdentifier?: string;
-
- public clientNotifications: ClientNotifications;
- public serverNotifications: ServerNotifications;
- public clientRequests: ClientRequests;
- public serverRequests: ServerRequests;
- protected console: ILSPLogConsole;
- private _options: ILSPOptions;
- public logAllCommunication: boolean;
-
- public log(kind: MessageKind, message: IMessageLog) {
- if (this.logAllCommunication) {
- this.console.log(kind, message);
- }
- }
-
- protected constructNotificationHandlers<
- T extends ServerNotifications | ClientNotifications
- >(
- methods: typeof Method.ServerNotification | typeof Method.ClientNotification
- ) {
- return createMethodMap>(
- methods,
- () => new Signal(this)
- );
- }
-
- protected constructClientRequestHandler<
- T extends ClientRequests,
- U extends keyof T = keyof T
- >(methods: typeof Method.ClientRequest) {
- return createMethodMap(
- methods,
- method =>
- new ClientRequestHandler(this.connection, method as U as any, this)
- );
- }
-
- protected constructServerRequestHandler<
- T extends ServerRequests,
- U extends keyof T = keyof T
- >(methods: typeof Method.ServerRequest) {
- return createMethodMap(
- methods,
- method =>
- new ServerRequestHandler(this.connection, method as U as any, this)
- );
- }
-
- constructor(options: ILSPOptions) {
- super(options);
- this._options = options;
- this.logAllCommunication = false;
- this.serverIdentifier = options.serverIdentifier;
- this.console = options.console.scope(this.serverIdentifier + ' connection');
- this.documentsToOpen = [];
- this.clientNotifications =
- this.constructNotificationHandlers(
- Method.ClientNotification
- );
- this.serverNotifications =
- this.constructNotificationHandlers(
- Method.ServerNotification
- );
- }
-
- /**
- * Initialization parameters to be sent to the language server.
- * Subclasses can overload this when adding more features.
- */
- protected initializeParams(): lsp.InitializeParams {
- return {
- ...super.initializeParams(),
- // TODO: remove as `lsp.ClientCapabilities` after upgrading to 3.17
- // which should finally include a fix for moniker issue:
- // https://github.com/microsoft/vscode-languageserver-node/pull/720
- capabilities: this._options.capabilities as lsp.ClientCapabilities,
- initializationOptions: null,
- processId: null,
- workspaceFolders: null
- };
- }
-
- sendOpenWhenReady(documentInfo: IDocumentInfo) {
- if (this.isReady) {
- this.sendOpen(documentInfo);
- } else {
- this.documentsToOpen.push(documentInfo);
- }
- }
-
- protected onServerInitialized(params: lsp.InitializeResult) {
- this.afterInitialized();
- super.onServerInitialized(params);
- while (this.documentsToOpen.length) {
- this.sendOpen(this.documentsToOpen.pop()!);
- }
- }
-
- protected afterInitialized() {
- for (const method of Object.values(
- Method.ServerNotification
- ) as (keyof ServerNotifications)[]) {
- const signal = this.serverNotifications[method] as Signal;
- this.connection.onNotification(method, params => {
- this.log(MessageKind.server_notified_client, {
- method,
- message: params
- });
- signal.emit(params);
- });
- }
-
- for (const method of Object.values(
- Method.ClientNotification
- ) as (keyof ClientNotifications)[]) {
- const signal = this.clientNotifications[method] as Signal;
- signal.connect((emitter, params) => {
- this.log(MessageKind.client_notified_server, {
- method,
- message: params
- });
- void this.connection.sendNotification(method, params);
- });
- }
-
- this.clientRequests = this.constructClientRequestHandler(
- Method.ClientRequest
- );
- this.serverRequests = this.constructServerRequestHandler(
- Method.ServerRequest
- );
-
- this.serverRequests['client/registerCapability'].setHandler(
- async (params: lsp.RegistrationParams) => {
- params.registrations.forEach(
- (capabilityRegistration: lsp.Registration) => {
- try {
- const updatedCapabilities = registerServerCapability(
- this.serverCapabilities,
- capabilityRegistration
- );
- if (updatedCapabilities === null) {
- this.console.error(
- `Failed to register server capability: ${capabilityRegistration}`
- );
- return;
- }
- this.serverCapabilities = updatedCapabilities;
- } catch (err) {
- this.console.error(err);
- }
- }
- );
- }
- );
-
- this.serverRequests['client/unregisterCapability'].setHandler(
- async (params: lsp.UnregistrationParams) => {
- params.unregisterations.forEach(
- (capabilityUnregistration: lsp.Unregistration) => {
- this.serverCapabilities = unregisterServerCapability(
- this.serverCapabilities,
- capabilityUnregistration
- );
- }
- );
- }
- );
-
- this.serverRequests['workspace/configuration'].setHandler(async params => {
- return params.items.map(item => {
- // LSP: "If the client can’t provide a configuration setting for a given scope
- // then `null` needs to be present in the returned array."
-
- // for now we do not support configuration, but yaml server does not respect
- // client capability so we have a handler just for that
- return null;
- });
- });
- }
-
- public sendSelectiveChange(
- changeEvent: lsp.TextDocumentContentChangeEvent,
- documentInfo: IDocumentInfo
- ) {
- this._sendChange([changeEvent], documentInfo);
- }
-
- public sendFullTextChange(text: string, documentInfo: IDocumentInfo): void {
- this._sendChange([{ text }], documentInfo);
- }
-
- /**
- * @deprecated The method should not be used in new code. Use provides() instead.
- */
- public isRenameSupported() {
- return !!(
- this.serverCapabilities && this.serverCapabilities.renameProvider
- );
- }
-
- provides(provider: keyof lsp.ServerCapabilities): boolean {
- return !!(this.serverCapabilities && this.serverCapabilities[provider]);
- }
-
- /**
- * @deprecated The method should not be used in new code
- */
- async rename(
- location: IPosition,
- documentInfo: IDocumentInfo,
- newName: string,
- emit = true
- ): Promise {
- if (!this.isReady || !this.isRenameSupported()) {
- return null;
- }
-
- const params: lsp.RenameParams = {
- textDocument: {
- uri: documentInfo.uri
- },
- position: {
- line: location.line,
- character: location.ch
- },
- newName
- };
-
- const edit: lsp.WorkspaceEdit = await this.connection.sendRequest(
- 'textDocument/rename',
- params
- );
-
- if (emit) {
- this.emit('renamed', edit);
- }
-
- return edit;
- }
-
- public connect(socket: WebSocket): this {
- super.connect(socket);
-
- until_ready(() => {
- return this.isConnected;
- }, -1)
- .then(() => {
- this.connection.onClose(() => {
- this.isConnected = false;
- this.emit('close', this.closing_manually);
- });
- })
- .catch(() => {
- console.error('Could not connect onClose signal');
- });
- return this;
- }
-
- private closing_manually = false;
-
- public close() {
- try {
- this.closing_manually = true;
- super.close();
- } catch (e) {
- this.closing_manually = false;
- }
- }
-
- private _sendChange(
- changeEvents: lsp.TextDocumentContentChangeEvent[],
- documentInfo: IDocumentInfo
- ) {
- if (!this.isReady) {
- return;
- }
- if (!this.openedUris.get(documentInfo.uri)) {
- this.sendOpen(documentInfo);
- }
- const textDocumentChange: lsp.DidChangeTextDocumentParams = {
- textDocument: {
- uri: documentInfo.uri,
- version: documentInfo.version
- } as lsp.VersionedTextDocumentIdentifier,
- contentChanges: changeEvents
- };
- void this.connection.sendNotification(
- 'textDocument/didChange',
- textDocumentChange
- );
- documentInfo.version++;
- }
-
- async getCompletionResolve(completionItem: lsp.CompletionItem) {
- if (!this.isReady || !this.isCompletionResolveProvider()) {
- return;
- }
- return this.connection.sendRequest(
- 'completionItem/resolve',
- completionItem
- );
- }
-
- /**
- * Does support completionItem/resolve?
- * @deprecated The method should not be used in new code
- */
- public isCompletionResolveProvider(): boolean {
- return (
- this.serverCapabilities?.completionProvider?.resolveProvider || false
- );
- }
-}
diff --git a/packages/jupyterlab-lsp/src/connection_manager.ts b/packages/jupyterlab-lsp/src/connection_manager.ts
deleted file mode 100644
index 2399a5bc0..000000000
--- a/packages/jupyterlab-lsp/src/connection_manager.ts
+++ /dev/null
@@ -1,536 +0,0 @@
-import { PageConfig, URLExt } from '@jupyterlab/coreutils';
-import { Signal } from '@lumino/signaling';
-import type * as protocol from 'vscode-languageserver-protocol';
-
-import { AskServersToSendTraceNotifications } from './_plugin';
-import type * as ConnectionModuleType from './connection';
-import { ClientCapabilities } from './lsp';
-import {
- ILSPLogConsole,
- ILanguageServerManager,
- TLanguageServerConfigurations,
- TLanguageServerId,
- TServerKeys
-} from './tokens';
-import { expandDottedPaths, sleep, until_ready } from './utils';
-import { IForeignContext, VirtualDocument } from './virtual/document';
-
-export interface IDocumentConnectionData {
- virtual_document: VirtualDocument;
- connection: ConnectionModuleType.LSPConnection;
-}
-
-export interface ISocketConnectionOptions {
- virtual_document: VirtualDocument;
- /**
- * The language identifier, corresponding to the API endpoint on the LSP proxy server.
- */
- language: string;
- /**
- * Path to the document in the JupyterLab space
- */
- document_path: string;
- /**
- * LSP capabilities describing currently supported features
- */
- capabilities: ClientCapabilities;
-}
-
-/**
- * Each Widget with a document (whether file or a notebook) has the same DocumentConnectionManager
- * (see JupyterLabWidgetAdapter). Using id_path instead of uri led to documents being overwritten
- * as two identical id_paths could be created for two different notebooks.
- */
-export class DocumentConnectionManager {
- connections: Map;
- documents: Map;
- initialized: Signal;
- connected: Signal;
- /**
- * Connection temporarily lost or could not be fully established; a re-connection will be attempted;
- */
- disconnected: Signal;
- /**
- * Connection was closed permanently and no-reconnection will be attempted, e.g.:
- * - there was a serious server error
- * - user closed the connection,
- * - re-connection attempts exceeded,
- */
- closed: Signal;
- documents_changed: Signal<
- DocumentConnectionManager,
- Map
- >;
- language_server_manager: ILanguageServerManager;
- initial_configurations: TLanguageServerConfigurations;
- private ignored_languages: Set;
- private readonly console: ILSPLogConsole;
-
- constructor(options: DocumentConnectionManager.IOptions) {
- this.connections = new Map();
- this.documents = new Map();
- this.ignored_languages = new Set();
- this.connected = new Signal(this);
- this.initialized = new Signal(this);
- this.disconnected = new Signal(this);
- this.closed = new Signal(this);
- this.documents_changed = new Signal(this);
- this.language_server_manager = options.language_server_manager;
- this.console = options.console;
- Private.setLanguageServerManager(options.language_server_manager);
- }
-
- connect_document_signals(virtual_document: VirtualDocument) {
- virtual_document.foreign_document_opened.connect(
- this.on_foreign_document_opened,
- this
- );
-
- virtual_document.foreign_document_closed.connect(
- this.on_foreign_document_closed,
- this
- );
-
- this.documents.set(virtual_document.uri, virtual_document);
- this.documents_changed.emit(this.documents);
- }
-
- disconnect_document_signals(virtual_document: VirtualDocument, emit = true) {
- virtual_document.foreign_document_opened.disconnect(
- this.on_foreign_document_opened,
- this
- );
-
- virtual_document.foreign_document_closed.disconnect(
- this.on_foreign_document_closed,
- this
- );
-
- this.documents.delete(virtual_document.uri);
- for (const foreign of virtual_document.foreign_documents.values()) {
- this.disconnect_document_signals(foreign, false);
- }
-
- if (emit) {
- this.documents_changed.emit(this.documents);
- }
- }
-
- on_foreign_document_opened(_host: VirtualDocument, context: IForeignContext) {
- this.console.log(
- 'ConnectionManager received foreign document: ',
- context.foreign_document.uri
- );
- }
-
- on_foreign_document_closed(_host: VirtualDocument, context: IForeignContext) {
- const { foreign_document } = context;
- this.disconnect_document_signals(foreign_document);
- }
-
- private async connect_socket(
- options: ISocketConnectionOptions
- ): Promise {
- this.console.log('Connection Socket', options);
- let { virtual_document, language, capabilities } = options;
-
- this.connect_document_signals(virtual_document);
-
- const uris = DocumentConnectionManager.solve_uris(
- virtual_document,
- language
- );
-
- const matchingServers = this.language_server_manager.getMatchingServers({
- language
- });
- this.console.debug('Matching servers: ', matchingServers);
-
- // for now use only the server with the highest priority.
- const language_server_id =
- matchingServers.length === 0 ? null : matchingServers[0];
-
- // lazily load 1) the underlying library (1.5mb) and/or 2) a live WebSocket-
- // like connection: either already connected or potentially in the process
- // of connecting.
- const connection = await Private.connection(
- language,
- language_server_id!,
- uris,
- this.on_new_connection,
- this.console,
- capabilities
- );
-
- // if connecting for the first time, all documents subsequent documents will
- // be re-opened and synced
- this.connections.set(virtual_document.uri, connection);
-
- return connection;
- }
-
- /**
- * Handles the settings that do not require an existing connection
- * with a language server (or can influence to which server the
- * connection will be created, e.g. `priority`).
- *
- * This function should be called **before** initialization of servers.
- */
- public updateConfiguration(allServerSettings: TLanguageServerConfigurations) {
- this.language_server_manager.setConfiguration(allServerSettings);
- }
-
- /**
- * Handles the settings that the language servers accept using
- * `onDidChangeConfiguration` messages, which should be passed under
- * the "serverSettings" keyword in the setting registry.
- * Other configuration options are handled by `updateConfiguration` instead.
- *
- * This function should be called **after** initialization of servers.
- */
- public updateServerConfigurations(
- allServerSettings: TLanguageServerConfigurations
- ) {
- let language_server_id: TServerKeys;
-
- for (language_server_id in allServerSettings) {
- if (!allServerSettings.hasOwnProperty(language_server_id)) {
- continue;
- }
- const rawSettings = allServerSettings[language_server_id]!;
-
- const parsedSettings = expandDottedPaths(
- rawSettings.serverSettings || {}
- );
-
- const serverSettings: protocol.DidChangeConfigurationParams = {
- settings: parsedSettings
- };
-
- this.console.log('Server Update: ', language_server_id);
- this.console.log('Sending settings: ', serverSettings);
- Private.updateServerConfiguration(language_server_id, serverSettings);
- }
- }
-
- /**
- * Fired the first time a connection is opened. These _should_ be the only
- * invocation of `.on` (once remaining LSPFeature.connection_handlers are made
- * singletons).
- */
- on_new_connection = (connection: ConnectionModuleType.LSPConnection) => {
- connection.on('error', e => {
- this.console.warn(e);
- // TODO invalid now
- let error: Error = e.length && e.length >= 1 ? e[0] : new Error();
- // TODO: those codes may be specific to my proxy client, need to investigate
- if (error.message.indexOf('code = 1005') !== -1) {
- this.console.warn(`Connection failed for ${connection}`);
- this.forEachDocumentOfConnection(connection, virtual_document => {
- this.console.warn('disconnecting ' + virtual_document.uri);
- this.closed.emit({ connection, virtual_document });
- this.ignored_languages.add(virtual_document.language);
-
- this.console.warn(
- `Cancelling further attempts to connect ${virtual_document.uri} and other documents for this language (no support from the server)`
- );
- });
- } else if (error.message.indexOf('code = 1006') !== -1) {
- this.console.warn('Connection closed by the server');
- } else {
- this.console.error('Connection error:', e);
- }
- });
-
- connection.on('serverInitialized', capabilities => {
- this.forEachDocumentOfConnection(connection, virtual_document => {
- // TODO: is this still necessary, e.g. for status bar to update responsively?
- this.initialized.emit({ connection, virtual_document });
- });
-
- // Initialize using settings stored in the SettingRegistry
- this.updateServerConfigurations(this.initial_configurations);
- });
-
- connection.on('close', closed_manually => {
- if (!closed_manually) {
- this.console.warn('Connection unexpectedly disconnected');
- } else {
- this.console.warn('Connection closed');
- this.forEachDocumentOfConnection(connection, virtual_document => {
- this.closed.emit({ connection, virtual_document });
- });
- }
- });
- };
-
- private forEachDocumentOfConnection(
- connection: ConnectionModuleType.LSPConnection,
- callback: (virtual_document: VirtualDocument) => void
- ) {
- for (const [
- virtual_document_uri,
- a_connection
- ] of this.connections.entries()) {
- if (connection !== a_connection) {
- continue;
- }
- callback(this.documents.get(virtual_document_uri)!);
- }
- }
-
- /**
- * TODO: presently no longer referenced. A failing connection would close
- * the socket, triggering the language server on the other end to exit
- */
- public async retry_to_connect(
- options: ISocketConnectionOptions,
- reconnect_delay: number,
- retrials_left = -1
- ) {
- let { virtual_document } = options;
-
- if (this.ignored_languages.has(virtual_document.language)) {
- return;
- }
-
- let interval = reconnect_delay * 1000;
- let success = false;
-
- while (retrials_left !== 0 && !success) {
- await this.connect(options)
- .then(() => {
- success = true;
- })
- .catch(e => {
- this.console.warn(e);
- });
-
- this.console.log(
- 'will attempt to re-connect in ' + interval / 1000 + ' seconds'
- );
- await sleep(interval);
-
- // gradually increase the time delay, up to 5 sec
- interval = interval < 5 * 1000 ? interval + 500 : interval;
- }
- }
-
- async connect(
- options: ISocketConnectionOptions,
- firstTimeoutSeconds = 30,
- secondTimeoutMinutes = 5
- ) {
- this.console.log('connection requested', options);
- let connection = await this.connect_socket(options);
-
- let { virtual_document, document_path } = options;
-
- if (!connection.isReady) {
- try {
- // user feedback hinted that 40 seconds was too short and some users are willing to wait more;
- // to make the best of both worlds we first check frequently (6.6 times a second) for the first
- // 30 seconds, and show the warning early in case if something is wrong; we then continue retrying
- // for another 5 minutes, but only once per second.
- await until_ready(
- () => connection.isReady,
- Math.round((firstTimeoutSeconds * 1000) / 150),
- 150
- );
- } catch {
- this.console.warn(
- `Connection to ${virtual_document.uri} timed out after ${firstTimeoutSeconds} seconds, will continue retrying for another ${secondTimeoutMinutes} minutes`
- );
- try {
- await until_ready(
- () => connection.isReady,
- 60 * secondTimeoutMinutes,
- 1000
- );
- } catch {
- this.console.warn(
- `Connection to ${virtual_document.uri} timed out again after ${secondTimeoutMinutes} minutes, giving up`
- );
- return;
- }
- }
- }
-
- this.console.log(document_path, virtual_document.uri, 'connected.');
-
- this.connected.emit({ connection, virtual_document });
-
- return connection;
- }
-
- public unregister_document(virtual_document: VirtualDocument) {
- this.connections.delete(virtual_document.uri);
- this.documents_changed.emit(this.documents);
- }
-
- updateLogging(
- logAllCommunication: boolean,
- setTrace: AskServersToSendTraceNotifications
- ) {
- for (const connection of this.connections.values()) {
- connection.logAllCommunication = logAllCommunication;
- if (setTrace !== null) {
- connection.clientNotifications['$/setTrace'].emit({ value: setTrace });
- }
- }
- }
-}
-
-export namespace DocumentConnectionManager {
- export interface IOptions {
- language_server_manager: ILanguageServerManager;
- console: ILSPLogConsole;
- }
-
- export function solve_uris(
- virtual_document: VirtualDocument,
- language: string
- ): IURIs {
- const serverManager = Private.getLanguageServerManager();
- const wsBase = serverManager.settings.wsUrl;
- const rootUri = PageConfig.getOption('rootUri');
- const virtualDocumentsUri = PageConfig.getOption('virtualDocumentsUri');
-
- // for now take the best match only
- const serverOptions: ILanguageServerManager.IGetServerIdOptions = {
- language
- };
- const matchingServers = serverManager.getMatchingServers(serverOptions);
- const languageServerId =
- matchingServers.length === 0 ? null : matchingServers[0];
-
- if (languageServerId === null) {
- throw `No language server installed for language ${language}`;
- }
-
- const specs = serverManager.getMatchingSpecs(serverOptions);
- const spec = specs.get(languageServerId);
- if (!spec) {
- console.warn(
- `Specification not available for server ${languageServerId}`
- );
- }
- const requiresOnDiskFiles = spec?.requires_documents_on_disk ?? true;
- const supportsInMemoryFiles = !requiresOnDiskFiles;
-
- const baseUri =
- virtual_document.has_lsp_supported_file || supportsInMemoryFiles
- ? rootUri
- : virtualDocumentsUri;
-
- // workaround url-parse bug(s) (see https://github.com/jupyter-lsp/jupyterlab-lsp/issues/595)
- let documentUri = URLExt.join(baseUri, virtual_document.uri);
- if (
- !documentUri.startsWith('file:///') &&
- documentUri.startsWith('file://')
- ) {
- documentUri = documentUri.replace('file://', 'file:///');
- if (
- documentUri.startsWith('file:///users/') &&
- baseUri.startsWith('file:///Users/')
- ) {
- documentUri = documentUri.replace('file:///users/', 'file:///Users/');
- }
- }
-
- return {
- base: baseUri,
- document: documentUri,
- server: URLExt.join('ws://jupyter-lsp', language),
- socket: URLExt.join(
- wsBase,
- ILanguageServerManager.URL_NS,
- 'ws',
- languageServerId
- )
- };
- }
-
- export interface IURIs {
- base: string;
- document: string;
- server: string;
- socket: string;
- }
-}
-
-/**
- * Namespace primarily for language-keyed cache of ConnectionModuleType.LSPConnections
- */
-namespace Private {
- const _connections: Map<
- TLanguageServerId,
- ConnectionModuleType.LSPConnection
- > = new Map();
- let _promise: Promise;
- let _language_server_manager: ILanguageServerManager;
-
- export function getLanguageServerManager() {
- return _language_server_manager;
- }
- export function setLanguageServerManager(
- language_server_manager: ILanguageServerManager
- ) {
- _language_server_manager = language_server_manager;
- }
-
- /**
- * Return (or create and initialize) the WebSocket associated with the language
- */
- export async function connection(
- language: string,
- language_server_id: TLanguageServerId,
- uris: DocumentConnectionManager.IURIs,
- onCreate: (connection: ConnectionModuleType.LSPConnection) => void,
- console: ILSPLogConsole,
- capabilities: ClientCapabilities
- ): Promise {
- if (_promise == null) {
- // TODO: consider lazy-loading _only_ the modules that _must_ be webpacked
- // with custom shims, e.g. `fs`
- _promise = import(
- /* webpackChunkName: "jupyter-lsp-connection" */ './connection'
- );
- }
-
- const { LSPConnection } = await _promise;
- let connection = _connections.get(language_server_id);
-
- if (connection == null) {
- const { settings } = Private.getLanguageServerManager();
- const socket = new settings.WebSocket(uris.socket);
- const connection = new LSPConnection({
- languageId: language,
- serverUri: uris.server,
- rootUri: uris.base,
- serverIdentifier: language_server_id,
- console: console,
- capabilities: capabilities
- });
- // TODO: remove remaining unbounded users of connection.on
- connection.setMaxListeners(999);
- _connections.set(language_server_id, connection);
- connection.connect(socket);
- onCreate(connection);
- }
-
- connection = _connections.get(language_server_id)!;
-
- return connection;
- }
-
- export function updateServerConfiguration(
- language_server_id: TLanguageServerId,
- settings: protocol.DidChangeConfigurationParams
- ): void {
- const connection = _connections.get(language_server_id);
- if (connection) {
- connection.sendConfigurationChange(settings);
- }
- }
-}
diff --git a/packages/jupyterlab-lsp/src/context.ts b/packages/jupyterlab-lsp/src/context.ts
new file mode 100644
index 000000000..9cf795b83
--- /dev/null
+++ b/packages/jupyterlab-lsp/src/context.ts
@@ -0,0 +1,276 @@
+import { JupyterFrontEnd } from '@jupyterlab/application';
+import { CodeEditor } from '@jupyterlab/codeeditor';
+import { IDocumentWidget } from '@jupyterlab/docregistry';
+import {
+ ILSPConnection,
+ WidgetLSPAdapter,
+ ILSPDocumentConnectionManager,
+ IEditorPosition,
+ IRootPosition,
+ IVirtualPosition,
+ Document
+} from '@jupyterlab/lsp';
+
+import {
+ PositionConverter,
+ documentAtRootPosition,
+ rootPositionToVirtualPosition,
+ editorPositionToRootPosition,
+ rootPositionToEditorPosition
+} from './converter';
+import { BrowserConsole } from './virtual/console';
+import { VirtualDocument } from './virtual/document';
+
+// TODO: reconsider naming
+export class ContextAssembler {
+ protected console = new BrowserConsole().scope('ContexAssembler');
+
+ constructor(private options: ContextAssembler.IOptions) {
+ // no-op
+ }
+
+ get isContextMenuOpen(): boolean {
+ return this.options.app.contextMenu.menu.isAttached;
+ }
+
+ getContext(): ICommandContext | null {
+ let context: ICommandContext | null = null;
+ if (this.isContextMenuOpen) {
+ try {
+ context = this.getContextFromContextMenu();
+ } catch (e) {
+ this.console.warn(
+ 'contextMenu is attached, but could not get the context',
+ e
+ );
+ context = null;
+ }
+ }
+ if (context == null) {
+ try {
+ context = this._contextFromActiveDocument();
+ } catch (e) {
+ if (
+ e instanceof Error &&
+ e.message === 'Source line not mapped to virtual position'
+ ) {
+ this.console.log(
+ 'Could not get context from active document: it is expected when restoring workspace with open files'
+ );
+ } else {
+ throw e;
+ }
+ }
+ }
+ return context;
+ }
+
+ isContextMenuOverToken() {
+ const context = this.getContextFromContextMenu();
+ if (!context) {
+ // annoyingly `isEnabled()` gets called again when mouse is over the menu
+ // which means we are no longer able to retrieve context; therefore we cache
+ // last value and return it if the mouse is over menu.
+ return this._wasOverToken;
+ }
+ const { rootPosition, adapter } = context;
+ const editor = adapter.activeEditor?.getEditor();
+ if (!editor) {
+ return;
+ }
+
+ const editorPosition = rootPositionToEditorPosition(adapter, rootPosition);
+
+ const offset = editor.getOffsetAt(
+ PositionConverter.cm_to_ce(editorPosition)
+ );
+ const token = editor.getTokenAt(offset);
+ const isOverToken = token.value !== '';
+ this._wasOverToken = isOverToken;
+ return isOverToken;
+ }
+ private _wasOverToken = false;
+
+ private _contextFromActiveDocument(): ICommandContext | null {
+ const adapter = [...this.options.connectionManager.adapters.values()].find(
+ adapter => adapter.widget == this.options.app.shell.currentWidget
+ );
+
+ if (!adapter) {
+ this.console.debug('No adapter');
+ return null;
+ }
+
+ const editor = adapter.activeEditor!.getEditor();
+
+ if (editor === null) {
+ return null;
+ }
+
+ let ce_cursor = editor.getCursorPosition();
+ let cm_cursor = PositionConverter.ce_to_cm(ce_cursor) as IEditorPosition;
+
+ const virtualDocument = adapter.virtualDocument;
+ if (!virtualDocument) {
+ console.warn('Could not retrieve current context', virtualDocument);
+ return null;
+ }
+ const rootPosition = virtualDocument.transformFromEditorToRoot(
+ adapter.activeEditor!,
+ cm_cursor
+ )!;
+
+ if (rootPosition == null) {
+ console.warn('Could not retrieve current context', virtualDocument);
+ return null;
+ }
+
+ return this._contextFromRoot(adapter, rootPosition);
+ }
+
+ private _contextFromRoot(
+ adapter: WidgetLSPAdapter,
+ rootPosition: IRootPosition
+ ): ICommandContext | null {
+ const document = documentAtRootPosition(adapter, rootPosition);
+ const connection = this.options.connectionManager.connections.get(
+ document.uri
+ )!;
+ const virtualPosition = rootPositionToVirtualPosition(
+ adapter,
+ rootPosition
+ );
+ return {
+ document: document as any,
+ connection,
+ virtualPosition,
+ rootPosition,
+ adapter: adapter
+ };
+ }
+
+ adapterFromNode(leafNode: HTMLElement): WidgetLSPAdapter | undefined {
+ return [...this.options.connectionManager.adapters.values()].find(adapter =>
+ adapter.widget.node.contains(leafNode!)
+ );
+ }
+
+ positionFromCoordinates(
+ left: number,
+ top: number,
+ adapter: WidgetLSPAdapter
+ ): IRootPosition | null {
+ // TODO: this relies on the editor under the cursor being the active editor;
+ // this may not be the case. Instead we should find editor from DOM and then
+ // have a magic way of transforming editor instances into CodeEditor and Document.Editor
+ // a naive way is to iterate all the editors in adapter (=cells) and see which one matches
+ // but the predicate is expensive and fallible in windowed notebook.
+ const editorAccessor = adapter.activeEditor;
+
+ if (!editorAccessor) {
+ return null;
+ }
+
+ const editorPosition = this.editorPositionFromCoordinates(
+ left,
+ top,
+ editorAccessor
+ );
+
+ if (!editorPosition) {
+ return null;
+ }
+
+ return editorPositionToRootPosition(
+ adapter,
+ editorAccessor,
+ editorPosition
+ );
+ }
+
+ editorPositionFromCoordinates(
+ left: number,
+ top: number,
+ editorAccessor: Document.IEditor
+ ): IEditorPosition | null {
+ const editor = editorAccessor.getEditor();
+ if (!editor) {
+ return null;
+ }
+ const position = editor.getPositionForCoordinate({
+ left: left,
+ right: left,
+ bottom: top,
+ top: top,
+ y: top,
+ x: left,
+ width: 0,
+ height: 0
+ } as CodeEditor.ICoordinate);
+
+ if (!position) {
+ return null;
+ }
+
+ const editorPosition = {
+ ch: position.column,
+ line: position.line
+ } as IEditorPosition;
+
+ return editorPosition;
+ }
+
+ private getContextFromContextMenu(): ICommandContext | null {
+ // Note: could also try using this.app.contextMenu.menu.contentNode position.
+ // Note: could add a guard on this.app.contextMenu.menu.isAttached
+
+ // get the first node as it gives the most accurate approximation
+ const leafNode = this.options.app.contextMenuHitTest(() => true);
+
+ if (!leafNode) {
+ return null;
+ }
+
+ let { left, top } = leafNode.getBoundingClientRect();
+
+ // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+ // @ts-ignore
+ let event = this.options.app._contextMenuEvent;
+
+ // if possible, use more accurate position from the actual event
+ // (but this relies on an undocumented and unstable feature)
+ if (event !== undefined) {
+ left = event.clientX;
+ top = event.clientY;
+ event.stopPropagation();
+ }
+ const adapter = this.adapterFromNode(leafNode);
+
+ if (!adapter) {
+ return null;
+ }
+
+ const rootPosition = this.positionFromCoordinates(left, top, adapter);
+
+ if (!rootPosition) {
+ return null;
+ }
+
+ return this._contextFromRoot(adapter!, rootPosition);
+ }
+}
+
+export namespace ContextAssembler {
+ export interface IOptions {
+ app: JupyterFrontEnd;
+ connectionManager: ILSPDocumentConnectionManager;
+ }
+}
+
+export interface ICommandContext {
+ document: VirtualDocument;
+ connection?: ILSPConnection;
+ virtualPosition: IVirtualPosition;
+ rootPosition: IRootPosition;
+ adapter: WidgetLSPAdapter;
+}
diff --git a/packages/jupyterlab-lsp/src/converter.spec.ts b/packages/jupyterlab-lsp/src/converter.spec.ts
new file mode 100644
index 000000000..72b39c968
--- /dev/null
+++ b/packages/jupyterlab-lsp/src/converter.spec.ts
@@ -0,0 +1,105 @@
+import {
+ Document,
+ CodeExtractorsManager,
+ IRootPosition
+} from '@jupyterlab/lsp';
+
+import {
+ documentAtRootPosition,
+ rootPositionToVirtualPosition
+} from './converter';
+import { RegExpForeignCodeExtractor } from './extractors/regexp';
+import { TestEnvironment, NotebookTestEnvironment } from './testutils';
+
+describe('Position conversion', () => {
+ let rLineExtractor = new RegExpForeignCodeExtractor({
+ language: 'R',
+ pattern: '(^|\n)%R (.*)\n?',
+ foreignCaptureGroups: [2],
+ isStandalone: false,
+ fileExtension: 'R'
+ });
+
+ let environment: NotebookTestEnvironment;
+
+ const extractorManager = new CodeExtractorsManager();
+ extractorManager.register(rLineExtractor, 'python');
+
+ const options: Partial = {
+ document: {
+ foreignCodeExtractors: extractorManager
+ }
+ };
+
+ beforeAll(async () => {
+ environment = new NotebookTestEnvironment(options);
+ await environment.init();
+ });
+
+ describe('#documentAtRootPosition()', () => {
+ it('returns correct document', () => {
+ let ceEditor_for_cell_1 = {} as Document.IEditor;
+ let ceEditor_for_cell_2 = {} as Document.IEditor;
+ const adapter = environment.adapter!;
+ const mainDocument = environment.adapter.virtualDocument!;
+
+ mainDocument.clear();
+ mainDocument.appendCodeBlock({
+ value: 'test line in Python 1\n%R test line in R 1',
+ ceEditor: ceEditor_for_cell_1,
+ type: 'code'
+ });
+ mainDocument.appendCodeBlock({
+ value: 'test line in Python 2\n%R test line in R 2',
+ ceEditor: ceEditor_for_cell_2,
+ type: 'code'
+ });
+
+ // The first (Python) line in the first block
+ let rootPosition = { line: 0, ch: 0 } as IRootPosition;
+ let document = documentAtRootPosition(adapter, rootPosition);
+ let virtualPosition = rootPositionToVirtualPosition(
+ adapter,
+ rootPosition
+ );
+ expect(document).toBe(mainDocument);
+ expect(virtualPosition.line).toBe(0);
+
+ // The second (Python | R) line in the first block - Python fragment
+ rootPosition = { line: 1, ch: 0 } as IRootPosition;
+ document = documentAtRootPosition(adapter, rootPosition);
+ virtualPosition = rootPositionToVirtualPosition(adapter, rootPosition);
+ expect(document).toBe(mainDocument);
+ expect(virtualPosition.line).toBe(1);
+
+ // The second (Python | R) line in the first block - R fragment
+ rootPosition = { line: 1, ch: 3 } as IRootPosition;
+ document = documentAtRootPosition(adapter, rootPosition);
+ virtualPosition = rootPositionToVirtualPosition(adapter, rootPosition);
+ expect(document).not.toBe(mainDocument);
+ expect(virtualPosition.line).toBe(0);
+
+ // The first (Python) line in the second block
+ rootPosition = { line: 2, ch: 0 } as IRootPosition;
+ document = documentAtRootPosition(adapter, rootPosition);
+ virtualPosition = rootPositionToVirtualPosition(adapter, rootPosition);
+ expect(document).toBe(mainDocument);
+ expect(virtualPosition.line).toBe(2 + 2);
+
+ // The second (Python | R) line in the second block - Python fragment
+ rootPosition = { line: 3, ch: 0 } as IRootPosition;
+ document = documentAtRootPosition(adapter, rootPosition);
+ virtualPosition = rootPositionToVirtualPosition(adapter, rootPosition);
+ expect(document).toBe(mainDocument);
+ expect(virtualPosition.line).toBe(2 + 2 + 1);
+
+ // The second (Python | R) line in the second block - R fragment
+ rootPosition = { line: 3, ch: 3 } as IRootPosition;
+ document = documentAtRootPosition(adapter, rootPosition);
+ virtualPosition = rootPositionToVirtualPosition(adapter, rootPosition);
+ expect(document).not.toBe(mainDocument);
+ // 0 + 1 (next line) + 2 (between-block spacing)
+ expect(virtualPosition.line).toBe(1 + 2);
+ });
+ });
+});
diff --git a/packages/jupyterlab-lsp/src/converter.ts b/packages/jupyterlab-lsp/src/converter.ts
index d93f6d055..7149114fd 100644
--- a/packages/jupyterlab-lsp/src/converter.ts
+++ b/packages/jupyterlab-lsp/src/converter.ts
@@ -1,13 +1,23 @@
import { CodeEditor } from '@jupyterlab/codeeditor';
-import type * as CodeMirror from 'codemirror';
+import type {
+ ISourcePosition,
+ IVirtualPosition,
+ IRootPosition,
+ IPosition,
+ IEditorPosition,
+ WidgetLSPAdapter,
+ Document
+} from '@jupyterlab/lsp';
import type * as lsProtocol from 'vscode-languageserver-protocol';
+import type { VirtualDocument } from './virtual/document';
+
export class PositionConverter {
- static lsp_to_cm(position: lsProtocol.Position): CodeMirror.Position {
+ static lsp_to_cm(position: lsProtocol.Position): IPosition {
return { line: position.line, ch: position.character };
}
- static cm_to_lsp(position: CodeMirror.Position): lsProtocol.Position {
+ static cm_to_lsp(position: IPosition): lsProtocol.Position {
return { line: position.line, character: position.ch };
}
@@ -15,11 +25,131 @@ export class PositionConverter {
return { line: position.line, column: position.character };
}
- static cm_to_ce(position: CodeMirror.Position): CodeEditor.IPosition {
+ static cm_to_ce(position: IPosition): CodeEditor.IPosition {
return { line: position.line, column: position.ch };
}
- static ce_to_cm(position: CodeEditor.IPosition): CodeMirror.Position {
+ static ce_to_cm(position: CodeEditor.IPosition): IPosition {
return { line: position.line, ch: position.column };
}
}
+
+/** TODO should it be wrapped into an object? Where should these live? */
+
+export interface IEditorRange {
+ start: IEditorPosition;
+ end: IEditorPosition;
+ editor: CodeEditor.IEditor;
+}
+
+export function documentAtRootPosition(
+ adapter: WidgetLSPAdapter,
+ position: IRootPosition
+): VirtualDocument {
+ let rootAsSource = position as ISourcePosition;
+ if (!adapter.virtualDocument) {
+ throw Error('Virtual document of adapter disposed!');
+ }
+ if (adapter.virtualDocument.root !== adapter.virtualDocument) {
+ throw Error('Virtual document on adapter must be the root document');
+ }
+ return adapter.virtualDocument.documentAtSourcePosition(
+ rootAsSource
+ ) as VirtualDocument;
+}
+
+export function editorAtRootPosition(
+ adapter: WidgetLSPAdapter,
+ position: IRootPosition
+): Document.IEditor {
+ let rootAsSource = position as ISourcePosition;
+ if (!adapter.virtualDocument) {
+ throw Error('Virtual document of adapter disposed!');
+ }
+ if (adapter.virtualDocument.root !== adapter.virtualDocument) {
+ throw Error('Virtual document on adapter must be the root document');
+ }
+ return adapter.virtualDocument.getEditorAtSourceLine(rootAsSource);
+}
+
+export function rootPositionToVirtualPosition(
+ adapter: WidgetLSPAdapter,
+ position: IRootPosition
+): IVirtualPosition {
+ let rootAsSource = position as ISourcePosition;
+ if (!adapter.virtualDocument) {
+ throw Error('Virtual document of adapter disposed!');
+ }
+ if (adapter.virtualDocument.root !== adapter.virtualDocument) {
+ throw Error('Virtual document on adapter must be the root document');
+ }
+ return adapter.virtualDocument!.virtualPositionAtDocument(rootAsSource);
+}
+
+export function virtualPositionToRootPosition(
+ adapter: WidgetLSPAdapter,
+ position: IVirtualPosition
+): IRootPosition | null {
+ if (!adapter.virtualDocument) {
+ throw Error('Virtual document of adapter disposed!');
+ }
+ return (adapter.virtualDocument as VirtualDocument).transformVirtualToRoot(
+ position
+ );
+}
+
+export function rootPositionToEditorPosition(
+ adapter: WidgetLSPAdapter,
+ position: IRootPosition
+): IEditorPosition {
+ let rootAsSource = position as ISourcePosition;
+ if (!adapter.virtualDocument) {
+ throw Error('Virtual document of adapter disposed!');
+ }
+ if (adapter.virtualDocument.root !== adapter.virtualDocument) {
+ throw Error('Virtual document on adapter must be the root document');
+ }
+ return adapter.virtualDocument.transformSourceToEditor(rootAsSource);
+}
+
+export function editorPositionToRootPosition(
+ adapter: WidgetLSPAdapter,
+ editor: Document.IEditor,
+ position: IEditorPosition
+): IRootPosition | null {
+ if (!adapter.virtualDocument) {
+ throw Error('Virtual document of adapter disposed!');
+ }
+ return adapter.virtualDocument.transformFromEditorToRoot(editor, position);
+}
+
+export function rangeToEditorRange(
+ adapter: WidgetLSPAdapter,
+ range: lsProtocol.Range,
+ editor: CodeEditor.IEditor | null
+): IEditorRange {
+ let start = PositionConverter.lsp_to_cm(range.start) as IVirtualPosition;
+ let end = PositionConverter.lsp_to_cm(range.end) as IVirtualPosition;
+
+ let startInRoot = virtualPositionToRootPosition(adapter, start);
+ if (!startInRoot) {
+ throw Error('Could not determine position in root');
+ }
+
+ if (editor == null) {
+ let editorAccessor = editorAtRootPosition(adapter, startInRoot);
+ const candidate = editorAccessor.getEditor();
+ if (!candidate) {
+ throw Error('Editor could not be accessed');
+ }
+ editor = candidate;
+ }
+
+ const document = documentAtRootPosition(adapter, startInRoot);
+
+ return {
+ start: document.transformVirtualToEditor(start)!,
+ end: document.transformVirtualToEditor(end)!,
+ editor: editor
+ };
+}
diff --git a/packages/jupyterlab-lsp/src/editor_integration/cm_adapter.spec.ts b/packages/jupyterlab-lsp/src/editor_integration/cm_adapter.spec.ts
deleted file mode 100644
index ab18a0ec0..000000000
--- a/packages/jupyterlab-lsp/src/editor_integration/cm_adapter.spec.ts
+++ /dev/null
@@ -1,48 +0,0 @@
-import { expect } from 'chai';
-import type * as CodeMirror from 'codemirror';
-
-import { IRootPosition } from '../positioning';
-import { IEditorChange } from '../virtual/editor';
-
-import { CodeMirrorIntegration } from './codemirror';
-import { FileEditorFeatureTestEnvironment } from './testutils';
-
-describe('CodeMirrorAdapter', () => {
- let env: FileEditorFeatureTestEnvironment;
-
- beforeEach(() => (env = new FileEditorFeatureTestEnvironment()));
- afterEach(() => env.dispose());
-
- describe('Works with VirtualFileEditor', () => {
- it('updates on change', async () => {
- class UpdateReceivingFeature extends CodeMirrorIntegration {
- public received_update = false;
- public last_change: CodeMirror.EditorChange = null as any;
- public last_change_position: IRootPosition;
-
- afterChange(change: IEditorChange, root_position: IRootPosition): void {
- this.received_update = true;
- this.last_change = change;
- this.last_change_position = root_position;
- }
- }
-
- await env.adapter.widget.context.initialize(true);
- await env.adapter.widget.context.ready;
- await env.adapter.initialized;
-
- let feature = env.init_integration({
- constructor: UpdateReceivingFeature,
- id: 'UpdateReceivingFeature'
- }) as UpdateReceivingFeature;
-
- await env.adapter.update_finished;
- expect(feature.received_update).to.equal(false);
-
- env.ce_editor.model.value.text = 'fo';
- await env.adapter.update_finished;
- expect(feature.received_update).to.equal(true);
- expect(feature.last_change.text[0]).to.equal('fo');
- });
- });
-});
diff --git a/packages/jupyterlab-lsp/src/editor_integration/codemirror.ts b/packages/jupyterlab-lsp/src/editor_integration/codemirror.ts
deleted file mode 100644
index 06925a269..000000000
--- a/packages/jupyterlab-lsp/src/editor_integration/codemirror.ts
+++ /dev/null
@@ -1,536 +0,0 @@
-import { CodeEditor } from '@jupyterlab/codeeditor';
-import { IDocumentWidget } from '@jupyterlab/docregistry';
-import { TranslationBundle } from '@jupyterlab/translation';
-import type * as CodeMirror from 'codemirror';
-import type * as lsProtocol from 'vscode-languageserver-protocol';
-
-import { StatusMessage, WidgetAdapter } from '../adapters/adapter';
-import { LSPConnection } from '../connection';
-import { PositionConverter } from '../converter';
-import {
- IEditorIntegrationOptions,
- IFeature,
- IFeatureEditorIntegration,
- IFeatureSettings
-} from '../feature';
-import {
- IEditorPosition,
- IRootPosition,
- IVirtualPosition,
- offset_at_position
-} from '../positioning';
-import { ILSPLogConsole } from '../tokens';
-import { DefaultMap, uris_equal } from '../utils';
-import {
- CodeMirrorHandler,
- CodeMirrorVirtualEditor,
- EventName as CodeMirrorEventName
-} from '../virtual/codemirror_editor';
-import { VirtualDocument } from '../virtual/document';
-import { IEditorChange } from '../virtual/editor';
-
-function toDocumentChanges(changes: {
- [uri: string]: lsProtocol.TextEdit[];
-}): lsProtocol.TextDocumentEdit[] {
- let documentChanges = [];
- for (let uri of Object.keys(changes)) {
- documentChanges.push({
- textDocument: { uri },
- edits: changes[uri]
- } as lsProtocol.TextDocumentEdit);
- }
- return documentChanges;
-}
-
-export interface IEditorRange {
- start: IEditorPosition;
- end: IEditorPosition;
- editor: CodeMirror.Editor;
-}
-
-function offset_from_lsp(position: lsProtocol.Position, lines: string[]) {
- return offset_at_position(PositionConverter.lsp_to_ce(position), lines);
-}
-
-export interface IEditOutcome {
- appliedChanges: number | null;
- modifiedCells: number;
- wasGranular: boolean;
- errors: string[];
-}
-
-/**
- * Interface for storage of HTMLElement event specifications (event name + handler).
- */
-interface IHTMLEventMap<
- T extends keyof HTMLElementEventMap = keyof HTMLElementEventMap
-> extends Map void> {
- set(
- k: E,
- handler: (event: HTMLElementEventMap[E]) => void
- ): this;
- get(k: E): (event: HTMLElementEventMap[E]) => void;
-}
-
-/**
- * One feature of each type exists per VirtualDocument
- * (the initialization is performed by the adapter).
- */
-export abstract class CodeMirrorIntegration
- implements IFeatureEditorIntegration
-{
- is_registered: boolean;
- feature: IFeature;
-
- protected readonly editor_handlers: Map<
- CodeMirrorEventName,
- CodeMirrorHandler
- >;
- // TODO use better type constraints for connection event names and for responses
- protected readonly connection_handlers: Map<
- string,
- (response: Record) => void
- >;
- protected readonly wrapper_handlers: IHTMLEventMap;
- protected wrapper: HTMLElement;
-
- protected virtual_editor: CodeMirrorVirtualEditor;
- protected virtual_document: VirtualDocument;
- protected connection: LSPConnection;
-
- /** @deprecated: use `setStatusMessage()` instead */
- protected status_message: StatusMessage;
- protected adapter: WidgetAdapter;
- protected console: ILSPLogConsole;
-
- protected trans: TranslationBundle;
-
- get settings(): IFeatureSettings | undefined {
- return this.feature.settings;
- }
-
- get lab_integration() {
- return this.feature.labIntegration;
- }
-
- constructor(options: IEditorIntegrationOptions) {
- this.feature = options.feature;
- this.virtual_editor = options.virtual_editor as CodeMirrorVirtualEditor;
- this.virtual_document = options.virtual_document;
- this.connection = options.connection;
- this.status_message = options.status_message;
- this.adapter = options.adapter;
- this.console = this.adapter.console.scope(options.feature.name);
- this.trans = options.trans;
-
- this.editor_handlers = new Map();
- this.connection_handlers = new Map();
- this.wrapper_handlers = new Map();
- this.is_registered = false;
- }
-
- /**
- * Set the text message and (optionally) the timeout to remove it.
- * @param message
- * @param timeout - number of ms to until the message is cleaned;
- * -1 if the message should stay up indefinitely;
- * defaults to 3000ms (3 seconds)
- */
- setStatusMessage(message: string, timeout?: number): void {
- this.status_message.set(message, timeout);
- }
-
- register(): void {
- // register editor handlers
- for (let [event_name, handler] of this.editor_handlers) {
- this.virtual_editor.on(event_name, handler);
- }
- // register connection handlers
- for (let [event_name, handler] of this.connection_handlers) {
- this.connection.on(event_name, handler);
- }
- // register editor wrapper handlers
- this.wrapper = this.virtual_editor.getWrapperElement();
- for (let [event_name, handler] of this.wrapper_handlers) {
- this.wrapper.addEventListener(event_name, handler);
- }
-
- this.is_registered = true;
- }
-
- remove(): void {
- // unregister editor handlers
- for (let [event_name, handler] of this.editor_handlers) {
- this.virtual_editor.off(event_name, handler);
- }
- this.editor_handlers.clear();
- // unregister connection handlers
- for (let [event_name, handler] of this.connection_handlers) {
- this.connection.off(event_name, handler);
- }
- this.connection_handlers.clear();
- // unregister editor wrapper handlers
- for (let [event_name, handler] of this.wrapper_handlers) {
- this.wrapper.removeEventListener(event_name, handler);
- }
- this.wrapper_handlers.clear();
- }
-
- protected range_to_editor_range(
- range: lsProtocol.Range,
- cm_editor?: CodeMirror.Editor
- ): IEditorRange {
- let start = PositionConverter.lsp_to_cm(range.start) as IVirtualPosition;
- let end = PositionConverter.lsp_to_cm(range.end) as IVirtualPosition;
-
- if (cm_editor == null) {
- let start_in_root =
- this.transform_virtual_position_to_root_position(start);
- let ce_editor =
- this.virtual_editor.get_editor_at_root_position(start_in_root);
- cm_editor = this.virtual_editor.ce_editor_to_cm_editor.get(ce_editor)!;
- }
-
- return {
- start: this.virtual_document.transform_virtual_to_editor(start)!,
- end: this.virtual_document.transform_virtual_to_editor(end)!,
- editor: cm_editor
- };
- }
-
- protected position_from_mouse(event: MouseEvent): IRootPosition | null {
- const position = this.virtual_editor.coordsChar(
- {
- left: event.clientX,
- top: event.clientY
- },
- 'window'
- );
- if (position.line === -1 && position.ch === -1) {
- return null;
- } else {
- return position as IRootPosition;
- }
- }
-
- public transform_virtual_position_to_root_position(
- start: IVirtualPosition
- ): IRootPosition {
- let ce_editor = this.virtual_document.virtual_lines.get(start.line)!.editor;
- let editor_position =
- this.virtual_document.transform_virtual_to_editor(start);
- return this.virtual_editor.transform_from_editor_to_root(
- ce_editor,
- editor_position!
- )!;
- }
-
- protected get_cm_editor(position: IRootPosition) {
- return this.virtual_editor.get_cm_editor(position);
- }
-
- protected get_language_at(
- position: IEditorPosition,
- editor: CodeMirror.Editor
- ) {
- return editor.getModeAt(position).name;
- }
-
- protected extract_last_character(change: CodeMirror.EditorChange): string {
- if (change.origin === 'paste') {
- let last_line = change.text[change.text.length - 1];
- return last_line[last_line.length - 1];
- } else {
- return change.text[0][0];
- }
- }
-
- /**
- * @deprecated
- */
- protected highlight_range(
- range: IEditorRange,
- class_name: string
- ): CodeMirror.TextMarker {
- return range.editor
- .getDoc()
- .markText(range.start, range.end, { className: class_name });
- }
-
- /**
- * Does the edit cover the entire document?
- */
- protected is_whole_document_edit(edit: lsProtocol.TextEdit) {
- let value = this.virtual_document.value;
- let lines = value.split('\n');
- let range = edit.range;
- let lsp_to_ce = PositionConverter.lsp_to_ce;
- return (
- offset_at_position(lsp_to_ce(range.start), lines) === 0 &&
- offset_at_position(lsp_to_ce(range.end), lines) === value.length
- );
- }
-
- protected async apply_edit(
- workspaceEdit: lsProtocol.WorkspaceEdit
- ): Promise {
- let current_uri = this.virtual_document.document_info.uri;
-
- // Specs: documentChanges are preferred over changes
- let changes = workspaceEdit.documentChanges
- ? workspaceEdit.documentChanges.map(
- change => change as lsProtocol.TextDocumentEdit
- )
- : toDocumentChanges(workspaceEdit.changes!);
- let applied_changes = 0;
- let edited_cells: number = 0;
- let is_whole_document_edit: boolean = false;
- let errors: string[] = [];
-
- for (let change of changes) {
- let uri = change.textDocument.uri;
-
- if (!uris_equal(uri, current_uri)) {
- errors.push(
- `Workspace-wide edits not implemented: ${uri} != ${current_uri}`
- );
- } else {
- is_whole_document_edit =
- change.edits.length === 1 &&
- this.is_whole_document_edit(change.edits[0]);
-
- let edit: lsProtocol.TextEdit;
-
- if (!is_whole_document_edit) {
- applied_changes = 0;
- let value = this.virtual_document.value;
- // TODO: make sure that it was not changed since the request was sent (using the returned document version)
- let lines = value.split('\n');
-
- let edits_by_offset = new Map();
- for (let e of change.edits) {
- let offset = offset_from_lsp(e.range.start, lines);
- if (edits_by_offset.has(offset)) {
- console.warn(
- 'Edits should not overlap, ignoring an overlapping edit'
- );
- } else {
- edits_by_offset.set(offset, e);
- applied_changes += 1;
- }
- }
-
- // TODO make use of old_to_new_line for edits which add of remove lines:
- // this is crucial to preserve cell boundaries in notebook in such cases
- let old_to_new_line = new DefaultMap(() => []);
- let new_text = '';
- let last_end = 0;
- let current_old_line = 0;
- let current_new_line = 0;
- // going over the edits in descending order of start points:
- let start_offsets = [...edits_by_offset.keys()].sort((a, b) => a - b);
- for (let start of start_offsets) {
- let edit = edits_by_offset.get(start)!;
- let prefix = value.slice(last_end, start);
- for (let i = 0; i < prefix.split('\n').length; i++) {
- let new_lines = old_to_new_line.get_or_create(current_old_line);
- new_lines.push(current_new_line);
- current_old_line += 1;
- current_new_line += 1;
- }
- new_text += prefix + edit.newText;
- let end = offset_from_lsp(edit.range.end, lines);
- let replaced_fragment = value.slice(start, end);
- for (let i = 0; i < edit.newText.split('\n').length; i++) {
- if (i < replaced_fragment.length) {
- current_old_line += 1;
- }
- current_new_line += 1;
- let new_lines = old_to_new_line.get_or_create(current_old_line);
- new_lines.push(current_new_line);
- }
- last_end = end;
- }
- new_text += value.slice(last_end, value.length);
-
- edit = {
- range: {
- start: { line: 0, character: 0 },
- end: {
- line: lines.length - 1,
- character: lines[lines.length - 1].length
- }
- },
- newText: new_text
- };
- console.assert(this.is_whole_document_edit(edit));
- } else {
- edit = change.edits[0];
- applied_changes += 1;
- }
- edited_cells = this.apply_single_edit(edit);
- }
- }
- const all_empty = changes.every(change => change.edits.length === 0);
- return {
- appliedChanges: applied_changes,
- modifiedCells: edited_cells,
- wasGranular: !is_whole_document_edit && !all_empty,
- errors: errors
- };
- }
-
- protected replace_fragment(
- newText: string,
- editor: CodeEditor.IEditor,
- fragment_start: CodeMirror.Position,
- fragment_end: CodeMirror.Position,
- start: CodeMirror.Position,
- end: CodeMirror.Position,
- is_whole_document_edit = false
- ): number {
- let document = this.virtual_document;
- let newFragmentText = newText
- .split('\n')
- .slice(fragment_start.line - start.line, fragment_end.line - start.line)
- .join('\n');
-
- if (newFragmentText.endsWith('\n')) {
- newFragmentText = newFragmentText.slice(0, -1);
- }
-
- let doc = this.virtual_editor.ce_editor_to_cm_editor.get(editor)!.getDoc();
-
- let raw_value = doc.getValue('\n');
- // extract foreign documents and substitute magics,
- // as it was done when the shadow virtual document was being created
- let { lines } = document.prepare_code_block({
- value: raw_value,
- ce_editor: editor
- });
- let old_value = lines.join('\n');
-
- if (is_whole_document_edit) {
- // partial edit
- let cm_to_ce = PositionConverter.cm_to_ce;
- let up_to_offset = offset_at_position(cm_to_ce(start), lines);
- let from_offset = offset_at_position(cm_to_ce(end), lines);
- newFragmentText =
- old_value.slice(0, up_to_offset) +
- newText +
- old_value.slice(from_offset);
- }
-
- if (old_value === newFragmentText) {
- return 0;
- }
-
- let new_value = document.decode_code_block(newFragmentText);
-
- let cursor = doc.getCursor();
-
- doc.replaceRange(
- new_value,
- { line: 0, ch: 0 },
- {
- line: fragment_end.line - fragment_start.line + 1,
- ch: 0
- }
- );
-
- try {
- // try to restore the cursor to the position prior to the edit
- // (this might not be the best UX, but definitely better than
- // the cursor jumping to the very end of the cell/file).
- doc.setCursor(cursor, cursor.ch, { scroll: false });
- // note: this does not matter for actions invoke from context menu
- // as those loose focus anyways (this might be addressed elsewhere)
- } catch (e) {
- console.log('Could not place the cursor back', e);
- }
-
- return 1;
- }
-
- afterChange(change: IEditorChange, root_position: IRootPosition) {
- // nothing here
- }
-
- protected apply_single_edit(edit: lsProtocol.TextEdit): number {
- let document = this.virtual_document;
- let applied_changes = 0;
- let start = PositionConverter.lsp_to_cm(edit.range.start);
- let end = PositionConverter.lsp_to_cm(edit.range.end);
-
- let start_editor = document.get_editor_at_virtual_line(
- start as IVirtualPosition
- );
- let end_editor = document.get_editor_at_virtual_line(
- end as IVirtualPosition
- );
- if (start_editor !== end_editor) {
- let last_editor = start_editor;
- let fragment_start = start;
- let fragment_end = { ...start };
-
- let line = start.line;
- let recently_replaced = false;
- while (line <= end.line) {
- line++;
- let editor = document.get_editor_at_virtual_line({
- line: line,
- ch: 0
- } as IVirtualPosition);
-
- if (editor === last_editor) {
- fragment_end.line = line;
- fragment_end.ch = 0;
- recently_replaced = false;
- } else {
- applied_changes += this.replace_fragment(
- edit.newText,
- last_editor,
- fragment_start,
- fragment_end,
- start,
- end
- );
- recently_replaced = true;
- fragment_start = {
- line: line,
- ch: 0
- };
- fragment_end = {
- line: line,
- ch: 0
- };
- last_editor = editor;
- }
- }
- if (!recently_replaced) {
- applied_changes += this.replace_fragment(
- edit.newText,
- last_editor,
- fragment_start,
- fragment_end,
- start,
- end
- );
- }
- } else {
- applied_changes += this.replace_fragment(
- edit.newText,
- start_editor,
- start,
- end,
- start,
- end
- );
- }
- return applied_changes;
- }
-}
-
-export type CodeMirrorIntegrationConstructor = {
- new (options: IEditorIntegrationOptions): CodeMirrorIntegration;
-};
diff --git a/packages/jupyterlab-lsp/src/editor_integration/editor_adapter.ts b/packages/jupyterlab-lsp/src/editor_integration/editor_adapter.ts
deleted file mode 100644
index f4dab15aa..000000000
--- a/packages/jupyterlab-lsp/src/editor_integration/editor_adapter.ts
+++ /dev/null
@@ -1,123 +0,0 @@
-import { CodeEditor } from '@jupyterlab/codeeditor';
-
-import { IFeatureEditorIntegration } from '../feature';
-import { IRootPosition } from '../positioning';
-import { ILSPLogConsole } from '../tokens';
-import { until_ready } from '../utils';
-import { VirtualDocument } from '../virtual/document';
-import { IEditorChange, IVirtualEditor } from '../virtual/editor';
-
-import IEditor = CodeEditor.IEditor;
-
-export class EditorAdapter> {
- features: Map>;
- isDisposed = false;
-
- private last_change: IEditorChange | null;
- private console: ILSPLogConsole;
-
- constructor(
- protected editor: IVirtualEditor,
- protected virtual_document: VirtualDocument,
- features = new Array>(),
- console: ILSPLogConsole
- ) {
- this.editor.change.connect(this.saveChange, this);
- this.console = console.scope('EditorAdapter');
-
- this.features = new Map();
-
- for (let feature of features) {
- feature.register();
- if (!feature.is_registered) {
- this.console.warn(
- 'The feature ',
- feature,
- 'was not registered properly'
- );
- }
- this.features.set(feature.feature.id, feature);
- }
- }
-
- public async updateAfterChange() {
- try {
- await until_ready(() => this.last_change != null, 30, 22);
- } catch (err) {
- this.console.log(
- 'No change obtained from CodeMirror editor within the expected time of 0.66s'
- );
- return;
- }
-
- let change: IEditorChange | null = this.last_change;
-
- let root_position: IRootPosition;
-
- try {
- root_position = this.editor.get_cursor_position();
- } catch (err) {
- this.console.log('Root position not found');
- return;
- }
-
- try {
- let document = this.editor.document_at_root_position(root_position);
-
- if (this.virtual_document !== document) {
- return true;
- }
-
- if (
- !change ||
- ((!change.text.length || !change.text[0].length) &&
- (!change.removed ||
- !change.removed.length ||
- !change.removed[0].length))
- ) {
- return true;
- }
-
- for (let feature of this.features.values()) {
- try {
- if (feature.afterChange) {
- feature.afterChange(change, root_position);
- }
- } catch (err) {
- console.warn('afterChange of feature', feature, 'failed with', err);
- }
- }
- return true;
- } catch (e) {
- this.console.log('updateAfterChange failure');
- this.console.error(e);
- }
- this.invalidateLastChange();
- return undefined;
- }
-
- public invalidateLastChange() {
- this.last_change = null;
- }
-
- public saveChange(sender: IVirtualEditor, change: IEditorChange) {
- this.last_change = change;
- }
-
- public dispose() {
- if (this.isDisposed) {
- return;
- }
- for (let feature of this.features.values()) {
- feature.remove();
- }
- this.features.clear();
- this.editor.change.disconnect(this.saveChange);
-
- // just to be sure
- this.editor = null as any;
-
- // actually disposed
- this.isDisposed = true;
- }
-}
diff --git a/packages/jupyterlab-lsp/src/editor_integration/feature.spec.ts b/packages/jupyterlab-lsp/src/editor_integration/feature.spec.ts
deleted file mode 100644
index be71ef08c..000000000
--- a/packages/jupyterlab-lsp/src/editor_integration/feature.spec.ts
+++ /dev/null
@@ -1,329 +0,0 @@
-import { PageConfig } from '@jupyterlab/coreutils';
-import * as nbformat from '@jupyterlab/nbformat';
-import { NotebookModel } from '@jupyterlab/notebook';
-import { expect } from 'chai';
-import * as lsProtocol from 'vscode-languageserver-protocol';
-
-import { foreign_code_extractors } from '../transclusions/ipython/extractors';
-import { overrides } from '../transclusions/ipython/overrides';
-
-import { CodeMirrorIntegration } from './codemirror';
-import {
- FileEditorFeatureTestEnvironment,
- NotebookFeatureTestEnvironment,
- code_cell,
- getCellsJSON,
- python_notebook_metadata,
- showAllCells
-} from './testutils';
-
-const js_fib_code = `function fib(n) {
- return n<2?n:fib(n-1)+fib(n-2);
-}
-
-fib(5);
-
-window.location /;`;
-
-const js_fib2_code = `function fib2(n) {
- return n<2?n:fib2(n-1)+fib2(n-2);
-}
-
-fib2(5);
-
-window.location /;`;
-
-const js_partial_edits = [
- {
- range: {
- start: {
- line: 0,
- character: 9
- },
- end: {
- line: 0,
- character: 12
- }
- },
- newText: 'fib2'
- },
- {
- range: {
- start: {
- line: 1,
- character: 15
- },
- end: {
- line: 1,
- character: 18
- }
- },
- newText: 'fib2'
- },
- {
- range: {
- start: {
- line: 1,
- character: 24
- },
- end: {
- line: 1,
- character: 27
- }
- },
- newText: 'fib2'
- },
- {
- range: {
- start: {
- line: 4,
- character: 0
- },
- end: {
- line: 4,
- character: 3
- }
- },
- newText: 'fib2'
- }
-];
-
-describe('Feature', () => {
- PageConfig.setOption('rootUri', 'file://');
-
- describe('apply_edit()', () => {
- class EditApplyingFeatureCM extends CodeMirrorIntegration {
- do_apply_edit(workspaceEdit: lsProtocol.WorkspaceEdit) {
- return this.apply_edit(workspaceEdit);
- }
- }
-
- describe('editing in FileEditor', () => {
- let feature: EditApplyingFeatureCM;
- let environment: FileEditorFeatureTestEnvironment;
-
- beforeEach(() => {
- environment = new FileEditorFeatureTestEnvironment();
- feature = environment.init_integration({
- constructor: EditApplyingFeatureCM,
- id: 'EditApplyingFeature'
- });
- });
-
- afterEach(() => {
- environment.dispose();
- });
-
- it('applies simple edit in FileEditor', async () => {
- environment.ce_editor.model.value.text = 'foo bar';
- await environment.adapter.update_documents();
-
- let outcome = await feature.do_apply_edit({
- changes: {
- ['file:///' + environment.document_options.path]: [
- {
- range: {
- start: { line: 0, character: 0 },
- end: { line: 1, character: 0 }
- },
- newText: 'changed bar'
- } as lsProtocol.TextEdit
- ]
- }
- });
- let raw_value = environment.ce_editor.doc.getValue();
- expect(raw_value).to.be.equal('changed bar');
- expect(environment.ce_editor.model.value.text).to.be.equal(
- 'changed bar'
- );
- expect(outcome.wasGranular).to.be.equal(false);
- expect(outcome.modifiedCells).to.be.equal(1);
- expect(outcome.appliedChanges).to.be.equal(1);
- });
-
- it('correctly summarizes empty edit', async () => {
- environment.ce_editor.model.value.text = 'foo bar';
- await environment.adapter.update_documents();
-
- let outcome = await feature.do_apply_edit({
- changes: {
- ['file:///' + environment.document_options.path]: []
- }
- });
- let raw_value = environment.ce_editor.doc.getValue();
- expect(raw_value).to.be.equal('foo bar');
- expect(environment.ce_editor.model.value.text).to.be.equal('foo bar');
- expect(outcome.wasGranular).to.be.equal(false);
- expect(outcome.appliedChanges).to.be.equal(0);
- expect(outcome.modifiedCells).to.be.equal(0);
- });
-
- it('applies partial edits', async () => {
- environment.ce_editor.model.value.text = js_fib_code;
- await environment.adapter.update_documents();
-
- let result = await feature.do_apply_edit({
- changes: {
- ['file:///' + environment.document_options.path]: js_partial_edits
- }
- });
- let raw_value = environment.ce_editor.doc.getValue();
- expect(raw_value).to.be.equal(js_fib2_code);
- expect(environment.ce_editor.model.value.text).to.be.equal(
- js_fib2_code
- );
-
- expect(result.appliedChanges).to.be.equal(js_partial_edits.length);
- expect(result.wasGranular).to.be.equal(true);
- expect(result.modifiedCells).to.be.equal(1);
- });
- });
-
- describe('editing in Notebook', () => {
- let feature: EditApplyingFeatureCM;
- let environment: NotebookFeatureTestEnvironment;
-
- beforeEach(() => {
- environment = new NotebookFeatureTestEnvironment({
- overrides_registry: {
- python: {
- cell: overrides.filter(override => override.scope == 'cell'),
- line: overrides.filter(override => override.scope == 'line')
- }
- },
- foreign_code_extractors: foreign_code_extractors
- });
-
- feature = environment.init_integration({
- constructor: EditApplyingFeatureCM,
- id: 'EditApplyingFeature'
- });
- });
-
- afterEach(() => {
- environment.dispose();
- });
-
- async function synchronizeContent() {
- await environment.adapter.update_documents();
- }
-
- it('applies edit across cells', async () => {
- let test_notebook = {
- cells: [
- code_cell(['def a_function():\n', ' pass']),
- code_cell(['x = a_function()'])
- ],
- metadata: python_notebook_metadata
- } as nbformat.INotebookContent;
-
- let notebook = environment.notebook;
-
- notebook.model = new NotebookModel();
- notebook.model.fromJSON(test_notebook);
- showAllCells(notebook);
-
- await synchronizeContent();
- let main_document = environment.virtual_editor.virtual_document;
-
- let old_virtual_source =
- 'def a_function():\n pass\n\n\nx = a_function()\n';
- let new_virtual_source =
- 'def a_function_2():\n pass\n\n\nx = a_function_2()\n';
- expect(main_document.value).to.be.equal(old_virtual_source);
-
- let outcome = await feature.do_apply_edit({
- changes: {
- [main_document.document_info.uri]: [
- {
- range: {
- start: { line: 0, character: 0 },
- end: { line: 5, character: 0 }
- },
- newText: new_virtual_source
- } as lsProtocol.TextEdit
- ]
- }
- });
-
- await synchronizeContent();
-
- let value = main_document.value;
- expect(value).to.be.equal(new_virtual_source);
-
- let code_cells = getCellsJSON(notebook);
-
- expect(code_cells[0]).to.have.property(
- 'source',
- 'def a_function_2():\n pass'
- );
- expect(code_cells[1]).to.have.property('source', 'x = a_function_2()');
-
- expect(outcome.appliedChanges).to.be.equal(1);
- expect(outcome.wasGranular).to.be.equal(false);
- expect(outcome.modifiedCells).to.be.equal(2);
- });
-
- it('handles IPython magics', async () => {
- let test_notebook = {
- cells: [
- code_cell(['x = %ls\n', 'print(x)']),
- code_cell(['%%python\n', 'y = x\n', 'print(x)'])
- ],
- metadata: python_notebook_metadata
- } as nbformat.INotebookContent;
-
- let notebook = environment.notebook;
-
- notebook.model = new NotebookModel();
- notebook.model.fromJSON(test_notebook);
- showAllCells(notebook);
-
- let main_document = environment.virtual_editor.virtual_document;
-
- let old_virtual_source = `x = get_ipython().run_line_magic("ls", "")
-print(x)
-
-
-get_ipython().run_cell_magic("python", "", """y = x
-print(x)""")
-`;
-
- let new_virtual_source = `z = get_ipython().run_line_magic("ls", "")
-print(z)
-
-
-get_ipython().run_cell_magic("python", "", """y = x
-print(x)""")
-`;
-
- await synchronizeContent();
- expect(main_document.value).to.be.equal(old_virtual_source);
-
- await feature.do_apply_edit({
- changes: {
- [main_document.document_info.uri]: [
- {
- range: {
- start: { line: 0, character: 0 },
- end: { line: 6, character: 10 }
- },
- newText: new_virtual_source
- } as lsProtocol.TextEdit
- ]
- }
- });
- await synchronizeContent();
- expect(main_document.value).to.be.equal(new_virtual_source);
-
- let code_cells = getCellsJSON(notebook);
-
- expect(code_cells[0]).to.have.property('source', 'z = %ls\nprint(z)');
- expect(code_cells[1]).to.have.property(
- 'source',
- '%%python\ny = x\nprint(x)'
- );
- });
- });
- });
-});
diff --git a/packages/jupyterlab-lsp/src/editor_integration/testutils.ts b/packages/jupyterlab-lsp/src/editor_integration/testutils.ts
deleted file mode 100644
index 041ce8580..000000000
--- a/packages/jupyterlab-lsp/src/editor_integration/testutils.ts
+++ /dev/null
@@ -1,438 +0,0 @@
-import { JupyterFrontEnd } from '@jupyterlab/application';
-import { ICellModel } from '@jupyterlab/cells';
-import { CodeEditor } from '@jupyterlab/codeeditor';
-import {
- CodeMirrorEditor,
- CodeMirrorEditorFactory,
- CodeMirrorMimeTypeService
-} from '@jupyterlab/codemirror';
-import {
- Context,
- IDocumentWidget,
- TextModelFactory
-} from '@jupyterlab/docregistry';
-import { FileEditor, FileEditorFactory } from '@jupyterlab/fileeditor';
-import { ILoggerRegistry } from '@jupyterlab/logconsole';
-import * as nbformat from '@jupyterlab/nbformat';
-import {
- Notebook,
- NotebookModel,
- NotebookModelFactory,
- NotebookPanel
-} from '@jupyterlab/notebook';
-import { ServiceManager } from '@jupyterlab/services';
-import { Mock, NBTestUtils } from '@jupyterlab/testutils';
-import { ITranslator } from '@jupyterlab/translation';
-import { Signal } from '@lumino/signaling';
-
-import { WidgetAdapter } from '../adapters/adapter';
-import { FileEditorAdapter } from '../adapters/file_editor/file_editor';
-import { NotebookAdapter } from '../adapters/notebook/notebook';
-import { LSPConnection } from '../connection';
-import { DocumentConnectionManager } from '../connection_manager';
-import { IForeignCodeExtractorsRegistry } from '../extractors/types';
-import { IFeatureSettings } from '../feature';
-import { FeatureManager, ILSPExtension } from '../index';
-import { LanguageServerManager } from '../manager';
-import { ICodeOverridesRegistry } from '../overrides/tokens';
-import {
- ILSPFeatureManager,
- ILSPLogConsole,
- ILSPVirtualEditorManager,
- WidgetAdapterConstructor
-} from '../tokens';
-import { CodeMirrorVirtualEditor } from '../virtual/codemirror_editor';
-import { BrowserConsole } from '../virtual/console';
-import { VirtualDocument } from '../virtual/document';
-import { IVirtualEditor, VirtualEditorManager } from '../virtual/editor';
-
-import {
- CodeMirrorIntegration,
- CodeMirrorIntegrationConstructor
-} from './codemirror';
-import { EditorAdapter } from './editor_adapter';
-
-import createNotebookPanel = NBTestUtils.createNotebookPanel;
-import IEditor = CodeEditor.IEditor;
-
-const DEFAULT_SERVER_ID = 'pylsp';
-
-export interface ITestEnvironment {
- document_options: VirtualDocument.IOptions;
-
- virtual_editor: CodeMirrorVirtualEditor;
-
- adapter: WidgetAdapter;
- /**
- * Has to be called after construction!
- */
- init(): void;
-
- dispose(): void;
-}
-
-export class MockLanguageServerManager extends LanguageServerManager {
- async fetchSessions() {
- this._sessions = new Map();
- this._sessions.set(DEFAULT_SERVER_ID, {
- spec: {
- languages: ['python']
- }
- } as any);
- this._sessionsChanged.emit(void 0);
- }
-}
-
-export class MockSettings implements IFeatureSettings {
- changed: Signal, void>;
-
- constructor(private settings: T) {
- this.changed = new Signal(this);
- }
-
- get composite(): Required {
- return this.settings as Required;
- }
-
- set(setting: keyof T, value: any): void {
- this.settings[setting] = value;
- }
-}
-
-export class MockExtension implements ILSPExtension {
- app: JupyterFrontEnd;
- connection_manager: DocumentConnectionManager;
- language_server_manager: LanguageServerManager;
- feature_manager: ILSPFeatureManager;
- editor_type_manager: ILSPVirtualEditorManager;
- foreign_code_extractors: IForeignCodeExtractorsRegistry;
- code_overrides: ICodeOverridesRegistry;
- console: ILSPLogConsole;
- user_console: ILoggerRegistry;
- translator: ITranslator;
-
- constructor() {
- this.app = null as any;
- this.feature_manager = new FeatureManager();
- this.editor_type_manager = new VirtualEditorManager();
- this.language_server_manager = new MockLanguageServerManager({
- console: new BrowserConsole()
- });
- this.connection_manager = new DocumentConnectionManager({
- language_server_manager: this.language_server_manager,
- console: new BrowserConsole()
- });
- this.editor_type_manager.registerEditorType({
- implementation: CodeMirrorVirtualEditor,
- name: 'CodeMirrorEditor',
- supports: CodeMirrorEditor
- });
- this.foreign_code_extractors = {};
- this.code_overrides = {};
- this.console = new BrowserConsole();
- this.user_console = null as any;
- }
-}
-
-export abstract class TestEnvironment implements ITestEnvironment {
- virtual_editor: CodeMirrorVirtualEditor;
- protected abstract get_adapter_type(): WidgetAdapterConstructor;
- adapter: WidgetAdapter;
- abstract widget: IDocumentWidget;
- protected extension: ILSPExtension;
- protected abstract get_defaults(): VirtualDocument.IOptions;
- public document_options: VirtualDocument.IOptions;
-
- constructor(options?: Partial) {
- this.document_options = {
- ...this.get_defaults(),
- ...(options || {})
- };
- this.extension = new MockExtension();
- this.init();
- }
-
- protected abstract create_widget(): IDocumentWidget;
-
- init() {
- this.widget = this.create_widget();
- let adapter_type = this.get_adapter_type();
- this.adapter = new adapter_type(this.extension, this.widget);
- this.virtual_editor = this.create_virtual_editor();
- // override the virtual editor with a mock/test one
- this.adapter.virtual_editor = this.virtual_editor;
- this.adapter.initialized
- .then(() => {
- // override it again after initialization
- // TODO: rewrite tests to async to only override after initialization
- this.adapter.virtual_editor = this.virtual_editor;
- })
- .catch(console.error);
- }
-
- create_virtual_editor(): CodeMirrorVirtualEditor {
- return new CodeMirrorVirtualEditor({
- adapter: this.adapter,
- virtual_document: new VirtualDocument(this.document_options)
- });
- }
-
- dispose(): void {
- this.adapter.dispose();
- }
-}
-
-export interface IFeatureTestEnvironment extends ITestEnvironment {
- init_integration(
- options: IFeatureTestEnvironment.IInitOptions
- ): T;
-
- dispose_feature(feature: CodeMirrorIntegration): void;
-}
-
-export namespace IFeatureTestEnvironment {
- export interface IInitOptions {
- constructor: CodeMirrorIntegrationConstructor;
- id: string;
- register?: boolean;
- document?: VirtualDocument;
- settings?: IFeatureSettings;
- }
-}
-
-type TestEnvironmentConstructor = new (...args: any[]) => ITestEnvironment;
-
-function FeatureSupport(Base: TBase) {
- return class FeatureTestEnvironment
- extends Base
- implements IFeatureTestEnvironment
- {
- _connections: Map;
-
- init() {
- this._connections = new Map();
- super.init();
- }
-
- get status_message() {
- return this.adapter.status_message;
- }
-
- public init_integration(
- options: IFeatureTestEnvironment.IInitOptions
- ): T {
- let connection = this.create_dummy_connection();
- let document = options.document
- ? options.document
- : this.virtual_editor.virtual_document;
-
- let editor_adapter = this.adapter.connect_adapter(document, connection, [
- {
- id: options.id,
- name: options.id,
- editorIntegrationFactory: new Map([
- ['CodeMirrorEditor', options.constructor]
- ]),
- settings: options.settings
- }
- ]);
- this.virtual_editor.virtual_document = document;
- document.changed.connect(async () => {
- await editor_adapter.updateAfterChange();
- });
-
- let feature = editor_adapter.features.get(options.id);
- this._connections.set(feature as CodeMirrorIntegration, connection);
- return feature as T;
- }
-
- public dispose_feature(feature: CodeMirrorIntegration) {
- let connection = this._connections.get(feature)!;
- connection.close();
- feature.is_registered = false;
- }
-
- public create_dummy_connection() {
- return new LSPConnection({
- languageId: this.document_options.language,
- serverUri: 'ws://localhost:8080',
- rootUri: 'file:///unit-test',
- serverIdentifier: DEFAULT_SERVER_ID,
- console: new BrowserConsole(),
- capabilities: {}
- });
- }
-
- public dispose() {
- super.dispose();
- for (let connection of this._connections.values()) {
- connection.close();
- }
- }
- };
-}
-
-export class FileEditorTestEnvironment extends TestEnvironment {
- protected get_adapter_type() {
- return FileEditorAdapter;
- }
- widget: IDocumentWidget;
-
- protected get_defaults(): VirtualDocument.IOptions {
- return {
- language: 'python',
- path: 'dummy.py',
- file_extension: 'py',
- has_lsp_supported_file: true,
- standalone: true,
- foreign_code_extractors: {},
- overrides_registry: {},
- console: new BrowserConsole()
- };
- }
-
- get ce_editor(): CodeMirrorEditor {
- return this.widget.content.editor as CodeMirrorEditor;
- }
-
- create_widget(): IDocumentWidget {
- let factory = new FileEditorFactory({
- editorServices: {
- factoryService: new CodeMirrorEditorFactory(),
- mimeTypeService: new CodeMirrorMimeTypeService()
- },
- factoryOptions: {
- name: 'Editor',
- fileTypes: ['*']
- }
- });
- const context = new Context({
- manager: new Mock.ServiceManagerMock(),
- factory: new TextModelFactory(),
- path: this.document_options.path
- });
- return factory.createNew(context);
- }
-
- dispose(): void {
- super.dispose();
- this.ce_editor.dispose();
- }
-}
-
-export class NotebookTestEnvironment extends TestEnvironment {
- public widget: NotebookPanel;
- protected get_adapter_type() {
- return NotebookAdapter;
- }
-
- get notebook(): Notebook {
- return this.widget.content;
- }
-
- protected get_defaults(): VirtualDocument.IOptions {
- return {
- language: 'python',
- path: 'notebook.ipynb',
- file_extension: 'py',
- overrides_registry: {},
- foreign_code_extractors: {},
- has_lsp_supported_file: false,
- standalone: true,
- console: new BrowserConsole()
- };
- }
-
- create_widget(): IDocumentWidget {
- let context = new Context({
- manager: new ServiceManager({ standby: 'never' }),
- factory: new NotebookModelFactory({}),
- path: this.document_options.path
- });
- return createNotebookPanel(context);
- }
-}
-
-export class FileEditorFeatureTestEnvironment extends FeatureSupport(
- FileEditorTestEnvironment
-) {}
-export class NotebookFeatureTestEnvironment extends FeatureSupport(
- NotebookTestEnvironment
-) {}
-
-export function code_cell(
- source: string[] | string,
- metadata: Partial = { trusted: false }
-) {
- return {
- cell_type: 'code',
- source: source,
- metadata: metadata,
- execution_count: null,
- outputs: []
- } as nbformat.ICodeCell;
-}
-
-export function set_notebook_content(
- notebook: Notebook,
- cells: nbformat.ICodeCell[],
- metadata = python_notebook_metadata
-) {
- let test_notebook = {
- cells: cells,
- metadata: metadata
- } as nbformat.INotebookContent;
-
- notebook.model = new NotebookModel();
- notebook.model.fromJSON(test_notebook);
-}
-
-export const python_notebook_metadata = {
- kernelspec: {
- display_name: 'Python [default]',
- language: 'python',
- name: 'python3'
- },
- language_info: {
- codemirror_mode: {
- name: 'ipython',
- version: 3
- },
- file_extension: '.py',
- mimetype: 'text/x-python',
- name: 'python',
- nbconvert_exporter: 'python',
- pygments_lexer: 'ipython3',
- version: '3.5.2'
- },
- orig_nbformat: 4.1
-} as nbformat.INotebookMetadata;
-
-export function showAllCells(notebook: Notebook) {
- notebook.show();
- // iterate over every cell to activate the editors
- for (let i = 0; i < notebook.model!.cells.length; i++) {
- notebook.activeCellIndex = i;
- notebook.activeCell!.show();
- }
-}
-
-export function getCellsJSON(notebook: Notebook): Array {
- let cells: Array = [];
- for (let i = 0; i < notebook.model!.cells.length; i++) {
- cells.push(notebook.model!.cells.get(i));
- }
- return cells.map(cell => cell.toJSON());
-}
-
-export async function synchronize_content(
- environment: IFeatureTestEnvironment,
- adapter: EditorAdapter>
-) {
- await environment.adapter.update_documents();
- try {
- await adapter.updateAfterChange();
- } catch (e) {
- console.warn(e);
- }
-}
diff --git a/packages/jupyterlab-lsp/src/edits.spec.ts b/packages/jupyterlab-lsp/src/edits.spec.ts
new file mode 100644
index 000000000..70a6f4b39
--- /dev/null
+++ b/packages/jupyterlab-lsp/src/edits.spec.ts
@@ -0,0 +1,342 @@
+import { PageConfig } from '@jupyterlab/coreutils';
+import { CodeExtractorsManager } from '@jupyterlab/lsp';
+import * as nbformat from '@jupyterlab/nbformat';
+import { NotebookModel } from '@jupyterlab/notebook';
+import * as lsProtocol from 'vscode-languageserver-protocol';
+
+import { EditApplicator } from './edits';
+import {
+ codeCell,
+ getCellsJSON,
+ python_notebook_metadata,
+ showAllCells,
+ FileEditorTestEnvironment,
+ NotebookTestEnvironment,
+ MockNotebookAdapter
+} from './testutils';
+import { foreignCodeExtractors } from './transclusions/ipython/extractors';
+import { overrides } from './transclusions/ipython/overrides';
+
+const js_fib_code = `function fib(n) {
+ return n<2?n:fib(n-1)+fib(n-2);
+}
+
+fib(5);
+
+window.location /;`;
+
+const js_fib2_code = `function fib2(n) {
+ return n<2?n:fib2(n-1)+fib2(n-2);
+}
+
+fib2(5);
+
+window.location /;`;
+
+const js_partial_edits = [
+ {
+ range: {
+ start: {
+ line: 0,
+ character: 9
+ },
+ end: {
+ line: 0,
+ character: 12
+ }
+ },
+ newText: 'fib2'
+ },
+ {
+ range: {
+ start: {
+ line: 1,
+ character: 15
+ },
+ end: {
+ line: 1,
+ character: 18
+ }
+ },
+ newText: 'fib2'
+ },
+ {
+ range: {
+ start: {
+ line: 1,
+ character: 24
+ },
+ end: {
+ line: 1,
+ character: 27
+ }
+ },
+ newText: 'fib2'
+ },
+ {
+ range: {
+ start: {
+ line: 4,
+ character: 0
+ },
+ end: {
+ line: 4,
+ character: 3
+ }
+ },
+ newText: 'fib2'
+ }
+];
+
+describe('EditApplicator', () => {
+ PageConfig.setOption('rootUri', 'file://');
+
+ describe('applyEdit()', () => {
+ describe('editing in FileEditor', () => {
+ let applicator: EditApplicator;
+ let environment: FileEditorTestEnvironment;
+
+ beforeEach(async () => {
+ environment = new FileEditorTestEnvironment();
+ await environment.init();
+ await environment.adapter.ready;
+ applicator = new EditApplicator(
+ environment.adapter.virtualDocument as any,
+ environment.adapter
+ );
+ });
+
+ afterEach(() => {
+ environment.dispose();
+ });
+
+ it('applies simple edit in FileEditor', async () => {
+ environment.activeEditor.model.sharedModel.setSource('foo bar');
+ await environment.adapter.updateDocuments();
+
+ let outcome = await applicator.applyEdit({
+ changes: {
+ ['file:///' + environment.documentOptions.path]: [
+ {
+ range: {
+ start: { line: 0, character: 0 },
+ end: { line: 1, character: 0 }
+ },
+ newText: 'changed bar'
+ } as lsProtocol.TextEdit
+ ]
+ }
+ });
+ expect(environment.activeEditor.model.sharedModel.source).toBe(
+ 'changed bar'
+ );
+ let raw_value = environment.activeEditor.editor.state.doc.toString();
+ expect(raw_value).toBe('changed bar');
+ expect(outcome.wasGranular).toBe(false);
+ expect(outcome.modifiedCells).toBe(1);
+ expect(outcome.appliedChanges).toBe(1);
+ });
+
+ it('correctly summarizes empty edit', async () => {
+ environment.activeEditor.model.sharedModel.setSource('foo bar');
+ await environment.adapter.updateDocuments();
+
+ let outcome = await applicator.applyEdit({
+ changes: {
+ ['file:///' + environment.documentOptions.path]: []
+ }
+ });
+ let raw_value = environment.activeEditor.editor.state.doc.toString();
+ expect(raw_value).toBe('foo bar');
+ expect(environment.activeEditor.model.sharedModel.source).toBe(
+ 'foo bar'
+ );
+ expect(outcome.wasGranular).toBe(false);
+ expect(outcome.appliedChanges).toBe(0);
+ expect(outcome.modifiedCells).toBe(0);
+ });
+
+ it('applies partial edits', async () => {
+ environment.activeEditor.model.sharedModel.setSource(js_fib_code);
+ await environment.adapter.updateDocuments();
+
+ let result = await applicator.applyEdit({
+ changes: {
+ ['file:///' + environment.documentOptions.path]: js_partial_edits
+ }
+ });
+ let raw_value = environment.activeEditor.editor.state.doc.toString();
+ expect(raw_value).toBe(js_fib2_code);
+ expect(environment.activeEditor.model.sharedModel.source).toBe(
+ js_fib2_code
+ );
+
+ expect(result.appliedChanges).toBe(js_partial_edits.length);
+ expect(result.wasGranular).toBe(true);
+ expect(result.modifiedCells).toBe(1);
+ });
+ });
+
+ describe('editing in Notebook', () => {
+ let applicator: EditApplicator;
+ let environment: NotebookTestEnvironment;
+
+ beforeEach(async () => {
+ const manager = new CodeExtractorsManager();
+ for (let language of Object.keys(foreignCodeExtractors)) {
+ for (let extractor of foreignCodeExtractors[language]) {
+ manager.register(extractor, language);
+ }
+ }
+ environment = new NotebookTestEnvironment({
+ document: {
+ overridesRegistry: {
+ python: {
+ cell: overrides.filter(override => override.scope == 'cell'),
+ line: overrides.filter(override => override.scope == 'line')
+ }
+ },
+ foreignCodeExtractors: manager
+ }
+ });
+ await environment.init();
+ applicator = new EditApplicator(
+ // TODO usptream, adatper should be parameterizable by virtual documentation class to allow overriding it more easily??
+ environment.adapter.virtualDocument as any,
+ environment.adapter
+ );
+ });
+
+ afterEach(() => {
+ environment.dispose();
+ });
+
+ async function synchronizeContent() {
+ await environment.adapter.updateDocuments();
+ }
+
+ it('applies edit across cells', async () => {
+ let test_notebook = {
+ cells: [
+ codeCell(['def a_function():', ' pass']),
+ codeCell(['x = a_function()'])
+ ],
+ metadata: python_notebook_metadata
+ } as nbformat.INotebookContent;
+
+ let notebook = environment.notebook;
+
+ notebook.model = new NotebookModel();
+ notebook.model.fromJSON(test_notebook);
+ showAllCells(notebook);
+
+ await synchronizeContent();
+ let mainDocument = environment.adapter.virtualDocument!;
+
+ let old_virtual_source =
+ 'def a_function():\n pass\n\n\nx = a_function()\n';
+ let new_virtual_source =
+ 'def a_function_2():\n pass\n\n\nx = a_function_2()\n';
+ expect(mainDocument.value).toBe(old_virtual_source);
+
+ let outcome = await applicator.applyEdit({
+ changes: {
+ [mainDocument.documentInfo.uri]: [
+ {
+ range: {
+ start: { line: 0, character: 0 },
+ end: { line: 5, character: 0 }
+ },
+ newText: new_virtual_source
+ } as lsProtocol.TextEdit
+ ]
+ }
+ });
+
+ await synchronizeContent();
+
+ let value = mainDocument.value;
+ expect(value).toBe(new_virtual_source);
+
+ let codeCells = getCellsJSON(notebook);
+
+ expect(codeCells[0]).toHaveProperty(
+ 'source',
+ 'def a_function_2():\n pass'
+ );
+ expect(codeCells[1]).toHaveProperty('source', 'x = a_function_2()');
+
+ expect(outcome.appliedChanges).toBe(1);
+ expect(outcome.wasGranular).toBe(false);
+ expect(outcome.modifiedCells).toBe(2);
+ });
+
+ it('handles IPython magics', async () => {
+ let test_notebook = {
+ cells: [
+ codeCell(['x = %ls', 'print(x)']),
+ codeCell(['%%python', 'y = x', 'print(x)'])
+ ],
+ metadata: python_notebook_metadata
+ } as nbformat.INotebookContent;
+
+ let notebook = environment.notebook;
+
+ notebook.model = new NotebookModel();
+ notebook.model.fromJSON(test_notebook);
+ showAllCells(notebook);
+
+ await (environment.adapter as MockNotebookAdapter).foreingDocumentOpened
+ .promise;
+
+ let mainDocument = environment.adapter.virtualDocument!;
+
+ let old_virtual_source = `x = get_ipython().run_line_magic("ls", "")
+print(x)
+
+
+get_ipython().run_cell_magic("python", "", """y = x
+print(x)""")
+`;
+
+ let new_virtual_source = `z = get_ipython().run_line_magic("ls", "")
+print(z)
+
+
+get_ipython().run_cell_magic("python", "", """y = x
+print(x)""")
+`;
+
+ await synchronizeContent();
+ expect(mainDocument.value).toBe(old_virtual_source);
+
+ await applicator.applyEdit({
+ changes: {
+ [mainDocument.documentInfo.uri]: [
+ {
+ range: {
+ start: { line: 0, character: 0 },
+ end: { line: 6, character: 10 }
+ },
+ newText: new_virtual_source
+ } as lsProtocol.TextEdit
+ ]
+ }
+ });
+ await (environment.adapter as MockNotebookAdapter).foreingDocumentOpened
+ .promise;
+
+ await synchronizeContent();
+ expect(mainDocument.value).toBe(new_virtual_source);
+
+ let codeCells = getCellsJSON(notebook);
+
+ expect(codeCells[0]).toHaveProperty('source', 'z = %ls\nprint(z)');
+ //expect(codeCells[1]).not.toHaveProperty(
+ // 'source',
+ // '%%python\ny = x\nprint(x)'
+ //);
+ });
+ });
+ });
+});
diff --git a/packages/jupyterlab-lsp/src/edits.ts b/packages/jupyterlab-lsp/src/edits.ts
new file mode 100644
index 000000000..f15b5704b
--- /dev/null
+++ b/packages/jupyterlab-lsp/src/edits.ts
@@ -0,0 +1,315 @@
+import {
+ IVirtualPosition,
+ offsetAtPosition,
+ WidgetLSPAdapter,
+ Document,
+ IPosition
+} from '@jupyterlab/lsp';
+import type * as lsProtocol from 'vscode-languageserver-protocol';
+
+import { PositionConverter } from './converter';
+import { DefaultMap, uris_equal } from './utils';
+import { VirtualDocument } from './virtual/document';
+
+export interface IEditOutcome {
+ appliedChanges: number | null;
+ modifiedCells: number;
+ wasGranular: boolean;
+ errors: string[];
+}
+
+function offsetFromLsp(position: lsProtocol.Position, lines: string[]) {
+ return offsetAtPosition(PositionConverter.lsp_to_ce(position), lines);
+}
+
+function toDocumentChanges(changes: {
+ [uri: string]: lsProtocol.TextEdit[];
+}): lsProtocol.TextDocumentEdit[] {
+ let documentChanges = [];
+ for (let uri of Object.keys(changes)) {
+ documentChanges.push({
+ textDocument: { uri },
+ edits: changes[uri]
+ } as lsProtocol.TextDocumentEdit);
+ }
+ return documentChanges;
+}
+
+export class EditApplicator {
+ constructor(
+ protected virtualDocument: VirtualDocument,
+ protected adapter: WidgetLSPAdapter
+ ) {
+ // no-op
+ }
+
+ async applyEdit(
+ workspaceEdit: lsProtocol.WorkspaceEdit
+ ): Promise {
+ let current_uri = this.virtualDocument.documentInfo.uri;
+
+ // Specs: documentChanges are preferred over changes
+ let changes = workspaceEdit.documentChanges
+ ? workspaceEdit.documentChanges.map(
+ change => change as lsProtocol.TextDocumentEdit
+ )
+ : toDocumentChanges(workspaceEdit.changes!);
+ let applied_changes = 0;
+ let edited_cells: number = 0;
+ let _isWholeDocumentEdit: boolean = false;
+ let errors: string[] = [];
+
+ for (let change of changes) {
+ let uri = change.textDocument.uri;
+
+ if (!uris_equal(uri, current_uri)) {
+ errors.push(
+ `Workspace-wide edits not implemented: ${uri} != ${current_uri}`
+ );
+ } else {
+ _isWholeDocumentEdit =
+ change.edits.length === 1 &&
+ this._isWholeDocumentEdit(change.edits[0]);
+
+ let edit: lsProtocol.TextEdit;
+
+ if (!_isWholeDocumentEdit) {
+ applied_changes = 0;
+ let value = this.virtualDocument.value;
+ // TODO: make sure that it was not changed since the request was sent (using the returned document version)
+ let lines = value.split('\n');
+
+ let edits_by_offset = new Map();
+ for (let e of change.edits) {
+ let offset = offsetFromLsp(e.range.start, lines);
+ if (edits_by_offset.has(offset)) {
+ console.warn(
+ 'Edits should not overlap, ignoring an overlapping edit'
+ );
+ } else {
+ edits_by_offset.set(offset, e);
+ applied_changes += 1;
+ }
+ }
+
+ // TODO make use of old_to_new_line for edits which add of remove lines:
+ // this is crucial to preserve cell boundaries in notebook in such cases
+ let old_to_new_line = new DefaultMap(() => []);
+ let new_text = '';
+ let last_end = 0;
+ let current_old_line = 0;
+ let current_new_line = 0;
+ // going over the edits in descending order of start points:
+ let start_offsets = [...edits_by_offset.keys()].sort((a, b) => a - b);
+ for (let start of start_offsets) {
+ let edit = edits_by_offset.get(start)!;
+ let prefix = value.slice(last_end, start);
+ for (let i = 0; i < prefix.split('\n').length; i++) {
+ let new_lines = old_to_new_line.get_or_create(current_old_line);
+ new_lines.push(current_new_line);
+ current_old_line += 1;
+ current_new_line += 1;
+ }
+ new_text += prefix + edit.newText;
+ let end = offsetFromLsp(edit.range.end, lines);
+ let replaced_fragment = value.slice(start, end);
+ for (let i = 0; i < edit.newText.split('\n').length; i++) {
+ if (i < replaced_fragment.length) {
+ current_old_line += 1;
+ }
+ current_new_line += 1;
+ let new_lines = old_to_new_line.get_or_create(current_old_line);
+ new_lines.push(current_new_line);
+ }
+ last_end = end;
+ }
+ new_text += value.slice(last_end, value.length);
+
+ edit = {
+ range: {
+ start: { line: 0, character: 0 },
+ end: {
+ line: lines.length - 1,
+ character: lines[lines.length - 1].length
+ }
+ },
+ newText: new_text
+ };
+ console.assert(this._isWholeDocumentEdit(edit));
+ } else {
+ edit = change.edits[0];
+ applied_changes += 1;
+ }
+ edited_cells = this._applySingleEdit(edit);
+ }
+ }
+ const all_empty = changes.every(change => change.edits.length === 0);
+ return {
+ appliedChanges: applied_changes,
+ modifiedCells: edited_cells,
+ wasGranular: !_isWholeDocumentEdit && !all_empty,
+ errors: errors
+ };
+ }
+
+ /**
+ * Does the edit cover the entire document?
+ */
+ private _isWholeDocumentEdit(edit: lsProtocol.TextEdit) {
+ let value = this.virtualDocument.value;
+ let lines = value.split('\n');
+ let range = edit.range;
+ let lsp_to_ce = PositionConverter.lsp_to_ce;
+ return (
+ offsetAtPosition(lsp_to_ce(range.start), lines) === 0 &&
+ offsetAtPosition(lsp_to_ce(range.end), lines) === value.length
+ );
+ }
+
+ private _replaceFragment(
+ newText: string,
+ editorAccessor: Document.IEditor,
+ fragment_start: IPosition,
+ fragment_end: IPosition,
+ start: IPosition,
+ end: IPosition,
+ _isWholeDocumentEdit = false
+ ): number {
+ let document = this.virtualDocument;
+ let newFragmentText = newText
+ .split('\n')
+ .slice(fragment_start.line - start.line, fragment_end.line - start.line)
+ .join('\n');
+
+ if (newFragmentText.endsWith('\n')) {
+ newFragmentText = newFragmentText.slice(0, -1);
+ }
+
+ const editor = editorAccessor.getEditor();
+ if (!editor) {
+ throw Error('Editor is not accessible');
+ }
+ // TODO: should accessor present the model even if editor is not created yet?
+ const model = editor.model;
+
+ let rawValue = model.sharedModel.source;
+ // extract foreign documents and substitute magics,
+ // as it was done when the shadow virtual document was being created
+ let { lines } = document.prepareCodeBlock({
+ value: rawValue,
+ ceEditor: editorAccessor,
+ type: 'code'
+ });
+ let old_value = lines.join('\n');
+
+ if (_isWholeDocumentEdit) {
+ // partial edit
+ let cm_to_ce = PositionConverter.cm_to_ce;
+ let up_to_offset = offsetAtPosition(cm_to_ce(start), lines);
+ let from_offset = offsetAtPosition(cm_to_ce(end), lines);
+ newFragmentText =
+ old_value.slice(0, up_to_offset) +
+ newText +
+ old_value.slice(from_offset);
+ }
+
+ if (old_value === newFragmentText) {
+ return 0;
+ }
+
+ let newValue = document.decodeCodeBlock(newFragmentText);
+
+ const cursor = editor.getCursorPosition();
+
+ model.sharedModel.updateSource(
+ editor.getOffsetAt({ line: 0, column: 0 }),
+ old_value.length,
+ newValue
+ );
+
+ try {
+ // try to restore the cursor to the position prior to the edit
+ // (this might not be the best UX, but definitely better than
+ // the cursor jumping to the very end of the cell/file).
+ editor.setSelection({ start: cursor, end: cursor });
+ // note: this does not matter for actions invoke from context menu
+ // as those loose focus anyways (this might be addressed elsewhere)
+ } catch (e) {
+ console.log('Could not place the cursor back', e);
+ }
+
+ return 1;
+ }
+
+ private _applySingleEdit(edit: lsProtocol.TextEdit): number {
+ let document = this.virtualDocument;
+ let applied_changes = 0;
+ let start = PositionConverter.lsp_to_cm(edit.range.start);
+ let end = PositionConverter.lsp_to_cm(edit.range.end);
+
+ let start_editor = document.getEditorAtVirtualLine(
+ start as IVirtualPosition
+ );
+ let end_editor = document.getEditorAtVirtualLine(end as IVirtualPosition);
+ if (start_editor !== end_editor) {
+ let last_editor = start_editor;
+ let fragment_start = start;
+ let fragment_end = { ...start };
+
+ let line = start.line;
+ let recently_replaced = false;
+ while (line <= end.line) {
+ line++;
+ let editor = document.getEditorAtVirtualLine({
+ line: line,
+ ch: 0
+ } as IVirtualPosition);
+
+ if (editor === last_editor) {
+ fragment_end.line = line;
+ fragment_end.ch = 0;
+ recently_replaced = false;
+ } else {
+ applied_changes += this._replaceFragment(
+ edit.newText,
+ last_editor,
+ fragment_start,
+ fragment_end,
+ start,
+ end
+ );
+ recently_replaced = true;
+ fragment_start = {
+ line: line,
+ ch: 0
+ };
+ fragment_end = {
+ line: line,
+ ch: 0
+ };
+ last_editor = editor;
+ }
+ }
+ if (!recently_replaced) {
+ applied_changes += this._replaceFragment(
+ edit.newText,
+ last_editor,
+ fragment_start,
+ fragment_end,
+ start,
+ end
+ );
+ }
+ } else {
+ applied_changes += this._replaceFragment(
+ edit.newText,
+ start_editor,
+ start,
+ end,
+ start,
+ end
+ );
+ }
+ return applied_changes;
+ }
+}
diff --git a/packages/jupyterlab-lsp/src/extractors/manager.ts b/packages/jupyterlab-lsp/src/extractors/manager.ts
deleted file mode 100644
index 3dd06abc4..000000000
--- a/packages/jupyterlab-lsp/src/extractors/manager.ts
+++ /dev/null
@@ -1,34 +0,0 @@
-import { JupyterFrontEndPlugin } from '@jupyterlab/application';
-
-import { ILSPCodeExtractorsManager } from '../tokens';
-
-import { IForeignCodeExtractor, IForeignCodeExtractorsRegistry } from './types';
-
-export class CodeExtractorsManager implements ILSPCodeExtractorsManager {
- registry: IForeignCodeExtractorsRegistry;
-
- constructor() {
- this.registry = {};
- }
-
- /**
- * Register an extractor to extract foreign code from host documents of specified language.
- */
- register(extractor: IForeignCodeExtractor, host_language: string): void {
- if (!this.registry.hasOwnProperty(host_language)) {
- this.registry[host_language] = [];
- }
- this.registry[host_language].push(extractor);
- }
-}
-
-export const CODE_EXTRACTORS_MANAGER: JupyterFrontEndPlugin =
- {
- id: ILSPCodeExtractorsManager.name,
- requires: [],
- activate: app => {
- return new CodeExtractorsManager();
- },
- provides: ILSPCodeExtractorsManager,
- autoStart: true
- };
diff --git a/packages/jupyterlab-lsp/src/extractors/regexp.spec.ts b/packages/jupyterlab-lsp/src/extractors/regexp.spec.ts
index 1789bd094..ce275facd 100644
--- a/packages/jupyterlab-lsp/src/extractors/regexp.spec.ts
+++ b/packages/jupyterlab-lsp/src/extractors/regexp.spec.ts
@@ -1,5 +1,3 @@
-import { expect } from 'chai';
-
import { RegExpForeignCodeExtractor, getIndexOfCaptureGroup } from './regexp';
let R_CELL_MAGIC_EXISTS = `%%R
@@ -35,7 +33,7 @@ describe('getIndexOfCaptureGroup', () => {
'%%python\nh',
'h'
);
- expect(result).to.be.equal(9);
+ expect(result).toBe(9);
});
});
@@ -43,79 +41,79 @@ describe('RegExpForeignCodeExtractor', () => {
let r_cell_extractor = new RegExpForeignCodeExtractor({
language: 'R',
pattern: '^%%R( .*?)?\n([^]*)',
- foreign_capture_groups: [2],
- keep_in_host: true,
- is_standalone: false,
- file_extension: 'R'
+ foreignCaptureGroups: [2],
+ keepInHost: true,
+ isStandalone: false,
+ fileExtension: 'R'
});
let r_line_extractor = new RegExpForeignCodeExtractor({
language: 'R',
pattern: '(^|\n)%R (.*)\n?',
- foreign_capture_groups: [2],
- keep_in_host: true,
- is_standalone: false,
- file_extension: 'R'
+ foreignCaptureGroups: [2],
+ keepInHost: true,
+ isStandalone: false,
+ fileExtension: 'R'
});
let python_cell_extractor = new RegExpForeignCodeExtractor({
language: 'python',
pattern: '^%%(python|python2|python3|pypy)( .*?)?\\n([^]*)',
- foreign_capture_groups: [3],
- keep_in_host: true,
- is_standalone: true,
- file_extension: 'py'
+ foreignCaptureGroups: [3],
+ keepInHost: true,
+ isStandalone: true,
+ fileExtension: 'py'
});
- describe('#has_foreign_code()', () => {
+ describe('#hasForeignCode()', () => {
it('detects cell magics', () => {
- let result = r_cell_extractor.has_foreign_code(R_CELL_MAGIC_EXISTS);
- expect(result).to.equal(true);
+ let result = r_cell_extractor.hasForeignCode(R_CELL_MAGIC_EXISTS);
+ expect(result).toBe(true);
- result = r_cell_extractor.has_foreign_code(R_LINE_MAGICS);
- expect(result).to.equal(false);
+ result = r_cell_extractor.hasForeignCode(R_LINE_MAGICS);
+ expect(result).toBe(false);
- result = r_cell_extractor.has_foreign_code(NO_CELL_MAGIC);
- expect(result).to.equal(false);
+ result = r_cell_extractor.hasForeignCode(NO_CELL_MAGIC);
+ expect(result).toBe(false);
});
it('is not stateful', () => {
// stateful implementation of regular expressions in JS can easily lead to
// an error manifesting it two consecutive checks giving different results,
// as the last index was moved in between:
- let result = r_cell_extractor.has_foreign_code(R_CELL_MAGIC_EXISTS);
- expect(result).to.equal(true);
+ let result = r_cell_extractor.hasForeignCode(R_CELL_MAGIC_EXISTS);
+ expect(result).toBe(true);
- result = r_cell_extractor.has_foreign_code(R_CELL_MAGIC_EXISTS);
- expect(result).to.equal(true);
+ result = r_cell_extractor.hasForeignCode(R_CELL_MAGIC_EXISTS);
+ expect(result).toBe(true);
});
it('detects line magics', () => {
- let result = r_line_extractor.has_foreign_code(R_LINE_MAGICS);
- expect(result).to.equal(true);
+ let result = r_line_extractor.hasForeignCode(R_LINE_MAGICS);
+ expect(result).toBe(true);
- result = r_line_extractor.has_foreign_code(R_CELL_MAGIC_EXISTS);
- expect(result).to.equal(false);
+ result = r_line_extractor.hasForeignCode(R_CELL_MAGIC_EXISTS);
+ expect(result).toBe(false);
});
});
- describe('#extract_foreign_code()', () => {
+ describe('#extractForeignCode()', () => {
it('should correctly return the range', () => {
- let results = python_cell_extractor.extract_foreign_code(
+ let results = python_cell_extractor.extractForeignCode(
PYTHON_CELL_MAGIC_WITH_H
);
- expect(results.length).to.equal(1);
+ expect(results.length).toBe(1);
let result = results[0];
// test against https://github.com/jupyter-lsp/jupyterlab-lsp/issues/559
- expect(result.host_code).to.equal(PYTHON_CELL_MAGIC_WITH_H);
- expect(result.foreign_code).to.equal('h');
+ expect(result.hostCode).toBe(PYTHON_CELL_MAGIC_WITH_H);
+ expect(result.foreignCode).toBe('h');
- expect(result.range!.start.line).to.equal(1);
- expect(result.range!.start.column).to.equal(0);
- expect(result.range!.end.line).to.equal(1);
- expect(result.range!.end.column).to.equal(1);
+ expect(result.range!.start.line).toBe(1);
+ expect(result.range!.start.column).toBe(0);
+ expect(result.range!.end.line).toBe(1);
+ expect(result.range!.end.column).toBe(1);
});
it('should work with non-line magic and non-cell magic code snippets as well', () => {
@@ -124,129 +122,129 @@ describe('RegExpForeignCodeExtractor', () => {
let html_extractor = new RegExpForeignCodeExtractor({
language: 'HTML',
pattern: '(<(.*?)( .*?)?>([^]*?))',
- foreign_capture_groups: [1],
- keep_in_host: false,
- is_standalone: false,
- file_extension: 'html'
+ foreignCaptureGroups: [1],
+ keepInHost: false,
+ isStandalone: false,
+ fileExtension: 'html'
});
- let results = html_extractor.extract_foreign_code(HTML_IN_PYTHON);
- expect(results.length).to.equal(2);
+ let results = html_extractor.extractForeignCode(HTML_IN_PYTHON);
+ expect(results.length).toBe(2);
let result = results[0];
// TODO: is tolerating the new line added here ok?
- expect(result.host_code).to.equal('\nx = """\n');
- expect(result.foreign_code).to.equal(
+ expect(result.hostCode).toBe('\nx = """\n');
+ expect(result.foreignCode).toBe(
'\nimportant link\n'
);
- expect(result.range!.start.line).to.equal(1);
- expect(result.range!.start.column).to.equal(7);
- expect(result.range!.end.line).to.equal(3);
- expect(result.range!.end.column).to.equal(4);
+ expect(result.range!.start.line).toBe(1);
+ expect(result.range!.start.column).toBe(7);
+ expect(result.range!.end.line).toBe(3);
+ expect(result.range!.end.column).toBe(4);
let last_bit = results[1];
- expect(last_bit.host_code).to.equal('""";\nprint(x)');
+ expect(last_bit.hostCode).toBe('""";\nprint(x)');
});
it('should extract cell magics and keep in host', () => {
- let results = r_cell_extractor.extract_foreign_code(R_CELL_MAGIC_EXISTS);
- expect(results.length).to.equal(1);
+ let results = r_cell_extractor.extractForeignCode(R_CELL_MAGIC_EXISTS);
+ expect(results.length).toBe(1);
let result = results[0];
- expect(result.host_code).to.equal(R_CELL_MAGIC_EXISTS);
- expect(result.foreign_code).to.equal('some text\n');
- expect(result.range!.start.line).to.equal(1);
- expect(result.range!.start.column).to.equal(0);
+ expect(result.hostCode).toBe(R_CELL_MAGIC_EXISTS);
+ expect(result.foreignCode).toBe('some text\n');
+ expect(result.range!.start.line).toBe(1);
+ expect(result.range!.start.column).toBe(0);
});
it('should extract and remove from host', () => {
let extractor = new RegExpForeignCodeExtractor({
language: 'R',
pattern: '^%%R( .*?)?\n([^]*)',
- foreign_capture_groups: [2],
- keep_in_host: false,
- is_standalone: false,
- file_extension: 'R'
+ foreignCaptureGroups: [2],
+ keepInHost: false,
+ isStandalone: false,
+ fileExtension: 'R'
});
- let results = extractor.extract_foreign_code(R_CELL_MAGIC_EXISTS);
- expect(results.length).to.equal(1);
+ let results = extractor.extractForeignCode(R_CELL_MAGIC_EXISTS);
+ expect(results.length).toBe(1);
let result = results[0];
- expect(result.foreign_code).to.equal('some text\n');
- expect(result.host_code).to.equal('');
+ expect(result.foreignCode).toBe('some text\n');
+ expect(result.hostCode).toBe('');
});
it('should extract multiple line magics deleting them from host', () => {
let r_line_extractor = new RegExpForeignCodeExtractor({
language: 'R',
pattern: '(^|\n)%R (.*)\n?',
- foreign_capture_groups: [2],
- keep_in_host: false,
- is_standalone: false,
- file_extension: 'R'
+ foreignCaptureGroups: [2],
+ keepInHost: false,
+ isStandalone: false,
+ fileExtension: 'R'
});
- let results = r_line_extractor.extract_foreign_code(R_LINE_MAGICS);
+ let results = r_line_extractor.extractForeignCode(R_LINE_MAGICS);
// 2 line magics to be extracted + the unprocessed host code
- expect(results.length).to.eq(3);
+ expect(results.length).toBe(3);
let first_magic = results[0];
- expect(first_magic.foreign_code).to.equal('df = data.frame()');
- expect(first_magic.host_code).to.equal('');
+ expect(first_magic.foreignCode).toBe('df = data.frame()');
+ expect(first_magic.hostCode).toBe('');
let second_magic = results[1];
- expect(second_magic.foreign_code).to.equal('ggplot(df)');
- expect(second_magic.host_code).to.equal('print("df created")\n');
+ expect(second_magic.foreignCode).toBe('ggplot(df)');
+ expect(second_magic.hostCode).toBe('print("df created")\n');
let final_bit = results[2];
- expect(final_bit.foreign_code).to.equal(null);
- expect(final_bit.host_code).to.equal('print("plotted")\n');
+ expect(final_bit.foreignCode).toBe(null);
+ expect(final_bit.hostCode).toBe('print("plotted")\n');
});
it('should extract multiple line magics preserving them in host', () => {
- let results = r_line_extractor.extract_foreign_code(R_LINE_MAGICS);
+ let results = r_line_extractor.extractForeignCode(R_LINE_MAGICS);
// 2 line magics to be extracted + the unprocessed host code
- expect(results.length).to.eq(3);
+ expect(results.length).toBe(3);
let first_magic = results[0];
- expect(first_magic.foreign_code).to.equal('df = data.frame()');
- expect(first_magic.host_code).to.equal('%R df = data.frame()\n');
- expect(first_magic.range!.end.line).to.equal(0);
- expect(first_magic.range!.end.column).to.equal(20);
+ expect(first_magic.foreignCode).toBe('df = data.frame()');
+ expect(first_magic.hostCode).toBe('%R df = data.frame()\n');
+ expect(first_magic.range!.end.line).toBe(0);
+ expect(first_magic.range!.end.column).toBe(20);
let second_magic = results[1];
- expect(second_magic.foreign_code).to.equal('ggplot(df)');
- expect(second_magic.host_code).to.equal(
+ expect(second_magic.foreignCode).toBe('ggplot(df)');
+ expect(second_magic.hostCode).toBe(
'print("df created")\n%R ggplot(df)\n'
);
let final_bit = results[2];
- expect(final_bit.foreign_code).to.equal(null);
- expect(final_bit.host_code).to.equal('print("plotted")\n');
+ expect(final_bit.foreignCode).toBe(null);
+ expect(final_bit.hostCode).toBe('print("plotted")\n');
});
it('should extract single line magic which does not end with a blank line', () => {
- let results = r_line_extractor.extract_foreign_code('%R test');
+ let results = r_line_extractor.extractForeignCode('%R test');
- expect(results.length).to.eq(1);
+ expect(results.length).toBe(1);
let result = results[0];
- expect(result.foreign_code).to.equal('test');
+ expect(result.foreignCode).toBe('test');
});
it('should not extract magic-like text from the middle of the cell', () => {
- let results = r_cell_extractor.extract_foreign_code(NO_CELL_MAGIC);
+ let results = r_cell_extractor.extractForeignCode(NO_CELL_MAGIC);
- expect(results.length).to.eq(1);
+ expect(results.length).toBe(1);
let result = results[0];
- expect(result.foreign_code).to.equal(null);
- expect(result.host_code).to.equal(NO_CELL_MAGIC);
- expect(result.range).to.equal(null);
+ expect(result.foreignCode).toBe(null);
+ expect(result.hostCode).toBe(NO_CELL_MAGIC);
+ expect(result.range).toBe(null);
});
});
});
diff --git a/packages/jupyterlab-lsp/src/extractors/regexp.ts b/packages/jupyterlab-lsp/src/extractors/regexp.ts
index f98cb6100..5f702c3e2 100644
--- a/packages/jupyterlab-lsp/src/extractors/regexp.ts
+++ b/packages/jupyterlab-lsp/src/extractors/regexp.ts
@@ -1,181 +1,184 @@
import { CodeEditor } from '@jupyterlab/codeeditor';
+import {
+ positionAtOffset,
+ IExtractedCode,
+ IForeignCodeExtractor
+} from '@jupyterlab/lsp';
import { replacer } from '../overrides/tokens';
-import { position_at_offset } from '../positioning';
-
-import { IExtractedCode, IForeignCodeExtractor } from './types';
export function getIndexOfCaptureGroup(
expression: RegExp,
- matched_string: string,
- value_of_captured_group: string
+ matchedString: string,
+ valueOfCapturedGroup: string
): number {
// TODO: use https://github.com/tc39/proposal-regexp-match-indices once supported in >95% of browsers
// (probably around 2025)
// get index of the part that is being extracted to foreign document
- let captured_groups = expression.exec(matched_string);
+ let capturedGroups = expression.exec(matchedString);
- if (captured_groups == null) {
+ if (capturedGroups == null) {
console.warn(
- `No capture group found for ${expression} in ${matched_string}`
+ `No capture group found for ${expression} in ${matchedString}`
);
return -1;
}
- let offset_in_match = 0;
+ let offsetInMatch = 0;
// first element is a full match
- let full_matched = captured_groups[0];
+ let fullMatched = capturedGroups[0];
- for (let group of captured_groups.slice(1)) {
+ for (let group of capturedGroups.slice(1)) {
if (typeof group === 'undefined') {
continue;
}
- if (group === value_of_captured_group) {
- offset_in_match += full_matched.indexOf(group);
+ if (group === valueOfCapturedGroup) {
+ offsetInMatch += fullMatched.indexOf(group);
break;
}
- let group_end_offset = full_matched.indexOf(group) + group.length;
+ let groupEndOffset = fullMatched.indexOf(group) + group.length;
- full_matched = full_matched.slice(group_end_offset);
- offset_in_match += group_end_offset;
+ fullMatched = fullMatched.slice(groupEndOffset);
+ offsetInMatch += groupEndOffset;
}
- return offset_in_match;
+ return offsetInMatch;
}
export class RegExpForeignCodeExtractor implements IForeignCodeExtractor {
options: RegExpForeignCodeExtractor.IOptions;
language: string;
- global_expression: RegExp;
- test_expression: RegExp;
+ globalExpression: RegExp;
+ testExpression: RegExp;
expression: RegExp;
standalone: boolean;
- file_extension: string;
+ fileExtension: string;
+ cellType: string[] = ['code'];
constructor(options: RegExpForeignCodeExtractor.IOptions) {
this.language = options.language;
this.options = options;
- this.global_expression = new RegExp(options.pattern, 'g');
- this.test_expression = new RegExp(options.pattern, 'g');
+ this.globalExpression = new RegExp(options.pattern, 'g');
+ this.testExpression = new RegExp(options.pattern, 'g');
this.expression = new RegExp(options.pattern);
- this.standalone = this.options.is_standalone;
- this.file_extension = this.options.file_extension;
+ this.standalone = this.options.isStandalone;
+ this.fileExtension = this.options.fileExtension;
}
- has_foreign_code(code: string): boolean {
- let result = this.test_expression.test(code);
- this.test_expression.lastIndex = 0;
+ hasForeignCode(code: string): boolean {
+ const result = this.testExpression.test(code);
+ this.testExpression.lastIndex = 0;
return result;
}
- extract_foreign_code(code: string): IExtractedCode[] {
- let lines = code.split('\n');
+ extractForeignCode(code: string): IExtractedCode[] {
+ const lines = code.split('\n');
- let extracts = new Array();
+ const extracts = new Array();
- let started_from = this.global_expression.lastIndex;
- let match: RegExpExecArray | null = this.global_expression.exec(code);
- let host_code_fragment: string;
+ let startedFrom = this.globalExpression.lastIndex;
+ let match: RegExpExecArray | null = this.globalExpression.exec(code);
+ let hostCodeFragment: string;
- let chosen_replacer: string | replacer;
- let is_new_api_replacer: boolean = false;
+ let chosenReplacer: string | replacer;
+ let isNewApiReplacer: boolean = false;
- if (typeof this.options.foreign_replacer !== 'undefined') {
- chosen_replacer = this.options.foreign_replacer;
- is_new_api_replacer = true;
- } else if (typeof this.options.foreign_capture_groups !== 'undefined') {
- chosen_replacer = '$' + this.options.foreign_capture_groups.join('$');
- is_new_api_replacer = true;
- } else if (this.options.extract_to_foreign) {
- chosen_replacer = this.options.extract_to_foreign;
+ if (typeof this.options.foreignReplacer !== 'undefined') {
+ chosenReplacer = this.options.foreignReplacer;
+ isNewApiReplacer = true;
+ } else if (typeof this.options.foreignCaptureGroups !== 'undefined') {
+ chosenReplacer = '$' + this.options.foreignCaptureGroups.join('$');
+ isNewApiReplacer = true;
+ } else if (this.options.extractToForeign) {
+ chosenReplacer = this.options.extractToForeign;
} else {
console.warn(
- `Foreign replacer not defined for extractor: {this.expression} - this is deprecated; use 'foreign_replacer' to define it`
+ `Foreign replacer not defined for extractor: {this.expression} - this is deprecated; use 'foreignReplacer' to define it`
);
return [];
}
while (match != null) {
- let matched_string = match[0];
- let position_shift: CodeEditor.IPosition | null = null;
+ let matchedString = match[0];
+ let positionShift: CodeEditor.IPosition | null = null;
- let foreign_code_fragment = matched_string.replace(
+ let foreignCodeFragment = matchedString.replace(
this.expression,
// eslint-disable-next-line @typescript-eslint/ban-ts-comment
// @ts-ignore
- chosen_replacer
+ chosenReplacer
);
let prefix = '';
- if (typeof this.options.extract_arguments !== 'undefined') {
- prefix = matched_string.replace(
+ if (typeof this.options.extractArguments !== 'undefined') {
+ prefix = matchedString.replace(
this.expression,
// eslint-disable-next-line @typescript-eslint/ban-ts-comment
// @ts-ignore
- this.options.extract_arguments
+ this.options.extractArguments
);
- position_shift = position_at_offset(prefix.length, prefix.split('\n'));
+ positionShift = positionAtOffset(prefix.length, prefix.split('\n'));
}
// NOTE:
- // match.index + matched_string.length === this.sticky_expression.lastIndex
+ // match.index + matchedString.length === this.sticky_expression.lastIndex
- let end_index = this.global_expression.lastIndex;
+ let endIndex = this.globalExpression.lastIndex;
- if (this.options.keep_in_host || this.options.keep_in_host == null) {
- host_code_fragment = code.substring(started_from, end_index);
+ if (this.options.keepInHost || this.options.keepInHost == null) {
+ hostCodeFragment = code.substring(startedFrom, endIndex);
} else {
- if (started_from === match.index) {
- host_code_fragment = '';
+ if (startedFrom === match.index) {
+ hostCodeFragment = '';
} else {
- host_code_fragment = code.substring(started_from, match.index) + '\n';
+ hostCodeFragment = code.substring(startedFrom, match.index) + '\n';
}
}
- let foreign_code_group_value = foreign_code_fragment;
+ let foreignCodeGroupValue = foreignCodeFragment;
- if (is_new_api_replacer) {
- foreign_code_group_value = matched_string.replace(
+ if (isNewApiReplacer) {
+ foreignCodeGroupValue = matchedString.replace(
this.expression,
- '$' + Math.min(...this.options.foreign_capture_groups!)
+ '$' + Math.min(...this.options.foreignCaptureGroups!)
);
}
- const foreign_group_index_in_match = getIndexOfCaptureGroup(
+ const foreignGroupIndexInMatch = getIndexOfCaptureGroup(
this.expression,
- matched_string,
- foreign_code_group_value
+ matchedString,
+ foreignCodeGroupValue
);
- let start_offset = match.index + foreign_group_index_in_match;
+ let startOffset = match.index + foreignGroupIndexInMatch;
- let start = position_at_offset(start_offset, lines);
- let end = position_at_offset(
- start_offset + foreign_code_fragment.length,
+ let start = positionAtOffset(startOffset, lines);
+ let end = positionAtOffset(
+ startOffset + foreignCodeFragment.length,
lines
);
extracts.push({
- host_code: host_code_fragment,
- foreign_code: prefix + foreign_code_fragment,
+ hostCode: hostCodeFragment,
+ foreignCode: prefix + foreignCodeFragment,
range: { start, end },
- virtual_shift: position_shift
+ virtualShift: positionShift
});
- started_from = this.global_expression.lastIndex;
- match = this.global_expression.exec(code);
+ startedFrom = this.globalExpression.lastIndex;
+ match = this.globalExpression.exec(code);
}
- if (started_from !== code.length) {
- let final_host_code_fragment = code.substring(started_from, code.length);
+ if (startedFrom !== code.length) {
+ let finalHostCodeFragment = code.substring(startedFrom, code.length);
extracts.push({
- host_code: final_host_code_fragment,
- foreign_code: null,
+ hostCode: finalHostCodeFragment,
+ foreignCode: null,
range: null,
- virtual_shift: null
+ virtualShift: null
});
}
@@ -203,30 +206,30 @@ namespace RegExpForeignCodeExtractor {
* For the R example this should be `3`. Please not that these are 1-based, as the 0th index is the full match.
* If multiple groups are given, those will be concatenated.
*
- * If additional code is needed in between the groups, use `foreign_replacer` in addition to
- * `foreign_capture_groups` (but not instead!).
+ * If additional code is needed in between the groups, use `foreignReplacer` in addition to
+ * `foreignCaptureGroups` (but not instead!).
*
- * `foreign_capture_groups` is required for proper offset calculation and will no longer be optional in 4.0.
+ * `foreignCaptureGroups` is required for proper offset calculation and will no longer be optional in 4.0.
*/
- foreign_capture_groups?: number[];
+ foreignCaptureGroups?: number[];
/**
* Function to compose the foreign document code, in case if using a capture group alone is not sufficient;
* If specified, `foreign_capture_group` should be specified as well, so that it points to the first occurrence
- * of the foreign code. When both are specified, `foreign_replacer` takes precedence.
+ * of the foreign code. When both are specified, `foreignReplacer` takes precedence.
*
* See:
* https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/replace#specifying_a_function_as_a_parameter
*/
- foreign_replacer?: replacer;
+ foreignReplacer?: replacer;
/**
- * @deprecated `extract_to_foreign` will be removed in 4.0; use `foreign_capture_group` or `foreign_replacer` instead
+ * @deprecated `extractToForeign` will be removed in 4.0; use `foreign_capture_group` or `foreignReplacer` instead
*/
- extract_to_foreign?: string | replacer;
+ extractToForeign?: string | replacer;
/**
* If arguments from the cell or line magic are to be extracted and prepended before the extracted code,
- * set extract_arguments to a replacer function taking the code and returning the string to be prepended.
+ * set extractArguments to a replacer function taking the code and returning the string to be prepended.
*/
- extract_arguments?: replacer;
+ extractArguments?: replacer;
/**
* Boolean if everything (true, default) or nothing (false) should be kept in the host document.
*
@@ -238,14 +241,14 @@ namespace RegExpForeignCodeExtractor {
* Setting to false is DEPRECATED as it breaks the edit feature (while it could be fixed,
* it would make the code considerably more complex).
*
- * @deprecated `keep_in_host` will be removed in 4.0
+ * @deprecated `keepInHost` will be removed in 4.0
*/
- keep_in_host?: boolean;
+ keepInHost?: boolean;
/**
* Should the foreign code be appended (False) to the previously established virtual document of the same language,
* or is it standalone snippet which requires separate connection?
*/
- is_standalone: boolean;
- file_extension: string;
+ isStandalone: boolean;
+ fileExtension: string;
}
}
diff --git a/packages/jupyterlab-lsp/src/extractors/testutils.ts b/packages/jupyterlab-lsp/src/extractors/testutils.ts
index 4c6c63141..ee0740eb2 100644
--- a/packages/jupyterlab-lsp/src/extractors/testutils.ts
+++ b/packages/jupyterlab-lsp/src/extractors/testutils.ts
@@ -1,11 +1,27 @@
import { CodeEditor } from '@jupyterlab/codeeditor';
-import { expect } from 'chai';
-
-import { IVirtualDocumentBlock, VirtualDocument } from '../virtual/document';
+import {
+ Document,
+ VirtualDocument,
+ CodeExtractorsManager
+} from '@jupyterlab/lsp';
+
+import { IForeignCodeExtractorsRegistry } from '../extractors/types';
+
+export function mockExtractorsManager(
+ foreignCodeExtractors: IForeignCodeExtractorsRegistry
+): CodeExtractorsManager {
+ const extractorManager = new CodeExtractorsManager();
+ for (const [language, list] of Object.entries(foreignCodeExtractors)) {
+ for (const extractor of list) {
+ extractorManager.register(extractor, language);
+ }
+ }
+ return extractorManager;
+}
-export function extract_code(document: VirtualDocument, code: string) {
- return document.extract_foreign_code(
- { value: code, ce_editor: null as any },
+export function extractCode(document: VirtualDocument, code: string) {
+ return document.extractForeignCode(
+ { value: code, ceEditor: null as any, type: 'code' },
{
line: 0,
column: 0
@@ -15,27 +31,27 @@ export function extract_code(document: VirtualDocument, code: string) {
interface IDocumentWithRange {
range: CodeEditor.IRange;
- virtual_document: VirtualDocument;
+ virtualDocument: VirtualDocument;
}
-export function get_the_only_pair(
- foreign_document_map: Map
+export function getTheOnlyPair(
+ foreignDocument_map: Map
): IDocumentWithRange {
- expect(foreign_document_map.size).to.equal(1);
+ expect(foreignDocument_map.size).toBe(1);
- let range = foreign_document_map.keys().next().value;
- let { virtual_document } = foreign_document_map.get(range)!;
+ let range = foreignDocument_map.keys().next().value;
+ let { virtualDocument } = foreignDocument_map.get(range)!;
- return { range, virtual_document };
+ return { range, virtualDocument };
}
-export function get_the_only_virtual(
- foreign_document_map: Map
+export function getTheOnlyVirtual(
+ foreignDocument_map: Map
) {
- let { virtual_document } = get_the_only_pair(foreign_document_map);
- return virtual_document;
+ let { virtualDocument } = getTheOnlyPair(foreignDocument_map);
+ return virtualDocument;
}
-export function wrap_in_python_lines(line: string) {
+export function wrapInPythonLines(line: string) {
return 'print("some code before")\n' + line + '\n' + 'print("and after")\n';
}
diff --git a/packages/jupyterlab-lsp/src/extractors/types.ts b/packages/jupyterlab-lsp/src/extractors/types.ts
index 710f65f75..579075d09 100644
--- a/packages/jupyterlab-lsp/src/extractors/types.ts
+++ b/packages/jupyterlab-lsp/src/extractors/types.ts
@@ -1,70 +1,4 @@
-import { CodeEditor } from '@jupyterlab/codeeditor';
-
-import { LanguageIdentifier } from '../lsp';
-
-export interface IExtractedCode {
- /**
- * Foreign code (may be empty, for example line of '%R') or null if none.
- */
- foreign_code: string | null;
- /**
- * Range of the foreign code relative to the original source.
- * `null` is used internally to represent a leftover host code after extraction.
- */
- range: CodeEditor.IRange | null;
- /**
- * Shift due to any additional code inserted at the beginning of the virtual document
- * (usually in order to mock the arguments passed to a magic, or to provide other context clues for the linters)
- */
- virtual_shift: CodeEditor.IPosition | null;
- /**
- * Code to be retained in the virtual document of the host.
- */
- host_code: string | null;
-}
-
-/**
- * Foreign code extractor makes it possible to analyze code of language X embedded in code (or notebook) of language Y.
- *
- * The typical examples are:
- * - (X=CSS< Y=HTML), or
- * - (X=JavaScript, Y=HTML),
- *
- * while in the data analysis realm, examples include:
- * - (X=R, Y=IPython),
- * - (X=LATEX Y=IPython),
- * - (X=SQL, Y=IPython)
- *
- * This extension does not aim to provide comprehensive abilities for foreign code extraction,
- * but it does intend to provide stable interface for other extensions to build on it.
- *
- * A simple, regular expression based, configurable foreign extractor is implemented
- * to provide a good reference and a good initial experience for the users.
- */
-export interface IForeignCodeExtractor {
- /**
- * The foreign language.
- */
- language: LanguageIdentifier;
-
- /**
- * Split the code into the host and foreign code (if any foreign code was detected)
- */
- extract_foreign_code(code: string): IExtractedCode[];
- /**
- * Does the extractor produce code which should be appended to the previously established virtual document (False)
- * of the same language, or does it produce standalone snippets which require separate connections (True)?
- */
- standalone: boolean;
- /**
- * Test if there is any foreign code in provided code snippet.
- */
- has_foreign_code(code: string): boolean;
- /**
- * Extension of the virtual document (some servers check extensions of files), e.g. 'py' or 'R'.
- */
- file_extension: string;
-}
+import { IForeignCodeExtractor } from '@jupyterlab/lsp';
export interface IForeignCodeExtractorsRegistry {
[host_language: string]: IForeignCodeExtractor[];
diff --git a/packages/jupyterlab-lsp/src/feature.ts b/packages/jupyterlab-lsp/src/feature.ts
index bb575f52a..19447ab7e 100644
--- a/packages/jupyterlab-lsp/src/feature.ts
+++ b/packages/jupyterlab-lsp/src/feature.ts
@@ -1,59 +1,8 @@
-import { CodeEditor } from '@jupyterlab/codeeditor';
-import { IDocumentWidget } from '@jupyterlab/docregistry';
+import { IFeature, ILSPDocumentConnectionManager } from '@jupyterlab/lsp';
import { ISettingRegistry } from '@jupyterlab/settingregistry';
-import { TranslationBundle } from '@jupyterlab/translation';
-import { LabIcon } from '@jupyterlab/ui-components';
import { PromiseDelegate } from '@lumino/coreutils';
import { Signal } from '@lumino/signaling';
-
-import { StatusMessage, WidgetAdapter } from './adapters/adapter';
-import { CommandEntryPoint, ICommandContext } from './command_manager';
-import { LSPConnection } from './connection';
-import { ClientCapabilities } from './lsp';
-import { IRootPosition } from './positioning';
-import { VirtualDocument } from './virtual/document';
-import { IEditorChange, IVirtualEditor } from './virtual/editor';
-
-import IEditor = CodeEditor.IEditor;
-
-export interface IFeatureCommand {
- /**
- * The command id; it will be prepended with 'lsp' prefix.
- * To support multiple attachment points, multiple actual commands will be created,
- * identified by an attachment-point-specific suffix.
- */
- id: string;
- /**
- * Execute callback, will be called when users executes the command.
- * @param context
- */
- execute: (context: ICommandContext) => void;
- /**
- * A callback to check whether the command is available in given context.
- * @param context
- */
- is_enabled: (context: ICommandContext) => boolean;
- /**
- * The user-facing name of the command.
- */
- label: string;
- /**
- * Default infinity (unassigned) if absolute, otherwise 0 (for relative ranks)
- */
- rank?: number;
- /**
- * Does the rank represent relative position in the LSP commands group? (default: true)
- */
- is_rank_relative?: boolean;
- /**
- * By default the command will be attached to context menus of each adapter.
- */
- attach_to?: Set;
- /**
- * The icon to be displayed next to the label.
- */
- icon?: LabIcon;
-}
+import * as lsProtocol from 'vscode-languageserver-protocol';
export interface IFeatureSettings {
readonly composite: Required;
@@ -63,6 +12,26 @@ export interface IFeatureSettings {
set(setting: keyof T, value: any): void;
}
+export namespace Feature {
+ export interface IOptions {
+ connectionManager: ILSPDocumentConnectionManager;
+ }
+}
+
+export abstract class Feature implements IFeature {
+ abstract readonly id: string;
+ abstract readonly capabilities?: lsProtocol.ClientCapabilities;
+ protected connectionManager: ILSPDocumentConnectionManager;
+
+ constructor(options: Feature.IOptions) {
+ this.connectionManager = options.connectionManager;
+ }
+
+ //getConnection(): ILSPConnection {
+
+ //}
+}
+
export class FeatureSettings implements IFeatureSettings {
protected settings: ISettingRegistry.ISettings;
public changed: Signal, void>;
@@ -102,122 +71,3 @@ export class FeatureSettings implements IFeatureSettings {
this.settings.set(setting as string, value).catch(console.warn);
}
}
-
-/**
- * Names of the supported editors.
- */
-export type IEditorName = string;
-
-export interface IFeature {
- /**
- * The feature identifier. It must be the same as the feature plugin id.
- */
- id: string;
- /**
- * The user-readable name of the feature.
- */
- name: string;
- /**
- * Each feature can be written in mind with support for one or more editors.
- * Separate editor integration implementations should be provided for each supported editor.
- *
- * Currently only CodeMirrorEditor is supported.
- */
- editorIntegrationFactory: Map<
- IEditorName,
- IFeatureEditorIntegrationConstructor>
- >;
- /**
- * LSP capabilities implemented by the feature.
- */
- capabilities?: ClientCapabilities;
- /**
- * Command specification, including context menu placement options.
- */
- commands?: Array;
- /**
- * Objects implementing JupyterLab-specific integration,
- * for example, adding new GUI elements such as hover tooltips or replacing completer.
- *
- * It can be accessed from the FeatureEditorIntegration object
- * constructor using (options: IEditorIntegrationOptions).feature.
- */
- labIntegration?: IFeatureLabIntegration;
- /**
- * Settings to be passed to the FeatureEditorIntegration.
- * To use the same settings for lab integration bind the same FeatureSettings object to the labIntegration object.
- */
- settings?: IFeatureSettings;
-}
-
-export interface IFeatureEditorIntegration> {
- /**
- * Stores registration confirmation and should be set to true once register()
- * is successfully called (and false beforehand)
- */
- is_registered: boolean;
- /**
- * The reference to the Feature (it will be provided in the constructor options;
- * the implementations should expose them as public so that the specific features
- * can access their settings and metadata).
- */
- feature: IFeature;
- /**
- * Connect event handlers to the editor, virtual document and connection(s).
- */
- register(): void;
- /**
- * Remove the event handlers.
- */
- remove(): void;
- /**
- * A callback which is executed after a change in the virtual document has been
- * recorded and the document positions were recalculated; this is different from
- * observing value changes in the underlying editor implementation itself (e.g. in
- * the CodeMirror.Editor) as the direct listening to the events does not guarantee
- * that the appropriate changes were reflected in the virtual document at the point
- * the listeners were reached (thus not using afterChange() when needed may lead to
- * position transformation errors).
- */
- afterChange?(change: IEditorChange, root_position: IRootPosition): void;
-
- /** no-unused-vars rule is hard to disable selectively */
- __unused_editor_?: T;
-}
-
-export interface IFeatureEditorIntegrationConstructor<
- T extends IVirtualEditor
-> {
- new (options: IEditorIntegrationOptions): IFeatureEditorIntegration;
-}
-
-export interface IEditorIntegrationOptions {
- feature: IFeature;
- /**
- * Provides the editor-implementation-specific methods;
- * is NOT aware of existence of cells or multiple editors
- */
- virtual_editor: IVirtualEditor;
- /**
- * Provides an abstraction of continuous document,
- * regardless of the actual underlying model or GUI display
- * (even if it is a notebook, it can be viewed as a continuous document).
- * Is aware of the document potentially having multiple editors (blocks),
- * but is NOT aware of the actual editor-implementation (such as CodeMirror).
- */
- virtual_document: VirtualDocument;
- /**
- * Interfaces with the relevant JupyterLab widget, such as Notebook or FileEditor.
- * Is aware of existence of cells in notebook (exposed as multiple editors),
- * but is NOT aware of editor-implementation details (such as existence of CodeMirror).
- */
- adapter: WidgetAdapter;
- connection: LSPConnection;
- status_message: StatusMessage;
- settings: IFeatureSettings;
- trans: TranslationBundle;
-}
-
-export interface IFeatureLabIntegration {
- settings?: IFeatureSettings;
-}
diff --git a/packages/jupyterlab-lsp/src/features/completion/completion.ts b/packages/jupyterlab-lsp/src/features/completion/completion.ts
deleted file mode 100644
index 81c351420..000000000
--- a/packages/jupyterlab-lsp/src/features/completion/completion.ts
+++ /dev/null
@@ -1,453 +0,0 @@
-import { ILSPCompletionThemeManager } from '@jupyter-lsp/completion-theme';
-import { JupyterFrontEnd } from '@jupyterlab/application';
-import { CodeEditor } from '@jupyterlab/codeeditor';
-import {
- CompletionHandler,
- ICompletionManager,
- CompleterModel
-} from '@jupyterlab/completer';
-import { IDocumentWidget } from '@jupyterlab/docregistry';
-import { NotebookPanel } from '@jupyterlab/notebook';
-import { IRenderMimeRegistry } from '@jupyterlab/rendermime';
-import type * as CodeMirror from 'codemirror';
-
-import { CodeCompletion as LSPCompletionSettings } from '../../_completion';
-import { IEditorChangedData, WidgetAdapter } from '../../adapters/adapter';
-import { NotebookAdapter } from '../../adapters/notebook/notebook';
-import { IDocumentConnectionData } from '../../connection_manager';
-import { CodeMirrorIntegration } from '../../editor_integration/codemirror';
-import { FeatureSettings, IFeatureLabIntegration } from '../../feature';
-import {
- AdditionalCompletionTriggerKinds,
- CompletionTriggerKind,
- ExtendedCompletionTriggerKind
-} from '../../lsp';
-import { ILSPAdapterManager, ILSPLogConsole } from '../../tokens';
-
-import { LSPConnector } from './completion_handler';
-import { LazyCompletionItem } from './item';
-import { LSPCompleterModel } from './model';
-import { ICompletionData, LSPCompletionRenderer } from './renderer';
-
-const DOC_PANEL_SELECTOR = '.jp-Completer-docpanel';
-const DOC_PANEL_PLACEHOLDER_CLASS = 'lsp-completer-placeholder';
-const LSP_COMPLETER_CLASS = 'lsp-completer';
-const LSP_COMPLETER_ENABLED_CLASS = 'lsp-completer-enabled';
-
-export class CompletionCM extends CodeMirrorIntegration {
- private _completionCharacters: string[];
-
- get settings() {
- return super.settings as FeatureSettings;
- }
-
- get completionCharacters() {
- if (
- this._completionCharacters == null ||
- !this._completionCharacters.length
- ) {
- this._completionCharacters =
- this.connection.getLanguageCompletionCharacters();
- }
- return this._completionCharacters;
- }
-
- // public handleCompletion(completions: lsProtocol.CompletionItem[]) {
- // TODO: populate the (already displayed) completions list if the completions timed out initially?
- // }
-
- afterChange(change: CodeMirror.EditorChange): void {
- // TODO: maybe the completer could be kicked off in the handleChange() method directly; signature help still
- // requires an up-to-date virtual document on the LSP side, so we need to wait for sync.
-
- // note: trigger character completion need to be have a higher priority than auto-invoked completion
- // because the latter does not work for on-dot completion due to suppression of trivial suggestions
- // see gh430
- let last_character = this.extract_last_character(change);
- if (this.completionCharacters.indexOf(last_character) > -1) {
- this.virtual_editor.console.log(
- 'Will invoke completer after',
- last_character
- );
- (this.feature.labIntegration as CompletionLabIntegration)
- .invoke_completer(CompletionTriggerKind.TriggerCharacter)
- .catch(this.console.warn);
- return;
- }
-
- if (
- change.text &&
- change.text[0].length == 1 &&
- this.settings.composite.continuousHinting
- ) {
- (this.feature.labIntegration as CompletionLabIntegration)
- .invoke_completer(AdditionalCompletionTriggerKinds.AutoInvoked)
- .catch(this.console.warn);
- }
- }
-}
-
-export class CompletionLabIntegration implements IFeatureLabIntegration {
- // TODO: maybe instead of creating it each time, keep a hash map instead?
- protected current_completion_connector: LSPConnector;
- protected current_completion_handler: CompletionHandler;
- protected current_adapter: WidgetAdapter | null = null;
- protected renderer: LSPCompletionRenderer;
- private _latestActiveItem: LazyCompletionItem | null = null;
- private _signalConnected: boolean = false;
- private _disabled: boolean;
-
- constructor(
- private app: JupyterFrontEnd,
- private completionManager: ICompletionManager,
- public settings: FeatureSettings,
- private adapterManager: ILSPAdapterManager,
- private completionThemeManager: ILSPCompletionThemeManager,
- private console: ILSPLogConsole,
- private renderMimeRegistry: IRenderMimeRegistry
- ) {
- const markdown_renderer =
- this.renderMimeRegistry.createRenderer('text/markdown');
- this.renderer = new LSPCompletionRenderer({
- integrator: this,
- markdownRenderer: markdown_renderer,
- latexTypesetter: this.renderMimeRegistry.latexTypesetter,
- console: console.scope('renderer')
- });
- this.renderer.activeChanged.connect(this.active_completion_changed, this);
- this.renderer.itemShown.connect(this.resolve_and_update, this);
- this._signalConnected = false;
- this._disabled = false;
- // TODO: figure out a better way to disable lab integration elements (postpone initialization?)
- settings.ready
- .then(() => {
- this._disabled = settings.composite.disable;
- if (!settings.composite.disable) {
- adapterManager.adapterChanged.connect(this.swap_adapter, this);
- this._signalConnected = true;
- }
- })
- .catch(console.warn);
-
- settings.changed.connect(() => {
- this._disabled = settings.composite.disable;
- if (!settings.composite.disable) {
- document.body.dataset.lspCompleterLayout =
- this.settings.composite.layout;
- completionThemeManager.set_theme(this.settings.composite.theme);
- completionThemeManager.set_icons_overrides(
- this.settings.composite.typesMap
- );
- if (!this._signalConnected) {
- adapterManager.adapterChanged.connect(this.swap_adapter, this);
- this._signalConnected = true;
- }
- } else {
- completionThemeManager.set_theme(null);
- delete document.body.dataset.lspCompleterLayout;
- }
- if (
- this.current_completion_handler &&
- this.model instanceof LSPCompleterModel
- ) {
- this.model.settings.caseSensitive =
- this.settings.composite.caseSensitive;
- this.model.settings.includePerfectMatches =
- this.settings.composite.includePerfectMatches;
- this.model.settings.preFilterMatches =
- this.settings.composite.preFilterMatches;
- }
- });
- }
-
- protected fetchDocumentation(item: LazyCompletionItem): void {
- if (!item) {
- return;
- }
- item
- .resolve()
- .then(resolvedCompletionItem => {
- if (item.self !== this._latestActiveItem!.self) {
- return;
- }
- this.set_doc_panel_placeholder(false);
- if (resolvedCompletionItem === null) {
- return;
- }
- this.refresh_doc_panel(item);
- })
- .catch(e => {
- // disabling placeholder can remove currently displayed documentation,
- // so only do that if this is really the active item!
- if (item.self === this._latestActiveItem!.self) {
- this.set_doc_panel_placeholder(false);
- }
- this.console.warn(e);
- });
- }
-
- active_completion_changed(
- renderer: LSPCompletionRenderer,
- active_completion: ICompletionData
- ) {
- let { item } = active_completion;
- this._latestActiveItem = item;
- if (!item.supportsResolution()) {
- if (item.isDocumentationMarkdown) {
- // TODO: remove once https://github.com/jupyterlab/jupyterlab/pull/9663 is merged and released
- this.refresh_doc_panel(item);
- }
- return;
- }
-
- if (item.needsResolution()) {
- this.set_doc_panel_placeholder(true);
- this.fetchDocumentation(item);
- } else if (item.isResolved()) {
- this.refresh_doc_panel(item);
- } else {
- // resolution has already started, but the re-render update could have been invalidated
- // by user action, so let's ensure the documentation will get shown this time.
- this.fetchDocumentation(item);
- }
-
- // also fetch completion for the previous and the next item to prevent jitter
- const index = this.current_index;
- const items = this.current_items;
-
- if (index - 1 >= 0) {
- const previous = items[index - 1] as LazyCompletionItem;
- this.resolve_and_update_from_item(previous?.self);
- }
- if (index + 1 < items.length) {
- const next = items[index + 1] as LazyCompletionItem;
- this.resolve_and_update_from_item(next?.self);
- }
- }
-
- private resolve_and_update_from_item(item: LazyCompletionItem) {
- if (!item) {
- return;
- }
- this.resolve_and_update(this.renderer, {
- item: item,
- element: item.element
- });
- }
-
- private resolve_and_update(
- renderer: LSPCompletionRenderer,
- active_completion: ICompletionData
- ) {
- let { item, element } = active_completion;
- if (!item.supportsResolution()) {
- this.renderer.updateExtraInfo(item, element);
- return;
- }
-
- if (item.isResolved()) {
- this.renderer.updateExtraInfo(item, element);
- } else {
- // supportsResolution as otherwise would short-circuit above
- item
- .resolve()
- .then(resolvedCompletionItem => {
- this.renderer.updateExtraInfo(item, element);
- })
- .catch(e => {
- this.console.warn(e);
- });
- }
- }
-
- private swap_adapter(
- manager: ILSPAdapterManager,
- adapter: WidgetAdapter
- ) {
- if (this.current_adapter) {
- // disconnect signals from the old adapter
- this.current_adapter.activeEditorChanged.disconnect(
- this.set_connector,
- this
- );
- this.current_adapter.adapterConnected.disconnect(
- this.connect_completion,
- this
- );
- }
- this.current_adapter = adapter;
- // connect the new adapter
- if (this.current_adapter.isConnected) {
- this.connect_completion(this.current_adapter);
- // TODO: what to do if adapter.activeEditor was just deleted/there is none because focus shifted?
- this.set_connector(adapter, { editor: adapter.activeEditor! });
- }
- // connect signals to the new adapter
- this.current_adapter.activeEditorChanged.connect(this.set_connector, this);
- this.current_adapter.adapterConnected.connect(
- this.connect_completion,
- this
- );
- }
-
- connect_completion(
- adapter: WidgetAdapter,
- data?: IDocumentConnectionData
- ) {
- let editor = adapter.activeEditor;
- if (editor == null) {
- return;
- }
- this.set_completion_connector(adapter, editor);
- this.current_completion_handler = this.completionManager.register(
- {
- connector: this.current_completion_connector,
- editor: editor,
- parent: adapter.widget
- },
- this.renderer
- ) as CompletionHandler;
- let completer = this.completer;
- if (this._disabled) {
- completer.removeClass(LSP_COMPLETER_CLASS);
- completer.model = new CompleterModel();
- } else {
- completer.addClass(LSP_COMPLETER_CLASS);
- completer.model = new LSPCompleterModel({
- caseSensitive: this.settings.composite.caseSensitive,
- includePerfectMatches: this.settings.composite.includePerfectMatches,
- preFilterMatches: this.settings.composite.preFilterMatches
- });
- }
- }
-
- protected get completer() {
- // TODO upstream: make completer public?
- return this.current_completion_handler.completer;
- }
-
- protected get model(): LSPCompleterModel | CompleterModel {
- return this.completer.model as LSPCompleterModel | CompleterModel;
- }
-
- invoke_completer(kind: ExtendedCompletionTriggerKind) {
- // TODO: ideally this would not re-trigger if list of items not isIncomplete
- let command: string;
- this.current_completion_connector.trigger_kind = kind;
-
- if (this.adapterManager.currentAdapter instanceof NotebookAdapter) {
- command = 'completer:invoke-notebook';
- } else {
- command = 'completer:invoke-file';
- }
- return this.app.commands.execute(command).catch(() => {
- this.current_completion_connector.trigger_kind =
- CompletionTriggerKind.Invoked;
- });
- }
-
- set_connector(
- adapter: WidgetAdapter,
- editor_changed: IEditorChangedData
- ) {
- if (!this.current_completion_handler) {
- // workaround for current_completion_handler not being there yet
- this.connect_completion(adapter);
- }
- this.set_completion_connector(adapter, editor_changed.editor);
- this.current_completion_handler.editor = editor_changed.editor;
- // eslint-disable-next-line @typescript-eslint/ban-ts-comment
- // @ts-ignore
- this.current_completion_handler.connector =
- this.current_completion_connector;
- }
-
- private get current_items() {
- // TODO upstream: allow to get completionItems() without markup
- // (note: not trivial as _markup() does filtering too)
- if (!(this.model instanceof LSPCompleterModel)) {
- return [];
- }
- return this.model.completionItems();
- }
-
- private get current_index() {
- let completer = this.current_completion_handler.completer;
-
- // TODO: use public activeIndex available since 3.1
- // eslint-disable-next-line @typescript-eslint/ban-ts-comment
- // @ts-ignore
- return completer._activeIndex;
- }
-
- refresh_doc_panel(item: LazyCompletionItem) {
- let completer = this.current_completion_handler.completer;
-
- const active: CompletionHandler.ICompletionItem =
- this.current_items[this.current_index];
-
- if (!item || !active || active.insertText != item.insertText) {
- return;
- }
-
- const docPanel = completer.node.querySelector(DOC_PANEL_SELECTOR);
- if (!docPanel) {
- this.console.warn('Could not find completer panel to refresh');
- return;
- }
- docPanel.classList.remove(DOC_PANEL_PLACEHOLDER_CLASS);
-
- if (item.documentation) {
- // remove all children
- docPanel.textContent = '';
- // TODO upstream: renderer should take care of the documentation rendering
- // sent PR: https://github.com/jupyterlab/jupyterlab/pull/9663
-
- const node = this.renderer.createDocumentationNode(item);
- docPanel.appendChild(node);
-
- docPanel.setAttribute('style', '');
- } else {
- docPanel.setAttribute('style', 'display: none');
- }
- }
-
- set_doc_panel_placeholder(enable: boolean): void {
- let completer = this.current_completion_handler.completer;
- const docPanel = completer.node.querySelector(DOC_PANEL_SELECTOR);
- if (!docPanel) {
- this.console.warn('Could not find completer panel for placeholder');
- return;
- }
- if (enable) {
- docPanel.setAttribute('style', '');
- docPanel.classList.add(DOC_PANEL_PLACEHOLDER_CLASS);
- } else if (docPanel.classList.contains(DOC_PANEL_PLACEHOLDER_CLASS)) {
- docPanel.setAttribute('style', 'display: none');
- docPanel.classList.remove(DOC_PANEL_PLACEHOLDER_CLASS);
- }
- }
-
- private set_completion_connector(
- adapter: WidgetAdapter,
- editor: CodeEditor.IEditor
- ) {
- this.current_completion_connector = new LSPConnector({
- editor: editor,
- themeManager: this.completionThemeManager,
- connections: this.current_adapter!.connection_manager.connections,
- virtual_editor: this.current_adapter!.virtual_editor,
- settings: this.settings,
- labIntegration: this,
- // it might or might not be a notebook panel (if it is not, the sessionContext and session will just be undefined)
- session: (this.current_adapter!.widget as NotebookPanel)?.sessionContext
- ?.session,
- console: this.console
- });
- if (this._disabled) {
- editor.host.classList.remove(LSP_COMPLETER_ENABLED_CLASS);
- } else {
- editor.host.classList.add(LSP_COMPLETER_ENABLED_CLASS);
- }
- }
-}
diff --git a/packages/jupyterlab-lsp/src/features/completion/completion_handler.spec.ts b/packages/jupyterlab-lsp/src/features/completion/completion_handler.spec.ts
deleted file mode 100644
index 537323494..000000000
--- a/packages/jupyterlab-lsp/src/features/completion/completion_handler.spec.ts
+++ /dev/null
@@ -1,87 +0,0 @@
-import { CodeEditor } from '@jupyterlab/codeeditor';
-import { expect } from 'chai';
-import type * as lsProtocol from 'vscode-languageserver-types';
-
-import { BrowserConsole } from '../../virtual/console';
-
-import { transformLSPCompletions } from './completion_handler';
-
-describe('transformLSPCompletions', () => {
- const browserConsole = new BrowserConsole();
-
- const transform = (
- token: CodeEditor.IToken,
- position: number,
- completions: lsProtocol.CompletionItem[]
- ) => {
- return transformLSPCompletions(
- token,
- position,
- completions,
- (kind: string, match: lsProtocol.CompletionItem) => {
- return { kind, match };
- },
- browserConsole
- );
- };
-
- it('Harmonizes `insertText` from `undefined` when adjusting path-like completions', () => {
- // `import { } from '@lumino/'`
- const result = transform(
- {
- offset: 16,
- value: "'@lumino/'",
- type: 'string'
- },
- 8,
- [
- {
- label: 'algorithm',
- kind: 19,
- sortText: '1',
- data: {
- entryNames: ['algorithm']
- }
- },
- {
- label: 'application',
- kind: 19,
- sortText: '1',
- data: {
- entryNames: ['application']
- }
- }
- ]
- );
- expect(result.items.length).to.equal(2);
- // insert text should keep `'` as it was part of original token
- expect(result.items[0].match.insertText).to.equal("'@lumino/algorithm");
- // label should not include `'`
- expect(result.items[0].match.label).to.equal('@lumino/algorithm');
- expect(result.source.name).to.equal('LSP');
- });
-
- it('Harmonizes `insertText` for paths', () => {
- // `'./Hov`
- const result = transform(
- {
- offset: 0,
- value: "'./Hov",
- type: 'string'
- },
- 5,
- [
- {
- label: "Hover.ipynb'",
- kind: 17,
- sortText: "aHover.ipynb'",
- insertText: "Hover.ipynb'"
- }
- ]
- );
- // insert text should keep `'` as it was part of original token
- expect(result.items[0].match.insertText).to.equal("'./Hover.ipynb'");
- // label should not include initial `'`
- expect(result.items[0].match.label).to.equal("./Hover.ipynb'");
- });
-});
diff --git a/packages/jupyterlab-lsp/src/features/completion/completion_handler.ts b/packages/jupyterlab-lsp/src/features/completion/completion_handler.ts
deleted file mode 100644
index a973e6e14..000000000
--- a/packages/jupyterlab-lsp/src/features/completion/completion_handler.ts
+++ /dev/null
@@ -1,729 +0,0 @@
-import {
- ILSPCompletionThemeManager,
- KernelKind
-} from '@jupyter-lsp/completion-theme';
-import { CodeEditor } from '@jupyterlab/codeeditor';
-import {
- CompletionConnector,
- CompletionHandler,
- ContextConnector,
- KernelConnector
-} from '@jupyterlab/completer';
-import { Session } from '@jupyterlab/services';
-import { LabIcon } from '@jupyterlab/ui-components';
-import { JSONArray, JSONObject } from '@lumino/coreutils';
-import type * as lsProtocol from 'vscode-languageserver-types';
-
-import { CodeCompletion as LSPCompletionSettings } from '../../_completion';
-import { LSPConnection } from '../../connection';
-import { PositionConverter } from '../../converter';
-import { FeatureSettings } from '../../feature';
-import {
- AdditionalCompletionTriggerKinds,
- CompletionItemKind,
- CompletionTriggerKind,
- ExtendedCompletionTriggerKind
-} from '../../lsp';
-import {
- IEditorPosition,
- IRootPosition,
- IVirtualPosition
-} from '../../positioning';
-import { ILSPLogConsole } from '../../tokens';
-import { VirtualDocument } from '../../virtual/document';
-import { IVirtualEditor } from '../../virtual/editor';
-
-import { CompletionLabIntegration } from './completion';
-import {
- ICompletionsSource,
- IExtendedCompletionItem,
- LazyCompletionItem
-} from './item';
-
-import ICompletionItemsResponseType = CompletionHandler.ICompletionItemsResponseType;
-
-/**
- * Completion items reply from a specific source
- */
-export interface ICompletionsReply
- extends CompletionHandler.ICompletionItemsReply {
- // TODO: it is not clear when the source is set here and when on IExtendedCompletionItem.
- // it might be good to separate the two stages for both interfaces
- source: ICompletionsSource | null;
- items: IExtendedCompletionItem[];
-}
-
-export function transformLSPCompletions(
- token: CodeEditor.IToken,
- position_in_token: number,
- lspCompletionItems: lsProtocol.CompletionItem[],
- createCompletionItem: (kind: string, match: lsProtocol.CompletionItem) => T,
- console: ILSPLogConsole
-) {
- let prefix = token.value.slice(0, position_in_token + 1);
- let all_non_prefixed = true;
- let items: T[] = [];
- lspCompletionItems.forEach(match => {
- let kind = match.kind ? CompletionItemKind[match.kind] : '';
-
- // Update prefix values
- let text = match.insertText ? match.insertText : match.label;
-
- // declare prefix presence if needed and update it
- if (text.toLowerCase().startsWith(prefix.toLowerCase())) {
- all_non_prefixed = false;
- if (prefix !== token.value) {
- if (text.toLowerCase().startsWith(token.value.toLowerCase())) {
- // given a completion insert text "display_table" and two test cases:
- // dispdata → display_tabledata
- // display → display_table
- // we have to adjust the prefix for the latter (otherwise we would get display_tablelay),
- // as we are constrained NOT to replace after the prefix (which would be "disp" otherwise)
- prefix = token.value;
- }
- }
- }
- // add prefix if needed
- else if (token.type === 'string' && prefix.includes('/')) {
- // special case for path completion in strings, ensuring that:
- // '/Com → '/Completion.ipynb
- // when the returned insert text is `Completion.ipynb` (the token here is `'/Com`)
- // developed against pyls and pylsp server, may not work well in other cases
- const parts = prefix.split('/');
- if (
- text.toLowerCase().startsWith(parts[parts.length - 1].toLowerCase())
- ) {
- let pathPrefix = parts.slice(0, -1).join('/') + '/';
- match.insertText = pathPrefix + text;
- // for label removing the prefix quote if present
- if (pathPrefix.startsWith("'") || pathPrefix.startsWith('"')) {
- pathPrefix = pathPrefix.substr(1);
- }
- match.label = pathPrefix + match.label;
- all_non_prefixed = false;
- }
- }
-
- let completionItem = createCompletionItem(kind, match);
-
- items.push(completionItem);
- });
- console.debug('Transformed');
- // required to make the repetitive trigger characters like :: or ::: work for R with R languageserver,
- // see https://github.com/jupyter-lsp/jupyterlab-lsp/issues/436
- let prefix_offset = token.value.length;
- // completion of dictionaries for Python with jedi-language-server was
- // causing an issue for dic[''] case; to avoid this let's make
- // sure that prefix.length >= prefix.offset
- if (all_non_prefixed && prefix_offset > prefix.length) {
- prefix_offset = prefix.length;
- }
-
- let response = {
- // note in the ContextCompleter it was:
- // start: token.offset,
- // end: token.offset + token.value.length,
- // which does not work with "from statistics import " as the last token ends at "t" of "import",
- // so the completer would append "mean" as "from statistics importmean" (without space!);
- // (in such a case the typedCharacters is undefined as we are out of range)
- // a different workaround would be to prepend the token.value prefix:
- // text = token.value + text;
- // but it did not work for "from statistics " and lead to "from statisticsimport" (no space)
- start: token.offset + (all_non_prefixed ? prefix_offset : 0),
- end: token.offset + prefix.length,
- items: items,
- source: {
- name: 'LSP',
- priority: 2
- }
- };
- if (response.start > response.end) {
- console.warn(
- 'Response contains start beyond end; this should not happen!',
- response
- );
- }
- return response;
-}
-
-/**
- * A LSP connector for completion handlers.
- */
-export class LSPConnector
- implements CompletionHandler.ICompletionItemsConnector
-{
- isDisposed = false;
- private _editor: CodeEditor.IEditor;
- private _connections: Map;
- private _context_connector: ContextConnector;
- private _kernel_connector: KernelConnector;
- private _kernel_and_context_connector: CompletionConnector;
- private console: ILSPLogConsole;
-
- // signal that this is the new type connector (providing completion items)
- responseType = ICompletionItemsResponseType;
-
- virtual_editor: IVirtualEditor;
- trigger_kind: ExtendedCompletionTriggerKind;
- lab_integration: CompletionLabIntegration;
- items: CompletionHandler.ICompletionItems;
-
- get kernel_completions_first(): boolean {
- return this.options.settings.composite.kernelCompletionsFirst;
- }
-
- protected get use_lsp_completions(): boolean {
- return (
- this.options.settings.composite.disableCompletionsFrom.indexOf('LSP') ==
- -1
- );
- }
-
- protected get use_kernel_completions(): boolean {
- return (
- this.options.settings.composite.disableCompletionsFrom.indexOf(
- 'Kernel'
- ) == -1
- );
- }
-
- protected get suppress_continuous_hinting_in(): string[] {
- return this.options.settings.composite.suppressContinuousHintingIn;
- }
-
- protected get suppress_trigger_character_in(): string[] {
- return this.options.settings.composite.suppressTriggerCharacterIn;
- }
-
- get should_show_documentation(): boolean {
- return this.options.settings.composite.showDocumentation;
- }
-
- /**
- * Create a new LSP connector for completion requests.
- *
- * @param options - The instantiation options for the LSP connector.
- */
- constructor(protected options: LSPConnector.IOptions) {
- this._editor = options.editor;
- this._connections = options.connections;
- this.virtual_editor = options.virtual_editor;
- this._context_connector = new ContextConnector({ editor: options.editor });
- if (options.session) {
- let kernel_options = { editor: options.editor, session: options.session };
- this._kernel_connector = new KernelConnector(kernel_options);
- this._kernel_and_context_connector = new CompletionConnector(
- kernel_options
- );
- }
- this.lab_integration = options.labIntegration;
- this.console = options.console;
- }
-
- dispose() {
- if (this.isDisposed) {
- return;
- }
- this._connections = null as any;
- this.virtual_editor = null as any;
- this._context_connector = null as any;
- this._kernel_connector = null as any;
- this._kernel_and_context_connector = null as any;
- this.options = null as any;
- this._editor = null as any;
- this.isDisposed = true;
- }
-
- protected get _has_kernel(): boolean {
- return this.options.session?.kernel != null;
- }
-
- protected get _is_kernel_idle(): boolean {
- return this.options.session?.kernel?.status == 'idle';
- }
-
- protected get _should_wait_for_busy_kernel(): boolean {
- return this.lab_integration.settings.composite.waitForBusyKernel;
- }
-
- protected async _kernel_language(): Promise {
- return (await this.options.session!.kernel!.info).language_info.name;
- }
-
- protected get _kernel_timeout(): number {
- return this.lab_integration.settings.composite.kernelResponseTimeout;
- }
-
- get fallback_connector() {
- return this._kernel_and_context_connector
- ? this._kernel_and_context_connector
- : this._context_connector;
- }
-
- protected transform_from_editor_to_root(
- position: CodeEditor.IPosition
- ): IRootPosition {
- let editor_position = PositionConverter.ce_to_cm(
- position
- ) as IEditorPosition;
- return this.virtual_editor.transform_from_editor_to_root(
- this._editor,
- editor_position
- )!;
- }
-
- /**
- * Fetch completion requests.
- *
- * @param request - The completion request text and details.
- */
- async fetch(
- request: CompletionHandler.IRequest
- ): Promise {
- let editor = this._editor;
-
- const cursor = editor.getCursorPosition();
- const token = editor.getTokenForPosition(cursor);
-
- if (this.trigger_kind == AdditionalCompletionTriggerKinds.AutoInvoked) {
- if (
- token.type &&
- this.suppress_continuous_hinting_in.indexOf(token.type) !== -1
- ) {
- this.console.debug('Suppressing completer auto-invoke in', token.type);
- this.trigger_kind = CompletionTriggerKind.Invoked;
- return;
- }
- } else if (this.trigger_kind == CompletionTriggerKind.TriggerCharacter) {
- if (
- token.type &&
- this.suppress_trigger_character_in.indexOf(token.type) !== -1
- ) {
- this.console.debug('Suppressing completer auto-invoke in', token.type);
- this.trigger_kind = CompletionTriggerKind.Invoked;
- return;
- }
- }
-
- const start = editor.getPositionAt(token.offset)!;
- const end = editor.getPositionAt(token.offset + token.value.length)!;
-
- let position_in_token = cursor.column - start.column - 1;
- const typed_character = token.value[cursor.column - start.column - 1];
-
- let start_in_root = this.transform_from_editor_to_root(start);
- let end_in_root = this.transform_from_editor_to_root(end);
- let cursor_in_root = this.transform_from_editor_to_root(cursor);
-
- let virtual_editor = this.virtual_editor;
-
- // find document for position
- let document = virtual_editor.document_at_root_position(start_in_root);
-
- let virtual_start =
- virtual_editor.root_position_to_virtual_position(start_in_root);
- let virtual_end =
- virtual_editor.root_position_to_virtual_position(end_in_root);
- let virtual_cursor =
- virtual_editor.root_position_to_virtual_position(cursor_in_root);
- const lsp_promise: Promise<
- CompletionHandler.ICompletionItemsReply | undefined
- > = this.use_lsp_completions
- ? this.fetch_lsp(
- token,
- typed_character,
- virtual_start,
- virtual_end,
- virtual_cursor,
- document,
- position_in_token
- )
- : Promise.resolve(undefined);
-
- let promise: Promise<
- CompletionHandler.ICompletionItemsReply | undefined
- > | null = null;
-
- try {
- const kernelTimeout = this._kernel_timeout;
-
- if (
- this.use_kernel_completions &&
- this._kernel_connector &&
- this._has_kernel &&
- (this._is_kernel_idle || this._should_wait_for_busy_kernel) &&
- kernelTimeout != 0
- ) {
- // TODO: this would be awesome if we could connect to rpy2 for R suggestions in Python,
- // but this is not the job of this extension; nevertheless its better to keep this in
- // mind to avoid introducing design decisions which would make this impossible
- // (for other extensions)
-
- // TODO: should it be cashed?
- const kernelLanguage = await this._kernel_language();
-
- if (
- document.language.toLocaleLowerCase() === kernelLanguage.toLowerCase()
- ) {
- let default_kernel_promise = this._kernel_connector.fetch(request);
- let kernel_promise: Promise;
-
- if (kernelTimeout == -1) {
- kernel_promise = default_kernel_promise;
- } else {
- // implement timeout for the kernel response using Promise.race:
- // an empty completion result will resolve after the timeout
- // if actual kernel response does not beat it to it
- kernel_promise = Promise.race([
- default_kernel_promise,
- new Promise(resolve => {
- return setTimeout(
- () =>
- resolve({
- start: 0,
- end: 0,
- matches: [],
- metadata: {}
- }),
- kernelTimeout
- );
- })
- ]);
- }
-
- promise = Promise.all([
- kernel_promise.catch(p => p),
- lsp_promise.catch(p => p)
- ]).then(([kernel, lsp]) => {
- let replies = [];
- if (kernel != null) {
- replies.push(this.transform_reply(kernel));
- }
- if (lsp != null) {
- replies.push(lsp);
- }
- return this.merge_replies(replies, this._editor);
- });
- }
- }
- if (!promise) {
- promise = lsp_promise.catch(e => {
- this.console.warn('hint failed', e);
- return this.fallback_connector
- .fetch(request)
- .then(this.transform_reply);
- });
- }
- } catch (e) {
- this.console.warn('kernel completions failed', e);
- promise = this.fallback_connector
- .fetch(request)
- .then(this.transform_reply);
- }
-
- this.console.debug('All promises set up and ready.');
- return promise.then(reply => {
- reply = this.suppress_if_needed(reply, token, cursor);
- if (reply) {
- this.items = reply.items;
- }
- this.trigger_kind = CompletionTriggerKind.Invoked;
- return reply;
- });
- }
-
- public get_connection(uri: string) {
- return this._connections.get(uri);
- }
-
- async fetch_lsp(
- token: CodeEditor.IToken,
- typed_character: string,
- start: IVirtualPosition,
- end: IVirtualPosition,
- cursor: IVirtualPosition,
- document: VirtualDocument,
- position_in_token: number
- ): Promise {
- let connection = this.get_connection(document.uri)!;
-
- this.console.debug('Fetching');
- this.console.debug('Token:', token, start, end);
-
- const trigger_kind =
- this.trigger_kind == AdditionalCompletionTriggerKinds.AutoInvoked
- ? CompletionTriggerKind.Invoked
- : this.trigger_kind;
-
- let lspCompletionItems = ((await connection.getCompletion(
- cursor,
- {
- start,
- end,
- text: token.value
- },
- document.document_info,
- false,
- typed_character,
- trigger_kind
- )) || []) as lsProtocol.CompletionItem[];
-
- this.console.debug('Transforming');
-
- return transformLSPCompletions(
- token,
- position_in_token,
- lspCompletionItems,
- (kind, match) =>
- new LazyCompletionItem(
- kind,
- this.icon_for(kind),
- match,
- this,
- document.uri
- ),
- this.console
- );
- }
-
- protected icon_for(type: string): LabIcon {
- if (typeof type === 'undefined') {
- type = KernelKind;
- }
- return (this.options.themeManager.get_icon(type) as LabIcon) || undefined;
- }
-
- private transform_reply(reply: CompletionHandler.IReply): ICompletionsReply {
- this.console.log('Transforming kernel reply:', reply);
- let items: IExtendedCompletionItem[];
- const metadata = reply.metadata || {};
- const types = metadata._jupyter_types_experimental as JSONArray;
-
- if (types) {
- items = types.map((item: JSONObject) => {
- return {
- label: item.text as string,
- insertText: item.text as string,
- type: item.type === '' ? undefined : (item.type as string),
- icon: this.icon_for(item.type as string),
- sortText: this.kernel_completions_first ? 'a' : 'z'
- };
- });
- } else {
- items = reply.matches.map(match => {
- return {
- label: match,
- insertText: match,
- sortText: this.kernel_completions_first ? 'a' : 'z'
- };
- });
- }
- return {
- start: reply.start,
- end: reply.end,
- source: {
- name: 'Kernel',
- priority: 1,
- fallbackIcon: this.icon_for('Kernel')
- },
- items
- };
- }
-
- protected merge_replies(
- replies: ICompletionsReply[],
- editor: CodeEditor.IEditor
- ): ICompletionsReply {
- this.console.debug('Merging completions:', replies);
-
- replies = replies.filter(reply => {
- if (reply instanceof Error) {
- this.console.warn(
- `Caught ${reply.source!.name} completions error`,
- reply
- );
- return false;
- }
- // ignore if no matches
- if (!reply.items.length) {
- return false;
- }
- // otherwise keep
- return true;
- });
-
- replies.sort((a, b) => b.source!.priority - a.source!.priority);
-
- this.console.debug('Sorted replies:', replies);
-
- const minEnd = Math.min(...replies.map(reply => reply.end));
-
- // if any of the replies uses a wider range, we need to align them
- // so that all responses use the same range
- const minStart = Math.min(...replies.map(reply => reply.start));
- const maxStart = Math.max(...replies.map(reply => reply.start));
-
- if (minStart != maxStart) {
- const cursor = editor.getCursorPosition();
- const line = editor.getLine(cursor.line);
- if (line == null) {
- this.console.warn(
- `Could not remove prefixes: line is undefined`,
- cursor.line
- );
- } else {
- replies = replies.map(reply => {
- // no prefix to strip, return as-is
- if (reply.start == maxStart) {
- return reply;
- }
- let prefix = line.substring(reply.start, maxStart);
- this.console.debug(`Removing ${reply.source!.name} prefix: `, prefix);
- return {
- ...reply,
- items: reply.items.map(item => {
- item.insertText = item.insertText.startsWith(prefix)
- ? item.insertText.substr(prefix.length)
- : item.insertText;
- return item;
- })
- };
- });
- }
- }
-
- const insertTextSet = new Set();
- const processedItems = new Array();
-
- for (const reply of replies) {
- reply.items.forEach(item => {
- // trimming because:
- // IPython returns 'import' and 'import '; while the latter is more useful,
- // user should not see two suggestions with identical labels and nearly-identical
- // behaviour as they could not distinguish the two either way
- let text = item.insertText.trim();
- if (insertTextSet.has(text)) {
- return;
- }
- insertTextSet.add(text);
- // extra processing (adding icon/source name) is delayed until
- // we are sure that the item will be kept (as otherwise it could
- // lead to processing hundreds of suggestions - e.g. from numpy
- // multiple times if multiple sources provide them).
- let processedItem = item as IExtendedCompletionItem;
- if (reply.source) {
- processedItem.source = reply.source;
- if (!processedItem.icon) {
- processedItem.icon = reply.source.fallbackIcon;
- }
- }
- processedItems.push(processedItem);
- });
- }
-
- // Return reply with processed items.
- this.console.debug('Merged: ', processedItems);
- return {
- start: maxStart,
- end: minEnd,
- source: null,
- items: processedItems
- };
- }
-
- list(query: string | undefined): Promise {
- return Promise.resolve(undefined);
- }
-
- remove(id: CompletionHandler.IRequest): Promise {
- return Promise.resolve(undefined);
- }
-
- save(id: CompletionHandler.IRequest, value: void): Promise {
- return Promise.resolve(undefined);
- }
-
- private suppress_if_needed(
- reply: CompletionHandler.ICompletionItemsReply | undefined,
- token: CodeEditor.IToken,
- cursor_at_request: CodeEditor.IPosition
- ) {
- if (reply == null) {
- return reply;
- }
- if (!this._editor.hasFocus()) {
- this.console.debug(
- 'Ignoring completion response: the corresponding editor lost focus'
- );
- return {
- start: reply.start,
- end: reply.end,
- items: []
- };
- }
-
- const cursor_now = this._editor.getCursorPosition();
-
- // if the cursor advanced in the same line, the previously retrieved completions may still be useful
- // if the line changed or cursor moved backwards then no reason to keep the suggestions
- if (
- cursor_at_request.line != cursor_now.line ||
- cursor_now.column < cursor_at_request.column
- ) {
- this.console.debug(
- 'Ignoring completion response: cursor has receded or changed line'
- );
- return {
- start: reply.start,
- end: reply.end,
- items: []
- };
- }
-
- if (this.trigger_kind == AdditionalCompletionTriggerKinds.AutoInvoked) {
- if (
- // do not auto-invoke if no match found
- reply.start == reply.end ||
- // do not auto-invoke if only one match found and this match is exactly the same as the current token
- (reply.items.length === 1 && reply.items[0].insertText === token.value)
- ) {
- return {
- start: reply.start,
- end: reply.end,
- items: []
- };
- }
- }
- return reply;
- }
-}
-
-/**
- * A namespace for LSP connector statics.
- */
-export namespace LSPConnector {
- /**
- * The instantiation options for cell completion handlers.
- */
- export interface IOptions {
- /**
- * The editor used by the LSP connector.
- */
- editor: CodeEditor.IEditor;
- virtual_editor: IVirtualEditor;
- /**
- * The connections to be used by the LSP connector.
- */
- connections: Map;
-
- settings: FeatureSettings;
-
- labIntegration: CompletionLabIntegration;
-
- themeManager: ILSPCompletionThemeManager;
-
- session?: Session.ISessionConnection | null;
-
- console: ILSPLogConsole;
- }
-}
diff --git a/packages/jupyterlab-lsp/src/features/completion/index.ts b/packages/jupyterlab-lsp/src/features/completion/index.ts
index 996a8247f..80ff47b6d 100644
--- a/packages/jupyterlab-lsp/src/features/completion/index.ts
+++ b/packages/jupyterlab-lsp/src/features/completion/index.ts
@@ -3,90 +3,133 @@ import {
JupyterFrontEnd,
JupyterFrontEndPlugin
} from '@jupyterlab/application';
-import { ICompletionManager } from '@jupyterlab/completer';
+import { ICompletionProviderManager } from '@jupyterlab/completer';
+import {
+ ILSPFeatureManager,
+ ILSPDocumentConnectionManager
+} from '@jupyterlab/lsp';
import { IRenderMimeRegistry } from '@jupyterlab/rendermime';
import { ISettingRegistry } from '@jupyterlab/settingregistry';
import { LabIcon } from '@jupyterlab/ui-components';
+import * as lsProtocol from 'vscode-languageserver-protocol';
import completionSvg from '../../../style/icons/completion.svg';
import { CodeCompletion as LSPCompletionSettings } from '../../_completion';
-import { FeatureSettings } from '../../feature';
+import { FeatureSettings, Feature } from '../../feature';
import { CompletionItemTag } from '../../lsp';
-import {
- ILSPAdapterManager,
- ILSPFeatureManager,
- ILSPLogConsole,
- PLUGIN_ID
-} from '../../tokens';
+import { PLUGIN_ID } from '../../tokens';
-import { CompletionCM, CompletionLabIntegration } from './completion';
+import {
+ EnhancedContextCompleterProvider,
+ EnhancedKernelCompleterProvider
+} from './overrides';
+import { CompletionProvider } from './provider';
export const completionIcon = new LabIcon({
name: 'lsp:completion',
svgstr: completionSvg
});
-const FEATURE_ID = PLUGIN_ID + ':completion';
+export class CompletionFeature extends Feature {
+ readonly id = CompletionFeature.id;
+ readonly capabilities: lsProtocol.ClientCapabilities = {
+ textDocument: {
+ completion: {
+ dynamicRegistration: true,
+ completionItem: {
+ snippetSupport: false,
+ commitCharactersSupport: true,
+ documentationFormat: ['markdown', 'plaintext'],
+ deprecatedSupport: true,
+ preselectSupport: false,
+ tagSupport: {
+ valueSet: [CompletionItemTag.Deprecated]
+ }
+ },
+ contextSupport: true
+ }
+ }
+ };
+
+ constructor(protected options: CompletionFeature.IOptions) {
+ super(options);
+ this._configure();
+
+ options.settings.changed.connect(() => {
+ this._configure();
+ });
+
+ const provider = new CompletionProvider({ ...options });
+ options.completionProviderManager.registerProvider(provider);
+ options.completionProviderManager.registerProvider(
+ new EnhancedContextCompleterProvider(options)
+ );
+ options.completionProviderManager.registerProvider(
+ new EnhancedKernelCompleterProvider(options)
+ );
+ }
+
+ private _configure() {
+ const settings = this.options.settings;
+ const completionThemeManager = this.options.iconsThemeManager;
+
+ if (!settings.composite.disable) {
+ document.body.dataset.lspCompleterLayout = settings.composite.layout;
+ completionThemeManager.set_theme(settings.composite.theme);
+ completionThemeManager.set_icons_overrides(settings.composite.typesMap);
+ } else {
+ completionThemeManager.set_theme(null);
+ delete document.body.dataset.lspCompleterLayout;
+ }
+ }
+}
+
+export namespace CompletionFeature {
+ export interface IOptions extends Feature.IOptions {
+ settings: FeatureSettings;
+ renderMimeRegistry: IRenderMimeRegistry;
+ completionProviderManager: ICompletionProviderManager;
+ iconsThemeManager: ILSPCompletionThemeManager;
+ }
+ export const id = PLUGIN_ID + ':completion';
+}
export const COMPLETION_PLUGIN: JupyterFrontEndPlugin = {
- id: FEATURE_ID,
+ id: CompletionFeature.id,
requires: [
ILSPFeatureManager,
ISettingRegistry,
- ICompletionManager,
- ILSPAdapterManager,
+ ICompletionProviderManager,
ILSPCompletionThemeManager,
- ILSPLogConsole,
- IRenderMimeRegistry
+ IRenderMimeRegistry,
+ ILSPDocumentConnectionManager
],
autoStart: true,
- activate: (
+ activate: async (
app: JupyterFrontEnd,
featureManager: ILSPFeatureManager,
settingRegistry: ISettingRegistry,
- completionManager: ICompletionManager,
- adapterManager: ILSPAdapterManager,
+ completionProviderManager: ICompletionProviderManager,
iconsThemeManager: ILSPCompletionThemeManager,
- logConsole: ILSPLogConsole,
- renderMimeRegistry: IRenderMimeRegistry
+ renderMimeRegistry: IRenderMimeRegistry,
+ connectionManager: ILSPDocumentConnectionManager
) => {
- const settings = new FeatureSettings(settingRegistry, FEATURE_ID);
- const labIntegration = new CompletionLabIntegration(
- app,
- completionManager,
- settings as FeatureSettings,
- adapterManager,
- iconsThemeManager,
- logConsole.scope('CompletionLab'),
- renderMimeRegistry
+ const settings = new FeatureSettings