Fixed generation of template context signatures to avoid issues with serializing template types

Author: MartinMystikJonas

composer.json

@@ -18,7 +18,7 @@
         "phpunit/phpunit": "^9.5",
         "nette/application": "^3.1.11",
         "nette/forms": "^3.1.12",
-        "nikic/php-parser": "5.6.0",
+        "nikic/php-parser": "^5.6.0",
         "efabrica/coding-standard": "^0.7",
         "phpstan/phpstan-strict-rules": "^2.0",
         "spaze/phpstan-disallowed-calls": "^2.11|^3.0|^4.0"

phpstan.neon

@@ -205,3 +205,6 @@ parameters:
             message: '#^Parameter \#1 .* of static method .*::fromJson\(\) expects array{.*}, array.* given\.$#'
         -
             message: '#^Parameter \#1 .* of static method .*::.*FromJson\(\) expects array{.*}, array.* given\.$#'
+        -
+            message: '#^Method Efabrica\\PHPStanLatte\\Compiler\\LatteVersion::isLatte.\(\) never returns (true|false) so the return type can be changed to (true|false)\.$#'
+            reportUnmatched: false

src/Template/Component.php

@@ -9,6 +9,7 @@
 use PHPStan\PhpDoc\TypeStringResolver;
 use PHPStan\PhpDocParser\Printer\Printer;
 use PHPStan\Type\Type;
+use PHPStan\Type\VerbosityLevel;
 use ReturnTypeWillChange;
 
 final class Component implements NameTypeItem, JsonSerializable
@@ -68,6 +69,18 @@ public function withType(Type $type): self
         return $clone;
     }
 
+    public function getSignatureHash(): string
+    {
+        return md5((string)json_encode([
+          'name' => $this->name,
+          'type' => $this->type->describe(VerbosityLevel::precise()),
+          'subcomponents' => array_map(
+              static fn(Component $component): string => $component->getSignatureHash(),
+              $this->subcomponents
+          ),
+        ]));
+    }
+
     /**
      * @return array<string, mixed>
      */

src/Template/Filter.php

@@ -9,6 +9,7 @@
 use PHPStan\PhpDoc\TypeStringResolver;
 use PHPStan\PhpDocParser\Printer\Printer;
 use PHPStan\Type\Type;
+use PHPStan\Type\VerbosityLevel;
 use ReturnTypeWillChange;
 
 final class Filter implements NameTypeItem, JsonSerializable
@@ -45,6 +46,14 @@ public function withType(Type $type): self
         return $clone;
     }
 
+    public function getSignatureHash(): string
+    {
+        return md5((string)json_encode([
+          'name' => $this->name,
+          'type' => $this->type->describe(VerbosityLevel::precise()),
+        ]));
+    }
+
     #[ReturnTypeWillChange]
     public function jsonSerialize()
     {

src/Template/Form/Container.php

@@ -9,6 +9,7 @@
 use PHPStan\PhpDoc\TypeStringResolver;
 use PHPStan\PhpDocParser\Printer\Printer;
 use PHPStan\Type\Type;
+use PHPStan\Type\VerbosityLevel;
 use ReturnTypeWillChange;
 
 final class Container implements ControlHolderInterface, ControlInterface
@@ -51,6 +52,16 @@ public function withType(Type $type): self
         return $clone;
     }
 
+    public function getSignatureHash(): string
+    {
+        return md5((string)json_encode([
+            'class' => self::class,
+            'name' => $this->name,
+            'type' => $this->type->describe(VerbosityLevel::precise()),
+            'controls' => array_map(fn(ControlInterface $control) => $control->getSignatureHash(), $this->controls),
+        ]));
+    }
+
     #[ReturnTypeWillChange]
     public function jsonSerialize()
     {
@@ -63,7 +74,7 @@ public function jsonSerialize()
     }
 
     /**
-     * @param array{name: string, type: string, controls: array<array<string, mixed>>} $data
+     * @param array{name: string, type: string, controls: array<array{name: string}>} $data
      */
     public static function fromJson(array $data, TypeStringResolver $typeStringResolver): self
     {

src/Template/Form/ControlInterface.php

@@ -9,4 +9,5 @@
 
 interface ControlInterface extends NameTypeItem, JsonSerializable
 {
+    public function getSignatureHash(): string;
 }

src/Template/Form/Field.php

@@ -9,6 +9,7 @@
 use PHPStan\PhpDoc\TypeStringResolver;
 use PHPStan\PhpDocParser\Printer\Printer;
 use PHPStan\Type\Type;
+use PHPStan\Type\VerbosityLevel;
 use ReturnTypeWillChange;
 
 final class Field implements NameTypeItem, ControlInterface
@@ -62,6 +63,16 @@ public function getOptions(): ?array
         return $this->options;
     }
 
+    public function getSignatureHash(): string
+    {
+        return md5((string)json_encode([
+            'class' => self::class,
+            'name' => $this->name,
+            'type' => $this->type->describe(VerbosityLevel::precise()),
+            'options' => $this->options,
+        ]));
+    }
+
     #[ReturnTypeWillChange]
     public function jsonSerialize()
     {

src/Template/Form/Form.php

@@ -99,6 +99,16 @@ public function withType(Type $type): self
         return $clone;
     }
 
+    public function getSignatureHash(): string
+    {
+        return md5((string)json_encode([
+            'name' => $this->name,
+            'type' => TypeHelper::serializeType($this->type),
+            'controls' => array_map(fn(ControlInterface $control) => $control->getSignatureHash(), $this->controls),
+            'groups' => array_map(fn(Group $group) => $group->getSignatureHash(), $this->groups),
+        ]));
+    }
+
     #[ReturnTypeWillChange]
     public function jsonSerialize()
     {

src/Template/Form/Group.php

@@ -30,6 +30,14 @@ public function getName(): string
         return $this->name;
     }
 
+    public function getSignatureHash(): string
+    {
+        return md5((string)json_encode([
+            'name' => $this->name,
+            'controls' => array_map(fn(ControlInterface $control) => $control->getSignatureHash(), $this->controls),
+        ]));
+    }
+
     #[ReturnTypeWillChange]
     public function jsonSerialize()
     {

src/Template/Template.php

@@ -106,7 +106,13 @@ public function getParentTemplatePaths(): array
 
     public function getSignatureHash(): string
     {
-        return md5((string)json_encode($this));
+        return md5((string)json_encode([
+            'path' => $this->path,
+            'actualClass' => $this->actualClass,
+            'actualAction' => $this->actualAction,
+            'templateContext' => $this->templateContext->getSignatureHash(),
+            'parentTemplatePaths' => $this->parentTemplatePaths,
+        ]));
     }
 
     #[ReturnTypeWillChange]