diff --git a/coverage-report/pom.xml b/coverage-report/pom.xml index 24a5e69..b216a80 100644 --- a/coverage-report/pom.xml +++ b/coverage-report/pom.xml @@ -21,7 +21,7 @@ axon-multitenancy-parent org.axonframework.extensions.multitenancy - 4.12.1-SNAPSHOT + 5.1.0-SNAPSHOT axon-coverage-report @@ -38,13 +38,19 @@ org.axonframework.extensions.multitenancy - axon-multitenancy-spring-boot-autoconfigure + axon-multitenancy-spring ${project.version} runtime org.axonframework.extensions.multitenancy - axon-multitenancy-spring-boot-3-integrationtests + axon-multitenancy-axon-server-connector + ${project.version} + runtime + + + org.axonframework.extensions.multitenancy + axon-multitenancy-spring-boot-autoconfigure ${project.version} runtime diff --git a/docs/reference/modules/ROOT/pages/configuration.adoc b/docs/reference/modules/ROOT/pages/configuration.adoc deleted file mode 100644 index 12e5ae6..0000000 --- a/docs/reference/modules/ROOT/pages/configuration.adoc +++ /dev/null @@ -1,276 +0,0 @@ -:navtitle: Configuration -= Configuration - -Minimal configuration is needed to get extension up and running. - -== Static tenants configuration - -If you know list of contexts that you want your application to connect in advanced configure them coma separated in `application.properties` via following properties: `axon.axonserver.contexts=tenant-context-1,tenant-context-2,tenant-context-3` - -== Dynamic tenants configuration - -If you don't know tenants in advance and you plan to create them in runtime, you can define a predicate which will tell application to which contexts to connect to in runtime: - -[source,java] ----- -@Bean -public TenantConnectPredicate tenantFilterPredicate() { - return context -> context.tenantId().startsWith("tenant-"); -} ----- - -Note that in this case you need to remove axon.axonserver.contexts property. - -== Route message to specific tenant - -By default, to route message to specific tenant you need to tag initial message that enters your system with metadata . This is done with meta-data helper, and you need to add tenant name to metadata with key `TenantConfiguration.TENANT_CORRELATION_KEY`. - -[source,java] ----- -message.andMetaData(Collections.singletonMap(TENANT_CORRELATION_KEY, "tenant-context-1") ----- - -Metadata needs to be added only to initial message that enters your system. Any message that is produced by consequence of initial message will have this metadata copied automatically using to `CorrelationProvider`. - -=== Custom resolver - -If you wish to disable default meta-data based routing define following property: - -[source,java] ----- -axon.multi-tenancy.use-metadata-helper=false ----- - -And define custom tenant resolver bean. For example following imaginary bean can use message payload to route message to specific tenant: - -[source,java] ----- - -@Bean -public TargetTenantResolver> customTargetTenantResolver() { - return (message, tenants) -> //<.> - TenantDescriptor.tenantWithId( - message.getPayload().getField("tenantName") - ); -} ----- -<.> First lambda parameter message represents message to be routed, while second parameter tenants represents list of currently registered tenants, if you wish to use is to route only to one of connected tenants. - -== Multi-tenant projections - -If you wish to use distinct database to store projections and token store for each tenant, configure following bean: - -[source,java] ----- -@Bean -public Function tenantDataSourceResolver() { - return tenant -> { - DataSourceProperties properties = new DataSourceProperties(); - properties.setUrl("jdbc:postgresql://localhost:5432/"+tenant.tenantId()); - properties.setDriverClassName("org.postgresql.Driver"); - properties.setUsername("postgres"); - properties.setPassword("postgres"); - return properties; - }; -} ----- - -Note that this works by using JPA multi-tenancy support, that means only SQL Databases are supported out of the box. If you wish to implement multi-tenancy for a different type of databases (for example, NoSQL) make sure that your projection database supports multi-tenancy. While in transaction you may find out which tenant owns transaction by calling: `TenantWrappedTransactionManager.getCurrentTenant()`. - -For more hints how to enable multi-tenancy for NoSQL databases check on how JPA SQL version is link:https://github.com/AxonFramework/extension-multitenancy/blob/main/multitenancy-spring-boot-autoconfigure/src/main/java/org/axonframework/extensions/multitenancy/autoconfig/MultiTenantDataSourceManager.java[implemented,window=_blank,role=external] - -IMPORTANT: In this case Liquibase or Flyway will not be able to initialise schemas for dynamic data sources. Any datasource that you use needs to have pre-initialized schema. - -== Query update emitter - -In order to correctly resolve right query update emitter inject update emitter in following style: - -[source,java] ----- -@EventHandler -public void on(Event event, QueryUpdateEmitter queryUpdateEmitter) { - //queryUpdateEmitter will route updates to same tenant as event will be - ... -} ----- - -=== Resetting projections - -Resetting projections works a bit different because you have instanced of each event processor group for each tenant. - -Reset specific tenant event processor group: - -[source,java] ----- -TrackingEventProcessor trackingEventProcessor = - configuration.eventProcessingConfiguration() - .eventProcessor("com.demo.query-ep@tenant-context-1", - TrackingEventProcessor.class) - .get(); ----- - -Name of each event processor is: `{even processor name}@{tenant name}` - -Access all tenant event processors by retrieving `MultiTenantEventProcessor` only. `MultiTenantEventProcessor` acts as a proxy Event Processor that references all tenant event processors. - -==== Dead-letter queue -The configuration of a dead-letter queue is similar to a non-multi-tenant environment. The tenant will be resolved through the Message's `MetaData` and routed to the corresponding DLQ. If you wish to have different enqueuing policies per tenant, you can use the `MetaData` from the dead letter message to determine to which tenant the message belongs to act accordingly. - -Do note that processing dead letters from the queue is slightly different, as you need the specific tenant context to process dead-letter from. - -To select the tenant for which you want to process a dead letter, you need to cast the `SequencedDeadLetterProcessor` to a `MultiTenantDeadLetterProcessor`. From the `MultiTenantDeadLetterProcessor`, you need to use the `forTenant` method to select the tenant-specific `SequencedDeadLetterProcessor`. - -[source,java] ----- -public class DlqManagement { - - private MultiTenantDeadLetterProcessor multiTenantDeadLetterProcessor; - - // Axon Framework's org.axonframework.config.Configuration - public DlqManagement(Configuration configuration) { - SequencedDeadLetterProcessor deadLetterProcessor = configuration.sequencedDeadLetterProcessor(); - this.multiTenantDeadLetterProcessor = (MultiTenantDeadLetterProcessor) deadLetterProcessor; - } - - public void processDeadLetterSequenceForTenant(String tenantId, - Predicate>> sequenceFilter) { - multiTenantDeadLetterProcessor.forTenant(tenantId) - .process(sequenceFilter); - } -} ----- - -Here is a full example of a REST endpoint to retry dead letters for a specific tenant: - -[source,java] ----- -public class DlqManagementController { - - // Axon Framework's org.axonframework.config.Configuration - private Configuration configuration; - - @PostMapping(path = "/retry-dlq") - public void retryDLQ(@RequestParam String tenant, @RequestParam String processingGroup) { - configuration.eventProcessingConfiguration() - .sequencedDeadLetterProcessor(processingGroup) - .map(p -> (MultiTenantDeadLetterProcessor) p) - .map(mp -> mp.forTenant(TenantDescriptor.tenantWithId(tenant))) - .ifPresent(SequencedDeadLetterProcessor::processAny); - } -} ----- - -WARNING: Only JPA Dead letter queue and In-Memory queues are supported. - -=== Deadline manager - -As of now, there is no plan to support deadline manager out of the box. None of deadline manager implementation support multi-tenancy. See Event scheduler section as alternative. - -=== Event scheduler - -You can use the `MultiTenantEventScheduler` to schedule events for specific tenants. To do so, you can inject the `EventScheduler` and use it to schedule events: - -[source,java] ----- -public class EventHandlingComponentSchedulingEvents { - - private EventScheduler eventScheduler; - - @EventHandler - public void eventHandler(Event event) { - // Schedules the given event to be published in 10 days. - ScheduledToken token = eventScheduler.schedule(Instant.now().plusDays(10), event); - // The token returned by EventScheduler#schedule can be used to, for example, cancel the scheduled task. - eventScheduler.cancelSchedule(token); - } -} ----- - -If you use the `EventScheduler` from any message handling method, it will automatically pick up tenant from `Message#metadata`. Hence, there is no need to specify the tenant you want to schedule an event for. If you wish to use the `EventScheduler` outside of message handlers, you are inclined to wrap the execution into a so-called `TenantWrappedTransactionManager`. Within this `TenantWrappedTransactionManager` you can schedule the event: - -[source,java] ----- -public class EventSchedulingComponent { - - private EventScheduler eventScheduler; - - public void schedule(Event event) { - ScheduledToken token; - // Schedules the given event to be published in 10 days. - new TenantWrappedTransactionManager( - TenantDescriptor.tenantWithId(tenantName)) - .executeInTransaction( - () -> token = eventScheduler.schedule(Instant.now().plusDays(10), event) - ); - // The token returned by EventScheduler#schedule can be used to, for example, cancel the scheduled task. - new TenantWrappedTransactionManager( - TenantDescriptor.tenantWithId(tenantName)) - .executeInTransaction( - () -> eventScheduler.cancelSchedule(token) - ); - } -} ----- - -=== Advanced configuration - -==== Overriding default message source - -You can override the default message source for each tenant by defining the following bean: - -[source,java] ----- -@Bean -public MultiTenantStreamableMessageSourceProvider multiTenantStreamableMessageSourceProvider(AxonServerEventStore customSource) { - return (defaultTenantSource, processorName, tenantDescriptor, configuration) -> { - if (tenantDescriptor.tenantId().startsWith("tenant-custom")) { - return customSource; - } - return defaultTenantSource; - }; -} ----- - -This bean should return a `StreamableMessageSource` that will be used for specific tenants. This lambda will be called for each tenant and each event processor, so be sure to return a default tenant source if you don't want to override it. - -==== Disable multi-tenancy for specific event processor - -In certain cases, you may want to disable multi-tenancy for specific Event Processor which does not have any tenants. -For example, when you have an event processor that is consuming events from an external context. -Per default, each event processor is scaled, and duplicated for each tenant. To disable this behavior for a specific processing, you can define following bean: - -[source,java] ----- -@Bean -public MultiTenantEventProcessorPredicate multiTenantEventProcessorPredicate() { - return (processorName) -> !processorName.equals("external-context"); -} ----- - -This bean should return `true` for each processor that you want to be multi-tenant, and `false` for each processor that you want to be single tenant. - -=== Tenant Segment Factories - -This extension provides several factory interfaces that are used to create tenant-specific segments for various Axon components, such as Command Bus, Query Bus, Event Store, and Event Scheduler. These factories allow you to configure and customize the behavior of these components for each tenant. - -The following tenant segment factories are available: - -==== TenantCommandSegmentFactory - -This factory is responsible for creating a `CommandBus` instance for each tenant. By default, it creates an `AxonServerCommandBus` that uses a `SimpleCommandBus` as the local segment and connects to Axon Server. You can override this factory to provide a custom implementation of the `CommandBus` for specific tenants. - -==== TenantQuerySegmentFactory - -This factory creates a `QueryBus` instance for each tenant. By default, it creates an `AxonServerQueryBus` that uses a `SimpleQueryBus` as lhe local segment and connects to Axon Server. You can override this factory to provide a custom implementation of the `QueryBus` for specific tenants. - -==== TenantEventSegmentFactory - -This factory is responsible for creating an `EventStore` instance for each tenant. By default, it creates an `AxonServerEventStore` that connects to Axon Server. You can override this factory to provide a custom implementation of the `EventStore` for specific tenants. - -==== TenantEventSchedulerSegmentFactory - -This factory creates an `EventScheduler` instance for each tenant. By default, it creates an `AxonServerEventScheduler` that connects to Axon Server. You can override this factory to provide a custom implementation of the `EventScheduler` for specific tenants. - -==== TenantEventProcessorControlSegmentFactory - -This factory creates a `TenantDescriptor` for each event processor, which is used to identify the tenant associated with the event processor. By default, it uses the tenant identifier as the `TenantDescriptor`. You can override this factory to provide a custom implementation of the `TenantDescriptor` for specific event processors. diff --git a/docs/reference/modules/ROOT/pages/configuration/dynamic-tenants.adoc b/docs/reference/modules/ROOT/pages/configuration/dynamic-tenants.adoc new file mode 100644 index 0000000..25992dc --- /dev/null +++ b/docs/reference/modules/ROOT/pages/configuration/dynamic-tenants.adoc @@ -0,0 +1,513 @@ +:navtitle: Dynamic Tenants += Dynamic Tenant Management + +Tenants can be added and removed at runtime without restarting the application. This page covers how to manage tenant lifecycle dynamically. + +== Overview + +Dynamic tenant management enables: + +* Adding new tenants when customers sign up +* Removing tenants when subscriptions end +* Filtering which tenants the application connects to +* Responding to external tenant events (e.g., from Axon Server) + +== TenantProvider Interface + +The `TenantProvider` interface manages the set of known tenants: + +[source,java] +---- +public interface TenantProvider { + + Registration subscribe(MultiTenantAwareComponent component); + + List getTenants(); +} +---- + +When tenants are added or removed, the provider notifies all subscribed `MultiTenantAwareComponent` instances, which create or destroy their tenant-specific resources. + +== SimpleTenantProvider + +`SimpleTenantProvider` is the standard implementation for programmatic tenant management: + +=== Creating with Initial Tenants + +[source,java] +---- +import org.axonframework.extension.multitenancy.core.SimpleTenantProvider; +import org.axonframework.extension.multitenancy.core.TenantDescriptor; + +// From a list +SimpleTenantProvider provider = new SimpleTenantProvider(List.of( + TenantDescriptor.tenantWithId("stanford"), + TenantDescriptor.tenantWithId("mit"), + TenantDescriptor.tenantWithId("berkeley") +)); + +// Or empty, to be populated later +SimpleTenantProvider provider = new SimpleTenantProvider(); +---- + +=== Adding Tenants at Runtime + +[source,java] +---- +TenantDescriptor newTenant = TenantDescriptor.tenantWithId("caltech"); + +boolean added = provider.addTenant(newTenant); +// Returns true if added, false if already registered + +// Add multiple tenants +provider.addTenants(List.of( + TenantDescriptor.tenantWithId("caltech"), + TenantDescriptor.tenantWithId("princeton") +)); +---- + +When a tenant is added: + +1. The tenant is added to the provider's registry +2. All subscribed `MultiTenantAwareComponent` instances are notified +3. Each component creates and starts its tenant-specific resources +4. The new tenant becomes available for message routing + +=== Removing Tenants at Runtime + +[source,java] +---- +// Remove by descriptor +boolean removed = provider.removeTenant(TenantDescriptor.tenantWithId("caltech")); + +// Or by ID +boolean removed = provider.removeTenant("caltech"); +// Returns true if removed, false if not registered +---- + +When a tenant is removed: + +1. The tenant is removed from the provider's registry +2. All `Registration` handles are cancelled +3. Tenant-specific resources are cleaned up (event processors stopped, connections closed, etc.) +4. Messages to the removed tenant will throw `NoSuchTenantException` + +=== Checking Tenant Status + +[source,java] +---- +// Check if tenant exists +boolean exists = provider.hasTenant(TenantDescriptor.tenantWithId("stanford")); +boolean exists = provider.hasTenant("stanford"); + +// Get all tenants +List tenants = provider.getTenants(); +---- + +== Subscription Lifecycle + +The `subscribe()` method connects components to tenant lifecycle events: + +[source,java] +---- +// Components subscribe to receive tenant notifications +Registration registration = tenantProvider.subscribe(multiTenantEventStore); + +// On subscribe: +// 1. Existing tenants are registered with the component +// 2. Future tenant additions/removals will notify the component + +// To unsubscribe (e.g., during shutdown): +registration.cancel(); +---- + +=== MultiTenantAwareComponent Interface + +Components that manage per-tenant resources implement this interface: + +[source,java] +---- +public interface MultiTenantAwareComponent { + + // Called when a tenant is registered (at startup or dynamically) + Registration registerTenant(TenantDescriptor tenantDescriptor); + + // Called when a tenant is registered AND should be started immediately + Registration registerAndStartTenant(TenantDescriptor tenantDescriptor); +} +---- + +The returned `Registration` is called when the tenant is removed, allowing cleanup. + +== TenantConnectPredicate + +Filter which tenants the application connects to: + +[source,java] +---- +import org.axonframework.extension.multitenancy.core.TenantConnectPredicate; + +// Accept all tenants (default) +TenantConnectPredicate all = tenant -> true; + +// Filter by tenant ID pattern +TenantConnectPredicate production = tenant -> + !tenant.tenantId().startsWith("test-"); + +// Filter by tenant properties +TenantConnectPredicate euRegion = tenant -> + "eu".equals(tenant.properties().get("region")); +---- + +=== Configuration + +==== Axon Framework + +[source,java] +---- +MultiTenancyConfigurer.enhance(configurer) + .registerTenantProvider(config -> tenantProvider) + .registerTenantConnectPredicate(config -> tenant -> + !tenant.tenantId().startsWith("_admin") + ); +---- + +==== Spring Boot + +[source,java] +---- +@Bean +public TenantConnectPredicate tenantConnectPredicate() { + return tenant -> { + // Only connect to production tenants + return !tenant.tenantId().contains("test"); + }; +} +---- + +== AxonServerTenantProvider + +When using Axon Server, `AxonServerTenantProvider` discovers tenants from Axon Server contexts: + +=== Predefined Contexts + +[source,java] +---- +import org.axonframework.extension.multitenancy.axonserver.AxonServerTenantProvider; + +AxonServerTenantProvider provider = AxonServerTenantProvider.builder() + .axonServerConnectionManager(connectionManager) + .preDefinedContexts("stanford,mit,berkeley") // Comma-separated + .build(); +---- + +=== Dynamic Context Discovery + +Without predefined contexts, the provider discovers tenants via Axon Server's Admin API: + +[source,java] +---- +AxonServerTenantProvider provider = AxonServerTenantProvider.builder() + .axonServerConnectionManager(connectionManager) + .tenantConnectPredicate(tenant -> !tenant.tenantId().startsWith("_")) + .build(); + +// Discovers all contexts and filters out admin contexts +---- + +=== Subscribing to Context Updates + +The provider automatically subscribes to Axon Server context events: + +[source,java] +---- +// When a context is created in Axon Server: +// 1. Provider receives CREATED event +// 2. If predicate allows, tenant is added +// 3. All components create resources for new tenant + +// When a context is deleted: +// 1. Provider receives DELETED event +// 2. Tenant is removed +// 3. All tenant resources are cleaned up +// 4. Connection to Axon Server context is closed +---- + +=== Spring Boot Configuration + +[source,yaml] +---- +# application.yml +axon: + multi-tenancy: + enabled: true + axon-server: + # Predefined contexts (optional) + contexts: stanford,mit,berkeley + + # Filter admin contexts (default: true) + filter-admin-contexts: true +---- + +Without `contexts` configured, tenants are discovered dynamically from Axon Server. + +== Complete Example: REST API for Tenant Management + +[source,java] +---- +import org.axonframework.extension.multitenancy.core.SimpleTenantProvider; +import org.axonframework.extension.multitenancy.core.TenantDescriptor; +import org.springframework.web.bind.annotation.*; + +@RestController +@RequestMapping("/api/admin/tenants") +public class TenantManagementController { + + private final SimpleTenantProvider tenantProvider; + + public TenantManagementController(SimpleTenantProvider tenantProvider) { + this.tenantProvider = tenantProvider; + } + + @GetMapping + public List listTenants() { + return tenantProvider.getTenants().stream() + .map(TenantDescriptor::tenantId) + .toList(); + } + + @PostMapping("/{tenantId}") + public ResponseEntity addTenant(@PathVariable String tenantId) { + TenantDescriptor tenant = TenantDescriptor.tenantWithId(tenantId); + + if (tenantProvider.addTenant(tenant)) { + return ResponseEntity.ok("Tenant added: " + tenantId); + } else { + return ResponseEntity.badRequest() + .body("Tenant already exists: " + tenantId); + } + } + + @DeleteMapping("/{tenantId}") + public ResponseEntity removeTenant(@PathVariable String tenantId) { + if (tenantProvider.removeTenant(tenantId)) { + return ResponseEntity.ok("Tenant removed: " + tenantId); + } else { + return ResponseEntity.notFound().build(); + } + } + + @GetMapping("/{tenantId}/exists") + public boolean tenantExists(@PathVariable String tenantId) { + return tenantProvider.hasTenant(tenantId); + } +} +---- + +== Complete Example: Event-Driven Tenant Provisioning + +[source,java] +---- +@Component +public class TenantProvisioningHandler { + + private final SimpleTenantProvider tenantProvider; + + public TenantProvisioningHandler(SimpleTenantProvider tenantProvider) { + this.tenantProvider = tenantProvider; + } + + @EventHandler + public void on(UniversityOnboarded event) { + TenantDescriptor tenant = new TenantDescriptor( + event.universityId(), + Map.of( + "name", event.universityName(), + "region", event.region(), + "tier", event.subscriptionTier() + ) + ); + + tenantProvider.addTenant(tenant); + log.info("Provisioned tenant for university: {}", event.universityName()); + } + + @EventHandler + public void on(UniversityDecommissioned event) { + tenantProvider.removeTenant(event.universityId()); + log.info("Decommissioned tenant: {}", event.universityId()); + } +} +---- + +== Tenant Lifecycle Events + +Understanding the full lifecycle when tenants are added/removed: + +=== Tenant Addition Flow + +[source] +---- +tenantProvider.addTenant(tenant) + | + +-- For each subscribed component: + | + +-- MultiTenantCommandBus.registerAndStartTenant(tenant) + | +-- Creates SimpleCommandBus for tenant + | +-- Registers command handlers + | +-- Returns Registration for cleanup + | + +-- MultiTenantQueryBus.registerAndStartTenant(tenant) + | +-- Creates SimpleQueryBus for tenant + | +-- Registers query handlers + | +-- Returns Registration for cleanup + | + +-- MultiTenantEventStore.registerAndStartTenant(tenant) + | +-- Creates EventStore segment for tenant + | +-- Returns Registration for cleanup + | + +-- MultiTenantEventProcessor.registerAndStartTenant(tenant) + +-- Creates PooledStreamingEventProcessor for tenant + +-- Creates TokenStore for tenant + +-- Starts processing events + +-- Returns Registration for cleanup +---- + +=== Tenant Removal Flow + +[source] +---- +tenantProvider.removeTenant(tenant) + | + +-- Cancels all Registrations for tenant (in reverse order): + | + +-- EventProcessor Registration cancelled + | +-- Stops processing + | +-- Cleans up token store + | + +-- EventStore Registration cancelled + | +-- Closes event store segment + | + +-- QueryBus Registration cancelled + | +-- Unregisters query handlers + | +-- Closes query bus + | + +-- CommandBus Registration cancelled + +-- Unregisters command handlers + +-- Closes command bus +---- + +== Best Practices + +=== 1. Validate Before Adding + +[source,java] +---- +public void provisionTenant(String tenantId) { + // Validate tenant ID format + if (!isValidTenantId(tenantId)) { + throw new IllegalArgumentException("Invalid tenant ID: " + tenantId); + } + + // Check for duplicates + if (tenantProvider.hasTenant(tenantId)) { + throw new TenantAlreadyExistsException(tenantId); + } + + // Verify resources are available (database, etc.) + verifyResourcesAvailable(tenantId); + + tenantProvider.addTenant(TenantDescriptor.tenantWithId(tenantId)); +} +---- + +=== 2. Handle Removal Gracefully + +[source,java] +---- +public void decommissionTenant(String tenantId) { + // Drain in-flight messages first + drainMessagesForTenant(tenantId); + + // Remove tenant + tenantProvider.removeTenant(tenantId); + + // Archive data if needed + archiveTenantData(tenantId); +} +---- + +=== 3. Use TenantConnectPredicate for Filtering + +[source,java] +---- +// Filter at the provider level, not in business logic +TenantConnectPredicate predicate = tenant -> { + String region = tenant.properties().get("region"); + return "eu".equals(region); // This instance only handles EU tenants +}; +---- + +=== 4. Monitor Tenant Operations + +[source,java] +---- +public void addTenantWithMonitoring(TenantDescriptor tenant) { + Instant start = Instant.now(); + + boolean added = tenantProvider.addTenant(tenant); + + Duration duration = Duration.between(start, Instant.now()); + + if (added) { + meterRegistry.timer("tenant.provisioning") + .record(duration); + log.info("Tenant {} provisioned in {}ms", tenant.tenantId(), duration.toMillis()); + } +} +---- + +=== 5. Expose Health Information + +[source,java] +---- +@Component +public class TenantHealthIndicator implements HealthIndicator { + + private final TenantProvider tenantProvider; + + @Override + public Health health() { + List tenants = tenantProvider.getTenants(); + + return Health.up() + .withDetail("tenantCount", tenants.size()) + .withDetail("tenants", tenants.stream() + .map(TenantDescriptor::tenantId) + .toList()) + .build(); + } +} +---- + +== Thread Safety + +`SimpleTenantProvider` is thread-safe: + +* Uses `ConcurrentHashMap.newKeySet()` for tenant storage +* Uses `CopyOnWriteArrayList` for subscribers +* Safe to add/remove tenants from any thread + +[source,java] +---- +// Safe to call from multiple threads +executor.submit(() -> tenantProvider.addTenant(tenant1)); +executor.submit(() -> tenantProvider.addTenant(tenant2)); +executor.submit(() -> tenantProvider.removeTenant("old-tenant")); +---- + +== See Also + +* xref:tenant-resolution.adoc[Tenant Resolution] - How tenant context is determined +* xref:event-processors.adoc[Event Processors] - Per-tenant event processing +* xref:../tenant-management.adoc[Tenant Management Overview] - High-level concepts diff --git a/docs/reference/modules/ROOT/pages/configuration/event-processors.adoc b/docs/reference/modules/ROOT/pages/configuration/event-processors.adoc new file mode 100644 index 0000000..2cc087c --- /dev/null +++ b/docs/reference/modules/ROOT/pages/configuration/event-processors.adoc @@ -0,0 +1,481 @@ +:navtitle: Event Processors += Event Processor Configuration + +Multi-tenant event processing creates isolated event processors per tenant. This page covers how to configure multi-tenant event processors and their token stores. + +== Overview + +In a multi-tenant application, each tenant needs its own event processor to: + +* Process events from their own event store +* Track progress independently via per-tenant token stores +* Scale separately based on tenant workload + +[source] +---- +MultiTenantEventProcessor ["courseProjection"] + | + +-- PooledStreamingEventProcessor ["courseProjection@stanford"] + | └── TokenStore (stanford) + | + +-- PooledStreamingEventProcessor ["courseProjection@mit"] + | └── TokenStore (mit) + | + +-- PooledStreamingEventProcessor ["courseProjection@berkeley"] + └── TokenStore (berkeley) +---- + +== MultiTenantPooledStreamingEventProcessorModule + +This module creates a `MultiTenantEventProcessor` that wraps per-tenant `PooledStreamingEventProcessor` instances. + +=== Basic Usage + +[source,java] +---- +import org.axonframework.extension.multitenancy.messaging.eventhandling.processing.MultiTenantPooledStreamingEventProcessorModule; + +configurer.messaging(m -> m + .eventProcessing(ep -> ep + .pooledStreaming(ps -> ps + .processor( + MultiTenantPooledStreamingEventProcessorModule + .create("courseProjection") + .eventHandlingComponents(c -> c + .autodetected(cfg -> new CourseProjector()) + ) + ) + ) + ) +); +---- + +=== With Configuration Customization + +[source,java] +---- +MultiTenantPooledStreamingEventProcessorModule + .create("courseProjection") + .eventHandlingComponents(c -> c + .autodetected(cfg -> new CourseProjector()) + ) + .customized((cfg, config) -> config + .batchSize(100) + .initialSegmentCount(4) + .maxClaimedSegments(2) + ) +---- + +=== With Tenant Components + +Register tenant-scoped dependencies for injection into handlers: + +[source,java] +---- +MultiTenantPooledStreamingEventProcessorModule + .create("courseProjection") + .eventHandlingComponents(c -> c + .autodetected(cfg -> new CourseProjector()) + ) + .tenantComponent(CourseRepository.class, tenant -> new InMemoryCourseRepository()) + .tenantComponent(MetricsService.class, tenant -> new TenantMetrics(tenant.tenantId())) +---- + +== TenantTokenStoreFactory + +The `TenantTokenStoreFactory` creates per-tenant token stores for tracking event processing progress: + +[source,java] +---- +@FunctionalInterface +public interface TenantTokenStoreFactory extends Function { + + @Override + TokenStore apply(TenantDescriptor tenant); +} +---- + +=== Available Implementations + +==== InMemoryTenantTokenStoreFactory (Default) + +Creates in-memory token stores. Suitable for testing and development: + +[source,java] +---- +import org.axonframework.extension.multitenancy.messaging.eventhandling.processing.InMemoryTenantTokenStoreFactory; + +// Default factory - creates InMemoryTokenStore per tenant +TenantTokenStoreFactory factory = new InMemoryTenantTokenStoreFactory(); +---- + +WARNING: In-memory token stores lose all progress on restart. Use JPA or JDBC implementations for production. + +==== JpaTenantTokenStoreFactory + +Creates JPA-based token stores with tenant-specific `EntityManagerFactory`: + +[source,java] +---- +import org.axonframework.extension.multitenancy.messaging.eventhandling.processing.JpaTenantTokenStoreFactory; +import org.axonframework.conversion.Converter; +import jakarta.persistence.EntityManagerFactory; + +// Provider for tenant-specific EntityManagerFactory +Function emfProvider = tenant -> { + // Return EMF configured for tenant's database + return createEntityManagerFactory(tenant); +}; + +// Create factory with converter from configuration +Converter converter = config.getComponent(Converter.class); +TenantTokenStoreFactory factory = new JpaTenantTokenStoreFactory(emfProvider, converter); +---- + +With custom JPA configuration: + +[source,java] +---- +import org.axonframework.messaging.eventhandling.processing.streaming.token.store.jpa.JpaTokenStoreConfiguration; + +JpaTokenStoreConfiguration jpaConfig = JpaTokenStoreConfiguration.builder() + .schema("tokens") + .build(); + +TenantTokenStoreFactory factory = new JpaTenantTokenStoreFactory( + emfProvider, + converter, + jpaConfig +); +---- + +==== Custom Implementation + +Create custom factories for other storage backends: + +[source,java] +---- +import org.axonframework.extension.multitenancy.messaging.eventhandling.processing.TenantTokenStoreFactory; +import org.axonframework.messaging.eventhandling.processing.streaming.token.store.jdbc.JdbcTokenStore; + +public class JdbcTenantTokenStoreFactory implements TenantTokenStoreFactory { + + private final Map tokenStores = new ConcurrentHashMap<>(); + private final TenantDataSourceProvider dataSourceProvider; + private final Converter converter; + + public JdbcTenantTokenStoreFactory( + TenantDataSourceProvider dataSourceProvider, + Converter converter) { + this.dataSourceProvider = dataSourceProvider; + this.converter = converter; + } + + @Override + public TokenStore apply(TenantDescriptor tenant) { + return tokenStores.computeIfAbsent(tenant, this::createTokenStore); + } + + private TokenStore createTokenStore(TenantDescriptor tenant) { + DataSource dataSource = dataSourceProvider.getDataSource(tenant); + ConnectionProvider connectionProvider = new DataSourceConnectionProvider(dataSource); + return JdbcTokenStore.builder() + .connectionProvider(connectionProvider) + .converter(converter) + .build(); + } +} +---- + +== Configuration + +=== Global Token Store Factory + +Configure a global factory used by all multi-tenant processors: + +==== Axon Framework + +[source,java] +---- +configurer.componentRegistry(cr -> cr.registerComponent( + TenantTokenStoreFactory.class, + config -> new JpaTenantTokenStoreFactory( + tenant -> getEntityManagerFactory(tenant), + config.getComponent(Converter.class) + ) +)); +---- + +==== Spring Boot + +[source,java] +---- +import org.axonframework.extension.multitenancy.messaging.eventhandling.processing.TenantTokenStoreFactory; +import org.springframework.context.annotation.Bean; +import org.springframework.context.annotation.Configuration; + +@Configuration +public class EventProcessorConfiguration { + + @Bean + public TenantTokenStoreFactory tenantTokenStoreFactory( + TenantDataSourceProvider dataSourceProvider, + Converter converter) { + return new JdbcTenantTokenStoreFactory(dataSourceProvider, converter); + } +} +---- + +=== Per-Processor Token Store Factory + +Override the global factory for a specific processor: + +[source,java] +---- +MultiTenantPooledStreamingEventProcessorModule + .create("auditLogProjection") + .eventHandlingComponents(c -> c.autodetected(cfg -> new AuditLogProjector())) + .customized((cfg, config) -> config + // Use dedicated token store for this processor + .tenantTokenStoreFactory(new JpaTenantTokenStoreFactory( + tenant -> getAuditEntityManagerFactory(tenant), + cfg.getComponent(Converter.class) + )) + ) +---- + +== MultiTenantEventProcessorPredicate + +Control which processing groups use multi-tenant processors: + +[source,java] +---- +import org.axonframework.extension.multitenancy.core.configuration.MultiTenantEventProcessorPredicate; + +// Enable multi-tenancy for all processors (default) +MultiTenantEventProcessorPredicate.enableMultiTenancy() + +// Disable multi-tenancy for all processors +MultiTenantEventProcessorPredicate.disableMultiTenancy() + +// Custom predicate - enable for specific processors +MultiTenantEventProcessorPredicate predicate = processorName -> + processorName.startsWith("tenant-") || processorName.equals("courseProjection"); +---- + +=== Spring Boot Configuration + +[source,java] +---- +import org.axonframework.extension.multitenancy.core.configuration.MultiTenantEventProcessorPredicate; +import org.springframework.context.annotation.Bean; + +@Bean +public MultiTenantEventProcessorPredicate multiTenantEventProcessorPredicate() { + return processorName -> { + // Only these processors are multi-tenant + Set multiTenantProcessors = Set.of( + "courseProjection", + "enrollmentProjection", + "gradeProjection" + ); + return multiTenantProcessors.contains(processorName); + }; +} +---- + +== Processing Group Configuration + +Each processing group becomes a multi-tenant event processor. Configure groups via annotations: + +[source,java] +---- +import org.axonframework.messaging.eventhandling.annotation.EventHandler; +import org.axonframework.messaging.eventhandling.annotation.ProcessingGroup; + +@ProcessingGroup("courseProjection") +@Component +public class CourseProjector { + + @EventHandler + public void on(CourseCreated event, CourseRepository repository) { + repository.save(new CourseReadModel( + event.courseId(), + event.name(), + event.capacity() + )); + } +} +---- + +Multiple handlers in the same group share the same multi-tenant processor: + +[source,java] +---- +@ProcessingGroup("courseProjection") +@Component +public class CourseStatsProjector { + + @EventHandler + public void on(StudentEnrolled event, CourseStatsRepository repository) { + repository.incrementEnrollmentCount(event.courseId()); + } +} +---- + +== Per-Tenant Processor Names + +The extension creates tenant-specific processor names by appending `@tenantId`: + +[source] +---- +Processing Group: "courseProjection" + +Per-Tenant Processors: + - courseProjection@stanford + - courseProjection@mit + - courseProjection@berkeley +---- + +This naming convention helps with: + +* Logging and debugging +* Metrics collection per tenant +* Token store isolation + +== Lifecycle Management + +=== Starting Processors + +Multi-tenant processors start during application startup: + +[source,java] +---- +// Lifecycle phases: +// 1. TenantProvider registers tenants +// 2. MultiTenantEventProcessor subscribes to TenantProvider +// 3. Per-tenant processors created for each registered tenant +// 4. All processors started +---- + +=== Dynamic Tenant Addition + +When a tenant is added at runtime: + +[source,java] +---- +// Adding a new tenant +tenantProvider.addTenant(TenantDescriptor.tenantWithId("caltech")); + +// Automatically triggers: +// 1. New PooledStreamingEventProcessor created: "courseProjection@caltech" +// 2. Token store created for caltech +// 3. Processor started, begins processing from initial token +---- + +=== Tenant Removal + +When a tenant is removed: + +[source,java] +---- +// Removing a tenant +tenantProvider.removeTenant(TenantDescriptor.tenantWithId("caltech")); + +// Automatically triggers: +// 1. Processor "courseProjection@caltech" stopped +// 2. Resources cleaned up +---- + +== Spring Boot Auto-Configuration + +Spring Boot auto-configures multi-tenant event processing when enabled: + +[source,yaml] +---- +# application.yml +axon: + multi-tenancy: + enabled: true # Default +---- + +The auto-configuration provides: + +* `MultiTenantMessageHandlerLookup` - Creates multi-tenant processors for `@EventHandler` components +* `InMemoryTenantTokenStoreFactory` - Default token store factory (override for production) + +=== Overriding Auto-Configuration + +[source,java] +---- +@Configuration +public class CustomEventProcessorConfig { + + // Override token store factory + @Bean + public TenantTokenStoreFactory tenantTokenStoreFactory( + TenantDataSourceProvider dataSourceProvider, + Converter converter) { + return new JpaTenantTokenStoreFactory( + tenant -> dataSourceProvider.getEntityManagerFactory(tenant), + converter + ); + } + + // Control which processors are multi-tenant + @Bean + public MultiTenantEventProcessorPredicate multiTenantEventProcessorPredicate() { + return processorName -> !processorName.equals("globalAuditProcessor"); + } +} +---- + +== Best Practices + +=== 1. Use Persistent Token Stores in Production + +[source,java] +---- +// Development/Testing +TenantTokenStoreFactory factory = new InMemoryTenantTokenStoreFactory(); + +// Production +TenantTokenStoreFactory factory = new JpaTenantTokenStoreFactory( + emfProvider, converter +); +---- + +=== 2. Configure Appropriate Batch Sizes + +[source,java] +---- +.customized((cfg, config) -> config + .batchSize(100) // Balance throughput vs memory +) +---- + +=== 3. Monitor Per-Tenant Processing + +Use metrics to track processing lag per tenant: + +[source,java] +---- +.customized((cfg, config) -> config + .messageMonitor(new TenantAwareMetricsMonitor()) +) +---- + +=== 4. Handle Tenant-Specific Errors + +[source,java] +---- +.customized((cfg, config) -> config + .errorHandler(new TenantAwareErrorHandler()) +) +---- + +== See Also + +* xref:tenant-components.adoc[Tenant Components] - Injecting tenant-scoped dependencies +* xref:../event-processors.adoc[Event Processors Overview] - General event processor concepts +* xref:dynamic-tenants.adoc[Dynamic Tenants] - Adding/removing tenants at runtime diff --git a/docs/reference/modules/ROOT/pages/configuration/tenant-components.adoc b/docs/reference/modules/ROOT/pages/configuration/tenant-components.adoc new file mode 100644 index 0000000..9c08a43 --- /dev/null +++ b/docs/reference/modules/ROOT/pages/configuration/tenant-components.adoc @@ -0,0 +1,523 @@ +:navtitle: Tenant Components += Tenant-Scoped Components + +Tenant-scoped components provide per-tenant dependencies to message handlers. This page covers how to define, register, and use tenant components. + +== Overview + +In multi-tenant applications, handlers often need tenant-specific resources like repositories, services, or configuration. Tenant components solve this by: + +* Creating isolated instances per tenant +* Automatically resolving the correct instance based on message context +* Managing lifecycle (creation and cleanup) per tenant + +[source] +---- +@EventHandler +void on(CourseCreated event, CourseRepository repository) { + // repository is automatically the correct tenant's instance + repository.save(new CourseReadModel(event)); +} +---- + +== TenantComponentFactory Interface + +The `TenantComponentFactory` is the core interface for creating tenant-scoped components: + +[source,java] +---- +@FunctionalInterface +public interface TenantComponentFactory extends Function { + + T apply(TenantDescriptor tenant); + + default void cleanup(TenantDescriptor tenant, T component) { + if (component instanceof AutoCloseable autoCloseable) { + try { + autoCloseable.close(); + } catch (Exception e) { + // Logged but not propagated + } + } + } +} +---- + +=== Simple Factory + +Use a lambda for simple cases: + +[source,java] +---- +TenantComponentFactory factory = + tenant -> new InMemoryCourseRepository(); +---- + +=== Factory with Tenant Context + +Access tenant information when creating components: + +[source,java] +---- +TenantComponentFactory factory = + tenant -> new JpaCourseRepository( + getDataSourceForTenant(tenant.tenantId()) + ); +---- + +=== Factory with Custom Cleanup + +Override cleanup for resources requiring special handling: + +[source,java] +---- +TenantComponentFactory factory = new TenantComponentFactory<>() { + + @Override + public EntityManagerFactory apply(TenantDescriptor tenant) { + return createEntityManagerFactory(tenant); + } + + @Override + public void cleanup(TenantDescriptor tenant, EntityManagerFactory emf) { + emf.close(); + logger.info("Closed EMF for tenant {}", tenant.tenantId()); + } +}; +---- + +== Registering Tenant Components + +=== Axon Framework (Programmatic) + +Use `MultiTenancyConfigurer.tenantComponent()`: + +[source,java] +---- +import org.axonframework.eventsourcing.configuration.EventSourcingConfigurer; +import org.axonframework.extension.multitenancy.core.configuration.MultiTenancyConfigurer; + +EventSourcingConfigurer configurer = EventSourcingConfigurer.create(); + +MultiTenancyConfigurer.enhance(configurer) + .registerTenantProvider(config -> tenantProvider) + .registerTargetTenantResolver(config -> new MetadataBasedTenantResolver()) + // Register tenant components + .tenantComponent(CourseRepository.class, tenant -> new InMemoryCourseRepository()) + .tenantComponent(MetricsService.class, tenant -> new TenantMetrics(tenant.tenantId())); +---- + +With custom cleanup: + +[source,java] +---- +MultiTenancyConfigurer.enhance(configurer) + .tenantComponent( + ConnectionPool.class, + tenant -> createPoolForTenant(tenant), + (tenant, pool) -> { + pool.drain(); + pool.close(); + } + ); +---- + +=== MultiTenantPooledStreamingEventProcessorModule + +Register per-processor tenant components: + +[source,java] +---- +MultiTenantPooledStreamingEventProcessorModule + .create("courseProjection") + .eventHandlingComponents(c -> c.autodetected(cfg -> new CourseProjector())) + .tenantComponent(CourseRepository.class, tenant -> new InMemoryCourseRepository()) + .tenantComponent(AuditService.class, tenant -> new TenantAuditService(tenant.tenantId())) +---- + +=== Spring Boot with TenantComponent Interface + +For Spring Boot applications, implement the `TenantComponent` interface for automatic discovery: + +[source,java] +---- +import org.axonframework.extension.multitenancy.spring.TenantComponent; +import org.axonframework.extension.multitenancy.core.TenantDescriptor; + +// Note: Do NOT add @Component annotation! +public class TenantAuditService implements TenantComponent { + + private final Clock clock; // Spring-injected dependency + private final String tenantId; // Tenant context + + // Constructor for factory instance - Spring injects Clock + public TenantAuditService(Clock clock) { + this.clock = clock; + this.tenantId = null; + } + + // Private constructor for tenant-specific instances + private TenantAuditService(Clock clock, String tenantId) { + this.clock = clock; + this.tenantId = tenantId; + } + + @Override + public TenantAuditService createForTenant(TenantDescriptor tenant) { + return new TenantAuditService(clock, tenant.tenantId()); + } + + public void recordAudit(String action) { + Instant timestamp = clock.instant(); + // ... record audit entry for tenantId + } + + public String getTenantId() { + return tenantId; + } +} +---- + +IMPORTANT: Do NOT annotate `TenantComponent` implementations with `@Component`, `@Service`, or similar. The auto-configuration discovers them via classpath scanning and creates factory instances with Spring DI without registering them as beans. + +=== Spring Data JPA Repositories + +For JPA repositories, use `TenantRepositoryParameterResolverFactory`: + +[source,java] +---- +import org.springframework.data.jpa.repository.JpaRepository; + +public interface CourseStatsJpaRepository extends JpaRepository { + List findAll(); +} +---- + +The repository is automatically injected as tenant-scoped when `TenantDataSourceProvider` is configured: + +[source,java] +---- +@EventHandler +public void on(CourseCreated event, CourseStatsJpaRepository repository) { + // repository uses the tenant's EntityManagerFactory + repository.save(new CourseStatsReadModel( + event.courseId().raw(), + event.name(), + event.capacity() + )); +} +---- + +== TenantComponentRegistry + +The `TenantComponentRegistry` manages component instances per tenant: + +[source,java] +---- +TenantComponentRegistry registry = new TenantComponentRegistry<>( + CourseRepository.class, + tenant -> new InMemoryCourseRepository() +); + +// Get (or create) component for a tenant +CourseRepository repo = registry.getComponent(TenantDescriptor.tenantWithId("stanford")); + +// Check registered tenants +Set tenants = registry.getTenants(); +---- + +=== Lazy Creation + +Components are created lazily on first access, not when a tenant is registered: + +[source,java] +---- +// Tenant registered, but no component created yet +registry.registerTenant(tenant); + +// Now component is created and cached +CourseRepository repo = registry.getComponent(tenant); + +// Subsequent calls return cached instance +CourseRepository sameRepo = registry.getComponent(tenant); // Same instance +---- + +=== Cleanup on Tenant Removal + +When a tenant is unregistered, the registry cleans up its component: + +[source,java] +---- +Registration registration = registry.registerTenant(tenant); + +// Later, when tenant is removed: +registration.cancel(); // Calls factory.cleanup(tenant, component) +---- + +== TenantAwareProcessingContext + +Access tenant components via `ProcessingContext.component()`: + +[source,java] +---- +@EventHandler +void on(CourseCreated event, ProcessingContext context) { + CourseRepository repository = context.component(CourseRepository.class); + // repository is the tenant-scoped instance + repository.save(new CourseReadModel(event)); +} +---- + +This uses `TenantAwareProcessingContext` which wraps the standard context and intercepts `component()` calls for registered tenant types. + +== Per-Tenant Spring Data JPA Repositories + +For full tenant isolation with separate databases, configure per-tenant JPA: + +=== Configuration + +[source,yaml] +---- +# application.yml +axon: + multi-tenancy: + enabled: true + jpa: + tenant-repositories: true +---- + +=== TenantDataSourceProvider + +Implement the provider to supply tenant-specific data sources: + +[source,java] +---- +import org.axonframework.extension.multitenancy.spring.data.jpa.TenantDataSourceProvider; +import org.axonframework.extension.multitenancy.core.TenantDescriptor; +import javax.sql.DataSource; + +@Component +public class UniversityDataSourceProvider implements TenantDataSourceProvider { + + private final Map dataSources = new ConcurrentHashMap<>(); + + @Override + public DataSource getDataSource(TenantDescriptor tenant) { + return dataSources.computeIfAbsent(tenant.tenantId(), this::createDataSource); + } + + private DataSource createDataSource(String tenantId) { + HikariConfig config = new HikariConfig(); + config.setJdbcUrl("jdbc:postgresql://localhost:5432/university_" + tenantId); + config.setUsername("app"); + config.setPassword("secret"); + return new HikariDataSource(config); + } +} +---- + +=== Using TenantJpaRepositoryFactory + +For programmatic registration: + +[source,java] +---- +import org.axonframework.extension.multitenancy.spring.data.jpa.TenantJpaRepositoryFactory; +import org.axonframework.extension.multitenancy.spring.data.jpa.TenantEntityManagerFactoryBuilder; +import org.axonframework.extension.multitenancy.spring.data.jpa.TenantTransactionManagerBuilder; + +TenantJpaRepositoryFactory factory = + TenantJpaRepositoryFactory.forRepository( + CourseStatsJpaRepository.class, + emfBuilder, + txBuilder + ); + +MultiTenancyConfigurer.enhance(configurer) + .tenantComponent(CourseStatsJpaRepository.class, factory); +---- + +== Complete Example + +=== Domain Model + +[source,java] +---- +// Read model entity +@Entity +@Table(name = "course_stats") +public class CourseStatsReadModel { + + @Id + private String courseId; + private String name; + private int capacity; + private int enrollmentCount = 0; + + // constructors, getters, setters +} + +// Repository interface +public interface CourseStatsJpaRepository extends JpaRepository { + List findAll(); +} +---- + +=== Tenant-Scoped Service + +[source,java] +---- +// Note: No @Component annotation! +public class EnrollmentMetricsService implements TenantComponent { + + private final MeterRegistry meterRegistry; // Spring dependency + private final String tenantId; + private final Counter enrollmentCounter; + + public EnrollmentMetricsService(MeterRegistry meterRegistry) { + this.meterRegistry = meterRegistry; + this.tenantId = null; + this.enrollmentCounter = null; + } + + private EnrollmentMetricsService(MeterRegistry meterRegistry, String tenantId) { + this.meterRegistry = meterRegistry; + this.tenantId = tenantId; + this.enrollmentCounter = Counter.builder("enrollments") + .tag("tenant", tenantId) + .register(meterRegistry); + } + + @Override + public EnrollmentMetricsService createForTenant(TenantDescriptor tenant) { + return new EnrollmentMetricsService(meterRegistry, tenant.tenantId()); + } + + public void recordEnrollment() { + enrollmentCounter.increment(); + } +} +---- + +=== Event Handler + +[source,java] +---- +@ProcessingGroup("courseProjection") +@Component +public class CourseStatsProjector { + + @EventHandler + public void on(CourseCreated event, + CourseStatsJpaRepository repository, + EnrollmentMetricsService metricsService) { + + repository.save(new CourseStatsReadModel( + event.courseId().raw(), + event.name(), + event.capacity() + )); + } + + @EventHandler + public void on(StudentEnrolled event, + CourseStatsJpaRepository repository, + EnrollmentMetricsService metricsService) { + + repository.findById(event.courseId().raw()) + .ifPresent(stats -> { + stats.setEnrollmentCount(stats.getEnrollmentCount() + 1); + repository.save(stats); + metricsService.recordEnrollment(); + }); + } +} +---- + +== Best Practices + +=== 1. Keep Factory Instances Stateless + +Factory instances should only hold shared dependencies, not tenant state: + +[source,java] +---- +// CORRECT - Factory holds shared dependency +public class TenantService implements TenantComponent { + private final SharedDependency shared; // Shared across all tenants + + public TenantService(SharedDependency shared) { + this.shared = shared; + } + + @Override + public TenantService createForTenant(TenantDescriptor tenant) { + return new TenantService(shared, tenant.tenantId()); + } +} + +// INCORRECT - Factory accumulates state +public class BadTenantService implements TenantComponent { + private final List processedIds = new ArrayList<>(); // Don't do this! +} +---- + +=== 2. Use Private Constructors for Tenant Instances + +Prevent accidental creation of tenant instances: + +[source,java] +---- +public class TenantAuditService implements TenantComponent { + + // Public constructor for factory (Spring DI) + public TenantAuditService(Clock clock) { + this.clock = clock; + this.tenantId = null; + } + + // Private constructor for tenant instances + private TenantAuditService(Clock clock, String tenantId) { + this.clock = clock; + this.tenantId = tenantId; + } +} +---- + +=== 3. Implement AutoCloseable for Resource Cleanup + +[source,java] +---- +public class TenantConnectionPool implements TenantComponent, + AutoCloseable { + + @Override + public void close() { + pool.shutdown(); + } + + // cleanupForTenant will automatically call close() +} +---- + +=== 4. Validate Tenant Context + +Guard against usage on factory instances: + +[source,java] +---- +public void recordAudit(String action) { + if (tenantId == null) { + throw new IllegalStateException( + "Cannot record audit on factory instance - no tenant context" + ); + } + // ... implementation +} +---- + +== See Also + +* xref:event-processors.adoc[Event Processors] - Configuring multi-tenant processors +* xref:tenant-resolution.adoc[Tenant Resolution] - How tenant context is determined +* xref:dynamic-tenants.adoc[Dynamic Tenants] - Adding/removing tenants at runtime diff --git a/docs/reference/modules/ROOT/pages/configuration/tenant-resolution.adoc b/docs/reference/modules/ROOT/pages/configuration/tenant-resolution.adoc new file mode 100644 index 0000000..65dd176 --- /dev/null +++ b/docs/reference/modules/ROOT/pages/configuration/tenant-resolution.adoc @@ -0,0 +1,410 @@ +:navtitle: Tenant Resolution += Tenant Resolution + +Tenant resolution determines which tenant a message belongs to. This page covers how to configure tenant resolution and propagation. + +== Overview + +When a message enters the multi-tenant system, the `TargetTenantResolver` extracts the target tenant: + +[source] +---- +Incoming Message + | + v +TargetTenantResolver.resolveTenant(message, tenants) + | + v +TenantDescriptor --> Route to tenant's infrastructure +---- + +== TargetTenantResolver Interface + +The `TargetTenantResolver` interface is the core contract for tenant resolution: + +[source,java] +---- +public interface TargetTenantResolver + extends BiFunction, TenantDescriptor> { + + default TenantDescriptor resolveTenant(M message, Collection tenants) { + return this.apply(message, Collections.unmodifiableCollection(tenants)); + } +} +---- + +The resolver receives: + +* The message being processed +* The collection of currently registered tenants + +It returns the `TenantDescriptor` identifying the target tenant. + +== MetadataBasedTenantResolver (Default) + +The default implementation extracts tenant ID from message metadata: + +[source,java] +---- +import org.axonframework.extension.multitenancy.core.MetadataBasedTenantResolver; + +// Using default key "tenantId" +TargetTenantResolver resolver = new MetadataBasedTenantResolver(); + +// Using custom key +TargetTenantResolver resolver = new MetadataBasedTenantResolver("universityTenant"); +---- + +=== Default Metadata Key + +The default key is `tenantId`: + +[source,java] +---- +public static final String DEFAULT_TENANT_KEY = "tenantId"; +---- + +=== Error Handling + +When the metadata key is missing, `NoSuchTenantException` is thrown: + +[source,java] +---- +// Command without tenantId in metadata +commandGateway.sendAndWait(new EnrollStudent(studentId, courseId)); +// Throws: NoSuchTenantException("No tenant identifier found in message metadata under key 'tenantId'") +---- + +== Custom Tenant Resolvers + +Implement custom resolvers for alternative routing strategies. + +=== Payload-Based Resolution + +Extract tenant from the message payload: + +[source,java] +---- +import org.axonframework.extension.multitenancy.core.TargetTenantResolver; +import org.axonframework.extension.multitenancy.core.TenantDescriptor; +import org.axonframework.extension.multitenancy.core.NoSuchTenantException; +import org.axonframework.messaging.core.Message; + +public class PayloadBasedTenantResolver implements TargetTenantResolver { + + @Override + public TenantDescriptor apply(Message message, Collection tenants) { + Object payload = message.payload(); + + if (payload instanceof UniversityCommand cmd) { + return TenantDescriptor.tenantWithId(cmd.getUniversityId()); + } + + throw new NoSuchTenantException("Cannot determine university from command"); + } +} +---- + +=== Header-Based Resolution with Fallback + +Try multiple sources for tenant identification: + +[source,java] +---- +public class FallbackTenantResolver implements TargetTenantResolver { + + private static final String PRIMARY_KEY = "tenantId"; + private static final String FALLBACK_KEY = "university"; + + @Override + public TenantDescriptor apply(Message message, Collection tenants) { + Metadata metadata = message.metadata(); + + // Try primary key first + String tenantId = metadata.get(PRIMARY_KEY); + + // Fall back to secondary key + if (tenantId == null) { + tenantId = metadata.get(FALLBACK_KEY); + } + + if (tenantId == null) { + throw new NoSuchTenantException("No tenant found in metadata"); + } + + return TenantDescriptor.tenantWithId(tenantId); + } +} +---- + +== Tenant Correlation Provider + +The `TenantCorrelationProvider` ensures tenant context propagates from one message to subsequent messages: + +[source,java] +---- +import org.axonframework.extension.multitenancy.autoconfig.TenantCorrelationProvider; + +// Creates a provider that propagates the "tenantId" key +TenantCorrelationProvider provider = new TenantCorrelationProvider("tenantId"); +---- + +=== How Correlation Works + +When a command handler publishes events, the correlation provider copies tenant metadata: + +[source] +---- +EnrollStudentCommand {tenantId: "stanford"} + | + v +Command Handler + | + +-- StudentEnrolledEvent {tenantId: "stanford"} <-- auto-propagated + | + v +Event Handler + | + +-- SendWelcomeEmailCommand {tenantId: "stanford"} <-- auto-propagated +---- + +=== Default Tenant Handling + +If the tenant key is missing, the provider uses `"unknownTenant"`: + +[source,java] +---- +@Override +public Map correlationDataFor(Message message) { + Map result = new HashMap<>(); + String tenantId = metadata.containsKey(tenantCorrelationKey) + ? metadata.get(tenantCorrelationKey) + : "unknownTenant"; + result.put(tenantCorrelationKey, tenantId); + return result; +} +---- + +== Configuration + +=== Axon Framework (Programmatic) + +[source,java] +---- +import org.axonframework.eventsourcing.configuration.EventSourcingConfigurer; +import org.axonframework.extension.multitenancy.core.MetadataBasedTenantResolver; +import org.axonframework.extension.multitenancy.core.configuration.MultiTenancyConfigurer; +import org.axonframework.extension.multitenancy.core.SimpleTenantProvider; + +// Create configurer +EventSourcingConfigurer configurer = EventSourcingConfigurer.create(); + +// Create tenant provider +SimpleTenantProvider tenantProvider = new SimpleTenantProvider(List.of( + TenantDescriptor.tenantWithId("stanford"), + TenantDescriptor.tenantWithId("mit"), + TenantDescriptor.tenantWithId("berkeley") +)); + +// Enhance with multi-tenancy +MultiTenancyConfigurer.enhance(configurer) + .registerTenantProvider(config -> tenantProvider) + .registerTargetTenantResolver(config -> new MetadataBasedTenantResolver("tenantId")); + +// Register correlation provider for propagation +configurer.messaging(mc -> mc.registerCorrelationDataProvider(config -> message -> { + Map result = new HashMap<>(); + if (message.metadata().containsKey("tenantId")) { + result.put("tenantId", message.metadata().get("tenantId")); + } + return result; +})); + +// Build and start +AxonConfiguration configuration = configurer.start(); +---- + +=== Spring Boot + +Spring Boot auto-configures both the resolver and correlation provider: + +[source,yaml] +---- +# application.yml +axon: + multi-tenancy: + enabled: true + tenant-key: tenantId # Used by both resolver and correlation provider +---- + +==== Custom Resolver Bean + +Override the default resolver by defining a bean: + +[source,java] +---- +import org.axonframework.extension.multitenancy.core.TargetTenantResolver; +import org.axonframework.messaging.core.Message; +import org.springframework.context.annotation.Bean; +import org.springframework.context.annotation.Configuration; + +@Configuration +public class TenantConfiguration { + + @Bean + public TargetTenantResolver targetTenantResolver() { + return new PayloadBasedTenantResolver(); + } +} +---- + +== Adding Tenant to Entry Point Messages + +At your application's entry point, add tenant context to the first message: + +=== REST Controller Example + +[source,java] +---- +import org.axonframework.messaging.commandhandling.gateway.CommandGateway; +import org.axonframework.messaging.core.Metadata; +import org.springframework.web.bind.annotation.*; + +@RestController +@RequestMapping("/api/universities/{universityId}/courses") +public class CourseController { + + private final CommandGateway commandGateway; + + public CourseController(CommandGateway commandGateway) { + this.commandGateway = commandGateway; + } + + @PostMapping + public CompletableFuture createCourse( + @PathVariable String universityId, + @RequestBody CreateCourseRequest request) { + + return commandGateway.send( + new CreateCourse( + CourseId.random(), + request.getName(), + request.getCapacity() + ), + Metadata.with("tenantId", universityId) + ).getResultMessage() + .thenApply(result -> result.payload().toString()); + } +} +---- + +=== Message Listener Example + +[source,java] +---- +@Component +public class ExternalEventListener { + + private final CommandGateway commandGateway; + + @KafkaListener(topics = "enrollment-requests") + public void handleEnrollmentRequest(EnrollmentRequestMessage message) { + commandGateway.send( + new EnrollStudent( + StudentId.from(message.getStudentId()), + CourseId.from(message.getCourseId()) + ), + Metadata.with("tenantId", message.getUniversityId()) + ); + } +} +---- + +== Best Practices + +=== 1. Extract Tenant Early + +Determine tenant at the API boundary (authentication, headers, path): + +[source,java] +---- +@RestController +public class UniversityApiController { + + @PostMapping("/courses") + public CompletableFuture createCourse( + @RequestHeader("X-University-Id") String universityId, // From auth system + @RequestBody CreateCourseRequest request) { + // universityId validated by security filter + return commandGateway.send( + new CreateCourse(...), + Metadata.with("tenantId", universityId) + ).getResultMessage(); + } +} +---- + +=== 2. Use Consistent Metadata Key + +Use the same key throughout your application: + +[source,yaml] +---- +# application.yml - Single source of truth +axon: + multi-tenancy: + tenant-key: tenantId +---- + +=== 3. Validate Tenant Existence + +Consider validating tenant before processing: + +[source,java] +---- +@Component +public class TenantValidationInterceptor implements MessageDispatchInterceptor { + + private final TenantProvider tenantProvider; + + @Override + public CommandMessage handle(CommandMessage message) { + String tenantId = message.metadata().get("tenantId"); + if (tenantId != null) { + boolean exists = tenantProvider.getTenants().stream() + .anyMatch(t -> t.tenantId().equals(tenantId)); + if (!exists) { + throw new NoSuchTenantException("Unknown tenant: " + tenantId); + } + } + return message; + } +} +---- + +=== 4. Never Hardcode Tenant in Business Logic + +Let infrastructure handle routing: + +[source,java] +---- +// WRONG - Tenant logic in command handler +@CommandHandler +public void handle(CreateCourse command) { + if (command.getUniversityId().equals("stanford")) { // Don't do this + // special logic + } +} + +// RIGHT - Command handler is tenant-agnostic +@CommandHandler +public static void handle(CreateCourse command, EventAppender appender) { + appender.append(new CourseCreated(command.courseId(), command.name(), command.capacity())); +} +---- + +== See Also + +* xref:../tenant-management.adoc[Tenant Management] - Managing tenant lifecycle +* xref:dynamic-tenants.adoc[Dynamic Tenants] - Adding/removing tenants at runtime +* xref:../message-routing.adoc[Message Routing] - How messages flow through the system diff --git a/docs/reference/modules/ROOT/pages/disable.adoc b/docs/reference/modules/ROOT/pages/disable.adoc deleted file mode 100644 index c55cc62..0000000 --- a/docs/reference/modules/ROOT/pages/disable.adoc +++ /dev/null @@ -1,9 +0,0 @@ -:navtitle: Disable Extension -= Disable Extension - -By default, extension is automatically enabled. If you wish to disable extension without removing extension use following property. - -[source,properties] ----- -axon.multi-tenancy.enabled=false ----- diff --git a/docs/reference/modules/ROOT/pages/index.adoc b/docs/reference/modules/ROOT/pages/index.adoc index f27e747..b89f095 100644 --- a/docs/reference/modules/ROOT/pages/index.adoc +++ b/docs/reference/modules/ROOT/pages/index.adoc @@ -1,15 +1,193 @@ :navtitle: Introduction -= Introduction += Multitenancy Extension -Axon Framework Multitenancy Extension provides your application ability to serve multiple tenants (event-stores) at once. Multi-tenancy is important in cloud computing and this extension will provide ability to connect to tenants dynamically, physical separate tenants data, scale tenants independently... +Multitenancy is an architectural pattern where a single application instance serves multiple tenants -- such as universities, departments, or organizations -- while keeping their data and operations logically isolated. +This extension enables Axon Framework applications to support multiple tenants with complete isolation of commands, events, queries, and event processors. -== Requirements -Currently, following requirements needs to be meet for extension to work: +== How It Works -- Use *Spring Framework* together with *Axon Framework 4.6+* -- Use *Axon Server EE 4.6+* or Axon Cloud as event store -- This is not hard requirement but if you wish to enable multitenancy on projection side, only SQL databases are supported out-of-the box +The Multitenancy Extension transforms your single-tenant Axon application into a multi-tenant system by introducing a routing layer. +Instead of a single command bus, event store, query bus, and event processor, the extension manages multiple _tenant segments_ -- one set of infrastructure components per tenant. -== Restrictions +=== Single-Tenant Architecture -Only components that interact with Axon Server and or database via JPA are supported out of the box. If you wish to use other components, you need to implement multi-tenancy support for them. +In a standard Axon application, all messages flow through shared infrastructure: + +[source] +---- + +------------------+ + Command -------->| | + | Command Bus |-------> Command Handler + Query ---------->| | + | Query Bus |-------> Query Handler + | | + Event <----------| Event Store |<------- Command Handler + | | + | Event Processor |-------> Event Handler + +------------------+ +---- + +=== Multi-Tenant Architecture + +With the Multitenancy Extension, each tenant gets its own isolated segment: + +[source] +---- + +---------------------------+ + | Multi-Tenant Command | + Command + tenantId --->| Bus | + +---------------------------+ + | + +-----------------------+-----------------------+ + | | | + v v v + +------------------+ +------------------+ +------------------+ + | MIT Segment | | Stanford Segment | | Oxford Segment | + | | | | | | + | Command Bus | | Command Bus | | Command Bus | + | Event Store | | Event Store | | Event Store | + | Query Bus | | Query Bus | | Query Bus | + | Event Processor | | Event Processor | | Event Processor | + +------------------+ +------------------+ +------------------+ +---- + +When a message arrives, the extension: + +1. Extracts the tenant identifier from the message (typically from metadata) +2. Routes the message to the appropriate tenant segment +3. Processes the message in complete isolation from other tenants + +== Key Concepts + +=== TenantDescriptor + +A `TenantDescriptor` identifies a tenant in the system. +At its simplest, it contains a tenant identifier string, but it can also carry additional properties for tenant-specific configuration. + +[source,java] +---- +// Simple tenant with just an ID +TenantDescriptor mit = TenantDescriptor.tenantWithId("mit-university"); + +// Tenant with additional properties +TenantDescriptor stanford = new TenantDescriptor("stanford-university", + Map.of("region", "us-west", "tier", "premium")); +---- + +=== TenantProvider + +The `TenantProvider` manages the set of known tenants and notifies multi-tenant components when tenants are added or removed. +It enables both static configurations (tenants defined at startup) and dynamic configurations (tenants added at runtime). + +[source,java] +---- +// Static configuration: define tenants at startup +SimpleTenantProvider provider = new SimpleTenantProvider(List.of( + TenantDescriptor.tenantWithId("mit-university"), + TenantDescriptor.tenantWithId("stanford-university"), + TenantDescriptor.tenantWithId("oxford-university") +)); + +// Dynamic configuration: add tenants at runtime +provider.addTenant(TenantDescriptor.tenantWithId("cambridge-university")); +provider.removeTenant(TenantDescriptor.tenantWithId("oxford-university")); +---- + +=== TargetTenantResolver + +The `TargetTenantResolver` determines which tenant a message belongs to. +The most common implementation extracts the tenant identifier from message metadata. + +[source,java] +---- +// Resolves tenant from message metadata using key "tenantId" +TargetTenantResolver resolver = new MetadataBasedTenantResolver(); + +// Custom metadata key +TargetTenantResolver resolver = new MetadataBasedTenantResolver("universityId"); +---- + +When sending commands or queries, include the tenant identifier in the metadata: + +[source,java] +---- +// The tenant ID flows through the entire message chain +commandGateway.send( + new EnrollStudentCommand(courseId, studentId), + Metadata.with("tenantId", "mit-university") +); +---- + +=== Segment Factories + +Segment factories create tenant-specific infrastructure components. +Each factory receives a `TenantDescriptor` and returns the appropriate component for that tenant: + +[cols="1,2"] +|=== +|Factory |Purpose + +|`TenantCommandSegmentFactory` +|Creates a command bus for each tenant + +|`TenantQuerySegmentFactory` +|Creates a query bus for each tenant + +|`TenantEventSegmentFactory` +|Creates an event store for each tenant + +|`TenantEventProcessorSegmentFactory` +|Creates event processors for each tenant +|=== + +These factories give you complete control over tenant isolation strategies: + +* **Separate databases**: Each tenant's events stored in a different database +* **Separate schemas**: Shared database with tenant-specific schemas +* **Separate connections**: Tenant-specific connection pools or Axon Server contexts + +== When to Use This Extension + +The Multitenancy Extension is ideal when you need: + +Data isolation:: +Each tenant's commands, events, and queries must be completely separate. +A university's course enrollments and student records should never be visible to another university. + +Tenant-specific scaling:: +Different tenants may require different processing capacities. +A large university with thousands of courses needs more event processor threads than a small college. + +Dynamic tenant onboarding:: +New tenants can be added without application restarts. +When a new university signs up, their infrastructure is provisioned automatically. + +Compliance requirements:: +Regulatory requirements demand strict data separation between customers. +Each university's data must be provably isolated for audit purposes. + +Consider alternatives if: + +* You only need logical separation (filtering by tenant ID in queries) +* All tenants share the same data model and can coexist in a single event store +* You have a small, fixed number of tenants that rarely changes + +== Setup Guides + +Choose the setup guide that matches your infrastructure: + +xref:setup/getting-started.adoc[Getting Started]:: +Standard setup with any event store backend. +Use this guide if you are using a custom event store implementation or want to understand the core concepts. + +xref:setup/axon-server.adoc[Axon Server Integration]:: +Setup for applications using Axon Server as the event store. +Leverages Axon Server contexts for tenant isolation. + +xref:setup/spring-boot.adoc[Spring Boot Integration]:: +Setup for Spring Boot applications with any event store backend. +Provides auto-configuration and simplified setup. + +xref:setup/spring-boot-axon-server.adoc[Spring Boot with Axon Server]:: +The most streamlined setup for Spring Boot applications using Axon Server. +Combines Spring Boot auto-configuration with Axon Server context-based isolation. diff --git a/docs/reference/modules/ROOT/pages/infrastructure.adoc b/docs/reference/modules/ROOT/pages/infrastructure.adoc new file mode 100644 index 0000000..9f41156 --- /dev/null +++ b/docs/reference/modules/ROOT/pages/infrastructure.adoc @@ -0,0 +1,271 @@ +:navtitle: Infrastructure += Multi-Tenant Infrastructure + +The extension provides multi-tenant versions of Axon Framework's core infrastructure components. These components route messages to tenant-specific segments while maintaining the same API as their single-tenant counterparts. + +== Architecture Overview + +Each multi-tenant component follows the same pattern: + +1. Wraps the standard component as a decorator +2. Uses `TargetTenantResolver` to determine the tenant +3. Delegates to tenant-specific segments +4. Creates segments on-demand via factory + +[source] +---- +MultiTenantCommandBus + ├── tenantSegments: Map + ├── segmentFactory: TenantCommandSegmentFactory + └── targetTenantResolver: TargetTenantResolver +---- + +== MultiTenantCommandBus + +Routes commands to tenant-specific command buses. + +=== How It Differs from Standard CommandBus + +|=== +|Standard CommandBus |MultiTenantCommandBus + +|Single instance handles all commands +|Routes to per-tenant command bus instances + +|Handlers registered once +|Handlers registered per tenant segment + +|Direct dispatch +|Resolves tenant, then dispatches to segment +|=== + +=== With Axon Server + +When using Axon Server, the `MultiTenantAxonServerCommandBusConnector` handles routing at the connector level. Commands are sent to the correct Axon Server context without needing per-tenant bus instances locally. + +=== Embedded Mode + +Without Axon Server, each tenant gets a `SimpleCommandBus`. The default factory creates these automatically: + +[source,java] +---- +// Default behavior - creates SimpleCommandBus per tenant +// You get this for free, no configuration needed +---- + +To customize: + +[source,java] +---- +import org.axonframework.extension.multitenancy.messaging.commandhandling.TenantCommandSegmentFactory; +import org.axonframework.messaging.commandhandling.CommandBus; + +@Bean +public TenantCommandSegmentFactory commandBusFactory() { + return tenant -> { + // Custom command bus configuration per tenant + return SimpleCommandBus.builder() + // ... custom configuration + .build(); + }; +} +---- + +== MultiTenantQueryBus + +Routes queries to tenant-specific query buses. + +=== Query Handlers + +Query handlers must use **method parameter injection** for tenant-scoped data access: + +[source,java] +---- +@QueryHandler +public List handle(FindOrdersQuery query, OrderRepository orderRepository) { + // Repository is resolved per-invocation based on query's tenant metadata + return orderRepository.findAll(); +} + +// Or with EntityManager +@QueryHandler +public List handle(FindOrdersQuery query, EntityManager entityManager) { + return entityManager.createQuery("SELECT o FROM Order o", Order.class) + .getResultList(); +} +---- + +IMPORTANT: Do NOT use field-injected repositories or EntityManagers. Field injection creates a single instance shared across all tenants, causing data leakage. Always use method parameter injection for tenant-scoped data access. + +=== Subscription Queries + +Subscription queries work per-tenant. Updates emitted on one tenant's bus don't reach subscribers on other tenants: + +[source,java] +---- +// Subscription on tenant-1 +queryGateway.subscriptionQuery( + new FindOrdersQuery() + .andMetaData(Map.of("tenantId", "tenant-1")), + ... +); + +// Updates emitted on tenant-1's QueryUpdateEmitter +// Only reach tenant-1 subscribers +---- + +== MultiTenantEventStore + +Routes event operations to tenant-specific event stores. + +=== How It Differs from Standard EventStore + +|=== +|Operation |Standard EventStore |MultiTenantEventStore + +|`publish(events)` +|Stores in single event store +|Resolves tenant from event metadata, stores in tenant's event store + +|`source(condition)` +|Sources from single store +|Resolves tenant from entity ID's context, sources from tenant's store + +|`open(condition)` for streaming +|Opens single stream +|Not supported directly - use `tenantSegments().get(tenant).open()` +|=== + +=== Event Sourcing + +When sourcing an entity, the event store uses the entity identifier's context to determine the tenant: + +[source,java] +---- +// Command with tenant metadata +CreateOrderCommand cmd = new CreateOrderCommand(orderId, productId) + .andMetaData(Map.of("tenantId", "tenant-1")); + +// Events sourced from tenant-1's event store +// Events publish to tenant-1's event store +---- + +=== Accessing Tenant Segments + +For operations that need direct access to a tenant's event store (like event processors): + +[source,java] +---- +MultiTenantEventStore multiTenantStore = ...; + +// Get all tenant segments +Map segments = multiTenantStore.tenantSegments(); + +// Access specific tenant's store +EventStore tenant1Store = segments.get(TenantDescriptor.tenantWithId("tenant-1")); +---- + +== Segment Factories + +Segment factories create tenant-specific infrastructure: + +|=== +|Factory |Creates |Default Implementation + +|`TenantCommandSegmentFactory` +|`CommandBus` +|`SimpleCommandBus` + +|`TenantQuerySegmentFactory` +|`QueryBus` +|`SimpleQueryBus` + +|`TenantEventSegmentFactory` +|`EventStore` +|In-memory `StorageEngineBackedEventStore` +|=== + +=== Custom Segment Factory Example + +[source,java] +---- +import org.axonframework.extension.multitenancy.eventsourcing.eventstore.TenantEventSegmentFactory; +import org.axonframework.eventsourcing.eventstore.EventStore; +import org.axonframework.eventsourcing.eventstore.jpa.JpaEventStorageEngine; + +@Bean +public TenantEventSegmentFactory eventStoreFactory(EntityManagerFactory emf) { + return tenant -> { + // Create JPA-based event store per tenant + JpaEventStorageEngine engine = JpaEventStorageEngine.builder() + .entityManagerProvider(() -> createEntityManagerForTenant(tenant)) + .build(); + + return new StorageEngineBackedEventStore( + engine, + new SimpleEventBus(), + new AnnotationBasedTagResolver() + ); + }; +} +---- + +== Configuration + +=== Axon Framework + +[source,java] +---- +import org.axonframework.extension.multitenancy.core.configuration.MultiTenancyConfigurer; + +MultiTenancyConfigurer.enhance(messagingConfigurer) + .registerTenantProvider(config -> tenantProvider) + .registerTargetTenantResolver(config -> resolver) + // Custom factories (optional - defaults provided) + .registerCommandBusSegmentFactory(config -> tenant -> createCommandBus(tenant)) + .registerQueryBusSegmentFactory(config -> tenant -> createQueryBus(tenant)) + .registerEventStoreSegmentFactory(config -> tenant -> createEventStore(tenant)) + .build(); +---- + +=== Spring Boot + +With Spring Boot, just define beans for custom factories: + +[source,java] +---- +@Configuration +public class MultiTenantInfrastructureConfig { + + @Bean + public TenantEventSegmentFactory eventStoreFactory() { + return tenant -> { + // Custom event store per tenant + }; + } +} +---- + +The default factories are used if you don't provide custom ones. + +== Axon Server Connector Module + +When using the `multitenancy-axon-server-connector` module, you get: + +|=== +|Component |Behavior + +|`AxonServerTenantProvider` +|Discovers tenants from Axon Server contexts + +|`MultiTenantAxonServerCommandBusConnector` +|Routes commands to correct Axon Server context + +|`MultiTenantAxonServerQueryBusConnector` +|Routes queries to correct Axon Server context + +|`AxonServerTenantEventSegmentFactory` +|Creates `AxonServerEventStore` per tenant +|=== + +These are registered via SPI and override the embedded defaults. No configuration needed - just add the dependency. diff --git a/docs/reference/modules/ROOT/pages/message-routing.adoc b/docs/reference/modules/ROOT/pages/message-routing.adoc new file mode 100644 index 0000000..c5a75a5 --- /dev/null +++ b/docs/reference/modules/ROOT/pages/message-routing.adoc @@ -0,0 +1,219 @@ +:navtitle: Message Routing += Message Routing + +Every message in a multi-tenant application must be routed to the correct tenant. This page explains how tenant resolution works and how to configure it. + +== How Routing Works + +When you send a command, query, or event: + +1. The multi-tenant bus receives the message +2. `TargetTenantResolver` extracts the tenant from the message +3. The message is forwarded to that tenant's infrastructure +4. The response (if any) returns through the same path + +[source] +---- +Command with metadata {tenantId: "tenant-1"} + │ + ▼ +MultiTenantCommandBus + │ + ├── TargetTenantResolver extracts "tenant-1" + │ + ▼ +tenant-1's CommandBus + │ + ▼ +Command Handler +---- + +== TargetTenantResolver + +The `TargetTenantResolver` interface determines which tenant a message belongs to: + +[source,java] +---- +public interface TargetTenantResolver { + TenantDescriptor resolveTenant(M message, List tenants); +} +---- + +=== MetadataBasedTenantResolver (Default) + +The default implementation reads tenant ID from message metadata: + +[source,java] +---- +// Configured with key "tenantId" +MetadataBasedTenantResolver resolver = new MetadataBasedTenantResolver("tenantId"); + +// Message with metadata: {"tenantId": "customer-acme"} +// Resolves to: TenantDescriptor.tenantWithId("customer-acme") +---- + +=== Custom Resolver + +Implement your own resolver for different routing strategies: + +[source,java] +---- +import org.axonframework.extension.multitenancy.core.TargetTenantResolver; +import org.axonframework.extension.multitenancy.core.TenantDescriptor; +import org.axonframework.messaging.core.Message; + +public class PayloadBasedTenantResolver implements TargetTenantResolver { + + @Override + public TenantDescriptor resolveTenant(Message message, List tenants) { + Object payload = message.payload(); + + if (payload instanceof TenantAwareCommand cmd) { + return TenantDescriptor.tenantWithId(cmd.getTenantId()); + } + + throw new NoTenantInMessageException("Cannot determine tenant from message"); + } +} +---- + +== Adding Tenant to Messages + +=== Entry Point + +At your application's entry point (REST controller, message listener, etc.), add the tenant ID to the first message: + +[source,java] +---- +import org.axonframework.messaging.commandhandling.gateway.CommandGateway; +import org.axonframework.messaging.core.Metadata; +import org.springframework.web.bind.annotation.PostMapping; +import org.springframework.web.bind.annotation.RequestHeader; +import org.springframework.web.bind.annotation.RestController; + +@RestController +public class OrderController { + + private final CommandGateway commandGateway; + + @PostMapping("/orders") + public CompletableFuture createOrder( + @RequestHeader("X-Tenant-Id") String tenantId, + @RequestBody CreateOrderRequest request) { + + return commandGateway.send( + new CreateOrderCommand(request.getProductId(), request.getQuantity()), + Metadata.with("tenantId", tenantId) + ).getResultMessage() + .thenApply(result -> result.payload().toString()); + } +} +---- + +=== Automatic Propagation + +Once a message has tenant metadata, the `TenantCorrelationProvider` automatically propagates it to all subsequent messages: + +[source] +---- +CreateOrderCommand {tenantId: "tenant-1"} + │ + ▼ +Command Handler + │ + ├── OrderCreatedEvent {tenantId: "tenant-1"} ← auto-propagated + │ + ▼ +Event Handler + │ + ├── ConfirmInventoryCommand {tenantId: "tenant-1"} ← auto-propagated +---- + +You only need to add the tenant ID once at the entry point. + +== Configuration + +=== Axon Framework + +[source,java] +---- +import org.axonframework.extension.multitenancy.core.MetadataBasedTenantResolver; +import org.axonframework.extension.multitenancy.core.configuration.MultiTenancyConfigurer; +import org.axonframework.messaging.core.correlation.CorrelationDataProviderRegistry; + +MultiTenancyConfigurer.enhance(messagingConfigurer) + .registerTenantProvider(config -> tenantProvider) + .registerTargetTenantResolver(config -> new MetadataBasedTenantResolver("tenantId")) + .build(); + +// Also register the correlation provider for propagation +messagingConfigurer.componentRegistry(registry -> + registry.getComponent(CorrelationDataProviderRegistry.class) + .registerProvider(config -> new TenantCorrelationProvider("tenantId")) +); +---- + +=== Spring Boot + +The Spring Boot autoconfiguration provides both components automatically: + +[source,yaml] +---- +# application.yml +axon: + multi-tenancy: + tenant-key: tenantId # Used by both resolver and correlation provider +---- + +To customize: + +[source,java] +---- +import org.axonframework.extension.multitenancy.core.TargetTenantResolver; +import org.axonframework.messaging.core.Message; +import org.springframework.context.annotation.Bean; + +@Bean +public TargetTenantResolver customTenantResolver() { + return new PayloadBasedTenantResolver(); +} +---- + +== Error Handling + +=== NoTenantInMessageException + +Thrown when the resolver cannot determine the tenant: + +[source,java] +---- +// Message without tenantId metadata +commandGateway.send(new CreateOrderCommand(...)); +// Throws: NoTenantInMessageException +---- + +Always ensure entry point messages have tenant metadata. + +=== NoSuchTenantException + +Thrown when the resolved tenant doesn't exist: + +[source,java] +---- +// Tenant "unknown" is not registered +commandGateway.send( + new CreateOrderCommand(...), + Metadata.with("tenantId", "unknown") +); +// Throws: NoSuchTenantException +---- + +== Best Practices + +1. **Single entry point for tenant**: Extract tenant ID from authentication token, HTTP header, or request path at your API layer. + +2. **Don't hardcode tenants in business logic**: Let the infrastructure handle routing. + +3. **Validate tenant early**: Check that the tenant exists before processing requests. + +4. **Use consistent key names**: Stick with one metadata key (like `"tenantId"`) throughout your application. diff --git a/docs/reference/modules/ROOT/pages/multi-tenant-components.adoc b/docs/reference/modules/ROOT/pages/multi-tenant-components.adoc deleted file mode 100644 index 40f07c2..0000000 --- a/docs/reference/modules/ROOT/pages/multi-tenant-components.adoc +++ /dev/null @@ -1,17 +0,0 @@ -:navtitle: Supported Multi-Tenant Components -= Supported Multi-Tenant Components - -Currently, supported multi-tenants components are as follows: - -- `MultiTenantCommandBus` -- `MultiTenantEventProcessor` -- `MultiTenantEventStore` -- `MultiTenantQueryBus` -- `MultiTenantQueryUpdateEmitter` -- `MultiTenantEventProcessorControlService` -- `MultiTenantDataSourceManager` -- `MultiTenantEventScheduler` - -Not supported components are: - -- Deadline Manager \ No newline at end of file diff --git a/docs/reference/modules/ROOT/pages/projections.adoc b/docs/reference/modules/ROOT/pages/projections.adoc new file mode 100644 index 0000000..4277444 --- /dev/null +++ b/docs/reference/modules/ROOT/pages/projections.adoc @@ -0,0 +1,309 @@ +:navtitle: Projections += Multi-Tenant Projections + +Projections (read models) in multi-tenant applications typically require tenant-specific database access. The extension provides two approaches for JPA-based projections: + +1. **EntityManager injection** - Direct JPA access for the current tenant +2. **Spring Data Repository injection** - Higher-level repository abstraction (Spring Boot only) + +== Architecture + +Each tenant can have: + +* Separate database +* Separate schema in shared database +* Separate table prefix (not recommended) + +The extension manages `EntityManagerFactory` instances per tenant: + +[source] +---- +TenantEntityManagerRegistry + ├── tenant-1: EntityManagerFactory → database-tenant-1 + ├── tenant-2: EntityManagerFactory → database-tenant-2 + └── tenant-3: EntityManagerFactory → database-tenant-3 +---- + +When an event handler runs, it receives an `EntityManager` bound to the event's tenant. + +== EntityManager Injection + +=== Configuration + +First, provide a factory that creates `EntityManagerFactory` per tenant: + +==== Axon Framework + +[source,java] +---- +import jakarta.persistence.EntityManagerFactory; +import jakarta.persistence.Persistence; +import org.axonframework.extension.multitenancy.core.configuration.MultiTenancyConfigurer; +import org.axonframework.extension.multitenancy.projection.jpa.TenantEntityManagerFactoryProvider; + +MultiTenancyConfigurer.enhance(messagingConfigurer) + .registerTenantEntityManagerFactoryProvider(config -> tenant -> { + Map props = new HashMap<>(); + props.put("hibernate.connection.url", + "jdbc:postgresql://localhost:5432/" + tenant.tenantId()); + props.put("hibernate.connection.username", "postgres"); + props.put("hibernate.connection.password", "postgres"); + + return Persistence.createEntityManagerFactory("tenant-pu", props); + }) + .build(); +---- + +==== Spring Boot + +[source,java] +---- +import jakarta.persistence.EntityManagerFactory; +import org.axonframework.extension.multitenancy.projection.jpa.TenantEntityManagerFactoryProvider; +import org.springframework.orm.jpa.LocalContainerEntityManagerFactoryBean; +import org.springframework.context.annotation.Bean; + +@Configuration +public class JpaMultiTenancyConfig { + + @Bean + public TenantEntityManagerFactoryProvider tenantEntityManagerFactoryProvider( + DataSource... tenantDataSources) { // Your tenant data sources + + return tenant -> { + LocalContainerEntityManagerFactoryBean factory = + new LocalContainerEntityManagerFactoryBean(); + factory.setDataSource(getDataSourceForTenant(tenant)); + factory.setPackagesToScan("com.example.projections"); + factory.setJpaVendorAdapter(new HibernateJpaVendorAdapter()); + factory.afterPropertiesSet(); + return factory.getObject(); + }; + } +} +---- + +=== Usage in Event Handlers + +[source,java] +---- +import jakarta.persistence.EntityManager; +import org.axonframework.eventsourcing.eventhandling.EventHandler; +import org.axonframework.messaging.eventhandling.processing.ProcessingGroup; + +@ProcessingGroup("orders") +public class OrderProjection { + + @EventHandler + public void on(OrderCreatedEvent event, EntityManager entityManager) { + // EntityManager is automatically bound to the event's tenant + OrderEntity order = new OrderEntity( + event.getOrderId(), + event.getProductId(), + event.getQuantity() + ); + entityManager.persist(order); + } + + @EventHandler + public void on(OrderShippedEvent event, EntityManager entityManager) { + OrderEntity order = entityManager.find(OrderEntity.class, event.getOrderId()); + if (order != null) { + order.setStatus("SHIPPED"); + order.setShippedAt(event.getShippedAt()); + } + } +} +---- + +The `EntityManager` parameter is resolved by `TenantEntityManagerResolverFactory`, which: + +1. Extracts the tenant from the event's metadata +2. Gets the `EntityManagerFactory` for that tenant +3. Creates and provides an `EntityManager` + +== Spring Data Repository Injection + +For Spring Boot applications, you can inject tenant-scoped Spring Data repositories directly. + +=== Configuration + +[source,java] +---- +import org.axonframework.extension.multitenancy.autoconfig.jpa.TenantRepositoryRegistry; +import org.axonframework.extension.multitenancy.autoconfig.jpa.DefaultTenantRepositoryRegistry; +import org.axonframework.extension.multitenancy.projection.jpa.TenantEntityManagerRegistry; +import org.springframework.context.annotation.Bean; + +@Configuration +public class RepositoryConfig { + + @Bean + public TenantRepositoryRegistry tenantRepositoryRegistry( + TenantEntityManagerRegistry entityManagerRegistry) { + + return new DefaultTenantRepositoryRegistry(entityManagerRegistry); + } +} +---- + +=== Usage in Event Handlers + +[source,java] +---- +import org.axonframework.eventsourcing.eventhandling.EventHandler; +import org.axonframework.messaging.eventhandling.processing.ProcessingGroup; + +@ProcessingGroup("orders") +public class OrderProjection { + + @EventHandler + public void on(OrderCreatedEvent event, OrderRepository orderRepository) { + // Repository is automatically bound to the event's tenant + orderRepository.save(new OrderEntity( + event.getOrderId(), + event.getProductId(), + event.getQuantity() + )); + } + + @EventHandler + public void on(OrderShippedEvent event, OrderRepository orderRepository) { + orderRepository.findById(event.getOrderId()) + .ifPresent(order -> { + order.setStatus("SHIPPED"); + order.setShippedAt(event.getShippedAt()); + orderRepository.save(order); + }); + } +} +---- + +The `OrderRepository` is a standard Spring Data interface: + +[source,java] +---- +import org.springframework.data.jpa.repository.JpaRepository; + +public interface OrderRepository extends JpaRepository { + List findByStatus(String status); +} +---- + +=== How It Works + +The `TenantScopedJpaRepositoryResolverFactory`: + +1. Detects Spring Data `Repository` interface parameters +2. Extracts the tenant from the message context +3. Creates a repository bound to that tenant's `EntityManager` + +This happens per-handler-invocation, so each event gets a repository for its tenant. + +== Database Schema Management + +The extension does not manage database schemas. You're responsible for: + +1. Creating tenant databases/schemas +2. Running migrations (Flyway, Liquibase) per tenant +3. Ensuring schema compatibility + +=== Schema-per-Tenant Strategy + +[source,java] +---- +// Each tenant gets its own schema in a shared database +TenantEntityManagerFactoryProvider provider = tenant -> { + Map props = new HashMap<>(); + props.put("hibernate.connection.url", "jdbc:postgresql://localhost:5432/app"); + props.put("hibernate.default_schema", tenant.tenantId()); + return Persistence.createEntityManagerFactory("tenant-pu", props); +}; +---- + +=== Database-per-Tenant Strategy + +[source,java] +---- +// Each tenant gets its own database +TenantEntityManagerFactoryProvider provider = tenant -> { + Map props = new HashMap<>(); + props.put("hibernate.connection.url", + "jdbc:postgresql://localhost:5432/" + tenant.tenantId()); + return Persistence.createEntityManagerFactory("tenant-pu", props); +}; +---- + +== Query Handlers + +Query handlers can also receive tenant-scoped `EntityManager` or repositories: + +[source,java] +---- +@QueryHandler +public List handle(FindOrdersQuery query, EntityManager entityManager) { + return entityManager.createQuery( + "SELECT new OrderSummary(o.id, o.status) FROM OrderEntity o", + OrderSummary.class + ).getResultList(); +} + +// Or with repository +@QueryHandler +public List handle(FindOrdersQuery query, OrderRepository repository) { + return repository.findAll().stream() + .map(o -> new OrderSummary(o.getId(), o.getStatus())) + .toList(); +} +---- + +The tenant is resolved from the query message's metadata. + +== Critical: Method Parameter Injection + +In multi-tenant applications, you **must** use method parameter injection for all tenant-scoped resources: + +[source,java] +---- +// WRONG - field injection is NOT tenant-aware +@Component +public class OrderProjection { + @Autowired + private OrderRepository orderRepository; // Single instance for ALL tenants! + + @EventHandler + public void on(OrderCreatedEvent event) { + orderRepository.save(...); // Data goes to wrong tenant! + } +} + +// CORRECT - method parameter injection +@Component +public class OrderProjection { + + @EventHandler + public void on(OrderCreatedEvent event, OrderRepository orderRepository) { + orderRepository.save(...); // Correct tenant's repository + } +} +---- + +This applies to: + +* `EntityManager` +* Spring Data repositories (`JpaRepository`, etc.) +* Any tenant-scoped resource + +The parameter resolver extracts the tenant from the message's metadata and provides the correctly-scoped instance. + +== Best Practices + +1. **Use database-per-tenant for strong isolation**: Separate databases provide the strongest tenant isolation. + +2. **Cache EntityManagerFactory instances**: The `TenantEntityManagerRegistry` caches factories - don't create them on every request. + +3. **Handle missing tenants gracefully**: If a tenant's database doesn't exist, your factory should fail clearly. + +4. **Run migrations before tenant activation**: Ensure database schema is ready before adding a tenant to the provider. + +5. **Consider connection pooling**: Each tenant's `EntityManagerFactory` may have its own connection pool. Monitor total connections. diff --git a/docs/reference/modules/ROOT/pages/setup/axon-server.adoc b/docs/reference/modules/ROOT/pages/setup/axon-server.adoc new file mode 100644 index 0000000..6dffa37 --- /dev/null +++ b/docs/reference/modules/ROOT/pages/setup/axon-server.adoc @@ -0,0 +1,577 @@ +:navtitle: Using Axon Server += Using Axon Server + +This guide covers setting up multitenancy with Axon Server using the standard Axon Framework configuration (non-Spring). When using Axon Server, each tenant maps to an Axon Server context, providing natural isolation and automatic tenant discovery. + +== Why Axon Server for Multitenancy + +Axon Server Enterprise Edition provides native multi-context support that maps perfectly to multitenancy: + +* **Context-per-tenant isolation** - Each tenant gets its own Axon Server context with separate event stores, command routing, and query handling +* **Automatic tenant discovery** - The extension discovers available contexts from Axon Server and registers them as tenants +* **Dynamic tenant management** - Create or delete contexts in Axon Server, and the application automatically adapts +* **Distributed command and query routing** - Commands and queries route to the correct context automatically +* **No local infrastructure management** - Axon Server handles event storage and message distribution + +== Prerequisites + +Before starting, ensure you have: + +* **Axon Server Enterprise Edition** running with multiple contexts configured +* Each context represents a tenant (e.g., `university-oxford`, `university-cambridge`) +* Network connectivity from your application to Axon Server + +TIP: Without an Axon Server license, only the `default` context is available. This is sufficient for development and testing single-tenant scenarios. + +== Dependencies + +Add both the multitenancy core and Axon Server connector modules: + +[source,xml] +---- + + + + org.axonframework.extensions.multitenancy + axon-multitenancy + ${multitenancy.version} + + + + + org.axonframework.extensions.multitenancy + axon-multitenancy-axon-server-connector + ${multitenancy.version} + + + + + org.axonframework + axon-server-connector + ${axon.version} + + + + + org.axonframework + axon-eventsourcing + ${axon.version} + + +---- + +== Before: Single-Tenant Application + +Here is a typical single-tenant Axon Framework application connected to Axon Server: + +[source,java] +---- +import org.axonframework.axonserver.connector.AxonServerConfiguration; +import org.axonframework.common.configuration.AxonConfiguration; +import org.axonframework.eventsourcing.configuration.EventSourcingConfigurer; + +public class SingleTenantUniversityApp { + + public static void main(String[] args) { + // Configure Axon Server connection + AxonServerConfiguration axonServerConfig = new AxonServerConfiguration(); + axonServerConfig.setServers("localhost:8124"); + + // Create the configurer + EventSourcingConfigurer configurer = EventSourcingConfigurer.create(); + + // Register Axon Server configuration + configurer.componentRegistry(cr -> cr.registerComponent( + AxonServerConfiguration.class, c -> axonServerConfig)); + + // Register domain components (entities, projections, etc.) + configurer = CourseConfiguration.configure(configurer); + configurer = StudentConfiguration.configure(configurer); + + // Start the application + AxonConfiguration configuration = configurer.start(); + + // Use the command and query gateways + CommandGateway commandGateway = configuration.getComponent(CommandGateway.class); + QueryGateway queryGateway = configuration.getComponent(QueryGateway.class); + + // All operations go to the single "default" context + commandGateway.sendAndWait(new CreateCourse(CourseId.random(), "Introduction to Multitenancy", 30)); + } +} +---- + +In this setup: + +* All commands route to a single Axon Server context +* Events store in one context's event store +* All queries execute against one context + +== After: Multi-Tenant Application + +Here is the same application transformed to support multiple tenants using Axon Server contexts: + +[source,java] +---- +import org.axonframework.axonserver.connector.AxonServerConfiguration; +import org.axonframework.common.configuration.AxonConfiguration; +import org.axonframework.eventsourcing.configuration.EventSourcingConfigurer; +import org.axonframework.extension.multitenancy.core.MetadataBasedTenantResolver; +import org.axonframework.extension.multitenancy.core.TenantConnectPredicate; +import org.axonframework.extension.multitenancy.core.TenantDescriptor; +import org.axonframework.extension.multitenancy.core.configuration.MultiTenancyConfigurer; +import org.axonframework.messaging.core.Metadata; + +public class MultiTenantUniversityApp { + + public static void main(String[] args) { + // Configure Axon Server connection + AxonServerConfiguration axonServerConfig = new AxonServerConfiguration(); + axonServerConfig.setServers("localhost:8124"); + + // Create the base configurer + EventSourcingConfigurer configurer = EventSourcingConfigurer.create(); + + // Register Axon Server configuration + configurer.componentRegistry(cr -> cr.registerComponent( + AxonServerConfiguration.class, c -> axonServerConfig)); + + // Register tenant filter - only connect to university contexts + configurer.componentRegistry(cr -> cr.registerComponent( + TenantConnectPredicate.class, + c -> tenant -> tenant.tenantId().startsWith("university-"))); + + // Enable multitenancy with tenant resolver + MultiTenancyConfigurer multiTenancyConfigurer = MultiTenancyConfigurer.enhance(configurer) + .registerTargetTenantResolver(config -> new MetadataBasedTenantResolver()); + + // Register domain components (same as before) + configurer = CourseConfiguration.configure(configurer); + configurer = StudentConfiguration.configure(configurer); + + // Register tenant-scoped components (e.g., per-tenant repositories) + multiTenancyConfigurer.tenantComponent( + CourseRepository.class, + tenant -> new InMemoryCourseRepository() + ); + + // Ensure tenant ID propagates to events and subsequent messages + configurer.messaging(mc -> mc.registerCorrelationDataProvider(config -> message -> { + Map result = new HashMap<>(); + if (message.metadata().containsKey("tenantId")) { + result.put("tenantId", message.metadata().get("tenantId")); + } + return result; + })); + + // Start the application + AxonConfiguration configuration = configurer.start(); + + // Use the gateways with tenant metadata + CommandGateway commandGateway = configuration.getComponent(CommandGateway.class); + QueryGateway queryGateway = configuration.getComponent(QueryGateway.class); + + // Create course for Oxford University + commandGateway.send( + new CreateCourse(CourseId.random(), "Medieval History", 25), + Metadata.with("tenantId", "university-oxford") + ); + + // Create course for Cambridge University + commandGateway.send( + new CreateCourse(CourseId.random(), "Quantum Physics", 20), + Metadata.with("tenantId", "university-cambridge") + ); + } +} +---- + +=== What Changed + +The transformation involves these key additions: + +==== 1. AxonServerConfiguration Setup + +[source,java] +---- +AxonServerConfiguration axonServerConfig = new AxonServerConfiguration(); +axonServerConfig.setServers("localhost:8124"); + +configurer.componentRegistry(cr -> cr.registerComponent( + AxonServerConfiguration.class, c -> axonServerConfig)); +---- + +The `AxonServerConfiguration` tells the extension how to connect to Axon Server. The multitenancy connector uses this to discover available contexts and create per-tenant connections. + +==== 2. TenantConnectPredicate for Filtering Contexts + +[source,java] +---- +configurer.componentRegistry(cr -> cr.registerComponent( + TenantConnectPredicate.class, + c -> tenant -> tenant.tenantId().startsWith("university-"))); +---- + +The `TenantConnectPredicate` filters which Axon Server contexts become tenants. This is essential because: + +* Axon Server may have system contexts (like `_admin`) you do not want as tenants +* You may want to connect only to specific contexts based on naming conventions +* In production, you might filter based on context metadata + +Common patterns: + +[source,java] +---- +// Accept all non-system contexts +tenant -> !tenant.tenantId().startsWith("_") + +// Accept only contexts with specific prefix +tenant -> tenant.tenantId().startsWith("tenant-") + +// Accept contexts based on metadata +tenant -> "production".equals(tenant.properties().get("environment")) + +// Accept specific named contexts +Set allowed = Set.of("university-oxford", "university-cambridge"); +tenant -> allowed.contains(tenant.tenantId()) +---- + +==== 3. Automatic Tenant Discovery + +When using the `axon-multitenancy-axon-server-connector` module, the `AxonServerTenantProvider` is automatically registered via SPI. It: + +* Queries Axon Server's Admin API to discover available contexts +* Filters contexts using your `TenantConnectPredicate` +* Registers each matching context as a tenant +* Subscribes to context updates for dynamic tenant management + +You do not need to manually register tenants - they are discovered automatically. + +==== 4. Commands and Queries Route to Correct Context + +[source,java] +---- +// Command routes to university-oxford context in Axon Server +commandGateway.send( + new CreateCourse(CourseId.random(), "Medieval History", 25), + Metadata.with("tenantId", "university-oxford") +); +---- + +The `MultiTenantAxonServerCommandBusConnector` (registered automatically) uses the `TargetTenantResolver` to determine which tenant a command belongs to, then routes it to that tenant's Axon Server context. + +=== Complete Working Example + +Here is a complete example with domain classes: + +[source,java] +---- +// Command +public record CreateCourse( + @TargetEntityId CourseId courseId, + String name, + int capacity +) {} + +// Event +@Event(name = "CourseCreated") +public record CourseCreated( + @EventTag(key = "courseId") CourseId courseId, + String name, + int capacity +) {} + +// State entity - only reconstructs state from events +@EventSourcedEntity(tagKey = "courseId") +public class CourseState { + + private CourseId id; + private String name; + private int capacity; + private boolean created = false; + + @EntityCreator + public CourseState() {} + + @EventSourcingHandler + public void on(CourseCreated event) { + this.id = event.courseId(); + this.name = event.name(); + this.capacity = event.capacity(); + this.created = true; + } + + public boolean isCreated() { return created; } +} + +// Command handler - separate from state entity +public class CreateCourseHandler { + + @CommandHandler + public void handle(CreateCourse command, CourseState state, EventAppender appender) { + appender.append(new CourseCreated( + command.courseId(), + command.name(), + command.capacity() + )); + } +} +---- + +[source,java] +---- +// Query +public record FindAllCourses() { + public record Result(List courses) {} +} + +// Query Handler - uses parameter injection for tenant-scoped repository +public class FindAllCoursesQueryHandler { + + @QueryHandler + public FindAllCourses.Result handle(FindAllCourses query, CourseRepository repository) { + return new FindAllCourses.Result(repository.findAll()); + } +} +---- + +[source,java] +---- +// Configuration module for the Course entity +public class CourseConfiguration { + + public static EventSourcingConfigurer configure(EventSourcingConfigurer configurer) { + var entityModule = EventSourcedEntityModule + .autodetected(CourseId.class, Course.class); + + return configurer.registerEntity(entityModule); + } +} + +// Configuration module for the Course projection +public class CourseStatsConfiguration { + + public static EventSourcingConfigurer configure(EventSourcingConfigurer configurer) { + var processor = MultiTenantPooledStreamingEventProcessorModule + .create("CourseStatsProjection") + .eventHandlingComponents(c -> c + .autodetected(cfg -> new CourseStatsProjector()) + ) + .notCustomized(); + + QueryHandlingModule queryModule = QueryHandlingModule.named("CourseStats-Handler") + .queryHandlers() + .annotatedQueryHandlingComponent(cfg -> new FindAllCoursesQueryHandler()) + .build(); + + return configurer + .componentRegistry(cr -> cr.registerModule(processor.build())) + .registerQueryHandlingModule(queryModule); + } +} +---- + +[source,java] +---- +// Main application +public class MultiTenantUniversityApp { + + public static void main(String[] args) { + AxonServerConfiguration axonServerConfig = new AxonServerConfiguration(); + axonServerConfig.setServers("localhost:8124"); + + EventSourcingConfigurer configurer = EventSourcingConfigurer.create(); + + configurer.componentRegistry(cr -> cr.registerComponent( + AxonServerConfiguration.class, c -> axonServerConfig)); + + configurer.componentRegistry(cr -> cr.registerComponent( + TenantConnectPredicate.class, + c -> tenant -> tenant.tenantId().startsWith("university-"))); + + MultiTenancyConfigurer multiTenancyConfigurer = MultiTenancyConfigurer.enhance(configurer) + .registerTargetTenantResolver(config -> new MetadataBasedTenantResolver()); + + configurer = CourseConfiguration.configure(configurer); + configurer = CourseStatsConfiguration.configure(configurer); + + multiTenancyConfigurer.tenantComponent( + CourseRepository.class, + tenant -> new InMemoryCourseRepository() + ); + + configurer.messaging(mc -> mc.registerCorrelationDataProvider(config -> message -> { + Map result = new HashMap<>(); + if (message.metadata().containsKey("tenantId")) { + result.put("tenantId", message.metadata().get("tenantId")); + } + return result; + })); + + AxonConfiguration configuration = configurer.start(); + + // Wait for tenant discovery + TenantProvider provider = configuration.getComponent(TenantProvider.class); + // In production, use proper synchronization + + CommandGateway commandGateway = configuration.getComponent(CommandGateway.class); + QueryGateway queryGateway = configuration.getComponent(QueryGateway.class); + + // Operations now route to correct Axon Server context based on tenant metadata + } +} +---- + +== Key Differences from Non-Axon-Server Setup + +When using Axon Server, several things work differently compared to embedded mode: + +|=== +|Aspect |Embedded Mode |With Axon Server + +|Tenant Discovery +|Manual registration via `SimpleTenantProvider` +|Automatic discovery from Axon Server contexts + +|Event Storage +|In-memory or custom `StorageEngine` per tenant +|Axon Server context per tenant (events stored in Axon Server) + +|Command Routing +|Local `SimpleCommandBus` per tenant +|Distributed via `MultiTenantAxonServerCommandBusConnector` + +|Query Routing +|Local `SimpleQueryBus` per tenant +|Distributed via `MultiTenantAxonServerQueryBusConnector` + +|Dynamic Tenants +|Call `tenantProvider.addTenant()` +|Create new context in Axon Server (auto-discovered) + +|Infrastructure Management +|Application manages all infrastructure +|Axon Server manages event stores and message routing +|=== + +=== Automatically Registered Components + +When `axon-multitenancy-axon-server-connector` is on the classpath, these components are registered via SPI: + +|=== +|Component |Role + +|`AxonServerTenantProvider` +|Discovers tenants from Axon Server contexts + +|`MultiTenantAxonServerCommandBusConnector` +|Routes commands to tenant-specific Axon Server contexts + +|`MultiTenantAxonServerQueryBusConnector` +|Routes queries to tenant-specific Axon Server contexts + +|`AxonServerTenantEventSegmentFactory` +|Creates `EventStore` instances backed by Axon Server per tenant +|=== + +These override the embedded defaults without any additional configuration. + +== Production Considerations + +=== Axon Server Cluster Configuration + +For production deployments: + +[source,java] +---- +AxonServerConfiguration axonServerConfig = new AxonServerConfiguration(); +axonServerConfig.setServers("axonserver-1:8124,axonserver-2:8124,axonserver-3:8124"); +axonServerConfig.setClientId("university-service-" + instanceId); +axonServerConfig.setComponentName("university-service"); +---- + +=== Error Handling for Missing Tenants + +Commands sent to non-existent tenants will fail with `NoSuchTenantException`: + +[source,java] +---- +try { + // Note: .getResultMessage().join() blocks - necessary here to catch the exception + commandGateway.send( + new CreateCourse(courseId, "Test Course", 10), + Metadata.with("tenantId", "non-existent-tenant") + ).getResultMessage().join(); +} catch (CompletionException e) { + if (e.getCause() instanceof NoSuchTenantException) { + // Handle missing tenant + log.error("Tenant not found: {}", e.getCause().getMessage()); + } +} +---- + +=== Waiting for Tenant Registration + +After startup, tenants are discovered asynchronously. In production, wait for tenants to be available: + +[source,java] +---- +TenantProvider provider = configuration.getComponent(TenantProvider.class); +TenantDescriptor expectedTenant = TenantDescriptor.tenantWithId("university-oxford"); + +// Wait for tenant to be registered +Awaitility.await() + .atMost(Duration.ofSeconds(30)) + .until(() -> provider.getTenants().contains(expectedTenant)); +---- + +=== Health Checks + +Monitor tenant connectivity: + +[source,java] +---- +TenantProvider provider = configuration.getComponent(TenantProvider.class); +List tenants = provider.getTenants(); + +for (TenantDescriptor tenant : tenants) { + // Verify connectivity per tenant + log.info("Connected to tenant: {}", tenant.tenantId()); +} +---- + +=== Context Naming Conventions + +Establish clear naming conventions for contexts: + +* `tenant-` - Customer-specific contexts +* `region-` - Regional contexts +* `env-` - Environment-specific contexts (dev, staging, prod) + +Then filter with `TenantConnectPredicate`: + +[source,java] +---- +// Only connect to production tenant contexts +TenantConnectPredicate predicate = tenant -> + tenant.tenantId().startsWith("tenant-") && + !"_admin".equals(tenant.tenantId()); +---- + +=== Graceful Shutdown + +The extension handles shutdown automatically, but ensure proper cleanup: + +[source,java] +---- +Runtime.getRuntime().addShutdownHook(new Thread(() -> { + log.info("Shutting down multi-tenant application..."); + configuration.shutdown(); +})); +---- + +The shutdown process: + +1. Disconnects from each tenant's Axon Server context +2. Stops event processors for each tenant +3. Cleans up tenant-specific resources diff --git a/docs/reference/modules/ROOT/pages/setup/getting-started.adoc b/docs/reference/modules/ROOT/pages/setup/getting-started.adoc new file mode 100644 index 0000000..90e7786 --- /dev/null +++ b/docs/reference/modules/ROOT/pages/setup/getting-started.adoc @@ -0,0 +1,443 @@ +:navtitle: Getting Started += Getting Started + +This guide walks you through adding multi-tenancy to an existing Axon Framework application. We will transform a simple single-tenant Course management application into a multi-tenant system where each tenant has isolated data. + +== Prerequisites + +Before you begin, ensure you have: + +* **Axon Framework 5.0 or later** - This extension requires Axon Framework 5 +* **Java 17 or later** - Required by Axon Framework 5 + +== Add the Dependency + +Add the Multitenancy Extension to your Maven project: + +[source,xml] +---- + + org.axonframework.extensions.multitenancy + axon-multitenancy + ${multitenancy.version} + +---- + +NOTE: This guide covers the standard (non-Spring) setup with an embedded in-memory event store. For production deployments, see xref:setup/axon-server.adoc[Setting Up with Axon Server]. + +== Before: Single-Tenant Application + +Let's start with a simple Course management application. This is a standard Axon Framework application without multi-tenancy. + +=== Domain Model + +First, the command and event: + +[source,java] +---- +// Command to create a course +public record CreateCourse( + @TargetEntityId + CourseId courseId, + String name, + int capacity +) {} + +// Event published when a course is created +@Event(name = "CourseCreated") +public record CourseCreated( + @EventTag(key = "courseId") + CourseId courseId, + String name, + int capacity +) {} +---- + +The `CourseId` value object: + +[source,java] +---- +public record CourseId(String raw) { + + public static CourseId random() { + return new CourseId(UUID.randomUUID().toString()); + } + + @Override + public String toString() { + return raw; + } +} +---- + +=== State Entity + +The state entity reconstructs state from events. It only contains `@EventSourcingHandler` methods: + +[source,java] +---- +@EventSourcedEntity(tagKey = "courseId") +public class CourseState { + + private CourseId id; + private boolean created = false; + private int capacity; + + @EntityCreator + public CourseState() {} + + @EventSourcingHandler + public void on(CourseCreated event) { + this.id = event.courseId(); + this.created = true; + this.capacity = event.capacity(); + } + + public boolean isCreated() { return created; } + public int getCapacity() { return capacity; } +} +---- + +=== Command Handler + +Command handlers are separate from state entities. They receive the state as a parameter for validation: + +[source,java] +---- +public class CreateCourseHandler { + + @CommandHandler + public void handle(CreateCourse command, CourseState state, EventAppender appender) { + // Validate against current state if needed + // For creation, state will be empty/null for new entities + + appender.append( + new CourseCreated( + command.courseId(), + command.name(), + command.capacity() + ) + ); + } +} +---- + +=== Projection + +A simple projection to track course statistics: + +[source,java] +---- +// Read model +public record CourseStats(CourseId courseId, String name, int capacity) {} + +// Repository interface +public interface CourseStatsRepository { + CourseStats save(CourseStats stats); + List findAll(); +} + +// In-memory implementation +public class InMemoryCourseStatsRepository implements CourseStatsRepository { + private final ConcurrentHashMap stats = new ConcurrentHashMap<>(); + + @Override + public CourseStats save(CourseStats stats) { + this.stats.put(stats.courseId(), stats); + return stats; + } + + @Override + public List findAll() { + return stats.values().stream().toList(); + } +} + +// Event handler +public class CourseStatsProjector { + + @EventHandler + void handle(CourseCreated event, CourseStatsRepository repository) { + repository.save(new CourseStats( + event.courseId(), + event.name(), + event.capacity() + )); + } +} + +// Query and handler +public record FindAllCourses() { + public record Result(List courses) {} +} + +public class FindAllCoursesQueryHandler { + + @QueryHandler + FindAllCourses.Result handle(FindAllCourses query, CourseStatsRepository repository) { + return new FindAllCourses.Result(repository.findAll()); + } +} +---- + +=== Single-Tenant Configuration + +The standard configuration for a single-tenant application: + +[source,java] +---- +public class SingleTenantApplication { + + public static void main(String[] args) { + // Create base configurer + EventSourcingConfigurer configurer = EventSourcingConfigurer.create(); + + // Register the entity + var courseEntity = EventSourcedEntityModule + .autodetected(CourseId.class, CourseCreation.class); + configurer.registerEntity(courseEntity); + + // Register event processor with projector + var processor = PooledStreamingEventProcessorModule + .create("CourseStats") + .eventHandlingComponents(c -> c + .autodetected(cfg -> new CourseStatsProjector()) + ) + .notCustomized(); + configurer.componentRegistry(cr -> cr.registerModule(processor.build())); + + // Register query handler + QueryHandlingModule queryModule = QueryHandlingModule.named("CourseQueries") + .queryHandlers() + .annotatedQueryHandlingComponent(cfg -> new FindAllCoursesQueryHandler()) + .build(); + configurer.registerQueryHandlingModule(queryModule); + + // Register repository as a component + InMemoryCourseStatsRepository repository = new InMemoryCourseStatsRepository(); + configurer.componentRegistry(cr -> + cr.register(CourseStatsRepository.class, c -> repository) + ); + + // Start the application + AxonConfiguration configuration = configurer.start(); + CommandGateway commandGateway = configuration.getComponent(CommandGateway.class); + + // Send a command + commandGateway.sendAndWait( + new CreateCourse(CourseId.random(), "Introduction to Axon", 30) + ); + } +} +---- + +== After: Multi-Tenant Application + +Now let's transform this into a multi-tenant application. The key changes are: + +1. Enhance the configurer with `MultiTenancyConfigurer` +2. Register a `TenantProvider` to define available tenants +3. Register a `TargetTenantResolver` to determine which tenant a message belongs to +4. Register a correlation data provider to propagate tenant ID from commands to events +5. Register tenant-scoped components (like the repository) +6. Send commands with tenant metadata + +=== Multi-Tenant Configuration + +[source,java] +---- +import org.axonframework.extension.multitenancy.core.MetadataBasedTenantResolver; +import org.axonframework.extension.multitenancy.core.SimpleTenantProvider; +import org.axonframework.extension.multitenancy.core.TenantDescriptor; +import org.axonframework.extension.multitenancy.core.configuration.MultiTenancyConfigurer; +import org.axonframework.extension.multitenancy.messaging.eventhandling.processing.MultiTenantPooledStreamingEventProcessorModule; + +public class MultiTenantApplication { + + // Define tenants + private static final TenantDescriptor TENANT_A = TenantDescriptor.tenantWithId("tenant-a"); + private static final TenantDescriptor TENANT_B = TenantDescriptor.tenantWithId("tenant-b"); + + public static void main(String[] args) { + // Create tenant provider with initial tenants + SimpleTenantProvider tenantProvider = new SimpleTenantProvider( + List.of(TENANT_A, TENANT_B) + ); + + // Create base configurer + EventSourcingConfigurer configurer = EventSourcingConfigurer.create(); + + // 1. Enhance with multi-tenancy + MultiTenancyConfigurer multiTenancyConfigurer = MultiTenancyConfigurer.enhance(configurer) + .registerTenantProvider(config -> tenantProvider) + .registerTargetTenantResolver(config -> new MetadataBasedTenantResolver()); + + // 2. Register entity (same as before) + var courseEntity = EventSourcedEntityModule + .autodetected(CourseId.class, CourseCreation.class); + configurer.registerEntity(courseEntity); + + // 3. Use MultiTenantPooledStreamingEventProcessorModule for projections + // Register tenant-scoped repository with the processor - each tenant gets its own instance + var processor = MultiTenantPooledStreamingEventProcessorModule + .create("CourseStats") + .eventHandlingComponents(c -> c + .autodetected(cfg -> new CourseStatsProjector()) + ) + .tenantComponent(CourseStatsRepository.class, tenant -> new InMemoryCourseStatsRepository()) + .notCustomized(); + configurer.componentRegistry(cr -> cr.registerModule(processor.build())); + + // 4. Register query handler (same as before) + QueryHandlingModule queryModule = QueryHandlingModule.named("CourseQueries") + .queryHandlers() + .annotatedQueryHandlingComponent(cfg -> new FindAllCoursesQueryHandler()) + .build(); + configurer.registerQueryHandlingModule(queryModule); + + // 5. Register correlation data provider for tenant propagation + // This ensures tenantId flows from commands to events + configurer.messaging(mc -> mc.registerCorrelationDataProvider(config -> message -> { + Map result = new HashMap<>(); + if (message.metadata().containsKey("tenantId")) { + result.put("tenantId", message.metadata().get("tenantId")); + } + return result; + })); + + // Start the application + AxonConfiguration configuration = configurer.start(); + CommandGateway commandGateway = configuration.getComponent(CommandGateway.class); + + // Send command WITH tenant metadata + // Note: .getResultMessage().join() blocks - necessary here to prevent main() from exiting + commandGateway.send( + new CreateCourse(CourseId.random(), "Introduction to Multi-Tenancy", 30), + Metadata.with("tenantId", "tenant-a") // <1> + ).getResultMessage().join(); + } +} +---- +<1> The `tenantId` metadata is required. Without it, the command will fail with `NoSuchTenantException`. + +=== What Changed + +[cols="1,1"] +|=== +|Before (Single-Tenant) |After (Multi-Tenant) + +|`EventSourcingConfigurer.create()` +|`MultiTenancyConfigurer.enhance(configurer)` + +|Single repository instance +|`tenantComponent()` creates one per tenant + +|`PooledStreamingEventProcessorModule` +|`MultiTenantPooledStreamingEventProcessorModule` + +|No tenant metadata needed +|`Metadata.with("tenantId", "tenant-a")` +|=== + +=== Sending Commands with Tenant Metadata + +When sending commands, include the tenant ID in metadata: + +[source,java] +---- +// Using CommandGateway with metadata +// Note: .getResultMessage().join() blocks until completion - only needed in main() or tests. +// In REST controllers, return CompletableFuture instead. +commandGateway.send( + new CreateCourse(courseId, "Course Name", 25), + Metadata.with("tenantId", "tenant-a") +).getResultMessage().join(); +---- + +=== Querying with Tenant Metadata + +Queries also require tenant metadata: + +[source,java] +---- +QueryMessage query = new GenericQueryMessage( + new MessageType(FindAllCourses.class), + new FindAllCourses() +).andMetadata(Metadata.with("tenantId", "tenant-a")); + +List courses = queryGateway.query(query, FindAllCourses.Result.class) + .thenApply(FindAllCourses.Result::courses) + .join(); +---- + +== Key Points + +=== Tenant Isolation + +Each tenant has completely isolated infrastructure: + +* **Separate Event Stores** - Events from tenant A are never visible to tenant B +* **Separate Command Buses** - Commands are routed to the correct tenant's command handlers +* **Separate Query Buses** - Queries only return data from the specified tenant +* **Separate Event Processors** - Each tenant has its own event processor instances + +=== Same Entity ID in Different Tenants + +The same entity ID can exist in multiple tenants without conflict: + +[source,java] +---- +CourseId sharedId = CourseId.random(); + +// Create course with this ID in tenant A +commandGateway.send( + new CreateCourse(sharedId, "Course in Tenant A", 30), + Metadata.with("tenantId", "tenant-a") +); + +// Create course with SAME ID in tenant B - no conflict! +commandGateway.send( + new CreateCourse(sharedId, "Course in Tenant B", 25), + Metadata.with("tenantId", "tenant-b") +); +---- + +=== Dynamic Tenant Registration + +You can add tenants at runtime: + +[source,java] +---- +SimpleTenantProvider tenantProvider = new SimpleTenantProvider(List.of(TENANT_A)); + +// Later, add a new tenant dynamically +TenantDescriptor newTenant = TenantDescriptor.tenantWithId("tenant-c"); +tenantProvider.addTenant(newTenant); + +// Now commands to tenant-c will work +---- + +=== Missing Tenant Metadata + +If you send a command without tenant metadata, you will get a `NoSuchTenantException`: + +[source,java] +---- +// This will throw NoSuchTenantException +commandGateway.sendAndWait(new CreateCourse(courseId, "No Tenant", 10)); +---- + +Always include tenant information in your message metadata. + +== Next Steps + +This guide demonstrated multi-tenancy with an embedded in-memory event store, suitable for development and testing. For production deployments: + +* xref:setup/axon-server.adoc[Setting Up with Axon Server] - Recommended for production. Provides persistent storage, clustering, and automatic tenant discovery from Axon Server contexts. + +For more details on specific features: + +* xref:tenant-management.adoc[Tenant Management] - Dynamic tenant registration and lifecycle +* xref:message-routing.adoc[Message Routing] - How messages are routed to tenants +* xref:projections.adoc[Projections] - Multi-tenant event handling and projections +* xref:infrastructure.adoc[Infrastructure] - Multi-tenant infrastructure components diff --git a/docs/reference/modules/ROOT/pages/setup/spring-boot-axon-server.adoc b/docs/reference/modules/ROOT/pages/setup/spring-boot-axon-server.adoc new file mode 100644 index 0000000..12d674f --- /dev/null +++ b/docs/reference/modules/ROOT/pages/setup/spring-boot-axon-server.adoc @@ -0,0 +1,509 @@ +:navtitle: Spring Boot with Axon Server += Spring Boot with Axon Server + +This guide covers the recommended production setup: Spring Boot with Axon Server Enterprise Edition. This combination provides the simplest path to multi-tenancy with automatic tenant discovery and zero infrastructure code changes. + +== Introduction + +Spring Boot with Axon Server is the "golden path" for Axon Framework multi-tenancy. This setup offers: + +* **Automatic tenant discovery** - Tenants map directly to Axon Server contexts +* **Zero infrastructure code** - No custom factories or wiring required +* **Production-ready isolation** - Each tenant's events, commands, and queries are completely isolated +* **Dynamic tenant management** - Add or remove tenants at runtime through Axon Server + +With just a dependency and minimal configuration, your existing single-tenant application becomes multi-tenant. + +== Prerequisites + +Before starting, ensure you have: + +* **Spring Boot 3.x** - The extension requires Spring Boot 3.0 or later +* **Axon Server Enterprise Edition** - Multi-context support requires EE (or Developer Edition for testing) +* **Axon Server contexts created** - One context per tenant (e.g., `university-stanford`, `university-mit`) +* **Java 17+** - Required by Spring Boot 3.x + +TIP: For local development, use Axon Server Developer Edition which includes multi-context support. In the free Standard Edition, only the `default` context is available. + +== Dependencies + +Add the Spring Boot starter to your `pom.xml`: + +[source,xml] +---- + + org.axonframework.extension.multitenancy + multitenancy-spring-boot-starter + ${axon-multitenancy.version} + +---- + +This starter transitively includes: + +* `multitenancy` - Core multi-tenancy abstractions +* `multitenancy-axon-server-connector` - Axon Server integration +* `multitenancy-spring` - Spring integration +* `multitenancy-spring-boot-autoconfigure` - Auto-configuration + +== Before: Single-Tenant Application + +Consider a typical university course management application: + +=== Domain Model + +[source,java] +---- +// Command +public record CreateCourse( + @TargetEntityId CourseId courseId, + String name, + int capacity +) {} + +// Event +@Event(name = "CourseCreated") +public record CourseCreated( + @EventTag(key = "courseId") CourseId courseId, + String name, + int capacity +) {} + +// State entity - only reconstructs state from events +@EventSourced(tagKey = "courseId", idType = CourseId.class) +public class CourseState { + + private boolean created = false; + + @EventSourcingHandler + public void on(CourseCreated event) { + this.created = true; + } + + public boolean isCreated() { return created; } +} + +// Command handler - separate from state entity +@Component +public class CreateCourseHandler { + + @CommandHandler + public void handle(CreateCourse command, CourseState state, EventAppender appender) { + appender.append(new CourseCreated( + command.courseId(), + command.name(), + command.capacity() + )); + } +} +---- + +=== Projection + +[source,java] +---- +@Entity +@Table(name = "course_stats") +public class CourseStatsReadModel { + @Id + private String courseId; + private String name; + private int capacity; + // getters, setters... +} + +public interface CourseStatsRepository + extends JpaRepository { +} + +@Component +public class CourseStatsProjector { + + @Autowired + private CourseStatsRepository repository; // Single-tenant: field injection works + + @EventHandler + public void on(CourseCreated event) { + repository.save(new CourseStatsReadModel( + event.courseId().raw(), + event.name(), + event.capacity() + )); + } +} +---- + +=== Configuration + +[source,yaml] +---- +# application.yml - Single tenant +axon: + axonserver: + servers: localhost:8124 +---- + +This application serves one university. All courses, students, and data exist in a single Axon Server context. + +== After: Multi-Tenant Transformation + +Transform this into a multi-tenant application serving multiple universities: + +=== Step 1: Add the Dependency + +[source,xml] +---- + + org.axonframework.extension.multitenancy + multitenancy-spring-boot-starter + ${axon-multitenancy.version} + +---- + +=== Step 2: Configure Tenants + +[source,yaml] +---- +# application.yml - Multi-tenant +axon: + axonserver: + servers: localhost:8124 + multi-tenancy: + tenant-key: tenantId + axon-server: + contexts: stanford,mit,berkeley +---- + +That is the complete infrastructure configuration. The extension automatically: + +* Creates connections to each Axon Server context +* Routes commands and queries to the correct context based on message metadata +* Stores and retrieves events from tenant-specific event stores +* Creates per-tenant event processors + +=== Step 3: Update Projections for Tenant Isolation + +The only code change required is switching from field injection to method parameter injection for data access: + +[source,java] +---- +@Component +public class CourseStatsProjector { + + // REMOVED: @Autowired private CourseStatsRepository repository; + + @EventHandler + public void on(CourseCreated event, CourseStatsRepository repository) { + // Repository is automatically scoped to the event's tenant + repository.save(new CourseStatsReadModel( + event.courseId().raw(), + event.name(), + event.capacity() + )); + } +} +---- + +The `CourseStatsRepository` parameter is resolved per-invocation based on the event's tenant metadata. Each tenant's data is stored in its own database. + +=== Step 4: Send Messages with Tenant Context + +Include tenant information in your commands and queries: + +[source,java] +---- +// From a REST controller +@PostMapping("/courses") +public CompletableFuture createCourse(@RequestBody CreateCourseRequest request, + @RequestHeader("X-Tenant-ID") String tenantId) { + return commandGateway.send( + new CreateCourse(CourseId.random(), request.name(), request.capacity()), + Metadata.with("tenantId", tenantId) + ).getResultMessage(); +} + +// Query with tenant context +@GetMapping("/courses") +public CompletableFuture> listCourses(@RequestHeader("X-Tenant-ID") String tenantId) { + QueryMessage query = new GenericQueryMessage( + new MessageType(FindAllCourses.class), + new FindAllCourses() + ).andMetadata(Metadata.with("tenantId", tenantId)); + + return queryGateway.query(query, FindAllCourses.Result.class) + .thenApply(FindAllCourses.Result::courses); +} +---- + +== Automatic Tenant Discovery + +Instead of listing contexts explicitly, let the extension discover them from Axon Server: + +[source,yaml] +---- +axon: + multi-tenancy: + tenant-key: tenantId + axon-server: + filter-admin-contexts: true # Excludes contexts starting with "_" + # contexts: (omit to enable automatic discovery) +---- + +With automatic discovery: + +* The extension queries Axon Server for available contexts at startup +* New contexts added to Axon Server are automatically registered as tenants +* Contexts removed from Axon Server are automatically unregistered + +NOTE: Automatic discovery requires Axon Server's Admin API to be accessible. + +== Advanced Configuration + +=== TenantConnectPredicate for Context Filtering + +Control which Axon Server contexts become tenants: + +[source,java] +---- +import org.axonframework.extension.multitenancy.core.TenantConnectPredicate; +import org.axonframework.extension.multitenancy.core.TenantDescriptor; + +@Configuration +public class MultiTenancyConfig { + + @Bean + public TenantConnectPredicate tenantConnectPredicate() { + // Only connect to contexts starting with "university-" + return tenant -> tenant.tenantId().startsWith("university-"); + } +} +---- + +Use cases: + +* Filter by naming convention (e.g., `prod-*` vs `dev-*`) +* Exclude specific contexts (e.g., shared infrastructure contexts) +* Implement tenant allowlists + +=== Custom Tenant Resolver + +Override the default metadata-based resolver: + +[source,java] +---- +import org.axonframework.extension.multitenancy.core.TargetTenantResolver; +import org.axonframework.extension.multitenancy.core.TenantDescriptor; +import org.axonframework.messaging.core.Message; + +@Configuration +public class MultiTenancyConfig { + + @Bean + public TargetTenantResolver tenantResolver() { + return (message, tenants) -> { + // Custom logic to determine tenant + // Example: extract from a custom header or message payload + String tenantId = message.metadata().get("organizationId"); + if (tenantId == null) { + tenantId = extractFromPayload(message.payload()); + } + return TenantDescriptor.tenantWithId(tenantId); + }; + } +} +---- + +=== Per-Tenant JPA Projections + +For tenant-isolated projections with separate databases: + +==== Enable Tenant Repositories + +[source,yaml] +---- +axon: + multi-tenancy: + jpa: + tenant-repositories: true +---- + +==== Provide a TenantDataSourceProvider + +[source,java] +---- +import org.axonframework.extension.multitenancy.core.TenantDescriptor; +import org.axonframework.extension.multitenancy.spring.data.jpa.TenantDataSourceProvider; +import org.axonframework.extension.multitenancy.spring.data.jpa.TenantEntityManagerFactoryBuilder; +import org.springframework.boot.jdbc.DataSourceBuilder; + +@Configuration +public class TenantDatabaseConfig { + + @Bean + public TenantDataSourceProvider tenantDataSourceProvider() { + Map cache = new ConcurrentHashMap<>(); + + return tenant -> cache.computeIfAbsent(tenant.tenantId(), id -> + DataSourceBuilder.create() + .url("jdbc:postgresql://localhost:5432/" + id) + .username("app_user") + .password("secret") + .build() + ); + } + + @Bean + public TenantEntityManagerFactoryBuilder tenantEntityManagerFactoryBuilder( + TenantDataSourceProvider dataSourceProvider) { + return TenantEntityManagerFactoryBuilder + .forDataSourceProvider(dataSourceProvider) + .packagesToScan("com.example.university.projections") + .jpaProperty("hibernate.hbm2ddl.auto", "validate") + .jpaProperty("hibernate.dialect", "org.hibernate.dialect.PostgreSQLDialect") + .build(); + } +} +---- + +==== Use Method Parameter Injection + +[source,java] +---- +@Component +public class CourseStatsProjector { + + @EventHandler + public void on(CourseCreated event, CourseStatsRepository repository) { + // Repository connects to the tenant's specific database + repository.save(new CourseStatsReadModel( + event.courseId().raw(), + event.name(), + event.capacity() + )); + } +} + +@Component +public class CourseQueryHandler { + + @QueryHandler + public List handle(FindAllCourses query, + CourseStatsRepository repository) { + // Query runs against the tenant's database + return repository.findAll().stream() + .map(entity -> new CourseStats(entity.getCourseId(), entity.getName())) + .toList(); + } +} +---- + +IMPORTANT: Always use method parameter injection for repositories and EntityManagers in multi-tenant applications. Field injection creates a single instance shared across all tenants, causing data leakage. + +== Production Checklist + +Before deploying to production, verify: + +=== Infrastructure + +* [ ] Axon Server Enterprise Edition is deployed and licensed +* [ ] One Axon Server context exists per tenant +* [ ] Contexts are properly named (consider a naming convention like `prod-tenant-{name}`) +* [ ] Network connectivity from application to all Axon Server nodes + +=== Configuration + +* [ ] `axon.multi-tenancy.tenant-key` matches your metadata convention +* [ ] Either explicit contexts are listed or automatic discovery is configured +* [ ] `TenantConnectPredicate` filters out non-tenant contexts if using discovery +* [ ] Admin contexts (`_*`) are filtered out (`filter-admin-contexts: true`) + +=== Data Isolation + +* [ ] All repositories and EntityManagers use method parameter injection +* [ ] No field-injected data access components in handlers +* [ ] Per-tenant databases are configured (if using JPA projections) +* [ ] Database connections are properly pooled per tenant + +=== Operations + +* [ ] Monitoring configured for per-tenant metrics +* [ ] Logging includes tenant context for debugging +* [ ] Database migrations run per tenant before adding to Axon Server +* [ ] Backup strategy covers all tenant databases + +=== Security + +* [ ] Tenant ID validated before adding to message metadata +* [ ] No cross-tenant data access possible through API +* [ ] Axon Server context access properly secured + +== Complete Example Configuration + +[source,yaml] +---- +# application.yml +axon: + axonserver: + servers: axonserver.example.com:8124 + + multi-tenancy: + enabled: true + tenant-key: tenantId + + axon-server: + # Option 1: Explicit tenant list + contexts: stanford,mit,berkeley + + # Option 2: Automatic discovery (comment out 'contexts' above) + # filter-admin-contexts: true + + jpa: + tenant-repositories: true + +spring: + jpa: + # Disable default JPA when using tenant repositories + # (handled automatically by the extension) + +logging: + level: + org.axonframework.extension.multitenancy: DEBUG +---- + +[source,java] +---- +@Configuration +public class MultiTenancyConfig { + + @Bean + public TenantConnectPredicate tenantConnectPredicate() { + Set allowedTenants = Set.of("stanford", "mit", "berkeley"); + return tenant -> allowedTenants.contains(tenant.tenantId()); + } + + @Bean + public TenantDataSourceProvider tenantDataSourceProvider() { + return tenant -> DataSourceBuilder.create() + .url("jdbc:postgresql://db.example.com:5432/" + tenant.tenantId()) + .username(System.getenv("DB_USERNAME")) + .password(System.getenv("DB_PASSWORD")) + .build(); + } + + @Bean + public TenantEntityManagerFactoryBuilder tenantEntityManagerFactoryBuilder( + TenantDataSourceProvider provider) { + return TenantEntityManagerFactoryBuilder + .forDataSourceProvider(provider) + .packagesToScan("com.example.university.projections") + .jpaProperty("hibernate.hbm2ddl.auto", "validate") + .build(); + } +} +---- + +== Next Steps + +* xref:../tenant-management.adoc[Tenant Management] - Dynamic tenant registration and lifecycle +* xref:../message-routing.adoc[Message Routing] - How messages are routed to tenants +* xref:../projections.adoc[Projections] - Detailed guide on multi-tenant read models +* xref:../event-processors.adoc[Event Processors] - Per-tenant event processing diff --git a/docs/reference/modules/ROOT/pages/setup/spring-boot.adoc b/docs/reference/modules/ROOT/pages/setup/spring-boot.adoc new file mode 100644 index 0000000..df0ee3d --- /dev/null +++ b/docs/reference/modules/ROOT/pages/setup/spring-boot.adoc @@ -0,0 +1,655 @@ +:navtitle: Spring Boot += Spring Boot Integration + +This guide covers setting up the Multitenancy Extension with Spring Boot using embedded storage (JPA). For Axon Server deployments, see xref:setup/axon-server.adoc[Axon Server Integration]. + +== Benefits of Spring Boot Autoconfiguration + +Spring Boot autoconfiguration provides: + +* **Zero-configuration startup**: Multi-tenant infrastructure is created automatically +* **Handler auto-discovery**: `@CommandHandler`, `@EventHandler`, and `@QueryHandler` methods are discovered via component scanning +* **Tenant-scoped injection**: Spring Data repositories and `TenantComponent` implementations are automatically resolved per-tenant +* **Configuration properties**: Customize behavior via `application.yml` + +== Prerequisites + +* Spring Boot 3.x +* Axon Framework 5.x +* JPA provider (Hibernate recommended) + +== Dependencies + +Add the Spring Boot starter to your `pom.xml`: + +[source,xml] +---- + + org.axonframework.extension.multitenancy + multitenancy-spring-boot-starter + ${multitenancy.version} + +---- + +This starter includes: + +* Core multitenancy components +* Spring Boot autoconfiguration +* Spring Data JPA integration + +For JPA, also include: + +[source,xml] +---- + + org.springframework.boot + spring-boot-starter-data-jpa + + + com.h2database + h2 + runtime + +---- + +== Before: Single-Tenant Application + +Here is a typical single-tenant Spring Boot application managing university courses: + +=== Application Class + +[source,java] +---- +@SpringBootApplication +public class UniversityApplication { + public static void main(String[] args) { + SpringApplication.run(UniversityApplication.class, args); + } +} +---- + +=== Domain Model + +[source,java] +---- +// Command +public record CreateCourse( + @TargetEntityId CourseId courseId, + String name, + int capacity +) {} + +// Event +public record CourseCreated( + CourseId courseId, + String name, + int capacity +) {} +---- + +=== JPA Entity + +[source,java] +---- +@Entity +@Table(name = "course_stats") +public class CourseStatsReadModel { + + @Id + private String courseId; + private String name; + private int capacity; + + public CourseStatsReadModel() {} + + public CourseStatsReadModel(String courseId, String name, int capacity) { + this.courseId = courseId; + this.name = name; + this.capacity = capacity; + } + + // Getters and setters + public String getCourseId() { return courseId; } + public void setCourseId(String courseId) { this.courseId = courseId; } + public String getName() { return name; } + public void setName(String name) { this.name = name; } + public int getCapacity() { return capacity; } + public void setCapacity(int capacity) { this.capacity = capacity; } +} +---- + +=== Spring Data Repository + +[source,java] +---- +public interface CourseStatsJpaRepository extends JpaRepository { +} +---- + +=== Event Handler (Single-Tenant) + +In a single-tenant application, the repository is typically injected via constructor: + +[source,java] +---- +@Component +public class CourseStatsProjector { + + private final CourseStatsJpaRepository repository; + + public CourseStatsProjector(CourseStatsJpaRepository repository) { + this.repository = repository; // Single shared instance + } + + @EventHandler + public void on(CourseCreated event) { + repository.save(new CourseStatsReadModel( + event.courseId().raw(), + event.name(), + event.capacity() + )); + } +} +---- + +This approach fails in multi-tenant scenarios because all tenants share the same repository instance, causing data to mix between tenants. + +== After: Multi-Tenant Transformation + +=== Application Configuration + +Configure multi-tenancy in `application.yml`: + +[source,yaml] +---- +axon: + axonserver: + enabled: false # Using embedded storage, not Axon Server + multi-tenancy: + tenant-key: tenantId # Metadata key for tenant identification (default) + jpa: + tenant-repositories: true # Enable per-tenant JPA repositories +---- + +=== Tenant Provider + +Provide a `TenantProvider` bean that defines available tenants: + +[source,java] +---- +import org.axonframework.extension.multitenancy.core.TenantDescriptor; +import org.axonframework.extension.multitenancy.core.TenantProvider; +import org.axonframework.extension.multitenancy.core.SimpleTenantProvider; + +@Configuration +public class MultiTenancyConfiguration { + + public static final TenantDescriptor UNIVERSITY_A = + TenantDescriptor.tenantWithId("university-a"); + public static final TenantDescriptor UNIVERSITY_B = + TenantDescriptor.tenantWithId("university-b"); + + @Bean + public TenantProvider tenantProvider() { + return new SimpleTenantProvider(List.of(UNIVERSITY_A, UNIVERSITY_B)); + } +} +---- + +=== Per-Tenant DataSource Provider + +When using `axon.multi-tenancy.jpa.tenant-repositories=true`, you must provide a `TenantDataSourceProvider` that supplies a `DataSource` for each tenant: + +[source,java] +---- +import org.axonframework.extension.multitenancy.spring.data.jpa.TenantDataSourceProvider; +import org.springframework.boot.jdbc.DataSourceBuilder; +import javax.sql.DataSource; + +@Configuration +public class MultiTenancyConfiguration { + + @Bean + public TenantDataSourceProvider tenantDataSourceProvider() { + Map cache = new ConcurrentHashMap<>(); + return tenant -> cache.computeIfAbsent(tenant.tenantId(), id -> + DataSourceBuilder.create() + .url("jdbc:h2:mem:" + id + ";DB_CLOSE_DELAY=-1") + .driverClassName("org.h2.Driver") + .username("sa") + .password("") + .build() + ); + } +} +---- + +For production, connect to separate databases per tenant: + +[source,java] +---- +@Bean +public TenantDataSourceProvider tenantDataSourceProvider( + @Value("${db.username}") String username, + @Value("${db.password}") String password) { + + Map cache = new ConcurrentHashMap<>(); + return tenant -> cache.computeIfAbsent(tenant.tenantId(), id -> + DataSourceBuilder.create() + .url("jdbc:postgresql://localhost:5432/" + id) + .driverClassName("org.postgresql.Driver") + .username(username) + .password(password) + .build() + ); +} +---- + +=== EntityManagerFactory Configuration + +Optionally customize the `TenantEntityManagerFactoryBuilder` for Hibernate settings: + +[source,java] +---- +import org.axonframework.extension.multitenancy.spring.data.jpa.TenantEntityManagerFactoryBuilder; + +@Bean +public TenantEntityManagerFactoryBuilder tenantEntityManagerFactoryBuilder( + TenantDataSourceProvider dataSourceProvider) { + return TenantEntityManagerFactoryBuilder + .forDataSourceProvider(dataSourceProvider) + .packagesToScan("com.example.university.domain.read") + .jpaProperty("hibernate.hbm2ddl.auto", "create-drop") + .jpaProperty("hibernate.show_sql", "true") + .build(); +} +---- + +=== Repository Interface (No Changes Required) + +Your Spring Data repository interface stays exactly the same: + +[source,java] +---- +public interface CourseStatsJpaRepository extends JpaRepository { +} +---- + +When `axon.multi-tenancy.jpa.tenant-repositories=true`, the extension automatically: + +1. Discovers all `Repository` interfaces via classpath scanning +2. Registers them as tenant components +3. Creates tenant-scoped instances on demand + +=== Event Handler (Multi-Tenant) + +The key change is using **method parameter injection** instead of constructor injection: + +[source,java] +---- +@Component +public class CourseStatsProjector { + + private static final Logger logger = LoggerFactory.getLogger(CourseStatsProjector.class); + + @EventHandler + public void on(CourseCreated event, CourseStatsJpaRepository repository) { + // repository is automatically scoped to the event's tenant + logger.info("Saving course {} for current tenant", event.courseId()); + + repository.save(new CourseStatsReadModel( + event.courseId().raw(), + event.name(), + event.capacity() + )); + } +} +---- + +The `repository` parameter is resolved by `TenantRepositoryParameterResolverFactory`, which: + +1. Extracts the tenant from the event's metadata +2. Gets or creates the `EntityManagerFactory` for that tenant +3. Creates a Spring Data repository bound to that tenant's `EntityManager` + +=== Query Handler + +Query handlers also receive tenant-scoped repositories: + +[source,java] +---- +public record FindAllCourses() { + public record Result(List courses) {} +} + +@Component +public class FindAllCoursesQueryHandler { + + @QueryHandler + public FindAllCourses.Result handle(FindAllCourses query, + CourseStatsJpaRepository repository) { + // repository is scoped to the query's tenant + return new FindAllCourses.Result(repository.findAll()); + } +} +---- + +== TenantComponent for Tenant-Scoped Services + +Beyond repositories, you can create custom tenant-scoped services using the `TenantComponent` interface. + +=== Defining a TenantComponent + +[source,java] +---- +import org.axonframework.extension.multitenancy.core.TenantDescriptor; +import org.axonframework.extension.multitenancy.spring.TenantComponent; + +// Note: Do NOT add @Component annotation! +public class TenantAuditService implements TenantComponent { + + private final Clock clock; // Spring dependency + private final String tenantId; // Tenant context + + // Constructor for factory instance - Spring injects Clock + public TenantAuditService(Clock clock) { + this.clock = clock; + this.tenantId = null; + } + + // Private constructor for tenant-specific instances + private TenantAuditService(Clock clock, String tenantId) { + this.clock = clock; + this.tenantId = tenantId; + } + + @Override + public TenantAuditService createForTenant(TenantDescriptor tenant) { + return new TenantAuditService(clock, tenant.tenantId()); + } + + public void recordAudit(String action) { + Instant timestamp = clock.instant(); + // Record audit for this tenant + System.out.println(tenantId + ": " + action + " at " + timestamp); + } + + public String getTenantId() { + return tenantId; + } +} +---- + +Key points: + +* Do NOT annotate with `@Component` - the autoconfiguration discovers and manages these +* Spring dependencies are injected into the factory constructor +* The `createForTenant` method creates tenant-specific instances +* Instances are cached per-tenant + +=== Using TenantComponent in Handlers + +[source,java] +---- +@Component +public class CourseStatsProjector { + + @EventHandler + public void on(CourseCreated event, + CourseStatsJpaRepository repository, + TenantAuditService auditService) { + + // Both are automatically scoped to the event's tenant + auditService.recordAudit("course_created:" + event.courseId().raw()); + + repository.save(new CourseStatsReadModel( + event.courseId().raw(), + event.name(), + event.capacity() + )); + } +} +---- + +== TenantAwareProcessingContext + +For advanced scenarios, inject `ProcessingContext` to access tenant-scoped components programmatically: + +[source,java] +---- +import org.axonframework.messaging.core.unitofwork.ProcessingContext; + +@EventHandler +public void on(CourseCreated event, ProcessingContext context) { + // Get tenant-scoped repository from context + CourseStatsJpaRepository repository = + context.component(CourseStatsJpaRepository.class); + + // Get tenant-scoped service from context + TenantAuditService auditService = + context.component(TenantAuditService.class); + + auditService.recordAudit("course_created:" + event.courseId().raw()); + repository.save(new CourseStatsReadModel( + event.courseId().raw(), + event.name(), + event.capacity() + )); +} +---- + +When multi-tenancy is enabled, `ProcessingContext` is wrapped in `TenantAwareProcessingContext`, which intercepts `component()` calls for registered tenant-scoped types. + +== Sending Messages with Tenant Context + +When sending commands or queries, include the tenant ID in metadata: + +[source,java] +---- +import org.axonframework.messaging.core.Metadata; + +// Sending a command +// Note: .getResultMessage().join() blocks until completion - only needed in main() or tests. +// In REST controllers, return CompletableFuture instead. +commandGateway.send( + new CreateCourse(courseId, "Introduction to Java", 30), + Metadata.with("tenantId", "university-a") +).getResultMessage().join(); + +// Sending a query +QueryMessage query = new GenericQueryMessage( + new MessageType(FindAllCourses.class), + new FindAllCourses() +).andMetadata(Metadata.with("tenantId", "university-a")); + +List courses = queryGateway + .query(query, FindAllCourses.Result.class) + .thenApply(FindAllCourses.Result::courses) + .join(); +---- + +Messages without tenant metadata will fail with `NoSuchTenantException`. + +== Key Spring Boot Features + +=== Auto-Discovered Handlers + +Handler classes annotated with `@Component` are automatically discovered: + +[source,java] +---- +@Component // Spring discovers this +public class CourseStatsProjector { + + @EventHandler // Axon registers this handler + public void on(CourseCreated event, CourseStatsJpaRepository repository) { + // ... + } +} +---- + +=== Tenant-Scoped Repository Injection + +When `axon.multi-tenancy.jpa.tenant-repositories=true`: + +* Spring Data repositories are NOT registered as Spring beans +* Instead, they are created per-tenant on demand +* Inject via handler method parameters, not constructor injection + +=== Configuration Properties + +[cols="2,1,3"] +|=== +|Property |Default |Description + +|`axon.multi-tenancy.enabled` +|`true` +|Enable/disable multi-tenancy + +|`axon.multi-tenancy.tenant-key` +|`tenantId` +|Metadata key for tenant identification + +|`axon.multi-tenancy.jpa.tenant-repositories` +|`false` +|Enable per-tenant Spring Data repositories + +|`axon.multi-tenancy.tenant-components.enabled` +|`true` +|Enable TenantComponent auto-discovery +|=== + +== Complete Example + +=== Configuration + +[source,java] +---- +@Configuration +public class UniversityMultiTenancyConfig { + + public static final TenantDescriptor UNIVERSITY_A = + TenantDescriptor.tenantWithId("university-a"); + public static final TenantDescriptor UNIVERSITY_B = + TenantDescriptor.tenantWithId("university-b"); + + @Bean + public TenantProvider tenantProvider() { + return new SimpleTenantProvider(List.of(UNIVERSITY_A, UNIVERSITY_B)); + } + + @Bean + public TenantDataSourceProvider tenantDataSourceProvider() { + Map cache = new ConcurrentHashMap<>(); + return tenant -> cache.computeIfAbsent(tenant.tenantId(), id -> + DataSourceBuilder.create() + .url("jdbc:h2:mem:" + id + ";DB_CLOSE_DELAY=-1") + .driverClassName("org.h2.Driver") + .username("sa") + .password("") + .build() + ); + } + + @Bean + public TenantEntityManagerFactoryBuilder tenantEntityManagerFactoryBuilder( + TenantDataSourceProvider dataSourceProvider) { + return TenantEntityManagerFactoryBuilder + .forDataSourceProvider(dataSourceProvider) + .packagesToScan("com.example.university.domain.read") + .jpaProperty("hibernate.hbm2ddl.auto", "create-drop") + .build(); + } + + @Bean + public Clock clock() { + return Clock.systemUTC(); + } +} +---- + +=== application.yml + +[source,yaml] +---- +axon: + axonserver: + enabled: false + multi-tenancy: + jpa: + tenant-repositories: true + +logging: + level: + org.axonframework: INFO + org.axonframework.extension.multitenancy: DEBUG +---- + +=== Repository + +[source,java] +---- +public interface CourseStatsJpaRepository + extends JpaRepository { +} +---- + +=== Projector + +[source,java] +---- +@Component +public class CourseStatsProjector { + + @EventHandler + public void on(CourseCreated event, + CourseStatsJpaRepository repository, + TenantAuditService auditService) { + + auditService.recordAudit("course_created:" + event.courseId().raw()); + + repository.save(new CourseStatsReadModel( + event.courseId().raw(), + event.name(), + event.capacity() + )); + } +} +---- + +=== Query Handler + +[source,java] +---- +@Component +public class FindAllCoursesQueryHandler { + + @QueryHandler + public FindAllCourses.Result handle(FindAllCourses query, + CourseStatsJpaRepository repository) { + return new FindAllCourses.Result(repository.findAll()); + } +} +---- + +== What Happens Automatically + +When you add the multitenancy starter with the configuration above: + +1. **Multi-tenant infrastructure**: `MultiTenantCommandBus`, `MultiTenantQueryBus`, and `MultiTenantEventStore` replace the standard implementations + +2. **Handler registration**: Handlers are registered with all tenants via `MultiTenantMessageHandlerLookup` + +3. **Repository discovery**: All `JpaRepository` interfaces are discovered and registered as tenant components + +4. **TenantComponent discovery**: All `TenantComponent` implementations are discovered and registered + +5. **Parameter resolution**: Handler parameters are resolved per-tenant based on message metadata + +6. **Tenant correlation**: Tenant ID automatically propagates from commands to events via `TenantCorrelationProvider` + +== Next Steps + +* xref:tenant-management.adoc[Tenant Management] - Dynamic tenant registration +* xref:projections.adoc[Projections] - Advanced projection strategies +* xref:event-processors.adoc[Event Processors] - Multi-tenant event processing diff --git a/docs/reference/modules/ROOT/pages/tenant-management.adoc b/docs/reference/modules/ROOT/pages/tenant-management.adoc new file mode 100644 index 0000000..a02a3c3 --- /dev/null +++ b/docs/reference/modules/ROOT/pages/tenant-management.adoc @@ -0,0 +1,173 @@ +:navtitle: Tenant Management += Tenant Management + +Tenant management is handled by the `TenantProvider` interface. This component tracks which tenants exist and notifies other components when tenants are added or removed. + +== TenantProvider Interface + +[source,java] +---- +public interface TenantProvider { + Registration subscribe(MultiTenantAwareComponent component); + List getTenants(); +} +---- + +The provider serves two purposes: + +1. **Query**: Returns the current list of tenants via `getTenants()` +2. **Subscribe**: Notifies components when tenants change via `subscribe()` + +Multi-tenant infrastructure components (like `MultiTenantCommandBus`) subscribe to the provider and automatically create/destroy tenant segments as tenants come and go. + +== Choosing a TenantProvider + +=== With Axon Server (Recommended) + +When using the `multitenancy-axon-server-connector` module, `AxonServerTenantProvider` is auto-registered via SPI. It discovers tenants from Axon Server contexts. + +[source,yaml] +---- +# application.yml +axon: + multi-tenancy: + axon-server: + # Option 1: Explicit list + contexts: tenant-1,tenant-2,tenant-3 + + # Option 2: Auto-discovery with filtering + filter-admin-contexts: true # Excludes contexts starting with "_" +---- + +With auto-discovery, the provider monitors Axon Server and automatically adds/removes tenants as contexts are created/deleted. + +=== SimpleTenantProvider + +For deployments without Axon Server, use `SimpleTenantProvider`: + +[source,java] +---- +import org.axonframework.extension.multitenancy.core.SimpleTenantProvider; +import org.axonframework.extension.multitenancy.core.TenantDescriptor; + +// Static tenants at startup +SimpleTenantProvider provider = new SimpleTenantProvider(); +provider.addTenant(TenantDescriptor.tenantWithId("tenant-1")); +provider.addTenant(TenantDescriptor.tenantWithId("tenant-2")); +---- + +Or with initial tenants in the constructor: + +[source,java] +---- +SimpleTenantProvider provider = new SimpleTenantProvider(List.of( + TenantDescriptor.tenantWithId("tenant-1"), + TenantDescriptor.tenantWithId("tenant-2") +)); +---- + +=== Dynamic Tenant Management + +`SimpleTenantProvider` supports runtime tenant changes: + +[source,java] +---- +// Add a tenant at runtime +provider.addTenant(TenantDescriptor.tenantWithId("new-tenant")); + +// Remove a tenant +provider.removeTenant(TenantDescriptor.tenantWithId("old-tenant")); + +// Check if tenant exists +boolean exists = provider.hasTenant("tenant-1"); +---- + +When you add a tenant, all subscribed components (command bus, query bus, event store, event processors) automatically create infrastructure for that tenant. + +== Configuration + +=== Axon Framework + +[source,java] +---- +import org.axonframework.extension.multitenancy.core.SimpleTenantProvider; +import org.axonframework.extension.multitenancy.core.TenantDescriptor; +import org.axonframework.extension.multitenancy.core.configuration.MultiTenancyConfigurer; +import org.axonframework.messaging.core.configuration.MessagingConfigurer; + +SimpleTenantProvider tenantProvider = new SimpleTenantProvider(List.of( + TenantDescriptor.tenantWithId("tenant-1"), + TenantDescriptor.tenantWithId("tenant-2") +)); + +MessagingConfigurer messagingConfigurer = MessagingConfigurer.create(); +// ... configure handlers, entities, etc. + +MultiTenancyConfigurer.enhance(messagingConfigurer) + .registerTenantProvider(config -> tenantProvider) + .registerTargetTenantResolver(config -> new MetadataBasedTenantResolver("tenantId")) + .build() + .start(); +---- + +=== Spring Boot + +[source,java] +---- +import org.axonframework.extension.multitenancy.core.SimpleTenantProvider; +import org.axonframework.extension.multitenancy.core.TenantDescriptor; +import org.axonframework.extension.multitenancy.core.TenantProvider; +import org.springframework.context.annotation.Bean; +import org.springframework.context.annotation.Configuration; + +@Configuration +public class TenantConfiguration { + + @Bean + public TenantProvider tenantProvider() { + return new SimpleTenantProvider(List.of( + TenantDescriptor.tenantWithId("tenant-1"), + TenantDescriptor.tenantWithId("tenant-2") + )); + } +} +---- + +NOTE: With Axon Server and Spring Boot, you typically don't need to define a `TenantProvider` bean - the `AxonServerTenantProvider` is auto-registered via SPI. + +== Filtering Tenants + +Use `TenantConnectPredicate` to filter which tenants your application connects to: + +[source,java] +---- +import org.axonframework.extension.multitenancy.core.TenantConnectPredicate; +import org.springframework.context.annotation.Bean; + +@Bean +public TenantConnectPredicate tenantFilter() { + return tenant -> tenant.tenantId().startsWith("customer-"); +} +---- + +This is useful when: + +* Multiple applications share an Axon Server cluster but handle different tenant subsets +* You want to exclude administrative or system contexts +* You're doing a rolling deployment and want to gradually migrate tenants + +== TenantDescriptor + +`TenantDescriptor` is a simple record that identifies a tenant: + +[source,java] +---- +TenantDescriptor tenant = TenantDescriptor.tenantWithId("my-tenant"); +String id = tenant.tenantId(); // "my-tenant" +---- + +The tenant ID is typically used: + +* As the Axon Server context name +* In database connection strings for tenant-specific schemas +* As a routing key in message metadata diff --git a/docs/reference/modules/nav.adoc b/docs/reference/modules/nav.adoc index af74732..139290c 100644 --- a/docs/reference/modules/nav.adoc +++ b/docs/reference/modules/nav.adoc @@ -1,4 +1,21 @@ -* xref::configuration.adoc[] -* xref::multi-tenant-components.adoc[] -* xref::disable.adoc[] -* xref::release-notes.adoc[] \ No newline at end of file +* xref:ROOT:index.adoc[Introduction] + +* Setup Guides +** xref:ROOT:setup/getting-started.adoc[Getting Started] +** xref:ROOT:setup/axon-server.adoc[Axon Server Integration] +** xref:ROOT:setup/spring-boot.adoc[Spring Boot Integration] +** xref:ROOT:setup/spring-boot-axon-server.adoc[Spring Boot with Axon Server] + +* Concepts +** xref:ROOT:tenant-management.adoc[Tenant Management] +** xref:ROOT:message-routing.adoc[Message Routing] +** xref:ROOT:infrastructure.adoc[Infrastructure] +** xref:ROOT:projections.adoc[Projections] + +* Configuration Reference +** xref:ROOT:configuration/tenant-resolution.adoc[Tenant Resolution] +** xref:ROOT:configuration/event-processors.adoc[Event Processors] +** xref:ROOT:configuration/tenant-components.adoc[Tenant Components] +** xref:ROOT:configuration/dynamic-tenants.adoc[Dynamic Tenants] + +* xref:ROOT:release-notes.adoc[Release Notes] diff --git a/multitenancy-axon-server-connector/pom.xml b/multitenancy-axon-server-connector/pom.xml new file mode 100644 index 0000000..cfb4493 --- /dev/null +++ b/multitenancy-axon-server-connector/pom.xml @@ -0,0 +1,86 @@ + + + + 4.0.0 + + axon-multitenancy-parent + org.axonframework.extensions.multitenancy + 5.1.0-SNAPSHOT + + + axon-multitenancy-axon-server-connector + + Axon Framework Multi-Tenancy Extension - Axon Server Connector + + Module providing Axon Server integration for multi-tenancy. Contains AxonServerTenantProvider + which discovers tenants from Axon Server contexts. This module is Spring-agnostic and can be + used with any framework (raw Java, Quarkus, etc.) that uses Axon Server. + + + jar + + + + + org.axonframework.extensions.multitenancy + axon-multitenancy + ${project.version} + + + + org.axonframework + axon-server-connector + provided + + + + org.axonframework + axon-common + provided + + + + org.axonframework + axon-messaging + provided + + + + org.axonframework + axon-eventsourcing + provided + + + + jakarta.annotation + jakarta.annotation-api + + + + org.junit.jupiter + junit-jupiter-api + ${junit.jupiter.version} + test + + + org.mockito + mockito-core + ${mockito.version} + test + + + diff --git a/multitenancy-axon-server-connector/src/main/java/org/axonframework/extension/multitenancy/axonserver/AxonServerTenantEventSegmentFactory.java b/multitenancy-axon-server-connector/src/main/java/org/axonframework/extension/multitenancy/axonserver/AxonServerTenantEventSegmentFactory.java new file mode 100644 index 0000000..d8c5fb0 --- /dev/null +++ b/multitenancy-axon-server-connector/src/main/java/org/axonframework/extension/multitenancy/axonserver/AxonServerTenantEventSegmentFactory.java @@ -0,0 +1,111 @@ +/* + * Copyright (c) 2010-2025. Axon Framework + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.axonframework.extension.multitenancy.axonserver; + +import jakarta.annotation.Nonnull; +import org.axonframework.axonserver.connector.AxonServerConnectionManager; +import org.axonframework.axonserver.connector.event.AxonServerEventStorageEngine; +import org.axonframework.axonserver.connector.event.AxonServerEventStorageEngineFactory; +import org.axonframework.common.configuration.Configuration; +import org.axonframework.eventsourcing.eventstore.AnnotationBasedTagResolver; +import org.axonframework.eventsourcing.eventstore.EventStore; +import org.axonframework.eventsourcing.eventstore.StorageEngineBackedEventStore; +import org.axonframework.eventsourcing.eventstore.TagResolver; +import org.axonframework.extension.multitenancy.core.TenantDescriptor; +import org.axonframework.extension.multitenancy.eventsourcing.eventstore.TenantEventSegmentFactory; +import org.axonframework.messaging.eventhandling.SimpleEventBus; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +import java.util.Objects; + +/** + * A {@link TenantEventSegmentFactory} that creates {@link EventStore} instances + * per tenant, connecting each to its own Axon Server context. + *

+ * For each tenant, this factory: + *

    + *
  • Creates an {@link AxonServerEventStorageEngine} for the tenant's context
    • + *
  • Wraps it in a {@link StorageEngineBackedEventStore}
    • + *
+ * + * @author Theo Emanuelsson + * @since 5.0.0 + * @see TenantEventSegmentFactory + * @see AxonServerEventStorageEngineFactory + */ +public class AxonServerTenantEventSegmentFactory implements TenantEventSegmentFactory { + + private static final Logger logger = LoggerFactory.getLogger(AxonServerTenantEventSegmentFactory.class); + + private final Configuration configuration; + private final TagResolver tagResolver; + + /** + * Constructs an {@link AxonServerTenantEventSegmentFactory} using the provided configuration. + * + * @param configuration The Axon {@link Configuration} used to create tenant-specific event stores. + * @param tagResolver The {@link TagResolver} used for tagging events. + */ + public AxonServerTenantEventSegmentFactory( + @Nonnull Configuration configuration, + @Nonnull TagResolver tagResolver + ) { + this.configuration = Objects.requireNonNull(configuration, "Configuration must not be null"); + this.tagResolver = Objects.requireNonNull(tagResolver, "TagResolver must not be null"); + } + + /** + * Creates an {@link AxonServerTenantEventSegmentFactory} from the given {@link Configuration}. + * + * @param config The Axon {@link Configuration} to obtain components from. + * @return A new factory instance, or {@code null} if required components are not available. + */ + public static AxonServerTenantEventSegmentFactory createFrom(@Nonnull Configuration config) { + // Only create if AxonServerConnectionManager is available + if (!config.hasComponent(AxonServerConnectionManager.class)) { + return null; + } + + TagResolver tagResolver = config.getComponent( + TagResolver.class, + () -> new AnnotationBasedTagResolver() + ); + + return new AxonServerTenantEventSegmentFactory(config, tagResolver); + } + + @Override + public EventStore apply(TenantDescriptor tenant) { + logger.debug("Creating EventStore segment for tenant [{}]", tenant.tenantId()); + + // Create tenant-specific storage engine using the factory + AxonServerEventStorageEngine storageEngine = AxonServerEventStorageEngineFactory.constructForContext( + tenant.tenantId(), + configuration + ); + + // Create event store with tenant-specific storage engine + StorageEngineBackedEventStore eventStore = new StorageEngineBackedEventStore( + storageEngine, + new SimpleEventBus(), + tagResolver + ); + + logger.debug("Created EventStore segment for tenant [{}]", tenant.tenantId()); + return eventStore; + } +} diff --git a/multitenancy-spring-boot-autoconfigure/src/main/java/org/axonframework/extensions/multitenancy/autoconfig/AxonServerTenantProvider.java b/multitenancy-axon-server-connector/src/main/java/org/axonframework/extension/multitenancy/axonserver/AxonServerTenantProvider.java similarity index 61% rename from multitenancy-spring-boot-autoconfigure/src/main/java/org/axonframework/extensions/multitenancy/autoconfig/AxonServerTenantProvider.java rename to multitenancy-axon-server-connector/src/main/java/org/axonframework/extension/multitenancy/axonserver/AxonServerTenantProvider.java index 3570406..91fbd0e 100644 --- a/multitenancy-spring-boot-autoconfigure/src/main/java/org/axonframework/extensions/multitenancy/autoconfig/AxonServerTenantProvider.java +++ b/multitenancy-axon-server-connector/src/main/java/org/axonframework/extension/multitenancy/axonserver/AxonServerTenantProvider.java @@ -1,11 +1,11 @@ /* - * Copyright (c) 2010-2023. Axon Framework + * Copyright (c) 2010-2025. Axon Framework * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * - * http://www.apache.org/licenses/LICENSE-2.0 + * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, @@ -13,7 +13,7 @@ * See the License for the specific language governing permissions and * limitations under the License. */ -package org.axonframework.extensions.multitenancy.autoconfig; +package org.axonframework.extension.multitenancy.axonserver; import io.axoniq.axonserver.connector.ResultStream; import io.axoniq.axonserver.grpc.admin.ContextOverview; @@ -21,12 +21,10 @@ import org.axonframework.axonserver.connector.AxonServerConnectionManager; import org.axonframework.common.Registration; import org.axonframework.common.StringUtils; -import org.axonframework.extensions.multitenancy.components.MultiTenantAwareComponent; -import org.axonframework.extensions.multitenancy.components.TenantConnectPredicate; -import org.axonframework.extensions.multitenancy.components.TenantDescriptor; -import org.axonframework.extensions.multitenancy.components.TenantProvider; -import org.axonframework.lifecycle.Lifecycle; -import org.axonframework.lifecycle.Phase; +import org.axonframework.extension.multitenancy.core.MultiTenantAwareComponent; +import org.axonframework.extension.multitenancy.core.TenantConnectPredicate; +import org.axonframework.extension.multitenancy.core.TenantDescriptor; +import org.axonframework.extension.multitenancy.core.TenantProvider; import org.slf4j.Logger; import org.slf4j.LoggerFactory; @@ -38,58 +36,80 @@ import java.util.List; import java.util.Map; import java.util.Set; +import java.util.concurrent.CompletableFuture; import java.util.concurrent.ConcurrentHashMap; import java.util.concurrent.CopyOnWriteArrayList; import java.util.stream.Collectors; -import javax.annotation.Nonnull; /** * Axon Server implementation of the {@link TenantProvider}. Uses Axon Server's multi-context support to construct * tenant-specific segments of all {@link MultiTenantAwareComponent MultiTenantAwareComponents}. + *

+ * This provider can: + *

    + *
  • Discover tenants from predefined context names
    • + *
  • Dynamically discover tenants via Axon Server's Admin API
    • + *
  • Subscribe to context updates to add/remove tenants at runtime
    • + *
+ *

+ * This class is Spring-agnostic and can be used with any framework that uses Axon Server. + * Lifecycle management (start/shutdown) is handled through the configuration API via + * {@link DistributedMultiTenancyConfigurationDefaults}. * * @author Stefan Dragisic - * @since 4.6.0 + * @author Theo Emanuelsson + * @since 5.0.0 + * @see TenantProvider + * @see TenantConnectPredicate + * @see DistributedMultiTenancyConfigurationDefaults */ -public class AxonServerTenantProvider implements TenantProvider, Lifecycle { +public class AxonServerTenantProvider implements TenantProvider { private static final Logger logger = LoggerFactory.getLogger(AxonServerTenantProvider.class); + private static final String ADMIN_CTX = "_admin"; private final List tenantAwareComponents = new CopyOnWriteArrayList<>(); - private final Set tenantDescriptors = new HashSet<>(); private final String preDefinedContexts; private final TenantConnectPredicate tenantConnectPredicate; private final AxonServerConnectionManager axonServerConnectionManager; - private final String ADMIN_CTX = "_admin"; + private ConcurrentHashMap> registrationMap = new ConcurrentHashMap<>(); /** - * Construct a {@link AxonServerTenantProvider}. + * Construct a {@link AxonServerTenantProvider} using a builder pattern. * - * @param preDefinedContexts A comma-separated list of all the base contexts used for the tenants. - * @param tenantConnectPredicate A {@link java.util.function.Predicate} used to filter out newly registered - * contexts as tenants. - * @param axonServerConnectionManager The {@link AxonServerConnectionManager} used to retrieve all context-specific - * changes through to make adjustments in the tenant-specific segments. + * @param builder The builder containing the configuration. */ - public AxonServerTenantProvider(String preDefinedContexts, - TenantConnectPredicate tenantConnectPredicate, - AxonServerConnectionManager axonServerConnectionManager) { - this.preDefinedContexts = preDefinedContexts; - this.tenantConnectPredicate = tenantConnectPredicate; - this.axonServerConnectionManager = axonServerConnectionManager; + protected AxonServerTenantProvider(Builder builder) { + this.preDefinedContexts = builder.preDefinedContexts; + this.tenantConnectPredicate = builder.tenantConnectPredicate; + this.axonServerConnectionManager = builder.axonServerConnectionManager; } /** - * Start this {@link TenantProvider}, by added all tenants and subscribing to the + * Creates a new {@link Builder} to construct an {@link AxonServerTenantProvider}. + * + * @return A new Builder instance. + */ + public static Builder builder() { + return new Builder(); + } + + /** + * Start this {@link TenantProvider}, by adding all tenants and subscribing to the * {@link AxonServerConnectionManager} for context updates. + * + * @return A {@link CompletableFuture} that completes when the provider has started. */ - public void start() { - tenantDescriptors.addAll(getInitialTenants()); - tenantDescriptors.forEach(this::addTenant); - if (preDefinedContexts == null || preDefinedContexts.isEmpty()) { - subscribeToUpdates(); - } + public CompletableFuture start() { + return CompletableFuture.runAsync(() -> { + tenantDescriptors.addAll(getInitialTenants()); + tenantDescriptors.forEach(this::addTenant); + if (preDefinedContexts == null || preDefinedContexts.isEmpty()) { + subscribeToUpdates(); + } + }); } private List getInitialTenants() { @@ -125,6 +145,10 @@ private void subscribeToUpdates() { break; case DELETED: removeTenant(TenantDescriptor.tenantWithId(contextUpdate.getContext())); + break; + default: + // Ignore other update types + break; } } } catch (Exception e) { @@ -176,7 +200,7 @@ private TenantDescriptor toTenantDescriptor(ContextOverview context) { /** * Adds a new tenant to the system. - * + *

* This method adds the provided {@link TenantDescriptor} to the set of known tenants. * Once added all {@link MultiTenantAwareComponent MultiTenantAwareComponents} are registered and started for the * new tenant. @@ -186,14 +210,14 @@ private TenantDescriptor toTenantDescriptor(ContextOverview context) { public void addTenant(TenantDescriptor tenantDescriptor) { tenantDescriptors.add(tenantDescriptor); tenantAwareComponents - .forEach(bus -> registrationMap + .forEach(component -> registrationMap .computeIfAbsent(tenantDescriptor, t -> new CopyOnWriteArrayList<>()) - .add(bus.registerAndStartTenant(tenantDescriptor))); + .add(component.registerAndStartTenant(tenantDescriptor))); } /** * Removes a tenant from the system. - * + *

* This method checks if the provided {@link TenantDescriptor} is in the set of known tenants. * If it is, the method removes the tenant and cancels all its registrations. * {@link MultiTenantAwareComponent MultiTenantAwareComponents} are then unregistered in reverse order of their @@ -213,18 +237,18 @@ public void removeTenant(TenantDescriptor tenantDescriptor) { } @Override - public Registration subscribe(MultiTenantAwareComponent bus) { - tenantAwareComponents.add(bus); + public Registration subscribe(MultiTenantAwareComponent component) { + tenantAwareComponents.add(component); tenantDescriptors .forEach(tenantDescriptor -> registrationMap .computeIfAbsent(tenantDescriptor, t -> new CopyOnWriteArrayList<>()) - .add(bus.registerTenant(tenantDescriptor))); + .add(component.registerTenant(tenantDescriptor))); return () -> { + tenantAwareComponents.remove(component); registrationMap.forEach((tenant, registrationList) -> { registrationList.forEach(Registration::cancel); - tenantAwareComponents.removeIf(t -> true); axonServerConnectionManager.disconnect(tenant.tenantId()); }); registrationMap = new ConcurrentHashMap<>(); @@ -232,16 +256,8 @@ public Registration subscribe(MultiTenantAwareComponent bus) { }; } - @Override - public void registerLifecycleHandlers(@Nonnull LifecycleRegistry lifecycle) { - lifecycle.onStart(Phase.INSTRUCTION_COMPONENTS + 10, this::start); - lifecycle.onShutdown(Phase.INSTRUCTION_COMPONENTS + 10, this::shutdown); - } - /** * Shuts down the AxonServerTenantProvider by deregistering all subscribed components. - * This method is designed to be invoked by a lifecycle handler (e.g., a shutdown hook) - * to ensure proper cleanup when the application is shutting down. *

* The shutdown process involves the following steps: *

    @@ -255,12 +271,74 @@ public void registerLifecycleHandlers(@Nonnull LifecycleRegistry lifecycle) { * This method ensures that all resources associated with tenant management are properly * released and that components are given the opportunity to perform any necessary cleanup * in the reverse order of their registration. + * + * @return A {@link CompletableFuture} that completes when the provider has shut down. */ - public void shutdown() { - registrationMap.values().forEach(registrationList -> { - ArrayList reversed = new ArrayList<>(registrationList); - Collections.reverse(reversed); - reversed.forEach(Registration::cancel); + public CompletableFuture shutdown() { + return CompletableFuture.runAsync(() -> { + registrationMap.values().forEach(registrationList -> { + ArrayList reversed = new ArrayList<>(registrationList); + Collections.reverse(reversed); + reversed.forEach(Registration::cancel); + }); }); } + + /** + * Builder class for constructing an {@link AxonServerTenantProvider}. + */ + public static class Builder { + + private String preDefinedContexts; + private TenantConnectPredicate tenantConnectPredicate = tenant -> true; + private AxonServerConnectionManager axonServerConnectionManager; + + /** + * Sets a comma-separated list of predefined context names to use as tenants. + * If set, the provider will not discover tenants from Axon Server's Admin API. + * + * @param preDefinedContexts A comma-separated list of context names. + * @return This builder for chaining. + */ + public Builder preDefinedContexts(String preDefinedContexts) { + this.preDefinedContexts = preDefinedContexts; + return this; + } + + /** + * Sets the predicate used to filter which contexts should be registered as tenants. + * Defaults to accepting all contexts. + * + * @param tenantConnectPredicate The predicate to filter tenants. + * @return This builder for chaining. + */ + public Builder tenantConnectPredicate(TenantConnectPredicate tenantConnectPredicate) { + this.tenantConnectPredicate = tenantConnectPredicate; + return this; + } + + /** + * Sets the {@link AxonServerConnectionManager} used to connect to Axon Server + * and retrieve context information. + * + * @param axonServerConnectionManager The connection manager. + * @return This builder for chaining. + */ + public Builder axonServerConnectionManager(AxonServerConnectionManager axonServerConnectionManager) { + this.axonServerConnectionManager = axonServerConnectionManager; + return this; + } + + /** + * Builds the {@link AxonServerTenantProvider} with the configured settings. + * + * @return A new AxonServerTenantProvider instance. + */ + public AxonServerTenantProvider build() { + if (axonServerConnectionManager == null) { + throw new IllegalStateException("AxonServerConnectionManager is required"); + } + return new AxonServerTenantProvider(this); + } + } } diff --git a/multitenancy-axon-server-connector/src/main/java/org/axonframework/extension/multitenancy/axonserver/DistributedMultiTenancyConfigurationDefaults.java b/multitenancy-axon-server-connector/src/main/java/org/axonframework/extension/multitenancy/axonserver/DistributedMultiTenancyConfigurationDefaults.java new file mode 100644 index 0000000..de9c691 --- /dev/null +++ b/multitenancy-axon-server-connector/src/main/java/org/axonframework/extension/multitenancy/axonserver/DistributedMultiTenancyConfigurationDefaults.java @@ -0,0 +1,147 @@ +/* + * Copyright (c) 2010-2025. Axon Framework + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.axonframework.extension.multitenancy.axonserver; + +import jakarta.annotation.Nonnull; +import org.axonframework.axonserver.connector.AxonServerConnectionManager; +import org.axonframework.common.configuration.ComponentDefinition; +import org.axonframework.common.configuration.ComponentRegistry; +import org.axonframework.common.configuration.Configuration; +import org.axonframework.common.configuration.ConfigurationEnhancer; +import org.axonframework.common.configuration.SearchScope; +import org.axonframework.common.lifecycle.Phase; +import org.axonframework.extension.multitenancy.core.MultiTenantAwareComponent; +import org.axonframework.extension.multitenancy.core.TenantConnectPredicate; +import org.axonframework.extension.multitenancy.core.TenantProvider; +import org.axonframework.extension.multitenancy.core.configuration.MultiTenancyConfigurationDefaults; +import org.axonframework.extension.multitenancy.eventsourcing.eventstore.TenantEventSegmentFactory; +import org.axonframework.messaging.commandhandling.distributed.CommandBusConnector; +import org.axonframework.messaging.queryhandling.distributed.QueryBusConnector; + +/** + * A {@link ConfigurationEnhancer} that provides default multi-tenancy components for distributed + * deployments using Axon Server. This enhancer is auto-discovered via SPI when the module is on + * the classpath. + *

    + * This enhancer implements the wrapping pattern: rather than creating per-tenant + * {@code DistributedCommandBus} and {@code DistributedQueryBus} instances, it provides multi-tenant + * connectors that wrap the standard framework infrastructure. This ensures all framework decorators + * (such as {@code PayloadConvertingCommandBusConnector}) are automatically applied. + *

    + * When activated, this enhancer registers: + *

      + *
    • {@link AxonServerTenantProvider} as the {@link TenantProvider} - discovers tenants from Axon Server contexts
      • + *
    • {@link MultiTenantAxonServerCommandBusConnector} as the {@link CommandBusConnector} - routes commands to tenant-specific connectors
      • + *
    • {@link MultiTenantAxonServerQueryBusConnector} as the {@link QueryBusConnector} - routes queries to tenant-specific connectors
      • + *
    • {@link AxonServerTenantEventSegmentFactory} as the {@link TenantEventSegmentFactory} - creates per-tenant event stores
      • + *
    + *

    + * The multi-tenant connectors are subscribed to the {@link TenantProvider} during the + * {@link Phase#INSTRUCTION_COMPONENTS} phase, enabling them to receive tenant lifecycle events + * and create/destroy tenant-specific connectors dynamically. + *

    + * The enhancer only registers components if: + *

      + *
    • An {@link AxonServerConnectionManager} is available in the configuration
      • + *
    • A {@link org.axonframework.extension.multitenancy.core.TargetTenantResolver TargetTenantResolver} is available
      • + *
    • No other implementation has been explicitly registered for that component type
      • + *
    + * + * @author Theo Emanuelsson + * @since 5.0.0 + * @see AxonServerTenantProvider + * @see MultiTenantAxonServerCommandBusConnector + * @see MultiTenantAxonServerQueryBusConnector + * @see AxonServerTenantEventSegmentFactory + */ +public class DistributedMultiTenancyConfigurationDefaults implements ConfigurationEnhancer { + + /** + * The order of this enhancer. Runs just before {@code MultiTenancyConfigurationDefaults} + * to register Axon Server-specific components that override the embedded defaults. + *

    + * Both enhancers use {@code registerIfNotPresent()} - whichever runs first wins. + * This ensures Axon Server implementations take precedence when on the classpath. + */ + public static final int ENHANCER_ORDER = MultiTenancyConfigurationDefaults.ENHANCER_ORDER - 5; + + @Override + public void enhance(@Nonnull ComponentRegistry registry) { + registry.registerIfNotPresent(tenantProviderDefinition(), SearchScope.ALL); + registry.registerIfNotPresent(commandBusConnectorDefinition(), SearchScope.ALL); + registry.registerIfNotPresent(queryBusConnectorDefinition(), SearchScope.ALL); + registry.registerIfNotPresent(eventSegmentFactoryDefinition(), SearchScope.ALL); + } + + private static ComponentDefinition tenantProviderDefinition() { + return ComponentDefinition.ofType(TenantProvider.class) + .withBuilder(config -> { + // Only build if AxonServerConnectionManager is available + return config.getOptionalComponent(AxonServerConnectionManager.class) + .map(connectionManager -> AxonServerTenantProvider.builder() + .axonServerConnectionManager(connectionManager) + .tenantConnectPredicate( + config.getComponent( + TenantConnectPredicate.class, + () -> tenant -> true + ) + ) + .build()) + .orElse(null); + }) + .onStart(Phase.INSTRUCTION_COMPONENTS + 10, + provider -> ((AxonServerTenantProvider) provider).start()) + .onShutdown(Phase.INSTRUCTION_COMPONENTS + 10, + provider -> ((AxonServerTenantProvider) provider).shutdown()); + } + + private static ComponentDefinition commandBusConnectorDefinition() { + return ComponentDefinition.ofType(CommandBusConnector.class) + .withBuilder(MultiTenantAxonServerCommandBusConnector::createFrom) + .onStart(Phase.INSTRUCTION_COMPONENTS, + (Configuration config, CommandBusConnector connector) -> + subscribeToTenantProvider(config, connector)) + .onShutdown(Phase.OUTBOUND_COMMAND_CONNECTORS, + connector -> ((MultiTenantAxonServerCommandBusConnector) connector).shutdown()); + } + + private static ComponentDefinition queryBusConnectorDefinition() { + return ComponentDefinition.ofType(QueryBusConnector.class) + .withBuilder(MultiTenantAxonServerQueryBusConnector::createFrom) + .onStart(Phase.INSTRUCTION_COMPONENTS, + (Configuration config, QueryBusConnector connector) -> + subscribeToTenantProvider(config, connector)) + .onShutdown(Phase.OUTBOUND_QUERY_CONNECTORS, + connector -> ((MultiTenantAxonServerQueryBusConnector) connector).shutdown()); + } + + private static void subscribeToTenantProvider(Configuration config, Object connector) { + if (connector instanceof MultiTenantAwareComponent multiTenantConnector) { + config.getOptionalComponent(TenantProvider.class) + .ifPresent(provider -> provider.subscribe(multiTenantConnector)); + } + } + + private static ComponentDefinition eventSegmentFactoryDefinition() { + return ComponentDefinition.ofType(TenantEventSegmentFactory.class) + .withBuilder(AxonServerTenantEventSegmentFactory::createFrom); + } + + @Override + public int order() { + return ENHANCER_ORDER; + } +} diff --git a/multitenancy-axon-server-connector/src/main/java/org/axonframework/extension/multitenancy/axonserver/MultiTenantAxonServerCommandBusConnector.java b/multitenancy-axon-server-connector/src/main/java/org/axonframework/extension/multitenancy/axonserver/MultiTenantAxonServerCommandBusConnector.java new file mode 100644 index 0000000..a1ad10f --- /dev/null +++ b/multitenancy-axon-server-connector/src/main/java/org/axonframework/extension/multitenancy/axonserver/MultiTenantAxonServerCommandBusConnector.java @@ -0,0 +1,332 @@ +/* + * Copyright (c) 2010-2025. Axon Framework + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.axonframework.extension.multitenancy.axonserver; + +import io.axoniq.axonserver.connector.AxonServerConnection; +import jakarta.annotation.Nonnull; +import jakarta.annotation.Nullable; +import org.axonframework.axonserver.connector.AxonServerConfiguration; +import org.axonframework.axonserver.connector.AxonServerConnectionManager; +import org.axonframework.axonserver.connector.command.AxonServerCommandBusConnector; +import org.axonframework.common.AxonConfigurationException; +import org.axonframework.common.Registration; +import org.axonframework.common.configuration.Configuration; +import org.axonframework.common.infra.ComponentDescriptor; +import org.axonframework.extension.multitenancy.core.MultiTenantAwareComponent; +import org.axonframework.extension.multitenancy.core.NoSuchTenantException; +import org.axonframework.extension.multitenancy.core.TargetTenantResolver; +import org.axonframework.extension.multitenancy.core.TenantDescriptor; +import org.axonframework.messaging.commandhandling.CommandMessage; +import org.axonframework.messaging.commandhandling.CommandResultMessage; +import org.axonframework.messaging.commandhandling.distributed.CommandBusConnector; +import org.axonframework.messaging.core.Message; +import org.axonframework.messaging.core.QualifiedName; +import org.axonframework.messaging.core.unitofwork.ProcessingContext; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +import java.util.Collections; +import java.util.Map; +import java.util.concurrent.CompletableFuture; +import java.util.concurrent.ConcurrentHashMap; + +import static org.axonframework.common.BuilderUtils.assertNonNull; + +/** + * A multi-tenant implementation of {@link CommandBusConnector} that routes commands to tenant-specific + * {@link AxonServerCommandBusConnector} instances. + *

    + * This connector implements the wrapping pattern: rather than creating per-tenant {@code DistributedCommandBus} + * instances, it wraps the standard framework infrastructure by providing a single connector that internally + * routes to tenant-specific Axon Server connections. This ensures all framework decorators (such as + * {@code PayloadConvertingCommandBusConnector}) are applied automatically. + *

    + * The connector manages tenant-specific connectors in response to tenant lifecycle events via the + * {@link MultiTenantAwareComponent} interface. When a tenant is registered, a new + * {@link AxonServerCommandBusConnector} is created for that tenant's context. Existing command subscriptions + * are automatically replayed to the new connector. + *

    + * Usage: + * 

    {@code
+ * MultiTenantAxonServerCommandBusConnector connector = MultiTenantAxonServerCommandBusConnector.builder()
+ *     .connectionManager(connectionManager)
+ *     .axonServerConfiguration(axonServerConfig)
+ *     .targetTenantResolver(tenantResolver)
+ *     .build();
+ *
+ * // Subscribe to tenant provider to receive tenant lifecycle events
+ * tenantProvider.subscribe(connector);
+ * }
    + * + * @author Theo Emanuelsson + * @since 5.0.0 + * @see CommandBusConnector + * @see MultiTenantAwareComponent + * @see AxonServerCommandBusConnector + */ +public class MultiTenantAxonServerCommandBusConnector implements CommandBusConnector, MultiTenantAwareComponent { + + private static final Logger logger = LoggerFactory.getLogger(MultiTenantAxonServerCommandBusConnector.class); + + private final AxonServerConnectionManager connectionManager; + private final AxonServerConfiguration axonServerConfiguration; + private final TargetTenantResolver targetTenantResolver; + + private final Map connectors = new ConcurrentHashMap<>(); + private final Map subscriptions = new ConcurrentHashMap<>(); + + private volatile Handler incomingHandler; + + /** + * Instantiate a {@link MultiTenantAxonServerCommandBusConnector} based on the given {@link Builder builder}. + * + * @param builder The {@link Builder} used to instantiate a {@link MultiTenantAxonServerCommandBusConnector}. + */ + protected MultiTenantAxonServerCommandBusConnector(Builder builder) { + builder.validate(); + this.connectionManager = builder.connectionManager; + this.axonServerConfiguration = builder.axonServerConfiguration; + this.targetTenantResolver = builder.targetTenantResolver; + } + + /** + * Creates a {@link MultiTenantAxonServerCommandBusConnector} from the given {@link Configuration}. + * + * @param config The Axon {@link Configuration} to obtain components from. + * @return A new connector instance, or {@code null} if required components are not available. + */ + @Nullable + public static MultiTenantAxonServerCommandBusConnector createFrom(@Nonnull Configuration config) { + return config.getOptionalComponent(AxonServerConnectionManager.class) + .flatMap(connectionManager -> config.getOptionalComponent(TargetTenantResolver.class) + .map(resolver -> MultiTenantAxonServerCommandBusConnector.builder() + .connectionManager(connectionManager) + .axonServerConfiguration(config.getComponent(AxonServerConfiguration.class)) + .targetTenantResolver(resolver) + .build())) + .orElse(null); + } + + /** + * Instantiate a builder to construct a {@link MultiTenantAxonServerCommandBusConnector}. + * + * @return A Builder to create a {@link MultiTenantAxonServerCommandBusConnector}. + */ + public static Builder builder() { + return new Builder(); + } + + @Nonnull + @Override + public CompletableFuture dispatch(@Nonnull CommandMessage command, + @Nullable ProcessingContext processingContext) { + TenantDescriptor tenant = targetTenantResolver.resolveTenant(command, connectors.keySet()); + AxonServerCommandBusConnector connector = connectors.get(tenant); + if (connector == null) { + return CompletableFuture.failedFuture(NoSuchTenantException.forTenantId(tenant.tenantId())); + } + return connector.dispatch(command, processingContext); + } + + @Override + public CompletableFuture subscribe(@Nonnull QualifiedName commandName, int loadFactor) { + logger.debug("Subscribing to command [{}] with load factor [{}] across all tenants", commandName, loadFactor); + subscriptions.put(commandName, loadFactor); + + if (connectors.isEmpty()) { + // No tenants registered yet; subscription will be replayed when tenants join + return CompletableFuture.completedFuture(null); + } + + return CompletableFuture.allOf( + connectors.values().stream() + .map(connector -> connector.subscribe(commandName, loadFactor)) + .toArray(CompletableFuture[]::new) + ); + } + + @Override + public boolean unsubscribe(@Nonnull QualifiedName commandName) { + subscriptions.remove(commandName); + + boolean allUnsubscribed = true; + for (AxonServerCommandBusConnector connector : connectors.values()) { + if (!connector.unsubscribe(commandName)) { + allUnsubscribed = false; + } + } + return allUnsubscribed; + } + + @Override + public void onIncomingCommand(@Nonnull Handler handler) { + this.incomingHandler = handler; + connectors.values().forEach(connector -> connector.onIncomingCommand(handler)); + } + + @Override + public Registration registerTenant(TenantDescriptor tenantDescriptor) { + logger.debug("Registering tenant [{}] for command routing", tenantDescriptor.tenantId()); + + AxonServerConnection connection = connectionManager.getConnection(tenantDescriptor.tenantId()); + AxonServerCommandBusConnector connector = new AxonServerCommandBusConnector( + connection, + axonServerConfiguration + ); + connectors.put(tenantDescriptor, connector); + + // Set incoming handler if already configured + if (incomingHandler != null) { + connector.onIncomingCommand(incomingHandler); + } + + connector.start(); + + return () -> { + logger.debug("Unregistering tenant [{}] from command routing", tenantDescriptor.tenantId()); + AxonServerCommandBusConnector removed = connectors.remove(tenantDescriptor); + if (removed != null) { + removed.disconnect() + .thenCompose(v -> removed.shutdownDispatching()) + .join(); + } + return removed != null; + }; + } + + @Override + public Registration registerAndStartTenant(TenantDescriptor tenantDescriptor) { + Registration registration = registerTenant(tenantDescriptor); + + // Replay existing subscriptions to the new tenant connector + AxonServerCommandBusConnector connector = connectors.get(tenantDescriptor); + if (connector != null) { + subscriptions.forEach((commandName, loadFactor) -> { + logger.debug("Replaying subscription [{}] to tenant [{}]", + commandName, tenantDescriptor.tenantId()); + connector.subscribe(commandName, loadFactor); + }); + } + + return registration; + } + + /** + * Shuts down all tenant connectors. + * + * @return A {@link CompletableFuture} that completes when all connectors have been shut down. + */ + public CompletableFuture shutdown() { + logger.debug("Shutting down {} command bus connectors", connectors.size()); + return CompletableFuture.allOf( + connectors.values().stream() + .map(connector -> connector.disconnect() + .thenCompose(v -> connector.shutdownDispatching())) + .toArray(CompletableFuture[]::new) + ); + } + + /** + * Returns the tenant-specific connectors managed by this multi-tenant connector. + * Primarily for testing purposes. + * + * @return An unmodifiable view of the tenant-to-connector mapping. + */ + Map connectors() { + return Collections.unmodifiableMap(connectors); + } + + @Override + public void describeTo(@Nonnull ComponentDescriptor descriptor) { + descriptor.describeProperty("connectionManager", connectionManager); + descriptor.describeProperty("tenants", connectors.keySet()); + descriptor.describeProperty("subscriptions", subscriptions.keySet()); + } + + /** + * Builder class to instantiate a {@link MultiTenantAxonServerCommandBusConnector}. + *

    + * The {@link AxonServerConnectionManager}, {@link AxonServerConfiguration}, and + * {@link TargetTenantResolver} are hard requirements and must be provided. + */ + public static class Builder { + + private AxonServerConnectionManager connectionManager; + private AxonServerConfiguration axonServerConfiguration; + private TargetTenantResolver targetTenantResolver; + + /** + * Sets the {@link AxonServerConnectionManager} used to obtain tenant-specific connections. + * + * @param connectionManager The connection manager providing Axon Server connections per tenant context. + * @return The current builder instance, for fluent interfacing. + */ + public Builder connectionManager(@Nonnull AxonServerConnectionManager connectionManager) { + assertNonNull(connectionManager, "AxonServerConnectionManager may not be null"); + this.connectionManager = connectionManager; + return this; + } + + /** + * Sets the {@link AxonServerConfiguration} for Axon Server settings. + * + * @param axonServerConfiguration The Axon Server configuration. + * @return The current builder instance, for fluent interfacing. + */ + public Builder axonServerConfiguration(@Nonnull AxonServerConfiguration axonServerConfiguration) { + assertNonNull(axonServerConfiguration, "AxonServerConfiguration may not be null"); + this.axonServerConfiguration = axonServerConfiguration; + return this; + } + + /** + * Sets the {@link TargetTenantResolver} used to resolve which tenant a command belongs to. + * + * @param targetTenantResolver The resolver that determines the target tenant for each command. + * @return The current builder instance, for fluent interfacing. + */ + @SuppressWarnings("unchecked") + public Builder targetTenantResolver(@Nonnull TargetTenantResolver targetTenantResolver) { + assertNonNull(targetTenantResolver, "TargetTenantResolver may not be null"); + this.targetTenantResolver = (TargetTenantResolver) targetTenantResolver; + return this; + } + + /** + * Initializes a {@link MultiTenantAxonServerCommandBusConnector} as specified through this Builder. + * + * @return A {@link MultiTenantAxonServerCommandBusConnector} as specified through this Builder. + */ + public MultiTenantAxonServerCommandBusConnector build() { + return new MultiTenantAxonServerCommandBusConnector(this); + } + + /** + * Validate whether the fields contained in this Builder are set accordingly. + * + * @throws AxonConfigurationException If one field is asserted to be incorrect according to the Builder's + * specifications. + */ + protected void validate() { + assertNonNull(connectionManager, + "The AxonServerConnectionManager is a hard requirement and should be provided"); + assertNonNull(axonServerConfiguration, + "The AxonServerConfiguration is a hard requirement and should be provided"); + assertNonNull(targetTenantResolver, + "The TargetTenantResolver is a hard requirement and should be provided"); + } + } +} diff --git a/multitenancy-axon-server-connector/src/main/java/org/axonframework/extension/multitenancy/axonserver/MultiTenantAxonServerQueryBusConnector.java b/multitenancy-axon-server-connector/src/main/java/org/axonframework/extension/multitenancy/axonserver/MultiTenantAxonServerQueryBusConnector.java new file mode 100644 index 0000000..bc86c1a --- /dev/null +++ b/multitenancy-axon-server-connector/src/main/java/org/axonframework/extension/multitenancy/axonserver/MultiTenantAxonServerQueryBusConnector.java @@ -0,0 +1,347 @@ +/* + * Copyright (c) 2010-2025. Axon Framework + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.axonframework.extension.multitenancy.axonserver; + +import io.axoniq.axonserver.connector.AxonServerConnection; +import jakarta.annotation.Nonnull; +import jakarta.annotation.Nullable; +import org.axonframework.axonserver.connector.AxonServerConfiguration; +import org.axonframework.axonserver.connector.AxonServerConnectionManager; +import org.axonframework.axonserver.connector.query.AxonServerQueryBusConnector; +import org.axonframework.common.AxonConfigurationException; +import org.axonframework.common.Registration; +import org.axonframework.common.configuration.Configuration; +import org.axonframework.common.infra.ComponentDescriptor; +import org.axonframework.extension.multitenancy.core.MultiTenantAwareComponent; +import org.axonframework.extension.multitenancy.core.NoSuchTenantException; +import org.axonframework.extension.multitenancy.core.TargetTenantResolver; +import org.axonframework.extension.multitenancy.core.TenantDescriptor; +import org.axonframework.messaging.core.Message; +import org.axonframework.messaging.core.MessageStream; +import org.axonframework.messaging.core.QualifiedName; +import org.axonframework.messaging.core.unitofwork.ProcessingContext; +import org.axonframework.messaging.queryhandling.QueryMessage; +import org.axonframework.messaging.queryhandling.QueryResponseMessage; +import org.axonframework.messaging.queryhandling.distributed.QueryBusConnector; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +import java.util.Collections; +import java.util.Map; +import java.util.Set; +import java.util.concurrent.CompletableFuture; +import java.util.concurrent.ConcurrentHashMap; + +import static org.axonframework.common.BuilderUtils.assertNonNull; + +/** + * A multi-tenant implementation of {@link QueryBusConnector} that routes queries to tenant-specific + * {@link AxonServerQueryBusConnector} instances. + *

    + * This connector implements the wrapping pattern: rather than creating per-tenant {@code DistributedQueryBus} + * instances, it wraps the standard framework infrastructure by providing a single connector that internally + * routes to tenant-specific Axon Server connections. This ensures all framework decorators (such as + * {@code PayloadConvertingQueryBusConnector}) are applied automatically. + *

    + * The connector manages tenant-specific connectors in response to tenant lifecycle events via the + * {@link MultiTenantAwareComponent} interface. When a tenant is registered, a new + * {@link AxonServerQueryBusConnector} is created for that tenant's context. Existing query subscriptions + * are automatically replayed to the new connector. + *

    + * Usage: + * 

    {@code
+ * MultiTenantAxonServerQueryBusConnector connector = MultiTenantAxonServerQueryBusConnector.builder()
+ *     .connectionManager(connectionManager)
+ *     .axonServerConfiguration(axonServerConfig)
+ *     .targetTenantResolver(tenantResolver)
+ *     .build();
+ *
+ * // Subscribe to tenant provider to receive tenant lifecycle events
+ * tenantProvider.subscribe(connector);
+ * }
    + * + * @author Theo Emanuelsson + * @since 5.0.0 + * @see QueryBusConnector + * @see MultiTenantAwareComponent + * @see AxonServerQueryBusConnector + */ +public class MultiTenantAxonServerQueryBusConnector implements QueryBusConnector, MultiTenantAwareComponent { + + private static final Logger logger = LoggerFactory.getLogger(MultiTenantAxonServerQueryBusConnector.class); + + private final AxonServerConnectionManager connectionManager; + private final AxonServerConfiguration axonServerConfiguration; + private final TargetTenantResolver targetTenantResolver; + + private final Map connectors = new ConcurrentHashMap<>(); + private final Set subscriptions = ConcurrentHashMap.newKeySet(); + + private volatile Handler incomingHandler; + + /** + * Instantiate a {@link MultiTenantAxonServerQueryBusConnector} based on the given {@link Builder builder}. + * + * @param builder The {@link Builder} used to instantiate a {@link MultiTenantAxonServerQueryBusConnector}. + */ + protected MultiTenantAxonServerQueryBusConnector(Builder builder) { + builder.validate(); + this.connectionManager = builder.connectionManager; + this.axonServerConfiguration = builder.axonServerConfiguration; + this.targetTenantResolver = builder.targetTenantResolver; + } + + /** + * Creates a {@link MultiTenantAxonServerQueryBusConnector} from the given {@link Configuration}. + * + * @param config The Axon {@link Configuration} to obtain components from. + * @return A new connector instance, or {@code null} if required components are not available. + */ + @Nullable + public static MultiTenantAxonServerQueryBusConnector createFrom(@Nonnull Configuration config) { + return config.getOptionalComponent(AxonServerConnectionManager.class) + .flatMap(connectionManager -> config.getOptionalComponent(TargetTenantResolver.class) + .map(resolver -> MultiTenantAxonServerQueryBusConnector.builder() + .connectionManager(connectionManager) + .axonServerConfiguration(config.getComponent(AxonServerConfiguration.class)) + .targetTenantResolver(resolver) + .build())) + .orElse(null); + } + + /** + * Instantiate a builder to construct a {@link MultiTenantAxonServerQueryBusConnector}. + * + * @return A Builder to create a {@link MultiTenantAxonServerQueryBusConnector}. + */ + public static Builder builder() { + return new Builder(); + } + + @Nonnull + @Override + public MessageStream query(@Nonnull QueryMessage query, + @Nullable ProcessingContext context) { + TenantDescriptor tenant = targetTenantResolver.resolveTenant(query, connectors.keySet()); + AxonServerQueryBusConnector connector = connectors.get(tenant); + if (connector == null) { + return MessageStream.failed(NoSuchTenantException.forTenantId(tenant.tenantId())); + } + return connector.query(query, context); + } + + @Nonnull + @Override + public MessageStream subscriptionQuery(@Nonnull QueryMessage query, + @Nullable ProcessingContext context, + int updateBufferSize) { + TenantDescriptor tenant = targetTenantResolver.resolveTenant(query, connectors.keySet()); + AxonServerQueryBusConnector connector = connectors.get(tenant); + if (connector == null) { + return MessageStream.failed(NoSuchTenantException.forTenantId(tenant.tenantId())); + } + return connector.subscriptionQuery(query, context, updateBufferSize); + } + + @Override + public CompletableFuture subscribe(@Nonnull QualifiedName name) { + logger.debug("Subscribing to query [{}] across all tenants", name); + subscriptions.add(name); + + if (connectors.isEmpty()) { + // No tenants registered yet; subscription will be replayed when tenants join + return CompletableFuture.completedFuture(null); + } + + return CompletableFuture.allOf( + connectors.values().stream() + .map(connector -> connector.subscribe(name)) + .toArray(CompletableFuture[]::new) + ); + } + + @Override + public boolean unsubscribe(@Nonnull QualifiedName name) { + subscriptions.remove(name); + + boolean allUnsubscribed = true; + for (AxonServerQueryBusConnector connector : connectors.values()) { + if (!connector.unsubscribe(name)) { + allUnsubscribed = false; + } + } + return allUnsubscribed; + } + + @Override + public void onIncomingQuery(@Nonnull Handler handler) { + this.incomingHandler = handler; + connectors.values().forEach(connector -> connector.onIncomingQuery(handler)); + } + + @Override + public Registration registerTenant(TenantDescriptor tenantDescriptor) { + logger.debug("Registering tenant [{}] for query routing", tenantDescriptor.tenantId()); + + AxonServerConnection connection = connectionManager.getConnection(tenantDescriptor.tenantId()); + AxonServerQueryBusConnector connector = new AxonServerQueryBusConnector( + connection, + axonServerConfiguration + ); + connectors.put(tenantDescriptor, connector); + + // Set incoming handler if already configured + if (incomingHandler != null) { + connector.onIncomingQuery(incomingHandler); + } + + connector.start(); + + return () -> { + logger.debug("Unregistering tenant [{}] from query routing", tenantDescriptor.tenantId()); + AxonServerQueryBusConnector removed = connectors.remove(tenantDescriptor); + if (removed != null) { + removed.disconnect() + .thenCompose(v -> removed.shutdownDispatching()) + .join(); + } + return removed != null; + }; + } + + @Override + public Registration registerAndStartTenant(TenantDescriptor tenantDescriptor) { + Registration registration = registerTenant(tenantDescriptor); + + // Replay existing subscriptions to the new tenant connector + AxonServerQueryBusConnector connector = connectors.get(tenantDescriptor); + if (connector != null) { + subscriptions.forEach(queryName -> { + logger.debug("Replaying subscription [{}] to tenant [{}]", + queryName, tenantDescriptor.tenantId()); + connector.subscribe(queryName); + }); + } + + return registration; + } + + /** + * Shuts down all tenant connectors. + * + * @return A {@link CompletableFuture} that completes when all connectors have been shut down. + */ + public CompletableFuture shutdown() { + logger.debug("Shutting down {} query bus connectors", connectors.size()); + return CompletableFuture.allOf( + connectors.values().stream() + .map(connector -> connector.disconnect() + .thenCompose(v -> connector.shutdownDispatching())) + .toArray(CompletableFuture[]::new) + ); + } + + /** + * Returns the tenant-specific connectors managed by this multi-tenant connector. + * Primarily for testing purposes. + * + * @return An unmodifiable view of the tenant-to-connector mapping. + */ + Map connectors() { + return Collections.unmodifiableMap(connectors); + } + + @Override + public void describeTo(@Nonnull ComponentDescriptor descriptor) { + descriptor.describeProperty("connectionManager", connectionManager); + descriptor.describeProperty("tenants", connectors.keySet()); + descriptor.describeProperty("subscriptions", subscriptions); + } + + /** + * Builder class to instantiate a {@link MultiTenantAxonServerQueryBusConnector}. + *

    + * The {@link AxonServerConnectionManager}, {@link AxonServerConfiguration}, and + * {@link TargetTenantResolver} are hard requirements and must be provided. + */ + public static class Builder { + + private AxonServerConnectionManager connectionManager; + private AxonServerConfiguration axonServerConfiguration; + private TargetTenantResolver targetTenantResolver; + + /** + * Sets the {@link AxonServerConnectionManager} used to obtain tenant-specific connections. + * + * @param connectionManager The connection manager providing Axon Server connections per tenant context. + * @return The current builder instance, for fluent interfacing. + */ + public Builder connectionManager(@Nonnull AxonServerConnectionManager connectionManager) { + assertNonNull(connectionManager, "AxonServerConnectionManager may not be null"); + this.connectionManager = connectionManager; + return this; + } + + /** + * Sets the {@link AxonServerConfiguration} for Axon Server settings. + * + * @param axonServerConfiguration The Axon Server configuration. + * @return The current builder instance, for fluent interfacing. + */ + public Builder axonServerConfiguration(@Nonnull AxonServerConfiguration axonServerConfiguration) { + assertNonNull(axonServerConfiguration, "AxonServerConfiguration may not be null"); + this.axonServerConfiguration = axonServerConfiguration; + return this; + } + + /** + * Sets the {@link TargetTenantResolver} used to resolve which tenant a query belongs to. + * + * @param targetTenantResolver The resolver that determines the target tenant for each query. + * @return The current builder instance, for fluent interfacing. + */ + @SuppressWarnings("unchecked") + public Builder targetTenantResolver(@Nonnull TargetTenantResolver targetTenantResolver) { + assertNonNull(targetTenantResolver, "TargetTenantResolver may not be null"); + this.targetTenantResolver = (TargetTenantResolver) targetTenantResolver; + return this; + } + + /** + * Initializes a {@link MultiTenantAxonServerQueryBusConnector} as specified through this Builder. + * + * @return A {@link MultiTenantAxonServerQueryBusConnector} as specified through this Builder. + */ + public MultiTenantAxonServerQueryBusConnector build() { + return new MultiTenantAxonServerQueryBusConnector(this); + } + + /** + * Validate whether the fields contained in this Builder are set accordingly. + * + * @throws AxonConfigurationException If one field is asserted to be incorrect according to the Builder's + * specifications. + */ + protected void validate() { + assertNonNull(connectionManager, + "The AxonServerConnectionManager is a hard requirement and should be provided"); + assertNonNull(axonServerConfiguration, + "The AxonServerConfiguration is a hard requirement and should be provided"); + assertNonNull(targetTenantResolver, + "The TargetTenantResolver is a hard requirement and should be provided"); + } + } +} diff --git a/multitenancy-axon-server-connector/src/main/resources/META-INF/services/org.axonframework.common.configuration.ConfigurationEnhancer b/multitenancy-axon-server-connector/src/main/resources/META-INF/services/org.axonframework.common.configuration.ConfigurationEnhancer new file mode 100644 index 0000000..1007688 --- /dev/null +++ b/multitenancy-axon-server-connector/src/main/resources/META-INF/services/org.axonframework.common.configuration.ConfigurationEnhancer @@ -0,0 +1 @@ +org.axonframework.extension.multitenancy.axonserver.DistributedMultiTenancyConfigurationDefaults diff --git a/multitenancy-axon-server-connector/src/test/java/org/axonframework/extension/multitenancy/axonserver/AxonServerTenantEventSegmentFactoryTest.java b/multitenancy-axon-server-connector/src/test/java/org/axonframework/extension/multitenancy/axonserver/AxonServerTenantEventSegmentFactoryTest.java new file mode 100644 index 0000000..0a7e415 --- /dev/null +++ b/multitenancy-axon-server-connector/src/test/java/org/axonframework/extension/multitenancy/axonserver/AxonServerTenantEventSegmentFactoryTest.java @@ -0,0 +1,92 @@ +/* + * Copyright (c) 2010-2025. Axon Framework + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.axonframework.extension.multitenancy.axonserver; + +import org.axonframework.axonserver.connector.AxonServerConnectionManager; +import org.axonframework.common.configuration.Configuration; +import org.axonframework.eventsourcing.eventstore.AnnotationBasedTagResolver; +import org.axonframework.eventsourcing.eventstore.TagResolver; +import org.junit.jupiter.api.*; + +import java.util.function.Supplier; + +import static org.junit.jupiter.api.Assertions.*; +import static org.mockito.Mockito.*; + +/** + * Test class validating the {@link AxonServerTenantEventSegmentFactory}. + * + * @author Stefan Dragisic + */ +class AxonServerTenantEventSegmentFactoryTest { + + private Configuration configuration; + private TagResolver tagResolver; + + @BeforeEach + void setUp() { + configuration = mock(Configuration.class); + tagResolver = new AnnotationBasedTagResolver(); + } + + @Test + void createFromReturnsFactoryWhenConnectionManagerAvailable() { + when(configuration.hasComponent(AxonServerConnectionManager.class)).thenReturn(true); + when(configuration.getComponent(eq(TagResolver.class), (Supplier) any())).thenReturn(tagResolver); + + AxonServerTenantEventSegmentFactory result = AxonServerTenantEventSegmentFactory.createFrom(configuration); + + assertNotNull(result); + } + + @Test + void createFromReturnsNullWhenConnectionManagerNotAvailable() { + when(configuration.hasComponent(AxonServerConnectionManager.class)).thenReturn(false); + + AxonServerTenantEventSegmentFactory result = AxonServerTenantEventSegmentFactory.createFrom(configuration); + + assertNull(result); + } + + @SuppressWarnings("unchecked") + @Test + void createFromUsesDefaultTagResolverWhenNotConfigured() { + when(configuration.hasComponent(AxonServerConnectionManager.class)).thenReturn(true); + when(configuration.getComponent(eq(TagResolver.class), (Supplier) any())) + .thenAnswer(invocation -> { + // Return the default from the supplier + return invocation.getArgument(1, Supplier.class).get(); + }); + + AxonServerTenantEventSegmentFactory result = AxonServerTenantEventSegmentFactory.createFrom(configuration); + + assertNotNull(result); + } + + @Test + void constructorRejectsNullConfiguration() { + assertThrows(NullPointerException.class, () -> + new AxonServerTenantEventSegmentFactory(null, tagResolver) + ); + } + + @Test + void constructorRejectsNullTagResolver() { + assertThrows(NullPointerException.class, () -> + new AxonServerTenantEventSegmentFactory(configuration, null) + ); + } +} diff --git a/multitenancy-axon-server-connector/src/test/java/org/axonframework/extension/multitenancy/axonserver/MultiTenantAxonServerCommandBusConnectorTest.java b/multitenancy-axon-server-connector/src/test/java/org/axonframework/extension/multitenancy/axonserver/MultiTenantAxonServerCommandBusConnectorTest.java new file mode 100644 index 0000000..a2365d5 --- /dev/null +++ b/multitenancy-axon-server-connector/src/test/java/org/axonframework/extension/multitenancy/axonserver/MultiTenantAxonServerCommandBusConnectorTest.java @@ -0,0 +1,283 @@ +/* + * Copyright (c) 2010-2025. Axon Framework + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.axonframework.extension.multitenancy.axonserver; + +import io.axoniq.axonserver.connector.AxonServerConnection; +import io.axoniq.axonserver.connector.Registration; +import io.axoniq.axonserver.connector.command.CommandChannel; +import org.axonframework.axonserver.connector.AxonServerConfiguration; +import org.axonframework.axonserver.connector.AxonServerConnectionManager; +import org.axonframework.common.AxonConfigurationException; +import org.axonframework.common.configuration.Configuration; +import org.axonframework.extension.multitenancy.core.NoSuchTenantException; +import org.axonframework.extension.multitenancy.core.TargetTenantResolver; +import org.axonframework.extension.multitenancy.core.TenantDescriptor; +import org.axonframework.messaging.commandhandling.CommandMessage; +import org.axonframework.messaging.commandhandling.distributed.CommandBusConnector; +import org.axonframework.messaging.core.Message; +import org.axonframework.messaging.core.QualifiedName; +import org.junit.jupiter.api.*; + +import java.util.Collection; +import java.util.Optional; +import java.util.concurrent.CompletableFuture; +import java.util.concurrent.ExecutionException; + +import static org.junit.jupiter.api.Assertions.*; +import static org.mockito.ArgumentMatchers.*; +import static org.mockito.Mockito.*; + +/** + * Test class validating the {@link MultiTenantAxonServerCommandBusConnector}. + * + * @author Stefan Dragisic + * @author Theo Emanuelsson + */ +class MultiTenantAxonServerCommandBusConnectorTest { + + private AxonServerConnectionManager connectionManager; + private AxonServerConfiguration axonServerConfiguration; + private TargetTenantResolver targetTenantResolver; + + private static final TenantDescriptor TENANT_1 = TenantDescriptor.tenantWithId("tenant1"); + private static final TenantDescriptor TENANT_2 = TenantDescriptor.tenantWithId("tenant2"); + + @BeforeEach + void setUp() { + connectionManager = mock(AxonServerConnectionManager.class); + axonServerConfiguration = mock(AxonServerConfiguration.class); + targetTenantResolver = mock(TargetTenantResolver.class); + + when(axonServerConfiguration.getClientId()).thenReturn("test-client"); + when(axonServerConfiguration.getComponentName()).thenReturn("test-component"); + } + + @Test + void buildWithAllRequiredComponentsSucceeds() { + MultiTenantAxonServerCommandBusConnector connector = MultiTenantAxonServerCommandBusConnector.builder() + .connectionManager(connectionManager) + .axonServerConfiguration(axonServerConfiguration) + .targetTenantResolver(targetTenantResolver) + .build(); + + assertNotNull(connector); + } + + @Test + void buildWithoutConnectionManagerFails() { + assertThrows(AxonConfigurationException.class, () -> + MultiTenantAxonServerCommandBusConnector.builder() + .axonServerConfiguration(axonServerConfiguration) + .targetTenantResolver(targetTenantResolver) + .build() + ); + } + + @Test + void buildWithoutAxonServerConfigurationFails() { + assertThrows(AxonConfigurationException.class, () -> + MultiTenantAxonServerCommandBusConnector.builder() + .connectionManager(connectionManager) + .targetTenantResolver(targetTenantResolver) + .build() + ); + } + + @Test + void buildWithoutTargetTenantResolverFails() { + assertThrows(AxonConfigurationException.class, () -> + MultiTenantAxonServerCommandBusConnector.builder() + .connectionManager(connectionManager) + .axonServerConfiguration(axonServerConfiguration) + .build() + ); + } + + @Test + @SuppressWarnings("unchecked") + void createFromReturnsConnectorWhenAllComponentsAvailable() { + Configuration config = mock(Configuration.class); + when(config.getOptionalComponent(AxonServerConnectionManager.class)) + .thenReturn(Optional.of(connectionManager)); + when(config.getOptionalComponent(TargetTenantResolver.class)) + .thenReturn(Optional.of(targetTenantResolver)); + when(config.getComponent(AxonServerConfiguration.class)) + .thenReturn(axonServerConfiguration); + + MultiTenantAxonServerCommandBusConnector result = + MultiTenantAxonServerCommandBusConnector.createFrom(config); + + assertNotNull(result); + } + + @Test + void createFromReturnsNullWhenConnectionManagerNotAvailable() { + Configuration config = mock(Configuration.class); + when(config.getOptionalComponent(AxonServerConnectionManager.class)) + .thenReturn(Optional.empty()); + + MultiTenantAxonServerCommandBusConnector result = + MultiTenantAxonServerCommandBusConnector.createFrom(config); + + assertNull(result); + } + + @Test + @SuppressWarnings("unchecked") + void createFromReturnsNullWhenTargetTenantResolverNotAvailable() { + Configuration config = mock(Configuration.class); + when(config.getOptionalComponent(AxonServerConnectionManager.class)) + .thenReturn(Optional.of(connectionManager)); + when(config.getOptionalComponent(TargetTenantResolver.class)) + .thenReturn(Optional.empty()); + + MultiTenantAxonServerCommandBusConnector result = + MultiTenantAxonServerCommandBusConnector.createFrom(config); + + assertNull(result); + } + + @Test + void registerTenantAddsConnectorForTenant() { + AxonServerConnection tenantConnection = mockTenantConnection(); + when(connectionManager.getConnection("tenant1")).thenReturn(tenantConnection); + + MultiTenantAxonServerCommandBusConnector connector = createConnector(); + + assertTrue(connector.connectors().isEmpty()); + + var registration = connector.registerTenant(TENANT_1); + + assertEquals(1, connector.connectors().size()); + assertTrue(connector.connectors().containsKey(TENANT_1)); + assertNotNull(registration); + } + + @Test + void unregisterTenantRemovesConnector() { + AxonServerConnection tenantConnection = mockTenantConnection(); + when(connectionManager.getConnection("tenant1")).thenReturn(tenantConnection); + + MultiTenantAxonServerCommandBusConnector connector = createConnector(); + var registration = connector.registerTenant(TENANT_1); + + assertEquals(1, connector.connectors().size()); + + registration.cancel(); + + assertTrue(connector.connectors().isEmpty()); + } + + @Test + void dispatchToUnknownTenantFails() { + MultiTenantAxonServerCommandBusConnector connector = createConnector(); + + CommandMessage command = mock(CommandMessage.class); + when(targetTenantResolver.resolveTenant(eq(command), any(Collection.class))).thenReturn(TENANT_1); + + CompletableFuture result = connector.dispatch(command, null); + + assertTrue(result.isCompletedExceptionally()); + assertThrows(ExecutionException.class, () -> result.get()); + try { + result.get(); + } catch (ExecutionException e) { + assertTrue(e.getCause() instanceof NoSuchTenantException); + } catch (InterruptedException e) { + fail("Unexpected interruption"); + } + } + + @Test + void subscribeWithNoTenantsCompletesSuccessfully() { + MultiTenantAxonServerCommandBusConnector connector = createConnector(); + + QualifiedName commandName = new QualifiedName("TestCommand"); + CompletableFuture result = connector.subscribe(commandName, 100); + + assertDoesNotThrow(() -> result.get()); + } + + @Test + void registerAndStartTenantReplaysSubscriptions() { + AxonServerConnection tenantConnection = mockTenantConnection(); + when(connectionManager.getConnection("tenant1")).thenReturn(tenantConnection); + + MultiTenantAxonServerCommandBusConnector connector = createConnector(); + + // Subscribe before any tenants + QualifiedName commandName = new QualifiedName("TestCommand"); + connector.subscribe(commandName, 100); + + // Register tenant - should replay subscription + connector.registerAndStartTenant(TENANT_1); + + // Verify tenant connector was created + assertEquals(1, connector.connectors().size()); + } + + @Test + void onIncomingCommandSetsHandlerOnAllConnectors() { + AxonServerConnection tenant1Connection = mockTenantConnection(); + AxonServerConnection tenant2Connection = mockTenantConnection(); + when(connectionManager.getConnection("tenant1")).thenReturn(tenant1Connection); + when(connectionManager.getConnection("tenant2")).thenReturn(tenant2Connection); + + MultiTenantAxonServerCommandBusConnector connector = createConnector(); + connector.registerTenant(TENANT_1); + connector.registerTenant(TENANT_2); + + CommandBusConnector.Handler handler = mock(CommandBusConnector.Handler.class); + connector.onIncomingCommand(handler); + + // Handler should be set on all tenant connectors + assertEquals(2, connector.connectors().size()); + } + + @Test + void shutdownCompletesSuccessfully() { + AxonServerConnection tenantConnection = mockTenantConnection(); + when(connectionManager.getConnection("tenant1")).thenReturn(tenantConnection); + + MultiTenantAxonServerCommandBusConnector connector = createConnector(); + connector.registerTenant(TENANT_1); + + CompletableFuture result = connector.shutdown(); + + assertDoesNotThrow(() -> result.get()); + } + + private MultiTenantAxonServerCommandBusConnector createConnector() { + return MultiTenantAxonServerCommandBusConnector.builder() + .connectionManager(connectionManager) + .axonServerConfiguration(axonServerConfiguration) + .targetTenantResolver(targetTenantResolver) + .build(); + } + + private AxonServerConnection mockTenantConnection() { + AxonServerConnection connection = mock(AxonServerConnection.class); + CommandChannel commandChannel = mock(CommandChannel.class); + + when(connection.commandChannel()).thenReturn(commandChannel); + when(connection.isConnected()).thenReturn(false); + when(commandChannel.prepareDisconnect()).thenReturn(CompletableFuture.completedFuture(null)); + when(commandChannel.registerCommandHandler(any(), anyInt(), any())) + .thenReturn(mock(Registration.class)); + + return connection; + } +} diff --git a/multitenancy-axon-server-connector/src/test/java/org/axonframework/extension/multitenancy/axonserver/MultiTenantAxonServerQueryBusConnectorTest.java b/multitenancy-axon-server-connector/src/test/java/org/axonframework/extension/multitenancy/axonserver/MultiTenantAxonServerQueryBusConnectorTest.java new file mode 100644 index 0000000..96fb9e6 --- /dev/null +++ b/multitenancy-axon-server-connector/src/test/java/org/axonframework/extension/multitenancy/axonserver/MultiTenantAxonServerQueryBusConnectorTest.java @@ -0,0 +1,288 @@ +/* + * Copyright (c) 2010-2025. Axon Framework + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.axonframework.extension.multitenancy.axonserver; + +import io.axoniq.axonserver.connector.AxonServerConnection; +import io.axoniq.axonserver.connector.Registration; +import io.axoniq.axonserver.connector.query.QueryChannel; +import org.axonframework.axonserver.connector.AxonServerConfiguration; +import org.axonframework.axonserver.connector.AxonServerConnectionManager; +import org.axonframework.common.AxonConfigurationException; +import org.axonframework.common.configuration.Configuration; +import org.axonframework.extension.multitenancy.core.TargetTenantResolver; +import org.axonframework.extension.multitenancy.core.TenantDescriptor; +import org.axonframework.messaging.core.Message; +import org.axonframework.messaging.core.MessageStream; +import org.axonframework.messaging.core.QualifiedName; +import org.axonframework.messaging.queryhandling.QueryMessage; +import org.axonframework.messaging.queryhandling.QueryResponseMessage; +import org.axonframework.messaging.queryhandling.distributed.QueryBusConnector; +import org.junit.jupiter.api.*; + +import java.util.Collection; +import java.util.Optional; +import java.util.concurrent.CompletableFuture; + +import static org.junit.jupiter.api.Assertions.*; +import static org.mockito.ArgumentMatchers.*; +import static org.mockito.Mockito.*; + +/** + * Test class validating the {@link MultiTenantAxonServerQueryBusConnector}. + * + * @author Stefan Dragisic + * @author Theo Emanuelsson + */ +class MultiTenantAxonServerQueryBusConnectorTest { + + private AxonServerConnectionManager connectionManager; + private AxonServerConfiguration axonServerConfiguration; + private TargetTenantResolver targetTenantResolver; + + private static final TenantDescriptor TENANT_1 = TenantDescriptor.tenantWithId("tenant1"); + private static final TenantDescriptor TENANT_2 = TenantDescriptor.tenantWithId("tenant2"); + + @BeforeEach + void setUp() { + connectionManager = mock(AxonServerConnectionManager.class); + axonServerConfiguration = mock(AxonServerConfiguration.class); + targetTenantResolver = mock(TargetTenantResolver.class); + + when(axonServerConfiguration.getClientId()).thenReturn("test-client"); + when(axonServerConfiguration.getComponentName()).thenReturn("test-component"); + } + + @Test + void buildWithAllRequiredComponentsSucceeds() { + MultiTenantAxonServerQueryBusConnector connector = MultiTenantAxonServerQueryBusConnector.builder() + .connectionManager(connectionManager) + .axonServerConfiguration(axonServerConfiguration) + .targetTenantResolver(targetTenantResolver) + .build(); + + assertNotNull(connector); + } + + @Test + void buildWithoutConnectionManagerFails() { + assertThrows(AxonConfigurationException.class, () -> + MultiTenantAxonServerQueryBusConnector.builder() + .axonServerConfiguration(axonServerConfiguration) + .targetTenantResolver(targetTenantResolver) + .build() + ); + } + + @Test + void buildWithoutAxonServerConfigurationFails() { + assertThrows(AxonConfigurationException.class, () -> + MultiTenantAxonServerQueryBusConnector.builder() + .connectionManager(connectionManager) + .targetTenantResolver(targetTenantResolver) + .build() + ); + } + + @Test + void buildWithoutTargetTenantResolverFails() { + assertThrows(AxonConfigurationException.class, () -> + MultiTenantAxonServerQueryBusConnector.builder() + .connectionManager(connectionManager) + .axonServerConfiguration(axonServerConfiguration) + .build() + ); + } + + @Test + @SuppressWarnings("unchecked") + void createFromReturnsConnectorWhenAllComponentsAvailable() { + Configuration config = mock(Configuration.class); + when(config.getOptionalComponent(AxonServerConnectionManager.class)) + .thenReturn(Optional.of(connectionManager)); + when(config.getOptionalComponent(TargetTenantResolver.class)) + .thenReturn(Optional.of(targetTenantResolver)); + when(config.getComponent(AxonServerConfiguration.class)) + .thenReturn(axonServerConfiguration); + + MultiTenantAxonServerQueryBusConnector result = + MultiTenantAxonServerQueryBusConnector.createFrom(config); + + assertNotNull(result); + } + + @Test + void createFromReturnsNullWhenConnectionManagerNotAvailable() { + Configuration config = mock(Configuration.class); + when(config.getOptionalComponent(AxonServerConnectionManager.class)) + .thenReturn(Optional.empty()); + + MultiTenantAxonServerQueryBusConnector result = + MultiTenantAxonServerQueryBusConnector.createFrom(config); + + assertNull(result); + } + + @Test + @SuppressWarnings("unchecked") + void createFromReturnsNullWhenTargetTenantResolverNotAvailable() { + Configuration config = mock(Configuration.class); + when(config.getOptionalComponent(AxonServerConnectionManager.class)) + .thenReturn(Optional.of(connectionManager)); + when(config.getOptionalComponent(TargetTenantResolver.class)) + .thenReturn(Optional.empty()); + + MultiTenantAxonServerQueryBusConnector result = + MultiTenantAxonServerQueryBusConnector.createFrom(config); + + assertNull(result); + } + + @Test + void registerTenantAddsConnectorForTenant() { + AxonServerConnection tenantConnection = mockTenantConnection(); + when(connectionManager.getConnection("tenant1")).thenReturn(tenantConnection); + + MultiTenantAxonServerQueryBusConnector connector = createConnector(); + + assertTrue(connector.connectors().isEmpty()); + + var registration = connector.registerTenant(TENANT_1); + + assertEquals(1, connector.connectors().size()); + assertTrue(connector.connectors().containsKey(TENANT_1)); + assertNotNull(registration); + } + + @Test + void unregisterTenantRemovesConnector() { + AxonServerConnection tenantConnection = mockTenantConnection(); + when(connectionManager.getConnection("tenant1")).thenReturn(tenantConnection); + + MultiTenantAxonServerQueryBusConnector connector = createConnector(); + var registration = connector.registerTenant(TENANT_1); + + assertEquals(1, connector.connectors().size()); + + registration.cancel(); + + assertTrue(connector.connectors().isEmpty()); + } + + @Test + void queryToUnknownTenantReturnsFailedStream() { + MultiTenantAxonServerQueryBusConnector connector = createConnector(); + + QueryMessage query = mock(QueryMessage.class); + when(targetTenantResolver.resolveTenant(eq(query), any(Collection.class))).thenReturn(TENANT_1); + + MessageStream result = connector.query(query, null); + + assertNotNull(result); + // The stream should contain an error when consumed + } + + @Test + void subscriptionQueryToUnknownTenantReturnsFailedStream() { + MultiTenantAxonServerQueryBusConnector connector = createConnector(); + + QueryMessage query = mock(QueryMessage.class); + when(targetTenantResolver.resolveTenant(eq(query), any(Collection.class))).thenReturn(TENANT_1); + + MessageStream result = connector.subscriptionQuery(query, null, 100); + + assertNotNull(result); + // The stream should contain an error when consumed + } + + @Test + void subscribeWithNoTenantsCompletesSuccessfully() { + MultiTenantAxonServerQueryBusConnector connector = createConnector(); + + QualifiedName queryName = new QualifiedName("TestQuery"); + CompletableFuture result = connector.subscribe(queryName); + + assertDoesNotThrow(() -> result.get()); + } + + @Test + void registerAndStartTenantReplaysSubscriptions() { + AxonServerConnection tenantConnection = mockTenantConnection(); + when(connectionManager.getConnection("tenant1")).thenReturn(tenantConnection); + + MultiTenantAxonServerQueryBusConnector connector = createConnector(); + + // Subscribe before any tenants + QualifiedName queryName = new QualifiedName("TestQuery"); + connector.subscribe(queryName); + + // Register tenant - should replay subscription + connector.registerAndStartTenant(TENANT_1); + + // Verify tenant connector was created + assertEquals(1, connector.connectors().size()); + } + + @Test + void onIncomingQuerySetsHandlerOnAllConnectors() { + AxonServerConnection tenant1Connection = mockTenantConnection(); + AxonServerConnection tenant2Connection = mockTenantConnection(); + when(connectionManager.getConnection("tenant1")).thenReturn(tenant1Connection); + when(connectionManager.getConnection("tenant2")).thenReturn(tenant2Connection); + + MultiTenantAxonServerQueryBusConnector connector = createConnector(); + connector.registerTenant(TENANT_1); + connector.registerTenant(TENANT_2); + + QueryBusConnector.Handler handler = mock(QueryBusConnector.Handler.class); + connector.onIncomingQuery(handler); + + // Handler should be set on all tenant connectors + assertEquals(2, connector.connectors().size()); + } + + @Test + void shutdownCompletesSuccessfully() { + AxonServerConnection tenantConnection = mockTenantConnection(); + when(connectionManager.getConnection("tenant1")).thenReturn(tenantConnection); + + MultiTenantAxonServerQueryBusConnector connector = createConnector(); + connector.registerTenant(TENANT_1); + + CompletableFuture result = connector.shutdown(); + + assertDoesNotThrow(() -> result.get()); + } + + private MultiTenantAxonServerQueryBusConnector createConnector() { + return MultiTenantAxonServerQueryBusConnector.builder() + .connectionManager(connectionManager) + .axonServerConfiguration(axonServerConfiguration) + .targetTenantResolver(targetTenantResolver) + .build(); + } + + private AxonServerConnection mockTenantConnection() { + AxonServerConnection connection = mock(AxonServerConnection.class); + QueryChannel queryChannel = mock(QueryChannel.class); + + when(connection.queryChannel()).thenReturn(queryChannel); + when(connection.isConnected()).thenReturn(false); + when(queryChannel.registerQueryHandler(any(), any())) + .thenReturn(mock(Registration.class)); + + return connection; + } +} diff --git a/multitenancy-integration-tests-axon-server/pom.xml b/multitenancy-integration-tests-axon-server/pom.xml new file mode 100644 index 0000000..adceb4f --- /dev/null +++ b/multitenancy-integration-tests-axon-server/pom.xml @@ -0,0 +1,175 @@ + + + + + 4.0.0 + + + org.axonframework.extensions.multitenancy + axon-multitenancy-parent + 5.1.0-SNAPSHOT + + + axon-multitenancy-integration-tests-axon-server + Axon Framework Multi-Tenancy Extension - Axon Server Integration Tests + + Integration tests for multi-tenancy with Axon Server using Testcontainers. + Tests tenant infrastructure routing and configuration with a single context. + Note: Multi-context isolation tests require Axon Server license. + + + + 4.2.2 + 3.27.3 + 2.0.3 + + + + + + org.axonframework.extensions.multitenancy + axon-multitenancy + ${project.version} + test + + + + + org.axonframework.extensions.multitenancy + axon-multitenancy-axon-server-connector + ${project.version} + test + + + + + org.axonframework + axon-eventsourcing + test + + + org.axonframework + axon-modelling + ${axon.version} + test + + + org.axonframework + axon-messaging + test + + + + + org.axonframework + axon-server-connector + test + + + + + org.axonframework + axon-test + ${axon.version} + test + + + + + org.testcontainers + testcontainers-junit-jupiter + ${testcontainers.version} + test + + + + + org.junit.jupiter + junit-jupiter + test + + + + + org.assertj + assertj-core + ${assertj.version} + test + + + org.awaitility + awaitility + ${awaitility.version} + test + + + + + jakarta.validation + jakarta.validation-api + 3.1.0 + test + + + + + org.slf4j + slf4j-api + 2.0.17 + test + + + org.apache.logging.log4j + log4j-slf4j2-impl + 2.24.3 + test + + + org.apache.logging.log4j + log4j-core + 2.24.3 + test + + + + + + + org.apache.maven.plugins + maven-surefire-plugin + + + **/*IT.java + **/*Test.java + + -Daxon.axonserver.suppressDownloadMessage=true + + + + + org.apache.maven.plugins + maven-deploy-plugin + 3.1.3 + + true + + + + + diff --git a/multitenancy-integration-tests-axon-server/src/test/java/org/axonframework/extension/multitenancy/integrationtests/axonserver/AxonServerMultiTenantIT.java b/multitenancy-integration-tests-axon-server/src/test/java/org/axonframework/extension/multitenancy/integrationtests/axonserver/AxonServerMultiTenantIT.java new file mode 100644 index 0000000..31658a4 --- /dev/null +++ b/multitenancy-integration-tests-axon-server/src/test/java/org/axonframework/extension/multitenancy/integrationtests/axonserver/AxonServerMultiTenantIT.java @@ -0,0 +1,230 @@ +/* + * Copyright (c) 2010-2025. Axon Framework + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.axonframework.extension.multitenancy.integrationtests.axonserver; + +import org.awaitility.Awaitility; +import org.axonframework.axonserver.connector.AxonServerConfiguration; +import org.axonframework.common.configuration.AxonConfiguration; +import org.axonframework.eventsourcing.configuration.EventSourcingConfigurer; +import org.axonframework.extension.multitenancy.core.MetadataBasedTenantResolver; +import org.axonframework.extension.multitenancy.core.NoSuchTenantException; +import org.axonframework.extension.multitenancy.core.TenantConnectPredicate; +import org.axonframework.extension.multitenancy.core.TenantDescriptor; +import org.axonframework.extension.multitenancy.core.TenantProvider; +import org.axonframework.extension.multitenancy.core.configuration.MultiTenancyConfigurer; +import org.axonframework.extension.multitenancy.integrationtests.axonserver.read.coursestats.FindAllCourses; +import org.axonframework.extension.multitenancy.integrationtests.axonserver.read.coursestats.CourseStatsConfiguration; +import org.axonframework.extension.multitenancy.integrationtests.axonserver.read.coursestats.CourseStatsRepository; +import org.axonframework.extension.multitenancy.integrationtests.axonserver.read.coursestats.CoursesStats; +import org.axonframework.extension.multitenancy.integrationtests.axonserver.read.coursestats.InMemoryCourseStatsRepository; +import org.axonframework.extension.multitenancy.integrationtests.axonserver.shared.CourseId; +import org.axonframework.extension.multitenancy.integrationtests.axonserver.write.createcourse.CreateCourse; +import org.axonframework.extension.multitenancy.integrationtests.axonserver.write.createcourse.CreateCourseConfiguration; +import org.axonframework.messaging.commandhandling.gateway.CommandGateway; +import org.axonframework.messaging.core.MessageType; +import org.axonframework.messaging.core.Metadata; +import org.axonframework.messaging.queryhandling.GenericQueryMessage; +import org.axonframework.messaging.queryhandling.QueryMessage; +import org.axonframework.messaging.queryhandling.gateway.QueryGateway; +import org.axonframework.test.server.AxonServerContainer; +import org.junit.jupiter.api.AfterEach; +import org.junit.jupiter.api.BeforeAll; +import org.junit.jupiter.api.Test; +import org.testcontainers.junit.jupiter.Container; +import org.testcontainers.junit.jupiter.Testcontainers; + +import java.time.Duration; +import java.util.HashMap; +import java.util.List; +import java.util.Map; + +import static org.assertj.core.api.Assertions.assertThat; +import static org.assertj.core.api.Assertions.assertThatThrownBy; +import static org.junit.jupiter.api.Assertions.assertDoesNotThrow; + +/** + * Integration tests verifying multi-tenant infrastructure with Axon Server. + *

    + * Important: Without an Axon Server license, only the {@code default} context is available. + * These tests verify the full command → event → projection → query flow works through the + * multi-tenant infrastructure connected to Axon Server. + * + * @author Theo Emanuelsson + * @since 5.0.0 + */ +@Testcontainers +class AxonServerMultiTenantIT { + + private static final String AXON_SERVER_IMAGE = "docker.axoniq.io/axoniq/axonserver:2025.2.0"; + private static final TenantDescriptor DEFAULT_TENANT = TenantDescriptor.tenantWithId("default"); + + @Container + static final AxonServerContainer axonServer = new AxonServerContainer(AXON_SERVER_IMAGE) + .withDevMode(true) + .withDcbContext(true) + .withReuse(true); + + private AxonConfiguration configuration; + private CommandGateway commandGateway; + private QueryGateway queryGateway; + + @BeforeAll + static void beforeAll() { + assertThat(axonServer.isRunning()).isTrue(); + } + + @AfterEach + void tearDown() { + if (configuration != null) { + configuration.shutdown(); + configuration = null; + } + } + + private void startApp() { + AxonServerConfiguration asConfig = new AxonServerConfiguration(); + asConfig.setServers(axonServer.getAxonServerAddress()); + + EventSourcingConfigurer configurer = EventSourcingConfigurer.create(); + + configurer.componentRegistry(cr -> cr.registerComponent( + AxonServerConfiguration.class, c -> asConfig)); + + configurer.componentRegistry(cr -> cr.registerComponent( + TenantConnectPredicate.class, + c -> tenant -> "default".equals(tenant.tenantId()))); + + MultiTenancyConfigurer multiTenancyConfigurer = MultiTenancyConfigurer.enhance(configurer) + .registerTargetTenantResolver(config -> new MetadataBasedTenantResolver()); + + configurer = CreateCourseConfiguration.configure(configurer); + configurer = CourseStatsConfiguration.configure(configurer); + + multiTenancyConfigurer.tenantComponent(CourseStatsRepository.class, tenant -> new InMemoryCourseStatsRepository()); + + configurer.messaging(mc -> mc.registerCorrelationDataProvider(config -> message -> { + Map result = new HashMap<>(); + if (message.metadata().containsKey("tenantId")) { + result.put("tenantId", message.metadata().get("tenantId")); + } + return result; + })); + + configuration = configurer.start(); + commandGateway = configuration.getComponent(CommandGateway.class); + queryGateway = configuration.getComponent(QueryGateway.class); + } + + private void waitForTenantRegistration() { + Awaitility.await() + .atMost(Duration.ofSeconds(10)) + .until(() -> { + TenantProvider provider = configuration.getComponent(TenantProvider.class); + return provider.getTenants().contains(DEFAULT_TENANT); + }); + } + + private void createCourseForTenant(TenantDescriptor tenant, CourseId courseId, String name, int capacity) { + commandGateway.send( + new CreateCourse(courseId, name, capacity), + Metadata.with("tenantId", tenant.tenantId()), + null + ).getResultMessage().join(); + } + + private List queryCoursesForTenant(TenantDescriptor tenant) { + QueryMessage query = new GenericQueryMessage( + new MessageType(FindAllCourses.class), new FindAllCourses() + ).andMetadata(Metadata.with("tenantId", tenant.tenantId())); + return queryGateway.query(query, FindAllCourses.Result.class) + .thenApply(FindAllCourses.Result::courses).join(); + } + + @Test + void commandCreatesEventWhichUpdatesProjection() { + startApp(); + waitForTenantRegistration(); + + CourseId courseId = CourseId.random(); + String courseName = "Test Course " + System.currentTimeMillis(); + + // Send command + assertDoesNotThrow(() -> + createCourseForTenant(DEFAULT_TENANT, courseId, courseName, 50) + ); + + // Wait for projection to process and verify + Awaitility.await() + .atMost(Duration.ofSeconds(10)) + .until(() -> queryCoursesForTenant(DEFAULT_TENANT).stream() + .anyMatch(c -> c.courseId().equals(courseId))); + + List courses = queryCoursesForTenant(DEFAULT_TENANT); + assertThat(courses) + .anyMatch(c -> c.courseId().equals(courseId) && c.name().equals(courseName)); + } + + @Test + void multipleCoursesCanBeCreatedAndQueried() { + startApp(); + waitForTenantRegistration(); + + CourseId course1 = CourseId.random(); + CourseId course2 = CourseId.random(); + String name1 = "Course One " + System.currentTimeMillis(); + String name2 = "Course Two " + System.currentTimeMillis(); + + createCourseForTenant(DEFAULT_TENANT, course1, name1, 30); + createCourseForTenant(DEFAULT_TENANT, course2, name2, 25); + + Awaitility.await() + .atMost(Duration.ofSeconds(10)) + .until(() -> { + List courses = queryCoursesForTenant(DEFAULT_TENANT); + return courses.stream().anyMatch(c -> c.courseId().equals(course1)) + && courses.stream().anyMatch(c -> c.courseId().equals(course2)); + }); + + List courses = queryCoursesForTenant(DEFAULT_TENANT); + assertThat(courses).anyMatch(c -> c.courseId().equals(course1) && c.name().equals(name1)); + assertThat(courses).anyMatch(c -> c.courseId().equals(course2) && c.name().equals(name2)); + } + + @Test + void commandToNonExistentTenantFails() { + startApp(); + waitForTenantRegistration(); + + TenantDescriptor nonExistentTenant = TenantDescriptor.tenantWithId("non-existent"); + CourseId courseId = CourseId.random(); + + assertThatThrownBy(() -> + createCourseForTenant(nonExistentTenant, courseId, "Should Fail", 10) + ).hasCauseInstanceOf(NoSuchTenantException.class); + } + + @Test + void commandWithoutTenantMetadataFails() { + startApp(); + waitForTenantRegistration(); + + CourseId courseId = CourseId.random(); + CreateCourse command = new CreateCourse(courseId, "Test Course without Tenant", 10); + + assertThatThrownBy(() -> commandGateway.sendAndWait(command)) + .isInstanceOf(NoSuchTenantException.class); + } +} diff --git a/multitenancy-integration-tests-axon-server/src/test/java/org/axonframework/extension/multitenancy/integrationtests/axonserver/event/CourseCreated.java b/multitenancy-integration-tests-axon-server/src/test/java/org/axonframework/extension/multitenancy/integrationtests/axonserver/event/CourseCreated.java new file mode 100644 index 0000000..1b5a287 --- /dev/null +++ b/multitenancy-integration-tests-axon-server/src/test/java/org/axonframework/extension/multitenancy/integrationtests/axonserver/event/CourseCreated.java @@ -0,0 +1,37 @@ +/* + * Copyright (c) 2010-2025. Axon Framework + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.axonframework.extension.multitenancy.integrationtests.axonserver.event; + +import org.axonframework.eventsourcing.annotation.EventTag; +import org.axonframework.extension.multitenancy.integrationtests.axonserver.shared.CourseId; +import org.axonframework.extension.multitenancy.integrationtests.axonserver.shared.CourseTags; +import org.axonframework.messaging.eventhandling.annotation.Event; + +/** + * Course created event. + * + * @param courseId course ID. + * @param name course name. + * @param capacity course capacity. + */ +@Event(name = "CourseCreated") +public record CourseCreated( + @EventTag(key = CourseTags.COURSE_ID) + CourseId courseId, + String name, + int capacity +) { +} diff --git a/multitenancy-integration-tests-axon-server/src/test/java/org/axonframework/extension/multitenancy/integrationtests/axonserver/read/coursestats/CourseStatsConfiguration.java b/multitenancy-integration-tests-axon-server/src/test/java/org/axonframework/extension/multitenancy/integrationtests/axonserver/read/coursestats/CourseStatsConfiguration.java new file mode 100644 index 0000000..4563ca6 --- /dev/null +++ b/multitenancy-integration-tests-axon-server/src/test/java/org/axonframework/extension/multitenancy/integrationtests/axonserver/read/coursestats/CourseStatsConfiguration.java @@ -0,0 +1,72 @@ +/* + * Copyright (c) 2010-2025. Axon Framework + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.axonframework.extension.multitenancy.integrationtests.axonserver.read.coursestats; + +import org.axonframework.eventsourcing.configuration.EventSourcingConfigurer; +import org.axonframework.extension.multitenancy.messaging.eventhandling.processing.MultiTenantPooledStreamingEventProcessorModule; +import org.axonframework.messaging.queryhandling.configuration.QueryHandlingModule; + +/** + * Configuration for course statistics projection and query handlers. + *

    + * Demonstrates two approaches for accessing tenant-scoped components using + * separate event processors: + *

      + *
    1. {@link CoursesStatsProjectorViaInjection} - Direct parameter injection
      2. + *
    2. {@link CoursesStatsProjectorViaContext} - Via {@code ProcessingContext.component()}
      3. + *
    + *

    + * Note: Tenant-scoped repository is registered separately via + * {@code MultiTenancyConfigurer.tenantComponent()} for global access. + */ +public class CourseStatsConfiguration { + + public static final String PROCESSOR_VIA_INJECTION = "Projection_CourseStats_ViaInjection"; + public static final String PROCESSOR_VIA_CONTEXT = "Projection_CourseStats_ViaContext"; + + public static EventSourcingConfigurer configure(EventSourcingConfigurer configurer) { + // Processor 1: Demonstrates direct parameter injection approach + var injectionProcessor = MultiTenantPooledStreamingEventProcessorModule + .create(PROCESSOR_VIA_INJECTION) + .eventHandlingComponents(c -> c + .autodetected(cfg -> new CoursesStatsProjectorViaInjection()) + ) + .notCustomized(); + + // Processor 2: Demonstrates ProcessingContext.component() approach + var contextProcessor = MultiTenantPooledStreamingEventProcessorModule + .create(PROCESSOR_VIA_CONTEXT) + .eventHandlingComponents(c -> c + .autodetected(cfg -> new CoursesStatsProjectorViaContext()) + ) + .notCustomized(); + + // Query handler uses direct parameter injection for tenant-scoped repository + QueryHandlingModule queryModule = QueryHandlingModule.named("Stats-Handler") + .queryHandlers() + .annotatedQueryHandlingComponent(cfg -> new FindAllCoursesQueryHandler()) + .build(); + + return configurer + .componentRegistry(cr -> cr.registerModule(injectionProcessor.build())) + .componentRegistry(cr -> cr.registerModule(contextProcessor.build())) + .registerQueryHandlingModule(queryModule); + } + + private CourseStatsConfiguration() { + // Prevent instantiation + } +} diff --git a/multitenancy-integration-tests-axon-server/src/test/java/org/axonframework/extension/multitenancy/integrationtests/axonserver/read/coursestats/CourseStatsRepository.java b/multitenancy-integration-tests-axon-server/src/test/java/org/axonframework/extension/multitenancy/integrationtests/axonserver/read/coursestats/CourseStatsRepository.java new file mode 100644 index 0000000..414477d --- /dev/null +++ b/multitenancy-integration-tests-axon-server/src/test/java/org/axonframework/extension/multitenancy/integrationtests/axonserver/read/coursestats/CourseStatsRepository.java @@ -0,0 +1,38 @@ +/* + * Copyright (c) 2010-2025. Axon Framework + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.axonframework.extension.multitenancy.integrationtests.axonserver.read.coursestats; + +import org.axonframework.extension.multitenancy.integrationtests.axonserver.shared.CourseId; + +import java.util.List; +import java.util.Optional; + +/** + * Repository of course statistics. + */ +public interface CourseStatsRepository { + + CoursesStats save(CoursesStats stats); + + Optional findById(CourseId courseId); + + default CoursesStats findByIdOrThrow(CourseId courseId) { + return findById(courseId).orElseThrow(() -> new RuntimeException( + "Course with ID " + courseId + " does not exist!")); + } + + List findAll(); +} diff --git a/multitenancy-integration-tests-axon-server/src/test/java/org/axonframework/extension/multitenancy/integrationtests/axonserver/read/coursestats/CoursesStats.java b/multitenancy-integration-tests-axon-server/src/test/java/org/axonframework/extension/multitenancy/integrationtests/axonserver/read/coursestats/CoursesStats.java new file mode 100644 index 0000000..0caccd7 --- /dev/null +++ b/multitenancy-integration-tests-axon-server/src/test/java/org/axonframework/extension/multitenancy/integrationtests/axonserver/read/coursestats/CoursesStats.java @@ -0,0 +1,36 @@ +/* + * Copyright (c) 2010-2025. Axon Framework + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.axonframework.extension.multitenancy.integrationtests.axonserver.read.coursestats; + +import org.axonframework.extension.multitenancy.integrationtests.axonserver.shared.CourseId; + +/** + * Read model representing statistics about a course. + * + * @param courseId course ID. + * @param name name of the course. + * @param capacity capacity of the course. + */ +public record CoursesStats(CourseId courseId, String name, int capacity) { + + public CoursesStats name(String name) { + return new CoursesStats(courseId, name, capacity); + } + + public CoursesStats capacity(int capacity) { + return new CoursesStats(courseId, name, capacity); + } +} diff --git a/multitenancy-integration-tests-axon-server/src/test/java/org/axonframework/extension/multitenancy/integrationtests/axonserver/read/coursestats/CoursesStatsProjectorViaContext.java b/multitenancy-integration-tests-axon-server/src/test/java/org/axonframework/extension/multitenancy/integrationtests/axonserver/read/coursestats/CoursesStatsProjectorViaContext.java new file mode 100644 index 0000000..293deb2 --- /dev/null +++ b/multitenancy-integration-tests-axon-server/src/test/java/org/axonframework/extension/multitenancy/integrationtests/axonserver/read/coursestats/CoursesStatsProjectorViaContext.java @@ -0,0 +1,71 @@ +/* + * Copyright (c) 2010-2025. Axon Framework + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.axonframework.extension.multitenancy.integrationtests.axonserver.read.coursestats; + +import org.axonframework.extension.multitenancy.integrationtests.axonserver.event.CourseCreated; +import org.axonframework.messaging.core.unitofwork.ProcessingContext; +import org.axonframework.messaging.eventhandling.annotation.EventHandler; +import org.axonframework.messaging.eventhandling.annotation.SequencingPolicy; +import org.axonframework.messaging.eventhandling.sequencing.PropertySequencingPolicy; +import org.axonframework.messaging.queryhandling.QueryUpdateEmitter; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +import java.util.List; + +/** + * Event handler that demonstrates accessing tenant-scoped components via + * {@link ProcessingContext#component(Class)}. + *

    + * This approach is useful when you need to access multiple tenant-scoped components + * or when the component type isn't known at compile time. + *

    + * Example: + * 

    {@code
+ * @EventHandler
+ * void handle(SomeEvent event, ProcessingContext context) {
+ *     MyRepository repo = context.component(MyRepository.class);
+ *     repo.save(...);
+ * }
+ * }
    + * + * @see CoursesStatsProjectorViaInjection for the direct injection approach + */ +@SequencingPolicy(type = PropertySequencingPolicy.class, parameters = {"courseId"}) +class CoursesStatsProjectorViaContext { + + private static final Logger logger = LoggerFactory.getLogger(CoursesStatsProjectorViaContext.class); + + @EventHandler + void handle(CourseCreated event, ProcessingContext context, QueryUpdateEmitter emitter) { + // Get tenant-scoped repository via ProcessingContext.component() + CourseStatsRepository repository = context.component(CourseStatsRepository.class); + + var stats = new CoursesStats( + event.courseId(), + event.name(), + event.capacity() + ); + repository.save(stats); + logger.info("[VIA-CONTEXT] Saved course: {}", event.courseId()); + + emitter.emit( + FindAllCourses.class, + q -> true, + new FindAllCourses.Result(List.of(stats)) + ); + } +} diff --git a/multitenancy-integration-tests-axon-server/src/test/java/org/axonframework/extension/multitenancy/integrationtests/axonserver/read/coursestats/CoursesStatsProjectorViaInjection.java b/multitenancy-integration-tests-axon-server/src/test/java/org/axonframework/extension/multitenancy/integrationtests/axonserver/read/coursestats/CoursesStatsProjectorViaInjection.java new file mode 100644 index 0000000..246a967 --- /dev/null +++ b/multitenancy-integration-tests-axon-server/src/test/java/org/axonframework/extension/multitenancy/integrationtests/axonserver/read/coursestats/CoursesStatsProjectorViaInjection.java @@ -0,0 +1,58 @@ +/* + * Copyright (c) 2010-2025. Axon Framework + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.axonframework.extension.multitenancy.integrationtests.axonserver.read.coursestats; + +import org.axonframework.extension.multitenancy.integrationtests.axonserver.event.CourseCreated; +import org.axonframework.messaging.eventhandling.annotation.EventHandler; +import org.axonframework.messaging.eventhandling.annotation.SequencingPolicy; +import org.axonframework.messaging.eventhandling.sequencing.PropertySequencingPolicy; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +/** + * Event handler that demonstrates accessing tenant-scoped components via + * direct parameter injection. + *

    + * This approach is the most concise when you know the component type at compile time + * and only need a single tenant-scoped component. + *

    + * Example: + * 

    {@code
+ * @EventHandler
+ * void handle(SomeEvent event, MyRepository repository) {
+ *     repository.save(...);
+ * }
+ * }
    + * + * @see CoursesStatsProjectorViaContext for the ProcessingContext approach + */ +@SequencingPolicy(type = PropertySequencingPolicy.class, parameters = {"courseId"}) +class CoursesStatsProjectorViaInjection { + + private static final Logger logger = LoggerFactory.getLogger(CoursesStatsProjectorViaInjection.class); + + @EventHandler + void handle(CourseCreated event, CourseStatsRepository repository) { + // Repository is injected directly as a parameter - tenant is resolved automatically + var stats = new CoursesStats( + event.courseId(), + event.name(), + event.capacity() + ); + repository.save(stats); + logger.info("[VIA-INJECTION] Saved course: {}", event.courseId()); + } +} diff --git a/multitenancy-integration-tests-axon-server/src/test/java/org/axonframework/extension/multitenancy/integrationtests/axonserver/read/coursestats/FindAllCourses.java b/multitenancy-integration-tests-axon-server/src/test/java/org/axonframework/extension/multitenancy/integrationtests/axonserver/read/coursestats/FindAllCourses.java new file mode 100644 index 0000000..e4514c7 --- /dev/null +++ b/multitenancy-integration-tests-axon-server/src/test/java/org/axonframework/extension/multitenancy/integrationtests/axonserver/read/coursestats/FindAllCourses.java @@ -0,0 +1,32 @@ +/* + * Copyright (c) 2010-2025. Axon Framework + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.axonframework.extension.multitenancy.integrationtests.axonserver.read.coursestats; + +import java.util.List; + +/** + * Query to find all courses. + */ +public record FindAllCourses() { + + /** + * Result containing all courses. + * + * @param courses the list of course stats. + */ + public record Result(List courses) { + } +} diff --git a/multitenancy-integration-tests-axon-server/src/test/java/org/axonframework/extension/multitenancy/integrationtests/axonserver/read/coursestats/FindAllCoursesQueryHandler.java b/multitenancy-integration-tests-axon-server/src/test/java/org/axonframework/extension/multitenancy/integrationtests/axonserver/read/coursestats/FindAllCoursesQueryHandler.java new file mode 100644 index 0000000..0a24d82 --- /dev/null +++ b/multitenancy-integration-tests-axon-server/src/test/java/org/axonframework/extension/multitenancy/integrationtests/axonserver/read/coursestats/FindAllCoursesQueryHandler.java @@ -0,0 +1,32 @@ +/* + * Copyright (c) 2010-2025. Axon Framework + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.axonframework.extension.multitenancy.integrationtests.axonserver.read.coursestats; + +import org.axonframework.messaging.queryhandling.annotation.QueryHandler; + +/** + * Query handler for finding all courses. + *

    + * Uses parameter injection to receive the tenant-scoped repository. + * The repository is resolved based on the query's tenant context. + */ +public class FindAllCoursesQueryHandler { + + @QueryHandler + FindAllCourses.Result handle(FindAllCourses query, CourseStatsRepository repository) { + return new FindAllCourses.Result(repository.findAll()); + } +} diff --git a/multitenancy-integration-tests-axon-server/src/test/java/org/axonframework/extension/multitenancy/integrationtests/axonserver/read/coursestats/InMemoryCourseStatsRepository.java b/multitenancy-integration-tests-axon-server/src/test/java/org/axonframework/extension/multitenancy/integrationtests/axonserver/read/coursestats/InMemoryCourseStatsRepository.java new file mode 100644 index 0000000..8351aef --- /dev/null +++ b/multitenancy-integration-tests-axon-server/src/test/java/org/axonframework/extension/multitenancy/integrationtests/axonserver/read/coursestats/InMemoryCourseStatsRepository.java @@ -0,0 +1,46 @@ +/* + * Copyright (c) 2010-2025. Axon Framework + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.axonframework.extension.multitenancy.integrationtests.axonserver.read.coursestats; + +import org.axonframework.extension.multitenancy.integrationtests.axonserver.shared.CourseId; + +import java.util.List; +import java.util.Optional; +import java.util.concurrent.ConcurrentHashMap; + +/** + * In-memory implementation of the course statistics repository. + */ +public class InMemoryCourseStatsRepository implements CourseStatsRepository { + + private final ConcurrentHashMap stats = new ConcurrentHashMap<>(); + + @Override + public CoursesStats save(CoursesStats stats) { + this.stats.put(stats.courseId(), stats); + return stats; + } + + @Override + public Optional findById(CourseId courseId) { + return Optional.ofNullable(stats.get(courseId)); + } + + @Override + public List findAll() { + return stats.values().stream().toList(); + } +} diff --git a/multitenancy-integration-tests-axon-server/src/test/java/org/axonframework/extension/multitenancy/integrationtests/axonserver/shared/CourseId.java b/multitenancy-integration-tests-axon-server/src/test/java/org/axonframework/extension/multitenancy/integrationtests/axonserver/shared/CourseId.java new file mode 100644 index 0000000..78a92ea --- /dev/null +++ b/multitenancy-integration-tests-axon-server/src/test/java/org/axonframework/extension/multitenancy/integrationtests/axonserver/shared/CourseId.java @@ -0,0 +1,54 @@ +/* + * Copyright (c) 2010-2025. Axon Framework + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.axonframework.extension.multitenancy.integrationtests.axonserver.shared; + +import jakarta.validation.constraints.NotNull; + +import java.util.UUID; + +/** + * Course ID value object. + * + * @param raw raw string ID representation. + */ +public record CourseId(@NotNull String raw) { + + private final static String ENTITY_TYPE = "Course"; + + public CourseId { + if (raw == null || raw.isBlank()) { + throw new IllegalArgumentException("Course ID cannot be null or empty"); + } + raw = withType(raw); + } + + public static CourseId of(String raw) { + return new CourseId(raw); + } + + public static CourseId random() { + return new CourseId(UUID.randomUUID().toString()); + } + + @Override + public String toString() { + return raw; + } + + private static String withType(String id) { + return id.startsWith(ENTITY_TYPE + ":") ? id : ENTITY_TYPE + ":" + id; + } +} diff --git a/multitenancy-integration-tests-axon-server/src/test/java/org/axonframework/extension/multitenancy/integrationtests/axonserver/shared/CourseTags.java b/multitenancy-integration-tests-axon-server/src/test/java/org/axonframework/extension/multitenancy/integrationtests/axonserver/shared/CourseTags.java new file mode 100644 index 0000000..1426ec1 --- /dev/null +++ b/multitenancy-integration-tests-axon-server/src/test/java/org/axonframework/extension/multitenancy/integrationtests/axonserver/shared/CourseTags.java @@ -0,0 +1,28 @@ +/* + * Copyright (c) 2010-2025. Axon Framework + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.axonframework.extension.multitenancy.integrationtests.axonserver.shared; + +/** + * Event tags for course-related events. + */ +public class CourseTags { + + public static final String COURSE_ID = "courseId"; + + private CourseTags() { + // Prevent instantiation + } +} diff --git a/multitenancy-integration-tests-axon-server/src/test/java/org/axonframework/extension/multitenancy/integrationtests/axonserver/write/createcourse/CourseCreation.java b/multitenancy-integration-tests-axon-server/src/test/java/org/axonframework/extension/multitenancy/integrationtests/axonserver/write/createcourse/CourseCreation.java new file mode 100644 index 0000000..7322fc1 --- /dev/null +++ b/multitenancy-integration-tests-axon-server/src/test/java/org/axonframework/extension/multitenancy/integrationtests/axonserver/write/createcourse/CourseCreation.java @@ -0,0 +1,59 @@ +/* + * Copyright (c) 2010-2025. Axon Framework + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.axonframework.extension.multitenancy.integrationtests.axonserver.write.createcourse; + +import jakarta.validation.Valid; +import org.axonframework.eventsourcing.annotation.EventSourcedEntity; +import org.axonframework.eventsourcing.annotation.EventSourcingHandler; +import org.axonframework.eventsourcing.annotation.reflection.EntityCreator; +import org.axonframework.extension.multitenancy.integrationtests.axonserver.event.CourseCreated; +import org.axonframework.extension.multitenancy.integrationtests.axonserver.shared.CourseId; +import org.axonframework.extension.multitenancy.integrationtests.axonserver.shared.CourseTags; +import org.axonframework.messaging.commandhandling.annotation.CommandHandler; +import org.axonframework.messaging.eventhandling.gateway.EventAppender; + +/** + * Entity for course creation with internal command handler. + */ +@EventSourcedEntity(tagKey = CourseTags.COURSE_ID) +public class CourseCreation { + + private boolean created = false; + private CourseId id; + private int capacity; + + @CommandHandler + public static void handle(@Valid CreateCourse command, EventAppender appender) { + appender.append( + new CourseCreated( + command.courseId(), + command.name(), + command.capacity() + ) + ); + } + + @EntityCreator + public CourseCreation() { + } + + @EventSourcingHandler + public void evolve(CourseCreated courseCreated) { + this.id = courseCreated.courseId(); + this.created = true; + this.capacity = courseCreated.capacity(); + } +} diff --git a/multitenancy-integration-tests-axon-server/src/test/java/org/axonframework/extension/multitenancy/integrationtests/axonserver/write/createcourse/CreateCourse.java b/multitenancy-integration-tests-axon-server/src/test/java/org/axonframework/extension/multitenancy/integrationtests/axonserver/write/createcourse/CreateCourse.java new file mode 100644 index 0000000..0ced2d3 --- /dev/null +++ b/multitenancy-integration-tests-axon-server/src/test/java/org/axonframework/extension/multitenancy/integrationtests/axonserver/write/createcourse/CreateCourse.java @@ -0,0 +1,44 @@ +/* + * Copyright (c) 2010-2025. Axon Framework + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.axonframework.extension.multitenancy.integrationtests.axonserver.write.createcourse; + +import jakarta.validation.Valid; +import jakarta.validation.constraints.Min; +import jakarta.validation.constraints.NotEmpty; +import jakarta.validation.constraints.NotNull; +import jakarta.validation.constraints.Size; +import org.axonframework.extension.multitenancy.integrationtests.axonserver.shared.CourseId; +import org.axonframework.modelling.annotation.TargetEntityId; + +/** + * Command to create a new course. + * + * @param courseId course ID. + * @param name course name. + * @param capacity course capacity. + */ +public record CreateCourse( + @Valid + @NotNull + @TargetEntityId + CourseId courseId, + @NotEmpty + @Size(min = 10) + String name, + @Min(value = 1, message = "Capacity must be a positive integer") + int capacity +) { +} diff --git a/multitenancy-integration-tests-axon-server/src/test/java/org/axonframework/extension/multitenancy/integrationtests/axonserver/write/createcourse/CreateCourseConfiguration.java b/multitenancy-integration-tests-axon-server/src/test/java/org/axonframework/extension/multitenancy/integrationtests/axonserver/write/createcourse/CreateCourseConfiguration.java new file mode 100644 index 0000000..c3098da --- /dev/null +++ b/multitenancy-integration-tests-axon-server/src/test/java/org/axonframework/extension/multitenancy/integrationtests/axonserver/write/createcourse/CreateCourseConfiguration.java @@ -0,0 +1,37 @@ +/* + * Copyright (c) 2010-2025. Axon Framework + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.axonframework.extension.multitenancy.integrationtests.axonserver.write.createcourse; + +import org.axonframework.eventsourcing.configuration.EventSourcedEntityModule; +import org.axonframework.eventsourcing.configuration.EventSourcingConfigurer; +import org.axonframework.extension.multitenancy.integrationtests.axonserver.shared.CourseId; + +/** + * Configuration for the CreateCourse command handler. + */ +public class CreateCourseConfiguration { + + public static EventSourcingConfigurer configure(EventSourcingConfigurer configurer) { + var stateEntity = EventSourcedEntityModule + .autodetected(CourseId.class, CourseCreation.class); + + return configurer.registerEntity(stateEntity); + } + + private CreateCourseConfiguration() { + // Prevent instantiation + } +} diff --git a/multitenancy-integration-tests-axon-server/src/test/resources/log4j2-test.xml b/multitenancy-integration-tests-axon-server/src/test/resources/log4j2-test.xml new file mode 100644 index 0000000..2d5cb9f --- /dev/null +++ b/multitenancy-integration-tests-axon-server/src/test/resources/log4j2-test.xml @@ -0,0 +1,17 @@ + + + + + + + + + + + + + + + + + diff --git a/multitenancy-integration-tests-embedded/pom.xml b/multitenancy-integration-tests-embedded/pom.xml new file mode 100644 index 0000000..81c2b24 --- /dev/null +++ b/multitenancy-integration-tests-embedded/pom.xml @@ -0,0 +1,141 @@ + + + + + 4.0.0 + + + org.axonframework.extensions.multitenancy + axon-multitenancy-parent + 5.1.0-SNAPSHOT + + + axon-multitenancy-integration-tests-embedded + Axon Framework Multi-Tenancy Extension - Embedded Integration Tests + + Integration tests for core multi-tenancy with embedded in-memory event store. + Tests tenant isolation, routing, and dynamic tenant registration. + + + + 4.2.2 + 3.27.3 + + + + + + org.axonframework.extensions.multitenancy + axon-multitenancy + ${project.version} + test + + + + + org.axonframework + axon-eventsourcing + test + + + org.axonframework + axon-modelling + ${axon.version} + test + + + org.axonframework + axon-messaging + test + + + + + org.junit.jupiter + junit-jupiter + test + + + + + org.assertj + assertj-core + ${assertj.version} + test + + + org.awaitility + awaitility + ${awaitility.version} + test + + + + + jakarta.validation + jakarta.validation-api + 3.1.0 + test + + + + + org.slf4j + slf4j-api + 2.0.17 + test + + + org.apache.logging.log4j + log4j-slf4j2-impl + 2.24.3 + test + + + org.apache.logging.log4j + log4j-core + 2.24.3 + test + + + + + + + org.apache.maven.plugins + maven-surefire-plugin + + + **/*IT.java + **/*Test.java + + + + + + org.apache.maven.plugins + maven-deploy-plugin + 3.1.3 + + true + + + + + diff --git a/multitenancy-integration-tests-embedded/src/test/java/org/axonframework/extension/multitenancy/integrationtests/embedded/EmbeddedMultiTenantIT.java b/multitenancy-integration-tests-embedded/src/test/java/org/axonframework/extension/multitenancy/integrationtests/embedded/EmbeddedMultiTenantIT.java new file mode 100644 index 0000000..7c2b7c4 --- /dev/null +++ b/multitenancy-integration-tests-embedded/src/test/java/org/axonframework/extension/multitenancy/integrationtests/embedded/EmbeddedMultiTenantIT.java @@ -0,0 +1,434 @@ +/* + * Copyright (c) 2010-2025. Axon Framework + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.axonframework.extension.multitenancy.integrationtests.embedded; + +import org.awaitility.Awaitility; +import org.axonframework.common.configuration.AxonConfiguration; +import org.axonframework.eventsourcing.configuration.EventSourcingConfigurer; +import org.axonframework.eventsourcing.eventstore.EventStore; +import org.axonframework.eventsourcing.eventstore.InterceptingEventStore; +import org.axonframework.extension.multitenancy.core.MetadataBasedTenantResolver; +import org.axonframework.extension.multitenancy.core.NoSuchTenantException; +import org.axonframework.extension.multitenancy.core.SimpleTenantProvider; +import org.axonframework.extension.multitenancy.core.TenantDescriptor; +import org.axonframework.extension.multitenancy.core.configuration.MultiTenancyConfigurer; +import org.axonframework.extension.multitenancy.eventsourcing.eventstore.MultiTenantEventStore; +import org.axonframework.extension.multitenancy.integrationtests.embedded.read.coursestats.FindAllCourses; +import org.axonframework.extension.multitenancy.integrationtests.embedded.read.coursestats.CoursesStats; +import org.axonframework.extension.multitenancy.integrationtests.embedded.read.coursestats.CourseStatsConfiguration; +import org.axonframework.extension.multitenancy.integrationtests.embedded.read.coursestats.CourseStatsRepository; +import org.axonframework.extension.multitenancy.integrationtests.embedded.read.coursestats.InMemoryCourseStatsRepository; +import org.axonframework.extension.multitenancy.integrationtests.embedded.shared.CourseId; +import org.axonframework.extension.multitenancy.integrationtests.embedded.write.createcourse.CreateCourse; +import org.axonframework.extension.multitenancy.integrationtests.embedded.write.createcourse.CreateCourseConfiguration; +import org.axonframework.extension.multitenancy.integrationtests.embedded.automation.CourseNotificationConfiguration; +import org.axonframework.extension.multitenancy.integrationtests.embedded.automation.NotificationService; +import org.axonframework.messaging.commandhandling.CommandBus; +import org.axonframework.messaging.commandhandling.gateway.CommandGateway; +import org.axonframework.messaging.core.MessageType; +import org.axonframework.messaging.core.Metadata; +import org.axonframework.messaging.queryhandling.GenericQueryMessage; +import org.axonframework.messaging.queryhandling.QueryBus; +import org.axonframework.messaging.queryhandling.QueryMessage; +import org.axonframework.messaging.queryhandling.gateway.QueryGateway; + +import java.util.HashMap; +import java.util.Map; +import java.util.concurrent.ConcurrentHashMap; + +import org.axonframework.messaging.core.interception.DispatchInterceptorRegistry; +import org.axonframework.messaging.core.MessageDispatchInterceptor; +import org.axonframework.messaging.eventhandling.EventMessage; +import org.junit.jupiter.api.AfterEach; +import org.junit.jupiter.api.Test; + +import java.time.Duration; +import java.util.List; + +import static org.assertj.core.api.Assertions.assertThat; +import static org.assertj.core.api.Assertions.assertThatThrownBy; +import static org.junit.jupiter.api.Assertions.assertDoesNotThrow; + +/** + * Integration tests verifying multi-tenant isolation with embedded in-memory event store. + *

    + * These tests verify the core multi-tenancy functionality: + *

      + *
    • Tenant isolation - data from tenant A not visible in tenant B
      • + *
    • Tenant routing - commands/queries routed to correct tenant segment
      • + *
    • Dynamic tenant registration - tenants can be added after startup
      • + *
    + * + * @author Theo Emanuelsson + * @since 5.0.0 + */ +class EmbeddedMultiTenantIT { + + private static final TenantDescriptor TENANT_A = TenantDescriptor.tenantWithId("tenant-a"); + private static final TenantDescriptor TENANT_B = TenantDescriptor.tenantWithId("tenant-b"); + + private SimpleTenantProvider tenantProvider; + private AxonConfiguration configuration; + private CommandGateway commandGateway; + private QueryGateway queryGateway; + + @AfterEach + void tearDown() { + if (configuration != null) { + configuration.shutdown(); + configuration = null; + } + } + + private void startApp() { + tenantProvider = new SimpleTenantProvider(List.of(TENANT_A, TENANT_B)); + + // Create base configurer + EventSourcingConfigurer configurer = EventSourcingConfigurer.create(); + + // Enhance with multi-tenancy - this registers resolver factories early + MultiTenancyConfigurer multiTenancyConfigurer = MultiTenancyConfigurer.enhance(configurer) + .registerTenantProvider(config -> tenantProvider) + .registerTargetTenantResolver(config -> new MetadataBasedTenantResolver()); + + // Domain modules can be configured in ANY order relative to tenantComponent() + // because resolver factories are registered in enhance(), not tenantComponent() + configurer = CreateCourseConfiguration.configure(configurer); + configurer = CourseStatsConfiguration.configure(configurer); + + // tenantComponent() can be called after domain modules are configured + multiTenancyConfigurer.tenantComponent(CourseStatsRepository.class, tenant -> new InMemoryCourseStatsRepository()); + + // Register correlation provider for metadata-based tenant resolution + // This ensures tenantId propagates from commands to events + configurer.messaging(mc -> mc.registerCorrelationDataProvider(config -> message -> { + Map result = new HashMap<>(); + if (message.metadata().containsKey("tenantId")) { + result.put("tenantId", message.metadata().get("tenantId")); + } + return result; + })); + + configuration = configurer.start(); + commandGateway = configuration.getComponent(CommandGateway.class); + queryGateway = configuration.getComponent(QueryGateway.class); + } + + private void createCourseForTenant(TenantDescriptor tenant, CourseId courseId, String name, int capacity) { + commandGateway.send( + new CreateCourse(courseId, name, capacity), + Metadata.with("tenantId", tenant.tenantId()), + null + ).getResultMessage().join(); + } + + private List queryCoursesForTenant(TenantDescriptor tenant) { + QueryMessage query = new GenericQueryMessage( + new MessageType(FindAllCourses.class), new FindAllCourses() + ).andMetadata(Metadata.with("tenantId", tenant.tenantId())); + return queryGateway.query(query, FindAllCourses.Result.class) + .thenApply(FindAllCourses.Result::courses).join(); + } + + @Test + void debugCorrelationAndInterceptorConfiguration() { + // Modified startApp with debug hooks + tenantProvider = new SimpleTenantProvider(List.of(TENANT_A, TENANT_B)); + EventSourcingConfigurer configurer = EventSourcingConfigurer.create(); + configurer = CreateCourseConfiguration.configure(configurer); + configurer = CourseStatsConfiguration.configure(configurer); + + configurer.messaging(mc -> mc.registerCorrelationDataProvider(config -> message -> { + Map result = new HashMap<>(); + if (message.metadata().containsKey("tenantId")) { + result.put("tenantId", message.metadata().get("tenantId")); + } + return result; + })); + + MultiTenancyConfigurer.enhance(configurer) + .registerTenantProvider(config -> tenantProvider) + .registerTargetTenantResolver(config -> new MetadataBasedTenantResolver()) + .tenantComponent(CourseStatsRepository.class, tenant -> new InMemoryCourseStatsRepository()); + + // Debug: Check if MultiTenancy enhancer actually runs by adding decorator at MIN_VALUE-1 (BEFORE MultiTenant) + configurer.componentRegistry(cr -> cr.registerDecorator( + EventStore.class, + Integer.MIN_VALUE + 10, // Between MIN_VALUE and +50 to see what's happening + (config, name, delegate) -> { + System.out.println("=== DEBUG @ MIN_VALUE+10 ==="); + System.out.println(" delegate type: " + delegate.getClass().getName()); + return delegate; + } + )); + + // Debug: right after MultiTenantEventStore decorator (MIN_VALUE) + configurer.componentRegistry(cr -> cr.registerDecorator( + EventStore.class, + Integer.MIN_VALUE + 1, + (config, name, delegate) -> { + System.out.println("=== DEBUG @ MIN_VALUE+1 (after MultiTenant) ==="); + System.out.println(" delegate type: " + delegate.getClass().getName()); + return delegate; + } + )); + + // Debug: right before InterceptingEventStore decorator (MIN_VALUE + 50) + configurer.componentRegistry(cr -> cr.registerDecorator( + EventStore.class, + Integer.MIN_VALUE + 49, + (config, name, delegate) -> { + System.out.println("=== DEBUG @ MIN_VALUE+49 (before Intercepting) ==="); + System.out.println(" delegate type: " + delegate.getClass().getName()); + DispatchInterceptorRegistry registry = config.getComponent(DispatchInterceptorRegistry.class); + List> interceptors = registry.eventInterceptors(config); + System.out.println(" Event dispatch interceptors: " + interceptors.size()); + return delegate; + } + )); + + // Debug: right after InterceptingEventStore decorator (MIN_VALUE + 50) + configurer.componentRegistry(cr -> cr.registerDecorator( + EventStore.class, + Integer.MIN_VALUE + 51, + (config, name, delegate) -> { + System.out.println("=== DEBUG @ MIN_VALUE+51 (after Intercepting) ==="); + System.out.println(" delegate type: " + delegate.getClass().getName()); + DispatchInterceptorRegistry registry = config.getComponent(DispatchInterceptorRegistry.class); + List> interceptors = registry.eventInterceptors(config); + System.out.println(" Event dispatch interceptors: " + interceptors.size()); + return delegate; + } + )); + + // Print decoration order constants to verify + System.out.println("=== DECORATION ORDER CONSTANTS ==="); + System.out.println(" MultiTenantEventStore.DECORATION_ORDER = " + MultiTenantEventStore.DECORATION_ORDER); + System.out.println(" InterceptingEventStore.DECORATION_ORDER = " + InterceptingEventStore.DECORATION_ORDER); + System.out.println(" Integer.MIN_VALUE = " + Integer.MIN_VALUE); + System.out.println(" Integer.MIN_VALUE + 50 = " + (Integer.MIN_VALUE + 50)); + + configuration = configurer.start(); + commandGateway = configuration.getComponent(CommandGateway.class); + queryGateway = configuration.getComponent(QueryGateway.class); + + // Debug: Check EventStore type AFTER configuration + EventStore eventStore = configuration.getComponent(EventStore.class); + System.out.println("=== AFTER CONFIG: EventStore ==="); + System.out.println("EventStore type: " + eventStore.getClass().getName()); + + // Debug: Check dispatch interceptors AFTER configuration + DispatchInterceptorRegistry dispatchRegistry = configuration.getComponent(DispatchInterceptorRegistry.class); + List> eventInterceptors = dispatchRegistry.eventInterceptors(configuration); + System.out.println("=== AFTER CONFIG: Event Dispatch Interceptors ==="); + System.out.println("Number of interceptors: " + eventInterceptors.size()); + + // Expected: InterceptingEventStore wrapping MultiTenantEventStore + assertThat(eventStore).isInstanceOf(InterceptingEventStore.class) + .withFailMessage("EventStore should be wrapped in InterceptingEventStore but was: " + eventStore.getClass().getName()); + } + + @Test + void multiTenantConfigurationCreatesIsolatedSegments() { + startApp(); + + // Verify EventStore is wrapped with InterceptingEventStore (for dispatch interceptors) + EventStore eventStore = configuration.getComponent(EventStore.class); + assertThat(eventStore).isInstanceOf(InterceptingEventStore.class); + + // Verify CommandBus and QueryBus are configured + assertThat(configuration.getComponent(CommandBus.class)).isNotNull(); + QueryBus queryBus = configuration.getComponent(QueryBus.class); + assertThat(queryBus).isNotNull(); + } + + @Test + void sameEntityIdInDifferentTenantsDoNotConflict() { + startApp(); + + // Use the same CourseId in both tenants - should NOT conflict + CourseId sharedCourseId = CourseId.random(); + + // Register in tenant A + assertDoesNotThrow(() -> + createCourseForTenant(TENANT_A, sharedCourseId, "Introduction to Multi-Tenancy A", 30) + ); + + // Register same ID in tenant B - should succeed (different tenant segment) + assertDoesNotThrow(() -> + createCourseForTenant(TENANT_B, sharedCourseId, "Introduction to Multi-Tenancy B", 25) + ); + } + + @Test + void eventsFromTenantANotVisibleInTenantB() { + startApp(); + + // Create courses for both tenants + CourseId courseIdA = CourseId.random(); + CourseId courseIdB = CourseId.random(); + createCourseForTenant(TENANT_A, courseIdA, "Course for Tenant A", 20); + createCourseForTenant(TENANT_B, courseIdB, "Course for Tenant B", 30); + + // Wait for both projections to process + Awaitility.await().atMost(Duration.ofSeconds(5)).until(() -> + !queryCoursesForTenant(TENANT_A).isEmpty() && !queryCoursesForTenant(TENANT_B).isEmpty() + ); + + // Tenant A should only see their own course + List tenantACourses = queryCoursesForTenant(TENANT_A); + assertThat(tenantACourses).hasSize(1); + assertThat(tenantACourses.get(0).courseId()).isEqualTo(courseIdA); + assertThat(tenantACourses.get(0).name()).isEqualTo("Course for Tenant A"); + + // Tenant B should only see their own course - not Tenant A's + List tenantBCourses = queryCoursesForTenant(TENANT_B); + assertThat(tenantBCourses).hasSize(1); + assertThat(tenantBCourses.get(0).courseId()).isEqualTo(courseIdB); + assertThat(tenantBCourses.get(0).name()).isEqualTo("Course for Tenant B"); + } + + @Test + void commandWithoutTenantMetadataFails() { + startApp(); + + CourseId courseId = CourseId.random(); + CreateCourse command = new CreateCourse(courseId, "Test Course without Tenant", 10); + + // Send without tenant metadata - should fail + assertThatThrownBy(() -> commandGateway.sendAndWait(command)) + .isInstanceOf(NoSuchTenantException.class); + } + + @Test + void dynamicTenantRegistrationWorks() { + startApp(); + + TenantDescriptor dynamicTenant = TenantDescriptor.tenantWithId("dynamic-tenant"); + + // Initially, operations to dynamic tenant should fail + CourseId courseId1 = CourseId.random(); + assertThatThrownBy(() -> + createCourseForTenant(dynamicTenant, courseId1, "Test Course for Dynamic", 15) + ).hasCauseInstanceOf(NoSuchTenantException.class); + + // Add the tenant dynamically + tenantProvider.addTenant(dynamicTenant); + + // Now operations should succeed + CourseId courseId2 = CourseId.random(); + assertDoesNotThrow(() -> + createCourseForTenant(dynamicTenant, courseId2, "Dynamic Tenant Course", 20) + ); + + // Verify the course was stored + Awaitility.await().atMost(Duration.ofSeconds(5)).until(() -> + !queryCoursesForTenant(dynamicTenant).isEmpty() + ); + List dynamicTenantCourses = queryCoursesForTenant(dynamicTenant); + assertThat(dynamicTenantCourses).hasSize(1); + } + + // --- Tests for CommandDispatcher tenant propagation --- + + private Map notificationServices; + + private void startAppWithNotifications() { + tenantProvider = new SimpleTenantProvider(List.of(TENANT_A, TENANT_B)); + notificationServices = new ConcurrentHashMap<>(); + + EventSourcingConfigurer configurer = EventSourcingConfigurer.create(); + + MultiTenancyConfigurer multiTenancyConfigurer = MultiTenancyConfigurer.enhance(configurer) + .registerTenantProvider(config -> tenantProvider) + .registerTargetTenantResolver(config -> new MetadataBasedTenantResolver()); + + // Domain modules + configurer = CreateCourseConfiguration.configure(configurer); + configurer = CourseStatsConfiguration.configure(configurer); + configurer = CourseNotificationConfiguration.configure(configurer); + + // Tenant-scoped components + multiTenancyConfigurer.tenantComponent(CourseStatsRepository.class, tenant -> new InMemoryCourseStatsRepository()); + multiTenancyConfigurer.tenantComponent(NotificationService.class, tenant -> { + var service = new NotificationService(tenant.tenantId()); + notificationServices.put(tenant.tenantId(), service); + return service; + }); + + // Correlation provider for tenant propagation + configurer.messaging(mc -> mc.registerCorrelationDataProvider(config -> message -> { + Map result = new HashMap<>(); + if (message.metadata().containsKey("tenantId")) { + result.put("tenantId", message.metadata().get("tenantId")); + } + return result; + })); + + configuration = configurer.start(); + commandGateway = configuration.getComponent(CommandGateway.class); + queryGateway = configuration.getComponent(QueryGateway.class); + } + + @Test + void commandDispatcherPropagatesTenantContext() { + startAppWithNotifications(); + + // Create courses for both tenants + CourseId courseIdA = CourseId.random(); + CourseId courseIdB = CourseId.random(); + createCourseForTenant(TENANT_A, courseIdA, "Course A", 20); + createCourseForTenant(TENANT_B, courseIdB, "Course B", 30); + + // Wait for notifications to be sent via the automation + Awaitility.await().atMost(Duration.ofSeconds(10)).until(() -> { + var serviceA = notificationServices.get(TENANT_A.tenantId()); + var serviceB = notificationServices.get(TENANT_B.tenantId()); + return serviceA != null && !serviceA.getSentNotifications().isEmpty() + && serviceB != null && !serviceB.getSentNotifications().isEmpty(); + }); + + // Get the tenant-specific NotificationService instances + NotificationService tenantAService = notificationServices.get(TENANT_A.tenantId()); + NotificationService tenantBService = notificationServices.get(TENANT_B.tenantId()); + + // Verify each service was constructed with the correct tenant ID + assertThat(tenantAService.getTenantId()).isEqualTo(TENANT_A.tenantId()); + assertThat(tenantBService.getTenantId()).isEqualTo(TENANT_B.tenantId()); + + // Verify tenant A's service received ONLY tenant A's notification + assertThat(tenantAService.getSentNotifications()) + .as("Tenant A's service should receive exactly 1 notification") + .hasSize(1); + assertThat(tenantAService.getSentNotifications().get(0).message()) + .as("Tenant A's notification should be about Course A") + .contains("Course A"); + assertThat(tenantAService.getSentNotifications().get(0).message()) + .as("Tenant A's service should NOT have Course B's notification") + .doesNotContain("Course B"); + + // Verify tenant B's service received ONLY tenant B's notification + assertThat(tenantBService.getSentNotifications()) + .as("Tenant B's service should receive exactly 1 notification") + .hasSize(1); + assertThat(tenantBService.getSentNotifications().get(0).message()) + .as("Tenant B's notification should be about Course B") + .contains("Course B"); + assertThat(tenantBService.getSentNotifications().get(0).message()) + .as("Tenant B's service should NOT have Course A's notification") + .doesNotContain("Course A"); + } +} diff --git a/multitenancy-integration-tests-embedded/src/test/java/org/axonframework/extension/multitenancy/integrationtests/embedded/automation/CourseNotificationConfiguration.java b/multitenancy-integration-tests-embedded/src/test/java/org/axonframework/extension/multitenancy/integrationtests/embedded/automation/CourseNotificationConfiguration.java new file mode 100644 index 0000000..5b41c1d --- /dev/null +++ b/multitenancy-integration-tests-embedded/src/test/java/org/axonframework/extension/multitenancy/integrationtests/embedded/automation/CourseNotificationConfiguration.java @@ -0,0 +1,58 @@ +/* + * Copyright (c) 2010-2025. Axon Framework + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.axonframework.extension.multitenancy.integrationtests.embedded.automation; + +import org.axonframework.eventsourcing.configuration.EventSourcedEntityModule; +import org.axonframework.eventsourcing.configuration.EventSourcingConfigurer; +import org.axonframework.extension.multitenancy.integrationtests.embedded.shared.CourseId; +import org.axonframework.extension.multitenancy.messaging.eventhandling.processing.MultiTenantPooledStreamingEventProcessorModule; +import org.axonframework.messaging.commandhandling.configuration.CommandHandlingModule; + +/** + * Configuration for the course notification automation. + */ +public class CourseNotificationConfiguration { + + public static EventSourcingConfigurer configure(EventSourcingConfigurer configurer) { + // Register the automation's state entity + var stateEntity = EventSourcedEntityModule.autodetected( + CourseId.class, + WhenCourseCreatedThenNotify.State.class + ); + configurer.registerEntity(stateEntity); + + // Register the event processor for the automation + var processor = MultiTenantPooledStreamingEventProcessorModule + .create("CourseNotifications") + .eventHandlingComponents(c -> c + .autodetected(cfg -> new WhenCourseCreatedThenNotify()) + ) + .notCustomized(); + + configurer.componentRegistry(cr -> cr.registerModule(processor.build())); + + // Register the command handler for the automation + var commandHandlingModule = CommandHandlingModule + .named("SendCourseCreatedNotificationHandler") + .commandHandlers() + .annotatedCommandHandlingComponent(cfg -> new WhenCourseCreatedThenNotify()) + .build(); + + configurer.registerCommandHandlingModule(commandHandlingModule); + + return configurer; + } +} diff --git a/multitenancy-integration-tests-embedded/src/test/java/org/axonframework/extension/multitenancy/integrationtests/embedded/automation/NotificationService.java b/multitenancy-integration-tests-embedded/src/test/java/org/axonframework/extension/multitenancy/integrationtests/embedded/automation/NotificationService.java new file mode 100644 index 0000000..1f00c53 --- /dev/null +++ b/multitenancy-integration-tests-embedded/src/test/java/org/axonframework/extension/multitenancy/integrationtests/embedded/automation/NotificationService.java @@ -0,0 +1,56 @@ +/* + * Copyright (c) 2010-2025. Axon Framework + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.axonframework.extension.multitenancy.integrationtests.embedded.automation; + +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +import java.util.ArrayList; +import java.util.Collections; +import java.util.List; + +/** + * Simple notification service for testing tenant component isolation. + * Each tenant gets its own instance with isolated notification logs. + */ +public class NotificationService { + + private static final Logger log = LoggerFactory.getLogger(NotificationService.class); + + public record Notification(String recipientId, String message) {} + + private final String tenantId; + private final List sentNotifications = Collections.synchronizedList(new ArrayList<>()); + + public NotificationService(String tenantId) { + this.tenantId = tenantId; + log.info("[TENANT-COMPONENT] NotificationService created for tenant: {}", tenantId); + } + + public void sendNotification(Notification notification) { + log.info("[TENANT-COMPONENT] NotificationService[{}] received notification: {}", + tenantId, notification.message()); + sentNotifications.add(notification); + } + + public List getSentNotifications() { + return new ArrayList<>(sentNotifications); + } + + public String getTenantId() { + return tenantId; + } +} diff --git a/multitenancy-integration-tests-embedded/src/test/java/org/axonframework/extension/multitenancy/integrationtests/embedded/automation/SendCourseCreatedNotification.java b/multitenancy-integration-tests-embedded/src/test/java/org/axonframework/extension/multitenancy/integrationtests/embedded/automation/SendCourseCreatedNotification.java new file mode 100644 index 0000000..ad65831 --- /dev/null +++ b/multitenancy-integration-tests-embedded/src/test/java/org/axonframework/extension/multitenancy/integrationtests/embedded/automation/SendCourseCreatedNotification.java @@ -0,0 +1,27 @@ +/* + * Copyright (c) 2010-2025. Axon Framework + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.axonframework.extension.multitenancy.integrationtests.embedded.automation; + +import org.axonframework.extension.multitenancy.integrationtests.embedded.shared.CourseId; +import org.axonframework.modelling.annotation.TargetEntityId; + +/** + * Command to send a notification about course creation. + */ +public record SendCourseCreatedNotification( + @TargetEntityId CourseId courseId, + String courseName +) {} diff --git a/multitenancy-integration-tests-embedded/src/test/java/org/axonframework/extension/multitenancy/integrationtests/embedded/automation/WhenCourseCreatedThenNotify.java b/multitenancy-integration-tests-embedded/src/test/java/org/axonframework/extension/multitenancy/integrationtests/embedded/automation/WhenCourseCreatedThenNotify.java new file mode 100644 index 0000000..4648bde --- /dev/null +++ b/multitenancy-integration-tests-embedded/src/test/java/org/axonframework/extension/multitenancy/integrationtests/embedded/automation/WhenCourseCreatedThenNotify.java @@ -0,0 +1,126 @@ +/* + * Copyright (c) 2010-2025. Axon Framework + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.axonframework.extension.multitenancy.integrationtests.embedded.automation; + +import org.axonframework.eventsourcing.annotation.EventSourcedEntity; +import org.axonframework.eventsourcing.annotation.EventSourcingHandler; +import org.axonframework.eventsourcing.annotation.reflection.EntityCreator; +import org.axonframework.extension.multitenancy.integrationtests.embedded.event.CourseCreated; +import org.axonframework.extension.multitenancy.integrationtests.embedded.event.CourseCreatedNotificationSent; +import org.axonframework.extension.multitenancy.integrationtests.embedded.shared.CourseId; +import org.axonframework.extension.multitenancy.integrationtests.embedded.shared.CourseTags; +import org.axonframework.messaging.commandhandling.annotation.CommandHandler; +import org.axonframework.messaging.commandhandling.gateway.CommandDispatcher; +import org.axonframework.messaging.core.unitofwork.ProcessingContext; +import org.axonframework.messaging.eventhandling.annotation.EventHandler; +import org.axonframework.messaging.eventhandling.gateway.EventAppender; +import org.axonframework.modelling.StateManager; +import org.axonframework.modelling.annotation.InjectEntity; + +import java.util.concurrent.CompletableFuture; + +/** + * Stateful automation that sends notifications when courses are created. + *

    + * This automation tests that tenant context is properly propagated through: + *

      + *
    • Event handlers receiving tenant-scoped events
      • + *
    • CommandDispatcher propagating tenant context to dispatched commands
      • + *
    • Command handlers receiving tenant-scoped components (NotificationService)
      • + *
    + */ +public class WhenCourseCreatedThenNotify { + + @EventHandler + CompletableFuture react( + CourseCreated event, + CommandDispatcher commandDispatcher, + ProcessingContext context + ) { + var state = context.component(StateManager.class) + .loadEntity(State.class, event.courseId(), context) + .join(); + + return sendNotificationIfNotAlreadySent(event.courseId(), event.name(), state, commandDispatcher); + } + + private CompletableFuture sendNotificationIfNotAlreadySent( + CourseId courseId, + String courseName, + State state, + CommandDispatcher commandDispatcher + ) { + var automationState = state != null ? state : new State(); + + if (automationState.notified()) { + return CompletableFuture.completedFuture(null); + } + + return commandDispatcher.send( + new SendCourseCreatedNotification(courseId, courseName), + Object.class + ); + } + + @CommandHandler + void decide( + SendCourseCreatedNotification command, + @InjectEntity State state, + ProcessingContext context + ) { + var automationState = state != null ? state : new State(); + + if (automationState.notified()) { + return; + } + + // Send notification using tenant-scoped service from context + var notificationService = context.component(NotificationService.class); + var message = String.format("Course '%s' has been created", command.courseName()); + notificationService.sendNotification( + new NotificationService.Notification("admin", message) + ); + + // Record that we've sent the notification + var eventAppender = EventAppender.forContext(context); + eventAppender.append(new CourseCreatedNotificationSent( + command.courseId(), + notificationService.getTenantId() + )); + } + + /** + * State entity tracking whether a notification has been sent for a course. + */ + @EventSourcedEntity(tagKey = CourseTags.COURSE_ID) + public record State(CourseId courseId, boolean notified) { + + @EntityCreator + public State() { + this(null, false); + } + + @EventSourcingHandler + State evolve(CourseCreated event) { + return new State(event.courseId(), this.notified); + } + + @EventSourcingHandler + State evolve(CourseCreatedNotificationSent event) { + return new State(event.courseId(), true); + } + } +} diff --git a/multitenancy-integration-tests-embedded/src/test/java/org/axonframework/extension/multitenancy/integrationtests/embedded/event/CourseCreated.java b/multitenancy-integration-tests-embedded/src/test/java/org/axonframework/extension/multitenancy/integrationtests/embedded/event/CourseCreated.java new file mode 100644 index 0000000..7974772 --- /dev/null +++ b/multitenancy-integration-tests-embedded/src/test/java/org/axonframework/extension/multitenancy/integrationtests/embedded/event/CourseCreated.java @@ -0,0 +1,37 @@ +/* + * Copyright (c) 2010-2025. Axon Framework + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.axonframework.extension.multitenancy.integrationtests.embedded.event; + +import org.axonframework.eventsourcing.annotation.EventTag; +import org.axonframework.extension.multitenancy.integrationtests.embedded.shared.CourseId; +import org.axonframework.extension.multitenancy.integrationtests.embedded.shared.CourseTags; +import org.axonframework.messaging.eventhandling.annotation.Event; + +/** + * Course created event. + * + * @param courseId course ID. + * @param name course name. + * @param capacity course capacity. + */ +@Event(name = "CourseCreated") +public record CourseCreated( + @EventTag(key = CourseTags.COURSE_ID) + CourseId courseId, + String name, + int capacity +) { +} diff --git a/multitenancy-integration-tests-embedded/src/test/java/org/axonframework/extension/multitenancy/integrationtests/embedded/event/CourseCreatedNotificationSent.java b/multitenancy-integration-tests-embedded/src/test/java/org/axonframework/extension/multitenancy/integrationtests/embedded/event/CourseCreatedNotificationSent.java new file mode 100644 index 0000000..6d91bd1 --- /dev/null +++ b/multitenancy-integration-tests-embedded/src/test/java/org/axonframework/extension/multitenancy/integrationtests/embedded/event/CourseCreatedNotificationSent.java @@ -0,0 +1,28 @@ +/* + * Copyright (c) 2010-2025. Axon Framework + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.axonframework.extension.multitenancy.integrationtests.embedded.event; + +import org.axonframework.eventsourcing.annotation.EventTag; +import org.axonframework.extension.multitenancy.integrationtests.embedded.shared.CourseId; +import org.axonframework.extension.multitenancy.integrationtests.embedded.shared.CourseTags; + +/** + * Event indicating that a course creation notification was sent. + */ +public record CourseCreatedNotificationSent( + @EventTag(key = CourseTags.COURSE_ID) CourseId courseId, + String tenantId +) {} diff --git a/multitenancy-integration-tests-embedded/src/test/java/org/axonframework/extension/multitenancy/integrationtests/embedded/read/coursestats/CourseStatsConfiguration.java b/multitenancy-integration-tests-embedded/src/test/java/org/axonframework/extension/multitenancy/integrationtests/embedded/read/coursestats/CourseStatsConfiguration.java new file mode 100644 index 0000000..b184307 --- /dev/null +++ b/multitenancy-integration-tests-embedded/src/test/java/org/axonframework/extension/multitenancy/integrationtests/embedded/read/coursestats/CourseStatsConfiguration.java @@ -0,0 +1,72 @@ +/* + * Copyright (c) 2010-2025. Axon Framework + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.axonframework.extension.multitenancy.integrationtests.embedded.read.coursestats; + +import org.axonframework.eventsourcing.configuration.EventSourcingConfigurer; +import org.axonframework.extension.multitenancy.messaging.eventhandling.processing.MultiTenantPooledStreamingEventProcessorModule; +import org.axonframework.messaging.queryhandling.configuration.QueryHandlingModule; + +/** + * Configuration for course statistics projection and query handlers. + *

    + * Demonstrates two approaches for accessing tenant-scoped components using + * separate event processors: + *

      + *
    1. {@link CoursesStatsProjectorViaInjection} - Direct parameter injection
      2. + *
    2. {@link CoursesStatsProjectorViaContext} - Via {@code ProcessingContext.component()}
      3. + *
    + *

    + * Note: Tenant-scoped repository is registered separately via + * {@code MultiTenancyConfigurer.tenantComponent()} for global access. + */ +public class CourseStatsConfiguration { + + public static final String PROCESSOR_VIA_INJECTION = "Projection_CourseStats_ViaInjection"; + public static final String PROCESSOR_VIA_CONTEXT = "Projection_CourseStats_ViaContext"; + + public static EventSourcingConfigurer configure(EventSourcingConfigurer configurer) { + // Processor 1: Demonstrates direct parameter injection approach + var injectionProcessor = MultiTenantPooledStreamingEventProcessorModule + .create(PROCESSOR_VIA_INJECTION) + .eventHandlingComponents(c -> c + .autodetected(cfg -> new CoursesStatsProjectorViaInjection()) + ) + .notCustomized(); + + // Processor 2: Demonstrates ProcessingContext.component() approach + var contextProcessor = MultiTenantPooledStreamingEventProcessorModule + .create(PROCESSOR_VIA_CONTEXT) + .eventHandlingComponents(c -> c + .autodetected(cfg -> new CoursesStatsProjectorViaContext()) + ) + .notCustomized(); + + // Query handler uses direct parameter injection for tenant-scoped repository + QueryHandlingModule queryModule = QueryHandlingModule.named("Stats-Handler") + .queryHandlers() + .annotatedQueryHandlingComponent(cfg -> new FindAllCoursesQueryHandler()) + .build(); + + return configurer + .componentRegistry(cr -> cr.registerModule(injectionProcessor.build())) + .componentRegistry(cr -> cr.registerModule(contextProcessor.build())) + .registerQueryHandlingModule(queryModule); + } + + private CourseStatsConfiguration() { + // Prevent instantiation + } +} diff --git a/multitenancy-integration-tests-embedded/src/test/java/org/axonframework/extension/multitenancy/integrationtests/embedded/read/coursestats/CourseStatsRepository.java b/multitenancy-integration-tests-embedded/src/test/java/org/axonframework/extension/multitenancy/integrationtests/embedded/read/coursestats/CourseStatsRepository.java new file mode 100644 index 0000000..e686593 --- /dev/null +++ b/multitenancy-integration-tests-embedded/src/test/java/org/axonframework/extension/multitenancy/integrationtests/embedded/read/coursestats/CourseStatsRepository.java @@ -0,0 +1,38 @@ +/* + * Copyright (c) 2010-2025. Axon Framework + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.axonframework.extension.multitenancy.integrationtests.embedded.read.coursestats; + +import org.axonframework.extension.multitenancy.integrationtests.embedded.shared.CourseId; + +import java.util.List; +import java.util.Optional; + +/** + * Repository of course statistics. + */ +public interface CourseStatsRepository { + + CoursesStats save(CoursesStats stats); + + Optional findById(CourseId courseId); + + default CoursesStats findByIdOrThrow(CourseId courseId) { + return findById(courseId).orElseThrow(() -> new RuntimeException( + "Course with ID " + courseId + " does not exist!")); + } + + List findAll(); +} diff --git a/multitenancy-integration-tests-embedded/src/test/java/org/axonframework/extension/multitenancy/integrationtests/embedded/read/coursestats/CoursesStats.java b/multitenancy-integration-tests-embedded/src/test/java/org/axonframework/extension/multitenancy/integrationtests/embedded/read/coursestats/CoursesStats.java new file mode 100644 index 0000000..bcdd86b --- /dev/null +++ b/multitenancy-integration-tests-embedded/src/test/java/org/axonframework/extension/multitenancy/integrationtests/embedded/read/coursestats/CoursesStats.java @@ -0,0 +1,36 @@ +/* + * Copyright (c) 2010-2025. Axon Framework + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.axonframework.extension.multitenancy.integrationtests.embedded.read.coursestats; + +import org.axonframework.extension.multitenancy.integrationtests.embedded.shared.CourseId; + +/** + * Read model representing statistics about a course. + * + * @param courseId course ID. + * @param name name of the course. + * @param capacity capacity of the course. + */ +public record CoursesStats(CourseId courseId, String name, int capacity) { + + public CoursesStats name(String name) { + return new CoursesStats(courseId, name, capacity); + } + + public CoursesStats capacity(int capacity) { + return new CoursesStats(courseId, name, capacity); + } +} diff --git a/multitenancy-integration-tests-embedded/src/test/java/org/axonframework/extension/multitenancy/integrationtests/embedded/read/coursestats/CoursesStatsProjectorViaContext.java b/multitenancy-integration-tests-embedded/src/test/java/org/axonframework/extension/multitenancy/integrationtests/embedded/read/coursestats/CoursesStatsProjectorViaContext.java new file mode 100644 index 0000000..1bd98cd --- /dev/null +++ b/multitenancy-integration-tests-embedded/src/test/java/org/axonframework/extension/multitenancy/integrationtests/embedded/read/coursestats/CoursesStatsProjectorViaContext.java @@ -0,0 +1,71 @@ +/* + * Copyright (c) 2010-2025. Axon Framework + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.axonframework.extension.multitenancy.integrationtests.embedded.read.coursestats; + +import org.axonframework.extension.multitenancy.integrationtests.embedded.event.CourseCreated; +import org.axonframework.messaging.core.unitofwork.ProcessingContext; +import org.axonframework.messaging.eventhandling.annotation.EventHandler; +import org.axonframework.messaging.eventhandling.annotation.SequencingPolicy; +import org.axonframework.messaging.eventhandling.sequencing.PropertySequencingPolicy; +import org.axonframework.messaging.queryhandling.QueryUpdateEmitter; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +import java.util.List; + +/** + * Event handler that demonstrates accessing tenant-scoped components via + * {@link ProcessingContext#component(Class)}. + *

    + * This approach is useful when you need to access multiple tenant-scoped components + * or when the component type isn't known at compile time. + *

    + * Example: + * 

    {@code
+ * @EventHandler
+ * void handle(SomeEvent event, ProcessingContext context) {
+ *     MyRepository repo = context.component(MyRepository.class);
+ *     repo.save(...);
+ * }
+ * }
    + * + * @see CoursesStatsProjectorViaInjection for the direct injection approach + */ +@SequencingPolicy(type = PropertySequencingPolicy.class, parameters = {"courseId"}) +class CoursesStatsProjectorViaContext { + + private static final Logger logger = LoggerFactory.getLogger(CoursesStatsProjectorViaContext.class); + + @EventHandler + void handle(CourseCreated event, ProcessingContext context, QueryUpdateEmitter emitter) { + // Get tenant-scoped repository via ProcessingContext.component() + CourseStatsRepository repository = context.component(CourseStatsRepository.class); + + var stats = new CoursesStats( + event.courseId(), + event.name(), + event.capacity() + ); + repository.save(stats); + logger.info("[VIA-CONTEXT] Saved course: {}", event.courseId()); + + emitter.emit( + FindAllCourses.class, + q -> true, + new FindAllCourses.Result(List.of(stats)) + ); + } +} diff --git a/multitenancy-integration-tests-embedded/src/test/java/org/axonframework/extension/multitenancy/integrationtests/embedded/read/coursestats/CoursesStatsProjectorViaInjection.java b/multitenancy-integration-tests-embedded/src/test/java/org/axonframework/extension/multitenancy/integrationtests/embedded/read/coursestats/CoursesStatsProjectorViaInjection.java new file mode 100644 index 0000000..cfc8121 --- /dev/null +++ b/multitenancy-integration-tests-embedded/src/test/java/org/axonframework/extension/multitenancy/integrationtests/embedded/read/coursestats/CoursesStatsProjectorViaInjection.java @@ -0,0 +1,58 @@ +/* + * Copyright (c) 2010-2025. Axon Framework + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.axonframework.extension.multitenancy.integrationtests.embedded.read.coursestats; + +import org.axonframework.extension.multitenancy.integrationtests.embedded.event.CourseCreated; +import org.axonframework.messaging.eventhandling.annotation.EventHandler; +import org.axonframework.messaging.eventhandling.annotation.SequencingPolicy; +import org.axonframework.messaging.eventhandling.sequencing.PropertySequencingPolicy; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +/** + * Event handler that demonstrates accessing tenant-scoped components via + * direct parameter injection. + *

    + * This approach is the most concise when you know the component type at compile time + * and only need a single tenant-scoped component. + *

    + * Example: + * 

    {@code
+ * @EventHandler
+ * void handle(SomeEvent event, MyRepository repository) {
+ *     repository.save(...);
+ * }
+ * }
    + * + * @see CoursesStatsProjectorViaContext for the ProcessingContext approach + */ +@SequencingPolicy(type = PropertySequencingPolicy.class, parameters = {"courseId"}) +class CoursesStatsProjectorViaInjection { + + private static final Logger logger = LoggerFactory.getLogger(CoursesStatsProjectorViaInjection.class); + + @EventHandler + void handle(CourseCreated event, CourseStatsRepository repository) { + // Repository is injected directly as a parameter - tenant is resolved automatically + var stats = new CoursesStats( + event.courseId(), + event.name(), + event.capacity() + ); + repository.save(stats); + logger.info("[VIA-INJECTION] Saved course: {}", event.courseId()); + } +} diff --git a/multitenancy-integration-tests-embedded/src/test/java/org/axonframework/extension/multitenancy/integrationtests/embedded/read/coursestats/FindAllCourses.java b/multitenancy-integration-tests-embedded/src/test/java/org/axonframework/extension/multitenancy/integrationtests/embedded/read/coursestats/FindAllCourses.java new file mode 100644 index 0000000..5f2a790 --- /dev/null +++ b/multitenancy-integration-tests-embedded/src/test/java/org/axonframework/extension/multitenancy/integrationtests/embedded/read/coursestats/FindAllCourses.java @@ -0,0 +1,32 @@ +/* + * Copyright (c) 2010-2025. Axon Framework + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.axonframework.extension.multitenancy.integrationtests.embedded.read.coursestats; + +import java.util.List; + +/** + * Query to find all courses. + */ +public record FindAllCourses() { + + /** + * Result containing all courses. + * + * @param courses the list of course stats. + */ + public record Result(List courses) { + } +} diff --git a/multitenancy-integration-tests-embedded/src/test/java/org/axonframework/extension/multitenancy/integrationtests/embedded/read/coursestats/FindAllCoursesQueryHandler.java b/multitenancy-integration-tests-embedded/src/test/java/org/axonframework/extension/multitenancy/integrationtests/embedded/read/coursestats/FindAllCoursesQueryHandler.java new file mode 100644 index 0000000..323b19e --- /dev/null +++ b/multitenancy-integration-tests-embedded/src/test/java/org/axonframework/extension/multitenancy/integrationtests/embedded/read/coursestats/FindAllCoursesQueryHandler.java @@ -0,0 +1,32 @@ +/* + * Copyright (c) 2010-2025. Axon Framework + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.axonframework.extension.multitenancy.integrationtests.embedded.read.coursestats; + +import org.axonframework.messaging.queryhandling.annotation.QueryHandler; + +/** + * Query handler for finding all courses. + *

    + * Uses parameter injection to receive the tenant-scoped repository. + * The repository is resolved based on the query's tenant context. + */ +public class FindAllCoursesQueryHandler { + + @QueryHandler + FindAllCourses.Result handle(FindAllCourses query, CourseStatsRepository repository) { + return new FindAllCourses.Result(repository.findAll()); + } +} diff --git a/multitenancy-integration-tests-embedded/src/test/java/org/axonframework/extension/multitenancy/integrationtests/embedded/read/coursestats/InMemoryCourseStatsRepository.java b/multitenancy-integration-tests-embedded/src/test/java/org/axonframework/extension/multitenancy/integrationtests/embedded/read/coursestats/InMemoryCourseStatsRepository.java new file mode 100644 index 0000000..59c7d09 --- /dev/null +++ b/multitenancy-integration-tests-embedded/src/test/java/org/axonframework/extension/multitenancy/integrationtests/embedded/read/coursestats/InMemoryCourseStatsRepository.java @@ -0,0 +1,46 @@ +/* + * Copyright (c) 2010-2025. Axon Framework + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.axonframework.extension.multitenancy.integrationtests.embedded.read.coursestats; + +import org.axonframework.extension.multitenancy.integrationtests.embedded.shared.CourseId; + +import java.util.List; +import java.util.Optional; +import java.util.concurrent.ConcurrentHashMap; + +/** + * In-memory implementation of the course statistics repository. + */ +public class InMemoryCourseStatsRepository implements CourseStatsRepository { + + private final ConcurrentHashMap stats = new ConcurrentHashMap<>(); + + @Override + public CoursesStats save(CoursesStats stats) { + this.stats.put(stats.courseId(), stats); + return stats; + } + + @Override + public Optional findById(CourseId courseId) { + return Optional.ofNullable(stats.get(courseId)); + } + + @Override + public List findAll() { + return stats.values().stream().toList(); + } +} diff --git a/multitenancy-integration-tests-embedded/src/test/java/org/axonframework/extension/multitenancy/integrationtests/embedded/shared/CourseId.java b/multitenancy-integration-tests-embedded/src/test/java/org/axonframework/extension/multitenancy/integrationtests/embedded/shared/CourseId.java new file mode 100644 index 0000000..be6bcae --- /dev/null +++ b/multitenancy-integration-tests-embedded/src/test/java/org/axonframework/extension/multitenancy/integrationtests/embedded/shared/CourseId.java @@ -0,0 +1,54 @@ +/* + * Copyright (c) 2010-2025. Axon Framework + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.axonframework.extension.multitenancy.integrationtests.embedded.shared; + +import jakarta.validation.constraints.NotNull; + +import java.util.UUID; + +/** + * Course ID value object. + * + * @param raw raw string ID representation. + */ +public record CourseId(@NotNull String raw) { + + private final static String ENTITY_TYPE = "Course"; + + public CourseId { + if (raw == null || raw.isBlank()) { + throw new IllegalArgumentException("Course ID cannot be null or empty"); + } + raw = withType(raw); + } + + public static CourseId of(String raw) { + return new CourseId(raw); + } + + public static CourseId random() { + return new CourseId(UUID.randomUUID().toString()); + } + + @Override + public String toString() { + return raw; + } + + private static String withType(String id) { + return id.startsWith(ENTITY_TYPE + ":") ? id : ENTITY_TYPE + ":" + id; + } +} diff --git a/multitenancy-integration-tests-embedded/src/test/java/org/axonframework/extension/multitenancy/integrationtests/embedded/shared/CourseTags.java b/multitenancy-integration-tests-embedded/src/test/java/org/axonframework/extension/multitenancy/integrationtests/embedded/shared/CourseTags.java new file mode 100644 index 0000000..65bea81 --- /dev/null +++ b/multitenancy-integration-tests-embedded/src/test/java/org/axonframework/extension/multitenancy/integrationtests/embedded/shared/CourseTags.java @@ -0,0 +1,28 @@ +/* + * Copyright (c) 2010-2025. Axon Framework + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.axonframework.extension.multitenancy.integrationtests.embedded.shared; + +/** + * Event tags for course-related events. + */ +public class CourseTags { + + public static final String COURSE_ID = "courseId"; + + private CourseTags() { + // Prevent instantiation + } +} diff --git a/multitenancy-integration-tests-embedded/src/test/java/org/axonframework/extension/multitenancy/integrationtests/embedded/write/createcourse/CourseCreation.java b/multitenancy-integration-tests-embedded/src/test/java/org/axonframework/extension/multitenancy/integrationtests/embedded/write/createcourse/CourseCreation.java new file mode 100644 index 0000000..9810484 --- /dev/null +++ b/multitenancy-integration-tests-embedded/src/test/java/org/axonframework/extension/multitenancy/integrationtests/embedded/write/createcourse/CourseCreation.java @@ -0,0 +1,59 @@ +/* + * Copyright (c) 2010-2025. Axon Framework + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.axonframework.extension.multitenancy.integrationtests.embedded.write.createcourse; + +import jakarta.validation.Valid; +import org.axonframework.eventsourcing.annotation.EventSourcedEntity; +import org.axonframework.eventsourcing.annotation.EventSourcingHandler; +import org.axonframework.eventsourcing.annotation.reflection.EntityCreator; +import org.axonframework.extension.multitenancy.integrationtests.embedded.event.CourseCreated; +import org.axonframework.extension.multitenancy.integrationtests.embedded.shared.CourseId; +import org.axonframework.extension.multitenancy.integrationtests.embedded.shared.CourseTags; +import org.axonframework.messaging.commandhandling.annotation.CommandHandler; +import org.axonframework.messaging.eventhandling.gateway.EventAppender; + +/** + * Entity for course creation with internal command handler. + */ +@EventSourcedEntity(tagKey = CourseTags.COURSE_ID) +public class CourseCreation { + + private boolean created = false; + private CourseId id; + private int capacity; + + @CommandHandler + public static void handle(@Valid CreateCourse command, EventAppender appender) { + appender.append( + new CourseCreated( + command.courseId(), + command.name(), + command.capacity() + ) + ); + } + + @EntityCreator + public CourseCreation() { + } + + @EventSourcingHandler + public void evolve(CourseCreated courseCreated) { + this.id = courseCreated.courseId(); + this.created = true; + this.capacity = courseCreated.capacity(); + } +} diff --git a/multitenancy-integration-tests-embedded/src/test/java/org/axonframework/extension/multitenancy/integrationtests/embedded/write/createcourse/CreateCourse.java b/multitenancy-integration-tests-embedded/src/test/java/org/axonframework/extension/multitenancy/integrationtests/embedded/write/createcourse/CreateCourse.java new file mode 100644 index 0000000..354bbd1 --- /dev/null +++ b/multitenancy-integration-tests-embedded/src/test/java/org/axonframework/extension/multitenancy/integrationtests/embedded/write/createcourse/CreateCourse.java @@ -0,0 +1,44 @@ +/* + * Copyright (c) 2010-2025. Axon Framework + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.axonframework.extension.multitenancy.integrationtests.embedded.write.createcourse; + +import jakarta.validation.Valid; +import jakarta.validation.constraints.Min; +import jakarta.validation.constraints.NotEmpty; +import jakarta.validation.constraints.NotNull; +import jakarta.validation.constraints.Size; +import org.axonframework.extension.multitenancy.integrationtests.embedded.shared.CourseId; +import org.axonframework.modelling.annotation.TargetEntityId; + +/** + * Command to create a new course. + * + * @param courseId course ID. + * @param name course name. + * @param capacity course capacity. + */ +public record CreateCourse( + @Valid + @NotNull + @TargetEntityId + CourseId courseId, + @NotEmpty + @Size(min = 10) + String name, + @Min(value = 1, message = "Capacity must be a positive integer") + int capacity +) { +} diff --git a/multitenancy-integration-tests-embedded/src/test/java/org/axonframework/extension/multitenancy/integrationtests/embedded/write/createcourse/CreateCourseConfiguration.java b/multitenancy-integration-tests-embedded/src/test/java/org/axonframework/extension/multitenancy/integrationtests/embedded/write/createcourse/CreateCourseConfiguration.java new file mode 100644 index 0000000..2eae101 --- /dev/null +++ b/multitenancy-integration-tests-embedded/src/test/java/org/axonframework/extension/multitenancy/integrationtests/embedded/write/createcourse/CreateCourseConfiguration.java @@ -0,0 +1,37 @@ +/* + * Copyright (c) 2010-2025. Axon Framework + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.axonframework.extension.multitenancy.integrationtests.embedded.write.createcourse; + +import org.axonframework.eventsourcing.configuration.EventSourcedEntityModule; +import org.axonframework.eventsourcing.configuration.EventSourcingConfigurer; +import org.axonframework.extension.multitenancy.integrationtests.embedded.shared.CourseId; + +/** + * Configuration for the CreateCourse command handler. + */ +public class CreateCourseConfiguration { + + public static EventSourcingConfigurer configure(EventSourcingConfigurer configurer) { + var stateEntity = EventSourcedEntityModule + .autodetected(CourseId.class, CourseCreation.class); + + return configurer.registerEntity(stateEntity); + } + + private CreateCourseConfiguration() { + // Prevent instantiation + } +} diff --git a/multitenancy-integration-tests-embedded/src/test/resources/log4j2.properties b/multitenancy-integration-tests-embedded/src/test/resources/log4j2.properties new file mode 100644 index 0000000..2a217e4 --- /dev/null +++ b/multitenancy-integration-tests-embedded/src/test/resources/log4j2.properties @@ -0,0 +1,19 @@ +# Log4j2 configuration for integration tests +status = warn +name = MultitenancyEmbeddedTestConfig + +appender.console.type = Console +appender.console.name = Console +appender.console.layout.type = PatternLayout +appender.console.layout.pattern = %d{HH:mm:ss.SSS} [%t] %-5level %-30.30logger{1.} [%X] - %msg%n + +rootLogger.level = info +rootLogger.appenderRef.console.ref = Console + +# Reduce noise from Axon Framework internals +logger.axon.name = org.axonframework +logger.axon.level = info + +# Show multi-tenancy debug info +logger.multitenancy.name = org.axonframework.extensions.multitenancy +logger.multitenancy.level = debug diff --git a/multitenancy-integration-tests-springboot-axonserver/pom.xml b/multitenancy-integration-tests-springboot-axonserver/pom.xml new file mode 100644 index 0000000..87d708f --- /dev/null +++ b/multitenancy-integration-tests-springboot-axonserver/pom.xml @@ -0,0 +1,207 @@ + + + + + 4.0.0 + + + org.axonframework.extensions.multitenancy + axon-multitenancy-parent + 5.1.0-SNAPSHOT + + + axon-multitenancy-integration-tests-springboot-axonserver + Axon Framework Multi-Tenancy Extension - Spring Boot Axon Server Integration Tests + + Spring Boot integration tests for multi-tenancy with Axon Server using Testcontainers. + Tests verify that multi-tenant infrastructure works correctly through Spring Boot autoconfiguration. + Note: Without Axon Server license, only 'default' context is available. + + + + 4.2.2 + 3.27.3 + 2.0.3 + 2.3.232 + + 3.1.0 + + + + + + org.axonframework.extensions.multitenancy + axon-multitenancy-spring-boot-starter + ${project.version} + test + + + + org.axonframework.extensions.multitenancy + axon-multitenancy-spring + ${project.version} + test + + + + + org.axonframework.extensions.multitenancy + axon-multitenancy-axon-server-connector + ${project.version} + test + + + + + org.axonframework + axon-eventsourcing + test + + + org.axonframework + axon-modelling + ${axon.version} + test + + + org.axonframework + axon-messaging + test + + + + + org.axonframework + axon-server-connector + test + + + + + org.axonframework + axon-test + ${axon.version} + test + + + + + org.springframework.boot + spring-boot-starter + ${spring.boot.version} + test + + + org.springframework.boot + spring-boot-starter-data-jpa + ${spring.boot.version} + test + + + org.springframework.boot + spring-boot-starter-test + ${spring.boot.version} + test + + + + + com.h2database + h2 + ${h2.version} + test + + + + + org.testcontainers + testcontainers-junit-jupiter + ${testcontainers.version} + test + + + + + org.junit.jupiter + junit-jupiter + test + + + + + org.assertj + assertj-core + ${assertj.version} + test + + + org.awaitility + awaitility + ${awaitility.version} + test + + + + + jakarta.validation + jakarta.validation-api + 3.1.0 + test + + + + + org.slf4j + slf4j-api + ${slf4j.version} + test + + + ch.qos.logback + logback-classic + 1.5.15 + test + + + + + + + org.apache.maven.plugins + maven-surefire-plugin + + + **/*IT.java + **/*Test.java + + -Daxon.axonserver.suppressDownloadMessage=true + + + + + org.apache.maven.plugins + maven-deploy-plugin + 3.1.3 + + true + + + + + diff --git a/multitenancy-integration-tests-springboot-axonserver/src/test/java/org/axonframework/extension/multitenancy/integrationtests/springboot/axonserver/SpringBootAxonServerMultiTenantIT.java b/multitenancy-integration-tests-springboot-axonserver/src/test/java/org/axonframework/extension/multitenancy/integrationtests/springboot/axonserver/SpringBootAxonServerMultiTenantIT.java new file mode 100644 index 0000000..0afabd4 --- /dev/null +++ b/multitenancy-integration-tests-springboot-axonserver/src/test/java/org/axonframework/extension/multitenancy/integrationtests/springboot/axonserver/SpringBootAxonServerMultiTenantIT.java @@ -0,0 +1,159 @@ +/* + * Copyright (c) 2010-2025. Axon Framework + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.axonframework.extension.multitenancy.integrationtests.springboot.axonserver; + +import org.awaitility.Awaitility; +import org.axonframework.extension.multitenancy.core.NoSuchTenantException; +import org.axonframework.extension.multitenancy.core.TenantDescriptor; +import org.axonframework.extension.multitenancy.integrationtests.springboot.axonserver.domain.read.coursestats.CourseStatsReadModel; +import org.axonframework.extension.multitenancy.integrationtests.springboot.axonserver.domain.read.coursestats.FindAllCourses; +import org.axonframework.extension.multitenancy.integrationtests.springboot.axonserver.domain.shared.CourseId; +import org.axonframework.extension.multitenancy.integrationtests.springboot.axonserver.domain.write.createcourse.CreateCourse; +import org.axonframework.messaging.commandhandling.gateway.CommandGateway; +import org.axonframework.messaging.core.MessageType; +import org.axonframework.messaging.core.Metadata; +import org.axonframework.messaging.queryhandling.GenericQueryMessage; +import org.axonframework.messaging.queryhandling.QueryMessage; +import org.axonframework.messaging.queryhandling.gateway.QueryGateway; +import org.axonframework.test.server.AxonServerContainer; +import org.junit.jupiter.api.Test; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.boot.test.context.SpringBootTest; +import org.springframework.test.context.DynamicPropertyRegistry; +import org.springframework.test.context.DynamicPropertySource; +import org.testcontainers.junit.jupiter.Container; +import org.testcontainers.junit.jupiter.Testcontainers; + +import java.time.Duration; +import java.util.List; + +import static org.assertj.core.api.Assertions.assertThat; +import static org.assertj.core.api.Assertions.assertThatThrownBy; +import static org.axonframework.extension.multitenancy.integrationtests.springboot.axonserver.config.TestMultiTenancyConfiguration.DEFAULT_TENANT; +import static org.junit.jupiter.api.Assertions.assertDoesNotThrow; + +/** + * Spring Boot integration tests verifying multi-tenant infrastructure with Axon Server. + *

    + * Important: Without an Axon Server license, only the {@code default} context is available. + * These tests verify the full command → event → projection → query flow works through the + * multi-tenant infrastructure connected to Axon Server with Spring Boot autoconfiguration. + * + * @author Theo Emanuelsson + * @since 5.0.0 + */ +@SpringBootTest(classes = TestApplication.class) +@Testcontainers +class SpringBootAxonServerMultiTenantIT { + + private static final String AXON_SERVER_IMAGE = "docker.axoniq.io/axoniq/axonserver:2025.2.0"; + + @Container + static final AxonServerContainer axonServer = new AxonServerContainer(AXON_SERVER_IMAGE) + .withDevMode(true) + .withDcbContext(true) + .withReuse(true); + + @DynamicPropertySource + static void axonServerProperties(DynamicPropertyRegistry registry) { + registry.add("axon.axonserver.servers", axonServer::getAxonServerAddress); + } + + @Autowired + private CommandGateway commandGateway; + + @Autowired + private QueryGateway queryGateway; + + private void createCourseForTenant(TenantDescriptor tenant, CourseId courseId, String name, int capacity) { + commandGateway.send( + new CreateCourse(courseId, name, capacity), + Metadata.with("tenantId", tenant.tenantId()), + null + ).getResultMessage().join(); + } + + private List queryCoursesForTenant(TenantDescriptor tenant) { + QueryMessage query = new GenericQueryMessage( + new MessageType(FindAllCourses.class), new FindAllCourses() + ).andMetadata(Metadata.with("tenantId", tenant.tenantId())); + return queryGateway.query(query, FindAllCourses.Result.class) + .thenApply(FindAllCourses.Result::courses).join(); + } + + @Test + void commandCreatesEventWhichUpdatesProjection() { + CourseId courseId = CourseId.random(); + String courseName = "Test Course " + System.currentTimeMillis(); + + // Send command + assertDoesNotThrow(() -> + createCourseForTenant(DEFAULT_TENANT, courseId, courseName, 50) + ); + + // Wait for projection to process and verify + Awaitility.await() + .atMost(Duration.ofSeconds(10)) + .until(() -> queryCoursesForTenant(DEFAULT_TENANT).stream() + .anyMatch(c -> c.getCourseId().equals(courseId.raw()))); + + List courses = queryCoursesForTenant(DEFAULT_TENANT); + assertThat(courses) + .anyMatch(c -> c.getCourseId().equals(courseId.raw()) && c.getName().equals(courseName)); + } + + @Test + void multipleCoursesCanBeCreatedAndQueried() { + CourseId course1 = CourseId.random(); + CourseId course2 = CourseId.random(); + String name1 = "Course One " + System.currentTimeMillis(); + String name2 = "Course Two " + System.currentTimeMillis(); + + createCourseForTenant(DEFAULT_TENANT, course1, name1, 30); + createCourseForTenant(DEFAULT_TENANT, course2, name2, 25); + + Awaitility.await() + .atMost(Duration.ofSeconds(10)) + .until(() -> { + List courses = queryCoursesForTenant(DEFAULT_TENANT); + return courses.stream().anyMatch(c -> c.getCourseId().equals(course1.raw())) + && courses.stream().anyMatch(c -> c.getCourseId().equals(course2.raw())); + }); + + List courses = queryCoursesForTenant(DEFAULT_TENANT); + assertThat(courses).anyMatch(c -> c.getCourseId().equals(course1.raw()) && c.getName().equals(name1)); + assertThat(courses).anyMatch(c -> c.getCourseId().equals(course2.raw()) && c.getName().equals(name2)); + } + + @Test + void commandToNonExistentTenantFails() { + TenantDescriptor nonExistentTenant = TenantDescriptor.tenantWithId("non-existent"); + CourseId courseId = CourseId.random(); + + assertThatThrownBy(() -> + createCourseForTenant(nonExistentTenant, courseId, "Should Fail", 10) + ).hasCauseInstanceOf(NoSuchTenantException.class); + } + + @Test + void commandWithoutTenantMetadataFails() { + CourseId courseId = CourseId.random(); + CreateCourse command = new CreateCourse(courseId, "Test Course without Tenant", 10); + + assertThatThrownBy(() -> commandGateway.sendAndWait(command)) + .isInstanceOf(NoSuchTenantException.class); + } +} diff --git a/multitenancy-integration-tests-springboot-axonserver/src/test/java/org/axonframework/extension/multitenancy/integrationtests/springboot/axonserver/TestApplication.java b/multitenancy-integration-tests-springboot-axonserver/src/test/java/org/axonframework/extension/multitenancy/integrationtests/springboot/axonserver/TestApplication.java new file mode 100644 index 0000000..d43f97b --- /dev/null +++ b/multitenancy-integration-tests-springboot-axonserver/src/test/java/org/axonframework/extension/multitenancy/integrationtests/springboot/axonserver/TestApplication.java @@ -0,0 +1,25 @@ +/* + * Copyright (c) 2010-2025. Axon Framework + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.axonframework.extension.multitenancy.integrationtests.springboot.axonserver; + +import org.springframework.boot.autoconfigure.SpringBootApplication; + +/** + * Spring Boot test application for Axon Server multi-tenancy integration tests. + */ +@SpringBootApplication +public class TestApplication { +} diff --git a/multitenancy-integration-tests-springboot-axonserver/src/test/java/org/axonframework/extension/multitenancy/integrationtests/springboot/axonserver/config/TestMultiTenancyConfiguration.java b/multitenancy-integration-tests-springboot-axonserver/src/test/java/org/axonframework/extension/multitenancy/integrationtests/springboot/axonserver/config/TestMultiTenancyConfiguration.java new file mode 100644 index 0000000..23c7284 --- /dev/null +++ b/multitenancy-integration-tests-springboot-axonserver/src/test/java/org/axonframework/extension/multitenancy/integrationtests/springboot/axonserver/config/TestMultiTenancyConfiguration.java @@ -0,0 +1,67 @@ +/* + * Copyright (c) 2010-2025. Axon Framework + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.axonframework.extension.multitenancy.integrationtests.springboot.axonserver.config; + +import org.axonframework.extension.multitenancy.core.TenantDescriptor; +import org.axonframework.extension.multitenancy.spring.data.jpa.TenantDataSourceProvider; +import org.axonframework.extension.multitenancy.spring.data.jpa.TenantEntityManagerFactoryBuilder; +import org.springframework.boot.jdbc.DataSourceBuilder; +import org.springframework.context.annotation.Bean; +import org.springframework.context.annotation.Configuration; + +import java.util.Map; +import java.util.concurrent.ConcurrentHashMap; +import javax.sql.DataSource; + +/** + * Configuration for multi-tenancy tests with Axon Server. + *

    + * Note: Without Axon Server license, only the 'default' context is available. + * The tenant provider is discovered automatically from Axon Server contexts. + */ +@Configuration +public class TestMultiTenancyConfiguration { + + public static final TenantDescriptor DEFAULT_TENANT = TenantDescriptor.tenantWithId("default"); + + @Bean + public TenantDataSourceProvider tenantDataSourceProvider() { + Map cache = new ConcurrentHashMap<>(); + return tenant -> cache.computeIfAbsent(tenant.tenantId(), id -> + DataSourceBuilder.create() + .url("jdbc:h2:mem:" + id + ";DB_CLOSE_DELAY=-1;MODE=PostgreSQL") + .driverClassName("org.h2.Driver") + .username("sa") + .password("") + .build() + ); + } + + /** + * Configures the TenantEntityManagerFactoryBuilder with entity packages and DDL auto. + * This ensures tenant databases have the schema created and entity classes are scanned. + */ + @Bean + public TenantEntityManagerFactoryBuilder tenantEntityManagerFactoryBuilder( + TenantDataSourceProvider dataSourceProvider) { + return TenantEntityManagerFactoryBuilder + .forDataSourceProvider(dataSourceProvider) + .packagesToScan("org.axonframework.extensions.multitenancy.integrationtests.springboot.axonserver.domain.read.coursestats") + .jpaProperty("hibernate.hbm2ddl.auto", "create-drop") + .jpaProperty("hibernate.show_sql", "true") + .build(); + } +} diff --git a/multitenancy-integration-tests-springboot-axonserver/src/test/java/org/axonframework/extension/multitenancy/integrationtests/springboot/axonserver/domain/event/CourseCreated.java b/multitenancy-integration-tests-springboot-axonserver/src/test/java/org/axonframework/extension/multitenancy/integrationtests/springboot/axonserver/domain/event/CourseCreated.java new file mode 100644 index 0000000..8d6d131 --- /dev/null +++ b/multitenancy-integration-tests-springboot-axonserver/src/test/java/org/axonframework/extension/multitenancy/integrationtests/springboot/axonserver/domain/event/CourseCreated.java @@ -0,0 +1,37 @@ +/* + * Copyright (c) 2010-2025. Axon Framework + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.axonframework.extension.multitenancy.integrationtests.springboot.axonserver.domain.event; + +import org.axonframework.eventsourcing.annotation.EventTag; +import org.axonframework.extension.multitenancy.integrationtests.springboot.axonserver.domain.shared.CourseId; +import org.axonframework.extension.multitenancy.integrationtests.springboot.axonserver.domain.shared.CourseTags; +import org.axonframework.messaging.eventhandling.annotation.Event; + +/** + * Course created event. + * + * @param courseId course ID. + * @param name course name. + * @param capacity course capacity. + */ +@Event(name = "CourseCreated") +public record CourseCreated( + @EventTag(key = CourseTags.COURSE_ID) + CourseId courseId, + String name, + int capacity +) { +} diff --git a/multitenancy-integration-tests-springboot-axonserver/src/test/java/org/axonframework/extension/multitenancy/integrationtests/springboot/axonserver/domain/read/coursestats/CourseStatsJpaRepository.java b/multitenancy-integration-tests-springboot-axonserver/src/test/java/org/axonframework/extension/multitenancy/integrationtests/springboot/axonserver/domain/read/coursestats/CourseStatsJpaRepository.java new file mode 100644 index 0000000..9738cee --- /dev/null +++ b/multitenancy-integration-tests-springboot-axonserver/src/test/java/org/axonframework/extension/multitenancy/integrationtests/springboot/axonserver/domain/read/coursestats/CourseStatsJpaRepository.java @@ -0,0 +1,32 @@ +/* + * Copyright (c) 2010-2025. Axon Framework + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.axonframework.extension.multitenancy.integrationtests.springboot.axonserver.domain.read.coursestats; + +import org.springframework.data.jpa.repository.JpaRepository; + +/** + * Spring Data JPA repository for course statistics. + *

    + * When {@code axon.multi-tenancy.jpa.tenant-repositories=true}, this repository + * is automatically discovered and registered as a tenant component. No special + * annotations are required - just extend {@link JpaRepository} (or any Spring Data + * repository interface). + *

    + * When injected into event/query handlers, this repository is automatically + * scoped to the tenant from the message's metadata. + */ +public interface CourseStatsJpaRepository extends JpaRepository { +} diff --git a/multitenancy-integration-tests-springboot-axonserver/src/test/java/org/axonframework/extension/multitenancy/integrationtests/springboot/axonserver/domain/read/coursestats/CourseStatsProjector.java b/multitenancy-integration-tests-springboot-axonserver/src/test/java/org/axonframework/extension/multitenancy/integrationtests/springboot/axonserver/domain/read/coursestats/CourseStatsProjector.java new file mode 100644 index 0000000..160a29d --- /dev/null +++ b/multitenancy-integration-tests-springboot-axonserver/src/test/java/org/axonframework/extension/multitenancy/integrationtests/springboot/axonserver/domain/read/coursestats/CourseStatsProjector.java @@ -0,0 +1,42 @@ +/* + * Copyright (c) 2010-2025. Axon Framework + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.axonframework.extension.multitenancy.integrationtests.springboot.axonserver.domain.read.coursestats; + +import org.axonframework.extension.multitenancy.integrationtests.springboot.axonserver.domain.event.CourseCreated; +import org.axonframework.messaging.eventhandling.annotation.EventHandler; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; +import org.springframework.stereotype.Component; + +/** + * Event handler that projects course events to the JPA repository. + * The repository parameter is automatically scoped to the tenant from the event's metadata. + */ +@Component +public class CourseStatsProjector { + + private static final Logger logger = LoggerFactory.getLogger(CourseStatsProjector.class); + + @EventHandler + public void on(CourseCreated event, CourseStatsJpaRepository repository) { + logger.info("Processing CourseCreated event for course: {}", event.courseId()); + repository.save(new CourseStatsReadModel( + event.courseId().raw(), + event.name(), + event.capacity() + )); + } +} diff --git a/multitenancy-integration-tests-springboot-axonserver/src/test/java/org/axonframework/extension/multitenancy/integrationtests/springboot/axonserver/domain/read/coursestats/CourseStatsReadModel.java b/multitenancy-integration-tests-springboot-axonserver/src/test/java/org/axonframework/extension/multitenancy/integrationtests/springboot/axonserver/domain/read/coursestats/CourseStatsReadModel.java new file mode 100644 index 0000000..6036971 --- /dev/null +++ b/multitenancy-integration-tests-springboot-axonserver/src/test/java/org/axonframework/extension/multitenancy/integrationtests/springboot/axonserver/domain/read/coursestats/CourseStatsReadModel.java @@ -0,0 +1,67 @@ +/* + * Copyright (c) 2010-2025. Axon Framework + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.axonframework.extension.multitenancy.integrationtests.springboot.axonserver.domain.read.coursestats; + +import jakarta.persistence.Entity; +import jakarta.persistence.Id; +import jakarta.persistence.Table; + +/** + * JPA entity representing course statistics in the read model. + */ +@Entity +@Table(name = "course_stats") +public class CourseStatsReadModel { + + @Id + private String courseId; + private String name; + private int capacity; + + public CourseStatsReadModel() { + // Required by JPA + } + + public CourseStatsReadModel(String courseId, String name, int capacity) { + this.courseId = courseId; + this.name = name; + this.capacity = capacity; + } + + public String getCourseId() { + return courseId; + } + + public void setCourseId(String courseId) { + this.courseId = courseId; + } + + public String getName() { + return name; + } + + public void setName(String name) { + this.name = name; + } + + public int getCapacity() { + return capacity; + } + + public void setCapacity(int capacity) { + this.capacity = capacity; + } +} diff --git a/multitenancy-integration-tests-springboot-axonserver/src/test/java/org/axonframework/extension/multitenancy/integrationtests/springboot/axonserver/domain/read/coursestats/FindAllCourses.java b/multitenancy-integration-tests-springboot-axonserver/src/test/java/org/axonframework/extension/multitenancy/integrationtests/springboot/axonserver/domain/read/coursestats/FindAllCourses.java new file mode 100644 index 0000000..e0f75aa --- /dev/null +++ b/multitenancy-integration-tests-springboot-axonserver/src/test/java/org/axonframework/extension/multitenancy/integrationtests/springboot/axonserver/domain/read/coursestats/FindAllCourses.java @@ -0,0 +1,32 @@ +/* + * Copyright (c) 2010-2025. Axon Framework + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.axonframework.extension.multitenancy.integrationtests.springboot.axonserver.domain.read.coursestats; + +import java.util.List; + +/** + * Query to find all courses for a tenant. + */ +public record FindAllCourses() { + + /** + * Result containing all courses. + * + * @param courses the list of course stats entities. + */ + public record Result(List courses) { + } +} diff --git a/multitenancy-integration-tests-springboot-axonserver/src/test/java/org/axonframework/extension/multitenancy/integrationtests/springboot/axonserver/domain/read/coursestats/FindAllCoursesQueryHandler.java b/multitenancy-integration-tests-springboot-axonserver/src/test/java/org/axonframework/extension/multitenancy/integrationtests/springboot/axonserver/domain/read/coursestats/FindAllCoursesQueryHandler.java new file mode 100644 index 0000000..173c429 --- /dev/null +++ b/multitenancy-integration-tests-springboot-axonserver/src/test/java/org/axonframework/extension/multitenancy/integrationtests/springboot/axonserver/domain/read/coursestats/FindAllCoursesQueryHandler.java @@ -0,0 +1,37 @@ +/* + * Copyright (c) 2010-2025. Axon Framework + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.axonframework.extension.multitenancy.integrationtests.springboot.axonserver.domain.read.coursestats; + +import org.axonframework.messaging.queryhandling.annotation.QueryHandler; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; +import org.springframework.stereotype.Component; + +/** + * Query handler for finding all courses. + * The repository parameter is automatically scoped to the tenant from the query's metadata. + */ +@Component +public class FindAllCoursesQueryHandler { + + private static final Logger logger = LoggerFactory.getLogger(FindAllCoursesQueryHandler.class); + + @QueryHandler + public FindAllCourses.Result handle(FindAllCourses query, CourseStatsJpaRepository repository) { + logger.info("Handling FindAllCourses query"); + return new FindAllCourses.Result(repository.findAll()); + } +} diff --git a/multitenancy-integration-tests-springboot-axonserver/src/test/java/org/axonframework/extension/multitenancy/integrationtests/springboot/axonserver/domain/shared/CourseId.java b/multitenancy-integration-tests-springboot-axonserver/src/test/java/org/axonframework/extension/multitenancy/integrationtests/springboot/axonserver/domain/shared/CourseId.java new file mode 100644 index 0000000..681d5d9 --- /dev/null +++ b/multitenancy-integration-tests-springboot-axonserver/src/test/java/org/axonframework/extension/multitenancy/integrationtests/springboot/axonserver/domain/shared/CourseId.java @@ -0,0 +1,54 @@ +/* + * Copyright (c) 2010-2025. Axon Framework + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.axonframework.extension.multitenancy.integrationtests.springboot.axonserver.domain.shared; + +import jakarta.validation.constraints.NotNull; + +import java.util.UUID; + +/** + * Course ID value object. + * + * @param raw raw string ID representation. + */ +public record CourseId(@NotNull String raw) { + + private final static String ENTITY_TYPE = "Course"; + + public CourseId { + if (raw == null || raw.isBlank()) { + throw new IllegalArgumentException("Course ID cannot be null or empty"); + } + raw = withType(raw); + } + + public static CourseId of(String raw) { + return new CourseId(raw); + } + + public static CourseId random() { + return new CourseId(UUID.randomUUID().toString()); + } + + @Override + public String toString() { + return raw; + } + + private static String withType(String id) { + return id.startsWith(ENTITY_TYPE + ":") ? id : ENTITY_TYPE + ":" + id; + } +} diff --git a/multitenancy-integration-tests-springboot-axonserver/src/test/java/org/axonframework/extension/multitenancy/integrationtests/springboot/axonserver/domain/shared/CourseTags.java b/multitenancy-integration-tests-springboot-axonserver/src/test/java/org/axonframework/extension/multitenancy/integrationtests/springboot/axonserver/domain/shared/CourseTags.java new file mode 100644 index 0000000..959c862 --- /dev/null +++ b/multitenancy-integration-tests-springboot-axonserver/src/test/java/org/axonframework/extension/multitenancy/integrationtests/springboot/axonserver/domain/shared/CourseTags.java @@ -0,0 +1,28 @@ +/* + * Copyright (c) 2010-2025. Axon Framework + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.axonframework.extension.multitenancy.integrationtests.springboot.axonserver.domain.shared; + +/** + * Event tags for course-related events. + */ +public class CourseTags { + + public static final String COURSE_ID = "courseId"; + + private CourseTags() { + // Prevent instantiation + } +} diff --git a/multitenancy-integration-tests-springboot-axonserver/src/test/java/org/axonframework/extension/multitenancy/integrationtests/springboot/axonserver/domain/write/createcourse/CourseCreation.java b/multitenancy-integration-tests-springboot-axonserver/src/test/java/org/axonframework/extension/multitenancy/integrationtests/springboot/axonserver/domain/write/createcourse/CourseCreation.java new file mode 100644 index 0000000..81ed997 --- /dev/null +++ b/multitenancy-integration-tests-springboot-axonserver/src/test/java/org/axonframework/extension/multitenancy/integrationtests/springboot/axonserver/domain/write/createcourse/CourseCreation.java @@ -0,0 +1,61 @@ +/* + * Copyright (c) 2010-2025. Axon Framework + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.axonframework.extension.multitenancy.integrationtests.springboot.axonserver.domain.write.createcourse; + +import jakarta.validation.Valid; +import org.axonframework.eventsourcing.annotation.EventSourcingHandler; +import org.axonframework.eventsourcing.annotation.reflection.EntityCreator; +import org.axonframework.extension.spring.stereotype.EventSourced; +import org.axonframework.extension.multitenancy.integrationtests.springboot.axonserver.domain.event.CourseCreated; +import org.axonframework.extension.multitenancy.integrationtests.springboot.axonserver.domain.shared.CourseId; +import org.axonframework.extension.multitenancy.integrationtests.springboot.axonserver.domain.shared.CourseTags; +import org.axonframework.messaging.commandhandling.annotation.CommandHandler; +import org.axonframework.messaging.eventhandling.gateway.EventAppender; + +/** + * Entity for course creation with internal command handler. + * Uses {@code @EventSourced} (Spring stereotype) which includes + * {@code @Component} and {@code @Scope("prototype")}. + */ +@EventSourced(tagKey = CourseTags.COURSE_ID, idType = CourseId.class) +public class CourseCreation { + + private boolean created = false; + private CourseId id; + private int capacity; + + @CommandHandler + public static void handle(@Valid CreateCourse command, EventAppender appender) { + appender.append( + new CourseCreated( + command.courseId(), + command.name(), + command.capacity() + ) + ); + } + + @EntityCreator + public CourseCreation() { + } + + @EventSourcingHandler + public void evolve(CourseCreated courseCreated) { + this.id = courseCreated.courseId(); + this.created = true; + this.capacity = courseCreated.capacity(); + } +} diff --git a/multitenancy-integration-tests-springboot-axonserver/src/test/java/org/axonframework/extension/multitenancy/integrationtests/springboot/axonserver/domain/write/createcourse/CreateCourse.java b/multitenancy-integration-tests-springboot-axonserver/src/test/java/org/axonframework/extension/multitenancy/integrationtests/springboot/axonserver/domain/write/createcourse/CreateCourse.java new file mode 100644 index 0000000..93b241f --- /dev/null +++ b/multitenancy-integration-tests-springboot-axonserver/src/test/java/org/axonframework/extension/multitenancy/integrationtests/springboot/axonserver/domain/write/createcourse/CreateCourse.java @@ -0,0 +1,44 @@ +/* + * Copyright (c) 2010-2025. Axon Framework + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.axonframework.extension.multitenancy.integrationtests.springboot.axonserver.domain.write.createcourse; + +import jakarta.validation.Valid; +import jakarta.validation.constraints.Min; +import jakarta.validation.constraints.NotEmpty; +import jakarta.validation.constraints.NotNull; +import jakarta.validation.constraints.Size; +import org.axonframework.extension.multitenancy.integrationtests.springboot.axonserver.domain.shared.CourseId; +import org.axonframework.modelling.annotation.TargetEntityId; + +/** + * Command to create a new course. + * + * @param courseId course ID. + * @param name course name. + * @param capacity course capacity. + */ +public record CreateCourse( + @Valid + @NotNull + @TargetEntityId + CourseId courseId, + @NotEmpty + @Size(min = 10) + String name, + @Min(value = 1, message = "Capacity must be a positive integer") + int capacity +) { +} diff --git a/multitenancy-integration-tests-springboot-axonserver/src/test/resources/application.yml b/multitenancy-integration-tests-springboot-axonserver/src/test/resources/application.yml new file mode 100644 index 0000000..7e5996c --- /dev/null +++ b/multitenancy-integration-tests-springboot-axonserver/src/test/resources/application.yml @@ -0,0 +1,9 @@ +axon: + multi-tenancy: + jpa: + tenant-repositories: true + +logging: + level: + org.axonframework: INFO + org.axonframework.extensions.multitenancy: DEBUG diff --git a/multitenancy-integration-tests-springboot-embedded/pom.xml b/multitenancy-integration-tests-springboot-embedded/pom.xml new file mode 100644 index 0000000..350a060 --- /dev/null +++ b/multitenancy-integration-tests-springboot-embedded/pom.xml @@ -0,0 +1,173 @@ + + + + + 4.0.0 + + + org.axonframework.extensions.multitenancy + axon-multitenancy-parent + 5.1.0-SNAPSHOT + + + axon-multitenancy-integration-tests-springboot-embedded + Axon Framework Multi-Tenancy Extension - Spring Boot Embedded Integration Tests + + Spring Boot integration tests for multi-tenancy with Spring Data JPA repositories. + Tests tenant-scoped repository injection and tenant isolation using H2 in-memory databases. + + + + 4.2.2 + 3.27.3 + 2.3.232 + + 3.1.0 + + + + + + org.axonframework.extensions.multitenancy + axon-multitenancy-spring-boot-starter + ${project.version} + test + + + + org.axonframework.extensions.multitenancy + axon-multitenancy-spring + ${project.version} + test + + + + + org.axonframework + axon-eventsourcing + test + + + org.axonframework + axon-modelling + ${axon.version} + test + + + org.axonframework + axon-messaging + test + + + + + org.springframework.boot + spring-boot-starter + ${spring.boot.version} + test + + + org.springframework.boot + spring-boot-starter-data-jpa + ${spring.boot.version} + test + + + org.springframework.boot + spring-boot-starter-test + ${spring.boot.version} + test + + + + + com.h2database + h2 + ${h2.version} + test + + + + + org.junit.jupiter + junit-jupiter + test + + + + + org.assertj + assertj-core + ${assertj.version} + test + + + org.awaitility + awaitility + ${awaitility.version} + test + + + + + jakarta.validation + jakarta.validation-api + 3.1.0 + test + + + + + org.slf4j + slf4j-api + ${slf4j.version} + test + + + ch.qos.logback + logback-classic + 1.5.15 + test + + + + + + + org.apache.maven.plugins + maven-surefire-plugin + + + **/*IT.java + **/*Test.java + + + + + + org.apache.maven.plugins + maven-deploy-plugin + 3.1.3 + + true + + + + + diff --git a/multitenancy-integration-tests-springboot-embedded/src/test/java/org/axonframework/extension/multitenancy/integrationtests/springboot/embedded/SpringBootEmbeddedMultiTenantIT.java b/multitenancy-integration-tests-springboot-embedded/src/test/java/org/axonframework/extension/multitenancy/integrationtests/springboot/embedded/SpringBootEmbeddedMultiTenantIT.java new file mode 100644 index 0000000..1e57c66 --- /dev/null +++ b/multitenancy-integration-tests-springboot-embedded/src/test/java/org/axonframework/extension/multitenancy/integrationtests/springboot/embedded/SpringBootEmbeddedMultiTenantIT.java @@ -0,0 +1,277 @@ +/* + * Copyright (c) 2010-2025. Axon Framework + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.axonframework.extension.multitenancy.integrationtests.springboot.embedded; + +import org.awaitility.Awaitility; +import org.axonframework.extension.multitenancy.core.TenantDescriptor; +import org.axonframework.extension.multitenancy.core.NoSuchTenantException; +import org.axonframework.extension.multitenancy.integrationtests.springboot.embedded.domain.read.coursestats.CourseStatsReadModel; +import org.axonframework.extension.multitenancy.integrationtests.springboot.embedded.domain.read.coursestats.FindAllCourses; +import org.axonframework.extension.multitenancy.integrationtests.springboot.embedded.domain.shared.TenantAuditService; +import org.axonframework.extension.multitenancy.integrationtests.springboot.embedded.domain.shared.CourseId; +import org.axonframework.extension.multitenancy.integrationtests.springboot.embedded.domain.write.createcourse.CreateCourse; +import org.axonframework.messaging.commandhandling.gateway.CommandGateway; +import org.axonframework.messaging.core.MessageType; +import org.axonframework.messaging.core.Metadata; +import org.axonframework.messaging.queryhandling.GenericQueryMessage; +import org.axonframework.messaging.queryhandling.QueryMessage; +import org.axonframework.messaging.queryhandling.gateway.QueryGateway; +import org.junit.jupiter.api.BeforeEach; +import org.junit.jupiter.api.Test; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.boot.test.context.SpringBootTest; +import org.springframework.test.annotation.DirtiesContext; + +import java.time.Duration; +import java.util.List; + +import static org.assertj.core.api.Assertions.assertThat; +import static org.assertj.core.api.Assertions.assertThatThrownBy; +import static org.axonframework.extension.multitenancy.integrationtests.springboot.embedded.config.TestMultiTenancyConfiguration.TENANT_A; +import static org.axonframework.extension.multitenancy.integrationtests.springboot.embedded.config.TestMultiTenancyConfiguration.TENANT_B; +import static org.junit.jupiter.api.Assertions.assertDoesNotThrow; + +/** + * Spring Boot integration tests verifying multi-tenant isolation with JPA repositories. + *

    + * Key differences from the embedded integration tests: + *

      + *
    • Uses Spring Boot autoconfiguration (not raw Configurer)
      • + *
    • Handlers are auto-discovered via component scanning
      • + *
    • Spring Data JPA repositories are automatically tenant-scoped via + * {@link org.axonframework.extension.multitenancy.spring.data.TenantRepositoryParameterResolverFactory}
      • + *
    + * + * @author Theo Emanuelsson + * @since 5.0.0 + */ +@SpringBootTest(classes = TestApplication.class) +@DirtiesContext(classMode = DirtiesContext.ClassMode.AFTER_EACH_TEST_METHOD) +class SpringBootEmbeddedMultiTenantIT { + + @Autowired + private CommandGateway commandGateway; + + @Autowired + private QueryGateway queryGateway; + + @BeforeEach + void setUp() { + TenantAuditService.clearAllAuditEntries(); + } + + private void createCourseForTenant(TenantDescriptor tenant, CourseId courseId, String name, int capacity) { + commandGateway.send( + new CreateCourse(courseId, name, capacity), + Metadata.with("tenantId", tenant.tenantId()), + null + ).getResultMessage().join(); + } + + private List queryCoursesForTenant(TenantDescriptor tenant) { + QueryMessage query = new GenericQueryMessage( + new MessageType(FindAllCourses.class), new FindAllCourses() + ).andMetadata(Metadata.with("tenantId", tenant.tenantId())); + return queryGateway.query(query, FindAllCourses.Result.class) + .thenApply(FindAllCourses.Result::courses).join(); + } + + @Test + void tenantScopedRepositoryInjection_repositorySavesToCorrectTenantDatabase() { + CourseId courseIdA = CourseId.random(); + CourseId courseIdB = CourseId.random(); + + // Create courses in different tenants + createCourseForTenant(TENANT_A, courseIdA, "Spring Boot Course A", 25); + createCourseForTenant(TENANT_B, courseIdB, "Spring Boot Course B", 35); + + // Wait for projections to process + Awaitility.await().atMost(Duration.ofSeconds(10)).until(() -> + !queryCoursesForTenant(TENANT_A).isEmpty() && !queryCoursesForTenant(TENANT_B).isEmpty() + ); + + // Verify tenant A only sees their course + List tenantACourses = queryCoursesForTenant(TENANT_A); + assertThat(tenantACourses).hasSize(1); + assertThat(tenantACourses.get(0).getCourseId()).isEqualTo(courseIdA.raw()); + assertThat(tenantACourses.get(0).getName()).isEqualTo("Spring Boot Course A"); + + // Verify tenant B only sees their course + List tenantBCourses = queryCoursesForTenant(TENANT_B); + assertThat(tenantBCourses).hasSize(1); + assertThat(tenantBCourses.get(0).getCourseId()).isEqualTo(courseIdB.raw()); + assertThat(tenantBCourses.get(0).getName()).isEqualTo("Spring Boot Course B"); + } + + @Test + void fullTenantIsolation_dataFromTenantANotVisibleInTenantB() { + CourseId courseIdA1 = CourseId.random(); + CourseId courseIdA2 = CourseId.random(); + CourseId courseIdB = CourseId.random(); + + // Create two courses for tenant A + createCourseForTenant(TENANT_A, courseIdA1, "First Course TenantA", 10); + createCourseForTenant(TENANT_A, courseIdA2, "Second Course TenantA", 15); + + // Create one course for tenant B + createCourseForTenant(TENANT_B, courseIdB, "Only Course TenantB", 20); + + // Wait for projections + Awaitility.await().atMost(Duration.ofSeconds(10)).until(() -> { + List a = queryCoursesForTenant(TENANT_A); + List b = queryCoursesForTenant(TENANT_B); + return a.size() == 2 && b.size() == 1; + }); + + // Tenant A sees exactly 2 courses + List tenantACourses = queryCoursesForTenant(TENANT_A); + assertThat(tenantACourses).hasSize(2); + assertThat(tenantACourses).extracting(CourseStatsReadModel::getName) + .containsExactlyInAnyOrder("First Course TenantA", "Second Course TenantA"); + + // Tenant B sees exactly 1 course - NOT tenant A's courses + List tenantBCourses = queryCoursesForTenant(TENANT_B); + assertThat(tenantBCourses).hasSize(1); + assertThat(tenantBCourses.get(0).getName()).isEqualTo("Only Course TenantB"); + } + + @Test + void sameEntityIdInDifferentTenants_noConflicts() { + // Use same CourseId in both tenants + CourseId sharedCourseId = CourseId.random(); + + // Create in tenant A + assertDoesNotThrow(() -> + createCourseForTenant(TENANT_A, sharedCourseId, "Shared ID Course A", 30) + ); + + // Create same ID in tenant B - should succeed (different tenant database) + assertDoesNotThrow(() -> + createCourseForTenant(TENANT_B, sharedCourseId, "Shared ID Course B", 40) + ); + + // Wait and verify both exist independently + Awaitility.await().atMost(Duration.ofSeconds(10)).until(() -> + !queryCoursesForTenant(TENANT_A).isEmpty() && !queryCoursesForTenant(TENANT_B).isEmpty() + ); + + List tenantACourses = queryCoursesForTenant(TENANT_A); + List tenantBCourses = queryCoursesForTenant(TENANT_B); + + // Both tenants have a course with the same ID but different data + assertThat(tenantACourses).hasSize(1); + assertThat(tenantBCourses).hasSize(1); + assertThat(tenantACourses.get(0).getCourseId()).isEqualTo(sharedCourseId.raw()); + assertThat(tenantBCourses.get(0).getCourseId()).isEqualTo(sharedCourseId.raw()); + assertThat(tenantACourses.get(0).getName()).isEqualTo("Shared ID Course A"); + assertThat(tenantBCourses.get(0).getName()).isEqualTo("Shared ID Course B"); + } + + @Test + void commandWithoutTenantMetadata_failsWithNoSuchTenantException() { + CourseId courseId = CourseId.random(); + CreateCourse command = new CreateCourse(courseId, "Test Course No Tenant", 10); + + // Send without tenant metadata - should fail + assertThatThrownBy(() -> commandGateway.sendAndWait(command)) + .isInstanceOf(NoSuchTenantException.class); + } + + @Test + void queryWithoutTenantMetadata_failsWithNoSuchTenantException() { + // First create some data + createCourseForTenant(TENANT_A, CourseId.random(), "Course for QueryTest", 15); + + // Wait for projection + Awaitility.await().atMost(Duration.ofSeconds(10)).until(() -> + !queryCoursesForTenant(TENANT_A).isEmpty() + ); + + // Query without tenant metadata + QueryMessage query = new GenericQueryMessage( + new MessageType(FindAllCourses.class), new FindAllCourses() + ); + // No tenant metadata added + + assertThatThrownBy(() -> queryGateway.query(query, FindAllCourses.Result.class).join()) + .hasCauseInstanceOf(NoSuchTenantException.class); + } + + @Test + void tenantComponentInjection_serviceReceivesCorrectTenantContext() { + CourseId courseIdA = CourseId.random(); + CourseId courseIdB = CourseId.random(); + + // Create courses in different tenants + createCourseForTenant(TENANT_A, courseIdA, "TenantComponent Test A", 10); + createCourseForTenant(TENANT_B, courseIdB, "TenantComponent Test B", 20); + + // Wait for projections to process (which triggers audit recording) + Awaitility.await().atMost(Duration.ofSeconds(10)).until(() -> + TenantAuditService.getAllAuditEntries().size() >= 2 + ); + + // Verify tenant A's audit service recorded with correct tenant context + var tenantAEntries = TenantAuditService.getAuditEntriesForTenant(TENANT_A.tenantId()); + assertThat(tenantAEntries).hasSize(1); + assertThat(tenantAEntries.get(0).action()).contains(courseIdA.raw()); + + // Verify tenant B's audit service recorded with correct tenant context + var tenantBEntries = TenantAuditService.getAuditEntriesForTenant(TENANT_B.tenantId()); + assertThat(tenantBEntries).hasSize(1); + assertThat(tenantBEntries.get(0).action()).contains(courseIdB.raw()); + + // Verify no cross-tenant contamination + assertThat(tenantAEntries.get(0).action()).doesNotContain(courseIdB.raw()); + assertThat(tenantBEntries.get(0).action()).doesNotContain(courseIdA.raw()); + + // Verify Spring DI worked - Clock was injected and timestamps are present + assertThat(tenantAEntries.get(0).timestamp()).isNotNull(); + assertThat(tenantBEntries.get(0).timestamp()).isNotNull(); + } + + @Test + void tenantComponentIsolation_eachTenantGetsOwnServiceInstance() { + // Create multiple courses for tenant A + CourseId courseIdA1 = CourseId.random(); + CourseId courseIdA2 = CourseId.random(); + createCourseForTenant(TENANT_A, courseIdA1, "Course A1", 10); + createCourseForTenant(TENANT_A, courseIdA2, "Course A2", 15); + + // Create one course for tenant B + CourseId courseIdB = CourseId.random(); + createCourseForTenant(TENANT_B, courseIdB, "Course B", 20); + + // Wait for all projections + Awaitility.await().atMost(Duration.ofSeconds(10)).until(() -> + TenantAuditService.getAllAuditEntries().size() >= 3 + ); + + // Tenant A should have 2 audit entries + var tenantAEntries = TenantAuditService.getAuditEntriesForTenant(TENANT_A.tenantId()); + assertThat(tenantAEntries).hasSize(2); + + // Tenant B should have 1 audit entry + var tenantBEntries = TenantAuditService.getAuditEntriesForTenant(TENANT_B.tenantId()); + assertThat(tenantBEntries).hasSize(1); + + // All entries for tenant A should have tenant A's ID + assertThat(tenantAEntries).allMatch(e -> e.tenantId().equals(TENANT_A.tenantId())); + + // All entries for tenant B should have tenant B's ID + assertThat(tenantBEntries).allMatch(e -> e.tenantId().equals(TENANT_B.tenantId())); + } +} diff --git a/multitenancy-integration-tests-springboot-embedded/src/test/java/org/axonframework/extension/multitenancy/integrationtests/springboot/embedded/TestApplication.java b/multitenancy-integration-tests-springboot-embedded/src/test/java/org/axonframework/extension/multitenancy/integrationtests/springboot/embedded/TestApplication.java new file mode 100644 index 0000000..dbbf669 --- /dev/null +++ b/multitenancy-integration-tests-springboot-embedded/src/test/java/org/axonframework/extension/multitenancy/integrationtests/springboot/embedded/TestApplication.java @@ -0,0 +1,48 @@ +/* + * Copyright (c) 2010-2025. Axon Framework + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.axonframework.extension.multitenancy.integrationtests.springboot.embedded; + +import org.springframework.boot.autoconfigure.SpringBootApplication; +import org.springframework.context.annotation.Bean; + +import java.time.Clock; + +/** + * Spring Boot test application for multi-tenancy integration tests. + * Uses auto-discovered handlers and tenant-scoped Spring Data JPA repositories. + *

    + * When multi-tenancy is enabled (default), the {@code MultiTenancyAutoConfigurationImportFilter} + * automatically excludes conflicting autoconfiguration classes: + *

      + *
    • InfrastructureConfiguration - replaced by MultiTenantMessageHandlerLookup
      • + *
    • JpaAutoConfiguration - replaced by TenantTokenStoreFactory
      • + *
    • JpaEventStoreAutoConfiguration - replaced by MultiTenantEventStore via SPI
      • + *
    • HibernateJpaAutoConfiguration - excluded when TenantDataSourceProvider is present
      • + *
    • JpaRepositoriesAutoConfiguration - excluded when TenantDataSourceProvider is present
      • + *
    + */ +@SpringBootApplication +public class TestApplication { + + /** + * Provides a Clock bean to demonstrate that TenantComponent implementations + * can receive Spring dependencies via constructor injection. + */ + @Bean + public Clock clock() { + return Clock.systemUTC(); + } +} diff --git a/multitenancy-integration-tests-springboot-embedded/src/test/java/org/axonframework/extension/multitenancy/integrationtests/springboot/embedded/config/TestMultiTenancyConfiguration.java b/multitenancy-integration-tests-springboot-embedded/src/test/java/org/axonframework/extension/multitenancy/integrationtests/springboot/embedded/config/TestMultiTenancyConfiguration.java new file mode 100644 index 0000000..6567821 --- /dev/null +++ b/multitenancy-integration-tests-springboot-embedded/src/test/java/org/axonframework/extension/multitenancy/integrationtests/springboot/embedded/config/TestMultiTenancyConfiguration.java @@ -0,0 +1,74 @@ +/* + * Copyright (c) 2010-2025. Axon Framework + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.axonframework.extension.multitenancy.integrationtests.springboot.embedded.config; + +import org.axonframework.extension.multitenancy.core.TenantDescriptor; +import org.axonframework.extension.multitenancy.core.TenantProvider; +import org.axonframework.extension.multitenancy.core.SimpleTenantProvider; +import org.axonframework.extension.multitenancy.spring.data.jpa.TenantDataSourceProvider; +import org.axonframework.extension.multitenancy.spring.data.jpa.TenantEntityManagerFactoryBuilder; +import org.springframework.boot.jdbc.DataSourceBuilder; +import org.springframework.context.annotation.Bean; +import org.springframework.context.annotation.Configuration; + +import java.util.List; +import java.util.Map; +import java.util.concurrent.ConcurrentHashMap; +import javax.sql.DataSource; + +/** + * Configuration for multi-tenancy tests. + * Provides tenant definitions and H2 database-per-tenant via {@link TenantDataSourceProvider}. + */ +@Configuration +public class TestMultiTenancyConfiguration { + + public static final TenantDescriptor TENANT_A = TenantDescriptor.tenantWithId("tenant-a"); + public static final TenantDescriptor TENANT_B = TenantDescriptor.tenantWithId("tenant-b"); + + @Bean + public TenantProvider tenantProvider() { + return new SimpleTenantProvider(List.of(TENANT_A, TENANT_B)); + } + + @Bean + public TenantDataSourceProvider tenantDataSourceProvider() { + Map cache = new ConcurrentHashMap<>(); + return tenant -> cache.computeIfAbsent(tenant.tenantId(), id -> + DataSourceBuilder.create() + .url("jdbc:h2:mem:" + id + ";DB_CLOSE_DELAY=-1;MODE=PostgreSQL") + .driverClassName("org.h2.Driver") + .username("sa") + .password("") + .build() + ); + } + + /** + * Configures the TenantEntityManagerFactoryBuilder with entity packages and DDL auto. + * This ensures tenant databases have the schema created and entity classes are scanned. + */ + @Bean + public TenantEntityManagerFactoryBuilder tenantEntityManagerFactoryBuilder( + TenantDataSourceProvider dataSourceProvider) { + return TenantEntityManagerFactoryBuilder + .forDataSourceProvider(dataSourceProvider) + .packagesToScan("org.axonframework.extensions.multitenancy.integrationtests.springboot.embedded.domain.read.coursestats") + .jpaProperty("hibernate.hbm2ddl.auto", "create-drop") + .jpaProperty("hibernate.show_sql", "true") + .build(); + } +} diff --git a/multitenancy-integration-tests-springboot-embedded/src/test/java/org/axonframework/extension/multitenancy/integrationtests/springboot/embedded/domain/event/CourseCreated.java b/multitenancy-integration-tests-springboot-embedded/src/test/java/org/axonframework/extension/multitenancy/integrationtests/springboot/embedded/domain/event/CourseCreated.java new file mode 100644 index 0000000..bbce53a --- /dev/null +++ b/multitenancy-integration-tests-springboot-embedded/src/test/java/org/axonframework/extension/multitenancy/integrationtests/springboot/embedded/domain/event/CourseCreated.java @@ -0,0 +1,37 @@ +/* + * Copyright (c) 2010-2025. Axon Framework + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.axonframework.extension.multitenancy.integrationtests.springboot.embedded.domain.event; + +import org.axonframework.eventsourcing.annotation.EventTag; +import org.axonframework.extension.multitenancy.integrationtests.springboot.embedded.domain.shared.CourseId; +import org.axonframework.extension.multitenancy.integrationtests.springboot.embedded.domain.shared.CourseTags; +import org.axonframework.messaging.eventhandling.annotation.Event; + +/** + * Course created event. + * + * @param courseId course ID. + * @param name course name. + * @param capacity course capacity. + */ +@Event(name = "CourseCreated") +public record CourseCreated( + @EventTag(key = CourseTags.COURSE_ID) + CourseId courseId, + String name, + int capacity +) { +} diff --git a/multitenancy-integration-tests-springboot-embedded/src/test/java/org/axonframework/extension/multitenancy/integrationtests/springboot/embedded/domain/read/coursestats/CourseStatsJpaRepository.java b/multitenancy-integration-tests-springboot-embedded/src/test/java/org/axonframework/extension/multitenancy/integrationtests/springboot/embedded/domain/read/coursestats/CourseStatsJpaRepository.java new file mode 100644 index 0000000..80c5179 --- /dev/null +++ b/multitenancy-integration-tests-springboot-embedded/src/test/java/org/axonframework/extension/multitenancy/integrationtests/springboot/embedded/domain/read/coursestats/CourseStatsJpaRepository.java @@ -0,0 +1,32 @@ +/* + * Copyright (c) 2010-2025. Axon Framework + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.axonframework.extension.multitenancy.integrationtests.springboot.embedded.domain.read.coursestats; + +import org.springframework.data.jpa.repository.JpaRepository; + +/** + * Spring Data JPA repository for course statistics. + *

    + * When {@code axon.multi-tenancy.jpa.tenant-repositories=true}, this repository + * is automatically discovered and registered as a tenant component. No special + * annotations are required - just extend {@link JpaRepository} (or any Spring Data + * repository interface). + *

    + * When injected into event/query handlers, this repository is automatically + * scoped to the tenant from the message's metadata. + */ +public interface CourseStatsJpaRepository extends JpaRepository { +} diff --git a/multitenancy-integration-tests-springboot-embedded/src/test/java/org/axonframework/extension/multitenancy/integrationtests/springboot/embedded/domain/read/coursestats/CourseStatsProjector.java b/multitenancy-integration-tests-springboot-embedded/src/test/java/org/axonframework/extension/multitenancy/integrationtests/springboot/embedded/domain/read/coursestats/CourseStatsProjector.java new file mode 100644 index 0000000..1717868 --- /dev/null +++ b/multitenancy-integration-tests-springboot-embedded/src/test/java/org/axonframework/extension/multitenancy/integrationtests/springboot/embedded/domain/read/coursestats/CourseStatsProjector.java @@ -0,0 +1,49 @@ +/* + * Copyright (c) 2010-2025. Axon Framework + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.axonframework.extension.multitenancy.integrationtests.springboot.embedded.domain.read.coursestats; + +import org.axonframework.extension.multitenancy.integrationtests.springboot.embedded.domain.event.CourseCreated; +import org.axonframework.extension.multitenancy.integrationtests.springboot.embedded.domain.shared.TenantAuditService; +import org.axonframework.messaging.eventhandling.annotation.EventHandler; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; +import org.springframework.stereotype.Component; + +/** + * Event handler that projects course events to the JPA repository. + * The repository parameter is automatically scoped to the tenant from the event's metadata. + * The audit service is also tenant-scoped via {@link org.axonframework.extension.multitenancy.spring.TenantComponent}. + */ +@Component +public class CourseStatsProjector { + + private static final Logger logger = LoggerFactory.getLogger(CourseStatsProjector.class); + + @EventHandler + public void on(CourseCreated event, CourseStatsJpaRepository repository, TenantAuditService auditService) { + logger.info("Processing CourseCreated event for course: {} in tenant: {}", + event.courseId(), auditService.getTenantId()); + + // Record audit entry using tenant-scoped service + auditService.recordAudit("course_created:" + event.courseId().raw()); + + repository.save(new CourseStatsReadModel( + event.courseId().raw(), + event.name(), + event.capacity() + )); + } +} diff --git a/multitenancy-integration-tests-springboot-embedded/src/test/java/org/axonframework/extension/multitenancy/integrationtests/springboot/embedded/domain/read/coursestats/CourseStatsReadModel.java b/multitenancy-integration-tests-springboot-embedded/src/test/java/org/axonframework/extension/multitenancy/integrationtests/springboot/embedded/domain/read/coursestats/CourseStatsReadModel.java new file mode 100644 index 0000000..b9355c5 --- /dev/null +++ b/multitenancy-integration-tests-springboot-embedded/src/test/java/org/axonframework/extension/multitenancy/integrationtests/springboot/embedded/domain/read/coursestats/CourseStatsReadModel.java @@ -0,0 +1,67 @@ +/* + * Copyright (c) 2010-2025. Axon Framework + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.axonframework.extension.multitenancy.integrationtests.springboot.embedded.domain.read.coursestats; + +import jakarta.persistence.Entity; +import jakarta.persistence.Id; +import jakarta.persistence.Table; + +/** + * JPA entity representing course statistics in the read model. + */ +@Entity +@Table(name = "course_stats") +public class CourseStatsReadModel { + + @Id + private String courseId; + private String name; + private int capacity; + + public CourseStatsReadModel() { + // Required by JPA + } + + public CourseStatsReadModel(String courseId, String name, int capacity) { + this.courseId = courseId; + this.name = name; + this.capacity = capacity; + } + + public String getCourseId() { + return courseId; + } + + public void setCourseId(String courseId) { + this.courseId = courseId; + } + + public String getName() { + return name; + } + + public void setName(String name) { + this.name = name; + } + + public int getCapacity() { + return capacity; + } + + public void setCapacity(int capacity) { + this.capacity = capacity; + } +} diff --git a/multitenancy-integration-tests-springboot-embedded/src/test/java/org/axonframework/extension/multitenancy/integrationtests/springboot/embedded/domain/read/coursestats/FindAllCourses.java b/multitenancy-integration-tests-springboot-embedded/src/test/java/org/axonframework/extension/multitenancy/integrationtests/springboot/embedded/domain/read/coursestats/FindAllCourses.java new file mode 100644 index 0000000..9c93665 --- /dev/null +++ b/multitenancy-integration-tests-springboot-embedded/src/test/java/org/axonframework/extension/multitenancy/integrationtests/springboot/embedded/domain/read/coursestats/FindAllCourses.java @@ -0,0 +1,32 @@ +/* + * Copyright (c) 2010-2025. Axon Framework + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.axonframework.extension.multitenancy.integrationtests.springboot.embedded.domain.read.coursestats; + +import java.util.List; + +/** + * Query to find all courses for a tenant. + */ +public record FindAllCourses() { + + /** + * Result containing all courses. + * + * @param courses the list of course stats entities. + */ + public record Result(List courses) { + } +} diff --git a/multitenancy-integration-tests-springboot-embedded/src/test/java/org/axonframework/extension/multitenancy/integrationtests/springboot/embedded/domain/read/coursestats/FindAllCoursesQueryHandler.java b/multitenancy-integration-tests-springboot-embedded/src/test/java/org/axonframework/extension/multitenancy/integrationtests/springboot/embedded/domain/read/coursestats/FindAllCoursesQueryHandler.java new file mode 100644 index 0000000..a8764fa --- /dev/null +++ b/multitenancy-integration-tests-springboot-embedded/src/test/java/org/axonframework/extension/multitenancy/integrationtests/springboot/embedded/domain/read/coursestats/FindAllCoursesQueryHandler.java @@ -0,0 +1,37 @@ +/* + * Copyright (c) 2010-2025. Axon Framework + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.axonframework.extension.multitenancy.integrationtests.springboot.embedded.domain.read.coursestats; + +import org.axonframework.messaging.queryhandling.annotation.QueryHandler; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; +import org.springframework.stereotype.Component; + +/** + * Query handler for finding all courses. + * The repository parameter is automatically scoped to the tenant from the query's metadata. + */ +@Component +public class FindAllCoursesQueryHandler { + + private static final Logger logger = LoggerFactory.getLogger(FindAllCoursesQueryHandler.class); + + @QueryHandler + public FindAllCourses.Result handle(FindAllCourses query, CourseStatsJpaRepository repository) { + logger.info("Handling FindAllCourses query"); + return new FindAllCourses.Result(repository.findAll()); + } +} diff --git a/multitenancy-integration-tests-springboot-embedded/src/test/java/org/axonframework/extension/multitenancy/integrationtests/springboot/embedded/domain/shared/CourseId.java b/multitenancy-integration-tests-springboot-embedded/src/test/java/org/axonframework/extension/multitenancy/integrationtests/springboot/embedded/domain/shared/CourseId.java new file mode 100644 index 0000000..09a1ea4 --- /dev/null +++ b/multitenancy-integration-tests-springboot-embedded/src/test/java/org/axonframework/extension/multitenancy/integrationtests/springboot/embedded/domain/shared/CourseId.java @@ -0,0 +1,54 @@ +/* + * Copyright (c) 2010-2025. Axon Framework + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.axonframework.extension.multitenancy.integrationtests.springboot.embedded.domain.shared; + +import jakarta.validation.constraints.NotNull; + +import java.util.UUID; + +/** + * Course ID value object. + * + * @param raw raw string ID representation. + */ +public record CourseId(@NotNull String raw) { + + private final static String ENTITY_TYPE = "Course"; + + public CourseId { + if (raw == null || raw.isBlank()) { + throw new IllegalArgumentException("Course ID cannot be null or empty"); + } + raw = withType(raw); + } + + public static CourseId of(String raw) { + return new CourseId(raw); + } + + public static CourseId random() { + return new CourseId(UUID.randomUUID().toString()); + } + + @Override + public String toString() { + return raw; + } + + private static String withType(String id) { + return id.startsWith(ENTITY_TYPE + ":") ? id : ENTITY_TYPE + ":" + id; + } +} diff --git a/multitenancy-integration-tests-springboot-embedded/src/test/java/org/axonframework/extension/multitenancy/integrationtests/springboot/embedded/domain/shared/CourseTags.java b/multitenancy-integration-tests-springboot-embedded/src/test/java/org/axonframework/extension/multitenancy/integrationtests/springboot/embedded/domain/shared/CourseTags.java new file mode 100644 index 0000000..b70cc67 --- /dev/null +++ b/multitenancy-integration-tests-springboot-embedded/src/test/java/org/axonframework/extension/multitenancy/integrationtests/springboot/embedded/domain/shared/CourseTags.java @@ -0,0 +1,28 @@ +/* + * Copyright (c) 2010-2025. Axon Framework + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.axonframework.extension.multitenancy.integrationtests.springboot.embedded.domain.shared; + +/** + * Event tags for course-related events. + */ +public class CourseTags { + + public static final String COURSE_ID = "courseId"; + + private CourseTags() { + // Prevent instantiation + } +} diff --git a/multitenancy-integration-tests-springboot-embedded/src/test/java/org/axonframework/extension/multitenancy/integrationtests/springboot/embedded/domain/shared/TenantAuditService.java b/multitenancy-integration-tests-springboot-embedded/src/test/java/org/axonframework/extension/multitenancy/integrationtests/springboot/embedded/domain/shared/TenantAuditService.java new file mode 100644 index 0000000..d979fe6 --- /dev/null +++ b/multitenancy-integration-tests-springboot-embedded/src/test/java/org/axonframework/extension/multitenancy/integrationtests/springboot/embedded/domain/shared/TenantAuditService.java @@ -0,0 +1,135 @@ +/* + * Copyright (c) 2010-2025. Axon Framework + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.axonframework.extension.multitenancy.integrationtests.springboot.embedded.domain.shared; + +import org.axonframework.extension.multitenancy.core.TenantDescriptor; +import org.axonframework.extension.multitenancy.spring.TenantComponent; + +import java.time.Clock; +import java.time.Instant; +import java.util.ArrayList; +import java.util.Collections; +import java.util.List; +import java.util.concurrent.CopyOnWriteArrayList; + +/** + * A simple tenant-scoped service for testing {@link TenantComponent} auto-configuration. + *

    + * This service records audit entries for each tenant. Each tenant gets their own instance + * with isolated audit logs, demonstrating tenant-scoped component injection. + *

    + * Note: This class does NOT have @Component annotation - it's discovered and managed + * by the TenantComponent auto-configuration. + *

    + * This class also demonstrates that TenantComponent implementations can receive Spring + * dependencies (like {@link Clock}) via constructor injection. + */ +public class TenantAuditService implements TenantComponent { + + /** + * Static registry to track all audit entries across all tenant instances. + * Used by tests to verify tenant isolation. + */ + private static final List ALL_AUDIT_ENTRIES = new CopyOnWriteArrayList<>(); + + private final Clock clock; + private final String tenantId; + private final List localAuditLog = new ArrayList<>(); + + /** + * Constructor for the factory instance (no tenant context). + * Spring will use this constructor when creating the factory via AutowireCapableBeanFactory, + * injecting the Clock bean. + */ + public TenantAuditService(Clock clock) { + this.clock = clock; + this.tenantId = null; + } + + /** + * Constructor for tenant-specific instances. + * The Clock dependency is passed from the factory instance. + */ + private TenantAuditService(Clock clock, String tenantId) { + this.clock = clock; + this.tenantId = tenantId; + } + + @Override + public TenantAuditService createForTenant(TenantDescriptor tenant) { + return new TenantAuditService(this.clock, tenant.tenantId()); + } + + /** + * Records an audit entry for this tenant. + * Uses the injected Clock to timestamp the entry, proving Spring DI works. + */ + public void recordAudit(String action) { + if (tenantId == null) { + throw new IllegalStateException("Cannot record audit on factory instance - no tenant context"); + } + if (clock == null) { + throw new IllegalStateException("Clock was not injected - Spring DI failed!"); + } + Instant timestamp = clock.instant(); + String entry = tenantId + ":" + action + "@" + timestamp; + localAuditLog.add(entry); + ALL_AUDIT_ENTRIES.add(new AuditEntry(tenantId, action, timestamp)); + } + + /** + * Returns the tenant ID this service instance is scoped to. + */ + public String getTenantId() { + return tenantId; + } + + /** + * Returns the local audit log for this tenant instance. + */ + public List getLocalAuditLog() { + return Collections.unmodifiableList(localAuditLog); + } + + /** + * Returns all audit entries across all tenants (for test verification). + */ + public static List getAllAuditEntries() { + return Collections.unmodifiableList(ALL_AUDIT_ENTRIES); + } + + /** + * Clears all audit entries (call in test setup). + */ + public static void clearAllAuditEntries() { + ALL_AUDIT_ENTRIES.clear(); + } + + /** + * Returns audit entries for a specific tenant. + */ + public static List getAuditEntriesForTenant(String tenantId) { + return ALL_AUDIT_ENTRIES.stream() + .filter(e -> e.tenantId().equals(tenantId)) + .toList(); + } + + /** + * Audit entry record with timestamp to prove Clock injection works. + */ + public record AuditEntry(String tenantId, String action, Instant timestamp) { + } +} diff --git a/multitenancy-integration-tests-springboot-embedded/src/test/java/org/axonframework/extension/multitenancy/integrationtests/springboot/embedded/domain/write/createcourse/CourseCreation.java b/multitenancy-integration-tests-springboot-embedded/src/test/java/org/axonframework/extension/multitenancy/integrationtests/springboot/embedded/domain/write/createcourse/CourseCreation.java new file mode 100644 index 0000000..bcad722 --- /dev/null +++ b/multitenancy-integration-tests-springboot-embedded/src/test/java/org/axonframework/extension/multitenancy/integrationtests/springboot/embedded/domain/write/createcourse/CourseCreation.java @@ -0,0 +1,61 @@ +/* + * Copyright (c) 2010-2025. Axon Framework + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.axonframework.extension.multitenancy.integrationtests.springboot.embedded.domain.write.createcourse; + +import jakarta.validation.Valid; +import org.axonframework.eventsourcing.annotation.EventSourcingHandler; +import org.axonframework.eventsourcing.annotation.reflection.EntityCreator; +import org.axonframework.extension.spring.stereotype.EventSourced; +import org.axonframework.extension.multitenancy.integrationtests.springboot.embedded.domain.event.CourseCreated; +import org.axonframework.extension.multitenancy.integrationtests.springboot.embedded.domain.shared.CourseId; +import org.axonframework.extension.multitenancy.integrationtests.springboot.embedded.domain.shared.CourseTags; +import org.axonframework.messaging.commandhandling.annotation.CommandHandler; +import org.axonframework.messaging.eventhandling.gateway.EventAppender; + +/** + * Entity for course creation with internal command handler. + * Uses {@code @EventSourced} (Spring stereotype) which includes + * {@code @Component} and {@code @Scope("prototype")}. + */ +@EventSourced(tagKey = CourseTags.COURSE_ID, idType = CourseId.class) +public class CourseCreation { + + private boolean created = false; + private CourseId id; + private int capacity; + + @CommandHandler + public static void handle(@Valid CreateCourse command, EventAppender appender) { + appender.append( + new CourseCreated( + command.courseId(), + command.name(), + command.capacity() + ) + ); + } + + @EntityCreator + public CourseCreation() { + } + + @EventSourcingHandler + public void evolve(CourseCreated courseCreated) { + this.id = courseCreated.courseId(); + this.created = true; + this.capacity = courseCreated.capacity(); + } +} diff --git a/multitenancy-integration-tests-springboot-embedded/src/test/java/org/axonframework/extension/multitenancy/integrationtests/springboot/embedded/domain/write/createcourse/CreateCourse.java b/multitenancy-integration-tests-springboot-embedded/src/test/java/org/axonframework/extension/multitenancy/integrationtests/springboot/embedded/domain/write/createcourse/CreateCourse.java new file mode 100644 index 0000000..bee35d2 --- /dev/null +++ b/multitenancy-integration-tests-springboot-embedded/src/test/java/org/axonframework/extension/multitenancy/integrationtests/springboot/embedded/domain/write/createcourse/CreateCourse.java @@ -0,0 +1,44 @@ +/* + * Copyright (c) 2010-2025. Axon Framework + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.axonframework.extension.multitenancy.integrationtests.springboot.embedded.domain.write.createcourse; + +import jakarta.validation.Valid; +import jakarta.validation.constraints.Min; +import jakarta.validation.constraints.NotEmpty; +import jakarta.validation.constraints.NotNull; +import jakarta.validation.constraints.Size; +import org.axonframework.extension.multitenancy.integrationtests.springboot.embedded.domain.shared.CourseId; +import org.axonframework.modelling.annotation.TargetEntityId; + +/** + * Command to create a new course. + * + * @param courseId course ID. + * @param name course name. + * @param capacity course capacity. + */ +public record CreateCourse( + @Valid + @NotNull + @TargetEntityId + CourseId courseId, + @NotEmpty + @Size(min = 10) + String name, + @Min(value = 1, message = "Capacity must be a positive integer") + int capacity +) { +} diff --git a/multitenancy-integration-tests-springboot-embedded/src/test/resources/application.yml b/multitenancy-integration-tests-springboot-embedded/src/test/resources/application.yml new file mode 100644 index 0000000..54b2976 --- /dev/null +++ b/multitenancy-integration-tests-springboot-embedded/src/test/resources/application.yml @@ -0,0 +1,11 @@ +axon: + axonserver: + enabled: false + multi-tenancy: + jpa: + tenant-repositories: true + +logging: + level: + org.axonframework: INFO + org.axonframework.extensions.multitenancy: DEBUG diff --git a/multitenancy-spring-boot-3-integrationtests/pom.xml b/multitenancy-spring-boot-3-integrationtests/pom.xml deleted file mode 100644 index 7d24cf6..0000000 --- a/multitenancy-spring-boot-3-integrationtests/pom.xml +++ /dev/null @@ -1,213 +0,0 @@ - - - - - - org.springframework.boot - spring-boot-starter-parent - 3.3.4 - - - 4.0.0 - - axon-multitenancy-spring-boot-3-integrationtests - org.axonframework.extensions.multitenancy - - Axon Framework Multi-Tenancy Extension - Spring Boot 3 Integration Tests - - Module used to test the integration with Spring Boot 3 - - 4.12.1-SNAPSHOT - - jar - - - 4.12.0 - 1.21.3 - - 3.4.2 - 0.8.13 - - - - - - org.axonframework - axon-messaging - ${axon.version} - - - org.axonframework - axon-spring-boot-autoconfigure - ${axon.version} - - - org.axonframework - axon-test - ${axon.version} - test - - - org.axonframework.extensions.multitenancy - axon-multitenancy-spring-boot-starter - ${project.version} - - - - org.springframework.boot - spring-boot-starter - - - org.yaml - snakeyaml - - - - - org.springframework.boot - spring-boot-starter-log4j2 - - - org.springframework.boot - spring-boot-starter-test - - - - com.fasterxml.jackson.datatype - jackson-datatype-jsr310 - test - - - - org.awaitility - awaitility - test - - - org.testcontainers - junit-jupiter - test - - - org.testcontainers - testcontainers - test - - - - - - - org.testcontainers - testcontainers-bom - ${testcoontainers.version} - pom - import - - - - - - - - - org.apache.maven.plugins - maven-compiler-plugin - - 17 - 17 - UTF-8 - true - true - - - - - org.apache.maven.plugins - maven-jar-plugin - ${jar-plugin.version} - - - - true - - - - - - - org.apache.maven.plugins - maven-deploy-plugin - ${maven-deploy-plugin.version} - - true - - - - - - - - coverage - - false - - coverage - - - - - - org.apache.maven.plugins - maven-surefire-plugin - ${maven-surefire-plugin.version} - - - -Djava.awt.headless=true ${surefireArgLine} - - - - - org.jacoco - jacoco-maven-plugin - ${jacoco-plugin.version} - - - prepare-agent-for-unit-tests - initialize - - prepare-agent - - - surefireArgLine - ${project.build.directory}/jacoco-ut.exec - - - - - - - - - - - - sonatype-snapshots - https://oss.sonatype.org/content/repositories/snapshots - - - \ No newline at end of file diff --git a/multitenancy-spring-boot-3-integrationtests/src/test/java/org/axonframework/extensions/multitenancy/integration/MultiTenancyIntegrationTest.java b/multitenancy-spring-boot-3-integrationtests/src/test/java/org/axonframework/extensions/multitenancy/integration/MultiTenancyIntegrationTest.java deleted file mode 100644 index f5747ba..0000000 --- a/multitenancy-spring-boot-3-integrationtests/src/test/java/org/axonframework/extensions/multitenancy/integration/MultiTenancyIntegrationTest.java +++ /dev/null @@ -1,217 +0,0 @@ -/* - * Copyright (c) 2010-2023. Axon Framework - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -package org.axonframework.extensions.multitenancy.integration; - -import org.axonframework.axonserver.connector.AxonServerConfiguration; -import org.axonframework.commandhandling.CommandBus; -import org.axonframework.commandhandling.CommandMessage; -import org.axonframework.commandhandling.GenericCommandMessage; -import org.axonframework.extensions.multitenancy.components.NoSuchTenantException; -import org.axonframework.extensions.multitenancy.components.TenantDescriptor; -import org.axonframework.extensions.multitenancy.components.commandhandeling.MultiTenantCommandBus; -import org.axonframework.extensions.multitenancy.components.queryhandeling.MultiTenantQueryBus; -import org.axonframework.extensions.multitenancy.components.queryhandeling.MultiTenantQueryUpdateEmitter; -import org.axonframework.messaging.GenericMessage; -import org.axonframework.messaging.Message; -import org.axonframework.messaging.responsetypes.InstanceResponseType; -import org.axonframework.queryhandling.GenericQueryMessage; -import org.axonframework.queryhandling.QueryBus; -import org.axonframework.queryhandling.QueryMessage; -import org.axonframework.queryhandling.QueryResponseMessage; -import org.axonframework.queryhandling.QueryUpdateEmitter; -import org.axonframework.test.server.AxonServerContainer; -import org.junit.jupiter.api.*; -import org.springframework.boot.autoconfigure.EnableAutoConfiguration; -import org.springframework.boot.test.context.runner.ApplicationContextRunner; -import org.springframework.context.annotation.EnableMBeanExport; -import org.springframework.jmx.support.RegistrationPolicy; -import org.springframework.test.context.ContextConfiguration; -import org.testcontainers.junit.jupiter.Container; -import org.testcontainers.junit.jupiter.Testcontainers; - -import java.time.Duration; -import java.util.HashMap; -import java.util.Map; -import java.util.concurrent.ExecutionException; -import java.util.concurrent.atomic.AtomicReference; - -import static org.awaitility.Awaitility.await; -import static org.axonframework.extensions.multitenancy.autoconfig.TenantConfiguration.TENANT_CORRELATION_KEY; -import static org.junit.jupiter.api.Assertions.*; - -@Testcontainers -class MultiTenancyIntegrationTest { - - // The tenantId is "default" as the used Axon Server test container only allows a single context. - private static final String TENANT_ID = "default"; - - private ApplicationContextRunner testApplicationContext; - - @Container - private static final AxonServerContainer AXON_SERVER_CONTAINER = new AxonServerContainer(); - - @BeforeEach - void setUp() { - testApplicationContext = new ApplicationContextRunner() - .withSystemProperties("disable-axoniq-console-message=true") - .withPropertyValues("axon.axonserver.enabled=true") - .withPropertyValues("axon.axonserver.servers=" + AXON_SERVER_CONTAINER.getAxonServerAddress()) - .withUserConfiguration(DefaultContext.class); - } - - @Test - void willUseRegisteredTenantForCommand() { - testApplicationContext.run(context -> { - CommandBus commandBus = context.getBean(CommandBus.class); - assertNotNull(commandBus); - assertTrue(commandBus instanceof MultiTenantCommandBus); - registerTenant((MultiTenantCommandBus) commandBus); - subscribeCommandHandler(commandBus); - executeCommand(commandBus); - }); - } - - @Test - void commandFailsWhenNoTenantSet() { - testApplicationContext.run(context -> { - CommandBus commandBus = context.getBean(CommandBus.class); - assertNotNull(commandBus); - assertTrue(commandBus instanceof MultiTenantCommandBus); - executeCommandWhileTenantNotSet(commandBus); - }); - } - - @Test - void willUseRegisteredTenantForQuery() { - testApplicationContext.run(context -> { - QueryUpdateEmitter emitter = context.getBean(QueryUpdateEmitter.class); - assertNotNull(emitter); - assertTrue(emitter instanceof MultiTenantQueryUpdateEmitter); - QueryBus queryBus = context.getBean(QueryBus.class); - assertNotNull(queryBus); - assertTrue(queryBus instanceof MultiTenantQueryBus); - registerTenant( - (MultiTenantQueryUpdateEmitter) emitter, (MultiTenantQueryBus) queryBus - ); - subscribeQueryHandler(queryBus); - executeQuery(queryBus); - }); - } - - @Test - void queryFailsWhenNoTenantSet() { - testApplicationContext.run(context -> { - QueryBus queryBus = context.getBean(QueryBus.class); - assertNotNull(queryBus); - assertTrue(queryBus instanceof MultiTenantQueryBus); - executeQueryWhileTenantNotSet(queryBus); - }); - } - - @Test - void heartBeatDisabled() { - testApplicationContext.run(context -> { - AxonServerConfiguration axonServerConfiguration = context.getBean(AxonServerConfiguration.class); - assertNotNull(axonServerConfiguration); - assertFalse(axonServerConfiguration.getHeartbeat().isEnabled()); - }); - } - - @Test - void heartBeatEnabled() { - testApplicationContext.withPropertyValues("axon.axonserver.heartbeat.enabled=true") - .run(context -> { - AxonServerConfiguration axonServerConfiguration = - context.getBean(AxonServerConfiguration.class); - assertNotNull(axonServerConfiguration); - assertTrue(axonServerConfiguration.getHeartbeat().isEnabled()); - }); - } - - private void registerTenant(MultiTenantCommandBus commandBus) { - //noinspection resource - commandBus.registerTenant(TenantDescriptor.tenantWithId(TENANT_ID)); - } - - private void registerTenant(MultiTenantQueryUpdateEmitter emitter, MultiTenantQueryBus queryBus) { - //noinspection resource - emitter.registerTenant(TenantDescriptor.tenantWithId(TENANT_ID)); - //noinspection resource - queryBus.registerTenant(TenantDescriptor.tenantWithId(TENANT_ID)); - } - - private void subscribeCommandHandler(CommandBus commandBus) { - //noinspection resource - commandBus.subscribe("testCommand", e -> "correct"); - } - - private void subscribeQueryHandler(QueryBus queryBus) { - //noinspection resource - queryBus.subscribe("testQuery", String.class, e -> "correct"); - } - - private void executeCommand(CommandBus commandBus) { - Message message = new GenericMessage<>("hi"); - Map metadata = new HashMap<>(); - metadata.put(TENANT_CORRELATION_KEY, TENANT_ID); - CommandMessage command = new GenericCommandMessage<>(message, "testCommand").withMetaData(metadata); - AtomicReference result = new AtomicReference<>(); - commandBus.dispatch( - command, - (commandMessage, commandResultMessage) -> result.set((String) commandResultMessage.getPayload()) - ); - await().atMost(Duration.ofSeconds(5)).until(() -> result.get() != null); - assertEquals("correct", result.get()); - } - - private void executeQuery(QueryBus queryBus) throws ExecutionException, InterruptedException { - Message message = new GenericMessage<>("hi"); - Map metadata = new HashMap<>(); - metadata.put(TENANT_CORRELATION_KEY, TENANT_ID); - QueryMessage query = - new GenericQueryMessage<>(message, "testQuery", new InstanceResponseType<>(String.class)) - .withMetaData(metadata); - QueryResponseMessage responseMessage = queryBus.query(query).get(); - assertEquals("correct", responseMessage.getPayload()); - } - - private void executeCommandWhileTenantNotSet(CommandBus commandBus) { - Message message = new GenericMessage<>("hi"); - CommandMessage command = new GenericCommandMessage<>(message, "anotherCommand"); - AtomicReference result = new AtomicReference<>(); - commandBus.dispatch( - command, - (commandMessage, commandResultMessage) -> result.set(commandResultMessage.exceptionResult()) - ); - await().atMost(Duration.ofSeconds(5)).until(() -> result.get() != null); - assertTrue(result.get() instanceof NoSuchTenantException); - } - - private void executeQueryWhileTenantNotSet(QueryBus queryBus) { - Message message = new GenericMessage<>("hi"); - QueryMessage query = - new GenericQueryMessage<>(message, "anotherQuery", new InstanceResponseType<>(String.class)); - assertThrows(NoSuchTenantException.class, () -> queryBus.query(query)); - } - - @ContextConfiguration - @EnableAutoConfiguration - @EnableMBeanExport(registration = RegistrationPolicy.IGNORE_EXISTING) - public static class DefaultContext { - - } -} diff --git a/multitenancy-spring-boot-3-integrationtests/src/test/resources/logback-test.xml b/multitenancy-spring-boot-3-integrationtests/src/test/resources/logback-test.xml deleted file mode 100644 index 1c6d76e..0000000 --- a/multitenancy-spring-boot-3-integrationtests/src/test/resources/logback-test.xml +++ /dev/null @@ -1,31 +0,0 @@ - - - - - - %d{HH:mm:ss.SSS} [%thread] %-5level %logger - %msg%n - - - - - - - - - - - diff --git a/multitenancy-spring-boot-autoconfigure/pom.xml b/multitenancy-spring-boot-autoconfigure/pom.xml index 7b1212e..791fb6a 100644 --- a/multitenancy-spring-boot-autoconfigure/pom.xml +++ b/multitenancy-spring-boot-autoconfigure/pom.xml @@ -19,7 +19,7 @@ axon-multitenancy-parent org.axonframework.extensions.multitenancy - 4.12.1-SNAPSHOT + 5.1.0-SNAPSHOT axon-multitenancy-spring-boot-autoconfigure @@ -31,75 +31,93 @@ - 5.3.39 3.27.3 - - - org.axonframework - axon-configuration - + org.axonframework axon-messaging + - org.axonframework - axon-server-connector - - - org.axonframework + org.axonframework.extensions.spring axon-spring - compile - org.axonframework + org.axonframework.extensions.spring axon-spring-boot-autoconfigure - provided + org.axonframework.extensions.multitenancy axon-multitenancy ${project.version} - + + org.axonframework.extensions.multitenancy + axon-multitenancy-spring + ${project.version} + true + + + org.axonframework.extensions.multitenancy + axon-multitenancy-axon-server-connector + ${project.version} + true + + + + org.springframework.data + spring-data-jpa + true + + org.springframework.boot spring-boot-starter ${spring.boot.version} true - - - org.yaml - snakeyaml - - org.springframework.boot - spring-boot-starter-test + spring-boot-configuration-processor ${spring.boot.version} - test - - - net.minidev - json-smart - - + true org.springframework.boot - spring-boot-test-autoconfigure + spring-boot-autoconfigure-processor ${spring.boot.version} - test + true + org.springframework spring-jdbc - ${spring.web.version} - compile + ${spring.version} + true + + + + org.springframework + spring-r2dbc + ${spring.version} + true + + + + org.springframework.boot + spring-boot-starter-test + ${spring.boot.version} + test + + + org.springframework.boot + spring-boot-test-autoconfigure + ${spring.boot.version} + test org.springframework diff --git a/multitenancy-spring-boot-autoconfigure/src/main/java/org/axonframework/extension/multitenancy/autoconfig/MultiTenancyAutoConfiguration.java b/multitenancy-spring-boot-autoconfigure/src/main/java/org/axonframework/extension/multitenancy/autoconfig/MultiTenancyAutoConfiguration.java new file mode 100644 index 0000000..a37c914 --- /dev/null +++ b/multitenancy-spring-boot-autoconfigure/src/main/java/org/axonframework/extension/multitenancy/autoconfig/MultiTenancyAutoConfiguration.java @@ -0,0 +1,153 @@ +/* + * Copyright (c) 2010-2025. Axon Framework + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.axonframework.extension.multitenancy.autoconfig; + +import org.axonframework.common.configuration.Configuration; +import org.axonframework.eventsourcing.eventstore.EventStore; +import org.axonframework.extension.multitenancy.core.MetadataBasedTenantResolver; +import org.axonframework.extension.multitenancy.core.TargetTenantResolver; +import org.axonframework.extension.multitenancy.core.TenantConnectPredicate; +import org.axonframework.extension.multitenancy.core.configuration.MultiTenantEventProcessorPredicate; +import org.axonframework.messaging.core.Message; +import org.axonframework.messaging.core.correlation.CorrelationDataProvider; +import org.axonframework.messaging.eventhandling.EventSink; +import org.springframework.boot.autoconfigure.AutoConfiguration; +import org.springframework.boot.autoconfigure.AutoConfigureAfter; +import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean; +import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty; +import org.springframework.boot.context.properties.EnableConfigurationProperties; +import org.springframework.context.annotation.Bean; +import org.springframework.context.annotation.Primary; + +/** + * Auto-configuration for multi-tenant Axon Framework support beans. + *

    + * This configuration provides: + *

      + *
    • Property binding via {@link MultiTenancyProperties}
      • + *
    • Default {@link TargetTenantResolver} using message metadata
      • + *
    • Default {@link TenantConnectPredicate} accepting all tenants
      • + *
    • {@link CorrelationDataProvider} for tenant ID propagation
      • + *
    • {@link MultiTenantEventProcessorPredicate} for event processor configuration
      • + *
    + *

    + * The actual multi-tenant infrastructure components (MultiTenantCommandBus, MultiTenantQueryBus, + * MultiTenantEventStore) are created by the {@code MultiTenancyConfigurationDefaults} SPI enhancer + * in the core module. This autoconfiguration only provides the supporting beans that the SPI + * enhancer uses. + *

    + * For Axon Server deployments, the {@code DistributedMultiTenancyConfigurationDefaults} in the + * {@code multitenancy-axon-server-connector} module provides additional components like + * {@code AxonServerTenantProvider} and multi-tenant connectors. + *

    + * Multi-tenancy can be disabled by setting {@code axon.multi-tenancy.enabled=false}. + * + * @author Stefan Dragisic + * @author Theo Emanuelsson + * @since 5.0.0 + * @see MultiTenancyProperties + * @see org.axonframework.extension.multitenancy.core.configuration.MultiTenancyConfigurationDefaults + */ +@AutoConfiguration +@ConditionalOnProperty(value = "axon.multi-tenancy.enabled", matchIfMissing = true) +@AutoConfigureAfter(MultiTenancyAxonServerAutoConfiguration.class) +@EnableConfigurationProperties(MultiTenancyProperties.class) +public class MultiTenancyAutoConfiguration { + + /** + * Creates a default {@link TenantConnectPredicate} that accepts all tenants. + *

    + * Users can override this bean to filter which tenants should be connected. + * + * @return a predicate that returns {@code true} for all tenants + */ + @Bean + @ConditionalOnMissingBean + public TenantConnectPredicate tenantFilterPredicate() { + return tenant -> true; + } + + /** + * Creates a predicate that determines whether multi-tenancy should be enabled + * for a given event processor. + *

    + * By default, enables multi-tenancy for all processors. Users can override + * this bean to selectively enable/disable multi-tenancy per processor. + * + * @return a predicate that enables multi-tenancy for all processors + */ + @Bean + @ConditionalOnMissingBean + public MultiTenantEventProcessorPredicate multiTenantEventProcessorPredicate() { + return MultiTenantEventProcessorPredicate.enableMultiTenancy(); + } + + /** + * Creates the target tenant resolver that extracts the tenant from message metadata. + *

    + * Uses the {@code tenantKey} property from {@link MultiTenancyProperties} to determine + * which metadata key contains the tenant identifier. Defaults to "tenantId". + *

    + * This resolver is used by the SPI-registered multi-tenant components to route + * messages to the appropriate tenant. + * + * @param properties the multi-tenancy configuration properties + * @return the metadata-based tenant resolver + */ + @Bean + @ConditionalOnMissingBean + public TargetTenantResolver targetTenantResolver(MultiTenancyProperties properties) { + return new MetadataBasedTenantResolver(properties.getTenantKey()); + } + + /** + * Creates the correlation data provider that propagates tenant information + * to new messages dispatched during message handling. + *

    + * Uses the {@code tenantKey} property from {@link MultiTenancyProperties} to determine + * which metadata key to propagate. This ensures that when a command handler dispatches + * events or other commands, the tenant ID is automatically included in the new messages. + * + * @param properties the multi-tenancy configuration properties + * @return the tenant correlation provider + */ + @Bean + @ConditionalOnMissingBean(TenantCorrelationProvider.class) + public CorrelationDataProvider tenantCorrelationProvider(MultiTenancyProperties properties) { + return new TenantCorrelationProvider(properties.getTenantKey()); + } + + /** + * Provides the primary {@link EventSink} bean to resolve ambiguity when multiple beans + * implement {@code EventSink}. + *

    + * This is necessary because when multi-tenancy is enabled, both the decorated + * {@link EventStore} and the {@code TenantEventStoreProvider} component are exposed + * as Spring beans by the {@code SpringComponentRegistry}. Since {@code MultiTenantEventStore} + * implements both interfaces, Spring sees duplicate candidates for {@code EventSink}. + *

    + * This bean delegates to the Axon {@link Configuration}'s {@link EventStore}, ensuring + * the properly decorated event store is used as the primary {@code EventSink}. + * + * @param configuration the Axon configuration + * @return the primary event sink (the configured event store) + */ + @Bean + @Primary + public EventSink primaryEventSink(Configuration configuration) { + return configuration.getComponent(EventStore.class); + } +} diff --git a/multitenancy-spring-boot-autoconfigure/src/main/java/org/axonframework/extension/multitenancy/autoconfig/MultiTenancyAutoConfigurationImportFilter.java b/multitenancy-spring-boot-autoconfigure/src/main/java/org/axonframework/extension/multitenancy/autoconfig/MultiTenancyAutoConfigurationImportFilter.java new file mode 100644 index 0000000..2821f82 --- /dev/null +++ b/multitenancy-spring-boot-autoconfigure/src/main/java/org/axonframework/extension/multitenancy/autoconfig/MultiTenancyAutoConfigurationImportFilter.java @@ -0,0 +1,147 @@ +/* + * Copyright (c) 2010-2025. Axon Framework + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.axonframework.extension.multitenancy.autoconfig; + +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; +import org.springframework.boot.autoconfigure.AutoConfigurationImportFilter; +import org.springframework.boot.autoconfigure.AutoConfigurationMetadata; +import org.springframework.context.EnvironmentAware; +import org.springframework.core.env.Environment; + +import java.util.Set; + +/** + * An {@link AutoConfigurationImportFilter} that excludes conflicting autoconfiguration + * classes when multi-tenancy is enabled. + *

    + * When {@code axon.multi-tenancy.enabled=true} (the default), this filter prevents + * the following Axon Framework autoconfiguration classes from loading: + *

      + *
    • {@code InfrastructureConfiguration} - Replaced by multi-tenant message handler lookup
      • + *
    • {@code JpaAutoConfiguration} - TokenStore replaced by TenantTokenStoreFactory
      • + *
    • {@code JpaEventStoreAutoConfiguration} - EventStore replaced by MultiTenantEventStore via SPI
      • + *
    + *

    + * Additionally, when {@code axon.multi-tenancy.jpa.tenant-repositories=true}, this filter + * also excludes Spring Boot's JPA autoconfiguration to allow per-tenant EntityManagerFactory: + *

      + *
    • {@code HibernateJpaAutoConfiguration} - Replaced by tenant-specific EMF instances
      • + *
    • {@code JpaRepositoriesAutoConfiguration} - Replaced by tenant-scoped repositories
      • + *
    + * + * @author Theo Emanuelsson + * @since 5.0.0 + * @see MultiTenantEventProcessingAutoConfiguration + * @see MultiTenancySpringDataJpaAutoConfiguration + */ +public class MultiTenancyAutoConfigurationImportFilter implements AutoConfigurationImportFilter, EnvironmentAware { + + private static final Logger logger = LoggerFactory.getLogger(MultiTenancyAutoConfigurationImportFilter.class); + + /** + * Axon Framework autoconfiguration classes to exclude when multi-tenancy is enabled. + */ + private static final Set EXCLUDED_WHEN_MULTITENANCY_ENABLED = Set.of( + // Provides MessageHandlerLookup which creates standard (non-multi-tenant) event processors + "org.axonframework.extension.springboot.autoconfig.InfrastructureConfiguration", + // Provides single JpaTokenStore - we need TenantTokenStoreFactory for per-tenant stores + "org.axonframework.extension.springboot.autoconfig.JpaAutoConfiguration", + // Provides JPA EventStorageEngine - we use MultiTenantEventStore via SPI instead + "org.axonframework.extension.springboot.autoconfig.JpaEventStoreAutoConfiguration" + ); + + /** + * Spring Boot JPA autoconfiguration classes to exclude when tenant repositories are enabled. + */ + private static final Set EXCLUDED_WHEN_TENANT_REPOSITORIES_ENABLED = Set.of( + // Provides default EntityManagerFactory - we use per-tenant EMF instances + "org.springframework.boot.autoconfigure.orm.jpa.HibernateJpaAutoConfiguration", + // Provides default repository beans - we use tenant-scoped repositories + "org.springframework.boot.autoconfigure.data.jpa.JpaRepositoriesAutoConfiguration" + ); + + private Environment environment; + + @Override + public void setEnvironment(Environment environment) { + this.environment = environment; + } + + @Override + public boolean[] match(String[] autoConfigurationClasses, AutoConfigurationMetadata autoConfigurationMetadata) { + boolean multiTenancyEnabled = isMultiTenancyEnabled(); + boolean tenantRepositoriesEnabled = isTenantRepositoriesEnabled(); + + if (autoConfigurationClasses.length > 1) { + logger.debug("MultiTenancyAutoConfigurationImportFilter: multiTenancyEnabled={}, tenantRepositoriesEnabled={}", + multiTenancyEnabled, tenantRepositoriesEnabled); + } + + boolean[] matches = new boolean[autoConfigurationClasses.length]; + for (int i = 0; i < autoConfigurationClasses.length; i++) { + String className = autoConfigurationClasses[i]; + if (className == null) { + matches[i] = true; // Include null entries (they're already filtered out elsewhere) + continue; + } + + // Exclude Axon Framework autoconfiguration when multi-tenancy is enabled + if (multiTenancyEnabled && EXCLUDED_WHEN_MULTITENANCY_ENABLED.contains(className)) { + logger.debug("Multi-tenancy enabled: EXCLUDING [{}]", className); + matches[i] = false; + continue; + } + + // Exclude Spring JPA autoconfiguration when tenant repositories are enabled + if (tenantRepositoriesEnabled && EXCLUDED_WHEN_TENANT_REPOSITORIES_ENABLED.contains(className)) { + logger.debug("Tenant repositories enabled: EXCLUDING [{}]", className); + matches[i] = false; + continue; + } + + matches[i] = true; // INCLUDE + } + return matches; + } + + /** + * Checks if multi-tenancy is enabled via the {@code axon.multi-tenancy.enabled} property. + * Defaults to {@code true} if the property is not set. + * + * @return {@code true} if multi-tenancy is enabled, {@code false} otherwise + */ + private boolean isMultiTenancyEnabled() { + if (environment == null) { + // Default to enabled if environment is not available + return true; + } + return environment.getProperty("axon.multi-tenancy.enabled", Boolean.class, true); + } + + /** + * Checks if tenant repositories are enabled via the {@code axon.multi-tenancy.jpa.tenant-repositories} property. + * Defaults to {@code false} if the property is not set. + * + * @return {@code true} if tenant repositories are enabled, {@code false} otherwise + */ + private boolean isTenantRepositoriesEnabled() { + if (environment == null) { + return false; + } + return environment.getProperty("axon.multi-tenancy.jpa.tenant-repositories", Boolean.class, false); + } +} diff --git a/multitenancy-spring-boot-autoconfigure/src/main/java/org/axonframework/extension/multitenancy/autoconfig/MultiTenancyAxonServerAutoConfiguration.java b/multitenancy-spring-boot-autoconfigure/src/main/java/org/axonframework/extension/multitenancy/autoconfig/MultiTenancyAxonServerAutoConfiguration.java new file mode 100644 index 0000000..010625a --- /dev/null +++ b/multitenancy-spring-boot-autoconfigure/src/main/java/org/axonframework/extension/multitenancy/autoconfig/MultiTenancyAxonServerAutoConfiguration.java @@ -0,0 +1,103 @@ +/* + * Copyright (c) 2010-2025. Axon Framework + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.axonframework.extension.multitenancy.autoconfig; + +import org.axonframework.axonserver.connector.AxonServerConfiguration; +import org.axonframework.axonserver.connector.AxonServerConnectionManager; +import org.axonframework.extension.springboot.autoconfig.AxonAutoConfiguration; +import org.axonframework.extension.multitenancy.axonserver.AxonServerTenantProvider; +import org.axonframework.extension.multitenancy.core.TenantConnectPredicate; +import org.axonframework.extension.multitenancy.core.TenantProvider; +import org.springframework.boot.autoconfigure.AutoConfiguration; +import org.springframework.boot.autoconfigure.AutoConfigureAfter; +import org.springframework.boot.autoconfigure.condition.ConditionalOnBean; +import org.springframework.boot.autoconfigure.condition.ConditionalOnClass; +import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean; +import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty; +import org.springframework.boot.context.properties.EnableConfigurationProperties; +import org.springframework.context.annotation.Bean; + +/** + * Auto-configuration for Axon Server multi-tenancy integration. + *

    + * This configuration provides property binding for the {@code AxonServerTenantProvider} + * which is auto-registered via SPI by the {@code multitenancy-axon-server-connector} module. + *

    + * When Axon Server is available and multi-tenancy is enabled, this configuration ensures + * that the {@link AxonServerTenantProvider} is properly configured with: + *

      + *
    • Predefined contexts from {@code axon.multi-tenancy.axon-server.contexts}
      • + *
    • Admin context filtering from {@code axon.multi-tenancy.axon-server.filter-admin-contexts}
      • + *
    + *

    + * The actual {@link TenantProvider} registration is handled by + * {@code DistributedMultiTenancyConfigurationDefaults} in the connector module via SPI. This auto-configuration + * only provides property binding and conditional bean overrides. + * + * @author Stefan Dragisic + * @author Theo Emanuelsson + * @since 5.0.0 + * @see AxonServerTenantProvider + * @see MultiTenancyProperties + */ +@AutoConfiguration +@AutoConfigureAfter(AxonAutoConfiguration.class) +@ConditionalOnClass(AxonServerConfiguration.class) +@ConditionalOnProperty(value = {"axon.axonserver.enabled", "axon.multi-tenancy.enabled"}, matchIfMissing = true) +@EnableConfigurationProperties(MultiTenancyProperties.class) +public class MultiTenancyAxonServerAutoConfiguration { + + /** + * Creates an {@link AxonServerTenantProvider} with property-based configuration. + *

    + * This bean is only created if: + *

      + *
    • An {@link AxonServerConnectionManager} is available
      • + *
    • No other {@link TenantProvider} has been registered
      • + *
    + *

    + * In most cases, the {@code DistributedMultiTenancyConfigurationDefaults} from the connector module + * will have already registered the provider via SPI. This bean serves as a fallback + * that includes Spring Boot property binding for contexts and filtering. + * + * @param properties the multi-tenancy configuration properties + * @param tenantConnectPredicate predicate for filtering which contexts become tenants + * @param connectionManager the Axon Server connection manager + * @return the configured Axon Server tenant provider + */ + @Bean + @ConditionalOnBean(AxonServerConnectionManager.class) + @ConditionalOnMissingBean(TenantProvider.class) + public TenantProvider tenantProvider(MultiTenancyProperties properties, + TenantConnectPredicate tenantConnectPredicate, + AxonServerConnectionManager connectionManager) { + MultiTenancyProperties.AxonServerProperties axonServerProps = properties.getAxonServer(); + + TenantConnectPredicate effectivePredicate = tenantConnectPredicate; + if (axonServerProps.isFilterAdminContexts()) { + // Filter out admin contexts (those starting with "_") + effectivePredicate = tenant -> + tenantConnectPredicate.test(tenant) && + !tenant.tenantId().startsWith("_"); + } + + return AxonServerTenantProvider.builder() + .axonServerConnectionManager(connectionManager) + .preDefinedContexts(axonServerProps.getContexts()) + .tenantConnectPredicate(effectivePredicate) + .build(); + } +} diff --git a/multitenancy-spring-boot-autoconfigure/src/main/java/org/axonframework/extension/multitenancy/autoconfig/MultiTenancyJdbcAutoConfiguration.java b/multitenancy-spring-boot-autoconfigure/src/main/java/org/axonframework/extension/multitenancy/autoconfig/MultiTenancyJdbcAutoConfiguration.java new file mode 100644 index 0000000..0c3f2df --- /dev/null +++ b/multitenancy-spring-boot-autoconfigure/src/main/java/org/axonframework/extension/multitenancy/autoconfig/MultiTenancyJdbcAutoConfiguration.java @@ -0,0 +1,142 @@ +/* + * Copyright (c) 2010-2025. Axon Framework + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.axonframework.extension.multitenancy.autoconfig; + +import jakarta.annotation.Nonnull; +import org.axonframework.extension.multitenancy.core.TenantComponentRegistry; +import org.axonframework.extension.multitenancy.core.TenantProvider; +import org.axonframework.extension.multitenancy.messaging.core.annotation.TenantComponentResolverFactory; +import org.axonframework.extension.multitenancy.spring.data.jpa.TenantDataSourceProvider; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; +import org.springframework.boot.autoconfigure.AutoConfiguration; +import org.springframework.boot.autoconfigure.condition.ConditionalOnBean; +import org.springframework.boot.autoconfigure.condition.ConditionalOnClass; +import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean; +import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty; +import org.springframework.boot.context.properties.EnableConfigurationProperties; +import org.springframework.context.annotation.Bean; +import org.springframework.jdbc.core.JdbcTemplate; +import org.springframework.jdbc.core.namedparam.NamedParameterJdbcTemplate; + +/** + * Auto-configuration for multi-tenant JDBC support. + *

    + * This configuration is activated when {@code axon.multi-tenancy.jdbc.enabled=true}. + * When enabled, it registers {@link JdbcTemplate} and {@link NamedParameterJdbcTemplate} + * as tenant-scoped components that can be injected into message handlers. + *

    + * This provides a lightweight alternative to JPA for projections and queries, + * offering better performance for simple CRUD operations without ORM overhead. + *

    + * Example usage: + * 

    {@code
+ * @Component
+ * public class CourseProjector {
+ *     @EventHandler
+ *     public void on(CourseCreatedEvent event, JdbcTemplate jdbcTemplate) {
+ *         // jdbcTemplate is automatically scoped to the tenant from event metadata
+ *         jdbcTemplate.update(
+ *             "INSERT INTO courses (id, title) VALUES (?, ?)",
+ *             event.courseId(), event.title()
+ *         );
+ *     }
+ * }
+ * }
    + * + * @author Theo Emanuelsson + * @since 5.0.0 + * @see TenantDataSourceProvider + * @see MultiTenancySpringDataJpaAutoConfiguration + */ +@AutoConfiguration(after = MultiTenancyAutoConfiguration.class) +@ConditionalOnClass(JdbcTemplate.class) +@ConditionalOnBean({TenantDataSourceProvider.class, TenantComponentResolverFactory.class, TenantProvider.class}) +@ConditionalOnProperty(value = "axon.multi-tenancy.jdbc.enabled", havingValue = "true") +@EnableConfigurationProperties(MultiTenancyProperties.class) +public class MultiTenancyJdbcAutoConfiguration { + + private static final Logger logger = LoggerFactory.getLogger(MultiTenancyJdbcAutoConfiguration.class); + + /** + * Registers {@link JdbcTemplate} as a tenant-scoped component. + *

    + * Each tenant will receive a {@link JdbcTemplate} instance configured with their + * tenant-specific {@link javax.sql.DataSource}. + * + * @param dataSourceProvider the provider for tenant-specific DataSources + * @param resolverFactory the factory for creating tenant component resolvers + * @param tenantProvider the tenant provider for lifecycle management + * @return a registry of tenant-scoped JdbcTemplate instances + */ + @Bean + @ConditionalOnMissingBean(name = "tenantJdbcTemplateRegistry") + public TenantComponentRegistry tenantJdbcTemplateRegistry( + @Nonnull TenantDataSourceProvider dataSourceProvider, + @Nonnull TenantComponentResolverFactory resolverFactory, + @Nonnull TenantProvider tenantProvider) { + + logger.debug("Registering JdbcTemplate as tenant component"); + + TenantComponentRegistry registry = resolverFactory.registerComponent( + JdbcTemplate.class, + tenant -> { + logger.debug("Creating JdbcTemplate for tenant {}", tenant.tenantId()); + return new JdbcTemplate(dataSourceProvider.apply(tenant)); + } + ); + + tenantProvider.subscribe(registry); + tenantProvider.getTenants().forEach(registry::registerTenant); + + return registry; + } + + /** + * Registers {@link NamedParameterJdbcTemplate} as a tenant-scoped component. + *

    + * Each tenant will receive a {@link NamedParameterJdbcTemplate} instance that + * allows using named parameters (e.g., {@code :paramName}) instead of positional + * parameters ({@code ?}) in SQL queries. + * + * @param dataSourceProvider the provider for tenant-specific DataSources + * @param resolverFactory the factory for creating tenant component resolvers + * @param tenantProvider the tenant provider for lifecycle management + * @return a registry of tenant-scoped NamedParameterJdbcTemplate instances + */ + @Bean + @ConditionalOnMissingBean(name = "tenantNamedParameterJdbcTemplateRegistry") + public TenantComponentRegistry tenantNamedParameterJdbcTemplateRegistry( + @Nonnull TenantDataSourceProvider dataSourceProvider, + @Nonnull TenantComponentResolverFactory resolverFactory, + @Nonnull TenantProvider tenantProvider) { + + logger.debug("Registering NamedParameterJdbcTemplate as tenant component"); + + TenantComponentRegistry registry = resolverFactory.registerComponent( + NamedParameterJdbcTemplate.class, + tenant -> { + logger.debug("Creating NamedParameterJdbcTemplate for tenant {}", tenant.tenantId()); + return new NamedParameterJdbcTemplate(dataSourceProvider.apply(tenant)); + } + ); + + tenantProvider.subscribe(registry); + tenantProvider.getTenants().forEach(registry::registerTenant); + + return registry; + } +} diff --git a/multitenancy-spring-boot-autoconfigure/src/main/java/org/axonframework/extension/multitenancy/autoconfig/MultiTenancyProperties.java b/multitenancy-spring-boot-autoconfigure/src/main/java/org/axonframework/extension/multitenancy/autoconfig/MultiTenancyProperties.java new file mode 100644 index 0000000..734e5db --- /dev/null +++ b/multitenancy-spring-boot-autoconfigure/src/main/java/org/axonframework/extension/multitenancy/autoconfig/MultiTenancyProperties.java @@ -0,0 +1,450 @@ +/* + * Copyright (c) 2010-2025. Axon Framework + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.axonframework.extension.multitenancy.autoconfig; + +import org.springframework.boot.context.properties.ConfigurationProperties; + +import java.util.ArrayList; +import java.util.List; + +/** + * Configuration properties for Axon Framework multi-tenancy extension. + *

    + * These properties allow customization of multi-tenancy behavior including + * enabling/disabling the feature, configuring the tenant key used in message + * metadata, and providing a static list of tenants for non-Axon Server deployments. + * + * @author Theo Emanuelsson + * @since 5.0.0 + */ +@ConfigurationProperties("axon.multi-tenancy") +public class MultiTenancyProperties { + + /** + * Whether multi-tenancy is enabled. Defaults to {@code true}. + */ + private boolean enabled = true; + + /** + * The metadata key used to identify the tenant. Defaults to {@code "tenantId"}. + * This key is used by {@link org.axonframework.extension.multitenancy.core.MetadataBasedTenantResolver} + * to extract the tenant from message metadata. + */ + private String tenantKey = TenantConfiguration.TENANT_CORRELATION_KEY; + + /** + * Static list of tenant identifiers. Use this for non-Axon Server deployments + * where tenants are known at configuration time. + *

    + * When using Axon Server, tenants are typically discovered dynamically from + * Axon Server contexts via the {@code multitenancy-axon-server-connector} module. + */ + private List tenants = new ArrayList<>(); + + /** + * Axon Server specific configuration for multi-tenancy. + */ + private AxonServerProperties axonServer = new AxonServerProperties(); + + /** + * Data access configuration for multi-tenant repositories. + */ + private DataAccessProperties dataAccess = new DataAccessProperties(); + + /** + * JPA-specific configuration for multi-tenant data access. + */ + private JpaProperties jpa = new JpaProperties(); + + /** + * JDBC-specific configuration for multi-tenant data access. + */ + private JdbcProperties jdbc = new JdbcProperties(); + + /** + * R2DBC-specific configuration for multi-tenant reactive data access. + */ + private R2dbcProperties r2dbc = new R2dbcProperties(); + + /** + * Returns whether multi-tenancy is enabled. + * + * @return {@code true} if multi-tenancy is enabled, {@code false} otherwise + */ + public boolean isEnabled() { + return enabled; + } + + /** + * Sets whether multi-tenancy is enabled. + * + * @param enabled {@code true} to enable multi-tenancy, {@code false} to disable + */ + public void setEnabled(boolean enabled) { + this.enabled = enabled; + } + + /** + * Returns the metadata key used to identify the tenant. + * + * @return the tenant key + */ + public String getTenantKey() { + return tenantKey; + } + + /** + * Sets the metadata key used to identify the tenant. + * + * @param tenantKey the tenant key + */ + public void setTenantKey(String tenantKey) { + this.tenantKey = tenantKey; + } + + /** + * Returns the static list of tenant identifiers. + * + * @return the list of tenant identifiers + */ + public List getTenants() { + return tenants; + } + + /** + * Sets the static list of tenant identifiers. + * + * @param tenants the list of tenant identifiers + */ + public void setTenants(List tenants) { + this.tenants = tenants; + } + + /** + * Returns the Axon Server specific configuration. + * + * @return the Axon Server properties + */ + public AxonServerProperties getAxonServer() { + return axonServer; + } + + /** + * Sets the Axon Server specific configuration. + * + * @param axonServer the Axon Server properties + */ + public void setAxonServer(AxonServerProperties axonServer) { + this.axonServer = axonServer; + } + + /** + * Returns the data access configuration. + * + * @return the data access properties + */ + public DataAccessProperties getDataAccess() { + return dataAccess; + } + + /** + * Sets the data access configuration. + * + * @param dataAccess the data access properties + */ + public void setDataAccess(DataAccessProperties dataAccess) { + this.dataAccess = dataAccess; + } + + /** + * Returns the JPA-specific configuration. + * + * @return the JPA properties + */ + public JpaProperties getJpa() { + return jpa; + } + + /** + * Sets the JPA-specific configuration. + * + * @param jpa the JPA properties + */ + public void setJpa(JpaProperties jpa) { + this.jpa = jpa; + } + + /** + * Returns the JDBC-specific configuration. + * + * @return the JDBC properties + */ + public JdbcProperties getJdbc() { + return jdbc; + } + + /** + * Sets the JDBC-specific configuration. + * + * @param jdbc the JDBC properties + */ + public void setJdbc(JdbcProperties jdbc) { + this.jdbc = jdbc; + } + + /** + * Returns the R2DBC-specific configuration. + * + * @return the R2DBC properties + */ + public R2dbcProperties getR2dbc() { + return r2dbc; + } + + /** + * Sets the R2DBC-specific configuration. + * + * @param r2dbc the R2DBC properties + */ + public void setR2dbc(R2dbcProperties r2dbc) { + this.r2dbc = r2dbc; + } + + /** + * Axon Server specific properties for multi-tenancy configuration. + *

    + * These properties are passed to the {@code AxonServerTenantProvider} in the + * {@code multitenancy-axon-server-connector} module when Axon Server is used. + */ + public static class AxonServerProperties { + + /** + * Comma-separated list of predefined Axon Server context names to use as tenants. + * When set, the tenant provider will not query Axon Server's Admin API for contexts + * and will not subscribe to context update events. + *

    + * Leave empty to discover tenants dynamically from Axon Server. + */ + private String contexts; + + /** + * Whether to filter out admin contexts (those starting with "_") from + * the list of tenants. Defaults to {@code true}. + */ + private boolean filterAdminContexts = true; + + /** + * Returns the comma-separated list of predefined context names. + * + * @return the predefined contexts, or {@code null} if dynamic discovery is used + */ + public String getContexts() { + return contexts; + } + + /** + * Sets the comma-separated list of predefined context names. + * + * @param contexts the predefined contexts + */ + public void setContexts(String contexts) { + this.contexts = contexts; + } + + /** + * Returns whether admin contexts should be filtered out. + * + * @return {@code true} if admin contexts are filtered, {@code false} otherwise + */ + public boolean isFilterAdminContexts() { + return filterAdminContexts; + } + + /** + * Sets whether admin contexts should be filtered out. + * + * @param filterAdminContexts {@code true} to filter admin contexts + */ + public void setFilterAdminContexts(boolean filterAdminContexts) { + this.filterAdminContexts = filterAdminContexts; + } + } + + /** + * Data access properties for multi-tenant Spring Data repository injection. + *

    + * When enabled, Spring Data JPA repositories can be injected as handler parameters + * and will automatically be scoped to the current message's tenant. + */ + public static class DataAccessProperties { + + /** + * Whether tenant-scoped data access is enabled. Defaults to {@code true}. + *

    + * When enabled, event handlers can receive tenant-scoped Spring Data repositories + * as parameters, automatically configured for the message's tenant. + */ + private boolean enabled = true; + + /** + * Returns whether tenant-scoped data access is enabled. + * + * @return {@code true} if enabled, {@code false} otherwise + */ + public boolean isEnabled() { + return enabled; + } + + /** + * Sets whether tenant-scoped data access is enabled. + * + * @param enabled {@code true} to enable tenant-scoped data access + */ + public void setEnabled(boolean enabled) { + this.enabled = enabled; + } + } + + /** + * JPA-specific properties for multi-tenant data access. + *

    + * When {@code tenant-repositories} is enabled, Spring Boot's default JPA autoconfiguration + * is excluded (HibernateJpaAutoConfiguration, JpaRepositoriesAutoConfiguration), and + * tenant-specific EntityManagerFactory instances are used instead. + */ + public static class JpaProperties { + + /** + * Whether to enable per-tenant JPA repositories. Defaults to {@code false}. + *

    + * When enabled: + *

      + *
    • Spring Boot's default JPA autoconfiguration is excluded
      • + *
    • A {@link org.axonframework.extension.multitenancy.spring.data.jpa.TenantDataSourceProvider} + * bean is required
      • + *
    • Spring Data repositories extending {@link org.springframework.data.repository.Repository} + * are automatically scoped to the current message's tenant
      • + *
    + *

    + * When disabled, JPA works normally with Spring Boot's default single-datasource configuration. + */ + private boolean tenantRepositories = false; + + /** + * Returns whether per-tenant JPA repositories are enabled. + * + * @return {@code true} if tenant repositories are enabled, {@code false} otherwise + */ + public boolean isTenantRepositories() { + return tenantRepositories; + } + + /** + * Sets whether per-tenant JPA repositories are enabled. + * + * @param tenantRepositories {@code true} to enable per-tenant repositories + */ + public void setTenantRepositories(boolean tenantRepositories) { + this.tenantRepositories = tenantRepositories; + } + } + + /** + * JDBC-specific properties for multi-tenant data access. + *

    + * When enabled, {@link org.springframework.jdbc.core.JdbcTemplate} and + * {@link org.springframework.jdbc.core.namedparam.NamedParameterJdbcTemplate} + * are registered as tenant-scoped components that can be injected into message handlers. + *

    + * This provides a lightweight alternative to JPA for projections and queries. + */ + public static class JdbcProperties { + + /** + * Whether to enable per-tenant JDBC templates. Defaults to {@code false}. + *

    + * When enabled: + *

      + *
    • A {@link org.axonframework.extension.multitenancy.spring.data.jpa.TenantDataSourceProvider} + * bean is required
      • + *
    • {@link org.springframework.jdbc.core.JdbcTemplate} can be injected into message handlers
      • + *
    • {@link org.springframework.jdbc.core.namedparam.NamedParameterJdbcTemplate} can be injected + * into message handlers
      • + *
    + */ + private boolean enabled = false; + + /** + * Returns whether per-tenant JDBC templates are enabled. + * + * @return {@code true} if JDBC templates are enabled, {@code false} otherwise + */ + public boolean isEnabled() { + return enabled; + } + + /** + * Sets whether per-tenant JDBC templates are enabled. + * + * @param enabled {@code true} to enable per-tenant JDBC templates + */ + public void setEnabled(boolean enabled) { + this.enabled = enabled; + } + } + + /** + * R2DBC-specific properties for multi-tenant reactive data access. + *

    + * When enabled, {@link org.springframework.r2dbc.core.DatabaseClient} + * is registered as a tenant-scoped component that can be injected into message handlers + * for non-blocking database operations. + *

    + * R2DBC is beneficial in high-concurrency scenarios when not using virtual threads. + */ + public static class R2dbcProperties { + + /** + * Whether to enable per-tenant R2DBC database clients. Defaults to {@code false}. + *

    + * When enabled: + *

      + *
    • A {@link org.axonframework.extension.multitenancy.spring.data.r2dbc.TenantConnectionFactoryProvider} + * bean is required
      • + *
    • {@link org.springframework.r2dbc.core.DatabaseClient} can be injected into message handlers
      • + *
    + */ + private boolean enabled = false; + + /** + * Returns whether per-tenant R2DBC database clients are enabled. + * + * @return {@code true} if R2DBC is enabled, {@code false} otherwise + */ + public boolean isEnabled() { + return enabled; + } + + /** + * Sets whether per-tenant R2DBC database clients are enabled. + * + * @param enabled {@code true} to enable per-tenant R2DBC + */ + public void setEnabled(boolean enabled) { + this.enabled = enabled; + } + } +} diff --git a/multitenancy-spring-boot-autoconfigure/src/main/java/org/axonframework/extension/multitenancy/autoconfig/MultiTenancyR2dbcAutoConfiguration.java b/multitenancy-spring-boot-autoconfigure/src/main/java/org/axonframework/extension/multitenancy/autoconfig/MultiTenancyR2dbcAutoConfiguration.java new file mode 100644 index 0000000..221dd90 --- /dev/null +++ b/multitenancy-spring-boot-autoconfigure/src/main/java/org/axonframework/extension/multitenancy/autoconfig/MultiTenancyR2dbcAutoConfiguration.java @@ -0,0 +1,107 @@ +/* + * Copyright (c) 2010-2025. Axon Framework + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.axonframework.extension.multitenancy.autoconfig; + +import jakarta.annotation.Nonnull; +import org.axonframework.extension.multitenancy.core.TenantComponentRegistry; +import org.axonframework.extension.multitenancy.core.TenantProvider; +import org.axonframework.extension.multitenancy.messaging.core.annotation.TenantComponentResolverFactory; +import org.axonframework.extension.multitenancy.spring.data.r2dbc.TenantConnectionFactoryProvider; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; +import org.springframework.boot.autoconfigure.AutoConfiguration; +import org.springframework.boot.autoconfigure.condition.ConditionalOnBean; +import org.springframework.boot.autoconfigure.condition.ConditionalOnClass; +import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean; +import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty; +import org.springframework.boot.context.properties.EnableConfigurationProperties; +import org.springframework.context.annotation.Bean; +import org.springframework.r2dbc.core.DatabaseClient; + +/** + * Auto-configuration for multi-tenant R2DBC (reactive database) support. + *

    + * This configuration is activated when {@code axon.multi-tenancy.r2dbc.enabled=true}. + * When enabled, it registers {@link DatabaseClient} as a tenant-scoped component + * that can be injected into message handlers for non-blocking database operations. + *

    + * R2DBC provides reactive, non-blocking database access which can be beneficial + * in high-concurrency scenarios when not using virtual threads. + *

    + * Example usage: + * 

    {@code
+ * @Component
+ * public class CourseProjector {
+ *     @EventHandler
+ *     public Mono on(CourseCreatedEvent event, DatabaseClient databaseClient) {
+ *         // databaseClient is automatically scoped to the tenant from event metadata
+ *         return databaseClient
+ *             .sql("INSERT INTO courses (id, title) VALUES (:id, :title)")
+ *             .bind("id", event.courseId())
+ *             .bind("title", event.title())
+ *             .then();
+ *     }
+ * }
+ * }
    + * + * @author Theo Emanuelsson + * @since 5.0.0 + * @see TenantConnectionFactoryProvider + * @see MultiTenancyJdbcAutoConfiguration + */ +@AutoConfiguration(after = MultiTenancyAutoConfiguration.class) +@ConditionalOnClass(DatabaseClient.class) +@ConditionalOnBean({TenantConnectionFactoryProvider.class, TenantComponentResolverFactory.class, TenantProvider.class}) +@ConditionalOnProperty(value = "axon.multi-tenancy.r2dbc.enabled", havingValue = "true") +@EnableConfigurationProperties(MultiTenancyProperties.class) +public class MultiTenancyR2dbcAutoConfiguration { + + private static final Logger logger = LoggerFactory.getLogger(MultiTenancyR2dbcAutoConfiguration.class); + + /** + * Registers {@link DatabaseClient} as a tenant-scoped component. + *

    + * Each tenant will receive a {@link DatabaseClient} instance configured with their + * tenant-specific {@link io.r2dbc.spi.ConnectionFactory}. + * + * @param connectionFactoryProvider the provider for tenant-specific ConnectionFactories + * @param resolverFactory the factory for creating tenant component resolvers + * @param tenantProvider the tenant provider for lifecycle management + * @return a registry of tenant-scoped DatabaseClient instances + */ + @Bean + @ConditionalOnMissingBean(name = "tenantDatabaseClientRegistry") + public TenantComponentRegistry tenantDatabaseClientRegistry( + @Nonnull TenantConnectionFactoryProvider connectionFactoryProvider, + @Nonnull TenantComponentResolverFactory resolverFactory, + @Nonnull TenantProvider tenantProvider) { + + logger.debug("Registering DatabaseClient as tenant component"); + + TenantComponentRegistry registry = resolverFactory.registerComponent( + DatabaseClient.class, + tenant -> { + logger.debug("Creating DatabaseClient for tenant {}", tenant.tenantId()); + return DatabaseClient.create(connectionFactoryProvider.apply(tenant)); + } + ); + + tenantProvider.subscribe(registry); + tenantProvider.getTenants().forEach(registry::registerTenant); + + return registry; + } +} diff --git a/multitenancy-spring-boot-autoconfigure/src/main/java/org/axonframework/extension/multitenancy/autoconfig/MultiTenancySpringDataJpaAutoConfiguration.java b/multitenancy-spring-boot-autoconfigure/src/main/java/org/axonframework/extension/multitenancy/autoconfig/MultiTenancySpringDataJpaAutoConfiguration.java new file mode 100644 index 0000000..cc92a8c --- /dev/null +++ b/multitenancy-spring-boot-autoconfigure/src/main/java/org/axonframework/extension/multitenancy/autoconfig/MultiTenancySpringDataJpaAutoConfiguration.java @@ -0,0 +1,324 @@ +/* + * Copyright (c) 2010-2025. Axon Framework + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.axonframework.extension.multitenancy.autoconfig; + +import jakarta.annotation.Nonnull; +import org.axonframework.common.configuration.ComponentRegistry; +import org.axonframework.common.configuration.ConfigurationEnhancer; +import org.axonframework.extension.multitenancy.core.TargetTenantResolver; +import org.axonframework.extension.multitenancy.core.TenantComponentFactory; +import org.axonframework.extension.multitenancy.core.TenantComponentRegistry; +import org.axonframework.extension.multitenancy.core.TenantProvider; +import org.axonframework.extension.multitenancy.messaging.core.annotation.TenantComponentResolverFactory; +import org.axonframework.extension.multitenancy.messaging.core.unitofwork.annotation.TenantAwareProcessingContextResolverFactory; +import org.axonframework.extension.multitenancy.spring.data.jpa.TenantDataSourceProvider; +import org.axonframework.extension.multitenancy.spring.data.jpa.TenantEntityManagerFactoryBuilder; +import org.axonframework.extension.multitenancy.spring.data.jpa.TenantJpaRepositoryFactory; +import org.axonframework.extension.multitenancy.spring.data.jpa.TenantTransactionManagerBuilder; +import org.axonframework.messaging.core.Message; +import org.axonframework.messaging.core.annotation.MultiParameterResolverFactory; +import org.axonframework.messaging.core.configuration.reflection.ParameterResolverFactoryUtils; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; +import org.springframework.beans.factory.BeanFactory; +import org.springframework.beans.factory.annotation.AnnotatedBeanDefinition; +import org.springframework.beans.factory.config.BeanDefinition; +import org.springframework.boot.autoconfigure.AutoConfiguration; +import org.springframework.boot.autoconfigure.AutoConfigurationPackages; +import org.springframework.boot.autoconfigure.condition.ConditionalOnBean; +import org.springframework.boot.autoconfigure.condition.ConditionalOnClass; +import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean; +import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty; +import org.springframework.boot.context.properties.EnableConfigurationProperties; +import org.springframework.context.annotation.Bean; +import org.springframework.context.annotation.ClassPathScanningCandidateComponentProvider; +import org.springframework.core.type.filter.AssignableTypeFilter; +import org.springframework.data.jpa.repository.JpaRepository; +import org.springframework.data.repository.Repository; + +import java.util.ArrayList; +import java.util.HashSet; +import java.util.List; +import java.util.Set; + +/** + * Auto-configuration for multi-tenant Spring Data JPA support. + *

    + * This configuration is activated when {@code axon.multi-tenancy.jpa.tenant-repositories=true}. + * When enabled, it: + *

      + *
    1. Requires a {@link TenantDataSourceProvider} bean to be present
      2. + *
    2. Creates a {@link TenantEntityManagerFactoryBuilder} for building tenant-specific EntityManagerFactories
      3. + *
    3. Creates a {@link TenantTransactionManagerBuilder} for building tenant-specific TransactionManagers
      4. + *
    4. Scans for all Spring Data repository interfaces (extending {@link Repository})
      5. + *
    5. Registers each repository as a tenant component for automatic tenant-scoped injection
      6. + *
    + *

    + * When this property is enabled, Spring Boot's default JPA autoconfiguration (HibernateJpaAutoConfiguration, + * JpaRepositoriesAutoConfiguration) is automatically excluded by {@link MultiTenancyAutoConfigurationImportFilter}. + * This means you don't need any special annotations - just define your repository interfaces as usual: + * 

    {@code
+ * public interface OrderRepository extends JpaRepository {
+ *     List findByCustomerId(String customerId);
+ * }
+ *
+ * @Component
+ * public class OrderProjector {
+ *     @EventHandler
+ *     public void on(OrderCreatedEvent event, OrderRepository repository) {
+ *         // repository is automatically scoped to the tenant from event metadata
+ *         repository.save(new Order(event.orderId(), event.customerId()));
+ *     }
+ * }
+ * }
    + * + * @author Theo Emanuelsson + * @since 5.0.0 + * @see TenantDataSourceProvider + * @see TenantEntityManagerFactoryBuilder + * @see MultiTenancyAutoConfigurationImportFilter + */ +@AutoConfiguration(after = MultiTenancyAutoConfiguration.class) +@ConditionalOnClass(JpaRepository.class) +@ConditionalOnBean(TenantDataSourceProvider.class) +@ConditionalOnProperty(value = "axon.multi-tenancy.jpa.tenant-repositories", havingValue = "true") +@EnableConfigurationProperties(MultiTenancyProperties.class) +public class MultiTenancySpringDataJpaAutoConfiguration { + + private static final Logger logger = LoggerFactory.getLogger(MultiTenancySpringDataJpaAutoConfiguration.class); + + /** + * Creates a {@link TenantEntityManagerFactoryBuilder} for building tenant-specific EntityManagerFactories. + * + * @param dataSourceProvider the provider for tenant-specific DataSources + * @return a builder for tenant-specific EntityManagerFactories + */ + @Bean + @ConditionalOnMissingBean(TenantEntityManagerFactoryBuilder.class) + public TenantEntityManagerFactoryBuilder tenantEntityManagerFactoryBuilder( + TenantDataSourceProvider dataSourceProvider) { + return TenantEntityManagerFactoryBuilder + .forDataSourceProvider(dataSourceProvider) + .build(); + } + + /** + * Creates a {@link TenantTransactionManagerBuilder} for building tenant-specific TransactionManagers. + *

    + * Each tenant's {@link jakarta.persistence.EntityManagerFactory} requires its own + * {@link org.springframework.orm.jpa.JpaTransactionManager} to properly manage transactions. + * + * @param emfBuilder the tenant EntityManagerFactory builder + * @return a builder for tenant-specific TransactionManagers + */ + @Bean + @ConditionalOnMissingBean(TenantTransactionManagerBuilder.class) + public TenantTransactionManagerBuilder tenantTransactionManagerBuilder( + TenantEntityManagerFactoryBuilder emfBuilder) { + return TenantTransactionManagerBuilder + .forEntityManagerFactoryBuilder(emfBuilder) + .build(); + } + + /** + * Creates a {@link ConfigurationEnhancer} that registers Spring Data repository interfaces + * as tenant components. + *

    + * This enhancer scans the classpath for interfaces extending {@link Repository}, + * using the same base packages as Spring Boot's auto-configuration. + * + * @param emfBuilder the tenant EntityManagerFactory builder + * @param txBuilder the tenant TransactionManager builder + * @param beanFactory the bean factory to get auto-configuration packages + * @return a configuration enhancer for tenant repository registration + */ + @Bean + public ConfigurationEnhancer tenantRepositoryConfigurationEnhancer( + TenantEntityManagerFactoryBuilder emfBuilder, + TenantTransactionManagerBuilder txBuilder, + BeanFactory beanFactory) { + + // Get base packages from Spring Boot's auto-configuration + List basePackages = AutoConfigurationPackages.has(beanFactory) + ? AutoConfigurationPackages.get(beanFactory) + : List.of(); + + // Scan for Spring Data repository interfaces + Set> repositoryTypes = scanForRepositories(basePackages); + + if (repositoryTypes.isEmpty()) { + logger.debug("No Spring Data repository interfaces found in packages: {}", basePackages); + return componentRegistry -> { /* no-op */ }; + } + + logger.debug("Found {} Spring Data repository interfaces for tenant component registration", + repositoryTypes.size()); + + return new TenantRepositoryEnhancer(repositoryTypes, emfBuilder, txBuilder); + } + + /** + * Scans the classpath for interfaces extending {@link Repository}. + *

    + * This finds all Spring Data repository interfaces including those extending + * {@code JpaRepository}, {@code CrudRepository}, {@code PagingAndSortingRepository}, etc. + */ + private Set> scanForRepositories(List basePackages) { + Set> repositoryTypes = new HashSet<>(); + + if (basePackages.isEmpty()) { + logger.warn("No base packages configured for repository scanning. " + + "Ensure your application has @EnableAutoConfiguration or @SpringBootApplication."); + return repositoryTypes; + } + + // Create scanner that can find interfaces (not just concrete classes) + ClassPathScanningCandidateComponentProvider scanner = + new ClassPathScanningCandidateComponentProvider(false) { + @Override + protected boolean isCandidateComponent(AnnotatedBeanDefinition beanDefinition) { + // Allow interfaces (default implementation only allows concrete classes) + return beanDefinition.getMetadata().isInterface() + || super.isCandidateComponent(beanDefinition); + } + }; + // Scan for any interface extending Spring Data's Repository + scanner.addIncludeFilter(new AssignableTypeFilter(Repository.class)); + + for (String basePackage : basePackages) { + logger.debug("Scanning package {} for Spring Data repositories", basePackage); + for (BeanDefinition bd : scanner.findCandidateComponents(basePackage)) { + try { + Class repositoryType = Class.forName(bd.getBeanClassName()); + // Skip the Repository interface itself and Spring's built-in interfaces + if (isUserDefinedRepository(repositoryType)) { + repositoryTypes.add(repositoryType); + logger.debug("Discovered repository: {}", repositoryType.getName()); + } + } catch (ClassNotFoundException e) { + logger.warn("Could not load repository class: {}", bd.getBeanClassName(), e); + } + } + } + + return repositoryTypes; + } + + /** + * Checks if a repository type is a user-defined repository (not a Spring Data built-in). + */ + private boolean isUserDefinedRepository(Class repositoryType) { + // Skip Spring Data's own interfaces + String packageName = repositoryType.getPackageName(); + return !packageName.startsWith("org.springframework.data"); + } + + /** + * A {@link ConfigurationEnhancer} that registers Spring Data repository interfaces + * as tenant components. + */ + private static class TenantRepositoryEnhancer implements ConfigurationEnhancer { + + private final Set> repositoryTypes; + private final TenantEntityManagerFactoryBuilder emfBuilder; + private final TenantTransactionManagerBuilder txBuilder; + + TenantRepositoryEnhancer(Set> repositoryTypes, + TenantEntityManagerFactoryBuilder emfBuilder, + TenantTransactionManagerBuilder txBuilder) { + this.repositoryTypes = repositoryTypes; + this.emfBuilder = emfBuilder; + this.txBuilder = txBuilder; + } + + @Override + public int order() { + // Run after MultiTenancyConfigurationDefaults (which is MAX_VALUE - 1) + return Integer.MAX_VALUE - 2; + } + + @Override + public void enhance(@Nonnull ComponentRegistry componentRegistry) { + logger.debug("Registering {} Spring Data repositories as tenant components", repositoryTypes.size()); + + // Collect tenant component registrations + List> registrations = new ArrayList<>(); + for (Class repositoryType : repositoryTypes) { + registrations.add(createRegistration(repositoryType)); + } + + // Register a ParameterResolverFactory that creates tenant-scoped repositories + ParameterResolverFactoryUtils.registerToComponentRegistry( + componentRegistry, + config -> { + @SuppressWarnings("unchecked") + TargetTenantResolver tenantResolver = + config.getComponent(TargetTenantResolver.class); + + // Create the TenantComponentResolverFactory + TenantComponentResolverFactory componentFactory = + new TenantComponentResolverFactory(tenantResolver); + + // Get tenant provider for lifecycle management + TenantProvider tenantProvider = config.getOptionalComponent(TenantProvider.class) + .orElse(null); + + // Register all repository types in the factory + for (TenantComponentRegistration registration : registrations) { + registerTenantComponent(componentFactory, registration, tenantProvider); + } + + // Create the TenantAwareProcessingContextResolverFactory + TenantAwareProcessingContextResolverFactory contextFactory = + new TenantAwareProcessingContextResolverFactory(componentFactory, tenantResolver); + + // Return a MultiParameterResolverFactory containing both + return MultiParameterResolverFactory.ordered(componentFactory, contextFactory); + } + ); + } + + @SuppressWarnings("unchecked") + private TenantComponentRegistration createRegistration(Class repositoryType) { + TenantComponentFactory factory = TenantJpaRepositoryFactory.forRepository(repositoryType, emfBuilder, txBuilder); + return new TenantComponentRegistration<>(repositoryType, factory); + } + + private void registerTenantComponent( + TenantComponentResolverFactory componentFactory, + TenantComponentRegistration registration, + TenantProvider tenantProvider) { + + TenantComponentRegistry registry = componentFactory.registerComponent( + registration.componentType(), + registration.factory() + ); + + if (tenantProvider != null) { + tenantProvider.subscribe(registry); + tenantProvider.getTenants().forEach(registry::registerTenant); + } + + logger.debug("Registered tenant component: {}", registration.componentType().getName()); + } + } + + /** + * Holds a tenant component registration: the type and its factory. + */ + private record TenantComponentRegistration(Class componentType, TenantComponentFactory factory) { + } +} diff --git a/multitenancy-spring-boot-autoconfigure/src/main/java/org/axonframework/extension/multitenancy/autoconfig/MultiTenantEventProcessingAutoConfiguration.java b/multitenancy-spring-boot-autoconfigure/src/main/java/org/axonframework/extension/multitenancy/autoconfig/MultiTenantEventProcessingAutoConfiguration.java new file mode 100644 index 0000000..89af2d0 --- /dev/null +++ b/multitenancy-spring-boot-autoconfigure/src/main/java/org/axonframework/extension/multitenancy/autoconfig/MultiTenantEventProcessingAutoConfiguration.java @@ -0,0 +1,102 @@ +/* + * Copyright (c) 2010-2025. Axon Framework + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.axonframework.extension.multitenancy.autoconfig; + +import org.axonframework.extension.spring.config.SpringEventSourcedEntityLookup; +import org.axonframework.extension.multitenancy.messaging.eventhandling.processing.TenantTokenStoreFactory; +import org.axonframework.extension.multitenancy.messaging.eventhandling.processing.InMemoryTenantTokenStoreFactory; +import org.springframework.beans.factory.config.BeanDefinition; +import org.springframework.boot.autoconfigure.AutoConfiguration; +import org.springframework.boot.autoconfigure.AutoConfigureBefore; +import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean; +import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty; +import org.springframework.context.annotation.Bean; +import org.springframework.context.annotation.Role; + +/** + * Auto-configuration for multi-tenant event processing. + *

    + * This configuration provides: + *

      + *
    • {@link MultiTenantMessageHandlerLookup} - replaces standard message handler lookup + * to create multi-tenant event processors instead of standard ones
      • + *
    • Default {@link TenantTokenStoreFactory} - provides in-memory token stores per tenant + * (override with JPA or JDBC factory for production use)
      • + *
    + *

    + * This configuration is activated when multi-tenancy is enabled + * ({@code axon.multi-tenancy.enabled=true} or missing). The {@link MultiTenantMessageHandlerConfigurer} + * will check at runtime whether to create multi-tenant processors based on + * {@link org.axonframework.extension.multitenancy.core.configuration.MultiTenantEventProcessorPredicate}. + * + * @author Theo Emanuelsson + * @since 5.0.0 + * @see MultiTenantMessageHandlerConfigurer + * @see MultiTenantMessageHandlerLookup + */ +@AutoConfiguration +@ConditionalOnProperty(value = "axon.multi-tenancy.enabled", matchIfMissing = true) +@AutoConfigureBefore(name = "org.axonframework.extension.springboot.autoconfig.EventProcessingAutoConfiguration") +public class MultiTenantEventProcessingAutoConfiguration { + + /** + * Creates the multi-tenant message handler lookup that replaces the standard + * Spring extension's message handler lookup. + *

    + * This lookup creates {@link MultiTenantMessageHandlerConfigurer} instances + * that produce multi-tenant event processors. + * + * @return the multi-tenant message handler lookup + */ + @Bean + public MultiTenantMessageHandlerLookup multiTenantMessageHandlerLookup() { + return new MultiTenantMessageHandlerLookup(); + } + + /** + * Creates a default in-memory tenant token store factory. + *

    + * This is suitable for testing and development. For production use, + * provide a JPA or JDBC based {@link TenantTokenStoreFactory}. + * + * @return the default in-memory tenant token store factory + */ + @Bean + @ConditionalOnMissingBean + public TenantTokenStoreFactory tenantTokenStoreFactory() { + return new InMemoryTenantTokenStoreFactory(); + } + + /** + * Provides the Spring event-sourced entity lookup. + *

    + * This bean is normally provided by the framework's {@code InfrastructureAutoConfiguration}, + * but since we exclude that configuration when multi-tenancy is enabled (to replace + * {@code MessageHandlerLookup} with our multi-tenant version), we need to provide this + * bean ourselves. + *

    + * The {@code SpringEventSourcedEntityLookup} scans for {@code @EventSourced} annotated + * classes and registers them with the Axon configuration via + * {@code SpringEventSourcedEntityConfigurer}. + * + * @return the Spring event-sourced entity lookup + */ + @Role(BeanDefinition.ROLE_INFRASTRUCTURE) + @Bean + public static SpringEventSourcedEntityLookup springEventSourcedEntityLookup() { + return new SpringEventSourcedEntityLookup(); + } +} diff --git a/multitenancy-spring-boot-autoconfigure/src/main/java/org/axonframework/extension/multitenancy/autoconfig/MultiTenantMessageHandlerConfigurer.java b/multitenancy-spring-boot-autoconfigure/src/main/java/org/axonframework/extension/multitenancy/autoconfig/MultiTenantMessageHandlerConfigurer.java new file mode 100644 index 0000000..e2f71e1 --- /dev/null +++ b/multitenancy-spring-boot-autoconfigure/src/main/java/org/axonframework/extension/multitenancy/autoconfig/MultiTenantMessageHandlerConfigurer.java @@ -0,0 +1,246 @@ +/* + * Copyright (c) 2010-2025. Axon Framework + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.axonframework.extension.multitenancy.autoconfig; + +import jakarta.annotation.Nonnull; +import org.axonframework.common.configuration.ComponentBuilder; +import org.axonframework.common.configuration.ComponentRegistry; +import org.axonframework.common.configuration.Configuration; +import org.axonframework.common.configuration.ConfigurationEnhancer; +import org.axonframework.common.configuration.LazyInitializedModule; +import org.axonframework.common.configuration.Module; +import org.axonframework.common.configuration.ModuleBuilder; +import org.axonframework.extension.spring.config.EventProcessorSettings; +import org.axonframework.extension.spring.config.EventProcessorSettings.PooledEventProcessorSettings; +import org.axonframework.extension.spring.config.EventProcessorSettings.SubscribingEventProcessorSettings; +import org.axonframework.extension.multitenancy.core.configuration.MultiTenantEventProcessorPredicate; +import org.axonframework.extension.multitenancy.messaging.eventhandling.processing.MultiTenantPooledStreamingEventProcessorModule; +import org.axonframework.messaging.commandhandling.CommandMessage; +import org.axonframework.messaging.commandhandling.configuration.CommandHandlingModule; +import org.axonframework.messaging.core.Message; +import org.axonframework.messaging.core.unitofwork.UnitOfWorkFactory; +import org.axonframework.messaging.eventhandling.EventMessage; +import org.axonframework.messaging.eventhandling.configuration.EventHandlingComponentsConfigurer.AdditionalComponentPhase; +import org.axonframework.messaging.eventhandling.configuration.EventHandlingComponentsConfigurer.CompletePhase; +import org.axonframework.messaging.eventhandling.configuration.EventHandlingComponentsConfigurer.RequiredComponentPhase; +import org.axonframework.messaging.eventhandling.configuration.EventProcessorModule; +import org.axonframework.messaging.queryhandling.QueryMessage; +import org.axonframework.messaging.queryhandling.configuration.QueryHandlingModule; +import org.springframework.beans.BeansException; +import org.springframework.beans.factory.annotation.AnnotatedBeanDefinition; +import org.springframework.beans.factory.config.BeanDefinition; +import org.springframework.beans.factory.support.AbstractBeanDefinition; +import org.springframework.context.ApplicationContext; +import org.springframework.context.ApplicationContextAware; +import org.springframework.context.ConfigurableApplicationContext; + +import java.util.List; +import java.util.Map; +import java.util.Optional; +import java.util.function.Function; +import java.util.stream.Collectors; + +/** + * A multi-tenant aware version of the message handler configurer that creates + * {@link MultiTenantPooledStreamingEventProcessorModule} instead of standard pooled streaming processors + * when multi-tenancy is enabled for a processor. + *

    + * This configurer is registered by {@link MultiTenantMessageHandlerLookup} when multi-tenancy + * autoconfiguration is active. + * + * @author Theo Emanuelsson + * @since 5.0.0 + * @see MultiTenantMessageHandlerLookup + * @see MultiTenantPooledStreamingEventProcessorModule + */ +public class MultiTenantMessageHandlerConfigurer implements ConfigurationEnhancer, ApplicationContextAware { + + private final Type type; + private final List handlerBeansRefs; + private ApplicationContext applicationContext; + + public MultiTenantMessageHandlerConfigurer(Type type, List beanRefs) { + this.type = type; + this.handlerBeansRefs = beanRefs; + } + + @Override + public void enhance(@Nonnull ComponentRegistry registry) { + switch (type) { + case EVENT: + configureEventHandlers(registry); + break; + case QUERY: + configureQueryHandlers(registry); + break; + case COMMAND: + configureCommandHandlers(registry); + break; + } + } + + private void configureEventHandlers(ComponentRegistry registry) { + groupNamedBeanDefinitionsByPackage().forEach((packageName, beanDefs) -> { + + Function componentRegistration = (RequiredComponentPhase phase) -> { + AdditionalComponentPhase resultOfRegistration = null; + for (NamedBeanDefinition namedBeanDefinition : beanDefs) { + resultOfRegistration = phase.autodetected(this.createComponentBuilder(namedBeanDefinition)); + } + return resultOfRegistration; + }; + + var processorName = "EventProcessor[" + packageName + "]"; + + Function> moduleBuilder = (configuration) -> { + var allSettings = configuration.getComponent(EventProcessorSettings.MapWrapper.class).settings(); + var settings = Optional.ofNullable(allSettings.get(packageName)) + .orElseGet(() -> allSettings.get(EventProcessorSettings.DEFAULT)); + + // Check if multi-tenancy should be enabled for this processor + // First try Spring ApplicationContext, then Axon Configuration, then default to enabled + MultiTenantEventProcessorPredicate multiTenantPredicate; + try { + multiTenantPredicate = applicationContext.getBean(MultiTenantEventProcessorPredicate.class); + } catch (Exception e) { + multiTenantPredicate = configuration.getOptionalComponent( + MultiTenantEventProcessorPredicate.class + ).orElse(MultiTenantEventProcessorPredicate.enableMultiTenancy()); + } + + boolean useMultiTenancy = multiTenantPredicate.test(processorName); + + return switch (settings.processorMode()) { + case POOLED -> { + var moduleSettings = (PooledEventProcessorSettings) settings; + if (useMultiTenancy) { + // Use multi-tenant processor + yield MultiTenantPooledStreamingEventProcessorModule + .create(processorName) + .eventHandlingComponents(componentRegistration) + .customized((cfg, config) -> config + .unitOfWorkFactory(cfg.getComponent(UnitOfWorkFactory.class))); + } else { + // Use standard processor with Spring customizations + yield EventProcessorModule + .pooledStreaming(processorName) + .eventHandlingComponents(componentRegistration) + .customized(MultiTenantSpringCustomizations.pooledStreamingCustomizations( + packageName, + moduleSettings + ).andThen(c -> c.unitOfWorkFactory(configuration.getComponent(UnitOfWorkFactory.class)))); + } + } + case SUBSCRIBING -> { + var moduleSettings = (SubscribingEventProcessorSettings) settings; + // Subscribing processors don't support multi-tenancy in the same way + yield EventProcessorModule + .subscribing(processorName) + .eventHandlingComponents(componentRegistration) + .customized(MultiTenantSpringCustomizations.subscribingCustomizations( + packageName, + moduleSettings + ).andThen(c -> c.unitOfWorkFactory(configuration.getComponent(UnitOfWorkFactory.class)))); + } + }; + }; + registry.registerModule( + new LazyInitializedModule<>("Lazy[" + processorName + "]", moduleBuilder) + ); + }); + } + + private void configureQueryHandlers(ComponentRegistry registry) { + groupNamedBeanDefinitionsByPackage().forEach((packageName, beanDefs) -> { + var moduleName = "QueryHandling[" + packageName + "]"; + var queryHandlingModuleBuilder = QueryHandlingModule + .named(moduleName) + .queryHandlers(); + beanDefs.forEach(namedBeanDefinition -> queryHandlingModuleBuilder.annotatedQueryHandlingComponent( + this.createComponentBuilder(namedBeanDefinition) + )); + registry.registerModule(queryHandlingModuleBuilder.build()); + }); + } + + private void configureCommandHandlers(ComponentRegistry registry) { + groupNamedBeanDefinitionsByPackage().forEach((packageName, beanDefs) -> { + var moduleName = "CommandHandling[" + packageName + "]"; + var commandHandlingModuleBuilder = CommandHandlingModule + .named(moduleName) + .commandHandlers(); + beanDefs.forEach(namedBeanDefinition -> { + commandHandlingModuleBuilder + .annotatedCommandHandlingComponent(this.createComponentBuilder(namedBeanDefinition)); + }); + registry.registerModule(commandHandlingModuleBuilder.build()); + }); + } + + private ComponentBuilder createComponentBuilder(@Nonnull NamedBeanDefinition namedBeanDefinition) { + return (Configuration configuration) -> applicationContext.getBean(namedBeanDefinition.name()); + } + + private Map> groupNamedBeanDefinitionsByPackage() { + var beanFactory = ((ConfigurableApplicationContext) applicationContext).getBeanFactory(); + return handlerBeansRefs + .stream() + .map(name -> new NamedBeanDefinition(name, beanFactory.getBeanDefinition(name))) + .collect(Collectors.groupingBy( + nbd -> { + String className = nbd.definition().getBeanClassName(); + if (className == null) { + if (nbd.definition() instanceof AbstractBeanDefinition abstractBeanDefinition) { + if (abstractBeanDefinition.hasBeanClass()) { + className = abstractBeanDefinition.getBeanClass().getName(); + } else if (nbd.definition() instanceof AnnotatedBeanDefinition annotatedBeanDefinition) { + className = annotatedBeanDefinition.getMetadata().getClassName(); + } + } + } + return (className != null && className.contains(".")) + ? className.substring(0, className.lastIndexOf('.')) + : "default"; + } + ) + ); + } + + @Override + public void setApplicationContext(@Nonnull ApplicationContext applicationContext) throws BeansException { + this.applicationContext = applicationContext; + } + + record NamedBeanDefinition(@Nonnull String name, @Nonnull BeanDefinition definition) { + } + + public enum Type { + COMMAND(CommandMessage.class), + EVENT(EventMessage.class), + QUERY(QueryMessage.class); + + private final Class messageType; + + @SuppressWarnings({"rawtypes", "unchecked"}) + Type(Class messageType) { + this.messageType = (Class) messageType; + } + + public Class getMessageType() { + return messageType; + } + } +} diff --git a/multitenancy-spring-boot-autoconfigure/src/main/java/org/axonframework/extension/multitenancy/autoconfig/MultiTenantMessageHandlerLookup.java b/multitenancy-spring-boot-autoconfigure/src/main/java/org/axonframework/extension/multitenancy/autoconfig/MultiTenantMessageHandlerLookup.java new file mode 100644 index 0000000..f2308ea --- /dev/null +++ b/multitenancy-spring-boot-autoconfigure/src/main/java/org/axonframework/extension/multitenancy/autoconfig/MultiTenantMessageHandlerLookup.java @@ -0,0 +1,147 @@ +/* + * Copyright (c) 2010-2025. Axon Framework + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.axonframework.extension.multitenancy.autoconfig; + +import jakarta.annotation.Nonnull; +import org.axonframework.common.ReflectionUtils; +import org.axonframework.common.annotation.AnnotationUtils; +import org.axonframework.messaging.core.Message; +import org.axonframework.messaging.core.annotation.MessageHandler; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; +import org.springframework.beans.BeansException; +import org.springframework.beans.factory.config.BeanDefinition; +import org.springframework.beans.factory.config.ConfigurableListableBeanFactory; +import org.springframework.beans.factory.support.AbstractBeanDefinition; +import org.springframework.beans.factory.support.BeanDefinitionBuilder; +import org.springframework.beans.factory.support.BeanDefinitionRegistry; +import org.springframework.beans.factory.support.BeanDefinitionRegistryPostProcessor; +import org.springframework.core.Ordered; +import org.springframework.core.PriorityOrdered; +import org.springframework.core.annotation.OrderUtils; + +import java.lang.reflect.Method; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; +import java.util.Optional; +import java.util.stream.Collectors; + +/** + * A multi-tenant aware version of the message handler lookup that registers + * {@link MultiTenantMessageHandlerConfigurer} instead of the standard configurer. + *

    + * This lookup implements {@link PriorityOrdered} with {@link Ordered#HIGHEST_PRECEDENCE} + * to ensure it runs before the standard Spring extension's MessageHandlerLookup, + * effectively replacing the standard event processor configuration with multi-tenant + * aware processors. + *

    + * The bean names used match the standard Spring extension's names, so the standard + * lookup will skip registration when it sees these beans already exist. + * + * @author Theo Emanuelsson + * @since 5.0.0 + * @see MultiTenantMessageHandlerConfigurer + */ +public class MultiTenantMessageHandlerLookup implements BeanDefinitionRegistryPostProcessor, PriorityOrdered { + + private static final Logger logger = LoggerFactory.getLogger(MultiTenantMessageHandlerLookup.class); + + public static List messageHandlerBeans(Class messageType, + ConfigurableListableBeanFactory registry) { + List found = new ArrayList<>(); + for (String beanName : registry.getBeanDefinitionNames()) { + BeanDefinition bd = registry.getBeanDefinition(beanName); + + if (bd.isAutowireCandidate()) { + if (bd.isSingleton() && !bd.isAbstract()) { + Class beanType = registry.getType(beanName); + if (beanType != null && hasMessageHandler(messageType, beanType)) { + found.add(beanName); + } + } + } + } + return found; + } + + private static boolean hasMessageHandler(Class messageType, Class beanType) { + for (Method m : ReflectionUtils.methodsOf(beanType)) { + Optional> attr = AnnotationUtils.findAnnotationAttributes(m, MessageHandler.class); + if (attr.isPresent() && messageType.isAssignableFrom((Class) attr.get().get("messageType"))) { + return true; + } + } + return false; + } + + @Override + public void postProcessBeanFactory(@Nonnull ConfigurableListableBeanFactory beanFactory) throws BeansException { + if (!(beanFactory instanceof BeanDefinitionRegistry)) { + logger.warn("Given bean factory is not a BeanDefinitionRegistry. Cannot auto-configure multi-tenant message handlers"); + return; + } + + for (MultiTenantMessageHandlerConfigurer.Type value : MultiTenantMessageHandlerConfigurer.Type.values()) { + // Use the SAME bean name as the standard Spring extension to prevent it from registering + String configurerBeanName = "MessageHandlerConfigurer$$Axon$$" + value.name(); + if (beanFactory.containsBeanDefinition(configurerBeanName)) { + logger.debug("Message handler configurer [{}] already available. Skipping multi-tenant configuration", configurerBeanName); + continue; + } + + List found = messageHandlerBeans(value.getMessageType(), beanFactory); + if (!found.isEmpty()) { + List sortedFound = sortByOrder(found, beanFactory); + logger.debug("Registering multi-tenant message handler configurer [{}] for {} handlers", + configurerBeanName, sortedFound.size()); + AbstractBeanDefinition beanDefinition = + BeanDefinitionBuilder.genericBeanDefinition(MultiTenantMessageHandlerConfigurer.class) + .addConstructorArgValue(value.name()) + .addConstructorArgValue(sortedFound) + .getBeanDefinition(); + ((BeanDefinitionRegistry) beanFactory).registerBeanDefinition(configurerBeanName, beanDefinition); + } + } + } + + private List sortByOrder(List found, @Nonnull ConfigurableListableBeanFactory beanFactory) { + return found.stream() + .collect(Collectors.toMap( + beanRef -> beanRef, + beanRef -> OrderUtils.getOrder( + beanFactory.getType(beanRef) != null ? beanFactory.getType(beanRef) : Object.class, + Ordered.LOWEST_PRECEDENCE + ) + )) + .entrySet() + .stream() + .sorted(java.util.Map.Entry.comparingByValue()) + .map(java.util.Map.Entry::getKey) + .collect(Collectors.toList()); + } + + @Override + public void postProcessBeanDefinitionRegistry(@Nonnull BeanDefinitionRegistry registry) throws BeansException { + // No action required. + } + + @Override + public int getOrder() { + // Run before the standard Spring extension's MessageHandlerLookup + return Ordered.HIGHEST_PRECEDENCE; + } +} diff --git a/multitenancy-spring-boot-autoconfigure/src/main/java/org/axonframework/extension/multitenancy/autoconfig/MultiTenantSpringCustomizations.java b/multitenancy-spring-boot-autoconfigure/src/main/java/org/axonframework/extension/multitenancy/autoconfig/MultiTenantSpringCustomizations.java new file mode 100644 index 0000000..e09151d --- /dev/null +++ b/multitenancy-spring-boot-autoconfigure/src/main/java/org/axonframework/extension/multitenancy/autoconfig/MultiTenantSpringCustomizations.java @@ -0,0 +1,149 @@ +/* + * Copyright (c) 2010-2025. Axon Framework + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.axonframework.extension.multitenancy.autoconfig; + +import jakarta.annotation.Nonnull; +import jakarta.annotation.Nullable; +import org.axonframework.common.AxonConfigurationException; +import org.axonframework.common.AxonThreadFactory; +import org.axonframework.common.configuration.Configuration; +import org.axonframework.extension.spring.config.EventProcessorSettings; +import org.axonframework.messaging.core.SubscribableEventSource; +import org.axonframework.messaging.eventhandling.processing.streaming.pooled.PooledStreamingEventProcessorConfiguration; +import org.axonframework.messaging.eventhandling.processing.streaming.pooled.PooledStreamingEventProcessorModule; +import org.axonframework.messaging.eventhandling.processing.streaming.token.store.TokenStore; +import org.axonframework.messaging.eventhandling.processing.subscribing.SubscribingEventProcessorConfiguration; +import org.axonframework.messaging.eventhandling.processing.subscribing.SubscribingEventProcessorModule; +import org.axonframework.messaging.eventstreaming.StreamableEventSource; + +import java.util.concurrent.Executors; +import java.util.function.Supplier; + +/** + * Spring customizations for event processors when multi-tenancy is disabled for a specific processor. + * This is a copy of the Spring extension's SpringCustomizations to avoid package-private access issues. + * + * @author Theo Emanuelsson + * @since 5.0.0 + */ +interface MultiTenantSpringCustomizations { + + static PooledStreamingEventProcessorModule.Customization pooledStreamingCustomizations( + String name, + EventProcessorSettings.PooledEventProcessorSettings settings + ) { + return new SpringPooledStreamingEventProcessingModuleCustomization(name, settings); + } + + static SubscribingEventProcessorModule.Customization subscribingCustomizations( + String name, + EventProcessorSettings.SubscribingEventProcessorSettings settings) { + return new SpringSubscribingEventProcessingModuleCustomization(name, settings); + } + + class SpringSubscribingEventProcessingModuleCustomization implements SubscribingEventProcessorModule.Customization { + + private final EventProcessorSettings.SubscribingEventProcessorSettings settings; + private final String name; + + SpringSubscribingEventProcessingModuleCustomization( + String name, + EventProcessorSettings.SubscribingEventProcessorSettings settings) { + this.name = name; + this.settings = settings; + } + + @Override + public SubscribingEventProcessorConfiguration apply(Configuration configuration, + SubscribingEventProcessorConfiguration subscribingEventProcessorConfiguration) { + var messageSource = getComponent(configuration, + SubscribableEventSource.class, + settings.source(), + null + ); + require(messageSource != null, "Could not find a mandatory Source with name '" + settings.source() + + "' for event processor '" + name + "'."); + + return subscribingEventProcessorConfiguration + .eventSource(messageSource); + } + } + + class SpringPooledStreamingEventProcessingModuleCustomization + implements PooledStreamingEventProcessorModule.Customization { + + private final EventProcessorSettings.PooledEventProcessorSettings settings; + private final String name; + + SpringPooledStreamingEventProcessingModuleCustomization( + String name, + EventProcessorSettings.PooledEventProcessorSettings settings + ) { + this.settings = settings; + this.name = name; + } + + @Override + public PooledStreamingEventProcessorConfiguration apply( + Configuration configuration, + PooledStreamingEventProcessorConfiguration eventProcessorConfiguration) { + String executorName = "WorkPackage[" + name + "]"; + var scheduledExecutorService = Executors.newScheduledThreadPool( + settings.threadCount(), + new AxonThreadFactory(executorName) + ); + + var eventStore = getComponent(configuration, + StreamableEventSource.class, + settings.source(), + null); + require(eventStore != null, + "Could not find a mandatory Source with name '" + settings.source() + + "' for event processor '" + name + "'."); + + var tokenStore = getComponent(configuration, + TokenStore.class, + settings.tokenStore(), + null); + require(tokenStore != null, + "Could not find a mandatory TokenStore with name '" + settings.tokenStore() + + "' for event processor '" + name + "'." + ); + + return eventProcessorConfiguration + .workerExecutor(scheduledExecutorService) + .tokenClaimInterval(settings.tokenClaimIntervalInMillis()) + .batchSize(settings.batchSize()) + .initialSegmentCount(settings.initialSegmentCount()) + .eventSource(eventStore) + .tokenStore(tokenStore); + } + } + + @Nullable + static T getComponent(@Nonnull Configuration configuration, @Nonnull Class type, + @Nullable String name, + @Nullable Supplier supplier) { + Supplier safeSupplier = (supplier != null) ? supplier : () -> null; + return configuration.getOptionalComponent(type, name).orElseGet(safeSupplier); + } + + static void require(boolean condition, String message) { + if (!condition) { + throw new AxonConfigurationException(message); + } + } +} diff --git a/multitenancy-spring-boot-autoconfigure/src/main/java/org/axonframework/extension/multitenancy/autoconfig/TenantComponentAutoConfiguration.java b/multitenancy-spring-boot-autoconfigure/src/main/java/org/axonframework/extension/multitenancy/autoconfig/TenantComponentAutoConfiguration.java new file mode 100644 index 0000000..4633652 --- /dev/null +++ b/multitenancy-spring-boot-autoconfigure/src/main/java/org/axonframework/extension/multitenancy/autoconfig/TenantComponentAutoConfiguration.java @@ -0,0 +1,344 @@ +/* + * Copyright (c) 2010-2025. Axon Framework + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.axonframework.extension.multitenancy.autoconfig; + +import jakarta.annotation.Nonnull; +import org.axonframework.common.configuration.ComponentRegistry; +import org.axonframework.common.configuration.ConfigurationEnhancer; +import org.axonframework.extension.multitenancy.core.TargetTenantResolver; +import org.axonframework.extension.multitenancy.core.TenantComponentFactory; +import org.axonframework.extension.multitenancy.core.TenantComponentRegistry; +import org.axonframework.extension.multitenancy.core.TenantDescriptor; +import org.axonframework.extension.multitenancy.core.TenantProvider; +import org.axonframework.extension.multitenancy.messaging.core.annotation.TenantComponentResolverFactory; +import org.axonframework.extension.multitenancy.messaging.core.unitofwork.annotation.TenantAwareProcessingContextResolverFactory; +import org.axonframework.extension.multitenancy.spring.TenantComponent; +import org.axonframework.messaging.core.Message; +import org.axonframework.messaging.core.annotation.MultiParameterResolverFactory; +import org.axonframework.messaging.core.configuration.reflection.ParameterResolverFactoryUtils; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; +import org.springframework.beans.factory.BeanFactory; +import org.springframework.beans.factory.config.AutowireCapableBeanFactory; +import org.springframework.beans.factory.config.BeanDefinition; +import org.springframework.boot.autoconfigure.AutoConfiguration; +import org.springframework.boot.autoconfigure.AutoConfigurationPackages; +import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty; +import org.springframework.context.ApplicationContext; +import org.springframework.context.annotation.Bean; +import org.springframework.context.annotation.ClassPathScanningCandidateComponentProvider; +import org.springframework.core.GenericTypeResolver; +import org.springframework.core.type.filter.AssignableTypeFilter; + +import java.util.ArrayList; +import java.util.HashSet; +import java.util.List; +import java.util.Map; +import java.util.Set; + +/** + * Auto-configuration for automatic discovery and registration of {@link TenantComponent} implementations. + *

    + * This configuration scans the classpath for classes implementing {@link TenantComponent}, + * instantiates them with Spring dependency injection (without registering them as Spring beans), + * and registers them as tenant components for injection into message handlers. + *

    + * Classes implementing {@link TenantComponent} will: + *

      + *
    • Receive Spring dependencies through constructor injection
      • + *
    • NOT be available for autowiring in other Spring beans
      • + *
    • Only be injectable into Axon message handlers or accessible via {@code TenantAwareProcessingContext}
      • + *
    + *

    + * This auto-configuration is enabled by default. To disable it, set + * {@code axon.multi-tenancy.tenant-components.enabled=false}. + *

    + * Example usage: + * 

    {@code
+ * // Note: No @Component annotation!
+ * public class TenantOrderService implements TenantComponent {
+ *     private final EmailService emailService;
+ *     private final String tenantId;
+ *
+ *     public TenantOrderService(EmailService emailService) {
+ *         this.emailService = emailService;
+ *         this.tenantId = null;
+ *     }
+ *
+ *     private TenantOrderService(EmailService emailService, String tenantId) {
+ *         this.emailService = emailService;
+ *         this.tenantId = tenantId;
+ *     }
+ *
+ *     @Override
+ *     public TenantOrderService createForTenant(TenantDescriptor tenant) {
+ *         return new TenantOrderService(emailService, tenant.tenantId());
+ *     }
+ * }
+ *
+ * // In a message handler:
+ * @EventHandler
+ * public void handle(OrderPlaced event, TenantOrderService orderService) {
+ *     // orderService is automatically the tenant-specific instance
+ * }
+ * }
    + * + * @author Theo Emanuelsson + * @since 5.0.0 + * @see TenantComponent + */ +@AutoConfiguration(after = MultiTenancyAutoConfiguration.class) +@ConditionalOnProperty(value = "axon.multi-tenancy.tenant-components.enabled", matchIfMissing = true) +public class TenantComponentAutoConfiguration { + + private static final Logger logger = LoggerFactory.getLogger(TenantComponentAutoConfiguration.class); + + /** + * Creates a {@link ConfigurationEnhancer} that discovers and registers {@link TenantComponent} + * implementations as tenant-scoped components. + * + * @param applicationContext the Spring application context for classpath scanning and bean creation + * @param beanFactory the bean factory to get auto-configuration packages + * @return a configuration enhancer for tenant component registration + */ + @Bean + public ConfigurationEnhancer tenantComponentConfigurationEnhancer( + ApplicationContext applicationContext, + BeanFactory beanFactory) { + + // Fail fast if someone accidentally annotated a TenantComponent with @Component + Map accidentalBeans = applicationContext.getBeansOfType(TenantComponent.class); + if (!accidentalBeans.isEmpty()) { + throw new IllegalStateException( + "TenantComponent implementations must NOT be registered as Spring beans. " + + "Remove @Component, @Service, or similar annotations from: " + accidentalBeans.keySet() + + ". TenantComponent instances are managed by Axon's multi-tenancy infrastructure and " + + "should only be injected into message handlers or accessed via TenantAwareProcessingContext." + ); + } + + // Get base packages from Spring Boot's auto-configuration + List basePackages = AutoConfigurationPackages.has(beanFactory) + ? AutoConfigurationPackages.get(beanFactory) + : List.of(); + + // Scan for TenantComponent implementations + Set> tenantComponentClasses = scanForTenantComponents(basePackages); + + if (tenantComponentClasses.isEmpty()) { + logger.debug("No TenantComponent implementations found in packages: {}", basePackages); + return componentRegistry -> { /* no-op */ }; + } + + logger.debug("Found {} TenantComponent implementations for registration", tenantComponentClasses.size()); + + // Create factory instances with Spring DI (but not registered as beans) + List> holders = createFactoryInstances(applicationContext, tenantComponentClasses); + + return new TenantComponentEnhancer(holders); + } + + /** + * Scans the classpath for classes implementing {@link TenantComponent}. + */ + private Set> scanForTenantComponents(List basePackages) { + Set> tenantComponentClasses = new HashSet<>(); + + if (basePackages.isEmpty()) { + logger.warn("No base packages configured for TenantComponent scanning. " + + "Ensure your application has @EnableAutoConfiguration or @SpringBootApplication."); + return tenantComponentClasses; + } + + ClassPathScanningCandidateComponentProvider scanner = + new ClassPathScanningCandidateComponentProvider(false); + scanner.addIncludeFilter(new AssignableTypeFilter(TenantComponent.class)); + + for (String basePackage : basePackages) { + logger.debug("Scanning package {} for TenantComponent implementations", basePackage); + for (BeanDefinition bd : scanner.findCandidateComponents(basePackage)) { + try { + Class componentClass = Class.forName(bd.getBeanClassName()); + // Skip the interface itself + if (componentClass != TenantComponent.class && !componentClass.isInterface()) { + tenantComponentClasses.add(componentClass); + logger.debug("Discovered TenantComponent: {}", componentClass.getName()); + } + } catch (ClassNotFoundException e) { + logger.warn("Could not load TenantComponent class: {}", bd.getBeanClassName(), e); + } + } + } + + return tenantComponentClasses; + } + + /** + * Creates factory instances with Spring DI but without registering them as beans. + */ + private List> createFactoryInstances( + ApplicationContext applicationContext, + Set> tenantComponentClasses) { + + List> holders = new ArrayList<>(); + AutowireCapableBeanFactory beanFactory = applicationContext.getAutowireCapableBeanFactory(); + + for (Class componentClass : tenantComponentClasses) { + try { + // Create instance with Spring DI, but don't register as a bean + @SuppressWarnings("unchecked") + TenantComponent factoryInstance = (TenantComponent) + beanFactory.createBean(componentClass, AutowireCapableBeanFactory.AUTOWIRE_CONSTRUCTOR, false); + + // Resolve the generic type parameter T + Class componentType = GenericTypeResolver.resolveTypeArgument( + componentClass, TenantComponent.class); + + if (componentType == null) { + logger.warn("Could not resolve component type for TenantComponent: {}. " + + "Ensure the class directly specifies the type parameter.", componentClass.getName()); + continue; + } + + @SuppressWarnings({"unchecked", "rawtypes"}) + TenantComponentHolder holder = new TenantComponentHolder(componentType, factoryInstance); + holders.add(holder); + logger.debug("Created factory instance for TenantComponent: {} -> {}", + componentClass.getName(), componentType.getName()); + + } catch (Exception e) { + logger.error("Failed to create factory instance for TenantComponent: {}", + componentClass.getName(), e); + } + } + + return holders; + } + + /** + * Wraps a {@link TenantComponent} as a {@link TenantComponentFactory}. + */ + @SuppressWarnings("unchecked") + private static TenantComponentFactory wrapAsFactory(TenantComponent instance) { + return new TenantComponentFactory<>() { + @Override + public T apply(TenantDescriptor tenant) { + return instance.createForTenant(tenant); + } + + @Override + public void cleanup(TenantDescriptor tenant, T component) { + instance.cleanupForTenant(tenant, component); + } + }; + } + + /** + * Holds a tenant component factory instance along with its resolved component type. + */ + private record TenantComponentHolder(Class componentType, TenantComponent factoryInstance) { + } + + /** + * A {@link ConfigurationEnhancer} that registers {@link TenantComponent} implementations + * as tenant-scoped components. + */ + private static class TenantComponentEnhancer implements ConfigurationEnhancer { + + private final List> holders; + + TenantComponentEnhancer(List> holders) { + this.holders = holders; + } + + @Override + public int order() { + // Run after MultiTenancyConfigurationDefaults (which is MAX_VALUE - 1) + return Integer.MAX_VALUE - 2; + } + + @Override + public void enhance(@Nonnull ComponentRegistry componentRegistry) { + logger.debug("Registering {} TenantComponent implementations as tenant components", holders.size()); + + // Create registrations from holders + List> registrations = new ArrayList<>(); + for (TenantComponentHolder holder : holders) { + registrations.add(createRegistration(holder)); + } + + // Register a ParameterResolverFactory that creates tenant-scoped components + ParameterResolverFactoryUtils.registerToComponentRegistry( + componentRegistry, + config -> { + @SuppressWarnings("unchecked") + TargetTenantResolver tenantResolver = + config.getComponent(TargetTenantResolver.class); + + // Create the TenantComponentResolverFactory + TenantComponentResolverFactory componentFactory = + new TenantComponentResolverFactory(tenantResolver); + + // Get tenant provider for lifecycle management + TenantProvider tenantProvider = config.getOptionalComponent(TenantProvider.class) + .orElse(null); + + // Register all component types in the factory + for (TenantComponentRegistration registration : registrations) { + registerTenantComponent(componentFactory, registration, tenantProvider); + } + + // Create the TenantAwareProcessingContextResolverFactory + TenantAwareProcessingContextResolverFactory contextFactory = + new TenantAwareProcessingContextResolverFactory(componentFactory, tenantResolver); + + // Return a MultiParameterResolverFactory containing both + return MultiParameterResolverFactory.ordered(componentFactory, contextFactory); + } + ); + } + + @SuppressWarnings("unchecked") + private TenantComponentRegistration createRegistration(TenantComponentHolder holder) { + TenantComponentFactory factory = wrapAsFactory(holder.factoryInstance()); + return new TenantComponentRegistration<>(holder.componentType(), factory); + } + + private void registerTenantComponent( + TenantComponentResolverFactory componentFactory, + TenantComponentRegistration registration, + TenantProvider tenantProvider) { + + TenantComponentRegistry registry = componentFactory.registerComponent( + registration.componentType(), + registration.factory() + ); + + if (tenantProvider != null) { + tenantProvider.subscribe(registry); + tenantProvider.getTenants().forEach(registry::registerTenant); + } + + logger.debug("Registered tenant component: {}", registration.componentType().getName()); + } + } + + /** + * Holds a tenant component registration: the type and its factory. + */ + private record TenantComponentRegistration(Class componentType, TenantComponentFactory factory) { + } +} diff --git a/multitenancy-spring-boot-autoconfigure/src/main/java/org/axonframework/extensions/multitenancy/autoconfig/TenantConfiguration.java b/multitenancy-spring-boot-autoconfigure/src/main/java/org/axonframework/extension/multitenancy/autoconfig/TenantConfiguration.java similarity index 54% rename from multitenancy-spring-boot-autoconfigure/src/main/java/org/axonframework/extensions/multitenancy/autoconfig/TenantConfiguration.java rename to multitenancy-spring-boot-autoconfigure/src/main/java/org/axonframework/extension/multitenancy/autoconfig/TenantConfiguration.java index 80dd540..a971440 100644 --- a/multitenancy-spring-boot-autoconfigure/src/main/java/org/axonframework/extensions/multitenancy/autoconfig/TenantConfiguration.java +++ b/multitenancy-spring-boot-autoconfigure/src/main/java/org/axonframework/extension/multitenancy/autoconfig/TenantConfiguration.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 2010-2023. Axon Framework + * Copyright (c) 2010-2025. Axon Framework * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -13,19 +13,29 @@ * See the License for the specific language governing permissions and * limitations under the License. */ -package org.axonframework.extensions.multitenancy.autoconfig; +package org.axonframework.extension.multitenancy.autoconfig; /** - * Enables static access to default {@code TENANT_CORRELATION_KEY} used to correlate tenant identifiers within - * {@link org.axonframework.messaging.MetaData}. + * Configuration constants for multi-tenancy. + *

    + * Provides static access to the default tenant correlation key used to identify + * tenant information within message metadata. * * @author Stefan Dragisic - * @since 4.6.0 + * @author Theo Emanuelsson + * @since 5.0.0 */ public class TenantConfiguration { + private TenantConfiguration() { + // Utility class + } + /** - * The tenant correlation key used within {@link org.axonframework.messaging.MetaData}. + * The default metadata key used to store and retrieve the tenant identifier. + *

    + * This key is used by {@link TenantCorrelationProvider} to propagate tenant + * information between messages. */ public static final String TENANT_CORRELATION_KEY = "tenantId"; } diff --git a/multitenancy-spring-boot-autoconfigure/src/main/java/org/axonframework/extension/multitenancy/autoconfig/TenantCorrelationProvider.java b/multitenancy-spring-boot-autoconfigure/src/main/java/org/axonframework/extension/multitenancy/autoconfig/TenantCorrelationProvider.java new file mode 100644 index 0000000..860a355 --- /dev/null +++ b/multitenancy-spring-boot-autoconfigure/src/main/java/org/axonframework/extension/multitenancy/autoconfig/TenantCorrelationProvider.java @@ -0,0 +1,69 @@ +/* + * Copyright (c) 2010-2025. Axon Framework + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.axonframework.extension.multitenancy.autoconfig; + +import jakarta.annotation.Nonnull; +import org.axonframework.messaging.core.Message; +import org.axonframework.messaging.core.Metadata; +import org.axonframework.messaging.core.correlation.CorrelationDataProvider; + +import java.util.HashMap; +import java.util.Map; + +/** + * Implementation of {@link CorrelationDataProvider} that propagates the tenant identifier + * from incoming messages to outgoing messages. + *

    + * This provider ensures that the tenant context is preserved when messages trigger + * new messages during processing (e.g., when a command handler publishes events, + * or when an event handler sends queries). + *

    + * If the tenant key is not present in the incoming message's metadata, a default value + * of "unknownTenant" is used to ensure tenant information is always propagated. + * + * @author Stefan Dragisic + * @author Theo Emanuelsson + * @since 5.0.0 + * @see CorrelationDataProvider + */ +public class TenantCorrelationProvider implements CorrelationDataProvider { + + private static final String UNKNOWN_TENANT = "unknownTenant"; + + private final String tenantCorrelationKey; + + /** + * Constructs a tenant-specific {@link CorrelationDataProvider} using the given {@code tenantCorrelationKey}. + * + * @param tenantCorrelationKey The key used to store the tenant identifier in the + * {@link Metadata message metadata}. + */ + public TenantCorrelationProvider(String tenantCorrelationKey) { + this.tenantCorrelationKey = tenantCorrelationKey; + } + + @Nonnull + @Override + public Map correlationDataFor(@Nonnull Message message) { + Map result = new HashMap<>(); + Metadata metadata = message.metadata(); + String tenantId = metadata.containsKey(tenantCorrelationKey) + ? metadata.get(tenantCorrelationKey) + : UNKNOWN_TENANT; + result.put(tenantCorrelationKey, tenantId); + return result; + } +} diff --git a/multitenancy-spring-boot-autoconfigure/src/main/java/org/axonframework/extensions/multitenancy/autoconfig/MultiTenancyAutoConfiguration.java b/multitenancy-spring-boot-autoconfigure/src/main/java/org/axonframework/extensions/multitenancy/autoconfig/MultiTenancyAutoConfiguration.java deleted file mode 100644 index 76c8aba..0000000 --- a/multitenancy-spring-boot-autoconfigure/src/main/java/org/axonframework/extensions/multitenancy/autoconfig/MultiTenancyAutoConfiguration.java +++ /dev/null @@ -1,227 +0,0 @@ -/* - * Copyright (c) 2010-2024. Axon Framework - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ -package org.axonframework.extensions.multitenancy.autoconfig; - -import org.axonframework.commandhandling.CommandBus; -import org.axonframework.commandhandling.CommandMessage; -import org.axonframework.eventhandling.EventMessage; -import org.axonframework.extensions.multitenancy.components.TargetTenantResolver; -import org.axonframework.extensions.multitenancy.components.TenantConnectPredicate; -import org.axonframework.extensions.multitenancy.components.TenantDescriptor; -import org.axonframework.extensions.multitenancy.components.TenantProvider; -import org.axonframework.extensions.multitenancy.components.commandhandeling.MultiTenantCommandBus; -import org.axonframework.extensions.multitenancy.components.commandhandeling.TenantCommandSegmentFactory; -import org.axonframework.extensions.multitenancy.components.deadletterqueue.MultiTenantDeadLetterQueue; -import org.axonframework.extensions.multitenancy.components.deadletterqueue.MultiTenantDeadLetterQueueFactory; -import org.axonframework.extensions.multitenancy.components.eventstore.MultiTenantEventStore; -import org.axonframework.extensions.multitenancy.components.eventstore.TenantEventSegmentFactory; -import org.axonframework.extensions.multitenancy.components.queryhandeling.MultiTenantQueryBus; -import org.axonframework.extensions.multitenancy.components.queryhandeling.MultiTenantQueryUpdateEmitter; -import org.axonframework.extensions.multitenancy.components.queryhandeling.TenantQuerySegmentFactory; -import org.axonframework.extensions.multitenancy.components.queryhandeling.TenantQueryUpdateEmitterSegmentFactory; -import org.axonframework.extensions.multitenancy.components.scheduling.MultiTenantEventScheduler; -import org.axonframework.extensions.multitenancy.components.scheduling.TenantEventSchedulerSegmentFactory; -import org.axonframework.extensions.multitenancy.configuration.MultiTenantEventProcessingModule; -import org.axonframework.extensions.multitenancy.configuration.MultiTenantEventProcessorPredicate; -import org.axonframework.extensions.multitenancy.configuration.MultiTenantStreamableMessageSourceProvider; -import org.axonframework.messaging.Message; -import org.axonframework.messaging.correlation.CorrelationDataProvider; -import org.axonframework.queryhandling.QueryMessage; -import org.axonframework.queryhandling.QueryUpdateEmitter; -import org.axonframework.springboot.util.ConditionalOnMissingQualifiedBean; -import org.springframework.boot.autoconfigure.AutoConfiguration; -import org.springframework.boot.autoconfigure.AutoConfigureAfter; -import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean; -import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty; -import org.springframework.context.annotation.Bean; -import org.springframework.context.annotation.Primary; - -import java.util.Map; -import java.util.concurrent.ConcurrentHashMap; - -import static org.axonframework.extensions.multitenancy.autoconfig.TenantConfiguration.TENANT_CORRELATION_KEY; - -/** - * Autoconfiguration constructing the - * {@link org.axonframework.extensions.multitenancy.components.MultiTenantAwareComponent multi-tenant aware} - * infrastructure components. - * - * @author Stefan Dragisic - * @since 4.6.0 - */ -@AutoConfiguration -@ConditionalOnProperty(value = "axon.multi-tenancy.enabled", matchIfMissing = true) -@AutoConfigureAfter(MultiTenancyAxonServerAutoConfiguration.class) -public class MultiTenancyAutoConfiguration { - - @Bean - @ConditionalOnMissingBean - public TenantConnectPredicate tenantFilterPredicate() { - return tenant -> true; - } - - @Bean - @Primary - @ConditionalOnMissingQualifiedBean(qualifier = "!localSegment", beanClass = CommandBus.class) - public MultiTenantCommandBus multiTenantCommandBus(TenantCommandSegmentFactory tenantCommandSegmentFactory, - TargetTenantResolver targetTenantResolver, - TenantProvider tenantProvider) { - //noinspection unchecked - MultiTenantCommandBus commandBus = - MultiTenantCommandBus.builder() - .tenantSegmentFactory(tenantCommandSegmentFactory) - .targetTenantResolver( - (TargetTenantResolver>) targetTenantResolver - ) - .build(); - tenantProvider.subscribe(commandBus); - return commandBus; - } - - @Bean - @Primary - public MultiTenantQueryBus multiTenantQueryBus(TenantQuerySegmentFactory tenantQuerySegmentFactory, - TargetTenantResolver targetTenantResolver, - TenantProvider tenantProvider) { - //noinspection unchecked - MultiTenantQueryBus queryBus = - MultiTenantQueryBus.builder() - .tenantSegmentFactory(tenantQuerySegmentFactory) - .targetTenantResolver( - (TargetTenantResolver>) targetTenantResolver - ) - .build(); - tenantProvider.subscribe(queryBus); - return queryBus; - } - - @Bean - @Primary - public QueryUpdateEmitter multiTenantQueryUpdateEmitter( - TenantQueryUpdateEmitterSegmentFactory tenantQueryUpdateEmitterSegmentFactory, - TargetTenantResolver targetTenantResolver, - TenantProvider tenantProvider - ) { - //noinspection unchecked - MultiTenantQueryUpdateEmitter multiTenantQueryUpdateEmitter = - MultiTenantQueryUpdateEmitter.builder() - .tenantSegmentFactory(tenantQueryUpdateEmitterSegmentFactory) - .targetTenantResolver( - (TargetTenantResolver>) targetTenantResolver - ) - .build(); - tenantProvider.subscribe(multiTenantQueryUpdateEmitter); - return multiTenantQueryUpdateEmitter; - } - - @Bean - @Primary - public MultiTenantEventStore multiTenantEventStore(TenantEventSegmentFactory tenantEventSegmentFactory, - TargetTenantResolver targetTenantResolver, - TenantProvider tenantProvider) { - //noinspection unchecked - MultiTenantEventStore multiTenantEventStore = - MultiTenantEventStore.builder() - .tenantSegmentFactory(tenantEventSegmentFactory) - .targetTenantResolver((TargetTenantResolver>) targetTenantResolver) - .build(); - tenantProvider.subscribe(multiTenantEventStore); - return multiTenantEventStore; - } - - @Bean - @Primary - public MultiTenantEventScheduler multiTenantEventScheduler( - TenantEventSchedulerSegmentFactory tenantEventSchedulerSegmentFactory, - TargetTenantResolver targetTenantResolver, - TenantProvider tenantProvider - ) { - //noinspection unchecked - MultiTenantEventScheduler multiTenantEventScheduler = - MultiTenantEventScheduler.builder() - .tenantSegmentFactory(tenantEventSchedulerSegmentFactory) - .targetTenantResolver( - (TargetTenantResolver>) targetTenantResolver - ) - .build(); - tenantProvider.subscribe(multiTenantEventScheduler); - return multiTenantEventScheduler; - } - - @Bean - public MultiTenantDeadLetterQueueFactory> multiTenantDeadLetterQueueFactory( - TenantProvider tenantProvider, - TargetTenantResolver targetTenantResolver - ) { - Map>> multiTenantDeadLetterQueue = new ConcurrentHashMap<>(); - return (processingGroup) -> multiTenantDeadLetterQueue.computeIfAbsent(processingGroup, (key) -> { - //noinspection unchecked - MultiTenantDeadLetterQueue> deadLetterQueue = - MultiTenantDeadLetterQueue.builder() - .targetTenantResolver( - (TargetTenantResolver>) targetTenantResolver - ) - .processingGroup(processingGroup) - .build(); - tenantProvider.subscribe(deadLetterQueue); - return deadLetterQueue; - }); - } - - - @Bean - @ConditionalOnMissingBean - public MultiTenantStreamableMessageSourceProvider multiTenantStreamableMessageSourceProvider() { - return (defaultTenantSource, processorName, tenantDescriptor, configuration) -> defaultTenantSource; - } - - @Bean - @ConditionalOnMissingBean - public MultiTenantEventProcessorPredicate multiTenantEventProcessorPredicate() { - return MultiTenantEventProcessorPredicate.enableMultiTenancy(); - } - - @Bean - public MultiTenantEventProcessingModule multiTenantEventProcessingModule( - TenantProvider tenantProvider, - MultiTenantStreamableMessageSourceProvider multiTenantStreamableMessageSourceProvider, - MultiTenantDeadLetterQueueFactory> multiTenantDeadLetterQueueFactory, - MultiTenantEventProcessorPredicate multiTenantEventProcessorPredicate - ) { - return new MultiTenantEventProcessingModule( - tenantProvider, - multiTenantStreamableMessageSourceProvider, - multiTenantDeadLetterQueueFactory, - multiTenantEventProcessorPredicate - ); - } - - @Bean - @ConditionalOnProperty(name = "axon.multi-tenancy.use-metadata-helper", matchIfMissing = true) - public TargetTenantResolver> targetTenantResolver() { - return (message, tenants) -> - TenantDescriptor.tenantWithId( - (String) message.getMetaData() - .getOrDefault(TENANT_CORRELATION_KEY, "unknownTenant") - ); - } - - @Bean - @ConditionalOnProperty(name = "axon.multi-tenancy.use-metadata-helper", matchIfMissing = true) - public CorrelationDataProvider tenantCorrelationProvider() { - return new TenantCorrelationProvider(TENANT_CORRELATION_KEY); - } -} diff --git a/multitenancy-spring-boot-autoconfigure/src/main/java/org/axonframework/extensions/multitenancy/autoconfig/MultiTenancyAxonServerAutoConfiguration.java b/multitenancy-spring-boot-autoconfigure/src/main/java/org/axonframework/extensions/multitenancy/autoconfig/MultiTenancyAxonServerAutoConfiguration.java deleted file mode 100644 index d003583..0000000 --- a/multitenancy-spring-boot-autoconfigure/src/main/java/org/axonframework/extensions/multitenancy/autoconfig/MultiTenancyAxonServerAutoConfiguration.java +++ /dev/null @@ -1,295 +0,0 @@ -/* - * Copyright (c) 2010-2024. Axon Framework - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ -package org.axonframework.extensions.multitenancy.autoconfig; - -import org.axonframework.axonserver.connector.AxonServerConfiguration; -import org.axonframework.axonserver.connector.AxonServerConnectionManager; -import org.axonframework.axonserver.connector.TargetContextResolver; -import org.axonframework.axonserver.connector.command.AxonServerCommandBus; -import org.axonframework.axonserver.connector.command.CommandLoadFactorProvider; -import org.axonframework.axonserver.connector.command.CommandPriorityCalculator; -import org.axonframework.axonserver.connector.event.axon.AxonServerEventScheduler; -import org.axonframework.axonserver.connector.event.axon.AxonServerEventStore; -import org.axonframework.axonserver.connector.event.axon.EventProcessorInfoConfiguration; -import org.axonframework.axonserver.connector.query.AxonServerQueryBus; -import org.axonframework.axonserver.connector.query.QueryPriorityCalculator; -import org.axonframework.commandhandling.CommandBus; -import org.axonframework.commandhandling.CommandBusSpanFactory; -import org.axonframework.commandhandling.CommandMessage; -import org.axonframework.commandhandling.DuplicateCommandHandlerResolver; -import org.axonframework.commandhandling.SimpleCommandBus; -import org.axonframework.commandhandling.distributed.RoutingStrategy; -import org.axonframework.common.transaction.TransactionManager; -import org.axonframework.config.Configuration; -import org.axonframework.eventhandling.EventBusSpanFactory; -import org.axonframework.extensions.multitenancy.components.TenantConnectPredicate; -import org.axonframework.extensions.multitenancy.components.TenantDescriptor; -import org.axonframework.extensions.multitenancy.components.TenantEventProcessorControlSegmentFactory; -import org.axonframework.extensions.multitenancy.components.TenantProvider; -import org.axonframework.extensions.multitenancy.components.commandhandeling.TenantCommandSegmentFactory; -import org.axonframework.extensions.multitenancy.components.eventstore.TenantEventSegmentFactory; -import org.axonframework.extensions.multitenancy.components.queryhandeling.MultiTenantQueryUpdateEmitter; -import org.axonframework.extensions.multitenancy.components.queryhandeling.TenantQuerySegmentFactory; -import org.axonframework.extensions.multitenancy.components.queryhandeling.TenantQueryUpdateEmitterSegmentFactory; -import org.axonframework.extensions.multitenancy.components.scheduling.TenantEventSchedulerSegmentFactory; -import org.axonframework.messaging.interceptors.CorrelationDataInterceptor; -import org.axonframework.queryhandling.QueryBus; -import org.axonframework.queryhandling.QueryBusSpanFactory; -import org.axonframework.queryhandling.QueryInvocationErrorHandler; -import org.axonframework.queryhandling.QueryMessage; -import org.axonframework.queryhandling.QueryUpdateEmitter; -import org.axonframework.queryhandling.SimpleQueryBus; -import org.axonframework.queryhandling.SimpleQueryUpdateEmitter; -import org.axonframework.serialization.Serializer; -import org.axonframework.spring.config.SpringAxonConfiguration; -import org.axonframework.springboot.autoconfig.AxonServerAutoConfiguration; -import org.springframework.beans.factory.annotation.Autowired; -import org.springframework.beans.factory.annotation.Qualifier; -import org.springframework.boot.autoconfigure.AutoConfiguration; -import org.springframework.boot.autoconfigure.AutoConfigureBefore; -import org.springframework.boot.autoconfigure.condition.ConditionalOnClass; -import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean; -import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty; -import org.springframework.context.annotation.Bean; -import org.springframework.context.annotation.ComponentScan; -import org.springframework.context.annotation.FilterType; -import org.springframework.context.annotation.Primary; -import org.springframework.core.env.Environment; - -/** - * Autoconfiguration constructing the Axon Server specific tenant factories, with the {@link AxonServerTenantProvider} - * at its core. - * - * @author Stefan Dragisic - * @since 4.6.0 - */ -@AutoConfiguration -@ConditionalOnClass(AxonServerConfiguration.class) -@ConditionalOnProperty(value = {"axon.axonserver.enabled", "axon.multi-tenancy.enabled"}, matchIfMissing = true) -@AutoConfigureBefore(AxonServerAutoConfiguration.class) -@ComponentScan(excludeFilters = { - @ComponentScan.Filter( - type = FilterType.REGEX, - pattern = "org.axonframework.springboot.autoconfig.AxonServerBusAutoConfiguration.class" - ) -}) -public class MultiTenancyAxonServerAutoConfiguration { - - @Autowired - public void disableHeartBeat(AxonServerConfiguration axonServerConfig, Environment env) { - if (!"true".equals(env.getProperty("axon.axonserver.heartbeat.enabled"))) { - axonServerConfig.getHeartbeat().setEnabled(false); - } - } - - @Bean - @ConditionalOnClass(name = "org.axonframework.axonserver.connector.command.AxonServerCommandBus") - public TenantProvider tenantProvider(Environment env, - TenantConnectPredicate tenantConnectPredicate, - AxonServerConnectionManager axonServerConnectionManager) { - return new AxonServerTenantProvider(env.getProperty("axon.axonserver.contexts"), - tenantConnectPredicate, - axonServerConnectionManager); - } - - private SimpleCommandBus localCommandBus(TransactionManager txManager, - Configuration axonConfiguration, - DuplicateCommandHandlerResolver duplicateCommandHandlerResolver) { - SimpleCommandBus commandBus = - SimpleCommandBus.builder() - .transactionManager(txManager) - .duplicateCommandHandlerResolver(duplicateCommandHandlerResolver) - .spanFactory(axonConfiguration.getComponent(CommandBusSpanFactory.class)) - .messageMonitor(axonConfiguration.messageMonitor(CommandBus.class, "commandBus")) - .build(); - commandBus.registerHandlerInterceptor( - new CorrelationDataInterceptor<>(axonConfiguration.correlationDataProviders()) - ); - return commandBus; - } - - @Bean - @ConditionalOnClass(name = "org.axonframework.axonserver.connector.command.AxonServerCommandBus") - public TenantCommandSegmentFactory tenantAxonServerCommandSegmentFactory( - @Qualifier("messageSerializer") Serializer messageSerializer, - RoutingStrategy routingStrategy, - CommandPriorityCalculator priorityCalculator, - CommandLoadFactorProvider loadFactorProvider, - TargetContextResolver> targetContextResolver, - AxonServerConfiguration axonServerConfig, - AxonServerConnectionManager connectionManager, - TransactionManager txManager, Configuration axonConfiguration, - DuplicateCommandHandlerResolver duplicateCommandHandlerResolver - ) { - return tenantDescriptor -> { - SimpleCommandBus localCommandBus = localCommandBus(txManager, - axonConfiguration, - duplicateCommandHandlerResolver); - AxonServerCommandBus commandBus = - AxonServerCommandBus.builder() - .localSegment(localCommandBus) - .serializer(messageSerializer) - .routingStrategy(routingStrategy) - .priorityCalculator(priorityCalculator) - .loadFactorProvider(loadFactorProvider) - .spanFactory(axonConfiguration.getComponent(CommandBusSpanFactory.class)) - .targetContextResolver(targetContextResolver) - .axonServerConnectionManager(connectionManager) - .configuration(axonServerConfig) - .defaultContext(tenantDescriptor.tenantId()) - .build(); - commandBus.start(); - return commandBus; - }; - } - - - @Bean - @ConditionalOnClass(name = "org.axonframework.axonserver.connector.query.AxonServerQueryBus") - public TenantQuerySegmentFactory tenantAxonServerQuerySegmentFactory( - AxonServerConnectionManager axonServerConnectionManager, - AxonServerConfiguration axonServerConfig, - SpringAxonConfiguration axonConfig, - TransactionManager txManager, - @Qualifier("messageSerializer") Serializer messageSerializer, - Serializer genericSerializer, - QueryPriorityCalculator priorityCalculator, - QueryInvocationErrorHandler queryInvocationErrorHandler, - TargetContextResolver> targetContextResolver, - QueryUpdateEmitter multiTenantQueryUpdateEmitter - ) { - return tenantDescriptor -> { - Configuration config = axonConfig.getObject(); - SimpleQueryBus simpleQueryBus = - SimpleQueryBus.builder() - .messageMonitor(config.messageMonitor( - QueryBus.class, "queryBus@" + tenantDescriptor - )) - .transactionManager(txManager) - .spanFactory(config.getComponent(QueryBusSpanFactory.class)) - .queryUpdateEmitter(multiTenantQueryUpdateEmitter) - .errorHandler(queryInvocationErrorHandler) - .build(); - //noinspection resource - simpleQueryBus.registerHandlerInterceptor( - new CorrelationDataInterceptor<>(config.correlationDataProviders()) - ); - - AxonServerQueryBus queryBus = - AxonServerQueryBus.builder() - .axonServerConnectionManager(axonServerConnectionManager) - .configuration(axonServerConfig) - .localSegment(simpleQueryBus) - .updateEmitter( - ((MultiTenantQueryUpdateEmitter) multiTenantQueryUpdateEmitter) - .getTenant(tenantDescriptor) - ) - .messageSerializer(messageSerializer) - .genericSerializer(genericSerializer) - .priorityCalculator(priorityCalculator) - .spanFactory(config.getComponent(QueryBusSpanFactory.class)) - .targetContextResolver(targetContextResolver) - .defaultContext(tenantDescriptor.tenantId()) - .build(); - - queryBus.start(); - return queryBus; - }; - } - - @Bean - @ConditionalOnClass(name = "org.axonframework.axonserver.connector.query.AxonServerQueryBus") - public TenantQueryUpdateEmitterSegmentFactory tenantQueryUpdateEmitterSegmentFactory( - SpringAxonConfiguration axonConfig - ) { - return tenantDescriptor -> { - Configuration config = axonConfig.getObject(); - return SimpleQueryUpdateEmitter.builder() - .updateMessageMonitor(config.messageMonitor( - QueryUpdateEmitter.class, "queryUpdateEmitter@" + tenantDescriptor - )) - .build(); - }; - } - - @Bean - @ConditionalOnClass(name = "org.axonframework.axonserver.connector.command.AxonServerCommandBus") - public TenantEventSegmentFactory tenantEventSegmentFactory(AxonServerConfiguration axonServerConfig, - SpringAxonConfiguration axonConfig, - AxonServerConnectionManager axonServerConnectionManager, - Serializer snapshotSerializer, - @Qualifier("eventSerializer") Serializer eventSerializer) { - return tenant -> { - Configuration config = axonConfig.getObject(); - return AxonServerEventStore.builder() - .messageMonitor(config.messageMonitor( - AxonServerEventStore.class, "eventStore@" + tenant - )) - .configuration(axonServerConfig) - .platformConnectionManager(axonServerConnectionManager) - .snapshotSerializer(snapshotSerializer) - .eventSerializer(eventSerializer) - .spanFactory(config.getComponent(EventBusSpanFactory.class)) - .defaultContext(tenant.tenantId()) - .snapshotFilter(config.snapshotFilter()) - .upcasterChain(config.upcasterChain()) - .build(); - }; - } - - @Bean - @ConditionalOnClass(name = "org.axonframework.axonserver.connector.event.axon.AxonServerEventScheduler") - public TenantEventSchedulerSegmentFactory tenantEventSchedulerSegmentFactory( - AxonServerConnectionManager axonServerConnectionManager, - Serializer serializer - ) { - return tenant -> { - AxonServerEventScheduler eventScheduler = - AxonServerEventScheduler.builder() - .connectionManager(axonServerConnectionManager) - .eventSerializer(serializer) - .defaultContext(tenant.tenantId()) - .build(); - eventScheduler.start(); - return eventScheduler; - }; - } - - @Bean - @Primary - @ConditionalOnMissingBean - public TenantEventProcessorControlSegmentFactory tenantEventProcessorControlSegmentFactory() { - return TenantDescriptor::tenantId; - } - - @Bean - public EventProcessorInfoConfiguration processorInfoConfiguration( - TenantProvider tenantProvider, - AxonServerConnectionManager connectionManager, - TenantEventProcessorControlSegmentFactory tenantEventProcessorControlSegmentFactory - ) { - return new EventProcessorInfoConfiguration(c -> { - MultiTenantEventProcessorControlService controlService = new MultiTenantEventProcessorControlService( - connectionManager, - c.eventProcessingConfiguration(), - c.getComponent(AxonServerConfiguration.class), - tenantEventProcessorControlSegmentFactory - ); - tenantProvider.subscribe(controlService); - return controlService; - }); - } -} \ No newline at end of file diff --git a/multitenancy-spring-boot-autoconfigure/src/main/java/org/axonframework/extensions/multitenancy/autoconfig/MultiTenantDataSourceManager.java b/multitenancy-spring-boot-autoconfigure/src/main/java/org/axonframework/extensions/multitenancy/autoconfig/MultiTenantDataSourceManager.java deleted file mode 100644 index aef0de0..0000000 --- a/multitenancy-spring-boot-autoconfigure/src/main/java/org/axonframework/extensions/multitenancy/autoconfig/MultiTenantDataSourceManager.java +++ /dev/null @@ -1,243 +0,0 @@ -/* - * Copyright (c) 2010-2023. Axon Framework - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ -package org.axonframework.extensions.multitenancy.autoconfig; - -import org.axonframework.common.Registration; -import org.axonframework.extensions.multitenancy.TenantWrappedTransactionManager; -import org.axonframework.extensions.multitenancy.components.*; -import org.axonframework.messaging.Message; -import org.axonframework.messaging.unitofwork.CurrentUnitOfWork; -import org.axonframework.messaging.unitofwork.UnitOfWork; -import org.slf4j.Logger; -import org.slf4j.LoggerFactory; -import org.springframework.beans.factory.annotation.Autowired; -import org.springframework.boot.autoconfigure.condition.ConditionalOnBean; -import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty; -import org.springframework.boot.autoconfigure.jdbc.DataSourceProperties; -import org.springframework.context.annotation.Bean; -import org.springframework.context.annotation.Configuration; -import org.springframework.context.annotation.Primary; -import org.springframework.jdbc.datasource.lookup.AbstractRoutingDataSource; - -import javax.sql.DataSource; -import java.sql.Connection; -import java.sql.SQLException; -import java.util.Collections; -import java.util.Map; -import java.util.concurrent.ConcurrentHashMap; -import java.util.function.Function; - -/** - * Autoconfiguration for the MultiTenantDataSourceManager. Works in conjunction with the - * {@link TenantWrappedTransactionManager} that is used to add tenant to transaction context. - *

    - * Provides multi-tenant support for JPA-based applications. - * - * @author Stefan Dragisic - * @since 4.6.0 - */ -@Configuration -@ConditionalOnProperty(value = "axon.multi-tenancy.enabled", matchIfMissing = true) -@ConditionalOnBean(name = "tenantDataSourceResolver") -public class MultiTenantDataSourceManager implements MultiTenantAwareComponent { - - private static final Logger logger = LoggerFactory.getLogger(MultiTenantDataSourceManager.class); - - private final Map tenantDataSources = new ConcurrentHashMap<>(); - private AbstractRoutingDataSource multiTenantDataSource; - - private final DataSourceProperties properties; - private final TargetTenantResolver> tenantResolver; - private final Function dataSourcePropertyResolver; - - private final Function dataSourceResolver; - - private final Function dataSourceBuilder; - - /** - * Constructs a {@link MultiTenantDataSourceManager}. - * - * @param properties The default {@link DataSourceProperties} for the - * {@link AbstractRoutingDataSource tenant-aware DataSource}. - * @param tenantResolver A lambda used to resolve a {@link TenantDescriptor tenant} based on a - * {@link UnitOfWork#getMessage() message}. Integral part of the tenant-aware - * {@link DataSource} constructed by this class. - * @param dataSourcePropertyResolver A lambda resolving the tenant-specific {@link DataSourceProperties} based on a - * given {@link TenantDescriptor tenant}. - * @param dataSourceResolver A lambda resolving the tenant-specific {@link DataSource} based on a given - * @param dataSourceBuilder A lambda that builds a {@link DataSource} from a given {@link DataSourceProperties}. - */ - public MultiTenantDataSourceManager(DataSourceProperties properties, - TargetTenantResolver> tenantResolver, - @Autowired(required = false) - Function dataSourcePropertyResolver, - @Autowired(required = false) - Function dataSourceResolver, - @Autowired(required = false) - Function dataSourceBuilder) { - this.properties = properties; - this.tenantResolver = tenantResolver; - this.dataSourcePropertyResolver = dataSourcePropertyResolver; - this.dataSourceResolver = dataSourceResolver; - if (dataSourceBuilder == null) { - this.dataSourceBuilder = p -> p.initializeDataSourceBuilder().build(); - } else { - this.dataSourceBuilder = dataSourceBuilder; - } - } - - /** - * Bean creation method for a {@link DataSource} implementation that dynamically chooses a tenant-specific - * {@code DataSource}. Does so through {@link UnitOfWork#getMessage() message} from the - * {@link org.axonframework.messaging.unitofwork.UnitOfWork}, or from transaction provided by - * {@link TenantWrappedTransactionManager}. - * - * @param tenantProvider The {@link TenantProvider} to register the {@link MultiTenantDataSourceManager} with. - * @return A {@link DataSource} implementation that dynamically chooses a tenant-specific - */ - @Primary - @Bean - public DataSource tenantDataSource(TenantProvider tenantProvider) { - multiTenantDataSource = new AbstractRoutingDataSource() { - @Override - protected Object determineCurrentLookupKey() { - if (!CurrentUnitOfWork.isStarted()) { - return TenantWrappedTransactionManager.getCurrentTenant(); - } - Message message = CurrentUnitOfWork.get().getMessage(); - return tenantResolver.resolveTenant(message, tenantDataSources.keySet()); - } - }; - multiTenantDataSource.setTargetDataSources(Collections.unmodifiableMap(tenantDataSources)); - DataSource defaultDatasource = defaultDataSource(); - multiTenantDataSource.setDefaultTargetDataSource(defaultDatasource); - multiTenantDataSource.setLenientFallback(false); - multiTenantDataSource.afterPropertiesSet(); - - tenantProvider.subscribe(this); - return multiTenantDataSource; - } - - /** - * Creates and configures a default DataSource using the properties set in the application. - * - * This method initializes a DriverManagerDataSource with the following configurations: - * - Driver class name - * - Database URL - * - Username - * - Password - * - * These configurations are obtained from the application properties. - * - * @return A configured DriverManagerDataSource to be used as the default DataSource. - * @throws IllegalStateException if any of the required properties are not set. - */ - protected DataSource defaultDataSource() { - return dataSourceBuilder.apply(properties); - } - - private boolean tenantIsAbsent(TenantDescriptor tenantDescriptor) { - return !tenantDataSources.containsKey(tenantDescriptor); - } - - AbstractRoutingDataSource getMultiTenantDataSource() { - return multiTenantDataSource; - } - - /** - * Registers the given {@code tenantDescriptor}. - * - * @param tenantDescriptor The tenantDescriptor to register - * @return a Registration, which may be used to unregister the tenantDescriptor datasource - */ - @Override - public Registration registerTenant(TenantDescriptor tenantDescriptor) { - register(tenantDescriptor); - return () -> unregister(tenantDescriptor) != null; - } - - private void register(TenantDescriptor tenant) { - if (tenantIsAbsent(tenant)) { - if (dataSourceResolver != null) { - DataSource dataSource; - try { - dataSource = dataSourceResolver.apply(tenant); - logger.debug("[d] Datasource properties resolved for tenant descriptor [{}]", tenant); - } catch (Exception e) { - throw new NoSuchTenantException("Could not resolve the tenant!"); - } - addTenant(tenant, dataSource); - } - else if (dataSourcePropertyResolver != null) { - DataSourceProperties dataSourceProperties; - try { - dataSourceProperties = dataSourcePropertyResolver.apply(tenant); - logger.debug("[d] Datasource properties resolved for tenant descriptor [{}]", tenant); - } catch (Exception e) { - throw new NoSuchTenantException("Could not resolve the tenant!"); - } - addTenant(tenant, dataSourceProperties); - } - } - logger.debug("[d] Tenant [{}] set as current.", tenant); - } - - /** - * Adds a new tenant to the system using the provided tenant descriptor and data source properties. - * This method creates a new DataSource from the properties and then adds it to the system. - * - * @param tenant The descriptor of the tenant to be added. - * @param dataSourceProperties The properties used to create the DataSource for this tenant. - */ - protected void addTenant(TenantDescriptor tenant, DataSourceProperties dataSourceProperties) { - DataSource dataSource = dataSourceBuilder.apply(dataSourceProperties); - addTenant(tenant, dataSource); - } - - /** - * Adds a new tenant to the system using the provided tenant descriptor and pre-configured DataSource. - * This method validates the DataSource, adds it to the tenant map, and performs necessary setup. - * - * @param tenant The descriptor of the tenant to be added. - * @param dataSource The pre-configured DataSource for this tenant. - */ - protected void addTenant(TenantDescriptor tenant, DataSource dataSource) { - try (Connection ignored = dataSource.getConnection()) { - tenantDataSources.put(tenant, dataSource); - multiTenantDataSource.afterPropertiesSet(); - logger.debug("[d] Tenant '{}' added.", tenant); - } catch (SQLException t) { - logger.error("[d] Could not add tenant '{}'", tenant, t); - } - } - - private DataSource unregister(TenantDescriptor tenantDescriptor) { - Object removedDataSource = tenantDataSources.remove(tenantDescriptor); - multiTenantDataSource.afterPropertiesSet(); - return (DataSource) removedDataSource; - } - - /** - * Registers and starts the given {@code tenantDescriptor}. - * - * @param tenantDescriptor The tenantDescriptor to register - * @return a Registration, which may be used to unregister the tenantDescriptor datasource - */ - @Override - public Registration registerAndStartTenant(TenantDescriptor tenantDescriptor) { - return registerTenant(tenantDescriptor); - } -} \ No newline at end of file diff --git a/multitenancy-spring-boot-autoconfigure/src/main/java/org/axonframework/extensions/multitenancy/autoconfig/MultiTenantEventProcessorControlService.java b/multitenancy-spring-boot-autoconfigure/src/main/java/org/axonframework/extensions/multitenancy/autoconfig/MultiTenantEventProcessorControlService.java deleted file mode 100644 index e3cbce1..0000000 --- a/multitenancy-spring-boot-autoconfigure/src/main/java/org/axonframework/extensions/multitenancy/autoconfig/MultiTenantEventProcessorControlService.java +++ /dev/null @@ -1,228 +0,0 @@ -/* - * Copyright (c) 2010-2024. Axon Framework - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ -package org.axonframework.extensions.multitenancy.autoconfig; - -import io.axoniq.axonserver.connector.AxonServerConnection; -import io.axoniq.axonserver.connector.admin.AdminChannel; -import io.axoniq.axonserver.connector.control.ControlChannel; -import org.axonframework.axonserver.connector.AxonServerConfiguration; -import org.axonframework.axonserver.connector.AxonServerConnectionManager; -import org.axonframework.axonserver.connector.processor.EventProcessorControlService; -import org.axonframework.common.Registration; -import org.axonframework.config.EventProcessingConfiguration; -import org.axonframework.eventhandling.EventProcessor; -import org.axonframework.extensions.multitenancy.components.MultiTenantAwareComponent; -import org.axonframework.extensions.multitenancy.components.TenantDescriptor; -import org.axonframework.extensions.multitenancy.components.TenantEventProcessorControlSegmentFactory; -import org.axonframework.extensions.multitenancy.components.eventhandeling.MultiTenantEventProcessor; -import org.axonframework.lifecycle.Phase; -import org.axonframework.lifecycle.StartHandler; -import org.slf4j.Logger; -import org.slf4j.LoggerFactory; - -import java.lang.invoke.MethodHandles; -import java.util.HashMap; -import java.util.List; -import java.util.Map; -import java.util.Optional; -import java.util.stream.Collectors; - -import static java.util.stream.Collectors.toMap; - -/** - * Multi-tenant implementation of {@link EventProcessorControlService}. - *

    - * Enables event processor control for multi-tenant environment in Axon Server dashboard. - * - * @author Stefan Dragisic - * @since 4.6.0 - */ -public class MultiTenantEventProcessorControlService - extends EventProcessorControlService - implements MultiTenantAwareComponent { - - private static final Logger logger = LoggerFactory.getLogger(MethodHandles.lookup().lookupClass()); - private final TenantEventProcessorControlSegmentFactory tenantEventProcessorControlSegmentFactory; - - /** - * Initialize a {@link MultiTenantEventProcessorControlService}. - *

    - * This service adds processor instruction handlers to the {@link ControlChannel} of the given {@code context}, for - * every tenant. Doing so ensures operation like the {@link EventProcessor#start() start} and - * {@link EventProcessor#shutDown() shutdown} can be triggered through Axon Server. Furthermore, it sets the - * configured load balancing strategies through the {@link AdminChannel} of the {@code context}. - * - * @param axonServerConnectionManager A {@link AxonServerConnectionManager} from which to retrieve the - * {@link ControlChannel} and {@link AdminChannel}. - * @param eventProcessingConfiguration The {@link EventProcessor} configuration of this application, - * used to retrieve the registered event processors from. - * @param axonServerConfiguration The {@link AxonServerConfiguration} used to retrieve the - * {@link AxonServerConnectionManager#getDefaultContext() default - * context} from. - * @param tenantEventProcessorControlSegmentFactory The {@link TenantEventProcessorControlSegmentFactory} used to - * retrieve the context name for the given tenant. - */ - public MultiTenantEventProcessorControlService(AxonServerConnectionManager axonServerConnectionManager, - EventProcessingConfiguration eventProcessingConfiguration, - AxonServerConfiguration axonServerConfiguration, - TenantEventProcessorControlSegmentFactory tenantEventProcessorControlSegmentFactory) { - super(axonServerConnectionManager, - eventProcessingConfiguration, - axonServerConfiguration.getContext(), - axonServerConfiguration.getEventhandling().getProcessors()); - this.tenantEventProcessorControlSegmentFactory = tenantEventProcessorControlSegmentFactory; - } - - @StartHandler(phase = Phase.INSTRUCTION_COMPONENTS) - @Override - public void start() { - if (axonServerConnectionManager == null || eventProcessingConfiguration == null) { - return; - } - - Map contextToConnection = new HashMap<>(); - Map eventProcessors = eventProcessingConfiguration.eventProcessors(); - Map strategiesPerProcessor = strategiesPerProcessor(eventProcessors); - - eventProcessors.forEach((processorAndContext, processor) -> { - if (processor instanceof MultiTenantEventProcessor) { - return; - } - - String processorName = processorNameFromCombination(processorAndContext); - String context = contextFromCombination(processorAndContext); - AxonServerConnection connection = - contextToConnection.computeIfAbsent(context, axonServerConnectionManager::getConnection); - - registerInstructionHandler(connection.controlChannel(), processorAndContext, processor); - String strategyForProcessor = strategiesPerProcessor.get(processorName); - if (strategyForProcessor != null) { - setLoadBalancingStrategy(connection.adminChannel(), processorName, strategyForProcessor); - } - }); - } - - private Map strategiesPerProcessor(Map eventProcessors) { - List processorNames = - eventProcessors.entrySet() - .stream() - // Filter out MultiTenantEventProcessors as those aren't registered with Axon Server anyhow. - .filter(entry -> !(entry.getValue() instanceof MultiTenantEventProcessor)) - .map(Map.Entry::getKey) - .map(this::processorNameFromCombination) - .collect(Collectors.toList()); - return processorConfig.entrySet() - .stream() - .filter(entry -> { - if (!processorNames.contains(entry.getKey())) { - logger.info("Event Processor [{}] is not a registered. " - + "Please check the name or register the Event Processor", - entry.getKey()); - return false; - } - return true; - }) - .collect(toMap(Map.Entry::getKey, entry -> entry.getValue().getLoadBalancingStrategy())); - } - - private void registerInstructionHandler(ControlChannel controlChannel, - String processorAndContext, - EventProcessor processor) { - controlChannel.registerEventProcessor(processorAndContext, - infoSupplier(processor), - new AxonProcessorInstructionHandler(processor, processorAndContext)); - } - - private void setLoadBalancingStrategy(AdminChannel adminChannel, String processorName, String strategy) { - Optional optionalIdentifier = tokenStoreIdentifierFor(processorName); - if (!optionalIdentifier.isPresent()) { - logger.warn("Cannot find token store identifier for processor [{}]. " - + "Load balancing cannot be configured without this identifier.", processorName); - return; - } - String tokenStoreIdentifier = optionalIdentifier.get(); - - adminChannel.loadBalanceEventProcessor(processorName, tokenStoreIdentifier, strategy) - .whenComplete((r, e) -> { - if (e == null) { - logger.debug("Successfully requested to load balance processor [{}]" - + " with strategy [{}].", processorName, strategy); - return; - } - logger.warn("Requesting to load balance processor [{}] with strategy [{}] failed.", - processorName, strategy, e); - }); - if (processorConfig.get(processorName).isAutomaticBalancing()) { - adminChannel.setAutoLoadBalanceStrategy(processorName, tokenStoreIdentifier, strategy) - .whenComplete((r, e) -> { - if (e == null) { - logger.debug("Successfully requested to automatically balance processor [{}]" - + " with strategy [{}].", processorName, strategy); - return; - } - logger.warn( - "Requesting to automatically balance processor [{}] with strategy [{}] failed.", - processorName, strategy, e - ); - }); - } - } - - private Optional tokenStoreIdentifierFor(String processorName) { - return eventProcessingConfiguration.tokenStore(processorName) - .retrieveStorageIdentifier(); - } - - private String processorNameFromCombination(String processorAndTenantId) { - int index = processorAndTenantId.indexOf("@"); - return index == -1 ? processorAndTenantId : processorAndTenantId.substring(0, index); - } - - private String contextFromCombination(String processorAndTenantId) { - int index = processorAndTenantId.indexOf("@"); - //if there is no context name in the processorAndContext, return the _admin as default - String tenantId = index == -1 ? "_admin" : processorAndTenantId.substring(index + 1); - if ("_admin".equals(tenantId)) { - return "_admin"; - } - return tenantEventProcessorControlSegmentFactory.apply(TenantDescriptor.tenantWithId(tenantId)); - } - - @Override - public Registration registerTenant(TenantDescriptor tenantDescriptor) { - //Already registered - return () -> true; - } - - @Override - public Registration registerAndStartTenant(TenantDescriptor tenantDescriptor) { - if (axonServerConnectionManager == null || eventProcessingConfiguration == null) { - return () -> true; - } - Map eventProcessors = eventProcessingConfiguration.eventProcessors(); - eventProcessors.forEach((name, processor) -> { - if (processor instanceof MultiTenantEventProcessor || !name.contains(tenantDescriptor.tenantId())) { - return; - } - String context = tenantEventProcessorControlSegmentFactory.apply(tenantDescriptor); - ControlChannel controlChannel = axonServerConnectionManager.getConnection(context) - .controlChannel(); - AxonProcessorInstructionHandler instructionHandler = new AxonProcessorInstructionHandler(processor, name); - controlChannel.registerEventProcessor(name, infoSupplier(processor), instructionHandler); - }); - return () -> true; - } -} diff --git a/multitenancy-spring-boot-autoconfigure/src/main/java/org/axonframework/extensions/multitenancy/autoconfig/MultiTenantPersistentStreamAutoConfiguration.java b/multitenancy-spring-boot-autoconfigure/src/main/java/org/axonframework/extensions/multitenancy/autoconfig/MultiTenantPersistentStreamAutoConfiguration.java deleted file mode 100644 index 38afa40..0000000 --- a/multitenancy-spring-boot-autoconfigure/src/main/java/org/axonframework/extensions/multitenancy/autoconfig/MultiTenantPersistentStreamAutoConfiguration.java +++ /dev/null @@ -1,84 +0,0 @@ -/* - * Copyright (c) 2010-2024. Axon Framework - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ -package org.axonframework.extensions.multitenancy.autoconfig; - -import org.axonframework.axonserver.connector.event.axon.PersistentStreamMessageSource; -import org.axonframework.axonserver.connector.event.axon.PersistentStreamMessageSourceFactory; -import org.axonframework.common.StringUtils; -import org.axonframework.extensions.multitenancy.components.TenantProvider; -import org.axonframework.springboot.autoconfig.AxonServerAutoConfiguration; -import org.springframework.boot.autoconfigure.AutoConfiguration; -import org.springframework.boot.autoconfigure.AutoConfigureBefore; -import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean; -import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty; -import org.springframework.context.annotation.Bean; - -/** - * Auto-configuration class for multi-tenant persistent stream support in Axon Framework. - * This configuration is enabled when Axon Server and multi-tenancy are both enabled. - * - * @author Stefan Dragisic - * @since 4.10.0 - */ -@AutoConfiguration -@ConditionalOnProperty(value = {"axon.axonserver.enabled", "axon.multi-tenancy.enabled"}, matchIfMissing = true) -@AutoConfigureBefore(AxonServerAutoConfiguration.class) -public class MultiTenantPersistentStreamAutoConfiguration { - - /** - * Creates a PersistentStreamMessageSourceFactory for multi-tenant environments. - * - * @param tenantProvider The TenantProvider for managing tenants. - * @param tenantPersistentStreamMessageSourceFactory The factory for creating tenant-specific PersistentStreamMessageSources. - * @return A PersistentStreamMessageSourceFactory that supports multi-tenancy. - */ - @Bean - @ConditionalOnMissingBean - public PersistentStreamMessageSourceFactory persistentStreamMessageSourceFactory( - TenantProvider tenantProvider, - TenantPersistentStreamMessageSourceFactory tenantPersistentStreamMessageSourceFactory - ) { - return (name, persistentStreamProperties, scheduler, batchSize, context, configuration) -> { - MultiTenantPersistentStreamMessageSource component = new MultiTenantPersistentStreamMessageSource(name, persistentStreamProperties, scheduler, batchSize, context, configuration, - tenantPersistentStreamMessageSourceFactory); - tenantProvider.subscribe(component); - return component; - }; - } - - /** - * Creates a TenantPersistentStreamMessageSourceFactory for creating tenant-specific PersistentStreamMessageSources. - * @return A TenantPersistentStreamMessageSourceFactory. - */ - @Bean - @ConditionalOnMissingBean - public TenantPersistentStreamMessageSourceFactory tenantPersistentStreamMessageSourceFactory( - ) { - return ( name, - persistentStreamProperties, - scheduler, - batchSize, - context, - configuration, - tenantDescriptor) -> - new PersistentStreamMessageSource(name + "@" + tenantDescriptor.tenantId(), - configuration, - persistentStreamProperties, - scheduler, - batchSize, - StringUtils.emptyOrNull(context) ? tenantDescriptor.tenantId() : context); - } -} \ No newline at end of file diff --git a/multitenancy-spring-boot-autoconfigure/src/main/java/org/axonframework/extensions/multitenancy/autoconfig/MultiTenantPersistentStreamMessageSource.java b/multitenancy-spring-boot-autoconfigure/src/main/java/org/axonframework/extensions/multitenancy/autoconfig/MultiTenantPersistentStreamMessageSource.java deleted file mode 100644 index 3a5954c..0000000 --- a/multitenancy-spring-boot-autoconfigure/src/main/java/org/axonframework/extensions/multitenancy/autoconfig/MultiTenantPersistentStreamMessageSource.java +++ /dev/null @@ -1,125 +0,0 @@ -/* - * Copyright (c) 2010-2024. Axon Framework - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ -package org.axonframework.extensions.multitenancy.autoconfig; - - -import io.axoniq.axonserver.connector.event.PersistentStreamProperties; -import org.axonframework.axonserver.connector.event.axon.PersistentStreamMessageSource; -import org.axonframework.config.Configuration; -import org.axonframework.extensions.multitenancy.components.MultiTenantAwareComponent; -import org.axonframework.extensions.multitenancy.components.TenantDescriptor; -import org.axonframework.common.Registration; -import org.axonframework.extensions.multitenancy.components.eventstore.MultiTenantSubscribableMessageSource; - -import java.util.Collections; -import java.util.Map; -import java.util.concurrent.ConcurrentHashMap; -import java.util.concurrent.ScheduledExecutorService; - -/** - * A multi-tenant persistent stream message source that extends PersistentStreamMessageSource - * and implements MultiTenantAwareComponent and MultiTenantSubscribableMessageSource interfaces. - *

    - * This class provides functionality to manage message sources for multiple tenants, - * allowing registration and management of tenant-specific persistent stream message sources. - * It maintains a concurrent map of tenant descriptors to their corresponding message sources. - *

    - *

    - * The class supports operations such as registering new tenants, starting tenants, - * and retrieving all tenant segments. It uses a factory to create tenant-specific - * message sources, ensuring proper initialization and configuration for each tenant. - *

    - * @author Stefan Dragisic - * @since 4.10.0 - */ -public class MultiTenantPersistentStreamMessageSource extends PersistentStreamMessageSource - implements MultiTenantAwareComponent, MultiTenantSubscribableMessageSource { - - private final String name; - private final Configuration configuration; - private final TenantPersistentStreamMessageSourceFactory tenantPersistentStreamMessageSourceFactory; - private final Map tenantSegments = new ConcurrentHashMap<>(); - private final PersistentStreamProperties persistentStreamProperties; - private final ScheduledExecutorService scheduler; - private final int batchSize; - private final String context; - - /** - * Constructs a new MultiTenantPersistentStreamMessageSource. - * - * @param name The name of the message source. - * @param persistentStreamProperties Properties for the persistent stream. - * @param scheduler The scheduled executor service for managing tasks. - * @param batchSize The size of each batch of messages to process. - * @param context The context in which this message source operates. - * @param configuration The configuration settings for the message source. - * @param tenantPersistentStreamMessageSourceFactory The factory for creating tenant-specific message sources. - */ - public MultiTenantPersistentStreamMessageSource(String name, PersistentStreamProperties - persistentStreamProperties, ScheduledExecutorService scheduler, int batchSize, String context, Configuration configuration, - TenantPersistentStreamMessageSourceFactory tenantPersistentStreamMessageSourceFactory) { - - super(name, configuration, persistentStreamProperties, scheduler, batchSize, context); - this.tenantPersistentStreamMessageSourceFactory = tenantPersistentStreamMessageSourceFactory; - this.name = name; - this.configuration = configuration; - this.persistentStreamProperties = persistentStreamProperties; - this.scheduler = scheduler; - this.batchSize = batchSize; - this.context = context; - } - - /** - * Registers a new tenant with the message source. - * - * @param tenantDescriptor The descriptor of the tenant to register. - * @return A Registration object that can be used to unregister the tenant. - */ - @Override - public Registration registerTenant(TenantDescriptor tenantDescriptor) { - PersistentStreamMessageSource tenantSegment = tenantPersistentStreamMessageSourceFactory.build(name, - persistentStreamProperties, scheduler, batchSize, context, configuration, tenantDescriptor); - tenantSegments.putIfAbsent(tenantDescriptor, tenantSegment); - - return () -> { - PersistentStreamMessageSource removed = tenantSegments.remove(tenantDescriptor); - return removed != null; - }; - } - - /** - * Registers and starts a new tenant with the message source. - * In this implementation, it's equivalent to just registering the tenant. - * This component doesn't require any additional steps to start a tenant. - * - * @param tenantDescriptor The descriptor of the tenant to register and start. - * @return A Registration object that can be used to unregister the tenant. - */ - @Override - public Registration registerAndStartTenant(TenantDescriptor tenantDescriptor) { - return registerTenant(tenantDescriptor); - } - - /** - * Returns a map of all registered tenant segments. - * - * @return An unmodifiable map where keys are TenantDescriptors and values are PersistentStreamMessageSources. - */ - @Override - public Map tenantSegments() { - return Collections.unmodifiableMap(tenantSegments); - } -} \ No newline at end of file diff --git a/multitenancy-spring-boot-autoconfigure/src/main/java/org/axonframework/extensions/multitenancy/autoconfig/TenantCorrelationProvider.java b/multitenancy-spring-boot-autoconfigure/src/main/java/org/axonframework/extensions/multitenancy/autoconfig/TenantCorrelationProvider.java deleted file mode 100644 index 8d0b759..0000000 --- a/multitenancy-spring-boot-autoconfigure/src/main/java/org/axonframework/extensions/multitenancy/autoconfig/TenantCorrelationProvider.java +++ /dev/null @@ -1,50 +0,0 @@ -/* - * Copyright (c) 2010-2023. Axon Framework - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ -package org.axonframework.extensions.multitenancy.autoconfig; - -import org.axonframework.messaging.Message; -import org.axonframework.messaging.correlation.CorrelationDataProvider; - -import java.util.HashMap; -import java.util.Map; - -/** - * Default implementation of {@link CorrelationDataProvider} that provides the tenant identifier as a correlation. - * - * @author Stefan Dragisic - * @since 4.6.0 - */ -public class TenantCorrelationProvider implements CorrelationDataProvider { - - private final String tenantCorrelationKey; - - /** - * Construct a tenant-specific {@link CorrelationDataProvider} using the given {@code tenantCorrelationKey}. - * - * @param tenantCorrelationKey The key used to store the tenant identifier in the - * {@link org.axonframework.messaging.MetaData}. - */ - public TenantCorrelationProvider(String tenantCorrelationKey) { - this.tenantCorrelationKey = tenantCorrelationKey; - } - - @Override - public Map correlationDataFor(Message message) { - Map result = new HashMap<>(); - result.put(tenantCorrelationKey, message.getMetaData().getOrDefault(tenantCorrelationKey, "unknownTenant")); - return result; - } -} diff --git a/multitenancy-spring-boot-autoconfigure/src/main/java/org/axonframework/extensions/multitenancy/autoconfig/TenantPersistentStreamMessageSourceFactory.java b/multitenancy-spring-boot-autoconfigure/src/main/java/org/axonframework/extensions/multitenancy/autoconfig/TenantPersistentStreamMessageSourceFactory.java deleted file mode 100644 index dca9b1d..0000000 --- a/multitenancy-spring-boot-autoconfigure/src/main/java/org/axonframework/extensions/multitenancy/autoconfig/TenantPersistentStreamMessageSourceFactory.java +++ /dev/null @@ -1,61 +0,0 @@ -/* - * Copyright (c) 2010-2024. Axon Framework - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ -package org.axonframework.extensions.multitenancy.autoconfig; - -import io.axoniq.axonserver.connector.event.PersistentStreamProperties; -import org.axonframework.axonserver.connector.event.axon.PersistentStreamMessageSource; -import org.axonframework.config.Configuration; -import org.axonframework.extensions.multitenancy.components.TenantDescriptor; - -import java.util.concurrent.ScheduledExecutorService; - - - /** - * Factory interface for creating a {@link PersistentStreamMessageSource} for a specific tenant. - * The created PersistentStreamMessageSource can be used to read a stream of events from an Axon Server for a specific processor and tenant. - * The PersistentStreamMessageSource is configured with the provided processor name, settings, tenant descriptor, and Axon configuration. - * - * This interface is used to create a {@link PersistentStreamMessageSource} for a given tenant, - * @author Stefan Dragisic - * @since 4.10.0 - */ -@FunctionalInterface -public interface TenantPersistentStreamMessageSourceFactory { - - - /** - * Builds a new instance of {@link PersistentStreamMessageSource} with the specified parameters. - * - * @param name The name of the persistent stream. This is used to identify the stream. - * @param persistentStreamProperties The properties of the persistent stream, containing configuration details. - * @param scheduler The {@link ScheduledExecutorService} to be used for scheduling tasks related to the message source. - * @param batchSize The number of events to be fetched in a single batch from the stream. - * @param context The context in which the persistent stream operates. This can be used to differentiate streams in different environments or applications. - * @param configuration The Axon {@link Configuration} object, which provides access to the framework's configuration settings. - * @param tenantDescriptor The descriptor of the tenant for which the PersistentStreamMessageSource is created. - * @return A new instance of {@link PersistentStreamMessageSource} configured with the provided parameters. - * @throws IllegalArgumentException if any of the required parameters are null or invalid. - * @throws org.axonframework.axonserver.connector.AxonServerException if there's an issue connecting to or configuring the Axon Server. - */ - PersistentStreamMessageSource build( - String name, - PersistentStreamProperties persistentStreamProperties, - ScheduledExecutorService scheduler, - int batchSize, - String context, - Configuration configuration, - TenantDescriptor tenantDescriptor); -} \ No newline at end of file diff --git a/multitenancy-spring-boot-autoconfigure/src/main/resources/META-INF/spring.factories b/multitenancy-spring-boot-autoconfigure/src/main/resources/META-INF/spring.factories index 0487059..43b4709 100644 --- a/multitenancy-spring-boot-autoconfigure/src/main/resources/META-INF/spring.factories +++ b/multitenancy-spring-boot-autoconfigure/src/main/resources/META-INF/spring.factories @@ -1,5 +1,8 @@ org.springframework.boot.autoconfigure.EnableAutoConfiguration=\ - org.axonframework.extensions.multitenancy.autoconfig.MultiTenantPersistentStreamAutoConfiguration,\ - org.axonframework.extensions.multitenancy.autoconfig.MultiTenancyAutoConfiguration,\ - org.axonframework.extensions.multitenancy.autoconfig.MultiTenancyAxonServerAutoConfiguration + org.axonframework.extension.multitenancy.autoconfig.MultiTenancyAutoConfiguration,\ + org.axonframework.extension.multitenancy.autoconfig.MultiTenancyAxonServerAutoConfiguration,\ + org.axonframework.extension.multitenancy.autoconfig.MultiTenancySpringDataJpaAutoConfiguration,\ + org.axonframework.extension.multitenancy.autoconfig.MultiTenantEventProcessingAutoConfiguration +org.springframework.boot.autoconfigure.AutoConfigurationImportFilter=\ + org.axonframework.extension.multitenancy.autoconfig.MultiTenancyAutoConfigurationImportFilter diff --git a/multitenancy-spring-boot-autoconfigure/src/main/resources/META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports b/multitenancy-spring-boot-autoconfigure/src/main/resources/META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports index ae1b8e3..4f11602 100644 --- a/multitenancy-spring-boot-autoconfigure/src/main/resources/META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports +++ b/multitenancy-spring-boot-autoconfigure/src/main/resources/META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports @@ -1,2 +1,7 @@ -org.axonframework.extensions.multitenancy.autoconfig.MultiTenancyAutoConfiguration -org.axonframework.extensions.multitenancy.autoconfig.MultiTenancyAxonServerAutoConfiguration \ No newline at end of file +org.axonframework.extension.multitenancy.autoconfig.MultiTenancyAutoConfiguration +org.axonframework.extension.multitenancy.autoconfig.MultiTenancyAxonServerAutoConfiguration +org.axonframework.extension.multitenancy.autoconfig.MultiTenancySpringDataJpaAutoConfiguration +org.axonframework.extension.multitenancy.autoconfig.MultiTenancyJdbcAutoConfiguration +org.axonframework.extension.multitenancy.autoconfig.MultiTenancyR2dbcAutoConfiguration +org.axonframework.extension.multitenancy.autoconfig.MultiTenantEventProcessingAutoConfiguration +org.axonframework.extension.multitenancy.autoconfig.TenantComponentAutoConfiguration diff --git a/multitenancy-spring-boot-autoconfigure/src/test/java/org/axonframework/extensions/multitenancy/autoconfig/AxonServerTenantProviderTest.java b/multitenancy-spring-boot-autoconfigure/src/test/java/org/axonframework/extensions/multitenancy/autoconfig/AxonServerTenantProviderTest.java deleted file mode 100644 index c616c38..0000000 --- a/multitenancy-spring-boot-autoconfigure/src/test/java/org/axonframework/extensions/multitenancy/autoconfig/AxonServerTenantProviderTest.java +++ /dev/null @@ -1,304 +0,0 @@ -/* - * Copyright (c) 2010-2023. Axon Framework - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -package org.axonframework.extensions.multitenancy.autoconfig; - -import io.axoniq.axonserver.connector.AxonServerConnection; -import io.axoniq.axonserver.connector.ResultStream; -import io.axoniq.axonserver.connector.admin.AdminChannel; -import io.axoniq.axonserver.grpc.admin.ContextOverview; -import io.axoniq.axonserver.grpc.admin.ContextUpdate; -import io.axoniq.axonserver.grpc.admin.ContextUpdateType; -import io.axoniq.axonserver.grpc.admin.ReplicationGroupOverview; -import org.axonframework.axonserver.connector.AxonServerConnectionManager; -import org.axonframework.common.Registration; -import org.axonframework.extensions.multitenancy.components.MultiTenantAwareComponent; -import org.axonframework.extensions.multitenancy.components.TenantConnectPredicate; -import org.axonframework.extensions.multitenancy.components.TenantDescriptor; -import org.junit.jupiter.api.*; -import org.mockito.*; - -import java.util.Arrays; -import java.util.Iterator; -import java.util.List; -import java.util.Optional; -import java.util.concurrent.CompletableFuture; -import java.util.concurrent.Executors; -import java.util.concurrent.ScheduledExecutorService; -import java.util.concurrent.TimeUnit; -import java.util.concurrent.atomic.AtomicInteger; -import java.util.stream.IntStream; - -import static java.util.Arrays.asList; -import static org.junit.jupiter.api.Assertions.*; -import static org.mockito.Mockito.*; - -/** - * @author Stefan Dragisic - */ -class AxonServerTenantProviderTest { - - private AxonServerTenantProvider testSubject; - private TenantConnectPredicate tenantConnectPredicate; - private AxonServerConnectionManager axonServerConnectionManager; - - @BeforeEach - void setUp() { - tenantConnectPredicate = ctx -> ctx.tenantId().startsWith("tenant"); - axonServerConnectionManager = mock(AxonServerConnectionManager.class); - - AxonServerConnection axonServerConnection = mock(AxonServerConnection.class); - when(axonServerConnectionManager.getConnection(anyString())).thenReturn(axonServerConnection); - AdminChannel adminChannel = mock(AdminChannel.class); - when(axonServerConnection.adminChannel()).thenReturn(adminChannel); - ResultStream updatesStream = new StubResultStream<>(ContextUpdate.newBuilder() - .setContext("default") - .setType(ContextUpdateType.CREATED) - .build(), - ContextUpdate.newBuilder() - .setContext("tenant-1") - .setType(ContextUpdateType.CREATED) - .build(), - ContextUpdate.newBuilder() - .setContext("tenant-2") - .setType(ContextUpdateType.CREATED) - .build(), - ContextUpdate.newBuilder() - .setContext("tenant-2") - .setType(ContextUpdateType.DELETED) - .build()); - when(adminChannel.subscribeToContextUpdates()).thenReturn(updatesStream); - - ArgumentCaptor contextName = ArgumentCaptor.forClass(String.class); - when(adminChannel.getContextOverview(contextName.capture())) - .thenAnswer(unused -> CompletableFuture.completedFuture(ContextOverview.newBuilder() - .setName(contextName.getValue()) - .setChangePending(true) - .setPendingSince(1000L) - .setReplicationGroup( - ReplicationGroupOverview.newBuilder() - .setName( - "default-rp") - .build()) - .build())); - - when(adminChannel.getAllContexts()) - .thenReturn(CompletableFuture.completedFuture(Arrays.asList( - ContextOverview.newBuilder() - .setName("tenant-3") - .setChangePending(true) - .setPendingSince(1000L) - .setReplicationGroup( - ReplicationGroupOverview.newBuilder() - .setName( - "tenant-3-rp") - .build()) - .build(), - ContextOverview.newBuilder() - .setName("tenant-4") - .setChangePending(false) - .setPendingSince(2000L) - .setReplicationGroup( - ReplicationGroupOverview.newBuilder() - .setName( - "tenant-4-rp") - .build()) - .build() - ))); - } - - - @Test - void whenInitialTenantsThenStart() { - testSubject = new AxonServerTenantProvider("default, tenant-1, tenant-2", - tenantConnectPredicate, - axonServerConnectionManager); - MultiTenantAwareComponent mockComponent = mock(MultiTenantAwareComponent.class); - when(mockComponent.registerTenant(any())).thenReturn(() -> true); - - //first start provider - testSubject.start(); - - //add new component - testSubject.subscribe(mockComponent); - - //noinspection resource - verify(mockComponent).registerTenant(TenantDescriptor.tenantWithId("tenant-1")); - //noinspection resource - verify(mockComponent).registerTenant(TenantDescriptor.tenantWithId("tenant-2")); - } - - @Test - void whenInitialTenantsIsEmpty() throws InterruptedException { - testSubject = new AxonServerTenantProvider("", tenantConnectPredicate, axonServerConnectionManager); - MultiTenantAwareComponent mockComponent = mock(MultiTenantAwareComponent.class); - - //first start provider - testSubject.start(); - - //add new component - testSubject.subscribe(mockComponent); - - Thread.sleep(3000); - - ArgumentCaptor tenantCaptor = ArgumentCaptor.forClass(TenantDescriptor.class); - //initial setup - //noinspection resource - verify(mockComponent, times(2)).registerTenant(tenantCaptor.capture()); - tenantCaptor.getAllValues().forEach(tenantDescriptor -> { - if (tenantDescriptor.tenantId().equals("tenant-3")) { - assertEquals("tenant-3", tenantDescriptor.tenantId()); - assertEquals("tenant-3-rp", tenantDescriptor.properties().get("replicationGroup")); - } else if (tenantDescriptor.tenantId().equals("tenant-4")) { - assertEquals("tenant-4", tenantDescriptor.tenantId()); - assertEquals("tenant-4-rp", tenantDescriptor.properties().get("replicationGroup")); - } else { - fail("Unexpected tenant descriptor"); - } - }); - - tenantCaptor = ArgumentCaptor.forClass(TenantDescriptor.class); - //additionally created contexts - verify(mockComponent, times(2)).registerAndStartTenant(tenantCaptor.capture()); - List resultDescriptors = tenantCaptor.getAllValues(); - assertEquals(2, resultDescriptors.size()); - assertEquals("tenant-1", resultDescriptors.get(0).tenantId()); - assertEquals("tenant-2", resultDescriptors.get(1).tenantId()); - } - - private static class StubResultStream implements ResultStream { - - private final ScheduledExecutorService executor = Executors.newScheduledThreadPool(5); - private final Iterator responses; - private final Throwable error; - private T peeked; - private volatile boolean closed; - private final int totalNumberOfElements; - - @SafeVarargs - public StubResultStream(T... responses) { - this.error = null; - List queryResponses = asList(responses); - this.responses = queryResponses.iterator(); - this.totalNumberOfElements = queryResponses.size(); - this.closed = totalNumberOfElements == 0; - } - - @Override - public T peek() { - if (peeked == null && responses.hasNext()) { - peeked = responses.next(); - } - return peeked; - } - - @Override - public T nextIfAvailable() { - if (peeked != null) { - T result = peeked; - peeked = null; - closeIfThereAreNoMoreElements(); - return result; - } - if (responses.hasNext()) { - T next = responses.next(); - closeIfThereAreNoMoreElements(); - return next; - } else { - return null; - } - } - - private void closeIfThereAreNoMoreElements() { - if (!responses.hasNext()) { - close(); - } - } - - @Override - public T nextIfAvailable(long timeout, TimeUnit unit) { - return nextIfAvailable(); - } - - @Override - public T next() { - return nextIfAvailable(); - } - - AtomicInteger messageNumber = new AtomicInteger(0); - - @Override - public void onAvailable(Runnable r) { - if (peeked != null || responses.hasNext() || isClosed()) { - IntStream.rangeClosed(0, totalNumberOfElements) - .forEach(i -> executor.schedule(r, - 1000 + messageNumber.getAndIncrement() * 100L, - TimeUnit.MILLISECONDS)); - } - } - - @Override - public void close() { - closed = true; - } - - @Override - public boolean isClosed() { - return closed; - } - - @Override - public Optional getError() { - return Optional.ofNullable(error); - } - } - - @Test - void whenShutdownThenDeregisterComponentsInReverseOrder() { - testSubject = new AxonServerTenantProvider("default, tenant-1, tenant-2", - tenantConnectPredicate, - axonServerConnectionManager); - testSubject.start(); - - MultiTenantAwareComponent component1 = mock(MultiTenantAwareComponent.class); - MultiTenantAwareComponent component2 = mock(MultiTenantAwareComponent.class); - MultiTenantAwareComponent component3 = mock(MultiTenantAwareComponent.class); - - // Create mocked Registration objects - Registration registration1 = mock(Registration.class); - Registration registration2 = mock(Registration.class); - Registration registration3 = mock(Registration.class); - - // Setup the mocks to return the registrations - when(component1.registerTenant(any())).thenReturn(() -> registration1.cancel()); - when(component2.registerTenant(any())).thenReturn(() -> registration2.cancel()); - when(component3.registerTenant(any())).thenReturn(() -> registration3.cancel()); - - // Subscribe components in order - testSubject.subscribe(component1); - testSubject.subscribe(component2); - testSubject.subscribe(component3); - - // Shutdown the provider - testSubject.shutdown(); - - // Verify that cancellations happened in reverse order - InOrder inOrder = inOrder(registration3, registration2, registration1); - inOrder.verify(registration3).cancel(); - inOrder.verify(registration2).cancel(); - inOrder.verify(registration1).cancel(); - } -} \ No newline at end of file diff --git a/multitenancy-spring-boot-autoconfigure/src/test/java/org/axonframework/extensions/multitenancy/autoconfig/MultiTenancyAutoConfigurationTest.java b/multitenancy-spring-boot-autoconfigure/src/test/java/org/axonframework/extensions/multitenancy/autoconfig/MultiTenancyAutoConfigurationTest.java deleted file mode 100644 index c939d2d..0000000 --- a/multitenancy-spring-boot-autoconfigure/src/test/java/org/axonframework/extensions/multitenancy/autoconfig/MultiTenancyAutoConfigurationTest.java +++ /dev/null @@ -1,169 +0,0 @@ -/* - * Copyright (c) 2010-2023. Axon Framework - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -package org.axonframework.extensions.multitenancy.autoconfig; - -import org.axonframework.axonserver.connector.event.axon.PersistentStreamMessageSource; -import org.axonframework.axonserver.connector.event.axon.PersistentStreamMessageSourceFactory; -import org.axonframework.extensions.multitenancy.components.TargetTenantResolver; -import org.axonframework.extensions.multitenancy.components.TenantConnectPredicate; -import org.axonframework.extensions.multitenancy.components.TenantDescriptor; -import org.axonframework.extensions.multitenancy.components.commandhandeling.MultiTenantCommandBus; -import org.axonframework.extensions.multitenancy.components.commandhandeling.TenantCommandSegmentFactory; -import org.axonframework.extensions.multitenancy.components.deadletterqueue.MultiTenantDeadLetterQueueFactory; -import org.axonframework.extensions.multitenancy.components.eventstore.MultiTenantEventStore; -import org.axonframework.extensions.multitenancy.components.eventstore.TenantEventSegmentFactory; -import org.axonframework.extensions.multitenancy.components.queryhandeling.MultiTenantQueryBus; -import org.axonframework.extensions.multitenancy.components.queryhandeling.MultiTenantQueryUpdateEmitter; -import org.axonframework.extensions.multitenancy.components.queryhandeling.TenantQuerySegmentFactory; -import org.axonframework.extensions.multitenancy.components.scheduling.MultiTenantEventScheduler; -import org.axonframework.extensions.multitenancy.configuration.MultiTenantEventProcessingModule; -import org.axonframework.messaging.Message; -import org.axonframework.messaging.correlation.CorrelationDataProvider; -import org.axonframework.springboot.autoconfig.*; -import org.junit.jupiter.api.*; -import org.springframework.boot.autoconfigure.AutoConfigurations; -import org.springframework.boot.test.context.runner.ApplicationContextRunner; - -import static org.assertj.core.api.Assertions.assertThat; -import static org.junit.jupiter.api.Assertions.*; -import static org.mockito.Mockito.mock; - -/** - * Test class validating the multi-tenancy auto-configuration. - * - * @author Stefan Dragisic - */ -class MultiTenancyAutoConfigurationTest { - - private final ApplicationContextRunner contextRunner = new ApplicationContextRunner() - .withConfiguration( - AutoConfigurations.of( - AxonAutoConfiguration.class, - EventProcessingAutoConfiguration.class, - InfraConfiguration.class, - AxonServerBusAutoConfiguration.class, - AxonServerAutoConfiguration.class, - NoOpTransactionAutoConfiguration.class, - ObjectMapperAutoConfiguration.class, - TransactionAutoConfiguration.class, - XStreamAutoConfiguration.class, - AxonTracingAutoConfiguration.class - )); - - @Test - void multiTenancyAutoConfiguration() { - contextRunner.withConfiguration(AutoConfigurations.of(MultiTenancyAxonServerAutoConfiguration.class)) - .withConfiguration(AutoConfigurations.of(MultiTenancyAutoConfiguration.class)) - .withPropertyValues("axon.axonserver.contexts=tenant-1,tenant-2") - .run(context -> { - assertThat(context).getBean("tenantFilterPredicate") - .isInstanceOf(TenantConnectPredicate.class); - assertThat(context).getBean("targetTenantResolver") - .isInstanceOf(TargetTenantResolver.class); - assertThat(context).getBean("tenantCorrelationProvider") - .isInstanceOf(CorrelationDataProvider.class); - assertThat(context).getBean("multiTenantEventProcessingModule") - .isExactlyInstanceOf(MultiTenantEventProcessingModule.class); - assertThat(context).getBean("multiTenantCommandBus") - .isExactlyInstanceOf(MultiTenantCommandBus.class); - assertThat(context).getBean("multiTenantQueryBus") - .isExactlyInstanceOf(MultiTenantQueryBus.class); - assertThat(context).getBean("multiTenantEventStore") - .isExactlyInstanceOf(MultiTenantEventStore.class); - assertThat(context).getBean("multiTenantDeadLetterQueueFactory") - .isInstanceOf(MultiTenantDeadLetterQueueFactory.class); - assertThat(context).getBean("multiTenantEventScheduler") - .isExactlyInstanceOf(MultiTenantEventScheduler.class); - assertThat(context).getBean("multiTenantQueryUpdateEmitter") - .isInstanceOf(MultiTenantQueryUpdateEmitter.class); - assertThat(context).getBean("persistentStreamMessageSourceFactory") - .isInstanceOf(PersistentStreamMessageSourceFactory.class); - assertThat(context).getBean("tenantPersistentStreamMessageSourceFactory") - .isInstanceOf(TenantPersistentStreamMessageSourceFactory.class); - }); - } - - @Test - void multiTenancyDisabled() { - contextRunner.withPropertyValues( - "axon.multi-tenancy.enabled:false", "axon.axonserver.contexts=tenant-1,tenant-2" - ) - .withConfiguration(AutoConfigurations.of(MultiTenancyAxonServerAutoConfiguration.class)) - .withConfiguration(AutoConfigurations.of(MultiTenancyAutoConfiguration.class)) - .run(context -> { - assertThat(context).doesNotHaveBean(TenantConnectPredicate.class); - assertThat(context).doesNotHaveBean(TargetTenantResolver.class); - assertThat(context).doesNotHaveBean(MultiTenantEventProcessingModule.class); - assertThat(context).doesNotHaveBean(MultiTenantCommandBus.class); - assertThat(context).doesNotHaveBean(MultiTenantEventStore.class); - assertThat(context).doesNotHaveBean(MultiTenantQueryBus.class); - assertThat(context).doesNotHaveBean(AxonServerTenantProvider.class); - assertThat(context).doesNotHaveBean(TenantCommandSegmentFactory.class); - assertThat(context).doesNotHaveBean(TenantQuerySegmentFactory.class); - assertThat(context).doesNotHaveBean(MultiTenantQueryUpdateEmitter.class); - assertThat(context).doesNotHaveBean(TenantEventSegmentFactory.class); - assertThat(context).doesNotHaveBean(MultiTenantDeadLetterQueueFactory.class); - assertThat(context).doesNotHaveBean(MultiTenantEventScheduler.class); - assertThat(context).doesNotHaveBean(MultiTenantQueryUpdateEmitter.class); - assertThat(context).doesNotHaveBean(TenantPersistentStreamMessageSourceFactory.class); - }); - } - - @Test - void multiTenancyAutoConfigurationMultiTenantPersistentStreamMessageSource() { - contextRunner - .withConfiguration(AutoConfigurations.of(AxonServerAutoConfiguration.class)) - - .withConfiguration(AutoConfigurations.of(MultiTenancyAxonServerAutoConfiguration.class)) - .withConfiguration(AutoConfigurations.of(MultiTenantPersistentStreamAutoConfiguration.class)) - .withPropertyValues("axon.axonserver.contexts=tenant-1,tenant-2") - .run(context -> { - PersistentStreamMessageSourceFactory persistentStreamMessageSourceFactory = - context.getBean("persistentStreamMessageSourceFactory", PersistentStreamMessageSourceFactory.class); - PersistentStreamMessageSource persistentStreamMessageSource = persistentStreamMessageSourceFactory.build("testName", mock(), mock(), 100, "testContext", mock()); - assertThat(persistentStreamMessageSource).isInstanceOf(MultiTenantPersistentStreamMessageSource.class); - }); - } - - @Test - void multiTenancyMetaDataHelperDisabled() { - TargetTenantResolver> userResolver = (message, tenants) -> - TenantDescriptor.tenantWithId( - (String) message.getMetaData() - .getOrDefault("USER_CORRELATION_KEY", "unknownTenant") - ); - contextRunner.withBean(TargetTenantResolver.class, () -> userResolver) - .withPropertyValues( - "axon.multi-tenancy.use-metadata-helper:false", - "axon.axonserver.contexts=tenant-1,tenant-2" - ) - .withConfiguration(AutoConfigurations.of(MultiTenancyAxonServerAutoConfiguration.class)) - .withConfiguration(AutoConfigurations.of(MultiTenancyAutoConfiguration.class)) - .run(context -> { - assertThat(context).doesNotHaveBean("tenantCorrelationProvider"); - assertThat(context).getBeanNames(TargetTenantResolver.class) - .hasSize(1); - assertThat(context).getBean("targetTenantResolver") - .returns(TargetTenantResolver.class, ttr -> { - assertEquals(ttr, userResolver); - return TargetTenantResolver.class; - }); - }); - } -} - - diff --git a/multitenancy-spring-boot-autoconfigure/src/test/java/org/axonframework/extensions/multitenancy/autoconfig/MultiTenancyAxonServerAutoConfigurationTest.java b/multitenancy-spring-boot-autoconfigure/src/test/java/org/axonframework/extensions/multitenancy/autoconfig/MultiTenancyAxonServerAutoConfigurationTest.java deleted file mode 100644 index 493e961..0000000 --- a/multitenancy-spring-boot-autoconfigure/src/test/java/org/axonframework/extensions/multitenancy/autoconfig/MultiTenancyAxonServerAutoConfigurationTest.java +++ /dev/null @@ -1,137 +0,0 @@ -/* - * Copyright (c) 2010-2023. Axon Framework - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -package org.axonframework.extensions.multitenancy.autoconfig; - -import org.axonframework.axonserver.connector.command.AxonServerCommandBus; -import org.axonframework.axonserver.connector.event.axon.EventProcessorInfoConfiguration; -import org.axonframework.commandhandling.CommandBus; -import org.axonframework.commandhandling.SimpleCommandBus; -import org.axonframework.extensions.multitenancy.components.TenantDescriptor; -import org.axonframework.extensions.multitenancy.components.commandhandeling.TenantCommandSegmentFactory; -import org.axonframework.extensions.multitenancy.components.eventstore.TenantEventSegmentFactory; -import org.axonframework.extensions.multitenancy.components.queryhandeling.TenantQuerySegmentFactory; -import org.axonframework.extensions.multitenancy.components.queryhandeling.TenantQueryUpdateEmitterSegmentFactory; -import org.axonframework.extensions.multitenancy.components.scheduling.TenantEventSchedulerSegmentFactory; -import org.axonframework.springboot.autoconfig.AxonAutoConfiguration; -import org.axonframework.springboot.autoconfig.AxonServerAutoConfiguration; -import org.axonframework.springboot.autoconfig.AxonServerBusAutoConfiguration; -import org.axonframework.springboot.autoconfig.AxonTracingAutoConfiguration; -import org.axonframework.springboot.autoconfig.EventProcessingAutoConfiguration; -import org.axonframework.springboot.autoconfig.InfraConfiguration; -import org.axonframework.springboot.autoconfig.NoOpTransactionAutoConfiguration; -import org.axonframework.springboot.autoconfig.ObjectMapperAutoConfiguration; -import org.axonframework.springboot.autoconfig.TransactionAutoConfiguration; -import org.axonframework.springboot.autoconfig.XStreamAutoConfiguration; -import org.junit.jupiter.api.*; -import org.springframework.beans.factory.annotation.Qualifier; -import org.springframework.boot.autoconfigure.AutoConfigurations; -import org.springframework.boot.test.context.runner.ApplicationContextRunner; -import org.springframework.context.annotation.Bean; - -import static org.assertj.core.api.Assertions.assertThat; -import static org.mockito.Mockito.mock; - -/** - * Test class validating the autoconfiguration of Axon Server-specific multi-tenancy components. - * - * @author Stefan Dragisic - */ -class MultiTenancyAxonServerAutoConfigurationTest { - - private final ApplicationContextRunner contextRunner = new ApplicationContextRunner() - .withConfiguration( - AutoConfigurations.of( - AxonAutoConfiguration.class, - EventProcessingAutoConfiguration.class, - InfraConfiguration.class, - AxonServerBusAutoConfiguration.class, - MultiTenancyAxonServerAutoConfiguration.class, - AxonServerAutoConfiguration.class, - NoOpTransactionAutoConfiguration.class, - ObjectMapperAutoConfiguration.class, - TransactionAutoConfiguration.class, - XStreamAutoConfiguration.class, - AxonTracingAutoConfiguration.class - )); - - @Test - void axonServerAutoConfiguration() { - contextRunner.withConfiguration(AutoConfigurations.of(MultiTenancyAxonServerAutoConfiguration.class)) - .withConfiguration(AutoConfigurations.of(MultiTenancyAutoConfiguration.class)) - .withPropertyValues("axon.axonserver.contexts=tenant-1,tenant-2") - .run(context -> { - assertThat(context).getBean("tenantEventSchedulerSegmentFactory") - .isInstanceOf(TenantEventSchedulerSegmentFactory.class); - assertThat(context).getBean("tenantAxonServerCommandSegmentFactory") - .isInstanceOf(TenantCommandSegmentFactory.class); - assertThat(context).getBean("tenantAxonServerQuerySegmentFactory") - .isInstanceOf(TenantQuerySegmentFactory.class); - assertThat(context).getBean("tenantQueryUpdateEmitterSegmentFactory") - .isInstanceOf(TenantQueryUpdateEmitterSegmentFactory.class); - assertThat(context).getBean("tenantEventSegmentFactory") - .isInstanceOf(TenantEventSegmentFactory.class); - assertThat(context).getBean("tenantEventSchedulerSegmentFactory") - .isInstanceOf(TenantEventSchedulerSegmentFactory.class); - assertThat(context).getBean("processorInfoConfiguration") - .isInstanceOf(EventProcessorInfoConfiguration.class); - assertThat(context).getBean("tenantProvider") - .isInstanceOf(AxonServerTenantProvider.class); - }); - } - - @Test - void tenantCommandSegmentFactoryUsesOwnSimpleCommandBus() { - contextRunner.withConfiguration(AutoConfigurations.of(MultiTenancyAxonServerAutoConfiguration.class)) - .withConfiguration(AutoConfigurations.of(MultiTenancyAutoConfiguration.class)) - .withUserConfiguration(SharedCommandBus.class) - .withPropertyValues("axon.axonserver.contexts=tenant-1,tenant-2") - .run(context -> { - TenantCommandSegmentFactory factory = context.getBean(TenantCommandSegmentFactory.class); - SimpleCommandBus sharedCommandBus = context.getBean("sharedSimpleCommandBus", SimpleCommandBus.class); - - AxonServerCommandBus commandBus = (AxonServerCommandBus) factory.apply(new TenantDescriptor("test-tenant")); - CommandBus localSegment = commandBus.localSegment(); - - assertThat(localSegment).isNotSameAs(sharedCommandBus); - }); - } - - - static class SharedCommandBus { - @Qualifier("localSegment") - @Bean - public SimpleCommandBus sharedSimpleCommandBus() { - return mock(SimpleCommandBus.class); - } - } - - @Test - void axonServerDisabled() { - contextRunner.withPropertyValues("axon.axonserver.enabled:false", "axon.axonserver.contexts=tenant-1,tenant-2") - .run(context -> { - assertThat(context).doesNotHaveBean(TenantEventSchedulerSegmentFactory.class); - assertThat(context).doesNotHaveBean(TenantCommandSegmentFactory.class); - assertThat(context).doesNotHaveBean(TenantQuerySegmentFactory.class); - assertThat(context).doesNotHaveBean(TenantQueryUpdateEmitterSegmentFactory.class); - assertThat(context).doesNotHaveBean(TenantEventSegmentFactory.class); - assertThat(context).doesNotHaveBean(TenantEventSchedulerSegmentFactory.class); - assertThat(context).doesNotHaveBean(TenantCommandSegmentFactory.class); - assertThat(context).doesNotHaveBean(EventProcessorInfoConfiguration.class); - assertThat(context).doesNotHaveBean(AxonServerTenantProvider.class); - }); - } -} \ No newline at end of file diff --git a/multitenancy-spring-boot-autoconfigure/src/test/java/org/axonframework/extensions/multitenancy/autoconfig/MultiTenantDataSourceManagerTest.java b/multitenancy-spring-boot-autoconfigure/src/test/java/org/axonframework/extensions/multitenancy/autoconfig/MultiTenantDataSourceManagerTest.java deleted file mode 100644 index da26a17..0000000 --- a/multitenancy-spring-boot-autoconfigure/src/test/java/org/axonframework/extensions/multitenancy/autoconfig/MultiTenantDataSourceManagerTest.java +++ /dev/null @@ -1,170 +0,0 @@ -/* - * Copyright (c) 2010-2023. Axon Framework - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -package org.axonframework.extensions.multitenancy.autoconfig; - -import org.axonframework.extensions.multitenancy.components.TenantDescriptor; -import org.axonframework.extensions.multitenancy.components.TenantProvider; -import org.axonframework.springboot.autoconfig.*; -import org.junit.jupiter.api.Test; -import org.springframework.boot.autoconfigure.AutoConfigurations; -import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty; -import org.springframework.boot.autoconfigure.jdbc.DataSourceProperties; -import org.springframework.boot.jdbc.DataSourceBuilder; -import org.springframework.boot.test.context.runner.ApplicationContextRunner; -import org.springframework.context.annotation.Bean; -import org.springframework.context.annotation.Configuration; - -import javax.sql.DataSource; -import java.util.concurrent.atomic.AtomicBoolean; -import java.util.function.Function; - -import static org.assertj.core.api.Assertions.assertThat; -import static org.junit.jupiter.api.Assertions.assertSame; -import static org.mockito.Mockito.*; - -/** - * Test class validating Multi-Tenancy auto-configuration for the {@code DataSourceManager}. - * - * @author Stefan Dragisic - */ -class MultiTenantDataSourceManagerTest { - - private final ApplicationContextRunner contextRunner = new ApplicationContextRunner() - .withConfiguration( - AutoConfigurations.of( - AxonAutoConfiguration.class, - EventProcessingAutoConfiguration.class, - InfraConfiguration.class, - AxonServerBusAutoConfiguration.class, - AxonServerAutoConfiguration.class, - NoOpTransactionAutoConfiguration.class, - ObjectMapperAutoConfiguration.class, - TransactionAutoConfiguration.class, - XStreamAutoConfiguration.class, - MultiTenancyAxonServerAutoConfiguration.class, - MultiTenancyAutoConfiguration.class, - MultiTenantDataSourceManager.class, - AxonTracingAutoConfiguration.class - )); - - @Test - void resolveDefaultDataSourceProperties() { - DataSourceProperties dataSourceProperties = mock(DataSourceProperties.class); - Function tenantDataSourceResolver = - (tenant) -> dataSourceProperties; - - DataSourceProperties defaultDataSourceProperties = mock(DataSourceProperties.class); - - TenantProvider tenantProvider = mock(TenantProvider.class); - when(tenantProvider.subscribe(any())).thenReturn(() -> true); - - this.contextRunner.withPropertyValues("axon.axonserver.contexts=default") - .withAllowBeanDefinitionOverriding(true) - .withBean(TenantProvider.class, () -> tenantProvider) - .withBean("tenantDataSourceResolver", Function.class, () -> tenantDataSourceResolver) - .withBean("properties", DataSourceProperties.class, () -> defaultDataSourceProperties) - .withUserConfiguration(TestConfiguration.class) - .run(context -> { - assertThat(context).hasSingleBean(MultiTenantDataSourceManager.class); - MultiTenantDataSourceManager multiTenantDataSourceManager = context.getBean(MultiTenantDataSourceManager.class); - - verify(tenantProvider).subscribe(multiTenantDataSourceManager); - assertThat(TestConfiguration.dataSourceResolved.get()); - }); - } - - @Test - void resolveTenantDataSource() { - DataSourceProperties defaultDataSourceProperties = mock(DataSourceProperties.class); - - TenantProvider tenantProvider = mock(TenantProvider.class); - when(tenantProvider.subscribe(any())).thenReturn(() -> true); - - this.contextRunner - .withPropertyValues("axon.axonserver.contexts=default") - .withAllowBeanDefinitionOverriding(true) - .withBean(TenantProvider.class, () -> tenantProvider) - .withUserConfiguration(TestConfiguration.class) - .withUserConfiguration(DataSourceResolverConfiguration.class) - .withBean("properties", DataSourceProperties.class, () -> defaultDataSourceProperties) - .run(context -> { - assertThat(context).hasSingleBean(MultiTenantDataSourceManager.class); - MultiTenantDataSourceManager multiTenantDataSourceManager = context.getBean(MultiTenantDataSourceManager.class); - verify(tenantProvider).subscribe(multiTenantDataSourceManager); - multiTenantDataSourceManager.registerTenant(TenantDescriptor.tenantWithId("test")); - assertThat(DataSourceResolverConfiguration.dataSourceResolved.get()).isTrue(); - }); - } - - @Test - void resolveTenantDataSourceProperties() { - DataSourceProperties defaultDataSourceProperties = mock(DataSourceProperties.class); - - TenantProvider tenantProvider = mock(TenantProvider.class); - when(tenantProvider.subscribe(any())).thenReturn(() -> true); - - this.contextRunner - .withPropertyValues("axon.axonserver.contexts=default") - .withAllowBeanDefinitionOverriding(true) - .withBean(TenantProvider.class, () -> tenantProvider) - .withUserConfiguration(TestConfiguration.class) - .withUserConfiguration(DataSourcePropertiesResolverConfiguration.class) - .withBean("properties", DataSourceProperties.class, () -> defaultDataSourceProperties) - .run(context -> { - assertThat(context).hasSingleBean(MultiTenantDataSourceManager.class); - MultiTenantDataSourceManager multiTenantDataSourceManager = context.getBean(MultiTenantDataSourceManager.class); - verify(tenantProvider).subscribe(multiTenantDataSourceManager); - multiTenantDataSourceManager.registerTenant(TenantDescriptor.tenantWithId("test")); - assertThat(DataSourcePropertiesResolverConfiguration.dataSourcePropertiesResolved.get()).isTrue(); - }); - } - - static class TestConfiguration { - public static AtomicBoolean dataSourceResolved = new AtomicBoolean(false); - @Bean - public Function dataSourceBuilder() { - return properties -> { - dataSourceResolved.set(true); - return mock(DataSource.class); - }; - } - } - - static class DataSourceResolverConfiguration { - - public static AtomicBoolean dataSourceResolved = new AtomicBoolean(false); - @Bean - public Function tenantDataSourceResolver() { - return tenant -> { - dataSourceResolved.set(true); - return mock(DataSource.class); - }; - } - } - static class DataSourcePropertiesResolverConfiguration { - - public static AtomicBoolean dataSourcePropertiesResolved = new AtomicBoolean(false); - @Bean - public Function tenantDataSourceResolver() { - return tenant -> { - dataSourcePropertiesResolved.set(true); - return mock(DataSourceProperties.class); - }; - } - } - -} \ No newline at end of file diff --git a/multitenancy-spring-boot-autoconfigure/src/test/java/org/axonframework/extensions/multitenancy/autoconfig/MultiTenantEventProcessorControlServiceTest.java b/multitenancy-spring-boot-autoconfigure/src/test/java/org/axonframework/extensions/multitenancy/autoconfig/MultiTenantEventProcessorControlServiceTest.java deleted file mode 100644 index 5847c21..0000000 --- a/multitenancy-spring-boot-autoconfigure/src/test/java/org/axonframework/extensions/multitenancy/autoconfig/MultiTenantEventProcessorControlServiceTest.java +++ /dev/null @@ -1,250 +0,0 @@ -/* - * Copyright (c) 2010-2023. Axon Framework - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -package org.axonframework.extensions.multitenancy.autoconfig; - -import com.google.common.collect.ImmutableMap; -import io.axoniq.axonserver.connector.AxonServerConnection; -import io.axoniq.axonserver.connector.admin.AdminChannel; -import io.axoniq.axonserver.connector.control.ControlChannel; -import io.axoniq.axonserver.grpc.admin.Admin; -import org.axonframework.axonserver.connector.AxonServerConfiguration; -import org.axonframework.axonserver.connector.AxonServerConnectionManager; -import org.axonframework.config.EventProcessingConfiguration; -import org.axonframework.eventhandling.EventProcessor; -import org.axonframework.eventhandling.tokenstore.TokenStore; -import org.axonframework.extensions.multitenancy.components.TenantDescriptor; -import org.axonframework.extensions.multitenancy.components.TenantEventProcessorControlSegmentFactory; -import org.axonframework.extensions.multitenancy.components.eventhandeling.MultiTenantEventProcessor; -import org.junit.jupiter.api.*; -import org.mockito.*; - -import java.util.HashMap; -import java.util.Map; -import java.util.Optional; -import java.util.concurrent.CompletableFuture; - -import static org.mockito.Mockito.*; - -/** - * Test class validating the {@link MultiTenantEventProcessorControlService}. - * - * @author Stefan Dragisic - */ -class MultiTenantEventProcessorControlServiceTest { - - private static final String PROCESSOR_NAME = "some-processor"; - private static final String TOKEN_STORE_IDENTIFIER = "token-store-identifier"; - private static final String LOAD_BALANCING_STRATEGY = "some-strategy"; - - private AxonServerConnectionManager axonServerConnectionManager; - private EventProcessingConfiguration eventProcessingConfiguration; - - private ControlChannel controlTenant1; - private ControlChannel controlAdmin; - - private AdminChannel adminAdmin; - private AdminChannel adminTenant1; - private ControlChannel controlTenant2; - private AdminChannel adminTenant2; - - private MultiTenantEventProcessorControlService testSubject; - - @BeforeEach - void setUp() { - axonServerConnectionManager = mock(AxonServerConnectionManager.class); - mockConnectionManager(); - - eventProcessingConfiguration = mock(EventProcessingConfiguration.class); - TokenStore tokenStore = mock(TokenStore.class); - when(tokenStore.retrieveStorageIdentifier()).thenReturn(Optional.of(TOKEN_STORE_IDENTIFIER)); - when(eventProcessingConfiguration.tokenStore(PROCESSOR_NAME)).thenReturn(tokenStore); - - AxonServerConfiguration axonServerConfig = mock(AxonServerConfiguration.class); - mockAxonServerConfig(axonServerConfig); - - TenantEventProcessorControlSegmentFactory tenantEventProcessorControlSegmentFactory = TenantDescriptor::tenantId; - - testSubject = new MultiTenantEventProcessorControlService(axonServerConnectionManager, - eventProcessingConfiguration, - axonServerConfig, - tenantEventProcessorControlSegmentFactory); - } - - private void mockConnectionManager() { - AxonServerConnection connectionAdmin = mock(AxonServerConnection.class); - controlAdmin = mock(ControlChannel.class); - adminAdmin = mock(AdminChannel.class); - when(connectionAdmin.controlChannel()).thenReturn(controlAdmin); - when(connectionAdmin.adminChannel()).thenReturn(adminAdmin); - when(adminAdmin.loadBalanceEventProcessor(any(), any(), any())) - .thenReturn(CompletableFuture.completedFuture(null)); - when(adminAdmin.setAutoLoadBalanceStrategy(any(), any(), any())) - .thenReturn(CompletableFuture.completedFuture(null)); - AxonServerConnection connectionTenant1 = mock(AxonServerConnection.class); - controlTenant1 = mock(ControlChannel.class); - when(connectionTenant1.controlChannel()).thenReturn(controlTenant1); - adminTenant1 = mock(AdminChannel.class); - when(adminTenant1.loadBalanceEventProcessor(any(), any(), any())) - .thenReturn(CompletableFuture.completedFuture(null)); - when(adminTenant1.setAutoLoadBalanceStrategy(any(), any(), any())) - .thenReturn(CompletableFuture.completedFuture(null)); - when(connectionTenant1.adminChannel()).thenReturn(adminTenant1); - AxonServerConnection connectionTenant2 = mock(AxonServerConnection.class); - controlTenant2 = mock(ControlChannel.class); - when(connectionTenant2.controlChannel()).thenReturn(controlTenant2); - adminTenant2 = mock(AdminChannel.class); - when(adminTenant2.loadBalanceEventProcessor(any(), any(), any())) - .thenReturn(CompletableFuture.completedFuture(null)); - when(adminTenant2.setAutoLoadBalanceStrategy(any(), any(), any())) - .thenReturn(CompletableFuture.completedFuture(null)); - when(connectionTenant2.adminChannel()).thenReturn(adminTenant2); - ArgumentCaptor contextCapture = ArgumentCaptor.forClass(String.class); - when(axonServerConnectionManager.getConnection(contextCapture.capture())) - .thenAnswer(a -> { - String capturedValue = contextCapture.getValue(); - if (capturedValue.equals("tenant-1") || capturedValue.equals("tenant-1-context")) { - return connectionTenant1; - } else if (capturedValue.equals("tenant-2")) { - return connectionTenant2; - } else if (capturedValue.equals("_admin")) { - return connectionAdmin; - } else { - throw new IllegalArgumentException("Unexpected value: " + capturedValue); - } - }); - } - - private static void mockAxonServerConfig(AxonServerConfiguration axonServerConfig) { - Map processorSettings = new HashMap<>(); - AxonServerConfiguration.Eventhandling eventHandling = mock(AxonServerConfiguration.Eventhandling.class); - AxonServerConfiguration.Eventhandling.ProcessorSettings tepSettings = - new AxonServerConfiguration.Eventhandling.ProcessorSettings(); - tepSettings.setLoadBalancingStrategy(LOAD_BALANCING_STRATEGY); - tepSettings.setAutomaticBalancing(true); - processorSettings.put(PROCESSOR_NAME, tepSettings); - when(eventHandling.getProcessors()).thenReturn(processorSettings); - when(axonServerConfig.getEventhandling()).thenReturn(eventHandling); - } - - @Test - void registersInstructionHandlersWithEachContextControlChannelOnStart() { - when(eventProcessingConfiguration.eventProcessors()).thenReturn(ImmutableMap.of( - PROCESSOR_NAME + "@tenant-1", mock(EventProcessor.class), - PROCESSOR_NAME + "@tenant-2", mock(EventProcessor.class), - "proxy-ep", mock(MultiTenantEventProcessor.class) - )); - - testSubject.start(); - - verify(controlTenant1).registerEventProcessor(eq(PROCESSOR_NAME + "@tenant-1"), any(), any()); - verify(controlTenant2).registerEventProcessor(eq(PROCESSOR_NAME + "@tenant-2"), any(), any()); - } - - @Test - void registersInstructionHandlersWithoutTenantOnStart() { - when(eventProcessingConfiguration.eventProcessors()).thenReturn(ImmutableMap.of( - PROCESSOR_NAME , mock(EventProcessor.class) - )); - - testSubject.start(); - - verify(controlAdmin).registerEventProcessor(eq(PROCESSOR_NAME), any(), any()); - } - - @Test - void addingNewTenantAfterStart() { - when(eventProcessingConfiguration.eventProcessors()).thenReturn(ImmutableMap.of( - PROCESSOR_NAME + "@tenant-1", mock(EventProcessor.class), - "proxy-ep", mock(MultiTenantEventProcessor.class) - )); - - testSubject.start(); - - verify(controlTenant1).registerEventProcessor(eq(PROCESSOR_NAME + "@tenant-1"), any(), any()); - verify(controlTenant2, times(0)).registerEventProcessor(eq(PROCESSOR_NAME + "@tenant-2"), any(), any()); - - when(eventProcessingConfiguration.eventProcessors()).thenReturn(ImmutableMap.of( - PROCESSOR_NAME + "@tenant-1", mock(EventProcessor.class), - PROCESSOR_NAME + "@tenant-2", mock(EventProcessor.class), - "proxy-ep", mock(MultiTenantEventProcessor.class) - )); - - testSubject.registerAndStartTenant(TenantDescriptor.tenantWithId("tenant-2")); - verify(controlTenant2).registerEventProcessor(eq(PROCESSOR_NAME + "@tenant-2"), any(), any()); - } - - @Test - void willSetLoadBalancingStrategyForProcessorsWithPropertiesOnStart() { - String processorNameWithoutSettings = "processor-without-load-balancing"; - String expectedStrategy = "some-strategy"; - - // Given - // Mock Event Processor Configuration - when(eventProcessingConfiguration.eventProcessors()).thenReturn(ImmutableMap.of( - PROCESSOR_NAME + "@tenant-1", mock(EventProcessor.class), - PROCESSOR_NAME + "@tenant-2", mock(EventProcessor.class), - processorNameWithoutSettings + "@tenant-1", mock(EventProcessor.class), - processorNameWithoutSettings + "@tenant-2", mock(EventProcessor.class), - "proxy-ep", mock(MultiTenantEventProcessor.class) - )); - - // When - testSubject.start(); - - // Then - // Registers instruction handlers - verify(controlTenant1).registerEventProcessor(eq(PROCESSOR_NAME + "@tenant-1"), any(), any()); - verify(controlTenant2).registerEventProcessor(eq(PROCESSOR_NAME + "@tenant-2"), any(), any()); - verify(controlTenant1).registerEventProcessor(eq(processorNameWithoutSettings + "@tenant-1"), any(), any()); - verify(controlTenant2).registerEventProcessor(eq(processorNameWithoutSettings + "@tenant-2"), any(), any()); - // Load balances Processors - verify(adminTenant1).loadBalanceEventProcessor(PROCESSOR_NAME, TOKEN_STORE_IDENTIFIER, expectedStrategy); - verify(adminTenant2).loadBalanceEventProcessor(PROCESSOR_NAME, TOKEN_STORE_IDENTIFIER, expectedStrategy); - verify(adminTenant1, never()).loadBalanceEventProcessor(eq(processorNameWithoutSettings), any(), any()); - verify(adminTenant2, never()).loadBalanceEventProcessor(eq(processorNameWithoutSettings), any(), any()); - // Enables automatic load balancing - verify(adminTenant1).setAutoLoadBalanceStrategy(PROCESSOR_NAME, TOKEN_STORE_IDENTIFIER, expectedStrategy); - verify(adminTenant2).setAutoLoadBalanceStrategy(PROCESSOR_NAME, TOKEN_STORE_IDENTIFIER, expectedStrategy); - verify(adminTenant1, never()).setAutoLoadBalanceStrategy(eq(processorNameWithoutSettings), any(), any()); - verify(adminTenant2, never()).setAutoLoadBalanceStrategy(eq(processorNameWithoutSettings), any(), any()); - } - - @Test - void testNonDefaultTenantEventProcessorControlSegmentFactory() { - AxonServerConfiguration axonServerConfig = mock(AxonServerConfiguration.class); - mockAxonServerConfig(axonServerConfig); - // Arrange - TenantEventProcessorControlSegmentFactory tenantEventProcessorControlSegmentFactory = tenantId -> tenantId.tenantId() + "-context"; - MultiTenantEventProcessorControlService testSubject = new MultiTenantEventProcessorControlService( - axonServerConnectionManager, - eventProcessingConfiguration, - axonServerConfig, - tenantEventProcessorControlSegmentFactory - ); - - when(eventProcessingConfiguration.eventProcessors()).thenReturn(ImmutableMap.of( - PROCESSOR_NAME + "@tenant-1", mock(EventProcessor.class) - )); - - // Act - testSubject.start(); - - // Assert - verify(axonServerConnectionManager).getConnection("tenant-1-context"); - verify(controlTenant1).registerEventProcessor(eq(PROCESSOR_NAME + "@tenant-1"), any(), any()); - } -} \ No newline at end of file diff --git a/multitenancy-spring-boot-autoconfigure/src/test/java/org/axonframework/extensions/multitenancy/autoconfig/MultiTenantPersistentStreamMessageSourceTest.java b/multitenancy-spring-boot-autoconfigure/src/test/java/org/axonframework/extensions/multitenancy/autoconfig/MultiTenantPersistentStreamMessageSourceTest.java deleted file mode 100644 index 93f724d..0000000 --- a/multitenancy-spring-boot-autoconfigure/src/test/java/org/axonframework/extensions/multitenancy/autoconfig/MultiTenantPersistentStreamMessageSourceTest.java +++ /dev/null @@ -1,150 +0,0 @@ -/* - * Copyright (c) 2010-2024. Axon Framework - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ -package org.axonframework.extensions.multitenancy.autoconfig; - -import io.axoniq.axonserver.connector.event.PersistentStreamProperties; -import org.axonframework.axonserver.connector.event.axon.PersistentStreamMessageSource; -import org.axonframework.config.Configuration; -import org.axonframework.extensions.multitenancy.components.TenantDescriptor; -import org.axonframework.common.Registration; -import org.junit.jupiter.api.BeforeEach; -import org.junit.jupiter.api.Test; -import org.mockito.Mock; -import org.mockito.MockitoAnnotations; - -import java.util.Map; -import java.util.concurrent.ScheduledExecutorService; - -import static org.junit.jupiter.api.Assertions.*; -import static org.mockito.Mockito.*; - -class MultiTenantPersistentStreamMessageSourceTest { - - @Mock - private Configuration configuration; - @Mock - private TenantPersistentStreamMessageSourceFactory factory; - @Mock - private PersistentStreamProperties persistentStreamProperties; - @Mock - private ScheduledExecutorService scheduler; - @Mock - private PersistentStreamMessageSource mockTenantSource; - - private MultiTenantPersistentStreamMessageSource source; - - @BeforeEach - void setUp() { - MockitoAnnotations.openMocks(this); - source = new MultiTenantPersistentStreamMessageSource( - "testName", - persistentStreamProperties, - scheduler, - 100, - "testContext", - configuration, - factory - ); - } - - @Test - void registerTenant() { - TenantDescriptor descriptor = new TenantDescriptor("testTenant"); - when(factory.build(anyString(), any(), any(), anyInt(), anyString(), any(), eq(descriptor))) - .thenReturn(mockTenantSource); - - Registration registration = source.registerTenant(descriptor); - - assertNotNull(registration); - verify(factory).build("testName", persistentStreamProperties, scheduler, 100, "testContext", configuration, descriptor); - - Map segments = source.tenantSegments(); - assertEquals(1, segments.size()); - assertTrue(segments.containsKey(descriptor)); - assertEquals(mockTenantSource, segments.get(descriptor)); - } - - @Test - void registerAndStartTenant() { - TenantDescriptor descriptor = new TenantDescriptor("testTenant"); - when(factory.build(anyString(), any(), any(), anyInt(), anyString(), any(), eq(descriptor))) - .thenReturn(mockTenantSource); - - Registration registration = source.registerAndStartTenant(descriptor); - - assertNotNull(registration); - verify(factory).build("testName", persistentStreamProperties, scheduler, 100, "testContext", configuration, descriptor); - - Map segments = source.tenantSegments(); - assertEquals(1, segments.size()); - assertTrue(segments.containsKey(descriptor)); - assertEquals(mockTenantSource, segments.get(descriptor)); - } - - @Test - void unregisterTenant() { - TenantDescriptor descriptor = new TenantDescriptor("testTenant"); - when(factory.build(anyString(), any(), any(), anyInt(), anyString(), any(), eq(descriptor))) - .thenReturn(mockTenantSource); - - Registration registration = source.registerTenant(descriptor); - assertTrue(registration.cancel()); - - Map segments = source.tenantSegments(); - assertTrue(segments.isEmpty()); - } - - @Test - void registerMultipleTenants() { - TenantDescriptor descriptor1 = new TenantDescriptor("tenant1"); - TenantDescriptor descriptor2 = new TenantDescriptor("tenant2"); - - when(factory.build(anyString(), any(), any(), anyInt(), anyString(), any(), eq(descriptor1))) - .thenReturn(mockTenantSource); - when(factory.build(anyString(), any(), any(), anyInt(), anyString(), any(), eq(descriptor2))) - .thenReturn(mockTenantSource); - - source.registerTenant(descriptor1); - source.registerTenant(descriptor2); - - Map segments = source.tenantSegments(); - assertEquals(2, segments.size()); - assertTrue(segments.containsKey(descriptor1)); - assertTrue(segments.containsKey(descriptor2)); - } - - @Test - void tenantPersistentStreamMessageSourceFactory() { - TenantPersistentStreamMessageSourceFactory testFactory = - (name, props, sched, batch, ctx, config, tenant) -> { - assertEquals("testName", name); - assertEquals(persistentStreamProperties, props); - assertEquals(scheduler, sched); - assertEquals(100, batch); - assertEquals("testContext", ctx); - assertEquals(configuration, config); - assertEquals(new TenantDescriptor("testTenant"), tenant); - return mockTenantSource; - }; - - PersistentStreamMessageSource result = testFactory.build( - "testName", persistentStreamProperties, scheduler, 100, "testContext", - configuration, new TenantDescriptor("testTenant") - ); - - assertEquals(mockTenantSource, result); - } -} \ No newline at end of file diff --git a/multitenancy-spring-boot-starter/pom.xml b/multitenancy-spring-boot-starter/pom.xml index 8b907ae..ea232cf 100644 --- a/multitenancy-spring-boot-starter/pom.xml +++ b/multitenancy-spring-boot-starter/pom.xml @@ -17,151 +17,44 @@ 4.0.0 - org.springframework.boot - spring-boot-starters - 2.2.13.RELEASE - + org.axonframework.extensions.multitenancy + axon-multitenancy-parent + 5.1.0-SNAPSHOT - org.axonframework.extensions.multitenancy axon-multitenancy-spring-boot-starter - 4.12.1-SNAPSHOT - Spring Boot Starter module for Axon Framework Multi-Tenancy Extension - Spring Boot Starter module for the Multi-Tenancy Extension of Axon Framework - - - AxonIQ B.V. - https://axoniq.io - - - - - Apache 2.0 - https://www.apache.org/licenses/LICENSE-2.0 - - - - GitHub - https://github.com/AxonFramework/extension-multitenancy/issues - - - - 0.8.0 - 3.5.0 - 3.14.0 - 3.1.1 - 3.2.8 - 3.1.4 - 3.11.2 - 3.3.1 - + Axon Framework Multi-Tenancy Extension - Spring Boot Starter + + Spring Boot Starter module for the Multi-Tenancy Extension of Axon Framework. + Add this dependency to get started with multi-tenancy in Spring Boot applications. + + org.axonframework.extensions.multitenancy axon-multitenancy-spring-boot-autoconfigure ${project.version} + + + org.axonframework.extensions.multitenancy + axon-multitenancy + ${project.version} + + + + org.axonframework.extensions.multitenancy + axon-multitenancy-spring + ${project.version} + + + + org.axonframework.extensions.multitenancy + axon-multitenancy-axon-server-connector + ${project.version} + true + - - - - - - maven-clean-plugin - ${maven-clean.version} - - - maven-install-plugin - ${maven-install.version} - - - - - - - - maven-compiler-plugin - ${maven-compiler.version} - - 1.8 - 1.8 - UTF-8 - - - - - maven-javadoc-plugin - ${maven-javadoc.version} - - - attach-javadoc - deploy - - jar - - - - - none - - - - - org.sonatype.central - central-publishing-maven-plugin - ${central-publishing-maven-plugin.version} - true - - central - - - - maven-resources-plugin - ${maven-resources.version} - - UTF-8 - - - - - - - - sign - - - performRelease - true - - - - - - org.apache.maven.plugins - maven-gpg-plugin - ${maven-gpg.version} - - - sign-artifacts - verify - - - sign - - - - - - - - - - - scm:git:git://github.com/AxonFramework/extension-multitenancy.git - scm:git:git@github.com:AxonFramework/extension-multitenancy.git - https://github.com/AxonFramework/extension-multitenancy - HEAD - - \ No newline at end of file + diff --git a/multitenancy-spring/pom.xml b/multitenancy-spring/pom.xml new file mode 100644 index 0000000..d130fcb --- /dev/null +++ b/multitenancy-spring/pom.xml @@ -0,0 +1,108 @@ + + + + 4.0.0 + + org.axonframework.extensions.multitenancy + axon-multitenancy-parent + 5.1.0-SNAPSHOT + + + axon-multitenancy-spring + + Axon Framework Multi-Tenancy Extension - Spring + + Spring Framework integration for the Multi-Tenancy Extension. + Provides Spring-specific implementations and factories for multi-tenant applications. + + + jar + + + + + org.axonframework.extensions.multitenancy + axon-multitenancy + ${project.version} + + + + org.axonframework + axon-messaging + provided + + + + org.axonframework.extensions.spring + axon-spring + true + + + + org.springframework + spring-context + ${spring.version} + provided + + + + jakarta.persistence + jakarta.persistence-api + true + + + + org.springframework.data + spring-data-jpa + true + + + + io.r2dbc + r2dbc-spi + 1.0.0.RELEASE + true + + + + com.google.code.findbugs + jsr305 + + + jakarta.annotation + jakarta.annotation-api + + + org.slf4j + slf4j-api + ${slf4j.version} + + + + org.junit.jupiter + junit-jupiter-api + ${junit.jupiter.version} + test + + + org.mockito + mockito-core + ${mockito.version} + test + + + diff --git a/multitenancy-spring/src/main/java/org/axonframework/extension/multitenancy/spring/TenantComponent.java b/multitenancy-spring/src/main/java/org/axonframework/extension/multitenancy/spring/TenantComponent.java new file mode 100644 index 0000000..d94e205 --- /dev/null +++ b/multitenancy-spring/src/main/java/org/axonframework/extension/multitenancy/spring/TenantComponent.java @@ -0,0 +1,122 @@ +/* + * Copyright (c) 2010-2025. Axon Framework + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.axonframework.extension.multitenancy.spring; + +import org.axonframework.extension.multitenancy.core.TenantDescriptor; +import org.slf4j.LoggerFactory; + +/** + * Interface for defining tenant-scoped components that can be automatically discovered + * and registered by Spring auto-configuration. + *

    + * Classes implementing this interface will be: + *

      + *
    • Automatically discovered via classpath scanning
      • + *
    • Instantiated with Spring dependency injection (but NOT registered as Spring beans)
      • + *
    • Registered as tenant components for injection into message handlers
      • + *
    + *

    + * The implementing class acts as a factory that creates tenant-specific instances. + * Spring will inject dependencies into the factory instance, which can then pass + * those dependencies to the tenant-specific instances it creates. + *

    + * Important: Classes implementing this interface should NOT be annotated + * with {@code @Component} or any other Spring stereotype annotation. They will receive + * Spring dependency injection through {@code AutowireCapableBeanFactory.createBean()}, + * but will not be registered in the Spring application context. This ensures that + * the component type cannot be accidentally autowired outside of message handlers. + *

    + * Example usage: + * 

    {@code
+ * // Note: No @Component annotation!
+ * public class TenantAwareOrderService implements TenantComponent {
+ *     private final EmailService emailService; // Spring dependency
+ *     private final String tenantId;
+ *
+ *     // Constructor for factory instance - Spring injects EmailService
+ *     public TenantAwareOrderService(EmailService emailService) {
+ *         this.emailService = emailService;
+ *         this.tenantId = null;
+ *     }
+ *
+ *     // Private constructor for tenant-specific instances
+ *     private TenantAwareOrderService(EmailService emailService, String tenantId) {
+ *         this.emailService = emailService;
+ *         this.tenantId = tenantId;
+ *     }
+ *
+ *     @Override
+ *     public TenantAwareOrderService createForTenant(TenantDescriptor tenant) {
+ *         return new TenantAwareOrderService(emailService, tenant.tenantId());
+ *     }
+ *
+ *     public void processOrder(Order order) {
+ *         // Business logic using tenantId and emailService
+ *     }
+ * }
+ *
+ * // In a message handler - automatically receives tenant-specific instance:
+ * @EventHandler
+ * public void handle(OrderPlaced event, TenantAwareOrderService orderService) {
+ *     orderService.processOrder(event.getOrder());
+ * }
+ * }
    + * + * @param the type of component this factory creates, typically the implementing class itself + * @author Theo Emanuelsson + * @since 5.0.0 + * @see org.axonframework.extension.multitenancy.core.TenantDescriptor + * @see org.axonframework.extension.multitenancy.core.TenantComponentFactory + */ +public interface TenantComponent { + + /** + * Creates a component instance configured for the specified tenant. + *

    + * This method is called lazily when a tenant-specific instance is first needed. + * The returned instance will be cached per-tenant, so subsequent requests for + * the same tenant will return the same instance. + *

    + * Implementations should create a new instance configured with the tenant's context, + * typically by passing the tenant information and any dependencies held by the + * factory instance. + * + * @param tenant the tenant descriptor identifying the tenant + * @return a new component instance configured for the specified tenant + */ + T createForTenant(TenantDescriptor tenant); + + /** + * Called when a tenant is unregistered to perform cleanup of tenant-specific resources. + *

    + * The default implementation handles {@link AutoCloseable} components by calling + * {@link AutoCloseable#close()}. Override this method to provide custom cleanup logic. + * + * @param tenant the tenant descriptor identifying the tenant being removed + * @param component the component instance to clean up + */ + default void cleanupForTenant(TenantDescriptor tenant, T component) { + if (component instanceof AutoCloseable autoCloseable) { + try { + autoCloseable.close(); + } catch (Exception e) { + LoggerFactory.getLogger(TenantComponent.class) + .warn("Error closing AutoCloseable component for tenant [{}]: {}", + tenant.tenantId(), e.getMessage(), e); + } + } + } +} diff --git a/multitenancy-spring/src/main/java/org/axonframework/extension/multitenancy/spring/data/jpa/TenantDataSourceProvider.java b/multitenancy-spring/src/main/java/org/axonframework/extension/multitenancy/spring/data/jpa/TenantDataSourceProvider.java new file mode 100644 index 0000000..c8720d2 --- /dev/null +++ b/multitenancy-spring/src/main/java/org/axonframework/extension/multitenancy/spring/data/jpa/TenantDataSourceProvider.java @@ -0,0 +1,65 @@ +/* + * Copyright (c) 2010-2025. Axon Framework + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.axonframework.extension.multitenancy.spring.data.jpa; + +import org.axonframework.extension.multitenancy.core.TenantDescriptor; + +import javax.sql.DataSource; +import java.util.function.Function; + +/** + * Provider interface for obtaining tenant-specific {@link DataSource} instances. + *

    + * Implementations of this interface are responsible for returning a {@link DataSource} + * configured for a specific tenant. This is typically used in database-per-tenant + * or schema-per-tenant multi-tenancy architectures. + *

    + * Example implementations might: + *

      + *
    • Return a pre-configured DataSource from a map of tenant databases
      • + *
    • Dynamically create DataSources using tenant-specific connection strings
      • + *
    • Return a routing DataSource that switches schemas based on tenant
      • + *
    + *

    + * Example usage: + * 

    {@code
+ * TenantDataSourceProvider provider = tenant -> {
+ *     String tenantId = tenant.tenantId();
+ *     return DataSourceBuilder.create()
+ *         .url("jdbc:postgresql://localhost:5432/" + tenantId)
+ *         .username("app_user")
+ *         .password("secret")
+ *         .build();
+ * };
+ * }
    + * + * @author Theo Emanuelsson + * @since 5.0.0 + * @see TenantEntityManagerFactoryBuilder + */ +@FunctionalInterface +public interface TenantDataSourceProvider extends Function { + + /** + * Returns a {@link DataSource} configured for the specified tenant. + * + * @param tenant the tenant descriptor identifying the tenant + * @return a DataSource for the tenant's database + * @throws IllegalArgumentException if the tenant is unknown or invalid + */ + @Override + DataSource apply(TenantDescriptor tenant); +} diff --git a/multitenancy-spring/src/main/java/org/axonframework/extension/multitenancy/spring/data/jpa/TenantEntityManagerFactoryBuilder.java b/multitenancy-spring/src/main/java/org/axonframework/extension/multitenancy/spring/data/jpa/TenantEntityManagerFactoryBuilder.java new file mode 100644 index 0000000..c696076 --- /dev/null +++ b/multitenancy-spring/src/main/java/org/axonframework/extension/multitenancy/spring/data/jpa/TenantEntityManagerFactoryBuilder.java @@ -0,0 +1,203 @@ +/* + * Copyright (c) 2010-2025. Axon Framework + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.axonframework.extension.multitenancy.spring.data.jpa; + +import jakarta.annotation.Nonnull; +import jakarta.persistence.EntityManagerFactory; +import org.axonframework.extension.multitenancy.core.TenantDescriptor; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; +import org.springframework.orm.jpa.LocalContainerEntityManagerFactoryBean; +import org.springframework.orm.jpa.vendor.HibernateJpaVendorAdapter; + +import javax.sql.DataSource; +import java.util.HashMap; +import java.util.Map; +import java.util.Objects; +import java.util.concurrent.ConcurrentHashMap; +import java.util.function.Function; + +/** + * Builder for creating tenant-specific {@link EntityManagerFactory} instances. + *

    + * This class provides a fluent API for configuring how EntityManagerFactory instances + * are created for each tenant. It caches created instances to ensure that the same + * tenant always receives the same EntityManagerFactory. + *

    + * The builder requires a {@link TenantDataSourceProvider} to obtain tenant-specific + * DataSources, and optionally accepts configuration for: + *

      + *
    • Packages to scan for JPA entities
      • + *
    • JPA properties (e.g., Hibernate settings)
      • + *
    • Persistence unit name
      • + *
    + *

    + * Example usage: + * 

    {@code
+ * TenantEntityManagerFactoryBuilder builder = TenantEntityManagerFactoryBuilder
+ *     .forDataSourceProvider(tenantDataSourceProvider)
+ *     .packagesToScan("com.example.domain")
+ *     .jpaProperty("hibernate.hbm2ddl.auto", "validate")
+ *     .build();
+ *
+ * // Register with multi-tenancy configurer
+ * multiTenancyConfigurer.tenantComponent(EntityManagerFactory.class, builder);
+ * }
    + * + * @author Theo Emanuelsson + * @since 5.0.0 + * @see TenantDataSourceProvider + */ +public class TenantEntityManagerFactoryBuilder implements Function { + + private static final Logger logger = LoggerFactory.getLogger(TenantEntityManagerFactoryBuilder.class); + + private final TenantDataSourceProvider dataSourceProvider; + private final String[] packagesToScan; + private final Map jpaProperties; + private final String persistenceUnitName; + private final Map emfCache = new ConcurrentHashMap<>(); + + private TenantEntityManagerFactoryBuilder(Builder builder) { + this.dataSourceProvider = builder.dataSourceProvider; + this.packagesToScan = builder.packagesToScan; + this.jpaProperties = new HashMap<>(builder.jpaProperties); + this.persistenceUnitName = builder.persistenceUnitName; + } + + /** + * Creates a new builder with the specified {@link TenantDataSourceProvider}. + * + * @param dataSourceProvider the provider for tenant-specific DataSources + * @return a new builder instance + */ + public static Builder forDataSourceProvider(@Nonnull TenantDataSourceProvider dataSourceProvider) { + return new Builder(dataSourceProvider); + } + + /** + * Returns the {@link EntityManagerFactory} for the specified tenant, creating it if necessary. + *

    + * Created EntityManagerFactory instances are cached to ensure that the same tenant + * always receives the same instance. + * + * @param tenant the tenant descriptor + * @return the EntityManagerFactory for the tenant + */ + @Override + public EntityManagerFactory apply(TenantDescriptor tenant) { + return emfCache.computeIfAbsent(tenant, this::createEntityManagerFactory); + } + + /** + * Returns the number of cached EntityManagerFactory instances. + * + * @return the cache size + */ + public int cacheSize() { + return emfCache.size(); + } + + private EntityManagerFactory createEntityManagerFactory(TenantDescriptor tenant) { + DataSource dataSource = dataSourceProvider.apply(tenant); + + try { + logger.debug("Creating EMF for tenant {} with datasource {}", tenant.tenantId(), dataSource.getConnection().getMetaData().getURL()); + } catch (Exception e) { + logger.debug("Creating EMF for tenant {} with datasource {}", tenant.tenantId(), dataSource); + } + + LocalContainerEntityManagerFactoryBean factoryBean = new LocalContainerEntityManagerFactoryBean(); + factoryBean.setDataSource(dataSource); + factoryBean.setPackagesToScan(packagesToScan); + factoryBean.setJpaVendorAdapter(new HibernateJpaVendorAdapter()); + factoryBean.setPersistenceUnitName(persistenceUnitName + "-" + tenant.tenantId()); + factoryBean.setJpaPropertyMap(jpaProperties); + factoryBean.afterPropertiesSet(); + + return factoryBean.getObject(); + } + + /** + * Builder for {@link TenantEntityManagerFactoryBuilder}. + */ + public static class Builder { + + private final TenantDataSourceProvider dataSourceProvider; + private String[] packagesToScan = new String[0]; + private final Map jpaProperties = new HashMap<>(); + private String persistenceUnitName = "tenant"; + + private Builder(TenantDataSourceProvider dataSourceProvider) { + this.dataSourceProvider = Objects.requireNonNull(dataSourceProvider, + "TenantDataSourceProvider may not be null"); + } + + /** + * Sets the packages to scan for JPA entity classes. + * + * @param packages the packages to scan + * @return this builder + */ + public Builder packagesToScan(String... packages) { + this.packagesToScan = packages; + return this; + } + + /** + * Adds a JPA property to be used when creating EntityManagerFactory instances. + * + * @param key the property key + * @param value the property value + * @return this builder + */ + public Builder jpaProperty(String key, Object value) { + this.jpaProperties.put(key, value); + return this; + } + + /** + * Adds multiple JPA properties to be used when creating EntityManagerFactory instances. + * + * @param properties the properties to add + * @return this builder + */ + public Builder jpaProperties(Map properties) { + this.jpaProperties.putAll(properties); + return this; + } + + /** + * Sets the base persistence unit name. The tenant ID will be appended to this name. + * + * @param persistenceUnitName the base persistence unit name + * @return this builder + */ + public Builder persistenceUnitName(String persistenceUnitName) { + this.persistenceUnitName = persistenceUnitName; + return this; + } + + /** + * Builds the {@link TenantEntityManagerFactoryBuilder}. + * + * @return a new TenantEntityManagerFactoryBuilder instance + */ + public TenantEntityManagerFactoryBuilder build() { + return new TenantEntityManagerFactoryBuilder(this); + } + } +} diff --git a/multitenancy-spring/src/main/java/org/axonframework/extension/multitenancy/spring/data/jpa/TenantJpaRepositoryFactory.java b/multitenancy-spring/src/main/java/org/axonframework/extension/multitenancy/spring/data/jpa/TenantJpaRepositoryFactory.java new file mode 100644 index 0000000..0e77ccc --- /dev/null +++ b/multitenancy-spring/src/main/java/org/axonframework/extension/multitenancy/spring/data/jpa/TenantJpaRepositoryFactory.java @@ -0,0 +1,181 @@ +/* + * Copyright (c) 2010-2025. Axon Framework + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.axonframework.extension.multitenancy.spring.data.jpa; + +import jakarta.annotation.Nonnull; +import jakarta.persistence.EntityManager; +import jakarta.persistence.EntityManagerFactory; +import org.axonframework.extension.multitenancy.core.TenantComponentFactory; +import org.axonframework.extension.multitenancy.core.TenantDescriptor; +import org.axonframework.messaging.core.unitofwork.transaction.TransactionManager; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; +import org.springframework.data.jpa.repository.support.JpaRepositoryFactory; +import org.springframework.orm.jpa.SharedEntityManagerCreator; + +import java.lang.reflect.InvocationHandler; +import java.lang.reflect.Method; +import java.lang.reflect.Proxy; +import java.util.Map; +import java.util.concurrent.ConcurrentHashMap; + +/** + * Factory for creating tenant-scoped Spring Data JPA repository instances. + *

    + * This factory creates repository instances connected to tenant-specific + * {@link EntityManagerFactory} instances, ensuring that each tenant's data + * is isolated in its own database. + *

    + * Each tenant's repository operations are wrapped in transactions managed by + * the tenant-specific {@link TransactionManager}. This follows the same pattern + * as Axon's {@code JpaEventStorageEngine} which manages its own transactions. + *

    + * Repositories are cached per-tenant for efficiency. + * + * @param the repository interface type + * @author Theo Emanuelsson + * @since 5.0.0 + * @see TenantEntityManagerFactoryBuilder + * @see TenantTransactionManagerBuilder + */ +public class TenantJpaRepositoryFactory implements TenantComponentFactory { + + private static final Logger logger = LoggerFactory.getLogger(TenantJpaRepositoryFactory.class); + + private final Class repositoryType; + private final TenantEntityManagerFactoryBuilder emfBuilder; + private final TenantTransactionManagerBuilder txBuilder; + private final Map cache = new ConcurrentHashMap<>(); + + /** + * Creates a new factory for the specified repository type. + * + * @param repositoryType the repository interface class + * @param emfBuilder the tenant EntityManagerFactory builder + * @param txBuilder the tenant TransactionManager builder + */ + public TenantJpaRepositoryFactory(@Nonnull Class repositoryType, + @Nonnull TenantEntityManagerFactoryBuilder emfBuilder, + @Nonnull TenantTransactionManagerBuilder txBuilder) { + this.repositoryType = repositoryType; + this.emfBuilder = emfBuilder; + this.txBuilder = txBuilder; + } + + /** + * Creates a factory for the specified repository type. + * + * @param repositoryType the repository interface class + * @param emfBuilder the tenant EntityManagerFactory builder + * @param txBuilder the tenant TransactionManager builder + * @param the repository type + * @return a new factory instance + */ + public static TenantJpaRepositoryFactory forRepository( + @Nonnull Class repositoryType, + @Nonnull TenantEntityManagerFactoryBuilder emfBuilder, + @Nonnull TenantTransactionManagerBuilder txBuilder) { + return new TenantJpaRepositoryFactory<>(repositoryType, emfBuilder, txBuilder); + } + + @Override + public T apply(TenantDescriptor tenant) { + return cache.computeIfAbsent(tenant, this::createRepository); + } + + @SuppressWarnings("unchecked") + private T createRepository(TenantDescriptor tenant) { + logger.debug("Creating repository {} for tenant {}", repositoryType.getName(), tenant.tenantId()); + EntityManagerFactory emf = emfBuilder.apply(tenant); + TransactionManager txManager = txBuilder.apply(tenant); + + logger.debug("Using EMF {} for tenant {}", emf, tenant.tenantId()); + + // Create a shared EntityManager proxy that participates in Spring transactions. + // Each tenant has its own EMF (and database), so data remains isolated. + EntityManager sharedEntityManager = SharedEntityManagerCreator.createSharedEntityManager(emf); + JpaRepositoryFactory factory = new JpaRepositoryFactory(sharedEntityManager); + T repository = factory.getRepository(repositoryType); + + logger.debug("Created repository {} for tenant {} with EMF hash {}", + repositoryType.getSimpleName(), tenant.tenantId(), System.identityHashCode(emf)); + + // Wrap the repository in a transactional proxy that manages transactions + // using the tenant's TransactionManager. This follows the same pattern as + // JpaEventStorageEngine which manages its own transactions. + return (T) Proxy.newProxyInstance( + repositoryType.getClassLoader(), + new Class[]{repositoryType}, + new TransactionalRepositoryInvocationHandler<>(repository, txManager, tenant.tenantId()) + ); + } + + /** + * Returns the repository type this factory creates. + * + * @return the repository interface class + */ + public Class getRepositoryType() { + return repositoryType; + } + + /** + * Invocation handler that wraps repository method calls in transactions. + *

    + * This follows the same pattern as Axon's {@code JpaEventStorageEngine} + * which explicitly manages transactions for JPA operations. + */ + private static class TransactionalRepositoryInvocationHandler implements InvocationHandler { + + private final T delegate; + private final TransactionManager transactionManager; + private final String tenantId; + + TransactionalRepositoryInvocationHandler(T delegate, TransactionManager transactionManager, String tenantId) { + this.delegate = delegate; + this.transactionManager = transactionManager; + this.tenantId = tenantId; + } + + @Override + public Object invoke(Object proxy, Method method, Object[] args) throws Throwable { + // Handle Object methods directly + if (method.getDeclaringClass() == Object.class) { + return method.invoke(delegate, args); + } + + logger.debug("Invoking {}.{} for tenant {} with transaction manager {}", + delegate.getClass().getSimpleName(), method.getName(), tenantId, transactionManager); + + // Wrap repository operations in a transaction + var tx = transactionManager.startTransaction(); + try { + Object result = method.invoke(delegate, args); + tx.commit(); + logger.debug("Transaction committed for tenant {}", tenantId); + return result; + } catch (Throwable t) { + tx.rollback(); + logger.debug("Transaction rolled back for tenant {}", tenantId, t); + // Unwrap InvocationTargetException + if (t instanceof java.lang.reflect.InvocationTargetException) { + throw t.getCause(); + } + throw t; + } + } + } +} diff --git a/multitenancy-spring/src/main/java/org/axonframework/extension/multitenancy/spring/data/jpa/TenantRepositoryFactory.java b/multitenancy-spring/src/main/java/org/axonframework/extension/multitenancy/spring/data/jpa/TenantRepositoryFactory.java new file mode 100644 index 0000000..946a659 --- /dev/null +++ b/multitenancy-spring/src/main/java/org/axonframework/extension/multitenancy/spring/data/jpa/TenantRepositoryFactory.java @@ -0,0 +1,126 @@ +/* + * Copyright (c) 2010-2025. Axon Framework + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.axonframework.extension.multitenancy.spring.data.jpa; + +import jakarta.annotation.Nonnull; +import jakarta.persistence.EntityManager; +import jakarta.persistence.EntityManagerFactory; +import org.axonframework.extension.multitenancy.core.TenantDescriptor; +import org.springframework.data.jpa.repository.support.JpaRepositoryFactory; +import org.springframework.data.repository.Repository; + +import java.util.Objects; +import java.util.concurrent.ConcurrentHashMap; +import java.util.function.Function; + +/** + * Factory for creating tenant-scoped Spring Data JPA repository instances. + *

    + * This class creates repository instances bound to tenant-specific {@link EntityManagerFactory} + * instances. Each tenant gets its own repository instance that operates on its own database. + *

    + * Repository instances are cached per tenant to ensure that the same tenant always receives + * the same repository instance. + *

    + * Example usage with {@code MultiTenancyConfigurer}: + * 

    {@code
+ * // Create EMF builder
+ * TenantEntityManagerFactoryBuilder emfBuilder = TenantEntityManagerFactoryBuilder
+ *     .forDataSourceProvider(tenantDataSourceProvider)
+ *     .packagesToScan("com.example.domain")
+ *     .build();
+ *
+ * // Create repository factory
+ * TenantRepositoryFactory repoFactory =
+ *     TenantRepositoryFactory.forRepository(CustomerRepository.class, emfBuilder);
+ *
+ * // Register with multi-tenancy configurer
+ * multiTenancyConfigurer.tenantComponent(CustomerRepository.class, repoFactory);
+ * }
    + * + * @param the repository interface type + * @author Theo Emanuelsson + * @since 5.0.0 + * @see TenantEntityManagerFactoryBuilder + * @see TenantDataSourceProvider + */ +public class TenantRepositoryFactory> implements Function { + + private final Class repositoryInterface; + private final Function emfProvider; + private final ConcurrentHashMap repositoryCache = new ConcurrentHashMap<>(); + + private TenantRepositoryFactory(Class repositoryInterface, + Function emfProvider) { + this.repositoryInterface = Objects.requireNonNull(repositoryInterface, + "Repository interface may not be null"); + this.emfProvider = Objects.requireNonNull(emfProvider, + "EntityManagerFactory provider may not be null"); + } + + /** + * Creates a new factory for the specified repository interface. + * + * @param repositoryInterface the Spring Data repository interface + * @param emfProvider provider function for tenant-specific EntityManagerFactories + * @param the repository interface type + * @return a new TenantRepositoryFactory + */ + public static > TenantRepositoryFactory forRepository( + @Nonnull Class repositoryInterface, + @Nonnull Function emfProvider) { + return new TenantRepositoryFactory<>(repositoryInterface, emfProvider); + } + + /** + * Returns the repository instance for the specified tenant, creating it if necessary. + *

    + * Created repository instances are cached to ensure that the same tenant always + * receives the same instance. + * + * @param tenant the tenant descriptor + * @return the repository instance for the tenant + */ + @Override + public T apply(TenantDescriptor tenant) { + return repositoryCache.computeIfAbsent(tenant, this::createRepository); + } + + /** + * Returns the number of cached repository instances. + * + * @return the cache size + */ + public int cacheSize() { + return repositoryCache.size(); + } + + /** + * Returns the repository interface this factory creates instances for. + * + * @return the repository interface class + */ + public Class getRepositoryInterface() { + return repositoryInterface; + } + + private T createRepository(TenantDescriptor tenant) { + EntityManagerFactory emf = emfProvider.apply(tenant); + EntityManager entityManager = emf.createEntityManager(); + JpaRepositoryFactory factory = new JpaRepositoryFactory(entityManager); + return factory.getRepository(repositoryInterface); + } +} diff --git a/multitenancy-spring/src/main/java/org/axonframework/extension/multitenancy/spring/data/jpa/TenantRepositoryParameterResolverFactory.java b/multitenancy-spring/src/main/java/org/axonframework/extension/multitenancy/spring/data/jpa/TenantRepositoryParameterResolverFactory.java new file mode 100644 index 0000000..143445a --- /dev/null +++ b/multitenancy-spring/src/main/java/org/axonframework/extension/multitenancy/spring/data/jpa/TenantRepositoryParameterResolverFactory.java @@ -0,0 +1,171 @@ +/* + * Copyright (c) 2010-2025. Axon Framework + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.axonframework.extension.multitenancy.spring.data.jpa; + +import jakarta.annotation.Nonnull; +import jakarta.persistence.EntityManagerFactory; +import org.axonframework.common.Priority; +import org.axonframework.extension.multitenancy.core.TargetTenantResolver; +import org.axonframework.extension.multitenancy.core.TenantDescriptor; +import org.axonframework.messaging.core.Message; +import org.axonframework.messaging.core.annotation.ParameterResolver; +import org.axonframework.messaging.core.annotation.ParameterResolverFactory; +import org.axonframework.messaging.core.unitofwork.ProcessingContext; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; +import org.springframework.data.jpa.repository.support.JpaRepositoryFactory; +import org.springframework.data.repository.Repository; + +import java.lang.reflect.Executable; +import java.lang.reflect.Parameter; +import java.util.Collections; +import java.util.Map; +import java.util.Objects; +import java.util.Set; +import java.util.concurrent.CompletableFuture; +import java.util.concurrent.ConcurrentHashMap; +import java.util.function.Function; + +/** + * A {@link ParameterResolverFactory} that resolves Spring Data JPA repository parameters + * as tenant-scoped instances. + *

    + * When a message handler declares a Spring Data {@link Repository} as a parameter, this factory + * automatically provides a tenant-specific instance based on the message's tenant metadata. + * Each tenant gets its own repository instance backed by a tenant-specific {@link EntityManagerFactory}. + *

    + * This factory is automatically registered when {@link TenantDataSourceProvider} is configured + * and Spring Data JPA is on the classpath. + *

    + * Example usage in a handler: + * 

    {@code
+ * @EventHandler
+ * void on(OrderCreatedEvent event, OrderRepository repository) {
+ *     // repository is automatically scoped to the event's tenant
+ *     repository.save(new OrderProjection(event));
+ * }
+ * }
    + * + * @author Theo Emanuelsson + * @since 5.0.0 + * @see TenantDataSourceProvider + * @see TenantEntityManagerFactoryBuilder + */ +@Priority(Priority.HIGH) +public class TenantRepositoryParameterResolverFactory implements ParameterResolverFactory { + + private static final Logger logger = LoggerFactory.getLogger(TenantRepositoryParameterResolverFactory.class); + + private final TargetTenantResolver tenantResolver; + private final Function emfProvider; + private final Set> repositoryTypes; + + // Cache: repositoryType -> (tenant -> repository instance) + private final Map, Map> repositoryCache = new ConcurrentHashMap<>(); + + /** + * Creates a new factory for resolving tenant-scoped Spring Data repositories. + * + * @param tenantResolver resolver for extracting tenant from messages + * @param emfProvider provider for tenant-specific EntityManagerFactories + * @param repositoryTypes the repository interface types to resolve + */ + public TenantRepositoryParameterResolverFactory( + @Nonnull TargetTenantResolver tenantResolver, + @Nonnull Function emfProvider, + @Nonnull Set> repositoryTypes) { + this.tenantResolver = Objects.requireNonNull(tenantResolver, "Tenant resolver may not be null"); + this.emfProvider = Objects.requireNonNull(emfProvider, "EMF provider may not be null"); + this.repositoryTypes = Objects.requireNonNull(repositoryTypes, "Repository types may not be null"); + + logger.debug("Initialized TenantRepositoryParameterResolverFactory for {} repository types", + repositoryTypes.size()); + } + + @Override + public ParameterResolver createInstance(Executable executable, Parameter[] parameters, int parameterIndex) { + Parameter parameter = parameters[parameterIndex]; + Class parameterType = parameter.getType(); + + // Check if this parameter is a repository we handle + if (Repository.class.isAssignableFrom(parameterType) && repositoryTypes.contains(parameterType)) { + logger.debug("Creating tenant-scoped resolver for repository parameter: {}", parameterType.getName()); + return new TenantRepositoryParameterResolver(parameterType); + } + + return null; + } + + /** + * Parameter resolver that provides tenant-scoped repository instances. + */ + private class TenantRepositoryParameterResolver implements ParameterResolver { + + private final Class repositoryType; + + TenantRepositoryParameterResolver(Class repositoryType) { + this.repositoryType = repositoryType; + } + + @Nonnull + @Override + public CompletableFuture resolveParameterValue(@Nonnull ProcessingContext context) { + Message message = Message.fromContext(context); + if (message == null) { + return CompletableFuture.failedFuture( + new IllegalStateException("No message found in ProcessingContext")); + } + + try { + TenantDescriptor tenant = tenantResolver.resolveTenant(message, Collections.emptyList()); + Object repository = getOrCreateRepository(repositoryType, tenant); + return CompletableFuture.completedFuture(repository); + } catch (Exception e) { + return CompletableFuture.failedFuture(e); + } + } + + @Override + public boolean matches(@Nonnull ProcessingContext context) { + Message message = Message.fromContext(context); + if (message == null) { + return false; + } + try { + TenantDescriptor tenant = tenantResolver.resolveTenant(message, Collections.emptyList()); + return tenant != null; + } catch (Exception e) { + return false; + } + } + } + + @SuppressWarnings("unchecked") + private T getOrCreateRepository(Class repositoryType, TenantDescriptor tenant) { + Map tenantCache = repositoryCache.computeIfAbsent( + repositoryType, k -> new ConcurrentHashMap<>()); + + return (T) tenantCache.computeIfAbsent(tenant, t -> createRepository(repositoryType, t)); + } + + private Object createRepository(Class repositoryType, TenantDescriptor tenant) { + logger.debug("Creating repository {} for tenant {}", repositoryType.getName(), tenant.tenantId()); + + EntityManagerFactory emf = emfProvider.apply(tenant); + JpaRepositoryFactory factory = new JpaRepositoryFactory(emf.createEntityManager()); + return factory.getRepository(repositoryType); + } +} diff --git a/multitenancy-spring/src/main/java/org/axonframework/extension/multitenancy/spring/data/jpa/TenantTransactionManagerBuilder.java b/multitenancy-spring/src/main/java/org/axonframework/extension/multitenancy/spring/data/jpa/TenantTransactionManagerBuilder.java new file mode 100644 index 0000000..e4f4e1d --- /dev/null +++ b/multitenancy-spring/src/main/java/org/axonframework/extension/multitenancy/spring/data/jpa/TenantTransactionManagerBuilder.java @@ -0,0 +1,135 @@ +/* + * Copyright (c) 2010-2025. Axon Framework + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.axonframework.extension.multitenancy.spring.data.jpa; + +import jakarta.annotation.Nonnull; +import jakarta.persistence.EntityManagerFactory; +import org.axonframework.extension.spring.messaging.unitofwork.SpringTransactionManager; +import org.axonframework.extension.multitenancy.core.TenantDescriptor; +import org.axonframework.messaging.core.unitofwork.transaction.TransactionManager; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; +import org.springframework.orm.jpa.JpaTransactionManager; + +import java.util.Map; +import java.util.Objects; +import java.util.concurrent.ConcurrentHashMap; +import java.util.function.Function; + +/** + * Builder for creating tenant-specific {@link TransactionManager} instances. + *

    + * Each tenant's {@link EntityManagerFactory} requires its own {@link JpaTransactionManager} + * to properly manage transactions. This builder creates and caches per-tenant + * {@link SpringTransactionManager} instances that wrap tenant-specific {@code JpaTransactionManager}s. + *

    + * This follows the established Axon Framework pattern where: + *

      + *
    • {@code JpaTransactionManager} (Spring) is bound to a specific {@code EntityManagerFactory}
      • + *
    • {@code SpringTransactionManager} (Axon) wraps Spring's {@code PlatformTransactionManager}
      • + *
    • Each tenant gets its own transaction manager for proper database isolation
      • + *
    + *

    + * Example usage: + * 

    {@code
+ * TenantTransactionManagerBuilder txBuilder = TenantTransactionManagerBuilder
+ *     .forEntityManagerFactoryBuilder(tenantEmfBuilder)
+ *     .build();
+ *
+ * // Get transaction manager for a specific tenant
+ * TransactionManager txManager = txBuilder.apply(tenant);
+ * }
    + * + * @author Theo Emanuelsson + * @since 5.0.0 + * @see TenantEntityManagerFactoryBuilder + * @see SpringTransactionManager + */ +public class TenantTransactionManagerBuilder implements Function { + + private static final Logger logger = LoggerFactory.getLogger(TenantTransactionManagerBuilder.class); + + private final TenantEntityManagerFactoryBuilder emfBuilder; + private final Map cache = new ConcurrentHashMap<>(); + + private TenantTransactionManagerBuilder(Builder builder) { + this.emfBuilder = builder.emfBuilder; + } + + /** + * Creates a new builder with the specified {@link TenantEntityManagerFactoryBuilder}. + * + * @param emfBuilder the provider for tenant-specific EntityManagerFactories + * @return a new builder instance + */ + public static Builder forEntityManagerFactoryBuilder(@Nonnull TenantEntityManagerFactoryBuilder emfBuilder) { + return new Builder(emfBuilder); + } + + /** + * Returns the {@link TransactionManager} for the specified tenant, creating it if necessary. + *

    + * Created TransactionManager instances are cached to ensure that the same tenant + * always receives the same instance. + * + * @param tenant the tenant descriptor + * @return the TransactionManager for the tenant + */ + @Override + public TransactionManager apply(TenantDescriptor tenant) { + return cache.computeIfAbsent(tenant, this::createTransactionManager); + } + + private TransactionManager createTransactionManager(TenantDescriptor tenant) { + EntityManagerFactory emf = emfBuilder.apply(tenant); + logger.debug("Creating TransactionManager for tenant {} with EMF hash {}", tenant.tenantId(), System.identityHashCode(emf)); + JpaTransactionManager jpaTransactionManager = new JpaTransactionManager(emf); + // Initialize the transaction manager + jpaTransactionManager.afterPropertiesSet(); + return new SpringTransactionManager(jpaTransactionManager); + } + + /** + * Returns the number of cached TransactionManager instances. + * + * @return the cache size + */ + public int cacheSize() { + return cache.size(); + } + + /** + * Builder for {@link TenantTransactionManagerBuilder}. + */ + public static class Builder { + + private final TenantEntityManagerFactoryBuilder emfBuilder; + + private Builder(TenantEntityManagerFactoryBuilder emfBuilder) { + this.emfBuilder = Objects.requireNonNull(emfBuilder, + "TenantEntityManagerFactoryBuilder may not be null"); + } + + /** + * Builds the {@link TenantTransactionManagerBuilder}. + * + * @return a new TenantTransactionManagerBuilder instance + */ + public TenantTransactionManagerBuilder build() { + return new TenantTransactionManagerBuilder(this); + } + } +} diff --git a/multitenancy-spring/src/main/java/org/axonframework/extension/multitenancy/spring/data/jpa/package-info.java b/multitenancy-spring/src/main/java/org/axonframework/extension/multitenancy/spring/data/jpa/package-info.java new file mode 100644 index 0000000..db46ebb --- /dev/null +++ b/multitenancy-spring/src/main/java/org/axonframework/extension/multitenancy/spring/data/jpa/package-info.java @@ -0,0 +1,58 @@ +/* + * Copyright (c) 2010-2025. Axon Framework + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +/** + * Spring Data JPA integration for multi-tenant applications. + *

    + * This package provides support for using Spring Data JPA repositories in multi-tenant + * Axon Framework applications. Key components include: + *

      + *
    • {@link org.axonframework.extension.multitenancy.spring.data.jpa.TenantDataSourceProvider} - + * Interface for providing tenant-specific DataSources
      • + *
    • {@link org.axonframework.extension.multitenancy.spring.data.jpa.TenantEntityManagerFactoryBuilder} - + * Builder for creating tenant-specific EntityManagerFactories
      • + *
    • {@link org.axonframework.extension.multitenancy.spring.data.jpa.TenantRepositoryFactory} - + * Factory for creating tenant-scoped Spring Data JPA repositories
      • + *
    + *

    + * Example usage: + * 

    {@code
+ * // 1. Implement TenantDataSourceProvider
+ * TenantDataSourceProvider dataSourceProvider = tenant -> {
+ *     return DataSourceBuilder.create()
+ *         .url("jdbc:postgresql://localhost:5432/" + tenant.tenantId())
+ *         .build();
+ * };
+ *
+ * // 2. Build EntityManagerFactory per tenant
+ * TenantEntityManagerFactoryBuilder emfBuilder = TenantEntityManagerFactoryBuilder
+ *     .forDataSourceProvider(dataSourceProvider)
+ *     .packagesToScan("com.example.domain")
+ *     .build();
+ *
+ * // 3. Create repository factory
+ * TenantRepositoryFactory repoFactory =
+ *     TenantRepositoryFactory.forRepository(CustomerRepository.class, emfBuilder);
+ *
+ * // 4. Register with multi-tenancy configurer
+ * multiTenancyConfigurer.tenantComponent(CustomerRepository.class, repoFactory);
+ *
+ * // Now CustomerRepository can be injected in handlers and will be tenant-scoped
+ * }
    + * + * @see org.axonframework.extension.multitenancy.core.configuration.MultiTenancyConfigurer + */ +package org.axonframework.extension.multitenancy.spring.data.jpa; diff --git a/multitenancy-spring/src/main/java/org/axonframework/extension/multitenancy/spring/data/r2dbc/TenantConnectionFactoryProvider.java b/multitenancy-spring/src/main/java/org/axonframework/extension/multitenancy/spring/data/r2dbc/TenantConnectionFactoryProvider.java new file mode 100644 index 0000000..d646b4e --- /dev/null +++ b/multitenancy-spring/src/main/java/org/axonframework/extension/multitenancy/spring/data/r2dbc/TenantConnectionFactoryProvider.java @@ -0,0 +1,62 @@ +/* + * Copyright (c) 2010-2025. Axon Framework + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.axonframework.extension.multitenancy.spring.data.r2dbc; + +import io.r2dbc.spi.ConnectionFactory; +import org.axonframework.extension.multitenancy.core.TenantDescriptor; + +import java.util.function.Function; + +/** + * Provider interface for obtaining tenant-specific R2DBC {@link ConnectionFactory} instances. + *

    + * Implementations of this interface are responsible for returning a {@link ConnectionFactory} + * configured for a specific tenant. This is used in reactive database-per-tenant + * or schema-per-tenant multi-tenancy architectures. + *

    + * Example usage: + * 

    {@code
+ * TenantConnectionFactoryProvider provider = tenant -> {
+ *     String tenantId = tenant.tenantId();
+ *     return ConnectionFactories.get(
+ *         ConnectionFactoryOptions.builder()
+ *             .option(DRIVER, "postgresql")
+ *             .option(HOST, "localhost")
+ *             .option(DATABASE, tenantId)
+ *             .option(USER, "app_user")
+ *             .option(PASSWORD, "secret")
+ *             .build()
+ *     );
+ * };
+ * }
    + * + * @author Theo Emanuelsson + * @since 5.0.0 + * @see org.axonframework.extension.multitenancy.spring.data.jpa.TenantDataSourceProvider + */ +@FunctionalInterface +public interface TenantConnectionFactoryProvider extends Function { + + /** + * Returns a {@link ConnectionFactory} configured for the specified tenant. + * + * @param tenant the tenant descriptor identifying the tenant + * @return a ConnectionFactory for the tenant's database + * @throws IllegalArgumentException if the tenant is unknown or invalid + */ + @Override + ConnectionFactory apply(TenantDescriptor tenant); +} diff --git a/multitenancy-spring/src/main/java/org/axonframework/extension/multitenancy/spring/data/r2dbc/package-info.java b/multitenancy-spring/src/main/java/org/axonframework/extension/multitenancy/spring/data/r2dbc/package-info.java new file mode 100644 index 0000000..3cd7926 --- /dev/null +++ b/multitenancy-spring/src/main/java/org/axonframework/extension/multitenancy/spring/data/r2dbc/package-info.java @@ -0,0 +1,26 @@ +/* + * Copyright (c) 2010-2025. Axon Framework + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +/** + * Provides multi-tenancy support for reactive R2DBC database access. + *

    + * This package contains components for creating tenant-scoped R2DBC + * {@link io.r2dbc.spi.ConnectionFactory} instances, enabling non-blocking + * database operations in multi-tenant applications. + * + * @see org.axonframework.extension.multitenancy.spring.data.r2dbc.TenantConnectionFactoryProvider + */ +package org.axonframework.extension.multitenancy.spring.data.r2dbc; diff --git a/multitenancy/pom.xml b/multitenancy/pom.xml index 5ee762e..5a011ee 100644 --- a/multitenancy/pom.xml +++ b/multitenancy/pom.xml @@ -19,7 +19,7 @@ axon-multitenancy-parent org.axonframework.extensions.multitenancy - 4.12.1-SNAPSHOT + 5.1.0-SNAPSHOT axon-multitenancy @@ -41,7 +41,7 @@ org.axonframework - axon-configuration + axon-eventsourcing provided @@ -49,12 +49,19 @@ com.google.code.findbugs jsr305 + + + jakarta.persistence + jakarta.persistence-api + 3.2.0 + true + org.junit.jupiter junit-jupiter-api ${junit.jupiter.version} - compile + test org.mockito @@ -62,9 +69,5 @@ ${mockito.version} test - - org.axonframework - axon-server-connector - \ No newline at end of file diff --git a/multitenancy/src/main/java/org/axonframework/extension/multitenancy/core/MetadataBasedTenantResolver.java b/multitenancy/src/main/java/org/axonframework/extension/multitenancy/core/MetadataBasedTenantResolver.java new file mode 100644 index 0000000..feebd51 --- /dev/null +++ b/multitenancy/src/main/java/org/axonframework/extension/multitenancy/core/MetadataBasedTenantResolver.java @@ -0,0 +1,106 @@ +/* + * Copyright (c) 2010-2025. Axon Framework + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.axonframework.extension.multitenancy.core; + +import jakarta.annotation.Nonnull; +import org.axonframework.messaging.core.Message; +import org.axonframework.messaging.core.correlation.SimpleCorrelationDataProvider; + +import java.util.Collection; + +import static org.axonframework.common.BuilderUtils.assertNonEmpty; + +/** + * A {@link TargetTenantResolver} implementation that resolves the target tenant from message metadata. + *

    + * This resolver extracts the tenant identifier from the message's {@link Message#metadata() metadata} + * using a configurable key (default: {@code "tenantId"}). If the metadata does not contain the + * expected key, a {@link NoSuchTenantException} is thrown. + *

    + * This is the standard resolver for metadata-based multi-tenant routing. Combined with a + * {@link org.axonframework.messaging.core.correlation.CorrelationDataProvider} that propagates + * the same metadata key, this enables automatic tenant context propagation throughout the + * message handling chain. + *

    + * Example usage: + * 

    
+ *     // Using default metadata key "tenantId"
+ *     TargetTenantResolver<Message> resolver = new MetadataBasedTenantResolver();
+ *
+ *     // Using custom metadata key
+ *     TargetTenantResolver<Message> resolver = new MetadataBasedTenantResolver("customTenantKey");
+ *
    + * + * @author Theo Emanuelsson + * @since 5.0.0 + * @see TargetTenantResolver + * @see SimpleCorrelationDataProvider + */ +public class MetadataBasedTenantResolver implements TargetTenantResolver { + + /** + * The default metadata key used to store the tenant identifier. + */ + public static final String DEFAULT_TENANT_KEY = "tenantId"; + + private final String metadataKey; + + /** + * Constructs a {@link MetadataBasedTenantResolver} using the default metadata key {@code "tenantId"}. + */ + public MetadataBasedTenantResolver() { + this(DEFAULT_TENANT_KEY); + } + + /** + * Constructs a {@link MetadataBasedTenantResolver} using the specified metadata key. + * + * @param metadataKey The key to use when extracting the tenant identifier from message metadata. + * Must not be {@code null} or empty. + */ + public MetadataBasedTenantResolver(@Nonnull String metadataKey) { + assertNonEmpty(metadataKey, "The metadata key must not be null or empty"); + this.metadataKey = metadataKey; + } + + /** + * Resolves the target tenant by extracting the tenant identifier from the message's metadata. + * + * @param message The message to resolve the tenant from. + * @param tenants The available tenants (not used by this implementation). + * @return The {@link TenantDescriptor} for the resolved tenant. + * @throws NoSuchTenantException if the message metadata does not contain the expected tenant key. + */ + @Override + public TenantDescriptor apply(Message message, Collection tenants) { + String tenantId = message.metadata().get(metadataKey); + if (tenantId == null) { + throw new NoSuchTenantException( + "No tenant identifier found in message metadata under key '" + metadataKey + "'" + ); + } + return TenantDescriptor.tenantWithId(tenantId); + } + + /** + * Returns the metadata key used by this resolver. + * + * @return The metadata key. + */ + public String metadataKey() { + return metadataKey; + } +} diff --git a/multitenancy/src/main/java/org/axonframework/extensions/multitenancy/components/MultiTenantAwareComponent.java b/multitenancy/src/main/java/org/axonframework/extension/multitenancy/core/MultiTenantAwareComponent.java similarity index 92% rename from multitenancy/src/main/java/org/axonframework/extensions/multitenancy/components/MultiTenantAwareComponent.java rename to multitenancy/src/main/java/org/axonframework/extension/multitenancy/core/MultiTenantAwareComponent.java index 0873be1..c4a8b99 100644 --- a/multitenancy/src/main/java/org/axonframework/extensions/multitenancy/components/MultiTenantAwareComponent.java +++ b/multitenancy/src/main/java/org/axonframework/extension/multitenancy/core/MultiTenantAwareComponent.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 2010-2023. Axon Framework + * Copyright (c) 2010-2025. Axon Framework * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -13,7 +13,7 @@ * See the License for the specific language governing permissions and * limitations under the License. */ -package org.axonframework.extensions.multitenancy.components; +package org.axonframework.extension.multitenancy.core; import org.axonframework.common.Registration; @@ -21,7 +21,8 @@ * Interface for components that can be registered with a {@link TenantProvider}. * * @author Stefan Dragisic - * @since 4.6.0 + * @author Theo Emanuelsson + * @since 5.0.0 */ public interface MultiTenantAwareComponent { diff --git a/multitenancy/src/main/java/org/axonframework/extensions/multitenancy/components/NoSuchTenantException.java b/multitenancy/src/main/java/org/axonframework/extension/multitenancy/core/NoSuchTenantException.java similarity index 56% rename from multitenancy/src/main/java/org/axonframework/extensions/multitenancy/components/NoSuchTenantException.java rename to multitenancy/src/main/java/org/axonframework/extension/multitenancy/core/NoSuchTenantException.java index cf8a789..985e6cf 100644 --- a/multitenancy/src/main/java/org/axonframework/extensions/multitenancy/components/NoSuchTenantException.java +++ b/multitenancy/src/main/java/org/axonframework/extension/multitenancy/core/NoSuchTenantException.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 2010-2023. Axon Framework + * Copyright (c) 2010-2025. Axon Framework * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -13,24 +13,35 @@ * See the License for the specific language governing permissions and * limitations under the License. */ -package org.axonframework.extensions.multitenancy.components; +package org.axonframework.extension.multitenancy.core; import org.axonframework.common.AxonNonTransientException; /** - * Exception thrown when a tenant is not found. + * Exception thrown when a tenant is not found or cannot be resolved. * * @author Stefan Dragisic - * @since 4.6.0 + * @author Theo Emanuelsson + * @since 5.0.0 */ public class NoSuchTenantException extends AxonNonTransientException { + /** + * Construct a {@link NoSuchTenantException} with a custom message. + * + * @param message The exception message. + */ + public NoSuchTenantException(String message) { + super(message); + } + /** * Construct a {@link NoSuchTenantException} referring to the given {@code tenantId}. * * @param tenantId The tenant identifier that could not be found. + * @return A {@link NoSuchTenantException} with a message indicating the tenant is unknown. */ - public NoSuchTenantException(String tenantId) { - super("Tenant with identifier [" + tenantId + "] is unknown"); + public static NoSuchTenantException forTenantId(String tenantId) { + return new NoSuchTenantException("Tenant with identifier [" + tenantId + "] is unknown"); } } diff --git a/multitenancy/src/main/java/org/axonframework/extension/multitenancy/core/NoTenantInMessageException.java b/multitenancy/src/main/java/org/axonframework/extension/multitenancy/core/NoTenantInMessageException.java new file mode 100644 index 0000000..6a39852 --- /dev/null +++ b/multitenancy/src/main/java/org/axonframework/extension/multitenancy/core/NoTenantInMessageException.java @@ -0,0 +1,66 @@ +/* + * Copyright (c) 2010-2025. Axon Framework + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.axonframework.extension.multitenancy.core; + +import org.axonframework.common.AxonNonTransientException; + +/** + * Exception thrown when a tenant-scoped operation is requested but no tenant ID + * is present in the message metadata. + *

    + * This typically indicates that a message was not properly annotated with tenant + * information, or the tenant correlation provider was not configured. + *

    + * This is a non-transient exception because retrying the operation will not resolve + * the missing tenant information - the message must be dispatched with proper tenant + * metadata. + * + * @author Theo Emanuelsson + * @since 5.0.0 + */ +public class NoTenantInMessageException extends AxonNonTransientException { + + /** + * Creates a new {@link NoTenantInMessageException} with the given message. + * + * @param message a description of the exception + */ + public NoTenantInMessageException(String message) { + super(message); + } + + /** + * Creates a new {@link NoTenantInMessageException} with the given message and cause. + * + * @param message a description of the exception + * @param cause the cause of the exception + */ + public NoTenantInMessageException(String message, Throwable cause) { + super(message, cause); + } + + /** + * Construct a {@link NoTenantInMessageException} referring to the given metadata key. + * + * @param metadataKey The metadata key that was expected to contain the tenant ID. + * @return A {@link NoTenantInMessageException} with a message indicating no tenant was found. + */ + public static NoTenantInMessageException forMetadataKey(String metadataKey) { + return new NoTenantInMessageException( + "No tenant ID found in message metadata with key '" + metadataKey + "'" + ); + } +} diff --git a/multitenancy/src/main/java/org/axonframework/extension/multitenancy/core/SimpleTenantProvider.java b/multitenancy/src/main/java/org/axonframework/extension/multitenancy/core/SimpleTenantProvider.java new file mode 100644 index 0000000..91f8386 --- /dev/null +++ b/multitenancy/src/main/java/org/axonframework/extension/multitenancy/core/SimpleTenantProvider.java @@ -0,0 +1,216 @@ +/* + * Copyright (c) 2010-2025. Axon Framework + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.axonframework.extension.multitenancy.core; + +import jakarta.annotation.Nonnull; +import org.axonframework.common.Registration; + +import java.util.ArrayList; +import java.util.Collection; +import java.util.List; +import java.util.Set; +import java.util.concurrent.ConcurrentHashMap; +import java.util.concurrent.CopyOnWriteArrayList; + +import static java.util.Objects.requireNonNull; + +/** + * A simple implementation of {@link TenantProvider} that allows programmatic management of tenants. + *

    + * This provider maintains an in-memory set of tenants and notifies subscribed + * {@link MultiTenantAwareComponent MultiTenantAwareComponents} when tenants are added or removed. + *

    + * Tenants can be added and removed at runtime, making this suitable for both static and dynamic + * tenant configurations. For static configurations, tenants can be added during application startup. + * For dynamic configurations, tenants can be added/removed based on external events. + *

    + * Example usage with static tenants: + * 

    {@code
+ * SimpleTenantProvider provider = new SimpleTenantProvider();
+ * provider.addTenant(TenantDescriptor.tenantWithId("tenant-1"));
+ * provider.addTenant(TenantDescriptor.tenantWithId("tenant-2"));
+ *
+ * MessagingConfigurer messagingConfigurer = MessagingConfigurer.create();
+ * // ... configure messaging components ...
+ *
+ * MultiTenancyConfigurer.enhance(messagingConfigurer)
+ *     .registerTenantProvider(config -> provider)
+ *     // ... other multi-tenancy configuration
+ *     .build();
+ * }
    + *

    + * Example usage with dynamic tenants: + * 

    {@code
+ * SimpleTenantProvider provider = new SimpleTenantProvider();
+ *
+ * // Later, when a new tenant is provisioned:
+ * provider.addTenant(TenantDescriptor.tenantWithId("new-tenant"));
+ *
+ * // When a tenant is decommissioned:
+ * provider.removeTenant(TenantDescriptor.tenantWithId("old-tenant"));
+ * }
    + *

    + * This implementation is thread-safe. Tenant additions and removals can safely occur from any thread. + * + * @author Theo Emanuelsson + * @since 5.0.0 + * @see TenantProvider + * @see TenantDescriptor + * @see MultiTenantAwareComponent + */ +public class SimpleTenantProvider implements TenantProvider { + + private final Set tenants = ConcurrentHashMap.newKeySet(); + private final List subscribers = new CopyOnWriteArrayList<>(); + private final ConcurrentHashMap> tenantRegistrations = new ConcurrentHashMap<>(); + + /** + * Creates a new {@link SimpleTenantProvider} with no initial tenants. + */ + public SimpleTenantProvider() { + } + + /** + * Creates a new {@link SimpleTenantProvider} with the given initial tenants. + * + * @param initialTenants the tenants to register initially + */ + public SimpleTenantProvider(@Nonnull Collection initialTenants) { + requireNonNull(initialTenants, "Initial tenants cannot be null"); + tenants.addAll(initialTenants); + } + + /** + * Adds a tenant to this provider and notifies all subscribed components. + *

    + * If the tenant is already registered, this method has no effect. + *

    + * When a tenant is added, all subscribed {@link MultiTenantAwareComponent MultiTenantAwareComponents} + * are notified via {@link MultiTenantAwareComponent#registerAndStartTenant(TenantDescriptor)}. + * + * @param tenant the tenant to add + * @return {@code true} if the tenant was added, {@code false} if it was already registered + */ + public boolean addTenant(@Nonnull TenantDescriptor tenant) { + requireNonNull(tenant, "Tenant cannot be null"); + if (tenants.add(tenant)) { + List registrations = new CopyOnWriteArrayList<>(); + subscribers.forEach(subscriber -> { + Registration registration = subscriber.registerAndStartTenant(tenant); + if (registration != null) { + registrations.add(registration); + } + }); + tenantRegistrations.put(tenant, registrations); + return true; + } + return false; + } + + /** + * Adds multiple tenants to this provider and notifies all subscribed components. + *

    + * This is equivalent to calling {@link #addTenant(TenantDescriptor)} for each tenant, + * but may be more efficient for bulk additions. + * + * @param tenantsToAdd the tenants to add + */ + public void addTenants(@Nonnull Collection tenantsToAdd) { + requireNonNull(tenantsToAdd, "Tenants cannot be null"); + tenantsToAdd.forEach(this::addTenant); + } + + /** + * Removes a tenant from this provider and triggers cleanup of all tenant-specific resources. + *

    + * If the tenant is not registered, this method has no effect. + *

    + * When a tenant is removed, all {@link Registration} handles returned by + * {@link MultiTenantAwareComponent#registerTenant(TenantDescriptor)} are cancelled, + * triggering cleanup of tenant-specific resources such as closing connections, + * releasing caches, and disposing components. + * + * @param tenant the tenant to remove + * @return {@code true} if the tenant was removed, {@code false} if it was not registered + */ + public boolean removeTenant(@Nonnull TenantDescriptor tenant) { + requireNonNull(tenant, "Tenant cannot be null"); + if (tenants.remove(tenant)) { + List registrations = tenantRegistrations.remove(tenant); + if (registrations != null) { + registrations.forEach(Registration::cancel); + } + return true; + } + return false; + } + + /** + * Removes a tenant by its ID. + *

    + * This is a convenience method that creates a {@link TenantDescriptor} from the given ID + * and calls {@link #removeTenant(TenantDescriptor)}. + * + * @param tenantId the ID of the tenant to remove + * @return {@code true} if the tenant was removed, {@code false} if it was not registered + */ + public boolean removeTenant(@Nonnull String tenantId) { + requireNonNull(tenantId, "Tenant ID cannot be null"); + return removeTenant(TenantDescriptor.tenantWithId(tenantId)); + } + + /** + * Checks if a tenant is registered with this provider. + * + * @param tenant the tenant to check + * @return {@code true} if the tenant is registered, {@code false} otherwise + */ + public boolean hasTenant(@Nonnull TenantDescriptor tenant) { + requireNonNull(tenant, "Tenant cannot be null"); + return tenants.contains(tenant); + } + + /** + * Checks if a tenant with the given ID is registered with this provider. + * + * @param tenantId the ID of the tenant to check + * @return {@code true} if a tenant with the given ID is registered, {@code false} otherwise + */ + public boolean hasTenant(@Nonnull String tenantId) { + requireNonNull(tenantId, "Tenant ID cannot be null"); + return hasTenant(TenantDescriptor.tenantWithId(tenantId)); + } + + @Override + public Registration subscribe(@Nonnull MultiTenantAwareComponent component) { + requireNonNull(component, "Component cannot be null"); + subscribers.add(component); + // Register all existing tenants with the new subscriber and store registrations + tenants.forEach(tenant -> { + Registration registration = component.registerTenant(tenant); + if (registration != null) { + tenantRegistrations.computeIfAbsent(tenant, k -> new CopyOnWriteArrayList<>()) + .add(registration); + } + }); + return () -> subscribers.remove(component); + } + + @Override + public List getTenants() { + return new ArrayList<>(tenants); + } +} diff --git a/multitenancy/src/main/java/org/axonframework/extensions/multitenancy/components/TargetTenantResolver.java b/multitenancy/src/main/java/org/axonframework/extension/multitenancy/core/TargetTenantResolver.java similarity index 85% rename from multitenancy/src/main/java/org/axonframework/extensions/multitenancy/components/TargetTenantResolver.java rename to multitenancy/src/main/java/org/axonframework/extension/multitenancy/core/TargetTenantResolver.java index c1cbca9..004078b 100644 --- a/multitenancy/src/main/java/org/axonframework/extensions/multitenancy/components/TargetTenantResolver.java +++ b/multitenancy/src/main/java/org/axonframework/extension/multitenancy/core/TargetTenantResolver.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 2010-2023. Axon Framework + * Copyright (c) 2010-2025. Axon Framework * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -13,9 +13,9 @@ * See the License for the specific language governing permissions and * limitations under the License. */ -package org.axonframework.extensions.multitenancy.components; +package org.axonframework.extension.multitenancy.core; -import org.axonframework.messaging.Message; +import org.axonframework.messaging.core.Message; import java.util.Collection; import java.util.Collections; @@ -26,9 +26,10 @@ * * @param The {@link Message} implementation this resolver acts on. * @author Stefan Dragisic - * @since 4.6.0 + * @author Theo Emanuelsson + * @since 5.0.0 */ -public interface TargetTenantResolver> +public interface TargetTenantResolver extends BiFunction, TenantDescriptor> { /** diff --git a/multitenancy/src/main/java/org/axonframework/extension/multitenancy/core/TenantComponentFactory.java b/multitenancy/src/main/java/org/axonframework/extension/multitenancy/core/TenantComponentFactory.java new file mode 100644 index 0000000..4260066 --- /dev/null +++ b/multitenancy/src/main/java/org/axonframework/extension/multitenancy/core/TenantComponentFactory.java @@ -0,0 +1,96 @@ +/* + * Copyright (c) 2010-2025. Axon Framework + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.axonframework.extension.multitenancy.core; + +import java.util.function.Function; + +/** + * Factory for creating and cleaning up tenant-scoped component instances. + *

    + * Users implement this interface to define how components (such as repositories, + * services, or any other dependencies) are created for each tenant. The factory + * is invoked lazily when a component is first needed for a tenant. + *

    + * When a tenant is removed, the {@link #cleanup(TenantDescriptor, Object)} method + * is called to release any resources held by the component. By default, this method + * will close components that implement {@link AutoCloseable}. + *

    + * Example usage: + * 

    {@code
+ * TenantComponentFactory repoFactory =
+ *     tenant -> new InMemoryCourseRepository();
+ *
+ * // Or with tenant-specific configuration:
+ * TenantComponentFactory repoFactory =
+ *     tenant -> new JpaCourseRepository(getDataSourceForTenant(tenant));
+ *
+ * // For components needing custom cleanup:
+ * TenantComponentFactory emfFactory =
+ *     new TenantComponentFactory<>() {
+ *         public EntityManagerFactory apply(TenantDescriptor tenant) {
+ *             return createEntityManagerFactory(tenant);
+ *         }
+ *         public void cleanup(TenantDescriptor tenant, EntityManagerFactory emf) {
+ *             emf.close();
+ *             logger.info("Closed EMF for tenant {}", tenant.tenantId());
+ *         }
+ *     };
+ * }
    + * + * @param The type of component this factory creates + * @author Theo Emanuelsson + * @since 5.0.0 + * @see TenantComponentRegistry + */ +@FunctionalInterface +public interface TenantComponentFactory extends Function { + + /** + * Creates a component instance for the given tenant. + * + * @param tenant The tenant descriptor identifying which tenant needs the component + * @return A new component instance for this tenant + */ + @Override + T apply(TenantDescriptor tenant); + + /** + * Cleans up a component instance when a tenant is removed. + *

    + * This method is called when a tenant is unregistered from the system. The default + * implementation will close components that implement {@link AutoCloseable}. Override + * this method to provide custom cleanup logic for components that require special + * handling (e.g., releasing database connections, flushing caches, etc.). + *

    + * Any exceptions thrown during cleanup are logged but do not propagate, ensuring + * that cleanup of other components can continue. + * + * @param tenant The tenant being removed + * @param component The component instance to clean up + */ + default void cleanup(TenantDescriptor tenant, T component) { + if (component instanceof AutoCloseable autoCloseable) { + try { + autoCloseable.close(); + } catch (Exception e) { + // Log but don't propagate - cleanup should be best-effort + org.slf4j.LoggerFactory.getLogger(TenantComponentFactory.class) + .warn("Error closing AutoCloseable component for tenant [{}]: {}", + tenant.tenantId(), e.getMessage(), e); + } + } + } +} diff --git a/multitenancy/src/main/java/org/axonframework/extension/multitenancy/core/TenantComponentRegistry.java b/multitenancy/src/main/java/org/axonframework/extension/multitenancy/core/TenantComponentRegistry.java new file mode 100644 index 0000000..aef2bcb --- /dev/null +++ b/multitenancy/src/main/java/org/axonframework/extension/multitenancy/core/TenantComponentRegistry.java @@ -0,0 +1,117 @@ +/* + * Copyright (c) 2010-2025. Axon Framework + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.axonframework.extension.multitenancy.core; + +import jakarta.annotation.Nonnull; +import org.axonframework.common.Registration; + +import java.util.Objects; +import java.util.Set; +import java.util.concurrent.ConcurrentHashMap; + +/** + * Registry that manages tenant-scoped component instances. + *

    + * This registry caches component instances per tenant, creating them lazily + * on first access using the provided {@link TenantComponentFactory}. When a + * tenant is unregistered, its component instance is removed from the cache + * and cleaned up via {@link TenantComponentFactory#cleanup(TenantDescriptor, Object)}. + *

    + * The registry implements {@link MultiTenantAwareComponent} to participate + * in tenant lifecycle management, but uses lazy creation - components are + * only instantiated when first requested, not when a tenant is registered. + *

    + * Components that implement {@link AutoCloseable} are automatically closed + * when their tenant is removed (unless custom cleanup is provided via the factory). + * + * @param The type of component managed by this registry + * @author Theo Emanuelsson + * @since 5.0.0 + * @see TenantComponentFactory + */ +public class TenantComponentRegistry implements MultiTenantAwareComponent { + + private final Class componentType; + private final TenantComponentFactory factory; + private final ConcurrentHashMap components = new ConcurrentHashMap<>(); + private final Set registeredTenants = ConcurrentHashMap.newKeySet(); + + /** + * Creates a new registry for the given component type and factory. + * + * @param componentType The class of the component type for parameter matching + * @param factory The factory to create component instances per tenant + */ + public TenantComponentRegistry(@Nonnull Class componentType, + @Nonnull TenantComponentFactory factory) { + this.componentType = Objects.requireNonNull(componentType, "Component type must not be null"); + this.factory = Objects.requireNonNull(factory, "Factory must not be null"); + } + + /** + * Gets the component instance for the given tenant, creating it if necessary. + *

    + * Components are created lazily using the configured factory. Once created, + * they are cached for subsequent calls with the same tenant. + * + * @param tenant The tenant descriptor + * @return The component instance for this tenant + */ + public T getComponent(@Nonnull TenantDescriptor tenant) { + return components.computeIfAbsent(tenant, factory); + } + + /** + * Returns the component type managed by this registry. + * + * @return The component class + */ + public Class getComponentType() { + return componentType; + } + + /** + * Returns the set of registered tenants. + *

    + * Note that this returns all tenants that have been registered, not just + * those for which components have been created. Use this for tenant resolution. + * + * @return An unmodifiable view of registered tenant descriptors + */ + public Set getTenants() { + return Set.copyOf(registeredTenants); + } + + @Override + public Registration registerTenant(TenantDescriptor tenantDescriptor) { + registeredTenants.add(tenantDescriptor); + // Lazy creation - don't create component until first access + return () -> { + boolean wasRegistered = registeredTenants.remove(tenantDescriptor); + T removed = components.remove(tenantDescriptor); + if (removed != null) { + factory.cleanup(tenantDescriptor, removed); + } + return wasRegistered; + }; + } + + @Override + public Registration registerAndStartTenant(TenantDescriptor tenantDescriptor) { + // For component registries, there's nothing to "start" + return registerTenant(tenantDescriptor); + } +} diff --git a/multitenancy/src/main/java/org/axonframework/extensions/multitenancy/components/TenantConnectPredicate.java b/multitenancy/src/main/java/org/axonframework/extension/multitenancy/core/TenantConnectPredicate.java similarity index 87% rename from multitenancy/src/main/java/org/axonframework/extensions/multitenancy/components/TenantConnectPredicate.java rename to multitenancy/src/main/java/org/axonframework/extension/multitenancy/core/TenantConnectPredicate.java index 21f89ce..227f2a6 100644 --- a/multitenancy/src/main/java/org/axonframework/extensions/multitenancy/components/TenantConnectPredicate.java +++ b/multitenancy/src/main/java/org/axonframework/extension/multitenancy/core/TenantConnectPredicate.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 2010-2023. Axon Framework + * Copyright (c) 2010-2025. Axon Framework * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -13,7 +13,7 @@ * See the License for the specific language governing permissions and * limitations under the License. */ -package org.axonframework.extensions.multitenancy.components; +package org.axonframework.extension.multitenancy.core; import java.util.function.Predicate; @@ -22,7 +22,8 @@ * to the tenant-aware infrastructure components. Used for dynamic registration of tenant-specific components. * * @author Stefan Dragisic - * @since 4.6.0 + * @author Theo Emanuelsson + * @since 5.0.0 */ public interface TenantConnectPredicate extends Predicate { diff --git a/multitenancy/src/main/java/org/axonframework/extensions/multitenancy/components/TenantDescriptor.java b/multitenancy/src/main/java/org/axonframework/extension/multitenancy/core/TenantDescriptor.java similarity index 95% rename from multitenancy/src/main/java/org/axonframework/extensions/multitenancy/components/TenantDescriptor.java rename to multitenancy/src/main/java/org/axonframework/extension/multitenancy/core/TenantDescriptor.java index ab9e3f6..1cbbdf7 100644 --- a/multitenancy/src/main/java/org/axonframework/extensions/multitenancy/components/TenantDescriptor.java +++ b/multitenancy/src/main/java/org/axonframework/extension/multitenancy/core/TenantDescriptor.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 2010-2023. Axon Framework + * Copyright (c) 2010-2025. Axon Framework * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -13,7 +13,7 @@ * See the License for the specific language governing permissions and * limitations under the License. */ -package org.axonframework.extensions.multitenancy.components; +package org.axonframework.extension.multitenancy.core; import java.util.Collections; import java.util.Map; @@ -23,7 +23,8 @@ * A descriptor for tenants. * * @author Stefan Dragisic - * @since 4.6.0 + * @author Theo Emanuelsson + * @since 5.0.0 */ public class TenantDescriptor { diff --git a/multitenancy/src/main/java/org/axonframework/extensions/multitenancy/components/TenantProvider.java b/multitenancy/src/main/java/org/axonframework/extension/multitenancy/core/TenantProvider.java similarity index 91% rename from multitenancy/src/main/java/org/axonframework/extensions/multitenancy/components/TenantProvider.java rename to multitenancy/src/main/java/org/axonframework/extension/multitenancy/core/TenantProvider.java index 0b81119..1ee28be 100644 --- a/multitenancy/src/main/java/org/axonframework/extensions/multitenancy/components/TenantProvider.java +++ b/multitenancy/src/main/java/org/axonframework/extension/multitenancy/core/TenantProvider.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 2010-2023. Axon Framework + * Copyright (c) 2010-2025. Axon Framework * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -13,7 +13,7 @@ * See the License for the specific language governing permissions and * limitations under the License. */ -package org.axonframework.extensions.multitenancy.components; +package org.axonframework.extension.multitenancy.core; import org.axonframework.common.Registration; @@ -27,7 +27,8 @@ * {@code MultiTenantAwareComponents} accordingly. * * @author Stefan Dragisic - * @since 4.6.0 + * @author Theo Emanuelsson + * @since 5.0.0 */ public interface TenantProvider { diff --git a/multitenancy/src/main/java/org/axonframework/extension/multitenancy/core/configuration/MultiTenancyConfigurationDefaults.java b/multitenancy/src/main/java/org/axonframework/extension/multitenancy/core/configuration/MultiTenancyConfigurationDefaults.java new file mode 100644 index 0000000..bdd0284 --- /dev/null +++ b/multitenancy/src/main/java/org/axonframework/extension/multitenancy/core/configuration/MultiTenancyConfigurationDefaults.java @@ -0,0 +1,298 @@ +/* + * Copyright (c) 2010-2025. Axon Framework + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.axonframework.extension.multitenancy.core.configuration; + +import jakarta.annotation.Nonnull; +import org.axonframework.common.configuration.ComponentRegistry; +import org.axonframework.common.configuration.Configuration; +import org.axonframework.common.configuration.ConfigurationEnhancer; +import org.axonframework.extension.multitenancy.core.MultiTenantAwareComponent; +import org.axonframework.extension.multitenancy.core.TargetTenantResolver; +import org.axonframework.extension.multitenancy.core.TenantDescriptor; +import org.axonframework.extension.multitenancy.core.TenantProvider; +import org.axonframework.extension.multitenancy.eventsourcing.eventstore.MultiTenantEventStore; +import org.axonframework.extension.multitenancy.eventsourcing.eventstore.TenantEventSegmentFactory; +import org.axonframework.extension.multitenancy.eventsourcing.eventstore.TenantEventStoreProvider; +import org.axonframework.extension.multitenancy.messaging.commandhandling.MultiTenantCommandBus; +import org.axonframework.extension.multitenancy.messaging.commandhandling.TenantAwareCommandBus; +import org.axonframework.extension.multitenancy.messaging.commandhandling.TenantCommandSegmentFactory; +import org.axonframework.extension.multitenancy.messaging.queryhandling.MultiTenantQueryBus; +import org.axonframework.extension.multitenancy.messaging.queryhandling.TenantQuerySegmentFactory; +import org.axonframework.eventsourcing.eventstore.AnnotationBasedTagResolver; +import org.axonframework.eventsourcing.eventstore.EventStore; +import org.axonframework.eventsourcing.eventstore.InterceptingEventStore; +import org.axonframework.eventsourcing.eventstore.StorageEngineBackedEventStore; +import org.axonframework.eventsourcing.eventstore.inmemory.InMemoryEventStorageEngine; +import org.axonframework.messaging.eventhandling.EventMessage; +import org.axonframework.messaging.core.MessageDispatchInterceptor; +import org.axonframework.messaging.core.interception.DispatchInterceptorRegistry; +import org.axonframework.messaging.commandhandling.CommandBus; +import org.axonframework.messaging.commandhandling.SimpleCommandBus; +import org.axonframework.messaging.core.Message; +import org.axonframework.messaging.core.unitofwork.ProcessingLifecycleHandlerRegistrar; +import org.axonframework.messaging.core.unitofwork.UnitOfWorkFactory; +import org.axonframework.messaging.core.unitofwork.transaction.TransactionManager; +import org.axonframework.messaging.eventhandling.SimpleEventBus; +import org.axonframework.messaging.queryhandling.QueryBus; +import org.axonframework.messaging.queryhandling.SimpleQueryBus; + +import java.util.Collections; +import java.util.List; + +/** + * {@link ConfigurationEnhancer} that provides configuration for multi-tenancy components. + *

    + * This enhancer provides default segment factories for embedded (non-distributed) deployments + * and registers decorators that replace standard infrastructure components (CommandBus, + * QueryBus, EventStore) with their multi-tenant equivalents when a {@link TargetTenantResolver} + * is configured. + *

    + * Default Segment Factories: For embedded deployments without Axon Server, this + * enhancer provides default implementations: + *

      + *
    • {@link TenantCommandSegmentFactory} - creates {@link SimpleCommandBus} per tenant
      • + *
    • {@link TenantQuerySegmentFactory} - creates {@link SimpleQueryBus} per tenant
      • + *
    • {@link TenantEventSegmentFactory} - creates in-memory {@link EventStore} per tenant
      • + *
    + * These defaults can be overridden by registering custom implementations. + *

    + * Decoration Order: Multi-tenant decorators run BEFORE intercepting decorators + * (e.g., {@code InterceptingCommandBus}). This means the decoration chain is: + * 

    + *     User → InterceptingCommandBus → MultiTenantCommandBus → TenantSegments
+ *
    + * This follows the standard Axon Framework pattern where interceptors wrap the outer bus, + * and the multi-tenant bus handles routing to tenant-specific segments. + * + * @author Stefan Dragisic + * @author Steven van Beelen + * @author Theo Emanuelsson + * @since 5.0.0 + */ +public class MultiTenancyConfigurationDefaults implements ConfigurationEnhancer { + + /** + * The order of {@code this} enhancer compared to others. + *

    + * Using {@code Integer.MAX_VALUE - 1} ensures multi-tenancy configuration runs after + * most other enhancers but before the final defaults. + */ + public static final int ENHANCER_ORDER = Integer.MAX_VALUE - 1; + + // Holds the MultiTenantEventStore instance created during decoration + // This is needed to register TenantEventStoreProvider for components that need tenant segments + private volatile MultiTenantEventStore multiTenantEventStoreInstance; + + @Override + public int order() { + return ENHANCER_ORDER; + } + + @Override + public void enhance(@Nonnull ComponentRegistry componentRegistry) { + // Register default segment factories for embedded mode (can be overridden) + componentRegistry.registerIfNotPresent( + TenantCommandSegmentFactory.class, + config -> tenant -> defaultCommandBusSegment(config, tenant) + ); + componentRegistry.registerIfNotPresent( + TenantQuerySegmentFactory.class, + config -> tenant -> defaultQueryBusSegment(config, tenant) + ); + componentRegistry.registerIfNotPresent( + TenantEventSegmentFactory.class, + config -> tenant -> defaultEventStoreSegment(config, tenant) + ); + + // Register decorator to replace CommandBus with MultiTenantCommandBus + // Uses decoration order from MultiTenantCommandBus.DECORATION_ORDER + componentRegistry.registerDecorator( + CommandBus.class, + MultiTenantCommandBus.DECORATION_ORDER, + (config, name, delegate) -> createMultiTenantCommandBus(config, delegate) + ); + + // Register decorator to replace QueryBus with MultiTenantQueryBus + // Uses decoration order from MultiTenantQueryBus.DECORATION_ORDER + componentRegistry.registerDecorator( + QueryBus.class, + MultiTenantQueryBus.DECORATION_ORDER, + (config, name, delegate) -> createMultiTenantQueryBus(config, delegate) + ); + + // Register decorator to replace EventStore with MultiTenantEventStore + // Uses decoration order from MultiTenantEventStore.DECORATION_ORDER + componentRegistry.registerDecorator( + EventStore.class, + MultiTenantEventStore.DECORATION_ORDER, + (config, name, delegate) -> createMultiTenantEventStore(config, delegate) + ); + + // Register TenantEventStoreProvider to allow components to access tenant segments + // without depending on the concrete MultiTenantEventStore type (which may be decorated) + componentRegistry.registerComponent( + TenantEventStoreProvider.class, + config -> { + // Ensure EventStore is resolved first, which triggers the decorator chain + // and populates multiTenantEventStoreInstance + config.getComponent(EventStore.class); + return multiTenantEventStoreInstance; + } + ); + } + + @SuppressWarnings("unchecked") + private CommandBus createMultiTenantCommandBus(Configuration config, CommandBus delegate) { + // Only wrap if we have both a segment factory and resolver configured + if (!config.hasComponent(TenantCommandSegmentFactory.class) || + !config.hasComponent(TargetTenantResolver.class)) { + return delegate; + } + + TenantCommandSegmentFactory segmentFactory = config.getComponent(TenantCommandSegmentFactory.class); + TargetTenantResolver resolver = config.getComponent(TargetTenantResolver.class); + + MultiTenantCommandBus multiTenantBus = MultiTenantCommandBus.builder() + .tenantSegmentFactory(segmentFactory) + .targetTenantResolver(resolver) + .build(); + + registerTenantsIfProviderAvailable(config, multiTenantBus); + return multiTenantBus; + } + + @SuppressWarnings("unchecked") + private QueryBus createMultiTenantQueryBus(Configuration config, QueryBus delegate) { + // Only wrap if we have both a segment factory and resolver configured + if (!config.hasComponent(TenantQuerySegmentFactory.class) || + !config.hasComponent(TargetTenantResolver.class)) { + return delegate; + } + + TenantQuerySegmentFactory segmentFactory = config.getComponent(TenantQuerySegmentFactory.class); + TargetTenantResolver resolver = config.getComponent(TargetTenantResolver.class); + + MultiTenantQueryBus multiTenantBus = MultiTenantQueryBus.builder() + .tenantSegmentFactory(segmentFactory) + .targetTenantResolver(resolver) + .build(); + + registerTenantsIfProviderAvailable(config, multiTenantBus); + return multiTenantBus; + } + + @SuppressWarnings("unchecked") + private EventStore createMultiTenantEventStore(Configuration config, EventStore delegate) { + // Only wrap if we have both a segment factory and resolver configured + if (!config.hasComponent(TenantEventSegmentFactory.class) || + !config.hasComponent(TargetTenantResolver.class)) { + return delegate; + } + + TenantEventSegmentFactory segmentFactory = config.getComponent(TenantEventSegmentFactory.class); + TargetTenantResolver resolver = config.getComponent(TargetTenantResolver.class); + + MultiTenantEventStore multiTenantStore = MultiTenantEventStore.builder() + .tenantSegmentFactory(segmentFactory) + .targetTenantResolver(resolver) + .build(); + + // Store the instance for direct component lookup + this.multiTenantEventStoreInstance = multiTenantStore; + + registerTenantsIfProviderAvailable(config, multiTenantStore); + return multiTenantStore; + } + + private void registerTenantsIfProviderAvailable(Configuration config, MultiTenantAwareComponent component) { + if (config.hasComponent(TenantProvider.class)) { + TenantProvider tenantProvider = config.getComponent(TenantProvider.class); + tenantProvider.subscribe(component); + tenantProvider.getTenants().forEach(component::registerTenant); + } + } + + /** + * Creates a default {@link CommandBus} for the given tenant. + *

    + * Returns a {@link TenantAwareCommandBus} wrapping a {@link SimpleCommandBus}. + * The wrapper ensures that command messages are added to the processing context, + * which is required for multi-tenant event store operations. + *

    + * Uses the configured {@link UnitOfWorkFactory} and {@link TransactionManager} from + * the main configuration to ensure tenant command buses have the same interceptors + * and lifecycle handlers as the main application. + * + * @param config the configuration to use for component resolution + * @param tenant the tenant for which to create the command bus + * @return a new tenant-aware {@link CommandBus} for the tenant + */ + private CommandBus defaultCommandBusSegment(Configuration config, TenantDescriptor tenant) { + SimpleCommandBus simpleCommandBus = new SimpleCommandBus( + config.getComponent(UnitOfWorkFactory.class), + config.getOptionalComponent(TransactionManager.class) + .map(tm -> (ProcessingLifecycleHandlerRegistrar) tm) + .map(List::of) + .orElse(Collections.emptyList()) + ); + return new TenantAwareCommandBus(simpleCommandBus); + } + + /** + * Creates a default {@link QueryBus} for the given tenant. + *

    + * Returns a new {@link SimpleQueryBus} instance using the configured {@link UnitOfWorkFactory}. + * This ensures tenant query buses have the same interceptors and lifecycle handlers + * as the main application. + * + * @param config the configuration to use for component resolution + * @param tenant the tenant for which to create the query bus + * @return a new {@link SimpleQueryBus} for the tenant + */ + private QueryBus defaultQueryBusSegment(Configuration config, TenantDescriptor tenant) { + return new SimpleQueryBus(config.getComponent(UnitOfWorkFactory.class)); + } + + /** + * Creates a default {@link EventStore} for the given tenant. + *

    + * Returns a new {@link StorageEngineBackedEventStore} with an {@link InMemoryEventStorageEngine}, + * wrapped in an {@link InterceptingEventStore} to apply dispatch interceptors (including + * correlation data propagation). + *

    + * This is suitable for testing and development, but not for production use as events + * are not persisted. + * + * @param config the configuration to use for component resolution + * @param tenant the tenant for which to create the event store + * @return a new in-memory {@link EventStore} for the tenant with interception + */ + private EventStore defaultEventStoreSegment(Configuration config, TenantDescriptor tenant) { + EventStore rawEventStore = new StorageEngineBackedEventStore( + new InMemoryEventStorageEngine(), + new SimpleEventBus(), + new AnnotationBasedTagResolver() + ); + + // Wrap with interceptors to ensure correlation data (including tenant) is applied + List> dispatchInterceptors = + config.getComponent(DispatchInterceptorRegistry.class).eventInterceptors(config); + + return dispatchInterceptors.isEmpty() + ? rawEventStore + : new InterceptingEventStore(rawEventStore, dispatchInterceptors); + } +} diff --git a/multitenancy/src/main/java/org/axonframework/extension/multitenancy/core/configuration/MultiTenancyConfigurer.java b/multitenancy/src/main/java/org/axonframework/extension/multitenancy/core/configuration/MultiTenancyConfigurer.java new file mode 100644 index 0000000..c5a48e4 --- /dev/null +++ b/multitenancy/src/main/java/org/axonframework/extension/multitenancy/core/configuration/MultiTenancyConfigurer.java @@ -0,0 +1,420 @@ +/* + * Copyright (c) 2010-2025. Axon Framework + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.axonframework.extension.multitenancy.core.configuration; + +import jakarta.annotation.Nonnull; +import org.axonframework.common.configuration.ApplicationConfigurer; +import org.axonframework.common.configuration.AxonConfiguration; +import org.axonframework.common.configuration.ComponentBuilder; +import org.axonframework.common.configuration.ComponentRegistry; +import org.axonframework.common.configuration.LifecycleRegistry; +import org.axonframework.extension.multitenancy.core.TenantConnectPredicate; +import org.axonframework.extension.multitenancy.core.TenantDescriptor; +import org.axonframework.extension.multitenancy.core.TenantProvider; +import org.axonframework.extension.multitenancy.core.TargetTenantResolver; +import org.axonframework.extension.multitenancy.eventsourcing.eventstore.TenantEventSegmentFactory; +import org.axonframework.extension.multitenancy.messaging.commandhandling.TenantCommandSegmentFactory; +import org.axonframework.extension.multitenancy.core.TenantComponentFactory; +import org.axonframework.extension.multitenancy.core.TenantComponentRegistry; +import org.axonframework.extension.multitenancy.messaging.core.unitofwork.annotation.TenantAwareProcessingContextResolverFactory; +import org.axonframework.extension.multitenancy.messaging.core.annotation.TenantComponentResolverFactory; +import org.axonframework.extension.multitenancy.messaging.eventhandling.processing.TenantEventProcessorSegmentFactory; +import org.axonframework.extension.multitenancy.messaging.queryhandling.TenantQuerySegmentFactory; +import org.axonframework.messaging.commandhandling.CommandBus; +import org.axonframework.messaging.core.Message; +import org.axonframework.messaging.core.annotation.MultiParameterResolverFactory; +import org.axonframework.messaging.core.configuration.MessagingConfigurer; +import org.axonframework.messaging.core.configuration.reflection.ParameterResolverFactoryUtils; +import org.axonframework.messaging.queryhandling.QueryBus; + +import java.util.ArrayList; +import java.util.List; +import java.util.function.BiConsumer; +import java.util.function.Consumer; +import java.util.function.Function; + +import static java.util.Objects.requireNonNull; + +/** + * The multitenancy {@link ApplicationConfigurer} of Axon Framework's configuration API. + *

    + * Provides register operations for multi-tenant infrastructure components including + * {@link #registerTenantProvider(ComponentBuilder) tenant provider}, + * {@link #registerTargetTenantResolver(ComponentBuilder) tenant resolver}, + * and tenant segment factories for commands, queries, events, and event processors. + *

    + * This configurer enhances a {@link MessagingConfigurer} by replacing standard infrastructure + * components with their multi-tenant equivalents. + *

    + * Example usage: + * 

    
+ *     MultiTenancyConfigurer.enhance(MessagingConfigurer.create())
+ *                           .registerTenantProvider(config -> myTenantProvider)
+ *                           .registerTargetTenantResolver(config -> new MetadataBasedTenantResolver())
+ *                           .registerCommandBusSegmentFactory(config -> tenant -> createBusForTenant(tenant))
+ *                           .build()
+ *                           .start();
+ *
    + * + * @author Stefan Dragisic + * @author Steven van Beelen + * @since 5.0.0 + */ +public class MultiTenancyConfigurer implements ApplicationConfigurer { + + private final ApplicationConfigurer delegate; + private final List> tenantComponentRegistrations = new ArrayList<>(); + private boolean resolverFactoryRegistered = false; + + /** + * Holds a tenant component registration: the type and its factory. + */ + private record TenantComponentRegistration(Class componentType, TenantComponentFactory factory) { + } + + /** + * Constructs a {@code MultiTenancyConfigurer} based on the given {@code delegate}. + * + * @param delegate The delegate {@code ApplicationConfigurer} the {@code MultiTenancyConfigurer} is based on. + */ + private MultiTenancyConfigurer(@Nonnull ApplicationConfigurer delegate) { + this.delegate = requireNonNull(delegate, "The Application Configurer cannot be null."); + } + + /** + * Creates a MultiTenancyConfigurer that enhances an existing {@code ApplicationConfigurer}. + * This method is useful when applying multiple specialized Configurers to configure a single application. + * + * @param applicationConfigurer The {@code ApplicationConfigurer} to enhance with multi-tenancy configuration. + * @return The current instance of the {@code MultiTenancyConfigurer} for a fluent API. + */ + public static MultiTenancyConfigurer enhance(@Nonnull ApplicationConfigurer applicationConfigurer) { + MultiTenancyConfigurer configurer = new MultiTenancyConfigurer(applicationConfigurer); + configurer.componentRegistry(cr -> cr.registerEnhancer(new MultiTenancyConfigurationDefaults())); + // Register resolver factory early so modules built later can access tenant components. + // The factory creation lambda captures tenantComponentRegistrations by reference, + // so it will see all registrations made before build() is called. + configurer.ensureResolverFactoryRegistered(); + return configurer; + } + + /** + * Creates a MultiTenancyConfigurer that enhances a {@code MessagingConfigurer}. + * This is the typical entry point for multi-tenant applications. + * + * @param messagingConfigurer The {@code MessagingConfigurer} to enhance with multi-tenancy configuration. + * @return The current instance of the {@code MultiTenancyConfigurer} for a fluent API. + */ + public static MultiTenancyConfigurer enhance(@Nonnull MessagingConfigurer messagingConfigurer) { + return enhance((ApplicationConfigurer) messagingConfigurer); + } + + /** + * Registers the given {@link TenantProvider} factory in this {@code Configurer}. + *

    + * The {@code tenantProviderBuilder} receives the configuration as input and is expected to return a + * {@link TenantProvider} instance that manages the available tenants. + * + * @param tenantProviderBuilder The builder constructing the {@link TenantProvider}. + * @return The current instance of the {@code MultiTenancyConfigurer} for a fluent API. + */ + public MultiTenancyConfigurer registerTenantProvider( + @Nonnull ComponentBuilder tenantProviderBuilder + ) { + delegate.componentRegistry(cr -> cr.registerComponent(TenantProvider.class, tenantProviderBuilder)); + return this; + } + + /** + * Registers the given {@link TargetTenantResolver} factory in this {@code Configurer}. + *

    + * The resolver is used to determine which tenant a message should be routed to based on + * the message's metadata or payload. + * + * @param resolverBuilder The builder constructing the {@link TargetTenantResolver}. + * @return The current instance of the {@code MultiTenancyConfigurer} for a fluent API. + */ + @SuppressWarnings("unchecked") + public MultiTenancyConfigurer registerTargetTenantResolver( + @Nonnull ComponentBuilder> resolverBuilder + ) { + delegate.componentRegistry(cr -> cr.registerComponent( + (Class>) (Class) TargetTenantResolver.class, + resolverBuilder + )); + return this; + } + + /** + * Registers the given {@link TenantConnectPredicate} factory in this {@code Configurer}. + *

    + * The predicate is used to filter which tenants should be connected to dynamically. + * + * @param predicateBuilder The builder constructing the {@link TenantConnectPredicate}. + * @return The current instance of the {@code MultiTenancyConfigurer} for a fluent API. + */ + public MultiTenancyConfigurer registerTenantConnectPredicate( + @Nonnull ComponentBuilder predicateBuilder + ) { + delegate.componentRegistry(cr -> cr.registerComponent(TenantConnectPredicate.class, predicateBuilder)); + return this; + } + + /** + * Registers the given {@link TenantCommandSegmentFactory} factory in this {@code Configurer}. + *

    + * The factory creates {@link CommandBus} instances for each tenant. + * + * @param factoryBuilder The builder constructing the {@link TenantCommandSegmentFactory}. + * @return The current instance of the {@code MultiTenancyConfigurer} for a fluent API. + */ + public MultiTenancyConfigurer registerCommandBusSegmentFactory( + @Nonnull ComponentBuilder factoryBuilder + ) { + delegate.componentRegistry(cr -> cr.registerComponent(TenantCommandSegmentFactory.class, factoryBuilder)); + return this; + } + + /** + * Registers the given {@link TenantQuerySegmentFactory} factory in this {@code Configurer}. + *

    + * The factory creates {@link QueryBus} instances for each tenant. + * + * @param factoryBuilder The builder constructing the {@link TenantQuerySegmentFactory}. + * @return The current instance of the {@code MultiTenancyConfigurer} for a fluent API. + */ + public MultiTenancyConfigurer registerQueryBusSegmentFactory( + @Nonnull ComponentBuilder factoryBuilder + ) { + delegate.componentRegistry(cr -> cr.registerComponent(TenantQuerySegmentFactory.class, factoryBuilder)); + return this; + } + + /** + * Registers the given {@link TenantEventSegmentFactory} factory in this {@code Configurer}. + *

    + * The factory creates event store instances for each tenant. + * + * @param factoryBuilder The builder constructing the {@link TenantEventSegmentFactory}. + * @return The current instance of the {@code MultiTenancyConfigurer} for a fluent API. + */ + public MultiTenancyConfigurer registerEventStoreSegmentFactory( + @Nonnull ComponentBuilder factoryBuilder + ) { + delegate.componentRegistry(cr -> cr.registerComponent(TenantEventSegmentFactory.class, factoryBuilder)); + return this; + } + + /** + * Registers the given {@link TenantEventProcessorSegmentFactory} factory in this {@code Configurer}. + *

    + * The factory creates event processor instances for each tenant. + * + * @param factoryBuilder The builder constructing the {@link TenantEventProcessorSegmentFactory}. + * @return The current instance of the {@code MultiTenancyConfigurer} for a fluent API. + */ + public MultiTenancyConfigurer registerEventProcessorSegmentFactory( + @Nonnull ComponentBuilder factoryBuilder + ) { + delegate.componentRegistry(cr -> cr.registerComponent( + TenantEventProcessorSegmentFactory.class, factoryBuilder + )); + return this; + } + + /** + * Registers a tenant-scoped component that will be created per-tenant and injected + * into event handlers, query handlers, and other message handlers. + *

    + * The factory receives a {@link org.axonframework.extension.multitenancy.core.TenantDescriptor} + * and should return a tenant-specific instance of the component. Components are created lazily + * on first access and cached per tenant. + *

    + * Example usage: + * 

    {@code
+     * MultiTenancyConfigurer.enhance(configurer)
+     *     .tenantComponent(OrderRepository.class, tenant -> new InMemoryOrderRepository())
+     *     .tenantComponent(MetricsService.class, tenant -> new TenantMetrics(tenant.tenantId()));
+     * }
    + *

    + * Handlers can then receive the tenant-scoped component via parameter injection: + * 

    {@code
+     * @EventHandler
+     * void on(OrderCreatedEvent event, OrderRepository repository) {
+     *     repository.save(new OrderProjection(event));
+     * }
+     * }
    + * + * @param componentType The class of the component to register + * @param factory The factory that creates tenant-specific instances + * @param The component type + * @return The current instance of the {@code MultiTenancyConfigurer} for a fluent API. + */ + public MultiTenancyConfigurer tenantComponent( + @Nonnull Class componentType, + @Nonnull TenantComponentFactory factory + ) { + requireNonNull(componentType, "The component type must not be null."); + requireNonNull(factory, "The component factory must not be null."); + tenantComponentRegistrations.add(new TenantComponentRegistration<>(componentType, factory)); + ensureResolverFactoryRegistered(); + return this; + } + + /** + * Registers a tenant-scoped component with a custom cleanup callback. + *

    + * This overload allows specifying explicit cleanup logic for components that need + * special handling when a tenant is removed. For components that implement + * {@link AutoCloseable}, consider using {@link #tenantComponent(Class, TenantComponentFactory)} + * which handles cleanup automatically. + *

    + * Example usage: + * 

    {@code
+     * MultiTenancyConfigurer.enhance(configurer)
+     *     .tenantComponent(
+     *         ConnectionPool.class,
+     *         tenant -> createPoolForTenant(tenant),
+     *         (tenant, pool) -> {
+     *             pool.drain();
+     *             pool.close();
+     *             logger.info("Closed pool for tenant {}", tenant.tenantId());
+     *         }
+     *     );
+     * }
    + * + * @param componentType The class of the component to register + * @param factory The factory that creates tenant-specific instances + * @param cleanup The cleanup callback invoked when a tenant is removed + * @param The component type + * @return The current instance of the {@code MultiTenancyConfigurer} for a fluent API. + */ + public MultiTenancyConfigurer tenantComponent( + @Nonnull Class componentType, + @Nonnull Function factory, + @Nonnull BiConsumer cleanup + ) { + requireNonNull(componentType, "The component type must not be null."); + requireNonNull(factory, "The component factory must not be null."); + requireNonNull(cleanup, "The cleanup callback must not be null."); + + // Wrap in TenantComponentFactory with custom cleanup + TenantComponentFactory wrappedFactory = new TenantComponentFactory<>() { + @Override + public T apply(TenantDescriptor tenant) { + return factory.apply(tenant); + } + + @Override + public void cleanup(TenantDescriptor tenant, T component) { + cleanup.accept(tenant, component); + } + }; + + tenantComponentRegistrations.add(new TenantComponentRegistration<>(componentType, wrappedFactory)); + ensureResolverFactoryRegistered(); + return this; + } + + /** + * Registers the parameter resolver factories for tenant-scoped components. + * This is called automatically when the first tenant component is registered. + *

    + * Registers two parameter resolver factories: + *

      + *
    1. {@link TenantComponentResolverFactory} - Resolves tenant-scoped component parameters
      2. + *
    2. {@link TenantAwareProcessingContextResolverFactory} - Wraps {@code ProcessingContext} + * parameters with tenant-aware functionality for {@code context.component()} access
      3. + *
    + *

    + * Uses {@link ParameterResolverFactoryUtils} to properly integrate with existing + * parameter resolver factories via {@link org.axonframework.messaging.core.annotation.MultiParameterResolverFactory}. + */ + private void ensureResolverFactoryRegistered() { + if (resolverFactoryRegistered) { + return; + } + resolverFactoryRegistered = true; + + // Register a single ParameterResolverFactory that creates both factories + // This avoids circular dependency issues when resolving components + delegate.componentRegistry(cr -> ParameterResolverFactoryUtils.registerToComponentRegistry( + cr, + config -> { + // Get the tenant resolver for both factories + TargetTenantResolver tenantResolver = config.getComponent(TargetTenantResolver.class); + + // Create the TenantComponentResolverFactory + TenantComponentResolverFactory componentFactory = new TenantComponentResolverFactory(tenantResolver); + + // Register all tenant components in the factory + for (TenantComponentRegistration registration : tenantComponentRegistrations) { + registerComponentInFactory(componentFactory, registration, config); + } + + // Create the TenantAwareProcessingContextResolverFactory + TenantAwareProcessingContextResolverFactory contextFactory = + new TenantAwareProcessingContextResolverFactory(componentFactory, tenantResolver); + + // Return a MultiParameterResolverFactory containing both + return MultiParameterResolverFactory.ordered(componentFactory, contextFactory); + } + )); + } + + /** + * Helper method to register a component in the resolver factory with proper typing. + */ + @SuppressWarnings("unchecked") + private void registerComponentInFactory( + TenantComponentResolverFactory resolverFactory, + TenantComponentRegistration registration, + org.axonframework.common.configuration.Configuration config + ) { + TenantComponentRegistry registry = resolverFactory.registerComponent( + registration.componentType(), + registration.factory() + ); + + // Subscribe registry to tenant provider for lifecycle management + TenantProvider tenantProvider = config.getComponent(TenantProvider.class); + if (tenantProvider != null) { + tenantProvider.subscribe(registry); + tenantProvider.getTenants().forEach(registry::registerTenant); + } + } + + @Override + public MultiTenancyConfigurer componentRegistry(@Nonnull Consumer componentRegistrar) { + delegate.componentRegistry( + requireNonNull(componentRegistrar, "The component registrar must not be null.") + ); + return this; + } + + @Override + public MultiTenancyConfigurer lifecycleRegistry(@Nonnull Consumer lifecycleRegistrar) { + delegate.lifecycleRegistry( + requireNonNull(lifecycleRegistrar, "The lifecycle registrar must not be null.") + ); + return this; + } + + @Override + public AxonConfiguration build() { + return delegate.build(); + } +} diff --git a/multitenancy/src/main/java/org/axonframework/extensions/multitenancy/configuration/MultiTenantEventProcessorPredicate.java b/multitenancy/src/main/java/org/axonframework/extension/multitenancy/core/configuration/MultiTenantEventProcessorPredicate.java similarity index 82% rename from multitenancy/src/main/java/org/axonframework/extensions/multitenancy/configuration/MultiTenantEventProcessorPredicate.java rename to multitenancy/src/main/java/org/axonframework/extension/multitenancy/core/configuration/MultiTenantEventProcessorPredicate.java index 1736f2b..f9aab3a 100644 --- a/multitenancy/src/main/java/org/axonframework/extensions/multitenancy/configuration/MultiTenantEventProcessorPredicate.java +++ b/multitenancy/src/main/java/org/axonframework/extension/multitenancy/core/configuration/MultiTenantEventProcessorPredicate.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 2010-2024. Axon Framework + * Copyright (c) 2010-2025. Axon Framework * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -13,7 +13,7 @@ * See the License for the specific language governing permissions and * limitations under the License. */ -package org.axonframework.extensions.multitenancy.configuration; +package org.axonframework.extension.multitenancy.core.configuration; import java.util.function.Predicate; @@ -24,23 +24,24 @@ * considered as multi-tenant. The input to the predicate is the name of the event processor. * * @author Stefan Dragisic - * @since 4.9.3 + * @author Theo Emanuelsson + * @since 5.0.0 */ public interface MultiTenantEventProcessorPredicate extends Predicate { /** - * A {@link MultiTenantEventProcessorPredicate} resulting in {@link true} for any tenant name. + * A {@link MultiTenantEventProcessorPredicate} resulting in {@code true} for any processor name. * - * @return A {@link MultiTenantEventProcessorPredicate} resulting in {@link true} for any tenant name. + * @return A {@link MultiTenantEventProcessorPredicate} resulting in {@code true} for any processor name. */ static MultiTenantEventProcessorPredicate enableMultiTenancy() { return name -> true; } /** - * A {@link MultiTenantEventProcessorPredicate} resulting in {@link false} for any tenant name. + * A {@link MultiTenantEventProcessorPredicate} resulting in {@code false} for any processor name. * - * @return A {@link MultiTenantEventProcessorPredicate} resulting in {@link false} for any tenant name. + * @return A {@link MultiTenantEventProcessorPredicate} resulting in {@code false} for any processor name. */ static MultiTenantEventProcessorPredicate disableMultiTenancy() { return name -> false; diff --git a/multitenancy/src/main/java/org/axonframework/extension/multitenancy/eventsourcing/eventstore/JpaTenantEventSegmentFactory.java b/multitenancy/src/main/java/org/axonframework/extension/multitenancy/eventsourcing/eventstore/JpaTenantEventSegmentFactory.java new file mode 100644 index 0000000..ec5bbd2 --- /dev/null +++ b/multitenancy/src/main/java/org/axonframework/extension/multitenancy/eventsourcing/eventstore/JpaTenantEventSegmentFactory.java @@ -0,0 +1,158 @@ +/* + * Copyright (c) 2010-2025. Axon Framework + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.axonframework.extension.multitenancy.eventsourcing.eventstore; + +import jakarta.annotation.Nonnull; +import jakarta.persistence.EntityManagerFactory; +import org.axonframework.common.jpa.EntityManagerProvider; +import org.axonframework.messaging.core.unitofwork.transaction.TransactionManager; +import org.axonframework.messaging.eventhandling.conversion.EventConverter; +import org.axonframework.eventsourcing.eventstore.AnnotationBasedTagResolver; +import org.axonframework.eventsourcing.eventstore.EventStore; +import org.axonframework.eventsourcing.eventstore.StorageEngineBackedEventStore; +import org.axonframework.eventsourcing.eventstore.TagResolver; +import org.axonframework.eventsourcing.eventstore.jpa.AggregateBasedJpaEventStorageEngine; +import org.axonframework.eventsourcing.eventstore.jpa.AggregateBasedJpaEventStorageEngineConfiguration; +import org.axonframework.extension.multitenancy.core.TenantDescriptor; +import org.axonframework.messaging.eventhandling.SimpleEventBus; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +import java.util.Map; +import java.util.Objects; +import java.util.concurrent.ConcurrentHashMap; +import java.util.function.Function; +import java.util.function.UnaryOperator; + +/** + * A {@link TenantEventSegmentFactory} that creates JPA-backed {@link EventStore} instances for each tenant. + *

    + * This factory uses a provider function to obtain tenant-specific {@link EntityManagerFactory} instances. + * Each tenant gets its own {@link EventStore} backed by {@link AggregateBasedJpaEventStorageEngine}, + * ensuring data isolation between tenants. + *

    + * Event stores are cached per tenant to avoid creating multiple instances for the same tenant. + *

    + * Example usage: + * 

    {@code
+ * JpaTenantEventSegmentFactory factory = new JpaTenantEventSegmentFactory(
+ *     tenant -> getEntityManagerFactoryForTenant(tenant),
+ *     transactionManager,
+ *     eventConverter
+ * );
+ *
+ * // Register it with the multi-tenancy configurer
+ * MultiTenancyConfigurer.enhance(configurer)
+ *     .registerComponent(TenantEventSegmentFactory.class, config -> factory);
+ * }
    + * + * @author Theo Emanuelsson + * @since 5.0.0 + * @see TenantEventSegmentFactory + * @see AggregateBasedJpaEventStorageEngine + */ +public class JpaTenantEventSegmentFactory implements TenantEventSegmentFactory { + + private static final Logger logger = LoggerFactory.getLogger(JpaTenantEventSegmentFactory.class); + + private final Function emfProvider; + private final TransactionManager transactionManager; + private final EventConverter eventConverter; + private final UnaryOperator configurer; + private final TagResolver tagResolver; + private final Map eventStores = new ConcurrentHashMap<>(); + + /** + * Creates a new {@link JpaTenantEventSegmentFactory} with the given dependencies and default configuration. + * + * @param emfProvider Function that provides an {@link EntityManagerFactory} for each tenant. + * @param transactionManager The transaction manager for coordinating transactions. + * @param eventConverter The converter for serializing/deserializing events. + */ + public JpaTenantEventSegmentFactory( + @Nonnull Function emfProvider, + @Nonnull TransactionManager transactionManager, + @Nonnull EventConverter eventConverter + ) { + this(emfProvider, transactionManager, eventConverter, c -> c, new AnnotationBasedTagResolver()); + } + + /** + * Creates a new {@link JpaTenantEventSegmentFactory} with the given dependencies and custom configuration. + * + * @param emfProvider Function that provides an {@link EntityManagerFactory} for each tenant. + * @param transactionManager The transaction manager for coordinating transactions. + * @param eventConverter The converter for serializing/deserializing events. + * @param configurer Function to customize the {@link AggregateBasedJpaEventStorageEngineConfiguration}. + * @param tagResolver The resolver for event tags. + */ + public JpaTenantEventSegmentFactory( + @Nonnull Function emfProvider, + @Nonnull TransactionManager transactionManager, + @Nonnull EventConverter eventConverter, + @Nonnull UnaryOperator configurer, + @Nonnull TagResolver tagResolver + ) { + this.emfProvider = Objects.requireNonNull(emfProvider, + "EntityManagerFactory provider must not be null"); + this.transactionManager = Objects.requireNonNull(transactionManager, + "TransactionManager must not be null"); + this.eventConverter = Objects.requireNonNull(eventConverter, + "EventConverter must not be null"); + this.configurer = Objects.requireNonNull(configurer, + "Configurer must not be null"); + this.tagResolver = Objects.requireNonNull(tagResolver, + "TagResolver must not be null"); + } + + @Override + public EventStore apply(TenantDescriptor tenant) { + return eventStores.computeIfAbsent(tenant, this::createEventStore); + } + + private EventStore createEventStore(TenantDescriptor tenant) { + logger.debug("Creating EventStore segment for tenant [{}]", tenant.tenantId()); + + EntityManagerFactory emf = emfProvider.apply(tenant); + EntityManagerProvider entityManagerProvider = emf::createEntityManager; + + AggregateBasedJpaEventStorageEngine storageEngine = new AggregateBasedJpaEventStorageEngine( + entityManagerProvider, + transactionManager, + eventConverter, + configurer + ); + + EventStore eventStore = new StorageEngineBackedEventStore( + storageEngine, + new SimpleEventBus(), + tagResolver + ); + + logger.info("Created EventStore segment for tenant [{}]", tenant.tenantId()); + return eventStore; + } + + /** + * Returns the number of event stores currently cached. + * Primarily for testing purposes. + * + * @return The number of cached event stores. + */ + int eventStoreCount() { + return eventStores.size(); + } +} diff --git a/multitenancy/src/main/java/org/axonframework/extension/multitenancy/eventsourcing/eventstore/MultiTenantEventStore.java b/multitenancy/src/main/java/org/axonframework/extension/multitenancy/eventsourcing/eventstore/MultiTenantEventStore.java new file mode 100644 index 0000000..6ab97c6 --- /dev/null +++ b/multitenancy/src/main/java/org/axonframework/extension/multitenancy/eventsourcing/eventstore/MultiTenantEventStore.java @@ -0,0 +1,303 @@ +/* + * Copyright (c) 2010-2025. Axon Framework + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.axonframework.extension.multitenancy.eventsourcing.eventstore; + +import jakarta.annotation.Nonnull; +import jakarta.annotation.Nullable; +import org.axonframework.common.AxonConfigurationException; +import org.axonframework.common.Registration; +import org.axonframework.common.infra.ComponentDescriptor; +import org.axonframework.eventsourcing.eventstore.EventStore; +import org.axonframework.eventsourcing.eventstore.EventStoreTransaction; +import org.axonframework.extension.multitenancy.core.MultiTenantAwareComponent; +import org.axonframework.extension.multitenancy.core.NoSuchTenantException; +import org.axonframework.extension.multitenancy.core.TargetTenantResolver; +import org.axonframework.extension.multitenancy.core.TenantDescriptor; +import org.axonframework.messaging.core.Message; +import org.axonframework.messaging.core.MessageStream; +import org.axonframework.messaging.core.unitofwork.ProcessingContext; +import org.axonframework.messaging.eventhandling.EventMessage; +import org.axonframework.messaging.eventstreaming.StreamingCondition; +import org.axonframework.messaging.eventhandling.processing.streaming.token.TrackingToken; + +import java.time.Instant; +import java.util.List; +import java.util.Map; +import java.util.concurrent.CompletableFuture; +import java.util.concurrent.ConcurrentHashMap; +import java.util.concurrent.CopyOnWriteArrayList; +import java.util.function.BiFunction; + +import static org.axonframework.common.BuilderUtils.assertNonNull; + +/** + * Tenant aware implementation of the {@link EventStore}. + *

    + * Tenant-specific {@code EventStore} segments are resolved from the {@link EventMessage#metadata() event's metadata}. + * The {@link #open(StreamingCondition, ProcessingContext)} operation throws an + * {@link UnsupportedOperationException} as multi-tenant streaming requires combining streams from all tenants, + * which should be handled at a higher level. + * + * @author Stefan Dragisic + * @author Steven van Beelen + * @author Theo Emanuelsson + * @since 5.0.0 + */ +public class MultiTenantEventStore implements EventStore, MultiTenantAwareComponent, TenantEventStoreProvider { + + /** + * The order in which the {@link MultiTenantEventStore} is applied as a decorator to the {@link EventStore}. + *

    + * Uses a lower order than {@link InterceptingEventStore} (which is at {@code Integer.MIN_VALUE + 50}) + * to ensure correlation data (including tenant info) is applied BEFORE multi-tenant routing. + */ + public static final int DECORATION_ORDER = Integer.MIN_VALUE + 25; + + private final Map tenantSegments = new ConcurrentHashMap<>(); + private final List, ProcessingContext, CompletableFuture>> eventsBatchConsumers = + new CopyOnWriteArrayList<>(); + private final Map subscribeRegistrations = new ConcurrentHashMap<>(); + + private final TenantEventSegmentFactory tenantSegmentFactory; + private final TargetTenantResolver targetTenantResolver; + + /** + * Instantiate a {@link MultiTenantEventStore} based on the given {@link Builder builder}. + * + * @param builder The {@link Builder} used to instantiate a {@link MultiTenantEventStore} instance with. + */ + protected MultiTenantEventStore(Builder builder) { + builder.validate(); + this.tenantSegmentFactory = builder.tenantSegmentFactory; + this.targetTenantResolver = builder.targetTenantResolver; + } + + /** + * Instantiate a builder to be able to construct a {@link MultiTenantEventStore} + *

    + * The {@link TenantEventSegmentFactory} and {@link TargetTenantResolver} are hard requirements and as such + * should be provided. + * + * @return A Builder to be able to create a {@link MultiTenantEventStore}. + */ + public static Builder builder() { + return new Builder(); + } + + @Override + public CompletableFuture publish(@Nullable ProcessingContext context, + @Nonnull List events) { + if (events.isEmpty()) { + return CompletableFuture.completedFuture(null); + } + EventStore tenantSegment = resolveTenant(events.get(0)); + return tenantSegment.publish(context, events); + } + + @Override + public Registration subscribe( + @Nonnull BiFunction, ProcessingContext, CompletableFuture> eventsBatchConsumer) { + eventsBatchConsumers.add(eventsBatchConsumer); + + tenantSegments.forEach((tenant, segment) -> subscribeRegistrations.computeIfAbsent( + tenant, t -> segment.subscribe(eventsBatchConsumer) + )); + + return () -> { + eventsBatchConsumers.remove(eventsBatchConsumer); + return subscribeRegistrations.values() + .stream() + .map(Registration::cancel) + .reduce((prev, acc) -> prev && acc) + .orElse(false); + }; + } + + @Override + public MessageStream open(@Nonnull StreamingCondition condition, + @Nullable ProcessingContext context) { + throw new UnsupportedOperationException( + "Multi-tenant event streaming is not directly supported. " + + "Use individual tenant segments or implement a multi-source stream combiner." + ); + } + + @Override + public EventStoreTransaction transaction(@Nonnull ProcessingContext processingContext) { + Message message = Message.fromContext(processingContext); + if (message == null) { + throw new IllegalStateException( + "Cannot create multi-tenant EventStoreTransaction: no message found in ProcessingContext. " + + "Ensure commands are dispatched through MultiTenantCommandBus, which adds the command " + + "message to the context for tenant resolution. If you're using a custom setup, wrap your " + + "CommandBus segments with TenantAwareCommandBus or manually add the message to the context " + + "using Message.addToContext()." + ); + } + + TenantDescriptor tenant = targetTenantResolver.resolveTenant(message, tenantSegments.keySet()); + EventStore tenantEventStore = tenantSegments.get(tenant); + if (tenantEventStore == null) { + throw NoSuchTenantException.forTenantId(tenant.tenantId()); + } + + return tenantEventStore.transaction(processingContext); + } + + @Override + public CompletableFuture firstToken(@Nullable ProcessingContext context) { + throw new UnsupportedOperationException( + "Multi-tenant token operations are not directly supported. " + + "Use individual tenant segments." + ); + } + + @Override + public CompletableFuture latestToken(@Nullable ProcessingContext context) { + throw new UnsupportedOperationException( + "Multi-tenant token operations are not directly supported. " + + "Use individual tenant segments." + ); + } + + @Override + public CompletableFuture tokenAt(@Nonnull Instant at, @Nullable ProcessingContext context) { + throw new UnsupportedOperationException( + "Multi-tenant token operations are not directly supported. " + + "Use individual tenant segments." + ); + } + + @Override + public void describeTo(@Nonnull ComponentDescriptor descriptor) { + descriptor.describeProperty("tenantSegments", tenantSegments); + } + + @Override + public Registration registerTenant(TenantDescriptor tenantDescriptor) { + EventStore tenantSegment = tenantSegmentFactory.apply(tenantDescriptor); + tenantSegments.putIfAbsent(tenantDescriptor, tenantSegment); + + return () -> { + EventStore delegate = unregisterTenant(tenantDescriptor); + return delegate != null; + }; + } + + @Override + public Registration registerAndStartTenant(TenantDescriptor tenantDescriptor) { + tenantSegments.computeIfAbsent(tenantDescriptor, k -> { + EventStore tenantSegment = tenantSegmentFactory.apply(tenantDescriptor); + + eventsBatchConsumers.forEach(consumer -> subscribeRegistrations.computeIfAbsent( + tenantDescriptor, t -> tenantSegment.subscribe(consumer) + )); + + return tenantSegment; + }); + + return () -> { + EventStore delegate = unregisterTenant(tenantDescriptor); + return delegate != null; + }; + } + + private EventStore unregisterTenant(TenantDescriptor tenantDescriptor) { + Registration remove = subscribeRegistrations.remove(tenantDescriptor); + if (remove != null) { + remove.cancel(); + } + return tenantSegments.remove(tenantDescriptor); + } + + private EventStore resolveTenant(Message message) { + TenantDescriptor tenantDescriptor = targetTenantResolver.resolveTenant(message, tenantSegments.keySet()); + EventStore tenantEventStore = tenantSegments.get(tenantDescriptor); + if (tenantEventStore == null) { + throw NoSuchTenantException.forTenantId(tenantDescriptor.tenantId()); + } + return tenantEventStore; + } + + /** + * Returns the tenant segments managed by this {@link MultiTenantEventStore}. + * + * @return The tenant segments managed by this {@link MultiTenantEventStore}. + */ + public Map tenantSegments() { + return tenantSegments; + } + + /** + * Builder class to instantiate a {@link MultiTenantEventStore}. + *

    + * The {@link TenantEventSegmentFactory} and {@link TargetTenantResolver} are hard requirements and as such + * should be provided. + */ + public static class Builder { + + protected TenantEventSegmentFactory tenantSegmentFactory; + protected TargetTenantResolver targetTenantResolver; + + /** + * Sets the {@link TenantEventSegmentFactory} used to build {@link EventStore} segment for given + * {@link TenantDescriptor}. + * + * @param tenantSegmentFactory tenant aware segment factory + * @return the current Builder instance, for fluent interfacing + */ + public Builder tenantSegmentFactory(TenantEventSegmentFactory tenantSegmentFactory) { + assertNonNull(tenantSegmentFactory, "The TenantEventSegmentFactory is a hard requirement"); + this.tenantSegmentFactory = tenantSegmentFactory; + return this; + } + + /** + * Sets the {@link TargetTenantResolver} used to resolve correct tenant segment based on {@link Message} + * message + * + * @param targetTenantResolver used to resolve correct tenant segment based on {@link Message} message + * @return the current Builder instance, for fluent interfacing + */ + public Builder targetTenantResolver(TargetTenantResolver targetTenantResolver) { + assertNonNull(targetTenantResolver, "The TargetTenantResolver is a hard requirement"); + this.targetTenantResolver = targetTenantResolver; + return this; + } + + /** + * Initializes a {@link MultiTenantEventStore} as specified through this Builder. + * + * @return a {@link MultiTenantEventStore} as specified through this Builder + */ + public MultiTenantEventStore build() { + return new MultiTenantEventStore(this); + } + + /** + * Validate whether the fields contained in this Builder as set accordingly. + * + * @throws AxonConfigurationException If one field is asserted to be incorrect according to the Builder's + * specifications. + */ + protected void validate() { + assertNonNull(tenantSegmentFactory, + "The TenantEventSegmentFactory is a hard requirement and should be provided"); + assertNonNull(targetTenantResolver, + "The TargetTenantResolver is a hard requirement and should be provided"); + } + } +} diff --git a/multitenancy/src/main/java/org/axonframework/extensions/multitenancy/components/eventstore/TenantEventSegmentFactory.java b/multitenancy/src/main/java/org/axonframework/extension/multitenancy/eventsourcing/eventstore/TenantEventSegmentFactory.java similarity index 80% rename from multitenancy/src/main/java/org/axonframework/extensions/multitenancy/components/eventstore/TenantEventSegmentFactory.java rename to multitenancy/src/main/java/org/axonframework/extension/multitenancy/eventsourcing/eventstore/TenantEventSegmentFactory.java index 801c223..66dd7d7 100644 --- a/multitenancy/src/main/java/org/axonframework/extensions/multitenancy/components/eventstore/TenantEventSegmentFactory.java +++ b/multitenancy/src/main/java/org/axonframework/extension/multitenancy/eventsourcing/eventstore/TenantEventSegmentFactory.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 2010-2023. Axon Framework + * Copyright (c) 2010-2025. Axon Framework * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -13,10 +13,10 @@ * See the License for the specific language governing permissions and * limitations under the License. */ -package org.axonframework.extensions.multitenancy.components.eventstore; +package org.axonframework.extension.multitenancy.eventsourcing.eventstore; import org.axonframework.eventsourcing.eventstore.EventStore; -import org.axonframework.extensions.multitenancy.components.TenantDescriptor; +import org.axonframework.extension.multitenancy.core.TenantDescriptor; import java.util.function.Function; @@ -25,7 +25,8 @@ * may be started automatically by the factory. * * @author Stefan Dragisic - * @since 4.6.0 + * @author Theo Emanuelsson + * @since 5.0.0 */ public interface TenantEventSegmentFactory extends Function { diff --git a/multitenancy/src/main/java/org/axonframework/extension/multitenancy/eventsourcing/eventstore/TenantEventStoreProvider.java b/multitenancy/src/main/java/org/axonframework/extension/multitenancy/eventsourcing/eventstore/TenantEventStoreProvider.java new file mode 100644 index 0000000..4400672 --- /dev/null +++ b/multitenancy/src/main/java/org/axonframework/extension/multitenancy/eventsourcing/eventstore/TenantEventStoreProvider.java @@ -0,0 +1,41 @@ +/* + * Copyright (c) 2010-2025. Axon Framework + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.axonframework.extension.multitenancy.eventsourcing.eventstore; + +import org.axonframework.eventsourcing.eventstore.EventStore; +import org.axonframework.extension.multitenancy.core.TenantDescriptor; + +import java.util.Map; + +/** + * Provides access to per-tenant {@link EventStore} segments. + *

    + * This interface abstracts the storage of tenant-specific event stores, allowing components + * like event processors to access tenant segments without depending on concrete implementations. + * This design ensures that decorator chains around {@code EventStore} don't affect component lookups. + * + * @author Theo Emanuelsson + * @since 5.0.0 + */ +public interface TenantEventStoreProvider { + + /** + * Returns the map of tenant descriptors to their corresponding {@link EventStore} segments. + * + * @return an unmodifiable view of the tenant segments map + */ + Map tenantSegments(); +} diff --git a/multitenancy/src/main/java/org/axonframework/extensions/multitenancy/components/commandhandeling/MultiTenantCommandBus.java b/multitenancy/src/main/java/org/axonframework/extension/multitenancy/messaging/commandhandling/MultiTenantCommandBus.java similarity index 50% rename from multitenancy/src/main/java/org/axonframework/extensions/multitenancy/components/commandhandeling/MultiTenantCommandBus.java rename to multitenancy/src/main/java/org/axonframework/extension/multitenancy/messaging/commandhandling/MultiTenantCommandBus.java index 194a9fd..a41ac4a 100644 --- a/multitenancy/src/main/java/org/axonframework/extensions/multitenancy/components/commandhandeling/MultiTenantCommandBus.java +++ b/multitenancy/src/main/java/org/axonframework/extension/multitenancy/messaging/commandhandling/MultiTenantCommandBus.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 2010-2023. Axon Framework + * Copyright (c) 2010-2025. Axon Framework * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -13,29 +13,28 @@ * See the License for the specific language governing permissions and * limitations under the License. */ -package org.axonframework.extensions.multitenancy.components.commandhandeling; +package org.axonframework.extension.multitenancy.messaging.commandhandling; -import org.axonframework.commandhandling.CommandBus; -import org.axonframework.commandhandling.CommandCallback; -import org.axonframework.commandhandling.CommandMessage; -import org.axonframework.commandhandling.GenericCommandResultMessage; +import jakarta.annotation.Nonnull; +import jakarta.annotation.Nullable; import org.axonframework.common.AxonConfigurationException; import org.axonframework.common.Registration; -import org.axonframework.extensions.multitenancy.components.MultiTenantAwareComponent; -import org.axonframework.extensions.multitenancy.components.MultiTenantDispatchInterceptorSupport; -import org.axonframework.extensions.multitenancy.components.MultiTenantHandlerInterceptorSupport; -import org.axonframework.extensions.multitenancy.components.NoSuchTenantException; -import org.axonframework.extensions.multitenancy.components.TargetTenantResolver; -import org.axonframework.extensions.multitenancy.components.TenantDescriptor; -import org.axonframework.messaging.MessageDispatchInterceptor; -import org.axonframework.messaging.MessageHandler; -import org.axonframework.messaging.MessageHandlerInterceptor; +import org.axonframework.common.infra.ComponentDescriptor; +import org.axonframework.extension.multitenancy.core.MultiTenantAwareComponent; +import org.axonframework.extension.multitenancy.core.NoSuchTenantException; +import org.axonframework.extension.multitenancy.core.TargetTenantResolver; +import org.axonframework.extension.multitenancy.core.TenantDescriptor; +import org.axonframework.messaging.commandhandling.CommandBus; +import org.axonframework.messaging.commandhandling.CommandHandler; +import org.axonframework.messaging.commandhandling.CommandMessage; +import org.axonframework.messaging.commandhandling.CommandResultMessage; +import org.axonframework.messaging.core.Message; +import org.axonframework.messaging.core.QualifiedName; +import org.axonframework.messaging.core.unitofwork.ProcessingContext; -import java.util.List; import java.util.Map; +import java.util.concurrent.CompletableFuture; import java.util.concurrent.ConcurrentHashMap; -import java.util.concurrent.CopyOnWriteArrayList; -import javax.annotation.Nonnull; import static org.axonframework.common.BuilderUtils.assertNonNull; @@ -45,28 +44,25 @@ * {@code CommandBus} instance is considered a "tenant". *

    * The {@code MultiTenantCommandBus} relies on a {@link TargetTenantResolver} to dispatch commands via resolved tenant - * segment of the {@code CommandBus}. {@link TenantCommandSegmentFactory} is as factory to create tenant segments with. + * segment of the {@code CommandBus}. {@link TenantCommandSegmentFactory} is a factory to create tenant segments with. * * @author Stefan Dragisic * @author Steven van Beelen - * @since 4.6.0 + * @author Theo Emanuelsson + * @since 5.0.0 */ -public class MultiTenantCommandBus implements - CommandBus, - MultiTenantAwareComponent, - MultiTenantDispatchInterceptorSupport, CommandBus>, - MultiTenantHandlerInterceptorSupport, CommandBus> { +public class MultiTenantCommandBus implements CommandBus, MultiTenantAwareComponent { - private final Map>> handlers = new ConcurrentHashMap<>(); + /** + * The order in which the {@link MultiTenantCommandBus} is applied as a decorator to the {@link CommandBus}. + */ + public static final int DECORATION_ORDER = Integer.MIN_VALUE + 50; + + private final Map handlers = new ConcurrentHashMap<>(); private final Map tenantSegments = new ConcurrentHashMap<>(); - private final Map subscribeRegistrations = new ConcurrentHashMap<>(); - private final List>> dispatchInterceptors = new CopyOnWriteArrayList<>(); - private final Map> dispatchInterceptorsRegistration = new ConcurrentHashMap<>(); - private final List>> handlerInterceptors = new CopyOnWriteArrayList<>(); - private final Map> handlerInterceptorsRegistration = new ConcurrentHashMap<>(); private final TenantCommandSegmentFactory tenantSegmentFactory; - private final TargetTenantResolver> targetTenantResolver; + private final TargetTenantResolver targetTenantResolver; /** * Instantiate a {@link MultiTenantCommandBus} based on the given {@link Builder builder}. @@ -92,42 +88,33 @@ public static Builder builder() { } @Override - public void dispatch(@Nonnull CommandMessage command) { - resolveTenant(command) - .dispatch(command); - } - - @Override - public void dispatch(@Nonnull CommandMessage command, - @Nonnull CommandCallback callback) { + public CompletableFuture dispatch(@Nonnull CommandMessage command, + @Nullable ProcessingContext processingContext) { try { - resolveTenant(command) - .dispatch(command, callback); + // Add command to context so downstream components (like EventStore) can resolve tenant + ProcessingContext contextWithMessage = processingContext != null + ? Message.addToContext(processingContext, command) + : null; + return resolveTenant(command).dispatch(command, contextWithMessage); } catch (NoSuchTenantException e) { - callback.onResult( - command, GenericCommandResultMessage.asCommandResultMessage(e) - ); + return CompletableFuture.failedFuture(e); } } @Override - public Registration subscribe(@Nonnull String commandName, - @Nonnull MessageHandler> handler) { - handlers.computeIfAbsent(commandName, k -> { - tenantSegments.forEach((tenant, segment) -> subscribeRegistrations.putIfAbsent( - tenant, segment.subscribe(commandName, handler) - )); - return handler; + public CommandBus subscribe(@Nonnull QualifiedName name, @Nonnull CommandHandler commandHandler) { + handlers.computeIfAbsent(name, k -> { + tenantSegments.forEach((tenant, segment) -> segment.subscribe(name, commandHandler)); + return commandHandler; }); - return () -> subscribeRegistrations.values() - .stream() - .map(Registration::cancel) - .reduce((prev, acc) -> prev && acc) - .orElse(false); + return this; } - - @Override + /** + * Returns the tenant segments managed by this {@code MultiTenantCommandBus}. + * + * @return A map of {@link TenantDescriptor} to {@link CommandBus} representing tenant segments. + */ public Map tenantSegments() { return tenantSegments; } @@ -144,22 +131,6 @@ public Registration registerTenant(TenantDescriptor tenantDescriptor) { } private CommandBus unregisterTenant(TenantDescriptor tenantDescriptor) { - List registrations = handlerInterceptorsRegistration.remove(tenantDescriptor); - if (registrations != null) { - registrations.forEach(Registration::cancel); - } - - registrations = dispatchInterceptorsRegistration.remove(tenantDescriptor); - if (registrations != null) { - registrations.forEach(Registration::cancel); - } - - //noinspection resource - Registration removed = subscribeRegistrations.remove(tenantDescriptor); - if (removed != null) { - removed.cancel(); - } - return tenantSegments.remove(tenantDescriptor); } @@ -168,20 +139,7 @@ public Registration registerAndStartTenant(TenantDescriptor tenantDescriptor) { tenantSegments.computeIfAbsent(tenantDescriptor, tenant -> { CommandBus tenantSegment = tenantSegmentFactory.apply(tenantDescriptor); - dispatchInterceptors.forEach(dispatchInterceptor -> - dispatchInterceptorsRegistration - .computeIfAbsent(tenant, t -> new CopyOnWriteArrayList<>()) - .add(tenantSegment.registerDispatchInterceptor( - dispatchInterceptor))); - - handlerInterceptors.forEach(handlerInterceptor -> - handlerInterceptorsRegistration - .computeIfAbsent(tenant, t -> new CopyOnWriteArrayList<>()) - .add(tenantSegment.registerHandlerInterceptor(handlerInterceptor))); - - handlers.forEach((commandName, handler) -> - subscribeRegistrations.putIfAbsent(tenantDescriptor, - tenantSegment.subscribe(commandName, handler))); + handlers.forEach((name, handler) -> tenantSegment.subscribe(name, handler)); return tenantSegment; }); @@ -192,33 +150,18 @@ public Registration registerAndStartTenant(TenantDescriptor tenantDescriptor) { }; } - private CommandBus resolveTenant(CommandMessage commandMessage) { + private CommandBus resolveTenant(CommandMessage commandMessage) { TenantDescriptor tenantDescriptor = targetTenantResolver.resolveTenant(commandMessage, tenantSegments.keySet()); CommandBus tenantCommandBus = tenantSegments.get(tenantDescriptor); if (tenantCommandBus == null) { - throw new NoSuchTenantException(tenantDescriptor.tenantId()); + throw NoSuchTenantException.forTenantId(tenantDescriptor.tenantId()); } return tenantCommandBus; } @Override - public List>> getDispatchInterceptors() { - return dispatchInterceptors; - } - - @Override - public Map> getDispatchInterceptorsRegistration() { - return dispatchInterceptorsRegistration; - } - - @Override - public List>> getHandlerInterceptors() { - return handlerInterceptors; - } - - @Override - public Map> getHandlerInterceptorsRegistration() { - return handlerInterceptorsRegistration; + public void describeTo(@Nonnull ComponentDescriptor descriptor) { + descriptor.describeProperty("tenantSegments", tenantSegments); } /** @@ -230,7 +173,7 @@ public Map> getHandlerInterceptorsRegistrat public static class Builder { protected TenantCommandSegmentFactory tenantSegmentFactory; - protected TargetTenantResolver> targetTenantResolver; + protected TargetTenantResolver targetTenantResolver; /** * Sets the {@link TenantCommandSegmentFactory} used to build {@link CommandBus} segment for given @@ -247,13 +190,13 @@ public Builder tenantSegmentFactory(TenantCommandSegmentFactory tenantSegmentFac /** * Sets the {@link TargetTenantResolver} used to resolve a {@link TenantDescriptor} based on a - * {@link CommandMessage}. Used to find the tenant-specific {@link CommandBus} segment. + * {@link Message}. Used to find the tenant-specific {@link CommandBus} segment. * - * @param targetTenantResolver The resolver of a {@link TenantDescriptor} based on a {@link CommandMessage}. + * @param targetTenantResolver The resolver of a {@link TenantDescriptor} based on a {@link Message}. * Used to find the tenant-specific {@link CommandBus} segment. * @return The current builder instance, for fluent interfacing. */ - public Builder targetTenantResolver(TargetTenantResolver> targetTenantResolver) { + public Builder targetTenantResolver(TargetTenantResolver targetTenantResolver) { assertNonNull(targetTenantResolver, "The TargetTenantResolver is a hard requirement"); this.targetTenantResolver = targetTenantResolver; return this; diff --git a/multitenancy/src/main/java/org/axonframework/extension/multitenancy/messaging/commandhandling/TenantAwareCommandBus.java b/multitenancy/src/main/java/org/axonframework/extension/multitenancy/messaging/commandhandling/TenantAwareCommandBus.java new file mode 100644 index 0000000..5f403aa --- /dev/null +++ b/multitenancy/src/main/java/org/axonframework/extension/multitenancy/messaging/commandhandling/TenantAwareCommandBus.java @@ -0,0 +1,79 @@ +/* + * Copyright (c) 2010-2025. Axon Framework + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.axonframework.extension.multitenancy.messaging.commandhandling; + +import jakarta.annotation.Nonnull; +import jakarta.annotation.Nullable; +import org.axonframework.common.infra.ComponentDescriptor; +import org.axonframework.messaging.commandhandling.CommandBus; +import org.axonframework.messaging.commandhandling.CommandHandler; +import org.axonframework.messaging.commandhandling.CommandMessage; +import org.axonframework.messaging.commandhandling.CommandResultMessage; +import org.axonframework.messaging.core.Message; +import org.axonframework.messaging.core.QualifiedName; +import org.axonframework.messaging.core.unitofwork.ProcessingContext; + +import java.util.concurrent.CompletableFuture; + +/** + * A {@link CommandBus} wrapper that ensures the command message is added to the + * {@link ProcessingContext} before handler invocation. + *

    + * This is essential for multi-tenant scenarios where downstream components (like + * {@link org.axonframework.extension.multitenancy.eventsourcing.eventstore.MultiTenantEventStore}) + * need to resolve the tenant from the message in the processing context. + *

    + * The wrapper intercepts handler subscriptions and wraps each handler to add the + * command message to the context before delegating to the actual handler. + * + * @author Theo Emanuelsson + * @since 5.0.0 + */ +public class TenantAwareCommandBus implements CommandBus { + + private final CommandBus delegate; + + /** + * Creates a new {@code TenantAwareCommandBus} wrapping the given delegate. + * + * @param delegate The {@link CommandBus} to wrap. + */ + public TenantAwareCommandBus(@Nonnull CommandBus delegate) { + this.delegate = delegate; + } + + @Override + public CompletableFuture dispatch(@Nonnull CommandMessage command, + @Nullable ProcessingContext processingContext) { + return delegate.dispatch(command, processingContext); + } + + @Override + public CommandBus subscribe(@Nonnull QualifiedName name, @Nonnull CommandHandler commandHandler) { + // Wrap the handler to add the command message to context before handling + CommandHandler wrappedHandler = (command, context) -> { + ProcessingContext contextWithMessage = Message.addToContext(context, command); + return commandHandler.handle(command, contextWithMessage); + }; + delegate.subscribe(name, wrappedHandler); + return this; + } + + @Override + public void describeTo(@Nonnull ComponentDescriptor descriptor) { + descriptor.describeProperty("delegate", delegate); + } +} diff --git a/multitenancy/src/main/java/org/axonframework/extensions/multitenancy/components/commandhandeling/TenantCommandSegmentFactory.java b/multitenancy/src/main/java/org/axonframework/extension/multitenancy/messaging/commandhandling/TenantCommandSegmentFactory.java similarity index 75% rename from multitenancy/src/main/java/org/axonframework/extensions/multitenancy/components/commandhandeling/TenantCommandSegmentFactory.java rename to multitenancy/src/main/java/org/axonframework/extension/multitenancy/messaging/commandhandling/TenantCommandSegmentFactory.java index 9e84dc4..d7665e0 100644 --- a/multitenancy/src/main/java/org/axonframework/extensions/multitenancy/components/commandhandeling/TenantCommandSegmentFactory.java +++ b/multitenancy/src/main/java/org/axonframework/extension/multitenancy/messaging/commandhandling/TenantCommandSegmentFactory.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 2010-2023. Axon Framework + * Copyright (c) 2010-2025. Axon Framework * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -13,10 +13,10 @@ * See the License for the specific language governing permissions and * limitations under the License. */ -package org.axonframework.extensions.multitenancy.components.commandhandeling; +package org.axonframework.extension.multitenancy.messaging.commandhandling; -import org.axonframework.commandhandling.CommandBus; -import org.axonframework.extensions.multitenancy.components.TenantDescriptor; +import org.axonframework.extension.multitenancy.core.TenantDescriptor; +import org.axonframework.messaging.commandhandling.CommandBus; import java.util.function.Function; @@ -25,7 +25,8 @@ * may be started automatically by the factory. * * @author Stefan Dragisic - * @since 4.6.0 + * @author Theo Emanuelsson + * @since 5.0.0 */ public interface TenantCommandSegmentFactory extends Function { diff --git a/multitenancy/src/main/java/org/axonframework/extension/multitenancy/messaging/core/annotation/TenantComponentResolver.java b/multitenancy/src/main/java/org/axonframework/extension/multitenancy/messaging/core/annotation/TenantComponentResolver.java new file mode 100644 index 0000000..dcc37a6 --- /dev/null +++ b/multitenancy/src/main/java/org/axonframework/extension/multitenancy/messaging/core/annotation/TenantComponentResolver.java @@ -0,0 +1,99 @@ +/* + * Copyright (c) 2010-2025. Axon Framework + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.axonframework.extension.multitenancy.messaging.core.annotation; + +import jakarta.annotation.Nonnull; +import org.axonframework.extension.multitenancy.core.TargetTenantResolver; +import org.axonframework.extension.multitenancy.core.TenantComponentRegistry; +import org.axonframework.extension.multitenancy.core.TenantDescriptor; +import org.axonframework.messaging.core.Message; +import org.axonframework.messaging.core.annotation.ParameterResolver; +import org.axonframework.messaging.core.unitofwork.ProcessingContext; + +import java.util.concurrent.CompletableFuture; + +/** + * A {@link ParameterResolver} that resolves parameters to tenant-scoped component instances. + *

    + * This resolver uses the configured {@link TargetTenantResolver} to determine which tenant + * the message belongs to, then retrieves the component instance from the + * {@link TenantComponentRegistry}. This enables async-safe multi-tenant component + * access without ThreadLocal storage. + *

    + * Usage in an event handler: + * 

    {@code
+ * @EventHandler
+ * public void on(OrderCreatedEvent event, OrderRepository repository) {
+ *     // Repository is automatically scoped to the event's tenant
+ *     repository.save(new OrderProjection(event));
+ * }
+ * }
    + * + * @param The type of component this resolver provides + * @author Theo Emanuelsson + * @since 5.0.0 + * @see TenantComponentRegistry + * @see TenantComponentResolverFactory + */ +public class TenantComponentResolver implements ParameterResolver { + + private final TenantComponentRegistry registry; + private final TargetTenantResolver tenantResolver; + + /** + * Creates a new {@link TenantComponentResolver}. + * + * @param registry The registry for tenant-scoped components + * @param tenantResolver The resolver used to determine which tenant a message belongs to + */ + public TenantComponentResolver(TenantComponentRegistry registry, + TargetTenantResolver tenantResolver) { + this.registry = registry; + this.tenantResolver = tenantResolver; + } + + @Nonnull + @Override + public CompletableFuture resolveParameterValue(@Nonnull ProcessingContext context) { + Message message = Message.fromContext(context); + if (message == null) { + return CompletableFuture.failedFuture( + new IllegalStateException("No message found in ProcessingContext")); + } + + try { + TenantDescriptor tenant = tenantResolver.resolveTenant(message, registry.getTenants()); + T component = registry.getComponent(tenant); + return CompletableFuture.completedFuture(component); + } catch (Exception e) { + return CompletableFuture.failedFuture(e); + } + } + + @Override + public boolean matches(@Nonnull ProcessingContext context) { + Message message = Message.fromContext(context); + if (message == null) { + return false; + } + try { + TenantDescriptor tenant = tenantResolver.resolveTenant(message, registry.getTenants()); + return registry.getTenants().contains(tenant); + } catch (Exception e) { + return false; + } + } +} diff --git a/multitenancy/src/main/java/org/axonframework/extension/multitenancy/messaging/core/annotation/TenantComponentResolverFactory.java b/multitenancy/src/main/java/org/axonframework/extension/multitenancy/messaging/core/annotation/TenantComponentResolverFactory.java new file mode 100644 index 0000000..934540f --- /dev/null +++ b/multitenancy/src/main/java/org/axonframework/extension/multitenancy/messaging/core/annotation/TenantComponentResolverFactory.java @@ -0,0 +1,125 @@ +/* + * Copyright (c) 2010-2025. Axon Framework + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.axonframework.extension.multitenancy.messaging.core.annotation; + +import jakarta.annotation.Nonnull; +import jakarta.annotation.Nullable; +import org.axonframework.common.Priority; +import org.axonframework.extension.multitenancy.core.TargetTenantResolver; +import org.axonframework.extension.multitenancy.core.TenantComponentFactory; +import org.axonframework.extension.multitenancy.core.TenantComponentRegistry; +import org.axonframework.messaging.core.Message; +import org.axonframework.messaging.core.annotation.ParameterResolver; +import org.axonframework.messaging.core.annotation.ParameterResolverFactory; + +import java.lang.reflect.Executable; +import java.lang.reflect.Parameter; +import java.util.Map; +import java.util.concurrent.ConcurrentHashMap; + +/** + * A {@link ParameterResolverFactory} that creates resolvers for tenant-scoped components. + *

    + * This factory manages multiple {@link TenantComponentRegistry} instances, one for each + * registered component type. When a handler method has a parameter matching a registered + * component type, this factory creates a {@link TenantComponentResolver} to provide + * the tenant-scoped instance. + *

    + * This factory runs with {@link Priority#HIGH} to ensure it processes component parameters + * before other resolvers that might attempt to inject non-tenant-aware instances. + *

    + * Example registration and usage: + * 

    {@code
+ * // Registration via MultiTenancyConfigurer
+ * MultiTenancyConfigurer.enhance(configurer)
+ *     .tenantComponent(OrderRepository.class, tenant -> new InMemoryOrderRepository());
+ *
+ * // Handler receives tenant-scoped instance
+ * @EventHandler
+ * public void on(OrderCreatedEvent event, OrderRepository repository) {
+ *     repository.save(new OrderProjection(event));
+ * }
+ * }
    + * + * @author Theo Emanuelsson + * @since 5.0.0 + * @see TenantComponentResolver + * @see TenantComponentRegistry + */ +@Priority(Priority.HIGH) +public class TenantComponentResolverFactory implements ParameterResolverFactory { + + private final Map, TenantComponentRegistry> registries = new ConcurrentHashMap<>(); + private final TargetTenantResolver tenantResolver; + + /** + * Creates a new {@link TenantComponentResolverFactory}. + * + * @param tenantResolver The resolver used to determine which tenant a message belongs to + */ + public TenantComponentResolverFactory(@Nonnull TargetTenantResolver tenantResolver) { + this.tenantResolver = tenantResolver; + } + + /** + * Registers a component type with its factory. + *

    + * This creates a {@link TenantComponentRegistry} for the component type that will + * lazily create instances using the provided factory when first accessed. + * + * @param componentType The class of the component + * @param factory The factory to create component instances per tenant + * @param The component type + * @return The created registry for lifecycle management + */ + public TenantComponentRegistry registerComponent(@Nonnull Class componentType, + @Nonnull TenantComponentFactory factory) { + TenantComponentRegistry registry = new TenantComponentRegistry<>(componentType, factory); + registries.put(componentType, registry); + return registry; + } + + /** + * Returns the registries managed by this factory. + *

    + * This is used for lifecycle management, allowing the registries to be + * subscribed to tenant providers. + * + * @return An unmodifiable view of the registered component registries + */ + public Map, TenantComponentRegistry> getRegistries() { + return Map.copyOf(registries); + } + + @Nullable + @Override + @SuppressWarnings("unchecked") + public ParameterResolver createInstance(@Nonnull Executable executable, + @Nonnull Parameter[] parameters, + int parameterIndex) { + Class parameterType = parameters[parameterIndex].getType(); + + TenantComponentRegistry registry = registries.get(parameterType); + if (registry == null) { + return null; + } + + return new TenantComponentResolver<>( + (TenantComponentRegistry) registry, + tenantResolver + ); + } +} diff --git a/multitenancy/src/main/java/org/axonframework/extension/multitenancy/messaging/core/unitofwork/TenantAwareProcessingContext.java b/multitenancy/src/main/java/org/axonframework/extension/multitenancy/messaging/core/unitofwork/TenantAwareProcessingContext.java new file mode 100644 index 0000000..646697a --- /dev/null +++ b/multitenancy/src/main/java/org/axonframework/extension/multitenancy/messaging/core/unitofwork/TenantAwareProcessingContext.java @@ -0,0 +1,245 @@ +/* + * Copyright (c) 2010-2025. Axon Framework + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.axonframework.extension.multitenancy.messaging.core.unitofwork; + +import jakarta.annotation.Nonnull; +import jakarta.annotation.Nullable; +import org.axonframework.extension.multitenancy.core.TenantComponentRegistry; +import org.axonframework.extension.multitenancy.core.TenantDescriptor; +import org.axonframework.extension.multitenancy.messaging.core.annotation.TenantComponentResolverFactory; +import org.axonframework.messaging.core.unitofwork.ProcessingContext; +import org.axonframework.messaging.core.unitofwork.ProcessingLifecycle; + +import java.util.Map; +import java.util.concurrent.CompletableFuture; +import java.util.function.Consumer; +import java.util.function.Function; +import java.util.function.Supplier; +import java.util.function.UnaryOperator; + +/** + * A {@link ProcessingContext} wrapper that intercepts {@link #component(Class)} calls + * for registered tenant-scoped component types and returns the tenant-specific instance. + *

    + * This allows handlers to retrieve tenant-scoped components via: + * 

    {@code
+ * @EventHandler
+ * void handle(SomeEvent event, ProcessingContext context) {
+ *     MyRepository repo = context.component(MyRepository.class);
+ *     // repo is the tenant-scoped instance based on the current message's tenant
+ * }
+ * }
    + * + * @author Theo Emanuelsson + * @since 5.0.0 + */ +public class TenantAwareProcessingContext implements ProcessingContext { + + private final ProcessingContext delegate; + private final TenantComponentResolverFactory resolverFactory; + private final TenantDescriptor tenant; + + /** + * Constructs a tenant-aware {@link ProcessingContext}. + * + * @param delegate The delegate {@link ProcessingContext} to wrap. + * @param resolverFactory The factory containing registered tenant component types. + * @param tenant The tenant descriptor for the current message. + */ + public TenantAwareProcessingContext( + @Nonnull ProcessingContext delegate, + @Nonnull TenantComponentResolverFactory resolverFactory, + @Nonnull TenantDescriptor tenant + ) { + this.delegate = delegate; + this.resolverFactory = resolverFactory; + this.tenant = tenant; + } + + @Nonnull + @Override + @SuppressWarnings("unchecked") + public C component(@Nonnull Class type) { + TenantComponentRegistry registry = resolverFactory.getRegistries().get(type); + if (registry != null) { + return (C) registry.getComponent(tenant); + } + return delegate.component(type); + } + + @Nonnull + @Override + @SuppressWarnings("unchecked") + public C component(@Nonnull Class type, @Nullable String name) { + TenantComponentRegistry registry = resolverFactory.getRegistries().get(type); + if (registry != null) { + return (C) registry.getComponent(tenant); + } + return delegate.component(type, name); + } + + // Delegate all other methods to the wrapped context + + @Override + public boolean isStarted() { + return delegate.isStarted(); + } + + @Override + public boolean isError() { + return delegate.isError(); + } + + @Override + public boolean isCommitted() { + return delegate.isCommitted(); + } + + @Override + public boolean isCompleted() { + return delegate.isCompleted(); + } + + @Override + public ProcessingLifecycle on(Phase phase, Function> action) { + return delegate.on(phase, action); + } + + @Override + public ProcessingLifecycle runOn(Phase phase, Consumer action) { + return delegate.runOn(phase, action); + } + + @Override + public ProcessingLifecycle onPreInvocation(Function> action) { + return delegate.onPreInvocation(action); + } + + @Override + public ProcessingLifecycle runOnPreInvocation(Consumer action) { + return delegate.runOnPreInvocation(action); + } + + @Override + public ProcessingLifecycle onInvocation(Function> action) { + return delegate.onInvocation(action); + } + + @Override + public ProcessingLifecycle runOnInvocation(Consumer action) { + return delegate.runOnInvocation(action); + } + + @Override + public ProcessingLifecycle onPostInvocation(Function> action) { + return delegate.onPostInvocation(action); + } + + @Override + public ProcessingLifecycle runOnPostInvocation(Consumer action) { + return delegate.runOnPostInvocation(action); + } + + @Override + public ProcessingLifecycle onPrepareCommit(Function> action) { + return delegate.onPrepareCommit(action); + } + + @Override + public ProcessingLifecycle runOnPrepareCommit(Consumer action) { + return delegate.runOnPrepareCommit(action); + } + + @Override + public ProcessingLifecycle onCommit(Function> action) { + return delegate.onCommit(action); + } + + @Override + public ProcessingLifecycle runOnCommit(Consumer action) { + return delegate.runOnCommit(action); + } + + @Override + public ProcessingLifecycle onAfterCommit(Function> action) { + return delegate.onAfterCommit(action); + } + + @Override + public ProcessingLifecycle runOnAfterCommit(Consumer action) { + return delegate.runOnAfterCommit(action); + } + + @Override + public ProcessingLifecycle onError(ErrorHandler action) { + return delegate.onError(action); + } + + @Override + public ProcessingLifecycle whenComplete(Consumer action) { + return delegate.whenComplete(action); + } + + @Override + public ProcessingLifecycle doFinally(Consumer action) { + return delegate.doFinally(action); + } + + @Override + public boolean containsResource(@Nonnull ResourceKey key) { + return delegate.containsResource(key); + } + + @Override + public T getResource(@Nonnull ResourceKey key) { + return delegate.getResource(key); + } + + @Override + public Map, Object> resources() { + return delegate.resources(); + } + + @Override + public T putResource(@Nonnull ResourceKey key, @Nonnull T resource) { + return delegate.putResource(key, resource); + } + + @Override + public T updateResource(@Nonnull ResourceKey key, @Nonnull UnaryOperator resourceUpdater) { + return delegate.updateResource(key, resourceUpdater); + } + + @Override + public T computeResourceIfAbsent(@Nonnull ResourceKey key, @Nonnull Supplier resourceSupplier) { + return delegate.computeResourceIfAbsent(key, resourceSupplier); + } + + @Override + public T putResourceIfAbsent(@Nonnull ResourceKey key, @Nonnull T resource) { + return delegate.putResourceIfAbsent(key, resource); + } + + @Override + public T removeResource(@Nonnull ResourceKey key) { + return delegate.removeResource(key); + } + + @Override + public boolean removeResource(@Nonnull ResourceKey key, @Nonnull T expectedResource) { + return delegate.removeResource(key, expectedResource); + } +} diff --git a/multitenancy/src/main/java/org/axonframework/extension/multitenancy/messaging/core/unitofwork/annotation/TenantAwareProcessingContextResolver.java b/multitenancy/src/main/java/org/axonframework/extension/multitenancy/messaging/core/unitofwork/annotation/TenantAwareProcessingContextResolver.java new file mode 100644 index 0000000..0f71d8c --- /dev/null +++ b/multitenancy/src/main/java/org/axonframework/extension/multitenancy/messaging/core/unitofwork/annotation/TenantAwareProcessingContextResolver.java @@ -0,0 +1,114 @@ +/* + * Copyright (c) 2010-2025. Axon Framework + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.axonframework.extension.multitenancy.messaging.core.unitofwork.annotation; + +import jakarta.annotation.Nonnull; +import org.axonframework.extension.multitenancy.core.TargetTenantResolver; +import org.axonframework.extension.multitenancy.core.TenantDescriptor; +import org.axonframework.extension.multitenancy.messaging.core.annotation.TenantComponentResolverFactory; +import org.axonframework.extension.multitenancy.messaging.core.unitofwork.TenantAwareProcessingContext; +import org.axonframework.messaging.core.Message; +import org.axonframework.messaging.core.annotation.ParameterResolver; +import org.axonframework.messaging.core.unitofwork.ProcessingContext; + +import java.util.concurrent.CompletableFuture; + +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +/** + * A {@link ParameterResolver} that resolves {@link ProcessingContext} parameters to + * {@link TenantAwareProcessingContext} instances when tenant components are registered. + *

    + * This resolver intercepts requests for {@code ProcessingContext} in handler methods and + * wraps them with tenant-aware functionality. This allows handlers to use + * {@code context.component(MyType.class)} to retrieve tenant-scoped component instances. + *

    + * If no tenant components are registered or if tenant resolution fails, the original + * ProcessingContext is returned unchanged. + *

    + * Example usage in a handler: + * 

    {@code
+ * @EventHandler
+ * public void on(OrderCreatedEvent event, ProcessingContext context) {
+ *     // Returns tenant-scoped instance based on the event's tenant
+ *     OrderRepository repo = context.component(OrderRepository.class);
+ *     repo.save(new OrderProjection(event));
+ * }
+ * }
    + * + * @author Theo Emanuelsson + * @since 5.0.0 + * @see TenantAwareProcessingContext + * @see TenantComponentResolverFactory + */ +public class TenantAwareProcessingContextResolver implements ParameterResolver { + + private static final Logger logger = LoggerFactory.getLogger(TenantAwareProcessingContextResolver.class); + + private final TenantComponentResolverFactory resolverFactory; + private final TargetTenantResolver tenantResolver; + + /** + * Creates a new {@link TenantAwareProcessingContextResolver}. + * + * @param resolverFactory The factory containing registered tenant component types + * @param tenantResolver The resolver used to determine which tenant a message belongs to + */ + public TenantAwareProcessingContextResolver( + TenantComponentResolverFactory resolverFactory, + TargetTenantResolver tenantResolver + ) { + this.resolverFactory = resolverFactory; + this.tenantResolver = tenantResolver; + } + + @Nonnull + @Override + public CompletableFuture resolveParameterValue(@Nonnull ProcessingContext context) { + // If no tenant components registered, return original context + if (resolverFactory.getRegistries().isEmpty()) { + return CompletableFuture.completedFuture(context); + } + + // Get message from context to resolve tenant + Message message = Message.fromContext(context); + if (message == null) { + return CompletableFuture.completedFuture(context); + } + + // Attempt to resolve tenant and wrap context + try { + TenantDescriptor tenant = tenantResolver.resolveTenant( + message, + resolverFactory.getRegistries().values().iterator().next().getTenants() + ); + return CompletableFuture.completedFuture( + new TenantAwareProcessingContext(context, resolverFactory, tenant) + ); + } catch (Exception e) { + // Fallback to unwrapped context if tenant resolution fails + logger.debug("Failed to resolve tenant, returning unwrapped context: {}", e.getMessage()); + return CompletableFuture.completedFuture(context); + } + } + + @Override + public boolean matches(@Nonnull ProcessingContext context) { + // Always matches - we handle the fallback internally + return true; + } +} diff --git a/multitenancy/src/main/java/org/axonframework/extension/multitenancy/messaging/core/unitofwork/annotation/TenantAwareProcessingContextResolverFactory.java b/multitenancy/src/main/java/org/axonframework/extension/multitenancy/messaging/core/unitofwork/annotation/TenantAwareProcessingContextResolverFactory.java new file mode 100644 index 0000000..8aa022e --- /dev/null +++ b/multitenancy/src/main/java/org/axonframework/extension/multitenancy/messaging/core/unitofwork/annotation/TenantAwareProcessingContextResolverFactory.java @@ -0,0 +1,77 @@ +/* + * Copyright (c) 2010-2025. Axon Framework + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.axonframework.extension.multitenancy.messaging.core.unitofwork.annotation; + +import jakarta.annotation.Nonnull; +import jakarta.annotation.Nullable; +import org.axonframework.common.Priority; +import org.axonframework.extension.multitenancy.core.TargetTenantResolver; +import org.axonframework.extension.multitenancy.messaging.core.annotation.TenantComponentResolverFactory; +import org.axonframework.messaging.core.Message; +import org.axonframework.messaging.core.annotation.ParameterResolver; +import org.axonframework.messaging.core.annotation.ParameterResolverFactory; +import org.axonframework.messaging.core.unitofwork.ProcessingContext; + +import java.lang.reflect.Executable; +import java.lang.reflect.Parameter; + +/** + * A {@link ParameterResolverFactory} that creates {@link TenantAwareProcessingContextResolver} + * instances for handler parameters of type {@link ProcessingContext}. + *

    + * This factory runs with {@link Priority#HIGH} to ensure it processes {@code ProcessingContext} + * parameters before the default resolver, allowing tenant-aware wrapping of the context. + *

    + * When a handler method has a {@code ProcessingContext} parameter, this factory creates a + * resolver that wraps the context with {@link org.axonframework.extension.multitenancy.messaging.core.unitofwork.TenantAwareProcessingContext}, + * enabling {@code context.component(MyType.class)} to return tenant-scoped instances. + * + * @author Theo Emanuelsson + * @since 5.0.0 + * @see TenantAwareProcessingContextResolver + * @see TenantComponentResolverFactory + */ +@Priority(Priority.HIGH) +public class TenantAwareProcessingContextResolverFactory implements ParameterResolverFactory { + + private final TenantComponentResolverFactory tenantComponentFactory; + private final TargetTenantResolver tenantResolver; + + /** + * Creates a new {@link TenantAwareProcessingContextResolverFactory}. + * + * @param tenantComponentFactory The factory containing registered tenant component types + * @param tenantResolver The resolver used to determine which tenant a message belongs to + */ + public TenantAwareProcessingContextResolverFactory( + @Nonnull TenantComponentResolverFactory tenantComponentFactory, + @Nonnull TargetTenantResolver tenantResolver + ) { + this.tenantComponentFactory = tenantComponentFactory; + this.tenantResolver = tenantResolver; + } + + @Nullable + @Override + public ParameterResolver createInstance(@Nonnull Executable executable, + @Nonnull Parameter[] parameters, + int parameterIndex) { + if (ProcessingContext.class.isAssignableFrom(parameters[parameterIndex].getType())) { + return new TenantAwareProcessingContextResolver(tenantComponentFactory, tenantResolver); + } + return null; + } +} diff --git a/multitenancy/src/main/java/org/axonframework/extension/multitenancy/messaging/eventhandling/processing/InMemoryTenantTokenStoreFactory.java b/multitenancy/src/main/java/org/axonframework/extension/multitenancy/messaging/eventhandling/processing/InMemoryTenantTokenStoreFactory.java new file mode 100644 index 0000000..134e832 --- /dev/null +++ b/multitenancy/src/main/java/org/axonframework/extension/multitenancy/messaging/eventhandling/processing/InMemoryTenantTokenStoreFactory.java @@ -0,0 +1,59 @@ +/* + * Copyright (c) 2010-2025. Axon Framework + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.axonframework.extension.multitenancy.messaging.eventhandling.processing; + +import org.axonframework.extension.multitenancy.core.TenantDescriptor; +import org.axonframework.messaging.eventhandling.processing.streaming.token.store.TokenStore; +import org.axonframework.messaging.eventhandling.processing.streaming.token.store.inmemory.InMemoryTokenStore; + +import java.util.Map; +import java.util.concurrent.ConcurrentHashMap; + +/** + * Default implementation of {@link TenantTokenStoreFactory} that creates per-tenant + * {@link InMemoryTokenStore} instances. + *

    + * This factory caches created token stores by tenant, ensuring the same store is returned + * for subsequent calls with the same tenant. Token stores created by this factory store + * tokens in memory and will lose all tokens when the application restarts. + *

    + * For production use with persistent token storage, consider using a different implementation + * such as the Axon Server token store factory or a JPA-based implementation. + * + * @author Theo Emanuelsson + * @since 5.0.0 + * @see TenantTokenStoreFactory + * @see InMemoryTokenStore + */ +public class InMemoryTenantTokenStoreFactory implements TenantTokenStoreFactory { + + private final Map tokenStores = new ConcurrentHashMap<>(); + + @Override + public TokenStore apply(TenantDescriptor tenant) { + return tokenStores.computeIfAbsent(tenant, t -> new InMemoryTokenStore()); + } + + /** + * Returns the number of token stores currently cached. + * Primarily for testing purposes. + * + * @return The number of cached token stores. + */ + int tokenStoreCount() { + return tokenStores.size(); + } +} diff --git a/multitenancy/src/main/java/org/axonframework/extension/multitenancy/messaging/eventhandling/processing/JdbcTenantTokenStoreFactory.java b/multitenancy/src/main/java/org/axonframework/extension/multitenancy/messaging/eventhandling/processing/JdbcTenantTokenStoreFactory.java new file mode 100644 index 0000000..e3d5087 --- /dev/null +++ b/multitenancy/src/main/java/org/axonframework/extension/multitenancy/messaging/eventhandling/processing/JdbcTenantTokenStoreFactory.java @@ -0,0 +1,120 @@ +/* + * Copyright (c) 2010-2025. Axon Framework + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.axonframework.extension.multitenancy.messaging.eventhandling.processing; + +import jakarta.annotation.Nonnull; +import org.axonframework.common.jdbc.ConnectionProvider; +import org.axonframework.conversion.Converter; +import org.axonframework.extension.multitenancy.core.TenantDescriptor; +import org.axonframework.messaging.eventhandling.processing.streaming.token.store.TokenStore; +import org.axonframework.messaging.eventhandling.processing.streaming.token.store.jdbc.JdbcTokenStore; +import org.axonframework.messaging.eventhandling.processing.streaming.token.store.jdbc.JdbcTokenStoreConfiguration; + +import java.util.Map; +import java.util.Objects; +import java.util.concurrent.ConcurrentHashMap; + +/** + * A {@link TenantTokenStoreFactory} that creates {@link JdbcTokenStore} instances for each tenant. + *

    + * This factory uses a {@link TenantConnectionProviderFactory} to obtain tenant-specific + * JDBC connections. Each tenant gets its own {@link JdbcTokenStore} that persists tokens + * to that tenant's database, ensuring transactional consistency and data isolation. + *

    + * Token stores are cached per tenant to avoid creating multiple instances for the same tenant. + *

    + * Example usage: + * 

    {@code
+ * // Create a connection provider factory that returns tenant-specific connections
+ * TenantConnectionProviderFactory connectionFactory = tenant -> {
+ *     DataSource tenantDataSource = getDataSourceForTenant(tenant);
+ *     return tenantDataSource::getConnection;
+ * };
+ *
+ * // Register the factory with configuration
+ * configurer.registerComponent(TenantTokenStoreFactory.class, cfg ->
+ *     new JdbcTenantTokenStoreFactory(
+ *         connectionFactory,
+ *         cfg.getComponent(Converter.class),
+ *         JdbcTokenStoreConfiguration.DEFAULT
+ *     )
+ * );
+ * }
    + * + * @author Theo Emanuelsson + * @since 5.0.0 + * @see TenantTokenStoreFactory + * @see JdbcTokenStore + * @see TenantConnectionProviderFactory + */ +public class JdbcTenantTokenStoreFactory implements TenantTokenStoreFactory { + + private final TenantConnectionProviderFactory connectionProviderFactory; + private final Converter converter; + private final JdbcTokenStoreConfiguration configuration; + private final Map tokenStores = new ConcurrentHashMap<>(); + + /** + * Creates a new {@link JdbcTenantTokenStoreFactory} with the given dependencies. + * + * @param connectionProviderFactory The factory for obtaining tenant-specific ConnectionProviders. + * @param converter The converter for serializing/deserializing tokens. + * @param configuration The JDBC token store configuration. + */ + public JdbcTenantTokenStoreFactory( + @Nonnull TenantConnectionProviderFactory connectionProviderFactory, + @Nonnull Converter converter, + @Nonnull JdbcTokenStoreConfiguration configuration + ) { + this.connectionProviderFactory = Objects.requireNonNull(connectionProviderFactory, + "TenantConnectionProviderFactory must not be null"); + this.converter = Objects.requireNonNull(converter, "Converter must not be null"); + this.configuration = Objects.requireNonNull(configuration, "JdbcTokenStoreConfiguration must not be null"); + } + + /** + * Creates a new {@link JdbcTenantTokenStoreFactory} with default configuration. + * + * @param connectionProviderFactory The factory for obtaining tenant-specific ConnectionProviders. + * @param converter The converter for serializing/deserializing tokens. + */ + public JdbcTenantTokenStoreFactory( + @Nonnull TenantConnectionProviderFactory connectionProviderFactory, + @Nonnull Converter converter + ) { + this(connectionProviderFactory, converter, JdbcTokenStoreConfiguration.DEFAULT); + } + + @Override + public TokenStore apply(TenantDescriptor tenant) { + return tokenStores.computeIfAbsent(tenant, this::createTokenStore); + } + + private TokenStore createTokenStore(TenantDescriptor tenant) { + ConnectionProvider tenantConnectionProvider = connectionProviderFactory.apply(tenant); + return new JdbcTokenStore(tenantConnectionProvider, converter, configuration); + } + + /** + * Returns the number of token stores currently cached. + * Primarily for testing purposes. + * + * @return The number of cached token stores. + */ + int tokenStoreCount() { + return tokenStores.size(); + } +} diff --git a/multitenancy/src/main/java/org/axonframework/extension/multitenancy/messaging/eventhandling/processing/JpaTenantTokenStoreFactory.java b/multitenancy/src/main/java/org/axonframework/extension/multitenancy/messaging/eventhandling/processing/JpaTenantTokenStoreFactory.java new file mode 100644 index 0000000..f35547e --- /dev/null +++ b/multitenancy/src/main/java/org/axonframework/extension/multitenancy/messaging/eventhandling/processing/JpaTenantTokenStoreFactory.java @@ -0,0 +1,119 @@ +/* + * Copyright (c) 2010-2025. Axon Framework + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.axonframework.extension.multitenancy.messaging.eventhandling.processing; + +import jakarta.annotation.Nonnull; +import jakarta.persistence.EntityManagerFactory; +import org.axonframework.common.jpa.EntityManagerProvider; +import org.axonframework.conversion.Converter; +import org.axonframework.extension.multitenancy.core.TenantDescriptor; +import org.axonframework.messaging.eventhandling.processing.streaming.token.store.TokenStore; +import org.axonframework.messaging.eventhandling.processing.streaming.token.store.jpa.JpaTokenStore; +import org.axonframework.messaging.eventhandling.processing.streaming.token.store.jpa.JpaTokenStoreConfiguration; + +import java.util.Map; +import java.util.Objects; +import java.util.concurrent.ConcurrentHashMap; +import java.util.function.Function; + +/** + * A {@link TenantTokenStoreFactory} that creates {@link JpaTokenStore} instances for each tenant. + *

    + * This factory uses a provider function to obtain tenant-specific {@link EntityManagerFactory} instances. + * Each tenant gets its own {@link JpaTokenStore} that persists tokens to that tenant's database, + * ensuring transactional consistency and data isolation. + *

    + * Token stores are cached per tenant to avoid creating multiple instances for the same tenant. + *

    + * Example usage with {@code tenantComponent()}: + * 

    {@code
+ * // Register EntityManagerFactory as a tenant component
+ * MultiTenancyConfigurer.enhance(configurer)
+ *     .tenantComponent(EntityManagerFactory.class, tenant -> createEmfForTenant(tenant));
+ *
+ * // Create the token store factory using the tenant component
+ * JpaTenantTokenStoreFactory tokenStoreFactory = new JpaTenantTokenStoreFactory(
+ *     tenant -> config.getComponent(TenantComponentRegistry.class)
+ *                     .getComponent(EntityManagerFactory.class, tenant),
+ *     converter
+ * );
+ * }
    + * + * @author Theo Emanuelsson + * @since 5.0.0 + * @see TenantTokenStoreFactory + * @see JpaTokenStore + */ +public class JpaTenantTokenStoreFactory implements TenantTokenStoreFactory { + + private final Function emfProvider; + private final Converter converter; + private final JpaTokenStoreConfiguration configuration; + private final Map tokenStores = new ConcurrentHashMap<>(); + + /** + * Creates a new {@link JpaTenantTokenStoreFactory} with the given dependencies. + * + * @param emfProvider Function that provides an {@link EntityManagerFactory} for each tenant. + * @param converter The converter for serializing/deserializing tokens. + * @param configuration The JPA token store configuration. + */ + public JpaTenantTokenStoreFactory( + @Nonnull Function emfProvider, + @Nonnull Converter converter, + @Nonnull JpaTokenStoreConfiguration configuration + ) { + this.emfProvider = Objects.requireNonNull(emfProvider, + "EntityManagerFactory provider must not be null"); + this.converter = Objects.requireNonNull(converter, "Converter must not be null"); + this.configuration = Objects.requireNonNull(configuration, "JpaTokenStoreConfiguration must not be null"); + } + + /** + * Creates a new {@link JpaTenantTokenStoreFactory} with default configuration. + * + * @param emfProvider Function that provides an {@link EntityManagerFactory} for each tenant. + * @param converter The converter for serializing/deserializing tokens. + */ + public JpaTenantTokenStoreFactory( + @Nonnull Function emfProvider, + @Nonnull Converter converter + ) { + this(emfProvider, converter, JpaTokenStoreConfiguration.DEFAULT); + } + + @Override + public TokenStore apply(TenantDescriptor tenant) { + return tokenStores.computeIfAbsent(tenant, this::createTokenStore); + } + + private TokenStore createTokenStore(TenantDescriptor tenant) { + EntityManagerFactory emf = emfProvider.apply(tenant); + // Create an EntityManagerProvider that creates fresh EntityManagers from the factory + EntityManagerProvider tenantEntityManagerProvider = emf::createEntityManager; + return new JpaTokenStore(tenantEntityManagerProvider, converter, configuration); + } + + /** + * Returns the number of token stores currently cached. + * Primarily for testing purposes. + * + * @return The number of cached token stores. + */ + int tokenStoreCount() { + return tokenStores.size(); + } +} diff --git a/multitenancy/src/main/java/org/axonframework/extensions/multitenancy/components/eventhandeling/MultiTenantEventProcessor.java b/multitenancy/src/main/java/org/axonframework/extension/multitenancy/messaging/eventhandling/processing/MultiTenantEventProcessor.java similarity index 77% rename from multitenancy/src/main/java/org/axonframework/extensions/multitenancy/components/eventhandeling/MultiTenantEventProcessor.java rename to multitenancy/src/main/java/org/axonframework/extension/multitenancy/messaging/eventhandling/processing/MultiTenantEventProcessor.java index d571d14..3fc546d 100644 --- a/multitenancy/src/main/java/org/axonframework/extensions/multitenancy/components/eventhandeling/MultiTenantEventProcessor.java +++ b/multitenancy/src/main/java/org/axonframework/extension/multitenancy/messaging/eventhandling/processing/MultiTenantEventProcessor.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 2010-2024. Axon Framework + * Copyright (c) 2010-2025. Axon Framework * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -13,26 +13,22 @@ * See the License for the specific language governing permissions and * limitations under the License. */ -package org.axonframework.extensions.multitenancy.components.eventhandeling; +package org.axonframework.extension.multitenancy.messaging.eventhandling.processing; +import jakarta.annotation.Nonnull; import org.axonframework.common.AxonConfigurationException; import org.axonframework.common.Registration; -import org.axonframework.eventhandling.EventMessage; -import org.axonframework.eventhandling.EventProcessor; -import org.axonframework.extensions.multitenancy.components.MultiTenantAwareComponent; -import org.axonframework.extensions.multitenancy.components.MultiTenantHandlerInterceptorSupport; -import org.axonframework.extensions.multitenancy.components.TenantDescriptor; -import org.axonframework.lifecycle.Phase; -import org.axonframework.lifecycle.ShutdownHandler; -import org.axonframework.lifecycle.StartHandler; -import org.axonframework.messaging.MessageHandlerInterceptor; +import org.axonframework.common.infra.ComponentDescriptor; +import org.axonframework.extension.multitenancy.core.MultiTenantAwareComponent; +import org.axonframework.extension.multitenancy.core.TenantDescriptor; +import org.axonframework.messaging.eventhandling.processing.EventProcessor; import java.util.ArrayList; import java.util.Collections; import java.util.List; import java.util.Map; +import java.util.concurrent.CompletableFuture; import java.util.concurrent.ConcurrentHashMap; -import java.util.concurrent.CopyOnWriteArrayList; import static org.axonframework.common.BuilderUtils.assertNonEmpty; import static org.axonframework.common.BuilderUtils.assertNonNull; @@ -41,17 +37,12 @@ * Tenant aware implementation of {@link EventProcessor} that encapsulates the actual {@link EventProcessor}s, and * forwards corresponding actions to a tenant-specific segment. * - * @author Stefan Dragisic - * @since 4.6.0 + * @author Theo Emanuelsson + * @since 5.0.0 */ -public class MultiTenantEventProcessor implements - EventProcessor, - MultiTenantAwareComponent, - MultiTenantHandlerInterceptorSupport, EventProcessor> { +public class MultiTenantEventProcessor implements EventProcessor, MultiTenantAwareComponent { private final Map tenantEventProcessorsSegments = new ConcurrentHashMap<>(); - private final List>> handlerInterceptors = new CopyOnWriteArrayList<>(); - private final Map> handlerInterceptorsRegistration = new ConcurrentHashMap<>(); private final String name; private final TenantEventProcessorSegmentFactory tenantEventProcessorSegmentFactory; @@ -82,37 +73,37 @@ public static Builder builder() { } @Override - public String getName() { + public String name() { return name; } - @Override + /** + * Returns the tenant segments managed by this {@code MultiTenantEventProcessor}. + * + * @return A map of {@link TenantDescriptor} to {@link EventProcessor} representing tenant segments. + */ public Map tenantSegments() { return tenantEventProcessorsSegments; } @Override - public List>> getHandlerInterceptors() { - return handlerInterceptors; - } - - @Override - public Map> getHandlerInterceptorsRegistration() { - return handlerInterceptorsRegistration; - } - - @Override - @StartHandler(phase = Phase.INBOUND_EVENT_CONNECTORS) - public void start() { + public CompletableFuture start() { started = true; - tenantEventProcessorsSegments.values().forEach(EventProcessor::start); + CompletableFuture[] futures = tenantEventProcessorsSegments.values() + .stream() + .map(EventProcessor::start) + .toArray(CompletableFuture[]::new); + return CompletableFuture.allOf(futures); } @Override - @ShutdownHandler(phase = Phase.INBOUND_EVENT_CONNECTORS) - public void shutDown() { + public CompletableFuture shutdown() { started = false; - tenantEventProcessorsSegments.values().forEach(EventProcessor::shutDown); + CompletableFuture[] futures = tenantEventProcessorsSegments.values() + .stream() + .map(EventProcessor::shutdown) + .toArray(CompletableFuture[]::new); + return CompletableFuture.allOf(futures); } @Override @@ -147,7 +138,7 @@ public boolean isError() { * Indicates whether the {@link EventProcessor} for the given {@code tenantDescriptor} has been shut down due to an * error. In such case, the processor has forcefully shut down, as it wasn't able to automatically recover. *

    - * Note that this method returns {@code false} when the tenant processor was stopped using {@link #shutDown()}. + * Note that this method returns {@code false} when the tenant processor was stopped using {@link #shutdown()}. * * @return {@code true} when paused due to an error, otherwise {@code false}. */ @@ -176,15 +167,7 @@ public Registration registerTenant(TenantDescriptor tenantDescriptor) { public Registration registerAndStartTenant(TenantDescriptor tenantDescriptor) { tenantEventProcessorsSegments.computeIfAbsent(tenantDescriptor, tenant -> { EventProcessor tenantSegment = tenantEventProcessorSegmentFactory.apply(tenant); - - handlerInterceptors.forEach( - handlerInterceptor -> handlerInterceptorsRegistration - .computeIfAbsent(tenant, t -> new CopyOnWriteArrayList<>()) - .add(tenantSegment.registerHandlerInterceptor(handlerInterceptor)) - ); - tenantSegment.start(); - return tenantSegment; }); @@ -194,20 +177,16 @@ public Registration registerAndStartTenant(TenantDescriptor tenantDescriptor) { /** * Stops the given {@code tenant} and removes it from this processor. Note that this does not remove any potentially - * persisted {@link org.axonframework.eventhandling.TrackingToken TrackingTokens} from - * {@link org.axonframework.eventhandling.StreamingEventProcessor} instances! + * persisted {@link org.axonframework.messaging.eventhandling.processing.TrackingToken TrackingTokens} from + * {@link org.axonframework.messaging.eventhandling.processing.StreamingEventProcessor} instances! * * @param tenantDescriptor The tenant to stop and remove from this processor. * @return A {@code boolean} indicating whether the tenant was removed. */ public boolean stopAndRemoveTenant(TenantDescriptor tenantDescriptor) { - List registrations = handlerInterceptorsRegistration.remove(tenantDescriptor); - if (registrations != null) { - registrations.forEach(Registration::cancel); - } EventProcessor delegate = tenantEventProcessorsSegments.remove(tenantDescriptor); if (delegate != null) { - delegate.shutDown(); + delegate.shutdown(); return true; } return false; @@ -222,6 +201,12 @@ public List tenantEventProcessors() { return Collections.unmodifiableList(new ArrayList<>(tenantEventProcessorsSegments.values())); } + @Override + public void describeTo(@Nonnull ComponentDescriptor descriptor) { + descriptor.describeProperty("name", name); + descriptor.describeProperty("tenantSegments", tenantEventProcessorsSegments); + } + /** * Builder class to instantiate a {@link MultiTenantEventProcessor}. *

    diff --git a/multitenancy/src/main/java/org/axonframework/extension/multitenancy/messaging/eventhandling/processing/MultiTenantPooledStreamingEventProcessorConfiguration.java b/multitenancy/src/main/java/org/axonframework/extension/multitenancy/messaging/eventhandling/processing/MultiTenantPooledStreamingEventProcessorConfiguration.java new file mode 100644 index 0000000..8fde8c9 --- /dev/null +++ b/multitenancy/src/main/java/org/axonframework/extension/multitenancy/messaging/eventhandling/processing/MultiTenantPooledStreamingEventProcessorConfiguration.java @@ -0,0 +1,275 @@ +/* + * Copyright (c) 2010-2025. Axon Framework + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.axonframework.extension.multitenancy.messaging.eventhandling.processing; + +import jakarta.annotation.Nonnull; +import org.axonframework.common.configuration.Configuration; +import org.axonframework.messaging.eventhandling.EventMessage; +import org.axonframework.messaging.eventhandling.configuration.EventProcessorConfiguration; +import org.axonframework.messaging.eventhandling.processing.errorhandling.ErrorHandler; +import org.axonframework.messaging.eventhandling.processing.streaming.pooled.MaxSegmentProvider; +import org.axonframework.messaging.eventhandling.processing.streaming.pooled.PooledStreamingEventProcessorConfiguration; +import org.axonframework.messaging.eventhandling.processing.streaming.token.TrackingToken; +import org.axonframework.messaging.eventhandling.processing.streaming.token.store.TokenStore; +import org.axonframework.messaging.eventhandling.tracing.EventProcessorSpanFactory; +import org.axonframework.messaging.eventstreaming.EventCriteria; +import org.axonframework.messaging.eventstreaming.StreamableEventSource; +import org.axonframework.messaging.eventstreaming.TrackingTokenSource; +import org.axonframework.messaging.core.MessageHandlerInterceptor; +import org.axonframework.messaging.core.QualifiedName; +import org.axonframework.messaging.core.unitofwork.ProcessingContext; +import org.axonframework.messaging.core.unitofwork.UnitOfWorkFactory; +import org.axonframework.messaging.monitoring.MessageMonitor; + +import java.time.Clock; +import java.util.Objects; +import java.util.Set; +import java.util.concurrent.CompletableFuture; +import java.util.concurrent.ScheduledExecutorService; +import java.util.function.Consumer; +import java.util.function.Function; +import java.util.function.Supplier; + +/** + * Configuration class for a multi-tenant {@link org.axonframework.messaging.eventhandling.processing.streaming.pooled.PooledStreamingEventProcessor}. + *

    + * Extends {@link PooledStreamingEventProcessorConfiguration} to add multi-tenant specific configuration options, + * primarily the ability to configure a {@link TenantTokenStoreFactory} for per-processor token store customization. + *

    + * This allows different multi-tenant processors to use different token store strategies, overriding the globally + * configured {@link TenantTokenStoreFactory} when needed. + * + * @author Theo Emanuelsson + * @since 5.0.0 + * @see PooledStreamingEventProcessorConfiguration + * @see TenantTokenStoreFactory + */ +public class MultiTenantPooledStreamingEventProcessorConfiguration extends PooledStreamingEventProcessorConfiguration { + + private TenantTokenStoreFactory tenantTokenStoreFactory; + + /** + * Constructs a new {@code MultiTenantPooledStreamingEventProcessorConfiguration} with just default values. + */ + public MultiTenantPooledStreamingEventProcessorConfiguration() { + super(); + } + + /** + * Constructs a new {@code MultiTenantPooledStreamingEventProcessorConfiguration} copying properties from the given + * configuration. + * + * @param base The {@link EventProcessorConfiguration} to copy properties from. + */ + public MultiTenantPooledStreamingEventProcessorConfiguration(@Nonnull EventProcessorConfiguration base) { + super(base); + } + + /** + * Constructs a new {@code MultiTenantPooledStreamingEventProcessorConfiguration} with default values and retrieve + * global default values. + * + * @param base The {@link EventProcessorConfiguration} to copy properties from. + * @param configuration The configuration, used to retrieve global default values. + */ + public MultiTenantPooledStreamingEventProcessorConfiguration( + @Nonnull EventProcessorConfiguration base, + @Nonnull Configuration configuration + ) { + super(base, configuration); + } + + /** + * Sets the {@link TenantTokenStoreFactory} to use for creating per-tenant token stores. + *

    + * If not set, the globally configured {@link TenantTokenStoreFactory} will be used. + * If no global factory is configured, an {@link InMemoryTenantTokenStoreFactory} is used as default. + * + * @param tenantTokenStoreFactory The factory to create per-tenant token stores. + * @return The current instance, for fluent interfacing. + */ + public MultiTenantPooledStreamingEventProcessorConfiguration tenantTokenStoreFactory( + @Nonnull TenantTokenStoreFactory tenantTokenStoreFactory + ) { + this.tenantTokenStoreFactory = Objects.requireNonNull(tenantTokenStoreFactory, + "TenantTokenStoreFactory may not be null"); + return this; + } + + /** + * Returns the configured {@link TenantTokenStoreFactory}, or {@code null} if not explicitly set. + * + * @return The configured {@link TenantTokenStoreFactory}, or {@code null}. + */ + public TenantTokenStoreFactory tenantTokenStoreFactory() { + return tenantTokenStoreFactory; + } + + // Override all fluent methods from parent to return this type for proper method chaining + + @Override + public MultiTenantPooledStreamingEventProcessorConfiguration errorHandler(@Nonnull ErrorHandler errorHandler) { + super.errorHandler(errorHandler); + return this; + } + + @Override + public MultiTenantPooledStreamingEventProcessorConfiguration messageMonitor( + @Nonnull MessageMonitor messageMonitor + ) { + super.messageMonitor(messageMonitor); + return this; + } + + @Override + public MultiTenantPooledStreamingEventProcessorConfiguration spanFactory( + @Nonnull EventProcessorSpanFactory spanFactory + ) { + super.spanFactory(spanFactory); + return this; + } + + @Override + public MultiTenantPooledStreamingEventProcessorConfiguration unitOfWorkFactory( + @Nonnull UnitOfWorkFactory unitOfWorkFactory + ) { + super.unitOfWorkFactory(unitOfWorkFactory); + return this; + } + + @Override + public MultiTenantPooledStreamingEventProcessorConfiguration eventSource( + @Nonnull StreamableEventSource eventSource + ) { + super.eventSource(eventSource); + return this; + } + + @Nonnull + @Override + public MultiTenantPooledStreamingEventProcessorConfiguration withInterceptor( + @Nonnull MessageHandlerInterceptor interceptor + ) { + super.withInterceptor(interceptor); + return this; + } + + @Override + public MultiTenantPooledStreamingEventProcessorConfiguration tokenStore(@Nonnull TokenStore tokenStore) { + super.tokenStore(tokenStore); + return this; + } + + @Override + public MultiTenantPooledStreamingEventProcessorConfiguration coordinatorExecutor( + @Nonnull ScheduledExecutorService coordinatorExecutor + ) { + super.coordinatorExecutor(coordinatorExecutor); + return this; + } + + @Override + public MultiTenantPooledStreamingEventProcessorConfiguration workerExecutor( + @Nonnull ScheduledExecutorService workerExecutor + ) { + super.workerExecutor(workerExecutor); + return this; + } + + @Override + public MultiTenantPooledStreamingEventProcessorConfiguration initialSegmentCount(int initialSegmentCount) { + super.initialSegmentCount(initialSegmentCount); + return this; + } + + @Override + public MultiTenantPooledStreamingEventProcessorConfiguration initialToken( + @Nonnull Function> initialToken + ) { + super.initialToken(initialToken); + return this; + } + + @Override + public MultiTenantPooledStreamingEventProcessorConfiguration tokenClaimInterval(long tokenClaimInterval) { + super.tokenClaimInterval(tokenClaimInterval); + return this; + } + + @Override + public MultiTenantPooledStreamingEventProcessorConfiguration maxClaimedSegments(int maxClaimedSegments) { + super.maxClaimedSegments(maxClaimedSegments); + return this; + } + + @Override + public MultiTenantPooledStreamingEventProcessorConfiguration maxSegmentProvider( + @Nonnull MaxSegmentProvider maxSegmentProvider + ) { + super.maxSegmentProvider(maxSegmentProvider); + return this; + } + + @Override + public MultiTenantPooledStreamingEventProcessorConfiguration claimExtensionThreshold( + long claimExtensionThreshold + ) { + super.claimExtensionThreshold(claimExtensionThreshold); + return this; + } + + @Override + public MultiTenantPooledStreamingEventProcessorConfiguration batchSize(int batchSize) { + super.batchSize(batchSize); + return this; + } + + @Override + public MultiTenantPooledStreamingEventProcessorConfiguration clock(@Nonnull Clock clock) { + super.clock(clock); + return this; + } + + @Override + public MultiTenantPooledStreamingEventProcessorConfiguration enableCoordinatorClaimExtension() { + super.enableCoordinatorClaimExtension(); + return this; + } + + @Override + public MultiTenantPooledStreamingEventProcessorConfiguration ignoredMessageHandler( + Consumer ignoredMessageHandler + ) { + super.ignoredMessageHandler(ignoredMessageHandler); + return this; + } + + @Override + public MultiTenantPooledStreamingEventProcessorConfiguration eventCriteria( + @Nonnull Function, EventCriteria> eventCriteriaProvider + ) { + super.eventCriteria(eventCriteriaProvider); + return this; + } + + @Override + public MultiTenantPooledStreamingEventProcessorConfiguration schedulingProcessingContextProvider( + @Nonnull Supplier schedulingProcessingContextProvider + ) { + super.schedulingProcessingContextProvider(schedulingProcessingContextProvider); + return this; + } +} diff --git a/multitenancy/src/main/java/org/axonframework/extension/multitenancy/messaging/eventhandling/processing/MultiTenantPooledStreamingEventProcessorModule.java b/multitenancy/src/main/java/org/axonframework/extension/multitenancy/messaging/eventhandling/processing/MultiTenantPooledStreamingEventProcessorModule.java new file mode 100644 index 0000000..b39666c --- /dev/null +++ b/multitenancy/src/main/java/org/axonframework/extension/multitenancy/messaging/eventhandling/processing/MultiTenantPooledStreamingEventProcessorModule.java @@ -0,0 +1,406 @@ +/* + * Copyright (c) 2010-2025. Axon Framework + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.axonframework.extension.multitenancy.messaging.eventhandling.processing; + +import jakarta.annotation.Nonnull; +import org.axonframework.common.AxonThreadFactory; +import org.axonframework.common.configuration.BaseModule; +import org.axonframework.common.configuration.ComponentBuilder; +import org.axonframework.common.configuration.ComponentDefinition; +import org.axonframework.common.configuration.Configuration; +import org.axonframework.common.configuration.ModuleBuilder; +import org.axonframework.common.lifecycle.Phase; +import org.axonframework.extension.multitenancy.core.TargetTenantResolver; +import org.axonframework.extension.multitenancy.core.TenantComponentFactory; +import org.axonframework.extension.multitenancy.messaging.core.annotation.TenantComponentResolverFactory; +import org.axonframework.extension.multitenancy.core.TenantProvider; +import org.axonframework.extension.multitenancy.eventsourcing.eventstore.TenantEventStoreProvider; +import org.axonframework.messaging.core.Message; +import org.axonframework.eventsourcing.eventstore.EventStore; +import org.axonframework.messaging.eventhandling.EventHandlingComponent; +import org.axonframework.messaging.eventhandling.configuration.DefaultEventHandlingComponentsConfigurer; +import org.axonframework.messaging.eventhandling.configuration.EventHandlingComponentsConfigurer; +import org.axonframework.messaging.eventhandling.configuration.EventProcessorConfiguration; +import org.axonframework.messaging.eventhandling.configuration.EventProcessorModule; +import org.axonframework.messaging.eventhandling.configuration.EventProcessorCustomization; +import org.axonframework.messaging.eventhandling.interception.InterceptingEventHandlingComponent; +import org.axonframework.messaging.eventhandling.processing.streaming.pooled.PooledStreamingEventProcessorModule; +import org.axonframework.messaging.eventhandling.processing.EventProcessor; +import org.axonframework.messaging.eventhandling.processing.streaming.pooled.PooledStreamingEventProcessor; +import org.axonframework.messaging.eventhandling.processing.streaming.segmenting.SequenceCachingEventHandlingComponent; +import org.axonframework.messaging.eventhandling.processing.streaming.token.store.TokenStore; +import org.axonframework.messaging.core.annotation.ParameterResolverFactory; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +import java.util.ArrayList; +import java.util.List; +import java.util.Objects; +import java.util.concurrent.Executors; +import java.util.concurrent.ScheduledExecutorService; +import java.util.function.BiFunction; +import java.util.function.Function; +import java.util.stream.IntStream; + +/** + * A configuration module for creating a {@link MultiTenantEventProcessor} that wraps + * per-tenant {@link PooledStreamingEventProcessor} instances. + *

    + * This module follows the same pattern as {@link org.axonframework.messaging.eventhandling.processing.streaming.pooled.PooledStreamingEventProcessorModule} + * but creates a multi-tenant aware processor that: + *

      + *
    • Creates separate {@link PooledStreamingEventProcessor} instances for each tenant
      • + *
    • Routes to tenant-specific event stores via {@link MultiTenantEventStore}
      • + *
    • Uses tenant-specific token stores via {@link TenantTokenStoreFactory}
      • + *
    • Dynamically adds/removes tenant processors as tenants are registered/unregistered
      • + *
    + *

    + * Example usage: + * 

    {@code
+ * configurer.messaging(m -> m
+ *     .eventProcessing(ep -> ep
+ *         .pooledStreaming(ps -> ps
+ *             .processor(
+ *                 MultiTenantPooledStreamingEventProcessorModule.create("orderProjection")
+ *                     .eventHandlingComponents(c -> c.autodetected(cfg -> new OrderProjection()))
+ *                     .customized((cfg, config) -> config.batchSize(100))
+ *             )
+ *         )
+ *     )
+ * );
+ * }
    + * + * @author Theo Emanuelsson + * @since 5.0.0 + * @see MultiTenantEventProcessor + * @see TenantTokenStoreFactory + */ +public class MultiTenantPooledStreamingEventProcessorModule extends BaseModule + implements EventProcessorModule, ModuleBuilder, + EventProcessorModule.EventHandlingPhase, + EventProcessorModule.CustomizationPhase { + + private static final Logger logger = LoggerFactory.getLogger(MultiTenantPooledStreamingEventProcessorModule.class); + + private final String processorName; + private List> eventHandlingComponentBuilders; + private BiFunction instanceCustomization; + private final List> tenantComponentRegistrations = new ArrayList<>(); + + /** + * Holds a tenant component registration: the type and its factory. + */ + private record TenantComponentRegistration(Class componentType, TenantComponentFactory factory) { + } + + /** + * Creates a new multi-tenant pooled streaming event processor module with the given name. + * + * @param processorName The name of the processor. + * @return A new module instance in the event handling configuration phase. + */ + public static EventHandlingPhase create( + @Nonnull String processorName + ) { + return new MultiTenantPooledStreamingEventProcessorModule(processorName); + } + + /** + * Constructs a module with the given processor name. + * + * @param processorName The unique name for the multi-tenant event processor. + */ + public MultiTenantPooledStreamingEventProcessorModule(@Nonnull String processorName) { + super(processorName); + this.processorName = Objects.requireNonNull(processorName, "Processor name must not be null"); + this.instanceCustomization = (cfg, config) -> config; + } + + @Override + public CustomizationPhase eventHandlingComponents( + @Nonnull Function configurerTask + ) { + var configurer = new DefaultEventHandlingComponentsConfigurer(); + this.eventHandlingComponentBuilders = configurerTask.apply(configurer).toList(); + return this; + } + + @Override + public MultiTenantPooledStreamingEventProcessorModule customized( + @Nonnull BiFunction instanceCustomization + ) { + this.instanceCustomization = Objects.requireNonNull(instanceCustomization); + return this; + } + + /** + * Registers a tenant-scoped component that will be resolved per-tenant in event handlers. + *

    + * When an event handler has a parameter of the specified component type, the framework will + * automatically inject the tenant-scoped instance based on the event's tenant context. + *

    + * Multiple tenant components can be registered on the same processor: + * 

    {@code
+     * MultiTenantPooledStreamingEventProcessorModule
+     *     .create("OrderProjection")
+     *     .eventHandlingComponents(c -> c.autodetected(cfg -> new OrderProjector()))
+     *     .tenantComponent(OrderRepository.class, tenant -> new InMemoryOrderRepository())
+     *     .tenantComponent(MetricsService.class, tenant -> new TenantMetrics(tenant.tenantId()))
+     *     .build();
+     * }
    + *

    + * The handler can then receive these components as method parameters: + * 

    {@code
+     * @EventHandler
+     * void handle(OrderCreated event, OrderRepository repo, MetricsService metrics) {
+     *     repo.save(new OrderProjection(event));
+     *     metrics.recordEvent("order.created");
+     * }
+     * }
    + * + * @param componentType The type of component to register + * @param factory Factory that creates component instances per tenant + * @param The component type + * @return This module for fluent configuration + */ + public MultiTenantPooledStreamingEventProcessorModule tenantComponent( + @Nonnull Class componentType, + @Nonnull TenantComponentFactory factory + ) { + Objects.requireNonNull(componentType, "Component type must not be null"); + Objects.requireNonNull(factory, "Factory must not be null"); + tenantComponentRegistrations.add(new TenantComponentRegistration<>(componentType, factory)); + return this; + } + + @Override + public MultiTenantPooledStreamingEventProcessorModule build() { + logger.debug("Building MultiTenantPooledStreamingEventProcessorModule [{}]", processorName); + registerTenantComponentResolverFactory(); + registerEventHandlingComponents(); + registerMultiTenantEventProcessor(); + return this; + } + + @SuppressWarnings("unchecked") + private void registerTenantComponentResolverFactory() { + if (tenantComponentRegistrations.isEmpty()) { + return; + } + + // Register as ParameterResolverFactory so it's picked up by parameter resolution + String resolverFactoryName = "TenantComponentResolverFactory[" + processorName + "]"; + componentRegistry(cr -> cr.registerComponent( + ParameterResolverFactory.class, + resolverFactoryName, + config -> { + TargetTenantResolver tenantResolver = config.getComponent(TargetTenantResolver.class); + TenantComponentResolverFactory factory = new TenantComponentResolverFactory(tenantResolver); + + // Register all tenant components + for (TenantComponentRegistration registration : tenantComponentRegistrations) { + registerTenantComponent(factory, registration); + } + + // Subscribe registries to tenant provider for lifecycle management + TenantProvider tenantProvider = config.getComponent(TenantProvider.class); + if (tenantProvider != null) { + factory.getRegistries().values().forEach(registry -> { + tenantProvider.subscribe(registry); + tenantProvider.getTenants().forEach(registry::registerTenant); + }); + } + + return factory; + } + )); + } + + @SuppressWarnings("unchecked") + private void registerTenantComponent(TenantComponentResolverFactory factory, + TenantComponentRegistration registration) { + factory.registerComponent(registration.componentType(), registration.factory()); + } + + private void registerEventHandlingComponents() { + for (int i = 0; i < eventHandlingComponentBuilders.size(); i++) { + var componentBuilder = eventHandlingComponentBuilders.get(i); + var componentName = processorEventHandlingComponentName(i); + componentRegistry(cr -> { + cr.registerComponent(EventHandlingComponent.class, componentName, + cfg -> { + var component = componentBuilder.build(cfg); + return new SequenceCachingEventHandlingComponent(component); + }); + cr.registerDecorator(EventHandlingComponent.class, componentName, + InterceptingEventHandlingComponent.DECORATION_ORDER, + (config, name, delegate) -> { + var processorConfig = getBaseConfiguration(config); + return new InterceptingEventHandlingComponent( + processorConfig.interceptors(), + delegate + ); + }); + }); + } + } + + private void registerMultiTenantEventProcessor() { + var processorComponentDefinition = ComponentDefinition + .ofTypeAndName(EventProcessor.class, processorName) + .withBuilder(this::buildMultiTenantEventProcessor) + .onStart(Phase.INBOUND_EVENT_CONNECTORS, (cfg, component) -> { + return component.start(); + }) + .onShutdown(Phase.INBOUND_EVENT_CONNECTORS, (cfg, component) -> { + return component.shutdown(); + }); + + componentRegistry(cr -> cr.registerComponent(processorComponentDefinition)); + } + + private MultiTenantEventProcessor buildMultiTenantEventProcessor(Configuration config) { + logger.debug("Creating MultiTenantEventProcessor [{}]", processorName); + + // Get required components + TenantEventStoreProvider tenantEventStoreProvider = config.getComponent(TenantEventStoreProvider.class); + TenantProvider tenantProvider = config.getComponent(TenantProvider.class); + + // Get the event handling components (shared across all tenants) + List eventHandlingComponents = getEventHandlingComponents(config); + + // Get base configuration for non-tenant-specific settings + MultiTenantPooledStreamingEventProcessorConfiguration baseConfig = getBaseConfiguration(config); + + // Use per-processor token store factory if configured, otherwise fall back to global + TenantTokenStoreFactory tokenStoreFactory = baseConfig.tenantTokenStoreFactory() != null + ? baseConfig.tenantTokenStoreFactory() + : config.getComponent(TenantTokenStoreFactory.class, InMemoryTenantTokenStoreFactory::new); + + // Create the tenant segment factory + TenantEventProcessorSegmentFactory segmentFactory = tenant -> { + logger.debug("Creating PooledStreamingEventProcessor for tenant [{}]", tenant.tenantId()); + + // Get tenant-specific components + EventStore tenantEventStore = tenantEventStoreProvider.tenantSegments().get(tenant); + if (tenantEventStore == null) { + throw new IllegalStateException( + "No event store segment found for tenant [" + tenant.tenantId() + "]. " + + "Ensure the tenant is registered with the MultiTenantEventStore." + ); + } + TokenStore tenantTokenStore = tokenStoreFactory.apply(tenant); + + // Create tenant-specific configuration with dedicated executors + // Must pass config to get proper ApplicationContext for sequencing policy + String tenantProcessorName = processorName + "@" + tenant.tenantId(); + MultiTenantPooledStreamingEventProcessorConfiguration tenantConfig = new MultiTenantPooledStreamingEventProcessorConfiguration(baseConfig, config) + .eventSource(tenantEventStore) + .tokenStore(tenantTokenStore) + .coordinatorExecutor(createExecutor("Coordinator[" + tenantProcessorName + "]")) + .workerExecutor(createExecutor("WorkPackage[" + tenantProcessorName + "]")); + + // Create the per-tenant processor + return new PooledStreamingEventProcessor( + tenantProcessorName, + eventHandlingComponents, + tenantConfig + ); + }; + + // Build the multi-tenant processor + MultiTenantEventProcessor multiTenantProcessor = MultiTenantEventProcessor.builder() + .name(processorName) + .tenantSegmentFactory(segmentFactory) + .build(); + + // Subscribe to tenant provider for dynamic tenant management + if (tenantProvider != null) { + tenantProvider.subscribe(multiTenantProcessor); + // Register existing tenants + tenantProvider.getTenants().forEach(multiTenantProcessor::registerTenant); + } + + logger.debug("Created MultiTenantEventProcessor [{}]", processorName); + return multiTenantProcessor; + } + + /** + * Builds the base configuration using the same layered approach as the framework's + * {@link PooledStreamingEventProcessorModule}: + *
      + *
    1. Start with {@link EventProcessorConfiguration} that includes shared interceptors
      2. + *
    2. Apply shared {@link EventProcessorCustomization} (applies to all processor types)
      3. + *
    3. Apply type-specific {@link PooledStreamingEventProcessorModule.Customization} (applies to all pooled streaming processors)
      4. + *
    4. Apply instance-specific customization
      5. + *
    + * This ensures that configuration set at any level (shared, type-specific, or instance) + * works seamlessly whether using the standard module or this multi-tenant module. + */ + private MultiTenantPooledStreamingEventProcessorConfiguration getBaseConfiguration(Configuration config) { + // Layer 1 & 2: Create base config with shared customization applied + // This mirrors PooledStreamingEventProcessorModule.defaultEventProcessorsConfiguration() + MultiTenantPooledStreamingEventProcessorConfiguration baseConfig = new MultiTenantPooledStreamingEventProcessorConfiguration( + parentSharedCustomizationOrDefault(config) + .apply(config, new EventProcessorConfiguration(config)), + config + ); + + // Layer 3: Apply type-specific customization for pooled streaming processors + // This picks up any PooledStreamingEventProcessorModule.Customization registered in config + // The customization mutates the config in-place, so we pass our instance + typeSpecificCustomizationOrNoOp(config).apply(config, baseConfig); + + // Layer 4: Apply instance-specific customization + return instanceCustomization.apply(config, baseConfig); + } + + /** + * Gets the shared customization that applies to ALL event processor types. + */ + private static EventProcessorCustomization parentSharedCustomizationOrDefault(Configuration config) { + return config.getOptionalComponent(EventProcessorCustomization.class) + .orElseGet(EventProcessorCustomization::noOp); + } + + /** + * Gets the type-specific customization that applies to all pooled streaming processors. + * This allows users to configure defaults for all pooled streaming processors (both standard and multi-tenant) + * via {@link PooledStreamingEventProcessorModule.Customization}. + */ + private static PooledStreamingEventProcessorModule.Customization typeSpecificCustomizationOrNoOp(Configuration config) { + return config.getOptionalComponent(PooledStreamingEventProcessorModule.Customization.class) + .orElseGet(PooledStreamingEventProcessorModule.Customization::noOp); + } + + private List getEventHandlingComponents(Configuration config) { + return IntStream.range(0, eventHandlingComponentBuilders.size()) + .mapToObj(i -> { + String componentName = processorEventHandlingComponentName(i); + return config.getComponent(EventHandlingComponent.class, componentName); + }) + .toList(); + } + + @Nonnull + private String processorEventHandlingComponentName(int index) { + return "EventHandlingComponent[" + processorName + "][" + index + "]"; + } + + private ScheduledExecutorService createExecutor(String name) { + return Executors.newScheduledThreadPool(1, new AxonThreadFactory(name)); + } +} diff --git a/multitenancy/src/main/java/org/axonframework/extension/multitenancy/messaging/eventhandling/processing/TenantConnectionProviderFactory.java b/multitenancy/src/main/java/org/axonframework/extension/multitenancy/messaging/eventhandling/processing/TenantConnectionProviderFactory.java new file mode 100644 index 0000000..1adfdfc --- /dev/null +++ b/multitenancy/src/main/java/org/axonframework/extension/multitenancy/messaging/eventhandling/processing/TenantConnectionProviderFactory.java @@ -0,0 +1,57 @@ +/* + * Copyright (c) 2010-2025. Axon Framework + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.axonframework.extension.multitenancy.messaging.eventhandling.processing; + +import org.axonframework.common.jdbc.ConnectionProvider; +import org.axonframework.extension.multitenancy.core.TenantDescriptor; + +import java.util.function.Function; + +/** + * Factory for creating tenant-specific {@link ConnectionProvider} instances. + *

    + * This factory is used by {@link JdbcTenantTokenStoreFactory} to create + * per-tenant JDBC connections for token storage. + *

    + * Implementations should ensure that each tenant gets connections to the appropriate + * database. For example, when using a database-per-tenant architecture, each tenant's + * {@link ConnectionProvider} should return connections to that tenant's specific database. + *

    + * Example implementation using DataSource per tenant: + * 

    {@code
+ * TenantConnectionProviderFactory factory = tenant -> {
+ *     DataSource tenantDataSource = getDataSourceForTenant(tenant);
+ *     return tenantDataSource::getConnection;
+ * };
+ * }
    + * + * @author Theo Emanuelsson + * @since 5.0.0 + * @see ConnectionProvider + * @see JdbcTenantTokenStoreFactory + */ +@FunctionalInterface +public interface TenantConnectionProviderFactory extends Function { + + /** + * Creates or retrieves a {@link ConnectionProvider} for the specified tenant. + * + * @param tenant The tenant descriptor identifying the tenant. + * @return A {@link ConnectionProvider} that provides connections to the tenant's database. + */ + @Override + ConnectionProvider apply(TenantDescriptor tenant); +} diff --git a/multitenancy/src/main/java/org/axonframework/extensions/multitenancy/components/eventhandeling/TenantEventProcessorSegmentFactory.java b/multitenancy/src/main/java/org/axonframework/extension/multitenancy/messaging/eventhandling/processing/TenantEventProcessorSegmentFactory.java similarity index 74% rename from multitenancy/src/main/java/org/axonframework/extensions/multitenancy/components/eventhandeling/TenantEventProcessorSegmentFactory.java rename to multitenancy/src/main/java/org/axonframework/extension/multitenancy/messaging/eventhandling/processing/TenantEventProcessorSegmentFactory.java index 1d04db7..b86129a 100644 --- a/multitenancy/src/main/java/org/axonframework/extensions/multitenancy/components/eventhandeling/TenantEventProcessorSegmentFactory.java +++ b/multitenancy/src/main/java/org/axonframework/extension/multitenancy/messaging/eventhandling/processing/TenantEventProcessorSegmentFactory.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 2010-2023. Axon Framework + * Copyright (c) 2010-2025. Axon Framework * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -13,10 +13,10 @@ * See the License for the specific language governing permissions and * limitations under the License. */ -package org.axonframework.extensions.multitenancy.components.eventhandeling; +package org.axonframework.extension.multitenancy.messaging.eventhandling.processing; -import org.axonframework.eventhandling.EventProcessor; -import org.axonframework.extensions.multitenancy.components.TenantDescriptor; +import org.axonframework.extension.multitenancy.core.TenantDescriptor; +import org.axonframework.messaging.eventhandling.processing.EventProcessor; import java.util.function.Function; @@ -25,7 +25,8 @@ * created, it may be started automatically by the factory. * * @author Stefan Dragisic - * @since 4.6.0 + * @author Theo Emanuelsson + * @since 5.0.0 */ public interface TenantEventProcessorSegmentFactory extends Function { diff --git a/multitenancy/src/main/java/org/axonframework/extension/multitenancy/messaging/eventhandling/processing/TenantTokenStoreFactory.java b/multitenancy/src/main/java/org/axonframework/extension/multitenancy/messaging/eventhandling/processing/TenantTokenStoreFactory.java new file mode 100644 index 0000000..6f3c43e --- /dev/null +++ b/multitenancy/src/main/java/org/axonframework/extension/multitenancy/messaging/eventhandling/processing/TenantTokenStoreFactory.java @@ -0,0 +1,48 @@ +/* + * Copyright (c) 2010-2025. Axon Framework + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.axonframework.extension.multitenancy.messaging.eventhandling.processing; + +import org.axonframework.extension.multitenancy.core.TenantDescriptor; +import org.axonframework.messaging.eventhandling.processing.streaming.token.store.TokenStore; + +import java.util.function.Function; + +/** + * Factory for creating tenant-specific {@link TokenStore} instances. + *

    + * This factory is used by {@link MultiTenantPooledStreamingEventProcessorModule} to create + * per-tenant token stores for tracking event processing progress. + *

    + * Implementations should ensure that each tenant gets an isolated token store to prevent + * token conflicts between tenants. + * + * @author Theo Emanuelsson + * @since 5.0.0 + * @see TokenStore + * @see MultiTenantPooledStreamingEventProcessorModule + */ +@FunctionalInterface +public interface TenantTokenStoreFactory extends Function { + + /** + * Creates or retrieves a {@link TokenStore} for the specified tenant. + * + * @param tenant The tenant descriptor identifying the tenant. + * @return A {@link TokenStore} instance for the specified tenant. + */ + @Override + TokenStore apply(TenantDescriptor tenant); +} diff --git a/multitenancy/src/main/java/org/axonframework/extension/multitenancy/messaging/queryhandling/MultiTenantQueryBus.java b/multitenancy/src/main/java/org/axonframework/extension/multitenancy/messaging/queryhandling/MultiTenantQueryBus.java new file mode 100644 index 0000000..5e21f9d --- /dev/null +++ b/multitenancy/src/main/java/org/axonframework/extension/multitenancy/messaging/queryhandling/MultiTenantQueryBus.java @@ -0,0 +1,305 @@ +/* + * Copyright (c) 2010-2025. Axon Framework + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.axonframework.extension.multitenancy.messaging.queryhandling; + +import jakarta.annotation.Nonnull; +import jakarta.annotation.Nullable; +import org.axonframework.common.AxonConfigurationException; +import org.axonframework.common.Registration; +import org.axonframework.common.infra.ComponentDescriptor; +import org.axonframework.extension.multitenancy.core.MultiTenantAwareComponent; +import org.axonframework.extension.multitenancy.core.NoSuchTenantException; +import org.axonframework.extension.multitenancy.core.TargetTenantResolver; +import org.axonframework.extension.multitenancy.core.TenantDescriptor; +import org.axonframework.messaging.core.Message; +import org.axonframework.messaging.core.MessageStream; +import org.axonframework.messaging.core.QualifiedName; +import org.axonframework.messaging.core.unitofwork.ProcessingContext; +import org.axonframework.messaging.queryhandling.QueryBus; +import org.axonframework.messaging.queryhandling.QueryHandler; +import org.axonframework.messaging.queryhandling.QueryMessage; +import org.axonframework.messaging.queryhandling.QueryResponseMessage; +import org.axonframework.messaging.queryhandling.SubscriptionQueryUpdateMessage; + +import java.util.Map; +import java.util.concurrent.CompletableFuture; +import java.util.concurrent.ConcurrentHashMap; +import java.util.function.Predicate; +import java.util.function.Supplier; + +import static org.axonframework.common.BuilderUtils.assertNonNull; + +/** + * Implementation of a {@link QueryBus} that is aware of multiple tenant instances of a {@code QueryBus}. Each + * {@code QueryBus} instance is considered a "tenant". + *

    + * The {@code MultiTenantQueryBus} relies on a {@link TargetTenantResolver} to dispatch queries via resolved tenant + * segment of the {@code QueryBus}. {@link TenantQuerySegmentFactory} is a factory to create the tenant segment. + * + * @author Stefan Dragisic + * @author Steven van Beelen + * @author Theo Emanuelsson + * @since 5.0.0 + */ +public class MultiTenantQueryBus implements QueryBus, MultiTenantAwareComponent { + + /** + * The order in which the {@link MultiTenantQueryBus} is applied as a decorator to the {@link QueryBus}. + */ + public static final int DECORATION_ORDER = Integer.MIN_VALUE + 50; + + private final Map handlers = new ConcurrentHashMap<>(); + private final Map tenantSegments = new ConcurrentHashMap<>(); + + private final TenantQuerySegmentFactory tenantSegmentFactory; + private final TargetTenantResolver targetTenantResolver; + + /** + * Instantiate a {@link MultiTenantQueryBus} based on the given {@link Builder builder}. + * + * @param builder The {@link Builder} used to instantiate a {@link MultiTenantQueryBus} instance with. + */ + protected MultiTenantQueryBus(Builder builder) { + builder.validate(); + this.tenantSegmentFactory = builder.tenantSegmentFactory; + this.targetTenantResolver = builder.targetTenantResolver; + } + + /** + * Instantiate a builder to be able to construct a {@link MultiTenantQueryBus}. + *

    + * The {@link TenantQuerySegmentFactory} and {@link TargetTenantResolver} are hard requirements and as such + * should be provided. + * + * @return A Builder to be able to create a {@link MultiTenantQueryBus}. + */ + public static Builder builder() { + return new Builder(); + } + + @Nonnull + @Override + public MessageStream query(@Nonnull QueryMessage query, + @Nullable ProcessingContext context) { + try { + return resolveTenant(query).query(query, context); + } catch (NoSuchTenantException e) { + return MessageStream.failed(e); + } + } + + @Nonnull + @Override + public MessageStream subscriptionQuery(@Nonnull QueryMessage query, + @Nullable ProcessingContext context, + int updateBufferSize) { + try { + return resolveTenant(query).subscriptionQuery(query, context, updateBufferSize); + } catch (NoSuchTenantException e) { + return MessageStream.failed(e); + } + } + + @Nonnull + @Override + public MessageStream subscribeToUpdates(@Nonnull QueryMessage query, + int updateBufferSize) { + try { + return resolveTenant(query).subscribeToUpdates(query, updateBufferSize); + } catch (NoSuchTenantException e) { + return MessageStream.failed(e); + } + } + + @Nonnull + @Override + public CompletableFuture emitUpdate(@Nonnull Predicate filter, + @Nonnull Supplier updateSupplier, + @Nullable ProcessingContext context) { + try { + return resolveTenantFromContext(context).emitUpdate(filter, updateSupplier, context); + } catch (NoSuchTenantException | IllegalStateException e) { + return CompletableFuture.failedFuture(e); + } + } + + @Nonnull + @Override + public CompletableFuture completeSubscriptions(@Nonnull Predicate filter, + @Nullable ProcessingContext context) { + try { + return resolveTenantFromContext(context).completeSubscriptions(filter, context); + } catch (NoSuchTenantException | IllegalStateException e) { + return CompletableFuture.failedFuture(e); + } + } + + @Nonnull + @Override + public CompletableFuture completeSubscriptionsExceptionally(@Nonnull Predicate filter, + @Nonnull Throwable cause, + @Nullable ProcessingContext context) { + try { + return resolveTenantFromContext(context).completeSubscriptionsExceptionally(filter, cause, context); + } catch (NoSuchTenantException | IllegalStateException e) { + return CompletableFuture.failedFuture(e); + } + } + + private QueryBus resolveTenantFromContext(@Nullable ProcessingContext context) { + if (context == null) { + throw new IllegalStateException( + "Cannot resolve tenant for subscription query update: ProcessingContext is required" + ); + } + Message message = Message.fromContext(context); + if (message == null) { + throw new IllegalStateException( + "Cannot resolve tenant for subscription query update: no message found in ProcessingContext" + ); + } + TenantDescriptor tenantDescriptor = targetTenantResolver.resolveTenant(message, tenantSegments.keySet()); + QueryBus tenantQueryBus = tenantSegments.get(tenantDescriptor); + if (tenantQueryBus == null) { + throw NoSuchTenantException.forTenantId(tenantDescriptor.tenantId()); + } + return tenantQueryBus; + } + + @Override + public QueryBus subscribe(@Nonnull QualifiedName queryName, @Nonnull QueryHandler queryHandler) { + handlers.computeIfAbsent(queryName, k -> { + tenantSegments.forEach((tenant, segment) -> segment.subscribe(queryName, queryHandler)); + return queryHandler; + }); + return this; + } + + /** + * Returns the tenant segments managed by this {@code MultiTenantQueryBus}. + * + * @return A map of {@link TenantDescriptor} to {@link QueryBus} representing tenant segments. + */ + public Map tenantSegments() { + return tenantSegments; + } + + @Override + public Registration registerTenant(TenantDescriptor tenantDescriptor) { + QueryBus tenantSegment = tenantSegmentFactory.apply(tenantDescriptor); + tenantSegments.putIfAbsent(tenantDescriptor, tenantSegment); + + return () -> { + QueryBus delegate = unregisterTenant(tenantDescriptor); + return delegate != null; + }; + } + + private QueryBus unregisterTenant(TenantDescriptor tenantDescriptor) { + return tenantSegments.remove(tenantDescriptor); + } + + @Override + public Registration registerAndStartTenant(TenantDescriptor tenantDescriptor) { + tenantSegments.computeIfAbsent(tenantDescriptor, tenant -> { + QueryBus tenantSegment = tenantSegmentFactory.apply(tenantDescriptor); + + handlers.forEach((queryName, queryHandler) -> tenantSegment.subscribe(queryName, queryHandler)); + + return tenantSegment; + }); + + return () -> { + QueryBus delegate = unregisterTenant(tenantDescriptor); + return delegate != null; + }; + } + + private QueryBus resolveTenant(QueryMessage queryMessage) { + TenantDescriptor tenantDescriptor = targetTenantResolver.resolveTenant(queryMessage, tenantSegments.keySet()); + QueryBus tenantQueryBus = tenantSegments.get(tenantDescriptor); + if (tenantQueryBus == null) { + throw NoSuchTenantException.forTenantId(tenantDescriptor.tenantId()); + } + return tenantQueryBus; + } + + @Override + public void describeTo(@Nonnull ComponentDescriptor descriptor) { + descriptor.describeProperty("tenantSegments", tenantSegments); + } + + /** + * Builder class to instantiate a {@link MultiTenantQueryBus}. + *

    + * The {@link TenantQuerySegmentFactory} and {@link TargetTenantResolver} are hard requirements and as such + * should be provided. + */ + public static class Builder { + + protected TargetTenantResolver targetTenantResolver; + protected TenantQuerySegmentFactory tenantSegmentFactory; + + /** + * Sets the {@link TenantQuerySegmentFactory} used to build {@link QueryBus} segment for given + * {@link TenantDescriptor}. + * + * @param tenantSegmentFactory A tenant-aware {@link QueryBus} segment factory. + * @return The current builder instance, for fluent interfacing. + */ + public Builder tenantSegmentFactory(TenantQuerySegmentFactory tenantSegmentFactory) { + assertNonNull(tenantSegmentFactory, "The TenantQuerySegmentFactory is a hard requirement"); + this.tenantSegmentFactory = tenantSegmentFactory; + return this; + } + + /** + * Sets the {@link TargetTenantResolver} used to resolve a {@link TenantDescriptor} based on a + * {@link Message}. Used to find the tenant-specific {@link QueryBus} segment. + * + * @param targetTenantResolver The resolver of a {@link TenantDescriptor} based on a {@link Message}. Used + * to find the tenant-specific {@link QueryBus} segment. + * @return The current builder instance, for fluent interfacing. + */ + public Builder targetTenantResolver(TargetTenantResolver targetTenantResolver) { + assertNonNull(targetTenantResolver, "The TargetTenantResolver is a hard requirement"); + this.targetTenantResolver = targetTenantResolver; + return this; + } + + /** + * Initializes a {@link MultiTenantQueryBus} as specified through this Builder. + * + * @return a {@link MultiTenantQueryBus} as specified through this Builder. + */ + public MultiTenantQueryBus build() { + return new MultiTenantQueryBus(this); + } + + /** + * Validate whether the fields contained in this Builder as set accordingly. + * + * @throws AxonConfigurationException If one field is asserted to be incorrect according to the Builder's + * specifications. + */ + protected void validate() { + assertNonNull(targetTenantResolver, + "The TargetTenantResolver is a hard requirement and should be provided"); + assertNonNull(tenantSegmentFactory, + "The TenantQuerySegmentFactory is a hard requirement and should be provided"); + } + } +} diff --git a/multitenancy/src/main/java/org/axonframework/extensions/multitenancy/components/queryhandeling/TenantQuerySegmentFactory.java b/multitenancy/src/main/java/org/axonframework/extension/multitenancy/messaging/queryhandling/TenantQuerySegmentFactory.java similarity index 75% rename from multitenancy/src/main/java/org/axonframework/extensions/multitenancy/components/queryhandeling/TenantQuerySegmentFactory.java rename to multitenancy/src/main/java/org/axonframework/extension/multitenancy/messaging/queryhandling/TenantQuerySegmentFactory.java index 7400605..d8a922d 100644 --- a/multitenancy/src/main/java/org/axonframework/extensions/multitenancy/components/queryhandeling/TenantQuerySegmentFactory.java +++ b/multitenancy/src/main/java/org/axonframework/extension/multitenancy/messaging/queryhandling/TenantQuerySegmentFactory.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 2010-2023. Axon Framework + * Copyright (c) 2010-2025. Axon Framework * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -14,10 +14,10 @@ * limitations under the License. */ -package org.axonframework.extensions.multitenancy.components.queryhandeling; +package org.axonframework.extension.multitenancy.messaging.queryhandling; -import org.axonframework.extensions.multitenancy.components.TenantDescriptor; -import org.axonframework.queryhandling.QueryBus; +import org.axonframework.extension.multitenancy.core.TenantDescriptor; +import org.axonframework.messaging.queryhandling.QueryBus; import java.util.function.Function; @@ -26,7 +26,8 @@ * may be started automatically by the factory. * * @author Stefan Dragisic - * @since 4.6.0 + * @author Theo Emanuelsson + * @since 5.0.0 */ public interface TenantQuerySegmentFactory extends Function { diff --git a/multitenancy/src/main/java/org/axonframework/extensions/multitenancy/TenantWrappedTransactionManager.java b/multitenancy/src/main/java/org/axonframework/extensions/multitenancy/TenantWrappedTransactionManager.java deleted file mode 100644 index 8dcb9b4..0000000 --- a/multitenancy/src/main/java/org/axonframework/extensions/multitenancy/TenantWrappedTransactionManager.java +++ /dev/null @@ -1,93 +0,0 @@ -/* - * Copyright (c) 2010-2023. Axon Framework - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ -package org.axonframework.extensions.multitenancy; - -import org.axonframework.common.transaction.NoTransactionManager; -import org.axonframework.common.transaction.Transaction; -import org.axonframework.common.transaction.TransactionManager; -import org.axonframework.extensions.multitenancy.components.TenantDescriptor; - -import java.util.function.Supplier; - -/** - * Wrapper around the {@link TransactionManager} that adds the current tenant to the transaction context. Used in - * certain cases to determine the tenant of the currently active transaction, allowing infrastructure components to find - * the tenant-specific segment. - * - * @author Stefan Dragisic - * @since 4.6.0 - */ -public class TenantWrappedTransactionManager implements TransactionManager { - - private final TransactionManager delegate; - private final TenantDescriptor tenantDescriptor; - private static final ThreadLocal threadLocal = new ThreadLocal<>(); - - /** - * Creates a new {@link TenantWrappedTransactionManager} with the given {@code tenantDescriptor}. - * - * @param tenantDescriptor The tenant descriptor to be added to the transaction context. - */ - public TenantWrappedTransactionManager(TenantDescriptor tenantDescriptor) { - this.delegate = NoTransactionManager.INSTANCE; - this.tenantDescriptor = tenantDescriptor; - } - - /** - * Creates a new {@link TenantWrappedTransactionManager} with the given {@code delegate} and - * {@code tenantDescriptor}. - * - * @param delegate The delegate transaction manager. - * @param tenantDescriptor The tenant descriptor to be added to the transaction context. - */ - public TenantWrappedTransactionManager(TransactionManager delegate, - TenantDescriptor tenantDescriptor) { - this.delegate = delegate; - this.tenantDescriptor = tenantDescriptor; - } - - @Override - public Transaction startTransaction() { - threadLocal.set(tenantDescriptor); - Transaction transaction = delegate.startTransaction(); - threadLocal.remove(); - return transaction; - } - - @Override - public void executeInTransaction(Runnable task) { - threadLocal.set(tenantDescriptor); - delegate.executeInTransaction(task); - threadLocal.remove(); - } - - @Override - public T fetchInTransaction(Supplier supplier) { - threadLocal.set(tenantDescriptor); - T t = delegate.fetchInTransaction(supplier); - threadLocal.remove(); - return t; - } - - /** - * Returns the {@link TenantDescriptor tenant} that's currently active within this thread. - * - * @return The {@link TenantDescriptor tenant} that's currently active within this thread. - */ - public static TenantDescriptor getCurrentTenant() { - return threadLocal.get(); - } -} diff --git a/multitenancy/src/main/java/org/axonframework/extensions/multitenancy/components/MultiTenantDispatchInterceptorSupport.java b/multitenancy/src/main/java/org/axonframework/extensions/multitenancy/components/MultiTenantDispatchInterceptorSupport.java deleted file mode 100644 index a1fc8f1..0000000 --- a/multitenancy/src/main/java/org/axonframework/extensions/multitenancy/components/MultiTenantDispatchInterceptorSupport.java +++ /dev/null @@ -1,85 +0,0 @@ -/* - * Copyright (c) 2010-2023. Axon Framework - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -package org.axonframework.extensions.multitenancy.components; - -import org.axonframework.common.Registration; -import org.axonframework.messaging.Message; -import org.axonframework.messaging.MessageDispatchInterceptor; -import org.axonframework.messaging.MessageDispatchInterceptorSupport; - -import java.util.Collection; -import java.util.HashMap; -import java.util.List; -import java.util.Map; -import java.util.Objects; -import java.util.concurrent.CopyOnWriteArrayList; -import javax.annotation.Nonnull; - -/** - * Contract towards a tenant-aware component upon which {@link MessageDispatchInterceptor MessageDispatchInterceptors} - * are supported. - * - * @author Stefan Dragisic - * @since 4.6.0 - */ -public interface MultiTenantDispatchInterceptorSupport, B extends MessageDispatchInterceptorSupport> - extends MessageDispatchInterceptorSupport { - - /** - * Returns a collection of {@link TenantDescriptor} to tenant-specific component. - * - * @return A collection of {@link TenantDescriptor} to tenant-specific component. - */ - Map tenantSegments(); - - /** - * Returns a list of all registered {@link MessageDispatchInterceptor MessageDispatchInterceptors}. - * - * @return A list of all registered {@link MessageDispatchInterceptor MessageDispatchInterceptors}. - */ - List> getDispatchInterceptors(); - - /** - * Returns a collection of all {@link MessageDispatchInterceptor} {@link Registration Registrations} per - * {@link TenantDescriptor}. - * - * @return A collection of all {@link MessageDispatchInterceptor} {@link Registration Registrations} per - * {@link TenantDescriptor}. - */ - Map> getDispatchInterceptorsRegistration(); - - @Override - default Registration registerDispatchInterceptor( - @Nonnull MessageDispatchInterceptor dispatchInterceptor - ) { - getDispatchInterceptors().add(dispatchInterceptor); - Map> newRegistrations = new HashMap<>(); - tenantSegments().forEach( - (tenant, bus) -> newRegistrations.computeIfAbsent(tenant, t -> new CopyOnWriteArrayList<>()) - .add(bus.registerDispatchInterceptor(dispatchInterceptor)) - ); - - getDispatchInterceptorsRegistration().putAll(newRegistrations); - - return () -> newRegistrations.values().stream() - .flatMap(Collection::stream) - .filter(Objects::nonNull) - .map(Registration::cancel) - .reduce((prev, acc) -> prev && acc) - .orElse(false); - } -} diff --git a/multitenancy/src/main/java/org/axonframework/extensions/multitenancy/components/MultiTenantHandlerInterceptorSupport.java b/multitenancy/src/main/java/org/axonframework/extensions/multitenancy/components/MultiTenantHandlerInterceptorSupport.java deleted file mode 100644 index 7b9ccbd..0000000 --- a/multitenancy/src/main/java/org/axonframework/extensions/multitenancy/components/MultiTenantHandlerInterceptorSupport.java +++ /dev/null @@ -1,83 +0,0 @@ -/* - * Copyright (c) 2010-2023. Axon Framework - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -package org.axonframework.extensions.multitenancy.components; - -import org.axonframework.common.Registration; -import org.axonframework.messaging.Message; -import org.axonframework.messaging.MessageHandlerInterceptor; -import org.axonframework.messaging.MessageHandlerInterceptorSupport; - -import java.util.Collection; -import java.util.HashMap; -import java.util.List; -import java.util.Map; -import java.util.concurrent.CopyOnWriteArrayList; -import javax.annotation.Nonnull; - -/** - * Contract towards a tenant-aware component upon which {@link MessageHandlerInterceptor MessageHandlerInterceptors} are - * supported. - * - * @author Stefan Dragisic - * @since 4.6.0 - */ -public interface MultiTenantHandlerInterceptorSupport, - B extends MessageHandlerInterceptorSupport> - extends MessageHandlerInterceptorSupport { - - /** - * Returns a collection of {@link TenantDescriptor} to tenant-specific component. - * - * @return A collection of {@link TenantDescriptor} to tenant-specific component. - */ - Map tenantSegments(); - - /** - * Returns a list of all registered {@link MessageHandlerInterceptor MessageHandlerInterceptors}. - * - * @return A list of all registered {@link MessageHandlerInterceptor MessageHandlerInterceptors}. - */ - List> getHandlerInterceptors(); - - /** - * Returns a collection of all {@link MessageHandlerInterceptor} {@link Registration Registrations} per - * {@link TenantDescriptor}. - * - * @return A collection of all {@link MessageHandlerInterceptor} {@link Registration Registrations} per - * {@link TenantDescriptor}. - */ - Map> getHandlerInterceptorsRegistration(); - - @Override - default Registration registerHandlerInterceptor(@Nonnull MessageHandlerInterceptor handlerInterceptor) { - getHandlerInterceptors().add(handlerInterceptor); - Map> newRegistrations = new HashMap<>(); - tenantSegments().forEach( - (tenant, bus) -> newRegistrations.computeIfAbsent(tenant, t -> new CopyOnWriteArrayList<>()) - .add(bus.registerHandlerInterceptor(handlerInterceptor)) - ); - - getHandlerInterceptorsRegistration().putAll(newRegistrations); - - return () -> newRegistrations.values() - .stream() - .flatMap(Collection::stream) - .map(Registration::cancel) - .reduce((prev, acc) -> prev && acc) - .orElse(false); - } -} diff --git a/multitenancy/src/main/java/org/axonframework/extensions/multitenancy/components/TenantEventProcessorControlSegmentFactory.java b/multitenancy/src/main/java/org/axonframework/extensions/multitenancy/components/TenantEventProcessorControlSegmentFactory.java deleted file mode 100644 index 78b4665..0000000 --- a/multitenancy/src/main/java/org/axonframework/extensions/multitenancy/components/TenantEventProcessorControlSegmentFactory.java +++ /dev/null @@ -1,33 +0,0 @@ -/* - * Copyright (c) 2010-2024. Axon Framework - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -package org.axonframework.extensions.multitenancy.components; - -import java.util.function.Function; - -/** - * Maps a tenant id to the context name for the EventProcessorControlService. - *

    - * This interface is used to create a mapping between a given {@link TenantDescriptor} and a context name. After a - * mapping is created, it will be used by EventProcessorControlService to associate event processor control with the - * given context. - * - * @author Stefan Dragisic - * @since 4.9.3 - */ -public interface TenantEventProcessorControlSegmentFactory extends Function { - -} \ No newline at end of file diff --git a/multitenancy/src/main/java/org/axonframework/extensions/multitenancy/components/deadletterqueue/MultiTenantDeadLetterProcessor.java b/multitenancy/src/main/java/org/axonframework/extensions/multitenancy/components/deadletterqueue/MultiTenantDeadLetterProcessor.java deleted file mode 100644 index b285232..0000000 --- a/multitenancy/src/main/java/org/axonframework/extensions/multitenancy/components/deadletterqueue/MultiTenantDeadLetterProcessor.java +++ /dev/null @@ -1,89 +0,0 @@ -/* - * Copyright (c) 2010-2023. Axon Framework - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -package org.axonframework.extensions.multitenancy.components.deadletterqueue; - -import org.axonframework.eventhandling.EventMessage; -import org.axonframework.extensions.multitenancy.TenantWrappedTransactionManager; -import org.axonframework.extensions.multitenancy.components.TenantDescriptor; -import org.axonframework.messaging.deadletter.DeadLetter; -import org.axonframework.messaging.deadletter.SequencedDeadLetterProcessor; - -import java.util.function.Predicate; - -/** - * Utility class, implementing a {@link SequencedDeadLetterProcessor} that invokes dead letter process operations on the - * correct tenant segment. This implementation will delegate the method to the correct tenant segment based on the - * provided {@link TenantDescriptor}. - * - * @author Stefan Dragisic - * @since 4.8.0 - */ -public class MultiTenantDeadLetterProcessor implements SequencedDeadLetterProcessor> { - - private TenantDescriptor tenantDescriptor; - - private final SequencedDeadLetterProcessor> delegate; - - /** - * Creates a {@link MultiTenantDeadLetterProcessor} for the given {@link SequencedDeadLetterProcessor} delegate. - * - * @param delegate The {@link SequencedDeadLetterProcessor} delegate - */ - public MultiTenantDeadLetterProcessor(SequencedDeadLetterProcessor> delegate) { - this.delegate = delegate; - } - - /** - * Creates a {@link MultiTenantDeadLetterProcessor} for the given {@link TenantDescriptor} and - * {@link SequencedDeadLetterProcessor} delegate. - * - * @param tenantDescriptor The {@link TenantDescriptor} used to determine the correct tenant segment - * @param delegate The {@link SequencedDeadLetterProcessor} delegate - */ - private MultiTenantDeadLetterProcessor(TenantDescriptor tenantDescriptor, - SequencedDeadLetterProcessor> delegate) { - this.tenantDescriptor = tenantDescriptor; - this.delegate = delegate; - } - - /** - * Sets the {@link TenantDescriptor} used to determine the correct tenant segment. - * - * @param tenantDescriptor The {@link TenantDescriptor} used to determine the correct tenant segment - * @return A {@link MultiTenantDeadLetterProcessor} with the given {@link TenantDescriptor} - */ - public MultiTenantDeadLetterProcessor forTenant(TenantDescriptor tenantDescriptor) { - return new MultiTenantDeadLetterProcessor(tenantDescriptor, delegate); - } - - @Override - public boolean process(Predicate>> sequenceFilter) { - if (tenantDescriptor == null) { - throw new IllegalStateException("Tenant descriptor is not set. Use forTenant method to set it."); - } - return new TenantWrappedTransactionManager(tenantDescriptor) - .fetchInTransaction(() -> delegate.process(sequenceFilter)); - } - - @Override - public boolean processAny() { - if (tenantDescriptor == null) { - throw new IllegalStateException("Tenant descriptor is not set. Use forTenant method to set it."); - } - return new TenantWrappedTransactionManager(tenantDescriptor).fetchInTransaction(delegate::processAny); - } -} diff --git a/multitenancy/src/main/java/org/axonframework/extensions/multitenancy/components/deadletterqueue/MultiTenantDeadLetterQueue.java b/multitenancy/src/main/java/org/axonframework/extensions/multitenancy/components/deadletterqueue/MultiTenantDeadLetterQueue.java deleted file mode 100644 index f9c5435..0000000 --- a/multitenancy/src/main/java/org/axonframework/extensions/multitenancy/components/deadletterqueue/MultiTenantDeadLetterQueue.java +++ /dev/null @@ -1,472 +0,0 @@ -/* - * Copyright (c) 2010-2023. Axon Framework - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -package org.axonframework.extensions.multitenancy.components.deadletterqueue; - -import org.axonframework.common.BuilderUtils; -import org.axonframework.common.Registration; -import org.axonframework.eventhandling.EventMessage; -import org.axonframework.extensions.multitenancy.TenantWrappedTransactionManager; -import org.axonframework.extensions.multitenancy.components.MultiTenantAwareComponent; -import org.axonframework.extensions.multitenancy.components.NoSuchTenantException; -import org.axonframework.extensions.multitenancy.components.TargetTenantResolver; -import org.axonframework.extensions.multitenancy.components.TenantDescriptor; -import org.axonframework.messaging.Message; -import org.axonframework.messaging.deadletter.DeadLetter; -import org.axonframework.messaging.deadletter.DeadLetterQueueOverflowException; -import org.axonframework.messaging.deadletter.EnqueueDecision; -import org.axonframework.messaging.deadletter.NoSuchDeadLetterException; -import org.axonframework.messaging.deadletter.SequencedDeadLetterQueue; -import org.slf4j.Logger; -import org.slf4j.LoggerFactory; - -import java.util.Collections; -import java.util.Map; -import java.util.Set; -import java.util.concurrent.ConcurrentHashMap; -import java.util.function.Consumer; -import java.util.function.Function; -import java.util.function.Predicate; -import java.util.function.Supplier; -import java.util.function.UnaryOperator; -import java.util.stream.Collectors; -import java.util.stream.StreamSupport; -import javax.annotation.Nonnull; - -import static org.axonframework.common.BuilderUtils.assertNonNull; - -/** - * Implementation of a {@link SequencedDeadLetterQueue} that is aware of the tenants in the application. This - * implementation will delegate dead-letter queue operations to the correct tenant segment based on the provided - * {@link TargetTenantResolver}. - * - * @param An implementation of {@link EventMessage} contained in the {@link DeadLetter dead letters} within this - * queue. - * @author Stefan Dragisic - * @since 4.8.0 - */ -public class MultiTenantDeadLetterQueue> - implements SequencedDeadLetterQueue, MultiTenantAwareComponent { - - private static final Logger logger = LoggerFactory.getLogger(MultiTenantDeadLetterQueue.class); - - private final Set tenants = Collections.newSetFromMap(new ConcurrentHashMap<>()); - private final Map> tenantSegments = new ConcurrentHashMap<>(); - private final TargetTenantResolver targetTenantResolver; - private final String processingGroup; - - private Supplier> deadLetterQueueSupplier = () -> null; - - /** - * Builder class to instantiate a {@link MultiTenantDeadLetterQueue}. - * - * @param builder The {@link Builder} used to instantiate a {@link MultiTenantDeadLetterQueue} instance. - */ - protected MultiTenantDeadLetterQueue(MultiTenantDeadLetterQueue.Builder builder) { - builder.validate(); - this.targetTenantResolver = builder.targetTenantResolver; - this.processingGroup = builder.processingGroup; - } - - /** - * Instantiate a Builder to be able to create a {@link MultiTenantDeadLetterQueue}. - *

    - * The {@link Builder#processingGroup(String) processingGroup} and - * {@link Builder#targetTenantResolver(TargetTenantResolver) TargetTenantResolver} are hard requirements and - * as such should be provided. - * - * @return a Builder to be able to create a {@link MultiTenantDeadLetterQueue}. - */ - public static > Builder builder() { - return new Builder<>(); - } - - /** - * Registers a builder function for {@link SequencedDeadLetterQueue SequencedDeadLetterQueues} that will be used by - * the tenants of this instance. - * - * @param deadLetterQueue A builder function for {@link SequencedDeadLetterQueue SequencedDeadLetterQueues} that - * will be used by the tenants of this instance. - */ - public void registerDeadLetterQueueSupplier(Supplier> deadLetterQueue) { - deadLetterQueueSupplier = deadLetterQueue; - } - - /** - * Gets the {@link SequencedDeadLetterQueue} for the given {@link TenantDescriptor}. If the tenant is not - * registered, it will return null. If the tenant is registered, but the {@link SequencedDeadLetterQueue} is not yet - * created, it will create it and return it. - * - * @param tenantDescriptor the {@link TenantDescriptor} for which to get the {@link SequencedDeadLetterQueue}. - * @return the {@link SequencedDeadLetterQueue} for the given {@link TenantDescriptor}. - */ - public SequencedDeadLetterQueue getTenantSegment(TenantDescriptor tenantDescriptor) { - return tenantSegments.computeIfAbsent(tenantDescriptor, t -> { - if (tenants.contains(tenantDescriptor)) { - return deadLetterQueueSupplier.get(); - } - return null; - }); - } - - private SequencedDeadLetterQueue resolveTenant(DeadLetter deadLetter) { - TenantDescriptor tenantDescriptor = targetTenantResolver.resolveTenant(deadLetter.message(), - tenantSegments.keySet()); - SequencedDeadLetterQueue tenantDeadLetterQueue = getTenantSegment(tenantDescriptor); - if (tenantDeadLetterQueue == null) { - throw new NoSuchTenantException(tenantDescriptor.tenantId()); - } - return tenantDeadLetterQueue; - } - - /** - * {@inheritDoc} - */ - @Override - public void enqueue(@Nonnull Object sequenceIdentifier, - @Nonnull DeadLetter letter) throws DeadLetterQueueOverflowException { - resolveTenant(letter).enqueue(sequenceIdentifier, letter); - } - - /** - * {@inheritDoc} - */ - @Override - public boolean enqueueIfPresent( - @Nonnull Object sequenceIdentifier, - Supplier> letterBuilder - ) throws DeadLetterQueueOverflowException { - return resolveTenant(letterBuilder.get()).enqueueIfPresent(sequenceIdentifier, letterBuilder); - } - - /** - * {@inheritDoc} - */ - @Override - public void evict(DeadLetter letter) { - resolveTenant(letter).evict(letter); - } - - /** - * {@inheritDoc} - */ - @Override - public void requeue( - @Nonnull DeadLetter letter, - @Nonnull UnaryOperator> letterUpdater - ) throws NoSuchDeadLetterException { - resolveTenant(letter).requeue(letter, letterUpdater); - } - - /** - * {@inheritDoc} - *

    - * If executed in tenant aware transaction, it will check if the current tenant contains the sequence identifier, - * otherwise it will check if any registered tenant contains the sequence identifier. - */ - @Override - public boolean contains(@Nonnull Object sequenceIdentifier) { - TenantDescriptor currentTenant = TenantWrappedTransactionManager.getCurrentTenant(); - if (currentTenant != null) { - return fetchFromTenantSegment(currentTenant, seg -> seg.contains(sequenceIdentifier)); - } else { - logger.info("No tenant found for current thread. Checking if any tenant contains the sequence identifier."); - return tenants.stream().anyMatch(tenant -> fetchFromTenantSegment(tenant, - seg -> seg.contains(sequenceIdentifier))); - } - } - - /** - * {@inheritDoc} - *

    - * If executed in tenant aware transaction, it will return all the {@link DeadLetter dead letters} for the given - * {@code sequenceIdentifier} for current tenant, otherwise it will return all the {@link DeadLetter dead letters} - * for the given {@code sequenceIdentifier} for any registered tenant that contains the sequence identifier. - * - * @param sequenceIdentifier The identifier of the sequence of {@link DeadLetter dead letters}to return. - * @return All the {@link DeadLetter dead letters} for the given {@code sequenceIdentifier} in insert order. - */ - @Override - public Iterable> deadLetterSequence(@Nonnull Object sequenceIdentifier) { - TenantDescriptor currentTenant = TenantWrappedTransactionManager.getCurrentTenant(); - if (currentTenant != null) { - return fetchFromTenantSegment(currentTenant, seg -> seg.deadLetterSequence(sequenceIdentifier)); - } else { - logger.info("No tenant found for current thread. Returning all tenants dead letter sequences."); - return tenants.stream() - .filter(tenant -> fetchFromTenantSegment(tenant, seg -> seg.contains(sequenceIdentifier))) - .map(tenant -> fetchFromTenantSegment(tenant, - seg -> seg.deadLetterSequence(sequenceIdentifier))) - .flatMap(it -> StreamSupport.stream(it.spliterator(), false)).collect(Collectors.toList()); - } - } - - /** - * {@inheritDoc} - *

    - * If executed in tenant aware transaction, it will return all {@link DeadLetter dead letter} sequences held by - * current tenant, otherwise it will return all {@link DeadLetter dead letter} sequences held by all registered - * tenant. - */ - @Override - public Iterable>> deadLetters() { - TenantDescriptor currentTenant = TenantWrappedTransactionManager.getCurrentTenant(); - if (currentTenant != null) { - return fetchFromTenantSegment(currentTenant, SequencedDeadLetterQueue::deadLetters); - } else { - logger.info("No tenant found for current thread. Returning all tenants dead letters."); - return tenants.stream().map(tenant -> fetchFromTenantSegment(tenant, SequencedDeadLetterQueue::deadLetters)) - .flatMap(it -> StreamSupport.stream(it.spliterator(), false)).collect(Collectors.toList()); - } - } - - /** - * {@inheritDoc} - *

    - * If executed in tenant aware transaction, it will check if the current tenant queue is full, otherwise it will - * check if any registered tenant queue is full. - */ - @Override - public boolean isFull(@Nonnull Object sequenceIdentifier) { - TenantDescriptor currentTenant = TenantWrappedTransactionManager.getCurrentTenant(); - if (currentTenant != null) { - return fetchFromTenantSegment(currentTenant, seg -> seg.isFull(sequenceIdentifier)); - } else { - logger.info("No tenant found for current thread. Checking if any of the tenants queues is full."); - return tenants.stream().anyMatch(tenant -> fetchFromTenantSegment(tenant, - seg -> seg.isFull(sequenceIdentifier))); - } - } - - /** - * {@inheritDoc} - *

    - * If executed in tenant aware transaction, it will return the number of dead letters contained in current tenant - * queue, otherwise it will return the number of dead letters contained in all registered tenants queues. - */ - @Override - public long size() { - TenantDescriptor currentTenant = TenantWrappedTransactionManager.getCurrentTenant(); - if (currentTenant != null) { - return fetchFromTenantSegment(currentTenant, SequencedDeadLetterQueue::size); - } else { - logger.info("No tenant found for current thread. Returning total size of all tenants queues."); - return tenants.stream().mapToLong(tenant -> fetchFromTenantSegment(tenant, SequencedDeadLetterQueue::size)) - .sum(); - } - } - - /** - * {@inheritDoc} - *

    - * If executed in tenant aware transaction, it will return the number of dead letters for the sequence matching the - * given {@code sequenceIdentifier} contained in current tenant queue, otherwise it will return the number of dead - * letters for the sequence matching the given {@code sequenceIdentifier} contained in any registered tenant queue, - * that contains the sequence identifier. - */ - @Override - public long sequenceSize(@Nonnull Object sequenceIdentifier) { - TenantDescriptor currentTenant = TenantWrappedTransactionManager.getCurrentTenant(); - if (currentTenant != null) { - return fetchFromTenantSegment(currentTenant, seg -> seg.sequenceSize(sequenceIdentifier)); - } else { - logger.info("No tenant found for current thread. Returning total size of sequences."); - return tenants.stream().filter(tenant -> fetchFromTenantSegment(tenant, - seg -> seg.contains(sequenceIdentifier))) - .findFirst().map(tenant -> fetchFromTenantSegment(tenant, - seg -> seg.sequenceSize(sequenceIdentifier))) - .orElse(0L); - } - } - - /** - * {@inheritDoc} - *

    - * If executed in tenant aware transaction, it will return the number of unique sequences contained in current - * tenant queue, otherwise it will return the number of unique sequences contained in all registered tenants. - */ - @Override - public long amountOfSequences() { - TenantDescriptor currentTenant = TenantWrappedTransactionManager.getCurrentTenant(); - if (currentTenant != null) { - return fetchFromTenantSegment(currentTenant, SequencedDeadLetterQueue::amountOfSequences); - } else { - logger.info("No tenant found for current thread. Returning total amount of all sequences from every tenant."); - return tenants.stream() - .mapToLong(tenant -> fetchFromTenantSegment( - tenant, SequencedDeadLetterQueue::amountOfSequences - )) - .sum(); - } - } - - /** - * {@inheritDoc} - *

    - * If executed in tenant aware transaction, it will process a sequence of enqueued {@link DeadLetter dead letters} - * through the given {@code processingTask} matching the {@code sequenceFilter} from current tenant queue, otherwise - * it will process a sequence of enqueued {@link DeadLetter dead letters} through the given {@code processingTask} - * matching the {@code sequenceFilter} from all registered tenants queues. - */ - @Override - public boolean process(@Nonnull Predicate> sequenceFilter, - @Nonnull Function, EnqueueDecision> processingTask) { - TenantDescriptor currentTenant = TenantWrappedTransactionManager.getCurrentTenant(); - if (currentTenant != null) { - return fetchFromTenantSegment(currentTenant, seg -> seg.process(sequenceFilter, processingTask)); - } else { - logger.info("No tenant found for current thread. Will process a sequence for all tenants."); - return tenants.stream() - .map(tenant -> fetchFromTenantSegment( - tenant, seg -> seg.process(sequenceFilter, processingTask) - )) - .reduce(false, (a, b) -> a || b); - } - } - - /** - * {@inheritDoc} - *

    - * If executed in tenant aware transaction, it will process a sequence of enqueued {@link DeadLetter dead letters} - * with the given {@code processingTask} from current tenant queue, otherwise it will process a sequence of enqueued - * {@link DeadLetter dead letters} with the given {@code processingTask} from all registered tenants queues. - */ - @Override - public boolean process(@Nonnull Function, EnqueueDecision> processingTask) { - TenantDescriptor currentTenant = TenantWrappedTransactionManager.getCurrentTenant(); - if (currentTenant != null) { - return fetchFromTenantSegment(currentTenant, seg -> seg.process(processingTask)); - } else { - logger.info("No tenant found for current thread. Will process a sequence for all tenants."); - return tenants.stream() - .map(tenant -> fetchFromTenantSegment(tenant, seg -> seg.process(processingTask))) - .reduce(false, (a, b) -> a || b); - } - } - - /** - * {@inheritDoc} - *

    - * If executed in tenant aware transaction, it will clear out all {@link DeadLetter dead letters} present in current - * tenant queue, otherwise it will clear out all {@link DeadLetter dead letters} all registered tenants queues. - */ - @Override - public void clear() { - TenantDescriptor currentTenant = TenantWrappedTransactionManager.getCurrentTenant(); - if (currentTenant != null) { - executeForTenantSegment(currentTenant, SequencedDeadLetterQueue::clear); - } else { - logger.info("No tenant found for current thread. Clearing queues for all tenants."); - tenants.forEach(tenant -> executeForTenantSegment(tenant, SequencedDeadLetterQueue::clear)); - } - } - - private R fetchFromTenantSegment(TenantDescriptor tenantDescriptor, - Function, R> fetchBlock) { - return new TenantWrappedTransactionManager(tenantDescriptor) - .fetchInTransaction(() -> fetchBlock.apply(getTenantSegment(tenantDescriptor))); - } - - private void executeForTenantSegment(TenantDescriptor tenantDescriptor, - Consumer> executeBlock) { - new TenantWrappedTransactionManager(tenantDescriptor).fetchInTransaction(() -> { - executeBlock.accept(getTenantSegment(tenantDescriptor)); - return null; - }); - } - - @Override - public Registration registerTenant(TenantDescriptor tenantDescriptor) { - tenants.add(tenantDescriptor); - return () -> { - tenants.remove(tenantDescriptor); - tenantSegments.remove(tenantDescriptor); - return true; - }; - } - - @Override - public Registration registerAndStartTenant(TenantDescriptor tenantDescriptor) { - return registerTenant(tenantDescriptor); - } - - /** - * Return the processing group that this queue is bound to. - * - * @return The processing group that this queue is bound to. - */ - public String processingGroup() { - return processingGroup; - } - - /** - * Builder class to instantiate a {@link MultiTenantDeadLetterQueue}. - *

    - * The {@link #processingGroup(String) processingGroup} and - * {@link #targetTenantResolver(TargetTenantResolver) TargetTenantResolver} are hard requirements and as such - * should be provided. - * - * @param The type of {@link EventMessage} contained in the {@link DeadLetter}. - */ - public static class Builder> { - - private String processingGroup; - private TargetTenantResolver targetTenantResolver; - - /** - * Sets the {@link TargetTenantResolver} used to resolve correct tenant segment based on {@link Message} - * message. - *

    - * This is a hard requirement and as such should be provided. - * - * @param targetTenantResolver used to resolve correct tenant segment based on {@link Message} message - * @return the current Builder instance, for fluent interfacing - */ - public MultiTenantDeadLetterQueue.Builder targetTenantResolver( - TargetTenantResolver targetTenantResolver) { - BuilderUtils.assertNonNull(targetTenantResolver, "The TargetTenantResolver is a hard requirement"); - this.targetTenantResolver = targetTenantResolver; - return this; - } - - /** - * Sets the processing group that this queue is bound to. - * - * @param processingGroup The processing group that this queue is bound to. - * @return the current Builder instance, for fluent interfacing - */ - public MultiTenantDeadLetterQueue.Builder processingGroup(String processingGroup) { - this.processingGroup = processingGroup; - return this; - } - - /** - * Initializes a {@link MultiTenantDeadLetterQueue} as specified through this Builder. - * - * @return a {@link MultiTenantDeadLetterQueue} as specified through this Builder - */ - public MultiTenantDeadLetterQueue build() { - return new MultiTenantDeadLetterQueue<>(this); - } - - /** - * Validates whether the fields contained in this Builder are set accordingly. - */ - protected void validate() { - assertNonNull(targetTenantResolver, "The TargetTenantResolver is a hard requirement"); - } - } -} diff --git a/multitenancy/src/main/java/org/axonframework/extensions/multitenancy/components/deadletterqueue/MultiTenantDeadLetterQueueFactory.java b/multitenancy/src/main/java/org/axonframework/extensions/multitenancy/components/deadletterqueue/MultiTenantDeadLetterQueueFactory.java deleted file mode 100644 index d4f4825..0000000 --- a/multitenancy/src/main/java/org/axonframework/extensions/multitenancy/components/deadletterqueue/MultiTenantDeadLetterQueueFactory.java +++ /dev/null @@ -1,42 +0,0 @@ -/* - * Copyright (c) 2010-2023. Axon Framework - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -package org.axonframework.extensions.multitenancy.components.deadletterqueue; - -import org.axonframework.eventhandling.EventMessage; -import org.axonframework.messaging.Message; -import org.axonframework.messaging.deadletter.DeadLetter; - -/** - * Factory for creating {@link MultiTenantDeadLetterQueue} instances. - *

    - * This factory is used to create a {@link MultiTenantDeadLetterQueue} for a specific processing group. - * - * @param An implementation of {@link Message} contained in the {@link DeadLetter dead letters} within this queue. - * @author Stefan Dragisic - * @since 4.8.0 - */ -@FunctionalInterface -public interface MultiTenantDeadLetterQueueFactory> { - - /** - * Returns a {@link MultiTenantDeadLetterQueue} for the given processing group. - * - * @param processingGroup The processing group for which to return a {@link MultiTenantDeadLetterQueue} - * @return a {@link MultiTenantDeadLetterQueue} for the given processing group - */ - MultiTenantDeadLetterQueue getDeadLetterQueue(String processingGroup); -} diff --git a/multitenancy/src/main/java/org/axonframework/extensions/multitenancy/components/eventstore/MultiTenantEventStore.java b/multitenancy/src/main/java/org/axonframework/extensions/multitenancy/components/eventstore/MultiTenantEventStore.java deleted file mode 100644 index 4bea590..0000000 --- a/multitenancy/src/main/java/org/axonframework/extensions/multitenancy/components/eventstore/MultiTenantEventStore.java +++ /dev/null @@ -1,353 +0,0 @@ -/* - * Copyright (c) 2010-2023. Axon Framework - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ -package org.axonframework.extensions.multitenancy.components.eventstore; - -import org.axonframework.common.AxonConfigurationException; -import org.axonframework.common.Registration; -import org.axonframework.common.stream.BlockingStream; -import org.axonframework.eventhandling.DomainEventMessage; -import org.axonframework.eventhandling.EventMessage; -import org.axonframework.eventhandling.MultiStreamableMessageSource; -import org.axonframework.eventhandling.TrackedEventMessage; -import org.axonframework.eventhandling.TrackingToken; -import org.axonframework.eventsourcing.eventstore.DomainEventStream; -import org.axonframework.eventsourcing.eventstore.EventStore; -import org.axonframework.extensions.multitenancy.components.*; -import org.axonframework.messaging.Message; -import org.axonframework.messaging.MessageDispatchInterceptor; -import org.axonframework.messaging.unitofwork.CurrentUnitOfWork; - -import java.time.Duration; -import java.time.Instant; -import java.util.List; -import java.util.Map; -import java.util.Objects; -import java.util.Optional; -import java.util.concurrent.ConcurrentHashMap; -import java.util.concurrent.CopyOnWriteArrayList; -import java.util.function.Consumer; -import javax.annotation.Nonnull; - -import static org.axonframework.common.BuilderUtils.assertNonNull; - - -/** - * Tenant aware implementation of the {@link EventStore}. - *

    - * Tenant-specific {@code EventStore} segments are either resolved from the - * {@link EventMessage#getMetaData() event's metadata} or from the expected existence of the - * {@link org.axonframework.messaging.unitofwork.UnitOfWork}. The {@link #openStream(TrackingToken)} operation defaults - * to returning a {@link MultiStreamableMessageSource} combining all tenant segments. - * - * @author Stefan Dragisic - * @author Steven van Beelen - * @since 4.6.0 - */ -public class MultiTenantEventStore implements - EventStore, - MultiTenantAwareComponent, - MultiTenantSubscribableMessageSource, - MultiTenantDispatchInterceptorSupport, EventStore> { - - private final Map tenantSegments = new ConcurrentHashMap<>(); - private final List>>> messageProcessors = new CopyOnWriteArrayList<>(); - private final Map subscribeRegistrations = new ConcurrentHashMap<>(); - private final List>> dispatchInterceptors = new CopyOnWriteArrayList<>(); - private final Map> dispatchInterceptorsRegistration = new ConcurrentHashMap<>(); - - private final TenantEventSegmentFactory tenantSegmentFactory; - private final TargetTenantResolver> targetTenantResolver; - - private MultiStreamableMessageSource multiSource; - - /** - * Instantiate a {@link MultiTenantEventStore} based on the given {@link Builder builder}. - * - * @param builder The {@link Builder} used to instantiate a {@link MultiTenantEventStore} instance with. - */ - protected MultiTenantEventStore(Builder builder) { - builder.validate(); - this.tenantSegmentFactory = builder.tenantSegmentFactory; - this.targetTenantResolver = builder.targetTenantResolver; - } - - /** - * Instantiate a builder to be able to construct a {@link MultiTenantEventStore} - *

    - * The {@link TenantEventSegmentFactory} and {@link TargetTenantResolver} are hard requirements and as such - * should be provided. - * - * @return A Builder to be able to create a {@link MultiTenantEventStore}. - */ - public static Builder builder() { - return new Builder(); - } - - @Override - public void publish(List> events) { - events.stream().findFirst() - .map(this::resolveTenant) - .orElseGet(this::resolveSegment) - .publish(events); - } - - @Override - public void publish(EventMessage... events) { - Optional.ofNullable(events[0]) - .map(this::resolveTenant) - .orElseGet(this::resolveSegment) - .publish(events); - } - - @Override - public Registration subscribe(@Nonnull Consumer>> messageProcessor) { - messageProcessors.add(messageProcessor); - - tenantSegments.forEach((tenant, segment) -> subscribeRegistrations.putIfAbsent( - tenant, segment.subscribe(messageProcessor) - )); - - return () -> subscribeRegistrations.values() - .stream() - .map(Registration::cancel) - .reduce((prev, acc) -> prev && acc) - .orElse(false); - } - - @Override - public Registration registerTenant(TenantDescriptor tenantDescriptor) { - EventStore tenantSegment = tenantSegmentFactory.apply(tenantDescriptor); - tenantSegments.putIfAbsent(tenantDescriptor, tenantSegment); - - return () -> { - EventStore delegate = unregisterTenant(tenantDescriptor); - return delegate != null; - }; - } - - private EventStore unregisterTenant(TenantDescriptor tenantDescriptor) { - //noinspection resource - Registration remove = subscribeRegistrations.remove(tenantDescriptor); - if (remove != null) { - remove.cancel(); - } - return tenantSegments.remove(tenantDescriptor); - } - - @Override - public Registration registerAndStartTenant(TenantDescriptor tenantDescriptor) { - tenantSegments.computeIfAbsent(tenantDescriptor, k -> { - EventStore tenantSegment = tenantSegmentFactory.apply(tenantDescriptor); - - dispatchInterceptors.forEach( - dispatchInterceptor -> - dispatchInterceptorsRegistration - .computeIfAbsent(tenantDescriptor, t -> new CopyOnWriteArrayList<>()) - .add(tenantSegment.registerDispatchInterceptor(dispatchInterceptor)) - ); - - messageProcessors.forEach(processor -> subscribeRegistrations.putIfAbsent( - tenantDescriptor, tenantSegment.subscribe(processor) - )); - - return tenantSegment; - }); - - return () -> { - EventStore delegate = unregisterTenant(tenantDescriptor); - return delegate != null; - }; - } - - private EventStore resolveTenantSilently(Message eventMessage) { - TenantDescriptor tenantDescriptor = targetTenantResolver.resolveTenant(eventMessage, tenantSegments.keySet()); - return tenantSegments.get(tenantDescriptor); - } - - private EventStore resolveTenant(Message eventMessage) { - TenantDescriptor tenantDescriptor = targetTenantResolver.resolveTenant(eventMessage, tenantSegments.keySet()); - EventStore tenantEventStore = tenantSegments.get(tenantDescriptor); - if (tenantEventStore == null) { - throw new NoSuchTenantException(tenantDescriptor.tenantId()); - } - return tenantEventStore; - } - - private EventStore resolveSegment() { - return resolveTenantSilently(CurrentUnitOfWork.get().getMessage()); - } - - @Override - public DomainEventStream readEvents(@Nonnull String aggregateIdentifier) { - return resolveSegment() - .readEvents(aggregateIdentifier); - } - - /** - * Open an event stream with the {@link EventStore} segment of the given {@code tenantDescriptor}, containing all - * domain events belonging to the given {@code aggregateIdentifier}. - *

    - * The returned stream is finite, ending with the last known event of the aggregate. If the event store - * holds no events of the given aggregate an empty stream is returned. - * - * @param aggregateIdentifier the identifier of the aggregate whose events to fetch - * @param tenantDescriptor The {@link TenantDescriptor} referring to the {@link EventStore} segment to read an - * aggregate event stream from. - * @return a stream of all currently stored events of the aggregate - */ - public DomainEventStream readEvents(@Nonnull String aggregateIdentifier, - @Nonnull TenantDescriptor tenantDescriptor) { - return tenantSegments.get(tenantDescriptor) - .readEvents(aggregateIdentifier); - } - - @Override - public void storeSnapshot(@Nonnull DomainEventMessage snapshot) { - resolveSegment() - .storeSnapshot(snapshot); - } - - /** - * Stores the given (temporary) {@code snapshot} event with the {@link EventStore} segment of the given - * {@code tenantDescriptor}, when present. This snapshot replaces the segment of the event stream identified by the - * {@code snapshot}'s {@link DomainEventMessage#getAggregateIdentifier() Aggregate Identifier} up to (and including) - * the event with the {@code snapshot}'s {@link DomainEventMessage#getSequenceNumber() sequence number}. - *

    - * These snapshots will only affect the {@link DomainEventStream} returned by the {@link #readEvents(String)} - * method. They do not change the events returned by {@link EventStore#openStream(TrackingToken)} or those received - * by using {@link #subscribe(java.util.function.Consumer)}. - *

    - * Note that snapshots are considered a temporary replacement for Events, and are used as performance optimization. - * Event Store implementations may choose to ignore or delete snapshots. - * - * @param snapshot The snapshot to replace part of the DomainEventStream. - * @param tenantDescriptor The {@link TenantDescriptor} referring to the {@link EventStore} segment to store a - * snapshot in. - */ - public void storeSnapshot(DomainEventMessage snapshot, TenantDescriptor tenantDescriptor) { - tenantSegments.get(tenantDescriptor) - .storeSnapshot(snapshot); - } - - @Override - public BlockingStream> openStream(TrackingToken trackingToken) { - return multiSource().openStream(trackingToken); - } - - private MultiStreamableMessageSource multiSource() { - if (Objects.isNull(multiSource)) { - MultiStreamableMessageSource.Builder sourceBuilder = MultiStreamableMessageSource.builder(); - tenantSegments.forEach((key, value) -> sourceBuilder.addMessageSource(key.tenantId(), value)); - this.multiSource = sourceBuilder.build(); - } - return multiSource; - } - - @Override - public TrackingToken createTailToken() { - return multiSource().createTailToken(); - } - - @Override - public TrackingToken createHeadToken() { - return multiSource().createHeadToken(); - } - - @Override - public TrackingToken createTokenAt(Instant dateTime) { - return multiSource().createTokenAt(dateTime); - } - - @Override - public TrackingToken createTokenSince(Duration duration) { - return multiSource().createTokenSince(duration); - } - - @Override - public Map tenantSegments() { - return tenantSegments; - } - - @Override - public List>> getDispatchInterceptors() { - return dispatchInterceptors; - } - - @Override - public Map> getDispatchInterceptorsRegistration() { - return dispatchInterceptorsRegistration; - } - - /** - * Builder class to instantiate a {@link MultiTenantEventStore}. - *

    - * The {@link TenantEventSegmentFactory} and {@link TargetTenantResolver} are hard requirements and as such - * should be provided. - */ - public static class Builder { - - protected TenantEventSegmentFactory tenantSegmentFactory; - protected TargetTenantResolver> targetTenantResolver; - - /** - * Sets the {@link TenantEventSegmentFactory} used to build {@link EventStore} segment for given - * {@link TenantDescriptor}. - * - * @param tenantSegmentFactory tenant aware segment factory - * @return the current Builder instance, for fluent interfacing - */ - public Builder tenantSegmentFactory(TenantEventSegmentFactory tenantSegmentFactory) { - assertNonNull(tenantSegmentFactory, "The TenantEventSegmentFactory is a hard requirement"); - this.tenantSegmentFactory = tenantSegmentFactory; - return this; - } - - /** - * Sets the {@link TargetTenantResolver} used to resolve correct tenant segment based on {@link Message} - * message - * - * @param targetTenantResolver used to resolve correct tenant segment based on {@link Message} message - * @return the current Builder instance, for fluent interfacing - */ - public Builder targetTenantResolver(TargetTenantResolver> targetTenantResolver) { - assertNonNull(targetTenantResolver, "The TargetTenantResolver is a hard requirement"); - this.targetTenantResolver = targetTenantResolver; - return this; - } - - /** - * Initializes a {@link MultiTenantEventStore} as specified through this Builder. - * - * @return a {@link MultiTenantEventStore} as specified through this Builder - */ - public MultiTenantEventStore build() { - return new MultiTenantEventStore(this); - } - - /** - * Validate whether the fields contained in this Builder as set accordingly. - * - * @throws AxonConfigurationException If one field is asserted to be incorrect according to the Builder's - * * specifications. - */ - protected void validate() { - assertNonNull(tenantSegmentFactory, - "The TenantEventProcessorSegmentFactory is a hard requirement and should be provided"); - assertNonNull(targetTenantResolver, - "The TargetTenantResolver is a hard requirement and should be provided"); - } - } -} diff --git a/multitenancy/src/main/java/org/axonframework/extensions/multitenancy/components/eventstore/MultiTenantSubscribableMessageSource.java b/multitenancy/src/main/java/org/axonframework/extensions/multitenancy/components/eventstore/MultiTenantSubscribableMessageSource.java deleted file mode 100644 index cb35e98..0000000 --- a/multitenancy/src/main/java/org/axonframework/extensions/multitenancy/components/eventstore/MultiTenantSubscribableMessageSource.java +++ /dev/null @@ -1,39 +0,0 @@ -/* - * Copyright (c) 2010-2024. Axon Framework - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ -package org.axonframework.extensions.multitenancy.components.eventstore; - -import java.util.Map; -import org.axonframework.eventhandling.EventMessage; -import org.axonframework.extensions.multitenancy.components.TenantDescriptor; -import org.axonframework.messaging.SubscribableMessageSource; - -/** - * Interface for multi-tenant message sources that can provide tenant segments. - * - * @author Stefan Dragisic - * @param The type of the tenant segment, which must extend MessageSource - * @since 4.10.0 - */ -public interface MultiTenantSubscribableMessageSource>> { - - /** - * Returns a map of tenant segments, where the key is the TenantDescriptor - * and the value is the corresponding tenant segment of type T, which extends {@link SubscribableMessageSource}. - * - * @return A map of TenantDescriptor to tenant segments - */ - Map tenantSegments(); -} diff --git a/multitenancy/src/main/java/org/axonframework/extensions/multitenancy/components/queryhandeling/MultiTenantQueryBus.java b/multitenancy/src/main/java/org/axonframework/extensions/multitenancy/components/queryhandeling/MultiTenantQueryBus.java deleted file mode 100644 index 1c11ea6..0000000 --- a/multitenancy/src/main/java/org/axonframework/extensions/multitenancy/components/queryhandeling/MultiTenantQueryBus.java +++ /dev/null @@ -1,331 +0,0 @@ -/* - * Copyright (c) 2010-2023. Axon Framework - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ -package org.axonframework.extensions.multitenancy.components.queryhandeling; - -import org.axonframework.common.AxonConfigurationException; -import org.axonframework.common.Registration; -import org.axonframework.extensions.multitenancy.components.MultiTenantAwareComponent; -import org.axonframework.extensions.multitenancy.components.MultiTenantDispatchInterceptorSupport; -import org.axonframework.extensions.multitenancy.components.MultiTenantHandlerInterceptorSupport; -import org.axonframework.extensions.multitenancy.components.NoSuchTenantException; -import org.axonframework.extensions.multitenancy.components.TargetTenantResolver; -import org.axonframework.extensions.multitenancy.components.TenantDescriptor; -import org.axonframework.messaging.MessageDispatchInterceptor; -import org.axonframework.messaging.MessageHandler; -import org.axonframework.messaging.MessageHandlerInterceptor; -import org.axonframework.messaging.unitofwork.CurrentUnitOfWork; -import org.axonframework.queryhandling.QueryBus; -import org.axonframework.queryhandling.QueryMessage; -import org.axonframework.queryhandling.QueryResponseMessage; -import org.axonframework.queryhandling.QuerySubscription; -import org.axonframework.queryhandling.QueryUpdateEmitter; -import org.axonframework.queryhandling.StreamingQueryMessage; -import org.axonframework.queryhandling.SubscriptionQueryMessage; -import org.axonframework.queryhandling.SubscriptionQueryResult; -import org.axonframework.queryhandling.SubscriptionQueryUpdateMessage; -import org.reactivestreams.Publisher; - -import java.lang.reflect.Type; -import java.util.List; -import java.util.Map; -import java.util.concurrent.CompletableFuture; -import java.util.concurrent.ConcurrentHashMap; -import java.util.concurrent.CopyOnWriteArrayList; -import java.util.concurrent.TimeUnit; -import java.util.stream.Stream; -import javax.annotation.Nonnull; - -import static org.axonframework.common.BuilderUtils.assertNonNull; - - -/** - * Implementation of a {@link QueryBus} that is aware of multiple tenant instances of a {@code QueryBus}. Each - * {@code QueryBus} instance is considered a "tenant". - *

    - * The {@code MultiTenantQueryBus} relies on a {@link TargetTenantResolver} to dispatch queries via resolved tenant - * segment of the {@code QueryBus}. {@link TenantQuerySegmentFactory} is as factory to create the tenant segment. - * - * @author Stefan Dragisic - * @author Steven van Beelen - * @since 4.6.0 - */ -public class MultiTenantQueryBus implements - QueryBus, - MultiTenantAwareComponent, - MultiTenantDispatchInterceptorSupport, QueryBus>, - MultiTenantHandlerInterceptorSupport, QueryBus> { - - private final Map> handlers = new ConcurrentHashMap<>(); - private final Map tenantSegments = new ConcurrentHashMap<>(); - private final Map subscribeRegistrations = new ConcurrentHashMap<>(); - private final List>> dispatchInterceptors = new CopyOnWriteArrayList<>(); - private final Map> dispatchInterceptorsRegistration = new ConcurrentHashMap<>(); - private final List>> handlerInterceptors = new CopyOnWriteArrayList<>(); - private final Map> handlerInterceptorsRegistration = new ConcurrentHashMap<>(); - - private final TenantQuerySegmentFactory tenantSegmentFactory; - private final TargetTenantResolver> targetTenantResolver; - - /** - * Instantiate a {@link MultiTenantQueryBus} based on the given {@link Builder builder}. - * - * @param builder The {@link Builder} used to instantiate a {@link MultiTenantQueryBus} instance with. - */ - protected MultiTenantQueryBus(Builder builder) { - builder.validate(); - this.tenantSegmentFactory = builder.tenantSegmentFactory; - this.targetTenantResolver = builder.targetTenantResolver; - } - - /** - * Instantiate a builder to be able to construct a {@link MultiTenantQueryBus}. - *

    - * The {@link TenantQuerySegmentFactory} and {@link TargetTenantResolver} are hard requirements and as such - * should be provided. - * - * @return A Builder to be able to create a {@link MultiTenantQueryBus}. - */ - public static Builder builder() { - return new Builder(); - } - - @Override - public CompletableFuture> query(@Nonnull QueryMessage query) { - QueryBus tenantQueryBus = resolveTenant(query); - return tenantQueryBus.query(query); - } - - - @Override - public Stream> scatterGather(@Nonnull QueryMessage query, - long timeout, - @Nonnull TimeUnit unit) { - QueryBus tenantQueryBus = resolveTenant(query); - return tenantQueryBus.scatterGather(query, timeout, unit); - } - - @Override - public Publisher> streamingQuery(StreamingQueryMessage query) { - QueryBus tenantQueryBus = resolveTenant(query); - return tenantQueryBus.streamingQuery(query); - } - - @Override - public Registration subscribe(@Nonnull String queryName, - @Nonnull Type responseType, - @Nonnull MessageHandler> handler) { - handlers.computeIfAbsent(queryName, k -> { - tenantSegments.forEach((tenant, segment) -> - subscribeRegistrations.putIfAbsent(tenant, - segment.subscribe(queryName, - responseType, - handler))); - return new QuerySubscription<>(responseType, handler); - }); - return () -> subscribeRegistrations.values().stream().map(Registration::cancel).reduce((prev, acc) -> prev - && acc).orElse(false); - } - - @Override - public Registration registerTenant(TenantDescriptor tenantDescriptor) { - QueryBus tenantSegment = tenantSegmentFactory.apply(tenantDescriptor); - tenantSegments.putIfAbsent(tenantDescriptor, tenantSegment); - - return () -> { - QueryBus delegate = unregisterTenant(tenantDescriptor); - return delegate != null; - }; - } - - private QueryBus unregisterTenant(TenantDescriptor tenantDescriptor) { - List registrations = handlerInterceptorsRegistration.remove(tenantDescriptor); - if (registrations != null) { - registrations.forEach(Registration::cancel); - } - - registrations = dispatchInterceptorsRegistration.remove(tenantDescriptor); - if (registrations != null) { - registrations.forEach(Registration::cancel); - } - - Registration removed = subscribeRegistrations.remove(tenantDescriptor); - if (removed != null) { - removed.cancel(); - } - - return tenantSegments.remove(tenantDescriptor); - } - - @Override - public Registration registerAndStartTenant(TenantDescriptor tenantDescriptor) { - tenantSegments.computeIfAbsent(tenantDescriptor, tenant -> { - QueryBus tenantSegment = tenantSegmentFactory.apply(tenant); - - dispatchInterceptors.forEach(handlerInterceptor -> - dispatchInterceptorsRegistration - .computeIfAbsent(tenant, t -> new CopyOnWriteArrayList<>()) - .add(tenantSegment.registerDispatchInterceptor( - handlerInterceptor))); - - handlerInterceptors.forEach(handlerInterceptor -> - handlerInterceptorsRegistration - .computeIfAbsent(tenant, t -> new CopyOnWriteArrayList<>()) - .add(tenantSegment.registerHandlerInterceptor(handlerInterceptor))); - - handlers.forEach((queryName, querySubscription) -> - subscribeRegistrations.putIfAbsent(tenantDescriptor, - tenantSegment.subscribe(queryName, - querySubscription.getResponseType(), - querySubscription.getQueryHandler()))); - - return tenantSegment; - }); - - return () -> { - QueryBus delegate = unregisterTenant(tenantDescriptor); - return delegate != null; - }; - } - - @Override - public SubscriptionQueryResult, SubscriptionQueryUpdateMessage> subscriptionQuery( - @Nonnull SubscriptionQueryMessage query - ) { - return resolveTenant(query) - .subscriptionQuery(query); - } - - @Override - public SubscriptionQueryResult, SubscriptionQueryUpdateMessage> subscriptionQuery( - @Nonnull SubscriptionQueryMessage query, - int updateBufferSize - ) { - return resolveTenant(query) - .subscriptionQuery(query, updateBufferSize); - } - - private QueryBus resolveTenant(QueryMessage queryMessage) { - TenantDescriptor tenantDescriptor = targetTenantResolver.resolveTenant(queryMessage, tenantSegments.keySet()); - QueryBus tenantQueryBus = tenantSegments.get(tenantDescriptor); - if (tenantQueryBus == null) { - throw new NoSuchTenantException(tenantDescriptor.tenantId()); - } - return tenantQueryBus; - } - - @Override - public QueryUpdateEmitter queryUpdateEmitter() { - return resolveTenant((QueryMessage) CurrentUnitOfWork.get().getMessage()) - .queryUpdateEmitter(); - } - - /** - * Returns a {@link QueryUpdateEmitter} referring to the given {@code tenantDescriptor}. - * - * @param tenantDescriptor The {@link TenantDescriptor} for which to get {@link QueryUpdateEmitter}. - * @return A {@link QueryUpdateEmitter} referring to the given {@code tenantDescriptor}. - */ - public QueryUpdateEmitter queryUpdateEmitter(TenantDescriptor tenantDescriptor) { - return tenantSegments.get(tenantDescriptor) - .queryUpdateEmitter(); - } - - @Override - public Map tenantSegments() { - return tenantSegments; - } - - @Override - public List>> getHandlerInterceptors() { - return handlerInterceptors; - } - - @Override - public Map> getHandlerInterceptorsRegistration() { - return handlerInterceptorsRegistration; - } - - @Override - public List>> getDispatchInterceptors() { - return dispatchInterceptors; - } - - @Override - public Map> getDispatchInterceptorsRegistration() { - return dispatchInterceptorsRegistration; - } - - /** - * Builder class to instantiate a {@link MultiTenantQueryBus}. - *

    - * The {@link TenantQuerySegmentFactory} and {@link TargetTenantResolver} are hard requirements and as such - * should be provided. - */ - public static class Builder { - - protected TargetTenantResolver> targetTenantResolver; - protected TenantQuerySegmentFactory tenantSegmentFactory; - - /** - * Sets the {@link TenantQuerySegmentFactory} used to build {@link QueryBus} segment for given - * {@link TenantDescriptor}. - * - * @param tenantSegmentFactory A tenant-aware {@link QueryBus} segment factory. - * @return The current builder instance, for fluent interfacing. - */ - public Builder tenantSegmentFactory(TenantQuerySegmentFactory tenantSegmentFactory) { - assertNonNull(tenantSegmentFactory, "The TenantQuerySegmentFactory is a hard requirement"); - this.tenantSegmentFactory = tenantSegmentFactory; - return this; - } - - /** - * Sets the {@link TargetTenantResolver} used to resolve a {@link TenantDescriptor} based on a - * {@link QueryMessage}. Used to find the tenant-specific {@link QueryBus} segment. - * - * @param targetTenantResolver The resolver of a {@link TenantDescriptor} based on a {@link QueryMessage}. Used - * to find the tenant-specific {@link QueryBus} segment. - * @return The current builder instance, for fluent interfacing. - */ - public Builder targetTenantResolver(TargetTenantResolver> targetTenantResolver) { - assertNonNull(targetTenantResolver, "The TargetTenantResolver is a hard requirement"); - this.targetTenantResolver = targetTenantResolver; - return this; - } - - /** - * Initializes a {@link MultiTenantQueryBus} as specified through this Builder. - * - * @return a {@link MultiTenantQueryBus} as specified through this Builder. - */ - public MultiTenantQueryBus build() { - return new MultiTenantQueryBus(this); - } - - /** - * Validate whether the fields contained in this Builder as set accordingly. - * - * @throws AxonConfigurationException If one field is asserted to be incorrect according to the Builder's - * specifications. - */ - protected void validate() { - assertNonNull(targetTenantResolver, - "The TargetTenantResolver is a hard requirement and should be provided"); - assertNonNull(tenantSegmentFactory, - "The TenantQuerySegmentFactory is a hard requirement and should be provided"); - } - } -} diff --git a/multitenancy/src/main/java/org/axonframework/extensions/multitenancy/components/queryhandeling/MultiTenantQueryUpdateEmitter.java b/multitenancy/src/main/java/org/axonframework/extensions/multitenancy/components/queryhandeling/MultiTenantQueryUpdateEmitter.java deleted file mode 100644 index fe5cdd2..0000000 --- a/multitenancy/src/main/java/org/axonframework/extensions/multitenancy/components/queryhandeling/MultiTenantQueryUpdateEmitter.java +++ /dev/null @@ -1,330 +0,0 @@ -/* - * Copyright (c) 2010-2023. Axon Framework - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ -package org.axonframework.extensions.multitenancy.components.queryhandeling; - -import org.axonframework.common.AxonConfigurationException; -import org.axonframework.common.Registration; -import org.axonframework.extensions.multitenancy.components.MultiTenantAwareComponent; -import org.axonframework.extensions.multitenancy.components.MultiTenantDispatchInterceptorSupport; -import org.axonframework.extensions.multitenancy.components.NoSuchTenantException; -import org.axonframework.extensions.multitenancy.components.TargetTenantResolver; -import org.axonframework.extensions.multitenancy.components.TenantDescriptor; -import org.axonframework.messaging.Message; -import org.axonframework.messaging.MessageDispatchInterceptor; -import org.axonframework.messaging.unitofwork.CurrentUnitOfWork; -import org.axonframework.queryhandling.QueryUpdateEmitter; -import org.axonframework.queryhandling.SubscriptionQueryBackpressure; -import org.axonframework.queryhandling.SubscriptionQueryMessage; -import org.axonframework.queryhandling.SubscriptionQueryUpdateMessage; -import org.axonframework.queryhandling.UpdateHandlerRegistration; - -import java.util.List; -import java.util.Map; -import java.util.Set; -import java.util.concurrent.ConcurrentHashMap; -import java.util.concurrent.CopyOnWriteArrayList; -import java.util.function.Predicate; -import javax.annotation.Nonnull; - -import static org.axonframework.common.BuilderUtils.assertNonNull; - -/** - * Tenant aware {@link QueryUpdateEmitter} implementation, emitting updates to specific tenants once a - * {@link TenantDescriptor} can be resolved. - * - * @author Stefan Dragisic - * @since 4.6.0 - */ -public class MultiTenantQueryUpdateEmitter implements - QueryUpdateEmitter, - MultiTenantAwareComponent, - MultiTenantDispatchInterceptorSupport, QueryUpdateEmitter> { - - private final Map tenantSegments = new ConcurrentHashMap<>(); - private final Map>> updateHandlersRegistration = new ConcurrentHashMap<>(); - private final List>> dispatchInterceptors = new CopyOnWriteArrayList<>(); - private final Map> dispatchInterceptorsRegistration = new ConcurrentHashMap<>(); - - private final TenantQueryUpdateEmitterSegmentFactory tenantSegmentFactory; - private final TargetTenantResolver> targetTenantResolver; - - /** - * Instantiates a {@link MultiTenantQueryUpdateEmitter} based on the given {@code builder}. - * - * @param builder The {@link Builder} used to instantiate a {@link MultiTenantQueryUpdateEmitter} with. - */ - protected MultiTenantQueryUpdateEmitter(Builder builder) { - builder.validate(); - this.tenantSegmentFactory = builder.tenantSegmentFactory; - this.targetTenantResolver = builder.targetTenantResolver; - } - - /** - * Instantiate a builder to be able to construct a {@link MultiTenantQueryUpdateEmitter}. - *

    - * The {@link TenantQueryUpdateEmitterSegmentFactory} and {@link TargetTenantResolver} are hard requirements - * and as such should be provided. - * - * @return A Builder to be able to create a {@link MultiTenantQueryUpdateEmitter}. - */ - public static Builder builder() { - return new Builder(); - } - - @Override - public void emit(@Nonnull Predicate> filter, - @Nonnull SubscriptionQueryUpdateMessage update) { - QueryUpdateEmitter tenantEmitter = resolveTenant(update); - tenantEmitter.emit(filter, update); - } - - @Override - public void emit(@Nonnull Predicate> filter, - U update) { - Message message; - if (update instanceof Message) { - message = (Message) update; - } else { - message = CurrentUnitOfWork.get().getMessage(); - } - if (message != null) { - QueryUpdateEmitter tenantEmitter = resolveTenant(message); - tenantEmitter.emit(filter, update); - } else { - throw new NoSuchTenantException("Can't find any tenant identifier for this message!"); - } - } - - @Override - public void emit(@Nonnull Class queryType, - @Nonnull Predicate filter, - @Nonnull SubscriptionQueryUpdateMessage update) { - QueryUpdateEmitter tenantEmitter = resolveTenant(update); - tenantEmitter.emit(queryType, filter, update); - } - - @Override - public void emit(@Nonnull Class queryType, - @Nonnull Predicate filter, - U update) { - Message message; - if (update instanceof Message) { - message = (Message) update; - } else { - message = CurrentUnitOfWork.get().getMessage(); - } - if (message != null) { - QueryUpdateEmitter tenantEmitter = resolveTenant(message); - tenantEmitter.emit(queryType, filter, update); - } else { - throw new NoSuchTenantException("Can't find any tenant identifier for this message!"); - } - } - - @Override - public void complete(@Nonnull Predicate> filter) { - throw new UnsupportedOperationException( - "Invoke operation directly on tenant segment. Use: MultiTenantQueryUpdateEmitter::getTenant"); - } - - @Override - public void complete(@Nonnull Class queryType, @Nonnull Predicate filter) { - throw new UnsupportedOperationException( - "Invoke operation directly on tenant segment. Use: MultiTenantQueryUpdateEmitter::getTenant"); - } - - @Override - public void completeExceptionally(@Nonnull Predicate> filter, - @Nonnull Throwable cause) { - throw new UnsupportedOperationException( - "Invoke operation directly on tenant segment. Use: MultiTenantQueryUpdateEmitter::getTenant"); - } - - @Override - public void completeExceptionally(@Nonnull Class queryType, - @Nonnull Predicate filter, - @Nonnull Throwable cause) { - throw new UnsupportedOperationException( - "Invoke operation directly on tenant segment. Use: MultiTenantQueryUpdateEmitter::getTenant"); - } - - @Override - public boolean queryUpdateHandlerRegistered(@Nonnull SubscriptionQueryMessage query) { - return tenantSegments.values().stream().anyMatch(segment -> segment.queryUpdateHandlerRegistered(query)); - } - - - @Override - public UpdateHandlerRegistration registerUpdateHandler(SubscriptionQueryMessage query, - SubscriptionQueryBackpressure backpressure, - int updateBufferSize) { - return registerUpdateHandler(query, updateBufferSize); - } - - @Override - public UpdateHandlerRegistration registerUpdateHandler(@Nonnull SubscriptionQueryMessage query, - int updateBufferSize) { - QueryUpdateEmitter queryUpdateEmitter = resolveTenant(query); - UpdateHandlerRegistration updateHandlerRegistration = - queryUpdateEmitter.registerUpdateHandler(query, updateBufferSize); - - updateHandlersRegistration - .computeIfAbsent(targetTenantResolver.resolveTenant(query, tenantSegments.keySet()), - t -> new CopyOnWriteArrayList<>()) - .add(updateHandlerRegistration); - - return updateHandlerRegistration; - } - - @Override - public Set> activeSubscriptions() { - throw new UnsupportedOperationException(); - } - - private QueryUpdateEmitter resolveTenant(Message update) { - TenantDescriptor tenantDescriptor = targetTenantResolver.resolveTenant(update, tenantSegments.keySet()); - QueryUpdateEmitter tenantQueryBus = tenantSegments.get(tenantDescriptor); - if (tenantQueryBus == null) { - throw new NoSuchTenantException(tenantDescriptor.tenantId()); - } - return tenantQueryBus; - } - - @Override - public Registration registerTenant(TenantDescriptor tenantDescriptor) { - return registerAndStartTenant(tenantDescriptor); - } - - - public QueryUpdateEmitter getTenant(TenantDescriptor tenantDescriptor) { - return tenantSegments.get(tenantDescriptor); - } - - private QueryUpdateEmitter unregisterTenant(TenantDescriptor tenantDescriptor) { - List> updateHandlerRegistrations = updateHandlersRegistration.remove( - tenantDescriptor); - if (updateHandlerRegistrations != null) { - updateHandlerRegistrations.forEach(it -> it.getRegistration().cancel()); - } - - List registrations = dispatchInterceptorsRegistration.remove(tenantDescriptor); - if (registrations != null) { - registrations.forEach(Registration::cancel); - } - - return tenantSegments.remove(tenantDescriptor); - } - - @Override - public Registration registerAndStartTenant(TenantDescriptor tenantDescriptor) { - tenantSegments.computeIfAbsent(tenantDescriptor, tenant -> { - QueryUpdateEmitter tenantSegment = tenantSegmentFactory.apply(tenant); - - dispatchInterceptors.forEach(dispatchInterceptor -> - dispatchInterceptorsRegistration - .computeIfAbsent(tenant, t -> new CopyOnWriteArrayList<>()) - .add(tenantSegment.registerDispatchInterceptor( - dispatchInterceptor))); - - return tenantSegment; - }); - - return () -> { - QueryUpdateEmitter delegate = unregisterTenant(tenantDescriptor); - return delegate != null; - }; - } - - @Override - public Map tenantSegments() { - return tenantSegments; - } - - @Override - public List>> getDispatchInterceptors() { - return dispatchInterceptors; - } - - @Override - public Map> getDispatchInterceptorsRegistration() { - return dispatchInterceptorsRegistration; - } - - /** - * Builder class to instantiate a {@link MultiTenantQueryUpdateEmitter}. - *

    - * The {@link TenantQueryUpdateEmitterSegmentFactory} and {@link TargetTenantResolver} are hard requirements - * and as such should be provided. - */ - public static class Builder { - - protected TargetTenantResolver> targetTenantResolver; - protected TenantQueryUpdateEmitterSegmentFactory tenantSegmentFactory; - - /** - * Sets the {@link TenantQueryUpdateEmitterSegmentFactory} used to build {@link QueryUpdateEmitter} segment for - * given {@link TenantDescriptor}. - * - * @param tenantSegmentFactory A tenant-aware {@link QueryUpdateEmitter} segment factory. - * @return The current Builder instance, for fluent interfacing. - */ - public MultiTenantQueryUpdateEmitter.Builder tenantSegmentFactory( - TenantQueryUpdateEmitterSegmentFactory tenantSegmentFactory) { - assertNonNull(tenantSegmentFactory, - "The TenantQueryUpdateEmitterSegmentFactory is a hard requirement"); - this.tenantSegmentFactory = tenantSegmentFactory; - return this; - } - - /** - * Sets the {@link TargetTenantResolver} used to resolve a {@link TenantDescriptor} based on a {@link Message}. - * Used to find the tenant-specific {@link QueryUpdateEmitter} segment. - * - * @param targetTenantResolver The resolver of a {@link TenantDescriptor} based on a {@link Message}. Used to - * find the tenant-specific {@link QueryUpdateEmitter} segment. - * @return The current builder instance, for fluent interfacing. - */ - public MultiTenantQueryUpdateEmitter.Builder targetTenantResolver( - TargetTenantResolver> targetTenantResolver - ) { - assertNonNull(targetTenantResolver, "The TargetTenantResolver is a hard requirement"); - this.targetTenantResolver = targetTenantResolver; - return this; - } - - /** - * Initializes a {@link MultiTenantQueryUpdateEmitter} as specified through this Builder. - * - * @return a {@link MultiTenantQueryUpdateEmitter} as specified through this Builder. - */ - public MultiTenantQueryUpdateEmitter build() { - return new MultiTenantQueryUpdateEmitter(this); - } - - /** - * Validate whether the fields contained in this Builder as set accordingly. - * - * @throws AxonConfigurationException If one field is asserted to be incorrect according to the Builder's - * specifications. - */ - protected void validate() { - assertNonNull(targetTenantResolver, - "The TargetTenantResolver is a hard requirement and should be provided"); - assertNonNull(tenantSegmentFactory, - "The TenantQueryUpdateEmitterSegmentFactory is a hard requirement and should be provided"); - } - } -} diff --git a/multitenancy/src/main/java/org/axonframework/extensions/multitenancy/components/queryhandeling/TenantQueryUpdateEmitterSegmentFactory.java b/multitenancy/src/main/java/org/axonframework/extensions/multitenancy/components/queryhandeling/TenantQueryUpdateEmitterSegmentFactory.java deleted file mode 100644 index cf3d6a6..0000000 --- a/multitenancy/src/main/java/org/axonframework/extensions/multitenancy/components/queryhandeling/TenantQueryUpdateEmitterSegmentFactory.java +++ /dev/null @@ -1,32 +0,0 @@ -/* - * Copyright (c) 2010-2023. Axon Framework - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ -package org.axonframework.extensions.multitenancy.components.queryhandeling; - -import org.axonframework.extensions.multitenancy.components.TenantDescriptor; -import org.axonframework.queryhandling.QueryUpdateEmitter; - -import java.util.function.Function; - -/** - * Factory for creating {@link QueryUpdateEmitter} segments for a given {@link TenantDescriptor}. After a segment is - * created, it may be started automatically by the factory. - * - * @author Stefan Dragisic - * @since 4.6.0 - */ -public interface TenantQueryUpdateEmitterSegmentFactory extends Function { - -} diff --git a/multitenancy/src/main/java/org/axonframework/extensions/multitenancy/components/scheduling/MultiTenantEventScheduler.java b/multitenancy/src/main/java/org/axonframework/extensions/multitenancy/components/scheduling/MultiTenantEventScheduler.java deleted file mode 100644 index 37e6f68..0000000 --- a/multitenancy/src/main/java/org/axonframework/extensions/multitenancy/components/scheduling/MultiTenantEventScheduler.java +++ /dev/null @@ -1,308 +0,0 @@ -/* - * Copyright (c) 2010-2023. Axon Framework - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -package org.axonframework.extensions.multitenancy.components.scheduling; - -import org.axonframework.common.AxonConfigurationException; -import org.axonframework.common.Registration; -import org.axonframework.eventhandling.EventMessage; -import org.axonframework.eventhandling.scheduling.EventScheduler; -import org.axonframework.eventhandling.scheduling.ScheduleToken; -import org.axonframework.extensions.multitenancy.TenantWrappedTransactionManager; -import org.axonframework.extensions.multitenancy.components.MultiTenantAwareComponent; -import org.axonframework.extensions.multitenancy.components.NoSuchTenantException; -import org.axonframework.extensions.multitenancy.components.TargetTenantResolver; -import org.axonframework.extensions.multitenancy.components.TenantDescriptor; -import org.axonframework.messaging.Message; -import org.axonframework.messaging.MetaData; -import org.slf4j.Logger; -import org.slf4j.LoggerFactory; - -import java.lang.invoke.MethodHandles; -import java.time.Duration; -import java.time.Instant; -import java.util.Map; -import java.util.concurrent.ConcurrentHashMap; - -import static org.axonframework.common.BuilderUtils.assertNonNull; - -/** - * Tenant aware implementation of {@link EventScheduler} that delegates to a tenant-specific {@link EventScheduler} - * based on the {@link TenantDescriptor} resolved by the {@link TargetTenantResolver}. - *

    - * Compared to other {@code EventScheduler} implementations, this version requires any given {@code event} for - * {@link #schedule(Instant, Object) schedule} and {@link #reschedule(ScheduleToken, Instant, Object) reschedule} to be - * of type {@link EventMessage}. Furthermore, the event message should contain {@link MetaData} with a registered - * {@link TenantDescriptor}, as without the {@code TenantDescriptor} this scheduler is incapable of finding the - * tenant-specific {@code EventScheduler} to invoke the task on. - * - * @author Stefan Dragisic - * @since 4.9.0 - */ -public class MultiTenantEventScheduler implements EventScheduler, MultiTenantAwareComponent { - - private static final Logger logger = LoggerFactory.getLogger(MethodHandles.lookup().lookupClass()); - - private final TenantEventSchedulerSegmentFactory tenantSegmentFactory; - private final TargetTenantResolver> targetTenantResolver; - - private final Map tenantSegments = new ConcurrentHashMap<>(); - - /** - * Instantiate a {@link MultiTenantEventScheduler} based on the fields contained in the {@link Builder}. - * - * @param builder the {@link Builder} used to instantiate a {@link MultiTenantEventScheduler} instance - */ - protected MultiTenantEventScheduler(Builder builder) { - builder.validate(); - this.tenantSegmentFactory = builder.tenantSegmentFactory; - this.targetTenantResolver = builder.targetTenantResolver; - } - - /** - * Instantiate a Builder to be able to create a {@link MultiTenantEventScheduler}. - *

    - * The {@link TenantEventSchedulerSegmentFactory} and {@link TargetTenantResolver} are hard requirements and - * as such should be provided. - * - * @return A Builder to be able to create a {@link MultiTenantEventScheduler}. - */ - public static Builder builder() { - return new Builder(); - } - - /** - * {@inheritDoc} - *

    - * It is required that the given {@code event} is of type {@link EventMessage}, containing a resolvable - * {@link TenantDescriptor} from the {@link Message#getMetaData meta data}. Without a {@code TenantDescriptor}, the - * `MultiTenantEventScheduler` is incapable of resolving the tenant-specific {@link EventScheduler}. Therefor, the - * provided {@code event} should be of type {@code EventMessage} with a {@code TenantDescriptor} in it's - * {@link MetaData}. - */ - @Override - public ScheduleToken schedule(Instant instant, Object event) { - return resolveTenant(event).schedule(instant, event); - } - - /** - * {@inheritDoc} - *

    - * It is required that the given {@code event} is of type {@link EventMessage}, containing a resolvable - * {@link TenantDescriptor} from the {@link Message#getMetaData meta data}. Without a {@code TenantDescriptor}, the - * `MultiTenantEventScheduler` is incapable of resolving the tenant-specific {@link EventScheduler}. Therefor, the - * provided {@code event} should be of type {@code EventMessage} with a {@code TenantDescriptor} in it's - * {@link MetaData}. - */ - @Override - public ScheduleToken schedule(Duration duration, Object event) { - return resolveTenant(event).schedule(duration, event); - } - - /** - * {@inheritDoc} - *

    - * Tries to extract {@link TenantDescriptor} from {@link TenantWrappedTransactionManager#getCurrentTenant()}. - *

    - * If the {@link TenantDescriptor} is not found, it tries to cancel the schedule token in all tenants until it finds - * the correct one. See {@link #forTenant(TenantDescriptor)}. - */ - @Override - public void cancelSchedule(ScheduleToken scheduleToken) { - TenantDescriptor currentTenant = TenantWrappedTransactionManager.getCurrentTenant(); - if (currentTenant != null) { - tenantSegments.get(currentTenant).cancelSchedule(scheduleToken); - } else { - logger.info("No current tenant found. Canceling schedule token {} by searching in all tenants.", - scheduleToken); - tenantSegments.forEach((tenantDescriptor, eventScheduler) -> { - try { - logger.info("Cancelling schedule token {} for tenant {}.", - scheduleToken, - tenantDescriptor.tenantId()); - eventScheduler.cancelSchedule(scheduleToken); - } catch (IllegalArgumentException e) { - logger.info("Schedule token {} does not belong to tenant {}. Skipping cancel task for this tenant.", - scheduleToken, - tenantDescriptor.tenantId()); - } - }); - } - } - - /** - * {@inheritDoc} - *

    - * It is required that the given {@code event} is of type {@link EventMessage}, containing a resolvable - * {@link TenantDescriptor} from the {@link Message#getMetaData meta data}. Without a {@code TenantDescriptor}, the - * `MultiTenantEventScheduler` is incapable of resolving the tenant-specific {@link EventScheduler}. Therefor, the - * provided {@code event} should be of type {@code EventMessage} with a {@code TenantDescriptor} in it's - * {@link MetaData}. - */ - @Override - public ScheduleToken reschedule(ScheduleToken scheduleToken, Duration triggerDuration, Object event) { - return resolveTenant(event).reschedule(scheduleToken, triggerDuration, event); - } - - /** - * {@inheritDoc} - *

    - * It is required that the given {@code event} is of type {@link EventMessage}, containing a resolvable - * {@link TenantDescriptor} from the {@link Message#getMetaData meta data}. Without a {@code TenantDescriptor}, the - * `MultiTenantEventScheduler` is incapable of resolving the tenant-specific {@link EventScheduler}. Therefor, the - * provided {@code event} should be of type {@code EventMessage} with a {@code TenantDescriptor} in it's - * {@link MetaData}. - */ - @Override - public ScheduleToken reschedule(ScheduleToken scheduleToken, Instant instant, Object event) { - return resolveTenant(event).reschedule(scheduleToken, instant, event); - } - - /** - * {@inheritDoc} - *

    - * Invoking shutdown, shuts down all tenant-specific {@link EventScheduler EventSchedulers}. - */ - @Override - public void shutdown() { - tenantSegments.forEach((tenantDescriptor, eventScheduler) -> eventScheduler.shutdown()); - } - - /** - * Get the tenant-specific {@link EventScheduler} for given the {@link TenantDescriptor}. - * - * @param tenantDescriptor The tenant descriptor to retrieve the {@link EventScheduler} segment for. - * @return The tenant-specific {@link EventScheduler} for the given {@code tenantDescriptor}. May return - * {@code null} if the tenant wasn't {@link #registerTenant(TenantDescriptor) registered}. - */ - public EventScheduler forTenant(TenantDescriptor tenantDescriptor) { - return tenantSegments.get(tenantDescriptor); - } - - /** - * The collection of all tenant-specific {@link EventScheduler EventSchedulers} - * {@link #registerTenant(TenantDescriptor) registered}. - * - * @return The collection of all tenant-specific {@link EventScheduler EventSchedulers} - * {@link #registerTenant(TenantDescriptor) registered}. - */ - public Map getTenantSegments() { - return tenantSegments; - } - - @Override - public Registration registerTenant(TenantDescriptor tenantDescriptor) { - EventScheduler tenantSegment = tenantSegmentFactory.apply(tenantDescriptor); - tenantSegments.putIfAbsent(tenantDescriptor, tenantSegment); - - return () -> { - EventScheduler delegate = unregisterTenant(tenantDescriptor); - return delegate != null; - }; - } - - private EventScheduler unregisterTenant(TenantDescriptor tenantDescriptor) { - EventScheduler eventScheduler = tenantSegments.remove(tenantDescriptor); - if (eventScheduler != null) { - eventScheduler.shutdown(); - } - return eventScheduler; - } - - @Override - public Registration registerAndStartTenant(TenantDescriptor tenantDescriptor) { - return registerTenant(tenantDescriptor); - } - - private EventScheduler resolveTenant(Object event) { - if (event instanceof EventMessage) { - TenantDescriptor tenantDescriptor = targetTenantResolver.resolveTenant( - (EventMessage) event, tenantSegments.keySet() - ); - EventScheduler tenantSegment = tenantSegments.get(tenantDescriptor); - if (tenantSegment == null) { - throw new NoSuchTenantException(tenantDescriptor.tenantId()); - } - return tenantSegment; - } else { - throw new IllegalArgumentException( - "Message is not an instance of EventMessage and doesn't contain Meta Data to resolve the tenant." - ); - } - } - - /** - * Builder class to instantiate a {@link MultiTenantEventScheduler}. - *

    - * The {@link TenantEventSchedulerSegmentFactory} and {@link TargetTenantResolver} are hard requirements and - * as such should be provided. - */ - public static class Builder { - - private TargetTenantResolver> targetTenantResolver; - private TenantEventSchedulerSegmentFactory tenantSegmentFactory; - - /** - * Sets the {@link TenantEventSchedulerSegmentFactory} used to build {@link EventScheduler} segment for given - * {@link TenantDescriptor}. - * - * @param tenantSegmentFactory The tenant aware segment factory used to build {@link EventScheduler} instances - * per tenant. - * @return The current Builder instance, for fluent interfacing. - */ - public Builder tenantSegmentFactory(TenantEventSchedulerSegmentFactory tenantSegmentFactory) { - assertNonNull(tenantSegmentFactory, "The TenantEventSchedulerSegmentFactory is a hard requirement"); - this.tenantSegmentFactory = tenantSegmentFactory; - return this; - } - - /** - * Sets the {@link TargetTenantResolver} used to resolve a tenant {@link EventScheduler}segment based on an - * {@link EventMessage}. - * - * @param targetTenantResolver The {@link TargetTenantResolver} used to resolve a tenant - * {@link EventScheduler}segment based on an {@link EventMessage}. - * @return The current Builder instance, for fluent interfacing. - */ - public Builder targetTenantResolver(TargetTenantResolver> targetTenantResolver) { - assertNonNull(targetTenantResolver, "The TargetTenantResolver is a hard requirement"); - this.targetTenantResolver = targetTenantResolver; - return this; - } - - /** - * Initializes a {@link MultiTenantEventScheduler} as specified through this Builder. - * - * @return A {@link MultiTenantEventScheduler} as specified through this Builder. - */ - public MultiTenantEventScheduler build() { - return new MultiTenantEventScheduler(this); - } - - /** - * Validates whether the fields contained in this Builder are set accordingly. - * - * @throws AxonConfigurationException If one field is asserted to be incorrect according to the Builder's - * specifications. - */ - protected void validate() { - assertNonNull(targetTenantResolver, - "The TargetTenantResolver is a hard requirement and should be provided"); - assertNonNull(tenantSegmentFactory, - "The TenantEventSchedulerSegmentFactory is a hard requirement and should be provided"); - } - } -} diff --git a/multitenancy/src/main/java/org/axonframework/extensions/multitenancy/components/scheduling/TenantEventSchedulerSegmentFactory.java b/multitenancy/src/main/java/org/axonframework/extensions/multitenancy/components/scheduling/TenantEventSchedulerSegmentFactory.java deleted file mode 100644 index eadfac1..0000000 --- a/multitenancy/src/main/java/org/axonframework/extensions/multitenancy/components/scheduling/TenantEventSchedulerSegmentFactory.java +++ /dev/null @@ -1,32 +0,0 @@ -/* - * Copyright (c) 2010-2023. Axon Framework - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ -package org.axonframework.extensions.multitenancy.components.scheduling; - -import org.axonframework.eventhandling.scheduling.EventScheduler; -import org.axonframework.extensions.multitenancy.components.TenantDescriptor; - -import java.util.function.Function; - -/** - * Factory for creating {@link EventScheduler} segments for a given {@link TenantDescriptor}. After a segment is - * created, it may be started automatically by the factory. - * - * @author Stefan Dragisic - * @since 4.9.0 - */ -public interface TenantEventSchedulerSegmentFactory extends Function { - -} diff --git a/multitenancy/src/main/java/org/axonframework/extensions/multitenancy/configuration/MultiTenantEventProcessingModule.java b/multitenancy/src/main/java/org/axonframework/extensions/multitenancy/configuration/MultiTenantEventProcessingModule.java deleted file mode 100644 index f6ab7fb..0000000 --- a/multitenancy/src/main/java/org/axonframework/extensions/multitenancy/configuration/MultiTenantEventProcessingModule.java +++ /dev/null @@ -1,458 +0,0 @@ -/* - * Copyright (c) 2010-2024. Axon Framework - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ -package org.axonframework.extensions.multitenancy.configuration; - -import org.axonframework.common.AxonConfigurationException; -import org.axonframework.common.AxonThreadFactory; -import org.axonframework.common.transaction.TransactionManager; -import org.axonframework.config.Configuration; -import org.axonframework.config.EventProcessingConfigurer; -import org.axonframework.config.EventProcessingModule; -import org.axonframework.eventhandling.DirectEventProcessingStrategy; -import org.axonframework.eventhandling.EventHandlerInvoker; -import org.axonframework.eventhandling.EventMessage; -import org.axonframework.eventhandling.EventProcessor; -import org.axonframework.eventhandling.EventProcessorSpanFactory; -import org.axonframework.eventhandling.SubscribingEventProcessor; -import org.axonframework.eventhandling.TrackedEventMessage; -import org.axonframework.eventhandling.TrackingEventProcessor; -import org.axonframework.eventhandling.TrackingEventProcessorConfiguration; -import org.axonframework.eventhandling.pooled.PooledStreamingEventProcessor; -import org.axonframework.extensions.multitenancy.TenantWrappedTransactionManager; -import org.axonframework.extensions.multitenancy.components.TenantDescriptor; -import org.axonframework.extensions.multitenancy.components.TenantProvider; -import org.axonframework.extensions.multitenancy.components.deadletterqueue.MultiTenantDeadLetterProcessor; -import org.axonframework.extensions.multitenancy.components.deadletterqueue.MultiTenantDeadLetterQueue; -import org.axonframework.extensions.multitenancy.components.deadletterqueue.MultiTenantDeadLetterQueueFactory; -import org.axonframework.extensions.multitenancy.components.eventhandeling.MultiTenantEventProcessor; -import org.axonframework.extensions.multitenancy.components.eventstore.MultiTenantEventStore; -import org.axonframework.extensions.multitenancy.components.eventstore.MultiTenantSubscribableMessageSource; -import org.axonframework.messaging.StreamableMessageSource; -import org.axonframework.messaging.SubscribableMessageSource; -import org.axonframework.messaging.deadletter.SequencedDeadLetterProcessor; -import org.axonframework.messaging.deadletter.SequencedDeadLetterQueue; - -import java.util.Map; -import java.util.Optional; -import java.util.concurrent.Executors; -import java.util.concurrent.ScheduledExecutorService; -import java.util.function.Function; -import java.util.stream.Collectors; -import javax.annotation.Nonnull; - -import static org.axonframework.config.EventProcessingConfigurer.PooledStreamingProcessorConfiguration.noOp; - -/** - * An extension of the {@link EventProcessingModule} that allows for the creation of - * {@link MultiTenantEventProcessor MultiTenantEventProcessors}. - * - * @author Stefan Dragisic - * @since 4.6.0 - */ -public class MultiTenantEventProcessingModule extends EventProcessingModule { - - private final TenantProvider tenantProvider; - private final MultiTenantStreamableMessageSourceProvider multiTenantStreamableMessageSourceProvider; - - private final MultiTenantEventProcessorPredicate multiTenantEventProcessorPredicate; - - protected final MultiTenantDeadLetterQueueFactory> multiTenantDeadLetterQueueFactory; - - /** - * Initializes a {@link MultiTenantEventProcessingModule} with a default {@link TenantProvider} and a default - * {@link MultiTenantStreamableMessageSourceProvider}, which does not change the default - * {@link StreamableMessageSource} for any {@link TenantDescriptor}. - * - * @param tenantProvider The default {@link TenantProvider} used to build {@link MultiTenantEventProcessor}s. - */ - public MultiTenantEventProcessingModule(TenantProvider tenantProvider) { - this.tenantProvider = tenantProvider; - this.multiTenantDeadLetterQueueFactory = null; - this.multiTenantStreamableMessageSourceProvider = ((defaultSource, processorName, tenantDescriptor, configuration) -> defaultSource); - this.multiTenantEventProcessorPredicate = MultiTenantEventProcessorPredicate.enableMultiTenancy(); - } - - /** - * Initializes a {@link MultiTenantEventProcessingModule} with a default {@link TenantProvider} and a default - * {@link MultiTenantStreamableMessageSourceProvider}, which does not change the default - * {@link StreamableMessageSource} for any {@link TenantDescriptor}. - * - * @param tenantProvider The default {@link TenantProvider} used to build - * {@link MultiTenantEventProcessor}s. - * @param multiTenantDeadLetterQueueFactory The {@link MultiTenantDeadLetterQueueFactory} used to build - * {@link MultiTenantDeadLetterQueue}s for each {@link TenantDescriptor}. - */ - public MultiTenantEventProcessingModule( - TenantProvider tenantProvider, - MultiTenantDeadLetterQueueFactory> multiTenantDeadLetterQueueFactory - ) { - this.tenantProvider = tenantProvider; - this.multiTenantDeadLetterQueueFactory = multiTenantDeadLetterQueueFactory; - multiTenantStreamableMessageSourceProvider = ((defaultSource, processorName, tenantDescriptor, configuration) -> defaultSource); - this.multiTenantEventProcessorPredicate = MultiTenantEventProcessorPredicate.enableMultiTenancy(); - } - - /** - * Initializes a {@link MultiTenantEventProcessingModule} with a default {@link TenantProvider} and a - * {@link MultiTenantStreamableMessageSourceProvider}, which allows for the customization of the - * {@link StreamableMessageSource} for each {@link TenantDescriptor}. - * - * @param tenantProvider The default {@link TenantProvider} used to build - * {@link MultiTenantEventProcessor}s. - * @param multiTenantStreamableMessageSourceProvider The {@link MultiTenantStreamableMessageSourceProvider} used to - * customize the {@link StreamableMessageSource} for each - * {@link TenantDescriptor}. - * @param multiTenantDeadLetterQueueFactory The {@link MultiTenantDeadLetterQueueFactory} used to build - * {@link MultiTenantDeadLetterQueue}s for each - * {@link TenantDescriptor}. - */ - public MultiTenantEventProcessingModule( - TenantProvider tenantProvider, - MultiTenantStreamableMessageSourceProvider multiTenantStreamableMessageSourceProvider, - MultiTenantDeadLetterQueueFactory> multiTenantDeadLetterQueueFactory, - MultiTenantEventProcessorPredicate multiTenantEventProcessorPredicate - ) { - this.tenantProvider = tenantProvider; - this.multiTenantEventProcessorPredicate = multiTenantEventProcessorPredicate; - this.multiTenantDeadLetterQueueFactory = multiTenantDeadLetterQueueFactory; - this.multiTenantStreamableMessageSourceProvider = multiTenantStreamableMessageSourceProvider; - } - - private static String getName(String name, TenantDescriptor tenantDescriptor) { - return name + "@" + tenantDescriptor.tenantId(); - } - - /** - * Return the {@link EventProcessor} matching the given {@code name} and {@code tenantDescriptor}. When either the - * {@code name} or {@code tenantDescriptor} does not match any {@code EventProcessor}, an - * {@link Optional#empty() empty Optional} is returned. - * - * @param name The name of the {@link EventProcessor} to return. - * @param tenantDescriptor The descriptor of the tenant to return an {@link EventProcessor} for. - * @return An {@link Optional} containing the {@link EventProcessor} matching the given {@code name} and - * {@code tenantDescriptor}. Or an {@link Optional#empty() empty Optional} if the processor could not be found. - */ - public Optional eventProcessor(String name, TenantDescriptor tenantDescriptor) { - return Optional.ofNullable(this.eventProcessors().get(getName(name, tenantDescriptor))); - } - - @Override - public Map eventProcessors() { - Map original = super.eventProcessors(); - Map allProcessors = - original.entrySet() - .stream() - .filter(entry -> entry.getValue().getClass().isAssignableFrom(MultiTenantEventProcessor.class)) - .flatMap( - entry -> ((MultiTenantEventProcessor) entry.getValue()).tenantEventProcessors().stream() - ) - .collect(Collectors.toMap(EventProcessor::getName, processor -> processor)); - allProcessors.putAll(original); - return allProcessors; - } - - @Override - public EventProcessor subscribingEventProcessor(String name, - EventHandlerInvoker eventHandlerInvoker, - SubscribableMessageSource> messageSource) { - - if (!multiTenantEventProcessorPredicate.test(name)) { - return buildSep(name, eventHandlerInvoker, messageSource); - } - - MultiTenantEventProcessor eventProcessor = - MultiTenantEventProcessor.builder() - .name(name) - .tenantSegmentFactory( - tenantDescriptor -> { - SubscribableMessageSource> tenantSource = - tenantSource(messageSource, tenantDescriptor); - - return buildSep( - tenantDescriptor, name, eventHandlerInvoker, tenantSource - ); - }) - .build(); - tenantProvider.subscribe(eventProcessor); - return eventProcessor; - } - - private static SubscribableMessageSource> tenantSource( - SubscribableMessageSource> messageSource, TenantDescriptor tenantDescriptor - ) { - return messageSource instanceof MultiTenantSubscribableMessageSource - ? ((MultiTenantSubscribableMessageSource>>) messageSource).tenantSegments().get(tenantDescriptor) - : messageSource; - } - - private SubscribingEventProcessor buildSep(String name, - EventHandlerInvoker eventHandlerInvoker, - SubscribableMessageSource> source, - TransactionManager transactionManager) { - return SubscribingEventProcessor.builder() - .name(name) - .eventHandlerInvoker(eventHandlerInvoker) - .rollbackConfiguration(super.rollbackConfiguration(name)) - .errorHandler(super.errorHandler(name)) - .messageMonitor(super.messageMonitor(SubscribingEventProcessor.class, name)) - .spanFactory(super.configuration.getComponent(EventProcessorSpanFactory.class)) - .messageSource(source) - .processingStrategy(DirectEventProcessingStrategy.INSTANCE) - .transactionManager(transactionManager) - .build(); - } - - private SubscribingEventProcessor buildSep(TenantDescriptor tenantDescriptor, - String name, - EventHandlerInvoker eventHandlerInvoker, - SubscribableMessageSource> source) { - TransactionManager transactionManager = new TenantWrappedTransactionManager(super.transactionManager(name), - tenantDescriptor); - return buildSep(getName(name, tenantDescriptor), eventHandlerInvoker, source, transactionManager); - } - - private SubscribingEventProcessor buildSep(String name, - EventHandlerInvoker eventHandlerInvoker, - SubscribableMessageSource> source) { - return buildSep(name, eventHandlerInvoker, source, super.transactionManager(name)); - } - - @Override - public EventProcessor trackingEventProcessor(String name, - EventHandlerInvoker eventHandlerInvoker, - TrackingEventProcessorConfiguration config, - StreamableMessageSource> source) { - if (!multiTenantEventProcessorPredicate.test(name)) { - return buildTep(name, eventHandlerInvoker, source, config); - } - - MultiTenantEventProcessor eventProcessor = - MultiTenantEventProcessor.builder() - .name(name) - .tenantSegmentFactory( - tenantDescriptor -> { - StreamableMessageSource> tenantSource = - multiTenantStreamableMessageSourceProvider.build( - defaultSource(source, tenantDescriptor), - name, - tenantDescriptor, - configuration - ); - - return buildTep(tenantDescriptor, - name, - eventHandlerInvoker, - tenantSource, - config); - } - ) - .build(); - tenantProvider.subscribe(eventProcessor); - return eventProcessor; - } - - private TrackingEventProcessor buildTep(String name, - EventHandlerInvoker eventHandlerInvoker, - StreamableMessageSource> source, - TransactionManager transactionManager, - TrackingEventProcessorConfiguration config) { - return TrackingEventProcessor.builder() - .name(name) - .eventHandlerInvoker(eventHandlerInvoker) - .rollbackConfiguration(super.rollbackConfiguration(name)) - .errorHandler(super.errorHandler(name)) - .messageMonitor(super.messageMonitor(TrackingEventProcessor.class, name)) - .spanFactory(super.configuration.getComponent(EventProcessorSpanFactory.class)) - .messageSource(source) - .tokenStore(super.tokenStore(name)) - .transactionManager(transactionManager) - .trackingEventProcessorConfiguration(config) - .build(); - } - - private TrackingEventProcessor buildTep(TenantDescriptor tenantDescriptor, - String name, - EventHandlerInvoker eventHandlerInvoker, - StreamableMessageSource> source, - TrackingEventProcessorConfiguration config) { - TransactionManager transactionManager = new TenantWrappedTransactionManager(super.transactionManager(name), - tenantDescriptor); - return buildTep(getName(name, tenantDescriptor), eventHandlerInvoker, source, transactionManager, config); - } - - private TrackingEventProcessor buildTep(String name, - EventHandlerInvoker eventHandlerInvoker, - StreamableMessageSource> source, - TrackingEventProcessorConfiguration config) { - return buildTep(name, eventHandlerInvoker, source, super.transactionManager(name), config); - } - - @Override - public EventProcessor pooledStreamingEventProcessor(String name, - EventHandlerInvoker eventHandlerInvoker, - Configuration config, - StreamableMessageSource> source, - PooledStreamingProcessorConfiguration processorConfiguration) { - if (!multiTenantEventProcessorPredicate.test(name)) { - return psepBuilder(name, eventHandlerInvoker, source, config).build(); - } - - MultiTenantEventProcessor eventProcessor = - MultiTenantEventProcessor.builder() - .name(name) - .tenantSegmentFactory( - tenantDescriptor -> { - StreamableMessageSource> tenantSource = - defaultSource(source, tenantDescriptor); - - tenantSource = multiTenantStreamableMessageSourceProvider.build( - tenantSource, - name, - tenantDescriptor, - configuration - ); - - PooledStreamingEventProcessor.Builder builder = psepBuilder( - tenantDescriptor, - name, - eventHandlerInvoker, - tenantSource, - config - ); - - return psepConfigs.getOrDefault("___DEFAULT_PSEP_CONFIG", noOp()) - .andThen(psepConfigs.getOrDefault( - name, - PooledStreamingProcessorConfiguration.noOp() - )) - .andThen(processorConfiguration) - .apply(config, builder) - .build(); - } - ) - .build(); - tenantProvider.subscribe(eventProcessor); - return eventProcessor; - } - - private static StreamableMessageSource> defaultSource( - StreamableMessageSource> source, TenantDescriptor tenantDescriptor - ) { - return source instanceof MultiTenantEventStore - ? ((MultiTenantEventStore) source).tenantSegments().get(tenantDescriptor) - : source; - } - - private PooledStreamingEventProcessor.Builder psepBuilder(String name, - EventHandlerInvoker eventHandlerInvoker, - StreamableMessageSource> source, - TransactionManager transactionManager, - Configuration config) { - return PooledStreamingEventProcessor.builder() - .name(name) - .eventHandlerInvoker(eventHandlerInvoker) - .rollbackConfiguration(super.rollbackConfiguration(name)) - .errorHandler(super.errorHandler(name)) - .messageMonitor(super.messageMonitor(PooledStreamingEventProcessor.class, - name)) - .messageSource(source) - .spanFactory(super.configuration.getComponent(EventProcessorSpanFactory.class)) - .tokenStore(super.tokenStore(name)) - .transactionManager(transactionManager) - .coordinatorExecutor(processorName -> { - ScheduledExecutorService coordinatorExecutor = defaultExecutor( - "Coordinator[" + processorName + "]"); - config.onShutdown(coordinatorExecutor::shutdown); - return coordinatorExecutor; - }) - .workerExecutor(processorName -> { - ScheduledExecutorService workerExecutor = defaultExecutor( - "WorkPackage[" + processorName + "]"); - config.onShutdown(workerExecutor::shutdown); - return workerExecutor; - }); - } - - private PooledStreamingEventProcessor.Builder psepBuilder(TenantDescriptor tenantDescriptor, - String name, - EventHandlerInvoker eventHandlerInvoker, - StreamableMessageSource> source, - Configuration config) { - TransactionManager transactionManager = new TenantWrappedTransactionManager(super.transactionManager(name), - tenantDescriptor); - return psepBuilder(getName(name, tenantDescriptor), eventHandlerInvoker, source, transactionManager, config); - } - - private PooledStreamingEventProcessor.Builder psepBuilder(String name, - EventHandlerInvoker eventHandlerInvoker, - StreamableMessageSource> source, - Configuration config) { - return psepBuilder(name, eventHandlerInvoker, source, super.transactionManager(name), config); - } - - /** - * Registers a {@link MultiTenantDeadLetterQueue} for the given {@code processingGroup}. The given - * {@code queueBuilder} Overrides user defined queue builder and puts the {@link SequencedDeadLetterQueue} in a - * {@link MultiTenantDeadLetterQueue}. - * - * @param processingGroup A {@link String} specifying the name of the processing group to register the given - * {@link SequencedDeadLetterQueue} for. - * @param queueBuilder A builder method returning a {@link SequencedDeadLetterQueue} based on a - * {@link Configuration}. The outcome is used by the given {@code processingGroup} to enqueue - * and evaluate failed events in. - * @return the current {@link EventProcessingConfigurer} instance, for fluent interfacing - */ - @Override - public EventProcessingConfigurer registerDeadLetterQueue( - @Nonnull String processingGroup, - @Nonnull Function>> queueBuilder - ) { - if (multiTenantDeadLetterQueueFactory == null) { - throw new AxonConfigurationException( - "Cannot register a DeadLetterQueue without a MultiTenantDeadLetterQueueFactory" - ); - } - MultiTenantDeadLetterQueue> deadLetterQueue = multiTenantDeadLetterQueueFactory - .getDeadLetterQueue(processingGroup); - deadLetterQueue.registerDeadLetterQueueSupplier(() -> queueBuilder.apply(configuration)); - return super.registerDeadLetterQueue(processingGroup, configuration -> deadLetterQueue); - } - - /** - * {@inheritDoc} - *

    - * Wraps the {@link SequencedDeadLetterProcessor} in a {@link MultiTenantDeadLetterProcessor}, which will delegate - * the processing of the dead letter to the {@link SequencedDeadLetterProcessor} for the tenant of the failed event. - * Enabling the {@link SequencedDeadLetterProcessor} to process dead letters for multiple tenants. - *

    - * It is necessary to invoke {@code forTenant} method on the returned {@link SequencedDeadLetterProcessor} to - * specify the tenant for which the dead letter should be processed. - * - * @param processingGroup The name of the processing group to register the {@link SequencedDeadLetterProcessor} - * for. - */ - @Override - public Optional>> sequencedDeadLetterProcessor( - @Nonnull String processingGroup - ) { - return super.sequencedDeadLetterProcessor(processingGroup) - .map(MultiTenantDeadLetterProcessor::new); - } - - private ScheduledExecutorService defaultExecutor(String factoryName) { - return Executors.newScheduledThreadPool(1, new AxonThreadFactory(factoryName)); - } -} diff --git a/multitenancy/src/main/java/org/axonframework/extensions/multitenancy/configuration/MultiTenantStreamableMessageSourceProvider.java b/multitenancy/src/main/java/org/axonframework/extensions/multitenancy/configuration/MultiTenantStreamableMessageSourceProvider.java deleted file mode 100644 index bf8473e..0000000 --- a/multitenancy/src/main/java/org/axonframework/extensions/multitenancy/configuration/MultiTenantStreamableMessageSourceProvider.java +++ /dev/null @@ -1,49 +0,0 @@ -/* - * Copyright (c) 2010-2023. Axon Framework - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -package org.axonframework.extensions.multitenancy.configuration; - -import org.axonframework.config.Configuration; -import org.axonframework.eventhandling.TrackedEventMessage; -import org.axonframework.extensions.multitenancy.components.TenantDescriptor; -import org.axonframework.messaging.StreamableMessageSource; - - -/** - * A functional interface to provide a {@link StreamableMessageSource} for a given {@link TenantDescriptor} and - * processor name. - * - * @author Stefan Dragisic - * @since 4.8.0 - */ -@FunctionalInterface -public interface MultiTenantStreamableMessageSourceProvider { - - /** - * Provide a custom {@link StreamableMessageSource} for a given {@link TenantDescriptor} and processor name. - * - * @param defaultTenantSource The default {@link StreamableMessageSource} to be used if no tenant-specific source is - * configured. - * @param processorName The name of the processor for which the {@link StreamableMessageSource} is built. - * @param tenantDescriptor The {@link TenantDescriptor} for which the {@link StreamableMessageSource} is built. - * @param configuration The {@link Configuration} used to build the {@link StreamableMessageSource}. - */ - StreamableMessageSource> build( - StreamableMessageSource> defaultTenantSource, - String processorName, - TenantDescriptor tenantDescriptor, - Configuration configuration); -} diff --git a/multitenancy/src/main/resources/META-INF/services/org.axonframework.common.configuration.ConfigurationEnhancer b/multitenancy/src/main/resources/META-INF/services/org.axonframework.common.configuration.ConfigurationEnhancer new file mode 100644 index 0000000..12eda31 --- /dev/null +++ b/multitenancy/src/main/resources/META-INF/services/org.axonframework.common.configuration.ConfigurationEnhancer @@ -0,0 +1 @@ +org.axonframework.extension.multitenancy.core.configuration.MultiTenancyConfigurationDefaults diff --git a/multitenancy/src/test/java/org/axonframework/extension/multitenancy/core/MetadataBasedTenantResolverTest.java b/multitenancy/src/test/java/org/axonframework/extension/multitenancy/core/MetadataBasedTenantResolverTest.java new file mode 100644 index 0000000..807f68a --- /dev/null +++ b/multitenancy/src/test/java/org/axonframework/extension/multitenancy/core/MetadataBasedTenantResolverTest.java @@ -0,0 +1,180 @@ +/* + * Copyright (c) 2010-2025. Axon Framework + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.axonframework.extension.multitenancy.core; + +import org.axonframework.common.AxonConfigurationException; +import org.axonframework.messaging.commandhandling.CommandMessage; +import org.axonframework.messaging.commandhandling.GenericCommandMessage; +import org.axonframework.messaging.core.MessageType; +import org.junit.jupiter.api.*; + +import java.util.Collections; +import java.util.Map; +import java.util.Set; + +import static org.junit.jupiter.api.Assertions.*; + +/** + * Test class validating the {@link MetadataBasedTenantResolver}. + * + * @author Stefan Dragisic + */ +class MetadataBasedTenantResolverTest { + + private static final String TENANT_ID = "tenant-1"; + private static final String CUSTOM_KEY = "customTenantKey"; + private static final MessageType COMMAND_TYPE = new MessageType("TestCommand"); + + private static final TenantDescriptor TENANT_1 = TenantDescriptor.tenantWithId("tenant-1"); + private static final TenantDescriptor TENANT_2 = TenantDescriptor.tenantWithId("tenant-2"); + private static final Set TENANTS = Set.of(TENANT_1, TENANT_2); + + @Test + void resolvesTenantFromDefaultMetadataKey() { + MetadataBasedTenantResolver testSubject = new MetadataBasedTenantResolver(); + + CommandMessage message = new GenericCommandMessage( + COMMAND_TYPE, + "payload", + Map.of("tenantId", TENANT_ID) + ); + + TenantDescriptor result = testSubject.resolveTenant(message, TENANTS); + + assertEquals(TENANT_1, result); + assertEquals(TENANT_ID, result.tenantId()); + } + + @Test + void resolvesTenantFromCustomMetadataKey() { + MetadataBasedTenantResolver testSubject = new MetadataBasedTenantResolver(CUSTOM_KEY); + + CommandMessage message = new GenericCommandMessage( + COMMAND_TYPE, + "payload", + Map.of(CUSTOM_KEY, TENANT_ID) + ); + + TenantDescriptor result = testSubject.resolveTenant(message, TENANTS); + + assertEquals(TENANT_1, result); + } + + @Test + void throwsExceptionWhenMetadataKeyNotPresent() { + MetadataBasedTenantResolver testSubject = new MetadataBasedTenantResolver(); + + CommandMessage message = new GenericCommandMessage( + COMMAND_TYPE, + "payload", + Collections.emptyMap() + ); + + NoSuchTenantException exception = assertThrows( + NoSuchTenantException.class, + () -> testSubject.resolveTenant(message, TENANTS) + ); + + assertTrue(exception.getMessage().contains("tenantId")); + assertTrue(exception.getMessage().contains("metadata")); + } + + @Test + void throwsExceptionWhenCustomKeyNotPresent() { + MetadataBasedTenantResolver testSubject = new MetadataBasedTenantResolver(CUSTOM_KEY); + + CommandMessage message = new GenericCommandMessage( + COMMAND_TYPE, + "payload", + Map.of("wrongKey", TENANT_ID) + ); + + NoSuchTenantException exception = assertThrows( + NoSuchTenantException.class, + () -> testSubject.resolveTenant(message, TENANTS) + ); + + assertTrue(exception.getMessage().contains(CUSTOM_KEY)); + } + + @Test + void defaultConstructorUsesDefaultKey() { + MetadataBasedTenantResolver testSubject = new MetadataBasedTenantResolver(); + + assertEquals(MetadataBasedTenantResolver.DEFAULT_TENANT_KEY, testSubject.metadataKey()); + assertEquals("tenantId", testSubject.metadataKey()); + } + + @Test + void metadataKeyAccessorReturnsConfiguredKey() { + MetadataBasedTenantResolver testSubject = new MetadataBasedTenantResolver(CUSTOM_KEY); + + assertEquals(CUSTOM_KEY, testSubject.metadataKey()); + } + + @Test + void constructorRejectsNullMetadataKey() { + assertThrows( + AxonConfigurationException.class, + () -> new MetadataBasedTenantResolver(null) + ); + } + + @Test + void constructorRejectsEmptyMetadataKey() { + assertThrows( + AxonConfigurationException.class, + () -> new MetadataBasedTenantResolver("") + ); + } + + @Test + void resolvesFromMessageWithMultipleMetadataEntries() { + MetadataBasedTenantResolver testSubject = new MetadataBasedTenantResolver(); + + CommandMessage message = new GenericCommandMessage( + COMMAND_TYPE, + "payload", + Map.of( + "someOtherKey", "someValue", + "tenantId", TENANT_ID, + "anotherKey", "anotherValue" + ) + ); + + TenantDescriptor result = testSubject.resolveTenant(message, TENANTS); + + assertEquals(TENANT_1, result); + } + + @Test + void createsNewTenantDescriptorForUnknownTenant() { + MetadataBasedTenantResolver testSubject = new MetadataBasedTenantResolver(); + String unknownTenantId = "unknown-tenant"; + + CommandMessage message = new GenericCommandMessage( + COMMAND_TYPE, + "payload", + Map.of("tenantId", unknownTenantId) + ); + + // The resolver creates a TenantDescriptor regardless of whether + // it's in the known tenants set - that validation happens elsewhere + TenantDescriptor result = testSubject.resolveTenant(message, TENANTS); + + assertEquals(unknownTenantId, result.tenantId()); + } +} diff --git a/multitenancy/src/test/java/org/axonframework/extension/multitenancy/core/SimpleTenantProviderTest.java b/multitenancy/src/test/java/org/axonframework/extension/multitenancy/core/SimpleTenantProviderTest.java new file mode 100644 index 0000000..79554d2 --- /dev/null +++ b/multitenancy/src/test/java/org/axonframework/extension/multitenancy/core/SimpleTenantProviderTest.java @@ -0,0 +1,237 @@ +/* + * Copyright (c) 2010-2025. Axon Framework + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.axonframework.extension.multitenancy.core; + +import org.axonframework.common.Registration; +import org.junit.jupiter.api.BeforeEach; +import org.junit.jupiter.api.Test; + +import java.util.List; +import java.util.concurrent.atomic.AtomicInteger; + +import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.junit.jupiter.api.Assertions.assertFalse; +import static org.junit.jupiter.api.Assertions.assertTrue; +import static org.mockito.Mockito.mock; +import static org.mockito.Mockito.never; +import static org.mockito.Mockito.verify; + +class SimpleTenantProviderTest { + + private SimpleTenantProvider provider; + private TenantDescriptor tenant1; + private TenantDescriptor tenant2; + + @BeforeEach + void setUp() { + provider = new SimpleTenantProvider(); + tenant1 = TenantDescriptor.tenantWithId("tenant-1"); + tenant2 = TenantDescriptor.tenantWithId("tenant-2"); + } + + @Test + void addTenantReturnsTrueWhenTenantIsNew() { + assertTrue(provider.addTenant(tenant1)); + assertEquals(1, provider.getTenants().size()); + assertTrue(provider.hasTenant(tenant1)); + } + + @Test + void addTenantReturnsFalseWhenTenantAlreadyExists() { + provider.addTenant(tenant1); + assertFalse(provider.addTenant(tenant1)); + assertEquals(1, provider.getTenants().size()); + } + + @Test + void addTenantNotifiesSubscribers() { + MultiTenantAwareComponent subscriber = mock(MultiTenantAwareComponent.class); + provider.subscribe(subscriber); + + provider.addTenant(tenant1); + + verify(subscriber).registerAndStartTenant(tenant1); + } + + @Test + void removeTenantReturnsTrueWhenTenantExists() { + provider.addTenant(tenant1); + assertTrue(provider.removeTenant(tenant1)); + assertFalse(provider.hasTenant(tenant1)); + } + + @Test + void removeTenantReturnsFalseWhenTenantDoesNotExist() { + assertFalse(provider.removeTenant(tenant1)); + } + + @Test + void removeTenantByIdWorks() { + provider.addTenant(tenant1); + assertTrue(provider.removeTenant("tenant-1")); + assertFalse(provider.hasTenant("tenant-1")); + } + + @Test + void subscribeRegistersExistingTenants() { + provider.addTenant(tenant1); + provider.addTenant(tenant2); + + MultiTenantAwareComponent subscriber = mock(MultiTenantAwareComponent.class); + provider.subscribe(subscriber); + + verify(subscriber).registerTenant(tenant1); + verify(subscriber).registerTenant(tenant2); + } + + @Test + void unsubscribeStopsNotifications() { + MultiTenantAwareComponent subscriber = mock(MultiTenantAwareComponent.class); + Registration registration = provider.subscribe(subscriber); + + registration.cancel(); + provider.addTenant(tenant1); + + verify(subscriber, never()).registerAndStartTenant(tenant1); + } + + @Test + void constructorWithInitialTenants() { + SimpleTenantProvider providerWithTenants = new SimpleTenantProvider(List.of(tenant1, tenant2)); + + assertEquals(2, providerWithTenants.getTenants().size()); + assertTrue(providerWithTenants.hasTenant(tenant1)); + assertTrue(providerWithTenants.hasTenant(tenant2)); + } + + @Test + void addTenantsAddsMutlipleTenants() { + provider.addTenants(List.of(tenant1, tenant2)); + + assertEquals(2, provider.getTenants().size()); + assertTrue(provider.hasTenant(tenant1)); + assertTrue(provider.hasTenant(tenant2)); + } + + @Test + void isThreadSafe() throws InterruptedException { + AtomicInteger addCount = new AtomicInteger(0); + MultiTenantAwareComponent subscriber = mock(MultiTenantAwareComponent.class); + provider.subscribe(subscriber); + + Thread[] threads = new Thread[10]; + for (int i = 0; i < 10; i++) { + int tenantNum = i; + threads[i] = new Thread(() -> { + TenantDescriptor tenant = TenantDescriptor.tenantWithId("tenant-" + tenantNum); + if (provider.addTenant(tenant)) { + addCount.incrementAndGet(); + } + }); + } + + for (Thread thread : threads) { + thread.start(); + } + for (Thread thread : threads) { + thread.join(); + } + + assertEquals(10, addCount.get()); + assertEquals(10, provider.getTenants().size()); + } + + @Test + void removeTenantTriggersCleanupRegistrations() { + AtomicInteger cleanupCount = new AtomicInteger(0); + + MultiTenantAwareComponent subscriber = new MultiTenantAwareComponent() { + @Override + public Registration registerTenant(TenantDescriptor tenantDescriptor) { + return () -> { + cleanupCount.incrementAndGet(); + return true; + }; + } + + @Override + public Registration registerAndStartTenant(TenantDescriptor tenantDescriptor) { + return registerTenant(tenantDescriptor); + } + }; + + provider.subscribe(subscriber); + provider.addTenant(tenant1); + + assertEquals(0, cleanupCount.get()); + + provider.removeTenant(tenant1); + + assertEquals(1, cleanupCount.get()); + } + + @Test + void removeTenantTriggersCleanupForAllSubscribers() { + AtomicInteger cleanupCount = new AtomicInteger(0); + + MultiTenantAwareComponent subscriber1 = createCleanupCountingSubscriber(cleanupCount); + MultiTenantAwareComponent subscriber2 = createCleanupCountingSubscriber(cleanupCount); + + provider.subscribe(subscriber1); + provider.subscribe(subscriber2); + provider.addTenant(tenant1); + + assertEquals(0, cleanupCount.get()); + + provider.removeTenant(tenant1); + + assertEquals(2, cleanupCount.get()); + } + + @Test + void subscribeAfterAddTenantStillGetsCleanupOnRemove() { + AtomicInteger cleanupCount = new AtomicInteger(0); + + // Add tenant first + provider.addTenant(tenant1); + + // Subscribe after + MultiTenantAwareComponent subscriber = createCleanupCountingSubscriber(cleanupCount); + provider.subscribe(subscriber); + + // Cleanup should still be triggered + provider.removeTenant(tenant1); + + assertEquals(1, cleanupCount.get()); + } + + private MultiTenantAwareComponent createCleanupCountingSubscriber(AtomicInteger cleanupCount) { + return new MultiTenantAwareComponent() { + @Override + public Registration registerTenant(TenantDescriptor tenantDescriptor) { + return () -> { + cleanupCount.incrementAndGet(); + return true; + }; + } + + @Override + public Registration registerAndStartTenant(TenantDescriptor tenantDescriptor) { + return registerTenant(tenantDescriptor); + } + }; + } +} diff --git a/multitenancy/src/test/java/org/axonframework/extension/multitenancy/core/TenantComponentRegistryTest.java b/multitenancy/src/test/java/org/axonframework/extension/multitenancy/core/TenantComponentRegistryTest.java new file mode 100644 index 0000000..c0f96dc --- /dev/null +++ b/multitenancy/src/test/java/org/axonframework/extension/multitenancy/core/TenantComponentRegistryTest.java @@ -0,0 +1,196 @@ +/* + * Copyright (c) 2010-2025. Axon Framework + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.axonframework.extension.multitenancy.core; + +import org.axonframework.common.Registration; +import org.junit.jupiter.api.BeforeEach; +import org.junit.jupiter.api.Test; + +import java.util.concurrent.atomic.AtomicBoolean; +import java.util.concurrent.atomic.AtomicInteger; +import java.util.concurrent.atomic.AtomicReference; + +import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.junit.jupiter.api.Assertions.assertFalse; +import static org.junit.jupiter.api.Assertions.assertNotNull; +import static org.junit.jupiter.api.Assertions.assertNull; +import static org.junit.jupiter.api.Assertions.assertSame; +import static org.junit.jupiter.api.Assertions.assertTrue; + +class TenantComponentRegistryTest { + + private TenantDescriptor tenant1; + private TenantDescriptor tenant2; + + @BeforeEach + void setUp() { + tenant1 = TenantDescriptor.tenantWithId("tenant-1"); + tenant2 = TenantDescriptor.tenantWithId("tenant-2"); + } + + @Test + void getComponentCreatesLazily() { + AtomicInteger createCount = new AtomicInteger(0); + + TenantComponentRegistry registry = new TenantComponentRegistry<>( + String.class, + tenant -> { + createCount.incrementAndGet(); + return "component-for-" + tenant.tenantId(); + } + ); + + registry.registerTenant(tenant1); + assertEquals(0, createCount.get(), "Component should not be created on registration"); + + String component = registry.getComponent(tenant1); + assertEquals(1, createCount.get(), "Component should be created on first access"); + assertEquals("component-for-tenant-1", component); + + // Second access should return cached instance + String sameComponent = registry.getComponent(tenant1); + assertEquals(1, createCount.get(), "Component should be cached"); + assertSame(component, sameComponent); + } + + @Test + void cleanupInvokedOnTenantRemoval() { + AtomicBoolean cleanupCalled = new AtomicBoolean(false); + AtomicReference cleanedComponent = new AtomicReference<>(); + + TenantComponentFactory factory = new TenantComponentFactory<>() { + @Override + public String apply(TenantDescriptor tenant) { + return "component-for-" + tenant.tenantId(); + } + + @Override + public void cleanup(TenantDescriptor tenant, String component) { + cleanupCalled.set(true); + cleanedComponent.set(component); + } + }; + + TenantComponentRegistry registry = new TenantComponentRegistry<>(String.class, factory); + Registration registration = registry.registerTenant(tenant1); + + // Create the component + String component = registry.getComponent(tenant1); + assertNotNull(component); + assertFalse(cleanupCalled.get()); + + // Cancel registration (simulates tenant removal) + registration.cancel(); + + assertTrue(cleanupCalled.get()); + assertEquals(component, cleanedComponent.get()); + } + + @Test + void cleanupNotInvokedIfComponentNeverCreated() { + AtomicBoolean cleanupCalled = new AtomicBoolean(false); + + TenantComponentFactory factory = new TenantComponentFactory<>() { + @Override + public String apply(TenantDescriptor tenant) { + return "component"; + } + + @Override + public void cleanup(TenantDescriptor tenant, String component) { + cleanupCalled.set(true); + } + }; + + TenantComponentRegistry registry = new TenantComponentRegistry<>(String.class, factory); + Registration registration = registry.registerTenant(tenant1); + + // Don't access component, just cancel + registration.cancel(); + + assertFalse(cleanupCalled.get(), "Cleanup should not be called if component was never created"); + } + + @Test + void autoCloseableComponentsClosedAutomatically() { + AtomicBoolean closed = new AtomicBoolean(false); + + TenantComponentRegistry registry = new TenantComponentRegistry<>( + AutoCloseable.class, + tenant -> () -> closed.set(true) + ); + + Registration registration = registry.registerTenant(tenant1); + registry.getComponent(tenant1); + + assertFalse(closed.get()); + + registration.cancel(); + + assertTrue(closed.get(), "AutoCloseable should be closed on tenant removal"); + } + + @Test + void getTenantsReturnsRegisteredTenants() { + TenantComponentRegistry registry = new TenantComponentRegistry<>( + String.class, + tenant -> "component" + ); + + assertTrue(registry.getTenants().isEmpty()); + + registry.registerTenant(tenant1); + registry.registerTenant(tenant2); + + assertEquals(2, registry.getTenants().size()); + assertTrue(registry.getTenants().contains(tenant1)); + assertTrue(registry.getTenants().contains(tenant2)); + } + + @Test + void tenantRemovedFromTenantsSetOnCancel() { + TenantComponentRegistry registry = new TenantComponentRegistry<>( + String.class, + tenant -> "component" + ); + + Registration registration = registry.registerTenant(tenant1); + assertTrue(registry.getTenants().contains(tenant1)); + + registration.cancel(); + assertFalse(registry.getTenants().contains(tenant1)); + } + + @Test + void componentRemovedFromCacheOnCancel() { + TenantComponentRegistry registry = new TenantComponentRegistry<>( + String.class, + tenant -> "component" + ); + + Registration registration = registry.registerTenant(tenant1); + String first = registry.getComponent(tenant1); + + registration.cancel(); + + // Re-register and get component should create new instance + registry.registerTenant(tenant1); + String second = registry.getComponent(tenant1); + + // Should be equal content but new instance (since factory returns same string) + assertEquals(first, second); + } +} diff --git a/multitenancy/src/test/java/org/axonframework/extensions/multitenancy/components/TenantDescriptorTest.java b/multitenancy/src/test/java/org/axonframework/extension/multitenancy/core/TenantDescriptorTest.java similarity index 98% rename from multitenancy/src/test/java/org/axonframework/extensions/multitenancy/components/TenantDescriptorTest.java rename to multitenancy/src/test/java/org/axonframework/extension/multitenancy/core/TenantDescriptorTest.java index a1f3474..17cdf55 100644 --- a/multitenancy/src/test/java/org/axonframework/extensions/multitenancy/components/TenantDescriptorTest.java +++ b/multitenancy/src/test/java/org/axonframework/extension/multitenancy/core/TenantDescriptorTest.java @@ -14,7 +14,7 @@ * limitations under the License. */ -package org.axonframework.extensions.multitenancy.components; +package org.axonframework.extension.multitenancy.core; import org.junit.jupiter.api.*; diff --git a/multitenancy/src/test/java/org/axonframework/extension/multitenancy/core/configuration/MultiTenancyConfigurationDefaultsTest.java b/multitenancy/src/test/java/org/axonframework/extension/multitenancy/core/configuration/MultiTenancyConfigurationDefaultsTest.java new file mode 100644 index 0000000..220f7e0 --- /dev/null +++ b/multitenancy/src/test/java/org/axonframework/extension/multitenancy/core/configuration/MultiTenancyConfigurationDefaultsTest.java @@ -0,0 +1,153 @@ +/* + * Copyright (c) 2010-2025. Axon Framework + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.axonframework.extension.multitenancy.core.configuration; + +import org.axonframework.common.configuration.Configuration; +import org.axonframework.extension.multitenancy.core.TenantDescriptor; +import org.axonframework.extension.multitenancy.messaging.commandhandling.MultiTenantCommandBus; +import org.axonframework.extension.multitenancy.messaging.commandhandling.TenantCommandSegmentFactory; +import org.axonframework.extension.multitenancy.messaging.queryhandling.MultiTenantQueryBus; +import org.axonframework.extension.multitenancy.messaging.queryhandling.TenantQuerySegmentFactory; +import org.axonframework.messaging.commandhandling.CommandBus; +import org.axonframework.messaging.commandhandling.interception.InterceptingCommandBus; +import org.axonframework.messaging.core.configuration.MessagingConfigurer; +import org.axonframework.messaging.queryhandling.QueryBus; +import org.axonframework.messaging.queryhandling.interception.InterceptingQueryBus; +import org.junit.jupiter.api.*; + +import static org.junit.jupiter.api.Assertions.*; +import static org.mockito.Mockito.*; + +/** + * Test class validating the {@link MultiTenancyConfigurationDefaults}. + * + * @author Stefan Dragisic + */ +class MultiTenancyConfigurationDefaultsTest { + + @Test + void orderIsMaxIntegerMinusOne() { + assertEquals(Integer.MAX_VALUE - 1, new MultiTenancyConfigurationDefaults().order()); + } + + @Test + void commandBusNotWrappedWithoutSegmentFactory() { + Configuration resultConfig = MultiTenancyConfigurer.enhance(MessagingConfigurer.create()) + .registerTargetTenantResolver(config -> (message, tenants) -> + TenantDescriptor.tenantWithId("test")) + .build(); + + CommandBus commandBus = resultConfig.getComponent(CommandBus.class); + // Should not be multi-tenant since no segment factory was registered + assertFalse(commandBus instanceof MultiTenantCommandBus, + "CommandBus should not be multi-tenant without segment factory"); + } + + @Test + void commandBusNotWrappedWithoutResolver() { + CommandBus mockSegmentBus = mock(CommandBus.class); + TenantCommandSegmentFactory segmentFactory = tenant -> mockSegmentBus; + + Configuration resultConfig = MultiTenancyConfigurer.enhance(MessagingConfigurer.create()) + .registerCommandBusSegmentFactory(config -> segmentFactory) + // No resolver registered + .build(); + + CommandBus commandBus = resultConfig.getComponent(CommandBus.class); + // Should not be multi-tenant since no resolver was registered + assertFalse(commandBus instanceof MultiTenantCommandBus, + "CommandBus should not be multi-tenant without tenant resolver"); + } + + @Test + void commandBusWrappedWhenBothFactoryAndResolverConfigured() { + CommandBus mockSegmentBus = mock(CommandBus.class); + TenantCommandSegmentFactory segmentFactory = tenant -> mockSegmentBus; + + Configuration resultConfig = MultiTenancyConfigurer.enhance(MessagingConfigurer.create()) + .registerCommandBusSegmentFactory(config -> segmentFactory) + .registerTargetTenantResolver(config -> (message, tenants) -> + TenantDescriptor.tenantWithId("test")) + .build(); + + CommandBus commandBus = resultConfig.getComponent(CommandBus.class); + // InterceptingCommandBus wraps MultiTenantCommandBus (following AF5 decorator pattern) + assertInstanceOf(InterceptingCommandBus.class, commandBus, + "CommandBus should be wrapped with InterceptingCommandBus"); + // The multi-tenant bus is inside the decoration chain + assertTrue(resultConfig.hasComponent(MultiTenantCommandBus.class) || + commandBus instanceof InterceptingCommandBus, + "MultiTenantCommandBus should be in the decoration chain"); + } + + @Test + void queryBusNotWrappedWithoutSegmentFactory() { + Configuration resultConfig = MultiTenancyConfigurer.enhance(MessagingConfigurer.create()) + .registerTargetTenantResolver(config -> (message, tenants) -> + TenantDescriptor.tenantWithId("test")) + .build(); + + QueryBus queryBus = resultConfig.getComponent(QueryBus.class); + // Should not be multi-tenant since no segment factory was registered + assertFalse(queryBus instanceof MultiTenantQueryBus, + "QueryBus should not be multi-tenant without segment factory"); + } + + @Test + void queryBusWrappedWhenBothFactoryAndResolverConfigured() { + QueryBus mockSegmentBus = mock(QueryBus.class); + TenantQuerySegmentFactory segmentFactory = tenant -> mockSegmentBus; + + Configuration resultConfig = MultiTenancyConfigurer.enhance(MessagingConfigurer.create()) + .registerQueryBusSegmentFactory(config -> segmentFactory) + .registerTargetTenantResolver(config -> (message, tenants) -> + TenantDescriptor.tenantWithId("test")) + .build(); + + QueryBus queryBus = resultConfig.getComponent(QueryBus.class); + // InterceptingQueryBus wraps MultiTenantQueryBus (following AF5 decorator pattern) + assertInstanceOf(InterceptingQueryBus.class, queryBus, + "QueryBus should be wrapped with InterceptingQueryBus"); + } + + @Test + void multipleComponentsCanBeConfiguredTogether() { + CommandBus mockCommandBus = mock(CommandBus.class); + QueryBus mockQueryBus = mock(QueryBus.class); + + Configuration resultConfig = MultiTenancyConfigurer.enhance(MessagingConfigurer.create()) + .registerCommandBusSegmentFactory(config -> tenant -> mockCommandBus) + .registerQueryBusSegmentFactory(config -> tenant -> mockQueryBus) + .registerTargetTenantResolver(config -> (message, tenants) -> + TenantDescriptor.tenantWithId("test")) + .build(); + + // Both buses are wrapped with intercepting decorators following AF5 pattern + assertInstanceOf(InterceptingCommandBus.class, resultConfig.getComponent(CommandBus.class)); + assertInstanceOf(InterceptingQueryBus.class, resultConfig.getComponent(QueryBus.class)); + } + + @Test + void decoratorOrderIsBeforeInterceptingBus() { + // Verify our decoration order is less than InterceptingCommandBus (MIN + 100) + // so that InterceptingCommandBus wraps our MultiTenantCommandBus + assertTrue( + MultiTenantCommandBus.DECORATION_ORDER < InterceptingCommandBus.DECORATION_ORDER, + "Multi-tenant decorator should run before intercepting decorator" + ); + } +} diff --git a/multitenancy/src/test/java/org/axonframework/extension/multitenancy/core/configuration/MultiTenancyConfigurerTest.java b/multitenancy/src/test/java/org/axonframework/extension/multitenancy/core/configuration/MultiTenancyConfigurerTest.java new file mode 100644 index 0000000..f2d4210 --- /dev/null +++ b/multitenancy/src/test/java/org/axonframework/extension/multitenancy/core/configuration/MultiTenancyConfigurerTest.java @@ -0,0 +1,166 @@ +/* + * Copyright (c) 2010-2025. Axon Framework + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.axonframework.extension.multitenancy.core.configuration; + +import org.axonframework.common.configuration.Configuration; +import org.axonframework.extension.multitenancy.core.MetadataBasedTenantResolver; +import org.axonframework.extension.multitenancy.core.TargetTenantResolver; +import org.axonframework.extension.multitenancy.core.TenantConnectPredicate; +import org.axonframework.extension.multitenancy.core.TenantProvider; +import org.axonframework.extension.multitenancy.eventsourcing.eventstore.TenantEventSegmentFactory; +import org.axonframework.extension.multitenancy.messaging.commandhandling.TenantCommandSegmentFactory; +import org.axonframework.extension.multitenancy.messaging.eventhandling.processing.TenantEventProcessorSegmentFactory; +import org.axonframework.extension.multitenancy.messaging.queryhandling.TenantQuerySegmentFactory; +import org.axonframework.messaging.core.Message; +import org.axonframework.messaging.core.configuration.MessagingConfigurer; +import org.junit.jupiter.api.*; + +import static org.junit.jupiter.api.Assertions.*; +import static org.mockito.Mockito.*; + +/** + * Test class validating the {@link MultiTenancyConfigurer}. + * + * @author Stefan Dragisic + * @since 5.0.0 + */ +class MultiTenancyConfigurerTest { + + private MultiTenancyConfigurer testSubject; + + @BeforeEach + void setUp() { + testSubject = MultiTenancyConfigurer.enhance(MessagingConfigurer.create()); + } + + @Test + void registerTenantProviderMakesProviderRetrievable() { + TenantProvider expected = mock(TenantProvider.class); + + Configuration result = testSubject.registerTenantProvider(config -> expected) + .build(); + + assertEquals(expected, result.getComponent(TenantProvider.class)); + } + + @SuppressWarnings("unchecked") + @Test + void registerTargetTenantResolverMakesResolverRetrievable() { + TargetTenantResolver expected = new MetadataBasedTenantResolver(); + + Configuration result = testSubject.registerTargetTenantResolver(config -> expected) + .build(); + + assertEquals(expected, result.getComponent(TargetTenantResolver.class)); + } + + @Test + void registerTenantConnectPredicateMakesPredicateRetrievable() { + TenantConnectPredicate expected = tenant -> true; + + Configuration result = testSubject.registerTenantConnectPredicate(config -> expected) + .build(); + + assertEquals(expected, result.getComponent(TenantConnectPredicate.class)); + } + + @Test + void registerCommandBusSegmentFactoryMakesFactoryRetrievable() { + TenantCommandSegmentFactory expected = mock(TenantCommandSegmentFactory.class); + + Configuration result = testSubject.registerCommandBusSegmentFactory(config -> expected) + .build(); + + assertEquals(expected, result.getComponent(TenantCommandSegmentFactory.class)); + } + + @Test + void registerQueryBusSegmentFactoryMakesFactoryRetrievable() { + TenantQuerySegmentFactory expected = mock(TenantQuerySegmentFactory.class); + + Configuration result = testSubject.registerQueryBusSegmentFactory(config -> expected) + .build(); + + assertEquals(expected, result.getComponent(TenantQuerySegmentFactory.class)); + } + + @Test + void registerEventStoreSegmentFactoryMakesFactoryRetrievable() { + TenantEventSegmentFactory expected = mock(TenantEventSegmentFactory.class); + + Configuration result = testSubject.registerEventStoreSegmentFactory(config -> expected) + .build(); + + assertEquals(expected, result.getComponent(TenantEventSegmentFactory.class)); + } + + @Test + void registerEventProcessorSegmentFactoryMakesFactoryRetrievable() { + TenantEventProcessorSegmentFactory expected = mock(TenantEventProcessorSegmentFactory.class); + + Configuration result = testSubject.registerEventProcessorSegmentFactory(config -> expected) + .build(); + + assertEquals(expected, result.getComponent(TenantEventProcessorSegmentFactory.class)); + } + + @Test + void enhanceWithNullConfigurerThrowsException() { + assertThrows(NullPointerException.class, () -> MultiTenancyConfigurer.enhance((MessagingConfigurer) null)); + } + + @Test + void fluentApiReturnsSameInstance() { + TenantProvider tenantProvider = mock(TenantProvider.class); + TenantCommandSegmentFactory commandFactory = mock(TenantCommandSegmentFactory.class); + + MultiTenancyConfigurer result = testSubject + .registerTenantProvider(config -> tenantProvider) + .registerCommandBusSegmentFactory(config -> commandFactory); + + assertSame(testSubject, result); + } + + @Test + void multipleRegistrationsCanBeChained() { + TenantProvider tenantProvider = mock(TenantProvider.class); + TargetTenantResolver resolver = new MetadataBasedTenantResolver(); + TenantConnectPredicate predicate = tenant -> true; + TenantCommandSegmentFactory commandFactory = mock(TenantCommandSegmentFactory.class); + TenantQuerySegmentFactory queryFactory = mock(TenantQuerySegmentFactory.class); + TenantEventSegmentFactory eventFactory = mock(TenantEventSegmentFactory.class); + TenantEventProcessorSegmentFactory processorFactory = mock(TenantEventProcessorSegmentFactory.class); + + Configuration result = testSubject + .registerTenantProvider(config -> tenantProvider) + .registerTargetTenantResolver(config -> resolver) + .registerTenantConnectPredicate(config -> predicate) + .registerCommandBusSegmentFactory(config -> commandFactory) + .registerQueryBusSegmentFactory(config -> queryFactory) + .registerEventStoreSegmentFactory(config -> eventFactory) + .registerEventProcessorSegmentFactory(config -> processorFactory) + .build(); + + assertEquals(tenantProvider, result.getComponent(TenantProvider.class)); + assertEquals(resolver, result.getComponent(TargetTenantResolver.class)); + assertEquals(predicate, result.getComponent(TenantConnectPredicate.class)); + assertEquals(commandFactory, result.getComponent(TenantCommandSegmentFactory.class)); + assertEquals(queryFactory, result.getComponent(TenantQuerySegmentFactory.class)); + assertEquals(eventFactory, result.getComponent(TenantEventSegmentFactory.class)); + assertEquals(processorFactory, result.getComponent(TenantEventProcessorSegmentFactory.class)); + } +} diff --git a/multitenancy/src/test/java/org/axonframework/extension/multitenancy/eventsourcing/eventstore/JpaTenantEventSegmentFactoryTest.java b/multitenancy/src/test/java/org/axonframework/extension/multitenancy/eventsourcing/eventstore/JpaTenantEventSegmentFactoryTest.java new file mode 100644 index 0000000..00e9967 --- /dev/null +++ b/multitenancy/src/test/java/org/axonframework/extension/multitenancy/eventsourcing/eventstore/JpaTenantEventSegmentFactoryTest.java @@ -0,0 +1,176 @@ +/* + * Copyright (c) 2010-2025. Axon Framework + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.axonframework.extension.multitenancy.eventsourcing.eventstore; + +import jakarta.persistence.EntityManager; +import jakarta.persistence.EntityManagerFactory; +import org.axonframework.eventsourcing.eventstore.AnnotationBasedTagResolver; +import org.axonframework.eventsourcing.eventstore.EventStore; +import org.axonframework.eventsourcing.eventstore.StorageEngineBackedEventStore; +import org.axonframework.eventsourcing.eventstore.TagResolver; +import org.axonframework.extension.multitenancy.core.TenantDescriptor; +import org.axonframework.messaging.core.unitofwork.transaction.TransactionManager; +import org.axonframework.messaging.eventhandling.conversion.EventConverter; +import org.junit.jupiter.api.BeforeEach; +import org.junit.jupiter.api.Test; + +import java.util.function.Function; + +import static org.junit.jupiter.api.Assertions.*; +import static org.mockito.Mockito.*; + +/** + * Test class validating the {@link JpaTenantEventSegmentFactory}. + * + * @author Theo Emanuelsson + */ +class JpaTenantEventSegmentFactoryTest { + + private static final TenantDescriptor TENANT_1 = TenantDescriptor.tenantWithId("tenant1"); + private static final TenantDescriptor TENANT_2 = TenantDescriptor.tenantWithId("tenant2"); + + private Function emfProvider; + private TransactionManager transactionManager; + private EventConverter eventConverter; + private JpaTenantEventSegmentFactory testSubject; + + @BeforeEach + @SuppressWarnings("unchecked") + void setUp() { + emfProvider = mock(Function.class); + transactionManager = mock(TransactionManager.class); + eventConverter = mock(EventConverter.class); + + // Setup mock to return an EntityManagerFactory for any tenant + EntityManagerFactory mockEmf = mock(EntityManagerFactory.class); + when(mockEmf.createEntityManager()).thenReturn(mock(EntityManager.class)); + when(emfProvider.apply(any(TenantDescriptor.class))).thenReturn(mockEmf); + + testSubject = new JpaTenantEventSegmentFactory(emfProvider, transactionManager, eventConverter); + } + + @Test + void applyReturnsStorageEngineBackedEventStore() { + EventStore eventStore = testSubject.apply(TENANT_1); + + assertNotNull(eventStore); + assertInstanceOf(StorageEngineBackedEventStore.class, eventStore); + } + + @Test + void applyReturnsSameEventStoreForSameTenant() { + EventStore first = testSubject.apply(TENANT_1); + EventStore second = testSubject.apply(TENANT_1); + + assertSame(first, second); + } + + @Test + void applyReturnsDifferentEventStoresForDifferentTenants() { + EventStore eventStore1 = testSubject.apply(TENANT_1); + EventStore eventStore2 = testSubject.apply(TENANT_2); + + assertNotSame(eventStore1, eventStore2); + } + + @Test + void eventStoreCountReflectsNumberOfCreatedStores() { + assertEquals(0, testSubject.eventStoreCount()); + + testSubject.apply(TENANT_1); + assertEquals(1, testSubject.eventStoreCount()); + + testSubject.apply(TENANT_2); + assertEquals(2, testSubject.eventStoreCount()); + + // Applying same tenant again should not increase count + testSubject.apply(TENANT_1); + assertEquals(2, testSubject.eventStoreCount()); + } + + @Test + void constructorWithCustomConfiguration() { + TagResolver customTagResolver = new AnnotationBasedTagResolver(); + + JpaTenantEventSegmentFactory factory = new JpaTenantEventSegmentFactory( + emfProvider, + transactionManager, + eventConverter, + c -> c.batchSize(50), + customTagResolver + ); + + EventStore eventStore = factory.apply(TENANT_1); + assertNotNull(eventStore); + } + + @Test + void constructorRejectsNullEmfProvider() { + assertThrows(NullPointerException.class, () -> + new JpaTenantEventSegmentFactory(null, transactionManager, eventConverter) + ); + } + + @Test + void constructorRejectsNullTransactionManager() { + assertThrows(NullPointerException.class, () -> + new JpaTenantEventSegmentFactory(emfProvider, null, eventConverter) + ); + } + + @Test + void constructorRejectsNullEventConverter() { + assertThrows(NullPointerException.class, () -> + new JpaTenantEventSegmentFactory(emfProvider, transactionManager, null) + ); + } + + @Test + void fullConstructorRejectsNullConfigurer() { + assertThrows(NullPointerException.class, () -> + new JpaTenantEventSegmentFactory( + emfProvider, + transactionManager, + eventConverter, + null, + new AnnotationBasedTagResolver() + ) + ); + } + + @Test + void fullConstructorRejectsNullTagResolver() { + assertThrows(NullPointerException.class, () -> + new JpaTenantEventSegmentFactory( + emfProvider, + transactionManager, + eventConverter, + c -> c, + null + ) + ); + } + + @Test + void emfProviderIsCalledForEachNewTenant() { + testSubject.apply(TENANT_1); + testSubject.apply(TENANT_2); + testSubject.apply(TENANT_1); // Should not call provider again + + verify(emfProvider, times(1)).apply(TENANT_1); + verify(emfProvider, times(1)).apply(TENANT_2); + } +} diff --git a/multitenancy/src/test/java/org/axonframework/extension/multitenancy/eventsourcing/eventstore/MultiTenantEventStoreTest.java b/multitenancy/src/test/java/org/axonframework/extension/multitenancy/eventsourcing/eventstore/MultiTenantEventStoreTest.java new file mode 100644 index 0000000..ec6120e --- /dev/null +++ b/multitenancy/src/test/java/org/axonframework/extension/multitenancy/eventsourcing/eventstore/MultiTenantEventStoreTest.java @@ -0,0 +1,212 @@ +/* + * Copyright (c) 2010-2025. Axon Framework + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.axonframework.extension.multitenancy.eventsourcing.eventstore; + +import org.axonframework.common.Registration; +import org.axonframework.eventsourcing.eventstore.EventStore; +import org.axonframework.extension.multitenancy.core.NoSuchTenantException; +import org.axonframework.extension.multitenancy.core.TargetTenantResolver; +import org.axonframework.extension.multitenancy.core.TenantDescriptor; +import org.axonframework.messaging.core.Message; +import org.axonframework.messaging.core.MessageType; +import org.axonframework.messaging.eventhandling.EventMessage; +import org.axonframework.messaging.eventhandling.GenericEventMessage; +import org.axonframework.messaging.eventstreaming.StreamingCondition; +import org.junit.jupiter.api.*; + +import java.util.List; +import java.util.concurrent.CompletableFuture; + +import static org.junit.jupiter.api.Assertions.*; +import static org.mockito.ArgumentMatchers.*; +import static org.mockito.Mockito.*; + +/** + * Test class validating the {@link MultiTenantEventStore}. + * + * @author Stefan Dragisic + */ +class MultiTenantEventStoreTest { + + private static final TenantDescriptor TENANT_1 = TenantDescriptor.tenantWithId("tenant1"); + private static final TenantDescriptor TENANT_2 = TenantDescriptor.tenantWithId("tenant2"); + + private EventStore tenantSegment1; + private EventStore tenantSegment2; + + private MultiTenantEventStore testSubject; + + @BeforeEach + void setUp() { + tenantSegment1 = mock(EventStore.class); + tenantSegment2 = mock(EventStore.class); + + when(tenantSegment1.subscribe(any())).thenReturn(() -> true); + when(tenantSegment2.subscribe(any())).thenReturn(() -> true); + + TenantEventSegmentFactory tenantSegmentFactory = tenant -> { + if (tenant.tenantId().equals("tenant1")) { + return tenantSegment1; + } else { + return tenantSegment2; + } + }; + + // Resolver always resolves to tenant2 + TargetTenantResolver targetTenantResolver = + (message, tenants) -> TENANT_2; + + testSubject = MultiTenantEventStore.builder() + .tenantSegmentFactory(tenantSegmentFactory) + .targetTenantResolver(targetTenantResolver) + .build(); + } + + @Test + void publishRoutesToCorrectTenant() { + when(tenantSegment2.publish(any(), anyList())) + .thenReturn(CompletableFuture.completedFuture(null)); + + testSubject.registerTenant(TENANT_1); + testSubject.registerTenant(TENANT_2); + + EventMessage event = new GenericEventMessage(new MessageType("TestEvent"), "payload"); + CompletableFuture result = testSubject.publish(null, List.of(event)); + + assertTrue(result.isDone()); + verify(tenantSegment2).publish(isNull(), eq(List.of(event))); + verify(tenantSegment1, never()).publish(any(), anyList()); + } + + @Test + void publishEmptyListReturnsImmediately() { + testSubject.registerTenant(TENANT_1); + + CompletableFuture result = testSubject.publish(null, List.of()); + + assertTrue(result.isDone()); + verify(tenantSegment1, never()).publish(any(), anyList()); + verify(tenantSegment2, never()).publish(any(), anyList()); + } + + @Test + void publishToUnknownTenantThrowsException() { + // No tenants registered + EventMessage event = new GenericEventMessage(new MessageType("TestEvent"), "payload"); + + assertThrows(NoSuchTenantException.class, + () -> testSubject.publish(null, List.of(event))); + } + + @Test + void subscribeRegistersOnExistingTenants() { + testSubject.registerTenant(TENANT_1); + testSubject.registerTenant(TENANT_2); + + testSubject.subscribe((events, ctx) -> CompletableFuture.completedFuture(null)); + + verify(tenantSegment1).subscribe(any()); + verify(tenantSegment2).subscribe(any()); + } + + @Test + void registerAndStartTenantSubscribesExistingConsumers() { + // First subscribe a consumer + testSubject.subscribe((events, ctx) -> CompletableFuture.completedFuture(null)); + + // Then register and start a tenant + testSubject.registerAndStartTenant(TENANT_1); + + // Consumer should be subscribed to the new tenant segment + verify(tenantSegment1).subscribe(any()); + } + + @Test + void openStreamThrowsUnsupportedOperationException() { + testSubject.registerTenant(TENANT_1); + + // Use the factory method to create a StreamingCondition + StreamingCondition condition = StreamingCondition.startingFrom(null); + assertThrows(UnsupportedOperationException.class, + () -> testSubject.open(condition, null)); + } + + @Test + void firstTokenThrowsUnsupportedOperationException() { + testSubject.registerTenant(TENANT_1); + + assertThrows(UnsupportedOperationException.class, + () -> testSubject.firstToken(null)); + } + + @Test + void latestTokenThrowsUnsupportedOperationException() { + testSubject.registerTenant(TENANT_1); + + assertThrows(UnsupportedOperationException.class, + () -> testSubject.latestToken(null)); + } + + @Test + void tokenAtThrowsUnsupportedOperationException() { + testSubject.registerTenant(TENANT_1); + + assertThrows(UnsupportedOperationException.class, + () -> testSubject.tokenAt(java.time.Instant.now(), null)); + } + + @Test + void unregisterTenantRemovesTenantFromRouting() { + Registration registration = testSubject.registerTenant(TENANT_2); + + // Unregister the tenant + registration.cancel(); + + // Should throw because tenant is no longer registered + EventMessage event = new GenericEventMessage(new MessageType("TestEvent"), "payload"); + assertThrows(NoSuchTenantException.class, + () -> testSubject.publish(null, List.of(event))); + } + + @Test + void tenantSegmentsReturnsRegisteredTenants() { + testSubject.registerTenant(TENANT_1); + testSubject.registerTenant(TENANT_2); + + assertEquals(2, testSubject.tenantSegments().size()); + assertTrue(testSubject.tenantSegments().containsKey(TENANT_1)); + assertTrue(testSubject.tenantSegments().containsKey(TENANT_2)); + } + + @Test + void builderRequiresTenantSegmentFactory() { + assertThrows(Exception.class, () -> + MultiTenantEventStore.builder() + .targetTenantResolver((m, t) -> TENANT_1) + .build() + ); + } + + @Test + void builderRequiresTargetTenantResolver() { + assertThrows(Exception.class, () -> + MultiTenantEventStore.builder() + .tenantSegmentFactory(t -> tenantSegment1) + .build() + ); + } +} diff --git a/multitenancy/src/test/java/org/axonframework/extension/multitenancy/messaging/commandhandling/MultiTenantCommandBusTest.java b/multitenancy/src/test/java/org/axonframework/extension/multitenancy/messaging/commandhandling/MultiTenantCommandBusTest.java new file mode 100644 index 0000000..74053e8 --- /dev/null +++ b/multitenancy/src/test/java/org/axonframework/extension/multitenancy/messaging/commandhandling/MultiTenantCommandBusTest.java @@ -0,0 +1,182 @@ +/* + * Copyright (c) 2010-2025. Axon Framework + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.axonframework.extension.multitenancy.messaging.commandhandling; + +import org.axonframework.extension.multitenancy.core.NoSuchTenantException; +import org.axonframework.extension.multitenancy.core.TargetTenantResolver; +import org.axonframework.extension.multitenancy.core.TenantDescriptor; +import org.axonframework.messaging.commandhandling.CommandBus; +import org.axonframework.messaging.commandhandling.CommandHandler; +import org.axonframework.messaging.commandhandling.CommandMessage; +import org.axonframework.messaging.commandhandling.CommandResultMessage; +import org.axonframework.messaging.commandhandling.GenericCommandMessage; +import org.axonframework.messaging.commandhandling.GenericCommandResultMessage; +import org.axonframework.messaging.core.Message; +import org.axonframework.messaging.core.MessageStream; +import org.axonframework.messaging.core.MessageType; +import org.axonframework.messaging.core.QualifiedName; +import org.junit.jupiter.api.*; + +import java.util.concurrent.CompletableFuture; +import java.util.concurrent.ExecutionException; + +import static org.junit.jupiter.api.Assertions.*; +import static org.mockito.ArgumentMatchers.*; +import static org.mockito.Mockito.*; + +/** + * Test class validating the {@link MultiTenantCommandBus}. + * + * @author Stefan Dragisic + */ +class MultiTenantCommandBusTest { + + private static final String PAYLOAD = "testCommand"; + private static final MessageType COMMAND_TYPE = new MessageType("TestCommand"); + private static final CommandMessage TEST_COMMAND = new GenericCommandMessage(COMMAND_TYPE, PAYLOAD); + private static final QualifiedName COMMAND_NAME = TEST_COMMAND.type().qualifiedName(); + + private static final TenantDescriptor TENANT_1 = TenantDescriptor.tenantWithId("tenant1"); + private static final TenantDescriptor TENANT_2 = TenantDescriptor.tenantWithId("tenant2"); + + private CommandBus tenantSegment1; + private CommandBus tenantSegment2; + + private MultiTenantCommandBus testSubject; + + @BeforeEach + void setUp() { + tenantSegment1 = mock(CommandBus.class); + tenantSegment2 = mock(CommandBus.class); + + // Stub subscribe to return the bus for fluent chaining + when(tenantSegment1.subscribe(any(QualifiedName.class), any(CommandHandler.class))).thenReturn(tenantSegment1); + when(tenantSegment2.subscribe(any(QualifiedName.class), any(CommandHandler.class))).thenReturn(tenantSegment2); + + TenantCommandSegmentFactory tenantSegmentFactory = tenant -> { + if (tenant.tenantId().equals("tenant1")) { + return tenantSegment1; + } else { + return tenantSegment2; + } + }; + + // Resolver always resolves to tenant2 + TargetTenantResolver targetTenantResolver = + (message, tenants) -> TENANT_2; + + testSubject = MultiTenantCommandBus.builder() + .tenantSegmentFactory(tenantSegmentFactory) + .targetTenantResolver(targetTenantResolver) + .build(); + } + + @Test + void dispatchRoutesToCorrectTenant() { + CommandResultMessage expectedResult = new GenericCommandResultMessage(COMMAND_TYPE, "result"); + when(tenantSegment2.dispatch(any(), any())) + .thenReturn(CompletableFuture.completedFuture(expectedResult)); + + testSubject.registerTenant(TENANT_1); + testSubject.registerTenant(TENANT_2); + + CompletableFuture result = testSubject.dispatch(TEST_COMMAND, null); + + verify(tenantSegment2).dispatch(eq(TEST_COMMAND), isNull()); + verify(tenantSegment1, never()).dispatch(any(), any()); + assertTrue(result.isDone()); + } + + @Test + void dispatchToUnknownTenantReturnsFailedFuture() { + // No tenants registered + CompletableFuture result = testSubject.dispatch(TEST_COMMAND, null); + + assertTrue(result.isCompletedExceptionally()); + ExecutionException exception = assertThrows(ExecutionException.class, result::get); + assertInstanceOf(NoSuchTenantException.class, exception.getCause()); + assertEquals("Tenant with identifier [tenant2] is unknown", exception.getCause().getMessage()); + } + + @Test + void subscribeRegistersHandlerOnExistingTenants() { + testSubject.registerTenant(TENANT_1); + testSubject.registerTenant(TENANT_2); + + CommandHandler handler = (msg, ctx) -> MessageStream.just(new GenericCommandResultMessage(COMMAND_TYPE, "ok")); + testSubject.subscribe(COMMAND_NAME, handler); + + verify(tenantSegment1).subscribe(eq(COMMAND_NAME), eq(handler)); + verify(tenantSegment2).subscribe(eq(COMMAND_NAME), eq(handler)); + } + + @Test + void registerAndStartTenantSubscribesExistingHandlers() { + // First subscribe a handler + CommandHandler handler = (msg, ctx) -> MessageStream.just(new GenericCommandResultMessage(COMMAND_TYPE, "ok")); + testSubject.subscribe(COMMAND_NAME, handler); + + // Then register and start a tenant + testSubject.registerAndStartTenant(TENANT_1); + + // Handler should be subscribed to the new tenant segment + verify(tenantSegment1).subscribe(eq(COMMAND_NAME), eq(handler)); + } + + @Test + void unregisterTenantRemovesTenantFromRouting() { + testSubject.registerTenant(TENANT_2); + + // Unregister the tenant + testSubject.registerTenant(TENANT_2).cancel(); + + // Should fail because tenant is no longer registered + CompletableFuture result = testSubject.dispatch(TEST_COMMAND, null); + + assertTrue(result.isCompletedExceptionally()); + ExecutionException exception = assertThrows(ExecutionException.class, result::get); + assertInstanceOf(NoSuchTenantException.class, exception.getCause()); + } + + @Test + void tenantSegmentsReturnsRegisteredTenants() { + testSubject.registerTenant(TENANT_1); + testSubject.registerTenant(TENANT_2); + + assertEquals(2, testSubject.tenantSegments().size()); + assertTrue(testSubject.tenantSegments().containsKey(TENANT_1)); + assertTrue(testSubject.tenantSegments().containsKey(TENANT_2)); + } + + @Test + void builderRequiresTenantSegmentFactory() { + assertThrows(Exception.class, () -> + MultiTenantCommandBus.builder() + .targetTenantResolver((m, t) -> TENANT_1) + .build() + ); + } + + @Test + void builderRequiresTargetTenantResolver() { + assertThrows(Exception.class, () -> + MultiTenantCommandBus.builder() + .tenantSegmentFactory(t -> tenantSegment1) + .build() + ); + } +} diff --git a/multitenancy/src/test/java/org/axonframework/extension/multitenancy/messaging/commandhandling/interception/InterceptingMultiTenantCommandBusTest.java b/multitenancy/src/test/java/org/axonframework/extension/multitenancy/messaging/commandhandling/interception/InterceptingMultiTenantCommandBusTest.java new file mode 100644 index 0000000..21314c3 --- /dev/null +++ b/multitenancy/src/test/java/org/axonframework/extension/multitenancy/messaging/commandhandling/interception/InterceptingMultiTenantCommandBusTest.java @@ -0,0 +1,318 @@ +/* + * Copyright (c) 2010-2025. Axon Framework + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.axonframework.extension.multitenancy.messaging.commandhandling.interception; + +import jakarta.annotation.Nonnull; +import jakarta.annotation.Nullable; +import org.axonframework.extension.multitenancy.core.TenantDescriptor; +import org.axonframework.extension.multitenancy.messaging.commandhandling.MultiTenantCommandBus; +import org.axonframework.messaging.commandhandling.CommandBus; +import org.axonframework.messaging.commandhandling.CommandMessage; +import org.axonframework.messaging.commandhandling.CommandResultMessage; +import org.axonframework.messaging.commandhandling.GenericCommandMessage; +import org.axonframework.messaging.commandhandling.GenericCommandResultMessage; +import org.axonframework.messaging.commandhandling.interception.InterceptingCommandBus; +import org.axonframework.messaging.core.Message; +import org.axonframework.messaging.core.MessageDispatchInterceptor; +import org.axonframework.messaging.core.MessageDispatchInterceptorChain; +import org.axonframework.messaging.core.MessageStream; +import org.axonframework.messaging.core.MessageType; +import org.axonframework.messaging.core.unitofwork.ProcessingContext; +import org.junit.jupiter.api.*; +import org.mockito.*; + +import java.util.List; +import java.util.Map; +import java.util.concurrent.CompletableFuture; +import java.util.concurrent.atomic.AtomicBoolean; + +import static org.junit.jupiter.api.Assertions.*; +import static org.mockito.ArgumentMatchers.*; +import static org.mockito.Mockito.*; + +/** + * Test class validating that {@link InterceptingCommandBus} correctly wraps + * {@link MultiTenantCommandBus}, ensuring interceptors are invoked before + * tenant routing occurs. + *

    + * This follows the same pattern as {@code InterceptingCommandBusTest} in the + * core framework, but validates the multi-tenant decorator chain: + * 

    + *     InterceptingCommandBus → MultiTenantCommandBus → TenantSegments
+ *
    + * + * @author Stefan Dragisic + * @since 5.0.0 + */ +class InterceptingMultiTenantCommandBusTest { + + private static final MessageType TEST_COMMAND_TYPE = new MessageType("TestCommand"); + private static final TenantDescriptor TENANT_1 = TenantDescriptor.tenantWithId("tenant1"); + private static final TenantDescriptor TENANT_2 = TenantDescriptor.tenantWithId("tenant2"); + + private CommandBus tenantSegment1; + private CommandBus tenantSegment2; + private MultiTenantCommandBus multiTenantCommandBus; + private InterceptingCommandBus testSubject; + + @BeforeEach + void setUp() { + tenantSegment1 = mock(CommandBus.class); + tenantSegment2 = mock(CommandBus.class); + + // Configure mock segments to return success + when(tenantSegment1.dispatch(any(), any())) + .thenReturn(CompletableFuture.completedFuture( + new GenericCommandResultMessage(TEST_COMMAND_TYPE, "success-tenant1"))); + when(tenantSegment2.dispatch(any(), any())) + .thenReturn(CompletableFuture.completedFuture( + new GenericCommandResultMessage(TEST_COMMAND_TYPE, "success-tenant2"))); + + // Create MultiTenantCommandBus that routes to tenant2 + multiTenantCommandBus = MultiTenantCommandBus.builder() + .tenantSegmentFactory(tenant -> { + if (TENANT_1.equals(tenant)) { + return tenantSegment1; + } + return tenantSegment2; + }) + .targetTenantResolver((message, tenants) -> TENANT_2) + .build(); + + // Register tenants + multiTenantCommandBus.registerTenant(TENANT_1); + multiTenantCommandBus.registerTenant(TENANT_2); + } + + @Nested + @DisplayName("Dispatch interceptor tests") + class DispatchInterceptorTests { + + @Test + void dispatchInterceptorsAreInvokedBeforeTenantRouting() { + AtomicBoolean interceptorInvoked = new AtomicBoolean(false); + + MessageDispatchInterceptor trackingInterceptor = (message, context, chain) -> { + interceptorInvoked.set(true); + return chain.proceed(message, context); + }; + + testSubject = new InterceptingCommandBus( + multiTenantCommandBus, + List.of(), + List.of(trackingInterceptor) + ); + + CommandMessage command = new GenericCommandMessage(TEST_COMMAND_TYPE, "test-payload"); + testSubject.dispatch(command, null); + + assertTrue(interceptorInvoked.get(), "Dispatch interceptor should be invoked"); + verify(tenantSegment2).dispatch(any(), any()); + } + + @Test + void dispatchInterceptorsCanModifyCommandBeforeRouting() { + MessageDispatchInterceptor addMetadataInterceptor = (message, context, chain) -> { + Message modified = message.andMetadata(Map.of("intercepted", "true")); + return chain.proceed(modified, context); + }; + + testSubject = new InterceptingCommandBus( + multiTenantCommandBus, + List.of(), + List.of(addMetadataInterceptor) + ); + + CommandMessage command = new GenericCommandMessage(TEST_COMMAND_TYPE, "test-payload"); + testSubject.dispatch(command, null); + + // Verify the tenant segment received the modified command + ArgumentCaptor commandCaptor = ArgumentCaptor.forClass(CommandMessage.class); + verify(tenantSegment2).dispatch(commandCaptor.capture(), any()); + + CommandMessage dispatchedCommand = commandCaptor.getValue(); + assertTrue(dispatchedCommand.metadata().containsKey("intercepted"), + "Command should contain interceptor-added metadata"); + assertEquals("true", dispatchedCommand.metadata().get("intercepted")); + } + + @Test + void multipleDispatchInterceptorsAreInvokedInOrder() { + MessageDispatchInterceptor firstInterceptor = (message, context, chain) -> { + Message modified = message.andMetadata(Map.of("first", "1")); + return chain.proceed(modified, context); + }; + + MessageDispatchInterceptor secondInterceptor = (message, context, chain) -> { + Message modified = message.andMetadata(Map.of("second", "2")); + return chain.proceed(modified, context); + }; + + testSubject = new InterceptingCommandBus( + multiTenantCommandBus, + List.of(), + List.of(firstInterceptor, secondInterceptor) + ); + + CommandMessage command = new GenericCommandMessage(TEST_COMMAND_TYPE, "test-payload"); + testSubject.dispatch(command, null); + + ArgumentCaptor commandCaptor = ArgumentCaptor.forClass(CommandMessage.class); + verify(tenantSegment2).dispatch(commandCaptor.capture(), any()); + + CommandMessage dispatchedCommand = commandCaptor.getValue(); + assertTrue(dispatchedCommand.metadata().containsKey("first"), + "First interceptor metadata should be present"); + assertTrue(dispatchedCommand.metadata().containsKey("second"), + "Second interceptor metadata should be present"); + } + + @Test + void interceptorCanShortCircuitDispatch() { + MessageDispatchInterceptor shortCircuitInterceptor = (message, context, chain) -> + MessageStream.failed(new RuntimeException("Short-circuited")); + + testSubject = new InterceptingCommandBus( + multiTenantCommandBus, + List.of(), + List.of(shortCircuitInterceptor) + ); + + CommandMessage command = new GenericCommandMessage(TEST_COMMAND_TYPE, "test-payload"); + CompletableFuture result = testSubject.dispatch(command, null); + + assertTrue(result.isCompletedExceptionally(), + "Result should be completed exceptionally when interceptor short-circuits"); + verify(tenantSegment1, never()).dispatch(any(), any()); + verify(tenantSegment2, never()).dispatch(any(), any()); + } + } + + @Nested + @DisplayName("Tenant routing tests") + class TenantRoutingTests { + + @Test + void commandIsRoutedToCorrectTenantAfterInterception() { + MessageDispatchInterceptor loggingInterceptor = (message, context, chain) -> + chain.proceed(message, context); + + testSubject = new InterceptingCommandBus( + multiTenantCommandBus, + List.of(), + List.of(loggingInterceptor) + ); + + CommandMessage command = new GenericCommandMessage(TEST_COMMAND_TYPE, "test-payload"); + testSubject.dispatch(command, null); + + // Tenant resolver is configured to route to TENANT_2 + verify(tenantSegment2).dispatch(any(), any()); + verify(tenantSegment1, never()).dispatch(any(), any()); + } + + @Test + void interceptedCommandReachesCorrectTenantSegment() { + MessageDispatchInterceptor addTenantContextInterceptor = (message, context, chain) -> { + Message modified = message.andMetadata(Map.of("tenant-context", "enriched")); + return chain.proceed(modified, context); + }; + + testSubject = new InterceptingCommandBus( + multiTenantCommandBus, + List.of(), + List.of(addTenantContextInterceptor) + ); + + CommandMessage command = new GenericCommandMessage(TEST_COMMAND_TYPE, "test-payload"); + CompletableFuture result = testSubject.dispatch(command, null); + + assertTrue(result.isDone()); + assertFalse(result.isCompletedExceptionally()); + + ArgumentCaptor commandCaptor = ArgumentCaptor.forClass(CommandMessage.class); + verify(tenantSegment2).dispatch(commandCaptor.capture(), any()); + + CommandMessage receivedCommand = commandCaptor.getValue(); + assertEquals("enriched", receivedCommand.metadata().get("tenant-context"), + "Tenant segment should receive enriched command"); + } + } + + @Nested + @DisplayName("Result handling tests") + class ResultHandlingTests { + + @Test + void resultFromTenantSegmentIsReturnedThroughInterceptorChain() { + AtomicBoolean resultIntercepted = new AtomicBoolean(false); + + MessageDispatchInterceptor resultTrackingInterceptor = + new MessageDispatchInterceptor<>() { + @Nonnull + @Override + public MessageStream interceptOnDispatch(@Nonnull Message message, + @Nullable ProcessingContext context, + @Nonnull MessageDispatchInterceptorChain chain) { + return chain.proceed(message, context) + .onNext(m -> resultIntercepted.set(true)); + } + }; + + testSubject = new InterceptingCommandBus( + multiTenantCommandBus, + List.of(), + List.of(resultTrackingInterceptor) + ); + + CommandMessage command = new GenericCommandMessage(TEST_COMMAND_TYPE, "test-payload"); + CompletableFuture result = testSubject.dispatch(command, null); + + assertTrue(result.isDone()); + assertTrue(resultIntercepted.get(), "Result should pass back through interceptor chain"); + } + + @Test + void interceptorCanModifyResult() { + MessageDispatchInterceptor resultModifyingInterceptor = + new MessageDispatchInterceptor<>() { + @Nonnull + @Override + public MessageStream interceptOnDispatch(@Nonnull Message message, + @Nullable ProcessingContext context, + @Nonnull MessageDispatchInterceptorChain chain) { + return chain.proceed(message, context) + .mapMessage(m -> m.andMetadata(Map.of("result-enriched", "yes"))); + } + }; + + testSubject = new InterceptingCommandBus( + multiTenantCommandBus, + List.of(), + List.of(resultModifyingInterceptor) + ); + + CommandMessage command = new GenericCommandMessage(TEST_COMMAND_TYPE, "test-payload"); + CompletableFuture result = testSubject.dispatch(command, null); + + assertTrue(result.isDone()); + CommandResultMessage resultMessage = result.join(); + assertEquals("yes", resultMessage.metadata().get("result-enriched"), + "Result should contain interceptor-added metadata"); + } + } +} diff --git a/multitenancy/src/test/java/org/axonframework/extension/multitenancy/messaging/eventhandling/processing/InMemoryTenantTokenStoreFactoryTest.java b/multitenancy/src/test/java/org/axonframework/extension/multitenancy/messaging/eventhandling/processing/InMemoryTenantTokenStoreFactoryTest.java new file mode 100644 index 0000000..a4129b4 --- /dev/null +++ b/multitenancy/src/test/java/org/axonframework/extension/multitenancy/messaging/eventhandling/processing/InMemoryTenantTokenStoreFactoryTest.java @@ -0,0 +1,78 @@ +/* + * Copyright (c) 2010-2025. Axon Framework + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.axonframework.extension.multitenancy.messaging.eventhandling.processing; + +import org.axonframework.extension.multitenancy.core.TenantDescriptor; +import org.axonframework.messaging.eventhandling.processing.streaming.token.store.TokenStore; +import org.junit.jupiter.api.*; + +import static org.junit.jupiter.api.Assertions.*; + +/** + * Test class validating the {@link InMemoryTenantTokenStoreFactory}. + * + * @author Stefan Dragisic + */ +class InMemoryTenantTokenStoreFactoryTest { + + private static final TenantDescriptor TENANT_1 = TenantDescriptor.tenantWithId("tenant1"); + private static final TenantDescriptor TENANT_2 = TenantDescriptor.tenantWithId("tenant2"); + + private InMemoryTenantTokenStoreFactory testSubject; + + @BeforeEach + void setUp() { + testSubject = new InMemoryTenantTokenStoreFactory(); + } + + @Test + void applyReturnsTokenStoreForTenant() { + TokenStore tokenStore = testSubject.apply(TENANT_1); + + assertNotNull(tokenStore); + } + + @Test + void applyReturnsSameTokenStoreForSameTenant() { + TokenStore first = testSubject.apply(TENANT_1); + TokenStore second = testSubject.apply(TENANT_1); + + assertSame(first, second); + } + + @Test + void applyReturnsDifferentTokenStoresForDifferentTenants() { + TokenStore tokenStore1 = testSubject.apply(TENANT_1); + TokenStore tokenStore2 = testSubject.apply(TENANT_2); + + assertNotSame(tokenStore1, tokenStore2); + } + + @Test + void tokenStoreCountReflectsNumberOfCreatedStores() { + assertEquals(0, testSubject.tokenStoreCount()); + + testSubject.apply(TENANT_1); + assertEquals(1, testSubject.tokenStoreCount()); + + testSubject.apply(TENANT_2); + assertEquals(2, testSubject.tokenStoreCount()); + + // Applying same tenant again should not increase count + testSubject.apply(TENANT_1); + assertEquals(2, testSubject.tokenStoreCount()); + } +} diff --git a/multitenancy/src/test/java/org/axonframework/extension/multitenancy/messaging/eventhandling/processing/JdbcTenantTokenStoreFactoryTest.java b/multitenancy/src/test/java/org/axonframework/extension/multitenancy/messaging/eventhandling/processing/JdbcTenantTokenStoreFactoryTest.java new file mode 100644 index 0000000..ce2373f --- /dev/null +++ b/multitenancy/src/test/java/org/axonframework/extension/multitenancy/messaging/eventhandling/processing/JdbcTenantTokenStoreFactoryTest.java @@ -0,0 +1,143 @@ +/* + * Copyright (c) 2010-2025. Axon Framework + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.axonframework.extension.multitenancy.messaging.eventhandling.processing; + +import org.axonframework.common.jdbc.ConnectionProvider; +import org.axonframework.conversion.Converter; +import org.axonframework.extension.multitenancy.core.TenantDescriptor; +import org.axonframework.messaging.eventhandling.processing.streaming.token.store.TokenStore; +import org.axonframework.messaging.eventhandling.processing.streaming.token.store.jdbc.JdbcTokenStore; +import org.axonframework.messaging.eventhandling.processing.streaming.token.store.jdbc.JdbcTokenStoreConfiguration; +import org.junit.jupiter.api.*; + +import static org.junit.jupiter.api.Assertions.*; +import static org.mockito.Mockito.*; + +/** + * Test class validating the {@link JdbcTenantTokenStoreFactory}. + * + * @author Stefan Dragisic + */ +class JdbcTenantTokenStoreFactoryTest { + + private static final TenantDescriptor TENANT_1 = TenantDescriptor.tenantWithId("tenant1"); + private static final TenantDescriptor TENANT_2 = TenantDescriptor.tenantWithId("tenant2"); + + private TenantConnectionProviderFactory connectionProviderFactory; + private Converter converter; + private JdbcTenantTokenStoreFactory testSubject; + + @BeforeEach + void setUp() { + connectionProviderFactory = mock(TenantConnectionProviderFactory.class); + converter = mock(Converter.class); + + // Setup mock to return a ConnectionProvider for any tenant + when(connectionProviderFactory.apply(any(TenantDescriptor.class))) + .thenReturn(mock(ConnectionProvider.class)); + + testSubject = new JdbcTenantTokenStoreFactory(connectionProviderFactory, converter); + } + + @Test + void applyReturnsJdbcTokenStore() { + TokenStore tokenStore = testSubject.apply(TENANT_1); + + assertNotNull(tokenStore); + assertInstanceOf(JdbcTokenStore.class, tokenStore); + } + + @Test + void applyReturnsSameTokenStoreForSameTenant() { + TokenStore first = testSubject.apply(TENANT_1); + TokenStore second = testSubject.apply(TENANT_1); + + assertSame(first, second); + } + + @Test + void applyReturnsDifferentTokenStoresForDifferentTenants() { + TokenStore tokenStore1 = testSubject.apply(TENANT_1); + TokenStore tokenStore2 = testSubject.apply(TENANT_2); + + assertNotSame(tokenStore1, tokenStore2); + } + + @Test + void tokenStoreCountReflectsNumberOfCreatedStores() { + assertEquals(0, testSubject.tokenStoreCount()); + + testSubject.apply(TENANT_1); + assertEquals(1, testSubject.tokenStoreCount()); + + testSubject.apply(TENANT_2); + assertEquals(2, testSubject.tokenStoreCount()); + + // Applying same tenant again should not increase count + testSubject.apply(TENANT_1); + assertEquals(2, testSubject.tokenStoreCount()); + } + + @Test + void constructorWithCustomConfiguration() { + JdbcTokenStoreConfiguration customConfig = JdbcTokenStoreConfiguration.DEFAULT + .nodeId("custom-node"); + + JdbcTenantTokenStoreFactory factory = new JdbcTenantTokenStoreFactory( + connectionProviderFactory, converter, customConfig + ); + + TokenStore tokenStore = factory.apply(TENANT_1); + assertNotNull(tokenStore); + } + + @Test + void constructorRejectsNullConnectionProviderFactory() { + assertThrows(NullPointerException.class, () -> + new JdbcTenantTokenStoreFactory(null, converter) + ); + } + + @Test + void constructorRejectsNullConverter() { + assertThrows(NullPointerException.class, () -> + new JdbcTenantTokenStoreFactory(connectionProviderFactory, null) + ); + } + + @Test + void constructorRejectsNullConfiguration() { + assertThrows(NullPointerException.class, () -> + new JdbcTenantTokenStoreFactory(connectionProviderFactory, converter, null) + ); + } + + @Test + void applyUsesConnectionProviderFactory() { + testSubject.apply(TENANT_1); + + verify(connectionProviderFactory).apply(TENANT_1); + } + + @Test + void applyDoesNotCallConnectionProviderFactoryForCachedTenant() { + testSubject.apply(TENANT_1); + testSubject.apply(TENANT_1); + + // Should only be called once due to caching + verify(connectionProviderFactory, times(1)).apply(TENANT_1); + } +} diff --git a/multitenancy/src/test/java/org/axonframework/extension/multitenancy/messaging/eventhandling/processing/JpaTenantTokenStoreFactoryTest.java b/multitenancy/src/test/java/org/axonframework/extension/multitenancy/messaging/eventhandling/processing/JpaTenantTokenStoreFactoryTest.java new file mode 100644 index 0000000..8ca54a2 --- /dev/null +++ b/multitenancy/src/test/java/org/axonframework/extension/multitenancy/messaging/eventhandling/processing/JpaTenantTokenStoreFactoryTest.java @@ -0,0 +1,144 @@ +/* + * Copyright (c) 2010-2025. Axon Framework + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.axonframework.extension.multitenancy.messaging.eventhandling.processing; + +import jakarta.persistence.EntityManager; +import jakarta.persistence.EntityManagerFactory; +import org.axonframework.conversion.Converter; +import org.axonframework.extension.multitenancy.core.TenantDescriptor; +import org.axonframework.messaging.eventhandling.processing.streaming.token.store.TokenStore; +import org.axonframework.messaging.eventhandling.processing.streaming.token.store.jpa.JpaTokenStore; +import org.axonframework.messaging.eventhandling.processing.streaming.token.store.jpa.JpaTokenStoreConfiguration; +import org.junit.jupiter.api.BeforeEach; +import org.junit.jupiter.api.Test; + +import java.util.function.Function; + +import static org.junit.jupiter.api.Assertions.*; +import static org.mockito.Mockito.*; + +/** + * Test class validating the {@link JpaTenantTokenStoreFactory}. + * + * @author Stefan Dragisic + * @author Theo Emanuelsson + */ +class JpaTenantTokenStoreFactoryTest { + + private static final TenantDescriptor TENANT_1 = TenantDescriptor.tenantWithId("tenant1"); + private static final TenantDescriptor TENANT_2 = TenantDescriptor.tenantWithId("tenant2"); + + private Function emfProvider; + private Converter converter; + private JpaTenantTokenStoreFactory testSubject; + + @BeforeEach + @SuppressWarnings("unchecked") + void setUp() { + emfProvider = mock(Function.class); + converter = mock(Converter.class); + + // Setup mock to return an EntityManagerFactory for any tenant + EntityManagerFactory mockEmf = mock(EntityManagerFactory.class); + when(mockEmf.createEntityManager()).thenReturn(mock(EntityManager.class)); + when(emfProvider.apply(any(TenantDescriptor.class))).thenReturn(mockEmf); + + testSubject = new JpaTenantTokenStoreFactory(emfProvider, converter); + } + + @Test + void applyReturnsJpaTokenStore() { + TokenStore tokenStore = testSubject.apply(TENANT_1); + + assertNotNull(tokenStore); + assertInstanceOf(JpaTokenStore.class, tokenStore); + } + + @Test + void applyReturnsSameTokenStoreForSameTenant() { + TokenStore first = testSubject.apply(TENANT_1); + TokenStore second = testSubject.apply(TENANT_1); + + assertSame(first, second); + } + + @Test + void applyReturnsDifferentTokenStoresForDifferentTenants() { + TokenStore tokenStore1 = testSubject.apply(TENANT_1); + TokenStore tokenStore2 = testSubject.apply(TENANT_2); + + assertNotSame(tokenStore1, tokenStore2); + } + + @Test + void tokenStoreCountReflectsNumberOfCreatedStores() { + assertEquals(0, testSubject.tokenStoreCount()); + + testSubject.apply(TENANT_1); + assertEquals(1, testSubject.tokenStoreCount()); + + testSubject.apply(TENANT_2); + assertEquals(2, testSubject.tokenStoreCount()); + + // Applying same tenant again should not increase count + testSubject.apply(TENANT_1); + assertEquals(2, testSubject.tokenStoreCount()); + } + + @Test + void constructorWithCustomConfiguration() { + JpaTokenStoreConfiguration customConfig = JpaTokenStoreConfiguration.DEFAULT + .nodeId("custom-node"); + + JpaTenantTokenStoreFactory factory = new JpaTenantTokenStoreFactory( + emfProvider, converter, customConfig + ); + + TokenStore tokenStore = factory.apply(TENANT_1); + assertNotNull(tokenStore); + } + + @Test + void constructorRejectsNullEmfProvider() { + assertThrows(NullPointerException.class, () -> + new JpaTenantTokenStoreFactory(null, converter) + ); + } + + @Test + void constructorRejectsNullConverter() { + assertThrows(NullPointerException.class, () -> + new JpaTenantTokenStoreFactory(emfProvider, null) + ); + } + + @Test + void constructorRejectsNullConfiguration() { + assertThrows(NullPointerException.class, () -> + new JpaTenantTokenStoreFactory(emfProvider, converter, null) + ); + } + + @Test + void emfProviderIsCalledForEachNewTenant() { + testSubject.apply(TENANT_1); + testSubject.apply(TENANT_2); + testSubject.apply(TENANT_1); // Should not call provider again + + verify(emfProvider, times(1)).apply(TENANT_1); + verify(emfProvider, times(1)).apply(TENANT_2); + } +} diff --git a/multitenancy/src/test/java/org/axonframework/extension/multitenancy/messaging/eventhandling/processing/MultiTenantEventProcessorTest.java b/multitenancy/src/test/java/org/axonframework/extension/multitenancy/messaging/eventhandling/processing/MultiTenantEventProcessorTest.java new file mode 100644 index 0000000..bc140d5 --- /dev/null +++ b/multitenancy/src/test/java/org/axonframework/extension/multitenancy/messaging/eventhandling/processing/MultiTenantEventProcessorTest.java @@ -0,0 +1,203 @@ +/* + * Copyright (c) 2010-2025. Axon Framework + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.axonframework.extension.multitenancy.messaging.eventhandling.processing; + +import org.axonframework.extension.multitenancy.core.TenantDescriptor; +import org.axonframework.messaging.eventhandling.processing.EventProcessor; +import org.junit.jupiter.api.*; + +import java.util.concurrent.CompletableFuture; + +import static org.junit.jupiter.api.Assertions.*; +import static org.mockito.Mockito.*; + +/** + * Test class validating the {@link MultiTenantEventProcessor}. + * + * @author Stefan Dragisic + */ +class MultiTenantEventProcessorTest { + + private static final TenantDescriptor TENANT_1 = TenantDescriptor.tenantWithId("tenant1"); + private static final TenantDescriptor TENANT_2 = TenantDescriptor.tenantWithId("tenant2"); + + private EventProcessor tenantSegment1; + private EventProcessor tenantSegment2; + + private MultiTenantEventProcessor testSubject; + + @BeforeEach + void setUp() { + tenantSegment1 = mock(EventProcessor.class); + tenantSegment2 = mock(EventProcessor.class); + + when(tenantSegment1.start()).thenReturn(CompletableFuture.completedFuture(null)); + when(tenantSegment2.start()).thenReturn(CompletableFuture.completedFuture(null)); + when(tenantSegment1.shutdown()).thenReturn(CompletableFuture.completedFuture(null)); + when(tenantSegment2.shutdown()).thenReturn(CompletableFuture.completedFuture(null)); + + TenantEventProcessorSegmentFactory tenantSegmentFactory = tenant -> { + if (tenant.tenantId().equals("tenant1")) { + return tenantSegment1; + } else { + return tenantSegment2; + } + }; + + testSubject = MultiTenantEventProcessor.builder() + .name("testProcessor") + .tenantSegmentFactory(tenantSegmentFactory) + .build(); + } + + @Test + void nameReturnsProcessorName() { + assertEquals("testProcessor", testSubject.name()); + } + + @Test + void registerTenantAddsTenantSegment() { + testSubject.registerTenant(TENANT_1); + + assertEquals(1, testSubject.tenantSegments().size()); + assertTrue(testSubject.tenantSegments().containsKey(TENANT_1)); + assertTrue(testSubject.tenantEventProcessors().contains(tenantSegment1)); + } + + @Test + void registerTenantAfterStartThrowsException() { + testSubject.registerTenant(TENANT_1); + testSubject.start(); + + assertThrows(IllegalStateException.class, () -> testSubject.registerTenant(TENANT_2)); + } + + @Test + void registerAndStartTenantStartsSegment() { + testSubject.registerAndStartTenant(TENANT_1); + + verify(tenantSegment1).start(); + assertTrue(testSubject.tenantEventProcessors().contains(tenantSegment1)); + } + + @Test + void startStartsAllTenantSegments() { + testSubject.registerTenant(TENANT_1); + testSubject.registerTenant(TENANT_2); + + CompletableFuture result = testSubject.start(); + + assertTrue(result.isDone()); + verify(tenantSegment1).start(); + verify(tenantSegment2).start(); + assertTrue(testSubject.isRunning()); + } + + @Test + void shutdownShutdownsAllTenantSegments() { + testSubject.registerTenant(TENANT_1); + testSubject.registerTenant(TENANT_2); + testSubject.start(); + + CompletableFuture result = testSubject.shutdown(); + + assertTrue(result.isDone()); + verify(tenantSegment1).shutdown(); + verify(tenantSegment2).shutdown(); + assertFalse(testSubject.isRunning()); + } + + @Test + void isRunningForTenantDelegatesToTenantSegment() { + when(tenantSegment1.isRunning()).thenReturn(true); + testSubject.registerTenant(TENANT_1); + + assertTrue(testSubject.isRunning(TENANT_1)); + verify(tenantSegment1).isRunning(); + } + + @Test + void isErrorForTenantDelegatesToTenantSegment() { + when(tenantSegment1.isError()).thenReturn(true); + testSubject.registerTenant(TENANT_1); + + assertTrue(testSubject.isError(TENANT_1)); + verify(tenantSegment1).isError(); + } + + @Test + void isErrorReturnsFalseForMultiTenantProcessor() { + // The multi-tenant processor itself never reports error + // Individual tenant segments should be checked via isError(TenantDescriptor) + assertFalse(testSubject.isError()); + } + + @Test + void stopAndRemoveTenantShutdownsAndRemovesSegment() { + testSubject.registerAndStartTenant(TENANT_1); + + boolean removed = testSubject.stopAndRemoveTenant(TENANT_1); + + assertTrue(removed); + verify(tenantSegment1).shutdown(); + assertFalse(testSubject.tenantSegments().containsKey(TENANT_1)); + assertTrue(testSubject.tenantEventProcessors().isEmpty()); + } + + @Test + void stopAndRemoveTenantReturnsFalseForUnknownTenant() { + boolean removed = testSubject.stopAndRemoveTenant(TENANT_1); + + assertFalse(removed); + } + + @Test + void unregisterTenantViaCancelStopsAndRemoves() { + testSubject.registerAndStartTenant(TENANT_1); + + testSubject.registerAndStartTenant(TENANT_1).cancel(); + + // Since registerAndStartTenant returns a registration that calls stopAndRemoveTenant + verify(tenantSegment1).shutdown(); + } + + @Test + void tenantEventProcessorsReturnsUnmodifiableList() { + testSubject.registerTenant(TENANT_1); + + assertThrows(UnsupportedOperationException.class, + () -> testSubject.tenantEventProcessors().add(tenantSegment2)); + } + + @Test + void builderRequiresName() { + assertThrows(Exception.class, () -> + MultiTenantEventProcessor.builder() + .tenantSegmentFactory(t -> tenantSegment1) + .build() + ); + } + + @Test + void builderRequiresTenantSegmentFactory() { + assertThrows(Exception.class, () -> + MultiTenantEventProcessor.builder() + .name("testProcessor") + .build() + ); + } +} diff --git a/multitenancy/src/test/java/org/axonframework/extension/multitenancy/messaging/eventhandling/processing/MultiTenantPooledStreamingEventProcessorConfigurationTest.java b/multitenancy/src/test/java/org/axonframework/extension/multitenancy/messaging/eventhandling/processing/MultiTenantPooledStreamingEventProcessorConfigurationTest.java new file mode 100644 index 0000000..232523f --- /dev/null +++ b/multitenancy/src/test/java/org/axonframework/extension/multitenancy/messaging/eventhandling/processing/MultiTenantPooledStreamingEventProcessorConfigurationTest.java @@ -0,0 +1,80 @@ +/* + * Copyright (c) 2010-2025. Axon Framework + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.axonframework.extension.multitenancy.messaging.eventhandling.processing; + +import org.junit.jupiter.api.*; + +import static org.junit.jupiter.api.Assertions.*; +import static org.mockito.Mockito.*; + +/** + * Test class validating the {@link MultiTenantPooledStreamingEventProcessorConfiguration}. + * + * @author Theo Emanuelsson + */ +class MultiTenantPooledStreamingEventProcessorConfigurationTest { + + @Test + void tenantTokenStoreFactoryIsNullByDefault() { + var config = new MultiTenantPooledStreamingEventProcessorConfiguration(); + + assertNull(config.tenantTokenStoreFactory()); + } + + @Test + void tenantTokenStoreFactoryCanBeSet() { + TenantTokenStoreFactory factory = mock(TenantTokenStoreFactory.class); + var config = new MultiTenantPooledStreamingEventProcessorConfiguration(); + + config.tenantTokenStoreFactory(factory); + + assertEquals(factory, config.tenantTokenStoreFactory()); + } + + @Test + void tenantTokenStoreFactoryRejectsNull() { + var config = new MultiTenantPooledStreamingEventProcessorConfiguration(); + + assertThrows(NullPointerException.class, () -> config.tenantTokenStoreFactory(null)); + } + + @Test + void fluentMethodsReturnCorrectType() { + TenantTokenStoreFactory factory = mock(TenantTokenStoreFactory.class); + var config = new MultiTenantPooledStreamingEventProcessorConfiguration(); + + // Verify fluent methods return the correct subtype for chaining + var result = config + .batchSize(100) + .tenantTokenStoreFactory(factory) + .initialSegmentCount(8); + + assertInstanceOf(MultiTenantPooledStreamingEventProcessorConfiguration.class, result); + assertEquals(factory, result.tenantTokenStoreFactory()); + assertEquals(100, result.batchSize()); + assertEquals(8, result.initialSegmentCount()); + } + + @Test + void tenantTokenStoreFactoryReturnsThisForChaining() { + TenantTokenStoreFactory factory = mock(TenantTokenStoreFactory.class); + var config = new MultiTenantPooledStreamingEventProcessorConfiguration(); + + var result = config.tenantTokenStoreFactory(factory); + + assertSame(config, result); + } +} diff --git a/multitenancy/src/test/java/org/axonframework/extension/multitenancy/messaging/eventhandling/processing/MultiTenantPooledStreamingEventProcessorModuleTest.java b/multitenancy/src/test/java/org/axonframework/extension/multitenancy/messaging/eventhandling/processing/MultiTenantPooledStreamingEventProcessorModuleTest.java new file mode 100644 index 0000000..cefb4cc --- /dev/null +++ b/multitenancy/src/test/java/org/axonframework/extension/multitenancy/messaging/eventhandling/processing/MultiTenantPooledStreamingEventProcessorModuleTest.java @@ -0,0 +1,194 @@ +/* + * Copyright (c) 2010-2025. Axon Framework + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.axonframework.extension.multitenancy.messaging.eventhandling.processing; + +import org.axonframework.common.configuration.Configuration; +import org.axonframework.extension.multitenancy.core.TenantDescriptor; +import org.axonframework.extension.multitenancy.core.TenantProvider; +import org.axonframework.extension.multitenancy.eventsourcing.eventstore.MultiTenantEventStore; +import org.axonframework.eventsourcing.eventstore.EventStore; +import org.axonframework.messaging.eventhandling.EventHandlingComponent; +import org.axonframework.messaging.eventhandling.configuration.EventProcessorModule; +import org.junit.jupiter.api.*; + +import java.util.List; +import java.util.Map; +import java.util.function.Supplier; + +import static org.junit.jupiter.api.Assertions.*; +import static org.mockito.ArgumentMatchers.*; +import static org.mockito.Mockito.*; + +/** + * Test class validating the {@link MultiTenantPooledStreamingEventProcessorModule}. + * + * @author Stefan Dragisic + */ +class MultiTenantPooledStreamingEventProcessorModuleTest { + + private static final String PROCESSOR_NAME = "testProcessor"; + private static final TenantDescriptor TENANT_1 = TenantDescriptor.tenantWithId("tenant1"); + private static final TenantDescriptor TENANT_2 = TenantDescriptor.tenantWithId("tenant2"); + + @Test + void createReturnsModuleInEventHandlingPhase() { + var result = MultiTenantPooledStreamingEventProcessorModule.create(PROCESSOR_NAME); + + assertNotNull(result); + assertInstanceOf( + EventProcessorModule.EventHandlingPhase.class, + result + ); + } + + @Test + void constructorRejectsNullProcessorName() { + assertThrows(IllegalArgumentException.class, () -> + new MultiTenantPooledStreamingEventProcessorModule(null) + ); + } + + @Test + void fluentApiAllowsFullConfiguration() { + var module = MultiTenantPooledStreamingEventProcessorModule.create(PROCESSOR_NAME) + .eventHandlingComponents(c -> c.autodetected(cfg -> mock(EventHandlingComponent.class))) + .customized((cfg, config) -> config.batchSize(100)); + + assertNotNull(module); + } + + @Test + void notCustomizedReturnsModule() { + var module = MultiTenantPooledStreamingEventProcessorModule.create(PROCESSOR_NAME) + .eventHandlingComponents(c -> c.autodetected(cfg -> mock(EventHandlingComponent.class))) + .notCustomized(); + + assertNotNull(module); + assertInstanceOf(MultiTenantPooledStreamingEventProcessorModule.class, module); + } + + @Test + void customizedAllowsProcessorConfigurationModification() { + var module = MultiTenantPooledStreamingEventProcessorModule.create(PROCESSOR_NAME) + .eventHandlingComponents(c -> c.autodetected(cfg -> mock(EventHandlingComponent.class))) + .customized((cfg, config) -> { + assertNotNull(config); + assertInstanceOf(MultiTenantPooledStreamingEventProcessorConfiguration.class, config); + return config.batchSize(50); + }); + + assertNotNull(module); + } + + @Test + void moduleImplementsEventProcessorModule() { + var module = MultiTenantPooledStreamingEventProcessorModule.create(PROCESSOR_NAME) + .eventHandlingComponents(c -> c.autodetected(cfg -> mock(EventHandlingComponent.class))) + .notCustomized(); + + assertInstanceOf(EventProcessorModule.class, module); + } + + @Test + @SuppressWarnings("unchecked") + void buildMultiTenantEventProcessorUsesConfiguredComponents() { + // Setup mocks + Configuration configuration = mock(Configuration.class); + MultiTenantEventStore multiTenantEventStore = mock(MultiTenantEventStore.class); + TenantProvider tenantProvider = mock(TenantProvider.class); + EventStore tenantEventStore = mock(EventStore.class); + + // Configure mock behavior + when(configuration.getComponent(eq(MultiTenantEventStore.class))) + .thenReturn(multiTenantEventStore); + when(configuration.getComponent(eq(TenantTokenStoreFactory.class), any(Supplier.class))) + .thenAnswer(invocation -> invocation.getArgument(1, Supplier.class).get()); + when(configuration.getComponent(eq(TenantProvider.class))) + .thenReturn(tenantProvider); + when(multiTenantEventStore.tenantSegments()) + .thenReturn(Map.of(TENANT_1, tenantEventStore)); + when(tenantProvider.getTenants()) + .thenReturn(List.of(TENANT_1)); + + // The module would create the processor when integrated into the full configuration system + // This test validates the module can be created without errors + var module = MultiTenantPooledStreamingEventProcessorModule.create(PROCESSOR_NAME) + .eventHandlingComponents(c -> c.autodetected(cfg -> mock(EventHandlingComponent.class))) + .notCustomized(); + + assertNotNull(module); + } + + @Test + void moduleSupportsMultipleEventHandlingComponents() { + EventHandlingComponent component1 = mock(EventHandlingComponent.class); + EventHandlingComponent component2 = mock(EventHandlingComponent.class); + + var module = MultiTenantPooledStreamingEventProcessorModule.create(PROCESSOR_NAME) + .eventHandlingComponents(c -> c + .autodetected(cfg -> component1) + .autodetected(cfg -> component2)) + .notCustomized(); + + assertNotNull(module); + } + + @Test + void customizedWithNoOpReturnsModule() { + var module = MultiTenantPooledStreamingEventProcessorModule.create(PROCESSOR_NAME) + .eventHandlingComponents(c -> c.autodetected(cfg -> mock(EventHandlingComponent.class))) + .customized((cfg, config) -> config); // No-op customization + + assertNotNull(module); + } + + @Test + void customizedRejectsNullFunction() { + var phase = MultiTenantPooledStreamingEventProcessorModule.create(PROCESSOR_NAME) + .eventHandlingComponents(c -> c.autodetected(cfg -> mock(EventHandlingComponent.class))); + + assertThrows(NullPointerException.class, () -> phase.customized(null)); + } + + @Test + void customizedAllowsTenantTokenStoreFactoryConfiguration() { + TenantTokenStoreFactory customFactory = mock(TenantTokenStoreFactory.class); + + var module = MultiTenantPooledStreamingEventProcessorModule.create(PROCESSOR_NAME) + .eventHandlingComponents(c -> c.autodetected(cfg -> mock(EventHandlingComponent.class))) + .customized((cfg, config) -> config + .tenantTokenStoreFactory(customFactory) + .batchSize(100)); + + assertNotNull(module); + } + + @Test + void customizedConfigurationSupportsFluentMethodChaining() { + TenantTokenStoreFactory customFactory = mock(TenantTokenStoreFactory.class); + + // Verify all fluent methods can be chained in any order + var module = MultiTenantPooledStreamingEventProcessorModule.create(PROCESSOR_NAME) + .eventHandlingComponents(c -> c.autodetected(cfg -> mock(EventHandlingComponent.class))) + .customized((cfg, config) -> config + .batchSize(50) + .tenantTokenStoreFactory(customFactory) + .initialSegmentCount(8) + .tokenClaimInterval(10000)); + + assertNotNull(module); + } +} diff --git a/multitenancy/src/test/java/org/axonframework/extension/multitenancy/messaging/queryhandling/MultiTenantQueryBusTest.java b/multitenancy/src/test/java/org/axonframework/extension/multitenancy/messaging/queryhandling/MultiTenantQueryBusTest.java new file mode 100644 index 0000000..9b1984d --- /dev/null +++ b/multitenancy/src/test/java/org/axonframework/extension/multitenancy/messaging/queryhandling/MultiTenantQueryBusTest.java @@ -0,0 +1,244 @@ +/* + * Copyright (c) 2010-2025. Axon Framework + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.axonframework.extension.multitenancy.messaging.queryhandling; + +import org.axonframework.extension.multitenancy.core.TargetTenantResolver; +import org.axonframework.extension.multitenancy.core.TenantDescriptor; +import org.axonframework.messaging.core.Message; +import org.axonframework.messaging.core.MessageStream; +import org.axonframework.messaging.core.MessageType; +import org.axonframework.messaging.core.QualifiedName; +import org.axonframework.messaging.core.unitofwork.ProcessingContext; +import org.axonframework.messaging.queryhandling.GenericQueryMessage; +import org.axonframework.messaging.queryhandling.GenericQueryResponseMessage; +import org.axonframework.messaging.queryhandling.QueryBus; +import org.axonframework.messaging.queryhandling.QueryHandler; +import org.axonframework.messaging.queryhandling.QueryMessage; +import org.axonframework.messaging.queryhandling.QueryResponseMessage; +import org.junit.jupiter.api.*; + +import java.util.concurrent.CompletableFuture; +import java.util.concurrent.ExecutionException; + +import static org.junit.jupiter.api.Assertions.*; +import static org.mockito.ArgumentMatchers.*; +import static org.mockito.Mockito.*; + +/** + * Test class validating the {@link MultiTenantQueryBus}. + * + * @author Stefan Dragisic + */ +class MultiTenantQueryBusTest { + + private static final String PAYLOAD = "testQuery"; + private static final MessageType QUERY_TYPE = new MessageType("TestQuery"); + private static final MessageType RESPONSE_TYPE = new MessageType("Response"); + private static final QueryMessage TEST_QUERY = new GenericQueryMessage(QUERY_TYPE, PAYLOAD); + private static final QualifiedName QUERY_NAME = TEST_QUERY.type().qualifiedName(); + + private static final TenantDescriptor TENANT_1 = TenantDescriptor.tenantWithId("tenant1"); + private static final TenantDescriptor TENANT_2 = TenantDescriptor.tenantWithId("tenant2"); + + private QueryBus tenantSegment1; + private QueryBus tenantSegment2; + + private MultiTenantQueryBus testSubject; + + @BeforeEach + void setUp() { + tenantSegment1 = mock(QueryBus.class); + tenantSegment2 = mock(QueryBus.class); + + // Stub subscribe to return the bus for fluent chaining + when(tenantSegment1.subscribe(any(QualifiedName.class), any(QueryHandler.class))).thenReturn(tenantSegment1); + when(tenantSegment2.subscribe(any(QualifiedName.class), any(QueryHandler.class))).thenReturn(tenantSegment2); + + TenantQuerySegmentFactory tenantSegmentFactory = tenant -> { + if (tenant.tenantId().equals("tenant1")) { + return tenantSegment1; + } else { + return tenantSegment2; + } + }; + + // Resolver always resolves to tenant2 + TargetTenantResolver targetTenantResolver = + (message, tenants) -> TENANT_2; + + testSubject = MultiTenantQueryBus.builder() + .tenantSegmentFactory(tenantSegmentFactory) + .targetTenantResolver(targetTenantResolver) + .build(); + } + + @Test + void queryRoutesToCorrectTenant() { + QueryResponseMessage expectedResponse = new GenericQueryResponseMessage(RESPONSE_TYPE, "result"); + when(tenantSegment2.query(any(), any())) + .thenReturn(MessageStream.just(expectedResponse)); + + testSubject.registerTenant(TENANT_1); + testSubject.registerTenant(TENANT_2); + + MessageStream result = testSubject.query(TEST_QUERY, null); + + verify(tenantSegment2).query(eq(TEST_QUERY), isNull()); + verify(tenantSegment1, never()).query(any(), any()); + assertNotNull(result); + } + + @Test + void queryToUnknownTenantReturnsFailedStream() { + // No tenants registered + MessageStream result = testSubject.query(TEST_QUERY, null); + + // The stream should be failed - check via the error() method + assertNotNull(result); + assertTrue(result.error().isPresent()); + } + + @Test + void subscriptionQueryRoutesToCorrectTenant() { + QueryResponseMessage expectedResponse = new GenericQueryResponseMessage(RESPONSE_TYPE, "result"); + when(tenantSegment2.subscriptionQuery(any(), any(), anyInt())) + .thenReturn(MessageStream.just(expectedResponse)); + + testSubject.registerTenant(TENANT_1); + testSubject.registerTenant(TENANT_2); + + MessageStream result = testSubject.subscriptionQuery(TEST_QUERY, null, 10); + + verify(tenantSegment2).subscriptionQuery(eq(TEST_QUERY), isNull(), eq(10)); + verify(tenantSegment1, never()).subscriptionQuery(any(), any(), anyInt()); + } + + @Test + void subscribeRegistersHandlerOnExistingTenants() { + testSubject.registerTenant(TENANT_1); + testSubject.registerTenant(TENANT_2); + + QueryHandler handler = (msg, ctx) -> MessageStream.just(new GenericQueryResponseMessage(RESPONSE_TYPE, "ok")); + testSubject.subscribe(QUERY_NAME, handler); + + verify(tenantSegment1).subscribe(eq(QUERY_NAME), eq(handler)); + verify(tenantSegment2).subscribe(eq(QUERY_NAME), eq(handler)); + } + + @Test + void registerAndStartTenantSubscribesExistingHandlers() { + // First subscribe a handler + QueryHandler handler = (msg, ctx) -> MessageStream.just(new GenericQueryResponseMessage(RESPONSE_TYPE, "ok")); + testSubject.subscribe(QUERY_NAME, handler); + + // Then register and start a tenant + testSubject.registerAndStartTenant(TENANT_1); + + // Handler should be subscribed to the new tenant segment + verify(tenantSegment1).subscribe(eq(QUERY_NAME), eq(handler)); + } + + @Test + void emitUpdateRoutesToCorrectTenant() { + when(tenantSegment2.emitUpdate(any(), any(), any())) + .thenReturn(CompletableFuture.completedFuture(null)); + + testSubject.registerTenant(TENANT_1); + testSubject.registerTenant(TENANT_2); + + // Create a mock ProcessingContext that returns our test query + ProcessingContext context = mock(ProcessingContext.class); + when(context.getResource(Message.RESOURCE_KEY)).thenReturn(TEST_QUERY); + + testSubject.emitUpdate(q -> true, () -> null, context); + + // Should only emit to tenant2 (resolved from the message) + verify(tenantSegment2).emitUpdate(any(), any(), any()); + verify(tenantSegment1, never()).emitUpdate(any(), any(), any()); + } + + @Test + void emitUpdateWithoutContextReturnsFailedFuture() { + testSubject.registerTenant(TENANT_1); + testSubject.registerTenant(TENANT_2); + + CompletableFuture result = testSubject.emitUpdate(q -> true, () -> null, null); + + assertTrue(result.isCompletedExceptionally()); + ExecutionException exception = assertThrows(ExecutionException.class, result::get); + assertInstanceOf(IllegalStateException.class, exception.getCause()); + } + + @Test + void completeSubscriptionsRoutesToCorrectTenant() { + when(tenantSegment2.completeSubscriptions(any(), any())) + .thenReturn(CompletableFuture.completedFuture(null)); + + testSubject.registerTenant(TENANT_1); + testSubject.registerTenant(TENANT_2); + + // Create a mock ProcessingContext that returns our test query + ProcessingContext context = mock(ProcessingContext.class); + when(context.getResource(Message.RESOURCE_KEY)).thenReturn(TEST_QUERY); + + testSubject.completeSubscriptions(q -> true, context); + + // Should only complete on tenant2 (resolved from the message) + verify(tenantSegment2).completeSubscriptions(any(), any()); + verify(tenantSegment1, never()).completeSubscriptions(any(), any()); + } + + @Test + void unregisterTenantRemovesTenantFromRouting() { + testSubject.registerTenant(TENANT_2); + + // Unregister the tenant + testSubject.registerTenant(TENANT_2).cancel(); + + // Should fail because tenant is no longer registered + MessageStream result = testSubject.query(TEST_QUERY, null); + assertTrue(result.error().isPresent()); + } + + @Test + void tenantSegmentsReturnsRegisteredTenants() { + testSubject.registerTenant(TENANT_1); + testSubject.registerTenant(TENANT_2); + + assertEquals(2, testSubject.tenantSegments().size()); + assertTrue(testSubject.tenantSegments().containsKey(TENANT_1)); + assertTrue(testSubject.tenantSegments().containsKey(TENANT_2)); + } + + @Test + void builderRequiresTenantSegmentFactory() { + assertThrows(Exception.class, () -> + MultiTenantQueryBus.builder() + .targetTenantResolver((m, t) -> TENANT_1) + .build() + ); + } + + @Test + void builderRequiresTargetTenantResolver() { + assertThrows(Exception.class, () -> + MultiTenantQueryBus.builder() + .tenantSegmentFactory(t -> tenantSegment1) + .build() + ); + } +} diff --git a/multitenancy/src/test/java/org/axonframework/extension/multitenancy/messaging/queryhandling/interception/InterceptingMultiTenantQueryBusTest.java b/multitenancy/src/test/java/org/axonframework/extension/multitenancy/messaging/queryhandling/interception/InterceptingMultiTenantQueryBusTest.java new file mode 100644 index 0000000..bd54e02 --- /dev/null +++ b/multitenancy/src/test/java/org/axonframework/extension/multitenancy/messaging/queryhandling/interception/InterceptingMultiTenantQueryBusTest.java @@ -0,0 +1,389 @@ +/* + * Copyright (c) 2010-2025. Axon Framework + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.axonframework.extension.multitenancy.messaging.queryhandling.interception; + +import jakarta.annotation.Nonnull; +import jakarta.annotation.Nullable; +import org.axonframework.extension.multitenancy.core.TenantDescriptor; +import org.axonframework.extension.multitenancy.messaging.queryhandling.MultiTenantQueryBus; +import org.axonframework.messaging.core.Message; +import org.axonframework.messaging.core.MessageDispatchInterceptor; +import org.axonframework.messaging.core.MessageDispatchInterceptorChain; +import org.axonframework.messaging.core.MessageStream; +import org.axonframework.messaging.core.MessageType; +import org.axonframework.messaging.core.unitofwork.ProcessingContext; +import org.axonframework.messaging.queryhandling.GenericQueryMessage; +import org.axonframework.messaging.queryhandling.GenericQueryResponseMessage; +import org.axonframework.messaging.queryhandling.QueryBus; +import org.axonframework.messaging.queryhandling.QueryMessage; +import org.axonframework.messaging.queryhandling.QueryResponseMessage; +import org.axonframework.messaging.queryhandling.interception.InterceptingQueryBus; +import org.junit.jupiter.api.*; +import org.mockito.*; + +import java.util.List; +import java.util.Map; +import java.util.concurrent.atomic.AtomicBoolean; + +import static org.junit.jupiter.api.Assertions.*; +import static org.mockito.ArgumentMatchers.*; +import static org.mockito.Mockito.*; + +/** + * Test class validating that {@link InterceptingQueryBus} correctly wraps + * {@link MultiTenantQueryBus}, ensuring interceptors are invoked before + * tenant routing occurs. + *

    + * This follows the same pattern as {@code InterceptingQueryBusTest} in the + * core framework, but validates the multi-tenant decorator chain: + * 

    + *     InterceptingQueryBus → MultiTenantQueryBus → TenantSegments
+ *
    + * + * @author Stefan Dragisic + * @since 5.0.0 + */ +class InterceptingMultiTenantQueryBusTest { + + private static final MessageType TEST_QUERY_TYPE = new MessageType("TestQuery"); + private static final MessageType TEST_RESPONSE_TYPE = new MessageType(String.class); + private static final TenantDescriptor TENANT_1 = TenantDescriptor.tenantWithId("tenant1"); + private static final TenantDescriptor TENANT_2 = TenantDescriptor.tenantWithId("tenant2"); + + private QueryBus tenantSegment1; + private QueryBus tenantSegment2; + private MultiTenantQueryBus multiTenantQueryBus; + private InterceptingQueryBus testSubject; + + @BeforeEach + void setUp() { + tenantSegment1 = mock(QueryBus.class); + tenantSegment2 = mock(QueryBus.class); + + // Configure mock segments to return success + when(tenantSegment1.query(any(), any())) + .thenReturn(MessageStream.just( + new GenericQueryResponseMessage(TEST_RESPONSE_TYPE, "success-tenant1"))); + when(tenantSegment2.query(any(), any())) + .thenReturn(MessageStream.just( + new GenericQueryResponseMessage(TEST_RESPONSE_TYPE, "success-tenant2"))); + + // Create MultiTenantQueryBus that routes to tenant2 + multiTenantQueryBus = MultiTenantQueryBus.builder() + .tenantSegmentFactory(tenant -> { + if (TENANT_1.equals(tenant)) { + return tenantSegment1; + } + return tenantSegment2; + }) + .targetTenantResolver((message, tenants) -> TENANT_2) + .build(); + + // Register tenants + multiTenantQueryBus.registerTenant(TENANT_1); + multiTenantQueryBus.registerTenant(TENANT_2); + } + + @Nested + @DisplayName("Dispatch interceptor tests") + class DispatchInterceptorTests { + + @Test + void dispatchInterceptorsAreInvokedBeforeTenantRouting() { + AtomicBoolean interceptorInvoked = new AtomicBoolean(false); + + MessageDispatchInterceptor trackingInterceptor = (message, context, chain) -> { + interceptorInvoked.set(true); + return chain.proceed(message, context); + }; + + testSubject = new InterceptingQueryBus( + multiTenantQueryBus, + List.of(), + List.of(trackingInterceptor), + List.of() + ); + + QueryMessage query = new GenericQueryMessage(TEST_QUERY_TYPE, "test-payload"); + testSubject.query(query, null); + + assertTrue(interceptorInvoked.get(), "Dispatch interceptor should be invoked"); + verify(tenantSegment2).query(any(), any()); + } + + @Test + void dispatchInterceptorsCanModifyQueryBeforeRouting() { + MessageDispatchInterceptor addMetadataInterceptor = (message, context, chain) -> { + Message modified = message.andMetadata(Map.of("intercepted", "true")); + return chain.proceed(modified, context); + }; + + testSubject = new InterceptingQueryBus( + multiTenantQueryBus, + List.of(), + List.of(addMetadataInterceptor), + List.of() + ); + + QueryMessage query = new GenericQueryMessage(TEST_QUERY_TYPE, "test-payload"); + testSubject.query(query, null); + + // Verify the tenant segment received the modified query + ArgumentCaptor queryCaptor = ArgumentCaptor.forClass(QueryMessage.class); + verify(tenantSegment2).query(queryCaptor.capture(), any()); + + QueryMessage dispatchedQuery = queryCaptor.getValue(); + assertTrue(dispatchedQuery.metadata().containsKey("intercepted"), + "Query should contain interceptor-added metadata"); + assertEquals("true", dispatchedQuery.metadata().get("intercepted")); + } + + @Test + void multipleDispatchInterceptorsAreInvokedInOrder() { + MessageDispatchInterceptor firstInterceptor = (message, context, chain) -> { + Message modified = message.andMetadata(Map.of("first", "1")); + return chain.proceed(modified, context); + }; + + MessageDispatchInterceptor secondInterceptor = (message, context, chain) -> { + Message modified = message.andMetadata(Map.of("second", "2")); + return chain.proceed(modified, context); + }; + + testSubject = new InterceptingQueryBus( + multiTenantQueryBus, + List.of(), + List.of(firstInterceptor, secondInterceptor), + List.of() + ); + + QueryMessage query = new GenericQueryMessage(TEST_QUERY_TYPE, "test-payload"); + testSubject.query(query, null); + + ArgumentCaptor queryCaptor = ArgumentCaptor.forClass(QueryMessage.class); + verify(tenantSegment2).query(queryCaptor.capture(), any()); + + QueryMessage dispatchedQuery = queryCaptor.getValue(); + assertTrue(dispatchedQuery.metadata().containsKey("first"), + "First interceptor metadata should be present"); + assertTrue(dispatchedQuery.metadata().containsKey("second"), + "Second interceptor metadata should be present"); + } + + @Test + void interceptorCanShortCircuitQuery() { + MessageDispatchInterceptor shortCircuitInterceptor = (message, context, chain) -> + MessageStream.failed(new RuntimeException("Short-circuited")); + + testSubject = new InterceptingQueryBus( + multiTenantQueryBus, + List.of(), + List.of(shortCircuitInterceptor), + List.of() + ); + + QueryMessage query = new GenericQueryMessage(TEST_QUERY_TYPE, "test-payload"); + MessageStream result = testSubject.query(query, null); + + assertTrue(result.first().asCompletableFuture().isCompletedExceptionally(), + "Result should be completed exceptionally when interceptor short-circuits"); + verify(tenantSegment1, never()).query(any(), any()); + verify(tenantSegment2, never()).query(any(), any()); + } + } + + @Nested + @DisplayName("Tenant routing tests") + class TenantRoutingTests { + + @Test + void queryIsRoutedToCorrectTenantAfterInterception() { + MessageDispatchInterceptor loggingInterceptor = (message, context, chain) -> + chain.proceed(message, context); + + testSubject = new InterceptingQueryBus( + multiTenantQueryBus, + List.of(), + List.of(loggingInterceptor), + List.of() + ); + + QueryMessage query = new GenericQueryMessage(TEST_QUERY_TYPE, "test-payload"); + testSubject.query(query, null); + + // Tenant resolver is configured to route to TENANT_2 + verify(tenantSegment2).query(any(), any()); + verify(tenantSegment1, never()).query(any(), any()); + } + + @Test + void interceptedQueryReachesCorrectTenantSegment() { + MessageDispatchInterceptor addTenantContextInterceptor = (message, context, chain) -> { + Message modified = message.andMetadata(Map.of("tenant-context", "enriched")); + return chain.proceed(modified, context); + }; + + testSubject = new InterceptingQueryBus( + multiTenantQueryBus, + List.of(), + List.of(addTenantContextInterceptor), + List.of() + ); + + QueryMessage query = new GenericQueryMessage(TEST_QUERY_TYPE, "test-payload"); + MessageStream result = testSubject.query(query, null); + + assertFalse(result.first().asCompletableFuture().isCompletedExceptionally()); + + ArgumentCaptor queryCaptor = ArgumentCaptor.forClass(QueryMessage.class); + verify(tenantSegment2).query(queryCaptor.capture(), any()); + + QueryMessage receivedQuery = queryCaptor.getValue(); + assertEquals("enriched", receivedQuery.metadata().get("tenant-context"), + "Tenant segment should receive enriched query"); + } + } + + @Nested + @DisplayName("Result handling tests") + class ResultHandlingTests { + + @Test + void resultFromTenantSegmentIsReturnedThroughInterceptorChain() { + AtomicBoolean resultIntercepted = new AtomicBoolean(false); + + MessageDispatchInterceptor resultTrackingInterceptor = + new MessageDispatchInterceptor<>() { + @Nonnull + @Override + public MessageStream interceptOnDispatch(@Nonnull Message message, + @Nullable ProcessingContext context, + @Nonnull MessageDispatchInterceptorChain chain) { + return chain.proceed(message, context) + .onNext(m -> resultIntercepted.set(true)); + } + }; + + testSubject = new InterceptingQueryBus( + multiTenantQueryBus, + List.of(), + List.of(resultTrackingInterceptor), + List.of() + ); + + QueryMessage query = new GenericQueryMessage(TEST_QUERY_TYPE, "test-payload"); + MessageStream result = testSubject.query(query, null); + + // Consume the result to trigger the interceptor + result.first().asCompletableFuture().join(); + + assertTrue(resultIntercepted.get(), "Result should pass back through interceptor chain"); + } + + @Test + void interceptorCanModifyResult() { + MessageDispatchInterceptor resultModifyingInterceptor = + new MessageDispatchInterceptor<>() { + @Nonnull + @Override + public MessageStream interceptOnDispatch(@Nonnull Message message, + @Nullable ProcessingContext context, + @Nonnull MessageDispatchInterceptorChain chain) { + return chain.proceed(message, context) + .mapMessage(m -> m.andMetadata(Map.of("result-enriched", "yes"))); + } + }; + + testSubject = new InterceptingQueryBus( + multiTenantQueryBus, + List.of(), + List.of(resultModifyingInterceptor), + List.of() + ); + + QueryMessage query = new GenericQueryMessage(TEST_QUERY_TYPE, "test-payload"); + MessageStream result = testSubject.query(query, null); + + QueryResponseMessage responseMessage = result.first().asCompletableFuture().join().message(); + assertEquals("yes", responseMessage.metadata().get("result-enriched"), + "Result should contain interceptor-added metadata"); + } + } + + @Nested + @DisplayName("Subscription query tests") + class SubscriptionQueryTests { + + @Test + void subscriptionQueryInterceptorsAreInvokedBeforeTenantRouting() { + AtomicBoolean interceptorInvoked = new AtomicBoolean(false); + + // Configure mock for subscription query + when(tenantSegment2.subscriptionQuery(any(), any(), anyInt())) + .thenReturn(MessageStream.just( + new GenericQueryResponseMessage(TEST_RESPONSE_TYPE, "subscription-success"))); + + MessageDispatchInterceptor trackingInterceptor = (message, context, chain) -> { + interceptorInvoked.set(true); + return chain.proceed(message, context); + }; + + testSubject = new InterceptingQueryBus( + multiTenantQueryBus, + List.of(), + List.of(trackingInterceptor), + List.of() + ); + + QueryMessage query = new GenericQueryMessage(TEST_QUERY_TYPE, "test-payload"); + testSubject.subscriptionQuery(query, null, 10); + + assertTrue(interceptorInvoked.get(), "Dispatch interceptor should be invoked for subscription query"); + verify(tenantSegment2).subscriptionQuery(any(), any(), anyInt()); + } + + @Test + void subscriptionQueryModifiedByInterceptorReachesCorrectTenant() { + // Configure mock for subscription query + when(tenantSegment2.subscriptionQuery(any(), any(), anyInt())) + .thenReturn(MessageStream.just( + new GenericQueryResponseMessage(TEST_RESPONSE_TYPE, "subscription-success"))); + + MessageDispatchInterceptor addMetadataInterceptor = (message, context, chain) -> { + Message modified = message.andMetadata(Map.of("subscription-context", "enriched")); + return chain.proceed(modified, context); + }; + + testSubject = new InterceptingQueryBus( + multiTenantQueryBus, + List.of(), + List.of(addMetadataInterceptor), + List.of() + ); + + QueryMessage query = new GenericQueryMessage(TEST_QUERY_TYPE, "test-payload"); + testSubject.subscriptionQuery(query, null, 10); + + ArgumentCaptor queryCaptor = ArgumentCaptor.forClass(QueryMessage.class); + verify(tenantSegment2).subscriptionQuery(queryCaptor.capture(), any(), anyInt()); + + QueryMessage dispatchedQuery = queryCaptor.getValue(); + assertEquals("enriched", dispatchedQuery.metadata().get("subscription-context"), + "Subscription query should contain interceptor-added metadata"); + } + } +} diff --git a/multitenancy/src/test/java/org/axonframework/extensions/multitenancy/TenantWrappedTransactionManagerTest.java b/multitenancy/src/test/java/org/axonframework/extensions/multitenancy/TenantWrappedTransactionManagerTest.java deleted file mode 100644 index d511a59..0000000 --- a/multitenancy/src/test/java/org/axonframework/extensions/multitenancy/TenantWrappedTransactionManagerTest.java +++ /dev/null @@ -1,82 +0,0 @@ -/* - * Copyright (c) 2010-2023. Axon Framework - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -package org.axonframework.extensions.multitenancy; - -import org.axonframework.common.transaction.Transaction; -import org.axonframework.common.transaction.TransactionManager; -import org.axonframework.extensions.multitenancy.components.TenantDescriptor; -import org.junit.jupiter.api.*; - -import java.util.function.Supplier; - -import static org.junit.jupiter.api.Assertions.*; -import static org.mockito.Mockito.*; - -/** - * Test class validating the {@link TenantWrappedTransactionManager}. - * - * @author Stefan Dragisic - */ -class TenantWrappedTransactionManagerTest { - - private TransactionManager delegate; - private final TenantDescriptor tenant1 = TenantDescriptor.tenantWithId("tenant1"); - - private TenantWrappedTransactionManager testSubject; - - @BeforeEach - void setUp() { - delegate = mock(TransactionManager.class); - testSubject = new TenantWrappedTransactionManager(delegate, tenant1); - } - - @Test - void startTransaction() { - Transaction transactionMock = mock(Transaction.class); - when(delegate.startTransaction()).thenReturn(transactionMock); - - testSubject.startTransaction(); - - assertNull(TenantWrappedTransactionManager.getCurrentTenant()); - verify(delegate, times(1)).startTransaction(); - } - - @Test - void executeInTransaction() { - doNothing().when(delegate).executeInTransaction(any()); - - Runnable task = () -> assertEquals(tenant1, TenantWrappedTransactionManager.getCurrentTenant()); - testSubject.executeInTransaction(task); - - assertNull(TenantWrappedTransactionManager.getCurrentTenant()); - verify(delegate, times(1)).executeInTransaction(task); - } - - @Test - void fetchInTransaction() { - when(delegate.fetchInTransaction(any())).thenReturn("result"); - - Supplier supplier = () -> { - assertEquals(tenant1, TenantWrappedTransactionManager.getCurrentTenant()); - return "string"; - }; - testSubject.fetchInTransaction(supplier); - - assertNull(TenantWrappedTransactionManager.getCurrentTenant()); - verify(delegate, times(1)).fetchInTransaction(supplier); - } -} \ No newline at end of file diff --git a/multitenancy/src/test/java/org/axonframework/extensions/multitenancy/components/commandhandeling/MultiTenantCommandBusTest.java b/multitenancy/src/test/java/org/axonframework/extensions/multitenancy/components/commandhandeling/MultiTenantCommandBusTest.java deleted file mode 100644 index a7f9b17..0000000 --- a/multitenancy/src/test/java/org/axonframework/extensions/multitenancy/components/commandhandeling/MultiTenantCommandBusTest.java +++ /dev/null @@ -1,175 +0,0 @@ -/* - * Copyright (c) 2010-2023. Axon Framework - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -package org.axonframework.extensions.multitenancy.components.commandhandeling; - -import org.axonframework.commandhandling.CommandBus; -import org.axonframework.commandhandling.CommandCallback; -import org.axonframework.commandhandling.CommandMessage; -import org.axonframework.commandhandling.GenericCommandMessage; -import org.axonframework.commandhandling.SimpleCommandBus; -import org.axonframework.common.Registration; -import org.axonframework.extensions.multitenancy.components.NoSuchTenantException; -import org.axonframework.extensions.multitenancy.components.TargetTenantResolver; -import org.axonframework.extensions.multitenancy.components.TenantDescriptor; -import org.axonframework.messaging.MessageDispatchInterceptor; -import org.axonframework.messaging.MessageHandler; -import org.axonframework.messaging.MessageHandlerInterceptor; -import org.junit.jupiter.api.*; - -import java.util.concurrent.CountDownLatch; - -import static org.junit.jupiter.api.Assertions.*; -import static org.mockito.Mockito.*; - -/** - * Test class validating the {@link MultiTenantCommandBus}. - * - * @author Stefan Dragisic - */ -@SuppressWarnings("resource") -class MultiTenantCommandBusTest { - - private CommandBus fixtureSegment1; - private CommandBus fixtureSegment2; - - private MultiTenantCommandBus testSubject; - - @BeforeEach - void setUp() { - fixtureSegment1 = mock(SimpleCommandBus.class); - fixtureSegment2 = mock(SimpleCommandBus.class); - - TenantCommandSegmentFactory tenantCommandSegmentFactory = t -> { - if (t.tenantId().equals("fixtureTenant1")) { - return fixtureSegment1; - } else { - return fixtureSegment2; - } - }; - TargetTenantResolver> targetTenantResolver = - (m, tenants) -> TenantDescriptor.tenantWithId("fixtureTenant2"); - - testSubject = MultiTenantCommandBus.builder() - .tenantSegmentFactory(tenantCommandSegmentFactory) - .targetTenantResolver(targetTenantResolver) - .build(); - } - - @Test - void dispatch() { - testSubject.registerTenant(TenantDescriptor.tenantWithId("fixtureTenant1")); - testSubject.registerTenant(TenantDescriptor.tenantWithId("fixtureTenant2")); - - CommandMessage command = GenericCommandMessage.asCommandMessage("command"); - testSubject.dispatch(command); - verify(fixtureSegment2).dispatch(command); - verify(fixtureSegment1, times(0)).dispatch(any()); - } - - @Test - void dispatchWithCallback() { - testSubject.registerTenant(TenantDescriptor.tenantWithId("fixtureTenant1")); - testSubject.registerTenant(TenantDescriptor.tenantWithId("fixtureTenant2")); - - CommandCallback cc = (c, r) -> assertEquals(c.getPayload(), "command"); - CommandMessage command = GenericCommandMessage.asCommandMessage("command"); - testSubject.dispatch(command, cc); - verify(fixtureSegment2).dispatch(command, cc); - verify(fixtureSegment1, times(0)).dispatch(any()); - } - - @Test - void unknownTenant() { - NoSuchTenantException noSuchTenantException = assertThrows(NoSuchTenantException.class, () -> { - CommandMessage command = GenericCommandMessage.asCommandMessage("command"); - testSubject.dispatch(command); - }); - assertEquals("Tenant with identifier [fixtureTenant2] is unknown", noSuchTenantException.getMessage()); - } - - @Test - void unknownTenantWithCallback() throws InterruptedException { - CountDownLatch lock = new CountDownLatch(1); - CommandMessage command = GenericCommandMessage.asCommandMessage("command"); - testSubject.dispatch(command, (c, r) -> { - assertTrue(r.isExceptional()); - assertEquals("Tenant with identifier [fixtureTenant2] is unknown", r.exceptionResult().getMessage()); - lock.countDown(); - }); - lock.await(); - } - - @Test - void unregister() { - NoSuchTenantException noSuchTenantException = assertThrows(NoSuchTenantException.class, () -> { - CommandMessage command = GenericCommandMessage.asCommandMessage("command"); - testSubject.registerTenant(TenantDescriptor.tenantWithId("fixtureTenant2")).cancel(); - testSubject.dispatch(command); - }); - assertEquals("Tenant with identifier [fixtureTenant2] is unknown", noSuchTenantException.getMessage()); - } - - @Test - void registerTenantAfterCommandBusHaveBeenStarted() { - when(fixtureSegment1.subscribe(anyString(), any())).thenReturn(() -> true); - when(fixtureSegment2.subscribe(anyString(), any())).thenReturn(() -> true); - - MessageHandlerInterceptor> messageHandlerInterceptor = (m, chain) -> chain.proceed(); - testSubject.registerHandlerInterceptor(messageHandlerInterceptor); - - MessageDispatchInterceptor> messageDispatchInterceptor = messages -> (a, b) -> b; - testSubject.registerDispatchInterceptor(messageDispatchInterceptor); - - testSubject.registerTenant(TenantDescriptor.tenantWithId("fixtureTenant1")); - - MessageHandler> commandHandler = c -> null; - testSubject.subscribe("command", commandHandler); - - testSubject.registerAndStartTenant(TenantDescriptor.tenantWithId("fixtureTenant2")); - - CommandMessage command = GenericCommandMessage.asCommandMessage("command"); - testSubject.dispatch(command); - verify(fixtureSegment2).dispatch(command); - verify(fixtureSegment1, times(0)).dispatch(any()); - - verify(fixtureSegment1).subscribe("command", commandHandler); - verify(fixtureSegment2).registerHandlerInterceptor(messageHandlerInterceptor); - - verify(fixtureSegment1).subscribe(any(), any()); - verify(fixtureSegment2).registerDispatchInterceptor(messageDispatchInterceptor); - } - - @Test - void registerDispatchInterceptor() { - when(fixtureSegment2.registerDispatchInterceptor(any())).thenReturn(() -> true); - MessageDispatchInterceptor> messageDispatchInterceptor = messages -> (a, b) -> b; - testSubject.registerAndStartTenant(TenantDescriptor.tenantWithId("fixtureTenant2")); - Registration registration = testSubject.registerDispatchInterceptor(messageDispatchInterceptor); - - assertTrue(registration.cancel()); - } - - @Test - void registerHandlerInterceptor() { - when(fixtureSegment2.registerHandlerInterceptor(any())).thenReturn(() -> true); - MessageHandlerInterceptor> messageHandlerInterceptor = (m, chain) -> chain.proceed(); - testSubject.registerAndStartTenant(TenantDescriptor.tenantWithId("fixtureTenant2")); - Registration registration = testSubject.registerHandlerInterceptor(messageHandlerInterceptor); - - assertTrue(registration.cancel()); - } -} \ No newline at end of file diff --git a/multitenancy/src/test/java/org/axonframework/extensions/multitenancy/components/deadletterqueue/MultiTenantDeadLetterProcessorTest.java b/multitenancy/src/test/java/org/axonframework/extensions/multitenancy/components/deadletterqueue/MultiTenantDeadLetterProcessorTest.java deleted file mode 100644 index a24ba82..0000000 --- a/multitenancy/src/test/java/org/axonframework/extensions/multitenancy/components/deadletterqueue/MultiTenantDeadLetterProcessorTest.java +++ /dev/null @@ -1,71 +0,0 @@ -/* - * Copyright (c) 2010-2023. Axon Framework - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -package org.axonframework.extensions.multitenancy.components.deadletterqueue; - -import org.axonframework.eventhandling.EventMessage; -import org.axonframework.extensions.multitenancy.TenantWrappedTransactionManager; -import org.axonframework.extensions.multitenancy.components.TenantDescriptor; -import org.axonframework.messaging.deadletter.DeadLetter; -import org.axonframework.messaging.deadletter.SequencedDeadLetterProcessor; -import org.junit.jupiter.api.*; - -import java.util.function.Predicate; - -import static org.junit.jupiter.api.Assertions.*; -import static org.mockito.Mockito.*; - -/** - * Test class validating the {@link MultiTenantDeadLetterProcessor}. - * - * @author Stefan Dragisic - */ -class MultiTenantDeadLetterProcessorTest { - - private SequencedDeadLetterProcessor> delegate; - - private MultiTenantDeadLetterProcessor testSubject; - - @BeforeEach - void setUp() { - //noinspection unchecked - delegate = mock(SequencedDeadLetterProcessor.class); - testSubject = new MultiTenantDeadLetterProcessor(delegate); - } - - @Test - void forTenantMustBeCalled() { - assertThrows(IllegalStateException.class, () -> testSubject.process(t -> true)); - - testSubject.forTenant(TenantDescriptor.tenantWithId("tenantId")) - .processAny(); - - verify(delegate).processAny(); - } - - @Test - void processHasTenantAttached() { - Predicate>> predicate = t -> { - assertEquals(TenantDescriptor.tenantWithId("tenantId"), - TenantWrappedTransactionManager.getCurrentTenant()); - return true; - }; - testSubject.forTenant(TenantDescriptor.tenantWithId("tenantId")) - .process(predicate); - - verify(delegate).process(predicate); - } -} \ No newline at end of file diff --git a/multitenancy/src/test/java/org/axonframework/extensions/multitenancy/components/deadletterqueue/MultiTenantDeadLetterQueueTest.java b/multitenancy/src/test/java/org/axonframework/extensions/multitenancy/components/deadletterqueue/MultiTenantDeadLetterQueueTest.java deleted file mode 100644 index c67f820..0000000 --- a/multitenancy/src/test/java/org/axonframework/extensions/multitenancy/components/deadletterqueue/MultiTenantDeadLetterQueueTest.java +++ /dev/null @@ -1,415 +0,0 @@ -/* - * Copyright (c) 2010-2023. Axon Framework - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -package org.axonframework.extensions.multitenancy.components.deadletterqueue; - -import org.axonframework.common.transaction.NoTransactionManager; -import org.axonframework.eventhandling.EventMessage; -import org.axonframework.extensions.multitenancy.TenantWrappedTransactionManager; -import org.axonframework.extensions.multitenancy.components.TargetTenantResolver; -import org.axonframework.extensions.multitenancy.components.TenantDescriptor; -import org.axonframework.messaging.deadletter.DeadLetter; -import org.axonframework.messaging.deadletter.Decisions; -import org.axonframework.messaging.deadletter.SequencedDeadLetterQueue; -import org.junit.jupiter.api.*; - -import java.util.ArrayList; -import java.util.List; -import java.util.Optional; -import java.util.concurrent.atomic.AtomicInteger; -import java.util.function.Supplier; - -import static org.junit.jupiter.api.Assertions.*; -import static org.mockito.Mockito.*; - -/** - * Test class validating the {@link MultiTenantDeadLetterQueue}. - * - * @author Stefan Dragisic - */ -@SuppressWarnings("resource") -class MultiTenantDeadLetterQueueTest { - - private List>> deadLetterQueues; - - private MultiTenantDeadLetterQueue> testSubject; - - @BeforeEach - void setUp() { - TargetTenantResolver> targetTenantResolver = - (m, tenants) -> TenantDescriptor.tenantWithId("tenant-send-to"); - - deadLetterQueues = new ArrayList<>(); - - testSubject = MultiTenantDeadLetterQueue.builder() - .processingGroup("test") - .targetTenantResolver(targetTenantResolver) - .build(); - - testSubject.registerDeadLetterQueueSupplier(() -> { - //noinspection unchecked - SequencedDeadLetterQueue> mock = mock(SequencedDeadLetterQueue.class); - deadLetterQueues.add(mock); - return mock; - }); - - testSubject.registerAndStartTenant(TenantDescriptor.tenantWithId("tenant-send-to")); - } - - @Test - void init() { - SequencedDeadLetterQueue> tenantSegment = - testSubject.getTenantSegment(TenantDescriptor.tenantWithId("tenant-send-to")); - Optional>> optionalDlq = deadLetterQueues.stream().findFirst(); - assertTrue(optionalDlq.isPresent()); - assertEquals(tenantSegment, optionalDlq.get()); - } - - @Test - void twoTenants() { - testSubject.registerAndStartTenant(TenantDescriptor.tenantWithId("second-tenant")); - SequencedDeadLetterQueue> firstTenantSegment = - testSubject.getTenantSegment(TenantDescriptor.tenantWithId("tenant-send-to")); - SequencedDeadLetterQueue> secondTenantSegment = - testSubject.getTenantSegment(TenantDescriptor.tenantWithId("second-tenant")); - assertTrue(deadLetterQueues.contains(firstTenantSegment)); - assertTrue(deadLetterQueues.contains(secondTenantSegment)); - assertEquals(2, deadLetterQueues.size()); - } - - @Test - void enqueue() { - //noinspection unchecked - DeadLetter> deadLetter = mock(DeadLetter.class); - testSubject.enqueue("id", deadLetter); - Optional>> optionalDlq = deadLetterQueues.stream().findFirst(); - assertTrue(optionalDlq.isPresent()); - SequencedDeadLetterQueue> deadLetterQueue = optionalDlq.get(); - verify(deadLetterQueue).enqueue("id", deadLetter); - } - - @Test - void enqueueIfPresent() { - //noinspection unchecked - DeadLetter> deadLetter = mock(DeadLetter.class); - Supplier>> deadLetterSupplier = () -> deadLetter; - testSubject.enqueueIfPresent("id", deadLetterSupplier); - Optional>> optionalDlq = deadLetterQueues.stream().findFirst(); - assertTrue(optionalDlq.isPresent()); - SequencedDeadLetterQueue> deadLetterQueue = optionalDlq.get(); - verify(deadLetterQueue).enqueueIfPresent("id", deadLetterSupplier); - } - - @Test - void registerDeadLetterQueueSupplier() { - AtomicInteger counter = new AtomicInteger(0); - testSubject.registerDeadLetterQueueSupplier(() -> { - counter.incrementAndGet(); - //noinspection unchecked - SequencedDeadLetterQueue> mock = mock(SequencedDeadLetterQueue.class); - deadLetterQueues.add(mock); - return mock; - }); - - testSubject.registerAndStartTenant(TenantDescriptor.tenantWithId("tenant1")); - testSubject.getTenantSegment(TenantDescriptor.tenantWithId("tenant1")); - testSubject.getTenantSegment(TenantDescriptor.tenantWithId("tenant1")); - assertEquals(1, counter.get()); - - testSubject.registerAndStartTenant(TenantDescriptor.tenantWithId("tenant2")); - testSubject.getTenantSegment(TenantDescriptor.tenantWithId("tenant2")); - testSubject.getTenantSegment(TenantDescriptor.tenantWithId("tenant2")); - testSubject.getTenantSegment(TenantDescriptor.tenantWithId("tenant2")); - assertEquals(2, counter.get()); - } - - @Test - void evict() { - //noinspection unchecked - DeadLetter> deadLetter = mock(DeadLetter.class); - testSubject.evict(deadLetter); - Optional>> optionalDlq = deadLetterQueues.stream().findFirst(); - assertTrue(optionalDlq.isPresent()); - SequencedDeadLetterQueue> deadLetterQueue = optionalDlq.get(); - verify(deadLetterQueue).evict(deadLetter); - } - - @Test - void requeue() { - //noinspection unchecked - DeadLetter> deadLetter = mock(DeadLetter.class); - testSubject.requeue(deadLetter, d -> d); - Optional>> optionalDlq = deadLetterQueues.stream().findFirst(); - assertTrue(optionalDlq.isPresent()); - SequencedDeadLetterQueue> deadLetterQueue = optionalDlq.get(); - verify(deadLetterQueue).requeue(eq(deadLetter), any()); - } - - @Test - void containsSingleTenant() { - TenantDescriptor secondTenant = TenantDescriptor.tenantWithId("tenant-second-tenant"); - testSubject.registerTenant(secondTenant); - testSubject.getTenantSegment(TenantDescriptor.tenantWithId("tenant-send-to")); - testSubject.getTenantSegment(secondTenant); - - new TenantWrappedTransactionManager( - NoTransactionManager.INSTANCE, secondTenant - ).fetchInTransaction(() -> testSubject.contains("id")); - - verify(deadLetterQueues.get(0), times(0)).contains("id"); - verify(deadLetterQueues.get(1), times(1)).contains("id"); - } - - @Test - void containsAllTenants() { - TenantDescriptor secondTenant = TenantDescriptor.tenantWithId("tenant-second-tenant"); - testSubject.registerTenant(secondTenant); - testSubject.getTenantSegment(TenantDescriptor.tenantWithId("tenant-send-to")); - testSubject.getTenantSegment(secondTenant); - - testSubject.contains("id"); - deadLetterQueues.forEach(q -> verify(q, times(1)).contains("id")); - } - - @Test - void deadLetterSequenceSingleTenant() { - TenantDescriptor secondTenant = TenantDescriptor.tenantWithId("tenant-second-tenant"); - testSubject.registerTenant(secondTenant); - testSubject.getTenantSegment(TenantDescriptor.tenantWithId("tenant-send-to")); - testSubject.getTenantSegment(secondTenant); - - new TenantWrappedTransactionManager( - NoTransactionManager.INSTANCE, secondTenant - ).fetchInTransaction(() -> testSubject.deadLetterSequence("id")); - - verify(deadLetterQueues.get(0), times(0)).deadLetterSequence("id"); - verify(deadLetterQueues.get(1), times(1)).deadLetterSequence("id"); - } - - @Test - void deadLetterSequenceAllTenants() { - TenantDescriptor secondTenant = TenantDescriptor.tenantWithId("tenant-second-tenant"); - testSubject.registerTenant(secondTenant); - testSubject.getTenantSegment(TenantDescriptor.tenantWithId("tenant-send-to")); - testSubject.getTenantSegment(secondTenant); - - deadLetterQueues.forEach(q -> when(q.contains(any())).thenReturn(true)); - testSubject.deadLetterSequence("id"); - deadLetterQueues.forEach(q -> { - verify(q, times(1)).contains("id"); - verify(q, times(1)).deadLetterSequence("id"); - }); - } - - @Test - void deadLettersSingleTenant() { - TenantDescriptor secondTenant = TenantDescriptor.tenantWithId("tenant-second-tenant"); - testSubject.registerTenant(secondTenant); - testSubject.getTenantSegment(TenantDescriptor.tenantWithId("tenant-send-to")); - testSubject.getTenantSegment(secondTenant); - - new TenantWrappedTransactionManager( - NoTransactionManager.INSTANCE, secondTenant - ).fetchInTransaction(() -> testSubject.deadLetters()); - - verify(deadLetterQueues.get(0), times(0)).deadLetters(); - verify(deadLetterQueues.get(1), times(1)).deadLetters(); - } - - @Test - void deadLettersAllTenants() { - TenantDescriptor secondTenant = TenantDescriptor.tenantWithId("tenant-second-tenant"); - testSubject.registerTenant(secondTenant); - testSubject.getTenantSegment(TenantDescriptor.tenantWithId("tenant-send-to")); - testSubject.getTenantSegment(secondTenant); - - testSubject.deadLetters(); - - deadLetterQueues.forEach(q -> verify(q, times(1)).deadLetters()); - } - - @Test - void isFullSingleTenant() { - TenantDescriptor secondTenant = TenantDescriptor.tenantWithId("tenant-second-tenant"); - testSubject.registerTenant(secondTenant); - testSubject.getTenantSegment(TenantDescriptor.tenantWithId("tenant-send-to")); - testSubject.getTenantSegment(secondTenant); - - new TenantWrappedTransactionManager( - NoTransactionManager.INSTANCE, secondTenant - ).fetchInTransaction(() -> testSubject.isFull("id")); - - verify(deadLetterQueues.get(0), times(0)).isFull("id"); - verify(deadLetterQueues.get(1), times(1)).isFull("id"); - } - - @Test - void isFullAllTenants() { - deadLetterQueues.forEach(q -> when(q.isFull(any())).thenReturn(false)); - - TenantDescriptor secondTenant = TenantDescriptor.tenantWithId("tenant-second-tenant"); - testSubject.registerTenant(secondTenant); - testSubject.getTenantSegment(TenantDescriptor.tenantWithId("tenant-send-to")); - testSubject.getTenantSegment(secondTenant); - - testSubject.isFull("id"); - - deadLetterQueues.forEach(q -> verify(q, times(1)).isFull("id")); - } - - @Test - void sizeSingleTenant() { - TenantDescriptor secondTenant = TenantDescriptor.tenantWithId("tenant-second-tenant"); - testSubject.registerTenant(secondTenant); - testSubject.getTenantSegment(TenantDescriptor.tenantWithId("tenant-send-to")); - testSubject.getTenantSegment(secondTenant); - - new TenantWrappedTransactionManager( - NoTransactionManager.INSTANCE, secondTenant - ).fetchInTransaction(() -> testSubject.size()); - - verify(deadLetterQueues.get(0), times(0)).size(); - verify(deadLetterQueues.get(1), times(1)).size(); - } - - @Test - void sizeAllTenants() { - TenantDescriptor secondTenant = TenantDescriptor.tenantWithId("tenant-second-tenant"); - testSubject.registerTenant(secondTenant); - testSubject.getTenantSegment(TenantDescriptor.tenantWithId("tenant-send-to")); - testSubject.getTenantSegment(secondTenant); - - deadLetterQueues.forEach(q -> when(q.size()).thenReturn(10L)); - assertEquals(20, testSubject.size()); - - deadLetterQueues.forEach(q -> verify(q, times(1)).size()); - } - - @Test - void sequenceSizeSingleTenant() { - TenantDescriptor secondTenant = TenantDescriptor.tenantWithId("tenant-second-tenant"); - testSubject.registerTenant(secondTenant); - testSubject.getTenantSegment(TenantDescriptor.tenantWithId("tenant-send-to")); - testSubject.getTenantSegment(secondTenant); - - new TenantWrappedTransactionManager( - NoTransactionManager.INSTANCE, secondTenant - ).fetchInTransaction(() -> testSubject.sequenceSize("id")); - - verify(deadLetterQueues.get(0), times(0)).sequenceSize("id"); - verify(deadLetterQueues.get(1), times(1)).sequenceSize("id"); - } - - @Test - void sequenceSizeAllTenants() { - TenantDescriptor secondTenant = TenantDescriptor.tenantWithId("tenant-second-tenant"); - testSubject.registerTenant(secondTenant); - testSubject.getTenantSegment(TenantDescriptor.tenantWithId("tenant-send-to")); - testSubject.getTenantSegment(secondTenant); - - deadLetterQueues.forEach(q -> when(q.contains("id")).thenReturn(true)); - deadLetterQueues.forEach(q -> when(q.sequenceSize("id")).thenReturn(10L)); - assertEquals(10, testSubject.sequenceSize("id")); //finds first tenant with sequence - - deadLetterQueues.stream().findFirst().ifPresent(q -> verify(q, times(1)).sequenceSize("id")); - } - - @Test - void amountOfSequencesSingleTenant() { - TenantDescriptor secondTenant = TenantDescriptor.tenantWithId("tenant-second-tenant"); - testSubject.registerTenant(secondTenant); - testSubject.getTenantSegment(TenantDescriptor.tenantWithId("tenant-send-to")); - testSubject.getTenantSegment(secondTenant); - - new TenantWrappedTransactionManager( - NoTransactionManager.INSTANCE, secondTenant - ).fetchInTransaction(() -> testSubject.amountOfSequences()); - - - verify(deadLetterQueues.get(0), times(0)).amountOfSequences(); - verify(deadLetterQueues.get(1), times(1)).amountOfSequences(); - } - - @Test - void amountOfSequencesAllTenant() { - TenantDescriptor secondTenant = TenantDescriptor.tenantWithId("tenant-second-tenant"); - testSubject.registerTenant(secondTenant); - testSubject.getTenantSegment(TenantDescriptor.tenantWithId("tenant-send-to")); - testSubject.getTenantSegment(secondTenant); - - deadLetterQueues.forEach(q -> when(q.amountOfSequences()).thenReturn(10L)); - assertEquals(20, testSubject.amountOfSequences()); - - deadLetterQueues.forEach(q -> verify(q, times(1)).amountOfSequences()); - } - - @Test - void processSingleTenant() { - TenantDescriptor secondTenant = TenantDescriptor.tenantWithId("tenant-second-tenant"); - testSubject.registerTenant(secondTenant); - testSubject.getTenantSegment(TenantDescriptor.tenantWithId("tenant-send-to")); - testSubject.getTenantSegment(secondTenant); - - new TenantWrappedTransactionManager( - NoTransactionManager.INSTANCE, secondTenant - ).fetchInTransaction(() -> testSubject.process(m -> true, (d) -> Decisions.evict())); - - verify(deadLetterQueues.get(0), times(0)).process(any(), any()); - verify(deadLetterQueues.get(1), times(1)).process(any(), any()); - } - - @Test - void processSingleAllTenants() { - TenantDescriptor secondTenant = TenantDescriptor.tenantWithId("tenant-second-tenant"); - testSubject.registerTenant(secondTenant); - testSubject.getTenantSegment(TenantDescriptor.tenantWithId("tenant-send-to")); - testSubject.getTenantSegment(secondTenant); - - deadLetterQueues.forEach(q -> when(q.process(any(), any())).thenReturn(true)); - assertTrue(testSubject.process(m -> true, (d) -> Decisions.evict())); - - deadLetterQueues.forEach(q -> verify(q, times(1)).process(any(), any())); - } - - @Test - void clearSingleTenant() { - TenantDescriptor secondTenant = TenantDescriptor.tenantWithId("tenant-second-tenant"); - testSubject.registerTenant(secondTenant); - testSubject.getTenantSegment(TenantDescriptor.tenantWithId("tenant-send-to")); - testSubject.getTenantSegment(secondTenant); - - new TenantWrappedTransactionManager(NoTransactionManager.INSTANCE, secondTenant).fetchInTransaction(() -> { - testSubject.clear(); - return null; - }); - - verify(deadLetterQueues.get(0), times(0)).clear(); - verify(deadLetterQueues.get(1), times(1)).clear(); - } - - @Test - void clearAllTenants() { - TenantDescriptor secondTenant = TenantDescriptor.tenantWithId("tenant-second-tenant"); - testSubject.registerTenant(secondTenant); - testSubject.getTenantSegment(TenantDescriptor.tenantWithId("tenant-send-to")); - testSubject.getTenantSegment(secondTenant); - - deadLetterQueues.forEach(q -> doNothing().when(q).clear()); - testSubject.clear(); - - deadLetterQueues.forEach(q -> verify(q, times(1)).clear()); - } -} \ No newline at end of file diff --git a/multitenancy/src/test/java/org/axonframework/extensions/multitenancy/components/eventhandeling/MultiTenantEventProcessorTest.java b/multitenancy/src/test/java/org/axonframework/extensions/multitenancy/components/eventhandeling/MultiTenantEventProcessorTest.java deleted file mode 100644 index 236ed4c..0000000 --- a/multitenancy/src/test/java/org/axonframework/extensions/multitenancy/components/eventhandeling/MultiTenantEventProcessorTest.java +++ /dev/null @@ -1,112 +0,0 @@ -/* - * Copyright (c) 2010-2023. Axon Framework - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -package org.axonframework.extensions.multitenancy.components.eventhandeling; - -import org.axonframework.common.Registration; -import org.axonframework.eventhandling.EventMessage; -import org.axonframework.eventhandling.StreamingEventProcessor; -import org.axonframework.eventhandling.SubscribingEventProcessor; -import org.axonframework.extensions.multitenancy.components.TenantDescriptor; -import org.axonframework.messaging.MessageHandlerInterceptor; -import org.junit.jupiter.api.*; - -import static org.junit.jupiter.api.Assertions.*; -import static org.mockito.Mockito.*; - -/** - * Test class validating the {@link MultiTenantEventProcessor}. - * - * @author Stefan Dragisic - */ -@SuppressWarnings("resource") -class MultiTenantEventProcessorTest { - - private StreamingEventProcessor fixtureSegment1; - private SubscribingEventProcessor fixtureSegment2; - - private MultiTenantEventProcessor testSubject; - - @BeforeEach - void setUp() { - fixtureSegment1 = mock(StreamingEventProcessor.class); - fixtureSegment2 = mock(SubscribingEventProcessor.class); - - TenantEventProcessorSegmentFactory tenantEventProcessorSegmentFactory = t -> { - if (t.tenantId().equals("fixtureTenant1")) { - return fixtureSegment1; - } else { - return fixtureSegment2; - } - }; - - testSubject = MultiTenantEventProcessor.builder() - .name("testSubject") - .tenantSegmentFactory(tenantEventProcessorSegmentFactory) - .build(); - } - - @Test - void registerTenant() { - testSubject.registerTenant(TenantDescriptor.tenantWithId("fixtureTenant1")); - assertTrue(testSubject.tenantEventProcessors().contains(fixtureSegment1)); - } - - @Test - void registerAndStartTenant() { - doNothing().when(fixtureSegment1).start(); - testSubject.registerHandlerInterceptor((unitOfWork, interceptorChain) -> interceptorChain.proceed()); - testSubject.registerAndStartTenant(TenantDescriptor.tenantWithId("fixtureTenant1")); - assertTrue(testSubject.tenantEventProcessors().contains(fixtureSegment1)); - verify(fixtureSegment1, times(1)).start(); - } - - @Test - void stopAndRemoveTenant() { - doNothing().when(fixtureSegment1).shutDown(); - when(fixtureSegment1.registerHandlerInterceptor(any())).thenReturn(() -> true); - testSubject.registerAndStartTenant(TenantDescriptor.tenantWithId("fixtureTenant1")); - testSubject.registerHandlerInterceptor((unitOfWork, interceptorChain) -> interceptorChain.proceed()); - testSubject.stopAndRemoveTenant(TenantDescriptor.tenantWithId("fixtureTenant1")); - assertTrue(testSubject.tenantEventProcessors().isEmpty()); - verify(fixtureSegment1, times(1)).shutDown(); - } - - @Test - void registerHandlerInterceptor() { - when(fixtureSegment1.registerHandlerInterceptor(any())).thenReturn(() -> true); - MessageHandlerInterceptor> messageHandlerInterceptor = (m, chain) -> chain.proceed(); - testSubject.registerAndStartTenant(TenantDescriptor.tenantWithId("fixtureTenant1")); - Registration registration = testSubject.registerHandlerInterceptor(messageHandlerInterceptor); - - assertTrue(registration.cancel()); - } - - @Test - void startAndShutDown() { - when(fixtureSegment1.isRunning()).thenReturn(true); - testSubject.registerTenant(TenantDescriptor.tenantWithId("fixtureTenant1")); - assertTrue(testSubject.tenantEventProcessors().contains(fixtureSegment1)); - testSubject.start(); - assertTrue(testSubject.isRunning()); - assertTrue(testSubject.isRunning(TenantDescriptor.tenantWithId("fixtureTenant1"))); - verify(fixtureSegment1, times(1)).start(); - - testSubject.shutDown(); - assertFalse(testSubject.isRunning()); - verify(fixtureSegment1, times(1)).shutDown(); - } -} \ No newline at end of file diff --git a/multitenancy/src/test/java/org/axonframework/extensions/multitenancy/components/eventstore/MultiTenantEventStoreTest.java b/multitenancy/src/test/java/org/axonframework/extensions/multitenancy/components/eventstore/MultiTenantEventStoreTest.java deleted file mode 100644 index 0af6c2b..0000000 --- a/multitenancy/src/test/java/org/axonframework/extensions/multitenancy/components/eventstore/MultiTenantEventStoreTest.java +++ /dev/null @@ -1,229 +0,0 @@ -/* - * Copyright (c) 2010-2023. Axon Framework - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -package org.axonframework.extensions.multitenancy.components.eventstore; - -import org.axonframework.common.Registration; -import org.axonframework.common.stream.BlockingStream; -import org.axonframework.eventhandling.DomainEventMessage; -import org.axonframework.eventhandling.EventMessage; -import org.axonframework.eventhandling.MultiSourceTrackingToken; -import org.axonframework.eventhandling.TrackedEventMessage; -import org.axonframework.eventsourcing.eventstore.DomainEventStream; -import org.axonframework.eventsourcing.eventstore.EventStore; -import org.axonframework.extensions.multitenancy.components.NoSuchTenantException; -import org.axonframework.extensions.multitenancy.components.TargetTenantResolver; -import org.axonframework.extensions.multitenancy.components.TenantDescriptor; -import org.axonframework.messaging.Message; -import org.axonframework.messaging.MessageDispatchInterceptor; -import org.axonframework.messaging.MetaData; -import org.axonframework.messaging.unitofwork.CurrentUnitOfWork; -import org.axonframework.messaging.unitofwork.DefaultUnitOfWork; -import org.axonframework.messaging.unitofwork.UnitOfWork; -import org.junit.jupiter.api.*; - -import java.util.Arrays; -import java.util.List; -import java.util.function.Consumer; - -import static org.junit.jupiter.api.Assertions.*; -import static org.mockito.Mockito.*; - -/** - * Test class validating the {@link MultiTenantEventStore}. - * - * @author Stefan Dragisic - */ -@SuppressWarnings("resource") -class MultiTenantEventStoreTest { - - private EventStore fixtureSegment1; - private EventStore fixtureSegment2; - - private MultiTenantEventStore testSubject; - - @BeforeEach - void setUp() { - fixtureSegment1 = mock(EventStore.class); - fixtureSegment2 = mock(EventStore.class); - - TenantEventSegmentFactory tenantEventSegmentFactory = t -> { - if (t.tenantId().equals("fixtureTenant1")) { - return fixtureSegment1; - } else { - return fixtureSegment2; - } - }; - TargetTenantResolver> targetTenantResolver = (m, tenants) -> TenantDescriptor.tenantWithId( - "fixtureTenant2"); - - testSubject = MultiTenantEventStore.builder() - .tenantSegmentFactory(tenantEventSegmentFactory) - .targetTenantResolver(targetTenantResolver) - .build(); - } - - @Test - void publish() { - testSubject.registerTenant(TenantDescriptor.tenantWithId("fixtureTenant1")); - testSubject.registerTenant(TenantDescriptor.tenantWithId("fixtureTenant2")); - - EventMessage event = mock(EventMessage.class); - testSubject.publish(event); - verify(fixtureSegment2).publish(event); - verify(fixtureSegment1, times(0)).publish(any(EventMessage.class)); - } - - @Test - void publishMany() { - testSubject.registerTenant(TenantDescriptor.tenantWithId("fixtureTenant1")); - testSubject.registerTenant(TenantDescriptor.tenantWithId("fixtureTenant2")); - - EventMessage event1 = mock(EventMessage.class); - EventMessage event2 = mock(EventMessage.class); - testSubject.publish(event1, event2); - verify(fixtureSegment2).publish(event1, event2); - verify(fixtureSegment1, times(0)).publish(any(), any()); - } - - @Test - void publishList() { - testSubject.registerTenant(TenantDescriptor.tenantWithId("fixtureTenant1")); - testSubject.registerTenant(TenantDescriptor.tenantWithId("fixtureTenant2")); - - EventMessage event1 = mock(EventMessage.class); - EventMessage event2 = mock(EventMessage.class); - List> eventMessages = Arrays.asList(event1, event2); - testSubject.publish(eventMessages); - verify(fixtureSegment2).publish(eventMessages); - verify(fixtureSegment1, times(0)).publish(eventMessages); - } - - @Test - void unknownTenant() { - NoSuchTenantException noSuchTenantException = assertThrows(NoSuchTenantException.class, () -> { - EventMessage event = mock(EventMessage.class); - testSubject.publish(event); - }); - assertEquals("Tenant with identifier [fixtureTenant2] is unknown", noSuchTenantException.getMessage()); - } - - @Test - void unregister() { - NoSuchTenantException noSuchTenantException = assertThrows(NoSuchTenantException.class, () -> { - EventMessage event = mock(EventMessage.class); - testSubject.registerTenant(TenantDescriptor.tenantWithId("fixtureTenant2")).cancel(); - testSubject.publish(event); - }); - assertEquals("Tenant with identifier [fixtureTenant2] is unknown", noSuchTenantException.getMessage()); - } - - @Test - void registerTenantAfterStoreHaveBeenStarted() { - when(fixtureSegment1.subscribe(any())).thenReturn(() -> true); - when(fixtureSegment2.subscribe(any())).thenReturn(() -> true); - - MessageDispatchInterceptor> messageDispatchInterceptor = messages -> (a, b) -> b; - testSubject.registerDispatchInterceptor(messageDispatchInterceptor); - testSubject.registerTenant(TenantDescriptor.tenantWithId("fixtureTenant1")); - - Consumer>> consumer = e -> { - }; - testSubject.subscribe(consumer); - testSubject.registerAndStartTenant(TenantDescriptor.tenantWithId("fixtureTenant2")); - - EventMessage event = mock(EventMessage.class); - testSubject.publish(event); - verify(fixtureSegment2).publish(event); - verify(fixtureSegment1, times(0)).publish(any(EventMessage.class)); - verify(fixtureSegment1).subscribe(consumer); - verify(fixtureSegment1).subscribe(consumer); - verify(fixtureSegment2).registerDispatchInterceptor(messageDispatchInterceptor); - } - - @Test - void registerDispatchInterceptor() { - when(fixtureSegment2.registerDispatchInterceptor(any())).thenReturn(() -> true); - MessageDispatchInterceptor> messageDispatchInterceptor = messages -> (a, b) -> b; - - testSubject.registerAndStartTenant(TenantDescriptor.tenantWithId("fixtureTenant2")); - Registration registration = testSubject.registerDispatchInterceptor(messageDispatchInterceptor); - - assertTrue(registration.cancel()); - } - - @Test - void readEvents() { - //noinspection rawtypes - UnitOfWork unitOfWork = mock(UnitOfWork.class); - EventMessage eventMessage = mock(EventMessage.class); - when(unitOfWork.getMessage()).thenReturn(eventMessage); - when(unitOfWork.getCorrelationData()).thenReturn(MetaData.emptyInstance()); - CurrentUnitOfWork.set(unitOfWork); - DomainEventStream domainEventStream = mock(DomainEventStream.class); - when(fixtureSegment2.readEvents(anyString())).thenReturn(domainEventStream); - testSubject.registerTenant(TenantDescriptor.tenantWithId("fixtureTenant2")); - testSubject.readEvents("aggregateId"); - verify(fixtureSegment2).readEvents("aggregateId"); - } - - @Test - void readEventsWithTenant() { - DomainEventStream domainEventStream = mock(DomainEventStream.class); - when(fixtureSegment2.readEvents(anyString())).thenReturn(domainEventStream); - testSubject.registerTenant(TenantDescriptor.tenantWithId("fixtureTenant2")); - testSubject.readEvents("aggregateId", TenantDescriptor.tenantWithId("fixtureTenant2")); - verify(fixtureSegment2).readEvents("aggregateId"); - } - - @Test - void storeSnapshot() { - EventMessage eventMessage = mock(EventMessage.class); - DefaultUnitOfWork.startAndGet(eventMessage); - DomainEventMessage snapshot = mock(DomainEventMessage.class); - doNothing().when(fixtureSegment2).storeSnapshot(any()); - testSubject.registerTenant(TenantDescriptor.tenantWithId("fixtureTenant2")); - testSubject.storeSnapshot(snapshot); - verify(fixtureSegment2).storeSnapshot(snapshot); - } - - @Test - void storeSnapshotWithTenant() { - DomainEventMessage snapshot = mock(DomainEventMessage.class); - doNothing().when(fixtureSegment2).storeSnapshot(any()); - testSubject.registerTenant(TenantDescriptor.tenantWithId("fixtureTenant2")); - testSubject.storeSnapshot(snapshot, TenantDescriptor.tenantWithId("fixtureTenant2")); - verify(fixtureSegment2).storeSnapshot(snapshot); - } - - @SuppressWarnings({"unchecked", "resource"}) - @Test - void openStream() { - BlockingStream> mockStream1 = mock(BlockingStream.class); - BlockingStream> mockStream2 = mock(BlockingStream.class); - when(fixtureSegment1.openStream(any())).thenReturn(mockStream1); - when(fixtureSegment2.openStream(any())).thenReturn(mockStream2); - testSubject.registerTenant(TenantDescriptor.tenantWithId("fixtureTenant1")); - testSubject.registerTenant(TenantDescriptor.tenantWithId("fixtureTenant2")); - - MultiSourceTrackingToken trackingToken = mock(MultiSourceTrackingToken.class); - BlockingStream> trackedEventMessageBlockingStream = testSubject.openStream(trackingToken); - - trackedEventMessageBlockingStream.peek(); - verify(mockStream1, times(1)).peek(); - verify(mockStream2, times(1)).peek(); - } -} \ No newline at end of file diff --git a/multitenancy/src/test/java/org/axonframework/extensions/multitenancy/components/queryhandeling/MultiTenantQueryBusTest.java b/multitenancy/src/test/java/org/axonframework/extensions/multitenancy/components/queryhandeling/MultiTenantQueryBusTest.java deleted file mode 100644 index fb510dc..0000000 --- a/multitenancy/src/test/java/org/axonframework/extensions/multitenancy/components/queryhandeling/MultiTenantQueryBusTest.java +++ /dev/null @@ -1,191 +0,0 @@ -/* - * Copyright (c) 2010-2023. Axon Framework - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -package org.axonframework.extensions.multitenancy.components.queryhandeling; - -import org.axonframework.common.Registration; -import org.axonframework.extensions.multitenancy.components.NoSuchTenantException; -import org.axonframework.extensions.multitenancy.components.TargetTenantResolver; -import org.axonframework.extensions.multitenancy.components.TenantDescriptor; -import org.axonframework.messaging.MessageDispatchInterceptor; -import org.axonframework.messaging.MessageHandler; -import org.axonframework.messaging.MessageHandlerInterceptor; -import org.axonframework.messaging.responsetypes.ResponseTypes; -import org.axonframework.queryhandling.GenericQueryMessage; -import org.axonframework.queryhandling.GenericStreamingQueryMessage; -import org.axonframework.queryhandling.GenericSubscriptionQueryMessage; -import org.axonframework.queryhandling.QueryBus; -import org.axonframework.queryhandling.QueryMessage; -import org.axonframework.queryhandling.SimpleQueryBus; -import org.axonframework.queryhandling.StreamingQueryMessage; -import org.axonframework.queryhandling.SubscriptionQueryMessage; -import org.junit.jupiter.api.*; - -import java.util.List; -import java.util.concurrent.TimeUnit; - -import static org.axonframework.messaging.responsetypes.ResponseTypes.instanceOf; -import static org.junit.jupiter.api.Assertions.*; -import static org.mockito.Mockito.*; - -/** - * Test class validating the {@link MultiTenantQueryBus}. - * - * @author Stefan Dragisic - */ -@SuppressWarnings("resource") -class MultiTenantQueryBusTest { - - private QueryBus fixtureSegment1; - private QueryBus fixtureSegment2; - - private MultiTenantQueryBus testSubject; - - @BeforeEach - void setUp() { - fixtureSegment1 = mock(SimpleQueryBus.class); - fixtureSegment2 = mock(SimpleQueryBus.class); - - TenantQuerySegmentFactory tenantQuerySegmentFactory = t -> { - if (t.tenantId().equals("fixtureTenant1")) { - return fixtureSegment1; - } else { - return fixtureSegment2; - } - }; - TargetTenantResolver> targetTenantResolver = (m, tenants) -> TenantDescriptor.tenantWithId( - "fixtureTenant2"); - - testSubject = MultiTenantQueryBus.builder() - .tenantSegmentFactory(tenantQuerySegmentFactory) - .targetTenantResolver(targetTenantResolver) - .build(); - } - - @Test - void query() { - testSubject.registerTenant(TenantDescriptor.tenantWithId("fixtureTenant1")); - testSubject.registerTenant(TenantDescriptor.tenantWithId("fixtureTenant2")); - - QueryMessage query = new GenericQueryMessage<>("Hello, World", instanceOf(String.class)); - testSubject.query(query); - verify(fixtureSegment2).query(query); - verify(fixtureSegment1, times(0)).query(any()); - } - - @Test - void scatterGather() { - testSubject.registerTenant(TenantDescriptor.tenantWithId("fixtureTenant1")); - testSubject.registerTenant(TenantDescriptor.tenantWithId("fixtureTenant2")); - - QueryMessage query = new GenericQueryMessage<>("Hello, World", instanceOf(String.class)); - testSubject.scatterGather(query, 1000, TimeUnit.MILLISECONDS); - verify(fixtureSegment2).scatterGather(query, 1000, TimeUnit.MILLISECONDS); - verify(fixtureSegment1, times(0)).scatterGather(any(), anyLong(), any()); - } - - @Test - void streamingQuery() { - testSubject.registerTenant(TenantDescriptor.tenantWithId("fixtureTenant1")); - testSubject.registerTenant(TenantDescriptor.tenantWithId("fixtureTenant2")); - - StreamingQueryMessage query = new GenericStreamingQueryMessage<>("Hello, World", String.class); - testSubject.streamingQuery(query); - verify(fixtureSegment2).streamingQuery(query); - verify(fixtureSegment1, times(0)).streamingQuery(any()); - } - - @Test - void subscriptionQuery() { - testSubject.registerTenant(TenantDescriptor.tenantWithId("fixtureTenant1")); - testSubject.registerTenant(TenantDescriptor.tenantWithId("fixtureTenant2")); - - SubscriptionQueryMessage, String> queryMessage = new GenericSubscriptionQueryMessage<>( - "TEST_PAYLOAD", - "queryName", - ResponseTypes.multipleInstancesOf(String.class), - ResponseTypes.instanceOf(String.class) - ); - - testSubject.subscriptionQuery(queryMessage); - testSubject.subscriptionQuery(queryMessage, 1); - verify(fixtureSegment2).subscriptionQuery(queryMessage); - verify(fixtureSegment2).subscriptionQuery(queryMessage, 1); - verify(fixtureSegment1, times(0)).subscriptionQuery(any()); - verify(fixtureSegment1, times(0)).subscriptionQuery(any(), anyInt()); - } - - @Test - void registerTenantAfterCommandBusHaveBeenStarted() { - when(fixtureSegment1.subscribe(anyString(), any(), any())).thenReturn(() -> true); - when(fixtureSegment2.subscribe(anyString(), any(), any())).thenReturn(() -> true); - - MessageHandlerInterceptor> messageHandlerInterceptor = (m, chain) -> chain.proceed(); - testSubject.registerHandlerInterceptor(messageHandlerInterceptor); - - MessageDispatchInterceptor> messageDispatchInterceptor = messages -> (a, b) -> b; - testSubject.registerDispatchInterceptor(messageDispatchInterceptor); - - testSubject.registerTenant(TenantDescriptor.tenantWithId("fixtureTenant1")); - - MessageHandler> queryHandler = q -> null; - testSubject.subscribe("query", String.class, queryHandler); - - testSubject.registerAndStartTenant(TenantDescriptor.tenantWithId("fixtureTenant2")); - - QueryMessage query = new GenericQueryMessage<>("Hello, World", instanceOf(String.class)); - testSubject.query(query); - verify(fixtureSegment2).query(query); - verify(fixtureSegment1, times(0)).query(any()); - - verify(fixtureSegment1).subscribe("query", String.class, queryHandler); - verify(fixtureSegment2).registerHandlerInterceptor(messageHandlerInterceptor); - - verify(fixtureSegment1).subscribe(any(), any(), any()); - verify(fixtureSegment2).registerDispatchInterceptor(messageDispatchInterceptor); - } - - @Test - void unregister() { - NoSuchTenantException noSuchTenantException = assertThrows(NoSuchTenantException.class, () -> { - QueryMessage query = new GenericQueryMessage<>("Hello, World", instanceOf(String.class)); - testSubject.registerTenant(TenantDescriptor.tenantWithId("fixtureTenant2")).cancel(); - testSubject.query(query); - }); - assertEquals("Tenant with identifier [fixtureTenant2] is unknown", noSuchTenantException.getMessage()); - } - - - @Test - void registerDispatchInterceptor() { - when(fixtureSegment2.registerDispatchInterceptor(any())).thenReturn(() -> true); - MessageDispatchInterceptor> messageDispatchInterceptor = messages -> (a, b) -> b; - testSubject.registerAndStartTenant(TenantDescriptor.tenantWithId("fixtureTenant2")); - Registration registration = testSubject.registerDispatchInterceptor(messageDispatchInterceptor); - - assertTrue(registration.cancel()); - } - - @Test - void registerHandlerInterceptor() { - when(fixtureSegment2.registerHandlerInterceptor(any())).thenReturn(() -> true); - MessageHandlerInterceptor> messageHandlerInterceptor = (m, chain) -> chain.proceed(); - testSubject.registerAndStartTenant(TenantDescriptor.tenantWithId("fixtureTenant2")); - Registration registration = testSubject.registerHandlerInterceptor(messageHandlerInterceptor); - - assertTrue(registration.cancel()); - } -} \ No newline at end of file diff --git a/multitenancy/src/test/java/org/axonframework/extensions/multitenancy/components/queryhandeling/MultiTenantQueryUpdateEmitterTest.java b/multitenancy/src/test/java/org/axonframework/extensions/multitenancy/components/queryhandeling/MultiTenantQueryUpdateEmitterTest.java deleted file mode 100644 index db8ddcd..0000000 --- a/multitenancy/src/test/java/org/axonframework/extensions/multitenancy/components/queryhandeling/MultiTenantQueryUpdateEmitterTest.java +++ /dev/null @@ -1,164 +0,0 @@ -/* - * Copyright (c) 2010-2023. Axon Framework - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -package org.axonframework.extensions.multitenancy.components.queryhandeling; - -import org.axonframework.common.Registration; -import org.axonframework.extensions.multitenancy.components.NoSuchTenantException; -import org.axonframework.extensions.multitenancy.components.TargetTenantResolver; -import org.axonframework.extensions.multitenancy.components.TenantDescriptor; -import org.axonframework.messaging.Message; -import org.axonframework.messaging.MessageDispatchInterceptor; -import org.axonframework.messaging.unitofwork.CurrentUnitOfWork; -import org.axonframework.messaging.unitofwork.UnitOfWork; -import org.axonframework.queryhandling.GenericSubscriptionQueryUpdateMessage; -import org.axonframework.queryhandling.QueryUpdateEmitter; -import org.axonframework.queryhandling.SubscriptionQueryMessage; -import org.axonframework.queryhandling.SubscriptionQueryUpdateMessage; -import org.junit.jupiter.api.*; - -import java.util.function.Predicate; - -import static org.junit.jupiter.api.Assertions.*; -import static org.mockito.ArgumentMatchers.*; -import static org.mockito.Mockito.*; - -/** - * Test class validating the {@link MultiTenantQueryUpdateEmitter}. - * - * @author Stefan Dragisic - */ -@SuppressWarnings("resource") -class MultiTenantQueryUpdateEmitterTest { - - private QueryUpdateEmitter fixtureSegment1; - private QueryUpdateEmitter fixtureSegment2; - - private MultiTenantQueryUpdateEmitter testSubject; - - @BeforeEach - void setUp() { - fixtureSegment1 = mock(QueryUpdateEmitter.class); - fixtureSegment2 = mock(QueryUpdateEmitter.class); - - TenantQueryUpdateEmitterSegmentFactory tenantQueryUpdateEmitterSegmentFactory = t -> { - if (t.tenantId().equals("fixtureTenant1")) { - return fixtureSegment1; - } else { - return fixtureSegment2; - } - }; - TargetTenantResolver> targetTenantResolver = (m, tenants) -> TenantDescriptor.tenantWithId( - "fixtureTenant2"); - - testSubject = MultiTenantQueryUpdateEmitter.builder() - .tenantSegmentFactory(tenantQueryUpdateEmitterSegmentFactory) - .targetTenantResolver(targetTenantResolver) - .build(); - } - - @Test - void emit() { - testSubject.registerTenant(TenantDescriptor.tenantWithId("fixtureTenant1")); - testSubject.registerTenant(TenantDescriptor.tenantWithId("fixtureTenant2")); - - Predicate>> filter = - m -> true; - - Predicate predicate = - p -> true; - - SubscriptionQueryUpdateMessage testSubscriptionQueryUpdateMessage = - GenericSubscriptionQueryUpdateMessage.asUpdateMessage("TEST_QUERY_UPDATE"); - testSubject.emit(filter, testSubscriptionQueryUpdateMessage); - - verify(fixtureSegment2).emit(filter, testSubscriptionQueryUpdateMessage); - verify(fixtureSegment1, times(0)).emit(filter, testSubscriptionQueryUpdateMessage); - - //noinspection unchecked - UnitOfWork> mockUnitOfWork = mock(UnitOfWork.class); - when(mockUnitOfWork.getMessage()).thenReturn(testSubscriptionQueryUpdateMessage); - CurrentUnitOfWork.set(mockUnitOfWork); - - testSubject.emit(String.class, predicate, "update"); - verify(fixtureSegment2).emit(String.class, predicate, "update"); - verify(fixtureSegment1, times(0)).emit(String.class, predicate, "update"); - - testSubject.emit(String.class, predicate, testSubscriptionQueryUpdateMessage); - verify(fixtureSegment2).emit(String.class, predicate, testSubscriptionQueryUpdateMessage); - verify(fixtureSegment1, times(0)).emit(String.class, predicate, testSubscriptionQueryUpdateMessage); - - testSubject.emit(m -> true, "update"); - verify(fixtureSegment2).emit(any(), eq("update")); - verify(fixtureSegment1, times(0)).emit(any(), anyString()); - } - - @Test - void unknownTenant() { - SubscriptionQueryMessage msg = mock(SubscriptionQueryMessage.class); - - NoSuchTenantException noSuchTenantException = - assertThrows(NoSuchTenantException.class, () -> testSubject.emit(String.class, p -> true, msg)); - assertEquals("Tenant with identifier [fixtureTenant2] is unknown", noSuchTenantException.getMessage()); - } - - @Test - void unregister() { - SubscriptionQueryMessage msg = mock(SubscriptionQueryMessage.class); - NoSuchTenantException noSuchTenantException = assertThrows(NoSuchTenantException.class, () -> { - testSubject.registerTenant(TenantDescriptor.tenantWithId("fixtureTenant2")).cancel(); - testSubject.emit(String.class, p -> true, msg); - }); - assertEquals("Tenant with identifier [fixtureTenant2] is unknown", noSuchTenantException.getMessage()); - } - - @Test - void getTenant() { - testSubject.registerTenant(TenantDescriptor.tenantWithId("fixtureTenant1")); - QueryUpdateEmitter tenant = testSubject.getTenant(TenantDescriptor.tenantWithId("fixtureTenant1")); - assertEquals(fixtureSegment1, tenant); - } - - @Test - void registerDispatchInterceptor() { - when(fixtureSegment2.registerDispatchInterceptor(any())).thenReturn(() -> true); - MessageDispatchInterceptor> messageDispatchInterceptor = messages -> (a, b) -> b; - testSubject.registerTenant(TenantDescriptor.tenantWithId("fixtureTenant2")); - Registration registration = testSubject.registerDispatchInterceptor(messageDispatchInterceptor); - - assertTrue(registration.cancel()); - } - - @Test - void unregisterTenant() { - when(fixtureSegment2.registerDispatchInterceptor(any())).thenReturn(() -> true); - MessageDispatchInterceptor> messageDispatchInterceptor = messages -> (a, b) -> b; - Registration registration = testSubject.registerTenant(TenantDescriptor.tenantWithId("fixtureTenant2")); - testSubject.registerDispatchInterceptor(messageDispatchInterceptor); - - assertTrue(registration.cancel()); - } - - @Test - void completeUnsupported() { - assertThrows(UnsupportedOperationException.class, () -> testSubject.complete(p -> true)); - assertThrows(UnsupportedOperationException.class, () -> testSubject.complete(String.class, p -> true)); - assertThrows(UnsupportedOperationException.class, - () -> testSubject.completeExceptionally(p -> true, new RuntimeException())); - assertThrows(UnsupportedOperationException.class, - () -> testSubject.completeExceptionally(String.class, p -> true, new RuntimeException())); - } -} \ No newline at end of file diff --git a/multitenancy/src/test/java/org/axonframework/extensions/multitenancy/components/scheduling/MultiTenantEventSchedulerTest.java b/multitenancy/src/test/java/org/axonframework/extensions/multitenancy/components/scheduling/MultiTenantEventSchedulerTest.java deleted file mode 100644 index c26fc75..0000000 --- a/multitenancy/src/test/java/org/axonframework/extensions/multitenancy/components/scheduling/MultiTenantEventSchedulerTest.java +++ /dev/null @@ -1,192 +0,0 @@ -/* - * Copyright (c) 2010-2023. Axon Framework - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -package org.axonframework.extensions.multitenancy.components.scheduling; - -import org.axonframework.common.Registration; -import org.axonframework.common.transaction.NoTransactionManager; -import org.axonframework.eventhandling.EventMessage; -import org.axonframework.eventhandling.GenericEventMessage; -import org.axonframework.eventhandling.scheduling.EventScheduler; -import org.axonframework.eventhandling.scheduling.ScheduleToken; -import org.axonframework.extensions.multitenancy.TenantWrappedTransactionManager; -import org.axonframework.extensions.multitenancy.components.NoSuchTenantException; -import org.axonframework.extensions.multitenancy.components.TargetTenantResolver; -import org.axonframework.extensions.multitenancy.components.TenantDescriptor; -import org.junit.jupiter.api.*; - -import java.time.Duration; -import java.time.Instant; - -import static org.junit.jupiter.api.Assertions.*; -import static org.mockito.Mockito.*; - -/** - * Test class validating the {@link MultiTenantEventScheduler}. - * - * @author Stefan Dragisic - */ -@SuppressWarnings("resource") -class MultiTenantEventSchedulerTest { - - private EventScheduler fixtureSegment1; - private EventScheduler fixtureSegment2; - - private MultiTenantEventScheduler testSubject; - - @BeforeEach - void setUp() { - fixtureSegment1 = mock(EventScheduler.class); - fixtureSegment2 = mock(EventScheduler.class); - - TenantEventSchedulerSegmentFactory tenantSegmentFactory = t -> { - if (t.tenantId().equals("fixtureTenant1")) { - return fixtureSegment1; - } else { - return fixtureSegment2; - } - }; - TargetTenantResolver> targetTenantResolver = - (m, tenants) -> TenantDescriptor.tenantWithId("fixtureTenant2"); - - testSubject = MultiTenantEventScheduler.builder() - .tenantSegmentFactory(tenantSegmentFactory) - .targetTenantResolver(targetTenantResolver) - .build(); - } - - @Test - void scheduleWithInstantAndTenantMetaData() { - testSubject.registerTenant(TenantDescriptor.tenantWithId("fixtureTenant1")); - testSubject.registerTenant(TenantDescriptor.tenantWithId("fixtureTenant2")); - - EventMessage event = GenericEventMessage.asEventMessage("event"); - Instant instant = Instant.MAX; - testSubject.schedule(instant, event); - verify(fixtureSegment2).schedule(instant, event); - verify(fixtureSegment1, times(0)).schedule(any(Instant.class), any()); - } - - - @Test - void scheduleWithDurationAndTenantMetaData() { - testSubject.registerTenant(TenantDescriptor.tenantWithId("fixtureTenant1")); - testSubject.registerTenant(TenantDescriptor.tenantWithId("fixtureTenant2")); - - EventMessage event = GenericEventMessage.asEventMessage("event"); - Duration duration = Duration.ZERO; - testSubject.schedule(duration, event); - verify(fixtureSegment2).schedule(duration, event); - verify(fixtureSegment1, times(0)).schedule(any(Duration.class), any()); - } - - @Test - void scheduleNonEventMessageThrowsIllegalArgumentException() { - assertThrowsExactly(IllegalArgumentException.class, () -> testSubject.schedule(Instant.MAX, "event")); - } - - @Test - void scheduleEventMessageWithoutTenantDescriptorInTheMetaDataThrowsNoSuchTenantException() { - EventMessage event = GenericEventMessage.asEventMessage("event"); - - assertThrowsExactly(NoSuchTenantException.class, () -> testSubject.schedule(Instant.MAX, event)); - } - - @Test - void cancelScheduleWithTenantInfo() { - testSubject.registerTenant(TenantDescriptor.tenantWithId("fixtureTenant1")); - testSubject.registerTenant(TenantDescriptor.tenantWithId("fixtureTenant2")); - - new TenantWrappedTransactionManager( - NoTransactionManager.INSTANCE, TenantDescriptor.tenantWithId("fixtureTenant2") - ).executeInTransaction(() -> testSubject.cancelSchedule(mock(ScheduleToken.class))); - - verify(fixtureSegment2).cancelSchedule(any()); - verifyNoInteractions(fixtureSegment1); - } - - @Test - void cancelScheduleNoTenantInfo() { - testSubject.registerTenant(TenantDescriptor.tenantWithId("fixtureTenant1")); - testSubject.registerTenant(TenantDescriptor.tenantWithId("fixtureTenant2")); - - doThrow(IllegalArgumentException.class).when(fixtureSegment1).cancelSchedule(any()); - doNothing().when(fixtureSegment2).cancelSchedule(any()); - - testSubject.cancelSchedule(mock(ScheduleToken.class)); - verify(fixtureSegment2).cancelSchedule(any()); - verify(fixtureSegment1).cancelSchedule(any()); - } - - @Test - void cancelScheduleOnTenantSegment() { - testSubject.registerTenant(TenantDescriptor.tenantWithId("fixtureTenant1")); - testSubject.registerTenant(TenantDescriptor.tenantWithId("fixtureTenant2")); - TenantDescriptor fixtureTenant = TenantDescriptor.tenantWithId("fixtureTenant2"); - testSubject.forTenant(fixtureTenant).cancelSchedule(mock(ScheduleToken.class)); - verify(fixtureSegment2).cancelSchedule(any()); - } - - @Test - void reschedule() { - testSubject.registerTenant(TenantDescriptor.tenantWithId("fixtureTenant1")); - testSubject.registerTenant(TenantDescriptor.tenantWithId("fixtureTenant2")); - - EventMessage event = GenericEventMessage.asEventMessage("event"); - Instant instant = Instant.MIN; - ScheduleToken scheduleToken = mock(ScheduleToken.class); - testSubject.reschedule(scheduleToken, instant, event); - verify(fixtureSegment2).reschedule(scheduleToken, instant, event); - verify(fixtureSegment1, times(0)).reschedule(scheduleToken, instant, event); - } - - @Test - void rescheduleDuration() { - testSubject.registerTenant(TenantDescriptor.tenantWithId("fixtureTenant1")); - testSubject.registerTenant(TenantDescriptor.tenantWithId("fixtureTenant2")); - - EventMessage event = GenericEventMessage.asEventMessage("event"); - Duration duration = Duration.ZERO; - ScheduleToken scheduleToken = mock(ScheduleToken.class); - testSubject.reschedule(scheduleToken, duration, event); - verify(fixtureSegment2).reschedule(scheduleToken, duration, event); - verify(fixtureSegment1, times(0)).reschedule(scheduleToken, duration, event); - } - - @Test - void shutdownAll() { - testSubject.registerTenant(TenantDescriptor.tenantWithId("fixtureTenant1")); - testSubject.registerTenant(TenantDescriptor.tenantWithId("fixtureTenant2")); - - doNothing().when(fixtureSegment1).shutdown(); - doNothing().when(fixtureSegment2).shutdown(); - - testSubject.shutdown(); - - verify(fixtureSegment1).shutdown(); - verify(fixtureSegment2).shutdown(); - } - - @Test - void registerUnregisterTenant() { - TenantDescriptor tenantDescriptor = TenantDescriptor.tenantWithId("fixtureTenant1"); - Registration registeredTenant = testSubject.registerTenant(tenantDescriptor); - assertNotNull(testSubject.forTenant(tenantDescriptor)); - - registeredTenant.cancel(); - assertNull(testSubject.forTenant(tenantDescriptor)); - } -} \ No newline at end of file diff --git a/multitenancy/src/test/java/org/axonframework/extensions/multitenancy/configuration/MultiTenantEventProcessingModuleTest.java b/multitenancy/src/test/java/org/axonframework/extensions/multitenancy/configuration/MultiTenantEventProcessingModuleTest.java deleted file mode 100644 index 7ee9cba..0000000 --- a/multitenancy/src/test/java/org/axonframework/extensions/multitenancy/configuration/MultiTenantEventProcessingModuleTest.java +++ /dev/null @@ -1,513 +0,0 @@ -/* - * Copyright (c) 2010-2024. Axon Framework - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -package org.axonframework.extensions.multitenancy.configuration; - -import org.axonframework.config.Configuration; -import org.axonframework.config.Configurer; -import org.axonframework.config.DefaultConfigurer; -import org.axonframework.eventhandling.*; -import org.axonframework.eventhandling.pooled.PooledStreamingEventProcessor; -import org.axonframework.extensions.multitenancy.components.TargetTenantResolver; -import org.axonframework.extensions.multitenancy.components.TenantDescriptor; -import org.axonframework.extensions.multitenancy.components.TenantProvider; -import org.axonframework.extensions.multitenancy.components.deadletterqueue.MultiTenantDeadLetterProcessor; -import org.axonframework.extensions.multitenancy.components.deadletterqueue.MultiTenantDeadLetterQueue; -import org.axonframework.extensions.multitenancy.components.deadletterqueue.MultiTenantDeadLetterQueueFactory; -import org.axonframework.extensions.multitenancy.components.eventhandeling.MultiTenantEventProcessor; -import org.axonframework.messaging.StreamableMessageSource; -import org.axonframework.messaging.SubscribableMessageSource; -import org.axonframework.messaging.deadletter.SequencedDeadLetterProcessor; -import org.axonframework.messaging.deadletter.SequencedDeadLetterQueue; -import org.junit.jupiter.api.BeforeEach; -import org.junit.jupiter.api.Test; -import org.mockito.ArgumentCaptor; - -import java.util.Map; -import java.util.Optional; -import java.util.concurrent.ConcurrentHashMap; - -import static org.junit.jupiter.api.Assertions.assertEquals; -import static org.junit.jupiter.api.Assertions.assertTrue; -import static org.mockito.Mockito.*; - -/** - * Test class validating the {@link MultiTenantEventProcessingModule}. - * - * @author Stefan Dragisic - */ -class MultiTenantEventProcessingModuleTest { - - private Configurer configurer; - private MultiTenantEventProcessor multiTenantEventProcessor; - private MultiTenantDeadLetterQueueFactory> multiTenantDeadLetterQueueFactory; - - @BeforeEach - void setUp() { - configurer = DefaultConfigurer.defaultConfiguration(); - multiTenantEventProcessor = mock(MultiTenantEventProcessor.class); - //noinspection unchecked - multiTenantDeadLetterQueueFactory = mock(MultiTenantDeadLetterQueueFactory.class); - } - - @Test - void deadLetterQueue() { - Map>> multiTenantDeadLetterQueueMap = new ConcurrentHashMap<>(); - TenantProvider tenantProvider = mock(TenantProvider.class); - //noinspection unchecked - TargetTenantResolver> targetTenantResolver = mock(TargetTenantResolver.class); - - multiTenantDeadLetterQueueFactory = (processingGroup) -> multiTenantDeadLetterQueueMap.computeIfAbsent( - processingGroup, - (key) -> MultiTenantDeadLetterQueue.builder() - .targetTenantResolver(targetTenantResolver) - .processingGroup(processingGroup) - .build()); - - //noinspection unchecked - SequencedDeadLetterQueue> originalDeadLetterQueue = mock(SequencedDeadLetterQueue.class); - - configurer.registerModule( - new MultiTenantEventProcessingModule(tenantProvider, multiTenantDeadLetterQueueFactory) - ); - configurer.eventProcessing() - .registerDeadLetterQueue("dlq", c -> originalDeadLetterQueue); - - MultiTenantDeadLetterQueue> multiTenantDeadLetterQueue = multiTenantDeadLetterQueueMap.get("dlq"); - - multiTenantDeadLetterQueue.registerAndStartTenant(TenantDescriptor.tenantWithId("tenant1")); - multiTenantDeadLetterQueue.registerAndStartTenant(TenantDescriptor.tenantWithId("tenant2")); - - assertEquals(originalDeadLetterQueue, - multiTenantDeadLetterQueue.getTenantSegment(TenantDescriptor.tenantWithId("tenant1"))); - assertEquals(originalDeadLetterQueue, - multiTenantDeadLetterQueue.getTenantSegment(TenantDescriptor.tenantWithId("tenant2"))); - } - - @Test - void sequencedDeadLetterProcessor() { - //noinspection unchecked - TargetTenantResolver> targetTenantResolver = mock(TargetTenantResolver.class); - multiTenantDeadLetterQueueFactory = - (processingGroup) -> MultiTenantDeadLetterQueue.builder() - .targetTenantResolver(targetTenantResolver) - .processingGroup(processingGroup) - .build(); - - configurer.registerModule(new MultiTenantEventProcessingModule(mock(TenantProvider.class), - multiTenantDeadLetterQueueFactory)); - - //noinspection unchecked - configurer.eventProcessing() - .usingTrackingEventProcessors() - .registerDeadLetterQueue("java.lang", c -> mock(SequencedDeadLetterQueue.class)) - .configureDefaultStreamableMessageSource(config -> mock(StreamableMessageSource.class)) - .registerEventHandler(c -> new Object()); // --> java.lang - - Configuration configuration = configurer.start(); - - ArgumentCaptor sep = ArgumentCaptor.forClass(MultiTenantEventProcessor.class); - sep.getAllValues() - .forEach(ep -> { - ep.registerAndStartTenant(TenantDescriptor.tenantWithId("tenant1")); - ep.registerAndStartTenant(TenantDescriptor.tenantWithId("tenant2")); - } - ); - - Optional>> deadLetterProcessor = - configuration.eventProcessingConfiguration() - .sequencedDeadLetterProcessor("java.lang"); - - assertTrue(deadLetterProcessor.isPresent()); - assertTrue(deadLetterProcessor.get() instanceof MultiTenantDeadLetterProcessor); - } - - @Test - void eventProcessors() { - ConcurrentHashMap map = new ConcurrentHashMap<>(); - TenantProvider tenantProvider = mock(TenantProvider.class); - - configurer.registerModule( - new MultiTenantEventProcessingModule(tenantProvider, multiTenantDeadLetterQueueFactory) - ); - configurer.eventProcessing() - .registerEventProcessorFactory((name, config, eventHandlerInvoker) -> multiTenantEventProcessor) - .assignHandlerInstancesMatching("java.util.concurrent", "concurrent"::equals) - .registerEventHandler(c -> new Object()) // --> java.lang - .registerEventHandler(c -> "") // --> java.lang - .registerEventHandler(c -> "concurrent") // --> java.util.concurrent - .registerEventHandler(c -> map); // --> java.util.concurrent - Configuration configuration = configurer.start(); - - assertEquals(2, configuration.eventProcessingConfiguration().eventProcessors().size()); - } - - @Test - void trackingEventProcessor() { - //noinspection unchecked - StreamableMessageSource> mockedSource = mock(StreamableMessageSource.class); - TenantProvider tenantProvider = mock(TenantProvider.class); - configurer.registerModule( - new MultiTenantEventProcessingModule(tenantProvider, multiTenantDeadLetterQueueFactory) - ); - TrackingEventProcessorConfiguration testTepConfig = - TrackingEventProcessorConfiguration.forParallelProcessing(4); - configurer.eventProcessing() - .usingTrackingEventProcessors() - .configureDefaultStreamableMessageSource(config -> mockedSource) - .assignHandlerInstancesMatching("java.util.concurrent", "concurrent"::equals) - .registerEventHandler(c -> new Object()) // --> java.lang - .registerEventHandler(c -> "") // --> java.lang - .registerEventHandler(c -> "concurrent") // --> java.util.concurrent - .registerTrackingEventProcessorConfiguration("tracking", config -> testTepConfig); - Configuration configuration = configurer.start(); - - ArgumentCaptor sep = ArgumentCaptor.forClass(MultiTenantEventProcessor.class); - verify(tenantProvider, times(2)).subscribe(sep.capture()); - sep.getAllValues() - .forEach(ep -> { - ep.registerAndStartTenant(TenantDescriptor.tenantWithId("tenant1")); - ep.registerAndStartTenant(TenantDescriptor.tenantWithId("tenant2")); - } - ); - - assertEquals(6, configuration.eventProcessingConfiguration().eventProcessors().size()); - assertTrue(configuration.eventProcessingConfiguration() - .eventProcessor("java.util.concurrent", MultiTenantEventProcessor.class) - .isPresent()); - assertTrue(configuration.eventProcessingConfiguration() - .eventProcessor("java.lang", MultiTenantEventProcessor.class) - .isPresent()); - - assertTrue(configuration.eventProcessingConfiguration() - .eventProcessor("java.util.concurrent@tenant1", TrackingEventProcessor.class) - .isPresent()); - assertTrue(configuration.eventProcessingConfiguration() - .eventProcessor("java.lang@tenant1", TrackingEventProcessor.class) - .isPresent()); - - assertTrue(configuration.eventProcessingConfiguration() - .eventProcessor("java.util.concurrent@tenant2", TrackingEventProcessor.class) - .isPresent()); - assertTrue(configuration.eventProcessingConfiguration() - .eventProcessor("java.lang@tenant2", TrackingEventProcessor.class) - .isPresent()); - } - - @Test - void trackingEventProcessorNonMultiTenant() { - //noinspection unchecked - StreamableMessageSource> mockedSource = mock(StreamableMessageSource.class); - TenantProvider tenantProvider = mock(TenantProvider.class); - MultiTenantStreamableMessageSourceProvider multiTenantStreamableMessageSourceProvider = - (source, processorName, tenantDescriptor, configuration) -> source; - configurer.registerModule( - new MultiTenantEventProcessingModule(tenantProvider, multiTenantStreamableMessageSourceProvider, null, MultiTenantEventProcessorPredicate.disableMultiTenancy()) - ); - - TrackingEventProcessorConfiguration testTepConfig = - TrackingEventProcessorConfiguration.forParallelProcessing(4); - configurer.eventProcessing() - .usingTrackingEventProcessors() - .configureDefaultStreamableMessageSource(config -> mockedSource) - .assignHandlerInstancesMatching("java.util.concurrent", "concurrent"::equals) - .registerEventHandler(c -> new Object()) // --> java.lang - .registerEventHandler(c -> "") // --> java.lang - .registerEventHandler(c -> "concurrent") // --> java.util.concurrent - .registerTrackingEventProcessorConfiguration("tracking", config -> testTepConfig); - Configuration configuration = configurer.start(); - - - assertEquals(2, configuration.eventProcessingConfiguration().eventProcessors().size()); - assertTrue(configuration.eventProcessingConfiguration() - .eventProcessor("java.util.concurrent", TrackingEventProcessor.class) - .isPresent()); - assertTrue(configuration.eventProcessingConfiguration() - .eventProcessor("java.lang", TrackingEventProcessor.class) - .isPresent()); - } - - @Test - void trackingEventProcessorCustomSource() { - //noinspection unchecked - StreamableMessageSource> defaultSource = mock(StreamableMessageSource.class); - //noinspection unchecked - StreamableMessageSource> customSource = mock(StreamableMessageSource.class); - TenantProvider tenantProvider = mock(TenantProvider.class); - - MultiTenantStreamableMessageSourceProvider multiTenantStreamableMessageSourceProvider = - (source, processorName, tenantDescriptor, configuration) -> customSource; - - configurer.registerModule( - new MultiTenantEventProcessingModule(tenantProvider, multiTenantStreamableMessageSourceProvider, null, MultiTenantEventProcessorPredicate.enableMultiTenancy()) - ); - - TrackingEventProcessorConfiguration testTepConfig = - TrackingEventProcessorConfiguration.forParallelProcessing(4); - configurer.eventProcessing() - .usingTrackingEventProcessors() - .configureDefaultStreamableMessageSource(config -> defaultSource) - .assignHandlerInstancesMatching("java.util.concurrent", "concurrent"::equals) - .registerEventHandler(c -> new Object()) // --> java.lang - .registerEventHandler(c -> "") // --> java.lang - .registerEventHandler(c -> "concurrent") // --> java.util.concurrent - .registerTrackingEventProcessorConfiguration("tracking", config -> testTepConfig); - Configuration configuration = configurer.start(); - - ArgumentCaptor sep = ArgumentCaptor.forClass(MultiTenantEventProcessor.class); - verify(tenantProvider, times(2)).subscribe(sep.capture()); - sep.getAllValues() - .forEach(ep -> { - ep.registerAndStartTenant(TenantDescriptor.tenantWithId("tenant1")); - ep.registerAndStartTenant(TenantDescriptor.tenantWithId("tenant2")); - } - ); - - assertEquals(6, configuration.eventProcessingConfiguration().eventProcessors().size()); - assertTrue(configuration.eventProcessingConfiguration() - .eventProcessor("java.util.concurrent", MultiTenantEventProcessor.class) - .isPresent()); - - assertTrue(configuration.eventProcessingConfiguration() - .eventProcessor("java.lang", MultiTenantEventProcessor.class) - .isPresent()); - - assertTrue(configuration.eventProcessingConfiguration() - .eventProcessor("java.util.concurrent@tenant1", TrackingEventProcessor.class) - .isPresent()); - - assertTrue(configuration.eventProcessingConfiguration() - .eventProcessor("java.util.concurrent@tenant1", TrackingEventProcessor.class) - .map(TrackingEventProcessor::getMessageSource) - .map(it -> it.equals(customSource)) - .orElse(false)); - - assertTrue(configuration.eventProcessingConfiguration() - .eventProcessor("java.util.concurrent@tenant1", TrackingEventProcessor.class) - .map(TrackingEventProcessor::getMessageSource) - .map(it -> it.equals(customSource)) - .orElse(false)); - - assertTrue(configuration.eventProcessingConfiguration() - .eventProcessor("java.lang@tenant1", TrackingEventProcessor.class).isPresent()); - - assertTrue(configuration.eventProcessingConfiguration() - .eventProcessor("java.lang@tenant1", TrackingEventProcessor.class) - .map(TrackingEventProcessor::getMessageSource) - .map(it -> it.equals(customSource)) - .orElse(false)); - - assertTrue(configuration.eventProcessingConfiguration() - .eventProcessor("java.util.concurrent@tenant2", TrackingEventProcessor.class) - .isPresent()); - - assertTrue(configuration.eventProcessingConfiguration() - .eventProcessor("java.util.concurrent@tenant2", TrackingEventProcessor.class) - .map(TrackingEventProcessor::getMessageSource) - .map(it -> it.equals(customSource)) - .orElse(false)); - - assertTrue(configuration.eventProcessingConfiguration() - .eventProcessor("java.lang@tenant2", TrackingEventProcessor.class) - .isPresent()); - - assertTrue(configuration.eventProcessingConfiguration() - .eventProcessor("java.lang@tenant2", TrackingEventProcessor.class) - .map(TrackingEventProcessor::getMessageSource).map(it -> it.equals(customSource)) - .orElse(false)); - } - - @Test - void subscribingEventProcessor() { - //noinspection unchecked - SubscribableMessageSource> mockedSource = mock(SubscribableMessageSource.class); - TenantProvider tenantProvider = mock(TenantProvider.class); - configurer.registerModule( - new MultiTenantEventProcessingModule(tenantProvider, multiTenantDeadLetterQueueFactory) - ); - - configurer.eventProcessing() - .usingSubscribingEventProcessors() - .configureDefaultSubscribableMessageSource(config -> mockedSource) - .byDefaultAssignTo("subscribing") - .registerSubscribingEventProcessor("subscribing", config -> mockedSource) - .registerEventHandler(config -> new Object()); - Configuration configuration = configurer.start(); - - ArgumentCaptor sep = ArgumentCaptor.forClass(MultiTenantEventProcessor.class); - verify(tenantProvider).subscribe(sep.capture()); - sep.getValue().registerAndStartTenant(TenantDescriptor.tenantWithId("tenant1")); - - assertEquals(2, configuration.eventProcessingConfiguration().eventProcessors().size()); - assertTrue(configuration.eventProcessingConfiguration() - .eventProcessor("subscribing", MultiTenantEventProcessor.class) - .isPresent()); - assertTrue(configuration.eventProcessingConfiguration() - .eventProcessor("subscribing@tenant1", SubscribingEventProcessor.class) - .isPresent()); - } - - @Test - void subscribingEventProcessorNonMultiTenant() { - //noinspection unchecked - SubscribableMessageSource> mockedSource = mock(SubscribableMessageSource.class); - TenantProvider tenantProvider = mock(TenantProvider.class); - MultiTenantStreamableMessageSourceProvider multiTenantStreamableMessageSourceProvider = - (source, processorName, tenantDescriptor, configuration) -> source; - - configurer.registerModule( - new MultiTenantEventProcessingModule(tenantProvider, multiTenantStreamableMessageSourceProvider, null, MultiTenantEventProcessorPredicate.disableMultiTenancy()) - ); - - configurer.eventProcessing() - .usingSubscribingEventProcessors() - .configureDefaultSubscribableMessageSource(config -> mockedSource) - .byDefaultAssignTo("subscribing") - .registerSubscribingEventProcessor("subscribing", config -> mockedSource) - .registerEventHandler(config -> new Object()); - Configuration configuration = configurer.start(); - - assertEquals(1, configuration.eventProcessingConfiguration().eventProcessors().size()); - assertTrue(configuration.eventProcessingConfiguration() - .eventProcessor("subscribing", SubscribingEventProcessor.class) - .isPresent()); - } - - @Test - void pooledStreamingEventProcessor() { - //noinspection unchecked - StreamableMessageSource> mockedSource = mock(StreamableMessageSource.class); - TenantProvider tenantProvider = mock(TenantProvider.class); - configurer.registerModule( - new MultiTenantEventProcessingModule(tenantProvider, multiTenantDeadLetterQueueFactory) - ); - TrackingEventProcessorConfiguration testTepConfig = - TrackingEventProcessorConfiguration.forParallelProcessing(4); - configurer.eventProcessing() - .usingPooledStreamingEventProcessors() - .configureDefaultStreamableMessageSource(config -> mockedSource) - .byDefaultAssignTo("default") - .registerEventHandler(config -> new Object()) - .registerTrackingEventProcessorConfiguration("tracking", config -> testTepConfig); - Configuration configuration = configurer.start(); - - ArgumentCaptor sep = ArgumentCaptor.forClass(MultiTenantEventProcessor.class); - verify(tenantProvider).subscribe(sep.capture()); - sep.getValue().registerAndStartTenant(TenantDescriptor.tenantWithId("tenant1")); - - assertEquals(2, configuration.eventProcessingConfiguration().eventProcessors().size()); - Optional resultTrackingTep = - configuration.eventProcessingConfiguration() - .eventProcessor("default", MultiTenantEventProcessor.class); - assertTrue(resultTrackingTep.isPresent()); - - assertTrue(configuration.eventProcessingConfiguration() - .eventProcessor("default", MultiTenantEventProcessor.class) - .isPresent()); - assertTrue(configuration.eventProcessingConfiguration() - .eventProcessor("default@tenant1", PooledStreamingEventProcessor.class) - .isPresent()); - } - - @Test - void pooledStreamingEventProcessorNonMultiTenant() { - //noinspection unchecked - StreamableMessageSource> mockedSource = mock(StreamableMessageSource.class); - TenantProvider tenantProvider = mock(TenantProvider.class); - MultiTenantStreamableMessageSourceProvider multiTenantStreamableMessageSourceProvider = - (source, processorName, tenantDescriptor, configuration) -> source; - - configurer.registerModule( - new MultiTenantEventProcessingModule(tenantProvider, multiTenantStreamableMessageSourceProvider, null, MultiTenantEventProcessorPredicate.disableMultiTenancy()) - ); - - TrackingEventProcessorConfiguration testTepConfig = - TrackingEventProcessorConfiguration.forParallelProcessing(4); - configurer.eventProcessing() - .usingPooledStreamingEventProcessors() - .configureDefaultStreamableMessageSource(config -> mockedSource) - .byDefaultAssignTo("default") - .registerEventHandler(config -> new Object()) - .registerTrackingEventProcessorConfiguration("tracking", config -> testTepConfig); - Configuration configuration = configurer.start(); - - - - assertEquals(1, configuration.eventProcessingConfiguration().eventProcessors().size()); - assertTrue(configuration.eventProcessingConfiguration() - .eventProcessor("default", PooledStreamingEventProcessor.class) - .isPresent()); - } - - @Test - void pooledStreamingEventProcessorCustomSource() { - //noinspection unchecked - StreamableMessageSource> mockedSource = mock(StreamableMessageSource.class); - //noinspection unchecked - StreamableMessageSource> customSource = mock(StreamableMessageSource.class); - - MultiTenantStreamableMessageSourceProvider multiTenantStreamableMessageSourceProvider = - (source, processorName, tenantDescriptor, configuration) -> customSource; - - TenantProvider tenantProvider = mock(TenantProvider.class); - configurer.registerModule(new MultiTenantEventProcessingModule(tenantProvider, - multiTenantStreamableMessageSourceProvider, - multiTenantDeadLetterQueueFactory, MultiTenantEventProcessorPredicate.enableMultiTenancy())); - TrackingEventProcessorConfiguration testTepConfig = - TrackingEventProcessorConfiguration.forParallelProcessing(4); - configurer.eventProcessing() - .usingPooledStreamingEventProcessors() - .configureDefaultStreamableMessageSource(config -> mockedSource) - .byDefaultAssignTo("default") - .registerEventHandler(config -> new TestEventHandler()) - .registerTrackingEventProcessorConfiguration("tracking", config -> testTepConfig); - Configuration configuration = configurer.start(); - - ArgumentCaptor sep = ArgumentCaptor.forClass(MultiTenantEventProcessor.class); - verify(tenantProvider).subscribe(sep.capture()); - sep.getValue().registerAndStartTenant(TenantDescriptor.tenantWithId("tenant1")); - - assertEquals(2, configuration.eventProcessingConfiguration().eventProcessors().size()); - Optional resultTrackingTep = - configuration.eventProcessingConfiguration() - .eventProcessor("default", MultiTenantEventProcessor.class); - assertTrue(resultTrackingTep.isPresent()); - - assertTrue(configuration.eventProcessingConfiguration() - .eventProcessor("default", MultiTenantEventProcessor.class) - .isPresent()); - assertTrue(configuration.eventProcessingConfiguration() - .eventProcessor("default@tenant1", PooledStreamingEventProcessor.class) - .isPresent()); - - configuration.eventProcessingConfiguration() - .eventProcessor("default@tenant1", PooledStreamingEventProcessor.class) - .ifPresent(pooledStreamingEventProcessor -> { - pooledStreamingEventProcessor.shutDown(); - pooledStreamingEventProcessor.resetTokens(StreamableMessageSource::createHeadToken); - }); - - verify(customSource, times(2)).createHeadToken(); - } - - private static class TestEventHandler { - - @EventHandler - public void handle(String event) { - - } - } -} \ No newline at end of file diff --git a/pom.xml b/pom.xml index 71101c4..80e43e2 100644 --- a/pom.xml +++ b/pom.xml @@ -19,11 +19,18 @@ org.axonframework.extensions.multitenancy axon-multitenancy-parent - 4.12.1-SNAPSHOT + 5.1.0-SNAPSHOT multitenancy + multitenancy-spring + multitenancy-axon-server-connector multitenancy-spring-boot-autoconfigure multitenancy-spring-boot-starter + + multitenancy-integration-tests-embedded + multitenancy-integration-tests-axon-server + multitenancy-integration-tests-springboot-embedded + multitenancy-integration-tests-springboot-axonserver pom @@ -54,19 +61,22 @@ ${project.basedir}/../coverage-report/target/site/jacoco-aggregate/jacoco.xml - 4.12.0 + 5.1.0-SNAPSHOT - 5.3.39 - 2.7.18 + 6.2.15 + 3.5.9 + 2025.0.7 - 1.7.28 - 2.13.0 + 2.0.17 + 2.25.3 - 5.13.3 - 4.11.0 + 6.0.1 + 5.21.0 - 3.7.8 + 3.8.1 3.0.2 + 3.0.0 + 3.2.0 0.8.0 0.8.13 @@ -87,6 +97,11 @@ + + org.axonframework + axon-common + ${axon.version} + org.axonframework axon-messaging @@ -99,16 +114,22 @@ org.axonframework - axon-server-connector + axon-eventsourcing ${axon.version} org.axonframework + axon-server-connector + ${axon.version} + + + + org.axonframework.extensions.spring axon-spring ${axon.version} - org.axonframework + org.axonframework.extensions.spring axon-spring-boot-autoconfigure ${axon.version} @@ -129,7 +150,26 @@ spring-boot-autoconfigure ${spring.boot.version} + + + org.springframework.data + spring-data-bom + ${spring-data.version} + pom + import + + + + jakarta.persistence + jakarta.persistence-api + ${jakarta.persistence.version} + + + jakarta.annotation + jakarta.annotation-api + ${jakarta.annotation.version} + com.google.code.findbugs jsr305 @@ -207,8 +247,8 @@ maven-compiler-plugin ${maven-compiler.version} - 1.8 - 1.8 + 21 + 21 UTF-8 @@ -261,7 +301,7 @@ - + maven-enforcer-plugin ${maven-enforcer.version} @@ -274,7 +314,7 @@ - 1.8 + 21 3.5 @@ -352,15 +392,18 @@ + + sources