Skip to content

fix(routes): accept relative JAX-RS @Path templates and compose Scala class-level @Path (#2147) #2158

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
htarnacki wants to merge 2 commits into
base: main
Choose a base branch
from
+53 −17
Open

fix(routes): accept relative JAX-RS @Path templates and compose Scala class-level @Path (#2147) #2158

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
db7d253
fix(routes): accept relative JAX-RS @Path templates
htarnacki Sep 9, 2026
b5f119c
fix(routes): compose class-level @Path for Scala JAX-RS resources
htarnacki Sep 9, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 25 additions & 13 deletions internal/cbm/extract_defs.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1416,7 +1416,8 @@ static bool is_route_string_kind(const char *kind) {
strcmp(kind, "interpreted_string_literal") == 0;
}

static const char *route_path_from_string_node(CBMArena *a, TSNode node, const char *source) {
static const char *route_path_from_string_node(CBMArena *a, TSNode node, const char *source,
bool allow_relative) {
if (!is_route_string_kind(ts_node_type(node))) {
return NULL;
}
Expand All @@ -1428,30 +1429,39 @@ static const char *route_path_from_string_node(CBMArena *a, TSNode node, const c
if (plen >= PAIR_CHARS && (path[0] == '"' || path[0] == '\'')) {
path = cbm_arena_strndup(a, path + SKIP_CHAR, (size_t)(plen - PAIR_CHARS));
}
return (path && path[0] == '/') ? path : NULL;
if (!path || path[0] == '/' || !allow_relative) {
return (path && path[0] == '/') ? path : NULL;
}
/* JAX-RS @Path values are relative URI templates; a leading slash is
* optional and ignored by the framework. Route nodes use absolute-looking
* paths consistently, so normalize a non-empty relative value here. */
return path[0] ? cbm_arena_sprintf(a, "/%s", path) : path;
}

static const char *find_route_path_literal(CBMArena *a, TSNode node, const char *source,
int max_depth) {
int max_depth, bool allow_relative) {
if (ts_node_is_null(node) || max_depth < 0) {
return NULL;
}
const char *path = route_path_from_string_node(a, node, source);
const char *path = route_path_from_string_node(a, node, source, allow_relative);
if (path || max_depth == 0) {
return path;
}
uint32_t nc = ts_node_named_child_count(node);
for (uint32_t i = 0; i < nc && i < DECORATOR_SCAN_LIMIT; i++) {
path = find_route_path_literal(a, ts_node_named_child(node, i), source, max_depth - 1);
path = find_route_path_literal(a, ts_node_named_child(node, i), source, max_depth - 1,
allow_relative);
if (path) {
return path;
}
}
return NULL;
}

// Extract route path from decorator arguments (first string that starts with /).
static const char *extract_route_path_from_args(CBMArena *a, TSNode args, const char *source) {
// Extract route path from decorator arguments. Generic mappings keep only
// slash-prefixed strings; JAX-RS @Path additionally accepts relative templates.
static const char *extract_route_path_from_args(CBMArena *a, TSNode args, const char *source,
bool allow_relative) {
/* Every argument is checked. Java and Kotlin put no order on annotation
* attributes, so `path` can sit anywhere in the list. Stopping early left
* a real route unread and formed no Route node. Each argument's own
Expand All @@ -1464,7 +1474,8 @@ static const char *extract_route_path_from_args(CBMArena *a, TSNode args, const
* @GetMapping(path = {"/orders"})
* Walk a bounded subtree and keep the first string literal that is
* path-shaped, while ignoring non-route literals such as media types. */
const char *path = find_route_path_literal(a, arg, source, CBM_DESCENDANT_MAX_DEPTH);
const char *path =
find_route_path_literal(a, arg, source, CBM_DESCENDANT_MAX_DEPTH, allow_relative);
if (path) {
return path;
}
Expand Down Expand Up @@ -1610,7 +1621,7 @@ static bool try_route_from_decorator_call(CBMArena *a, TSNode dchild, const char

TSNode args = find_decorator_args(dchild);
if (!ts_node_is_null(args)) {
const char *path = extract_route_path_from_args(a, args, source);
const char *path = extract_route_path_from_args(a, args, source, false);
if (path) {
*out_path = path;
*out_method = method;
Expand Down Expand Up @@ -1690,7 +1701,7 @@ static bool try_route_from_annotation(CBMArena *a, TSNode annotation, const char
TSNode args = annotation_args_node(annotation);
const char *path = NULL;
if (!ts_node_is_null(args)) {
path = extract_route_path_from_args(a, args, source);
path = extract_route_path_from_args(a, args, source, false);
}
*out_path = path ? path : "/";
*out_method = method;
Expand Down Expand Up @@ -1740,7 +1751,7 @@ static void scan_route_annotations(CBMArena *a, TSNode owner, const char *source
if (!*out_jax_path && strcmp(name, "Path") == 0) {
TSNode args = annotation_args_node(child);
if (!ts_node_is_null(args)) {
*out_jax_path = extract_route_path_from_args(a, args, source);
*out_jax_path = extract_route_path_from_args(a, args, source, true);
}
continue;
}
Expand All @@ -1750,7 +1761,7 @@ static void scan_route_annotations(CBMArena *a, TSNode owner, const char *source
*out_method = method;
TSNode args = annotation_args_node(child);
if (!ts_node_is_null(args)) {
*out_map_path = extract_route_path_from_args(a, args, source);
*out_map_path = extract_route_path_from_args(a, args, source, false);
}
}
}
Expand Down Expand Up @@ -4994,7 +5005,8 @@ static void push_method_def(CBMExtractCtx *ctx, TSNode child, TSNode class_node,

def.decorators = extract_decorators(a, child, ctx->source, ctx->language, spec);
extract_route_from_decorators(a, child, ctx->source, spec, &def.route_path, &def.route_method);
if (def.route_path && (ctx->language == CBM_LANG_JAVA || ctx->language == CBM_LANG_KOTLIN)) {
if (def.route_path && (ctx->language == CBM_LANG_JAVA || ctx->language == CBM_LANG_KOTLIN ||
ctx->language == CBM_LANG_SCALA)) {
const char *prefix = spring_class_route_prefix(a, class_node, ctx->source, spec);
def.route_path = join_route_paths(a, prefix, def.route_path);
}
Expand Down
28 changes: 26 additions & 2 deletions tests/test_edge_types_probe.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -473,19 +473,42 @@ TEST(handles_jaxrs_java) {
"package com.example;\n\n"
"import jakarta.ws.rs.GET;\n"
"import jakarta.ws.rs.Path;\n\n"
"@Path(\"/api/v1/widgets\")\npublic class WidgetResource {\n"
"@Path(\"api/v1/widgets\")\npublic class WidgetResource {\n"
" @GET\n"
" public String list() {\n"
" return \"widgets\";\n }\n\n"
" @GET\n"
" @Path(\"/count\")\n"
" @Path(\"count\")\n"
" public String count() {\n"
" return \"42\";\n }\n}\n"}};
ASSERT_TRUE(et_edge_present(f, 1, "HANDLES", 2));
ASSERT_TRUE(et_routes_exact(f, 1, routes));
PASS();
}

/* JAX-RS (Scala): class-level @Path must be composed with both an empty
* method path and a non-empty one. Without the Scala branch in
* push_method_def, unrelated resources collapse onto the global verb/root
* Route node. */
TEST(handles_jaxrs_scala) {
static const char *routes[] = {"/billingAccount", "/billingAccount/{id}",
"/billingAccount/{id}/attachment/{attachmentId}/content", NULL};
static const EtFile f[] = {
{"BillingAccountApiController.scala",
"package com.example\n\n"
"import jakarta.ws.rs.{GET, POST, Path}\n\n"
"@Path(\"/billingAccount\")\nclass BillingAccountApiController {\n"
" @POST\n @Path(\"\")\n"
" def createBillingAccount(): String = \"created\"\n\n"
" @GET\n @Path(\"{id}\")\n"
" def retrieveBillingAccount(): String = \"account\"\n\n"
" @GET\n @Path(\"{id}/attachment/{attachmentId}/content\")\n"
" def retrieveAttachment(): String = \"attachment\"\n}\n"}};
ASSERT_TRUE(et_edge_present(f, 1, "HANDLES", 3));
ASSERT_TRUE(et_routes_exact(f, 1, routes));
PASS();
}

/* ASP.NET Minimal API (C#) — route registration via static MapGet/MapPost calls
* with identifier handlers, under a Microsoft/AspNetCore path so the resolved
* callee QN carries the "MapGet"/"Microsoft.AspNetCore" route-reg substrings.
Expand Down Expand Up @@ -1605,6 +1628,7 @@ SUITE(edge_types_probe) {
RUN_TEST(handles_spring_java_path_attribute_fourth);
RUN_TEST(handles_spring_kotlin);
RUN_TEST(handles_jaxrs_java);
RUN_TEST(handles_jaxrs_scala);
RUN_TEST(handles_aspnet_csharp);
RUN_TEST(handles_laravel_php);
RUN_TEST(handles_laravel_facade_routes_issue952);
Expand Down
4 changes: 2 additions & 2 deletions tests/test_extraction.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4148,12 +4148,12 @@ TEST(arkts_ts_compat) {
TEST(extract_java_jaxrs_path_composition_issue1005) {
CBMFileResult *r = extract("import jakarta.ws.rs.GET;\n"
"import jakarta.ws.rs.Path;\n"
"@Path(\"/api/v1/widgets\")\n"
"@Path(\"api/v1/widgets\")\n"
"public class WidgetResource {\n"
" @GET\n"
" public String list() { return \"\"; }\n"
" @GET\n"
" @Path(\"/count\")\n"
" @Path(\"count\")\n"
" public String count() { return \"\"; }\n"
"}\n",
CBM_LANG_JAVA, "t", "WidgetResource.java");
Expand Down
Loading