Weak store: close weak store on store close #9

Author: greenrobot-team

objectbox/lib/src/native/store.dart

@@ -60,9 +60,13 @@ class Store {
   /// A list of observers of the Store.close() event.
   final _onClose = <dynamic, void Function()>{};
 
-  /// If weak and calling [close] does not try to close the native Store and
+  /// If true and calling [close] will also close the native Store and
   /// remove [_absoluteDirectoryPath] from [_openStoreDirectories].
-  final bool _weak;
+  final bool _closesNativeStore;
+
+  /// If true and calling [close] will also close a cached WeakStore, if one was
+  /// created for this store.
+  final bool _closesWeakStore;
 
   /// Default value for string query conditions [caseSensitive] argument.
   final bool _queriesCaseSensitiveDefault;
@@ -153,7 +157,8 @@ class Store {
       bool queriesCaseSensitiveDefault = true,
       String? macosApplicationGroup})
       : _defs = modelDefinition,
-        _weak = false,
+        _closesNativeStore = true,
+        _closesWeakStore = true,
         _queriesCaseSensitiveDefault = queriesCaseSensitiveDefault,
         directoryPath = _safeDirectoryPath(directory),
         _absoluteDirectoryPath =
@@ -269,8 +274,10 @@ class Store {
   /// ```
   Store.fromReference(this._defs, this._reference,
       {bool queriesCaseSensitiveDefault = true})
-      // must not close the same native store twice so [_weak]=true
-      : _weak = true,
+      :
+        // Must not close native store twice, only original store is allowed to.
+        _closesNativeStore = false,
+        _closesWeakStore = true,
         directoryPath = '',
         _absoluteDirectoryPath = '',
         _queriesCaseSensitiveDefault = queriesCaseSensitiveDefault {
@@ -297,7 +304,9 @@ class Store {
   /// See [_clone] for details.
   Store._minimal(int ptrAddress, {bool queriesCaseSensitiveDefault = true})
       : _defs = null,
-        _weak = false,
+        _closesNativeStore = true,
+        // Minimal store does not have a model, so could not create Weak Store.
+        _closesWeakStore = false,
         directoryPath = '',
         _absoluteDirectoryPath = '',
         _queriesCaseSensitiveDefault = queriesCaseSensitiveDefault {
@@ -322,8 +331,8 @@ class Store {
   /// is closed (e.g. when the app exits).
   Store.attach(this._defs, String? directoryPath,
       {bool queriesCaseSensitiveDefault = true})
-      // _weak = false so store can be closed.
-      : _weak = false,
+      : _closesNativeStore = true,
+        _closesWeakStore = true,
         _queriesCaseSensitiveDefault = queriesCaseSensitiveDefault,
         directoryPath = _safeDirectoryPath(directoryPath),
         _absoluteDirectoryPath =
@@ -368,7 +377,9 @@ class Store {
   Store._fromWeakStore(
       StoreConfiguration configuration, Pointer<OBX_weak_store> weakStorePtr)
       : _defs = configuration.modelDefinition,
-        _weak = false,
+        _closesNativeStore = true,
+        // This Store was obtained from a WeakStore, do not close it.
+        _closesWeakStore = false,
         directoryPath = configuration.directoryPath,
         _absoluteDirectoryPath = '',
         _queriesCaseSensitiveDefault =
@@ -499,7 +510,12 @@ class Store {
 
     _reader.clear();
 
-    if (!_weak) {
+    if (_closesWeakStore) {
+      // If there is a weak store reference for this, close it as well.
+      WeakStore.get(configuration())?.close();
+    }
+
+    if (_closesNativeStore) {
       _openStoreDirectories.remove(_absoluteDirectoryPath);
       final errors = List.filled(2, 0);
       if (_cFinalizer != nullptr) {

objectbox/lib/src/native/weak_store.dart

@@ -14,16 +14,20 @@ import 'bindings/helpers.dart';
 /// // Do Store operations.
 /// store.close();
 /// // Optional: if not longer needed, free the weak store reference.
+/// // Note this is done automatically if the underlying store is closed.
 /// weakStore.close();
 /// ```
 class WeakStore {
-  // TODO All these should be closed when the isolate is shut down.
   /// Holds previously constructed weak stores by store ID for this isolate.
   static final _weakStoresCacheOfIsolate = <int, WeakStore>{};
 
+  /// Based on the ID get an existing weak store, or null if there is none.
+  static WeakStore? get(StoreConfiguration configuration) =>
+      _weakStoresCacheOfIsolate[configuration.id];
+
   /// Based on the ID get an existing weak store, or create a new one.
-  static WeakStore get(StoreConfiguration configuration) {
-    final existingWeakStore = _weakStoresCacheOfIsolate[configuration.id];
+  static WeakStore getOrCreate(StoreConfiguration configuration) {
+    final existingWeakStore = get(configuration);
     if (existingWeakStore == null) {
       final newWeakStore = WeakStore(configuration);
       _weakStoresCacheOfIsolate[configuration.id] = newWeakStore;
@@ -61,6 +65,7 @@ class WeakStore {
     if (weakStorePtr == null) return;
     C.weak_store_free(weakStorePtr);
     _weakStorePtr = null;
+    _weakStoresCacheOfIsolate.remove(configuration.id);
   }
 
   /// Obtains a Store from a weak Store for short-time use.

objectbox/lib/src/relations/to_many.dart

@@ -351,7 +351,7 @@ class _ToManyStoreAccess<EntityT, OwningEntityT> {
 
   factory _ToManyStoreAccess(
       _ToManyStoreConfiguration<EntityT, OwningEntityT> configuration) {
-    final weakStore = WeakStore.get(configuration._storeConfiguration);
+    final weakStore = WeakStore.getOrCreate(configuration._storeConfiguration);
     final store = weakStore.lock();
     return _ToManyStoreAccess._fromFactory(configuration, store);
   }

objectbox/lib/src/relations/to_one.dart

@@ -250,7 +250,7 @@ class _ToOneStoreAccess<EntityT> {
   Store _store;
 
   factory _ToOneStoreAccess(_ToOneStoreConfiguration<EntityT> configuration) {
-    final weakStore = WeakStore.get(configuration._storeConfiguration);
+    final weakStore = WeakStore.getOrCreate(configuration._storeConfiguration);
     final store = weakStore.lock();
     return _ToOneStoreAccess._fromFactory(configuration, store);
   }

objectbox/test/store_test.dart

@@ -79,7 +79,7 @@ void main() {
     expect(storeConfig.id, isNot(0));
 
     // Create weak store by ID.
-    var weakStore = WeakStore.get(storeConfig);
+    var weakStore = WeakStore.getOrCreate(storeConfig);
 
     // Obtain strong reference.
     final store = weakStore.lock();
@@ -97,11 +97,8 @@ void main() {
     env.closeAndDelete();
     expect(
         () => weakStore.lock(),
-        throwsA(predicate(
-            (ObjectBoxException e) => e.message == "failed to create store")));
-
-    // Clean up.
-    weakStore.close();
+        throwsA(
+            predicate((StateError e) => e.message == "Weak store is closed")));
 
     // Re-open underlying store, store ID should have changed.
     final env2 = TestEnv("store");