Caching

Author: MartinMystikJonas

phpstan.neon

@@ -198,3 +198,7 @@ parameters:
             # present only in nette/utils 4
             message: '#^PHPDoc tag @var with type SplFileInfo is not subtype of native type Nette\\Utils\\FileInfo\.$#'
             reportUnmatched: false
+        -
+            message: '#^Parameter \#1 .* of static method .*::fromJson\(\) expects array{.*}, array.* given\.$#'
+        -
+            message: '#^Parameter \#1 .* of static method .*::.*FromJson\(\) expects array{.*}, array.* given\.$#'

src/Analyser/LatteContextAnalyser.php

@@ -204,7 +204,7 @@ private function cacheFilename(string $file): string
         return $this->tmpDir . basename($file) . '.' . $cacheKey . '.json';
     }
 
-    private function saveLatteContextDataToCache(string $file, LatteContextData $fileResult)
+    private function saveLatteContextDataToCache(string $file, LatteContextData $fileResult): void
     {
         if (!is_dir($this->tmpDir)) {
             Filesystem::createDir($this->tmpDir, 0777);
@@ -258,28 +258,47 @@ private function loadLatteContextDataFromCache(string $file): ?LatteContextData
             return null;
         }
 
+        $file = $cacheData['file'];
+        $fileHash = $cacheData['fileHash'];
+
+        if (!is_string($file) || !is_string($fileHash)) {
+            FileSystem::delete($cacheFile);
+            return null;
+        }
+
         // Check if the file has changed since the cache was created
-        if (sha1(Filesystem::read($cacheData['file'])) !== $cacheData['fileHash']) {
+        if (sha1(Filesystem::read($file)) !== $fileHash) {
             return null;
         }
 
         if (isset($cacheData['dependencies']) && is_array($cacheData['dependencies'])) {
             foreach ($cacheData['dependencies'] as $dependency) {
-                if (!isset($dependency['file'], $dependency['fileHash'])) {
+                if (!is_array($dependency) || !isset($dependency['file'], $dependency['fileHash'])) {
                     return null;
                 }
-                if (!is_file($dependency['file'])) {
+                $dependencyFile = $dependency['file'];
+                $dependencyFileHash = $dependency['fileHash'];
+                if (!is_string($dependencyFile) || !is_string($dependencyFileHash)) {
+                    return null;
+                }
+                if (!is_file($dependencyFile)) {
                     return null;
                 }
                 // Check if the dependency file has changed since the cache was created
-                if (sha1(Filesystem::read($dependency['file'])) !== $dependency['fileHash']) {
+                if (sha1(Filesystem::read($dependencyFile)) !== $dependencyFileHash) {
                     return null;
                 }
             }
         }
 
+        $data = $cacheData['data'];
+        if (!is_array($data)) {
+            FileSystem::delete($cacheFile);
+            return null;
+        }
+
         try {
-            return LatteContextData::fromJson($cacheData['data'], $this->typeStringResolver);
+            return LatteContextData::fromJson($data, $this->typeStringResolver);
         } catch (Exception) {
             FileSystem::delete($cacheFile);
             return null;

src/Analyser/LatteContextData.php

@@ -7,10 +7,12 @@
 use Efabrica\PHPStanLatte\LatteContext\CollectedData\CollectedError;
 use Efabrica\PHPStanLatte\LatteContext\CollectedData\CollectedLatteContextObject;
 use Efabrica\PHPStanLatte\LatteContext\CollectedData\CollectedRelatedFiles;
+use InvalidArgumentException;
 use JsonSerializable;
 use PHPStan\PhpDoc\TypeStringResolver;
 use PHPStan\Rules\IdentifierRuleError;
 use PHPStan\Rules\RuleErrorBuilder;
+use ReturnTypeWillChange;
 use function get_class;
 
 final class LatteContextData implements JsonSerializable
@@ -104,6 +106,10 @@ public function getRelatedFiles(): array
         return array_unique($relatedFiles);
     }
 
+    /**
+     * @return array<string, mixed>
+     */
+    #[ReturnTypeWillChange]
     public function jsonSerialize(): array
     {
         $data = [];
@@ -118,11 +124,17 @@ public function jsonSerialize(): array
         ];
     }
 
-    public static function fromJson(array $data, TypeStringResolver $typeStringResolver): self
+    /**
+     * @param array{items: array{class: class-string<CollectedLatteContextObject>, data: mixed}[]} $data
+     */
+    public static function fromJson(array $data, TypeStringResolver $typeStringResolver): static
     {
         $collectedData = [];
         foreach ($data['items'] as $item) {
             $class = $item['class'];
+            if (!class_exists($class) || !is_array($item['data'])) {
+                throw new InvalidArgumentException("Cannot deserialize collected data, class $class not found or data is not array");
+            }
             $collectedData[] = $class::fromJson($item['data'], $typeStringResolver);
         }
         return new self($collectedData, []);

src/Compiler/Compiler/Latte2Compiler.php

@@ -16,6 +16,7 @@
 
 final class Latte2Compiler extends AbstractCompiler
 {
+    /** @var string[] */
     private array $macros = [];
 
     /**
@@ -30,7 +31,7 @@ public function __construct(
         array $macros = []
     ) {
         parent::__construct($engine, $strictMode, $filters, $functions);
-        $this->marcos = $macros;
+        $this->macros = $macros;
         $this->installMacros($macros);
     }
 

src/LatteContext/CollectedData/CollectedComponent.php

@@ -10,6 +10,7 @@
 use PHPStan\Analyser\Scope;
 use PHPStan\PhpDoc\TypeStringResolver;
 use PHPStan\Type\Type;
+use ReturnTypeWillChange;
 
 final class CollectedComponent extends CollectedLatteContextObject
 {
@@ -80,6 +81,10 @@ public static function build(?Node $node, Scope $scope, string $name, Type $type
         );
     }
 
+    /**
+     * @return array<string, mixed>
+     */
+    #[ReturnTypeWillChange]
     public function jsonSerialize(): array
     {
         return [
@@ -91,14 +96,17 @@ public function jsonSerialize(): array
         ];
     }
 
-    public static function fromJson(array $data, TypeStringResolver $typeStringResolver): self
+    /**
+     * @param array{class: string, className: string, methodName: string, component: array<string, mixed>, declared: bool} $data
+     */
+    public static function fromJson(array $data, TypeStringResolver $typeStringResolver): static
     {
 
         return new self(
-            $data['className'] ?? '',
-            $data['methodName'] ?? '',
+            $data['className'],
+            $data['methodName'],
             Component::fromJson($data['component'], $typeStringResolver),
-            $data['declared'] ?? false
+            $data['declared']
         );
     }
 }

src/LatteContext/CollectedData/CollectedError.php

@@ -7,6 +7,7 @@
 use PhpParser\Node;
 use PHPStan\Analyser\Scope;
 use PHPStan\PhpDoc\TypeStringResolver;
+use ReturnTypeWillChange;
 
 final class CollectedError extends CollectedLatteContextObject
 {
@@ -47,6 +48,10 @@ public static function build(Node $node, Scope $scope, string $message): self
         );
     }
 
+    /**
+     * @return array<string, mixed>
+     */
+    #[ReturnTypeWillChange]
     public function jsonSerialize(): array
     {
         return [
@@ -56,7 +61,10 @@ public function jsonSerialize(): array
         ];
     }
 
-    public static function fromJson(array $data, TypeStringResolver $typeStringResolver): self
+    /**
+     * @param array{message: string, file: string, line?: int|null} $data
+     */
+    public static function fromJson(array $data, TypeStringResolver $typeStringResolver): static
     {
         return new self(
             $data['message'],

src/LatteContext/CollectedData/CollectedFilter.php

@@ -6,6 +6,7 @@
 
 use Efabrica\PHPStanLatte\Template\Filter;
 use PHPStan\PhpDoc\TypeStringResolver;
+use ReturnTypeWillChange;
 
 final class CollectedFilter extends CollectedLatteContextObject
 {
@@ -37,6 +38,10 @@ public function getFilter(): Filter
         return $this->filter;
     }
 
+    /**
+     * @return array<string, mixed>
+     */
+    #[ReturnTypeWillChange]
     public function jsonSerialize(): array
     {
         return [
@@ -46,7 +51,10 @@ public function jsonSerialize(): array
         ];
     }
 
-    public static function fromJson(array $data, TypeStringResolver $typeStringResolver): self
+    /**
+     * @param array{className: string, methodName: string, filter: array<string, mixed>} $data
+     */
+    public static function fromJson(array $data, TypeStringResolver $typeStringResolver): static
     {
         return new self(
             $data['className'],

src/LatteContext/CollectedData/CollectedLatteContextObject.php

@@ -5,8 +5,12 @@
 namespace Efabrica\PHPStanLatte\LatteContext\CollectedData;
 
 use JsonSerializable;
+use PHPStan\PhpDoc\TypeStringResolver;
 
 abstract class CollectedLatteContextObject implements JsonSerializable
 {
-
+    /**
+     * @param array<mixed> $data
+     */
+    abstract public static function fromJson(array $data, TypeStringResolver $typeStringResolver): static;
 }

src/LatteContext/CollectedData/CollectedMethod.php

@@ -8,6 +8,7 @@
 use PHPStan\Type\Type;
 use PHPStan\Type\TypeCombinator;
 use PHPStan\Type\VerbosityLevel;
+use ReturnTypeWillChange;
 
 final class CollectedMethod extends CollectedLatteContextObject
 {
@@ -69,6 +70,10 @@ public static function combine(string $className, string $methodName, CollectedM
         return new self($className, $methodName, $alwaysTerminated, $returnTypes ? TypeCombinator::union(...$returnTypes) : null);
     }
 
+    /**
+     * @return array<string, mixed>
+     */
+    #[ReturnTypeWillChange]
     public function jsonSerialize(): array
     {
         return [
@@ -79,7 +84,10 @@ public function jsonSerialize(): array
         ];
     }
 
-    public static function fromJson(array $data, TypeStringResolver $typeStringResolver): self
+    /**
+     * @param array{className: string, methodName: string, alwaysTerminated?: bool, returnType?: string|null} $data
+     */
+    public static function fromJson(array $data, TypeStringResolver $typeStringResolver): static
     {
         return new self(
             $data['className'],

src/LatteContext/CollectedData/CollectedMethodCall.php

@@ -9,6 +9,7 @@
 use PHPStan\Analyser\Scope;
 use PHPStan\PhpDoc\TypeStringResolver;
 use PHPStan\Reflection\ClassReflection;
+use ReturnTypeWillChange;
 
 final class CollectedMethodCall extends CollectedLatteContextObject
 {
@@ -181,6 +182,10 @@ public static function build(
         );
     }
 
+    /**
+     * @return array<string, mixed>
+     */
+    #[ReturnTypeWillChange]
     public function jsonSerialize(): array
     {
         return [
@@ -195,7 +200,10 @@ public function jsonSerialize(): array
         ];
     }
 
-    public static function fromJson(array $data, TypeStringResolver $typeStringResolver): self
+    /**
+     * @param array{callerClassName?: ?class-string, callerMethodName?: string, calledClassName?: ?class-string, calledMethodName?: string, isCalledConditionally?: bool, type?: string, params?: array<string, string|int|float|bool>, currentClassName?: ?class-string} $data
+     */
+    public static function fromJson(array $data, TypeStringResolver $typeStringResolver): static
     {
         return new self(
             $data['callerClassName'] ?? null,