realm compact

CHANGELOG.md

@@ -8,6 +8,7 @@
 * Support results of primitives, ie. `RealmResult<int>`. (Issue [#162](https://github.com/realm/realm-dart/issues/162))
 * Support notifications on all managed realm lists, including list of primitives, ie. `RealmList<int>.changes` is supported. ([#893](https://github.com/realm/realm-dart/pull/893))
 * Support named backlinks on realm models. You can now add and annotate a realm object iterator field with `@Backlink(#fieldName)`. ([#996](https://github.com/realm/realm-dart/pull/996))
+* Added Realm file compaction support. ([#1005](https://github.com/realm/realm-dart/pull/1005))
 * Allow `@Indexed` attribute on all indexable type, and ensure appropriate indexes are created in the realm. ([#797](https://github.com/realm/realm-dart/issues/797))
 
 ### Fixed

lib/src/native/realm_core.dart

@@ -2168,6 +2168,14 @@ class _RealmCore {
       return completer.future;
     });
   }
+
+  bool compact(Realm realm) {
+    return using((arena) {
+      final out_did_compact = arena<Bool>();
+      _realmLib.invokeGetBool(() => _realmLib.realm_compact(realm.handle._pointer, out_did_compact));
+      return out_did_compact.value;
+    });
+  }
 }
 
 class LastError {

lib/src/realm_class.dart

@@ -483,6 +483,16 @@ class Realm implements Finalizable {
       throw RealmError('Starting a write transaction on a frozen Realm is not allowed.');
     }
   }
+
+  /// Compacts a Realm file. A Realm file usually contains free/unused space. 
+  /// 
+  /// This method removes this free space and the file size is thereby reduced. 
+  /// Objects within the Realm file are untouched.
+  /// Note: The file system should have free space for at least a copy of the Realm file. This method must not be called inside a transaction. 
+  /// The Realm file is left untouched if any file operation fails.
+  bool compact() {
+    return realmCore.compact(this);
+  }
 }
 
 /// Provides a scope to safely write data to a [Realm]. Can be created using [Realm.beginWrite] or

test/realm_test.dart

@@ -20,6 +20,7 @@
 
 import 'dart:convert';
 import 'dart:io';
+import 'dart:isolate';
 import 'package:test/test.dart' hide test, throws;
 import 'package:timezone/timezone.dart' as tz;
 import 'package:timezone/data/latest.dart' as tz;
@@ -1394,6 +1395,58 @@ Future<void> main([List<String>? args]) async {
     expect(await realmIsCancelled, isTrue);
     expect(progressReturned, isFalse);
   });
+
+  test('Realm - local realm can be compacted', () {
+    var config = Configuration.local([Car.schema]);
+    var realm = getRealm(config);
+    final compacted = realm.compact();
+    expect(compacted, true);
+  });
+
+  test('Realm - local realm can be compacted in worker isolate', () async {
+    final receivePort = ReceivePort();
+    await Isolate.spawn((SendPort sendPort) {
+      var config = Configuration.local([Car.schema]);
+      var realm = getRealm(config);
+      final compacted = realm.compact();
+      Isolate.exit(sendPort, compacted);
+    }, receivePort.sendPort);
+
+    final compacted = await receivePort.first as bool;
+    expect(compacted, true);
+  });
+
+  test('Realm - local encrypted realm can be compacted', () {
+    final config = Configuration.local([Friend.schema],
+        encryptionKey: generateEncryptionKey(), path: p.join(Configuration.defaultStoragePath, "${generateRandomString(8)}.realm"));
+    final realm = getRealm(config);
+    final compacted = realm.compact();
+    expect(compacted, true);
+  });
+
+  baasTest('Realm - synced realm can be compacted', (appConfiguration) async {
+    final app = App(appConfiguration);
+    final credentials = Credentials.anonymous();
+    final user = await app.logIn(credentials);
+    final configuration = Configuration.flexibleSync(user, [Task.schema]);
+
+    final realm = getRealm(configuration);
+    final compacted = realm.compact();
+    expect(compacted, true);
+  });
+
+  baasTest('Realm - synced encrypted realm can be compacted', (appConfiguration) async {
+    final app = App(appConfiguration);
+    final credentials = Credentials.anonymous();
+    final user = await app.logIn(credentials);
+    List<int> key = List<int>.generate(encryptionKeySize, (i) => random.nextInt(256));
+    final configuration =
+        Configuration.flexibleSync(user, [Task.schema], encryptionKey: key, path: p.join(Configuration.defaultStoragePath, "${generateRandomString(8)}.realm"));
+
+    final realm = getRealm(configuration);
+    final compacted = realm.compact();
+    expect(compacted, true);
+  });
 }
 
 List<int> generateEncryptionKey() {