Migrate to new RecordSpec API.

armiol · armiol · commit cc1501a71ec9 · 2023-11-08T15:46:06.000Z
diff --git a/datastore/src/main/java/io/spine/server/storage/datastore/DatastoreStorageFactory.java b/datastore/src/main/java/io/spine/server/storage/datastore/DatastoreStorageFactory.java
@@ -158,7 +158,7 @@ public BoundedContextBuilder configureTenantIndex(BoundedContextBuilder builder)
 
     @Override
     public <I, R extends Message> RecordStorage<I, R>
-    createRecordStorage(ContextSpec context, RecordSpec<I, R, ?> spec) {
+    createRecordStorage(ContextSpec context, RecordSpec<I, R> spec) {
         checkNotNull(context);
         checkNotNull(spec);
         var config = configurationWith(context, spec);
@@ -170,7 +170,7 @@ public BoundedContextBuilder configureTenantIndex(BoundedContextBuilder builder)
     }
 
     private <I, R extends Message>
-    StorageConfiguration<I, R> configurationWith(ContextSpec context, RecordSpec<I, R, ?> spec) {
+    StorageConfiguration<I, R> configurationWith(ContextSpec context, RecordSpec<I, R> spec) {
         var wrapper = wrapperFor(context);
         var recordType = spec.sourceType();
         var behavior = txSettings.find(recordType);
diff --git a/datastore/src/main/java/io/spine/server/storage/datastore/config/CustomStorages.java b/datastore/src/main/java/io/spine/server/storage/datastore/config/CustomStorages.java
@@ -68,7 +68,7 @@ private CustomStorages(Builder builder) {
      * @return a callback to create a custom storage wrapped into {@code Optional},
      *         or {@code Optional.empty()} in case none was found
      */
-    public <I, R extends Message> Optional<CreateStorage<I, R>> find(RecordSpec<I, R, ?> spec) {
+    public <I, R extends Message> Optional<CreateStorage<I, R>> find(RecordSpec<I, R> spec) {
         var domainType = spec.sourceType();
         var optional = findValue(domainType);
         Optional<CreateStorage<I, R>> result =
@@ -117,7 +117,7 @@ Builder self() {
          * this builder.
          */
         @Override
-        public final CustomStorages build() {
+        public CustomStorages build() {
             return new CustomStorages(this);
         }
     }
diff --git a/datastore/src/main/java/io/spine/server/storage/datastore/config/StorageConfiguration.java b/datastore/src/main/java/io/spine/server/storage/datastore/config/StorageConfiguration.java
@@ -86,7 +86,7 @@ public DsEntitySpec<I, R> recordSpec() {
      */
     public Class<R> storedType() {
         return recordSpec.recordSpec()
-                         .storedType();
+                         .recordType();
     }
 
     /**
diff --git a/datastore/src/main/java/io/spine/server/storage/datastore/delivery/DsSessionStorage.java b/datastore/src/main/java/io/spine/server/storage/datastore/delivery/DsSessionStorage.java
@@ -32,7 +32,7 @@
 import io.spine.server.ContextSpec;
 import io.spine.server.delivery.ShardIndex;
 import io.spine.server.delivery.ShardSessionRecord;
-import io.spine.server.storage.MessageRecordSpec;
+import io.spine.server.storage.RecordSpec;
 import io.spine.server.storage.RecordWithColumns;
 import io.spine.server.storage.datastore.DatastoreStorageFactory;
 import io.spine.server.storage.datastore.config.StorageConfiguration;
@@ -64,7 +64,7 @@ public final class DsSessionStorage
         extends DsRecordStorage<ShardIndex, ShardSessionRecord> {
 
     private static final boolean multitenant = false;
-    private final MessageRecordSpec<ShardIndex, ShardSessionRecord> spec;
+    private final RecordSpec<ShardIndex, ShardSessionRecord> spec;
 
     /**
      * Creates a new instance of this storage.
@@ -104,9 +104,9 @@ private static DsEntitySpec<ShardIndex, ShardSessionRecord> newRecordSpec() {
         return result;
     }
 
-    private static MessageRecordSpec<ShardIndex, ShardSessionRecord> messageSpec() {
+    private static RecordSpec<ShardIndex, ShardSessionRecord> messageSpec() {
         @SuppressWarnings("ConstantConditions")     /* Protobuf getters never return `nulls`. */
-                var spec = new MessageRecordSpec<>(
+                var spec = new RecordSpec<>(
                 ShardIndex.class,
                 ShardSessionRecord.class,
                 ShardSessionRecord::getIndex,
diff --git a/datastore/src/main/java/io/spine/server/storage/datastore/record/DsEntitySpec.java b/datastore/src/main/java/io/spine/server/storage/datastore/record/DsEntitySpec.java
@@ -52,7 +52,7 @@
  */
 public final class DsEntitySpec<I, R extends Message> {
 
-    private final RecordSpec<I, R, ?> recordSpec;
+    private final RecordSpec<I, R> recordSpec;
     private final RecordLayout<I, R> layout;
 
     /**
@@ -63,7 +63,7 @@ public final class DsEntitySpec<I, R extends Message> {
      * @param layout
      *         ancestor-children structure to use for Datastore Entities
      */
-    public DsEntitySpec(RecordSpec<I, R, ?> recordSpec, RecordLayout<I, R> layout) {
+    public DsEntitySpec(RecordSpec<I, R> recordSpec, RecordLayout<I, R> layout) {
         this.recordSpec = checkNotNull(recordSpec);
         this.layout = checkNotNull(layout);
     }
@@ -75,14 +75,14 @@ public DsEntitySpec(RecordSpec<I, R, ?> recordSpec, RecordLayout<I, R> layout) {
      * @param recordSpec
      *         specification telling which fields of Protobuf message to store in Datastore Entity
      */
-    public DsEntitySpec(RecordSpec<I, R, ?> recordSpec) {
+    public DsEntitySpec(RecordSpec<I, R> recordSpec) {
         this(recordSpec, new FlatLayout<>(recordSpec.sourceType()));
     }
 
     /**
      * Returns the storage specification for the persisted Protobuf message.
      */
-    public RecordSpec<I, R, ?> recordSpec() {
+    public RecordSpec<I, R> recordSpec() {
         return recordSpec;
     }
 
diff --git a/datastore/src/main/java/io/spine/server/storage/datastore/record/DsRecordStorage.java b/datastore/src/main/java/io/spine/server/storage/datastore/record/DsRecordStorage.java
@@ -102,7 +102,7 @@ public Iterator<I> index() {
     protected Iterator<I> index(RecordQuery<I, R> query) {
         var spec = recordSpec();
         var recordIterator = readAllRecords(query);
-        var result = transform(recordIterator, spec::idFromRecord);
+        var result = transform(recordIterator, spec::idValueIn);
         return result;
     }
 
diff --git a/datastore/src/test/java/io/spine/server/storage/datastore/DatastoreStorageFactoryTest.java b/datastore/src/test/java/io/spine/server/storage/datastore/DatastoreStorageFactoryTest.java
@@ -30,7 +30,6 @@
 import com.google.cloud.datastore.DatastoreOptions;
 import com.google.cloud.datastore.Key;
 import com.google.common.testing.NullPointerTester;
-import com.google.common.truth.Truth8;
 import io.spine.base.Identifier;
 import io.spine.core.TenantId;
 import io.spine.server.BoundedContext;
@@ -55,11 +54,12 @@
 import org.junit.jupiter.api.Test;
 
 import static com.google.common.truth.Truth.assertThat;
+import static com.google.common.truth.Truth8.assertThat;
 import static io.spine.server.ContextSpec.multitenant;
 import static io.spine.server.storage.datastore.given.DatastoreStorageFactoryTestEnv.factoryFor;
 import static io.spine.server.storage.datastore.given.TestEnvironment.singleTenantSpec;
 import static io.spine.server.storage.datastore.given.TestRecordSpec.projectDetailsSpec;
-import static io.spine.server.storage.datastore.given.TestRecordSpec.stgProjectSpec;
+import static io.spine.server.storage.given.GivenStorageProject.messageSpec;
 import static io.spine.server.tenant.TenantAwareRunner.with;
 import static io.spine.testing.DisplayNames.NOT_ACCEPT_NULLS;
 import static io.spine.testing.server.storage.datastore.TestDatastores.defaultLocalProjectId;
@@ -85,7 +85,7 @@ final class DatastoreStorageFactoryTest {
     @DisplayName(NOT_ACCEPT_NULLS)
     void testNulls() {
         new NullPointerTester().setDefault(ContextSpec.class, singleTenantSpec())
-                               .setDefault(RecordSpec.class, stgProjectSpec())
+                               .setDefault(RecordSpec.class, messageSpec())
                                .testAllPublicInstanceMethods(factory);
     }
 
@@ -144,7 +144,7 @@ void namespaceForMultitenant() {
         var datastore = options.getService();
         var factory = factoryFor(datastore);
         var storage =
-                factory.createRecordStorage(spec, stgProjectSpec());
+                factory.createRecordStorage(spec, messageSpec());
         var key = writeForTenant(storage, tenant)
                 .setNamespace(namespace + ".V" + tenant.getValue())
                 .build();
@@ -162,7 +162,7 @@ void testDatastoreNamespaceInOptions() {
         var datastore = local();
         var factory = factoryFor(datastore);
         var storage =
-                factory.createRecordStorage(spec, stgProjectSpec());
+                factory.createRecordStorage(spec, messageSpec());
         var key = writeForTenant(storage, tenant)
                 .setNamespace('V' + tenant.getValue())
                 .build();
@@ -175,11 +175,11 @@ void testDatastoreNamespaceInOptions() {
     void testProduceBcBuilder() {
         DatastoreStorageFactory factory = TestDatastoreStorageFactory.local();
         var builder = BoundedContext.multitenant(testName());
-        Truth8.assertThat(builder.tenantIndex())
+        assertThat(builder.tenantIndex())
               .isEmpty();
         var updatedIndex = factory.configureTenantIndex(builder)
                                   .tenantIndex();
-        Truth8.assertThat(updatedIndex)
+        assertThat(updatedIndex)
               .isPresent();
         assertThat(updatedIndex.get()).isInstanceOf(TestNamespaceIndex.getType());
     }
@@ -194,14 +194,14 @@ void plainRecord() {
             var spec = ContextSpec.singleTenant(testName());
             var customStorage =
                     InMemoryStorageFactory.newInstance()
-                                          .createRecordStorage(spec, stgProjectSpec());
+                                          .createRecordStorage(spec, messageSpec());
             var factory = DatastoreStorageFactory.newBuilder()
                     .setDatastore(TestDatastores.local())
                     .useRecordStorage(StgProjectId.class, StgProject.class,
                                       configuration -> customStorage)
                     .build();
             var actualStorage =
-                    factory.createRecordStorage(spec, stgProjectSpec());
+                    factory.createRecordStorage(spec, messageSpec());
             assertThat(actualStorage).isEqualTo(customStorage);
         }
 
diff --git a/datastore/src/test/java/io/spine/server/storage/datastore/given/DatastoreStorageFactoryTestEnv.java b/datastore/src/test/java/io/spine/server/storage/datastore/given/DatastoreStorageFactoryTestEnv.java
@@ -27,8 +27,10 @@
 package io.spine.server.storage.datastore.given;
 
 import com.google.cloud.datastore.Datastore;
-import io.spine.server.entity.storage.EntityRecordSpec;
+import io.spine.server.entity.EntityRecord;
+import io.spine.server.entity.storage.SpecScanner;
 import io.spine.server.projection.Projection;
+import io.spine.server.storage.RecordSpec;
 import io.spine.server.storage.datastore.DatastoreStorageFactory;
 import io.spine.test.datastore.College;
 import io.spine.test.datastore.CollegeId;
@@ -62,16 +64,16 @@ public static DatastoreStorageFactory factoryFor(Datastore datastore) {
     public static class TestEntity
             extends Projection<StgProjectId, StgProject, StgProject.Builder> {
 
-        public static EntityRecordSpec<StgProjectId, StgProject, TestEntity> spec() {
-            return EntityRecordSpec.of(TestEntity.class);
+        public static RecordSpec<StgProjectId, EntityRecord> spec() {
+            return SpecScanner.scan(TestEntity.class);
         }
     }
 
     public static class DifferentTestEntity
             extends Projection<CollegeId, College, College.Builder> {
 
-        public static EntityRecordSpec<CollegeId, College, DifferentTestEntity> spec() {
-            return EntityRecordSpec.of(DifferentTestEntity.class);
+        public static RecordSpec<CollegeId, EntityRecord> spec() {
+            return SpecScanner.scan(DifferentTestEntity.class);
         }
     }
 }
diff --git a/datastore/src/test/java/io/spine/server/storage/datastore/given/TestRecordSpec.java b/datastore/src/test/java/io/spine/server/storage/datastore/given/TestRecordSpec.java
@@ -26,10 +26,10 @@
 
 package io.spine.server.storage.datastore.given;
 
-import com.google.common.collect.ImmutableSet;
-import io.spine.server.entity.storage.EntityRecordSpec;
+import io.spine.server.entity.EntityRecord;
+import io.spine.server.entity.storage.SpecScanner;
 import io.spine.server.projection.Projection;
-import io.spine.server.storage.MessageRecordSpec;
+import io.spine.server.storage.RecordSpec;
 import io.spine.test.storage.StgProject;
 import io.spine.test.storage.StgProjectId;
 
@@ -44,24 +44,12 @@ public final class TestRecordSpec {
     private TestRecordSpec() {
     }
 
-    /**
-     * Creates a new {@code MessageRecordSpec} describing how instances of {@link StgProject}
-     * message are stored.
-     *
-     * <p>Defines no record columns.
-     */
-    public static MessageRecordSpec<StgProjectId, StgProject> stgProjectSpec() {
-        return new MessageRecordSpec<>(
-                StgProjectId.class, StgProject.class, StgProject::getId, ImmutableSet.of()
-        );
-    }
-
     /**
      * Creates a new {@code EntityRecordSpec} describing how instances of {@link ProjectDetails}
      * projection are stored.
      */
-    public static EntityRecordSpec<StgProjectId, StgProject, ProjectDetails> projectDetailsSpec() {
-        return EntityRecordSpec.of(ProjectDetails.class);
+    public static RecordSpec<StgProjectId, EntityRecord> projectDetailsSpec() {
+        return SpecScanner.scan(ProjectDetails.class);
     }
 
     private static class ProjectDetails
diff --git a/datastore/src/test/java/io/spine/server/storage/datastore/record/DsRecordStorageTest.java b/datastore/src/test/java/io/spine/server/storage/datastore/record/DsRecordStorageTest.java
@@ -26,7 +26,6 @@
 
 package io.spine.server.storage.datastore.record;
 
-import io.spine.core.Versions;
 import io.spine.environment.Tests;
 import io.spine.server.ServerEnvironment;
 import io.spine.server.storage.RecordStorageDelegateTest;
@@ -44,10 +43,11 @@
 import org.junit.jupiter.api.Test;
 
 import static com.google.common.truth.Truth8.assertThat;
+import static io.spine.base.Identifier.newUuid;
 import static io.spine.base.Time.currentTime;
-import static io.spine.server.storage.given.StgColumn.due_date;
-import static io.spine.server.storage.given.StgColumn.project_version;
-import static io.spine.server.storage.given.StgColumn.status;
+import static io.spine.server.storage.given.GivenStorageProject.StgProjectColumns.due_date;
+import static io.spine.server.storage.given.GivenStorageProject.StgProjectColumns.name;
+import static io.spine.server.storage.given.GivenStorageProject.StgProjectColumns.status;
 import static org.junit.jupiter.api.Assertions.assertEquals;
 
 @DisplayName("`DsRecordStorage` should")
@@ -107,12 +107,12 @@ public StgProject newRecord(StgProjectId id) {
     void testPersistColumns() {
         var id = newId();
         var project = newStorageRecord(id);
-        var expectedVersion = Versions.newVersion(42, currentTime());
         var expectedDueDate = currentTime();
         var expectedStatus = StgProject.Status.STARTED;
+        var expectedName = newUuid();
         project = project
                 .toBuilder()
-                .setProjectVersion(expectedVersion)
+                .setName(expectedName)
                 .setDueDate(expectedDueDate)
                 .setStatus(expectedStatus)
                 .build();
@@ -135,9 +135,9 @@ void testPersistColumns() {
         assertEquals(expectedStatus.name(),
                      datastoreEntity.getString(status.name()
                                                      .value()));
-        assertEquals(expectedVersion.getNumber(),
-                     datastoreEntity.getLong(project_version.name()
-                                                            .value()));
+        assertEquals(expectedName,
+                     datastoreEntity.getString(name.name()
+                                                   .value()));
         var actualDueDate =
                 datastoreEntity.getTimestamp(due_date.name()
                                                      .value());
diff --git a/datastore/src/test/java/io/spine/server/storage/datastore/record/given/DsEntityColumnsTestEnv.java b/datastore/src/test/java/io/spine/server/storage/datastore/record/given/DsEntityColumnsTestEnv.java
@@ -33,7 +33,6 @@
 import com.google.cloud.datastore.Value;
 import com.google.common.collect.ImmutableList;
 import com.google.common.collect.ImmutableMap;
-import com.google.protobuf.Any;
 import com.google.protobuf.Timestamp;
 import com.google.protobuf.util.Durations;
 import com.google.protobuf.util.Timestamps;
@@ -43,7 +42,6 @@
 import io.spine.core.Versions;
 import io.spine.server.entity.EntityRecord;
 import io.spine.server.entity.storage.EntityRecordStorage;
-import io.spine.server.entity.storage.EntityRecordWithColumns;
 import io.spine.server.storage.ColumnTypeMapping;
 import io.spine.server.storage.datastore.DatastoreWrapper;
 import io.spine.server.storage.datastore.Kind;
@@ -80,8 +78,7 @@ private DsEntityColumnsTestEnv() {
                          DatastoreWrapper datastore,
                          Key key) {
         var record = toEntityRecord(college, version);
-        var recordWithCols = EntityRecordWithColumns.create(record, COLLEGE_CLS);
-        storage.write(recordWithCols);
+        storage.write(college.getId(), record);
         var response = datastore.read(key);
         checkArgument(response.isPresent());
         var storedDeadline = readAdmissionDeadline(response.get());
diff --git a/datastore/src/test/java/io/spine/server/storage/datastore/tenant/NamespaceIndexTest.java b/datastore/src/test/java/io/spine/server/storage/datastore/tenant/NamespaceIndexTest.java
@@ -37,7 +37,7 @@
 import io.spine.server.BoundedContextBuilder;
 import io.spine.server.ServerEnvironment;
 import io.spine.server.entity.EntityRecord;
-import io.spine.server.entity.storage.EntityRecordSpec;
+import io.spine.server.entity.storage.SpecScanner;
 import io.spine.server.storage.datastore.DatastoreStorageFactory;
 import io.spine.server.storage.datastore.given.CollegeProjection;
 import io.spine.test.datastore.College;
@@ -89,7 +89,7 @@ void createIndex() {
     }
 
     @AfterEach
-    void closeContext() throws Exception {
+    void closeContext() {
         context.close();
     }
 
@@ -170,7 +170,7 @@ void findPrefixedNamespaces() {
         storageFactory.configureTenantIndex(contextBuilder);
         var context = contextBuilder.build();
         var storage = storageFactory
-                .createRecordStorage(context.spec(), EntityRecordSpec.of(CollegeProjection.class));
+                .createRecordStorage(context.spec(), SpecScanner.scan(CollegeProjection.class));
         var id = CollegeId.newBuilder()
                 .setValue("Aeronautic Forgery College")
                 .build();

Original file line number	Diff line number	Diff line change
`@@ -86,7 +86,7 @@ public DsEntitySpec<I, R> recordSpec() {`
`86`	`86`	`*/`
`87`	`87`	`public Class<R> storedType() {`
`88`	`88`	`return recordSpec.recordSpec()`
`89`		`- .storedType();`
	`89`	`+ .recordType();`
`90`	`90`	`}`
`91`	`91`
`92`	`92`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -102,7 +102,7 @@ public Iterator<I> index() {`
`102`	`102`	`protected Iterator<I> index(RecordQuery<I, R> query) {`
`103`	`103`	`var spec = recordSpec();`
`104`	`104`	`var recordIterator = readAllRecords(query);`
`105`		`- var result = transform(recordIterator, spec::idFromRecord);`
	`105`	`+ var result = transform(recordIterator, spec::idValueIn);`
`106`	`106`	`return result;`
`107`	`107`	`}`
`108`	`108`
Original file line number	Diff line number	Diff line change
`@@ -27,8 +27,10 @@`
`27`	`27`	`package io.spine.server.storage.datastore.given;`
`28`	`28`
`29`	`29`	`import com.google.cloud.datastore.Datastore;`
`30`		`-import io.spine.server.entity.storage.EntityRecordSpec;`
	`30`	`+import io.spine.server.entity.EntityRecord;`
	`31`	`+import io.spine.server.entity.storage.SpecScanner;`
`31`	`32`	`import io.spine.server.projection.Projection;`
	`33`	`+import io.spine.server.storage.RecordSpec;`
`32`	`34`	`import io.spine.server.storage.datastore.DatastoreStorageFactory;`
`33`	`35`	`import io.spine.test.datastore.College;`
`34`	`36`	`import io.spine.test.datastore.CollegeId;`
`@@ -62,16 +64,16 @@ public static DatastoreStorageFactory factoryFor(Datastore datastore) {`
`62`	`64`	`public static class TestEntity`
`63`	`65`	`extends Projection<StgProjectId, StgProject, StgProject.Builder> {`
`64`	`66`
`65`		`- public static EntityRecordSpec<StgProjectId, StgProject, TestEntity> spec() {`
`66`		`- return EntityRecordSpec.of(TestEntity.class);`
	`67`	`+ public static RecordSpec<StgProjectId, EntityRecord> spec() {`
	`68`	`+ return SpecScanner.scan(TestEntity.class);`
`67`	`69`	`}`
`68`	`70`	`}`
`69`	`71`
`70`	`72`	`public static class DifferentTestEntity`
`71`	`73`	`extends Projection<CollegeId, College, College.Builder> {`
`72`	`74`
`73`		`- public static EntityRecordSpec<CollegeId, College, DifferentTestEntity> spec() {`
`74`		`- return EntityRecordSpec.of(DifferentTestEntity.class);`
	`75`	`+ public static RecordSpec<CollegeId, EntityRecord> spec() {`
	`76`	`+ return SpecScanner.scan(DifferentTestEntity.class);`
`75`	`77`	`}`
`76`	`78`	`}`
`77`	`79`	`}`