Cursor & Transaction: always log error if not closed

Author: greenrobot

objectbox-java/src/main/java/io/objectbox/Cursor.java

@@ -29,7 +29,9 @@
 @Internal
 @NotThreadSafe
 public abstract class Cursor<T> implements Closeable {
-    static final boolean WARN_FINALIZER = false;
+    /** May be set by tests */
+    @Internal
+    static boolean TRACK_CREATION_STACK;
 
     protected static final int PUT_FLAG_FIRST = 1;
     protected static final int PUT_FLAG_COMPLETE = 1 << 1;
@@ -136,19 +138,23 @@ protected Cursor(Transaction tx, long cursor, EntityInfo entityInfo, BoxStore bo
                 property.verifyId(id);
             }
         }
-        creationThrowable = WARN_FINALIZER ? new Throwable() : null;
+        creationThrowable = TRACK_CREATION_STACK ? new Throwable() : null;
 
         nativeSetBoxStoreForEntities(cursor, boxStore);
     }
 
     @Override
     protected void finalize() throws Throwable {
-        if (WARN_FINALIZER && !closed && creationThrowable != null) {
-            System.err.println("Cursor was not closed. It was initially created here:");
-            creationThrowable.printStackTrace();
+        if (!closed) {
+            System.err.println("Cursor was not closed.");
+            if (creationThrowable != null) {
+                System.err.println("Cursor was initially created here:");
+                creationThrowable.printStackTrace();
+            }
+            System.err.flush();
+            close();
+            super.finalize();
         }
-        close();
-        super.finalize();
     }
 
     protected abstract long getId(T entity);
@@ -223,8 +229,8 @@ public List<T> find(Property property, String value) {
     }
 
     /**
-     * @deprecated TODO only used in tests, remove in the future
      * @return key or 0 if not found
+     * @deprecated TODO only used in tests, remove in the future
      */
     long lookupKeyUsingIndex(int propertyId, String value) {
         return nativeLookupKeyUsingIndex(cursor, propertyId, value);

objectbox-java/src/main/java/io/objectbox/Transaction.java

@@ -26,7 +26,9 @@
 @Internal
 @NotThreadSafe
 public class Transaction implements Closeable {
-    static final boolean WARN_FINALIZER = false;
+    /** May be set by tests */
+    @Internal
+    static boolean TRACK_CREATION_STACK;
 
     private final long transaction;
     private final BoxStore store;
@@ -68,14 +70,18 @@ public Transaction(BoxStore store, long transaction, int initialCommitCount) {
         this.initialCommitCount = initialCommitCount;
         readOnly = nativeIsReadOnly(transaction);
 
-        creationThrowable = WARN_FINALIZER ? new Throwable() : null;
+        creationThrowable = TRACK_CREATION_STACK ? new Throwable() : null;
     }
 
     @Override
     protected void finalize() throws Throwable {
-        if (WARN_FINALIZER && !closed && creationThrowable != null) {
-            System.err.println("Transaction was not closed. It was initially created here:");
-            creationThrowable.printStackTrace();
+        if (!closed) {
+            System.err.println("Transaction was not closed (initial commit count: " + initialCommitCount + ").");
+            if (creationThrowable != null) {
+                System.err.println("Transaction was initially created here:");
+                creationThrowable.printStackTrace();
+            }
+            System.err.flush();
         }
         close();
         super.finalize();

tests/objectbox-java-test/src/main/java/io/objectbox/AbstractObjectBoxTest.java

@@ -29,12 +29,9 @@
 
 import io.objectbox.ModelBuilder.EntityBuilder;
 import io.objectbox.ModelBuilder.PropertyBuilder;
-import io.objectbox.internal.CursorFactory;
-import io.objectbox.internal.IdGetter;
 import io.objectbox.model.PropertyFlags;
 import io.objectbox.model.PropertyType;
 
-
 import static org.junit.Assert.assertEquals;
 import static org.junit.Assert.assertTrue;
 
@@ -52,6 +49,9 @@ public abstract class AbstractObjectBoxTest {
 
     @Before
     public void setUp() throws IOException {
+        Cursor.TRACK_CREATION_STACK = true;
+        Transaction.TRACK_CREATION_STACK = true;
+
         // This works with Android without needing any context
         File tempFile = File.createTempFile("object-store-test", "");
         tempFile.delete();