Add AsyncRPCInterface in AsyncCache, improve unit tests (#41)

roadrunner-php · Jul 25, 2024 · bc6e142 · bc6e142
1 parent c7ea69c
commit bc6e142
Show file tree

Hide file tree

Showing 10 changed files with 718 additions and 1,383 deletions.
diff --git a/src/AsyncCache.php b/src/AsyncCache.php
@@ -1,23 +1,21 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Spiral\RoadRunner\KeyValue;
 
-use DateInterval;
 use RoadRunner\KV\DTO\V1\Response;
 use Spiral\Goridge\RPC\AsyncRPCInterface;
 use Spiral\Goridge\RPC\Exception\RPCException;
 use Spiral\Goridge\RPC\Exception\ServiceException;
-use Spiral\Goridge\RPC\RPCInterface;
 use Spiral\RoadRunner\KeyValue\Exception\KeyValueException;
 use Spiral\RoadRunner\KeyValue\Exception\StorageException;
 use Spiral\RoadRunner\KeyValue\Serializer\DefaultSerializer;
 use Spiral\RoadRunner\KeyValue\Serializer\SerializerInterface;
-use function sprintf;
-use function str_contains;
-use function str_replace;
 
 /**
  * @psalm-suppress PropertyNotSetInConstructor
+ * @property AsyncRPCInterface $rpc
  */
 class AsyncCache extends Cache implements AsyncStorageInterface
 {
@@ -27,26 +25,20 @@ class AsyncCache extends Cache implements AsyncStorageInterface
     protected array $callsInFlight = [];
 
     /**
-     * @param AsyncRPCInterface $rpc
      * @param non-empty-string $name
      */
     public function __construct(
-        RPCInterface $rpc,
+        AsyncRPCInterface $rpc,
         string $name,
         SerializerInterface $serializer = new DefaultSerializer()
     ) {
         parent::__construct($rpc, $name, $serializer);
-
-        // This should result in things like the Symfony ContainerBuilder throwing during build instead of runtime.
-        assert($this->rpc instanceof AsyncRPCInterface);
     }
 
     /**
      * Note: The current PSR-16 implementation always returns true or
      * exception on error.
      *
-     * {@inheritDoc}
-     *
      * @throws KeyValueException
      * @throws RPCException
      */
@@ -59,19 +51,15 @@ public function deleteAsync(string $key): bool
      * Note: The current PSR-16 implementation always returns true or
      * exception on error.
      *
-     * {@inheritDoc}
-     *
-     * @psalm-param iterable<string> $keys
+     * @param iterable<string> $keys
      *
      * @throws KeyValueException
      * @throws RPCException
      */
     public function deleteMultipleAsync(iterable $keys): bool
     {
-        assert($this->rpc instanceof AsyncRPCInterface);
-
         // Handle someone never calling commitAsync()
-        if (count($this->callsInFlight) > 1000) {
+        if (\count($this->callsInFlight) > 1000) {
             $this->commitAsync();
         }
 
@@ -81,33 +69,29 @@ public function deleteMultipleAsync(iterable $keys): bool
     }
 
     /**
-     * {@inheritDoc}
-     *
-     * @psalm-param positive-int|\DateInterval|null $ttl
+     * @param positive-int|\DateInterval|null $ttl
      * @psalm-suppress MoreSpecificImplementedParamType
+     *
      * @throws KeyValueException
      * @throws RPCException
      */
-    public function setAsync(string $key, mixed $value, null|int|DateInterval $ttl = null): bool
+    public function setAsync(string $key, mixed $value, null|int|\DateInterval $ttl = null): bool
     {
         return $this->setMultipleAsync([$key => $value], $ttl);
     }
 
     /**
-     * {@inheritDoc}
-     *
-     * @psalm-param iterable<string, mixed> $values
-     * @psalm-param positive-int|\DateInterval|null $ttl
+     * @param iterable<string, mixed> $values
+     * @param positive-int|\DateInterval|null $ttl
      * @psalm-suppress MoreSpecificImplementedParamType
+     *
      * @throws KeyValueException
      * @throws RPCException
      */
-    public function setMultipleAsync(iterable $values, null|int|DateInterval $ttl = null): bool
+    public function setMultipleAsync(iterable $values, null|int|\DateInterval $ttl = null): bool
     {
-        assert($this->rpc instanceof AsyncRPCInterface);
-
         // Handle someone never calling commitAsync()
-        if (count($this->callsInFlight) > 1000) {
+        if (\count($this->callsInFlight) > 1000) {
             $this->commitAsync();
         }
 
@@ -125,15 +109,13 @@ public function setMultipleAsync(iterable $values, null|int|DateInterval $ttl =
      */
     public function commitAsync(): bool
     {
-        assert($this->rpc instanceof AsyncRPCInterface);
-
         try {
             $this->rpc->getResponses($this->callsInFlight, Response::class);
         } catch (ServiceException $e) {
-            $message = str_replace(["\t", "\n"], ' ', $e->getMessage());
+            $message = \str_replace(["\t", "\n"], ' ', $e->getMessage());
 
-            if (str_contains($message, 'no such storage')) {
-                throw new StorageException(sprintf(self::ERROR_INVALID_STORAGE, $this->name));
+            if (\str_contains($message, 'no such storage')) {
+                throw new StorageException(\sprintf(self::ERROR_INVALID_STORAGE, $this->name));
             }
 
             throw new KeyValueException($message, $e->getCode(), $e);

diff --git a/src/AsyncStorageInterface.php b/src/AsyncStorageInterface.php
@@ -1,8 +1,9 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Spiral\RoadRunner\KeyValue;
 
-use DateInterval;
 use Spiral\RoadRunner\KeyValue\Exception\KeyValueException;
 
 interface AsyncStorageInterface extends StorageInterface
@@ -28,7 +29,7 @@ public function commitAsync(): bool;
      *   MUST be thrown if $values is neither an array nor a Traversable,
      *   or if any of the $values are not a legal value.
      */
-    public function setMultipleAsync(iterable $values, null|int|DateInterval $ttl = null): bool;
+    public function setMultipleAsync(iterable $values, null|int|\DateInterval $ttl = null): bool;
 
     /**
      * Persists data in the cache, uniquely referenced by a key with an optional expiration TTL time.
@@ -44,7 +45,7 @@ public function setMultipleAsync(iterable $values, null|int|DateInterval $ttl =
      * @throws \Psr\SimpleCache\InvalidArgumentException
      *    MUST be thrown if the $key string is not a legal value.
      */
-    public function setAsync(string $key, mixed $value, null|int|DateInterval $ttl = null): bool;
+    public function setAsync(string $key, mixed $value, null|int|\DateInterval $ttl = null): bool;
 
     /**
      * Delete an item from the cache by its unique key.

diff --git a/src/Cache.php b/src/Cache.php
@@ -47,9 +47,9 @@ class Cache implements StorageInterface
      * @param non-empty-string $name
      */
     public function __construct(
-        RPCInterface              $rpc,
+        RPCInterface $rpc,
         protected readonly string $name,
-        SerializerInterface       $serializer = new DefaultSerializer()
+        SerializerInterface $serializer = new DefaultSerializer()
     ) {
         $this->rpc = $rpc->withCodec(new ProtobufCodec());
         $this->zone = new \DateTimeZone('UTC');

diff --git a/src/Factory.php b/src/Factory.php
@@ -28,8 +28,8 @@ public function select(string $name): StorageInterface
     {
         if ($this->rpc instanceof AsyncRPCInterface) {
             return new AsyncCache($this->rpc, $name, $this->getSerializer());
-        } else {
-            return new Cache($this->rpc, $name, $this->getSerializer());
         }
+
+        return new Cache($this->rpc, $name, $this->getSerializer());
     }
 }