Code adjustments based on PR review comments.

stefanmirkovic · stefanmirkovic · commit c8693cf910de · 2025-05-28T16:32:21.000+02:00
diff --git a/README.md b/README.md
@@ -39,7 +39,7 @@ default: `none`. Several options are available:
 
     * `preview_payload_only` – payloads of events are visible via the API or UI, but snapshot loading is disabled.
 
-    * `load_snapshot_only` – event payloads are not shown, but snapshot loading is enabled for aggregate reconstruction.
+    * `load_domain_state_only` – event payloads are not shown, but domain state loading is enabled for the domain entity.
 
     * `full` – full access: event payloads are visible, and aggregate loading is supported.
 
diff --git a/console-framework-client-api/src/main/java/io/axoniq/console/framework/api/Routes.kt b/console-framework-client-api/src/main/java/io/axoniq/console/framework/api/Routes.kt
@@ -66,9 +66,9 @@ object Routes {
         const val REPORT = "application-info-report"
     }
 
-    object Aggregate {
-        const val DOMAIN_EVENTS = "aggregate-domain-events"
-        const val LOAD_FOR_AGGREGATE = "load-for-aggregate"
+    object Enity {
+        const val DOMAIN_EVENTS = "domain-events"
+        const val ENTITY_STATE_AT_SEQUENCE = "entity-state-at-sequence"
     }
 
     object MessageFlow {
diff --git a/console-framework-client-api/src/main/java/io/axoniq/console/framework/api/aggregateApi.kt b/console-framework-client-api/src/main/java/io/axoniq/console/framework/api/aggregateApi.kt
@@ -3,8 +3,8 @@ package io.axoniq.console.framework.api
 import java.time.Instant
 
 data class DomainEventsResult(
-        val aggregateId: String,
-        val aggregateType: String,
+        val entityId: String,
+        val entityType: String,
         val domainEvents: List<DomainEvent>,
         val page: Int,
         val pageSize: Int,
@@ -19,20 +19,20 @@ data class DomainEvent(
 )
 
 data class DomainEventsQuery(
-        val aggregateId: String,
+        val entityId: String,
         val page: Int = 0,
         val pageSize: Int = 10,
 )
 
-data class AggregateSnapshotResult(
+data class EntityStateResult(
         val type: String,
-        val aggregateId: String,
+        val entityId: String,
         val maxSequenceNumber: Long = 0,
-        val snapshot: String,
+        val state: String,
 )
 
-data class AggregateSnapshotQuery(
+data class EntityStateAtSequenceQuery(
         val type: String,
-        val aggregateId: String,
+        val entityId: String,
         val maxSequenceNumber: Long = 0,
 )
diff --git a/console-framework-client/pom.xml b/console-framework-client/pom.xml
@@ -23,18 +23,6 @@
         <artifactId>console-framework-client-parent</artifactId>
         <version>1.9.3-SNAPSHOT</version>
     </parent>
-    <build>
-        <plugins>
-            <plugin>
-                <groupId>org.apache.maven.plugins</groupId>
-                <artifactId>maven-compiler-plugin</artifactId>
-                <configuration>
-                    <source>16</source>
-                    <target>16</target>
-                </configuration>
-            </plugin>
-        </plugins>
-    </build>
     <modelVersion>4.0.0</modelVersion>
 
     <artifactId>console-framework-client</artifactId>
diff --git a/console-framework-client/src/main/java/io/axoniq/console/framework/AxoniqConsoleConfigurerModule.java b/console-framework-client/src/main/java/io/axoniq/console/framework/AxoniqConsoleConfigurerModule.java
@@ -16,12 +16,15 @@
 
 package io.axoniq.console.framework;
 
-import io.axoniq.console.framework.application.AggregateEventStreamProvider;
+import com.fasterxml.jackson.annotation.JsonAutoDetect;
+import com.fasterxml.jackson.annotation.PropertyAccessor;
+import com.fasterxml.jackson.databind.ObjectMapper;
+import io.axoniq.console.framework.application.DomainEventStreamProvider;
 import io.axoniq.console.framework.application.ApplicationMetricRegistry;
 import io.axoniq.console.framework.application.ApplicationMetricReporter;
 import io.axoniq.console.framework.application.ApplicationReportCreator;
 import io.axoniq.console.framework.application.ApplicationThreadDumpProvider;
-import io.axoniq.console.framework.application.RSocketAggregateDataResponder;
+import io.axoniq.console.framework.application.RSocketDomainEntityDataResponder;
 import io.axoniq.console.framework.application.RSocketThreadDumpResponder;
 import io.axoniq.console.framework.client.AxoniqConsoleRSocketClient;
 import io.axoniq.console.framework.client.ClientSettingsService;
@@ -93,6 +96,7 @@ public class AxoniqConsoleConfigurerModule implements ConfigurerModule {
     private final EventScheduler eventScheduler;
     private final MeterRegistry meterRegistry = new SimpleMeterRegistry();
     private final String instanceName;
+    private final ObjectMapper objectMapper;
 
     /**
      * Creates the {@link AxoniqConsoleConfigurerModule} with the given {@code builder}.
@@ -116,6 +120,7 @@ protected AxoniqConsoleConfigurerModule(Builder builder) {
         this.configureSpanFactory = !builder.disableSpanFactoryInConfiguration;
         this.spanMatcherPredicateMap = builder.spanMatcherPredicateMap;
         this.eventScheduler = builder.eventScheduler;
+        this.objectMapper = builder.objectMapper;
     }
 
     /**
@@ -227,9 +232,10 @@ public void configureModule(@NotNull Configurer configurer) {
                 .registerComponent(ApplicationThreadDumpProvider.class,
                                    c -> new ApplicationThreadDumpProvider()
                 )
-                .registerComponent(AggregateEventStreamProvider.class,
-                                   c -> new AggregateEventStreamProvider(
-                                           configurer.buildConfiguration()
+                .registerComponent(DomainEventStreamProvider.class,
+                                   c -> new DomainEventStreamProvider(
+                                           configurer.buildConfiguration(),
+                                           objectMapper
                                    )
                 )
                 .registerComponent(RSocketDlqResponder.class,
@@ -242,9 +248,9 @@ public void configureModule(@NotNull Configurer configurer) {
                                            c.getComponent(ApplicationThreadDumpProvider.class),
                                            c.getComponent(RSocketHandlerRegistrar.class)
                                    ))
-                .registerComponent(RSocketAggregateDataResponder.class,
-                                   c -> new RSocketAggregateDataResponder(
-                                           c.getComponent(AggregateEventStreamProvider.class),
+                .registerComponent(RSocketDomainEntityDataResponder.class,
+                                   c -> new RSocketDomainEntityDataResponder(
+                                           c.getComponent(DomainEventStreamProvider.class),
                                            c.getComponent(RSocketHandlerRegistrar.class),
                                            domainEventAccessMode,
                                            c.eventSerializer()
@@ -275,7 +281,7 @@ public void configureModule(@NotNull Configurer configurer) {
             c.getComponent(RSocketDlqResponder.class);
             c.getComponent(HandlerMetricsRegistry.class);
             c.getComponent(RSocketThreadDumpResponder.class);
-            c.getComponent(RSocketAggregateDataResponder.class);
+            c.getComponent(RSocketDomainEntityDataResponder.class);
         });
 
         configurer.onStart(() -> {
@@ -329,6 +335,9 @@ public static class Builder {
         private Integer managementMaxThreadPoolSize = 5;
         private EventScheduler eventScheduler;
 
+        private ObjectMapper objectMapper = new ObjectMapper().findAndRegisterModules()
+                .setVisibility(PropertyAccessor.FIELD, JsonAutoDetect.Visibility.ANY);
+
         /**
          * Constructor to instantiate a {@link Builder} based on the fields contained in the
          * {@link AxoniqConsoleConfigurerModule.Builder}. Requires the {@code environmentId}, {@code accessToken} and
@@ -554,6 +563,19 @@ public Builder eventScheduler(EventScheduler eventScheduler) {
             return this;
         }
 
+        /**
+         * Set the object mapper to be used for serialization and deserialization of domain events.
+         * Defaults to a new {@link ObjectMapper} with all modules registered and field visibility set to any.
+         *
+         * @param objectMapper the object mapper to use
+         * @return The builder for fluent interfacing
+         */
+        public Builder objectMapper(ObjectMapper objectMapper) {
+            BuilderUtils.assertNonNull(objectMapper, "Object mapper must be non-null");
+            this.objectMapper = objectMapper;
+            return this;
+        }
+
         /**
          * Builds the {@link AxoniqConsoleConfigurerModule} based on the fields set in this {@link Builder}.
          *
diff --git a/console-framework-client/src/main/java/io/axoniq/console/framework/DomainEventAccessMode.java b/console-framework-client/src/main/java/io/axoniq/console/framework/DomainEventAccessMode.java
@@ -2,22 +2,22 @@
 
 public enum DomainEventAccessMode {
     /**
-     * Full access: payload is visible and LoadForAggregate is supported.
+     * Full access: payload is visible and loading domain state is supported.
      */
     FULL,
 
     /**
-     * Payload is hidden (e.g., masked or removed), but LoadForAggregate is still supported.
+     * Payload is hidden (e.g., masked), but loading domain state is still supported.
      */
-    LOAD_SNAPSHOT_ONLY,
+    LOAD_DOMAIN_STATE_ONLY,
 
     /**
-     * Payload is visible, but LoadForAggregate is not supported.
+     * Payload is visible, but loading domain state is not supported.
      */
     PREVIEW_PAYLOAD_ONLY,
 
     /**
-     * No access: payload is hidden and LoadForAggregate is not supported.
+     * No access: payload is hidden and loading domain state is not supported.
      */
     NONE
 }
diff --git a/console-framework-client/src/main/java/io/axoniq/console/framework/application/DomainEventStreamProvider.kt b/console-framework-client/src/main/java/io/axoniq/console/framework/application/DomainEventStreamProvider.kt
@@ -1,5 +1,6 @@
 package io.axoniq.console.framework.application
 
+import com.fasterxml.jackson.databind.ObjectMapper
 import org.axonframework.common.ReflectionUtils
 import org.axonframework.config.AggregateConfiguration
 import org.axonframework.config.Configuration
@@ -14,34 +15,39 @@ import org.axonframework.modelling.command.Repository
 import org.axonframework.modelling.command.RepositoryProvider
 import org.axonframework.modelling.command.inspection.AggregateModel
 
-class AggregateEventStreamProvider(
-        private val configuration: Configuration
+class DomainEventStreamProvider(
+        private val configuration: Configuration,
+        private val objectMapper: ObjectMapper
 ) {
 
-    fun getDomainEventStream(aggregateIdentifier: String): List<DomainEventMessage<*>>? =
-            configuration.eventStore().readEvents(aggregateIdentifier, 0).asStream().toList()
-
+    fun getDomainEventStream(entityIdentifier: String, firstSequenceNumber: Long = 0): List<DomainEventMessage<*>>? =
+            configuration.eventStore()
+                    .readEvents(entityIdentifier, firstSequenceNumber)
+                    .iterator()
+                    .asSequence()
+                    .toList()
+                    .takeIf { it.isNotEmpty() }
 
-    fun <T> loadForAggregate(type: String, identifier: String, maxSequenceNumber: Long): String? {
-        val aggregateConfiguration = configuration.modules
+    fun <T> loadDomainStateAtSequence(type: String, entityIdentifier: String, maxSequenceNumber: Long): String? {
+        val entityConfiguration = configuration.modules
                 .filterIsInstance<AggregateConfiguration<*>>()
                 .firstOrNull { it.aggregateType().simpleName == type }
-                ?: throw IllegalArgumentException("No aggregate found for type $type")
+                ?: throw IllegalArgumentException("No domain entity found for type $type")
 
         val eventStore = configuration.eventStore()
 
-        val factory: AggregateFactory<T> = aggregateConfiguration.aggregateFactory() as AggregateFactory<T>
-        val model: AggregateModel<T> = aggregateConfiguration.repository().getPropertyValue<AggregateModel<T>>("aggregateModel")
-                ?: throw IllegalArgumentException("No aggregate model found for type $type")
+        val factory: AggregateFactory<T> = entityConfiguration.aggregateFactory() as AggregateFactory<T>
+        val model: AggregateModel<T> = entityConfiguration.repository().getPropertyValue<AggregateModel<T>>("aggregateModel")
+                ?: throw IllegalArgumentException("No domain entity model found for type $type")
 
-        val stream = readEvents(identifier)
-        val loadingAggregate: EventSourcedAggregate<T> = EventSourcedAggregate
-                .initialize(factory.createAggregateRoot(identifier, stream.peek()),
+        val stream = readEvents(entityIdentifier)
+        val loadingEntity: EventSourcedAggregate<T> = EventSourcedAggregate
+                .initialize(factory.createAggregateRoot(entityIdentifier, stream.peek()),
                         model,
                         eventStore,
                         object : RepositoryProvider {
                             override fun <T> repositoryFor(aggregateType: Class<T>): Repository<T> {
-                                return aggregateConfiguration.repository() as Repository<T>
+                                return entityConfiguration.repository() as Repository<T>
                             }
 
                         },
@@ -55,15 +61,15 @@ class AggregateEventStreamProvider(
                             }
                         })
 
-        loadingAggregate.initializeState(stream.filter { it.sequenceNumber <= maxSequenceNumber })
+        loadingEntity.initializeState(stream.filter { it.sequenceNumber <= maxSequenceNumber })
 
-        return configuration.serializer().serialize(loadingAggregate.aggregateRoot, String::class.java).data
+        return objectMapper.writeValueAsString(loadingEntity.aggregateRoot)
     }
 
-    private fun readEvents(identifier: String): DomainEventStream =
+    private fun readEvents(identifier: String, firstSequenceNumber: Long = 0): DomainEventStream =
             configuration.eventStore()
                     .getPropertyValue<AbstractEventStorageEngine>("storageEngine")
-                    ?.readEvents(identifier, 0)
+                    ?.readEvents(identifier, firstSequenceNumber)
                     ?: throw IllegalStateException("Unable to find AbstractEventStorageEngine in event store")
 
     @Suppress("UNCHECKED_CAST")
diff --git a/console-framework-client/src/main/java/io/axoniq/console/framework/application/RSocketDomainEntityDataResponder.kt b/console-framework-client/src/main/java/io/axoniq/console/framework/application/RSocketDomainEntityDataResponder.kt

Original file line number	Diff line number	Diff line change
`@@ -66,9 +66,9 @@ object Routes {`
`66`	`66`	`const val REPORT = "application-info-report"`
`67`	`67`	`}`
`68`	`68`
`69`		`- object Aggregate {`
`70`		`- const val DOMAIN_EVENTS = "aggregate-domain-events"`
`71`		`- const val LOAD_FOR_AGGREGATE = "load-for-aggregate"`
	`69`	`+ object Enity {`
	`70`	`+ const val DOMAIN_EVENTS = "domain-events"`
	`71`	`+ const val ENTITY_STATE_AT_SEQUENCE = "entity-state-at-sequence"`
`72`	`72`	`}`
`73`	`73`
`74`	`74`	`object MessageFlow {`