Add support for frozen objects

CHANGELOG.md

@@ -1,3 +1,24 @@
+## 7.0.0(YYYY-MM-DD)
+
+### Breaking Changes
+* RxJava Flowables and Observables are now subscribed to and unsubscribed to asynchronously on the thread holding the live Realm, instead of previously where this was done synchronously.
+* All RxJava Flowables and Observables now return frozen objects instead of live objects. This can be configured using `RealmConfiguration.Builder.rxFactory(new RealmObservableFactory(true|false))`. By using frozen objects, it is possible to send RealmObjects across threads, which means that all RxJava operators should now be supported without the need to copy Realm data into unmanaged objects. 
+
+### Enhancements
+* Added `Realm.freeze()`, `RealmObject.freeze()`, `RealmResults.freeze()` and `RealmList.freeze()`. These methods will return a frozen version of the current Realm data. This data can be read from any thread without throwing an `IllegalStateException`, but will never change. All frozen Realms and data can be closed by calling `Realm.close()` on the frozen Realm, but fully closing all live Realms will also close the frozen ones. Frozen data can be queried as normal, but trying to mutate it in any way will throw an `IllegalStateException`. This includes all methods that attempt to refresh or add change listeners. (Issue [#6590](https://github.com/realm/realm-java/pull/6590))
+* Added `Realm.isFrozen()`, `RealmObject.isFrozen()`, `RealmObject.isFrozen(RealmModel)`, `RealmResults.isFrozen()` and `RealmList.isFrozen()`, which returns whether or not the data is frozen.
+* Added `RealmConfiguration.Builder.maxNumberOfActiveVersions(long number)`. Setting this will cause Realm to throw an `IllegalStateException` if too many versions of the Realm data are live at the same time. Having too many versions can dramatically increase the filesize of the Realm. 
+
+### Compatibility
+* Realm Object Server: 3.23.1 or later.
+* File format: Generates Realms with format v9 (Reads and upgrades all previous formats)
+* APIs are backwards compatible with all previous release of realm-java in the 6.x.y series.
+
+### Internal
+* `OsSharedRealm.VersionID.hashCode()` was not implemented correctly and included the memory location in the hashcode.
+* OKHttp was upgraded to 3.10.0 from 3.9.0.
+
+
 ## 6.0.2(2019-11-21)
 
 ### Enhancements

examples/objectServerExample/build.gradle

@@ -1,5 +1,5 @@
 buildscript {
-    ext.kotlin_version = '1.3.20'
+    ext.kotlin_version = '1.3.50'
     repositories {
         google()
         jcenter()
@@ -11,9 +11,9 @@ buildscript {
 }
 
 apply plugin: 'com.android.application'
-apply plugin: 'kotlin-android-extensions'
 apply plugin: 'kotlin-android'
 apply plugin: 'kotlin-kapt'
+apply plugin: 'kotlin-android-extensions'
 apply plugin: 'realm-android'
 
 android {
@@ -45,7 +45,6 @@ android {
         debug {
             buildConfigField "String", "REALM_AUTH_URL", "${realmAuthUrl}"
             buildConfigField "String", "REALM_URL", "${realmUrl}"
-            minifyEnabled true
         }
         release {
             buildConfigField "String", "REALM_AUTH_URL", "${realmAuthUrl}"

library-benchmarks/src/androidTest/java/io/realm/benchmarks/FrozenObjectsBenchmarks.kt

@@ -0,0 +1,119 @@
+/*
+ * Copyright 2019 Realm Inc.
+ *
+ * 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.realm.benchmarks
+
+import androidx.benchmark.junit4.BenchmarkRule
+import androidx.benchmark.junit4.measureRepeated
+import androidx.test.ext.junit.runners.AndroidJUnit4
+import androidx.test.platform.app.InstrumentationRegistry
+import io.realm.Realm
+import io.realm.RealmConfiguration
+import io.realm.RealmList
+import io.realm.RealmResults
+import io.realm.benchmarks.entities.AllTypes
+import io.realm.kotlin.createObject
+import io.realm.kotlin.where
+import io.realm.log.RealmLog
+import org.junit.After
+import org.junit.Before
+import org.junit.Rule
+import org.junit.Test
+import org.junit.runner.RunWith
+import java.util.*
+
+@RunWith(AndroidJUnit4::class)
+class FrozenObjectsBenchmarks {
+
+    @get:Rule
+    val benchmarkRule = BenchmarkRule()
+
+    private lateinit var realm: Realm
+    private lateinit var readObject: AllTypes
+    private lateinit var realmConfig: RealmConfiguration
+
+    @Before
+    fun setUp() {
+        Realm.init(InstrumentationRegistry.getInstrumentation().context)
+        RealmLog.error("SETUP")
+        realmConfig = RealmConfiguration.Builder().name("frozen${Random().nextLong()}.realm").build()
+        realm = Realm.getInstance(realmConfig)
+        realm.executeTransaction { realm ->
+            readObject = realm.createObject(AllTypes::class.java)
+            readObject.columnString = "Foo"
+            readObject.columnLong = 42
+            readObject.columnDouble = 1.234
+        }
+    }
+
+    @After
+    fun tearDown() {
+        RealmLog.error("TEAR_DOWN");
+        realm.close()
+    }
+
+    @Test
+    fun freezeRealm() {
+        benchmarkRule.measureRepeated {
+            // Skip caching in Java and directly measure how fast it is to freeze the SharedRealm.
+            // ObjectStore do not cache it, so it should be safe to run in a loop.
+            realm.sharedRealm.freeze()
+        }
+    }
+
+    @Test
+    fun freezeResults() {
+        realm.executeTransaction { r ->
+            for (i in 0..10_0000) {
+                val obj = r.createObject<AllTypes>()
+                obj.columnString= "String: " + i
+                obj.columnLong = i.toLong()
+                obj.isColumnBoolean = (i % 2 == 0)
+            }
+        }
+
+        var results: RealmResults<AllTypes> = realm.where<AllTypes>().findAll()
+        benchmarkRule.measureRepeated {
+            results.freeze()
+        }
+    }
+
+    @Test
+    fun freezeList() {
+        var list: RealmList<AllTypes> = RealmList()
+        realm.executeTransaction { r ->
+            for (i in 0..10_0000) {
+                list = readObject.columnRealmList
+                val obj = r.createObject<AllTypes>()
+                obj.columnString= "String: " + i
+                obj.columnLong = i.toLong()
+                obj.isColumnBoolean = (i % 2 == 0)
+                list.add(obj)
+            }
+        }
+
+        benchmarkRule.measureRepeated {
+            list.freeze()
+        }
+    }
+
+    @Test
+    fun freezeObject() {
+        benchmarkRule.measureRepeated {
+            readObject.freeze<AllTypes>()
+        }
+    }
+}

realm/realm-annotations-processor/src/main/java/io/realm/processor/RealmProxyClassGenerator.kt

@@ -760,7 +760,7 @@ class RealmProxyClassGenerator(private val processingEnvironment: ProcessingEnvi
                     "Map<RealmModel,RealmObjectProxy>", "cache",
                     "Set<ImportFlag>", "flags")
 
-                beginControlFlow("if (object instanceof RealmObjectProxy && ((RealmObjectProxy) object).realmGet\$proxyState().getRealm\$realm() != null)")
+                beginControlFlow("if (object instanceof RealmObjectProxy && !RealmObject.isFrozen(object) && ((RealmObjectProxy) object).realmGet\$proxyState().getRealm\$realm() != null)")
                     emitStatement("final BaseRealm otherRealm = ((RealmObjectProxy) object).realmGet\$proxyState().getRealm\$realm()")
                     beginControlFlow("if (otherRealm.threadId != realm.threadId)")
                         emitStatement("throw new IllegalArgumentException(\"Objects which belong to Realm instances in other threads cannot be copied into this Realm instance.\")")
@@ -948,7 +948,7 @@ class RealmProxyClassGenerator(private val processingEnvironment: ProcessingEnvi
             beginMethod("long","insert", EnumSet.of(Modifier.PUBLIC, Modifier.STATIC), "Realm", "realm", qualifiedJavaClassName.toString(), "object", "Map<RealmModel,Long>", "cache")
 
             // If object is already in the Realm there is nothing to update
-            beginControlFlow("if (object instanceof RealmObjectProxy && ((RealmObjectProxy) object).realmGet\$proxyState().getRealm\$realm() != null && ((RealmObjectProxy) object).realmGet\$proxyState().getRealm\$realm().getPath().equals(realm.getPath()))")
+            beginControlFlow("if (object instanceof RealmObjectProxy && !RealmObject.isFrozen(object) && ((RealmObjectProxy) object).realmGet\$proxyState().getRealm\$realm() != null && ((RealmObjectProxy) object).realmGet\$proxyState().getRealm\$realm().getPath().equals(realm.getPath()))")
                 emitStatement("return ((RealmObjectProxy) object).realmGet\$proxyState().getRow\$realm().getObjectKey()")
             endControlFlow()
 
@@ -1040,7 +1040,7 @@ class RealmProxyClassGenerator(private val processingEnvironment: ProcessingEnvi
                     beginControlFlow("if (cache.containsKey(object))")
                         emitStatement("continue")
                     endControlFlow()
-                    beginControlFlow("if (object instanceof RealmObjectProxy && ((RealmObjectProxy) object).realmGet\$proxyState().getRealm\$realm() != null && ((RealmObjectProxy) object).realmGet\$proxyState().getRealm\$realm().getPath().equals(realm.getPath()))")
+                    beginControlFlow("if (object instanceof RealmObjectProxy && !RealmObject.isFrozen(object) && ((RealmObjectProxy) object).realmGet\$proxyState().getRealm\$realm() != null && ((RealmObjectProxy) object).realmGet\$proxyState().getRealm\$realm().getPath().equals(realm.getPath()))")
                         emitStatement("cache.put(object, ((RealmObjectProxy) object).realmGet\$proxyState().getRow\$realm().getObjectKey())")
                         emitStatement("continue")
                     endControlFlow()
@@ -1109,7 +1109,7 @@ class RealmProxyClassGenerator(private val processingEnvironment: ProcessingEnvi
             beginMethod("long", "insertOrUpdate", EnumSet.of(Modifier.PUBLIC, Modifier.STATIC), "Realm", "realm", qualifiedJavaClassName.toString(), "object", "Map<RealmModel,Long>", "cache")
 
             // If object is already in the Realm there is nothing to update
-            beginControlFlow("if (object instanceof RealmObjectProxy && ((RealmObjectProxy) object).realmGet\$proxyState().getRealm\$realm() != null && ((RealmObjectProxy) object).realmGet\$proxyState().getRealm\$realm().getPath().equals(realm.getPath()))")
+            beginControlFlow("if (object instanceof RealmObjectProxy && !RealmObject.isFrozen(object) && ((RealmObjectProxy) object).realmGet\$proxyState().getRealm\$realm() != null && ((RealmObjectProxy) object).realmGet\$proxyState().getRealm\$realm().getPath().equals(realm.getPath()))")
                 emitStatement("return ((RealmObjectProxy) object).realmGet\$proxyState().getRow\$realm().getObjectKey()")
             endControlFlow()
             emitStatement("Table table = realm.getTable(%s.class)", qualifiedJavaClassName)
@@ -1215,7 +1215,7 @@ class RealmProxyClassGenerator(private val processingEnvironment: ProcessingEnvi
                         emitStatement("continue")
                     endControlFlow()
 
-                    beginControlFlow("if (object instanceof RealmObjectProxy && ((RealmObjectProxy) object).realmGet\$proxyState().getRealm\$realm() != null && ((RealmObjectProxy) object).realmGet\$proxyState().getRealm\$realm().getPath().equals(realm.getPath()))")
+                    beginControlFlow("if (object instanceof RealmObjectProxy && !RealmObject.isFrozen(object) && ((RealmObjectProxy) object).realmGet\$proxyState().getRealm\$realm() != null && ((RealmObjectProxy) object).realmGet\$proxyState().getRealm\$realm().getPath().equals(realm.getPath()))")
                         emitStatement("cache.put(object, ((RealmObjectProxy) object).realmGet\$proxyState().getRow\$realm().getObjectKey())")
                         emitStatement("continue")
                     endControlFlow()
@@ -1694,9 +1694,15 @@ class RealmProxyClassGenerator(private val processingEnvironment: ProcessingEnvi
                 emitStatement("if (o == null || getClass() != o.getClass()) return false")
                 emitStatement("%s %s = (%s)o", proxyClassName, otherObjectVarName, proxyClassName)  // FooRealmProxy aFoo = (FooRealmProxy)o
                 emitEmptyLine()
-                emitStatement("String path = proxyState.getRealm\$realm().getPath()")
-                emitStatement("String otherPath = %s.proxyState.getRealm\$realm().getPath()", otherObjectVarName)
+                emitStatement("BaseRealm realm = proxyState.getRealm\$realm()")
+                emitStatement("BaseRealm otherRealm = %s.proxyState.getRealm\$realm()", otherObjectVarName)
+                emitStatement("String path = realm.getPath()")
+                emitStatement("String otherPath = otherRealm.getPath()")
                 emitStatement("if (path != null ? !path.equals(otherPath) : otherPath != null) return false")
+                emitStatement("if (realm.isFrozen() != otherRealm.isFrozen()) return false")
+                beginControlFlow("if (!realm.sharedRealm.getVersionID().equals(otherRealm.sharedRealm.getVersionID()))")
+                    emitStatement("return false")
+                endControlFlow()
                 emitEmptyLine()
                 emitStatement("String tableName = proxyState.getRow\$realm().getTable().getName()")
                 emitStatement("String otherTableName = %s.proxyState.getRow\$realm().getTable().getName()", otherObjectVarName)

realm/realm-annotations-processor/src/test/resources/io/realm/some_test_AllTypesRealmProxy.java

@@ -1168,7 +1168,7 @@ private static some_test_AllTypesRealmProxy newProxyInstance(BaseRealm realm, Ro
     }
 
     public static some.test.AllTypes copyOrUpdate(Realm realm, AllTypesColumnInfo columnInfo, some.test.AllTypes object, boolean update, Map<RealmModel,RealmObjectProxy> cache, Set<ImportFlag> flags) {
-        if (object instanceof RealmObjectProxy && ((RealmObjectProxy) object).realmGet$proxyState().getRealm$realm() != null) {
+        if (object instanceof RealmObjectProxy && !RealmObject.isFrozen(object) && ((RealmObjectProxy) object).realmGet$proxyState().getRealm$realm() != null) {
             final BaseRealm otherRealm = ((RealmObjectProxy) object).realmGet$proxyState().getRealm$realm();
             if (otherRealm.threadId != realm.threadId) {
                 throw new IllegalArgumentException("Objects which belong to Realm instances in other threads cannot be copied into this Realm instance.");
@@ -1280,7 +1280,7 @@ public static some.test.AllTypes copy(Realm realm, AllTypesColumnInfo columnInfo
     }
 
     public static long insert(Realm realm, some.test.AllTypes object, Map<RealmModel,Long> cache) {
-        if (object instanceof RealmObjectProxy && ((RealmObjectProxy) object).realmGet$proxyState().getRealm$realm() != null && ((RealmObjectProxy) object).realmGet$proxyState().getRealm$realm().getPath().equals(realm.getPath())) {
+        if (object instanceof RealmObjectProxy && !RealmObject.isFrozen(object) && ((RealmObjectProxy) object).realmGet$proxyState().getRealm$realm() != null && ((RealmObjectProxy) object).realmGet$proxyState().getRealm$realm().getPath().equals(realm.getPath())) {
             return ((RealmObjectProxy) object).realmGet$proxyState().getRow$realm().getObjectKey();
         }
         Table table = realm.getTable(some.test.AllTypes.class);
@@ -1471,7 +1471,7 @@ public static void insert(Realm realm, Iterator<? extends RealmModel> objects, M
             if (cache.containsKey(object)) {
                 continue;
             }
-            if (object instanceof RealmObjectProxy && ((RealmObjectProxy) object).realmGet$proxyState().getRealm$realm() != null && ((RealmObjectProxy) object).realmGet$proxyState().getRealm$realm().getPath().equals(realm.getPath())) {
+            if (object instanceof RealmObjectProxy && !RealmObject.isFrozen(object) && ((RealmObjectProxy) object).realmGet$proxyState().getRealm$realm() != null && ((RealmObjectProxy) object).realmGet$proxyState().getRealm$realm().getPath().equals(realm.getPath())) {
                 cache.put(object, ((RealmObjectProxy) object).realmGet$proxyState().getRow$realm().getObjectKey());
                 continue;
             }
@@ -1649,7 +1649,7 @@ public static void insert(Realm realm, Iterator<? extends RealmModel> objects, M
     }
 
     public static long insertOrUpdate(Realm realm, some.test.AllTypes object, Map<RealmModel,Long> cache) {
-        if (object instanceof RealmObjectProxy && ((RealmObjectProxy) object).realmGet$proxyState().getRealm$realm() != null && ((RealmObjectProxy) object).realmGet$proxyState().getRealm$realm().getPath().equals(realm.getPath())) {
+        if (object instanceof RealmObjectProxy && !RealmObject.isFrozen(object) && ((RealmObjectProxy) object).realmGet$proxyState().getRealm$realm() != null && ((RealmObjectProxy) object).realmGet$proxyState().getRealm$realm().getPath().equals(realm.getPath())) {
             return ((RealmObjectProxy) object).realmGet$proxyState().getRow$realm().getObjectKey();
         }
         Table table = realm.getTable(some.test.AllTypes.class);
@@ -1881,7 +1881,7 @@ public static void insertOrUpdate(Realm realm, Iterator<? extends RealmModel> ob
             if (cache.containsKey(object)) {
                 continue;
             }
-            if (object instanceof RealmObjectProxy && ((RealmObjectProxy) object).realmGet$proxyState().getRealm$realm() != null && ((RealmObjectProxy) object).realmGet$proxyState().getRealm$realm().getPath().equals(realm.getPath())) {
+            if (object instanceof RealmObjectProxy && !RealmObject.isFrozen(object) && ((RealmObjectProxy) object).realmGet$proxyState().getRealm$realm() != null && ((RealmObjectProxy) object).realmGet$proxyState().getRealm$realm().getPath().equals(realm.getPath())) {
                 cache.put(object, ((RealmObjectProxy) object).realmGet$proxyState().getRow$realm().getObjectKey());
                 continue;
             }
@@ -2349,9 +2349,15 @@ public boolean equals(Object o) {
         if (o == null || getClass() != o.getClass()) return false;
         some_test_AllTypesRealmProxy aAllTypes = (some_test_AllTypesRealmProxy)o;
 
-        String path = proxyState.getRealm$realm().getPath();
-        String otherPath = aAllTypes.proxyState.getRealm$realm().getPath();
+        BaseRealm realm = proxyState.getRealm$realm();
+        BaseRealm otherRealm = aAllTypes.proxyState.getRealm$realm();
+        String path = realm.getPath();
+        String otherPath = otherRealm.getPath();
         if (path != null ? !path.equals(otherPath) : otherPath != null) return false;
+        if (realm.isFrozen() != otherRealm.isFrozen()) return false;
+        if (!realm.sharedRealm.getVersionID().equals(otherRealm.sharedRealm.getVersionID())) {
+            return false;
+        }
 
         String tableName = proxyState.getRow$realm().getTable().getName();
         String otherTableName = aAllTypes.proxyState.getRow$realm().getTable().getName();