[idb_shim] add count support on store and index

tekartik · Jul 22, 2024 · 2669990 · 2669990
1 parent eedbd1b
commit 2669990
Show file tree

Hide file tree

Showing 10 changed files with 98 additions and 26 deletions.
diff --git a/.github/dependabot.yml b/.github/dependabot.yml
@@ -3,22 +3,20 @@
 version: 2
 
 enable-beta-ecosystems: true
+
 updates:
   - package-ecosystem: "pub"
     directory: "idb_shim"
     schedule:
       interval: "monthly"
-
   - package-ecosystem: "pub"
     directory: "idb_test"
     schedule:
       interval: "monthly"
-
   - package-ecosystem: "pub"
     directory: "repo_support"
     schedule:
       interval: "monthly"
-
   - package-ecosystem: "github-actions"
     directory: "/"
     schedule:

diff --git a/idb_shim/lib/src/sdb/sdb_index.dart b/idb_shim/lib/src/sdb/sdb_index.dart
@@ -58,11 +58,15 @@ extension SdbIndexRefExtension<K extends KeyBase, V extends ValueBase,
       impl.findRecordsImpl(client,
           boundaries: boundaries, offset: offset, limit: limit);
 
-  /// Find records.
+  /// Find record keys.
   Future<List<SdbIndexRecordKey<K, V, I>>> findRecordKeys(SdbClient client,
           {SdbBoundaries<I>? boundaries, int? offset, int? limit}) =>
       impl.findRecordKeysImpl(client,
           boundaries: boundaries, offset: offset, limit: limit);
+
+  /// Count records.
+  Future<int> count(SdbClient client, {SdbBoundaries<I>? boundaries}) =>
+      impl.countImpl(client, boundaries: boundaries);
 }
 
 /// Extension on index on 1 field.

diff --git a/idb_shim/lib/src/sdb/sdb_index_impl.dart b/idb_shim/lib/src/sdb/sdb_index_impl.dart
@@ -165,4 +165,27 @@ class SdbIndexRefImpl<K extends KeyBase, V extends ValueBase,
       return SdbIndexRecordKeyImpl<K, V, I>(this, key, indexKey);
     }).toList();
   }
+
+  /// Count records.
+  Future<int> countImpl(SdbClient client, {SdbBoundaries<I>? boundaries}) =>
+      client.handleDbOrTxn((db) => dbCountImpl(db, boundaries: boundaries),
+          (txn) => txnCountImpl(txn, boundaries: boundaries));
+
+  /// Count records.
+  Future<int> dbCountImpl(SdbDatabase db, {SdbBoundaries<I>? boundaries}) {
+    return db.inStoreTransaction(store, SdbTransactionMode.readOnly, (txn) {
+      return txnCountImpl(txn.rawImpl, boundaries: boundaries);
+    });
+  }
+
+  /// Find record keys.
+  Future<int> txnCountImpl(
+    SdbTransactionImpl txn, {
+    SdbBoundaries<I>? boundaries,
+  }) async {
+    var idbObjectStore = txn.idbTransaction.objectStore(store.name);
+    var idbIndex = idbObjectStore.index(name);
+    var count = idbIndex.count(idbKeyRangeFromBoundaries(boundaries));
+    return count;
+  }
 }
diff --git a/idb_shim/lib/src/sdb/sdb_store.dart b/idb_shim/lib/src/sdb/sdb_store.dart
@@ -38,6 +38,10 @@ extension SdbStoreRefExtension<K extends KeyBase, V extends ValueBase>
       impl.findRecordKeysImpl(client,
           boundaries: boundaries, offset: offset, limit: limit);
 
+  /// Count records.
+  Future<int> count(SdbClient client, {SdbBoundaries<K>? boundaries}) =>
+      impl.countImpl(client, boundaries: boundaries);
+
   /// Record reference.
   SdbRecordRef<K, V> record(K key) => SdbRecordRefImpl<K, V>(impl, key);
 

diff --git a/idb_shim/lib/src/sdb/sdb_store_impl.dart b/idb_shim/lib/src/sdb/sdb_store_impl.dart
@@ -96,20 +96,11 @@ class SdbStoreRefImpl<K extends KeyBase, V extends ValueBase>
           (txn) => txnFindRecordsImpl(txn,
               boundaries: boundaries, offset: offset, limit: limit));
 
-  /// Find records.
-  Future<List<SdbRecordKey<K, V>>> findRecordKeysImpl(SdbClient client,
-          {SdbBoundaries<K>? boundaries, int? offset, int? limit}) =>
-      client.handleDbOrTxn(
-          (db) => dbFindRecordKeysImpl(db,
-              boundaries: boundaries, offset: offset, limit: limit),
-          (txn) => txnFindRecordKeysImpl(txn,
-              boundaries: boundaries, offset: offset, limit: limit));
-
   /// Find records.
   Future<List<SdbRecordSnapshot<K, V>>> dbFindRecordsImpl(SdbDatabase db,
       {SdbBoundaries<K>? boundaries, int? offset, int? limit}) {
     return db.inStoreTransaction(this, SdbTransactionMode.readOnly, (txn) {
-      return txn.findRecords(
+      return txnFindRecordsImpl(txn.rawImpl,
           boundaries: boundaries, offset: offset, limit: limit);
     });
   }
@@ -125,11 +116,20 @@ class SdbStoreRefImpl<K extends KeyBase, V extends ValueBase>
         .findRecords(boundaries: boundaries, offset: offset, limit: limit);
   }
 
+  /// Find records.
+  Future<List<SdbRecordKey<K, V>>> findRecordKeysImpl(SdbClient client,
+          {SdbBoundaries<K>? boundaries, int? offset, int? limit}) =>
+      client.handleDbOrTxn(
+          (db) => dbFindRecordKeysImpl(db,
+              boundaries: boundaries, offset: offset, limit: limit),
+          (txn) => txnFindRecordKeysImpl(txn,
+              boundaries: boundaries, offset: offset, limit: limit));
+
   /// Find record keys.
   Future<List<SdbRecordKey<K, V>>> dbFindRecordKeysImpl(SdbDatabase db,
       {SdbBoundaries<K>? boundaries, int? offset, int? limit}) {
     return db.inStoreTransaction(this, SdbTransactionMode.readOnly, (txn) {
-      return txn.findRecordKeys(
+      return txnFindRecordKeysImpl(txn.rawImpl,
           boundaries: boundaries, offset: offset, limit: limit);
     });
   }
@@ -141,4 +141,22 @@ class SdbStoreRefImpl<K extends KeyBase, V extends ValueBase>
         .storeImpl(this)
         .findRecordKeys(boundaries: boundaries, offset: offset, limit: limit);
   }
+
+  /// Count records.
+  Future<int> countImpl(SdbClient client, {SdbBoundaries<K>? boundaries}) =>
+      client.handleDbOrTxn((db) => dbCountImpl(db, boundaries: boundaries),
+          (txn) => txnCountImpl(txn, boundaries: boundaries));
+
+  /// Count records.
+  Future<int> dbCountImpl(SdbDatabase db, {SdbBoundaries<K>? boundaries}) {
+    return db.inStoreTransaction(this, SdbTransactionMode.readOnly, (txn) {
+      return txnCountImpl(txn.rawImpl, boundaries: boundaries);
+    });
+  }
+
+  /// Count records.
+  Future<int> txnCountImpl(SdbTransactionImpl txn,
+      {SdbBoundaries<K>? boundaries}) {
+    return txn.storeImpl(this).count(boundaries: boundaries);
+  }
 }
diff --git a/idb_shim/lib/src/sdb/sdb_transaction_store.dart b/idb_shim/lib/src/sdb/sdb_transaction_store.dart
@@ -44,6 +44,10 @@ extension SdbTransactionStoreRefExtension<K extends KeyBase,
       _impl.findRecordKeysImpl(
           boundaries: boundaries, offset: offset, limit: limit);
 
+  /// Count record.
+  Future<int> count({SdbBoundaries<K>? boundaries}) =>
+      _impl.countImpl(boundaries: boundaries);
+
   /// store name.
   String get name => store.name;
 }

diff --git a/idb_shim/lib/src/sdb/sdb_transaction_store_impl.dart b/idb_shim/lib/src/sdb/sdb_transaction_store_impl.dart
@@ -171,6 +171,11 @@ class SdbTransactionStoreRefImpl<K extends KeyBase, V extends ValueBase>
       return SdbRecordKeyImpl<K, V>(store, key);
     }).toList();
   }
+
+  /// Count records.
+  Future<int> countImpl({SdbBoundaries<K>? boundaries}) async {
+    return idbObjectStore.count(idbKeyRangeFromBoundaries(boundaries));
+  }
 }
 
 /// Multi store transaction internal extension.

diff --git a/idb_test/lib/sdb_test.dart b/idb_test/lib/sdb_test.dart
@@ -100,9 +100,13 @@ void simpleDbTest(idb.IdbFactory idbFactory) {
         await txn.add({'test': 2});
         await txn.add({'test': 3});
       });
-      var records = await testStore.findRecords(db,
-          boundaries: SdbBoundaries(SdbLowerBoundary(1), SdbUpperBoundary(3)));
+      var boundaries = SdbBoundaries(SdbLowerBoundary(1), SdbUpperBoundary(3));
+      var records = await testStore.findRecords(db, boundaries: boundaries);
       expect(records.length, 2);
+      var keys = await testStore.findRecordKeys(db, boundaries: boundaries);
+      expect(keys.keys, [1, 2]);
+      var count = await testStore.count(db, boundaries: boundaries);
+      expect(count, 2);
 
       await db.close();
     });
@@ -122,10 +126,14 @@ void simpleDbTest(idb.IdbFactory idbFactory) {
         await txn.add({'test': 2});
         await txn.add({'test': 3});
 
-        var records = await testStore.findRecords(txn,
-            boundaries:
-                SdbBoundaries(SdbLowerBoundary(1), SdbUpperBoundary(3)));
+        var boundaries =
+            SdbBoundaries(SdbLowerBoundary(1), SdbUpperBoundary(3));
+        var records = await testStore.findRecords(txn, boundaries: boundaries);
         expect(records.length, 2);
+        var keys = await testStore.findRecordKeys(txn, boundaries: boundaries);
+        expect(keys.keys, [1, 2]);
+        var count = await testStore.count(txn, boundaries: boundaries);
+        expect(count, 2);
       });
 
       await db.close();
@@ -214,13 +222,21 @@ void simpleDbTest(idb.IdbFactory idbFactory) {
         await txn.add({'test': 1});
         await txn.add({'test': 2});
         await txn.add({'test': 3});
+
+        var boundaries =
+            SdbBoundaries(SdbLowerBoundary(1), SdbUpperBoundary(3));
+        var records = await testIndex.findRecords(txn, boundaries: boundaries);
+        expect(records.length, 2);
+        var keys = await testIndex.findRecordKeys(txn, boundaries: boundaries);
+        expect(keys.length, 2);
+        expect(await testIndex.count(txn, boundaries: boundaries), 2);
       });
-      var records = await testIndex.findRecords(db,
-          boundaries: SdbBoundaries(SdbLowerBoundary(1), SdbUpperBoundary(3)));
+      var boundaries = SdbBoundaries(SdbLowerBoundary(1), SdbUpperBoundary(3));
+      var records = await testIndex.findRecords(db, boundaries: boundaries);
       expect(records.length, 2);
-      var keys = await testIndex.findRecordKeys(db,
-          boundaries: SdbBoundaries(SdbLowerBoundary(1), SdbUpperBoundary(3)));
+      var keys = await testIndex.findRecordKeys(db, boundaries: boundaries);
       expect(keys.length, 2);
+      expect(await testIndex.count(db, boundaries: boundaries), 2);
 
       await db.close();
     });

diff --git a/idb_test/pubspec.yaml b/idb_test/pubspec.yaml
@@ -6,7 +6,7 @@ homepage: https://github.com/tekartik/idb_shim.dart/tree/master/idb_test
 publish_to: none
 
 environment:
-  sdk: '>=3.4.0-0 <4.0.0'
+  sdk: ^3.4.0
 
 dependencies:
   idb_shim: '>=2.4.0-1 <3.0.0'

diff --git a/repo_support/pubspec.yaml b/repo_support/pubspec.yaml
@@ -3,7 +3,7 @@ version: 0.1.0
 publish_to: none
 
 environment:
-  sdk: '>=3.0.0 <4.0.0'
+  sdk: ^3.4.0
 
 dependencies:
   process_run: '>=0.10.0'