test with empty result cache (#482)

Author: staabm

.github/workflows/tests.yml

@@ -56,6 +56,15 @@ jobs:
             reflector: "pdo-mysql"
             mode: "replay-and-recording"
 
+          - php-version: "8.1"
+            db-image: 'mysql:8.0'
+            reflector: "pdo-mysql"
+            mode: "empty-recording"
+          - php-version: "8.1"
+            db-image: 'mysql:8.0'
+            reflector: "pdo-mysql"
+            mode: "empty-replay-and-recording"
+
     env:
       DBA_REFLECTOR: ${{ matrix.reflector }}
       DBA_MODE: ${{ matrix.mode }}

src/QueryReflection/RecordingQueryReflector.php

@@ -34,10 +34,12 @@ public function validateQueryString(string $queryString): ?Error
     {
         $error = $this->reflector->validateQueryString($queryString);
 
-        $this->reflectionCache->putValidationError(
-            $queryString,
-            $error
-        );
+        if (null !== $error) {
+            $this->reflectionCache->putValidationError(
+                $queryString,
+                $error
+            );
+        }
 
         return $error;
     }
@@ -46,11 +48,13 @@ public function getResultType(string $queryString, int $fetchType): ?Type
     {
         $resultType = $this->reflector->getResultType($queryString, $fetchType);
 
-        $this->reflectionCache->putResultType(
-            $queryString,
-            $fetchType,
-            $resultType
-        );
+        if (null !== $resultType) {
+            $this->reflectionCache->putResultType(
+                $queryString,
+                $fetchType,
+                $resultType
+            );
+        }
 
         return $resultType;
     }

src/QueryReflection/ReflectionCache.php

@@ -13,7 +13,7 @@
 
 final class ReflectionCache
 {
-    public const SCHEMA_VERSION = 'v9-put-null-when-valid';
+    public const SCHEMA_VERSION = 'v10-rework-replay';
 
     /**
      * @var string
@@ -174,11 +174,6 @@ public function persist(): void
             return;
         }
 
-        if ($this->isPHPStormSingleFileRun()) {
-            // don't overwrite reflection cache, when analyzing only a single file
-            return;
-        }
-
         try {
             flock(self::$lockHandle, LOCK_EX);
 
@@ -253,7 +248,7 @@ public function getValidationError(string $queryString): ?Error
         return $cacheEntry['error'];
     }
 
-    public function putValidationError(string $queryString, ?Error $error): void
+    public function putValidationError(string $queryString, Error $error): void
     {
         $records = $this->lazyReadRecords();
 
@@ -266,6 +261,8 @@ public function putValidationError(string $queryString, ?Error $error): void
             $this->changes[$queryString]['error'] = $this->records[$queryString]['error'] = $error;
             $this->cacheIsDirty = true;
         }
+
+        unset($this->records[$queryString]['result']);
     }
 
     /**
@@ -315,7 +312,7 @@ public function getResultType(string $queryString, int $fetchType): ?Type
     /**
      * @param QueryReflector::FETCH_TYPE* $fetchType
      */
-    public function putResultType(string $queryString, int $fetchType, ?Type $resultType): void
+    public function putResultType(string $queryString, int $fetchType, Type $resultType): void
     {
         $records = $this->lazyReadRecords();
 
@@ -334,14 +331,7 @@ public function putResultType(string $queryString, int $fetchType, ?Type $result
             $this->changes[$queryString]['result'][$fetchType] = $this->records[$queryString]['result'][$fetchType] = $resultType;
             $this->cacheIsDirty = true;
         }
-    }
-
-    private function isPHPStormSingleFileRun(): bool
-    {
-        if (!\array_key_exists('__CFBundleIdentifier', $_SERVER)) {
-            return false;
-        }
 
-        return 'com.jetbrains.PhpStorm' === $_SERVER['__CFBundleIdentifier'];
+        unset($this->records[$queryString]['error']);
     }
 }

src/QueryReflection/ReplayAndRecordingQueryReflector.php

@@ -5,7 +5,6 @@
 namespace staabm\PHPStanDba\QueryReflection;
 
 use PHPStan\Type\Type;
-use staabm\PHPStanDba\CacheNotPopulatedException;
 use staabm\PHPStanDba\DbSchema\SchemaHasherMysql;
 use staabm\PHPStanDba\Error;
 
@@ -66,11 +65,12 @@ public function validateQueryString(string $queryString): ?Error
             return $this->createRecordingReflector()->validateQueryString($queryString);
         }
 
-        try {
-            return $this->replayReflector->validateQueryString($queryString);
-        } catch (CacheNotPopulatedException $e) {
-            return $this->createRecordingReflector()->validateQueryString($queryString);
+        $error = $this->replayReflector->validateQueryString($queryString);
+        if (null !== $error) {
+            return $error;
         }
+
+        return $this->createRecordingReflector()->validateQueryString($queryString);
     }
 
     public function getResultType(string $queryString, int $fetchType): ?Type
@@ -79,11 +79,12 @@ public function getResultType(string $queryString, int $fetchType): ?Type
             return $this->createRecordingReflector()->getResultType($queryString, $fetchType);
         }
 
-        try {
-            return $this->replayReflector->getResultType($queryString, $fetchType);
-        } catch (CacheNotPopulatedException $e) {
-            return $this->createRecordingReflector()->getResultType($queryString, $fetchType);
+        $resultType = $this->replayReflector->getResultType($queryString, $fetchType);
+        if (null !== $resultType) {
+            return $resultType;
         }
+
+        return $this->createRecordingReflector()->getResultType($queryString, $fetchType);
     }
 
     public function getDatasource()

src/QueryReflection/ReplayQueryReflector.php

@@ -21,13 +21,16 @@ public function __construct(ReflectionCache $cache)
 
     public function validateQueryString(string $queryString): ?Error
     {
+        if (!$this->reflectionCache->hasValidationError($queryString)) {
+            return null;
+        }
+
         return $this->reflectionCache->getValidationError($queryString);
     }
 
     public function getResultType(string $queryString, int $fetchType): ?Type
     {
-        // queries with errors don't have a cached result type
-        if (false === $this->reflectionCache->hasResultType($queryString, $fetchType)) {
+        if (!$this->reflectionCache->hasResultType($queryString, $fetchType)) {
             return null;
         }
 

tests/ReflectorFactory.php

@@ -50,6 +50,11 @@ public static function create(string $cacheDir): QueryReflector
             $cacheFile = $cacheDir.'/.phpstan-dba-'.$reflector.'.cache';
         }
 
+        if (str_starts_with($mode, 'empty-')) {
+            file_put_contents($cacheFile, ''); // clear cache
+            $mode = substr($mode, 6);
+        }
+
         $reflectionCache = ReflectionCache::create(
             $cacheFile
         );