Queue a background job to refresh the tolerant cache if it is not expired

Author: Cyperghost

wcfsetup/install/files/lib/system/background/job/TolerantCacheRebuildBackgroundJob.class.php

@@ -2,6 +2,8 @@
 
 namespace wcf\system\background\job;
 
+use Symfony\Component\Cache\CacheItem;
+use Symfony\Contracts\Cache\ItemInterface;
 use wcf\system\cache\CacheHandler;
 use wcf\system\cache\tolerant\AbstractTolerantCache;
 
@@ -13,12 +15,17 @@
  */
 final class TolerantCacheRebuildBackgroundJob extends AbstractUniqueBackgroundJob
 {
+    private readonly ItemInterface $item;
     public function __construct(
+        /** @var ItemInterface $item */
+        ItemInterface $item,
         /** @var class-string<AbstractTolerantCache<array|object> */
         public readonly string $cacheClass,
         /** @var array<string, mixed> */
-        public readonly array $parameters = []
+        public readonly array $parameters = [],
     ) {
+        $this->item = clone $item;
+        $this->item->set(null);
     }
 
     public function identifier(): string
@@ -34,7 +41,7 @@ public function identifier(): string
     #[\Override]
     public function newInstance(): static
     {
-        return new TolerantCacheRebuildBackgroundJob($this->cacheClass, $this->parameters);
+        return new TolerantCacheRebuildBackgroundJob($this->item, $this->cacheClass, $this->parameters);
     }
 
     #[\Override]
@@ -50,11 +57,30 @@ public function perform()
             return;
         }
 
-        $asyncCache = new $this->cacheClass(...$this->parameters);
-        if (!$asyncCache->needsRebuild()) {
-            return;
-        }
+        // @see https://github.com/symfony/symfony/blob/7.2/src/Symfony/Component/Cache/Messenger/EarlyExpirationHandler.php
+
+        $startTime = microtime(true);
+
+        $tolerantCache = new $this->cacheClass(...$this->parameters);
+
+        $save = true;
+        $value = ($tolerantCache)($this->item, $save);
+
+        static $setMetadata;
+
+        $setMetadata ??= \Closure::bind(
+            function (CacheItem $item, float $startTime) {
+                if ($item->expiry > $endTime = microtime(true)) {
+                    $item->newMetadata[ItemInterface::METADATA_EXPIRY] = $item->expiry;
+                    $item->newMetadata[ItemInterface::METADATA_CTIME] = (int)ceil(1000 * ($endTime - $startTime));
+                }
+            },
+            null,
+            CacheItem::class
+        );
+
+        $setMetadata($this->item, $startTime);
 
-        $asyncCache->rebuild();
+        CacheHandler::getInstance()->getCacheAdapter()->save($this->item->set($value));
     }
 }

wcfsetup/install/files/lib/system/cache/ProxyAdapter.class.php

@@ -5,6 +5,7 @@
 use wcf\system\cache\builder\AbstractCacheBuilder;
 use wcf\system\cache\CacheHandler;
 use wcf\system\cache\ICacheCallback;
+use wcf\util\ClassUtil;
 
 /**
  * @author Olaf Braun
@@ -53,19 +54,7 @@ private function getCacheKey(): string
                 \get_class($this)
             );
 
-            $parameters = [];
-            foreach ($reflection->getProperties(\ReflectionProperty::IS_READONLY) as $property) {
-                if (!$property->isInitialized($this)) {
-                    continue;
-                }
-
-                $value = $property->getValue($this);
-                if ($value === null) {
-                    continue;
-                }
-
-                $parameters[$property->getName()] = $value;
-            }
+            $parameters = ClassUtil::getObjectProperties($this, \ReflectionProperty::IS_READONLY);
 
             if ($parameters !== []) {
                 $this->cacheName .= '-' . CacheHandler::getInstance()->getCacheIndex($parameters);

wcfsetup/install/files/lib/system/cache/eager/AbstractEagerCache.class.php

@@ -2,10 +2,12 @@
 
 namespace wcf\system\cache\tolerant;
 
-use Symfony\Contracts\Cache\CacheInterface;
+use Symfony\Contracts\Cache\ItemInterface;
+use wcf\system\background\BackgroundQueueHandler;
+use wcf\system\background\job\TolerantCacheRebuildBackgroundJob;
 use wcf\system\cache\CacheHandler;
 use wcf\system\cache\ICacheCallback;
-use wcf\system\cache\ProxyAdapter;
+use wcf\util\ClassUtil;
 
 /**
  * @author Olaf Braun
@@ -30,9 +32,26 @@ abstract class AbstractTolerantCache implements ICacheCallback
     final public function get(): array|object
     {
         if (!isset($this->cache)) {
-            $this->cache = AbstractTolerantCache::getCacheAdapter()->get(
+            $this->cache = CacheHandler::getInstance()->getCacheAdapter()->get(
                 $this->getCacheKey(),
-                $this,
+                function (ItemInterface $item, bool &$save) {
+                    if (!$item->isHit()) {
+                        return ($this)($item);
+                    }
+
+                    BackgroundQueueHandler::getInstance()->enqueueIn(
+                        new TolerantCacheRebuildBackgroundJob(
+                            $item,
+                            \get_class($this),
+                            ClassUtil::getObjectProperties($this, \ReflectionProperty::IS_READONLY)
+                        )
+                    );
+
+                    $save = false;
+
+                    return $item->get();
+                },
+                5500.0
             );
         }
 
@@ -49,7 +68,7 @@ private function getCacheKey(): string
                 \get_class($this)
             );
 
-            $parameters = $this->getProperties();
+            $parameters = ClassUtil::getObjectProperties($this, \ReflectionProperty::IS_READONLY);
 
             if ($parameters !== []) {
                 $this->cacheName .= '-' . CacheHandler::getInstance()->getCacheIndex($parameters);
@@ -58,36 +77,4 @@ private function getCacheKey(): string
 
         return $this->cacheName;
     }
-
-    private static function getCacheAdapter(): CacheInterface
-    {
-        static $cacheAdapter;
-        if (!isset($cacheAdapter)) {
-            $cacheAdapter = new ProxyAdapter(CacheHandler::getInstance()->getCacheAdapter());
-        }
-
-        return $cacheAdapter;
-    }
-
-    /**
-     * @return array<string, mixed>
-     */
-    private function getProperties(): array
-    {
-        $reflection = new \ReflectionClass($this);
-        $properties = [];
-        foreach ($reflection->getProperties(\ReflectionProperty::IS_READONLY) as $property) {
-            if (!$property->isInitialized($this)) {
-                continue;
-            }
-
-            if ($property->getValue($this) === null) {
-                continue;
-            }
-
-            $properties[$property->getName()] = $property->getValue($this);
-        }
-
-        return $properties;
-    }
 }

wcfsetup/install/files/lib/system/cache/tolerant/AbstractTolerantCache.class.php

@@ -97,6 +97,33 @@ public static function isDecoratedInstanceOf($className, $targetClass)
         return false;
     }
 
+    /**
+     * Returns the properties as a key-value array of the given object.
+     * This array doesn't contain properties with `null` as value.
+     *
+     * @param ?\ReflectionProperty::IS_* $filter
+     *
+     * @return array<string, mixed>
+     */
+    public static function getObjectProperties(object $object, ?int $filter = null): array
+    {
+        $reflection = new \ReflectionClass($object);
+        $properties = [];
+        foreach ($reflection->getProperties($filter) as $property) {
+            if (!$property->isInitialized($object)) {
+                continue;
+            }
+
+            if ($property->getValue($object) === null) {
+                continue;
+            }
+
+            $properties[$property->getName()] = $property->getValue($object);
+        }
+
+        return $properties;
+    }
+
     /**
      * Forbid creation of ClassUtil objects.
      */