Expose subscriptions more directly

CHANGELOG.md

@@ -1,4 +1,4 @@
-## 5.?.? (2018-mm-dd)
+## 5.?.? (2018-MM-DD)
 
 ### Enhancements
 * None
@@ -15,6 +15,26 @@
 * None
 
 
+## 5.8.0 (YYYY-MM-DD)
+
+### Enhancements
+* [ObjectServer] Added Subscription class available to Query-based Realms. This exposes a Subscription more directly. This class is in beta. [#6231](https://github.com/realm/realm-java/pull/6231).
+* [ObjectServer] Added `Realm.getSubscriptions()`, `Realm.getSubscriptions(String pattern)` and `Realm.getSubscription` to make it easier to find existing subscriptions. These API's are in beta. [#6231](https://github.com/realm/realm-java/pull/6231).
+* [ObjectServer] Added `RealmQuery.subscribe()` and `RealmQuery.subscribe(String name)` to subscribe immediately inside a transaction. These API's are in beta. [#6231](https://github.com/realm/realm-java/pull/6231).
+* [ObjectServer] Added support for subscribing directly inside `SyncConfiguration.initialData()`. This can be coupled with `SyncConfiguration.waitForInitialRemoteData()` in order to block a Realm from opening until the initial subscriptions are ready and have downloaded data. This API are in beta. [#6231](https://github.com/realm/realm-java/pull/6231).
+
+### Fixed
+* ?? (Issue [#??](https://github.com/realm/realm-java/issues/??), since ??).
+
+### Compatibility
+* Realm Object Server: 3.11.0 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 5.x.y series.
+
+### Internal
+* None
+
+
 ## 5.7.1 (2018-10-22)
 
 ### Enhancements
@@ -29,7 +49,7 @@
 * APIs are backwards compatible with all previous release of realm-java in the 5.x.y series.
 
 ### Internal
-* None
+* Updated to Object Store commit: 362b886628b3aefc5b7a0bc32293d794dc1d4ad5
 
 
 ## 5.7.0 (2018-09-24)

realm/config/findbugs/findbugs-filter.xml

@@ -39,5 +39,8 @@
     <Match>
         <Class name="io.realm.io_realm_sync_permissions_PermissionUserRealmProxy"/>
     </Match>
+    <Match>
+        <Class name="io.realm.io_realm_sync_SubscriptionRealmProxy"/>
+    </Match>
 
 </FindBugsFilter>

realm/realm-library/src/androidTest/java/io/realm/DynamicRealmTests.java

@@ -695,19 +695,27 @@ public void onSuccess(DynamicRealm realm) {
     @Test
     @RunTestInLooperThread
     public void getInstanceAsync_nullConfigShouldThrow() {
-        thrown.expect(IllegalArgumentException.class);
-        DynamicRealm.getInstanceAsync(null, new DynamicRealm.Callback() {
-            @Override
-            public void onSuccess(DynamicRealm realm) {
-                fail();
-            }
-        });
+        try {
+            //noinspection ConstantConditions
+            DynamicRealm.getInstanceAsync(null, new DynamicRealm.Callback() {
+                @Override
+                public void onSuccess(DynamicRealm realm) {
+                    fail();
+                }
+            });
+        } catch (IllegalArgumentException ignored) {
+        }
+        looperThread.testComplete();
     }
 
     @Test
     @RunTestInLooperThread
     public void getInstanceAsync_nullCallbackShouldThrow() {
-        thrown.expect(IllegalArgumentException.class);
-        DynamicRealm.getInstanceAsync(defaultConfig, null);
+        try {
+            //noinspection ConstantConditions
+            DynamicRealm.getInstanceAsync(defaultConfig, null);
+        } catch (IllegalArgumentException ignored) {
+        }
+        looperThread.testComplete();
     }
 }

realm/realm-library/src/androidTest/java/io/realm/LinkingObjectsDynamicTests.java

@@ -475,17 +475,18 @@ public void execute(Realm realm) {
         });
 
         final DynamicRealm dynamicRealm = DynamicRealm.getInstance(looperThread.getConfiguration());
-        try {
-            final DynamicRealmObject targetAsync = dynamicRealm.where(BacklinksTarget.CLASS_NAME)
-                    .equalTo(BacklinksTarget.FIELD_ID, 1L).findFirstAsync();
-            // precondition
-            assertFalse(targetAsync.isLoaded());
+        looperThread.closeAfterTest(dynamicRealm);
+        final DynamicRealmObject targetAsync = dynamicRealm.where(BacklinksTarget.CLASS_NAME)
+                .equalTo(BacklinksTarget.FIELD_ID, 1L).findFirstAsync();
+        // precondition
+        assertFalse(targetAsync.isLoaded());
 
-            thrown.expect(IllegalStateException.class);
+        try {
             targetAsync.linkingObjects(BacklinksSource.CLASS_NAME, BacklinksSource.FIELD_CHILD);
-        } finally {
-            dynamicRealm.close();
+            fail();
+        } catch (IllegalStateException ignored) {
         }
+        looperThread.testComplete();
     }
 
     @Test
@@ -505,25 +506,26 @@ public void execute(Realm realm) {
         });
 
         final DynamicRealm dynamicRealm = DynamicRealm.getInstance(looperThread.getConfiguration());
-        try {
-            final DynamicRealmObject target = dynamicRealm.where(BacklinksTarget.CLASS_NAME)
-                    .equalTo(BacklinksTarget.FIELD_ID, 1L).findFirst();
+        looperThread.closeAfterTest(dynamicRealm);
+        final DynamicRealmObject target = dynamicRealm.where(BacklinksTarget.CLASS_NAME)
+                .equalTo(BacklinksTarget.FIELD_ID, 1L).findFirst();
 
-            dynamicRealm.executeTransaction(new DynamicRealm.Transaction() {
-                @Override
-                public void execute(DynamicRealm realm) {
-                    target.deleteFromRealm();
-                }
-            });
+        dynamicRealm.executeTransaction(new DynamicRealm.Transaction() {
+            @Override
+            public void execute(DynamicRealm realm) {
+                target.deleteFromRealm();
+            }
+        });
 
-            // precondition
-            assertFalse(target.isValid());
+        // precondition
+        assertFalse(target.isValid());
 
-            thrown.expect(IllegalStateException.class);
+        try {
             target.linkingObjects(BacklinksSource.CLASS_NAME, BacklinksSource.FIELD_CHILD);
-        } finally {
-            dynamicRealm.close();
+            fail();
+        } catch (IllegalStateException ignored) {
         }
+        looperThread.testComplete();
     }
 
     @Test

realm/realm-library/src/androidTest/java/io/realm/LinkingObjectsManagedTests.java

@@ -434,10 +434,13 @@ public void execute(Realm realm) {
         // precondition
         assertFalse(targetAsync.isLoaded());
 
-        thrown.expect(IllegalStateException.class);
-        //noinspection ResultOfMethodCallIgnored
-        targetAsync.getParents();
-        fail();
+        try {
+            //noinspection ResultOfMethodCallIgnored
+            targetAsync.getParents();
+            fail();
+        } catch (IllegalStateException ignore) {
+        }
+        looperThread.testComplete();
     }
 
     @Test
@@ -471,10 +474,13 @@ public void execute(Realm realm) {
         // precondition
         assertFalse(target.isValid());
 
-        thrown.expect(IllegalStateException.class);
-        //noinspection ResultOfMethodCallIgnored
-        target.getParents();
-        fail();
+        try {
+            //noinspection ResultOfMethodCallIgnored
+            target.getParents();
+            fail();
+        } catch (IllegalStateException ignore) {
+        }
+        looperThread.testComplete();
     }
 
     @Test
@@ -509,10 +515,13 @@ public void execute(Realm realm) {
         // precondition
         assertFalse(target.isValid());
 
-        thrown.expect(IllegalStateException.class);
-        //noinspection ResultOfMethodCallIgnored
-        target.getParents();
-        fail();
+        try {
+            //noinspection ResultOfMethodCallIgnored
+            target.getParents();
+            fail();
+        } catch (IllegalStateException ignore) {
+        }
+        looperThread.testComplete();
     }
 
     /**

realm/realm-library/src/androidTest/java/io/realm/RealmAsyncQueryTests.java

@@ -462,7 +462,6 @@ public void onSuccess() {
             public void run() {
                 // Manually call refresh, so the did_change will be triggered.
                 foregroundRealm.sharedRealm.refresh();
-                foregroundRealm.setAutoRefresh(true);
             }
         });
     }

realm/realm-library/src/androidTest/java/io/realm/RealmTests.java

@@ -4322,13 +4322,15 @@ public void onSuccess(Realm realm) {
                 fail();
             }
         });
+        looperThread.testComplete();
     }
 
     @Test
     @RunTestInLooperThread
     public void getInstanceAsync_nullCallbackShouldThrow() {
         thrown.expect(IllegalArgumentException.class);
         Realm.getInstanceAsync(realmConfig, null);
+        looperThread.testComplete();
     }
 
     // Verify that the logic for waiting for the users file dir to be come available isn't totally broken

realm/realm-library/src/androidTest/java/io/realm/RunTestInLooperThreadLifeCycleTest.java

@@ -43,7 +43,8 @@
  * - @Before()
  * - @RunTestInLooperThread/@Test
  * - @After : This is called when exiting the test method. Warning: Looper test is still running.
- * - looperThread.runAfterTest(Runnable) : This is called when the LooperTest either succeed or fails.
+ * - looperThread.runAfterTest(Runnable) : This is called when `testComplete()` is called. This can
+ *   be both before and after `@After` has run.
  */
 
 @RunWith(AndroidJUnit4.class)

realm/realm-library/src/androidTest/java/io/realm/RxJavaTests.java

@@ -57,15 +57,10 @@ public class RxJavaTests {
 
     @Rule
     public final UiThreadTestRule uiThreadTestRule = new UiThreadTestRule();
+
     @Rule
-    public final RunInLooperThread looperThread = new RunInLooperThread() {
-        @Override
-        public void looperTearDown() {
-            if (subscription != null && !subscription.isDisposed()) {
-                subscription.dispose();
-            }
-        }
-    };
+    public final RunInLooperThread looperThread = new RunInLooperThread();
+
     @Rule
     public final TestRealmConfigurationFactory configFactory = new TestRealmConfigurationFactory();
 
@@ -76,6 +71,11 @@ public void looperTearDown() {
     public void setUp() throws Exception {
         // For non-LooperThread tests.
         realm = Realm.getInstance(configFactory.createConfiguration());
+        looperThread.runAfterTest(() -> {
+            if (subscription != null && !subscription.isDisposed()) {
+                subscription.dispose();
+            }
+        });
     }
 
     @After
@@ -936,30 +936,16 @@ public void realmResults_gcStressTest() {
         realm.commitTransaction();
 
         for (int i = 0; i < TEST_SIZE; i++) {
-            // Doesn't keep a reference to the Observable.
             realm.where(AllTypes.class).equalTo(AllTypes.FIELD_LONG, i).findAllAsync().asFlowable()
-                    .filter(new Predicate<RealmResults<AllTypes>>() {
-                        @Override
-                        public boolean test(RealmResults<AllTypes> results) throws Exception {
-                            return results.isLoaded();
-                        }
-                    })
+                    .filter(results -> results.isLoaded())
                     .take(1) // Unsubscribes from Realm.
-                    .subscribe(new Consumer<RealmResults<AllTypes>>() {
-                        @Override
-                        public void accept(RealmResults<AllTypes> allTypes) throws Exception {
-                            // Not guaranteed, but can result in the GC of other RealmResults waiting for a result.
-                            Runtime.getRuntime().gc();
-                            if (innerCounter.incrementAndGet() == TEST_SIZE) {
-                                looperThread.testComplete();
-                            }
-                        }
-                    }, new Consumer<Throwable>() {
-                        @Override
-                        public void accept(Throwable throwable) throws Exception {
-                            fail(throwable.toString());
+                    .subscribe(allTypes -> {
+                        // Not guaranteed, but can result in the GC of other RealmResults waiting for a result.
+                        Runtime.getRuntime().gc();
+                        if (innerCounter.incrementAndGet() == TEST_SIZE) {
+                            looperThread.testComplete();
                         }
-                    });
+                    }, throwable -> fail(throwable.toString()));
         }
     }
 
@@ -972,6 +958,7 @@ public void dynamicRealmResults_gcStressTest() {
         final int TEST_SIZE = 50;
         final AtomicLong innerCounter = new AtomicLong();
         final DynamicRealm realm = DynamicRealm.getInstance(looperThread.getConfiguration());
+        looperThread.closeAfterTest(realm);
 
         realm.beginTransaction();
         for (int i = 0; i < TEST_SIZE; i++) {
@@ -995,7 +982,6 @@ public void accept(RealmResults<DynamicRealmObject> dynamicRealmObjects) throws
                             // Not guaranteed, but can result in the GC of other RealmResults waiting for a result.
                             Runtime.getRuntime().gc();
                             if (innerCounter.incrementAndGet() == TEST_SIZE) {
-                                realm.close();
                                 looperThread.testComplete();
                             }
                         }
@@ -1061,6 +1047,7 @@ public void dynamicRealmObject_gcStressTest() {
         final int TEST_SIZE = 50;
         final AtomicLong innerCounter = new AtomicLong();
         final DynamicRealm realm = DynamicRealm.getInstance(looperThread.getConfiguration());
+        looperThread.closeAfterTest(realm);
 
         realm.beginTransaction();
         for (int i = 0; i < TEST_SIZE; i++) {
@@ -1084,7 +1071,6 @@ public void accept(DynamicRealmObject dynamicRealmObject) throws Exception {
                             // Not guaranteed, but can result in the GC of other RealmResults waiting for a result.
                             Runtime.getRuntime().gc();
                             if (innerCounter.incrementAndGet() == TEST_SIZE) {
-                                realm.close();
                                 looperThread.testComplete();
                             }
                         }

realm/realm-library/src/androidTest/java/io/realm/internal/RealmNotifierTests.java

@@ -100,8 +100,8 @@ public void addChangeListener_byLocalChanges() {
             public void onChange(OsSharedRealm sharedRealm) {
                 // Transaction has been committed in core, but commitTransaction hasn't returned in java.
                 assertFalse(commitReturns.get());
-                looperThread.testComplete();
                 sharedRealm.close();
+                looperThread.testComplete();
             }
         });
         sharedRealm.beginTransaction();

realm/realm-library/src/androidTestObjectServer/java/io/realm/SyncManagerTests.java

@@ -95,6 +95,8 @@ public void tearDown() {
             userStore.remove(syncUser.getIdentity(), syncUser.getAuthenticationUrl().toString());
         }
         SyncManager.reset();
+        BaseRealm.applicationContext = null; // Required for Realm.init() to work
+        Realm.init(InstrumentationRegistry.getTargetContext());
     }
 
     @Test