Merge pull request #735 from jupyter-lsp/prefilter-completion-items

krassowski · web-flow · commit 7ae3c056ed50 · 2021-12-30T13:25:25.000Z
Enable simple pre-filtering of completion matches
diff --git a/atest/05_Features/Completion.robot b/atest/05_Features/Completion.robot
@@ -12,13 +12,12 @@ ${KERNEL_BUSY_INDICATOR}    css:.jp-NotebookPanel-toolbar div[title="Kernel Busy
 
 *** Test Cases ***
 Works When Kernel Is Idle
-    Configure JupyterLab Plugin    {"kernelResponseTimeout": -1, "waitForBusyKernel": false}    plugin id=${COMPLETION PLUGIN ID}
-    [Documentation]    The suggestions from kernel and LSP should get integrated.
+    Configure JupyterLab Plugin    {"kernelResponseTimeout": -1, "waitForBusyKernel": false, "caseSensitive": false}    plugin id=${COMPLETION PLUGIN ID}
+    [Documentation]    The suggestions from kernel and LSP should get integrated; operates in case insensitive mode
     Enter Cell Editor    1    line=2
     Capture Page Screenshot    01-entered-cell.png
     Trigger Completer
     Capture Page Screenshot    02-completions-shown.png
-    # lowercase and uppercase suggestions:
     Completer Should Suggest    TabError
     # this comes from LSP:
     Completer Should Suggest    test
@@ -29,8 +28,18 @@ Works When Kernel Is Idle
     ${content} =    Get Cell Editor Content    1
     Should Contain    ${content}    TabError
 
+Filters Completions In Case Sensitive Mode
+    Configure JupyterLab Plugin    {"caseSensitive": true}    plugin id=${COMPLETION PLUGIN ID}
+    [Documentation]    Completions filtering is case-sensitive when caseSensitive is true
+    Enter Cell Editor    1    line=2
+    Trigger Completer
+    Completer Should Suggest    test
+    Completer Should Not Suggest    TabError
+
+
 Can Prioritize Kernel Completions
-    Configure JupyterLab Plugin    {"kernelCompletionsFirst": true, "kernelResponseTimeout": -1}    plugin id=${COMPLETION PLUGIN ID}
+    # note: disabling pre-filtering to get ranking without match scoring
+    Configure JupyterLab Plugin    {"kernelCompletionsFirst": true, "kernelResponseTimeout": -1, "preFilterMatches": false}    plugin id=${COMPLETION PLUGIN ID}
     Enter Cell Editor    1    line=2
     Trigger Completer
     Completer Should Suggest    %%timeit
@@ -39,7 +48,8 @@ Can Prioritize Kernel Completions
     Should Be True    ${kernel_position} < ${lsp_position}
 
 Can Prioritize LSP Completions
-    Configure JupyterLab Plugin    {"kernelCompletionsFirst": false, "kernelResponseTimeout": -1}    plugin id=${COMPLETION PLUGIN ID}
+    # note: disabling pre-filtering to get ranking without match scoring
+    Configure JupyterLab Plugin    {"kernelCompletionsFirst": false, "kernelResponseTimeout": -1, "preFilterMatches": false}    plugin id=${COMPLETION PLUGIN ID}
     Enter Cell Editor    1    line=2
     Trigger Completer
     Completer Should Suggest    %%timeit
@@ -160,6 +170,7 @@ Does Not Autocomplete If Multiple Options
     Completer Should Suggest    copy
 
 User Can Select Lowercase After Starting Uppercase
+    Configure JupyterLab Plugin    {"caseSensitive": false}    plugin id=${COMPLETION PLUGIN ID}
     # `from time import Tim<tab>` → `from time import time`
     Enter Cell Editor    5    line=1
     Trigger Completer
@@ -212,7 +223,7 @@ Triggers Completer On Dot
     Completer Should Suggest    append
 
 Material Theme Works
-    Configure JupyterLab Plugin    {"theme": "material"}    plugin id=${COMPLETION PLUGIN ID}
+    Configure JupyterLab Plugin    {"theme": "material", "caseSensitive": false}    plugin id=${COMPLETION PLUGIN ID}
     Capture Page Screenshot    01-configured.png
     Enter Cell Editor    1    line=2
     Trigger Completer
@@ -223,7 +234,7 @@ Material Theme Works
     Completer Should Include Icon    lsp:material-class-light
 
 VSCode Theme Works
-    Configure JupyterLab Plugin    {"theme": "vscode"}    plugin id=${COMPLETION PLUGIN ID}
+    Configure JupyterLab Plugin    {"theme": "vscode", "caseSensitive": false}    plugin id=${COMPLETION PLUGIN ID}
     Capture Page Screenshot    01-configured.png
     Enter Cell Editor    1    line=2
     Trigger Completer
@@ -236,7 +247,7 @@ VSCode Dark Theme Works
     Lab Command    Use Theme: JupyterLab Dark
     Wait For Splash
     Capture Page Screenshot    00-theme-changed.png
-    Configure JupyterLab Plugin    {"theme": "vscode"}    plugin id=${COMPLETION PLUGIN ID}
+    Configure JupyterLab Plugin    {"theme": "vscode", "caseSensitive": false}    plugin id=${COMPLETION PLUGIN ID}
     Capture Page Screenshot    01-configured.png
     Open ${file} in ${MENU NOTEBOOK}
     Wait Until Fully Initialized
@@ -249,7 +260,7 @@ VSCode Dark Theme Works
     Wait For Splash
 
 Works Without A Theme
-    Configure JupyterLab Plugin    {"theme": null}    plugin id=${COMPLETION PLUGIN ID}
+    Configure JupyterLab Plugin    {"theme": null, "caseSensitive": false}    plugin id=${COMPLETION PLUGIN ID}
     Capture Page Screenshot    01-configured.png
     Enter Cell Editor    1    line=2
     Trigger Completer
@@ -258,7 +269,7 @@ Works Without A Theme
     Wait Until Page Contains Element    ${COMPLETER_BOX} .jp-Completer-monogram
 
 Works With Incorrect Theme
-    Configure JupyterLab Plugin    {"theme": "a-non-existing-theme"}    plugin id=${COMPLETION PLUGIN ID}
+    Configure JupyterLab Plugin    {"theme": "a-non-existing-theme", "caseSensitive": false}    plugin id=${COMPLETION PLUGIN ID}
     Capture Page Screenshot    01-configured.png
     Enter Cell Editor    1    line=2
     Trigger Completer
diff --git a/packages/jupyterlab-lsp/schema/completion.json b/packages/jupyterlab-lsp/schema/completion.json
@@ -76,6 +76,12 @@
       "type": "boolean",
       "description": "Should perfect matches be included in the completion suggestions list?"
     },
+    "preFilterMatches": {
+      "title": "Pre-filter matches",
+      "default": true,
+      "type": "boolean",
+      "description": "Should matches be pre-filtered to ensure typed token is a prefix of the match?"
+    },
     "labelExtra": {
       "title": "Text to display next to completion label",
       "default": "auto",
diff --git a/packages/jupyterlab-lsp/src/features/completion/completion.ts b/packages/jupyterlab-lsp/src/features/completion/completion.ts
@@ -130,6 +130,8 @@ export class CompletionLabIntegration implements IFeatureLabIntegration {
           this.settings.composite.caseSensitive;
         this.model.settings.includePerfectMatches =
           this.settings.composite.includePerfectMatches;
+        this.model.settings.preFilterMatches =
+          this.settings.composite.preFilterMatches;
       }
     });
   }
@@ -285,7 +287,8 @@ export class CompletionLabIntegration implements IFeatureLabIntegration {
     completer.addClass('lsp-completer');
     completer.model = new LSPCompleterModel({
       caseSensitive: this.settings.composite.caseSensitive,
-      includePerfectMatches: this.settings.composite.includePerfectMatches
+      includePerfectMatches: this.settings.composite.includePerfectMatches,
+      preFilterMatches: this.settings.composite.preFilterMatches
     });
   }
 
diff --git a/packages/jupyterlab-lsp/src/features/completion/model.ts b/packages/jupyterlab-lsp/src/features/completion/model.ts
@@ -49,6 +49,21 @@ export class GenericCompleterModel<
 
   setCompletionItems(newValue: T[]) {
     super.setCompletionItems!(newValue);
+
+    if (this.settings.preFilterMatches && this.current && this.cursor) {
+      // set initial query to pre-filter items; in future we should use:
+      // https://github.com/jupyterlab/jupyterlab/issues/9763#issuecomment-1001603348
+      const { start, end } = this.cursor;
+      let query = this.current.text.substring(start, end).trim();
+      // special case for "Completes Paths In Strings" test case
+      if (query.startsWith('"') || query.startsWith("'")) {
+        query = query.substring(1);
+      }
+      if (query.endsWith('"') || query.endsWith("'")) {
+        query = query.substring(0, -1);
+      }
+      this.query = query;
+    }
   }
 
   private _markFragment(value: string): string {
@@ -180,10 +195,15 @@ export namespace GenericCompleterModel {
      * Whether perfect matches should be included (default = true)
      */
     includePerfectMatches?: boolean;
+    /**
+     * Wheteher matches should be pre-filtered (default = true)
+     */
+    preFilterMatches?: boolean;
   }
   export const defaultOptions: IOptions = {
     caseSensitive: true,
-    includePerfectMatches: true
+    includePerfectMatches: true,
+    preFilterMatches: true
   };
 }
 

Original file line number	Diff line number	Diff line change
`@@ -130,6 +130,8 @@ export class CompletionLabIntegration implements IFeatureLabIntegration {`
`130`	`130`	`this.settings.composite.caseSensitive;`
`131`	`131`	`this.model.settings.includePerfectMatches =`
`132`	`132`	`this.settings.composite.includePerfectMatches;`
	`133`	`+ this.model.settings.preFilterMatches =`
	`134`	`+ this.settings.composite.preFilterMatches;`
`133`	`135`	`}`
`134`	`136`	`});`
`135`	`137`	`}`
`@@ -285,7 +287,8 @@ export class CompletionLabIntegration implements IFeatureLabIntegration {`
`285`	`287`	`completer.addClass('lsp-completer');`
`286`	`288`	`completer.model = new LSPCompleterModel({`
`287`	`289`	`caseSensitive: this.settings.composite.caseSensitive,`
`288`		`- includePerfectMatches: this.settings.composite.includePerfectMatches`
	`290`	`+ includePerfectMatches: this.settings.composite.includePerfectMatches,`
	`291`	`+ preFilterMatches: this.settings.composite.preFilterMatches`
`289`	`292`	`});`
`290`	`293`	`}`
`291`	`294`