Add http.route tag to SymfonyIntegration.php

Makefile

@@ -920,7 +920,6 @@ TEST_WEB_81 := \
 	test_web_nette_30 \
 	test_web_slim_312 \
 	test_web_slim_4 \
-	test_web_symfony_52 \
 	test_web_wordpress_59 \
 	test_web_wordpress_61 \
 	test_web_custom \
@@ -981,7 +980,6 @@ TEST_WEB_82 := \
 	test_web_nette_30 \
 	test_web_slim_312 \
 	test_web_slim_4 \
-	test_web_symfony_52 \
 	test_web_symfony_62 \
 	test_web_symfony_70 \
 	test_web_wordpress_59 \
@@ -1040,7 +1038,6 @@ TEST_WEB_83 := \
 	test_web_nette_30 \
 	test_web_slim_312 \
 	test_web_slim_4 \
-	test_web_symfony_52 \
 	test_web_symfony_62 \
 	test_web_symfony_70 \
 	test_web_wordpress_59 \

appsec/tests/integration/build.gradle

@@ -438,6 +438,7 @@ task loadCaches(type: Exec) {
 
     commandLine 'docker', 'run', '--rm',
             '-v', 'php-tracer-cargo-cache:/caches/php-tracer-cargo-cache',
+            '-v', 'php-tracer-cargo-cache-git:/caches/php-tracer-cargo-cache-git',
             '-v', 'php-appsec-hunter-cache:/caches/php-appsec-hunter-cache',
             '-v', "${project.buildDir}:/build",
             'busybox',

appsec/tests/integration/gradle/images.gradle

@@ -234,6 +234,7 @@ task saveCaches(type: Exec) {
     commandLine 'docker', 'run', '--rm',
             '-e', "UUID=${uuid}",
             '-v', 'php-tracer-cargo-cache:/caches/php-tracer-cargo-cache',
+            '-v', 'php-tracer-cargo-cache-git:/caches/php-tracer-cargo-cache-git',
             '-v', 'php-appsec-hunter-cache:/caches/php-appsec-hunter-cache',
             '-v', "${project.buildDir}:/build",
             'busybox',

appsec/tests/integration/src/docker/php/build_dev_php.sh

@@ -80,17 +80,36 @@ EOD
 chmod +x /tmp/apxs_wrapper
 }
 
+function run_dsymutil {
+  if [[ $(uname) != Darwin ]] then
+    return
+  fi
+  local readonly dir=$1 exe=
+  find "$dir" -type f -exec test -x '{}' \; -print | while read -r exe; do
+    if [[ $exe != *.a ]]; then
+      if ! grep -q '^#!' "$exe"; then
+        local readonly dSYM_DIR="${exe}.dSYM"
+        if [[ ! -d $dSYM_DIR ]]; then
+          dsymutil "$exe"
+        fi
+      fi
+    fi
+  done
+}
+
 function get_xdebug_version {
   local -r version=$1
   local readonly version_id=$(php_version_id $version)
-  if [[ $version_id -lt 70300 ]]; then
-    echo '2.8.1'
-  elif [[ $version_id -lt 80000 ]]; then
+  if [[ $version_id -lt 70100 ]]; then
+    echo '2.6.1'
+  elif [[ $version_id -lt 70200 ]]; then
     echo '2.9.8'
+  elif [[ $version_id -lt 80000 ]]; then
+    echo '3.1.6'
   elif [[ $version_id -lt 80400 ]]; then
-    echo '3.3.1'
+    echo '3.3.2'
   elif [[ $version_id -ge 80400 ]]; then
-    echo '3.4.0beta1'
+    echo '3.4.0'
   fi
 }
 
@@ -294,6 +313,7 @@ function build_php {
   make install-sapi || true
   make install-binaries install-headers install-modules install-programs install-build
 
+  run_dsymutil "$prefix_dir"
   rm -rf "$build_dir"
   cd -
 }
@@ -462,11 +482,12 @@ function install_xdebug {
   "$php_prefix/bin/phpize"
   mkdir -p "$build_dir"
   cd "$build_dir"
-  "$xdebug_source_dir/configure" "--with-php-config=$php_prefix/bin/php-config"
+  CFLAGS="$CFLAGS -ggdb" "$xdebug_source_dir/configure" "--with-php-config=$php_prefix/bin/php-config"
   make -j
   make install
   cd -
 
+  run_dsymutil "$php_prefix/lib"
   rm -rf "$build_dir"
 }
 
@@ -483,7 +504,7 @@ fi
 
 if [[ -d /opt/homebrew/lib ]]; then
   export LDFLAGS="${LDFLAGS:-} -L/opt/homebrew/lib"
-  export CPPFLAGS="${CPPFLAGS:-} -I/opt/homebrew/include"
+  export CPPFLAGS="${CPPFLAGS:-} -idirafter /opt/homebrew/include"
 fi
 export CXXFLAGS="${CXXFLAGS:-} -std=c++11"
 export CFLAGS="${CFLAGS:-} -Wno-implicit-function-declaration"

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

@@ -6,7 +6,6 @@ import com.datadog.appsec.php.docker.InspectContainerHelper
 import com.datadog.appsec.php.model.Span
 import com.datadog.appsec.php.model.Trace
 import org.junit.jupiter.api.MethodOrderer
-import org.junit.jupiter.api.Order
 import org.junit.jupiter.api.Test
 import org.junit.jupiter.api.TestMethodOrder
 import org.junit.jupiter.api.condition.EnabledIf
@@ -45,12 +44,6 @@ class Symfony62Tests {
                     www: 'symfony62',
             )
 
-    @Test
-    @Order(1)
-    void 'reported telemetry integrations are not repeated'() {
-
-    }
-
     @Test
     void 'login success automated event'() {
         //The user [email protected] is already on the DB
@@ -113,5 +106,32 @@ class Symfony62Tests {
         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}'
+    }
+
+    @Test
+    void 'symfony http route disabled'() {
+        try {
+            def res = CONTAINER.execInContainer(
+                    'bash', '-c',
+                    '''echo export DD_TRACE_SYMFONY_HTTP_ROUTE=false >> /etc/apache2/envvars;
+                   service apache2 restart''')
+            assert res.exitCode == 0
+
+            HttpRequest req = container.buildReq('/dynamic-path/someValue').GET().build()
+            def trace = container.traceFromRequest(req, ofString()) { HttpResponse<String> re ->
+                assert re.statusCode() == 200
+                assert re.body().contains('Hi someValue!')
+            }
+
+            Span span = trace.first()
+            assert span.meta."http.route" != '/dynamic-path/{param01}'
+        } finally {
+            def res = CONTAINER.execInContainer(
+                    'bash', '-c',
+                    '''sed -i '/export DD_TRACE_SYMFONY_HTTP_ROUTE=/d' /etc/apache2/envvars;
+                       service apache2 restart''')
+            assert res.exitCode == 0
+        }
     }
 }

appsec/tests/integration/src/test/www/symfony62/config/packages/test/framework.yaml

@@ -1,4 +1,4 @@
 framework:
     test: true
     session:
-        storage_id: session.storage.mock_file
+        storage_factory_id: session.storage.factory.mock_file

appsec/tests/integration/src/test/www/symfony62/src/Controller/HomeController.php

@@ -21,13 +21,12 @@ public function homeAction(Request $request)
         );
     }
 
-    /**
-     * @Route("/dynamic-path/{param01}", name="dynamic-path")
-     */
-    public function dynamicAction(Request $request)
+    #[Route("/dynamic-path/{param01}", locale: "en")]
+    #[Route("/caminho-dinamico/{param01}", locale: "pt")]
+    public function dynamicAction(Request $request, string $param01)
     {
         return new Response(
-            'Hi!'
+            "Hi $param01!"
         );
     }
 }

docker-compose.yml

@@ -280,7 +280,7 @@ services:
   test-agent:
     image: ghcr.io/datadog/dd-apm-test-agent/ddapm-test-agent:latest
     ports:
-      - "127.0.0.1:9126:8126"
+      - "9126:9126"
     volumes:
       - ./tests/snapshots:/snapshots
     environment:

ext/configuration.h

@@ -141,6 +141,7 @@ enum ddtrace_sampling_rules_format {
     CONFIG(BOOL, DD_TRACE_LARAVEL_QUEUE_DISTRIBUTED_TRACING, "true")                                           \
     CONFIG(BOOL, DD_TRACE_SYMFONY_MESSENGER_DISTRIBUTED_TRACING, "true")                                       \
     CONFIG(BOOL, DD_TRACE_SYMFONY_MESSENGER_MIDDLEWARES, "false")                                              \
+    CONFIG(BOOL, DD_TRACE_SYMFONY_HTTP_ROUTE, "true")                                                          \
     CONFIG(BOOL, DD_TRACE_REMOVE_ROOT_SPAN_LARAVEL_QUEUE, "true")                                              \
     CONFIG(BOOL, DD_TRACE_REMOVE_ROOT_SPAN_SYMFONY_MESSENGER, "true")                                          \
     CONFIG(BOOL, DD_APPSEC_RASP_ENABLED , "false")                                                             \

src/DDTrace/Integrations/Symfony/SymfonyIntegration.php

@@ -9,8 +9,10 @@
 use DDTrace\Tag;
 use DDTrace\Type;
 use DDTrace\Util\Normalizer;
+use Symfony\Component\DependencyInjection\ContainerInterface;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpKernel\KernelEvents;
+use Symfony\Contracts\Cache\ItemInterface;
 
 class SymfonyIntegration extends Integration
 {
@@ -22,6 +24,8 @@ class SymfonyIntegration extends Integration
     /** @var string */
     public $frameworkPrefix = SymfonyIntegration::NAME;
 
+    public $kernel;
+
     /**
      * {@inheritdoc}
      */
@@ -355,6 +359,24 @@ function (SpanData $span) use ($class, $methodname) {
         );
          */
 
+        \DDTrace\hook_method(
+            'Symfony\Component\HttpKernel\Kernel',
+            'getHttpKernel',
+            null,
+            function ($object) use ($integration) {
+                $integration->kernel = $object;
+            }
+        );
+
+        \DDTrace\hook_method(
+            'Drupal\Core\DrupalKernel',
+            'getHttpKernel',
+            null,
+            function ($object) use ($integration) {
+                $integration->kernel = $object;
+            }
+        );
+
         \DDTrace\hook_method(
             'Symfony\Component\HttpKernel\HttpKernel',
             '__construct',
@@ -366,47 +388,90 @@ function () use ($integration) {
             }
         );
 
-        \DDTrace\trace_method(
-            'Symfony\Component\HttpKernel\HttpKernel',
-            'handle',
-            function (SpanData $span, $args, $response) use ($integration) {
-                /** @var Request $request */
-                list($request) = $args;
-
-                $span->name = 'symfony.kernel.handle';
-                $span->service = \ddtrace_config_app_name($integration->frameworkPrefix);
-                $span->type = Type::WEB_SERVLET;
-                $span->meta[Tag::COMPONENT] = SymfonyIntegration::NAME;
-
-                $rootSpan = \DDTrace\root_span();
-                $rootSpan->meta[Tag::HTTP_METHOD] = $request->getMethod();
-                $rootSpan->meta[Tag::COMPONENT] = $integration->frameworkPrefix;
-                $rootSpan->meta[Tag::SPAN_KIND] = 'server';
-                $integration->addTraceAnalyticsIfEnabled($rootSpan);
-
-                if (!array_key_exists(Tag::HTTP_URL, $rootSpan->meta)) {
-                    $rootSpan->meta[Tag::HTTP_URL] = Normalizer::urlSanitize($request->getUri());
+        if (\dd_trace_env_config('DD_TRACE_SYMFONY_HTTP_ROUTE')) {
+            $handle_http_route = function($route_name, $request, $rootSpan) use ($integration) {
+                if ($integration->kernel === null) {
+                    return;
                 }
-                if (isset($response)) {
-                    $rootSpan->meta[Tag::HTTP_STATUS_CODE] = $response->getStatusCode();
+                /** @var ContainerInterface $container */
+                $container = $integration->kernel->getContainer();
+                try {
+                    $cache = $container->get('cache.app');
+                } catch (\Exception $e) {
+                    return;
                 }
 
-                $parameters = $request->get('_route_params');
-                if (!empty($parameters) &&
-                    is_array($parameters) &&
-                    function_exists('\datadog\appsec\push_address')) {
-                    \datadog\appsec\push_address("server.request.path_params", $parameters);
+                /** @var \Symfony\Bundle\FrameworkBundle\Routing\Router $router */
+                $router = $container->get('router');
+                if (!\method_exists($cache, 'getItem')) {
+                    return;
+                }
+                $itemName = "_datadog.route.path.$route_name";
+                $locale = $request->get('_locale');
+                if ($locale !== null) {
+                    $itemName .= ".$locale";
                 }
+                $item = $cache->getItem($itemName);
+                if ($item->isHit()) {
+                    $route = $item->get();
+                } else {
+                    $routeCollection = $router->getRouteCollection();
+                    $route = $routeCollection->get($route_name);
+                    if ($route == null && ($locale = $request->get('_locale')) !== null) {
+                        $route = $routeCollection->get($route_name . '.' . $locale);
+                    }
+                    $item->set($route);
+                    $item->expiresAfter(3600);
+                    $cache->save($item);
+                }
+                if (isset($route)) {
+                    $rootSpan->meta[Tag::HTTP_ROUTE] = $route->getPath();
+                }
+            };
+
+            \DDTrace\trace_method(
+                'Symfony\Component\HttpKernel\HttpKernel',
+                'handle',
+                function (SpanData $span, $args, $response) use ($integration, $handle_http_route) {
+                    /** @var Request $request */
+                    list($request) = $args;
+
+                    $span->name = 'symfony.kernel.handle';
+                    $span->service = \ddtrace_config_app_name($integration->frameworkPrefix);
+                    $span->type = Type::WEB_SERVLET;
+                    $span->meta[Tag::COMPONENT] = SymfonyIntegration::NAME;
+
+                    $rootSpan = \DDTrace\root_span();
+                    $rootSpan->meta[Tag::HTTP_METHOD] = $request->getMethod();
+                    $rootSpan->meta[Tag::COMPONENT] = $integration->frameworkPrefix;
+                    $rootSpan->meta[Tag::SPAN_KIND] = 'server';
+                    $integration->addTraceAnalyticsIfEnabled($rootSpan);
+
+                    if (!array_key_exists(Tag::HTTP_URL, $rootSpan->meta)) {
+                        $rootSpan->meta[Tag::HTTP_URL] = Normalizer::urlSanitize($request->getUri());
+                    }
+                    if (isset($response)) {
+                        $rootSpan->meta[Tag::HTTP_STATUS_CODE] = $response->getStatusCode();
+                    }
 
-                $route = $request->get('_route');
-                if (null !== $route && null !== $request) {
-                    if (dd_trace_env_config("DD_HTTP_SERVER_ROUTE_BASED_NAMING")) {
-                        $rootSpan->resource = $route;
+                    $route_name = $request->get('_route');
+                    if ($route_name !== null) {
+                        if (dd_trace_env_config("DD_HTTP_SERVER_ROUTE_BASED_NAMING")) {
+                            $rootSpan->resource = $route_name;
+                        }
+                        $rootSpan->meta['symfony.route.name'] = $route_name;
+                        $handle_http_route($route_name, $request, $rootSpan);
+                    }
+
+                    $parameters = $request->get('_route_params');
+                    if (!empty($parameters) &&
+                        is_array($parameters) &&
+                        function_exists('datadog\appsec\push_address')) {
+                        \datadog\appsec\push_address("server.request.path_params", $parameters);
                     }
-                    $rootSpan->meta['symfony.route.name'] = $route;
                 }
-            }
-        );
+            );
+        }
 
         /*
          * EventDispatcher v4.3 introduced an arg hack that mutates the arguments.

tests/Common/TracerTestTrait.php

@@ -310,7 +310,7 @@ public function tracesFromWebRequest($fn, $tracer = null, callable $until = null
         // Clearing existing dumped file
         $this->resetRequestDumper();
 
-        // The we server has to be configured to send traces to the provided requests dumper.
+        // The web server has to be configured to send traces to the provided requests dumper.
         $fn($tracer);
 
         self::putEnv('DD_TRACE_SHUTDOWN_TIMEOUT');