Remove http.route from laminas

Author: estringana

appsec/tests/integration/src/test/groovy/com/datadog/appsec/php/integration/Laminas33Tests.groovy

@@ -99,16 +99,6 @@ class Laminas33Tests {
 
     @Test
     @Order(4)
-    void 'home request sets http route to literal slash'() {
-        Trace trace = container.traceFromRequest('/') { HttpResponse<InputStream> resp ->
-            assert resp.statusCode() == 200
-        }
-        Span span = trace.first()
-        assert span.meta.'http.route' == '/'
-    }
-
-    @Test
-    @Order(5)
     void 'Login failure automated event'() {
         Trace trace = container.traceFromRequest('/authenticate?email=nonExisiting@email.com') {
             HttpResponse<InputStream> resp ->
@@ -119,12 +109,11 @@ class Laminas33Tests {
         assert span.meta.'appsec.events.users.login.failure.track' == 'true'
         assert span.meta.'_dd.appsec.events.users.login.failure.auto.mode' == 'identification'
         assert span.meta.'appsec.events.users.login.failure.usr.exists' == 'false'
-        assert span.meta.'http.route' == '/authenticate'
         assert span.metrics._sampling_priority_v1 == 2.0d
     }
 
     @Test
-    @Order(6)
+    @Order(5)
     void 'Login success automated event'() {
         def trace = container.traceFromRequest('/authenticate?email=ciuser@example.com') {
             HttpResponse<InputStream> resp ->
@@ -135,12 +124,11 @@ class Laminas33Tests {
         assert span.meta.'usr.id' == '1'
         assert span.meta.'_dd.appsec.events.users.login.success.auto.mode' == 'identification'
         assert span.meta.'appsec.events.users.login.success.track' == 'true'
-        assert span.meta.'http.route' == '/authenticate'
         assert span.metrics._sampling_priority_v1 == 2.0d
     }
 
     @Test
-    @Order(7)
+    @Order(6)
     void 'path params trigger WAF block and laminas http route template'() {
         HttpRequest req = container.buildReq('/dynamic-path/someValue').GET().build()
         def trace = container.traceFromRequest(req, ofString()) { HttpResponse<String> re ->
@@ -153,6 +141,5 @@ class Laminas33Tests {
         assert span.metrics.'_dd.appsec.waf.duration' > 0.0d
         assert span.meta.'_dd.appsec.event_rules.version' != ''
         assert span.meta.'appsec.blocked' == 'true'
-        assert span.meta.'http.route' == '/dynamic-path[/:param01]'
     }
 }

src/DDTrace/Integrations/Laminas/LaminasIntegration.php

@@ -275,14 +275,6 @@ static function (SpanData $span) use ($controller, $action) {
                 $rootSpan->meta['laminas.route.name'] = $routeName;
                 $rootSpan->meta['laminas.route.action'] = "$controller@$action";
 
-                // http.route: developer-defined template (e.g. /dynamic_route[/:param01[/static[/:param02]]])
-                // Use LaminasIntegration:: not self:: — non-static hook closure is bound to the route object;
-                // ddtrace resolves self to the instrumented class (e.g. TreeRouteStack).
-                $routeTemplate = LaminasIntegration::httpRouteTemplateFromMatchedRoute($this, $routeMatch);
-                if ($routeTemplate !== null) {
-                    $rootSpan->meta[Tag::HTTP_ROUTE] = $routeTemplate;
-                }
-
                 // Push path params to appsec
                 if (function_exists('\datadog\appsec\push_addresses')) {
                     $params = $routeMatch->getParams();
@@ -544,10 +536,6 @@ static function ($This, $scope, $args) {
                 $rootSpan->resource = "$controller@$eventName $routeName";
                 $rootSpan->meta['laminas.route.name'] = $routeName;
                 $rootSpan->meta['laminas.route.action'] = $controller . '@' . $eventName;
-                $routeTemplate = LaminasIntegration::httpRouteTemplateFromMatchedRoute($event->getRouteMatch(), $event->getRouteMatch());
-                if ($routeTemplate !== null) {
-                    $rootSpan->meta[Tag::HTTP_ROUTE] = $routeTemplate;
-                }
 
                 if (isset($eventName, self::$EVENT_TYPES)) {
                     install_hook(
@@ -935,7 +923,13 @@ public static function httpRouteTemplateFromMatchedRoute($matchedRoute, $routeMa
                 }
             }
 
-            if (method_exists($matchedRoute, 'getRoute')) {
+            // Segment (and similar leaf routes) expose getRoute() with no args as the path template.
+            // RouteStackInterface (TreeRouteStack, Part, …) inherits SimpleRouteStack::getRoute($name), which
+            // requires the route name — calling it with no arguments throws ArgumentCountError.
+            if (
+                method_exists($matchedRoute, 'getRoute')
+                && !($matchedRoute instanceof \Laminas\Router\RouteStackInterface)
+            ) {
                 $routeSpec = $matchedRoute->getRoute();
                 if (is_string($routeSpec) && $routeSpec !== '') {
                     return $routeSpec;

tests/snapshots/tests.integrations.laminas.api_tools.latest.rest_test.test_scenario_rest2xx.json

@@ -11,7 +11,6 @@
       "_dd.p.dm": "-0",
       "component": "laminas",
       "http.method": "POST",
-      "http.route": "[/v:version]/datadog-rest-service[/:datadog_rest_service_id]",
       "http.status_code": "201",
       "http.url": "http://localhost/datadog-rest-service",
       "http.version": "1.1",

tests/snapshots/tests.integrations.laminas.api_tools.latest.rest_test.test_scenario_rest4xx.json

@@ -11,7 +11,6 @@
       "_dd.p.dm": "-0",
       "component": "laminas",
       "http.method": "GET",
-      "http.route": "[/v:version]/datadog-rest-service[/:datadog_rest_service_id]",
       "http.status_code": "405",
       "http.url": "http://localhost/datadog-rest-service/1",
       "http.version": "1.1",

tests/snapshots/tests.integrations.laminas.api_tools.latest.rest_test.test_scenario_rest5xx.json

@@ -15,7 +15,6 @@
       "error.stack": "#0 {path}/tests/Frameworks/Laminas/ApiTools/Latest/vendor/laminas-api-tools/api-tools-rest/src/AbstractResourceListener.php(182): DatadogApi\\V1\\Rest\\DatadogRestService\\DatadogRestServiceResource->fetch()\n#1 {path}/tests/Frameworks/Laminas/ApiTools/Latest/vendor/laminas/laminas-eventmanager/src/EventManager.php(319): Laminas\\ApiTools\\Rest\\AbstractResourceListener->dispatch()\n#2 {path}/tests/Frameworks/Laminas/ApiTools/Latest/vendor/laminas/laminas-eventmanager/src/EventManager.php(177): Laminas\\EventManager\\EventManager->triggerListeners()\n#3 {path}/tests/Frameworks/Laminas/ApiTools/Latest/vendor/laminas-api-tools/api-tools-rest/src/Resource.php(544): Laminas\\EventManager\\EventManager->triggerEventUntil()\n#4 {path}/tests/Frameworks/Laminas/ApiTools/Latest/vendor/laminas-api-tools/api-tools-rest/src/Resource.php(499): Laminas\\ApiTools\\Rest\\Resource->triggerEvent()\n#5 {path}/tests/Frameworks/Laminas/ApiTools/Latest/vendor/laminas-api-tools/api-tools-rest/src/RestController.php(493): Laminas\\ApiTools\\Rest\\Resource->fetch()\n#6 {path}/tests/Frameworks/Laminas/ApiTools/Latest/vendor/laminas/laminas-mvc/src/Controller/AbstractRestfulController.php(372): Laminas\\ApiTools\\Rest\\RestController->get()\n#7 {path}/tests/Frameworks/Laminas/ApiTools/Latest/vendor/laminas-api-tools/api-tools-rest/src/RestController.php(335): Laminas\\Mvc\\Controller\\AbstractRestfulController->onDispatch()\n#8 {path}/tests/Frameworks/Laminas/ApiTools/Latest/vendor/laminas/laminas-eventmanager/src/EventManager.php(319): Laminas\\ApiTools\\Rest\\RestController->onDispatch()\n#9 {path}/tests/Frameworks/Laminas/ApiTools/Latest/vendor/laminas/laminas-eventmanager/src/EventManager.php(177): Laminas\\EventManager\\EventManager->triggerListeners()\n#10 {path}/tests/Frameworks/Laminas/ApiTools/Latest/vendor/laminas/laminas-mvc/src/Controller/AbstractController.php(105): Laminas\\EventManager\\EventManager->triggerEventUntil()\n#11 {path}/tests/Frameworks/Laminas/ApiTools/Latest/vendor/laminas/laminas-mvc/src/Controller/AbstractRestfulController.php(306): Laminas\\Mvc\\Controller\\AbstractController->dispatch()\n#12 {path}/tests/Frameworks/Laminas/ApiTools/Latest/vendor/laminas/laminas-mvc/src/DispatchListener.php(117): Laminas\\Mvc\\Controller\\AbstractRestfulController->dispatch()\n#13 {path}/tests/Frameworks/Laminas/ApiTools/Latest/vendor/laminas/laminas-eventmanager/src/EventManager.php(319): Laminas\\Mvc\\DispatchListener->onDispatch()\n#14 {path}/tests/Frameworks/Laminas/ApiTools/Latest/vendor/laminas/laminas-eventmanager/src/EventManager.php(177): Laminas\\EventManager\\EventManager->triggerListeners()\n#15 {path}/tests/Frameworks/Laminas/ApiTools/Latest/vendor/laminas/laminas-mvc/src/Application.php(319): Laminas\\EventManager\\EventManager->triggerEventUntil()\n#16 {path}/tests/Frameworks/Laminas/ApiTools/Latest/public/index.php(60): Laminas\\Mvc\\Application->run()\n#17 {main}",
       "error.type": "Error",
       "http.method": "GET",
-      "http.route": "[/v:version]/datadog-rest-service[/:datadog_rest_service_id]",
       "http.status_code": "500",
       "http.url": "http://localhost/datadog-rest-service/42",
       "http.version": "1.1",

tests/snapshots/tests.integrations.laminas.mvc.latest.common_scenarios_test.test_scenario_get_return_string.json

@@ -11,7 +11,6 @@
       "_dd.p.dm": "-0",
       "component": "laminas",
       "http.method": "GET",
-      "http.route": "/simple[/:key][/:pwd]",
       "laminas.route.name": "simple",
       "http.status_code": "200",
       "http.url": "http://localhost/simple?key=value&<redacted>",

tests/snapshots/tests.integrations.laminas.mvc.latest.common_scenarios_test.test_scenario_get_with_exception.json

@@ -15,7 +15,6 @@
       "error.stack": "#0 {path}/tests/Frameworks/Laminas/Mvc/Latest/vendor/laminas/laminas-mvc/src/Controller/AbstractActionController.php(72): Application\\Controller\\CommonSpecsController->errorAction()\n#1 {path}/tests/Frameworks/Laminas/Mvc/Latest/vendor/laminas/laminas-eventmanager/src/EventManager.php(320): Laminas\\Mvc\\Controller\\AbstractActionController->onDispatch(Object(Laminas\\Mvc\\MvcEvent))\n#2 {path}/tests/Frameworks/Laminas/Mvc/Latest/vendor/laminas/laminas-eventmanager/src/EventManager.php(178): Laminas\\EventManager\\EventManager->triggerListeners(Object(Laminas\\Mvc\\MvcEvent), Object(Closure))\n#3 {path}/tests/Frameworks/Laminas/Mvc/Latest/vendor/laminas/laminas-mvc/src/Controller/AbstractController.php(105): Laminas\\EventManager\\EventManager->triggerEventUntil(Object(Closure), Object(Laminas\\Mvc\\MvcEvent))\n#4 {path}/tests/Frameworks/Laminas/Mvc/Latest/vendor/laminas/laminas-mvc/src/DispatchListener.php(117): Laminas\\Mvc\\Controller\\AbstractController->dispatch(Object(Laminas\\Http\\PhpEnvironment\\Request), Object(Laminas\\Http\\PhpEnvironment\\Response))\n#5 {path}/tests/Frameworks/Laminas/Mvc/Latest/vendor/laminas/laminas-eventmanager/src/EventManager.php(320): Laminas\\Mvc\\DispatchListener->onDispatch(Object(Laminas\\Mvc\\MvcEvent))\n#6 {path}/tests/Frameworks/Laminas/Mvc/Latest/vendor/laminas/laminas-eventmanager/src/EventManager.php(178): Laminas\\EventManager\\EventManager->triggerListeners(Object(Laminas\\Mvc\\MvcEvent), Object(Closure))\n#7 {path}/tests/Frameworks/Laminas/Mvc/Latest/vendor/laminas/laminas-mvc/src/Application.php(319): Laminas\\EventManager\\EventManager->triggerEventUntil(Object(Closure), Object(Laminas\\Mvc\\MvcEvent))\n#8 {path}/tests/Frameworks/Laminas/Mvc/Latest/public/index.php(37): Laminas\\Mvc\\Application->run()\n#9 {main}",
       "error.type": "Exception",
       "http.method": "GET",
-      "http.route": "/error[/:key][/:pwd]",
       "laminas.route.name": "error",
       "http.status_code": "500",
       "http.url": "http://localhost/error?key=value&<redacted>",

tests/snapshots/tests.integrations.laminas.mvc.latest.common_scenarios_test.test_scenario_get_with_view.json

@@ -11,7 +11,6 @@
       "_dd.p.dm": "-0",
       "component": "laminas",
       "http.method": "GET",
-      "http.route": "/simple_view[/:key][/:pwd]",
       "laminas.route.name": "simpleView",
       "http.status_code": "200",
       "http.url": "http://localhost/simple_view?key=value&<redacted>",

tests/snapshots/tests.integrations.laminas.mvc.v3_3.common_scenarios_test.test_scenario_get_return_string.json

@@ -12,7 +12,6 @@
       "_dd.p.tid": "6790b6e900000000",
       "component": "laminas",
       "http.method": "GET",
-      "http.route": "/simple[/:key][/:pwd]",
       "http.status_code": "200",
       "http.url": "http://localhost/simple?key=value&<redacted>",
       "http.version": "1.1",

tests/snapshots/tests.integrations.laminas.mvc.v3_3.common_scenarios_test.test_scenario_get_with_exception.json

@@ -16,7 +16,6 @@
       "error.stack": "#0 {path}/tests/Frameworks/Laminas/Mvc/Version_3_3/vendor/laminas/laminas-mvc/src/Controller/AbstractActionController.php(71): Application\\Controller\\CommonSpecsController->errorAction()\n#1 {path}/tests/Frameworks/Laminas/Mvc/Version_3_3/vendor/laminas/laminas-eventmanager/src/EventManager.php(319): Laminas\\Mvc\\Controller\\AbstractActionController->onDispatch()\n#2 {path}/tests/Frameworks/Laminas/Mvc/Version_3_3/vendor/laminas/laminas-eventmanager/src/EventManager.php(179): Laminas\\EventManager\\EventManager->triggerListeners()\n#3 {path}/tests/Frameworks/Laminas/Mvc/Version_3_3/vendor/laminas/laminas-mvc/src/Controller/AbstractController.php(97): Laminas\\EventManager\\EventManager->triggerEventUntil()\n#4 {path}/tests/Frameworks/Laminas/Mvc/Version_3_3/vendor/laminas/laminas-mvc/src/DispatchListener.php(132): Laminas\\Mvc\\Controller\\AbstractController->dispatch()\n#5 {path}/tests/Frameworks/Laminas/Mvc/Version_3_3/vendor/laminas/laminas-eventmanager/src/EventManager.php(319): Laminas\\Mvc\\DispatchListener->onDispatch()\n#6 {path}/tests/Frameworks/Laminas/Mvc/Version_3_3/vendor/laminas/laminas-eventmanager/src/EventManager.php(179): Laminas\\EventManager\\EventManager->triggerListeners()\n#7 {path}/tests/Frameworks/Laminas/Mvc/Version_3_3/vendor/laminas/laminas-mvc/src/Application.php(325): Laminas\\EventManager\\EventManager->triggerEventUntil()\n#8 {path}/tests/Frameworks/Laminas/Mvc/Version_3_3/public/index.php(37): Laminas\\Mvc\\Application->run()\n#9 {main}",
       "error.type": "Exception",
       "http.method": "GET",
-      "http.route": "/error[/:key][/:pwd]",
       "http.status_code": "500",
       "http.url": "http://localhost/error?key=value&<redacted>",
       "http.version": "1.1",