Merge pull request #507 from krassowski/completion-and-signature-invalidation

Completion and signature invalidation

Author: krassowski

CHANGELOG.md

@@ -4,11 +4,14 @@
 
 - bug fixes:
 
+  - completion and signature suggestions get invalidated when editor changes ([#507])
+  - signature suggestions now invalidate on cursor move to another line or backwards too ([#507])
   - LaTeX is now rendered in documentation panel of completer ([#506])
   - completion response returned as plain text use pre tag to retain whitespace formatting ([#506])
   - pre-formatted code font size was reduced to match font-size of the text in completion panel ([#506])
 
 [#506]: https://github.com/krassowski/jupyterlab-lsp/pull/506
+[#507]: https://github.com/krassowski/jupyterlab-lsp/pull/507
 
 ### `jupyter-lsp 1.1.3` (unreleased)
 

atest/03_Notebook.robot

@@ -91,6 +91,7 @@ Adding Text To Cells After Kernel Restart
     Setup Notebook    Python    ${file}
     ${virtual_path} =    Set Variable    ${VIRTUALDOCS DIR}${/}${file}
     Wait Until Created    ${virtual_path}
+    Restart Kernel
     Enter Cell Editor    1
     Lab Command    Insert Cell Below
     Enter Cell Editor    2    line=1

atest/05_Features/Completion.robot

@@ -29,6 +29,22 @@ Works When Kernel Is Idle
     ${content} =    Get Cell Editor Content    1
     Should Contain    ${content}    TabError
 
+Invalidates On Cell Change
+    Enter Cell Editor    1    line=2
+    Press Keys    None    TAB
+    Enter Cell Editor    2
+    # just to increase chances of caching this on CI (which is slow)
+    Sleep    5s
+    Completer Should Not Suggest    test
+
+Invalidates On Focus Loss
+    Enter Cell Editor    1    line=2
+    Press Keys    None    TAB
+    Enter Cell Editor    2
+    # just to increase chances of caching this on CI (which is slow)
+    Sleep    5s
+    Completer Should Not Suggest    test
+
 Uses LSP Completions When Kernel Resoponse Times Out
     Configure JupyterLab Plugin    {"kernelResponseTimeout": 1, "waitForBusyKernel": true}    plugin id=${COMPLETION PLUGIN ID}
     Should Complete While Kernel Is Busy
@@ -87,7 +103,6 @@ Continious Hinting Works
 Autocompletes If Only One Option
     Enter Cell Editor    3    line=1
     Press Keys    None    cle
-    Wait Until Fully Initialized
     # First tab brings up the completer
     Press Keys    None    TAB
     Completer Should Suggest    clear
@@ -99,7 +114,6 @@ Autocompletes If Only One Option
 Does Not Autocomplete If Multiple Options
     Enter Cell Editor    3    line=1
     Press Keys    None    c
-    Wait Until Fully Initialized
     # First tab brings up the completer
     Press Keys    None    TAB
     Completer Should Suggest    copy
@@ -302,11 +316,6 @@ Completer Should Include Documentation
     Wait Until Keyword Succeeds    10 x    1 s    Element Should Contain    ${DOCUMENTATION_PANEL}    ${text}
     Element Should Contain    ${DOCUMENTATION_PANEL}    ${text}
 
-Restart Kernel
-    Lab Command    Restart Kernel…
-    Wait For Dialog
-    Accept Default Dialog Option
-
 Count Completer Hints
     ${count} =    Get Element Count    css:.jp-Completer-item
     [Return]    ${count}

atest/05_Features/Signature.robot

@@ -16,3 +16,12 @@ Triggers Signature Help After A Keystroke
     Wait Until Keyword Succeeds    20x    0.5s    Page Should Contain Element    ${SIGNATURE_BOX}
     Element Should Contain    ${SIGNATURE_BOX}    Important docstring of abc()
     [Teardown]    Clean Up After Working With File    Signature.ipynb
+
+Invalidates On Cell Change
+    Setup Notebook    Python    Signature.ipynb
+    Enter Cell Editor    1    line=6
+    Press Keys    None    (
+    Enter Cell Editor    2
+    # just to increase chances of caching this on CI (which is slow)
+    Sleep    5s
+    Page Should Not Contain Element    ${SIGNATURE_BOX}

atest/Keywords.robot

@@ -419,3 +419,8 @@ Open New Notebook
     Wait For Dialog
     # Kernel selection dialog shows up, accept Python as default kernel
     Accept Default Dialog Option
+
+Restart Kernel
+    Lab Command    Restart Kernel…
+    Wait For Dialog
+    Accept Default Dialog Option

packages/jupyterlab-lsp/src/features/completion/completion_handler.ts

@@ -618,6 +618,17 @@ export class LSPConnector
     token: CodeEditor.IToken,
     cursor_at_request: CodeEditor.IPosition
   ) {
+    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
@@ -626,6 +637,9 @@ export class LSPConnector
       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,

packages/jupyterlab-lsp/src/features/signature.ts

@@ -92,16 +92,41 @@ export class SignatureCM extends CodeMirrorIntegration {
     return markdown;
   }
 
-  private handleSignature(response: lsProtocol.SignatureHelp) {
+  private handleSignature(
+    response: lsProtocol.SignatureHelp,
+    position_at_request: IRootPosition
+  ) {
     this.lab_integration.tooltip.remove();
 
     this.console.log('Signature received', response);
+
     if (!this.signature_character || !response || !response.signatures.length) {
+      this.console.debug(
+        'Ignoring signature response: cursor lost or response empty'
+      );
       return;
     }
 
-    let root_position = this.signature_character;
+    let root_position = position_at_request;
+
+    // if the cursor advanced in the same line, the previously retrieved signature may still be useful
+    // if the line changed or cursor moved backwards then no reason to keep the suggestions
+    if (
+      position_at_request.line != root_position.line ||
+      root_position.ch < position_at_request.ch
+    ) {
+      this.console.debug(
+        'Ignoring signature response: cursor has receded or changed line'
+      );
+    }
+
     let cm_editor = this.get_cm_editor(root_position);
+    if (!cm_editor.hasFocus()) {
+      this.console.debug(
+        'Ignoring signature response: the corresponding editor lost focus'
+      );
+      return;
+    }
     let editor_position = this.virtual_editor.root_position_to_editor(
       root_position
     );
@@ -152,7 +177,7 @@ export class SignatureCM extends CodeMirrorIntegration {
         this.virtual_document.document_info,
         false
       )
-      .then(help => this.handleSignature(help))
+      .then(help => this.handleSignature(help, root_position))
       .catch(this.console.warn);
   }
 }