Skip to content

Codebase intelligence for AI and humans: code health scores, auto-generated docs, git analytics, dead code detection, and architectural decisions via MCP.

feat(workspace): read MyBatis mapper XML and verbatim SQL as table consumers (#4524) (#4647)

Rishabh Mishra81be5b52f3fc
diff --git a/packages/core/src/repowise/core/workspace/extractors/base.py b/packages/core/src/repowise/core/workspace/extractors/base.py
index 96876957f..34ccd59a0 100644
--- a/packages/core/src/repowise/core/workspace/extractors/base.py
+++ b/packages/core/src/repowise/core/workspace/extractors/base.py
@@ -12,6 +12,7 @@ descend into sibling/vendored repos rooted under the workspace.
from __future__ import annotations
import os
+import re
from collections.abc import Callable, Iterator, Mapping, Sequence
from dataclasses import dataclass, field
from fnmatch import fnmatch
@@ -73,6 +74,7 @@ def make_exclude_predicate(
#: open a comment the masker cannot close. VB and SQL are left out too. A match
#: in an unmasked file is never treated as commented out.
_SLASH_COMMENT_SUFFIXES = JAVA | KOTLIN | GO | CSHARP | RUST | PHP | APEX | PROTO | {".prisma"}
+_XML_COMMENT_RE = re.compile(r"<!--.*?-->", re.DOTALL)
def _comment_mask(suffix: str, content: str) -> str | None:
@@ -84,6 +86,8 @@ def _comment_mask(suffix: str, content: str) -> str | None:
return mask_source(content, suffix)
if suffix in JS_TS:
return mask_source(content, ".js")
+ if suffix == ".xml":
+ return _XML_COMMENT_RE.sub(lambda m: " " * len(m.group(0)), content)
if suffix not in _SLASH_COMMENT_SUFFIXES:
return None
from repowise.core.analysis.security.masking import mask_comments_and_strings, mask_dialect
diff --git a/packages/core/src/repowise/core/workspace/extractors/data/__init__.py b/packages/core/src/repowise/core/workspace/extractors/data/__init__.py
index ca61d0912..701f86276 100644
--- a/packages/core/src/repowise/core/workspace/extractors/data/__init__.py
+++ b/packages/core/src/repowise/core/workspace/extractors/data/__init__.py
@@ -20,6 +20,7 @@ from .dialect import repo_embedded_engine
from .drizzle import DrizzleDialect
from .knex import KnexDialect
from .laravel import EloquentDialect, LaravelMigrationDialect, LaravelQueryDialect
+from .mybatis import MyBatisDialect
from .names import normalize_table_name
from .orm_models import (
ActiveRecordDialect,
@@ -62,6 +63,7 @@ CONSUMER_DIALECTS: tuple[ContractDialect, ...] = (
SqlStringsDialect(),
LaravelQueryDialect(),
KnexDialect(),
+ MyBatisDialect(),
)
diff --git a/packages/core/src/repowise/core/workspace/extractors/data/mybatis.py b/packages/core/src/repowise/core/workspace/extractors/data/mybatis.py
new file mode 100644
index 000000000..ba8439e63
--- /dev/null
+++ b/packages/core/src/repowise/core/workspace/extractors/data/mybatis.py
@@ -0,0 +1,120 @@
+"""Consumer dialect: MyBatis XML mappers and array-form annotations."""
+
+from __future__ import annotations
+
+import re
+from typing import TYPE_CHECKING
+
+from repowise.core.workspace.origins import ContractOrigin
+
+from ..base import ScanContext, line_at
+from ..langs import JAVA
+from .dialect import build_table_consumer
+from .sql_strings import SqlStringsDialect
+
+if TYPE_CHECKING:
+ from repowise.core.workspace.contracts import Contract
+
+_XML_GATES = ("mybatis-3-mapper", "<mapper")
+_JAVA_GATES = ("@Select", "@Insert", "@Update", "@Delete")
+
+# XML statement elements
+_XML_STATEMENT_RE = re.compile(
+ r"<(?P<tag>select|insert|update|delete)\b[^>]*>(?P<body>.*?)</(?P=tag)>",
+ re.IGNORECASE | re.DOTALL,
+)
+
+# Dynamic tags, CDATA, comments and MyBatis params
+_CDATA_RE = re.compile(r"<!\[CDATA\[(.*?)\]\]>", re.DOTALL)
+_TAG_STRIP_RE = re.compile(r"<[^>]+>")
+_PARAM_RE = re.compile(r"#\{[^}]*\}")
+
+# Array-form MyBatis annotations: @Select({"...", "..."}), @Update({...}), etc.
+_ARRAY_ANN_RE = re.compile(
+ r"@(?P<ann>Select|Insert|Update|Delete)\s*\(\s*(?:value\s*=\s*)?\{(?P<items>.*?)\}\s*\)",
+ re.IGNORECASE | re.DOTALL,
+)
+_STRING_LITERAL_RE = re.compile(r'"((?:[^"\\]|\\.)*)"')
+
+
+class MyBatisDialect:
+ """Consumers from MyBatis XML mapper files and array-form Java annotations."""
+
+ name = "mybatis"
+ extensions = frozenset({".xml"}) | JAVA
+ requires = _XML_GATES + _JAVA_GATES
+
+ def extract(self, ctx: ScanContext) -> list[Contract]:
+ if ctx.suffix == ".xml":
+ return self._extract_xml(ctx)
+ if ctx.suffix in JAVA:
+ return self._extract_java(ctx)
+ return []
+
+ def _extract_xml(self, ctx: ScanContext) -> list[Contract]:
+ if not (ctx.has_any((_XML_GATES[0],)) and ctx.has_any((_XML_GATES[1],))):
+ return []
+ out: list[Contract] = []
+ sql_strings = SqlStringsDialect()
+ seen: set[str] = set()
+
+ for m in _XML_STATEMENT_RE.finditer(ctx.content):
+ if ctx.in_comment(m.start()):
+ continue
+ body = m.group("body")
+ body = _CDATA_RE.sub(r"\1", body)
+ body = _TAG_STRIP_RE.sub(" ", body)
+ body = _PARAM_RE.sub("?", body)
+ line = line_at(ctx.content, m.start())
+ tag_verb = m.group("tag").lower()
+
+ for table_raw, verb in sql_strings._tables_in(body):
+ key = table_raw.lower()
+ if key in seen:
+ continue
+ seen.add(key)
+ contract = build_table_consumer(
+ ctx,
+ table_raw=table_raw,
+ verb=verb or tag_verb,
+ client=self.name,
+ line=line,
+ origin=ContractOrigin.SQL_STRING,
+ )
+ if contract is not None:
+ out.append(contract)
+ return out
+
+ def _extract_java(self, ctx: ScanContext) -> list[Contract]:
+ out: list[Contract] = []
+ sql_strings = SqlStringsDialect()
+ seen: set[str] = set()
+
+ for m in _ARRAY_ANN_RE.finditer(ctx.content):
+ if ctx.in_comment(m.start()):
+ continue
+ items = m.group("items")
+ parts = _STRING_LITERAL_RE.findall(items)
+ if not parts:
+ continue
+ query = " ".join(parts)
+ query = _PARAM_RE.sub("?", query)
+ line = line_at(ctx.content, m.start())
+ ann_verb = m.group("ann").lower()
+
+ for table_raw, verb in sql_strings._tables_in(query):
+ key = table_raw.lower()
+ if key in seen:
+ continue
+ seen.add(key)
+ contract = build_table_consumer(
+ ctx,
+ table_raw=table_raw,
+ verb=verb or ann_verb,
+ client=self.name,
+ line=line,
+ origin=ContractOrigin.SQL_STRING,
+ )
+ if contract is not None:
+ out.append(contract)
+ return out
diff --git a/packages/core/src/repowise/core/workspace/extractors/data/sql_strings.py b/packages/core/src/repowise/core/workspace/extractors/data/sql_strings.py
index 138c98c51..4a16463f7 100644
--- a/packages/core/src/repowise/core/workspace/extractors/data/sql_strings.py
+++ b/packages/core/src/repowise/core/workspace/extractors/data/sql_strings.py
@@ -38,6 +38,7 @@ _STRING_RE = re.compile(
r'"""(?P<t1>.*?)"""'
r"|'''(?P<t2>.*?)'''"
r"|`(?P<bt>[^`]*)`"
+ r'|(?:\$@|@\$|@)"(?P<verb>(?:[^"]|"")*)"'
r'|"(?P<dq>(?:[^"\\\n]|\\.)*)"'
r"|'(?P<sq>(?:[^'\\\n]|\\.)*)'",
re.DOTALL,
diff --git a/tests/unit/workspace/test_data_contracts.py b/tests/unit/workspace/test_data_contracts.py
index 290be6bbd..41affb70f 100644
--- a/tests/unit/workspace/test_data_contracts.py
+++ b/tests/unit/workspace/test_data_contracts.py
@@ -399,6 +399,66 @@ class TestSqlStringConsumers:
consumers = [c for c in contracts if c.role == "consumer"]
assert [c.contract_id for c in consumers] == ["data::orders"]
+ def test_csharp_verbatim_sql(self, tmp_path: Path) -> None:
+ _write(
+ tmp_path,
+ "src/Verbatim.cs",
+ 'const string sql = @"\n'
+ " SELECT *\n"
+ " FROM Orders o\n"
+ " JOIN Customers c ON o.CustomerId = c.Id\n"
+ '";\n',
+ )
+ contracts = DataExtractor().extract(tmp_path, "api")
+ ids = {c.contract_id for c in contracts if c.role == "consumer"}
+ assert ids == {"data::orders", "data::customers"}
+
+
+class TestMyBatisConsumers:
+ def test_mybatis_mapper_xml(self, tmp_path: Path) -> None:
+ _write(
+ tmp_path,
+ "src/main/resources/OrderMapper.xml",
+ """<?xml version="1.0" encoding="UTF-8" ?>
+ <!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
+ <mapper namespace="com.shop.mapper.OrderMapper">
+ <select id="findOrders">
+ SELECT * FROM orders WHERE id = #{id}
+ </select>
+ <select id="findLines">
+ SELECT * FROM order_lines WHERE order_id = #{orderId}
+ </select>
+ <!--
+ <select id="deletedOrders">
+ SELECT * FROM archived_orders
+ </select>
+ -->
+ </mapper>
+ """,
+ )
+ contracts = DataExtractor().extract(tmp_path, "api")
+ ids = {c.contract_id for c in contracts if c.role == "consumer"}
+ assert ids == {"data::orders", "data::order_lines"}
+
+ def test_mybatis_array_annotation(self, tmp_path: Path) -> None:
+ _write(
+ tmp_path,
+ "src/main/java/com/shop/mapper/CustomerMapper.java",
+ """package com.shop.mapper;
+ public interface CustomerMapper {
+ @Update({
+ "UPDATE customers",
+ "SET name = #{name}",
+ "WHERE id = #{id}"
+ })
+ int update(Customer c);
+ }
+ """,
+ )
+ contracts = DataExtractor().extract(tmp_path, "api")
+ ids = {c.contract_id for c in contracts if c.role == "consumer"}
+ assert ids == {"data::customers"}
+
class TestDataMatching:
def test_normalize_contract_id_lowercases(self) -> None: