Add path_params to laminas

Author: estringana

src/DDTrace/Integrations/Laminas/LaminasIntegration.php

@@ -274,6 +274,16 @@ static function (SpanData $span) use ($controller, $action) {
                 }
                 $rootSpan->meta['laminas.route.name'] = $routeName;
                 $rootSpan->meta['laminas.route.action'] = "$controller@$action";
+
+                // Push path params to appsec
+                if (function_exists('\datadog\appsec\push_addresses')) {
+                    $params = $routeMatch->getParams();
+                    // Filter out the framework-specific params (controller, action)
+                    $pathParams = array_diff_key($params, array_flip(['controller', 'action']));
+                    if (count($pathParams) > 0) {
+                        \datadog\appsec\push_addresses(["server.request.path_params" => $pathParams]);
+                    }
+                }
             }
         );
 

tests/Frameworks/Laminas/Mvc/Latest/module/Application/config/module.config.php

@@ -93,6 +93,20 @@
                         'action' => 'behindAuth',
                     ],
                 ]
+            ],
+            'dynamic_route' => [
+                'type' => Segment::class,
+                'options' => [
+                    'route' => '/dynamic_route[/:param01[/static[/:param02]]]',
+                    'constraints' => [
+                        'param01' => '[a-zA-Z0-9_-]+',
+                        'param02' => '[a-zA-Z0-9_-]+',
+                    ],
+                    'defaults' => [
+                        'controller' => Controller\CommonSpecsController::class,
+                        'action' => 'dynamicRoute',
+                    ],
+                ]
             ]
         ],
     ],

tests/Frameworks/Laminas/Mvc/Latest/module/Application/src/Controller/CommonSpecsController.php

@@ -32,4 +32,11 @@ public function errorAction()
     {
         throw new \Exception('Controller error');
     }
+
+    public function dynamicRouteAction()
+    {
+        $response = new Response();
+        $response->setContent('dynamicRoute');
+        return $response;
+    }
 }

tests/Frameworks/Laminas/Mvc/Version_3_3/module/Application/config/module.config.php

@@ -93,6 +93,20 @@
                         'action' => 'behindAuth',
                     ],
                 ]
+            ],
+            'dynamic_route' => [
+                'type' => Segment::class,
+                'options' => [
+                    'route' => '/dynamic_route[/:param01[/static[/:param02]]]',
+                    'constraints' => [
+                        'param01' => '[a-zA-Z0-9_-]+',
+                        'param02' => '[a-zA-Z0-9_-]+',
+                    ],
+                    'defaults' => [
+                        'controller' => Controller\CommonSpecsController::class,
+                        'action' => 'dynamicRoute',
+                    ],
+                ]
             ]
         ],
     ],

tests/Frameworks/Laminas/Mvc/Version_3_3/module/Application/src/Controller/CommonSpecsController.php

@@ -32,4 +32,11 @@ public function errorAction()
     {
         throw new \Exception('Controller error');
     }
+
+    public function dynamicRouteAction()
+    {
+        $response = new Response();
+        $response->setContent('dynamicRoute');
+        return $response;
+    }
 }

tests/Integrations/Laminas/Mvc/Latest/PathParamsTest.php

@@ -0,0 +1,16 @@
+<?php
+
+namespace DDTrace\Tests\Integrations\Laminas\Mvc\Latest;
+
+use DDTrace\Tests\Integrations\Laminas\Mvc\PathParamsTestSuite;
+
+/**
+ * @group appsec
+ */
+class PathParamsTest extends PathParamsTestSuite
+{
+    public static function getAppIndexScript()
+    {
+        return __DIR__ . '/../../../../Frameworks/Laminas/Mvc/Latest/public/index.php';
+    }
+}

tests/Integrations/Laminas/Mvc/PathParamsTestSuite.php

@@ -0,0 +1,44 @@
+<?php
+
+namespace DDTrace\Tests\Integrations\Laminas\Mvc;
+
+use DDTrace\Tests\Common\AppsecTestCase;
+use DDTrace\Tests\Frameworks\Util\Request\GetSpec;
+use datadog\appsec\AppsecStatus;
+
+class PathParamsTestSuite extends AppsecTestCase
+{
+    public function testDynamicRouteWithAllParametersGiven()
+    {
+        $param01 = 'first_param';
+        $param02 = 'second_param';
+        $this->call(
+            GetSpec::create('Call to dynamic route', "/dynamic_route/$param01/static/$param02")
+        );
+        $events = AppsecStatus::getInstance()->getEvents(['push_addresses'], ['server.request.path_params']);
+        $this->assertEquals(1, count($events));
+        $this->assertEquals($param01, $events[0][0]["server.request.path_params"]['param01']);
+        $this->assertEquals($param02, $events[0][0]["server.request.path_params"]['param02']);
+    }
+
+    public function testDynamicRouteWithOptionalParametersNotGiven()
+    {
+        $param01 = 'first_param';
+        $this->call(
+            GetSpec::create('Call to dynamic route', "/dynamic_route/$param01/static")
+        );
+        $events = AppsecStatus::getInstance()->getEvents(['push_addresses'], ['server.request.path_params']);
+        $this->assertEquals(1, count($events));
+        $this->assertCount(1, $events[0][0]["server.request.path_params"]);
+        $this->assertEquals($param01, $events[0][0]["server.request.path_params"]['param01']);
+    }
+
+    public function testStaticRouteDoesNotGenerateEvent()
+    {
+        $this->call(
+            GetSpec::create('Call to static route', "/simple")
+        );
+        $events = AppsecStatus::getInstance()->getEvents(['push_addresses'], ['server.request.path_params']);
+        $this->assertEquals(0, count($events));
+    }
+}

tests/Integrations/Laminas/Mvc/V3_3/PathParamsTest.php

@@ -0,0 +1,16 @@
+<?php
+
+namespace DDTrace\Tests\Integrations\Laminas\Mvc\V3_3;
+
+use DDTrace\Tests\Integrations\Laminas\Mvc\PathParamsTestSuite;
+
+/**
+ * @group appsec
+ */
+class PathParamsTest extends PathParamsTestSuite
+{
+    public static function getAppIndexScript()
+    {
+        return __DIR__ . '/../../../../Frameworks/Laminas/Mvc/Version_3_3/public/index.php';
+    }
+}