Merge pull request #56 from patchlevel/class-not-found-exception

throw exception if class not found
patchlevel · Oct 15, 2024 · b2cc966 · b2cc966
2 parents b8951b3 + 8f50b95
commit b2cc966
Show file tree

Hide file tree

Showing 10 changed files with 95 additions and 3 deletions.
diff --git a/baseline.xml b/baseline.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<files psalm-version="5.23.1@8471a896ccea3526b26d082f4461eeea467f10a4">
+<files psalm-version="5.26.1@d747f6500b38ac4f7dfc5edbcae6e4b637d7add0">
   <file src="src/Cryptography/Cipher/OpensslCipherKeyFactory.php">
     <ArgumentTypeCoercion>
       <code><![CDATA[openssl_random_pseudo_bytes($this->ivLength)]]></code>
@@ -45,4 +45,20 @@
       <code><![CDATA[$return]]></code>
     </MixedAssignment>
   </file>
+  <file src="tests/Unit/Metadata/AttributeMetadataFactoryTest.php">
+    <ArgumentTypeCoercion>
+      <code><![CDATA['Unknown']]></code>
+    </ArgumentTypeCoercion>
+    <UndefinedClass>
+      <code><![CDATA['Unknown']]></code>
+    </UndefinedClass>
+  </file>
+  <file src="tests/Unit/MetadataHydratorTest.php">
+    <ArgumentTypeCoercion>
+      <code><![CDATA['Unknown']]></code>
+    </ArgumentTypeCoercion>
+    <UndefinedClass>
+      <code><![CDATA['Unknown']]></code>
+    </UndefinedClass>
+  </file>
 </files>
diff --git a/phpstan-baseline.neon b/phpstan-baseline.neon
@@ -15,6 +15,11 @@ parameters:
 			count: 1
 			path: src/Cryptography/PersonalDataPayloadCryptographer.php
 
+		-
+			message: "#^Dead catch \\- ReflectionException is never thrown in the try block\\.$#"
+			count: 1
+			path: src/Metadata/AttributeMetadataFactory.php
+
 		-
 			message: "#^Property Patchlevel\\\\Hydrator\\\\Metadata\\\\ClassMetadata\\<T of object\\>\\:\\:\\$reflection \\(ReflectionClass\\<T of object\\>\\) does not accept ReflectionClass\\<object\\>\\.$#"
 			count: 1

diff --git a/src/ClassNotSupported.php b/src/ClassNotSupported.php
@@ -0,0 +1,19 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Patchlevel\Hydrator;
+
+use RuntimeException;
+use Throwable;
+
+use function sprintf;
+
+final class ClassNotSupported extends RuntimeException implements HydratorException
+{
+    /** @param class-string $className */
+    public function __construct(string $className, Throwable|null $previous = null)
+    {
+        parent::__construct(sprintf('Class %s not supported', $className), 0, $previous);
+    }
+}
diff --git a/src/Hydrator.php b/src/Hydrator.php
@@ -12,6 +12,8 @@ interface Hydrator
      *
      * @return T
      *
+     * @throws ClassNotSupported if the class is not supported or not found.
+     *
      * @template T of object
      */
     public function hydrate(string $class, array $data): object;

diff --git a/src/Metadata/AttributeMetadataFactory.php b/src/Metadata/AttributeMetadataFactory.php
@@ -22,6 +22,7 @@
 use Patchlevel\Hydrator\Normalizer\ReflectionTypeAwareNormalizer;
 use ReflectionAttribute;
 use ReflectionClass;
+use ReflectionException;
 use ReflectionNamedType;
 use ReflectionProperty;
 
@@ -52,7 +53,11 @@ public function metadata(string $class): ClassMetadata
             return $classMetadata;
         }
 
-        $reflectionClass = new ReflectionClass($class);
+        try {
+            $reflectionClass = new ReflectionClass($class);
+        } catch (ReflectionException) {
+            throw new ClassNotFound($class);
+        }
 
         $classMetadata = $this->getClassMetadata($reflectionClass);
 

diff --git a/src/Metadata/ClassNotFound.php b/src/Metadata/ClassNotFound.php
@@ -0,0 +1,18 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Patchlevel\Hydrator\Metadata;
+
+use RuntimeException;
+
+use function sprintf;
+
+final class ClassNotFound extends RuntimeException implements MetadataException
+{
+    /** @param class-string $className */
+    public function __construct(string $className)
+    {
+        parent::__construct(sprintf('Class %s not found', $className));
+    }
+}
diff --git a/src/Metadata/MetadataFactory.php b/src/Metadata/MetadataFactory.php
@@ -11,6 +11,8 @@ interface MetadataFactory
      *
      * @return ClassMetadata<T>
      *
+     * @throws ClassNotFound if the class does not exist.
+     *
      * @template T of object
      */
     public function metadata(string $class): ClassMetadata;

diff --git a/src/MetadataHydrator.php b/src/MetadataHydrator.php
@@ -7,6 +7,7 @@
 use Patchlevel\Hydrator\Cryptography\PayloadCryptographer;
 use Patchlevel\Hydrator\Metadata\AttributeMetadataFactory;
 use Patchlevel\Hydrator\Metadata\ClassMetadata;
+use Patchlevel\Hydrator\Metadata\ClassNotFound;
 use Patchlevel\Hydrator\Metadata\MetadataFactory;
 use Patchlevel\Hydrator\Normalizer\HydratorAwareNormalizer;
 use ReflectionParameter;
@@ -39,7 +40,11 @@ public function __construct(
      */
     public function hydrate(string $class, array $data): object
     {
-        $metadata = $this->metadataFactory->metadata($class);
+        try {
+            $metadata = $this->metadataFactory->metadata($class);
+        } catch (ClassNotFound $e) {
+            throw new ClassNotSupported($class, $e);
+        }
 
         if ($this->cryptographer) {
             $data = $this->cryptographer->decrypt($metadata, $data);

diff --git a/tests/Unit/Metadata/AttributeMetadataFactoryTest.php b/tests/Unit/Metadata/AttributeMetadataFactoryTest.php
@@ -10,6 +10,7 @@
 use Patchlevel\Hydrator\Attribute\PostHydrate;
 use Patchlevel\Hydrator\Attribute\PreExtract;
 use Patchlevel\Hydrator\Metadata\AttributeMetadataFactory;
+use Patchlevel\Hydrator\Metadata\ClassNotFound;
 use Patchlevel\Hydrator\Metadata\DuplicatedFieldNameInMetadata;
 use Patchlevel\Hydrator\Metadata\MissingDataSubjectId;
 use Patchlevel\Hydrator\Metadata\MultipleDataSubjectId;
@@ -77,6 +78,14 @@ public function testWithProperties(): void
         self::assertNull($propertyMetadata->normalizer());
     }
 
+    public function testUnknownClass(): void
+    {
+        $this->expectException(ClassNotFound::class);
+
+        $metadataFactory = new AttributeMetadataFactory();
+        $metadataFactory->metadata('Unknown');
+    }
+
     public function testSkipStaticProperties(): void
     {
         $object = new class {

diff --git a/tests/Unit/MetadataHydratorTest.php b/tests/Unit/MetadataHydratorTest.php
@@ -8,6 +8,7 @@
 use DateTimeImmutable;
 use DateTimeZone;
 use Patchlevel\Hydrator\CircularReference;
+use Patchlevel\Hydrator\ClassNotSupported;
 use Patchlevel\Hydrator\Cryptography\PayloadCryptographer;
 use Patchlevel\Hydrator\DenormalizationFailure;
 use Patchlevel\Hydrator\Metadata\AttributeMetadataFactory;
@@ -139,6 +140,16 @@ public function testHydrate(): void
         self::assertEquals($expected, $event);
     }
 
+    public function testHydrateUnknownClass(): void
+    {
+        $this->expectException(ClassNotSupported::class);
+
+        $this->hydrator->hydrate(
+            'Unknown',
+            ['profileId' => '1', 'email' => '[email protected]'],
+        );
+    }
+
     public function testHydrateWithDefaults(): void
     {
         $object = $this->hydrator->hydrate(