Support restart of FirestoreClient

[tom-andersen]

This PR is purely a refactor, since restart functionality is not exposed in API surface, but simply prepares for future development of features.

Currently, the FirestoreClient becomes unusable when terminated. Certain functionality, such as clearing the cache, require the FirestoreClient be terminated. This presents a problem when Firestore backend requires clearing of cache on client, since this will break customer applications. This PR makes it possible to restart the client after terminate, thereby allowing usage of Firestore to continue even after cache is cleared.

To support restarting FirestoreClient:

• Create new AsyncQueue that will start processing when old AsyncQueue has finished terminating. This is done by chaining old AsyncQueue terminate task to head of new AsyncQueue.
• Since ComponentProvider retains copies of shutdown components, a new component provider is created upon restart. This requires a higher level of abstraction where we introduce a ComponentProviderFactory, such that we can create ComponentProvider of same shape/config multiple times.
• Terminate will now clear reference to firestore client, such that Firestore will create a new instance through existing ensureFirestoreConfigured code path. To support existing behaviour of preventing Firestore usage after terminate, the ensureFirestoreConfigured method has guard added to check whether a _terminated task exists.
• Restart is implemented by simply clearing _terminated task, such that ensureFirestoreConfigured no longer prevents instantiating new client after terminate. With both the reference to _firestoreClient and _termianted being reset to undefined, the system appears fresh, ready to create a new firestore instance. By having the old AsyncQueue chained to new AsyncQueue, no processing will happen on new firestore instance, until all processing on old firestore instance is complete, thereby avoiding any interference between the old and new firestore instance.

[changeset-bot]

🦋 Changeset detected

Latest commit: 8eaee68

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	Patch
firebase	Patch
@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

[google-oss-bot]

Size Report ¹

Affected Products

• @firebase/firestore

  Type	Base (629919e)	Merge (02f1e4f)	Diff
  browser	381 kB	381 kB	-331 B (-0.1%)
  esm5	366 kB	366 kB	+73 B (+0.0%)
  main	587 kB	587 kB	+269 B (+0.0%)
  module	381 kB	381 kB	-331 B (-0.1%)
  react-native	382 kB	381 kB	-330 B (-0.1%)

• @firebase/firestore-lite

  Type	Base (629919e)	Merge (02f1e4f)	Diff
  browser	111 kB	111 kB	+179 B (+0.2%)
  esm5	108 kB	108 kB	+399 B (+0.4%)
  main	153 kB	153 kB	+193 B (+0.1%)
  module	111 kB	111 kB	+179 B (+0.2%)
  react-native	111 kB	111 kB	+179 B (+0.2%)

• bundle

  15 size changes

  Type	Base (629919e)	Merge (02f1e4f)	Diff
  firestore (CSI Auto Indexing Disable and Delete)	270 kB	269 kB	-664 B (-0.2%)
  firestore (CSI Auto Indexing Enable)	270 kB	269 kB	-664 B (-0.2%)
  firestore (Persistence)	305 kB	303 kB	-1.84 kB (-0.6%)
  firestore (Query Cursors)	242 kB	242 kB	+268 B (+0.1%)
  firestore (Query)	240 kB	240 kB	+268 B (+0.1%)
  firestore (Read data once)	228 kB	228 kB	+268 B (+0.1%)
  firestore (Read Write w Persistence)	325 kB	325 kB	-33 B (-0.0%)
  firestore (Realtime updates)	230 kB	230 kB	+261 B (+0.1%)
  firestore (Transaction)	207 kB	207 kB	+247 B (+0.1%)
  firestore (Write data)	207 kB	207 kB	+247 B (+0.1%)
  firestore-lite (Query Cursors)	91.3 kB	91.4 kB	+176 B (+0.2%)
  firestore-lite (Query)	87.4 kB	87.6 kB	+176 B (+0.2%)
  firestore-lite (Read data once)	62.9 kB	63.1 kB	+176 B (+0.3%)
  firestore-lite (Transaction)	88.1 kB	88.3 kB	+179 B (+0.2%)
  firestore-lite (Write data)	72.5 kB	72.6 kB	+176 B (+0.2%)

• firebase

  Type	Base (629919e)	Merge (02f1e4f)	Diff
  firebase-compat.js	788 kB	788 kB	-129 B (-0.0%)
  firebase-firestore-compat.js	344 kB	344 kB	-127 B (-0.0%)
  firebase-firestore-lite.js	119 kB	119 kB	+179 B (+0.2%)
  firebase-firestore.js	440 kB	440 kB	-294 B (-0.1%)

Test Logs

• Base (629919e): https://github.com/firebase/firebase-js-sdk/actions/runs/10836120241
• Merge (02f1e4f): https://github.com/firebase/firebase-js-sdk/actions/runs/10927516257

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

[google-oss-bot]

Size Analysis Report ¹

This report is too large (967,691 characters) to be displayed here in a GitHub comment. Please use the below link to see the full report on Google Cloud Storage.

Test Logs

• Base (629919e): https://github.com/firebase/firebase-js-sdk/actions/runs/10836120241
• Merge (02f1e4f): https://github.com/firebase/firebase-js-sdk/actions/runs/10927516257

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

[DellaBitta]

Please add a changeset and a PR description based on the template. Thanks!

[dconeybe]

Drive-by comment: Could you add a blurb to this PR description to explain why this change is being made? Is it fixing a bug? Is it setting the stage for a new feature? Is it a performance improvement? Thanks.