Add support for union type

jtattevin · jtattevin · commit 6087c602b937 · 2024-12-17T11:32:56.000+01:00
diff --git a/src/Symfony/Component/HttpKernel/Controller/ArgumentResolver/SessionParameterValueResolver.php b/src/Symfony/Component/HttpKernel/Controller/ArgumentResolver/SessionParameterValueResolver.php
@@ -29,7 +29,13 @@ public function resolve(Request $request, ArgumentMetadata $argument): array
         }
 
         if ((!$type = $argument->getType()) || (!class_exists($type) && !interface_exists($type, false))) {
-            throw new \LogicException(\sprintf('#[MapSessionParameter] cannot be used on controller argument "$%s": "%s" is not a class or interface name.', $argument->getName(), $type));
+            if ($type && (str_contains($type, '|') || str_contains($type, '&'))) {
+                if (!$argument->hasDefaultValue() && !$argument->isNullable()) {
+                    throw new \LogicException(\sprintf('#[MapSessionParameter] cannot be used on controller argument "$%s": "%s" is an union or intersection type, you need to make the parameter nullable or provide a default value..', $argument->getName(), $type));
+                }
+            } else {
+                throw new \LogicException(\sprintf('#[MapSessionParameter] cannot be used on controller argument "$%s": "%s" is not a class or interface name.', $argument->getName(), $type));
+            }
         }
 
         if (interface_exists($type, false) && !$argument->hasDefaultValue() && !$argument->isNullable()) {
@@ -39,14 +45,21 @@ public function resolve(Request $request, ArgumentMetadata $argument): array
         $name = $attribute->name ?? $argument->getName();
         if ($request->getSession()->has($name)) {
             $value = $request->getSession()->get($name);
-            if (!$value instanceof $type) {
+            if (!$value instanceof $type && !str_contains($type, '|') && !str_contains($type, '&')) {
                 throw new \LogicException(\sprintf('#[MapSessionParameter] cannot be used to map controller argument "$%s": the session contains a value of type "%s" which is not an instance of "%s".', $argument->getName(), get_debug_type($value), $type));
             }
 
             return [$value];
         }
 
-        if (\is_object($value = $argument->hasDefaultValue() ? $argument->getDefaultValue() : new $type())) {
+        if ($argument->hasDefaultValue()) {
+            $value = $argument->getDefaultValue();
+        } else {
+            // handle the type SessionInterface|null $param, which doesn't have a default value and can't be instantiated.
+            $value = class_exists($type, false) ? new $type() : null;
+        }
+
+        if (\is_object($value)) {
             $request->getSession()->set($name, $value);
         }
 
diff --git a/src/Symfony/Component/HttpKernel/Tests/Controller/ArgumentResolver/SessionParameterValueResolverTest.php b/src/Symfony/Component/HttpKernel/Tests/Controller/ArgumentResolver/SessionParameterValueResolverTest.php
@@ -84,6 +84,16 @@ public static function invalidArgumentTypeProvider(): iterable
             new ArgumentMetadata('MySessionObject', SessionParameterInterface::class, false, false, false, attributes: [new MapSessionParameter()]),
             '#[MapSessionParameter] cannot be used on controller argument "$MySessionObject": "Symfony\Component\HttpKernel\Tests\Controller\ArgumentResolver\SessionParameterInterface" is an interface, you need to make the parameter nullable or provide a default value.',
         ];
+
+        yield 'union type' => [
+            new ArgumentMetadata('MySessionObject', BasicSessionParameter::class.'|'.EmptySessionParameter::class, false, false, false, attributes: [new MapSessionParameter()]),
+            '#[MapSessionParameter] cannot be used on controller argument "$MySessionObject": "Symfony\Component\HttpKernel\Tests\Controller\ArgumentResolver\BasicSessionParameter|Symfony\Component\HttpKernel\Tests\Controller\ArgumentResolver\EmptySessionParameter" is an union or intersection type, you need to make the parameter nullable or provide a default value.',
+        ];
+
+        yield 'intersection type' => [
+            new ArgumentMetadata('MySessionObject', BasicSessionParameter::class.'&'.EmptySessionParameter::class, false, false, false, attributes: [new MapSessionParameter()]),
+            '#[MapSessionParameter] cannot be used on controller argument "$MySessionObject": "Symfony\Component\HttpKernel\Tests\Controller\ArgumentResolver\BasicSessionParameter&Symfony\Component\HttpKernel\Tests\Controller\ArgumentResolver\EmptySessionParameter" is an union or intersection type, you need to make the parameter nullable or provide a default value.',
+        ];
     }
 
     /**
@@ -131,13 +141,37 @@ public static function validDataProvider(): iterable
             null,
         ];
         yield 'nullable interface without default value' => [
+            new ArgumentMetadata('MySessionObject', SessionParameterInterface::class, false, false, null, true, attributes: [new MapSessionParameter()]),
+            null,
+        ];
+        yield 'nullable interface defaulting to null' => [
             new ArgumentMetadata('MySessionObject', SessionParameterInterface::class, false, true, null, true, attributes: [new MapSessionParameter()]),
             null,
         ];
         yield 'interface with default value' => [
             new ArgumentMetadata('MySessionObject', SessionParameterInterface::class, false, true, new BasicSessionParameter(), false, attributes: [new MapSessionParameter()]),
             BasicSessionParameter::class,
         ];
+
+        yield 'nullable union type without default value' => [
+            new ArgumentMetadata('MySessionObject', BasicSessionParameter::class.'|'.EmptySessionParameter::class, false, true, null, attributes: [new MapSessionParameter()]),
+            null,
+        ];
+
+        yield 'nullable intersection type without default value' => [
+            new ArgumentMetadata('MySessionObject', BasicSessionParameter::class.'&'.EmptySessionParameter::class, false, true, null, attributes: [new MapSessionParameter()]),
+            null,
+        ];
+
+        yield 'union type with default value' => [
+            new ArgumentMetadata('MySessionObject', BasicSessionParameter::class.'|'.EmptySessionParameter::class, false, true, new BasicSessionParameter(), attributes: [new MapSessionParameter()]),
+            BasicSessionParameter::class,
+        ];
+
+        yield 'intersection type with default value' => [
+            new ArgumentMetadata('MySessionObject', BasicSessionParameter::class.'&'.EmptySessionParameter::class, false, true, new BasicSessionParameter(), attributes: [new MapSessionParameter()]),
+            BasicSessionParameter::class,
+        ];
     }
 
     public function testWithoutNameParameter()
@@ -188,6 +222,24 @@ public function testResolvingCorrectInterfaceSuccessfully()
         $this->assertInstanceOf(SessionParameterInterface::class, $result[0]);
     }
 
+    public function testResolvingCorrectUnionSuccessfully()
+    {
+        $this->request->getSession()->set('MySessionObject', new BasicSessionParameter());
+        $result = $this->resolver->resolve($this->request, new ArgumentMetadata('MySessionObject', SessionParameterInterface::class.'|'.EmptySessionParameter::class, false, false, false, isNullable: true, attributes: [new MapSessionParameter()]));
+
+        $this->assertCount(1, $result);
+        $this->assertInstanceOf(BasicSessionParameter::class, $result[0]);
+    }
+
+    public function testResolvingCorrectIntersectionSuccessfully()
+    {
+        $this->request->getSession()->set('MySessionObject', new BasicSessionParameter());
+        $result = $this->resolver->resolve($this->request, new ArgumentMetadata('MySessionObject', SessionParameterInterface::class.'&'.BasicSessionParameter::class, false, false, false, isNullable: true, attributes: [new MapSessionParameter()]));
+
+        $this->assertCount(1, $result);
+        $this->assertInstanceOf(BasicSessionParameter::class, $result[0]);
+    }
+
     public function testResolvingIncorrectTypeFailure()
     {
         $this->expectException(\LogicException::class);
