[Config] Generate a meta file in JSON format for resource tracking

Author: nicolas-grekas

CHANGELOG.md

@@ -5,6 +5,8 @@ CHANGELOG
 ---
 
  * Add `#[WhenNot]` attribute to prevent service from being registered in a specific environment
+ * Generate a meta file in JSON format for resource tracking
+ * Add `SkippingResourceChecker`
 
 7.1
 ---

ConfigCache.php

@@ -11,7 +11,9 @@
 
 namespace Symfony\Component\Config;
 
+use Symfony\Component\Config\Resource\ResourceInterface;
 use Symfony\Component\Config\Resource\SelfCheckingResourceChecker;
+use Symfony\Component\Config\Resource\SkippingResourceChecker;
 
 /**
  * ConfigCache caches arbitrary content in files on disk.
@@ -26,18 +28,23 @@
 class ConfigCache extends ResourceCheckerConfigCache
 {
     /**
-     * @param string      $file     The absolute cache path
-     * @param bool        $debug    Whether debugging is enabled or not
-     * @param string|null $metaFile The absolute path to the meta file
+     * @param string                                 $file                 The absolute cache path
+     * @param bool                                   $debug                Whether debugging is enabled or not
+     * @param string|null                            $metaFile             The absolute path to the meta file
+     * @param class-string<ResourceInterface>[]|null $skippedResourceTypes
      */
     public function __construct(
         string $file,
         private bool $debug,
         ?string $metaFile = null,
+        array|null $skippedResourceTypes = null,
     ) {
         $checkers = [];
-        if (true === $this->debug) {
-            $checkers = [new SelfCheckingResourceChecker()];
+        if ($this->debug) {
+            if (null !== $skippedResourceTypes) {
+                $checkers[] = new SkippingResourceChecker($skippedResourceTypes);
+            }
+            $checkers[] = new SelfCheckingResourceChecker();
         }
 
         parent::__construct($file, $checkers, $metaFile);

Resource/SkippingResourceChecker.php

@@ -0,0 +1,37 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Config\Resource;
+
+use Symfony\Component\Config\ResourceCheckerInterface;
+
+class SkippingResourceChecker implements ResourceCheckerInterface
+{
+    private array $skippedResourceTypes;
+
+    /**
+     * @param class-string<ResourceInterface>[] $skippedResourceTypes
+     */
+    public function __construct(array $skippedResourceTypes = [])
+    {
+        $this->skippedResourceTypes = array_flip($skippedResourceTypes);
+    }
+
+    public function supports(ResourceInterface $metadata): bool
+    {
+        return !$this->skippedResourceTypes || isset($this->skippedResourceTypes[$metadata::class]);
+    }
+
+    public function isFresh(ResourceInterface $resource, int $timestamp): bool
+    {
+        return true;
+    }
+}

ResourceCheckerConfigCache.php

@@ -118,12 +118,26 @@ public function write(string $content, ?array $metadata = null): void
         }
 
         if (null !== $metadata) {
-            $filesystem->dumpFile($this->metaFile, serialize($metadata));
+            $filesystem->dumpFile($this->metaFile, $ser = serialize($metadata));
             try {
                 $filesystem->chmod($this->metaFile, $mode, $umask);
             } catch (IOException) {
                 // discard chmod failure (some filesystem may not support it)
             }
+
+            $ser = preg_replace_callback('/;O:(\d+):"/', static fn ($m) => ';O:'.(9 + $m[1]).':"Tracking\\', $ser);
+            $ser = preg_replace_callback('/s:(\d+):"\0[^\0]++\0/', static fn ($m) => 's:'.($m[1] - \strlen($m[0]) + 6).':"', $ser);
+            $ser = unserialize($ser);
+            $ser = @json_encode($ser) ?: [];
+            $ser = str_replace('"__PHP_Incomplete_Class_Name":"Tracking\\\\', '"@type":"', $ser);
+            $ser = \sprintf('{"resources":%s}', $ser);
+
+            $filesystem->dumpFile($this->metaFile.'.json', $ser);
+            try {
+                $filesystem->chmod($this->metaFile.'.json', $mode, $umask);
+            } catch (IOException) {
+                // discard chmod failure (some filesystem may not support it)
+            }
         }
 
         if (\function_exists('opcache_invalidate') && filter_var(\ini_get('opcache.enable'), \FILTER_VALIDATE_BOOL)) {

Tests/ResourceCheckerConfigCacheTest.php

@@ -30,7 +30,7 @@ protected function setUp(): void
 
     protected function tearDown(): void
     {
-        $files = [$this->cacheFile, "{$this->cacheFile}.meta", $this->metaFile];
+        $files = [$this->cacheFile, $this->cacheFile.'.meta', $this->cacheFile.'.meta.json', $this->metaFile, $this->metaFile.'.json'];
 
         foreach ($files as $file) {
             if (file_exists($file)) {
@@ -160,5 +160,14 @@ public function testCacheWithCustomMetaFile()
         $cache->write('foo', [new FileResource(__FILE__)]);
 
         $this->assertStringNotEqualsFile($this->metaFile, '');
+
+        $this->assertStringEqualsFile($this->metaFile.'.json', json_encode([
+            'resources' => [
+                [
+                    '@type' => FileResource::class,
+                    'resource' => __FILE__,
+                ],
+            ],
+        ]));
     }
 }