feat: upstream FluffyBox patches (isar#956)

- add `BoxCollection`
- prepare support for other web backends

Fixes: isar#939

Signed-off-by: TheOneWithTheBraid <the-one@with-the-braid.cf>

.gitignore

@@ -94,9 +94,12 @@ unlinked_spec.ds
 # Coverage
 coverage/
 
+# JavaScipt
+web_worker.dart.js*
+
 # Exceptions to above rules.
 !**/ios/**/default.mode1v3
 !**/ios/**/default.mode2v3
 !**/ios/**/default.pbxuser
 !**/ios/**/default.perspectivev3
-!/packages/flutter_tools/test/data/dart_dependencies_test/**/.packages
+!/packages/flutter_tools/test/data/dart_dependencies_test/**/.packages

hive/.pubignore

@@ -0,0 +1 @@
+!lib/src/backend/js/web_worker/web_worker.dart.js*

hive/lib/hive.dart

@@ -18,23 +18,25 @@ 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/object/hive_object.dart' show HiveObject, HiveObjectMixin;
 
 part 'src/annotations/hive_field.dart';
 part 'src/annotations/hive_type.dart';
 part 'src/binary/binary_reader.dart';
 part 'src/binary/binary_writer.dart';
-part 'src/box/box_base.dart';
 part 'src/box/box.dart';
+part 'src/box/box_base.dart';
 part 'src/box/lazy_box.dart';
 part 'src/crypto/hive_aes_cipher.dart';
 part 'src/crypto/hive_cipher.dart';
+part 'src/hive.dart';
+part 'src/hive_error.dart';
 part 'src/object/hive_collection.dart';
 part 'src/object/hive_list.dart';
-part 'src/registry/type_registry.dart';
+part 'src/object/hive_storage_backend_preference.dart';
 part 'src/registry/type_adapter.dart';
-part 'src/hive_error.dart';
-part 'src/hive.dart';
+part 'src/registry/type_registry.dart';
 
 /// Global constant to access Hive.
 // ignore: non_constant_identifier_names

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

@@ -1,46 +1,18 @@
-import 'dart:html';
-import 'dart:indexed_db';
-import 'dart:js' as js;
 import 'package:hive/hive.dart';
-import 'package:hive/src/backend/js/storage_backend_js.dart';
 import 'package:hive/src/backend/storage_backend.dart';
 
-/// Opens IndexedDB databases
-class BackendManager implements BackendManagerInterface {
-  IdbFactory? get indexedDB => js.context.hasProperty('window')
-      ? window.indexedDB
-      : WorkerGlobalScope.instance.indexedDB;
-
-  @override
-  Future<StorageBackend> open(
-      String name, String? path, bool crashRecovery, HiveCipher? cipher) async {
-    var db = await indexedDB!.open(name, version: 1, onUpgradeNeeded: (e) {
-      var db = e.target.result as Database;
-      if (!db.objectStoreNames!.contains('box')) {
-        db.createObjectStore('box');
-      }
-    });
-
-    return StorageBackendJs(db, cipher);
-  }
+import 'native/backend_manager.dart' as native;
 
-  @override
-  Future<void> deleteBox(String name, String? path) {
-    return indexedDB!.deleteDatabase(name);
-  }
+/// Opens IndexedDB databases
+abstract class BackendManager {
+  BackendManager._();
 
-  @override
-  Future<bool> boxExists(String name, String? path) async {
-    // https://stackoverflow.com/a/17473952
-    try {
-      var _exists = true;
-      await indexedDB!.open(name, version: 1, onUpgradeNeeded: (e) {
-        e.target.transaction!.abort();
-        _exists = false;
-      });
-      return _exists;
-    } catch (error) {
-      return false;
+  // dummy implementation as the WebWorker branch is not stable yet
+  static BackendManagerInterface select(
+      [HiveStorageBackendPreference? backendPreference]) {
+    switch (backendPreference) {
+      default:
+        return native.BackendManager();
     }
   }
 }

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

@@ -0,0 +1,82 @@
+import 'dart:async';
+import 'dart:html';
+import 'dart:indexed_db';
+import 'dart:js' as js;
+import 'package:hive/hive.dart';
+import 'package:hive/src/backend/js/native/storage_backend_js.dart';
+import 'package:hive/src/backend/storage_backend.dart';
+
+/// Opens IndexedDB databases
+class BackendManager implements BackendManagerInterface {
+  IdbFactory? get indexedDB => js.context.hasProperty('window')
+      ? window.indexedDB
+      : WorkerGlobalScope.instance.indexedDB;
+
+  @override
+  Future<StorageBackend> open(String name, String? path, bool crashRecovery,
+      HiveCipher? cipher, String? collection) async {
+    // compatibility for old store format
+    final databaseName = collection ?? name;
+    final objectStoreName = collection == null ? 'box' : name;
+
+    final db =
+        await indexedDB!.open(databaseName, version: 1, onUpgradeNeeded: (e) {
+      var db = e.target.result as Database;
+      if (!(db.objectStoreNames ?? []).contains(objectStoreName)) {
+        db.createObjectStore(objectStoreName);
+      }
+    });
+
+    return StorageBackendJs(db, cipher, objectStoreName);
+  }
+
+  @override
+  Future<void> deleteBox(String name, String? path, String? collection) async {
+    // compatibility for old store format
+    final databaseName = collection ?? name;
+    final objectStoreName = collection == null ? 'box' : name;
+
+    // directly deleting the entire DB if a non-collection Box
+    if (collection == null) {
+      await indexedDB!.deleteDatabase(databaseName);
+    } else {
+      final db =
+          await indexedDB!.open(databaseName, version: 1, onUpgradeNeeded: (e) {
+        var db = e.target.result as Database;
+        if ((db.objectStoreNames ?? []).contains(objectStoreName)) {
+          db.deleteObjectStore(objectStoreName);
+        }
+      });
+      if ((db.objectStoreNames ?? []).isEmpty) {
+        indexedDB!.deleteDatabase(databaseName);
+      }
+    }
+  }
+
+  @override
+  Future<bool> boxExists(String name, String? path, String? collection) async {
+    // compatibility for old store format
+    final databaseName = collection ?? name;
+    final objectStoreName = collection == null ? 'box' : name;
+    // https://stackoverflow.com/a/17473952
+    try {
+      var _exists = true;
+      if (collection == null) {
+        await indexedDB!.open(databaseName, version: 1, onUpgradeNeeded: (e) {
+          e.target.transaction!.abort();
+          _exists = false;
+        });
+      } else {
+        final db =
+            await indexedDB!.open(collection, version: 1, onUpgradeNeeded: (e) {
+          var db = e.target.result as Database;
+          _exists = (db.objectStoreNames ?? []).contains(objectStoreName);
+        });
+        _exists = (db.objectStoreNames ?? []).contains(objectStoreName);
+      }
+      return _exists;
+    } catch (error) {
+      return false;
+    }
+  }
+}