Introduce StorageRedisDsnModule

.github/dependabot.yml

@@ -12,3 +12,5 @@ updates:
     ignore:
       - dependency-name: "*" # Ignore all dependencies for specific update types
         update-types: ["version-update:semver-minor", "version-update:semver-patch"]
+      - dependency-name: "phpunit/phpunit"
+        update-types: ["version-update:semver-major"]

composer.json

@@ -17,8 +17,8 @@
         "doctrine/cache": "^1.12 || ^2.0",
         "mobiledetect/mobiledetectlib": "^3.74",
         "psr/cache": "^1.0 || ^2.0 || ^3.0",
-        "ray/aop": "^2.10",
-        "ray/di": "^2.13.1",
+        "ray/aop": "^2.16",
+        "ray/di": "^2.17.2",
         "ray/psr-cache-module": "^1.3.4",
         "symfony/cache": "^5.3 || ^6.0",
         "symfony/cache-contracts": "^2.4 || ^3.0"

psalm.xml

@@ -14,4 +14,11 @@
             <directory name="vendor" />
         </ignoreFiles>
     </projectFiles>
+    <issueHandlers>
+        <UndefinedClass>
+            <errorLevel type="suppress">
+                <file name="src/RedisDsnProvider.php" />
+            </errorLevel>
+        </UndefinedClass>
+    </issueHandlers>
 </psalm>

src-annotation/EtagPool.php

@@ -5,20 +5,10 @@
 namespace BEAR\RepositoryModule\Annotation;
 
 use Attribute;
-use Doctrine\Common\Annotations\Annotation\NamedArgumentConstructor;
 use Ray\Di\Di\Qualifier;
 
-/**
- * @Annotation
- * @Qualifier
- * @NamedArgumentConstructor
- */
-#[Attribute(Attribute::TARGET_PARAMETER | Attribute::TARGET_METHOD)]
+#[Attribute(Attribute::TARGET_PARAMETER)]
 #[Qualifier]
 final class EtagPool
 {
-    public function __construct(
-        public string $value = '',
-    ) {
-    }
 }

src-annotation/RedisDsn.php

@@ -0,0 +1,14 @@
+<?php
+
+declare(strict_types=1);
+
+namespace BEAR\RepositoryModule\Annotation;
+
+use Attribute;
+use Ray\Di\Di\Qualifier;
+
+#[Attribute(Attribute::TARGET_PARAMETER)]
+#[Qualifier]
+final class RedisDsn
+{
+}

src-annotation/RedisDsnOptions.php

@@ -0,0 +1,14 @@
+<?php
+
+declare(strict_types=1);
+
+namespace BEAR\RepositoryModule\Annotation;
+
+use Attribute;
+use Ray\Di\Di\Qualifier;
+
+#[Attribute(Attribute::TARGET_PARAMETER)]
+#[Qualifier]
+final class RedisDsnOptions
+{
+}

src-annotation/ResourceObjectPool.php

@@ -0,0 +1,14 @@
+<?php
+
+declare(strict_types=1);
+
+namespace BEAR\RepositoryModule\Annotation;
+
+use Attribute;
+use Ray\Di\Di\Qualifier;
+
+#[Attribute(Attribute::TARGET_PARAMETER)]
+#[Qualifier]
+final class ResourceObjectPool
+{
+}

src-annotation/TagsPool.php

@@ -0,0 +1,14 @@
+<?php
+
+declare(strict_types=1);
+
+namespace BEAR\RepositoryModule\Annotation;
+
+use Attribute;
+use Ray\Di\Di\Qualifier;
+
+#[Attribute(Attribute::TARGET_PARAMETER)]
+#[Qualifier]
+final class TagsPool
+{
+}

src-deprecated/BcModule.php

@@ -14,6 +14,8 @@
 use Ray\Di\Scope;
 
 /**
+ * @deprecated
+ *
  * Backward Compatibility module
  *
  * Install this when you need deprecated interface.

src-deprecated/NamespacedCacheProvider.php

@@ -10,14 +10,15 @@
 use Doctrine\Common\Cache\CacheProvider;
 use Ray\Di\ProviderInterface;
 
+/**
+ * @deprecated
+ */
 class NamespacedCacheProvider implements ProviderInterface
 {
     /** @var CacheProvider */
     private $cache;
 
     /**
-     * @deprecated
-     *
      * @CacheEngine("cache")
      * @AppName("appName")
      * @CacheVersion("version")

src/ResourceStorageCacheableTrait.php → src-deprecated/ResourceStorageCacheableTrait.php

@@ -17,6 +17,9 @@
 
 use function assert;
 
+/**
+ * @deprecated
+ */
 trait ResourceStorageCacheableTrait
 {
     /**

src/StorageRedisMemcachedModule.php → src-deprecated/StorageRedisMemcachedModule.php

@@ -13,11 +13,12 @@
 use Ray\PsrCacheModule\MemcachedAdapter;
 use Ray\PsrCacheModule\MemcachedProvider;
 use Ray\PsrCacheModule\Psr6RedisModule;
-
 use function array_map;
 use function explode;
 
 /**
+ * @deprecated
+ *
  * Bind redis to shared storage, Bind memcache to etag pool
  */
 final class StorageRedisMemcachedModule extends AbstractModule

src/StorageRedisModule.php → src-deprecated/StorageRedisModule.php

@@ -21,6 +21,8 @@
  * The following module are installed:
  *
  * Psr6RedisModule
+ *
+ * @deprecated Use StorageRedisDsnModule instead
  */
 final class StorageRedisModule extends AbstractModule
 {

src/ProdQueryRepositoryModule.php

@@ -5,7 +5,10 @@
 namespace BEAR\QueryRepository;
 
 use BEAR\RepositoryModule\Annotation\KnownTagTtl;
+use BEAR\RepositoryModule\Annotation\ResourceObjectPool;
 use Ray\Di\AbstractModule;
+use Ray\PsrCacheModule\LocalCacheProvider;
+use Symfony\Component\Cache\Adapter\AdapterInterface;
 
 final class ProdQueryRepositoryModule extends AbstractModule
 {
@@ -16,7 +19,9 @@ final class ProdQueryRepositoryModule extends AbstractModule
      */
     protected function configure(): void
     {
-        // boost the performance of symfony/cache
+        // Bind ResourceObjectPool to local cache (APCu or File)
+        $this->bind(AdapterInterface::class)->annotatedWith(ResourceObjectPool::class)->toProvider(LocalCacheProvider::class);
+        // Boost the performance of symfony/cache
         $this->bind()->annotatedWith(KnownTagTtl::class)->toInstance(0.15);
     }
 }

src/QueryRepositoryModule.php

@@ -5,20 +5,22 @@
 namespace BEAR\QueryRepository;
 
 use BEAR\RepositoryModule\Annotation\EtagPool;
+use BEAR\RepositoryModule\Annotation\ResourceObjectPool;
+use BEAR\RepositoryModule\Annotation\TagsPool;
 use BEAR\Resource\NamedParameter;
 use BEAR\Resource\NamedParameterInterface;
-use Psr\Cache\CacheItemPoolInterface;
 use Ray\Di\AbstractModule;
 use Ray\Di\Scope;
-use Ray\PsrCacheModule\Annotation\Shared;
+use Symfony\Component\Cache\Adapter\AdapterInterface;
 use Symfony\Component\Cache\Adapter\NullAdapter;
+use Symfony\Component\Cache\Adapter\TagAwareAdapter;
+use Symfony\Component\Cache\Adapter\TagAwareAdapterInterface;
 
 /**
  *  Provides ResourceStorageInterface and derived bindings
  *
  *  The following bindings are provided:
  *
- *  CacheItemPoolInterface-Shared::class
  *  CacheItemPoolInterface-EtagPool::class
  *  QueryRepositoryInterface
  *  CacheDependencyInterface
@@ -41,9 +43,20 @@ final class QueryRepositoryModule extends AbstractModule
      */
     protected function configure(): void
     {
-        // Null cache default
-        $this->bind(CacheItemPoolInterface::class)->annotatedWith(Shared::class)->to(NullAdapter::class)->in(Scope::SINGLETON);
-        $this->bind(CacheItemPoolInterface::class)->annotatedWith(EtagPool::class)->toInstance(null);
+        // Null cache engine default
+        $this->bind(AdapterInterface::class)->annotatedWith(ResourceObjectPool::class)->to(NullAdapter::class);
+        // When null is bound, the same adapter as the one assigned to the ResourceObjectPool is used.
+        $this->bind(AdapterInterface::class)->annotatedWith(TagsPool::class)->toInstance(null);
+        // TagAwareAdapterInterface is injected into ResourceStorage
+        $this->bind(TagAwareAdapterInterface::class)->annotatedWith(ResourceObjectPool::class)->toConstructor(
+            TagAwareAdapter::class,
+            [
+                'itemsPool' => ResourceObjectPool::class,
+                'tagsPool' => TagsPool::class,
+            ],
+        )->in(Scope::SINGLETON);
+        //  When null is bound, the same adapter as the one assigned to the ResourceObjectPool is used.
+        $this->bind(TagAwareAdapterInterface::class)->annotatedWith(EtagPool::class)->toInstance(null);
         // core
         $this->bind(QueryRepositoryInterface::class)->to(QueryRepository::class)->in(Scope::SINGLETON);
         $this->bind(CacheDependencyInterface::class)->to(CacheDependency::class);
@@ -53,6 +66,7 @@ protected function configure(): void
         $this->bind(MatchQueryInterface::class)->to(MatchQuery::class)->in(Scope::SINGLETON);
         $this->bind(UriTag::class)->in(Scope::SINGLETON);
         $this->bind(RefreshAnnotatedCommand::class);
+        $this->bind(ResourceStorageSaver::class);
         // #[Cacheable]
         $this->install(new CacheableModule());
         // #[CacheableResponse]

src/RedisDsnProvider.php

@@ -0,0 +1,36 @@
+<?php
+
+declare(strict_types=1);
+
+namespace BEAR\QueryRepository;
+
+use BEAR\RepositoryModule\Annotation\RedisDsn;
+use BEAR\RepositoryModule\Annotation\RedisDsnOptions;
+use Predis\ClientInterface;
+use Ray\Di\ProviderInterface;
+use Redis;
+use RedisArray;
+use RedisCluster;
+use Relay\Relay;
+use Symfony\Component\Cache\Adapter\RedisAdapter;
+
+/** @implements ProviderInterface<Redis|RedisArray|RedisCluster|ClientInterface|Relay> */
+final class RedisDsnProvider implements ProviderInterface
+{
+    /**
+     * @param string                                                   $dns     Redis DSN
+     * @param array<string, bool|int|string|array<string, mixed>|null> $options Redis DSN Options
+     */
+    public function __construct(
+        #[RedisDsn]
+        private string $dns,
+        #[RedisDsnOptions]
+        private array $options,
+    ) {
+    }
+
+    public function get(): Redis|RedisArray|RedisCluster|ClientInterface|Relay
+    {
+        return RedisAdapter::createConnection($this->dns, $this->options);
+    }
+}