Polish the code

Author: yevhenii.nadtochii

server/src/main/java/io/spine/server/BoundedContext.java

@@ -50,7 +50,6 @@
 import io.spine.server.security.Security;
 import io.spine.server.stand.Stand;
 import io.spine.server.tenant.TenantIndex;
-import io.spine.server.trace.TracerFactory;
 import io.spine.system.server.SystemClient;
 import io.spine.system.server.SystemContext;
 import io.spine.type.TypeName;
@@ -405,7 +404,6 @@ public boolean isMultitenant() {
      *     <li>Closes {@link DefaultEventStore EventStore}.
      *     <li>Closes {@link Stand}.
      *     <li>Closes {@link ImportBus}.
-     *     <li>Closes {@link TracerFactory} if it is present.
      *     <li>Closes all registered {@linkplain Repository repositories}.
      * </ol>
      *

server/src/main/java/io/spine/server/aggregate/AggregateRepository.java

@@ -255,7 +255,7 @@ protected void setupEventRouting(EventRouting<I> routing) {
      * <p>The default routing uses {@linkplain io.spine.core.EventContext#getProducerId()
      * producer ID} of the event as the ID of the target aggregate.
      *
-     * <p>This default routing requires that {@link Event Event} instances
+     * <p>This default routing requires that {@link Event} instances
      * {@linkplain ImportBus#post(io.spine.core.Signal, io.grpc.stub.StreamObserver) posted}
      * for import must {@link io.spine.core.EventContext#getProducerId() contain} the ID of the
      * target aggregate. Not providing a valid aggregate ID would result in

server/src/main/java/io/spine/server/aggregate/UncommittedHistory.java

@@ -44,7 +44,7 @@
  * {@linkplain #onAggregateRestored(AggregateHistory) remembers} the event count
  * after the last snapshot.
  *
- * <p>If during the tracking the number of events since the last snapshot exceeds
+ * <p>If during the dispatching of events the number of events since the last snapshot exceeds
  * the snapshot trigger, a snapshot is created and remembered as a part of uncommitted history.
  *
  * @see Aggregate#apply(List, int) remembering successfully applied events
@@ -68,15 +68,6 @@ final class UncommittedHistory {
         this.makeSnapshot = makeSnapshot;
     }
 
-    /**
-     * Records the history loaded from the aggregate storage.
-     *
-     * <p>This is only required in order to know the number of events since the last snapshot.
-     */
-    void onAggregateRestored(AggregateHistory history) {
-        this.eventCountAfterLastSnapshot = history.getEventCount();
-    }
-
     /**
      * Tracks the events, successfully dispatched to the Aggregate's applier.
      *
@@ -102,13 +93,6 @@ void track(List<Event> events, int snapshotTrigger) {
         }
     }
 
-    private static AggregateHistory historyFrom(List<Event> events, Snapshot snapshot) {
-        return AggregateHistory.newBuilder()
-                .addAllEvent(events)
-                .setSnapshot(snapshot)
-                .vBuild();
-    }
-
     /**
      * Composes and obtains the collected uncommitted history.
      *
@@ -125,12 +109,6 @@ ImmutableList<AggregateHistory> get() {
         return builder.build();
     }
 
-    private static AggregateHistory historyFrom(List<Event> events) {
-        return AggregateHistory.newBuilder()
-                .addAllEvent(events)
-                .vBuild();
-    }
-
     /**
      * Returns all tracked uncommitted events.
      */
@@ -156,4 +134,26 @@ void commit() {
         historySegments.clear();
         currentSegment.clear();
     }
+
+    /**
+     * Records the history loaded from the aggregate storage.
+     *
+     * <p>This is only required in order to know the number of events since the last snapshot.
+     */
+    void onAggregateRestored(AggregateHistory history) {
+        this.eventCountAfterLastSnapshot = history.getEventCount();
+    }
+
+    private static AggregateHistory historyFrom(List<Event> events, Snapshot snapshot) {
+        return AggregateHistory.newBuilder()
+                .addAllEvent(events)
+                .setSnapshot(snapshot)
+                .vBuild();
+    }
+
+    private static AggregateHistory historyFrom(List<Event> events) {
+        return AggregateHistory.newBuilder()
+                .addAllEvent(events)
+                .vBuild();
+    }
 }

server/src/main/java/io/spine/server/event/EventBus.java

@@ -195,7 +195,7 @@ public EventStore eventStore() {
      * Posts the event for handling.
      *
      * <p>Performs the same action as the
-     * {@linkplain io.spine.server.bus.Bus#post(Signal, StreamObserver)} parent method},
+     * {@linkplain io.spine.server.bus.Bus#post(Signal, StreamObserver) parent method},
      * but does not require any response observer.
      *
      * @param event the event to be handled
@@ -209,10 +209,10 @@ public void post(Event event) {
      * Posts the events for handling.
      *
      * <p>Performs the same action as the
-     * {@linkplain io.spine.server.bus.Bus#post(Iterable, StreamObserver)} parent method}
+     * {@linkplain io.spine.server.bus.Bus#post(Iterable, StreamObserver) parent method}
      * but does not require any response observer.
      *
-     * <p>This method should be used if the callee does not care about the events acknowledgement.
+     * <p>This method should be used if the callee does not care about the events' acknowledgement.
      *
      * @param events the events to be handled
      * @see io.spine.server.bus.Bus#post(Signal, StreamObserver)

server/src/test/java/io/spine/server/aggregate/AbstractAggregateResilienceTest.java

@@ -68,6 +68,7 @@
  * @see AggregateResilienceTest
  * @see CachedAggregateResilienceTest
  */
+@DisplayName("Abstract resilient `Aggregate` should")
 abstract class AbstractAggregateResilienceTest {
 
     private final EmployeeId jack = generate();
@@ -93,7 +94,7 @@ void tearDown() throws Exception {
     class NotStoreAndPostEventsBundle {
 
         @Nested
-        @DisplayName("when a faulty command produced")
+        @DisplayName("when a faulty command emitted")
         class WhenCommandEmitted {
 
             @Test

server/src/test/java/io/spine/server/aggregate/AggregateResilienceTest.java

@@ -46,7 +46,7 @@ final class AggregateResilienceTest extends AbstractAggregateResilienceTest {
     /**
      * @inheritDoc
      *
-     * This method dispatches the passed commands directly to the context's
+     * <p>This method dispatches the passed commands directly to the context's
      * {@code CommandBus} <i>one by one</i>.
      */
     @Override

server/src/test/java/io/spine/server/aggregate/CachedAggregateResilienceTest.java

@@ -44,11 +44,11 @@
  * Tests how <i>cached</i> {@code Aggregate} handles the case when one of events,
  * emitted by a command, corrupts the {@code Aggregate}'s state.
  *
- * An {@code Aggregate} is cached when multiple messages are dispatched from `Inbox` at once.
+ * <p>An {@code Aggregate} is cached when multiple messages are dispatched from `Inbox` at once.
  * Under the hood, they are processed as a "batch", which triggers the aggregate
  * to be cached for their processing.
  *
- * This class uses the custom {@linkplain PreparedInboxStorage InboxStorage} which allow
+ * <p>This class uses the custom {@linkplain PreparedInboxStorage InboxStorage} which allow
  * writing messages there directly. This storage is "fed" to the delivery which then is triggered
  * to perform dispatching.
  *
@@ -82,7 +82,7 @@ void tearDown() throws Exception {
     /**
      * @inheritDoc
      *
-     * This method fills the custom {@linkplain PreparedInboxStorage InboxStorage} with the passed
+     * <p>This method fills the custom {@linkplain PreparedInboxStorage InboxStorage} with the passed
      * commands and then runs delivery. The commands, dispatched this way, will be processed
      * withing a single "batch" which would cause an {@code Aggregate} to be cached.
      */

server/src/test/java/io/spine/server/aggregate/given/AbstractAggregateResilienceTestEnv.java

@@ -34,19 +34,25 @@
 import static com.google.common.truth.Truth.assertThat;
 
 /**
- * Environment for {@link io.spine.server.aggregate.AggregateResilienceTest AggregateResilienceTest}.
+ * Environment for {@link io.spine.server.aggregate.AbstractAggregateResilienceTest}.
  */
 public final class AbstractAggregateResilienceTestEnv {
 
     private AbstractAggregateResilienceTestEnv() {
     }
 
+    /**
+     * Wraps the "varargs-passed" event messages into a {@code List}.
+     */
     @SafeVarargs
     public static List<Class<? extends EventMessage>>
     eventTypes(Class<? extends EventMessage>... types) {
         return List.of(types);
     }
 
+    /**
+     * Assert that the passed events correspond to the passed types.
+     */
     public static void assertEvents(List<Event> events, List<Class<? extends EventMessage>> types) {
         assertThat(events.size()).isEqualTo(types.size());
         for (var i = 0; i < types.size(); i++) {

server/src/test/java/io/spine/server/aggregate/given/employee/DispatchExhaust.java

@@ -41,7 +41,7 @@
  *     <li>updated {@code Aggregate}'s state.</li>
  * </ul>
  *
- * <p>A healthy {@code Aggregate} usually stores and posts the same set of events withing a command
+ * <p>A healthy {@code Aggregate} usually stores and posts the same set of events within
  * dispatching. That consequently causes its state to be updated.
  */
 public final class DispatchExhaust {

server/src/test/java/io/spine/server/aggregate/given/employee/package-info.java

@@ -25,7 +25,7 @@
  */
 
 /**
- * Test environment classes for the {@link io.spine.server.aggregate.AggregateCachingTest}.
+ * Environment classes for {@link io.spine.server.aggregate.AbstractAggregateResilienceTest}.
  */
 @CheckReturnValue
 @ParametersAreNonnullByDefault