@firebase/firestore 3.9.0-canary.ce79f7fe2 → 3.9.0-canary.f8a2c5865

package/dist/index.node.mjs

@@ -8,7 +8,7 @@ import * as grpc from '@grpc/grpc-js';
 import * as protoLoader from '@grpc/proto-loader';
 
 const name = "@firebase/firestore";
-const version$1 = "3.9.0-canary.ce79f7fe2";
+const version$1 = "3.9.0-canary.f8a2c5865";
 
 /**
  * @license
@@ -61,7 +61,7 @@ User.GOOGLE_CREDENTIALS = new User('google-credentials-uid');
 User.FIRST_PARTY = new User('first-party-uid');
 User.MOCK_USER = new User('mock-user');
 
-const version = "9.18.0-canary.ce79f7fe2";
+const version = "9.18.0-canary.f8a2c5865";
 
 /**
  * @license
@@ -7742,6 +7742,89 @@ function mapCodeFromRpcCode(code) {
     }
 }
 
+/**
+ * @license
+ * Copyright 2023 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+/**
+ * Manages "testing hooks", hooks into the internals of the SDK to verify
+ * internal state and events during integration tests. Do not use this class
+ * except for testing purposes.
+ *
+ * There are two ways to retrieve the global singleton instance of this class:
+ * 1. The `instance` property, which returns null if the global singleton
+ *      instance has not been created. Use this property if the caller should
+ *      "do nothing" if there are no testing hooks registered, such as when
+ *      delivering an event to notify registered callbacks.
+ * 2. The `getOrCreateInstance()` method, which creates the global singleton
+ *      instance if it has not been created. Use this method if the instance is
+ *      needed to, for example, register a callback.
+ *
+ * @internal
+ */
+class TestingHooks {
+    constructor() {
+        this.onExistenceFilterMismatchCallbacks = new Map();
+    }
+    /**
+     * Returns the singleton instance of this class, or null if it has not been
+     * initialized.
+     */
+    static get instance() {
+        return gTestingHooksSingletonInstance;
+    }
+    /**
+     * Returns the singleton instance of this class, creating it if is has never
+     * been created before.
+     */
+    static getOrCreateInstance() {
+        if (gTestingHooksSingletonInstance === null) {
+            gTestingHooksSingletonInstance = new TestingHooks();
+        }
+        return gTestingHooksSingletonInstance;
+    }
+    /**
+     * Registers a callback to be notified when an existence filter mismatch
+     * occurs in the Watch listen stream.
+     *
+     * The relative order in which callbacks are notified is unspecified; do not
+     * rely on any particular ordering. If a given callback is registered multiple
+     * times then it will be notified multiple times, once per registration.
+     *
+     * @param callback the callback to invoke upon existence filter mismatch.
+     *
+     * @return a function that, when called, unregisters the given callback; only
+     * the first invocation of the returned function does anything; all subsequent
+     * invocations do nothing.
+     */
+    onExistenceFilterMismatch(callback) {
+        const key = Symbol();
+        this.onExistenceFilterMismatchCallbacks.set(key, callback);
+        return () => this.onExistenceFilterMismatchCallbacks.delete(key);
+    }
+    /**
+     * Invokes all currently-registered `onExistenceFilterMismatch` callbacks.
+     * @param info Information about the existence filter mismatch.
+     */
+    notifyOnExistenceFilterMismatch(info) {
+        this.onExistenceFilterMismatchCallbacks.forEach(callback => callback(info));
+    }
+}
+/** The global singleton instance of `TestingHooks`. */
+let gTestingHooksSingletonInstance = null;
+
 /**
  * @license
  * Copyright 2017 Google LLC
@@ -8150,6 +8233,7 @@ class WatchChangeAggregator {
      * `pendingTargetResets`.
      */
     handleExistenceFilter(watchChange) {
+        var _a;
         const targetId = watchChange.targetId;
         const expectedCount = watchChange.existenceFilter.count;
         const targetData = this.targetDataForActiveTarget(targetId);
@@ -8177,6 +8261,10 @@ class WatchChangeAggregator {
                     // snapshot with `isFromCache:true`.
                     this.resetTarget(targetId);
                     this.pendingTargetResets = this.pendingTargetResets.add(targetId);
+                    (_a = TestingHooks.instance) === null || _a === void 0 ? void 0 : _a.notifyOnExistenceFilterMismatch({
+                        localCacheCount: currentSize,
+                        existenceFilterCount: watchChange.existenceFilter.count
+                    });
                 }
             }
         }
@@ -30996,5 +31084,5 @@ function tryGetString(data, property) {
  */
 registerFirestore('node');
 
-export { AbstractUserDataWriter, AggregateField, AggregateQuerySnapshot, Bytes, CACHE_SIZE_UNLIMITED, CollectionReference, DocumentReference, DocumentSnapshot, FieldPath, FieldValue, Firestore, FirestoreError, GeoPoint, LoadBundleTask, Query, QueryCompositeFilterConstraint, QueryConstraint, QueryDocumentSnapshot, QueryEndAtConstraint, QueryFieldFilterConstraint, QueryLimitConstraint, QueryOrderByConstraint, QuerySnapshot, QueryStartAtConstraint, SnapshotMetadata, Timestamp, Transaction, WriteBatch, DatabaseId as _DatabaseId, DocumentKey as _DocumentKey, EmptyAppCheckTokenProvider as _EmptyAppCheckTokenProvider, EmptyAuthCredentialsProvider as _EmptyAuthCredentialsProvider, FieldPath$1 as _FieldPath, cast as _cast, debugAssert as _debugAssert, isBase64Available as _isBase64Available, logWarn as _logWarn, validateIsNotUsedTogether as _validateIsNotUsedTogether, addDoc, aggregateFieldEqual, aggregateQuerySnapshotEqual, and, arrayRemove, arrayUnion, average, clearIndexedDbPersistence, collection, collectionGroup, connectFirestoreEmulator, count, deleteDoc, deleteField, disableNetwork, doc, documentId, enableIndexedDbPersistence, enableMultiTabIndexedDbPersistence, enableNetwork, endAt, endBefore, ensureFirestoreConfigured, executeWrite, getAggregateFromServer, getCountFromServer, getDoc, getDocFromCache, getDocFromServer, getDocs, getDocsFromCache, getDocsFromServer, getFirestore, increment, initializeFirestore, limit, limitToLast, loadBundle, memoryLocalCache, namedQuery, onSnapshot, onSnapshotsInSync, or, orderBy, persistentLocalCache, persistentMultipleTabManager, persistentSingleTabManager, query, queryEqual, refEqual, runTransaction, serverTimestamp, setDoc, setIndexConfiguration, setLogLevel, snapshotEqual, startAfter, startAt, sum, terminate, updateDoc, waitForPendingWrites, where, writeBatch };
+export { AbstractUserDataWriter, AggregateField, AggregateQuerySnapshot, Bytes, CACHE_SIZE_UNLIMITED, CollectionReference, DocumentReference, DocumentSnapshot, FieldPath, FieldValue, Firestore, FirestoreError, GeoPoint, LoadBundleTask, Query, QueryCompositeFilterConstraint, QueryConstraint, QueryDocumentSnapshot, QueryEndAtConstraint, QueryFieldFilterConstraint, QueryLimitConstraint, QueryOrderByConstraint, QuerySnapshot, QueryStartAtConstraint, SnapshotMetadata, Timestamp, Transaction, WriteBatch, DatabaseId as _DatabaseId, DocumentKey as _DocumentKey, EmptyAppCheckTokenProvider as _EmptyAppCheckTokenProvider, EmptyAuthCredentialsProvider as _EmptyAuthCredentialsProvider, FieldPath$1 as _FieldPath, TestingHooks as _TestingHooks, cast as _cast, debugAssert as _debugAssert, isBase64Available as _isBase64Available, logWarn as _logWarn, validateIsNotUsedTogether as _validateIsNotUsedTogether, addDoc, aggregateFieldEqual, aggregateQuerySnapshotEqual, and, arrayRemove, arrayUnion, average, clearIndexedDbPersistence, collection, collectionGroup, connectFirestoreEmulator, count, deleteDoc, deleteField, disableNetwork, doc, documentId, enableIndexedDbPersistence, enableMultiTabIndexedDbPersistence, enableNetwork, endAt, endBefore, ensureFirestoreConfigured, executeWrite, getAggregateFromServer, getCountFromServer, getDoc, getDocFromCache, getDocFromServer, getDocs, getDocsFromCache, getDocsFromServer, getFirestore, increment, initializeFirestore, limit, limitToLast, loadBundle, memoryLocalCache, namedQuery, onSnapshot, onSnapshotsInSync, or, orderBy, persistentLocalCache, persistentMultipleTabManager, persistentSingleTabManager, query, queryEqual, refEqual, runTransaction, serverTimestamp, setDoc, setIndexConfiguration, setLogLevel, snapshotEqual, startAfter, startAt, sum, terminate, updateDoc, waitForPendingWrites, where, writeBatch };
 //# sourceMappingURL=index.node.mjs.map