Merge branch 'dev' into sync

greenrobot · greenrobot · commit 5ef35b2d2a31 · 2020-08-20T20:16:44.000+02:00
diff --git a/README.md b/README.md
@@ -6,7 +6,7 @@
 ObjectBox is a superfast object-oriented database with strong relation support.
 ObjectBox is embedded into your Android, Linux, macOS, or Windows app.
 
-**Latest version: [2.7.0 (2020/07/30)](https://docs.objectbox.io/#objectbox-changelog)**
+**Latest version: [2.7.1 (2020/08/19)](https://docs.objectbox.io/#objectbox-changelog)**
 
 Demo code using ObjectBox:
 
@@ -33,7 +33,7 @@ Add this to your root build.gradle (project level):
 
 ```groovy
 buildscript {
-    ext.objectboxVersion = '2.7.0'
+    ext.objectboxVersion = '2.7.1'
     dependencies {
         classpath "io.objectbox:objectbox-gradle-plugin:$objectboxVersion"
     }
diff --git a/build.gradle b/build.gradle
@@ -1,7 +1,7 @@
 buildscript {
     ext {
         // Typically, only edit those two:
-        def objectboxVersionNumber = '2.7.1' // without "-SNAPSHOT", e.g. '2.5.0' or '2.4.0-RC'
+        def objectboxVersionNumber = '2.7.2' // without "-SNAPSHOT", e.g. '2.5.0' or '2.4.0-RC'
         def objectboxVersionRelease = false  // set to true for releasing to ignore versionPostFix to avoid e.g. "-dev" versions
 
         // version post fix: '-<value>' or '' if not defined; e.g. used by CI to pass in branch name
@@ -21,7 +21,7 @@ buildscript {
 
         junit_version = '4.13'
         mockito_version = '3.3.3'
-        kotlin_version = '1.3.72'
+        kotlin_version = '1.4.0'
         dokka_version = '0.10.1'
 
         println "version=$ob_version"
diff --git a/objectbox-java/spotbugs-exclude.xml b/objectbox-java/spotbugs-exclude.xml
@@ -1,7 +1,14 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <FindBugsFilter>
+    <!-- Hint: to use regex, prefix with ~. https://spotbugs.readthedocs.io/en/stable/filter.html -->
+    <!-- Exclude FlatBuffers generated code, compare with /scripts/flatc-idls.sh of core project. -->
     <Match>
-        <!-- Exclude FlatBuffers generated code. -->
-        <Class name="~io\.objectbox\.model\.Model.*" />
+        <Class name="io.objectbox.DebugFlags" />
+    </Match>
+    <Match>
+        <Package name="io.objectbox.model" />
+    </Match>
+    <Match>
+        <Class name="io.objectbox.query.OrderFlags" />
     </Match>
 </FindBugsFilter>
diff --git a/objectbox-java/src/main/java/io/objectbox/BoxStore.java b/objectbox-java/src/main/java/io/objectbox/BoxStore.java
@@ -67,9 +67,9 @@ public class BoxStore implements Closeable {
     @Nullable private static Object relinker;
 
     /** Change so ReLinker will update native library when using workaround loading. */
-    public static final String JNI_VERSION = "2.7.0";
+    public static final String JNI_VERSION = "2.7.1";
 
-    private static final String VERSION = "2.7.0-2020-07-30";
+    private static final String VERSION = "2.7.2-2020-08-19";
     private static BoxStore defaultStore;
 
     /** Currently used DB dirs with values from {@link #getCanonicalPath(File)}. */
@@ -253,47 +253,52 @@ public static boolean isSyncServerAvailable() {
         canonicalPath = getCanonicalPath(directory);
         verifyNotAlreadyOpen(canonicalPath);
 
-        handle = nativeCreateWithFlatOptions(builder.buildFlatStoreOptions(canonicalPath), builder.model);
-        int debugFlags = builder.debugFlags;
-        if (debugFlags != 0) {
-            debugTxRead = (debugFlags & DebugFlags.LOG_TRANSACTIONS_READ) != 0;
-            debugTxWrite = (debugFlags & DebugFlags.LOG_TRANSACTIONS_WRITE) != 0;
-        } else {
-            debugTxRead = debugTxWrite = false;
-        }
-        debugRelations = builder.debugRelations;
+        try {
+            handle = nativeCreateWithFlatOptions(builder.buildFlatStoreOptions(canonicalPath), builder.model);
+            int debugFlags = builder.debugFlags;
+            if (debugFlags != 0) {
+                debugTxRead = (debugFlags & DebugFlags.LOG_TRANSACTIONS_READ) != 0;
+                debugTxWrite = (debugFlags & DebugFlags.LOG_TRANSACTIONS_WRITE) != 0;
+            } else {
+                debugTxRead = debugTxWrite = false;
+            }
+            debugRelations = builder.debugRelations;
 
-        for (EntityInfo<?> entityInfo : builder.entityInfoList) {
-            try {
-                dbNameByClass.put(entityInfo.getEntityClass(), entityInfo.getDbName());
-                int entityId = nativeRegisterEntityClass(handle, entityInfo.getDbName(), entityInfo.getEntityClass());
-                entityTypeIdByClass.put(entityInfo.getEntityClass(), entityId);
-                classByEntityTypeId.put(entityId, entityInfo.getEntityClass());
-                propertiesByClass.put(entityInfo.getEntityClass(), entityInfo);
-                for (Property<?> property : entityInfo.getAllProperties()) {
-                    if (property.customType != null) {
-                        if (property.converterClass == null) {
-                            throw new RuntimeException("No converter class for custom type of " + property);
+            for (EntityInfo<?> entityInfo : builder.entityInfoList) {
+                try {
+                    dbNameByClass.put(entityInfo.getEntityClass(), entityInfo.getDbName());
+                    int entityId = nativeRegisterEntityClass(handle, entityInfo.getDbName(), entityInfo.getEntityClass());
+                    entityTypeIdByClass.put(entityInfo.getEntityClass(), entityId);
+                    classByEntityTypeId.put(entityId, entityInfo.getEntityClass());
+                    propertiesByClass.put(entityInfo.getEntityClass(), entityInfo);
+                    for (Property<?> property : entityInfo.getAllProperties()) {
+                        if (property.customType != null) {
+                            if (property.converterClass == null) {
+                                throw new RuntimeException("No converter class for custom type of " + property);
+                            }
+                            nativeRegisterCustomType(handle, entityId, 0, property.dbName, property.converterClass,
+                                    property.customType);
                         }
-                        nativeRegisterCustomType(handle, entityId, 0, property.dbName, property.converterClass,
-                                property.customType);
                     }
+                } catch (RuntimeException e) {
+                    throw new RuntimeException("Could not setup up entity " + entityInfo.getEntityClass(), e);
                 }
-            } catch (RuntimeException e) {
-                throw new RuntimeException("Could not setup up entity " + entityInfo.getEntityClass(), e);
             }
-        }
-        int size = classByEntityTypeId.size();
-        allEntityTypeIds = new int[size];
-        long[] entityIdsLong = classByEntityTypeId.keys();
-        for (int i = 0; i < size; i++) {
-            allEntityTypeIds[i] = (int) entityIdsLong[i];
-        }
+            int size = classByEntityTypeId.size();
+            allEntityTypeIds = new int[size];
+            long[] entityIdsLong = classByEntityTypeId.keys();
+            for (int i = 0; i < size; i++) {
+                allEntityTypeIds[i] = (int) entityIdsLong[i];
+            }
 
-        objectClassPublisher = new ObjectClassPublisher(this);
+            objectClassPublisher = new ObjectClassPublisher(this);
 
-        failedReadTxAttemptCallback = builder.failedReadTxAttemptCallback;
-        queryAttempts = Math.max(builder.queryAttempts, 1);
+            failedReadTxAttemptCallback = builder.failedReadTxAttemptCallback;
+            queryAttempts = Math.max(builder.queryAttempts, 1);
+        } catch (RuntimeException runtimeException) {
+            close();  // Proper clean up, e.g. delete native handle, remove this path from openFiles
+            throw runtimeException;
+        }
     }
 
     static String getCanonicalPath(File directory) {
diff --git a/objectbox-java/src/main/java/io/objectbox/exception/DbExceptionListener.java b/objectbox-java/src/main/java/io/objectbox/exception/DbExceptionListener.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2018 ObjectBox Ltd. All rights reserved.
+ * Copyright 2018-2020 ObjectBox Ltd. All rights reserved.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -16,11 +16,30 @@
 
 package io.objectbox.exception;
 
+import io.objectbox.annotation.apihint.Experimental;
+
 /**
  * Listener for exceptions occurring during database operations.
  * Set via {@link io.objectbox.BoxStore#setDbExceptionListener(DbExceptionListener)}.
  */
 public interface DbExceptionListener {
+    /**
+     * WARNING/DISCLAIMER: Please avoid this method and handle exceptions "properly" instead.
+     * By using this method, you "hack" into the exception handling by preventing native core exceptions to be
+     * raised in Java. This typically results in methods returning zero or null regardless if this breaks any
+     * non-zero or non-null contract that would be in place otherwise. Additionally, "canceling" exceptions
+     * may lead to unforeseen follow-up errors that would never occur otherwise. In short, by using this method
+     * you are accepting undefined behavior.
+     * <p>
+     * Also note that it is likely that this method will never graduate from @{@link Experimental} until it is removed.
+     * <p>
+     * This method may be only called from {@link #onDbException(Exception)}.
+     */
+    @Experimental
+    static void cancelCurrentException() {
+        DbExceptionListenerJni.nativeCancelCurrentException();
+    }
+
     /**
      * Called when an exception is thrown during a database operation.
      * Do NOT throw exceptions in this method: throw exceptions are ignored (but logged to stderr).
@@ -29,3 +48,12 @@ public interface DbExceptionListener {
      */
     void onDbException(Exception e);
 }
+
+/**
+ * Interface cannot have native methods.
+ */
+class DbExceptionListenerJni {
+    native static void nativeCancelCurrentException();
+
+    native static void nativeThrowException(long nativeStore, int exNo);
+}
diff --git a/objectbox-java/src/main/java/io/objectbox/exception/PagesCorruptException.java b/objectbox-java/src/main/java/io/objectbox/exception/PagesCorruptException.java
@@ -0,0 +1,27 @@
+/*
+ * Copyright 2020 ObjectBox Ltd. All rights reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package io.objectbox.exception;
+
+/** Errors were detected in a file related to pages, e.g. illegal values or structural inconsistencies. */
+public class PagesCorruptException extends FileCorruptException {
+    public PagesCorruptException(String message) {
+        super(message);
+    }
+
+    public PagesCorruptException(String message, int errorCode) {
+        super(message, errorCode);
+    }
+}
diff --git a/tests/objectbox-java-test/src/test/java/io/objectbox/BoxStoreBuilderTest.java b/tests/objectbox-java-test/src/test/java/io/objectbox/BoxStoreBuilderTest.java
@@ -16,7 +16,7 @@
 
 package io.objectbox;
 
-import io.objectbox.exception.FileCorruptException;
+import io.objectbox.exception.PagesCorruptException;
 import io.objectbox.model.ValidateOnOpenMode;
 import org.greenrobot.essentials.io.IoUtils;
 import org.junit.Before;
@@ -152,18 +152,13 @@ public void validateOnOpen() {
     }
 
 
-    @Test(expected = FileCorruptException.class)
+    @Test(expected = PagesCorruptException.class)
     public void validateOnOpenCorruptFile() throws IOException {
         File dir = prepareTempDir("object-store-test-corrupted");
-        assertTrue(dir.mkdir());
-        File badDataFile = new File(dir, "data.mdb");
-        try (InputStream badIn = getClass().getResourceAsStream("corrupt-pageno-in-branch-data.mdb")) {
-            try (FileOutputStream badOut = new FileOutputStream(badDataFile)) {
-                IoUtils.copyAllBytes(badIn, badOut);
-            }
-        }
+        File badDataFile = prepareBadDataFile(dir);
+
         builder = BoxStoreBuilder.createDebugWithoutModel().directory(dir);
-        builder.validateOnOpen(ValidateOnOpenMode.AllBranches);
+        builder.validateOnOpen(ValidateOnOpenMode.Full);
         try {
             store = builder.build();
         } finally {
@@ -173,4 +168,50 @@ public void validateOnOpenCorruptFile() throws IOException {
             assertTrue(delOk);  // Try to delete all before asserting
         }
     }
+
+    @Test
+    public void usePreviousCommitWithCorruptFile() throws IOException {
+        File dir = prepareTempDir("object-store-test-corrupted");
+        prepareBadDataFile(dir);
+        builder = BoxStoreBuilder.createDebugWithoutModel().directory(dir);
+        builder.validateOnOpen(ValidateOnOpenMode.Full).usePreviousCommit();
+        store = builder.build();
+        String diagnoseString = store.diagnose();
+        assertTrue(diagnoseString.contains("entries=2"));
+        store.validate(0, true);
+        store.close();
+        assertTrue(store.deleteAllFiles());
+    }
+
+    @Test
+    public void usePreviousCommitAfterFileCorruptException() throws IOException {
+        File dir = prepareTempDir("object-store-test-corrupted");
+        prepareBadDataFile(dir);
+        builder = BoxStoreBuilder.createDebugWithoutModel().directory(dir);
+        builder.validateOnOpen(ValidateOnOpenMode.Full);
+        try {
+            store = builder.build();
+            fail("Should have thrown");
+        } catch (PagesCorruptException e) {
+            builder.usePreviousCommit();
+            store = builder.build();
+        }
+
+        String diagnoseString = store.diagnose();
+        assertTrue(diagnoseString.contains("entries=2"));
+        store.validate(0, true);
+        store.close();
+        assertTrue(store.deleteAllFiles());
+    }
+
+    private File prepareBadDataFile(File dir) throws IOException {
+        assertTrue(dir.mkdir());
+        File badDataFile = new File(dir, "data.mdb");
+        try (InputStream badIn = getClass().getResourceAsStream("corrupt-pageno-in-branch-data.mdb")) {
+            try (FileOutputStream badOut = new FileOutputStream(badDataFile)) {
+                IoUtils.copyAllBytes(badIn, badOut);
+            }
+        }
+        return badDataFile;
+    }
 }
diff --git a/tests/objectbox-java-test/src/test/java/io/objectbox/TransactionTest.java b/tests/objectbox-java-test/src/test/java/io/objectbox/TransactionTest.java
@@ -192,6 +192,26 @@ public void testCommitReadTxException_exceptionListener() {
         }
     }
 
+    @Test(expected = IllegalStateException.class)
+    public void testCancelExceptionOutsideDbExceptionListener() {
+        DbExceptionListener.cancelCurrentException();
+    }
+
+    @Test
+    public void testCommitReadTxException_cancelException() {
+        final Exception[] exs = {null};
+        DbExceptionListener exceptionListener = e -> {
+            if (exs[0] != null) throw new RuntimeException("Called more than once");
+            exs[0] = e;
+            DbExceptionListener.cancelCurrentException();
+        };
+        Transaction tx = store.beginReadTx();
+        store.setDbExceptionListener(exceptionListener);
+        tx.commit();
+        tx.abort();
+        assertNotNull(exs[0]);
+    }
+
     /*
     @Test
     public void testTransactionUsingAfterStoreClosed() {
diff --git a/tests/objectbox-java-test/src/test/java/io/objectbox/exception/ExceptionTest.java b/tests/objectbox-java-test/src/test/java/io/objectbox/exception/ExceptionTest.java
diff --git a/tests/objectbox-java-test/src/test/java/io/objectbox/query/QueryTest.java b/tests/objectbox-java-test/src/test/java/io/objectbox/query/QueryTest.java
