Feat: Add support for cache key specifier (#5)

Author: RikudouSage

README.md

@@ -189,6 +189,12 @@ cache for your application.
 If the `default_memoize_seconds` is set to `-1` this config is ignored and a default in-memory implementation
 is used (service `rikudou.memoize.internal_cache`, class [`InMemoryCachePool`](src/Cache/InMemoryCachePool.php)).
 
+### key_specifier_service
+
+This parameter allows you to specify a service that will alter the cache key. This is useful if your app relies on
+some kind of global state (like currently authenticated user etc.). It must implement the
+[CacheKeySpecifier](src/Cache/KeySpecifier/CacheKeySpecifier.php) interface.
+
 ### Default configuration
 
 Generated by `php bin/console config:dump rikudou_memoize`
@@ -205,6 +211,9 @@ rikudou_memoize:
 
   # The default cache service to use. If default_memoize_seconds is set to -1 this setting is ignored and internal service is used.
   cache_service:        cache.app
+
+  # The service to use to alter the cache key. Useful if you need to alter the cache key based on some global state.
+  key_specifier_service: rikudou.memoize.key_specifier.null
 ```
 
 ## Example proxy class
@@ -258,18 +267,20 @@ class Calculator implements CalculatorInterface
 
 namespace App\Memoized;
 
-final class Calculator_Proxy_97bcf9ddeba8fffab6ecd550cf2ea6d6 implements \App\Service\CalculatorInterface
+final class Calculator_Proxy_422705a42881a5490e7996fe93245734 implements \App\Service\CalculatorInterface
 {
 	public function __construct(
 		private readonly \App\Service\Calculator $original,
 		private readonly \Psr\Cache\CacheItemPoolInterface $cache,
 		private readonly \Rikudou\MemoizeBundle\Cache\InMemoryCachePool $internalCache,
+		private readonly \Rikudou\MemoizeBundle\Cache\KeySpecifier\CacheKeySpecifier $cacheKeySpecifier,
 	) {}
 
 	public function add(int $a, int $b): int {
 		$cacheKey = '';
 		$cacheKey .= serialize($a);
 		$cacheKey .= serialize($b);
+		$cacheKey .= $this->cacheKeySpecifier->generate();
 		$cacheKey = hash('sha512', $cacheKey);
 		$cacheKey = "rikudou_memoize_AppServiceCalculator_add_{$cacheKey}";
 
@@ -288,6 +299,7 @@ final class Calculator_Proxy_97bcf9ddeba8fffab6ecd550cf2ea6d6 implements \App\Se
 		$cacheKey = '';
 		$cacheKey .= serialize($a);
 		$cacheKey .= serialize($b);
+		$cacheKey .= $this->cacheKeySpecifier->generate();
 		$cacheKey = hash('sha512', $cacheKey);
 		$cacheKey = "rikudou_memoize_AppServiceCalculator_sub_{$cacheKey}";
 
@@ -308,6 +320,7 @@ final class Calculator_Proxy_97bcf9ddeba8fffab6ecd550cf2ea6d6 implements \App\Se
 
 	public function someVoidMethod(): void {
 		$cacheKey = '';
+		$cacheKey .= $this->cacheKeySpecifier->generate();
 		$cacheKey = hash('sha512', $cacheKey);
 		$cacheKey = "rikudou_memoize_AppServiceCalculator_someVoidMethod_{$cacheKey}";
 
@@ -326,4 +339,4 @@ final class Calculator_Proxy_97bcf9ddeba8fffab6ecd550cf2ea6d6 implements \App\Se
 	}
 
 }
-```
+```

src/Cache/KeySpecifier/CacheKeySpecifier.php

@@ -0,0 +1,8 @@
+<?php
+
+namespace Rikudou\MemoizeBundle\Cache\KeySpecifier;
+
+interface CacheKeySpecifier
+{
+    public function generate(): string;
+}

src/Cache/KeySpecifier/NullCacheKeySpecifier.php

@@ -0,0 +1,13 @@
+<?php
+
+namespace Rikudou\MemoizeBundle\Cache\KeySpecifier;
+
+use Rikudou\MemoizeBundle\Cache\KeySpecifier\CacheKeySpecifier;
+
+final class NullCacheKeySpecifier implements CacheKeySpecifier
+{
+    public function generate(): string
+    {
+        return '';
+    }
+}

src/DependencyInjection/Compiler/MemoizeProxyCreatorCompilerPass.php

@@ -17,6 +17,7 @@
 use Rikudou\MemoizeBundle\Attribute\Memoize;
 use Rikudou\MemoizeBundle\Attribute\NoMemoize;
 use Rikudou\MemoizeBundle\Cache\InMemoryCachePool;
+use Rikudou\MemoizeBundle\Cache\KeySpecifier\CacheKeySpecifier;
 use RuntimeException;
 use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
@@ -43,6 +44,8 @@ public function process(ContainerBuilder $container): void
 
         $cacheServiceName = $container->getParameter('rikudou.memoize.cache_service');
         assert(is_string($cacheServiceName));
+        $keySpecifierServiceName = $container->getParameter('rikudou.memoize.key_specifier_service');
+        assert(is_string($keySpecifierServiceName));
         $services = array_keys($container->findTaggedServiceIds('rikudou.memoize.memoizable_service'));
 
         foreach ($services as $service) {
@@ -72,6 +75,7 @@ public function process(ContainerBuilder $container): void
                 new Reference('.inner'),
                 new Reference($cacheServiceName),
                 new Reference('rikudou.memoize.internal_cache'),
+                new Reference($keySpecifierServiceName),
             ]);
             $newDefinition->setDecoratedService($service);
             $container->setDefinition($proxyClass, $newDefinition);
@@ -143,11 +147,13 @@ private function getConstructor(Definition $serviceDefinition): string
         $originalClass = $serviceDefinition->getClass();
         $cacheClass = CacheItemPoolInterface::class;
         $internalCacheClass = InMemoryCachePool::class;
+        $cacheKeySpecifierClass = CacheKeySpecifier::class;
 
         $constructor = "\tpublic function __construct(\n";
         $constructor .= "\t\tprivate readonly \\{$originalClass} \$original,\n";
         $constructor .= "\t\tprivate readonly \\{$cacheClass} \$cache,\n";
         $constructor .= "\t\tprivate readonly \\{$internalCacheClass} \$internalCache,\n";
+        $constructor .= "\t\tprivate readonly \\{$cacheKeySpecifierClass} \$cacheKeySpecifier,\n";
         $constructor .= "\t) {}";
 
         return $constructor;
@@ -189,6 +195,7 @@ private function getMemoizedMethod(ReflectionMethod $method, string $serviceId):
             }
             $methodContent .= "\t\t\$cacheKey .= serialize({$parameter});\n";
         }
+        $methodContent .= "\t\t\$cacheKey .= \$this->cacheKeySpecifier->generate();\n";
         $methodContent .= "\t\t\$cacheKey = hash('sha512', \$cacheKey);\n";
         $methodContent .= "\t\t\$cacheKey = \"rikudou_memoize_{$serviceName}_{$method->getName()}_{\$cacheKey}\";\n\n";
         if ($expiresAfter < 0) {

src/DependencyInjection/Configuration.php

@@ -27,6 +27,10 @@ public function getConfigTreeBuilder(): TreeBuilder
                     ->info('The default cache service to use. If default_memoize_seconds is set to -1 this setting is ignored and internal service is used.')
                     ->defaultValue('cache.app')
                 ->end()
+                ->scalarNode('key_specifier_service')
+                    ->info('The service to use to alter the cache key. Useful if you need to alter the cache key based on some global state.')
+                    ->defaultValue('rikudou.memoize.key_specifier.null')
+                ->end()
             ->end();
 
         return $treeBuilder;

src/DependencyInjection/RikudouMemoizeExtension.php

@@ -36,5 +36,6 @@ static function (ChildDefinition $definition): void {
         $container->setParameter('rikudou.memoize.cache_service', $configs['cache_service']);
         $container->setParameter('rikudou.memoize.default_memoize_seconds', $configs['default_memoize_seconds']);
         $container->setParameter('rikudou.memoize.enabled', $configs['enabled']);
+        $container->setParameter('rikudou.memoize.key_specifier_service', $configs['key_specifier_service']);
     }
 }

src/Resources/config/services.yaml

@@ -1,3 +1,5 @@
 services:
   rikudou.memoize.internal_cache:
     class: Rikudou\MemoizeBundle\Cache\InMemoryCachePool
+  rikudou.memoize.key_specifier.null:
+    class: Rikudou\MemoizeBundle\Cache\KeySpecifier\NullCacheKeySpecifier