Expose meta on ResourceCheckerConfigCache / ConfigCacheInterface

ruudk · ruudk · commit 87e083f484aa · 2023-10-14T13:42:04.000+02:00
When a developer adds meta to a config cache, it should also be possible to get back the meta.

I use these config caches for my own framework and want to retrieve a specific meta associated to
the cache.
diff --git a/src/Symfony/Component/Config/CHANGELOG.md b/src/Symfony/Component/Config/CHANGELOG.md
@@ -1,6 +1,11 @@
 CHANGELOG
 =========
 
+6.4
+---
+
+ * Added method `getMeta()` to ResourceCheckerConfigCache and ConfigCacheInterface
+
 6.3
 ---
 
diff --git a/src/Symfony/Component/Config/ConfigCacheInterface.php b/src/Symfony/Component/Config/ConfigCacheInterface.php
@@ -44,4 +44,11 @@ public function isFresh(): bool;
      * @throws \RuntimeException When the cache file cannot be written
      */
     public function write(string $content, array $metadata = null);
+
+    /**
+     * Returns the metadata stored for this cache.
+     *
+     * @return ResourceInterface[]
+     */
+    //public function getMeta() : false | array;
 }
diff --git a/src/Symfony/Component/Config/ResourceCheckerConfigCache.php b/src/Symfony/Component/Config/ResourceCheckerConfigCache.php
@@ -68,13 +68,7 @@ public function isFresh(): bool
             return true; // shortcut - if we don't have any checkers we don't need to bother with the meta file at all
         }
 
-        $metadata = $this->getMetaFile();
-
-        if (!is_file($metadata)) {
-            return false;
-        }
-
-        $meta = $this->safelyUnserialize($metadata);
+        $meta = $this->getMeta();
 
         if (false === $meta) {
             return false;
@@ -135,6 +129,22 @@ public function write(string $content, array $metadata = null)
         }
     }
 
+    /**
+     * Returns the metadata stored for this cache.
+     *
+     * @return ResourceInterface[]
+     */
+    public function getMeta() : false | array
+    {
+        $metadata = $this->getMetaFile();
+
+        if (!is_file($metadata)) {
+            return false;
+        }
+
+        return $this->safelyUnserialize($metadata);
+    }
+
     /**
      * Gets the meta file path.
      */
diff --git a/src/Symfony/Component/Config/Tests/ResourceCheckerConfigCacheTest.php b/src/Symfony/Component/Config/Tests/ResourceCheckerConfigCacheTest.php
@@ -148,4 +148,14 @@ public function testCacheIsNotFreshIfNotExistsMetaFile()
 
         $this->assertFalse($cache->isFresh());
     }
+
+    public function testGetMeta()
+    {
+        $checker = $this->createMock(ResourceCheckerInterface::class);
+        $cache = new ResourceCheckerConfigCache($this->cacheFile, [$checker]);
+        $cache->write('foo', [new FileResource(__FILE__)]);
+
+        $this->assertCount(1, $cache->getMeta());
+        $this->assertEquals(new FileResource(__FILE__), $cache->getMeta()[0]);
+    }
 }

Original file line number	Diff line number	Diff line change
`@@ -148,4 +148,14 @@ public function testCacheIsNotFreshIfNotExistsMetaFile()`
`148`	`148`
`149`	`149`	`$this->assertFalse($cache->isFresh());`
`150`	`150`	`}`
	`151`	`+`
	`152`	`+ public function testGetMeta()`
	`153`	`+ {`
	`154`	`+ $checker = $this->createMock(ResourceCheckerInterface::class);`
	`155`	`+ $cache = new ResourceCheckerConfigCache($this->cacheFile, [$checker]);`
	`156`	`+ $cache->write('foo', [new FileResource(__FILE__)]);`
	`157`	`+`
	`158`	`+ $this->assertCount(1, $cache->getMeta());`
	`159`	`+ $this->assertEquals(new FileResource(__FILE__), $cache->getMeta()[0]);`
	`160`	`+ }`
`151`	`161`	`}`