Add validation for subtypes during compilation

shipmonk-rnd · Sep 9, 2024 · 25ba92c · 25ba92c
1 parent 20e366d
commit 25ba92c
Show file tree

Hide file tree

Showing 2 changed files with 27 additions and 0 deletions.
diff --git a/src/Compiler/Exception/CannotCompileMapperException.php b/src/Compiler/Exception/CannotCompileMapperException.php
@@ -5,6 +5,7 @@
 use LogicException;
 use PHPStan\PhpDocParser\Ast\Type\TypeNode;
 use ShipMonk\InputMapper\Compiler\Mapper\MapperCompiler;
+use ShipMonk\InputMapper\Compiler\Mapper\Object\MapDiscriminatedObject;
 use ShipMonk\InputMapper\Compiler\Validator\ValidatorCompiler;
 use Throwable;
 
@@ -24,6 +25,24 @@ public static function withIncompatibleMapper(
         return new self("Cannot compile mapper {$mapperCompilerClass}, because {$reason}", 0, $previous);
     }
 
+    /**
+     * @template T of object
+     * @param MapDiscriminatedObject<T> $mapperCompiler
+     */
+    public static function withIncompatibleSubtypeMapper(
+        MapDiscriminatedObject $mapperCompiler,
+        MapperCompiler $subtypeMapperCompiler,
+        ?Throwable $previous = null
+    ): self
+    {
+        $mapperOutputType = $mapperCompiler->getOutputType();
+        $subtypeMapperCompilerClass = $subtypeMapperCompiler::class;
+        $subtypeMapperOutputType = $subtypeMapperCompiler->getOutputType();
+
+        $reason = "its output type '{$subtypeMapperOutputType}' is not super type of '{$mapperOutputType}'";
+        return new self("Cannot compile mapper {$subtypeMapperCompilerClass} as subtype (#[Discriminator]) mapper, because {$reason}", 0, $previous);
+    }
+
     public static function withIncompatibleValidator(
         ValidatorCompiler $validatorCompiler,
         MapperCompiler $mapperCompiler,

diff --git a/src/Compiler/Mapper/Object/MapDiscriminatedObject.php b/src/Compiler/Mapper/Object/MapDiscriminatedObject.php
@@ -9,12 +9,14 @@
 use PHPStan\PhpDocParser\Ast\Type\IdentifierTypeNode;
 use PHPStan\PhpDocParser\Ast\Type\TypeNode;
 use ShipMonk\InputMapper\Compiler\CompiledExpr;
+use ShipMonk\InputMapper\Compiler\Exception\CannotCompileMapperException;
 use ShipMonk\InputMapper\Compiler\Mapper\GenericMapperCompiler;
 use ShipMonk\InputMapper\Compiler\Mapper\MapperCompiler;
 use ShipMonk\InputMapper\Compiler\Mapper\Scalar\MapString;
 use ShipMonk\InputMapper\Compiler\Mapper\Wrapper\MapNullable;
 use ShipMonk\InputMapper\Compiler\Php\PhpCodeBuilder;
 use ShipMonk\InputMapper\Compiler\Type\GenericTypeParameter;
+use ShipMonk\InputMapper\Compiler\Type\PhpDocTypeUtils;
 use ShipMonk\InputMapper\Runtime\Exception\MappingFailedException;
 use function array_keys;
 use function count;
@@ -43,6 +45,12 @@ public function __construct(
 
     public function compile(Expr $value, Expr $path, PhpCodeBuilder $builder): CompiledExpr
     {
+        foreach ($this->subtypeCompilers as $subtypeCompiler) {
+            if (!PhpDocTypeUtils::isSubTypeOf($subtypeCompiler->getOutputType(), $this->getOutputType())) {
+                throw CannotCompileMapperException::withIncompatibleSubtypeMapper($this, $subtypeCompiler);
+            }
+        }
+
         $statements = [
             $builder->if($builder->not($builder->funcCall($builder->importFunction('is_array'), [$value])), [
                 $builder->throw(