From 909d9a308a65b780bab2b0269123db5104e0ad79 Mon Sep 17 00:00:00 2001
From: "hubert.lenoir" <hubert.lenoir@sensiolabs.com>
Date: Fri, 27 May 2022 16:00:39 +0200
Subject: [PATCH] [DependencyInjection] [ProxyManagerBridge] Add Memoize
 attribute

---
 .../AccessInterceptorValueHolderFactory.php   |  9 +++
 .../Attribute/Memoizable.php                  |  7 +++
 .../DependencyInjection/Attribute/Memoize.php | 14 +++++
 .../Compiler/MemoizePass.php                  | 60 +++++++++++++++++++
 .../Compiler/PassConfig.php                   |  1 +
 .../MemoizeProxy/BaseKeyGenerator.php         | 14 +++++
 .../MemoizeProxy/Interceptor.php              | 34 +++++++++++
 .../MemoizeProxy/KeyGeneratorInterface.php    | 11 ++++
 .../MemoizeProxy/MemoizeFactory.php           | 47 +++++++++++++++
 9 files changed, 197 insertions(+)
 create mode 100644 src/Symfony/Bridge/ProxyManager/AccessInterceptor/Instanciator/AccessInterceptorValueHolderFactory.php
 create mode 100644 src/Symfony/Component/DependencyInjection/Attribute/Memoizable.php
 create mode 100644 src/Symfony/Component/DependencyInjection/Attribute/Memoize.php
 create mode 100644 src/Symfony/Component/DependencyInjection/Compiler/MemoizePass.php
 create mode 100644 src/Symfony/Component/DependencyInjection/MemoizeProxy/BaseKeyGenerator.php
 create mode 100644 src/Symfony/Component/DependencyInjection/MemoizeProxy/Interceptor.php
 create mode 100644 src/Symfony/Component/DependencyInjection/MemoizeProxy/KeyGeneratorInterface.php
 create mode 100644 src/Symfony/Component/DependencyInjection/MemoizeProxy/MemoizeFactory.php

diff --git a/src/Symfony/Bridge/ProxyManager/AccessInterceptor/Instanciator/AccessInterceptorValueHolderFactory.php b/src/Symfony/Bridge/ProxyManager/AccessInterceptor/Instanciator/AccessInterceptorValueHolderFactory.php
new file mode 100644
index 0000000000000..0888be03c50ae
--- /dev/null
+++ b/src/Symfony/Bridge/ProxyManager/AccessInterceptor/Instanciator/AccessInterceptorValueHolderFactory.php
@@ -0,0 +1,9 @@
+<?php
+
+namespace Symfony\Bridge\ProxyManager\AccessInterceptor\Instanciator;
+
+use ProxyManager\Factory\AccessInterceptorValueHolderFactory as BaseFactory;
+
+final class AccessInterceptorValueHolderFactory extends BaseFactory
+{
+}
diff --git a/src/Symfony/Component/DependencyInjection/Attribute/Memoizable.php b/src/Symfony/Component/DependencyInjection/Attribute/Memoizable.php
new file mode 100644
index 0000000000000..1e53a7a62a7b2
--- /dev/null
+++ b/src/Symfony/Component/DependencyInjection/Attribute/Memoizable.php
@@ -0,0 +1,7 @@
+<?php
+
+namespace Symfony\Component\DependencyInjection\Attribute;
+
+#[\Attribute(\Attribute::TARGET_CLASS)]
+class Memoizable
+{}
diff --git a/src/Symfony/Component/DependencyInjection/Attribute/Memoize.php b/src/Symfony/Component/DependencyInjection/Attribute/Memoize.php
new file mode 100644
index 0000000000000..5bf649622d1ee
--- /dev/null
+++ b/src/Symfony/Component/DependencyInjection/Attribute/Memoize.php
@@ -0,0 +1,14 @@
+<?php
+
+namespace Symfony\Component\DependencyInjection\Attribute;
+
+#[\Attribute(\Attribute::TARGET_METHOD)]
+class Memoize
+{
+    public function __construct(
+        public string  $pool,
+        public ?string $keyGenerator = null,
+        public ?int    $ttl = null,
+    )
+    {}
+}
diff --git a/src/Symfony/Component/DependencyInjection/Compiler/MemoizePass.php b/src/Symfony/Component/DependencyInjection/Compiler/MemoizePass.php
new file mode 100644
index 0000000000000..cf94e64ace0ec
--- /dev/null
+++ b/src/Symfony/Component/DependencyInjection/Compiler/MemoizePass.php
@@ -0,0 +1,60 @@
+<?php
+
+namespace Symfony\Component\DependencyInjection\Compiler;
+
+use Symfony\Component\DependencyInjection\Attribute\Memoizable;
+use Symfony\Component\DependencyInjection\Attribute\Memoize;
+use Symfony\Component\DependencyInjection\ContainerBuilder;
+use Symfony\Component\DependencyInjection\MemoizeProxy\BaseKeyGenerator;
+use Symfony\Component\DependencyInjection\MemoizeProxy\MemoizeFactory;
+use Symfony\Component\DependencyInjection\Reference;
+
+class MemoizePass implements CompilerPassInterface
+{
+    public function process(ContainerBuilder $container): void
+    {
+        $container->register('dependency_injection.memoize_proxy.factory', MemoizeFactory::class)
+            ->setArguments([$container->getParameter('kernel.cache_dir').'/memoize']);
+        $container->register('dependency_injection.memoize_proxy.key_generator.base', BaseKeyGenerator::class);
+
+        foreach ($container->getDefinitions() as $id => $definition) {
+            if (!$definition->isAutoconfigured()) {
+                continue;
+            }
+
+            // Is MemoizeClass
+            if (!$class = $container->getReflectionClass($definition->getClass())) {
+                continue;
+            }
+            if (!$class->getAttributes(Memoizable::class, \ReflectionAttribute::IS_INSTANCEOF)) {
+                continue;
+            }
+
+            // Get Memoize methods
+            $methods = [];
+            foreach ($class->getMethods() as $method) {
+                if (!$memoize = $method->getAttributes(Memoize::class, \ReflectionAttribute::IS_INSTANCEOF)) {
+                    continue;
+                }
+                $memoize = $memoize[0]->newInstance();
+
+                $methods[$method->getName()] = [
+                    new Reference($memoize->pool),
+                    new Reference($memoize->keyGenerator ?: 'dependency_injection.memoize_proxy.key_generator.base'),
+                    $memoize->ttl,
+                ];
+            }
+
+            if (!$methods) {
+                continue;
+            }
+
+            // Create proxy
+            $proxy = $container->register($id.'.memoized', $definition->getClass());
+            $proxy->setDecoratedService($id);
+            $proxy->setFactory(new Reference('dependency_injection.memoize_proxy.factory'));
+            $proxy->setArguments([new Reference('.inner'), $methods]);
+        }
+    }
+
+}
diff --git a/src/Symfony/Component/DependencyInjection/Compiler/PassConfig.php b/src/Symfony/Component/DependencyInjection/Compiler/PassConfig.php
index 3acbe26de0d3c..30fead4ae407e 100644
--- a/src/Symfony/Component/DependencyInjection/Compiler/PassConfig.php
+++ b/src/Symfony/Component/DependencyInjection/Compiler/PassConfig.php
@@ -47,6 +47,7 @@ public function __construct()
                 new AttributeAutoconfigurationPass(),
                 new ResolveInstanceofConditionalsPass(),
                 new RegisterEnvVarProcessorsPass(),
+                new MemoizePass(),
             ],
             -1000 => [new ExtensionCompilerPass()],
         ];
diff --git a/src/Symfony/Component/DependencyInjection/MemoizeProxy/BaseKeyGenerator.php b/src/Symfony/Component/DependencyInjection/MemoizeProxy/BaseKeyGenerator.php
new file mode 100644
index 0000000000000..30fcc5ef8ce54
--- /dev/null
+++ b/src/Symfony/Component/DependencyInjection/MemoizeProxy/BaseKeyGenerator.php
@@ -0,0 +1,14 @@
+<?php
+
+namespace Symfony\Component\DependencyInjection\MemoizeProxy;
+
+class BaseKeyGenerator implements KeyGeneratorInterface
+{
+    /**
+     * @inheritDoc
+     */
+    public function __invoke(string $className, string $method, array $arguments): string
+    {
+        return hash('sha256', $className.$method.serialize($arguments));
+    }
+}
diff --git a/src/Symfony/Component/DependencyInjection/MemoizeProxy/Interceptor.php b/src/Symfony/Component/DependencyInjection/MemoizeProxy/Interceptor.php
new file mode 100644
index 0000000000000..adf9e7dfc3046
--- /dev/null
+++ b/src/Symfony/Component/DependencyInjection/MemoizeProxy/Interceptor.php
@@ -0,0 +1,34 @@
+<?php
+
+namespace Symfony\Component\DependencyInjection\MemoizeProxy;
+
+use Psr\Cache\CacheItemInterface;
+use Psr\Cache\CacheItemPoolInterface;
+
+class Interceptor
+{
+    private CacheItemInterface $item;
+
+    public function __construct(
+        private readonly CacheItemPoolInterface $cache,
+        private readonly KeyGeneratorInterface $keyGenerator,
+        private readonly ?int $ttl = null
+    )
+    {
+    }
+
+    public function getPrefixInterceptor($proxy, $instance, $method, $params, &$returnEarly) {
+        $this->item = $this->cache->getItem(($this->keyGenerator)(\get_class($instance), $method, $params));
+        if ($this->item->isHit()) {
+            $returnEarly = true;
+
+            return $this->item->get();
+        }
+    }
+
+    public function getSuffixInterceptor($proxy, $instance, $method, $params, $returnValue) {
+        $this->item->expiresAfter($this->ttl);
+        $this->item->set($returnValue);
+        $this->cache->save($this->item);
+    }
+}
diff --git a/src/Symfony/Component/DependencyInjection/MemoizeProxy/KeyGeneratorInterface.php b/src/Symfony/Component/DependencyInjection/MemoizeProxy/KeyGeneratorInterface.php
new file mode 100644
index 0000000000000..5e7810ca2d3b3
--- /dev/null
+++ b/src/Symfony/Component/DependencyInjection/MemoizeProxy/KeyGeneratorInterface.php
@@ -0,0 +1,11 @@
+<?php
+
+namespace Symfony\Component\DependencyInjection\MemoizeProxy;
+
+interface KeyGeneratorInterface
+{
+    /**
+     * Generates a cache key for the given arguments.
+     */
+    public function __invoke(string $className, string $method, array $arguments): string;
+}
diff --git a/src/Symfony/Component/DependencyInjection/MemoizeProxy/MemoizeFactory.php b/src/Symfony/Component/DependencyInjection/MemoizeProxy/MemoizeFactory.php
new file mode 100644
index 0000000000000..2764692661888
--- /dev/null
+++ b/src/Symfony/Component/DependencyInjection/MemoizeProxy/MemoizeFactory.php
@@ -0,0 +1,47 @@
+<?php
+
+namespace Symfony\Component\DependencyInjection\MemoizeProxy;
+
+use ProxyManager\Configuration;
+use ProxyManager\FileLocator\FileLocator;
+use ProxyManager\GeneratorStrategy\FileWriterGeneratorStrategy;
+use ProxyManager\Proxy\AccessInterceptorValueHolderInterface;
+use Psr\Cache\CacheItemPoolInterface;
+use Symfony\Bridge\ProxyManager\AccessInterceptor\Instanciator\AccessInterceptorValueHolderFactory;
+
+/**
+ * Memoize a service by creating a ProxyManager\Proxy\AccessInterceptorValueHolder
+ */
+final class MemoizeFactory
+{
+    readonly private AccessInterceptorValueHolderFactory $factory;
+
+    public function __construct(string $cacheDirectory)
+    {
+        if (!is_dir($cacheDirectory)) {
+            @mkdir($cacheDirectory, 0777, true);
+        }
+
+        $config = new Configuration();
+        $config->setGeneratorStrategy(new FileWriterGeneratorStrategy(new FileLocator($cacheDirectory)));
+        $config->setProxiesTargetDir($cacheDirectory);
+
+        $this->factory = new AccessInterceptorValueHolderFactory($config);
+    }
+
+    /**
+     * @param object $service Service to memoize
+     * @param array<array{CacheItemPoolInterface, KeyGeneratorInterface, int}> $methods
+     */
+    public function __invoke(object $service, array $methods): AccessInterceptorValueHolderInterface
+    {
+        $proxy = $this->factory->createProxy($service);
+        foreach ($methods as $name => [$cache, $key, $ttl]) {
+            $interceptor = new Interceptor($cache, $key, $ttl);
+            $proxy->setMethodPrefixInterceptor($name, $interceptor->getPrefixInterceptor(...));
+            $proxy->setMethodSuffixInterceptor($name, $interceptor->getSuffixInterceptor(...));
+        }
+
+        return $proxy;
+    }
+}