mirror of
https://github.com/headroomlabs-ai/headroom.git
synced 2026-08-27 14:17:10 -04:00
## Description Adds Perl as a supported language for `CodeAwareCompressor` / `CodeStructureHandler`. Function bodies are compressed while `use`/`require` imports, `sub`/`method` signatures, and `package`/`class`/`role` declarations are preserved — bringing Perl up to parity with the other Tier-2 languages. No new dependencies: the Perl grammar already ships in `tree-sitter-language-pack` (already a Headroom dependency), so this is pure configuration. Closes # ## Type of Change - [ ] Bug fix (non-breaking change that fixes an issue) - [x] New feature (non-breaking change that adds functionality) - [ ] Breaking change (fix or feature that would cause existing functionality to change) - [ ] Documentation update - [ ] Performance improvement - [ ] Code refactoring (no functional changes) ## Changes Made - `code_handler.py`: Perl entries in the four per-language tables — `_STRUCTURAL_NODE_TYPES`, `_SIGNATURE_PATTERNS` (regex fallback), `_LANGUAGE_MARKERS` (detection), `_IMPORT_PATTERNS`. The existing `_CONTAINER_BODY_TYPES` already covers Perl's `block` body node, so no change was needed there. - `code_compressor.py`: `CodeLanguage.PERL` enum value, a data-driven `LangConfig`, a `_LANGUAGE_PREFILTER` entry, and the supported-language string in the parser error message. - Node-type names (`subroutine_declaration_statement`, `package_statement`, `signature`, `block`, …) are from the `tree-sitter-perl/tree-sitter-perl` grammar (MIT). - Tests: 1 detection test + 2 regex-path signature/import-preservation tests. ## Testing - [x] Unit tests pass (`pytest`) - [x] Linting passes (`ruff check .`) - [x] Type checking passes (`mypy headroom`) - [x] New tests added for new functionality - [x] Manual testing performed ### Test Output ```text $ pytest tests/test_compression/test_code_handler.py -q collected 28 items tests/test_compression/test_code_handler.py ............................ [100%] ======================== 28 passed, 1 warning in 2.53s ========================= $ ruff check headroom/compression/handlers/code_handler.py headroom/transforms/code_compressor.py tests/test_compression/test_code_handler.py All checks passed! $ mypy headroom/compression/handlers/code_handler.py headroom/transforms/code_compressor.py Success: no issues found in 2 source files ``` ## Real Behavior Proof - Environment: Python 3.12, `pip install -e ".[code]"` (tree-sitter-language-pack installed, `is_tree_sitter_available() == True`). - Exact command / steps: ran `CodeStructureHandler().get_mask(code, language="perl")` on a real Perl module (package + two subs with bodies). - Observed result: detected as `perl`, parsed via the `tree-sitter` path (not regex), and the preserved span was exactly the imports + package + sub signatures, with both sub bodies marked compressible: ```text tree-sitter available: True parser: tree-sitter | detected: perl --- PRESERVED (signatures/imports/structure) --- use strict;use warnings;package Greeter;sub new sub greet ``` - Not tested: the full proxy/MCP server end-to-end path (out of scope — this PR only touches the code compressor's language tables). ## Review Readiness - [x] I have performed a self-review - [x] This PR is ready for human review ## Checklist - [x] My code follows the project's style guidelines - [x] I have performed a self-review of my code - [x] I have commented my code, particularly in hard-to-understand areas - [ ] I have made corresponding changes to the documentation - [x] My changes generate no new warnings - [x] I have added tests that prove my fix is effective or that my feature works - [x] New and existing unit tests pass locally with my changes - [ ] I have updated the CHANGELOG.md if applicable ## Additional Notes - Docs/CHANGELOG left unchecked — happy to add a Perl line to either if you'd like; I wasn't sure of your preferred location. - *Disclosure: I maintain the upstream `tree-sitter-perl` grammar this relies on. It's already a transitive dependency of Headroom via `tree-sitter-language-pack` — this PR only adds config to use it, with no dependency changes.* Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
309 lines
12 KiB
Python
309 lines
12 KiB
Python
"""Tests for code structure handler."""
|
|
|
|
import pytest
|
|
|
|
from headroom.compression.handlers.code_handler import (
|
|
CodeStructureHandler,
|
|
is_tree_sitter_available,
|
|
)
|
|
|
|
requires_tree_sitter = pytest.mark.skipif(
|
|
not is_tree_sitter_available(),
|
|
reason="tree-sitter-language-pack not installed",
|
|
)
|
|
|
|
|
|
class TestCanHandle:
|
|
@pytest.fixture
|
|
def handler(self):
|
|
return CodeStructureHandler()
|
|
|
|
def test_detects_python(self, handler):
|
|
assert handler.can_handle("def foo():\n pass\n") is True
|
|
|
|
def test_detects_javascript(self, handler):
|
|
assert handler.can_handle("function foo() { return 1; }") is True
|
|
|
|
def test_rejects_prose(self, handler):
|
|
assert handler.can_handle("This is a plain sentence.") is False
|
|
|
|
|
|
class TestRegexFallback:
|
|
"""Regex path runs regardless of tree-sitter availability."""
|
|
|
|
@pytest.fixture
|
|
def handler(self):
|
|
return CodeStructureHandler(use_tree_sitter=False)
|
|
|
|
def test_python_signature_preserved_body_compressible(self, handler):
|
|
code = "def hello(name: str) -> str:\n message = name\n return message\n"
|
|
result = handler.get_mask(code, language="python")
|
|
|
|
assert result.metadata["parser"] == "regex"
|
|
sig = "def hello(name: str) -> str:"
|
|
start = code.index(sig)
|
|
assert all(result.mask.mask[i] for i in range(start, start + len(sig)))
|
|
|
|
body_char = code.index("message = name")
|
|
assert result.mask.mask[body_char] is False
|
|
|
|
def test_python_import_preserved(self, handler):
|
|
code = "import os\n\nx = 1\n"
|
|
result = handler.get_mask(code, language="python")
|
|
assert all(result.mask.mask[i] for i in range(len("import os")))
|
|
|
|
|
|
class TestLanguageDetection:
|
|
@pytest.fixture
|
|
def handler(self):
|
|
return CodeStructureHandler()
|
|
|
|
def test_detects_python(self, handler):
|
|
code = "import os\n\nclass Foo:\n def method(self):\n pass\n"
|
|
assert handler._detect_language(code) == "python"
|
|
|
|
def test_detects_go(self, handler):
|
|
code = 'package main\n\nimport (\n\t"fmt"\n)\n\nfunc main() {\n}\n'
|
|
assert handler._detect_language(code) == "go"
|
|
|
|
def test_detects_rust(self, handler):
|
|
code = "use std::io;\n\npub fn main() {\n let mut x = 1;\n}\n"
|
|
assert handler._detect_language(code) == "rust"
|
|
|
|
def test_detects_perl(self, handler):
|
|
code = "use strict;\npackage Foo;\n\nsub greet {\n my $name = shift;\n return $name;\n}\n"
|
|
assert handler._detect_language(code) == "perl"
|
|
|
|
def test_falls_back_to_default(self):
|
|
handler = CodeStructureHandler(default_language="javascript")
|
|
assert handler._detect_language("plain words only here") == "javascript"
|
|
|
|
|
|
class TestRegexFallbackLanguages:
|
|
"""Signature/import preservation on the regex path across languages."""
|
|
|
|
@pytest.fixture
|
|
def handler(self):
|
|
return CodeStructureHandler(use_tree_sitter=False)
|
|
|
|
def test_go_func_signature_preserved(self, handler):
|
|
code = "func Add(a int, b int) int {\n\treturn a + b\n}\n"
|
|
result = handler.get_mask(code, language="go")
|
|
sig = "func Add(a int, b int)"
|
|
start = code.index(sig)
|
|
assert all(result.mask.mask[i] for i in range(start, start + len(sig)))
|
|
|
|
def test_rust_fn_signature_preserved(self, handler):
|
|
code = "pub fn add(a: i32, b: i32) -> i32 {\n a + b\n}\n"
|
|
result = handler.get_mask(code, language="rust")
|
|
sig = "pub fn add(a: i32, b: i32)"
|
|
start = code.index(sig)
|
|
assert all(result.mask.mask[i] for i in range(start, start + len(sig)))
|
|
|
|
def test_typescript_interface_preserved(self, handler):
|
|
code = "interface Shape {\n area(): number;\n}\n\nconst x = 1;\n"
|
|
result = handler.get_mask(code, language="typescript")
|
|
sig = "interface Shape"
|
|
start = code.index(sig)
|
|
assert all(result.mask.mask[i] for i in range(start, start + len(sig)))
|
|
|
|
def test_javascript_arrow_function_preserved(self, handler):
|
|
code = "const add = (a, b) => {\n return a + b;\n};\n"
|
|
result = handler.get_mask(code, language="javascript")
|
|
sig = "const add = (a, b) =>"
|
|
start = code.index(sig)
|
|
assert all(result.mask.mask[i] for i in range(start, start + len(sig)))
|
|
|
|
def test_perl_sub_signature_preserved(self, handler):
|
|
code = "sub add {\n my ($a, $b) = @_;\n return $a + $b;\n}\n"
|
|
result = handler.get_mask(code, language="perl")
|
|
sig = "sub add"
|
|
start = code.index(sig)
|
|
assert all(result.mask.mask[i] for i in range(start, start + len(sig)))
|
|
|
|
def test_perl_use_import_preserved(self, handler):
|
|
code = "use strict;\nuse warnings;\n\nmy $x = 1;\n"
|
|
result = handler.get_mask(code, language="perl")
|
|
assert all(result.mask.mask[i] for i in range(len("use strict")))
|
|
|
|
def test_regex_confidence_lower_than_tree_sitter(self, handler):
|
|
result = handler.get_mask("def f():\n pass\n", language="python")
|
|
assert result.confidence == 0.7
|
|
|
|
|
|
class TestEdgeCases:
|
|
@pytest.fixture
|
|
def handler(self):
|
|
return CodeStructureHandler()
|
|
|
|
def test_empty_content(self, handler):
|
|
result = handler.get_mask("")
|
|
assert result.confidence == 0.0
|
|
assert result.metadata.get("empty") is True
|
|
|
|
def test_whitespace_only_content(self, handler):
|
|
result = handler.get_mask(" \n\n ")
|
|
assert result.metadata.get("empty") is True
|
|
|
|
def test_unknown_language_regex_no_patterns(self):
|
|
"""A language with no regex patterns yields an all-compressible
|
|
mask rather than raising."""
|
|
handler = CodeStructureHandler(use_tree_sitter=False)
|
|
code = "BEGIN\n WRITELN('hello')\nEND.\n"
|
|
result = handler.get_mask(code, language="pascal")
|
|
assert not any(result.mask.mask)
|
|
|
|
def test_mask_length_matches_content(self, handler):
|
|
code = "def f():\n return 1\n"
|
|
result = handler.get_mask(code, language="python")
|
|
assert len(result.mask.mask) == len(code)
|
|
|
|
|
|
@requires_tree_sitter
|
|
class TestTreeSitterContainers:
|
|
"""Container bodies must stay compressible (signature-only spans).
|
|
|
|
Regression: class_definition / decorated_definition / impl_item were
|
|
marked structural over their FULL span, so every method body inside a
|
|
class (i.e. most real code) was preserved and compression no-opped at
|
|
confidence 0.95.
|
|
"""
|
|
|
|
@pytest.fixture
|
|
def handler(self):
|
|
return CodeStructureHandler()
|
|
|
|
def test_class_method_bodies_compressible(self, handler):
|
|
code = (
|
|
"class Foo:\n"
|
|
" def method_a(self):\n"
|
|
" body_line_a = 1\n"
|
|
" return body_line_a\n"
|
|
"\n"
|
|
" def method_b(self):\n"
|
|
" body_line_b = 2\n"
|
|
" return body_line_b\n"
|
|
)
|
|
result = handler.get_mask(code, language="python")
|
|
assert result.metadata["parser"] == "tree-sitter"
|
|
|
|
# Class signature and method signatures preserved
|
|
assert all(result.mask.mask[i] for i in range(len("class Foo:")))
|
|
sig = "def method_a(self):"
|
|
start = code.index(sig)
|
|
assert all(result.mask.mask[i] for i in range(start, start + len(sig)))
|
|
|
|
# Method bodies compressible
|
|
for body in ("body_line_a = 1", "body_line_b = 2"):
|
|
start = code.index(body)
|
|
assert not any(result.mask.mask[i] for i in range(start, start + len(body))), (
|
|
f"method body {body!r} must be compressible"
|
|
)
|
|
|
|
def test_decorated_function_body_compressible(self, handler):
|
|
code = "@decorator\ndef decorated():\n body_line = 4\n return body_line\n"
|
|
result = handler.get_mask(code, language="python")
|
|
|
|
# Decorator and signature preserved
|
|
assert all(result.mask.mask[i] for i in range(len("@decorator")))
|
|
sig = "def decorated():"
|
|
start = code.index(sig)
|
|
assert all(result.mask.mask[i] for i in range(start, start + len(sig)))
|
|
|
|
# Body compressible
|
|
start = code.index("body_line = 4")
|
|
assert not any(result.mask.mask[i] for i in range(start, start + len("body_line = 4"))), (
|
|
"decorated function body must be compressible"
|
|
)
|
|
|
|
def test_module_function_body_compressible(self, handler):
|
|
code = "def standalone():\n body_line = 3\n return body_line\n"
|
|
result = handler.get_mask(code, language="python")
|
|
|
|
start = code.index("body_line = 3")
|
|
assert not any(result.mask.mask[i] for i in range(start, start + len("body_line = 3")))
|
|
|
|
def test_rust_impl_method_bodies_compressible(self, handler):
|
|
code = (
|
|
"struct Foo { x: i32 }\n"
|
|
"impl Foo {\n"
|
|
" fn method(&self) -> i32 {\n"
|
|
" let body_line = 5;\n"
|
|
" body_line\n"
|
|
" }\n"
|
|
"}\n"
|
|
)
|
|
result = handler.get_mask(code, language="rust")
|
|
|
|
# impl signature preserved
|
|
start = code.index("impl Foo")
|
|
assert all(result.mask.mask[i] for i in range(start, start + len("impl Foo")))
|
|
|
|
# method body compressible
|
|
start = code.index("let body_line = 5;")
|
|
assert not any(
|
|
result.mask.mask[i] for i in range(start, start + len("let body_line = 5;"))
|
|
), "impl method body must be compressible"
|
|
|
|
def test_concurrent_parsing_uses_tree_sitter(self, handler):
|
|
"""Parsers must be thread-local.
|
|
|
|
Regression: parsers were cached in a process-global dict and
|
|
shared across threads. tree-sitter Parser objects are pyo3
|
|
unsendable — touching one from a non-creator thread panics (or
|
|
raises, dropping the handler to the regex fallback). Parsing
|
|
from a thread pool must succeed on the tree-sitter path in
|
|
every thread.
|
|
"""
|
|
from concurrent.futures import ThreadPoolExecutor
|
|
|
|
code = "class Foo:\n def m(self):\n x = 1\n return x\n"
|
|
|
|
def work(_: int) -> str:
|
|
result = handler.get_mask(code, language="python")
|
|
return str(result.metadata["parser"])
|
|
|
|
with ThreadPoolExecutor(max_workers=4) as pool:
|
|
parsers = list(pool.map(work, range(16)))
|
|
|
|
assert parsers == ["tree-sitter"] * 16, (
|
|
f"all threads must parse via tree-sitter, got: {set(parsers)}"
|
|
)
|
|
|
|
def test_non_ascii_content_mask_alignment(self, handler):
|
|
"""Byte offsets must be converted to char offsets.
|
|
|
|
Regression: tree-sitter reports byte offsets into the UTF-8
|
|
encoding, but the mask is char-indexed. Multi-byte characters
|
|
(here: accents + an emoji, 9 extra bytes) shifted every later
|
|
span, preserving the wrong characters.
|
|
"""
|
|
code = (
|
|
"# café münü 🎉 comment\n"
|
|
"def target(x: int) -> int:\n"
|
|
" body_value = 9\n"
|
|
" return body_value\n"
|
|
)
|
|
result = handler.get_mask(code, language="python")
|
|
|
|
sig = "def target(x: int) -> int:"
|
|
start = code.index(sig)
|
|
assert all(result.mask.mask[i] for i in range(start, start + len(sig))), (
|
|
"signature after non-ASCII content must be exactly preserved"
|
|
)
|
|
|
|
bstart = code.index("body_value = 9")
|
|
assert not any(
|
|
result.mask.mask[i] for i in range(bstart, bstart + len("body_value = 9"))
|
|
), "body after non-ASCII content must stay compressible"
|
|
|
|
def test_preservation_ratio_sane_for_class_code(self, handler):
|
|
"""A class with substantial method bodies should NOT preserve
|
|
everything — the whole point of the handler."""
|
|
body = "\n".join(f" line_{i} = {i}" for i in range(20))
|
|
code = f"class Big:\n def method(self):\n{body}\n return 0\n"
|
|
result = handler.get_mask(code, language="python")
|
|
assert result.preservation_ratio < 0.5, (
|
|
f"class code preserved {result.preservation_ratio:.0%} — "
|
|
"container bodies are leaking into the structural mask"
|
|
)
|