Skip to content

Latest commit

 

History

History
1632 lines (1006 loc) · 92.2 KB

CHANGELOG.md

File metadata and controls

1632 lines (1006 loc) · 92.2 KB
Raw

@firebase/firestore

4.7.5

Patch Changes

4.7.4

Patch Changes

4.7.3

Patch Changes

  • ff0475c41 #8259 - Re-enable useFetchStreams with the latest WebChannel implementation. This reduces the memory usage of WebChannel.

  • 47b091324 #8430 - Refactor Firestore client instantiation. This prepares for future features that require client to restart.

4.7.2

Patch Changes

4.7.1

Patch Changes

  • 62348e116 #8432 (fixes #8431) - Update undici dependency to 6.19.7 due to a memory leak in older versions.

4.7.0

Minor Changes

  • e6b852562 #8215 - Add support for reading and writing Firestore vectors.

4.6.5

Patch Changes

  • 025f2a103 #8280 (fixes #8279) - Fixed typos in documentation and some internal variables and parameters.

4.6.4

Patch Changes

4.6.3

Patch Changes

  • 2ce95696f #8247 - Fix multi-tab persistence raising empty snapshot issue

4.6.2

Patch Changes

4.6.1

Patch Changes

  • 224419457 #8145 - Prevent spurious "Backend didn't respond within 10 seconds" errors when network is indeed responding, just slowly.

  • bd12e83cd #8150 - Updated protobufjs transitive dependency in Firestore.

  • e1a7764cf #8197 - Go back using xmlhttprequest for bidi-streams, as fetch streams seem to be having connection issue.

  • 84f9ff008 #8178 - Reduce code bundle size by 6.5 kB in applications that only use memory persistence (the default persistence mode). This bundle size regression was accidentally introduced in v10.7.2.

4.6.0

Minor Changes

  • 666dddae0 #7999 - Enable queries with range & inequality filters on multiple fields.

Patch Changes

  • fe09d8338 #8138 (fixes #8132) - Update undici version to 5.28.4 due to CVE-2024-30260.

  • c6ecac8ac #8090 (fixes #8031) - Fixed the CSI issue where indexing on timestamp fields leads to incorrect query results.

  • a6fa54417 #8142 - Fix internal assertion due to Buffer value not evaluating to instanceof Uint8Array, encountered when testing with jsdom.

  • ad8d5470d #8134 - Updated dependencies. See GitHub PR #8098.

4.5.1

Patch Changes

4.5.0

Minor Changes

  • ce88e71e7 #7982 - Enable snapshot listener option to retrieve data from local cache only.

4.4.3

Patch Changes

4.4.2

Patch Changes

4.4.1

Patch Changes

  • 7481098d4 #7847 (fixes #7747) - Fixed leak of grpc-js resources on terminate.

  • f4788453e #7402 - Support special characters in query paths sent to getCountFromServer(...), getCount(...) (lite API), and getDocs(...) (lite API).

  • d7ace80d4 #7929 - Tweak the automatic index creation parameters to use more optimal values for the platform/browser detected at runtime.

  • a476c4692 #7861 (fixes #7706) - Update the isEqual function for arrayUnion, arrayRemove and increment.

4.4.0

Minor Changes

  • bebecdaad #7705 - Replaced node-fetch v2.6.7 dependency with the latest version of undici (v5.26.5) in Node.js SDK builds for auth, firestore, functions and storage.

Patch Changes

  • 0d29adc97 #7740 - Fixed an issue in the local cache synchronization logic where all locally-cached documents that matched a resumed query would be unnecessarily re-downloaded; with the fix it now only downloads the documents that are known to be out-of-sync.

  • 00235ba68 #7771 (fixes #6118) - Fix high memory usage of Firestore in browsers.

  • Updated dependencies [00235ba68]:

4.3.2

Patch Changes

  • f27baf423 #7729 - Rolling back the use of useFetchStreams, which has lead to hanging and incomplete queries.

4.3.1

Patch Changes

4.3.0

Minor Changes

  • 02e2518ca #7502 - Support sum and average aggregations.

  • cca47353c #7441 - Added a default template type parameter to withConverter() functions to improve backwards compatibility with the v9 SDK

4.2.0

Minor Changes

  • fbd8e0e2e #7599 - Add enablePersistentCacheIndexAutoCreation() function to enable automatic creation of local cache query indexes, which can improve performance of local query execution.

Patch Changes

  • 60e4a07d2 #7593 - Fix an issue where Firestore was incorrectly using XHR instead of fetch for streaming response.

  • 2d0a9f5fd #7592 - Updated minor dependencies grpc (firestore) and firebase-admin (rules-unit-testing).

  • Updated dependencies [60e4a07d2]:

4.1.3

Patch Changes

  • 12221ddb4 #7542 - Implemented internal logic to auto-create client-side indexes

  • 25cda8af6 #7587 - Implemented internal logic to delete all client-side indexes

4.1.2

Patch Changes

4.1.1

Patch Changes

  • 43e402fb4 #7520 - Update @grpc/proto-loader from v0.6.13 to v0.7.8

  • b395277f3 #7507 - Refactored aggregate query order-by normalization to support future aggregate operations.

4.1.0

Minor Changes

Patch Changes

  • c5518c80f #7440 - Fixed issue where count and lite API queries did not work with named databases.

4.0.0

Major Changes

  • f2fb56fc0 #7310 - Fixed updateDoc() typing issue by adding a 2nd type parameter to FirestoreDataConverter

Minor Changes

  • 57f2a863f #7318 (fixes #6105) - Changing UpdateData to expand support for types with index signatures.

Patch Changes

  • aaf3fa396 #7385 - Fix an issue where localCache is not copied as part of Settings.

  • d86c89f9c #7382 - Fix source maps that incorrectly referenced yet another minified and mangled bundle, rendering them useless. The fixed bundles' source maps are: index.esm2017.js, index.cjs.js, index.node.mjs, and index.browser.esm2017.js (lite sdk only).

3.13.0

Minor Changes

3.12.2

Patch Changes

3.12.1

Patch Changes

3.12.0

Minor Changes

  • e45fea9b8 #7236 - Enabled long-polling networking mode auto detection by default. It can be explicitly disabled by setting FirestoreSettings.experimentalForceLongPolling to false.

  • 8051e4a99 #7176 - Added the ability to configure the long-polling hanging get request timeout using the new experimentalLongPollingOptions.timeoutSeconds setting

3.11.0

Minor Changes

  • 253b998fc #6943 - Introduces a new LRU garbage document collector for memory cache.

  • 98abcd5ed #7229 - Implemented an optimization in the local cache synchronization logic that reduces the number of billed document reads when documents were deleted on the server while the client was not actively listening to the query (e.g. while the client was offline).

Patch Changes

3.10.1

Patch Changes

  • b66908df6 #7212 (fixes #7198) - Fix a bug that sometimes prevented aggregations from being run when multi-tab persistence was enabled.

3.10.0

Minor Changes

  • 60a730e37 #7015 - Introduces a new way to config Firestore SDK Cache.

Patch Changes

  • 7d23aa4bd #7130 - Check that DOMException exists before referencing it, to fix react-native, which was broken by firebase#7019 in v9.17.2.

  • ce79f7fe2 #7100 - Remove the deprecated gapi.auth from FirstPartyToken.

3.9.0

Minor Changes

  • 5ba524313 #7053 - Add support for disjunctions in queries (OR queries).

Patch Changes

  • e2bf2eca2 #7076 - Improved debug logging of networking abstractions

  • 5099f0f60 #6899 (fixes #6509) - Check navigator.userAgent, in addition to navigator.appVersion, when determining whether to work around an IndexedDb bug in Safari.

3.8.4

Patch Changes

3.8.3

Patch Changes

3.8.2

Patch Changes

3.8.1

Patch Changes

3.8.0

Minor Changes

  • ab3f16cba #6796 - Upgrade TypeScript to 4.7.4 (was 4.2.2)

  • fde5adf63 #6694 - Functions in the Firestore package that return QueryConstraints (for example: where(...), limit(...), and orderBy(...)) now return a more specific type, which extends QueryConstraint. Refactoring and code that supports future features is also included in this release.

Patch Changes

3.7.3

Patch Changes

  • bf7cc8f69 #6712 (fixes #6613) - Fix "missing index" error message to include the link to create the composite index.

  • e2a90bf67 #6729 - Fix transaction.set() failure without retry on "already-exists" error.

3.7.2

Patch Changes

3.7.1

Patch Changes

3.7.0

Minor Changes

  • 397317b53 #6643 - Set withCredentials=true when making requests via non-streaming RPCs, like is done for streaming RPCs.

Patch Changes

  • 0a112bd2a #6624 (fixes #5873) - Fix Firestore failing to raise initial snapshot from empty local cache result

3.6.0

Minor Changes

  • ee871fc0b #6608 - Added getCountFromServer() (getCount() in the Lite SDK), which fetches the number of documents in the result set without actually downloading the documents.

Patch Changes

  • fdd4ab464 #6526 - Add functionality to auto-initialize project config and emulator settings from global defaults provided by framework tooling.

3.5.0

Minor Changes

  • 7c0c640a4 #6107 - Enable encodeInitMessageHeaders. This transitions the Firestore client from encoding HTTP Headers via the Query Param to the request's POST payload.

    Requires Cloud Firestore Emulator v1.14.4 or newer.

Patch Changes

3.4.15

Patch Changes

  • b993aeec4 #6550 (fixes #5871) - Fix FAILED_PRECONDITION when writing to a deleted document in a transaction (#5871)

3.4.14

Patch Changes

  • f5426a512 #6403 - Add internal implementation of setIndexConfiguration
  • 10765511f #6496 - Expose client side indexing feature with setIndexConfiguration.

3.4.13

Patch Changes

  • 1703bb31a #6442 (fixes #6438) - Update @grpc/proto-loader and firebase-admin dependencies to address protobufjs security issue.

3.4.12

Patch Changes

3.4.11

Patch Changes

3.4.10

Patch Changes

3.4.9

Patch Changes

3.4.8

Patch Changes

3.4.7

Patch Changes

  • 69aa7b02d #5988 - The format of some of the IndexedDB data changed. This increases the performance of document lookups after an initial migration. If you do not want to migrate data, you can call clearIndexedDbPersistence() before invoking enableIndexedDbPersistence().

  • Updated dependencies [3198d58dc]:

3.4.6

Patch Changes

3.4.5

Patch Changes

  • bb8f37c3e #5993 - Fixed a bug that caused Firestore streams to get restarted with the same App Check token.
  • f5ac47fb1 #5982 - On browsers that support IndexedDB V3, we now invoke transaction.commit() to speed up data processing.
  • c1b9cf120 #5985 - Some database operations now use IndexedDB.getAll() on browsers where support is available.
  • e9619685b #5980 - Queries are now send to the backend before the SDK starts local processing, which reduces overall Query latency.

3.4.4

Patch Changes

  • e28b0e413 #5902 (fixes #5842) - Fixed an AppCheck issue that caused Firestore listeners to stop working and receive a "Permission Denied" error. This issue only occurred for AppCheck users that set their expiration time to under an hour.
  • d612d6f6e #5928 - Upgrade node-fetch dependency due to a security issue.

3.4.3

Patch Changes

  • ff2f7d4c8 #5883 - The Node SDK now uses JSON to load its internal Protobuf definition, which allows the Node SDK to work with bundlers such as Rollup and Webpack.

3.4.2

Patch Changes

3.4.1

Patch Changes

  • fd8cd3ec4 #5809 - Hardcode grpc-js version as a temporary fix for createRequire issues in Node CJS.

3.4.0

Minor Changes

3.3.1

Patch Changes

3.3.0

Minor Changes

  • 532b3cd93 #5675 (fixes #5661) - Expanded Firestore.WithFieldValue<T> to include T. This allows developers to delegate WithFieldValue<T> inside wrappers of type T to avoid exposing Firebase types beyond Firebase-specific logic.

Patch Changes

3.2.1

Patch Changes

3.2.0

Minor Changes

  • 4d3640481 #5532 (fixes #5499) - Fix exports field to also point to Node ESM builds. This change requires Node.js version 10+.

Patch Changes

  • f48527617 #5668 - Add missing compat Firestore conversion for runTransaction
  • c75bbe957 #5643 - Change the networking API to use XHR instead of fetch() for ReactNative.

3.1.1

Patch Changes

3.1.0

Minor Changes

  • f78ceca1c #5394 - Fixed a bug where UpdateData did not recognize union types or optional, dot-separated string fields.

Patch Changes

3.0.2

Patch Changes

  • 8180a2b77 #5396 - Improved the error handling when opening IndexedDb fails in a Firefox private browsing session.
  • b8462f248 #5434 - Fixes a deadlock during asynchronous initialization of both Firestore and Auth.
  • bf5772f64 #5440 - Fix the implementation of collection() with multiple path segments.
  • dca28a10d #5461 - Temporary fix for a bug causing initializeFirestore() to not work with certain bundling pipelines.

3.0.1

Patch Changes

  • 6163bb282 #5399 - Addressed incorrect use of the node-fetch polyfill

3.0.0

Major Changes

  • 5bc6afb75 #5268 (fixes #4277) - This change contains multiple quality-of-life improvements when using the FirestoreDataConverter in @firebase/firestore/lite and @firebase/firestore:
    • Support for passing in FieldValue property values when using a converter (via WithFieldValue<T> and PartialWithFieldValue<T>).
    • Support for omitting properties in nested fields when performing a set operation with {merge: true} with a converter (via PartialWithFieldValue<T>).
    • Support for typed update operations when using a converter (via the newly typed UpdateData). Improperly typed fields in update operations on typed document references will no longer compile.

2.4.0

Minor Changes

  • 3c6a11c8d #5282 - Implement mockUserToken for Storage and fix JWT format bugs.

Patch Changes

2.3.10

Patch Changes

2.3.9

Patch Changes

  • 2cd9d7c39 #5147 (fixes #5047) - Fixed an issue that prevented Timestamps from being used via update() when connected to the Emulator

2.3.8

Patch Changes

2.3.7

Patch Changes

2.3.6

Patch Changes

  • 1d54447ca #5010 - Fixes a regression that prevented Firestore from detecting Auth during its initial initialization, which could cause some writes to not be send. 4971 didn't actually fix it.

2.3.5

Patch Changes

  • 4c4b6aed9 #4971 - Fixes a regression that prevented Firestore from detecting Auth during its initial initialization, which could cause some writes to not be send.

  • Updated dependencies [4c4b6aed9]:

2.3.4

Patch Changes

2.3.3

Patch Changes

2.3.2

Patch Changes

  • 169174520 #4929 - Added a warning message when the host settings are overridden without {merge: true}.

2.3.1

Patch Changes

2.3.0

Minor Changes

Patch Changes

2.2.5

Patch Changes

  • c65883680 #4810 (fixes #4795) - Don't send empty X-Firebase-GMPID header when AppId is not set in FirebaseOptions

2.2.4

Patch Changes

2.2.3

Patch Changes

2.2.2

Patch Changes

2.2.1

Patch Changes

  • 5c1a83ed7 #4595 - Component factory now takes an options object. And added Provider.initialize() that can be used to pass an options object to the component factory.

  • Updated dependencies [5c1a83ed7]:

2.2.0

Minor Changes

  • b6080a857 #4577 - Added support to remove a FirestoreDataConverter on a Firestore reference by calling withConverter(null)

Patch Changes

2.1.7

Patch Changes

2.1.6

Patch Changes

  • a718518e9 #4395 - Fixes a bug where local cache inconsistencies were unnecessarily being resolved.
  • 3d0cd6f33 #4382 - Fix the path to the react native build for the Firestore memory build

2.1.5

Patch Changes

  • 9533688b1 #4347 (fixes #1392) - handle ignoreUndefinedProperties in set({ merge: true }). Previously this would behave as if the undefined value were FieldValue.delete(), which wasn't intended.

2.1.4

Patch Changes

  • 749c7f3d9 #4298 (fixes #4258) - Firestore classes like DocumentReference and Query can now be serialized to JSON (#4258)

2.1.3

Patch Changes

  • 6ac66baa0 #4284 (fixes #4278) - Fixes FirestoreDataConverter.fromFirestore() being called with an incorrect "snapshot" object.

2.1.2

Patch Changes

  • 6069b1d6c #4262 (fixes #4253) - Updated an outdated error message to include '!=' and 'not-in' as an inequalities.
  • ba59a0f90 #4233 (fixes #4226) - Fixes an issue in the Transaction API that caused the SDK to return invalid DocumentReferences through DocumentSnapshot.data() calls.

2.1.1

Patch Changes

  • 44b5251d0 #4189 (fixes #4175) - Fixes an issue that prevented the SDK from automatically retrieving custom User claims.

2.1.0

Minor Changes

  • b662f8c0a #4168 - Release Firestore Bundles (pre-packaged Firestore data). For NPM users, this can be enabled via an additional import: 'firebase/firestore/bundle'. For CDN usage, it is enabled by default.
  • 1b5407372 #4153 - A write to a document that contains FieldValue transforms is no longer split up into two separate operations. This reduces the number of writes the backend performs and allows each WriteBatch to hold 500 writes regardless of how many FieldValue transformations are attached.

Patch Changes

2.0.5

Patch Changes

  • 1849b0d0f #4148 - Fixed a bug that prevented usage of FieldPaths with multiple special characters.
  • 8993f16b8 #4136 (fixes #4125) - Fixes an issue that returned invalid DocumentReferences in QuerySnapshots.

2.0.4

Patch Changes

2.0.3

Patch Changes

  • e0bf3f70b #4080 (fixes #4071) - Fixes a regression introduced in v8.0.2 that returned invalid values for DocumentChange.newIndex.

2.0.2

Patch Changes

  • d2adf4e3e #4051 - Fixed an issue that caused DocumentReferences in DocumentSnapshots to be returned with the custom converter of the original DocumentReference.
  • 6dffdf2eb #3594 - Merge bundle loading implementation without exposing public API

2.0.1

Patch Changes

2.0.0

Major Changes

  • 8939aeca0 #3944 - Removed the undocumented Firestore.logLevel property.
  • 344bd8856 #3943 - Removed deprecated experimentalTabSynchronization settings. To enable multi-tab synchronization, use synchronizeTabs instead.
  • 4b540f91d #3939 - This releases removes all input validation. Please use our TypeScript types to validate API usage.
  • ffef32e38 #3897 (fixes #3879) - Removed the timestampsInSnapshots option from FirestoreSettings. Now, Firestore always returns Timestamp values for all timestamp values.

Minor Changes

  • 9719635fe #3960 - Removed excess validation of null and NaN values in query filters. This more closely aligns the SDK with the Firestore backend, which has always accepted null and NaN for all operators, even though this isn't necessarily useful.

Patch Changes

1.18.0

Minor Changes

  • 4f997bce1 #3724 - Adds a new experimentalAutoDetectLongPolling to FirestoreSettings. When enabled, the SDK's underlying transport (WebChannel) automatically detects if long-polling should be used. This is very similar to experimentalForceLongPolling, but only uses long-polling if required.

Patch Changes

1.17.3

Patch Changes

  • a10c18f89 #3871 - The SDK now include more information in the error message for failed IndexedDB transactions.

1.17.2

Patch Changes

1.17.1

Patch Changes

  • 4dc8817c3 #3821 - Fixes an issue that prevents waitForPendingWrites() from resolving in background tabs when multi-tab is used (firebase#3816).
  • 16c6ba979 #3820 (fixes #3814) - Fixes a "Comparison with -0" lint warning for customers that build from source.

1.17.0

Minor Changes

  • f9004177e #3772 - [feature] Added not-in and != query operators for use with .where(). not-in finds documents where a specified field’s value is not in a specified array. != finds documents where a specified field's value does not equal the specified value. Neither query operator will match documents where the specified field is not present.
  • a8ff3dbaa #3418 - Use FirestoreError instead of Error in onSnapshot*() error callbacks.

Patch Changes

1.16.7

Patch Changes

1.16.6

Patch Changes

  • 61b4cd31b #3464 (fixes #3354) - feat: Added merge option to firestore.settings(), which merges the provided settings with settings from a previous call. This allows adding settings on top of the settings that were applied by @firebase/testing.
  • Updated dependencies [61b4cd31b]:

1.16.5

Patch Changes

  • 960093d5b #3575 (fixes #2755) - terminate() can now be retried if it fails with an IndexedDB exception.
  • b97c7e758 #3487 - Enable fallback for auto-generated identifiers in environments that support crypto but not crypto.getRandomValues.

1.16.4

Patch Changes

  • 36be62a8 #3535 (fixes #3495) - The SDK no longer crashes with the error "The database connection is closing". Instead, the individual operations that cause this error may be rejected.

1.16.3

Patch Changes

1.16.2

Patch Changes

1.16.1

Patch Changes

  • 9a9a81fe #3279 Thanks @schmidt-sebastian! - [fixed] Removed a delay that may have prevented Firestore from immediately reestablishing a network connection if a connectivity change occurred while the app was in the background.

1.16.0

Minor Changes

Patch Changes

1.15.0

  • [feature] Added an experimentalForceOwningTab setting that can be used to enable persistence in environments without LocalStorage, which allows persistence to be used in Web Workers (#983).

  • [changed] All known failure cases for Indexed-related crashes have now been addressed. Instead of crashing the client, IndexedDB failures will result in rejected operations (e.g. rejected Writes or errored Query listeners). If these rejections surface in your app, you can retry these operations when IndexedDB access is restored. IndexedDB failures that occur due to background work are automatically retried.

    If you continue to see Indexed-related crashes, we appreciate feedback (firebase#2755).

1.14.6

  • [fixed] Fixed an issue that could cause Firestore to temporarily go offline when a Window visibility event occurred.
  • [feature] Added support for calling FirebaseFirestore.settings with { ignoreUndefinedProperties: true }. When set, Firestore ignores undefined properties inside objects rather than rejecting the API call.

1.14.4

  • [fixed] Fixed a regression introduced in v7.14.2 that incorrectly applied a FieldValue.increment in combination with set({...}, {merge: true}).

1.14.3

  • [fixed] Firestore now rejects onSnapshot() listeners if they cannot be registered in IndexedDB. Previously, these errors crashed the client.

1.14.2

  • [fixed] Firestore now rejects write operations if they cannot be persisted in IndexedDB. Previously, these errors crashed the client.
  • [fixed] Fixed a source of IndexedDB-related crashes for tabs that receive multi-tab notifications while the file system is locked.

1.10.2

  • [fixed] Temporarily reverted the use of window.crypto to generate document IDs to address compatibility issues with IE 11, WebWorkers, and React Native.
  • [changed] Firestore now limits the number of concurrent document lookups it will perform when resolving inconsistencies in the local cache (#2683).
  • [changed] Changed the in-memory representation of Firestore documents to reduce memory allocations and improve performance. Calls to DocumentSnapshot.getData() and DocumentSnapshot.toObject() will see the biggest improvement.

1.10.1

  • [fixed] Fixed an issue where the number value -0.0 would lose its sign when stored in Firestore.

1.10.0

  • [feature] Implemented Timestamp.valueOf() so that Timestamp objects can be compared for relative ordering using the JavaScript arithmetic comparison operators (#2632).
  • [fixed] Fixed an issue where auth credentials were not respected in Cordova environments (#2626).
  • [fixed] Fixed a performance regression introduced by the addition of Query.limitToLast(n: number) in Firestore 1.7.0 (Firebase 7.3.0) (#2620).
  • [fixed] Fixed an issue where CollectionReference.add() would reject custom types when using withConverter() (#2606).

1.9.3

  • [fixed] Fixed an issue where auth credentials were not respected in some Firefox or Chrome extensions. (#1491)
  • [changed] Firestore previously required that every document read in a transaction must also be written. This requirement has been removed, and you can now read a document in transaction without writing to it.

1.9.2

  • [fixed] Fixed an issue where auth credentials were not respected in certain browser environments (Electron 7, IE11 in trusted zone, UWP apps). (#1491)

1.9.0

  • [feature] Added support for storing and retrieving custom types in Firestore. Added support for strongly typed collections, documents, and queries. You can now use withConverter() to supply a custom data converter that will convert between Firestore data and your custom type.

1.8.0

  • [changed] Improved the performance of repeatedly executed queries when persistence is enabled. Recently executed queries should see dramatic improvements. This benefit is reduced if changes accumulate while the query is inactive. Queries that use the limit() API may not always benefit, depending on the accumulated changes.

1.7.0

  • [changed] The client can now recover if certain periodic IndexedDB operations fail.
  • [feature] Added in and array-contains-any query operators for use with .where(). in finds documents where a specified field’s value is IN a specified array. array-contains-any finds documents where a specified field is an array and contains ANY element of a specified array.
  • [feature] Added Query.limitToLast(n: number) , which returns the last n documents as the result.

1.6.3

  • [changed] Improved iOS 13 support by eliminating an additional crash in our IndexedDB persistence layer.

1.6.2

  • [changed] Fixed a crash on iOS 13 that occurred when persistence was enabled in a background tab (#2232).
  • [fixed] Fixed an issue in the interaction with the Firestore Emulator that caused requests with timestamps to fail.

1.6.0

  • [feature] Added a Firestore.onSnapshotsInSync() method that notifies you when all your snapshot listeners are in sync with each other.
  • [fixed] Fixed a regression that caused queries with nested field filters to crash the client if the field was not present in the local copy of the document.

1.5.0

  • [feature] Added a Firestore.waitForPendingWrites() method that allows users to wait until all pending writes are acknowledged by the Firestore backend.
  • [feature] Added a Firestore.terminate() method which terminates the instance, releasing any held resources. Once it completes, you can optionally call Firestore.clearPersistence() to wipe persisted Firestore data from disk.
  • [changed] Improved performance for queries with filters that only return a small subset of the documents in a collection.
  • [fixed] Fixed a race condition between authenticating and initializing Firestore that could result in initial writes to the database being dropped.

1.4.10

  • [changed] Transactions now perform exponential backoff before retrying. This means transactions on highly contended documents are more likely to succeed.

1.4.6

  • [changed] Transactions are now more flexible. Some sequences of operations that were previously incorrectly disallowed are now allowed. For example, after reading a document that doesn't exist, you can now set it multiple times successfully in a transaction.

1.4.5

  • [fixed] Fixed an issue where query results were temporarily missing documents that previously had not matched but had been updated to now match the query (firebase/firebase-android-sdk#155).

1.4.4

  • [fixed] Fixed an internal assertion that was triggered when an update with a FieldValue.serverTimestamp() and an update with a FieldValue.increment() were pending for the same document.

1.4.0

  • [changed] Added logging and a custom error message to help users hitting https://bugs.webkit.org/show_bug.cgi?id=197050 (a bug in iOS 12.2 causing the SDK to potentially crash when persistence is enabled).
  • [fixed] Fixed an issue for environments missing window.addEventListener, such as in React Native with Expo (#1824).

1.3.5

  • [feature] Added clearPersistence(), which clears the persistent storage including pending writes and cached documents. This is intended to help write reliable tests (#449).

1.3.3

  • [changed] Firestore now recovers more quickly after network connectivity changes (airplane mode, Wi-Fi availability, etc.).

1.3.0

  • [changed] Deprecated the experimentalTabSynchronization setting in favor of synchronizeTabs. If you use multi-tab synchronization, it is recommended that you update your call to enablePersistence(). Firestore logs an error if you continue to use experimentalTabSynchronization.
  • [feature] You can now query across all collections in your database with a given collection ID using the FirebaseFirestore.collectionGroup() method.

1.1.4

  • [feature] Added an experimentalForceLongPolling setting that can be used to work around proxies that prevent the Firestore client from connecting to the Firestore backend.

1.1.1

  • [changed] Increased a connection timeout that could lead to large writes perpetually retrying without ever succeeding (#1447).
  • [fixed] Fixed an issue with IndexedDb persistence that triggered an internal assert for Queries that use nested DocumentReferences in where() clauses (#1524, #1596).
  • [fixed] Fixed an issue where transactions in a Node.JS app could be sent without auth credentials, leading to Permission Denied errors.

1.1.0

  • [feature] Added FieldValue.increment(), which can be used in update() and set(..., {merge:true}) to increment or decrement numeric field values safely without transactions.
  • [changed] Prepared the persistence layer to support collection group queries. While this feature is not yet available, all schema changes are included in this release. Once you upgrade, you will not be able to use an older version of the Firestore SDK with persistence enabled.

1.0.5

  • [changed] Improved performance when querying over documents that contain subcollections.

1.0.4

  • [fixed] Fixed an uncaught promise error occurring when enablePersistence() was called in a second tab (#1531).

1.0.0

  • [changed] The timestampsInSnapshots setting is now enabled by default. Timestamp fields that read from a DocumentSnapshot are now returned as Timestamp objects instead of Date objects. This is a breaking change; developers must update any code that expects to receive a Date object. See https://firebase.google.com/docs/reference/js/firebase.firestore.Settings#~timestampsInSnapshots for more details.
  • [fixed] Fixed a crash that could happen when the app is shut down after a write has been sent to the server but before it has been received on a listener.

0.9.2

  • [fixed] Fixed a regression introduced in 5.7.0 that caused apps using experimentalTabSynchronization to hit an exception for "Failed to obtain primary lease for action 'Collect garbage'".

0.9.1

  • [changed] Added a custom error for schema downgrades.

0.9.0

  • [changed] Removed eval()-based fallback for JSON parsing, allowing SDK to be used in environments that prohibit eval().
  • [feature] Added a garbage collection process to on-disk persistence that removes older documents. This is enabled automatically if persistence is enabled, and the SDK will attempt to periodically clean up older, unused documents once the on-disk cache passes a threshold size (default: 40 MB). This threshold can be configured by changing the setting cacheSizeBytes in the settings passed to Firestore.settings(). It must be set to a minimum of 1 MB. The garbage collection process can be disabled entirely by setting cacheSizeBytes to CACHE_SIZE_UNLIMITED.

0.8.3

  • [fixed] Fixed an issue that prevented query synchronization between multiple tabs.

0.8.2

  • [fixed] Fixed an issue where native ES6 module loading was not working.

0.8.1

  • [fixed] Fixed an issue where typings are created in the wrong location.

0.8.0

  • [feature] Access to offline persistence is no longer limited to a single tab. You can opt into this new experimental mode by invoking enablePersistence() with {experimentalTabSynchronization: true}. All tabs accessing persistence must use the same setting for this flag.
  • [fixed] Fixed an issue where the first get() call made after being offline could incorrectly return cached data without attempting to reach the backend.
  • [changed] Changed get() to only make one attempt to reach the backend before returning cached data, potentially reducing delays while offline.
  • [fixed] Fixed an issue that caused Firebase to drop empty objects from calls to set(..., { merge: true }).
  • [changed] Improved argument validation for several API methods.

0.7.3

  • [changed] Changed the internal handling for locally updated documents that haven't yet been read back from Firestore. This can lead to slight behavior changes and may affect the SnapshotMetadata.hasPendingWrites metadata flag.
  • [changed] Eliminated superfluous update events for locally cached documents that are known to lag behind the server version. Instead, we buffer these events until the client has caught up with the server.

0.7.2

  • [fixed] Fixed a regression that prevented use of Firestore on ReactNative's Expo platform (#1138).

0.7.0

  • [fixed] Fixed get({source: 'cache'}) to be able to return nonexistent documents from cache.
  • [changed] Prepared the persistence layer to allow shared access from multiple tabs. While this feature is not yet available, all schema changes are included in this release. Once you upgrade, you will not be able to use an older version of the Firestore SDK with persistence enabled.
  • [fixed] Fixed an issue where changes to custom authentication claims did not take effect until you did a full sign-out and sign-in. (firebase/firebase-ios-sdk#1499)

0.6.1

  • [changed] Improved how Firestore handles idle queries to reduce the cost of re-listening within 30 minutes.
  • [changed] Improved offline performance with many outstanding writes.

0.6.0

  • [fixed] Fixed an issue where queries returned fewer results than they should, caused by documents that were cached as deleted when they should not have been (firebase/firebase-ios-sdk#1548). Because some cache data is cleared, clients might use extra bandwidth the first time they launch with this version of the SDK.
  • [feature] Added firebase.firestore.FieldValue.arrayUnion() and firebase.firestore.FieldValue.arrayRemove() to atomically add and remove elements from an array field in a document.
  • [feature] Added 'array-contains' query operator for use with .where() to find documents where an array field contains a specific element.

0.5.0

  • [changed] Merged the includeQueryMetadataChanges and includeDocumentMetadataChanges options passed to Query.onSnapshot() into a single includeMetadataChanges option.
  • [changed] QuerySnapshot.docChanges() is now a method that optionally takes an includeMetadataChanges option. By default, even when listening to a query with { includeMetadataChanges:true }, metadata-only document changes are suppressed in docChanges().
  • [feature] Added new { mergeFields: (string|FieldPath)[] } option to set() which allows merging of a reduced subset of fields.

0.4.1

  • [fixed] Fixed a regression in Firebase JS release 4.13.0 regarding the loading of proto files, causing Node.JS support to break.

0.4.0

  • [feature] Added a new Timestamp class to represent timestamp fields, currently supporting up to microsecond precision. It can be passed to API methods anywhere a JS Date object is currently accepted. To make DocumentSnapshots read timestamp fields back as Timestamps instead of Dates, you can set the newly added flag timestampsInSnapshots in FirestoreSettings to true. Note that the current behavior (DocumentSnapshots returning JS Date objects) will be removed in a future release. Timestamp supports higher precision than JS Date.
  • [feature] Added ability to control whether DocumentReference.get() and Query.get() should fetch from server only, (by passing { source: 'server' }), cache only (by passing { source: 'cache' }), or attempt server and fall back to the cache (which was the only option previously, and is now the default).

0.3.7

  • [fixed] Fixed a regression in the Firebase JS release 4.11.0 that could cause get() requests made while offline to be delayed by up to 10 seconds (rather than returning from cache immediately).

0.3.6

  • [fixed] Fixed a regression in the Firebase JS release 4.11.0 that could cause a crash if a user signs out while the client is offline, resulting in an error of "Attempted to schedule multiple operations with timer id listen_stream_connection_backoff".

0.3.5

  • [changed] If the SDK's attempt to connect to the Cloud Firestore backend neither succeeds nor fails within 10 seconds, the SDK will consider itself "offline", causing get() calls to resolve with cached results, rather than continuing to wait.
  • [fixed] Fixed a potential race condition after calling enableNetwork() that could result in a "Mutation batchIDs must be acknowledged in order" assertion crash.

0.3.2

  • [fixed] Fixed a regression in Firebase JS release 4.9.0 that could in certain cases result in an "OnlineState should not affect limbo documents." assertion crash when the client loses its network connection.

0.3.1

  • [changed] Snapshot listeners (with the includeMetadataChanges option enabled) now receive an event with snapshot.metadata.fromCache set to true if the SDK loses its connection to the backend. A new event with snapshot.metadata.fromCache set to false will be raised once the connection is restored and the query is in sync with the backend again.
  • [feature] Added SnapshotOptions API to control how DocumentSnapshots return unresolved server timestamps.
  • [feature] Added disableNetwork() and enableNetwork() methods to Firestore class, allowing for explicit network management.
  • [changed] For non-existing documents, DocumentSnapshot.data() now returns undefined instead of throwing an exception. A new QueryDocumentSnapshot class is introduced for Queries to reduce the number of undefined-checks in your code.
  • [added] Added isEqual API to GeoPoint, Blob, SnapshotMetadata, DocumentSnapshot, QuerySnapshot, CollectionReference, FieldValue and FieldPath.
  • [changed] A "Could not reach Firestore backend." message will be logged when the initial connection to the Firestore backend fails.
  • [changed] A "Using maximum backoff delay to prevent overloading the backend." message will be logged when we get a resource-exhausted error from the backend.

v0.2.1

  • [feature] Added Node.js support for Cloud Firestore (with the exception of the offline persistence feature).
  • [changed] Webchannel requests use $httpHeaders URL parameter rather than normal HTTP headers to avoid an extra CORS preflight request when initiating streams / RPCs.

v0.1.4

  • [changed] Network streams are automatically closed after 60 seconds of idleness.
  • [changed] We no longer log 'RPC failed' messages for expected failures.

v0.1.2

  • [changed] We now support FieldValue.delete() sentinels in set() calls with {merge:true}.
  • [fixed] Fixed validation of nested arrays to allow indirect nesting

v0.1.1

  • [fixed] Fixed an issue causing exceptions when trying to use firebase.firestore.FieldPath.documentId() in an orderBy() or where() clause in a query.

v0.1.0

  • Initial public release.