Don't return a metadata object unless there is explicit annotation or…

… attribute configuration, return null from decorating drivers if the driver they decorate returns null
schmittjoh · Jun 12, 2023 · 874250b · 874250b
1 parent 01e67df
commit 874250b
Show file tree

Hide file tree

Showing 6 changed files with 28 additions and 3 deletions.
diff --git a/src/Metadata/Driver/AbstractDoctrineTypeDriver.php b/src/Metadata/Driver/AbstractDoctrineTypeDriver.php
@@ -83,6 +83,11 @@ public function __construct(DriverInterface $delegate, ManagerRegistry $registry
     public function loadMetadataForClass(\ReflectionClass $class): ?BaseClassMetadata
     {
         $classMetadata = $this->delegate->loadMetadataForClass($class);
+
+        if (null === $classMetadata) {
+            return null;
+        }
+
         \assert($classMetadata instanceof ClassMetadata);
 
         // Abort if the given class is not a mapped entity

diff --git a/src/Metadata/Driver/AnnotationOrAttributeDriver.php b/src/Metadata/Driver/AnnotationOrAttributeDriver.php
@@ -70,6 +70,9 @@ public function __construct(PropertyNamingStrategyInterface $namingStrategy, ?Pa
 
     public function loadMetadataForClass(\ReflectionClass $class): ?BaseClassMetadata
     {
+        // For metadata to merge correctly, we must treat the object as configured if it has a parent class
+        $configured = $class->getParentClass() !== false;
+
         $classMetadata = new ClassMetadata($name = $class->name);
         $fileResource =  $class->getFilename();
 
@@ -86,6 +89,8 @@ public function loadMetadataForClass(\ReflectionClass $class): ?BaseClassMetadat
         $readOnlyClass = false;
 
         foreach ($this->getClassAnnotations($class) as $annot) {
+            $configured = true;
+
             if ($annot instanceof ExclusionPolicy) {
                 $exclusionPolicy = $annot->policy;
             } elseif ($annot instanceof XmlRoot) {
@@ -135,6 +140,8 @@ public function loadMetadataForClass(\ReflectionClass $class): ?BaseClassMetadat
             $methodAnnotations = $this->getMethodAnnotations($method);
 
             foreach ($methodAnnotations as $annot) {
+                $configured = true;
+
                 if ($annot instanceof PreSerialize) {
                     $classMetadata->addPreSerializeMethod(new MethodMetadata($name, $method->name));
                     continue 2;
@@ -174,6 +181,8 @@ public function loadMetadataForClass(\ReflectionClass $class): ?BaseClassMetadat
                 $propertyAnnotations = $propertiesAnnotations[$propertyKey];
 
                 foreach ($propertyAnnotations as $annot) {
+                    $configured = true;
+
                     if ($annot instanceof Since) {
                         $propertyMetadata->sinceVersion = $annot->version;
                     } elseif ($annot instanceof Until) {
@@ -274,6 +283,10 @@ public function loadMetadataForClass(\ReflectionClass $class): ?BaseClassMetadat
             }
         }
 
+        if (!$configured) {
+            return null;
+        }
+
         return $classMetadata;
     }
 

diff --git a/src/Metadata/Driver/DefaultValuePropertyDriver.php b/src/Metadata/Driver/DefaultValuePropertyDriver.php
@@ -30,12 +30,13 @@ public function __construct(DriverInterface $delegate)
     public function loadMetadataForClass(ReflectionClass $class): ?ClassMetadata
     {
         $classMetadata = $this->delegate->loadMetadataForClass($class);
-        \assert($classMetadata instanceof SerializerClassMetadata);
 
         if (null === $classMetadata) {
             return null;
         }
 
+        \assert($classMetadata instanceof SerializerClassMetadata);
+
         foreach ($classMetadata->propertyMetadata as $key => $propertyMetadata) {
             \assert($propertyMetadata instanceof PropertyMetadata);
             if (null !== $propertyMetadata->hasDefault) {

diff --git a/src/Metadata/Driver/DocBlockDriver.php b/src/Metadata/Driver/DocBlockDriver.php
@@ -45,12 +45,12 @@ public function __construct(DriverInterface $delegate, ?ParserInterface $typePar
     public function loadMetadataForClass(ReflectionClass $class): ?ClassMetadata
     {
         $classMetadata = $this->delegate->loadMetadataForClass($class);
-        \assert($classMetadata instanceof SerializerClassMetadata);
 
         if (null === $classMetadata) {
             return null;
         }
 
+        \assert($classMetadata instanceof SerializerClassMetadata);
         // We base our scan on the internal driver's property list so that we
         // respect any internal allow/blocklist like in the AnnotationDriver
         foreach ($classMetadata->propertyMetadata as $key => $propertyMetadata) {

diff --git a/src/Metadata/Driver/EnumPropertiesDriver.php b/src/Metadata/Driver/EnumPropertiesDriver.php
@@ -30,12 +30,13 @@ public function __construct(DriverInterface $delegate)
     public function loadMetadataForClass(ReflectionClass $class): ?ClassMetadata
     {
         $classMetadata = $this->delegate->loadMetadataForClass($class);
-        \assert($classMetadata instanceof SerializerClassMetadata);
 
         if (null === $classMetadata) {
             return null;
         }
 
+        \assert($classMetadata instanceof SerializerClassMetadata);
+
         // We base our scan on the internal driver's property list so that we
         // respect any internal allow/blocklist like in the AnnotationDriver
         foreach ($classMetadata->propertyMetadata as $propertyMetadata) {

diff --git a/src/Metadata/Driver/TypedPropertiesDriver.php b/src/Metadata/Driver/TypedPropertiesDriver.php
@@ -67,6 +67,11 @@ private function getDefaultWhiteList(): array
     public function loadMetadataForClass(ReflectionClass $class): ?ClassMetadata
     {
         $classMetadata = $this->delegate->loadMetadataForClass($class);
+
+        if (null === $classMetadata) {
+            return null;
+        }
+
         \assert($classMetadata instanceof SerializerClassMetadata);
 
         if (PHP_VERSION_ID <= 70400) {