@firebase/firestore 3.4.13 → 3.4.14-20220804201204

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.4.13";
+const version$1 = "3.4.14-20220804201204";
 
 /**
  * @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.9.1";
+const version = "9.9.2-20220804201204";
 
 /**
  * @license
@@ -1498,6 +1498,23 @@ function fieldIndexGetKeyOrder(fieldIndex) {
         ? 0 /* ASCENDING */
         : directionalSegments[directionalSegments.length - 1].kind;
 }
+/**
+ * Compares indexes by collection group and segments. Ignores update time and
+ * index ID.
+ */
+function fieldIndexSemanticComparator(left, right) {
+    let cmp = primitiveComparator(left.collectionGroup, right.collectionGroup);
+    if (cmp !== 0) {
+        return cmp;
+    }
+    for (let i = 0; i < Math.min(left.fields.length, right.fields.length); ++i) {
+        cmp = indexSegmentComparator(left.fields[i], right.fields[i]);
+        if (cmp !== 0) {
+            return cmp;
+        }
+    }
+    return primitiveComparator(left.fields.length, right.fields.length);
+}
 /** Returns a debug representation of the field index */
 function fieldIndexToString(fieldIndex) {
     return `id=${fieldIndex.indexId}|cg=${fieldIndex.collectionGroup}|f=${fieldIndex.fields.map(f => `${f.fieldPath}:${f.kind}`).join(',')}`;
@@ -1513,6 +1530,13 @@ class IndexSegment {
         this.kind = kind;
     }
 }
+function indexSegmentComparator(left, right) {
+    const cmp = FieldPath$1.comparator(left.fieldPath, right.fieldPath);
+    if (cmp !== 0) {
+        return cmp;
+    }
+    return primitiveComparator(left.kind, right.kind);
+}
 /**
  * Stores the "high water mark" that indicates how updated the Index is for the
  * current user.
@@ -1599,31 +1623,6 @@ function indexOffsetComparator(left, right) {
     }
     return primitiveComparator(left.largestBatchId, right.largestBatchId);
 }
-/**
- * Schema Version for the Web client:
- * 1.  Initial version including Mutation Queue, Query Cache, and Remote
- *     Document Cache
- * 2.  Used to ensure a targetGlobal object exists and add targetCount to it. No
- *     longer required because migration 3 unconditionally clears it.
- * 3.  Dropped and re-created Query Cache to deal with cache corruption related
- *     to limbo resolution. Addresses
- *     https://github.com/firebase/firebase-ios-sdk/issues/1548
- * 4.  Multi-Tab Support.
- * 5.  Removal of held write acks.
- * 6.  Create document global for tracking document cache size.
- * 7.  Ensure every cached document has a sentinel row with a sequence number.
- * 8.  Add collection-parent index for Collection Group queries.
- * 9.  Change RemoteDocumentChanges store to be keyed by readTime rather than
- *     an auto-incrementing ID. This is required for Index-Free queries.
- * 10. Rewrite the canonical IDs to the explicit Protobuf-based format.
- * 11. Add bundles and named_queries for bundle support.
- * 12. Add document overlays.
- * 13. Rewrite the keys of the remote document cache to allow for efficient
- *     document lookup via `getAll()`.
- * 14. Add overlays.
- * 15. Add indexing support.
- */
-const SCHEMA_VERSION = 14;
 
 /**
  * @license
@@ -2583,6 +2582,8 @@ function checkForAndReportiOSError(error) {
 }
 
 const LOG_TAG$h = 'IndexBackiller';
+/** How long we wait to try running index backfill after SDK initialization. */
+const INITIAL_BACKFILL_DELAY_MS = 15;
 /** Minimum amount of time between backfill checks, after the first one. */
 const REGULAR_BACKFILL_DELAY_MS = 1;
 /** The maximum number of documents to process each time backfill() is called. */
@@ -2595,6 +2596,7 @@ class IndexBackfillerScheduler {
         this.task = null;
     }
     start() {
+        this.schedule(INITIAL_BACKFILL_DELAY_MS);
     }
     stop() {
         if (this.task) {
@@ -12710,6 +12712,48 @@ function dbKeyComparator(l, r) {
     return primitiveComparator(left[left.length - 1], right[right.length - 1]);
 }
 
+/**
+ * @license
+ * Copyright 2017 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.
+ */
+/**
+ * Schema Version for the Web client:
+ * 1.  Initial version including Mutation Queue, Query Cache, and Remote
+ *     Document Cache
+ * 2.  Used to ensure a targetGlobal object exists and add targetCount to it. No
+ *     longer required because migration 3 unconditionally clears it.
+ * 3.  Dropped and re-created Query Cache to deal with cache corruption related
+ *     to limbo resolution. Addresses
+ *     https://github.com/firebase/firebase-ios-sdk/issues/1548
+ * 4.  Multi-Tab Support.
+ * 5.  Removal of held write acks.
+ * 6.  Create document global for tracking document cache size.
+ * 7.  Ensure every cached document has a sentinel row with a sequence number.
+ * 8.  Add collection-parent index for Collection Group queries.
+ * 9.  Change RemoteDocumentChanges store to be keyed by readTime rather than
+ *     an auto-incrementing ID. This is required for Index-Free queries.
+ * 10. Rewrite the canonical IDs to the explicit Protobuf-based format.
+ * 11. Add bundles and named_queries for bundle support.
+ * 12. Add document overlays.
+ * 13. Rewrite the keys of the remote document cache to allow for efficient
+ *     document lookup via `getAll()`.
+ * 14. Add overlays.
+ * 15. Add indexing support.
+ */
+const SCHEMA_VERSION = 15;
+
 /**
  * @license
  * Copyright 2022 Google LLC
@@ -15248,6 +15292,73 @@ async function indexedDbClearPersistence(persistenceKey) {
     await SimpleDb.delete(dbName);
 }
 
+/**
+ * @license
+ * Copyright 2017 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.
+ */
+/**
+ * Compares two array for equality using comparator. The method computes the
+ * intersection and invokes `onAdd` for every element that is in `after` but not
+ * `before`. `onRemove` is invoked for every element in `before` but missing
+ * from `after`.
+ *
+ * The method creates a copy of both `before` and `after` and runs in O(n log
+ * n), where n is the size of the two lists.
+ *
+ * @param before - The elements that exist in the original array.
+ * @param after - The elements to diff against the original array.
+ * @param comparator - The comparator for the elements in before and after.
+ * @param onAdd - A function to invoke for every element that is part of `
+ * after` but not `before`.
+ * @param onRemove - A function to invoke for every element that is part of
+ * `before` but not `after`.
+ */
+function diffArrays(before, after, comparator, onAdd, onRemove) {
+    before = [...before];
+    after = [...after];
+    before.sort(comparator);
+    after.sort(comparator);
+    const bLen = before.length;
+    const aLen = after.length;
+    let a = 0;
+    let b = 0;
+    while (a < aLen && b < bLen) {
+        const cmp = comparator(before[b], after[a]);
+        if (cmp < 0) {
+            // The element was removed if the next element in our ordered
+            // walkthrough is only in `before`.
+            onRemove(before[b++]);
+        }
+        else if (cmp > 0) {
+            // The element was added if the next element in our ordered walkthrough
+            // is only in `after`.
+            onAdd(after[a++]);
+        }
+        else {
+            a++;
+            b++;
+        }
+    }
+    while (a < aLen) {
+        onAdd(after[a++]);
+    }
+    while (b < bLen) {
+        onRemove(before[b++]);
+    }
+}
+
 /**
  * @license
  * Copyright 2020 Google LLC
@@ -16097,6 +16208,19 @@ async function localStoreSaveNamedQuery(localStore, query, documents = documentK
             .next(() => localStoreImpl.targetCache.addMatchingKeys(transaction, documents, allocated.targetId))
             .next(() => localStoreImpl.bundleCache.saveNamedQuery(transaction, query));
     });
+}
+async function localStoreConfigureFieldIndexes(localStore, newFieldIndexes) {
+    const localStoreImpl = debugCast(localStore);
+    const indexManager = localStoreImpl.indexManager;
+    const promises = [];
+    return localStoreImpl.persistence.runTransaction('Configure indexes', 'readwrite', transaction => indexManager
+        .getFieldIndexes(transaction)
+        .next(oldFieldIndexes => diffArrays(oldFieldIndexes, newFieldIndexes, fieldIndexSemanticComparator, fieldIndex => {
+        promises.push(indexManager.addFieldIndex(transaction, fieldIndex));
+    }, fieldIndex => {
+        promises.push(indexManager.deleteFieldIndex(transaction, fieldIndex));
+    }))
+        .next(() => PersistencePromise.waitFor(promises)));
 }
 
 /**
@@ -16176,9 +16300,56 @@ class QueryEngine {
      * persisted index values. Returns `null` if an index is not available.
      */
     performQueryUsingIndex(transaction, query) {
-        {
+        if (queryMatchesAllDocuments(query)) {
+            // Queries that match all documents don't benefit from using
+            // key-based lookups. It is more efficient to scan all documents in a
+            // collection, rather than to perform individual lookups.
             return PersistencePromise.resolve(null);
         }
+        let target = queryToTarget(query);
+        return this.indexManager
+            .getIndexType(transaction, target)
+            .next(indexType => {
+            if (indexType === 0 /* NONE */) {
+                // The target cannot be served from any index.
+                return null;
+            }
+            if (query.limit !== null && indexType === 1 /* PARTIAL */) {
+                // We cannot apply a limit for targets that are served using a partial
+                // index. If a partial index will be used to serve the target, the
+                // query may return a superset of documents that match the target
+                // (e.g. if the index doesn't include all the target's filters), or
+                // may return the correct set of documents in the wrong order (e.g. if
+                // the index doesn't include a segment for one of the orderBys).
+                // Therefore, a limit should not be applied in such cases.
+                query = queryWithLimit(query, null, "F" /* First */);
+                target = queryToTarget(query);
+            }
+            return this.indexManager
+                .getDocumentsMatchingTarget(transaction, target)
+                .next(keys => {
+                const sortedKeys = documentKeySet(...keys);
+                return this.localDocumentsView
+                    .getDocuments(transaction, sortedKeys)
+                    .next(indexedDocuments => {
+                    return this.indexManager
+                        .getMinOffset(transaction, target)
+                        .next(offset => {
+                        const previousResults = this.applyQuery(query, indexedDocuments);
+                        if (this.needsRefill(query, previousResults, sortedKeys, offset.readTime)) {
+                            // A limit query whose boundaries change due to local
+                            // edits can be re-run against the cache by excluding the
+                            // limit. This ensures that all documents that match the
+                            // query's filters are included in the result set. The SDK
+                            // can then apply the limit once all local edits are
+                            // incorporated.
+                            return this.performQueryUsingIndex(transaction, queryWithLimit(query, null, "F" /* First */));
+                        }
+                        return this.appendRemainingResults(transaction, previousResults, query, offset);
+                    });
+                });
+            });
+        });
     }
     /**
      * Performs a query based on the target's persisted query mapping. Returns
@@ -24273,7 +24444,7 @@ class AsyncObserver {
             this.scheduleEvent(this.observer.error, error);
         }
         else {
-            console.error('Uncaught Error in snapshot listener:', error);
+            logError('Uncaught Error in snapshot listener:', error);
         }
     }
     mute() {
@@ -26204,7 +26375,7 @@ function setPersistenceProviders(client, onlineComponentProvider, offlineCompone
             if (!canFallbackFromIndexedDbError(error)) {
                 throw error;
             }
-            console.warn('Error enabling offline persistence. Falling back to ' +
+            logWarn('Error enabling offline persistence. Falling back to ' +
                 'persistence disabled: ' +
                 error);
             persistenceResult.reject(error);
@@ -29118,14 +29289,23 @@ function writeBatch(firestore) {
  * limitations under the License.
  */
 function setIndexConfiguration(firestore, jsonOrConfiguration) {
+    var _a;
     firestore = cast(firestore, Firestore);
-    ensureFirestoreConfigured(firestore);
+    const client = ensureFirestoreConfigured(firestore);
+    // PORTING NOTE: We don't return an error if the user has not enabled
+    // persistence since `enableIndexeddbPersistence()` can fail on the Web.
+    if (!((_a = client.offlineComponents) === null || _a === void 0 ? void 0 : _a.indexBackfillerScheduler)) {
+        logWarn('Cannot enable indexes when persistence is disabled');
+        return Promise.resolve();
+    }
+    const parsedIndexes = parseIndexes(jsonOrConfiguration);
+    return getLocalStore(client).then(localStore => localStoreConfigureFieldIndexes(localStore, parsedIndexes));
+}
+function parseIndexes(jsonOrConfiguration) {
     const indexConfiguration = typeof jsonOrConfiguration === 'string'
         ? tryParseJson(jsonOrConfiguration)
         : jsonOrConfiguration;
     const parsedIndexes = [];
-    // PORTING NOTE: We don't return an error if the user has not enabled
-    // persistence since `enableIndexeddbPersistence()` can fail on the Web.
     if (Array.isArray(indexConfiguration.indexes)) {
         for (const index of indexConfiguration.indexes) {
             const collectionGroup = tryGetString(index, 'collectionGroup');
@@ -29148,8 +29328,7 @@ function setIndexConfiguration(firestore, jsonOrConfiguration) {
             parsedIndexes.push(new FieldIndex(FieldIndex.UNKNOWN_ID, collectionGroup, segments, IndexState.empty()));
         }
     }
-    // TODO(indexing): Configure indexes
-    return Promise.resolve();
+    return parsedIndexes;
 }
 function tryParseJson(json) {
     var _a;
@@ -29157,7 +29336,7 @@ function tryParseJson(json) {
         return JSON.parse(json);
     }
     catch (e) {
-        throw new FirestoreError(Code.INVALID_ARGUMENT, 'Failed to parse JSON:' + ((_a = e) === null || _a === void 0 ? void 0 : _a.message));
+        throw new FirestoreError(Code.INVALID_ARGUMENT, 'Failed to parse JSON: ' + ((_a = e) === null || _a === void 0 ? void 0 : _a.message));
     }
 }
 function tryGetString(data, property) {
@@ -29185,5 +29364,5 @@ function tryGetString(data, property) {
  */
 registerFirestore('node');
 
-export { AbstractUserDataWriter, Bytes, CACHE_SIZE_UNLIMITED, CollectionReference, DocumentReference, DocumentSnapshot, FieldPath, FieldValue, Firestore, FirestoreError, GeoPoint, LoadBundleTask, Query, QueryConstraint, QueryDocumentSnapshot, QuerySnapshot, 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, setIndexConfiguration as _setIndexConfiguration, validateIsNotUsedTogether as _validateIsNotUsedTogether, addDoc, arrayRemove, arrayUnion, clearIndexedDbPersistence, collection, collectionGroup, connectFirestoreEmulator, deleteDoc, deleteField, disableNetwork, doc, documentId, enableIndexedDbPersistence, enableMultiTabIndexedDbPersistence, enableNetwork, endAt, endBefore, ensureFirestoreConfigured, executeWrite, getDoc, getDocFromCache, getDocFromServer, getDocs, getDocsFromCache, getDocsFromServer, getFirestore, increment, initializeFirestore, limit, limitToLast, loadBundle, namedQuery, onSnapshot, onSnapshotsInSync, orderBy, query, queryEqual, refEqual, runTransaction, serverTimestamp, setDoc, setLogLevel, snapshotEqual, startAfter, startAt, terminate, updateDoc, waitForPendingWrites, where, writeBatch };
+export { AbstractUserDataWriter, Bytes, CACHE_SIZE_UNLIMITED, CollectionReference, DocumentReference, DocumentSnapshot, FieldPath, FieldValue, Firestore, FirestoreError, GeoPoint, LoadBundleTask, Query, QueryConstraint, QueryDocumentSnapshot, QuerySnapshot, 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, arrayRemove, arrayUnion, clearIndexedDbPersistence, collection, collectionGroup, connectFirestoreEmulator, deleteDoc, deleteField, disableNetwork, doc, documentId, enableIndexedDbPersistence, enableMultiTabIndexedDbPersistence, enableNetwork, endAt, endBefore, ensureFirestoreConfigured, executeWrite, getDoc, getDocFromCache, getDocFromServer, getDocs, getDocsFromCache, getDocsFromServer, getFirestore, increment, initializeFirestore, limit, limitToLast, loadBundle, namedQuery, onSnapshot, onSnapshotsInSync, orderBy, query, queryEqual, refEqual, runTransaction, serverTimestamp, setDoc, setIndexConfiguration, setLogLevel, snapshotEqual, startAfter, startAt, terminate, updateDoc, waitForPendingWrites, where, writeBatch };
 //# sourceMappingURL=index.node.mjs.map