mirror of
https://github.com/tiennm99/serena.git
synced 2026-10-13 20:15:20 +00:00
feat(al): inject full object name into hover and add path normalization
- Override request_hover() to inject cached original names (e.g. 'Table 50000 "TEST Customer"') into hover responses, preserving object type and ID metadata that the AL LSP doesn't include - Add _normalize_path() for consistent cache keys across Windows/Unix path formats - Add comprehensive tests for hover injection and path normalization
This commit is contained in:
Torben Leth committed
1 parent
4a44cba6c8
commit
7af2fe3e2b
2 files changed
+363
-2
No files matched your search
@@ -13,6 +13,7 @@ from pathlib import Path
|
||||
import requests
|
||||
from overrides import override
|
||||
|
||||
from solidlsp import ls_types
|
||||
from solidlsp.language_servers.common import quote_windows_path
|
||||
from solidlsp.ls import DocumentSymbols, LSPFileBuffer, SolidLanguageServer
|
||||
from solidlsp.ls_config import LanguageServerConfig
|
||||
@@ -109,6 +110,14 @@ class ALLanguageServer(SolidLanguageServer):
|
||||
|
||||
super().__init__(config, repository_root_path, ProcessLaunchInfo(cmd=cmd, cwd=repository_root_path), "al", solidlsp_settings)
|
||||
|
||||
# Cache mapping (file_path, line, char) -> original_full_name for hover injection
|
||||
self._al_original_names: dict[tuple[str, int, int], str] = {}
|
||||
|
||||
@staticmethod
|
||||
def _normalize_path(path: str) -> str:
|
||||
"""Normalize file path for consistent cache key usage across platforms."""
|
||||
return path.replace("\\", "/")
|
||||
|
||||
@classmethod
|
||||
def _download_al_extension(cls, url: str, target_dir: str) -> bool:
|
||||
"""
|
||||
@@ -1013,9 +1022,21 @@ class ALLanguageServer(SolidLanguageServer):
|
||||
# Get symbols from parent implementation
|
||||
document_symbols = super().request_document_symbols(relative_file_path, file_buffer=file_buffer)
|
||||
|
||||
# Normalize names by stripping AL object metadata
|
||||
# Normalize names by stripping AL object metadata, storing originals for hover
|
||||
def normalize_name(symbol: UnifiedSymbolInformation) -> None:
|
||||
symbol["name"] = extract_al_display_name(symbol["name"])
|
||||
original_name = symbol["name"]
|
||||
normalized_name = extract_al_display_name(original_name)
|
||||
|
||||
# Store original name if it was normalized (for hover injection)
|
||||
if original_name != normalized_name:
|
||||
sel_range = symbol.get("selectionRange", {})
|
||||
start = sel_range.get("start", {})
|
||||
line = start.get("line", 0)
|
||||
char = start.get("character", 0)
|
||||
normalized_path = self._normalize_path(relative_file_path)
|
||||
self._al_original_names[(normalized_path, line, char)] = original_name
|
||||
|
||||
symbol["name"] = normalized_name
|
||||
|
||||
# Process children recursively
|
||||
if symbol.get("children"):
|
||||
@@ -1027,3 +1048,29 @@ class ALLanguageServer(SolidLanguageServer):
|
||||
normalize_name(sym)
|
||||
|
||||
return document_symbols
|
||||
|
||||
@override
|
||||
def request_hover(self, relative_file_path: str, line: int, column: int) -> ls_types.Hover | None:
|
||||
"""
|
||||
Override to inject original AL object name (with type and ID) into hover responses.
|
||||
|
||||
When hovering over a symbol whose name was normalized, we prepend the original
|
||||
full name (e.g., 'Table 50000 "TEST Customer"') to the hover content.
|
||||
"""
|
||||
hover = super().request_hover(relative_file_path, line, column)
|
||||
|
||||
if hover is None:
|
||||
return None
|
||||
|
||||
# Check if we have an original name for this position (using normalized path for consistency)
|
||||
normalized_path = self._normalize_path(relative_file_path)
|
||||
original_name = self._al_original_names.get((normalized_path, line, column))
|
||||
|
||||
if original_name and "contents" in hover:
|
||||
contents = hover["contents"]
|
||||
if isinstance(contents, dict) and "value" in contents:
|
||||
# Prepend the original full name to the hover content
|
||||
prefix = f"**{original_name}**\n\n---\n\n"
|
||||
contents["value"] = prefix + contents["value"]
|
||||
|
||||
return hover
|
||||
@@ -242,3 +242,317 @@ class TestALLanguageServer:
|
||||
assert "TEST Customer" in al_object_names, f"TEST Customer not found in: {al_object_names}"
|
||||
assert "CustomerMgt" in al_object_names, f"CustomerMgt not found in: {al_object_names}"
|
||||
assert "CustomerType" in al_object_names, f"CustomerType not found in: {al_object_names}"
|
||||
|
||||
|
||||
@pytest.mark.al
|
||||
class TestALHoverInjection:
|
||||
"""Tests for hover injection of original AL object names with type and ID."""
|
||||
|
||||
def _get_symbol_hover(self, language_server: SolidLanguageServer, file_path: str, symbol_name: str) -> tuple[dict | None, str | None]:
|
||||
"""Helper to get hover info for a symbol by name.
|
||||
|
||||
Returns (hover_info, hover_value) tuple.
|
||||
"""
|
||||
symbols = language_server.request_document_symbols(file_path)
|
||||
for sym in symbols.root_symbols:
|
||||
if sym.get("name") == symbol_name:
|
||||
sel_range = sym.get("selectionRange", {})
|
||||
start = sel_range.get("start", {})
|
||||
line = start.get("line", 0)
|
||||
char = start.get("character", 0)
|
||||
hover = language_server.request_hover(file_path, line, char)
|
||||
if hover and "contents" in hover:
|
||||
return hover, hover["contents"].get("value", "")
|
||||
return hover, None
|
||||
return None, None
|
||||
|
||||
def _get_child_symbol_hover(
|
||||
self, language_server: SolidLanguageServer, file_path: str, parent_name: str, child_name_contains: str
|
||||
) -> tuple[dict | None, str | None]:
|
||||
"""Helper to get hover info for a child symbol.
|
||||
|
||||
Returns (hover_info, hover_value) tuple.
|
||||
"""
|
||||
symbols = language_server.request_document_symbols(file_path)
|
||||
for sym in symbols.root_symbols:
|
||||
if sym.get("name") == parent_name:
|
||||
for child in sym.get("children", []):
|
||||
if child_name_contains in child.get("name", ""):
|
||||
sel_range = child.get("selectionRange", {})
|
||||
start = sel_range.get("start", {})
|
||||
line = start.get("line", 0)
|
||||
char = start.get("character", 0)
|
||||
hover = language_server.request_hover(file_path, line, char)
|
||||
if hover and "contents" in hover:
|
||||
return hover, hover["contents"].get("value", "")
|
||||
return hover, None
|
||||
return None, None
|
||||
|
||||
@pytest.mark.parametrize("language_server", [Language.AL], indirect=True)
|
||||
def test_hover_table_injects_full_name(self, language_server: SolidLanguageServer) -> None:
|
||||
"""Test that hovering over a Table symbol shows the full object name with ID."""
|
||||
file_path = os.path.join("src", "Tables", "Customer.Table.al")
|
||||
hover, value = self._get_symbol_hover(language_server, file_path, "TEST Customer")
|
||||
|
||||
assert hover is not None, "Hover should return a result for Table symbol"
|
||||
assert value is not None, "Hover should have content"
|
||||
assert '**Table 50000 "TEST Customer"**' in value, f"Hover should contain full Table name with ID. Got: {value[:200]}"
|
||||
|
||||
@pytest.mark.parametrize("language_server", [Language.AL], indirect=True)
|
||||
def test_hover_page_injects_full_name(self, language_server: SolidLanguageServer) -> None:
|
||||
"""Test that hovering over a Page symbol shows the full object name with ID."""
|
||||
file_path = os.path.join("src", "Pages", "CustomerCard.Page.al")
|
||||
hover, value = self._get_symbol_hover(language_server, file_path, "TEST Customer Card")
|
||||
|
||||
assert hover is not None, "Hover should return a result for Page symbol"
|
||||
assert value is not None, "Hover should have content"
|
||||
assert '**Page 50001 "TEST Customer Card"**' in value, f"Hover should contain full Page name with ID. Got: {value[:200]}"
|
||||
|
||||
@pytest.mark.parametrize("language_server", [Language.AL], indirect=True)
|
||||
def test_hover_codeunit_injects_full_name(self, language_server: SolidLanguageServer) -> None:
|
||||
"""Test that hovering over a Codeunit symbol shows the full object name with ID."""
|
||||
file_path = os.path.join("src", "Codeunits", "CustomerMgt.Codeunit.al")
|
||||
hover, value = self._get_symbol_hover(language_server, file_path, "CustomerMgt")
|
||||
|
||||
assert hover is not None, "Hover should return a result for Codeunit symbol"
|
||||
assert value is not None, "Hover should have content"
|
||||
assert "**Codeunit 50000 CustomerMgt**" in value, f"Hover should contain full Codeunit name with ID. Got: {value[:200]}"
|
||||
|
||||
@pytest.mark.parametrize("language_server", [Language.AL], indirect=True)
|
||||
def test_hover_enum_injects_full_name(self, language_server: SolidLanguageServer) -> None:
|
||||
"""Test that hovering over an Enum symbol shows the full object name with ID."""
|
||||
file_path = os.path.join("src", "Enums", "CustomerType.Enum.al")
|
||||
hover, value = self._get_symbol_hover(language_server, file_path, "CustomerType")
|
||||
|
||||
assert hover is not None, "Hover should return a result for Enum symbol"
|
||||
assert value is not None, "Hover should have content"
|
||||
assert "**Enum 50000 CustomerType**" in value, f"Hover should contain full Enum name with ID. Got: {value[:200]}"
|
||||
|
||||
@pytest.mark.parametrize("language_server", [Language.AL], indirect=True)
|
||||
def test_hover_interface_injects_full_name(self, language_server: SolidLanguageServer) -> None:
|
||||
"""Test that hovering over an Interface symbol shows the full object name (no ID for interfaces)."""
|
||||
file_path = os.path.join("src", "Interfaces", "IPaymentProcessor.Interface.al")
|
||||
hover, value = self._get_symbol_hover(language_server, file_path, "IPaymentProcessor")
|
||||
|
||||
assert hover is not None, "Hover should return a result for Interface symbol"
|
||||
assert value is not None, "Hover should have content"
|
||||
assert "**Interface IPaymentProcessor**" in value, f"Hover should contain full Interface name. Got: {value[:200]}"
|
||||
|
||||
@pytest.mark.parametrize("language_server", [Language.AL], indirect=True)
|
||||
def test_hover_procedure_no_injection(self, language_server: SolidLanguageServer) -> None:
|
||||
"""Test that hovering over a procedure does NOT inject object name (procedures are not normalized)."""
|
||||
file_path = os.path.join("src", "Codeunits", "CustomerMgt.Codeunit.al")
|
||||
hover, value = self._get_child_symbol_hover(language_server, file_path, "CustomerMgt", "CreateCustomer")
|
||||
|
||||
assert hover is not None, "Hover should return a result for procedure"
|
||||
assert value is not None, "Hover should have content"
|
||||
# Procedure hover should NOT start with ** (no injection)
|
||||
assert not value.startswith("**"), f"Procedure hover should not have injected name. Got: {value[:200]}"
|
||||
# But should contain procedure info
|
||||
assert "CreateCustomer" in value, f"Hover should contain procedure name. Got: {value[:200]}"
|
||||
|
||||
@pytest.mark.parametrize("language_server", [Language.AL], indirect=True)
|
||||
def test_hover_field_no_injection(self, language_server: SolidLanguageServer) -> None:
|
||||
"""Test that hovering over a field does NOT inject object name (fields are not normalized)."""
|
||||
file_path = os.path.join("src", "Tables", "Customer.Table.al")
|
||||
symbols = language_server.request_document_symbols(file_path)
|
||||
|
||||
# Navigate to a field: Table -> fields -> specific field
|
||||
for sym in symbols.root_symbols:
|
||||
if sym.get("name") == "TEST Customer":
|
||||
for child in sym.get("children", []):
|
||||
if child.get("name") == "fields":
|
||||
for field in child.get("children", []):
|
||||
if "Name" in field.get("name", ""):
|
||||
sel_range = field.get("selectionRange", {})
|
||||
start = sel_range.get("start", {})
|
||||
line = start.get("line", 0)
|
||||
char = start.get("character", 0)
|
||||
hover = language_server.request_hover(file_path, line, char)
|
||||
|
||||
assert hover is not None, "Hover should return a result for field"
|
||||
value = hover.get("contents", {}).get("value", "")
|
||||
# Field hover should NOT start with ** (no injection)
|
||||
assert not value.startswith("**"), f"Field hover should not have injected name. Got: {value[:200]}"
|
||||
return
|
||||
|
||||
pytest.fail("Could not find a field to test hover on")
|
||||
|
||||
@pytest.mark.parametrize("language_server", [Language.AL], indirect=True)
|
||||
def test_hover_multiple_objects_correct_injection(self, language_server: SolidLanguageServer) -> None:
|
||||
"""Test that multiple AL objects each get their correct full name injected."""
|
||||
test_cases = [
|
||||
(os.path.join("src", "Tables", "Customer.Table.al"), "TEST Customer", 'Table 50000 "TEST Customer"'),
|
||||
(os.path.join("src", "Codeunits", "CustomerMgt.Codeunit.al"), "CustomerMgt", "Codeunit 50000 CustomerMgt"),
|
||||
(os.path.join("src", "Enums", "CustomerType.Enum.al"), "CustomerType", "Enum 50000 CustomerType"),
|
||||
]
|
||||
|
||||
for file_path, symbol_name, expected_full_name in test_cases:
|
||||
hover, value = self._get_symbol_hover(language_server, file_path, symbol_name)
|
||||
|
||||
assert hover is not None, f"Hover should return a result for {symbol_name}"
|
||||
assert value is not None, f"Hover should have content for {symbol_name}"
|
||||
assert (
|
||||
f"**{expected_full_name}**" in value
|
||||
), f"Hover for {symbol_name} should contain '{expected_full_name}'. Got: {value[:200]}"
|
||||
|
||||
@pytest.mark.parametrize("language_server", [Language.AL], indirect=True)
|
||||
def test_hover_contains_separator_after_injection(self, language_server: SolidLanguageServer) -> None:
|
||||
"""Test that injected hover has a separator between injected name and original content."""
|
||||
file_path = os.path.join("src", "Tables", "Customer.Table.al")
|
||||
hover, value = self._get_symbol_hover(language_server, file_path, "TEST Customer")
|
||||
|
||||
assert hover is not None, "Hover should return a result"
|
||||
assert value is not None, "Hover should have content"
|
||||
# Should have the separator after the bold name
|
||||
assert "---" in value, f"Hover should contain separator. Got: {value[:300]}"
|
||||
# The separator should come after the injected name
|
||||
bold_end = value.find("**", 2) # Find closing **
|
||||
separator_pos = value.find("---")
|
||||
assert separator_pos > bold_end, "Separator should come after the injected name"
|
||||
|
||||
@pytest.mark.parametrize("language_server", [Language.AL], indirect=True)
|
||||
def test_hover_preserves_original_content(self, language_server: SolidLanguageServer) -> None:
|
||||
"""Test that the original hover content is preserved after the injected name."""
|
||||
file_path = os.path.join("src", "Tables", "Customer.Table.al")
|
||||
hover, value = self._get_symbol_hover(language_server, file_path, "TEST Customer")
|
||||
|
||||
assert hover is not None, "Hover should return a result"
|
||||
assert value is not None, "Hover should have content"
|
||||
# Original AL hover content should still be present (the table structure)
|
||||
assert "```al" in value, f"Hover should contain original AL code block. Got: {value[:500]}"
|
||||
assert 'Table "TEST Customer"' in value, f"Hover should contain original table definition. Got: {value[:500]}"
|
||||
|
||||
|
||||
@pytest.mark.al
|
||||
class TestALPathNormalization:
|
||||
"""Tests for path normalization in hover injection cache."""
|
||||
|
||||
@pytest.mark.parametrize("language_server", [Language.AL], indirect=True)
|
||||
def test_hover_with_forward_slash_path(self, language_server: SolidLanguageServer) -> None:
|
||||
"""Test that hover injection works with forward slash paths."""
|
||||
file_path = "src/Tables/Customer.Table.al"
|
||||
symbols = language_server.request_document_symbols(file_path)
|
||||
|
||||
for sym in symbols.root_symbols:
|
||||
if sym.get("name") == "TEST Customer":
|
||||
sel_range = sym.get("selectionRange", {})
|
||||
start = sel_range.get("start", {})
|
||||
line = start.get("line", 0)
|
||||
char = start.get("character", 0)
|
||||
|
||||
hover = language_server.request_hover(file_path, line, char)
|
||||
assert hover is not None, "Hover should return a result"
|
||||
value = hover.get("contents", {}).get("value", "")
|
||||
assert '**Table 50000 "TEST Customer"**' in value, f"Hover should have injection. Got: {value[:200]}"
|
||||
return
|
||||
|
||||
pytest.fail("Could not find TEST Customer symbol")
|
||||
|
||||
@pytest.mark.parametrize("language_server", [Language.AL], indirect=True)
|
||||
def test_hover_with_backslash_path(self, language_server: SolidLanguageServer) -> None:
|
||||
"""Test that hover injection works with backslash paths (Windows style)."""
|
||||
file_path = "src\\Tables\\Customer.Table.al"
|
||||
symbols = language_server.request_document_symbols(file_path)
|
||||
|
||||
for sym in symbols.root_symbols:
|
||||
if sym.get("name") == "TEST Customer":
|
||||
sel_range = sym.get("selectionRange", {})
|
||||
start = sel_range.get("start", {})
|
||||
line = start.get("line", 0)
|
||||
char = start.get("character", 0)
|
||||
|
||||
hover = language_server.request_hover(file_path, line, char)
|
||||
assert hover is not None, "Hover should return a result"
|
||||
value = hover.get("contents", {}).get("value", "")
|
||||
assert '**Table 50000 "TEST Customer"**' in value, f"Hover should have injection. Got: {value[:200]}"
|
||||
return
|
||||
|
||||
pytest.fail("Could not find TEST Customer symbol")
|
||||
|
||||
@pytest.mark.parametrize("language_server", [Language.AL], indirect=True)
|
||||
def test_hover_with_mixed_path_formats_symbols_backslash_hover_forward(self, language_server: SolidLanguageServer) -> None:
|
||||
"""Test hover works when symbols requested with backslash but hover with forward slash."""
|
||||
file_path_backslash = "src\\Tables\\Customer.Table.al"
|
||||
file_path_forward = "src/Tables/Customer.Table.al"
|
||||
|
||||
# Request symbols with backslash path
|
||||
symbols = language_server.request_document_symbols(file_path_backslash)
|
||||
|
||||
for sym in symbols.root_symbols:
|
||||
if sym.get("name") == "TEST Customer":
|
||||
sel_range = sym.get("selectionRange", {})
|
||||
start = sel_range.get("start", {})
|
||||
line = start.get("line", 0)
|
||||
char = start.get("character", 0)
|
||||
|
||||
# Request hover with forward slash path (different format)
|
||||
hover = language_server.request_hover(file_path_forward, line, char)
|
||||
assert hover is not None, "Hover should return a result"
|
||||
value = hover.get("contents", {}).get("value", "")
|
||||
assert (
|
||||
'**Table 50000 "TEST Customer"**' in value
|
||||
), f"Hover injection should work with mixed path formats. Got: {value[:200]}"
|
||||
return
|
||||
|
||||
pytest.fail("Could not find TEST Customer symbol")
|
||||
|
||||
@pytest.mark.parametrize("language_server", [Language.AL], indirect=True)
|
||||
def test_hover_with_mixed_path_formats_symbols_forward_hover_backslash(self, language_server: SolidLanguageServer) -> None:
|
||||
"""Test hover works when symbols requested with forward slash but hover with backslash."""
|
||||
file_path_forward = "src/Tables/Customer.Table.al"
|
||||
file_path_backslash = "src\\Tables\\Customer.Table.al"
|
||||
|
||||
# Request symbols with forward slash path
|
||||
symbols = language_server.request_document_symbols(file_path_forward)
|
||||
|
||||
for sym in symbols.root_symbols:
|
||||
if sym.get("name") == "TEST Customer":
|
||||
sel_range = sym.get("selectionRange", {})
|
||||
start = sel_range.get("start", {})
|
||||
line = start.get("line", 0)
|
||||
char = start.get("character", 0)
|
||||
|
||||
# Request hover with backslash path (different format)
|
||||
hover = language_server.request_hover(file_path_backslash, line, char)
|
||||
assert hover is not None, "Hover should return a result"
|
||||
value = hover.get("contents", {}).get("value", "")
|
||||
assert (
|
||||
'**Table 50000 "TEST Customer"**' in value
|
||||
), f"Hover injection should work with mixed path formats. Got: {value[:200]}"
|
||||
return
|
||||
|
||||
pytest.fail("Could not find TEST Customer symbol")
|
||||
|
||||
@pytest.mark.parametrize("language_server", [Language.AL], indirect=True)
|
||||
def test_hover_caching_multiple_files_different_path_formats(self, language_server: SolidLanguageServer) -> None:
|
||||
"""Test that hover injection cache works correctly across multiple files with different path formats."""
|
||||
test_cases = [
|
||||
("src/Tables/Customer.Table.al", "src\\Tables\\Customer.Table.al", "TEST Customer", 'Table 50000 "TEST Customer"'),
|
||||
(
|
||||
"src\\Codeunits\\CustomerMgt.Codeunit.al",
|
||||
"src/Codeunits/CustomerMgt.Codeunit.al",
|
||||
"CustomerMgt",
|
||||
"Codeunit 50000 CustomerMgt",
|
||||
),
|
||||
]
|
||||
|
||||
for symbols_path, hover_path, symbol_name, expected_injection in test_cases:
|
||||
# Request symbols with one path format
|
||||
symbols = language_server.request_document_symbols(symbols_path)
|
||||
|
||||
for sym in symbols.root_symbols:
|
||||
if sym.get("name") == symbol_name:
|
||||
sel_range = sym.get("selectionRange", {})
|
||||
start = sel_range.get("start", {})
|
||||
line = start.get("line", 0)
|
||||
char = start.get("character", 0)
|
||||
|
||||
# Request hover with different path format
|
||||
hover = language_server.request_hover(hover_path, line, char)
|
||||
assert hover is not None, f"Hover should return a result for {symbol_name}"
|
||||
value = hover.get("contents", {}).get("value", "")
|
||||
assert (
|
||||
f"**{expected_injection}**" in value
|
||||
), f"Hover for {symbol_name} should have injection with mixed paths. Got: {value[:200]}"
|
||||
break
|
||||
Reference in new issue
Block a user