@dereekb/firebase 13.0.6 → 13.0.7

package/test/index.cjs.js

@@ -3485,6 +3485,87 @@ function describeFirestoreDocumentUtilityTests(f) {
                     });
                 });
             });
+            // MARK: limitedFirestoreDocumentAccessorSnapshotCache
+            describe('limitedFirestoreDocumentAccessorSnapshotCache()', () => {
+                it('should expose the underlying accessor', () => {
+                    const accessor = f.instance.mockItemCollection.documentAccessor();
+                    const cache = firebase.limitedFirestoreDocumentAccessorSnapshotCache(accessor);
+                    expect(cache.accessor).toBe(accessor);
+                });
+                describe('getDocumentSnapshotDataPairForKey()', () => {
+                    it('should return a snapshot data pair for an existing document', async () => {
+                        const accessor = f.instance.mockItemCollection.documentAccessor();
+                        const cache = firebase.limitedFirestoreDocumentAccessorSnapshotCache(accessor);
+                        const pair = await cache.getDocumentSnapshotDataPairForKey(items[0].key);
+                        expect(pair.document).toBeDefined();
+                        expect(pair.document.key).toBe(items[0].key);
+                        expect(pair.snapshot).toBeDefined();
+                        expect(pair.data).toBeDefined();
+                        expect(pair.data.id).toBe(items[0].id);
+                        expect(pair.data.key).toBe(items[0].key);
+                    });
+                    it('should return the same promise for the same key', async () => {
+                        const accessor = f.instance.mockItemCollection.documentAccessor();
+                        const cache = firebase.limitedFirestoreDocumentAccessorSnapshotCache(accessor);
+                        const promise1 = cache.getDocumentSnapshotDataPairForKey(items[0].key);
+                        const promise2 = cache.getDocumentSnapshotDataPairForKey(items[0].key);
+                        expect(promise1).toBe(promise2);
+                    });
+                    it('should return undefined data for a non-existent document', async () => {
+                        const accessor = f.instance.mockItemCollection.documentAccessor();
+                        const cache = firebase.limitedFirestoreDocumentAccessorSnapshotCache(accessor);
+                        const newDoc = firebase.newDocuments(accessor, 1)[0];
+                        const pair = await cache.getDocumentSnapshotDataPairForKey(newDoc.key);
+                        expect(pair.document).toBeDefined();
+                        expect(pair.data).toBeUndefined();
+                    });
+                });
+                describe('getDocumentSnapshotDataPairsForKeys()', () => {
+                    it('should return pairs for all keys in order', async () => {
+                        const accessor = f.instance.mockItemCollection.documentAccessor();
+                        const cache = firebase.limitedFirestoreDocumentAccessorSnapshotCache(accessor);
+                        const keys = items.map((x) => x.key);
+                        const pairs = await cache.getDocumentSnapshotDataPairsForKeys(keys);
+                        expect(pairs.length).toBe(testDocumentCount);
+                        pairs.forEach((pair, i) => {
+                            expect(pair.document.key).toBe(items[i].key);
+                            expect(pair.data).toBeDefined();
+                            expect(pair.data.id).toBe(items[i].id);
+                        });
+                    });
+                    it('should use the cache for duplicate keys', async () => {
+                        const accessor = f.instance.mockItemCollection.documentAccessor();
+                        const cache = firebase.limitedFirestoreDocumentAccessorSnapshotCache(accessor);
+                        const key = items[0].key;
+                        const [pair1] = await cache.getDocumentSnapshotDataPairsForKeys([key]);
+                        const [pair2] = await cache.getDocumentSnapshotDataPairsForKeys([key]);
+                        expect(pair1).toBe(pair2);
+                    });
+                });
+                describe('getDocumentSnapshotDataPairsWithDataForKeys()', () => {
+                    it('should return pairs for all existing documents', async () => {
+                        const accessor = f.instance.mockItemCollection.documentAccessor();
+                        const cache = firebase.limitedFirestoreDocumentAccessorSnapshotCache(accessor);
+                        const keys = items.map((x) => x.key);
+                        const pairs = await cache.getDocumentSnapshotDataPairsWithDataForKeys(keys);
+                        expect(pairs.length).toBe(testDocumentCount);
+                        pairs.forEach((pair) => {
+                            expect(pair.data).toBeDefined();
+                            expect(pair.data.id).toBeDefined();
+                            expect(pair.data.key).toBeDefined();
+                        });
+                    });
+                    it('should filter out non-existent documents', async () => {
+                        const accessor = f.instance.mockItemCollection.documentAccessor();
+                        const cache = firebase.limitedFirestoreDocumentAccessorSnapshotCache(accessor);
+                        const newDoc = firebase.newDocuments(accessor, 1)[0];
+                        const keys = [...items.map((x) => x.key), newDoc.key];
+                        const pairs = await cache.getDocumentSnapshotDataPairsWithDataForKeys(keys);
+                        expect(pairs.length).toBe(testDocumentCount);
+                        expect(pairs.every((p) => p.data != null)).toBe(true);
+                    });
+                });
+            });
         });
         describe('document.rxjs.ts', () => {
             // MARK: latestSnapshotsFromDocuments
@@ -3532,10 +3613,10 @@ function describeFirestoreDocumentUtilityTests(f) {
                     });
                 }));
             });
-            // MARK: latestDataFromDocuments
-            describe('latestDataFromDocuments()', () => {
+            // MARK: streamDocumentSnapshotsData
+            describe('streamDocumentSnapshotsData()', () => {
                 it('should emit data with id/key for all documents', test.callbackTest((done) => {
-                    sub.subscription = firebase.latestDataFromDocuments(items)
+                    sub.subscription = firebase.streamDocumentSnapshotsData(items)
                         .pipe(rxjs$1.first())
                         .subscribe((data) => {
                         expect(data.length).toBe(testDocumentCount);
@@ -3548,7 +3629,7 @@ function describeFirestoreDocumentUtilityTests(f) {
                     });
                 }));
                 it('should emit an empty array for empty input', test.callbackTest((done) => {
-                    sub.subscription = firebase.latestDataFromDocuments([])
+                    sub.subscription = firebase.streamDocumentSnapshotsData([])
                         .pipe(rxjs$1.first())
                         .subscribe((data) => {
                         expect(data.length).toBe(0);

package/test/index.esm.js

@@ -1,7 +1,7 @@
 import { performAsyncTasks, cachedGetter, bitwiseObjectDencoder, modelFieldConversions, isEvenNumber, arrayFactory, mapGetter, randomNumberFactory, randomFromArrayFactory, idBatchFactory, unique, waitForMs, arrayContainsDuplicateValue, useCallback, readableStreamToBuffer, SLASH_PATH_SEPARATOR } from '@dereekb/util';
 import { AbstractTestContextFixture, testContextBuilder, instanceWrapTestContextFactory, AbstractWrappedFixtureWithInstance, itShouldFail, expectFail, callbackTest } from '@dereekb/util/test';
 import { initializeTestEnvironment } from '@firebase/rules-unit-testing';
-import { firebaseStorageClientDrivers, firebaseFirestoreClientDrivers, firestoreContextFactory, firebaseStorageContextFactory, firestoreModelIdentity, snapshotConverterFunctions, firestoreBoolean, optionalFirestoreNumber, optionalFirestoreDate, optionalFirestoreArray, optionalFirestoreString, firestoreDate, firestoreBitwiseObjectMap, firestoreUniqueStringArray, firestoreNumber, firestoreString, firestoreUID, copyUserRelatedDataAccessorFactoryFunction, firestoreSubObject, AbstractFirestoreDocumentWithParent, AbstractFirestoreDocument, firebaseModelServiceFactory, grantFullAccessIfAdmin, firebaseModelsService, systemStateFirestoreCollection, allChildDocumentsUnderParent, where, makeDocuments, getDocumentSnapshotPairs, useDocumentSnapshot, useDocumentSnapshotData, firestoreIdBatchVerifierFactory, whereDocumentId, loadAllFirestoreDocumentSnapshotPairs, loadAllFirestoreDocumentSnapshot, iterateFirestoreDocumentSnapshotPairs, iterateFirestoreDocumentSnapshots, iterateFirestoreDocumentSnapshotPairBatches, iterateFirestoreDocumentSnapshotBatches, limit, orderBy, limitToLast, whereStringHasRootIdentityModelKey, whereStringValueHasPrefix, whereDateIsAfterWithSort, whereDateIsBeforeWithSort, whereDateIsOnOrAfterWithSort, whereDateIsOnOrBeforeWithSort, whereDateIsInRange, whereDateIsBetween, startAt, orderByDocumentId, startAtValue, startAfter, endAt, endAtValue, endBefore, streamFromOnSnapshot, latestSnapshotsFromDocuments, newDocuments, getDocumentSnapshots, getDocumentSnapshotPair, getDocumentSnapshotDataPair, getDocumentSnapshotDataPairs, getDocumentSnapshotDataPairsWithData, getDocumentSnapshotDataTuples, getDocumentSnapshotData, getDocumentSnapshotsData, getDataFromDocumentSnapshots, loadDocumentsForSnapshots, loadDocumentsForDocumentReferences, loadDocumentsForDocumentReferencesFromValues, loadDocumentsForKeys, loadDocumentsForKeysFromValues, loadDocumentsForIds, loadDocumentsForIdsFromValues, firestoreDocumentLoader, firestoreDocumentSnapshotPairsLoader, documentData, documentDataFunction, documentDataWithIdAndKey, setIdAndKeyFromSnapshotOnDocumentData, setIdAndKeyFromKeyIdRefOnDocumentData, firestoreModelIdFromDocument, firestoreModelIdsFromDocuments, firestoreModelKeyFromDocument, firestoreModelKeysFromDocuments, documentReferenceFromDocument, documentReferencesFromDocuments, mapLatestSnapshotsFromDocuments, latestDataFromDocuments, dataFromDocumentSnapshots, streamDocumentSnapshotDataPairs, streamDocumentSnapshotDataPairsWithData, firebaseQuerySnapshotAccumulator, firebaseQueryItemAccumulator, uploadFileWithStream, iterateStorageListFilesByEachFile } from '@dereekb/firebase';
+import { firebaseStorageClientDrivers, firebaseFirestoreClientDrivers, firestoreContextFactory, firebaseStorageContextFactory, firestoreModelIdentity, snapshotConverterFunctions, firestoreBoolean, optionalFirestoreNumber, optionalFirestoreDate, optionalFirestoreArray, optionalFirestoreString, firestoreDate, firestoreBitwiseObjectMap, firestoreUniqueStringArray, firestoreNumber, firestoreString, firestoreUID, copyUserRelatedDataAccessorFactoryFunction, firestoreSubObject, AbstractFirestoreDocumentWithParent, AbstractFirestoreDocument, firebaseModelServiceFactory, grantFullAccessIfAdmin, firebaseModelsService, systemStateFirestoreCollection, allChildDocumentsUnderParent, where, makeDocuments, getDocumentSnapshotPairs, useDocumentSnapshot, useDocumentSnapshotData, firestoreIdBatchVerifierFactory, whereDocumentId, loadAllFirestoreDocumentSnapshotPairs, loadAllFirestoreDocumentSnapshot, iterateFirestoreDocumentSnapshotPairs, iterateFirestoreDocumentSnapshots, iterateFirestoreDocumentSnapshotPairBatches, iterateFirestoreDocumentSnapshotBatches, limit, orderBy, limitToLast, whereStringHasRootIdentityModelKey, whereStringValueHasPrefix, whereDateIsAfterWithSort, whereDateIsBeforeWithSort, whereDateIsOnOrAfterWithSort, whereDateIsOnOrBeforeWithSort, whereDateIsInRange, whereDateIsBetween, startAt, orderByDocumentId, startAtValue, startAfter, endAt, endAtValue, endBefore, streamFromOnSnapshot, latestSnapshotsFromDocuments, newDocuments, getDocumentSnapshots, getDocumentSnapshotPair, getDocumentSnapshotDataPair, getDocumentSnapshotDataPairs, getDocumentSnapshotDataPairsWithData, getDocumentSnapshotDataTuples, getDocumentSnapshotData, getDocumentSnapshotsData, getDataFromDocumentSnapshots, loadDocumentsForSnapshots, loadDocumentsForDocumentReferences, loadDocumentsForDocumentReferencesFromValues, loadDocumentsForKeys, loadDocumentsForKeysFromValues, loadDocumentsForIds, loadDocumentsForIdsFromValues, firestoreDocumentLoader, firestoreDocumentSnapshotPairsLoader, documentData, documentDataFunction, documentDataWithIdAndKey, setIdAndKeyFromSnapshotOnDocumentData, setIdAndKeyFromKeyIdRefOnDocumentData, firestoreModelIdFromDocument, firestoreModelIdsFromDocuments, firestoreModelKeyFromDocument, firestoreModelKeysFromDocuments, documentReferenceFromDocument, documentReferencesFromDocuments, limitedFirestoreDocumentAccessorSnapshotCache, mapLatestSnapshotsFromDocuments, streamDocumentSnapshotsData, dataFromDocumentSnapshots, streamDocumentSnapshotDataPairs, streamDocumentSnapshotDataPairsWithData, firebaseQuerySnapshotAccumulator, firebaseQueryItemAccumulator, uploadFileWithStream, iterateStorageListFilesByEachFile } from '@dereekb/firebase';
 import { setLogLevel } from 'firebase/firestore';
 import { firstValueFrom, filter, skip, from, first, map, switchMap } from 'rxjs';
 import { SubscriptionObject, iteratorNextPageUntilPage, flattenAccumulatorResultItemArray, accumulatorCurrentPageListLoadingState, isLoadingStateFinishedLoading, accumulatorFlattenPageListLoadingState } from '@dereekb/rxjs';
@@ -3483,6 +3483,87 @@ function describeFirestoreDocumentUtilityTests(f) {
                     });
                 });
             });
+            // MARK: limitedFirestoreDocumentAccessorSnapshotCache
+            describe('limitedFirestoreDocumentAccessorSnapshotCache()', () => {
+                it('should expose the underlying accessor', () => {
+                    const accessor = f.instance.mockItemCollection.documentAccessor();
+                    const cache = limitedFirestoreDocumentAccessorSnapshotCache(accessor);
+                    expect(cache.accessor).toBe(accessor);
+                });
+                describe('getDocumentSnapshotDataPairForKey()', () => {
+                    it('should return a snapshot data pair for an existing document', async () => {
+                        const accessor = f.instance.mockItemCollection.documentAccessor();
+                        const cache = limitedFirestoreDocumentAccessorSnapshotCache(accessor);
+                        const pair = await cache.getDocumentSnapshotDataPairForKey(items[0].key);
+                        expect(pair.document).toBeDefined();
+                        expect(pair.document.key).toBe(items[0].key);
+                        expect(pair.snapshot).toBeDefined();
+                        expect(pair.data).toBeDefined();
+                        expect(pair.data.id).toBe(items[0].id);
+                        expect(pair.data.key).toBe(items[0].key);
+                    });
+                    it('should return the same promise for the same key', async () => {
+                        const accessor = f.instance.mockItemCollection.documentAccessor();
+                        const cache = limitedFirestoreDocumentAccessorSnapshotCache(accessor);
+                        const promise1 = cache.getDocumentSnapshotDataPairForKey(items[0].key);
+                        const promise2 = cache.getDocumentSnapshotDataPairForKey(items[0].key);
+                        expect(promise1).toBe(promise2);
+                    });
+                    it('should return undefined data for a non-existent document', async () => {
+                        const accessor = f.instance.mockItemCollection.documentAccessor();
+                        const cache = limitedFirestoreDocumentAccessorSnapshotCache(accessor);
+                        const newDoc = newDocuments(accessor, 1)[0];
+                        const pair = await cache.getDocumentSnapshotDataPairForKey(newDoc.key);
+                        expect(pair.document).toBeDefined();
+                        expect(pair.data).toBeUndefined();
+                    });
+                });
+                describe('getDocumentSnapshotDataPairsForKeys()', () => {
+                    it('should return pairs for all keys in order', async () => {
+                        const accessor = f.instance.mockItemCollection.documentAccessor();
+                        const cache = limitedFirestoreDocumentAccessorSnapshotCache(accessor);
+                        const keys = items.map((x) => x.key);
+                        const pairs = await cache.getDocumentSnapshotDataPairsForKeys(keys);
+                        expect(pairs.length).toBe(testDocumentCount);
+                        pairs.forEach((pair, i) => {
+                            expect(pair.document.key).toBe(items[i].key);
+                            expect(pair.data).toBeDefined();
+                            expect(pair.data.id).toBe(items[i].id);
+                        });
+                    });
+                    it('should use the cache for duplicate keys', async () => {
+                        const accessor = f.instance.mockItemCollection.documentAccessor();
+                        const cache = limitedFirestoreDocumentAccessorSnapshotCache(accessor);
+                        const key = items[0].key;
+                        const [pair1] = await cache.getDocumentSnapshotDataPairsForKeys([key]);
+                        const [pair2] = await cache.getDocumentSnapshotDataPairsForKeys([key]);
+                        expect(pair1).toBe(pair2);
+                    });
+                });
+                describe('getDocumentSnapshotDataPairsWithDataForKeys()', () => {
+                    it('should return pairs for all existing documents', async () => {
+                        const accessor = f.instance.mockItemCollection.documentAccessor();
+                        const cache = limitedFirestoreDocumentAccessorSnapshotCache(accessor);
+                        const keys = items.map((x) => x.key);
+                        const pairs = await cache.getDocumentSnapshotDataPairsWithDataForKeys(keys);
+                        expect(pairs.length).toBe(testDocumentCount);
+                        pairs.forEach((pair) => {
+                            expect(pair.data).toBeDefined();
+                            expect(pair.data.id).toBeDefined();
+                            expect(pair.data.key).toBeDefined();
+                        });
+                    });
+                    it('should filter out non-existent documents', async () => {
+                        const accessor = f.instance.mockItemCollection.documentAccessor();
+                        const cache = limitedFirestoreDocumentAccessorSnapshotCache(accessor);
+                        const newDoc = newDocuments(accessor, 1)[0];
+                        const keys = [...items.map((x) => x.key), newDoc.key];
+                        const pairs = await cache.getDocumentSnapshotDataPairsWithDataForKeys(keys);
+                        expect(pairs.length).toBe(testDocumentCount);
+                        expect(pairs.every((p) => p.data != null)).toBe(true);
+                    });
+                });
+            });
         });
         describe('document.rxjs.ts', () => {
             // MARK: latestSnapshotsFromDocuments
@@ -3530,10 +3611,10 @@ function describeFirestoreDocumentUtilityTests(f) {
                     });
                 }));
             });
-            // MARK: latestDataFromDocuments
-            describe('latestDataFromDocuments()', () => {
+            // MARK: streamDocumentSnapshotsData
+            describe('streamDocumentSnapshotsData()', () => {
                 it('should emit data with id/key for all documents', callbackTest((done) => {
-                    sub.subscription = latestDataFromDocuments(items)
+                    sub.subscription = streamDocumentSnapshotsData(items)
                         .pipe(first())
                         .subscribe((data) => {
                         expect(data.length).toBe(testDocumentCount);
@@ -3546,7 +3627,7 @@ function describeFirestoreDocumentUtilityTests(f) {
                     });
                 }));
                 it('should emit an empty array for empty input', callbackTest((done) => {
-                    sub.subscription = latestDataFromDocuments([])
+                    sub.subscription = streamDocumentSnapshotsData([])
                         .pipe(first())
                         .subscribe((data) => {
                         expect(data.length).toBe(0);

package/test/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@dereekb/firebase/test",
-  "version": "13.0.6",
+  "version": "13.0.7",
   "peerDependencies": {
-    "@dereekb/date": "13.0.6",
-    "@dereekb/firebase": "13.0.6",
-    "@dereekb/model": "13.0.6",
-    "@dereekb/rxjs": "13.0.6",
-    "@dereekb/util": "13.0.6",
+    "@dereekb/date": "13.0.7",
+    "@dereekb/firebase": "13.0.7",
+    "@dereekb/model": "13.0.7",
+    "@dereekb/rxjs": "13.0.7",
+    "@dereekb/util": "13.0.7",
     "@firebase/rules-unit-testing": "5.0.0",
     "date-fns": "^4.0.0",
     "firebase": "^12.0.0",