Fix profiler service deprecation by using non-deprecated internal id (#237)

Accessing the "profiler" service directly from the container triggers a
deprecation since symfony/framework-bundle 5.4: "Accessing the "profiler"
service directly from the container is deprecated, use dependency
injection instead."

The public "profiler" id is a deprecated alias that calls
trigger_deprecation() before delegating to the real, non-deprecated
private definition ".container.private.profiler". Prefer the internal id
and fall back to "profiler" for older/edge configs where the alias does
not exist. This avoids the deprecation on every container path (raw or
test container) across Symfony 5.4 to 8.0.

Closes #212

Author: TavoNiievez

src/Codeception/Lib/Connector/Symfony.php

@@ -87,13 +87,15 @@ private function resolveContainer(): ContainerInterface
 
     private function getProfiler(): ?Profiler
     {
-        if (!$this->container->has('profiler')) {
-            return null;
-        }
+        foreach (['.container.private.profiler', 'profiler'] as $id) {
+            if ($this->container->has($id)) {
+                $profiler = $this->container->get($id);
 
-        $profiler = $this->container->get('profiler');
+                return $profiler instanceof Profiler ? $profiler : null;
+            }
+        }
 
-        return $profiler instanceof Profiler ? $profiler : null;
+        return null;
     }
 
     private function persistDoctrineConnections(): void

src/Codeception/Module/Symfony.php

@@ -364,8 +364,7 @@ protected function getKernelClass(): string
      */
     protected function getProfile(): ?Profile
     {
-        /** @var Profiler|null $profiler */
-        $profiler = $this->getService('profiler');
+        $profiler = $this->grabCachedService(Profiler::class, ['.container.private.profiler', 'profiler']);
 
         if ($profiler === null) {
             return null;

tests/Support/CodeceptTestCase.php

@@ -153,12 +153,20 @@ protected function getProfile(): ?Profile
         }
 
         $container = $this->_getContainer();
-        if (!$container->has('profiler')) {
+
+        $profiler = null;
+        foreach (['.container.private.profiler', 'profiler'] as $id) {
+            if ($container->has($id)) {
+                /** @var Profiler $profiler */
+                $profiler = $container->get($id);
+                break;
+            }
+        }
+
+        if (!$profiler instanceof Profiler) {
             return null;
         }
 
-        /** @var Profiler $profiler */
-        $profiler = $container->get('profiler');
         $profile = $profiler->collect($request, $response);
 
         if ($profile instanceof Profile) {