SymfonyCon 2025 - MultiTenant

Transcript

1. Multi-Tenantising The Symfony Components Iain Cambridge
2. Background - BillaBear • BillaBear - A Symfony based billing system • Started as a standalone version • Later I added a cloud hosted version • The aim to have both use the same basic code base with cloud being modified for multi-tenant • Have the ability to test without having to worry about the multi-tenantancy part
3. What I Needed To Modify • Console - Commands • Messenger Component • Scheduler Component • Cache Component
4. Foundation - Tenant Interfaces #1 interface TenantSwitcher { public function switchBySubdomain(string $subdomain): void; public function switchById(string $id): void; } interface TenantProvider { public function getTenant(): Tenant; }
5. Foundation - Tenant Interfaces #2 interface TenantRepositoryInterface { /** * @return \Generator|Tenant[] */ public function getAllActive(): \Generator; }
6. Console - Commands - Steps • Automatically add an option to all commands • Automatically read the value of that option and use it to set the tenant
7. Commands - Add options automatically class MultiTenantPass implements CompilerPassInterface { public function process(ContainerBuilder $container) { $commands = $container->findTaggedServiceIds('console.command'); foreach ($commands as $id => $tagInfo) { $definition = $container->getDefinition($id); $definition->addMethodCall('addOption', ['tenant', null, InputOption::VALUE_REQUIRED]); } } }
8. Commands - Switch tenant automatically - #1 class MultiTenantCommandListener implements EventSubscriberInterface { public function __construct( private TenantSwitcher $tenantSwitcher, ) { } public static function getSubscribedEvents() { return [ ConsoleEvents::COMMAND => 'onCommand', ]; } // ...
9. \Symfony\Component\Console\Application::doRunCommand // @ line 1090 $this->dispatcher->dispatch($event, ConsoleEvents::COMMAND); if ($event->commandShouldRun()) { $exitCode = $command->run($input, $output); } else { $exitCode = ConsoleCommandEvent::RETURN_CODE_DISABLED; }
10. Commands - Switch tenant automatically - #2 class MultiTenantCommandListener implements EventSubscriberInterface { // ... public function onCommand(ConsoleCommandEvent $event) { if (!$event->getInput()->hasOption('tenant')) { return; } $tenant = $event->getInput()->getOption('tenant'); if (!$tenant) { return; } $this->tenantSwitcher->switchBySubdomain($tenant); } }
11. Messenger - Steps • Create a messenger stamp to declare the tenant • Create a middleware that adds the stamp • Create an event subscriber that uses the stamp to set the tenant
12. Messenger - Stamp class TenantStamp implements StampInterface { public function __construct( private string $tenantId, ) { } public function getTenantId(): string { return $this->tenantId; } }
13. Messenger - Middleware class TenantAssignerMiddleware implements MiddlewareInterface { public function __construct( private TenantProvider $tenantProvider, ) { } public function handle(Envelope $envelope, StackInterface $stack): Envelope { $last = $envelope->last(TenantStamp::class); if (null !== $last) { // Set somewhere else so we'll respect it. return $stack->next()->handle($envelope, $stack); } $tenant = $this->tenantProvider->getTenant(); $tenantId = (string) $tenant->getId(); $envelope = $envelope->with(new TenantStamp($tenantId)); return $stack->next()->handle($envelope, $stack); } }
14. Messenger - Event Subscriber #1 class WorkerMessageReceivedSubscriber implements EventSubscriberInterface { public function __construct( private TenantSwitcher $tenantSwitcher ) { } public static function getSubscribedEvents() { return [ WorkerMessageReceivedEvent::class => 'onWorkerReceived', ]; }
15. \Symfony\Component\Messenger\Worker::handleMessage // @ Line 154 $event = new WorkerMessageReceivedEvent($envelope, $transportName); $this->eventDispatcher?->dispatch($event); $envelope = $event->getEnvelope(); if (!$event->shouldHandle()) { return; } // Handle message ...
16. Messenger - Event Subscriber #2 public function onWorkerReceived( WorkerMessageReceivedEvent $event, ) { $envelope = $event->getEnvelope(); $tenantStamp = $envelope->last(TenantStamp::class); if (!$tenantStamp instanceof TenantStamp) { return; } $id = $tenantStamp->getTenantId(); $this->tenantSwitcher->switchById($id); } }
17. Scheduler - Steps 1. Create an interface to show it’s a Scheduler message 2. Create a messenger stamp to show it’s been created for a tenant 3. Create a messenger middleware to create a message for each tenant 4. Create a messenger middleware to switch to the correct tenant
18. Scheduler - Interface interface ScheduleMessageInterface { }
19. Scheduler - Stamp use Symfony\Component\Messenger\Stamp\StampInterface; class SchedaulerStamp implements StampInterface { }
20. Scheduler - Duplicate Messages Middleware #1 class ScheduleMiddleware implements MiddlewareInterface { public function __construct( private MessageBusInterface $messageBus, private TenantRepositoryInterface $tenantRepository, ) { } public function handle(Envelope $envelope, StackInterface $stack): Envelope {
21. Scheduler - Duplicate Messages Middleware #2 if (!$envelope->getMessage() instanceof ScheduleMessageInterface) { return $stack->next()->handle($envelope, $stack); } // Check if the message has already been duplicated if (null !== $envelope->last(SchedulerStamp::class)) { return $stack->next()->handle($envelope, $stack); } // ...
22. Scheduler - Duplicate Messages Middleware #3 // ... $allTenants = $this->tenantRepository->getAllActive(); $lastTenant = $allTenants->current(); $allTenants->next(); while ($allTenants->valid()) { $tenant = $allTenants->current(); $allTenants->next(); $duplicateEnvelope = clone $envelope; $duplicateEnvelope = $duplicateEnvelope->with( new SchedulerStamp(), new TenantStamp((string) $tenant->getId()), ); $this->messageBus->dispatch($duplicateEnvelope); }
23. Scheduler - Duplicate Messages Middleware #4 // ... $duplicateEnvelope = $envelope->with( new SchedulerStamp(), new TenantStamp((string) $lastTenant->getId()), ); return $stack->next()->handle( $duplicateEnvelope, $stack, ); } }
24. Scheduler - Switcher Middleware - #1 class ScheduleSwitcherMiddleware implements MiddlewareInterface { public function __construct( private TenantSwitcher $tenantSwitcher, ) { } public function handle(Envelope $envelope, StackInterface $stack): Envelope { // ...
25. Scheduler - Switcher Middleware - #2 // ... if (!$envelope->getMessage() instanceof ScheduleMessageInterface) { return $stack->next()->handle($envelope, $stack); } $tenantStamp = $envelope->last(TenantStamp::class); $this->tenantSwitcher->switchById($tenantStamp->getTenantId()); return $stack->next()->handle($envelope, $stack); } }
26. Cache - Steps • Create a factory to create cache adapters • Create Service definition for factory • Change config to use factory
27. Cache - Factory class Factory { public function __construct( #[Autowire('%redis_connection%')] private string $connection, private \Psr\Log\LoggerInterface $cacheLogger, ) { } public function createApp(): AdapterInterface { $redis = new \Redis(['host' => $this->connection]); $adapter = new RedisAdapter($redis, $this->getNamespace()); $adapter->setLogger($this->cacheLogger); return $adapter; } private function getNamespace() { $request = explode('.', $_SERVER['HTTP_HOST'] ?? 'system')[0]; return sprintf('tenant_%s', $request); } }
28. Cache - Service parameters: redis_connection: '%env(string:REDIS_URL)%' services: cache.tenant.redis: class: Symfony\Component\Cache\Adapter\RedisAdapter factory: ['@Cloud\Cache\Factory', 'createSystem'] public: true
29. Cache - Config framework: cache: system: cache.adapter.apcu pools: doctrine.result_cache_pool: adapter: cache.adapter.psr6 provider: 'cache.tenant.redis'
30. Any Questions?