Fix hover malfunction messages (jupyter-lsp#630)

* Fix hover malfunction messages

* Sync completion-theme version, relax some constraints

* Update changelog, bump theme versions (as pin was relaxed)

Author: krassowski

CHANGELOG.md

@@ -2,14 +2,19 @@
 
 ### `@krassowski/jupyterlab-lsp 3.7.1` (unreleased)
 
+- improvements:
+
+  - add a note on manually enabling backend extension ([#621], thanks @icankeep)
+
 - bug fixes:
   - fix rename shortcut registration in file editor ([#614])
-  - add a note on manually enabling backend extension ([#621], thanks @icankeep)
   - improve performance of icon rendering in completer ([#625])
+  - fix cache misses and concurrency issues for hover ([#630])
 
 [#614]: https://github.com/krassowski/jupyterlab-lsp/pull/614
 [#621]: https://github.com/krassowski/jupyterlab-lsp/pull/621
 [#625]: https://github.com/krassowski/jupyterlab-lsp/pull/625
+[#630]: https://github.com/krassowski/jupyterlab-lsp/pull/630
 
 ### `jupyter-lsp 1.3.0` (2021-06-02)
 

packages/jupyterlab-lsp/package.json

@@ -58,9 +58,9 @@
   },
   "dependencies": {
     "@krassowski/code-jumpers": "~1.1.0",
-    "@krassowski/completion-theme": "~3.0.0",
-    "@krassowski/theme-material": "~2.1.0",
-    "@krassowski/theme-vscode": "~2.1.0",
+    "@krassowski/completion-theme": "~3.1.0",
+    "@krassowski/theme-material": "~2.1.1",
+    "@krassowski/theme-vscode": "~2.1.1",
     "lodash.mergewith": "^4.6.1",
     "lsp-ws-connection": "~0.6.0"
   },

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

@@ -18,7 +18,11 @@ import {
   CodeMirrorIntegration,
   IEditorRange
 } from '../editor_integration/codemirror';
-import { FeatureSettings, IFeatureLabIntegration } from '../feature';
+import {
+  FeatureSettings,
+  IEditorIntegrationOptions,
+  IFeatureLabIntegration
+} from '../feature';
 import { IRootPosition, IVirtualPosition, is_equal } from '../positioning';
 import { ILSPFeatureManager, PLUGIN_ID } from '../tokens';
 import { getModifierState } from '../utils';
@@ -48,6 +52,18 @@ class ResponseCache {
   }
 
   store(item: IResponseData) {
+    const previousIndex = this._data.findIndex(
+      previous =>
+        previous.document === item.document &&
+        is_equal(previous.editor_range.start, item.editor_range.start) &&
+        is_equal(previous.editor_range.end, item.editor_range.end) &&
+        previous.editor_range.editor === item.editor_range.editor
+    );
+    if (previousIndex !== -1) {
+      this._data[previousIndex] = item;
+      return;
+    }
+
     if (this._data.length >= this.maxSize) {
       this._data.shift();
     }
@@ -85,6 +101,12 @@ export class HoverCM extends CodeMirrorIntegration {
 
   private debounced_get_hover: Throttler<Promise<lsProtocol.Hover>>;
   private tooltip: FreeTooltip;
+  private _previousHoverRequest: Promise<Promise<lsProtocol.Hover>> | null;
+
+  constructor(options: IEditorIntegrationOptions) {
+    super(options);
+    this._previousHoverRequest = null;
+  }
 
   protected get modifierKey(): ModifierKey {
     return this.settings.composite.modifierKey;
@@ -111,7 +133,8 @@ export class HoverCM extends CodeMirrorIntegration {
       return (
         line >= range.start.line &&
         line <= range.end.line &&
-        (line != range.start.line || ch >= range.start.character) &&
+        // need to be non-overlapping see https://github.com/krassowski/jupyterlab-lsp/issues/628
+        (line != range.start.line || ch > range.start.character) &&
         (line != range.end.line || ch <= range.end.character)
       );
     });
@@ -380,10 +403,27 @@ export class HoverCM extends CodeMirrorIntegration {
       this.virtual_position = virtual_position;
       this.last_hover_character = root_position;
 
+      // if we already sent a request, maybe it already covers the are of interest?
+      // not harm waiting as the server won't be able to help us anyways
+      if (this._previousHoverRequest) {
+        await Promise.race([
+          this._previousHoverRequest,
+          // just in case if the request stalled, set a timeout so we do not
+          // get stuck indefinitely
+          new Promise(resolve => {
+            return setTimeout(resolve, 1000);
+          })
+        ]);
+      }
       let response_data = this.restore_from_cache(document, virtual_position);
 
       if (response_data == null) {
-        let response = await this.debounced_get_hover.invoke();
+        const promise = this.debounced_get_hover.invoke();
+        this._previousHoverRequest = promise;
+        let response = await promise;
+        if (this._previousHoverRequest === promise) {
+          this._previousHoverRequest = null;
+        }
         if (this.is_useful_response(response)) {
           let ce_editor = this.virtual_editor.get_editor_at_root_position(
             root_position

packages/theme-material/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@krassowski/theme-material",
-  "version": "2.1.0",
+  "version": "2.1.1",
   "description": "Material theme for JupyterLab-LSP",
   "keywords": [
     "jupyter",
@@ -33,7 +33,7 @@
     "clean": "rimraf lib"
   },
   "dependencies": {
-    "@krassowski/completion-theme": "~3.0.0"
+    "@krassowski/completion-theme": "^3.0.0"
   },
   "devDependencies": {},
   "peerDependencies": {},

packages/theme-vscode/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@krassowski/theme-vscode",
-  "version": "2.1.0",
+  "version": "2.1.1",
   "description": "VSCode theme for JupyterLab-LSP",
   "keywords": [
     "jupyter",
@@ -33,7 +33,7 @@
     "clean": "rimraf lib"
   },
   "dependencies": {
-    "@krassowski/completion-theme": "~3.0.0"
+    "@krassowski/completion-theme": "^3.0.0"
   },
   "devDependencies": {},
   "peerDependencies": {},

yarn.lock

@@ -1987,7 +1987,7 @@
   version "1.1.0"
 
 "@krassowski/completion-theme@file:packages/completion-theme":
-  version "3.0.0"
+  version "3.1.0"
 
 "@krassowski/jupyterlab-lsp-example-extractor@file:packages/_example-extractor":
   version "0.0.0"
@@ -1998,7 +1998,7 @@
   version "3.7.0"
   dependencies:
     "@krassowski/code-jumpers" "~1.1.0"
-    "@krassowski/completion-theme" "~3.0.0"
+    "@krassowski/completion-theme" "~3.1.0"
     "@krassowski/theme-material" "~2.1.0"
     "@krassowski/theme-vscode" "~2.1.0"
     lodash.mergewith "^4.6.1"
@@ -2007,12 +2007,12 @@
 "@krassowski/theme-material@file:packages/theme-material":
   version "2.1.0"
   dependencies:
-    "@krassowski/completion-theme" "~3.0.0"
+    "@krassowski/completion-theme" "^3.0.0"
 
 "@krassowski/theme-vscode@file:packages/theme-vscode":
   version "2.1.0"
   dependencies:
-    "@krassowski/completion-theme" "~3.0.0"
+    "@krassowski/completion-theme" "^3.0.0"
 
 "@lerna/[email protected]":
   version "3.21.0"