Merge pull request #978 from hivedb/braid/web-performance

feat: improve web performance of BoxCollections

Author: The one with the braid (she/her) | Dфҿ mit dem Zopf (sie/ihr)

hive/lib/hive.dart

@@ -18,7 +18,9 @@ import 'package:hive/src/object/hive_object.dart';
 import 'package:hive/src/util/extensions.dart';
 import 'package:meta/meta.dart';
 
-export 'src/box_collection.dart';
+export 'src/box_collection/box_collection_stub.dart'
+    if (dart.library.html) 'package:hive/src/box_collection/box_collection_indexed_db.dart'
+    if (dart.library.io) 'package:hive/src/box_collection/box_collection.dart';
 export 'src/object/hive_object.dart' show HiveObject, HiveObjectMixin;
 
 part 'src/annotations/hive_field.dart';

hive/lib/src/backend/js/native/backend_manager.dart

@@ -19,19 +19,40 @@ class BackendManager implements BackendManagerInterface {
     final databaseName = collection ?? name;
     final objectStoreName = collection == null ? 'box' : name;
 
-    final db =
+    var db =
         await indexedDB!.open(databaseName, version: 1, onUpgradeNeeded: (e) {
       var db = e.target.result as Database;
       if (!(db.objectStoreNames ?? []).contains(objectStoreName)) {
         db.createObjectStore(objectStoreName);
       }
     });
 
+    // in case the objectStore is not contained, re-open the db and
+    // update version
+    if (!(db.objectStoreNames ?? []).contains(objectStoreName)) {
+      print(
+          'Creating objectStore $objectStoreName in database $databaseName...');
+      db = await indexedDB!.open(
+        databaseName,
+        version: (db.version ?? 1) + 1,
+        onUpgradeNeeded: (e) {
+          var db = e.target.result as Database;
+          if (!(db.objectStoreNames ?? []).contains(objectStoreName)) {
+            db.createObjectStore(objectStoreName);
+          }
+        },
+      );
+    }
+
+    print('Got object store $objectStoreName in database $databaseName.');
+
     return StorageBackendJs(db, cipher, objectStoreName);
   }
 
   @override
   Future<void> deleteBox(String name, String? path, String? collection) async {
+    print('Delete $name // $collection from disk');
+
     // compatibility for old store format
     final databaseName = collection ?? name;
     final objectStoreName = collection == null ? 'box' : name;

hive/lib/src/backend/js/native/storage_backend_js.dart

@@ -201,13 +201,26 @@ class StorageBackendJs extends StorageBackend {
 
   @override
   Future<void> deleteFromDisk() async {
-    if (_db.objectStoreNames?.length != 1) {
-      _db.deleteObjectStore(objectStoreName);
-    } else {
-      final indexDB = js.context.hasProperty('window')
-          ? window.indexedDB
-          : WorkerGlobalScope.instance.indexedDB;
+    final indexDB = js.context.hasProperty('window')
+        ? window.indexedDB
+        : WorkerGlobalScope.instance.indexedDB;
+
+    print('Delete ${_db.name} // $objectStoreName from disk');
+
+    // directly deleting the entire DB if a non-collection Box
+    if (_db.objectStoreNames?.length == 1) {
       await indexDB!.deleteDatabase(_db.name!);
+    } else {
+      final db =
+          await indexDB!.open(_db.name!, version: 1, onUpgradeNeeded: (e) {
+        var db = e.target.result as Database;
+        if ((db.objectStoreNames ?? []).contains(objectStoreName)) {
+          db.deleteObjectStore(objectStoreName);
+        }
+      });
+      if ((db.objectStoreNames ?? []).isEmpty) {
+        await indexDB.deleteDatabase(_db.name!);
+      }
     }
   }
 

hive/lib/src/box_collection.dart renamed to hive/lib/src/box_collection/box_collection.dart

@@ -4,8 +4,12 @@ import 'dart:convert';
 import 'package:crypto/crypto.dart';
 import 'package:hive/hive.dart';
 
-class BoxCollection {
+import 'box_collection_stub.dart' as implementation;
+
+class BoxCollection implements implementation.BoxCollection {
+  @override
   final String name;
+  @override
   final Set<String> boxNames;
   HiveCipher? _cipher;
 
@@ -34,9 +38,11 @@ class BoxCollection {
     return collection;
   }
 
+  @override
   Future<CollectionBox<V>> openBox<V>(String name,
       {bool preload = false,
-      CollectionBox<V> Function(String, BoxCollection)? boxCreator}) async {
+      implementation.CollectionBox<V> Function(String, BoxCollection)?
+          boxCreator}) async {
     if (!boxNames.contains(name)) {
       throw Exception(
           'Box with name $name is not in the known box names of this collection.');
@@ -46,17 +52,22 @@ class BoxCollection {
       return _openBoxes[i] as CollectionBox<V>;
     }
     final boxIdentifier = '${this.name}_$name';
-    final box = boxCreator?.call(boxIdentifier, this) ??
+    final box = boxCreator?.call(boxIdentifier, this) as CollectionBox<V>? ??
         CollectionBox<V>(boxIdentifier, this);
     if (preload) {
-      box._cachedBox = await Hive.openBox(box.name, encryptionCipher: _cipher);
+      box._cachedBox = await Hive.openBox(
+        box.name,
+        encryptionCipher: _cipher,
+        collection: name,
+      );
     }
     _openBoxes.add(box);
     return box;
   }
 
   final List<CollectionBox> _openBoxes = [];
 
+  @override
   Future<void> transaction(
     Future<void> Function() action, {
     List<String>? boxNames,
@@ -80,20 +91,24 @@ class BoxCollection {
     });
   }
 
+  @override
   void close() {
     for (final box in _openBoxes) {
       box._cachedBox?.close();
     }
   }
 
+  @override
   Future<void> deleteFromDisk() => Future.wait(
         boxNames.map(Hive.deleteBoxFromDisk),
       );
 }
 
 /// represents a [Box] being part of a [BoxCollection]
-class CollectionBox<V> {
+class CollectionBox<V> implements implementation.CollectionBox<V> {
+  @override
   final String name;
+  @override
   final BoxCollection boxCollection;
 
   static final transactionBoxes = <Zone, Set<String>>{};
@@ -104,6 +119,7 @@ class CollectionBox<V> {
     return _cachedBox ??= await Hive.openLazyBox<V>(
       name,
       encryptionCipher: boxCollection._cipher,
+      collection: boxCollection.name,
     );
   }
 
@@ -120,6 +136,7 @@ class CollectionBox<V> {
     }
   }
 
+  @override
   Future<List<String>> getAllKeys() async {
     final box = await _getBox();
     return box.keys
@@ -134,6 +151,7 @@ class CollectionBox<V> {
         .toList();
   }
 
+  @override
   Future<Map<String, V>> getAllValues() async {
     final box = await _getBox();
     final keys = box.keys.toList();
@@ -149,13 +167,15 @@ class CollectionBox<V> {
         .map((k, v) => MapEntry(Uri.decodeComponent(k.toString()), v as V));
   }
 
+  @override
   Future<V?> get(String key) async {
     key = _toHiveKey(key);
     final box = await _getBox();
     if (box is LazyBox) return await box.get(key) as V?;
     return (box as Box).get(key) as V?;
   }
 
+  @override
   Future<List<V?>> getAll(
     List<String> keys,
   ) async {
@@ -172,7 +192,8 @@ class CollectionBox<V> {
     return values;
   }
 
-  Future<void> put(String key, V val) async {
+  @override
+  Future<void> put(String key, V val, [Object? transaction]) async {
     if (val == null) {
       return delete(key);
     }
@@ -181,25 +202,29 @@ class CollectionBox<V> {
     await _flushOrMark();
   }
 
+  @override
   Future<void> delete(String key) async {
     final box = await _getBox();
     await box.delete(_toHiveKey(key));
     await _flushOrMark();
   }
 
+  @override
   Future<void> deleteAll(List<String> keys) async {
     final hiveKeys = keys.map(_toHiveKey);
     final box = await _getBox();
     await box.deleteAll(hiveKeys);
     await _flushOrMark();
   }
 
+  @override
   Future<void> clear() async {
     final box = await _getBox();
     await box.deleteAll(box.keys);
     await _flushOrMark();
   }
 
+  @override
   Future<void> flush() async {
     final box = await _getBox();
     // we do *not* await the flushing here. That makes it so that we can execute