Add nullable information to Subscriber ArgumentMetadata

fritz-gerneth · fritz-gerneth · commit c2f249b806d7 · 2026-02-10T09:56:13.000Z
diff --git a/phpstan-baseline.neon b/phpstan-baseline.neon
@@ -463,7 +463,7 @@ parameters:
 			path: tests/Unit/Message/Translator/ReplaceEventTranslatorTest.php
 
 		-
-			message: '#^Method class@anonymous/tests/Unit/Metadata/Subscriber/AttributeSubscriberMetadataFactoryTest\.php\:212\:\:profileVisited\(\) has parameter \$message with no type specified\.$#'
+			message: '#^Method class@anonymous/tests/Unit/Metadata/Subscriber/AttributeSubscriberMetadataFactoryTest\.php\:237\:\:profileVisited\(\) has parameter \$message with no type specified\.$#'
 			identifier: missingType.parameter
 			count: 1
 			path: tests/Unit/Metadata/Subscriber/AttributeSubscriberMetadataFactoryTest.php
diff --git a/src/Metadata/Subscriber/ArgumentMetadata.php b/src/Metadata/Subscriber/ArgumentMetadata.php
@@ -9,6 +9,7 @@ final class ArgumentMetadata
     public function __construct(
         public readonly string $name,
         public readonly string $type,
+        public readonly bool $allowsNull = false,
     ) {
     }
 }
diff --git a/src/Metadata/Subscriber/AttributeSubscriberMetadataFactory.php b/src/Metadata/Subscriber/AttributeSubscriberMetadataFactory.php
@@ -151,6 +151,7 @@ private function subscribeMethod(ReflectionMethod $method): SubscribeMethodMetad
             $arguments[] = new ArgumentMetadata(
                 $parameter->getName(),
                 $type->getName(),
+                $parameter->allowsNull(),
             );
         }
 
diff --git a/tests/Unit/Metadata/Subscriber/AttributeSubscriberMetadataFactoryTest.php b/tests/Unit/Metadata/Subscriber/AttributeSubscriberMetadataFactoryTest.php
@@ -191,13 +191,38 @@ public function profileCreated(ProfileCreated $profileCreated, string $aggregate
             [
                 ProfileVisited::class => [
                     new SubscribeMethodMetadata('profileVisited', [
-                        new ArgumentMetadata('message', Message::class),
+                        new ArgumentMetadata('message', Message::class, false),
                     ]),
                 ],
                 ProfileCreated::class => [
                     new SubscribeMethodMetadata('profileCreated', [
-                        new ArgumentMetadata('profileCreated', ProfileCreated::class),
-                        new ArgumentMetadata('aggregateId', 'string'),
+                        new ArgumentMetadata('profileCreated', ProfileCreated::class, false),
+                        new ArgumentMetadata('aggregateId', 'string', false),
+                    ]),
+                ],
+            ],
+            $metadata->subscribeMethods,
+        );
+    }
+
+    public function testSubscribeNullableAttribute(): void
+    {
+        $subscriber = new #[Subscriber('foo', RunMode::FromBeginning)]
+        class {
+            #[Subscribe(ProfileVisited::class)]
+            public function profileVisited(ProfileVisited|null $message): void
+            {
+            }
+        };
+
+        $metadataFactory = new AttributeSubscriberMetadataFactory();
+        $metadata = $metadataFactory->metadata($subscriber::class);
+
+        self::assertEquals(
+            [
+                ProfileVisited::class => [
+                    new SubscribeMethodMetadata('profileVisited', [
+                        new ArgumentMetadata('message', ProfileVisited::class, true),
                     ]),
                 ],
             ],
diff --git a/tests/Unit/Subscription/Subscriber/ArgumentResolver/AggregateIdArgumentResolverTest.php b/tests/Unit/Subscription/Subscriber/ArgumentResolver/AggregateIdArgumentResolverTest.php
@@ -26,21 +26,21 @@ public function testSupport(): void
 
         self::assertTrue(
             $resolver->support(
-                new ArgumentMetadata('aggregateId', Uuid::class),
+                new ArgumentMetadata('aggregateId', Uuid::class, false),
                 ProfileCreated::class,
             ),
         );
 
         self::assertTrue(
             $resolver->support(
-                new ArgumentMetadata('aggregateRootId', ProfileId::class),
+                new ArgumentMetadata('aggregateRootId', ProfileId::class, false),
                 ProfileCreated::class,
             ),
         );
 
         self::assertFalse(
             $resolver->support(
-                new ArgumentMetadata('foo', ProfileCreated::class),
+                new ArgumentMetadata('foo', ProfileCreated::class, false),
                 ProfileCreated::class,
             ),
         );
@@ -58,7 +58,7 @@ public function testResolve(): void
         self::assertEquals(
             new CustomId('bar'),
             $resolver->resolve(
-                new ArgumentMetadata('foo', CustomId::class),
+                new ArgumentMetadata('foo', CustomId::class, false),
                 $message,
             ),
         );
diff --git a/tests/Unit/Subscription/Subscriber/ArgumentResolver/EventArgumentResolverTest.php b/tests/Unit/Subscription/Subscriber/ArgumentResolver/EventArgumentResolverTest.php
@@ -22,14 +22,14 @@ public function testSupport(): void
 
         self::assertTrue(
             $resolver->support(
-                new ArgumentMetadata('foo', ProfileCreated::class),
+                new ArgumentMetadata('foo', ProfileCreated::class, false),
                 ProfileCreated::class,
             ),
         );
 
         self::assertFalse(
             $resolver->support(
-                new ArgumentMetadata('foo', ProfileVisited::class),
+                new ArgumentMetadata('foo', ProfileVisited::class, false),
                 ProfileCreated::class,
             ),
         );
@@ -45,7 +45,7 @@ public function testResolve(): void
         self::assertSame(
             $event,
             $resolver->resolve(
-                new ArgumentMetadata('foo', ProfileVisited::class),
+                new ArgumentMetadata('foo', ProfileVisited::class, false),
                 $message,
             ),
         );
diff --git a/tests/Unit/Subscription/Subscriber/ArgumentResolver/LookupResolverTest.php b/tests/Unit/Subscription/Subscriber/ArgumentResolver/LookupResolverTest.php
@@ -32,14 +32,14 @@ public function testSupport(): void
 
         self::assertTrue(
             $resolver->support(
-                new ArgumentMetadata('lookup', Lookup::class),
+                new ArgumentMetadata('lookup', Lookup::class, false),
                 ProfileCreated::class,
             ),
         );
 
         self::assertFalse(
             $resolver->support(
-                new ArgumentMetadata('foo', ProfileCreated::class),
+                new ArgumentMetadata('foo', ProfileCreated::class, false),
                 ProfileCreated::class,
             ),
         );
@@ -61,7 +61,7 @@ public function testResolve(): void
         );
 
         $lookup = $resolver->resolve(
-            new ArgumentMetadata('foo', Lookup::class),
+            new ArgumentMetadata('foo', Lookup::class, false),
             $message,
         );
 
diff --git a/tests/Unit/Subscription/Subscriber/ArgumentResolver/MessageArgumentResolverTest.php b/tests/Unit/Subscription/Subscriber/ArgumentResolver/MessageArgumentResolverTest.php
@@ -20,14 +20,14 @@ public function testSupport(): void
 
         self::assertTrue(
             $resolver->support(
-                new ArgumentMetadata('foo', Message::class),
+                new ArgumentMetadata('foo', Message::class, false),
                 'qux',
             ),
         );
 
         self::assertFalse(
             $resolver->support(
-                new ArgumentMetadata('foo', 'bar'),
+                new ArgumentMetadata('foo', 'bar', false),
                 'qux',
             ),
         );
@@ -41,7 +41,7 @@ public function testResolve(): void
         self::assertSame(
             $message,
             $resolver->resolve(
-                new ArgumentMetadata('foo', Message::class),
+                new ArgumentMetadata('foo', Message::class, false),
                 $message,
             ),
         );
diff --git a/tests/Unit/Subscription/Subscriber/ArgumentResolver/RecordedOnArgumentResolverTest.php b/tests/Unit/Subscription/Subscriber/ArgumentResolver/RecordedOnArgumentResolverTest.php
@@ -23,14 +23,14 @@ public function testSupport(): void
 
         self::assertTrue(
             $resolver->support(
-                new ArgumentMetadata('foo', DateTimeImmutable::class),
+                new ArgumentMetadata('foo', DateTimeImmutable::class, false),
                 'qux',
             ),
         );
 
         self::assertFalse(
             $resolver->support(
-                new ArgumentMetadata('foo', 'bar'),
+                new ArgumentMetadata('foo', 'bar', false),
                 'qux',
             ),
         );
@@ -53,7 +53,7 @@ public function testResolveFromAggregateHeader(): void
         self::assertSame(
             $date,
             $resolver->resolve(
-                new ArgumentMetadata('foo', DateTimeImmutable::class),
+                new ArgumentMetadata('foo', DateTimeImmutable::class, false),
                 $message,
             ),
         );
@@ -69,7 +69,7 @@ public function testResolveFromRecordedOnHeader(): void
         self::assertSame(
             $date,
             $resolver->resolve(
-                new ArgumentMetadata('foo', DateTimeImmutable::class),
+                new ArgumentMetadata('foo', DateTimeImmutable::class, false),
                 $message,
             ),
         );

Original file line number	Diff line number	Diff line change
`@@ -463,7 +463,7 @@ parameters:`
`463`	`463`	`path: tests/Unit/Message/Translator/ReplaceEventTranslatorTest.php`
`464`	`464`
`465`	`465`	`-`
`466`		`- message: '#^Method class@anonymous/tests/Unit/Metadata/Subscriber/AttributeSubscriberMetadataFactoryTest\.php\:212\:\:profileVisited\(\) has parameter \$message with no type specified\.$#'`
	`466`	`+ message: '#^Method class@anonymous/tests/Unit/Metadata/Subscriber/AttributeSubscriberMetadataFactoryTest\.php\:237\:\:profileVisited\(\) has parameter \$message with no type specified\.$#'`
`467`	`467`	`identifier: missingType.parameter`
`468`	`468`	`count: 1`
`469`	`469`	`path: tests/Unit/Metadata/Subscriber/AttributeSubscriberMetadataFactoryTest.php`
Original file line number	Diff line number	Diff line change
`@@ -9,6 +9,7 @@ final class ArgumentMetadata`
`9`	`9`	`public function __construct(`
`10`	`10`	`public readonly string $name,`
`11`	`11`	`public readonly string $type,`
	`12`	`+ public readonly bool $allowsNull = false,`
`12`	`13`	`) {`
`13`	`14`	`}`
`14`	`15`	`}`
Original file line number	Diff line number	Diff line change
`@@ -151,6 +151,7 @@ private function subscribeMethod(ReflectionMethod $method): SubscribeMethodMetad`
`151`	`151`	`$arguments[] = new ArgumentMetadata(`
`152`	`152`	`$parameter->getName(),`
`153`	`153`	`$type->getName(),`
	`154`	`+ $parameter->allowsNull(),`
`154`	`155`	`);`
`155`	`156`	`}`
`156`	`157`