Merge pull request #217 from loic425/fix/lazy-object-with-sf-7.3

lchrusciel · web-flow · commit 3ed86d77923b · 2025-06-03T15:32:20.000+02:00
Fix Mink lazy object with SF7.3 and PHP 8.4
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -17,15 +17,15 @@ jobs:
             fail-fast: false
             matrix:
                 php-version:
-                    - '8.1'
                     - '8.2'
+                    - '8.3'
+                    - '8.4'
                 symfony-version:
-                    - '6.2.*'
-                    - '6.4.*'
                     - '7.0.*'
-                exclude:
+                    - '7.3.*'
+                include:
                     - php-version: '8.1'
-                      symfony-version: '7.0.*'
+                      symfony-version: '6.4.*'
         steps:
             - name: Checkout
               uses: actions/checkout@v3
diff --git a/.php-version b/.php-version
@@ -0,0 +1 @@
+8.3
diff --git a/composer.json b/composer.json
@@ -12,9 +12,9 @@
     ],
     "require": {
         "php": "^8.1",
-        "behat/behat": "^3.6.1",
-        "symfony/dependency-injection": "^6.2 || ^7.0",
-        "symfony/http-kernel": "^6.2 || ^7.0"
+        "behat/behat": "^3.22",
+        "symfony/dependency-injection": "^6.4 || ^7.0",
+        "symfony/http-kernel": "^6.4 || ^7.0"
     },
     "require-dev": {
         "behat/mink-browserkit-driver": "^2.0",
@@ -24,11 +24,11 @@
         "friends-of-behat/page-object-extension": "^0.3.2",
         "friends-of-behat/service-container-extension": "^1.1",
         "sylius-labs/coding-standard": ">=4.1.1, <=4.2.1",
-        "symfony/browser-kit": "^6.2 || ^7.0",
-        "symfony/framework-bundle": "^6.2 || ^7.0",
-        "symfony/process": "^6.2 || ^7.0",
-        "symfony/yaml": "^6.2 || ^7.0",
-        "vimeo/psalm": "4.30.0"
+        "symfony/browser-kit": "^6.4 || ^7.0",
+        "symfony/framework-bundle": "^6.4 || ^7.0",
+        "symfony/process": "^6.4 || ^7.0",
+        "symfony/yaml": "^6.4 || ^7.0",
+        "vimeo/psalm": "^6.0"
     },
     "suggest": {
         "behat/mink-browserkit-driver": "^2.0",
diff --git a/psalm.xml b/psalm.xml
@@ -14,24 +14,62 @@
     </projectFiles>
 
     <issueHandlers>
-        <UndefinedClass>
-            <errorLevel type="suppress">
-                <referencedClass name="Symfony\Component\BrowserKit\AbstractBrowser" />
-                <referencedClass name="Symfony\Component\BrowserKit\Client" />
-                <referencedClass name="Symfony\Component\Routing\Loader\Configurator\RoutingConfigurator" />
-            </errorLevel>
-        </UndefinedClass>
         <InvalidAttribute>
             <errorLevel type="suppress">
                 <file name="src/Mink/MinkParameters.php" />
             </errorLevel>
         </InvalidAttribute>
 
+        <InvalidOperand>
+            <errorLevel type="suppress">
+                <file name="src/ServiceContainer/SymfonyExtension.php" />
+            </errorLevel>
+        </InvalidOperand>
+
+        <InvalidReturnStatement>
+            <errorLevel type="suppress">
+                <file name="src/Context/Environment/InitializedSymfonyExtensionEnvironment.php" />
+            </errorLevel>
+        </InvalidReturnStatement>
+
+        <InvalidReturnType>
+            <errorLevel type="suppress">
+                <file name="src/Context/Environment/InitializedSymfonyExtensionEnvironment.php" />
+            </errorLevel>
+        </InvalidReturnType>
+
+        <MissingTemplateParam>
+            <errorLevel type="suppress">
+                <file name="src/Mink/MinkParameters.php" />
+            </errorLevel>
+        </MissingTemplateParam>
+
         <!-- Workaround for https://github.com/vimeo/psalm/issues/7026 -->
         <ReservedWord>
             <errorLevel type="suppress">
                 <directory name="src" />
             </errorLevel>
         </ReservedWord>
+
+        <UndefinedClass>
+            <errorLevel type="suppress">
+                <referencedClass name="Symfony\Component\BrowserKit\AbstractBrowser" />
+                <referencedClass name="Symfony\Component\BrowserKit\Client" />
+                <referencedClass name="Symfony\Component\Routing\Loader\Configurator\RoutingConfigurator" />
+            </errorLevel>
+        </UndefinedClass>
+
+        <UndefinedInterfaceMethod>
+            <errorLevel type="suppress">
+                <file name="src/ServiceContainer/SymfonyExtension.php" />
+            </errorLevel>
+        </UndefinedInterfaceMethod>
+
+        <UnusedForeachValue>
+            <errorLevel type="suppress">
+                <file name="src/Bundle/DependencyInjection/FriendsOfBehatSymfonyExtensionExtension.php" />
+                <file name="src/ServiceContainer/SymfonyExtension.php" />
+            </errorLevel>
+        </UnusedForeachValue>
     </issueHandlers>
 </psalm>
diff --git a/src/Bundle/DependencyInjection/FriendsOfBehatSymfonyExtensionExtension.php b/src/Bundle/DependencyInjection/FriendsOfBehatSymfonyExtensionExtension.php
@@ -22,6 +22,7 @@
 
 final class FriendsOfBehatSymfonyExtensionExtension extends Extension implements CompilerPassInterface
 {
+    #[\Override]
     public function load(array $configs, ContainerBuilder $container): void
     {
         $this->provideMinkIntegration($container);
@@ -31,6 +32,7 @@ public function load(array $configs, ContainerBuilder $container): void
         $container->registerForAutoconfiguration(Context::class)->addTag('fob.context');
     }
 
+    #[\Override]
     public function process(ContainerBuilder $container): void
     {
         $this->provideBrowserKitIntegration($container);
diff --git a/src/Context/Environment/Handler/ContextServiceEnvironmentHandler.php b/src/Context/Environment/Handler/ContextServiceEnvironmentHandler.php
@@ -51,11 +51,13 @@ public function registerContextInitializer(ContextInitializer $contextInitialize
         $this->contextInitializers[] = $contextInitializer;
     }
 
+    #[\Override]
     public function supportsSuite(Suite $suite): bool
     {
         return $suite->hasSetting('contexts');
     }
 
+    #[\Override]
     public function buildEnvironment(Suite $suite): Environment
     {
         $symfonyContexts = [];
@@ -65,7 +67,6 @@ public function buildEnvironment(Suite $suite): Environment
                 continue;
             }
 
-            /** @var object $service */
             $service = $this->getContainer()->get($serviceId);
 
             $symfonyContexts[$serviceId] = get_class($service);
@@ -79,6 +80,7 @@ public function buildEnvironment(Suite $suite): Environment
         return new UninitializedSymfonyExtensionEnvironment($suite, $symfonyContexts, $delegatedEnvironment);
     }
 
+    #[\Override]
     public function supportsEnvironmentAndSubject(Environment $environment, $testSubject = null): bool
     {
         return $environment instanceof UninitializedSymfonyExtensionEnvironment;
@@ -87,6 +89,7 @@ public function supportsEnvironmentAndSubject(Environment $environment, $testSub
     /**
      * @throws EnvironmentIsolationException
      */
+    #[\Override]
     public function isolateEnvironment(Environment $environment, $testSubject = null): Environment
     {
         $this->assertEnvironmentCanBeIsolated($environment, $testSubject);
@@ -158,7 +161,12 @@ private function cloneSuiteWithoutContexts(Suite $suite, array $contextsToRemove
         return new GenericSuite($suite->getName(), array_merge($suite->getSettings(), ['contexts' => $contexts]));
     }
 
-    private function normalizeContext($context): string
+    /**
+     * @return (int|string)|false
+     *
+     * @psalm-return array-key|false
+     */
+    private function normalizeContext($context)
     {
         if (is_array($context)) {
             return current(array_keys($context));
diff --git a/src/Context/Environment/InitializedSymfonyExtensionEnvironment.php b/src/Context/Environment/InitializedSymfonyExtensionEnvironment.php
@@ -43,11 +43,13 @@ public function registerContext(Context $context): void
         $this->contexts[get_class($context)] = $context;
     }
 
+    #[\Override]
     public function getSuite(): Suite
     {
         return $this->suite;
     }
 
+    #[\Override]
     public function bindCallee(Callee $callee): callable
     {
         $callable = $callee->getCallable();
@@ -59,16 +61,24 @@ public function bindCallee(Callee $callee): callable
         return $callable;
     }
 
+    #[\Override]
     public function hasContexts(): bool
     {
         return count($this->contexts) > 0;
     }
 
+    #[\Override]
+    /**
+     * @return key-of<TArray>[]
+     *
+     * @psalm-return list<key-of<class-string-map<T as Behat\Behat\Context\Context, T:class-string-map as Behat\Behat\Context\Context>>>
+     */
     public function getContextClasses(): array
     {
         return array_keys($this->contexts);
     }
 
+    #[\Override]
     public function hasContextClass($class): bool
     {
         return isset($this->contexts[$class]);
diff --git a/src/Context/Environment/UninitializedSymfonyExtensionEnvironment.php b/src/Context/Environment/UninitializedSymfonyExtensionEnvironment.php
@@ -42,16 +42,19 @@ public function getServices(): array
         return array_keys($this->contexts);
     }
 
+    #[\Override]
     public function hasContexts(): bool
     {
         return count($this->contexts) > 0 || $this->delegatedEnvironment->hasContexts();
     }
 
+    #[\Override]
     public function getContextClasses(): array
     {
         return array_merge(array_values($this->contexts), $this->delegatedEnvironment->getContextClasses());
     }
 
+    #[\Override]
     public function hasContextClass($class): bool
     {
         return in_array($class, $this->contexts, true) || $this->delegatedEnvironment->hasContextClass($class);
diff --git a/src/Driver/Factory/SymfonyDriverFactory.php b/src/Driver/Factory/SymfonyDriverFactory.php
@@ -25,20 +25,24 @@ public function __construct(string $name, Reference $kernel)
         $this->kernel = $kernel;
     }
 
+    #[\Override]
     public function getDriverName(): string
     {
         return $this->name;
     }
 
+    #[\Override]
     public function supportsJavascript(): bool
     {
         return false;
     }
 
+    #[\Override]
     public function configure(ArrayNodeDefinition $builder): void
     {
     }
 
+    #[\Override]
     public function buildDriver(array $config): Definition
     {
         if (!class_exists(BrowserKitDriver::class)) {
diff --git a/src/Driver/SymfonyDriver.php b/src/Driver/SymfonyDriver.php
@@ -34,6 +34,7 @@ public function __construct(KernelInterface $kernel, ?string $baseUrl)
         parent::__construct($this->createBrowser(), $this->baseUrl);
     }
 
+    #[\Override]
     public function reset()
     {
         parent::reset();
@@ -61,7 +62,6 @@ public function reset()
 
     private function createBrowser(): AbstractBrowser
     {
-        /** @var object $testClient */
         $testClient = $this->kernel->getContainer()->get('test.client');
 
         if (!$testClient instanceof AbstractBrowser) {
diff --git a/src/Listener/KernelOrchestrator.php b/src/Listener/KernelOrchestrator.php
@@ -28,6 +28,7 @@ public function __construct(KernelInterface $symfonyKernel, KernelInterface $dri
         $this->behatContainer = $behatContainer;
     }
 
+    #[\Override]
     public static function getSubscribedEvents(): array
     {
         return [
diff --git a/src/Mink/Mink.php b/src/Mink/Mink.php
@@ -6,6 +6,9 @@
 
 use Behat\Mink\Mink as BaseMink;
 
+/**
+ * @deprecated use Behat\Mink\Mink instead, it will be removed on 3.0.
+ */
 class Mink extends BaseMink
 {
     /**
@@ -15,6 +18,7 @@ class Mink extends BaseMink
      * in an invalid state. Therefore, not stopping all the sessions while destructing Mink
      * saves our sanity.
      */
+    #[\Override]
     public function __destruct()
     {
         // Intentionally left empty
diff --git a/src/Mink/MinkParameters.php b/src/Mink/MinkParameters.php
@@ -17,11 +17,13 @@ public function __construct(array $minkParameters)
         $this->minkParameters = $minkParameters;
     }
 
+    #[\Override]
     public function getIterator(): \Traversable
     {
         return new \ArrayIterator($this->minkParameters);
     }
 
+    #[\Override]
     public function offsetExists($offset): bool
     {
         return array_key_exists($offset, $this->minkParameters);
@@ -30,22 +32,26 @@ public function offsetExists($offset): bool
     /**
      * @return mixed
      */
+    #[\Override]
     #[ReturnTypeWillChange]
     public function offsetGet($offset)
     {
         return $this->minkParameters[$offset] ?? null;
     }
 
+    #[\Override]
     public function offsetSet($offset, $value): void
     {
         throw new \BadMethodCallException(sprintf('"%s" is immutable.', self::class));
     }
 
+    #[\Override]
     public function offsetUnset($offset): void
     {
         throw new \BadMethodCallException(sprintf('"%s" is immutable.', self::class));
     }
 
+    #[\Override]
     public function count(): int
     {
         return count($this->minkParameters);
diff --git a/src/ServiceContainer/SymfonyExtension.php b/src/ServiceContainer/SymfonyExtension.php

Original file line number	Diff line number	Diff line change
`@@ -22,6 +22,7 @@`
`22`	`22`
`23`	`23`	`final class FriendsOfBehatSymfonyExtensionExtension extends Extension implements CompilerPassInterface`
`24`	`24`	`{`
	`25`	`+ #[\Override]`
`25`	`26`	`public function load(array $configs, ContainerBuilder $container): void`
`26`	`27`	`{`
`27`	`28`	`$this->provideMinkIntegration($container);`
`@@ -31,6 +32,7 @@ public function load(array $configs, ContainerBuilder $container): void`
`31`	`32`	`$container->registerForAutoconfiguration(Context::class)->addTag('fob.context');`
`32`	`33`	`}`
`33`	`34`
	`35`	`+ #[\Override]`
`34`	`36`	`public function process(ContainerBuilder $container): void`
`35`	`37`	`{`
`36`	`38`	`$this->provideBrowserKitIntegration($container);`
Original file line number	Diff line number	Diff line change
`@@ -51,11 +51,13 @@ public function registerContextInitializer(ContextInitializer $contextInitialize`
`51`	`51`	`$this->contextInitializers[] = $contextInitializer;`
`52`	`52`	`}`
`53`	`53`
	`54`	`+ #[\Override]`
`54`	`55`	`public function supportsSuite(Suite $suite): bool`
`55`	`56`	`{`
`56`	`57`	`return $suite->hasSetting('contexts');`
`57`	`58`	`}`
`58`	`59`
	`60`	`+ #[\Override]`
`59`	`61`	`public function buildEnvironment(Suite $suite): Environment`
`60`	`62`	`{`
`61`	`63`	`$symfonyContexts = [];`
`@@ -65,7 +67,6 @@ public function buildEnvironment(Suite $suite): Environment`
`65`	`67`	`continue;`
`66`	`68`	`}`
`67`	`69`
`68`		`- /** @var object $service */`
`69`	`70`	`$service = $this->getContainer()->get($serviceId);`
`70`	`71`
`71`	`72`	`$symfonyContexts[$serviceId] = get_class($service);`
`@@ -79,6 +80,7 @@ public function buildEnvironment(Suite $suite): Environment`
`79`	`80`	`return new UninitializedSymfonyExtensionEnvironment($suite, $symfonyContexts, $delegatedEnvironment);`
`80`	`81`	`}`
`81`	`82`
	`83`	`+ #[\Override]`
`82`	`84`	`public function supportsEnvironmentAndSubject(Environment $environment, $testSubject = null): bool`
`83`	`85`	`{`
`84`	`86`	`return $environment instanceof UninitializedSymfonyExtensionEnvironment;`
`@@ -87,6 +89,7 @@ public function supportsEnvironmentAndSubject(Environment $environment, $testSub`
`87`	`89`	`/**`
`88`	`90`	`* @throws EnvironmentIsolationException`
`89`	`91`	`*/`
	`92`	`+ #[\Override]`
`90`	`93`	`public function isolateEnvironment(Environment $environment, $testSubject = null): Environment`
`91`	`94`	`{`
`92`	`95`	`$this->assertEnvironmentCanBeIsolated($environment, $testSubject);`
`@@ -158,7 +161,12 @@ private function cloneSuiteWithoutContexts(Suite $suite, array $contextsToRemove`
`158`	`161`	`return new GenericSuite($suite->getName(), array_merge($suite->getSettings(), ['contexts' => $contexts]));`
`159`	`162`	`}`
`160`	`163`
`161`		`- private function normalizeContext($context): string`
	`164`	`+ /**`
	`165`	`+ * @return (int\|string)\|false`
	`166`	`+ *`
	`167`	`+ * @psalm-return array-key\|false`
	`168`	`+ */`
	`169`	`+ private function normalizeContext($context)`
`162`	`170`	`{`
`163`	`171`	`if (is_array($context)) {`
`164`	`172`	`return current(array_keys($context));`
Original file line number	Diff line number	Diff line change
`@@ -43,11 +43,13 @@ public function registerContext(Context $context): void`
`43`	`43`	`$this->contexts[get_class($context)] = $context;`
`44`	`44`	`}`
`45`	`45`
	`46`	`+ #[\Override]`
`46`	`47`	`public function getSuite(): Suite`
`47`	`48`	`{`
`48`	`49`	`return $this->suite;`
`49`	`50`	`}`
`50`	`51`
	`52`	`+ #[\Override]`
`51`	`53`	`public function bindCallee(Callee $callee): callable`
`52`	`54`	`{`
`53`	`55`	`$callable = $callee->getCallable();`
`@@ -59,16 +61,24 @@ public function bindCallee(Callee $callee): callable`
`59`	`61`	`return $callable;`
`60`	`62`	`}`
`61`	`63`
	`64`	`+ #[\Override]`
`62`	`65`	`public function hasContexts(): bool`
`63`	`66`	`{`
`64`	`67`	`return count($this->contexts) > 0;`
`65`	`68`	`}`
`66`	`69`
	`70`	`+ #[\Override]`
	`71`	`+ /**`
	`72`	`+ * @return key-of<TArray>[]`
	`73`	`+ *`
	`74`	`+ * @psalm-return list<key-of<class-string-map<T as Behat\Behat\Context\Context, T:class-string-map as Behat\Behat\Context\Context>>>`
	`75`	`+ */`
`67`	`76`	`public function getContextClasses(): array`
`68`	`77`	`{`
`69`	`78`	`return array_keys($this->contexts);`
`70`	`79`	`}`
`71`	`80`
	`81`	`+ #[\Override]`
`72`	`82`	`public function hasContextClass($class): bool`
`73`	`83`	`{`
`74`	`84`	`return isset($this->contexts[$class]);`
Original file line number	Diff line number	Diff line change
`@@ -42,16 +42,19 @@ public function getServices(): array`
`42`	`42`	`return array_keys($this->contexts);`
`43`	`43`	`}`
`44`	`44`
	`45`	`+ #[\Override]`
`45`	`46`	`public function hasContexts(): bool`
`46`	`47`	`{`
`47`	`48`	`return count($this->contexts) > 0 \|\| $this->delegatedEnvironment->hasContexts();`
`48`	`49`	`}`
`49`	`50`
	`51`	`+ #[\Override]`
`50`	`52`	`public function getContextClasses(): array`
`51`	`53`	`{`
`52`	`54`	`return array_merge(array_values($this->contexts), $this->delegatedEnvironment->getContextClasses());`
`53`	`55`	`}`
`54`	`56`
	`57`	`+ #[\Override]`
`55`	`58`	`public function hasContextClass($class): bool`
`56`	`59`	`{`
`57`	`60`	`return in_array($class, $this->contexts, true) \|\| $this->delegatedEnvironment->hasContextClass($class);`
Original file line number	Diff line number	Diff line change
`@@ -25,20 +25,24 @@ public function __construct(string $name, Reference $kernel)`
`25`	`25`	`$this->kernel = $kernel;`
`26`	`26`	`}`
`27`	`27`
	`28`	`+ #[\Override]`
`28`	`29`	`public function getDriverName(): string`
`29`	`30`	`{`
`30`	`31`	`return $this->name;`
`31`	`32`	`}`
`32`	`33`
	`34`	`+ #[\Override]`
`33`	`35`	`public function supportsJavascript(): bool`
`34`	`36`	`{`
`35`	`37`	`return false;`
`36`	`38`	`}`
`37`	`39`
	`40`	`+ #[\Override]`
`38`	`41`	`public function configure(ArrayNodeDefinition $builder): void`
`39`	`42`	`{`
`40`	`43`	`}`
`41`	`44`
	`45`	`+ #[\Override]`
`42`	`46`	`public function buildDriver(array $config): Definition`
`43`	`47`	`{`
`44`	`48`	`if (!class_exists(BrowserKitDriver::class)) {`
Original file line number	Diff line number	Diff line change
`@@ -34,6 +34,7 @@ public function __construct(KernelInterface $kernel, ?string $baseUrl)`
`34`	`34`	`parent::__construct($this->createBrowser(), $this->baseUrl);`
`35`	`35`	`}`
`36`	`36`
	`37`	`+ #[\Override]`
`37`	`38`	`public function reset()`
`38`	`39`	`{`
`39`	`40`	`parent::reset();`
`@@ -61,7 +62,6 @@ public function reset()`
`61`	`62`
`62`	`63`	`private function createBrowser(): AbstractBrowser`
`63`	`64`	`{`
`64`		`- /** @var object $testClient */`
`65`	`65`	`$testClient = $this->kernel->getContainer()->get('test.client');`
`66`	`66`
`67`	`67`	`if (!$testClient instanceof AbstractBrowser) {`