Make CoreSchema a plain schema (not a proxy) [ECR-3865] (#1303)

Make CoreSchema a plain schema — a factory of Exonum indexes.

The existing ITs in BlockchainIntegrationTest adequately cover
the operations now implemented in Java CoreSchema.

Also, push CoreSchema#getLastBlock to Blockchain.

Author: dmitry-timofeev

exonum-java-binding/core/rust/src/storage/core_schema.rs

@@ -12,7 +12,6 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-mod core_schema;
 mod db;
 mod entry;
 mod fork;
@@ -27,7 +26,6 @@ mod raw_proof_map_index;
 mod temporarydb;
 mod value_set_index;
 
-pub use self::core_schema::*;
 pub use self::db::Java_com_exonum_binding_core_storage_database_Views_nativeFree;
 pub(crate) use self::db::View;
 pub use self::entry::*;

exonum-java-binding/core/rust/src/storage/mod.rs

@@ -17,6 +17,7 @@
 package com.exonum.binding.core.blockchain;
 
 import static com.google.common.base.Preconditions.checkArgument;
+import static com.google.common.base.Preconditions.checkState;
 
 import com.exonum.binding.common.blockchain.TransactionLocation;
 import com.exonum.binding.common.hash.HashCode;
@@ -42,18 +43,18 @@
  */
 public final class Blockchain {
 
-  private final CoreSchemaProxy schema;
+  private final CoreSchema schema;
 
   @VisibleForTesting
-  Blockchain(CoreSchemaProxy schema) {
+  Blockchain(CoreSchema schema) {
     this.schema = schema;
   }
 
   /**
    * Constructs a new blockchain instance for the given database view.
    */
   public static Blockchain newInstance(View view) {
-    CoreSchemaProxy coreSchema = CoreSchemaProxy.newInstance(view);
+    CoreSchema coreSchema = CoreSchema.newInstance(view);
     return new Blockchain(coreSchema);
   }
 
@@ -225,10 +226,14 @@ public Optional<Block> findBlock(HashCode blockHash) {
   /**
    * Returns the latest committed block.
    *
-   * @throws RuntimeException if the "genesis block" was not created
+   * @throws IllegalStateException if the "genesis block" was not created
    */
   public Block getLastBlock() {
-    return schema.getLastBlock();
+    ListIndex<HashCode> blockHashes = getBlockHashes();
+    checkState(!blockHashes.isEmpty(),
+        "No genesis block created yet (block hashes list is empty)");
+    HashCode lastBlockHash = blockHashes.getLast();
+    return getBlocks().get(lastBlockHash);
   }
 
   /**

exonum-java-binding/core/src/main/java/com/exonum/binding/core/blockchain/Blockchain.java

@@ -27,9 +27,6 @@
 import com.exonum.binding.common.serialization.StandardSerializers;
 import com.exonum.binding.core.blockchain.serialization.BlockSerializer;
 import com.exonum.binding.core.blockchain.serialization.TransactionLocationSerializer;
-import com.exonum.binding.core.proxy.Cleaner;
-import com.exonum.binding.core.proxy.NativeHandle;
-import com.exonum.binding.core.proxy.ProxyDestructor;
 import com.exonum.binding.core.storage.database.View;
 import com.exonum.binding.core.storage.indices.EntryIndexProxy;
 import com.exonum.binding.core.storage.indices.KeySetIndexProxy;
@@ -39,24 +36,22 @@
 import com.exonum.binding.core.storage.indices.MapIndexProxy;
 import com.exonum.binding.core.storage.indices.ProofListIndexProxy;
 import com.exonum.binding.core.storage.indices.ProofMapIndexProxy;
-import com.exonum.binding.core.util.LibraryLoader;
 import com.exonum.core.messages.Blockchain.Config;
 import com.exonum.core.messages.Runtime.ExecutionStatus;
 import java.nio.ByteBuffer;
 import java.nio.ByteOrder;
 
 /**
- * A proxy class for the blockchain::Schema struct maintained by Exonum core.
- * Please refer to the
- * <a href="https://docs.rs/exonum/latest/exonum/blockchain/struct.Schema.html">doc</a> for details.
+ * Information schema for indices maintained by the Exonum core logic.
+ *
+ * <p>Indices defined by this schema are present in the blockchain regardless of the deployed
+ * services and store general-purpose information, such as committed transactions.
+ *
+ * @see <a href="https://docs.rs/exonum/latest/exonum/blockchain/struct.Schema.html">
+ *     Definition in Exonum</a>
  */
-final class CoreSchemaProxy {
+final class CoreSchema {
 
-  static {
-    LibraryLoader.load();
-  }
-
-  private final NativeHandle nativeHandle;
   private final View dbView;
   private static final Serializer<Block> BLOCK_SERIALIZER = BlockSerializer.INSTANCE;
   private static final Serializer<TransactionLocation> TRANSACTION_LOCATION_SERIALIZER =
@@ -68,32 +63,28 @@ final class CoreSchemaProxy {
   private static final Serializer<Config> CONSENSUS_CONFIG_SERIALIZER =
       StandardSerializers.protobuf(Config.class);
 
-  private CoreSchemaProxy(NativeHandle nativeHandle, View dbView) {
-    this.nativeHandle = nativeHandle;
+  private CoreSchema(View dbView) {
     this.dbView = dbView;
   }
 
   /**
-   * Constructs a schema proxy for a given dbView.
+   * Constructs a schema for a given dbView.
    */
-  static CoreSchemaProxy newInstance(View dbView) {
-    long nativePointer = nativeCreate(dbView.getViewNativeHandle());
-    NativeHandle nativeHandle = new NativeHandle(nativePointer);
-
-    Cleaner cleaner = dbView.getCleaner();
-    ProxyDestructor.newRegistered(cleaner, nativeHandle, CoreSchemaProxy.class,
-        CoreSchemaProxy::nativeFree);
-
-    return new CoreSchemaProxy(nativeHandle, dbView);
+  static CoreSchema newInstance(View dbView) {
+    return new CoreSchema(dbView);
   }
 
   /**
    * Returns the height of the latest committed block.
    *
-   * @throws RuntimeException if the "genesis block" was not created
+   * @throws IllegalStateException if the "genesis block" was not created
    */
   long getHeight() {
-    return nativeGetHeight(nativeHandle.get());
+    // The blockchain height is equal to the number of blocks (incl. genesis) minus one
+    ListIndex<HashCode> blockHashes = getBlockHashes();
+    checkState(!blockHashes.isEmpty(),
+        "No genesis block created yet (block hashes list is empty)");
+    return blockHashes.size() - 1;
   }
 
   /**
@@ -131,15 +122,6 @@ MapIndex<HashCode, Block> getBlocks() {
         CoreIndex.BLOCKS, dbView, StandardSerializers.hash(), BLOCK_SERIALIZER);
   }
 
-  /**
-   * Returns the latest committed block.
-   *
-   * @throws RuntimeException if the "genesis block" was not created
-   */
-  Block getLastBlock() {
-    return BLOCK_SERIALIZER.fromBytes(nativeGetLastBlock(nativeHandle.get()));
-  }
-
   /**
    * Returns a map of transaction messages identified by their SHA-256 hashes.
    */
@@ -191,19 +173,6 @@ Config getConsensusConfiguration() {
     return configEntry.get();
   }
 
-  private static native long nativeCreate(long viewNativeHandle);
-
-  private static native void nativeFree(long nativeHandle);
-
-  private static native long nativeGetHeight(long nativeHandle);
-
-  /**
-   * Returns the latest committed block.
-   *
-   * @throws RuntimeException if the "genesis block" was not created
-   */
-  private static native byte[] nativeGetLastBlock(long nativeHandle);
-
   private byte[] toCoreStorageKey(long value) {
     return ByteBuffer.allocate(Long.BYTES)
         .order(ByteOrder.BIG_ENDIAN)

…ing/core/blockchain/CoreSchemaProxy.java …/binding/core/blockchain/CoreSchema.javaexonum-java-binding/core/src/main/java/com/exonum/binding/core/blockchain/CoreSchemaProxy.java renamed to exonum-java-binding/core/src/main/java/com/exonum/binding/core/blockchain/CoreSchema.java exonum-java-binding/core/src/main/java/com/exonum/binding/core/blockchain/CoreSchemaProxy.java renamed to exonum-java-binding/core/src/main/java/com/exonum/binding/core/blockchain/CoreSchema.java

@@ -33,11 +33,11 @@
 import org.junit.jupiter.api.Test;
 
 @RequiresNativeLibrary
-class CoreSchemaProxyIntegrationTest {
+class CoreSchemaIntegrationTest {
 
   @Test
   void getHeightBeforeGenesisBlockTest() {
-    assertSchema((schema) -> assertThrows(RuntimeException.class, schema::getHeight));
+    assertSchema((schema) -> assertThrows(IllegalStateException.class, schema::getHeight));
   }
 
   @Test
@@ -49,10 +49,9 @@ void getAllBlockHashesTest() {
   void getBlockTransactionsTest() {
     assertSchema((schema) -> {
       long height = 0L;
-      Exception e = assertThrows(RuntimeException.class,
+      Exception e = assertThrows(IllegalStateException.class,
           () -> schema.getBlockTransactions(height));
-      assertThat(e).hasMessageContaining("An attempt to get the actual `height` "
-          + "during creating the genesis block");
+      assertThat(e).hasMessageContaining("No genesis block created");
     });
   }
 
@@ -67,11 +66,6 @@ void getBlocksTest() {
     assertSchema((schema) -> assertTrue(schema.getBlocks().isEmpty()));
   }
 
-  @Test
-  void getLastBlockBeforeGenesisBlockTest() {
-    assertSchema((schema) -> assertThrows(RuntimeException.class, schema::getLastBlock));
-  }
-
   @Test
   void getTxMessagesTest() {
     assertSchema((schema) -> assertTrue(schema.getTxMessages().isEmpty()));
@@ -95,10 +89,10 @@ void getTransactionPool() {
     });
   }
 
-  private static void assertSchema(Consumer<CoreSchemaProxy> assertion) {
+  private static void assertSchema(Consumer<CoreSchema> assertion) {
     try (TemporaryDb db = TemporaryDb.newInstance(); Cleaner cleaner = new Cleaner()) {
       Snapshot view = db.createSnapshot(cleaner);
-      assertion.accept(CoreSchemaProxy.newInstance(view));
+      assertion.accept(CoreSchema.newInstance(view));
     } catch (CloseFailuresException e) {
       fail(e.getLocalizedMessage());
     }

…hain/CoreSchemaProxyIntegrationTest.java …lockchain/CoreSchemaIntegrationTest.javaexonum-java-binding/core/src/test/java/com/exonum/binding/core/blockchain/CoreSchemaProxyIntegrationTest.java renamed to exonum-java-binding/core/src/test/java/com/exonum/binding/core/blockchain/CoreSchemaIntegrationTest.java exonum-java-binding/core/src/test/java/com/exonum/binding/core/blockchain/CoreSchemaProxyIntegrationTest.java renamed to exonum-java-binding/core/src/test/java/com/exonum/binding/core/blockchain/CoreSchemaIntegrationTest.java

@@ -59,6 +59,8 @@
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Nested;
 import org.junit.jupiter.api.Test;
+import org.junit.jupiter.params.ParameterizedTest;
+import org.junit.jupiter.params.provider.ValueSource;
 
 class BlockchainIntegrationTest {
 
@@ -147,7 +149,7 @@ void containsBlock() {
     @Test
     void getHeight() {
       testKitTest((blockchain) -> {
-        long expectedHeight = 1;
+        long expectedHeight = 1L;
         assertThat(blockchain.getHeight()).isEqualTo(expectedHeight);
       });
     }
@@ -209,6 +211,18 @@ void getBlockTransactionsByInvalidHeight() {
       });
     }
 
+    @ParameterizedTest
+    @ValueSource(longs = {-1, -2, Long.MIN_VALUE})
+    void getBlockTransactionsByNegativeHeight(long height) {
+      testKitTest((blockchain) -> {
+        Exception e = assertThrows(IllegalArgumentException.class,
+            () -> blockchain.getBlockTransactions(height));
+        assertThat(e.getMessage()).containsIgnoringCase("negative")
+            .containsIgnoringCase("height")
+            .contains(Long.toString(height));
+      });
+    }
+
     @Test
     void getBlockTransactionsByHash() {
       testKitTest((blockchain) -> {