Merge pull request #208 from mphe/fix_duplicated_caches

Fix multiple shapes sharing the same mesh cache after duplicate()

Author: mphe

addons/diagnosticlist/Diagnostic.gd

@@ -30,5 +30,3 @@ func get_filename() -> StringName:
     if _filename.is_empty():
         _filename = StringName(res_uri.get_file())
     return _filename
-
-

addons/diagnosticlist/Diagnostic.gd.uid

@@ -1 +1 @@
-uid://iepkcjoev3la
+uid://o35ee3po5en8

addons/diagnosticlist/DiagnosticProvider.gd

@@ -66,6 +66,8 @@ func refresh_diagnostics(force: bool = false) -> bool:
     # NOTE: We always have to do a full update, because a change in one file can cause errors in
     # other files, e.g. renaming an identifier.
 
+    DiagnosticList_Utils.log_debug("Provider: refresh_diagnostics()")
+
     # Still waiting for results from the last call
     if _num_outstanding > 0:
         _dirty = false  # Dirty will be reset anyway after update has been finished
@@ -125,6 +127,7 @@ func refresh_file_list() -> bool:
             cache.last_modified = last_modified
             cache.content = FileAccess.get_file_as_string(path)
             modified = true
+            DiagnosticList_Utils.log_debug("Provider: file modification detected: %s" % path)
 
     # One or more files were deleted
     if _file_cache.size() > _script_paths.size():
@@ -134,6 +137,7 @@ func refresh_file_list() -> bool:
         for path: String in _file_cache.keys():
             if not _script_paths.has(path):
                 _file_cache.erase(path)
+                DiagnosticList_Utils.log_debug("Provider: file deleted: %s" % path)
 
     return modified
 
@@ -143,8 +147,12 @@ func get_diagnostic_count(severity: DiagnosticList_Diagnostic.Severity) -> int:
     return _counts[severity]
 
 
-## Returns all diagnostics of the project
+## Returns all diagnostics of the project.
+## The list of diagnostics is grouped by file, i.e. all diagnostics belonging to the same file are
+## consecutive elements.
 func get_diagnostics() -> Array[DiagnosticList_Diagnostic]:
+    # NOTE: The LSP server usually publishes diagnostics consecutively per file and not in random
+    # order. Hence we do not need additional sorting to fulfill the contract of this method.
     return _diagnostics.duplicate()
 
 
@@ -191,6 +199,7 @@ func _mark_dirty() -> void:
 
 func _on_sources_changed(_exist: bool) -> void:
     _mark_dirty()
+    DiagnosticList_Utils.log_debug("Provider: on_sources_changed")
 
 
 func _on_script_classes_updated() -> void:
@@ -209,12 +218,13 @@ func _on_script_classes_updated() -> void:
     # Hence, when the signal arrives and the Godot window has focus, an update should be performed.
     if EditorInterface.get_base_control().get_window().has_focus():
         _mark_dirty()
+        DiagnosticList_Utils.log_debug("Provider: on_script_classes_updated")
 
 
 func _on_publish_diagnostics(diagnostics: DiagnosticList_Diagnostic.Pack) -> void:
     # Ignore unexpected diagnostic updates
     if _num_outstanding == 0:
-        _client.log_error("Received diagnostics without having them requested before")
+        DiagnosticList_Utils.log_error("Received diagnostics without having them requested before")
         return
 
     _diagnostics.append_array(diagnostics.diagnostics)

addons/diagnosticlist/DiagnosticProvider.gd.uid

@@ -1 +1 @@
-uid://c0fhe5ubxdqdu
+uid://dghjmk3ev0o15

addons/diagnosticlist/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Marvin Ewald
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

addons/diagnosticlist/LSPClient.gd

@@ -14,7 +14,6 @@ signal on_publish_diagnostics(diagnostics: DiagnosticList_Diagnostic.Pack)
 signal on_jsonrpc_error(error: Dictionary)
 
 
-const ENABLE_DEBUG_LOG: bool = false
 const TICK_INTERVAL_SECONDS_MIN: float = 0.05
 const TICK_INTERVAL_SECONDS_MAX: float = 30.0
 
@@ -26,7 +25,14 @@ var _jsonrpc := JSONRPC.new()
 var _client := StreamPeerTCP.new()
 var _id: int = 0
 var _timer: Timer
-var _lsp_project_path: String = ""  # Absolute project path reported by LS
+
+## Absolute project path reported by LS.
+## Will be initialized when the LSP connection is initialized ( _initialize()) and changed by
+## changeWorkspace events.
+var _ls_project_path: String = ""
+
+## Absolute path of the loaded project.
+var _project_path: String = ProjectSettings.globalize_path("res://").simplify_path()
 
 
 func _init(root: Node) -> void:
@@ -41,7 +47,7 @@ func _init(root: Node) -> void:
 
 
 func disconnect_lsp() -> void:
-    log_debug("Disconnecting from LSP")
+    DiagnosticList_Utils.log_debug("Disconnecting from LSP")
     _timer.stop()
     _client.disconnect_from_host()
 
@@ -56,10 +62,11 @@ func connect_lsp() -> bool:
 
 ## Connect to the LSP server at the given host and port.
 func connect_lsp_at(host: String, port: int) -> bool:
+    DiagnosticList_Utils.log_debug("Connecting to LSP at %s:%d" % [ host, port ])
     var err := _client.connect_to_host(host, port)
 
     if err != OK:
-        log_error("Failed to connect to LSP server: %s" % err)
+        DiagnosticList_Utils.log_error("Failed to connect to LSP server: %s" % err)
         return false
 
     # Enable processing
@@ -96,9 +103,11 @@ func update_diagnostics(res_path: String, content: String) -> void:
     })
 
 
-## Returns the absolute project path as reported by the LS.
-func get_project_path() -> String:
-    return _lsp_project_path
+## Returns whether the root directory reported by the LS is the same as the project root.
+## If there is a mismatch, the LSP client is very likely connected to a different Godot instance
+## with a different project opened.
+func lsp_root_matches_project_root() -> bool:
+    return _ls_project_path == _project_path
 
 
 func _reset_tick_interval() -> void:
@@ -118,10 +127,11 @@ func _on_tick() -> void:
     _update_tick_interval()
 
     while _client.get_available_bytes():
+        DiagnosticList_Utils.log_debug("Bytes available: %d" % _client.get_available_bytes())
         var json := _read_data()
 
         if json:
-            log_debug("Received message:\n%s" % json)
+            DiagnosticList_Utils.log_debug("Received message:\n%s" % json)
 
         _handle_response(json)
         _reset_tick_interval()  # Reset timer interval whenever data arrived as there will likely be more data coming
@@ -139,14 +149,14 @@ func _update_status() -> bool:
         StreamPeerTCP.STATUS_NONE:
             return false
         StreamPeerTCP.STATUS_ERROR:
-            log_error("StreamPeerTCP error")
+            DiagnosticList_Utils.log_error("StreamPeerTCP error")
             return false
         StreamPeerTCP.STATUS_CONNECTING:
             pass
         StreamPeerTCP.STATUS_CONNECTED:
             # First time connected -> run initialization
             if last_status != status:
-                log_debug("Connected to LSP")
+                DiagnosticList_Utils.log_debug("Connected to LSP")
                 on_connected.emit()
                 _initialize()
 
@@ -166,7 +176,7 @@ func _read_data() -> Dictionary:
     var json: Dictionary = JSON.parse_string(content)
 
     if not json:
-        log_error("Failed to parse JSON: %s" % content)
+        DiagnosticList_Utils.log_error("Failed to parse JSON: %s" % content)
         return {}
 
     return json
@@ -176,14 +186,16 @@ func _read_content(length: int) -> String:
     var data := _client.get_data(length)
 
     if data[0] != OK:
-        log_error("Failed to read content: %s" % error_string(data[0]))
+        DiagnosticList_Utils.log_error("Failed to read content: %s" % error_string(data[0]))
         return ""
     else:
         var buf: PackedByteArray = data[1]
         return buf.get_string_from_utf8()
 
 
 func _read_header() -> String:
+    DiagnosticList_Utils.log_debug("reading header")
+
     var buf := PackedByteArray()
     var char_r := "\r".unicode_at(0)
     var char_n := "\n".unicode_at(0)
@@ -192,7 +204,7 @@ func _read_header() -> String:
         var data := _client.get_data(1)
 
         if data[0] != OK:
-            log_error("Failed to read header: %s" % error_string(data[0]))
+            DiagnosticList_Utils.log_error("Failed to read header: %s" % error_string(data[0]))
             return ""
         else:
             buf.push_back(data[1][0])
@@ -221,20 +233,22 @@ func _handle_response(json: Dictionary) -> void:
 
         # Project path
         "gdscript_client/changeWorkspace":
-            _lsp_project_path = str(json["params"]["path"]).simplify_path()
+            _ls_project_path = str(json["params"]["path"]).simplify_path()
+            DiagnosticList_Utils.log_debug("Change Workspace: %s" % _ls_project_path)
             return
 
     # Initialization response
     if json.get("id") == 0:
+        DiagnosticList_Utils.log_debug("LSP initialized")
         _send_notification("initialized", {})
         on_initialized.emit()
         return
 
     # JSON-RPC error
     if json.has("error"):
         var error: Dictionary = json["error"]
-        log_error("JSON-RPC Error: %s" % error)
-        log_error("This is likely a bug in the plugin. Consider submitting a bug report on GitHub.")
+        DiagnosticList_Utils.log_error("JSON-RPC Error: %s" % error)
+        DiagnosticList_Utils.log_error("This is likely a bug in the plugin. Consider submitting a bug report on GitHub.")
         on_jsonrpc_error.emit(error)
 
 
@@ -275,14 +289,24 @@ func _send(json: Dictionary) -> void:
     var content_bytes := content.to_utf8_buffer()
     var header := "Content-Length: %s\r\n\r\n" % len(content_bytes)
     var header_bytes := header.to_ascii_buffer()
-    log_debug("Sending message (length: %s): %s" % [ len(content_bytes), content ])
-    _client.put_data(header_bytes + content_bytes)
+    DiagnosticList_Utils.log_debug("Sending message (length: %s): %s" % [ len(content_bytes), content ])
+    var err := _client.put_data(header_bytes + content_bytes)
+
+    if err != OK:
+        DiagnosticList_Utils.log_error("Failed to send: %s" % error_string(err))
+
     _reset_tick_interval()  # Reset the timer interval because we are expecting a response
 
 
 func _initialize() -> void:
+    # Comply with LSP, try to initialize root directory to the current project root.
+    # Godot will likely ignore it and send a changeWorkspace event anyway.
+    _ls_project_path = _project_path
+
     _send_request("initialize", {
         "processId": null,
+        "rootPath": _ls_project_path,
+        "rootUri": _res_path_to_lsp_uri("res://"),
         "capabilities": {
             "textDocument": {
                 "publishDiagnostics": {},
@@ -292,16 +316,10 @@ func _initialize() -> void:
 
 
 func _res_path_to_lsp_uri(res_path: String) -> String:
+    # NOTE: No need to manually call uri_encode() as JSONRPC seems to do that automatically
+    # TODO: Consider using the builtin parsing functionality of JSONRPC instead of doing it manually
     return URI_PREFIX + ProjectSettings.globalize_path(res_path).simplify_path()
 
 
 func _lsp_uri_to_res_path(lsp_uri: String) -> String:
-    return ProjectSettings.localize_path(lsp_uri.replace(URI_PREFIX, ""))
-
-
-func log_debug(text: String) -> void:
-    if ENABLE_DEBUG_LOG:
-        print("[DiagnosticList] ", text)
-
-func log_error(text: String) -> void:
-    push_error("[DiagnosticList] ", text)
+    return ProjectSettings.localize_path(lsp_uri.trim_prefix(URI_PREFIX).uri_decode())

addons/diagnosticlist/LSPClient.gd.uid

@@ -1 +1 @@
-uid://dijchaojix40h
+uid://ppx5ro6gy6ro

addons/diagnosticlist/Panel.gd

@@ -44,6 +44,8 @@ var _provider: DiagnosticList_DiagnosticProvider
 ## Alternative to _ready(). This will be called by plugin.gd to ensure the code in here only runs
 ## when this script is loaded as part of the plugin and not while editing the scene.
 func _plugin_ready() -> void:
+    DiagnosticList_Utils.log_debug("Panel _plugin_ready()")
+
     for i in len(_filter_buttons):
         var btn: Button = _filter_buttons[i]
         var severity := _severity_settings[i]
@@ -85,6 +87,8 @@ func _plugin_ready() -> void:
 
 ## Called by plugin.gd when the LSPClient is ready
 func start(provider: DiagnosticList_DiagnosticProvider) -> void:
+    DiagnosticList_Utils.log_debug("Panel start()")
+
     _provider = provider
 
     # Now that it is safe to do stuff, connect all the signals
@@ -104,18 +108,19 @@ func start(provider: DiagnosticList_DiagnosticProvider) -> void:
     _start_stop_auto_refresh()
 
     # If connected to a LS of a different Godot instance, show a warning
-    if provider.get_lsp_client().get_project_path() != ProjectSettings.globalize_path("res://").simplify_path():
+    if not provider.get_lsp_client().lsp_root_matches_project_root():
         _multiple_instances_alert.popup_centered()
 
 
 func refresh() -> void:
-    # NOTE: This list is sorted by file name as LSP publishes diagnostics per file
-    # This is important as the group-by-file implementation relies on it.
+    DiagnosticList_Utils.log_debug("Panel refresh()")
+
+    # NOTE: This list is grouped by file name. This is important as the group-by-file implementation relies on it.
     var diagnostics := _provider.get_diagnostics()
     var group_by_file := _cb_group_by_file.button_pressed
 
     if not group_by_file:
-        diagnostics.sort_custom(_sort_by_severity)
+        diagnostics.sort_custom(DiagnosticList_Utils.sort_by_severity)
 
     # Show refresh time
     _set_status_string("Up-to-date", true)
@@ -154,12 +159,6 @@ func _set_status_string(text: String, with_last_time: bool) -> void:
         _label_refresh_time.text = text
 
 
-func _sort_by_severity(a: DiagnosticList_Diagnostic, b: DiagnosticList_Diagnostic) -> bool:
-    if a.severity == b.severity:
-        return a.res_uri < b.res_uri
-    return a.severity < b.severity
-
-
 func _create_entry(diag: DiagnosticList_Diagnostic, parent: TreeItem) -> void:
     var entry: TreeItem = _error_list_tree.create_item(parent)
     var severity_setting := _severity_settings[diag.severity]
@@ -174,6 +173,8 @@ func _create_entry(diag: DiagnosticList_Diagnostic, parent: TreeItem) -> void:
 
 
 func _update_diagnostics(force: bool) -> void:
+    DiagnosticList_Utils.log_debug("Panel _update_diagnostics()")
+
     if _provider.is_updating() or _provider.refresh_diagnostics(force):
         _set_status_string("Updating...", false)
     else:

addons/diagnosticlist/Panel.gd.uid

@@ -1 +1 @@
-uid://btyk17v3aai46
+uid://b3dpnradvv4q5

addons/diagnosticlist/Panel.tscn

@@ -1,6 +1,6 @@
 [gd_scene load_steps=2 format=3 uid="uid://tsfsnxbfcax6"]
 
-[ext_resource type="Script" uid="uid://btyk17v3aai46" path="res://addons/diagnosticlist/Panel.gd" id="1_fewy8"]
+[ext_resource type="Script" uid="uid://b3dpnradvv4q5" path="res://addons/diagnosticlist/Panel.gd" id="1_fewy8"]
 
 [node name="DiagnosticsPanel" type="Control"]
 custom_minimum_size = Vector2(250, 225)
@@ -42,8 +42,8 @@ text = "Auto-Refresh"
 
 [node name="btn_refresh_errors" type="Button" parent="HBoxContainer/VBoxContainer"]
 unique_name_in_owner = true
+auto_translate_mode = 2
 layout_mode = 2
-auto_translate = false
 text = "Refresh"
 
 [node name="HSeparator" type="HSeparator" parent="HBoxContainer/VBoxContainer"]