experiment: multiple backends

distantmagic · May 27, 2024 · bd55c6a · bd55c6a
1 parent 87eba4d
commit bd55c6a
Show file tree

Hide file tree

Showing 25 changed files with 89 additions and 14 deletions.
diff --git a/src/AmpServer.php b/src/AmpServer.php
@@ -9,13 +9,15 @@
 use Amp\Http\Server\RequestHandler;
 use Amp\Http\Server\Response;
 use Amp\Http\Server\SocketHttpServer;
+use Distantmagic\Resonance\Attribute\RequiresBackendDriver;
 use Distantmagic\Resonance\Attribute\Singleton;
 use Distantmagic\Resonance\PsrMessage\AmpServerRequest;
 use Distantmagic\Resonance\PsrMessage\ServerResponse;
 use Psr\Log\LoggerInterface;
 
 use function Amp\trapSignal;
 
+#[RequiresBackendDriver(BackendDriver::Amp)]
 #[Singleton]
 readonly class AmpServer implements RequestHandler
 {

diff --git a/src/Attribute/RequiresBackendDriver.php b/src/Attribute/RequiresBackendDriver.php
@@ -0,0 +1,15 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Distantmagic\Resonance\Attribute;
+
+use Attribute;
+use Distantmagic\Resonance\Attribute as BaseAttribute;
+use Distantmagic\Resonance\BackendDriver;
+
+#[Attribute(Attribute::TARGET_CLASS)]
+final readonly class RequiresBackendDriver extends BaseAttribute
+{
+    public function __construct(public BackendDriver $backendDriver) {}
+}
diff --git a/src/BackendDriver.php b/src/BackendDriver.php
@@ -0,0 +1,11 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Distantmagic\Resonance;
+
+enum BackendDriver
+{
+    case Amp;
+    case Swoole;
+}
diff --git a/src/Command/GrpcGenerate.php b/src/Command/GrpcGenerate.php
@@ -5,7 +5,9 @@
 namespace Distantmagic\Resonance\Command;
 
 use Distantmagic\Resonance\Attribute\ConsoleCommand;
+use Distantmagic\Resonance\Attribute\RequiresBackendDriver;
 use Distantmagic\Resonance\Attribute\RequiresPhpExtension;
+use Distantmagic\Resonance\BackendDriver;
 use Distantmagic\Resonance\Command;
 use Distantmagic\Resonance\CoroutineCommand;
 use Distantmagic\Resonance\CoroutineDriverInterface;
@@ -21,6 +23,7 @@
     name: 'grpc:generate',
     description: 'Generate GRPC stubs'
 )]
+#[RequiresBackendDriver(BackendDriver::Swoole)]
 #[RequiresPhpExtension('grpc')]
 #[RequiresPhpExtension('protobuf')]
 final class GrpcGenerate extends CoroutineCommand

diff --git a/src/Command/Watch.php b/src/Command/Watch.php
@@ -6,7 +6,9 @@
 
 use Distantmagic\Resonance\ApplicationConfiguration;
 use Distantmagic\Resonance\Attribute\ConsoleCommand;
+use Distantmagic\Resonance\Attribute\RequiresBackendDriver;
 use Distantmagic\Resonance\Attribute\RequiresPhpExtension;
+use Distantmagic\Resonance\BackendDriver;
 use Distantmagic\Resonance\Command;
 use Distantmagic\Resonance\InotifyIterator;
 use Psr\Log\LoggerInterface;
@@ -19,6 +21,7 @@
     name: 'watch:command',
     description: 'Watch project files for changes'
 )]
+#[RequiresBackendDriver(BackendDriver::Swoole)]
 #[RequiresPhpExtension('inotify')]
 final class Watch extends Command
 {

diff --git a/src/DependencyInjectionContainer.php b/src/DependencyInjectionContainer.php
@@ -362,7 +362,7 @@ private function makeSingleton(string $className, DependencyStack $stack): objec
         if ($potentialSingletonProvider instanceof SingletonProviderInterface) {
             if ($potentialSingletonProvider instanceof RegisterableInterface && !$potentialSingletonProvider->shouldRegister()) {
                 throw new DependencyInjectionContainerException(sprintf(
-                    '"%s" service provider refused to register',
+                    '"%s" service provider refused to register. No other candidates available.',
                     $potentialSingletonProvider::class,
                 ));
             }

diff --git a/src/DoctrineEntityManagerWeakStore.php b/src/DoctrineEntityManagerWeakStore.php
@@ -4,6 +4,7 @@
 
 namespace Distantmagic\Resonance;
 
+use Distantmagic\Resonance\Attribute\RequiresBackendDriver;
 use Distantmagic\Resonance\Attribute\Singleton;
 use Distantmagic\Resonance\Attribute\WebSocketAware;
 use Doctrine\ORM\EntityManagerInterface;
@@ -13,6 +14,7 @@
 use Swoole\Coroutine\Context;
 use WeakMap;
 
+#[RequiresBackendDriver(BackendDriver::Swoole)]
 #[Singleton(collection: SingletonCollection::WebSocketAware)]
 #[WebSocketAware]
 readonly class DoctrineEntityManagerWeakStore

diff --git a/src/LlamaCppClient.php b/src/LlamaCppClient.php
@@ -5,13 +5,15 @@
 namespace Distantmagic\Resonance;
 
 use CurlHandle;
+use Distantmagic\Resonance\Attribute\RequiresBackendDriver;
 use Distantmagic\Resonance\Attribute\RequiresPhpExtension;
 use Distantmagic\Resonance\Attribute\Singleton;
 use Generator;
 use Psr\Log\LoggerInterface;
 use RuntimeException;
 use Swoole\Coroutine\Channel;
 
+#[RequiresBackendDriver(BackendDriver::Swoole)]
 #[RequiresPhpExtension('curl')]
 #[Singleton(provides: LlamaCppClientInterface::class)]
 readonly class LlamaCppClient implements LlamaCppClientInterface

diff --git a/src/ObservableTaskTable.php b/src/ObservableTaskTable.php
@@ -5,6 +5,7 @@
 namespace Distantmagic\Resonance;
 
 use DateTimeImmutable;
+use Distantmagic\Resonance\Attribute\RequiresBackendDriver;
 use Distantmagic\Resonance\Attribute\Singleton;
 use Generator;
 use IteratorAggregate;
@@ -14,6 +15,7 @@
 /**
  * @template-implements IteratorAggregate<non-empty-string,ObservableTaskTableRow>
  */
+#[RequiresBackendDriver(BackendDriver::Swoole)]
 #[Singleton]
 readonly class ObservableTaskTable implements IteratorAggregate
 {

diff --git a/src/PsrSwooleResponder.php b/src/PsrSwooleResponder.php
@@ -4,11 +4,13 @@
 
 namespace Distantmagic\Resonance;
 
+use Distantmagic\Resonance\Attribute\RequiresBackendDriver;
 use Distantmagic\Resonance\Attribute\Singleton;
 use Psr\Http\Message\ResponseInterface;
 use Psr\Http\Message\ServerRequestInterface;
 use Swoole\Http\Response;
 
+#[RequiresBackendDriver(BackendDriver::Swoole)]
 #[Singleton]
 readonly class PsrSwooleResponder
 {

diff --git a/src/RedisConnection.php b/src/RedisConnection.php
@@ -11,7 +11,7 @@
     public Redis $redis;
 
     public function __construct(
-        private RedisConnectionPoolRepository $redisConnectionPoolRepository,
+        private RedisConnectionPoolRepositoryInterface $redisConnectionPoolRepository,
         string $redisPrefix,
         private string $connectionPoolName = 'default',
     ) {

diff --git a/src/RedisConnectionPoolRepository.php b/src/RedisConnectionPoolRepository.php
@@ -9,7 +9,7 @@
 use Redis;
 use Swoole\Database\RedisPool;
 
-readonly class RedisConnectionPoolRepository
+readonly class RedisConnectionPoolRepository implements RedisConnectionPoolRepositoryInterface
 {
     /**
      * @var Map<string,RedisPool>

diff --git a/src/RedisConnectionPoolRepositoryInterface.php b/src/RedisConnectionPoolRepositoryInterface.php
@@ -0,0 +1,14 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Distantmagic\Resonance;
+
+use Redis;
+
+interface RedisConnectionPoolRepositoryInterface
+{
+    public function getConnection(string $name): Redis;
+
+    public function putConnection(string $name, Redis $redis): void;
+}
diff --git a/src/ServerPipeMessageDispatcher.php b/src/ServerPipeMessageDispatcher.php
@@ -4,10 +4,12 @@
 
 namespace Distantmagic\Resonance;
 
+use Distantmagic\Resonance\Attribute\RequiresBackendDriver;
 use Distantmagic\Resonance\Attribute\Singleton;
 use RuntimeException;
 use Swoole\Server;
 
+#[RequiresBackendDriver(BackendDriver::Swoole)]
 #[Singleton]
 readonly class ServerPipeMessageDispatcher
 {

diff --git a/src/ServerTaskHandlerDispatcher.php b/src/ServerTaskHandlerDispatcher.php
@@ -4,12 +4,14 @@
 
 namespace Distantmagic\Resonance;
 
+use Distantmagic\Resonance\Attribute\RequiresBackendDriver;
 use Distantmagic\Resonance\Attribute\Singleton;
 use Psr\Log\LoggerInterface;
 use Swoole\Server;
 use Swoole\Server\Task;
 use Symfony\Component\Messenger\Envelope;
 
+#[RequiresBackendDriver(BackendDriver::Swoole)]
 #[Singleton]
 readonly class ServerTaskHandlerDispatcher
 {

diff --git a/src/Session.php b/src/Session.php
@@ -12,7 +12,7 @@
 
     public function __construct(
         private RedisConfiguration $redisConfiguration,
-        private RedisConnectionPoolRepository $redisConnectionPoolRepository,
+        private RedisConnectionPoolRepositoryInterface $redisConnectionPoolRepository,
         private SerializerInterface $serializer,
         private SessionConfiguration $sessionConfiguration,
         public string $id,

diff --git a/src/SessionManager.php b/src/SessionManager.php
@@ -22,7 +22,7 @@
     public function __construct(
         private CookieManager $cookieManager,
         private RedisConfiguration $redisConfiguration,
-        private RedisConnectionPoolRepository $redisConnectionPoolRepository,
+        private RedisConnectionPoolRepositoryInterface $redisConnectionPoolRepository,
         private SecureIdentifierGenerator $secureIdentifierGenerator,
         private SerializerInterface $serializer,
         private SessionConfiguration $sessionConfiguration,

diff --git a/src/SingletonProvider/DatabaseConnectionPoolRepositoryProvider.php b/src/SingletonProvider/DatabaseConnectionPoolRepositoryProvider.php
@@ -4,8 +4,10 @@
 
 namespace Distantmagic\Resonance\SingletonProvider;
 
+use Distantmagic\Resonance\Attribute\RequiresBackendDriver;
 use Distantmagic\Resonance\Attribute\RequiresPhpExtension;
 use Distantmagic\Resonance\Attribute\Singleton;
+use Distantmagic\Resonance\BackendDriver;
 use Distantmagic\Resonance\DatabaseConfiguration;
 use Distantmagic\Resonance\DatabaseConnectionPoolRepository;
 use Distantmagic\Resonance\PHPProjectFiles;
@@ -17,6 +19,7 @@
 /**
  * @template-extends SingletonProvider<DatabaseConnectionPoolRepository>
  */
+#[RequiresBackendDriver(BackendDriver::Swoole)]
 #[RequiresPhpExtension('pdo')]
 #[Singleton(provides: DatabaseConnectionPoolRepository::class)]
 final readonly class DatabaseConnectionPoolRepositoryProvider extends SingletonProvider

diff --git a/...RedisConnectionPoolRepositoryProvider.php → ...RedisConnectionPoolRepositoryProvider.php b/...RedisConnectionPoolRepositoryProvider.php → ...RedisConnectionPoolRepositoryProvider.php
@@ -4,28 +4,32 @@
 
 namespace Distantmagic\Resonance\SingletonProvider;
 
+use Distantmagic\Resonance\Attribute\RequiresBackendDriver;
 use Distantmagic\Resonance\Attribute\RequiresPhpExtension;
 use Distantmagic\Resonance\Attribute\Singleton;
+use Distantmagic\Resonance\BackendDriver;
 use Distantmagic\Resonance\PHPProjectFiles;
 use Distantmagic\Resonance\RedisConfiguration;
 use Distantmagic\Resonance\RedisConnectionPoolRepository;
+use Distantmagic\Resonance\RedisConnectionPoolRepositoryInterface;
 use Distantmagic\Resonance\SingletonContainer;
 use Distantmagic\Resonance\SingletonProvider;
 use Swoole\Database\RedisConfig;
 use Swoole\Database\RedisPool;
 
 /**
- * @template-extends SingletonProvider<RedisConnectionPoolRepository>
+ * @template-extends SingletonProvider<RedisConnectionPoolRepositoryInterface>
  */
+#[RequiresBackendDriver(BackendDriver::Swoole)]
 #[RequiresPhpExtension('redis')]
-#[Singleton(provides: RedisConnectionPoolRepository::class)]
-final readonly class RedisConnectionPoolRepositoryProvider extends SingletonProvider
+#[Singleton(provides: RedisConnectionPoolRepositoryInterface::class)]
+final readonly class SwooleRedisConnectionPoolRepositoryProvider extends SingletonProvider
 {
     public function __construct(
         private RedisConfiguration $databaseConfiguration,
     ) {}
 
-    public function provide(SingletonContainer $singletons, PHPProjectFiles $phpProjectFiles): RedisConnectionPoolRepository
+    public function provide(SingletonContainer $singletons, PHPProjectFiles $phpProjectFiles): RedisConnectionPoolRepositoryInterface
     {
         $redisConnectionPoolRepository = new RedisConnectionPoolRepository();
 
@@ -44,9 +48,4 @@ public function provide(SingletonContainer $singletons, PHPProjectFiles $phpProj
 
         return $redisConnectionPoolRepository;
     }
-
-    public function shouldRegister(): bool
-    {
-        return false;
-    }
 }
diff --git a/src/SwooleServer.php b/src/SwooleServer.php
@@ -5,6 +5,7 @@
 namespace Distantmagic\Resonance;
 
 use Distantmagic\Resonance\Attribute\GrantsFeature;
+use Distantmagic\Resonance\Attribute\RequiresBackendDriver;
 use Distantmagic\Resonance\Attribute\Singleton;
 use Distantmagic\Resonance\Event\HttpServerBeforeStop;
 use Distantmagic\Resonance\Event\HttpServerStarted;
@@ -19,6 +20,7 @@
 use Throwable;
 
 #[GrantsFeature(Feature::SwooleTaskServer)]
+#[RequiresBackendDriver(BackendDriver::Swoole)]
 #[Singleton]
 readonly class SwooleServer
 {

diff --git a/src/SwooleTaskServerMessageBroker.php b/src/SwooleTaskServerMessageBroker.php
@@ -4,11 +4,13 @@
 
 namespace Distantmagic\Resonance;
 
+use Distantmagic\Resonance\Attribute\RequiresBackendDriver;
 use Distantmagic\Resonance\Attribute\Singleton;
 use Ds\Set;
 use Swoole\Server;
 use Symfony\Component\Messenger\Envelope;
 
+#[RequiresBackendDriver(BackendDriver::Swoole)]
 #[Singleton]
 readonly class SwooleTaskServerMessageBroker
 {

diff --git a/src/TickTimerScheduler.php b/src/TickTimerScheduler.php
@@ -4,10 +4,12 @@
 
 namespace Distantmagic\Resonance;
 
+use Distantmagic\Resonance\Attribute\RequiresBackendDriver;
 use Distantmagic\Resonance\Attribute\Singleton;
 use RuntimeException;
 use Swoole\Timer;
 
+#[RequiresBackendDriver(BackendDriver::Swoole)]
 #[Singleton]
 class TickTimerScheduler
 {

diff --git a/src/WebSocketProtocolController/JsonRPCProtocolController.php b/src/WebSocketProtocolController/JsonRPCProtocolController.php
@@ -6,8 +6,10 @@
 
 use Distantmagic\Resonance\Attribute\ControlsWebSocketProtocol;
 use Distantmagic\Resonance\Attribute\GrantsFeature;
+use Distantmagic\Resonance\Attribute\RequiresBackendDriver;
 use Distantmagic\Resonance\Attribute\Singleton;
 use Distantmagic\Resonance\AuthenticatedUserStoreAggregate;
+use Distantmagic\Resonance\BackendDriver;
 use Distantmagic\Resonance\ConstraintResultErrorMessage;
 use Distantmagic\Resonance\CSRFManager;
 use Distantmagic\Resonance\Feature;
@@ -37,6 +39,7 @@
 
 #[ControlsWebSocketProtocol(WebSocketProtocol::JsonRPC)]
 #[GrantsFeature(Feature::WebSocket)]
+#[RequiresBackendDriver(BackendDriver::Swoole)]
 #[Singleton(collection: SingletonCollection::WebSocketProtocolController)]
 final readonly class JsonRPCProtocolController extends WebSocketProtocolController
 {

diff --git a/src/WebSocketServerConnectionTable.php b/src/WebSocketServerConnectionTable.php
@@ -5,6 +5,7 @@
 namespace Distantmagic\Resonance;
 
 use Distantmagic\Resonance\Attribute\GrantsFeature;
+use Distantmagic\Resonance\Attribute\RequiresBackendDriver;
 use Distantmagic\Resonance\Attribute\Singleton;
 use Generator;
 use IteratorAggregate;
@@ -15,6 +16,7 @@
  * @template-implements IteratorAggregate<int,int>
  */
 #[GrantsFeature(Feature::WebSocket)]
+#[RequiresBackendDriver(BackendDriver::Swoole)]
 #[Singleton]
 readonly class WebSocketServerConnectionTable implements IteratorAggregate
 {

diff --git a/src/WebSocketServerController.php b/src/WebSocketServerController.php
@@ -6,6 +6,7 @@
 
 use Distantmagic\Resonance\Attribute\GrantsFeature;
 use Distantmagic\Resonance\Attribute\HandlesServerPipeMessage;
+use Distantmagic\Resonance\Attribute\RequiresBackendDriver;
 use Distantmagic\Resonance\Attribute\Singleton;
 use Distantmagic\Resonance\PsrMessage\SwooleServerRequest;
 use Distantmagic\Resonance\ServerPipeMessage\CloseWebSocketConnection;
@@ -23,6 +24,7 @@
  */
 #[GrantsFeature(Feature::WebSocket)]
 #[HandlesServerPipeMessage(CloseWebSocketConnection::class)]
+#[RequiresBackendDriver(BackendDriver::Swoole)]
 #[Singleton(collection: SingletonCollection::ServerPipeMessageHandler)]
 final readonly class WebSocketServerController implements ServerPipeMessageHandlerInterface
 {