Merge pull request #118 from SpineEventEngine/bump-versions

Migrate to new logging API

Author: alexander-yevsyukov

config

@@ -270,7 +270,7 @@ public Entity read(Key key) {
      * @see DatastoreReader#run(Query)
      */
     public DsQueryIterator read(StructuredQuery<Entity> query) {
-        Namespace namespace = getNamespace();
+        Namespace namespace = currentNamespace();
         StructuredQuery<Entity> queryWithNamespace =
                 query.toBuilder()
                      .setNamespace(namespace.getValue())
@@ -377,7 +377,7 @@ public void delete(Key... keys) {
      *         kind (a.k.a. type, table, etc.) of the records to delete
      */
     void dropTable(String table) {
-        Namespace namespace = getNamespace();
+        Namespace namespace = currentNamespace();
         StructuredQuery<Entity> query =
                 Query.newEntityQueryBuilder()
                      .setNamespace(namespace.getValue())
@@ -497,7 +497,7 @@ public KeyFactory keyFactory(Kind kind) {
         if (keyFactory == null) {
             keyFactory = initKeyFactory(kind);
         }
-        Namespace namespace = getNamespace();
+        Namespace namespace = currentNamespace();
         keyFactory.setNamespace(namespace.getValue());
 
         return keyFactory;
@@ -536,8 +536,8 @@ private KeyFactory initKeyFactory(Kind kind) {
      */
     private Iterator<Entity> readBulk(List<Key> keys) {
         int pageCount = keys.size() / MAX_KEYS_PER_READ_REQUEST + 1;
-        log().debug("Reading a big bulk of entities synchronously. The data is read as {} pages.",
-                    pageCount);
+        _debug().log("Reading a big bulk of entities synchronously." +
+                             " The data is read as %d pages.", pageCount);
         int lowerBound = 0;
         int higherBound = MAX_KEYS_PER_READ_REQUEST;
         int keysLeft = keys.size();
@@ -567,9 +567,9 @@ private void writeBulk(Entity[] entities) {
         }
     }
 
-    private Namespace getNamespace() {
+    private Namespace currentNamespace() {
         Namespace namespace = namespaceSupplier.get();
-        log().debug("Using namespace \"{}\".", namespace.getValue());
+        _debug().log("Using namespace `%s`.", namespace);
         return namespace;
     }
 

datastore/src/main/java/io/spine/server/storage/datastore/DatastoreWrapper.java

@@ -295,8 +295,6 @@ enum ConverterType {
          */
         SINGLE_CUSTOM(NamespaceConverters.forCustomNamespace());
 
-        // This enum isn't intended to be serialized.
-        @SuppressWarnings("NonSerializableFieldInSerializableClass")
         private final NamespaceConverter namespaceConverter;
 
         static ConverterType forTenantId(TenantId tenantId) {

datastore/src/main/java/io/spine/server/storage/datastore/tenant/Namespace.java

@@ -50,14 +50,13 @@ final class NamespaceIndex implements TenantIndex {
     private static final Kind NAMESPACE_KIND = Kind.ofNamespace();
 
     private final Set<Namespace> cache = new HashSet<>();
-
     private final Object lock = new Object();
     private final NamespaceQuery namespaceQuery;
-
     private final NsConverterFactory converterFactory;
-
     private final boolean multitenant;
 
+    private boolean registered;
+
     NamespaceIndex(Datastore datastore, boolean multitenant, NsConverterFactory converterFactory) {
         this(new DefaultNamespaceQuery(datastore),
              multitenant,
@@ -66,7 +65,8 @@ final class NamespaceIndex implements TenantIndex {
     }
 
     NamespaceIndex(NamespaceQuery namespaceQuery,
-                   boolean multitenant, NsConverterFactory converterFactory) {
+                   boolean multitenant,
+                   NsConverterFactory converterFactory) {
         this.namespaceQuery = checkNotNull(namespaceQuery);
         this.converterFactory = converterFactory;
         this.multitenant = multitenant;
@@ -75,9 +75,13 @@ final class NamespaceIndex implements TenantIndex {
     @Override
     public void registerWith(BoundedContext context) {
         checkNotNull(context);
+        registered = true;
+        // Do nothing more, as this implementation does not rely on any `BoundedContext` properties.
+    }
 
-        // Do nothing more, as this implementation does not rely on any {@code BoundedContext}
-        // properties.
+    @Override
+    public boolean isRegistered() {
+        return registered;
     }
 
     /**

datastore/src/main/java/io/spine/server/storage/datastore/tenant/NamespaceIndex.java

@@ -109,7 +109,7 @@ public void testBigDataOperations(RecordStorage<I> storage) {
                         writeTime));
         }
 
-        log().debug("Writing took {} millis.", writeTime);
+        _debug().log("Writing took %d millis.", writeTime);
 
         try {
             Thread.sleep(1000);
@@ -130,7 +130,7 @@ public void testBigDataOperations(RecordStorage<I> storage) {
                         readMillisLimit,
                         readTime));
         }
-        log().debug("Reading took {} millis.", readTime);
+        _debug().log("Reading took %d millis.", readTime);
 
         assertEquals(records.size(), size(readRecords), "Unexpected records count read.");
     }

datastore/src/test/java/io/spine/server/storage/datastore/BigDataTester.java

@@ -254,8 +254,7 @@ void testLoadHistoryAfterSnapshotTriggerChange() {
             for (int i = 0; i < tasksCount; i++) {
                 AggAddTask command = addTask(id);
                 CommandEnvelope envelope = CommandEnvelope.of(factory.createCommand(command));
-                ProjectId target = repository.dispatch(envelope);
-                assertEquals(id, target);
+                repository.dispatch(envelope);
             }
 
             int minimalSnapshotTrigger = 1;

datastore/src/test/java/io/spine/server/storage/datastore/DsAggregateStorageTest.java

@@ -22,20 +22,18 @@
 
 import com.google.cloud.datastore.Datastore;
 import com.google.cloud.datastore.DatastoreOptions;
+import com.google.common.flogger.FluentLogger;
 import io.spine.annotation.Internal;
-import io.spine.logging.Logging;
 import io.spine.server.storage.datastore.given.TestDatastores;
 import io.spine.server.storage.datastore.type.DatastoreTypeRegistryFactory;
 import org.checkerframework.checker.nullness.qual.MonotonicNonNull;
-import org.slf4j.Logger;
-
-import static java.lang.String.format;
 
 /**
  * Creates storages based on the local Google {@link Datastore}.
  */
 public class TestDatastoreStorageFactory extends DatastoreStorageFactory {
 
+    private static final FluentLogger logger = FluentLogger.forEnclosingClass();
     private static @MonotonicNonNull TestDatastoreStorageFactory instance = null;
 
     /**
@@ -53,7 +51,9 @@ public static synchronized TestDatastoreStorageFactory defaultInstance() {
             }
             return instance;
         } catch (Throwable e) {
-            log().error("Failed to initialize local datastore factory", e);
+            logger.atSevere()
+                  .withCause(e)
+                  .log("Failed to initialize local datastore factory.");
             throw new IllegalStateException(e);
         }
     }
@@ -111,13 +111,11 @@ public void clear() {
             try {
                 datastore.dropAllTables();
             } catch (Throwable e) {
-                log().error(format("Unable to drop tables in Datastore %s", datastore), e);
+                logger.atSevere()
+                      .withCause(e)
+                      .log("Unable to drop tables in Datastore `%s`.", datastore);
                 throw new IllegalStateException(e);
             }
         }
     }
-
-    private static Logger log() {
-        return Logging.get(TestDatastoreStorageFactory.class);
-    }
 }

datastore/src/test/java/io/spine/server/storage/datastore/TestDatastoreStorageFactory.java

@@ -141,10 +141,10 @@ private void dropTableConsistently(String table) {
     @SuppressWarnings("BusyWait")   // allow Datastore to become consistent before reading.
     private void waitForConsistency() {
         if (!waitForConsistency) {
-            log().debug("Wait for consistency is not required.");
+            _debug().log("Wait for consistency is not required.");
             return;
         }
-        log().debug("Waiting for data consistency to establish.");
+        _debug().log("Waiting for data consistency to establish.");
 
         for (int awaitCycle = 0; awaitCycle < CONSISTENCY_AWAIT_ITERATIONS; awaitCycle++) {
             try {
@@ -159,7 +159,7 @@ private void waitForConsistency() {
      * Deletes all records from the datastore.
      */
     public void dropAllTables() {
-        log().debug("Dropping all tables");
+        _debug().log("Dropping all tables...");
         for (String kind : kindsCache) {
             dropTable(kind);
         }

datastore/src/test/java/io/spine/server/storage/datastore/TestDatastoreWrapper.java

@@ -118,7 +118,7 @@ private Ci() {
                 ServiceAccountCredentials credentials = fromStream(bufferedStream);
                 builder().setCredentials(credentials);
             } catch (@SuppressWarnings("OverlyBroadCatchBlock") IOException e) {
-                log().warn("Cannot find the credentials file {}.", CREDENTIALS_FILE_PATH);
+                _warn().log("Cannot find the credentials file `%s`.", CREDENTIALS_FILE_PATH);
             }
         }
     }

datastore/src/test/java/io/spine/server/storage/datastore/given/TestDatastores.java

@@ -32,6 +32,8 @@
 import io.spine.server.BoundedContext;
 import io.spine.server.BoundedContextBuilder;
 import io.spine.testing.TestValues;
+import org.junit.jupiter.api.AfterEach;
+import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.DisplayName;
 import org.junit.jupiter.api.Test;
 
@@ -61,13 +63,27 @@ class NamespaceIndexTest {
 
     private static final NsConverterFactory converterFactory = NsConverterFactory.defaults();
 
+    private NamespaceIndex namespaceIndex;
+    private BoundedContext context;
+
     private static TenantId newTenantId() {
         return TenantId
                 .newBuilder()
                 .setValue(TestValues.randomString())
                 .vBuild();
     }
 
+    @BeforeEach
+    void createIndex() {
+        namespaceIndex = nsIndex();
+        context = BoundedContextBuilder.assumingTests().build();
+    }
+
+    @AfterEach
+    void closeContext() throws Exception {
+        context.close();
+    }
+
     @Test
     @DisplayName(NOT_ACCEPT_NULLS)
     void testNulls() {
@@ -77,17 +93,13 @@ void testNulls() {
         new NullPointerTester()
                 .setDefault(Namespace.class, defaultNamespace)
                 .setDefault(TenantId.class, tenantId)
-                .setDefault(BoundedContext.class, BoundedContextBuilder.assumingTests()
-                                                                       .build())
-                .testInstanceMethods(nsIndex(),
-                                     NullPointerTester.Visibility.PACKAGE);
+                .setDefault(BoundedContext.class, context)
+                .testInstanceMethods(namespaceIndex, NullPointerTester.Visibility.PACKAGE);
     }
 
     @Test
     @DisplayName("store tenant IDs")
     void testStore() {
-        NamespaceIndex namespaceIndex = nsIndex();
-
         Set<TenantId> initialEmptySet = namespaceIndex.all();
         assertTrue(initialEmptySet.isEmpty());
 
@@ -107,8 +119,6 @@ void testStore() {
     @Test
     @DisplayName("do nothing on close")
     void testClose() {
-        NamespaceIndex namespaceIndex = nsIndex();
-
         namespaceIndex.close();
         namespaceIndex.close();
         // No exception is thrown on the second call to #close() => no operation is performed
@@ -117,8 +127,6 @@ void testClose() {
     @Test
     @DisplayName("find existing namespaces")
     void testFindExisting() {
-        NamespaceIndex namespaceIndex = nsIndex();
-
         // Ensure no namespace has been kept
         Set<TenantId> initialEmptySet = namespaceIndex.all();
         assertTrue(initialEmptySet.isEmpty());
@@ -133,8 +141,6 @@ void testFindExisting() {
     @Test
     @DisplayName("not find non-existing namespaces")
     void testNotFindNonExisting() {
-        NamespaceIndex namespaceIndex = nsIndex();
-
         // Ensure no namespace has been kept
         Set<TenantId> initialEmptySet = namespaceIndex.all();
         assertTrue(initialEmptySet.isEmpty());
@@ -152,6 +158,14 @@ void testAsync() {
                       NamespaceIndexTest::testSynchronizeAccessMethods);
     }
 
+    @Test
+    @DisplayName("confirm registration")
+    void registered() {
+        namespaceIndex.registerWith(context);
+        assertThat(namespaceIndex.isRegistered())
+                .isTrue();
+    }
+
     @SuppressWarnings("OverlyLongMethod")
     private static void testSynchronizeAccessMethods() throws InterruptedException {
         // Initial data