Firestore: Release enablePersistentCacheIndexAutoCreation() and related functions #7599

dconeybe · 2023-08-30T19:21:23Z

Expose the functions and types for using the Firestore SDK's local persistent cache index auto-creation feature, and deprecate the functions for manually creating these indexes.

The following functions and types are made available by this PR:

PersistentCacheIndexManager
getPersistentCacheIndexManager()
enablePersistentCacheIndexAutoCreation()
disablePersistentCacheIndexAutoCreation()
deleteAllPersistentCacheIndexes()

This feature was implemented (but hidden) in the following PRs: #7542 and #7587. See those PRs and the public reference documentation for full details on this feature.

…anager.type

changeset-bot · 2023-08-30T19:21:40Z

🦋 Changeset detected

Latest commit: 73bfb9b

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 3 packages

Name	Type
@firebase/firestore	Minor
firebase	Minor
@firebase/firestore-compat	Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

github-actions · 2023-08-30T19:23:20Z

Changeset File Check ✅

No modified packages are missing from the changeset file.
No changeset formatting errors detected.

google-oss-bot · 2023-08-30T19:42:34Z

Size Report ¹

Affected Products

No changes between base commit (74fc4cf) and merge commit (1921365).

Test Logs

https://storage.googleapis.com/firebase-sdk-metric-reports/DH3ae9OI0V.html

google-oss-bot · 2023-08-30T20:01:27Z

Size Analysis Report ¹

Affected Products

No changes between base commit (74fc4cf) and merge commit (1921365).

Test Logs

https://storage.googleapis.com/firebase-sdk-metric-reports/EBIKbnIIGj.html

dconeybe · 2023-09-01T04:45:19Z

@markarndt Please review this PR for tech writer approval.

dconeybe · 2023-09-01T04:46:26Z

@markarndt For context, the equivalent PR in the android sdk, which you reviewed, is firebase/firebase-android-sdk#5256.

markarndt

A few edits.

markarndt · 2023-09-01T17:18:47Z

docs-devsite/firestore_.index.md

@@ -13,6 +13,11 @@ https://github.com/firebase/firebase-js-sdk
 > This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
 > 

+> Warning: This API is now obsolete.
+> 
+> Instead of creating cache indexes manually, consider using `enablePersistentCacheIndexAutoCreation()` to let SDK decide whether to create cache indexes for queries running locally.


Edit:

"Instead of creating cache indexes manually, consider using enablePersistentCacheIndexAutoCreation() to let the SDK decide whether to create cache indexes for queries running locally."

And line 16 in a couple other files below.

markarndt · 2023-09-01T17:20:20Z

docs-devsite/firestore_.md

+|  <b>function(indexManager...)</b> |
+|  [deleteAllPersistentCacheIndexes(indexManager)](./firestore_.md#deleteallpersistentcacheindexes) | Removes all persistent cache indexes.<!-- -->Please note this function will also deletes indexes generated by <code>setIndexConfiguration()</code>, which is deprecated. |
+|  [disablePersistentCacheIndexAutoCreation(indexManager)](./firestore_.md#disablepersistentcacheindexautocreation) | Stops creating persistent cache indexes automatically for local query execution. The indexes which have been created by calling <code>enablePersistentCacheIndexAutoCreation()</code> still take effect. |
+|  [enablePersistentCacheIndexAutoCreation(indexManager)](./firestore_.md#enablepersistentcacheindexautocreation) | Enables SDK to create persistent cache indexes automatically for local query execution when SDK believes cache indexes can help improves performance.<!-- -->This feature is disabled by default. |


Edit:

"enablePersistentCacheIndexAutoCreation(indexManager) | Enables the SDK to create persistent cache indexes automatically for local query execution when the SDK believes cache indexes can help improves performance.This feature is disabled by default."

markarndt · 2023-09-01T17:21:08Z

docs-devsite/firestore_.md

@@ -130,6 +135,7 @@ https://github.com/firebase/firebase-js-sdk
 |  [FirestoreError](./firestore_.firestoreerror.md#firestoreerror_class) | An error returned by a Firestore operation. |
 |  [GeoPoint](./firestore_.geopoint.md#geopoint_class) | An immutable object representing a geographic location in Firestore. The location is represented as latitude/longitude pair.<!-- -->Latitude values are in the range of \[-90, 90\]. Longitude values are in the range of \[-180, 180\]. |
 |  [LoadBundleTask](./firestore_.loadbundletask.md#loadbundletask_class) | Represents the task of loading a Firestore bundle. It provides progress of bundle loading, as well as task completion and error events.<!-- -->The API is compatible with <code>Promise&lt;LoadBundleTaskProgress&gt;</code>. |
+|  [PersistentCacheIndexManager](./firestore_.persistentcacheindexmanager.md#persistentcacheindexmanager_class) | A <code>PersistentCacheIndexManager</code> which you can config persistent cache indexes used for local query execution.<!-- -->To use, call <code>getPersistentCacheIndexManager()</code> to get an instance. |


Edits:

PersistentCacheIndexManager | A PersistentCacheIndexManager for configuring persistent cache indexes used for local query execution.To use, call getPersistentCacheIndexManager() to get an instance.

markarndt · 2023-09-01T17:22:02Z

docs-devsite/firestore_.md

@@ -659,6 +687,11 @@ If the transaction completed successfully or was explicitly aborted (the `update
 > This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
 > 

+> Warning: This API is now obsolete.
+> 
+> Instead of creating cache indexes manually, consider using `enablePersistentCacheIndexAutoCreation()` to let SDK decide whether to create cache indexes for queries running locally.


Edit:

"Instead of creating cache indexes manually, consider using enablePersistentCacheIndexAutoCreation() to let the SDK decide whether to create cache indexes for queries running locally."

And below....

markarndt · 2023-09-01T17:22:55Z

docs-devsite/firestore_.md

+
+## enablePersistentCacheIndexAutoCreation()
+
+Enables SDK to create persistent cache indexes automatically for local query execution when SDK believes cache indexes can help improves performance.


Edit:

"Enables the SDK to create persistent cache indexes automatically for local query execution when the SDK believes cache indexes can help improves performance."

markarndt · 2023-09-01T17:23:51Z

docs-devsite/firestore_.persistentcacheindexmanager.md

+https://github.com/firebase/firebase-js-sdk
+{% endcomment %}
+
+# PersistentCacheIndexManager class


Edit (I don't know if these are generated files, so edits to source may make these .md edits unnecessary.

"A PersistentCacheIndexManager for configuring persistent cache indexes used for local query execution."

…believes' -> 'when the SDK believes' and 'can help improves performance' -> 'can help improve performance'

…CreationExpose

dconeybe · 2023-09-05T18:00:09Z

@markarndt PTAL. I believe I have addressed your feedback.

cherylEnkidu

LGTM!

dconeybe added 6 commits August 30, 2023 14:50

persistent_cache_index_manager.ts: remove @internal annotations

ddc4b42

yarn changeset

3f3c3eb

index_configuration.ts: mark manual index creation apis as "deprecated"

1b6c95b

persistent_cache_index_manager.ts: add docs for PersistentCacheIndexM…

b75239f

…anager.type

firestore.api.md updated

e1b2221

yarn docgen devsite

fd9572a

dconeybe added the api: firestore label Aug 30, 2023

dconeybe self-assigned this Aug 30, 2023

This was referenced Aug 24, 2023

Firestore: enable/disablePersistentCacheIndexAutoCreation() added, but hidden for now #7542

Merged

Firestore: deleteAllPersistentCacheIndexes() added, but hidden for now #7587

Merged

add firebase to changeset

aca631f

dconeybe requested review from wu-hui and cherylEnkidu August 31, 2023 04:17

cherylEnkidu requested a review from markarndt August 31, 2023 18:12

cherylEnkidu assigned markarndt Aug 31, 2023

dconeybe marked this pull request as ready for review September 1, 2023 04:44

dconeybe requested review from a team, egilmorez and kevinthecheung as code owners September 1, 2023 04:44

markarndt approved these changes Sep 1, 2023

View reviewed changes

dconeybe added 2 commits September 1, 2023 16:06

'to let SDK decide' -> 'to let the SDK decide'

a9371f9

'Enables SDK to create' -> 'Enables the SDK to create' and 'when SDK …

5473c4a

…believes' -> 'when the SDK believes' and 'can help improves performance' -> 'can help improve performance'

dconeybe added 3 commits September 1, 2023 16:12

'which you can config' -> 'for configuring'

8f62cd8

Merge remote-tracking branch 'origin/master' into ClientSideIndexAuto…

3d46e76

…CreationExpose

yarn docgen devsite

73bfb9b

dconeybe requested a review from markarndt September 5, 2023 17:59

markarndt approved these changes Sep 5, 2023

View reviewed changes

cherylEnkidu approved these changes Sep 5, 2023

View reviewed changes

hsubox76 approved these changes Sep 5, 2023

View reviewed changes

dconeybe merged commit fbd8e0e into master Sep 5, 2023
41 checks passed

dconeybe deleted the dconeybe/ClientSideIndexAutoCreationExpose branch September 5, 2023 19:57

google-oss-bot mentioned this pull request Sep 12, 2023

Version Packages #7626

Merged

firebase locked and limited conversation to collaborators Oct 6, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Firestore: Release enablePersistentCacheIndexAutoCreation() and related functions #7599

Firestore: Release enablePersistentCacheIndexAutoCreation() and related functions #7599

dconeybe commented Aug 30, 2023

changeset-bot bot commented Aug 30, 2023 •

edited

Loading

github-actions bot commented Aug 30, 2023 •

edited

Loading

google-oss-bot commented Aug 30, 2023 •

edited

Loading

google-oss-bot commented Aug 30, 2023 •

edited

Loading

dconeybe commented Sep 1, 2023

dconeybe commented Sep 1, 2023

markarndt left a comment

markarndt Sep 1, 2023

markarndt Sep 1, 2023

markarndt Sep 1, 2023

markarndt Sep 1, 2023

markarndt Sep 1, 2023

markarndt Sep 1, 2023

markarndt Sep 1, 2023

markarndt Sep 1, 2023

dconeybe commented Sep 5, 2023

cherylEnkidu left a comment


		## enablePersistentCacheIndexAutoCreation()

		Enables SDK to create persistent cache indexes automatically for local query execution when SDK believes cache indexes can help improves performance.

Firestore: Release enablePersistentCacheIndexAutoCreation() and related functions #7599

Firestore: Release enablePersistentCacheIndexAutoCreation() and related functions #7599

Conversation

dconeybe commented Aug 30, 2023

changeset-bot bot commented Aug 30, 2023 • edited Loading

🦋 Changeset detected

github-actions bot commented Aug 30, 2023 • edited Loading

Changeset File Check ✅

google-oss-bot commented Aug 30, 2023 • edited Loading

Size Report 1

Affected Products

Test Logs

google-oss-bot commented Aug 30, 2023 • edited Loading

Size Analysis Report 1

Affected Products

Test Logs

dconeybe commented Sep 1, 2023

dconeybe commented Sep 1, 2023

markarndt left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dconeybe commented Sep 5, 2023

cherylEnkidu left a comment

Choose a reason for hiding this comment

changeset-bot bot commented Aug 30, 2023 •

edited

Loading

github-actions bot commented Aug 30, 2023 •

edited

Loading

google-oss-bot commented Aug 30, 2023 •

edited

Loading

Size Report ¹

google-oss-bot commented Aug 30, 2023 •

edited

Loading

Size Analysis Report ¹