Merge pull request #64 from IO-Design-Team/feature/wasm-int-warning

WASM int warning

hive/CHANGELOG.md

@@ -1,3 +1,8 @@
+## 2.9.0
+
+- Prints a warning when writing `int` or `List<int>` types in a WASM environment
+- Only emits print statements when assertions are enabled (aka debug mode)
+
 ## 2.8.0+3
 
 - Updates the commit hash for the transitive Hive dependencies workaround

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

@@ -4,6 +4,7 @@ import 'package:hive_ce/hive.dart';
 import 'package:hive_ce/src/backend/js/native/storage_backend_js.dart';
 import 'package:hive_ce/src/backend/js/native/utils.dart';
 import 'package:hive_ce/src/backend/storage_backend.dart';
+import 'package:hive_ce/src/util/debug_utils.dart';
 import 'package:web/web.dart';
 
 /// Opens IndexedDB databases
@@ -35,7 +36,7 @@ class BackendManager implements BackendManagerInterface {
     // in case the objectStore is not contained, re-open the db and
     // update version
     if (!db.objectStoreNames.contains(objectStoreName)) {
-      print(
+      debugPrint(
         'Creating objectStore $objectStoreName in database $databaseName...',
       );
       final request = indexedDB!.open(databaseName, db.version + 1);
@@ -48,14 +49,14 @@ class BackendManager implements BackendManagerInterface {
       db = await request.asFuture<IDBDatabase>();
     }
 
-    print('Got object store $objectStoreName in database $databaseName.');
+    debugPrint('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');
+    debugPrint('Delete $name // $collection from disk');
 
     // compatibility for old store format
     final databaseName = collection ?? name;

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

@@ -11,12 +11,29 @@ import 'package:hive_ce/src/binary/binary_writer_impl.dart';
 import 'package:hive_ce/src/binary/frame.dart';
 import 'package:hive_ce/src/box/keystore.dart';
 import 'package:hive_ce/src/registry/type_registry_impl.dart';
+import 'package:hive_ce/src/util/debug_utils.dart';
 import 'package:meta/meta.dart';
 import 'package:web/web.dart';
 
 /// Handles all IndexedDB related tasks
 class StorageBackendJs extends StorageBackend {
   static const _bytePrefix = [0x90, 0xA9];
+
+  /// If this is a WASM environment
+  @visibleForTesting
+  static const isWasm = bool.fromEnvironment('dart.tool.dart2wasm');
+
+  /// Warning message printed when writing `int` values in a WASM environment
+  @visibleForTesting
+  static const wasmIntWarning =
+      'WARNING: You are writing a type of `int` or `List<int>` in a WASM '
+      'environment. This value will read as a `double` or `List<double>` '
+      'on subsequent app launches and need manually casted back to the correct '
+      'type. Ensure you are doing one of the following:\n'
+      ' - (box.get(key) as num).toInt()\n'
+      ' - (box.get(key) as List).cast<num>().map((e) => e.toInt()).toList()\n\n'
+      'Also consider using TypeAdapters since they automatically handle this.';
+
   final IDBDatabase _db;
   final HiveCipher? _cipher;
 
@@ -62,6 +79,13 @@ class StorageBackendJs extends StorageBackend {
           value is List<num> ||
           value is List<bool> ||
           value is List<String>) {
+        ifDebug(() {
+          final isIntType = value is int || value is List<int>;
+          if (isIntType && isWasm) {
+            print(wasmIntWarning);
+          }
+        });
+
         return value.jsify();
       }
     }
@@ -206,7 +230,7 @@ class StorageBackendJs extends StorageBackend {
   Future<void> deleteFromDisk() async {
     final indexDB = window.self.indexedDB;
 
-    print('Delete ${_db.name} // $objectStoreName from disk');
+    debugPrint('Delete ${_db.name} // $objectStoreName from disk');
 
     // directly deleting the entire DB if a non-collection Box
     if (_db.objectStoreNames.length == 1) {

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

@@ -4,6 +4,7 @@ import 'dart:io';
 import 'package:hive_ce/hive.dart';
 import 'package:hive_ce/src/backend/storage_backend.dart';
 import 'package:hive_ce/src/backend/vm/storage_backend_vm.dart';
+import 'package:hive_ce/src/util/debug_utils.dart';
 import 'package:meta/meta.dart';
 
 /// Not part of public API
@@ -61,7 +62,7 @@ class BackendManager implements BackendManagerInterface {
       }
       return hiveFile;
     } else if (await compactedFile.exists()) {
-      print('Restoring compacted file.');
+      debugPrint('Restoring compacted file.');
       return await compactedFile.rename(hiveFile.path);
     } else {
       await hiveFile.create();

hive/lib/src/backend/vm/storage_backend_vm.dart

@@ -11,6 +11,7 @@ import 'package:hive_ce/src/box/keystore.dart';
 import 'package:hive_ce/src/io/buffered_file_reader.dart';
 import 'package:hive_ce/src/io/buffered_file_writer.dart';
 import 'package:hive_ce/src/io/frame_io_helper.dart';
+import 'package:hive_ce/src/util/debug_utils.dart';
 import 'package:meta/meta.dart';
 
 /// Storage backend for the Dart VM
@@ -102,7 +103,7 @@ class StorageBackendVm extends StorageBackend {
 
     if (recoveryOffset != -1) {
       if (_crashRecovery) {
-        print('Recovering corrupted box.');
+        debugPrint('Recovering corrupted box.');
         await writeRaf.truncate(recoveryOffset);
         await writeRaf.setPosition(recoveryOffset);
         writeOffset = recoveryOffset;

hive/lib/src/registry/type_registry_impl.dart

@@ -1,5 +1,6 @@
 import 'package:hive_ce/hive.dart';
 import 'package:hive_ce/src/adapters/ignored_type_adapter.dart';
+import 'package:hive_ce/src/util/debug_utils.dart';
 import 'package:meta/meta.dart';
 
 /// Not part of public API
@@ -107,7 +108,7 @@ class TypeRegistryImpl implements TypeRegistry {
     bool override = false,
   }) {
     if (T == dynamic || T == Object) {
-      print(
+      debugPrint(
         'Registering type adapters for dynamic type is must be avoided, '
         'otherwise all the write requests to Hive will be handled by given '
         'adapter. Please explicitly provide adapter type on registerAdapter '
@@ -130,7 +131,7 @@ class TypeRegistryImpl implements TypeRegistry {
           final oldAdapterType = oldAdapter.runtimeType;
           final newAdapterType = adapter.runtimeType;
           final typeId = adapter.typeId;
-          print(
+          debugPrint(
             'You are trying to override $oldAdapterType '
             'with $newAdapterType for typeId: $typeId. '
             'Please note that overriding adapters might '
@@ -151,7 +152,7 @@ class TypeRegistryImpl implements TypeRegistry {
         final existingAdapterTypeId = adapterForSameType.typeId;
 
         if (adapterTypeId != existingAdapterTypeId) {
-          print(
+          debugPrint(
             'WARNING: You are trying to register $adapterType '
             '(typeId $adapterTypeId) for type $T but there is already a '
             'TypeAdapter for this type: $existingAdapterType '

hive/lib/src/util/debug_utils.dart

@@ -0,0 +1,10 @@
+/// Only run the given function if assertions are enabled
+void ifDebug(void Function() f) {
+  assert(() {
+    f();
+    return true;
+  }());
+}
+
+/// Only print the given message if assertions are enabled
+void debugPrint(String message) => ifDebug(() => print(message));

hive/pubspec.yaml

@@ -1,6 +1,6 @@
 name: hive_ce
 description: Hive Community Edition - A spiritual continuation of Hive v2
-version: 2.8.0+3
+version: 2.9.0
 homepage: https://github.com/IO-Design-Team/hive_ce/tree/main/hive
 documentation: https://docs.hivedb.dev/
 

hive/test/tests/backend/js/storage_backend_js_test.dart

@@ -1,7 +1,7 @@
 @TestOn('browser')
 library;
 
-import 'dart:async' show Future;
+import 'dart:async';
 import 'dart:js_interop';
 import 'dart:typed_data';
 
@@ -117,6 +117,31 @@ void main() async {
           expect(encoded, [0x90, 0xA9, ...writer.toBytes()]);
         });
       });
+
+      group('int', () {
+        void expectWarning(Object obj) {
+          var output = '';
+          runZoned(
+            () => _getBackend().encodeValue(Frame('key', obj)),
+            zoneSpecification: ZoneSpecification(
+              print: (_, __, ___, line) => output += line,
+            ),
+          );
+
+          if (StorageBackendJs.isWasm) {
+            expect(output, StorageBackendJs.wasmIntWarning);
+          } else {
+            expect(output, isEmpty);
+          }
+        }
+
+        test('prints warning for `int` type', () => expectWarning(11));
+
+        test(
+          'prints warning for `List<int>` type',
+          () => expectWarning([11, 12, 13]),
+        );
+      });
     });
 
     group('.decodeValue()', () {