Fix more flaky completion tests (#863)

Author: krassowski

atest/05_Features/Completion.robot

@@ -193,14 +193,15 @@ User Can Select Lowercase After Starting Uppercase
 Mid Token Completions Do Not Overwrite
     # `disp<tab>data` → `display_table<cursor>data`
     Place Cursor In Cell Editor At    9    line=1    character=4
-    Capture Page Screenshot    01-cursor-placed.png
+    Wait For Our Completer To Replace Native In Cell    9
     Trigger Completer
     Completer Should Suggest    display_table
     Select Completer Suggestion    display_table
     Capture Page Screenshot    02-completed.png
     Wait Until Keyword Succeeds    40x    0.5s    Cell Editor Should Equal    9    display_tabledata
     # `disp<tab>lay` → `display_table<cursor>`
     Place Cursor In Cell Editor At    11    line=1    character=4
+    Wait For Our Completer To Replace Native In Cell    11
     Trigger Completer
     Wait For Ready State
     Completer Should Suggest    display_table
@@ -295,11 +296,7 @@ Completes Correctly With R Double And Triple Colon
     [Setup]    Prepare File for Editing    R    completion    completion.R
     Place Cursor In File Editor At    2    7
     Wait Until Fully Initialized
-    # normally the completion adapter taking time to initialise is not a problem
-    # but because the token-based completion fallback would break our test example
-    # if it kicked off we try to avoid it by adding some delay
-    # TODO remove sleep after migrating to JupyterLab 4.0 native adapters.
-    Sleep    2s    Workaround completion adapter taking some time to initialize
+    Wait For Our Completer To Replace Native In File Editor
     Trigger Completer
     Completer Should Suggest    .print.via.format
     Select Completer Suggestion    .print.via.format
@@ -324,8 +321,7 @@ Shows Documentation With CompletionItem Resolve
     [Setup]    Prepare File for Editing    R    completion    completion.R
     Place Cursor In File Editor At    8    7
     Wait Until Fully Initialized
-    # TODO remove sleep after migrating to JupyterLab 4.0 native adapters.
-    Sleep    2s    Workaround completion adapter taking some time to initialize
+    Wait For Our Completer To Replace Native In File Editor
     Trigger Completer
     Completer Should Suggest    print.data.frame
     # if data.frame is not active, activate it (it should be in top 10 on any platform)
@@ -352,6 +348,7 @@ Completes In R Magics
     # - R lanugage server is very sensitive to off-by-one errors (see https://github.com/REditorSupport/languageserver/issues/395)
     # '%%R\n librar<tab>'
     Enter Cell Editor    22    line=2
+    Wait For Our Completer To Replace Native In Cell    22
     Trigger Completer
     Completer Should Suggest    library
     # '%R lib<tab>'
@@ -361,6 +358,7 @@ Completes In R Magics
 
 Completes Paths In Strings
     Enter Cell Editor    26
+    Wait For Our Completer To Replace Native In Cell    26
     Press Keys    None    LEFT
     Trigger Completer
     Press Keys    None    ENTER
@@ -467,3 +465,15 @@ Should Complete While Kernel Is Busy
     Completer Should Suggest    test
     # Confirm that the kernel indicator was busy all along
     Page Should Contain Element    ${KERNEL_BUSY_INDICATOR}
+
+Wait For Our Completer To Replace Native In File Editor
+    # Normally the completion adapter taking time to initialise is not a problem
+    # but because the token-based completion fallback would break some test example
+    # if it kicked in (by instant-completing some token) so we try to avoid it
+    # TODO remove after migrating to JupyterLab 4.0 native adapters.
+    Wait Until Page Contains Element    css:.jp-FileEditor .lsp-completer-enabled
+
+Wait For Our Completer To Replace Native In Cell
+    [Arguments]    ${cell_nr}
+    # TODO remove after migrating to JupyterLab 4.0 native adapters.
+    Wait Until Page Contains Element    css:.jp-Cell:nth-child(${cell_nr}) .lsp-completer-enabled

atest/05_Features/Signature.robot

@@ -41,15 +41,13 @@ Triggers Signature Help After A Keystroke
     Press Keys    None    )
     Wait Until Keyword Succeeds    20x    0.5s    Page Should Not Contain Element    ${SIGNATURE_BOX}
 
-
 Triggered Signature Is Visible In First Cell
     # test boundary conditions for out of view behaviour
     Enter Cell Editor    1
     Press Keys    None    (
     Wait Until Keyword Succeeds    20x    0.5s    Page Should Contain Element    ${SIGNATURE_BOX}
     Element Should Be Visible    ${SIGNATURE_BOX}
 
-
 Should Close After Moving Cursor Prior To Start
     Enter Cell Editor    2    line=6
     Press Keys    None    (

atest/Variables.resource

@@ -22,7 +22,8 @@ ${CMD PALETTE ITEM ACTIVE}      css:#command-palette .lm-CommandPalette-item.lm-
 ${JLAB XP TOP}                  //div[@id='jp-top-panel']
 ${JLAB XP MENU ITEM LABEL}      //div[contains(@class, 'lm-Menu-itemLabel')]
 ${JLAB XP MENU LABEL}           //div[contains(@class, 'lm-MenuBar-itemLabel')]
-${JLAB XP DOCK TAB}             xpath://div[contains(@class, 'lm-DockPanel-tabBar')]//li[contains(@class, 'lm-TabBar-tab')]
+${JLAB XP DOCK TAB}
+...                             xpath://div[contains(@class, 'lm-DockPanel-tabBar')]//li[contains(@class, 'lm-TabBar-tab')]
 ${JLAB CSS VERSION}             css:.jp-About-version
 ${JLAB CSS REFRESH F_OLD}       css:button[title="Refresh File List"]
 ${JLAB CSS REFRESH FILES}       css:button[data-command="filebrowser:refresh"]
@@ -31,28 +32,34 @@ ${MENU OPEN WITH}               xpath://div[contains(@class, 'lm-Menu-itemLabel'
 # R is missing on purpose (may need to use .)
 ${MENU RENAME}                  xpath://div[contains(@class, 'lm-Menu-itemLabel')][contains(., "ename")]
 # N is missing on purpose (N is in separate <span>)
-${MENU NOTEBOOK}                xpath://li[@data-command='filebrowser:open']/div[contains(@class, 'lm-Menu-itemLabel')][contains(., "otebook")]
+${MENU NOTEBOOK}
+...                             xpath://li[@data-command='filebrowser:open']/div[contains(@class, 'lm-Menu-itemLabel')][contains(., "otebook")]
 ${DIAGNOSTICS PANEL}            id:lsp-diagnostics-panel
-${DIAGNOSTIC PANEL CLOSE}       css:.lm-DockPanel-tabBar .lm-TabBar-tab[data-id="lsp-diagnostics-panel"] .lm-TabBar-tabCloseIcon
+${DIAGNOSTIC PANEL CLOSE}
+...                             css:.lm-DockPanel-tabBar .lm-TabBar-tab[data-id="lsp-diagnostics-panel"] .lm-TabBar-tabCloseIcon
 ${DIALOG WINDOW}                css:.jp-Dialog
 ${DIALOG INPUT}                 css:.jp-Input-Dialog input
 ${DIALOG ACCEPT}                css:button.jp-Dialog-button.jp-mod-accept
 ${STATUSBAR}                    css:div.lsp-statusbar-item
 ${MENU EDITOR}                  xpath://div[contains(@class, 'lm-Menu-itemLabel')][contains(., "Editor")]
-${MENU JUMP}                    xpath://div[contains(@class, 'lm-Menu-itemLabel')][contains(text(), "Jump to definition")]
+${MENU JUMP}
+...                             xpath://div[contains(@class, 'lm-Menu-itemLabel')][contains(text(), "Jump to definition")]
 ${MENU SETTINGS}                xpath://div[contains(@class, 'lm-MenuBar-itemLabel')][contains(text(), "Settings")]
-${MENU EDITOR THEME}            xpath://div[contains(@class, 'lm-Menu-itemLabel')][contains(text(), "Text Editor Theme")]
+${MENU EDITOR THEME}
+...                             xpath://div[contains(@class, 'lm-Menu-itemLabel')][contains(text(), "Text Editor Theme")]
 ${LAB MENU}                     css:.lm-Menu
 ${CM CURSOR}                    css:.CodeMirror-cursor
-${CM CURSORS}                   css:.jp-MainAreaWidget:not(.lm-mod-hidden) .CodeMirror-cursors:not([style='visibility: hidden'])
+${CM CURSORS}
+...                             css:.jp-MainAreaWidget:not(.lm-mod-hidden) .CodeMirror-cursors:not([style='visibility: hidden'])
 # settings
 ${LSP PLUGIN ID}                @krassowski/jupyterlab-lsp:plugin
 ${COMPLETION PLUGIN ID}         @krassowski/jupyterlab-lsp:completion
 ${HIGHLIGHTS PLUGIN ID}         @krassowski/jupyterlab-lsp:highlights
 ${JUMP PLUGIN ID}               @krassowski/jupyterlab-lsp:jump_to
 ${DIAGNOSTICS PLUGIN ID}        @krassowski/jupyterlab-lsp:diagnostics
 ${CSS USER SETTINGS}            .jp-SettingsRawEditor-user
-${JLAB XP CLOSE SETTINGS}       ${JLAB XP DOCK TAB}\[contains(., 'Settings')]/*[contains(@class, 'm-TabBar-tabCloseIcon')]
+${JLAB XP CLOSE SETTINGS}
+...                             ${JLAB XP DOCK TAB}\[contains(., 'Settings')]/*[contains(@class, 'm-TabBar-tabCloseIcon')]
 # diagnostics
 ${CSS DIAGNOSTIC}               css:.cm-lsp-diagnostic
 # log messages

docs/Installation.ipynb

@@ -362,7 +362,7 @@
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "Python 3",
+   "display_name": "Python 3 (ipykernel)",
    "language": "python",
    "name": "python3"
   },

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

@@ -32,6 +32,7 @@ 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[];
@@ -443,5 +444,10 @@ export class CompletionLabIntegration implements IFeatureLabIntegration {
         ?.session,
       console: this.console
     });
+    if (this._disabled) {
+      editor.host.classList.remove(LSP_COMPLETER_ENABLED_CLASS);
+    } else {
+      editor.host.classList.add(LSP_COMPLETER_ENABLED_CLASS);
+    }
   }
 }