make RecordingQueryReflector work, without the need to pass --debug (#95)

Co-authored-by: Markus Staab <[email protected]>

Author: staabm

README.md

@@ -165,10 +165,6 @@ If not configured otherwise, the following defaults are used:
 composer require --dev staabm/phpstan-dba
 ```
 
-## Caveats
-
-- running `RecordingQueryReflector` requires running PHPStan with `--debug` (otherwise we see concurrency issues while building the cache).
-
 ## Todos
 
 - support [more mysql to PHPStan type mappings](https://github.com/staabm/phpstan-dba/blob/b868f40c80afcecd3de408df3801b5a24e220dd8/src/QueryReflection/MysqliQueryReflector.php#L111)

composer.json

@@ -33,10 +33,10 @@
 		],
 		"phpstan-dba-baseline": [
 			"phpunit",
-			"phpstan analyse -c phpstan.neon.dist --debug"
+			"phpstan analyse -c phpstan.neon.dist"
 		],
 		"phpstan": [
-			"phpstan analyse -c phpstan.neon.dist --debug"
+			"phpstan analyse -c phpstan.neon.dist"
 		],
 		"phpunit": [
 			"phpunit"

src/QueryReflection/ReflectionCache.php

@@ -23,9 +23,19 @@ final class ReflectionCache
      */
     private $records = [];
 
+    /**
+     * @var bool
+     */
+    private $changed = false;
+
     private function __construct(string $cacheFile)
     {
         $this->cacheFile = $cacheFile;
+
+        if (!is_file($cacheFile)) {
+            // enforce file creation
+            $this->changed = true;
+        }
     }
 
     public static function create(string $cacheFile): self
@@ -51,6 +61,10 @@ public static function load(string $cacheFile): self
 
     public function persist(): void
     {
+        if (!$this->changed) {
+            return;
+        }
+
         $records = $this->records;
 
         // sort records to prevent unnecessary cache invalidation caused by different order of queries
@@ -99,6 +113,7 @@ public function putValidationError(string $queryString, ?Error $error): void
 
         $cacheEntry = &$this->records[$queryString];
         $cacheEntry['error'] = $error;
+        $this->changed = true;
     }
 
     /**
@@ -154,5 +169,6 @@ public function putResultType(string $queryString, int $fetchType, ?Type $result
         }
 
         $cacheEntry['result'][$fetchType] = $resultType;
+        $this->changed = true;
     }
 }