Use distinct sign ids when placing col signs (autozimu#143)

* Use distinct sign ids when placing col signs

* Explicitly use the integer key of the diagnostics as the offset rather than the implicit ordering

* Update local DiagnosticsDisplay to match json equivalent

* Use sorted list of unique diagnostic names to determine exact sign id

Author: rschifflin

rplugin/python3/LanguageClient/util.py

@@ -12,6 +12,7 @@
 from . logger import logger
 from . Sign import Sign
 from .CompletionItemKind import convert_CompletionItemKind_to_vim_kind
+from .DiagnosticsDisplay import DiagnosticsDisplay
 
 project_root = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
 
@@ -113,6 +114,21 @@ def escape(string: str) -> str:
     return string.replace("'", "''")
 
 
+def convert_Sign_to_vim_sign_id(sign: Sign) -> int:
+    # Vim sign ids are a global namespace restricted to signed 32-bit integers.
+    # As a polite attempt to avoid collisions with other plugins, we begin numbering far from 0
+    base_id = 75000
+
+    diagnostic_names = sorted(set(map(lambda diag: diag["name"], DiagnosticsDisplay.values())))
+    diagnostic_offset = 0
+    for offset, name in enumerate(diagnostic_names):
+        if name == sign.signname:
+            diagnostic_offset = offset
+            break
+    line_multi = len(diagnostic_names)
+    return base_id + ((sign.line - 1) * line_multi) + diagnostic_offset
+
+
 def retry(span, count, condition):
     while count > 0 and condition():
         logger.info("retrying...")
@@ -128,13 +144,14 @@ def get_command_goto_file(path, bufnames, l, c) -> str:
 
 
 def get_command_delete_sign(sign: Sign) -> str:
-    return " | execute('sign unplace {}')".format(sign.line)
+    return " | execute('sign unplace {} buffer={}')".format(
+            convert_Sign_to_vim_sign_id(sign), sign.bufnumber)
 
 
 def get_command_add_sign(sign: Sign) -> str:
     return (" | execute('sign place {} line={} "
             "name=LanguageClient{} buffer={}')").format(
-                sign.line, sign.line, sign.signname, sign.bufnumber)
+                convert_Sign_to_vim_sign_id(sign), sign.line, sign.signname, sign.bufnumber)
 
 
 def get_command_update_signs(signs: List[Sign], next_signs: List[Sign]) -> str:

rplugin/python3/LanguageClient/util_test.py

@@ -49,14 +49,38 @@ def test_getGotoFileCommand():
 
 def test_getCommandDeleteSign():
     sign = Sign(1, "Error", 1)
-    assert get_command_delete_sign(sign) == " | execute('sign unplace 1')"
+    assert get_command_delete_sign(sign) == " | execute('sign unplace 75000 buffer=1')"
+
+    sign = Sign(1, "Hint", 2)
+    assert get_command_delete_sign(sign) == " | execute('sign unplace 75001 buffer=2')"
+
+    sign = Sign(1, "Information", 3)
+    assert get_command_delete_sign(sign) == " | execute('sign unplace 75002 buffer=3')"
+
+    sign = Sign(1, "Warning", 4)
+    assert get_command_delete_sign(sign) == " | execute('sign unplace 75003 buffer=4')"
 
 
 def test_getCommandAddSign():
-    sign = Sign(1, "Error", 1)
+    sign = Sign(7, "Error", 4)
     assert (get_command_add_sign(sign) ==
-            " | execute('sign place 1 line=1"
-            " name=LanguageClientError buffer=1')")
+            " | execute('sign place 75024 line=7"
+            " name=LanguageClientError buffer=4')")
+
+    sign = Sign(7, "Hint", 3)
+    assert (get_command_add_sign(sign) ==
+            " | execute('sign place 75025 line=7"
+            " name=LanguageClientHint buffer=3')")
+
+    sign = Sign(7, "Information", 2)
+    assert (get_command_add_sign(sign) ==
+            " | execute('sign place 75026 line=7"
+            " name=LanguageClientInformation buffer=2')")
+
+    sign = Sign(7, "Warning", 1)
+    assert (get_command_add_sign(sign) ==
+            " | execute('sign place 75027 line=7"
+            " name=LanguageClientWarning buffer=1')")
 
 
 def test_getCommandUpdateSigns_unique():
@@ -70,7 +94,7 @@ def test_getCommandUpdateSigns_unique():
         Sign(3, "Error", 1),
     ]
     assert (get_command_update_signs(signs, nextSigns) ==
-            "echo | execute('sign place 2 line=2"
+            "echo | execute('sign place 75004 line=2"
             " name=LanguageClientError buffer=1')")
 
 
@@ -92,10 +116,10 @@ def test_getCommandUpdateSigns_withDuplicates():
     ]
 
     cmd = get_command_update_signs(signs, nextSigns)
-    assert "execute('sign place 1 line=1 name=LanguageClientError buffer=1')" not in cmd
-    assert "execute('sign place 2 line=2 name=LanguageClientError buffer=1')" in cmd
-    assert "execute('sign unplace 3')" in cmd
-    assert "execute('sign unplace 4')" not in cmd
+    assert "execute('sign place 75000 line=1 name=LanguageClientError buffer=1')" not in cmd
+    assert "execute('sign place 75004 line=2 name=LanguageClientError buffer=1')" in cmd
+    assert "execute('sign unplace 75008 buffer=1')" in cmd
+    assert "execute('sign unplace 75012 buffer=1')" not in cmd
 
 
 def test_convertVimCommandArgsToKwargs():