Firestore: component_provider.ts: cleanup terminate() functions #7906

dconeybe · 2023-12-24T05:25:41Z

This PR makes a few tiny code improvements to the terminate() functions in component_provider.ts:

Simplify some if blocks checking for and object being null with more concise null chaining (i.e. the ?. operator).
Remove await from function calls that simply return void, which make the await superfluous and potentially confusing.
Explicitly call indexBackfillerScheduler?.stop(), just like how gcScheduler?.stop() is called. This doesn't really affect anything because the scheduled job is cancelled by virtue of the AsyncQueue being shut down, but it's probably best not to rely on that implementation detail of the scheduler.

changeset-bot · 2023-12-24T05:25:45Z

⚠️ No Changeset found

Latest commit: efedb67

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

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

…hen Firestore is terminated

google-oss-bot · 2023-12-24T05:41:39Z

Size Report ¹

Affected Products

@firebase/firestore
Type Base (537d399) Merge (9bdee51) Diff
browser 375 kB 375 kB +83 B (+0.0%)
esm5 360 kB 360 kB +20 B (+0.0%)
main 577 kB 577 kB +106 B (+0.0%)
module 375 kB 375 kB +83 B (+0.0%)
react-native 375 kB 375 kB +83 B (+0.0%)

`bundle`

Type	Base (`537d399`)	Merge (`9bdee51`)	Diff
firestore (Persistence)	302 kB	303 kB	+83 B (+0.0%)
firestore (Query Cursors)	238 kB	238 kB	+83 B (+0.0%)
firestore (Query)	236 kB	236 kB	+83 B (+0.0%)
firestore (Read data once)	224 kB	224 kB	+83 B (+0.0%)
firestore (Read Write w Persistence)	321 kB	321 kB	+83 B (+0.0%)
firestore (Realtime updates)	226 kB	226 kB	+83 B (+0.0%)
firestore (Transaction)	204 kB	204 kB	+83 B (+0.0%)
firestore (Write data)	204 kB	204 kB	+83 B (+0.0%)

firebase
Type Base (537d399) Merge (9bdee51) Diff
firebase-compat.js 779 kB 779 kB +81 B (+0.0%)
firebase-firestore-compat.js 341 kB 341 kB +81 B (+0.0%)
firebase-firestore.js 434 kB 434 kB +83 B (+0.0%)

Test Logs

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

google-oss-bot · 2023-12-24T05:55:35Z

Size Analysis Report ¹

Affected Products

@firebase/firestore
- addDoc
  Size
  Type Base (537d399) Merge (9bdee51) Diff
  size 123 kB 123 kB +83 B (+0.1%)
  size-with-ext-deps 194 kB 194 kB +83 B (+0.0%)
- deleteAllPersistentCacheIndexes
  Size
  Type Base (537d399) Merge (9bdee51) Diff
  size 87.2 kB 87.3 kB +73 B (+0.1%)
  size-with-ext-deps 157 kB 157 kB +73 B (+0.0%)
- deleteDoc
  Size
  Type Base (537d399) Merge (9bdee51) Diff
  size 114 kB 114 kB +83 B (+0.1%)
  size-with-ext-deps 185 kB 185 kB +83 B (+0.0%)
- disableNetwork
  Size
  Type Base (537d399) Merge (9bdee51) Diff
  size 103 kB 103 kB +83 B (+0.1%)
  size-with-ext-deps 173 kB 173 kB +83 B (+0.0%)
- disablePersistentCacheIndexAutoCreation
  Size
  Type Base (537d399) Merge (9bdee51) Diff
  size 87.2 kB 87.2 kB +73 B (+0.1%)
  size-with-ext-deps 157 kB 157 kB +73 B (+0.0%)
- enableIndexedDbPersistence
  Size
  Type Base (537d399) Merge (9bdee51) Diff
  size 186 kB 186 kB +83 B (+0.0%)
  size-with-ext-deps 258 kB 258 kB +83 B (+0.0%)
- enableMultiTabIndexedDbPersistence
  Size
  Type Base (537d399) Merge (9bdee51) Diff
  size 222 kB 222 kB +83 B (+0.0%)
  size-with-ext-deps 294 kB 294 kB +83 B (+0.0%)
- enableNetwork
  Size
  Type Base (537d399) Merge (9bdee51) Diff
  size 103 kB 103 kB +83 B (+0.1%)
  size-with-ext-deps 173 kB 173 kB +83 B (+0.0%)
- enablePersistentCacheIndexAutoCreation
  Size
  Type Base (537d399) Merge (9bdee51) Diff
  size 87.2 kB 87.2 kB +73 B (+0.1%)
  size-with-ext-deps 157 kB 157 kB +73 B (+0.0%)
- executeWrite
  Size
  Type Base (537d399) Merge (9bdee51) Diff
  size 113 kB 113 kB +83 B (+0.1%)
  size-with-ext-deps 184 kB 184 kB +83 B (+0.0%)
- getAggregateFromServer
  Size
  Type Base (537d399) Merge (9bdee51) Diff
  size 110 kB 110 kB +83 B (+0.1%)
  size-with-ext-deps 180 kB 180 kB +83 B (+0.0%)
- getCountFromServer
  Size
  Type Base (537d399) Merge (9bdee51) Diff
  size 110 kB 110 kB +83 B (+0.1%)
  size-with-ext-deps 181 kB 181 kB +83 B (+0.0%)
- getDoc
  Size
  Type Base (537d399) Merge (9bdee51) Diff
  size 143 kB 143 kB +83 B (+0.1%)
  size-with-ext-deps 214 kB 214 kB +83 B (+0.0%)
- getDocFromCache
  Size
  Type Base (537d399) Merge (9bdee51) Diff
  size 94.6 kB 94.7 kB +73 B (+0.1%)
  size-with-ext-deps 165 kB 165 kB +73 B (+0.0%)
- getDocFromServer
  Size
  Type Base (537d399) Merge (9bdee51) Diff
  size 143 kB 143 kB +83 B (+0.1%)
  size-with-ext-deps 214 kB 214 kB +83 B (+0.0%)
- getDocs
  Size
  Type Base (537d399) Merge (9bdee51) Diff
  size 145 kB 145 kB +83 B (+0.1%)
  size-with-ext-deps 216 kB 216 kB +83 B (+0.0%)
- getDocsFromCache
  Size
  Type Base (537d399) Merge (9bdee51) Diff
  size 102 kB 102 kB +73 B (+0.1%)
  size-with-ext-deps 172 kB 173 kB +73 B (+0.0%)
- getDocsFromServer
  Size
  Type Base (537d399) Merge (9bdee51) Diff
  size 145 kB 145 kB +83 B (+0.1%)
  size-with-ext-deps 215 kB 215 kB +83 B (+0.0%)
- loadBundle
  Size
  Type Base (537d399) Merge (9bdee51) Diff
  size 112 kB 112 kB +83 B (+0.1%)
  size-with-ext-deps 183 kB 183 kB +83 B (+0.0%)
- memoryEagerGarbageCollector
  Size
  Type Base (537d399) Merge (9bdee51) Diff
  size 85.2 kB 85.3 kB +73 B (+0.1%)
  size-with-ext-deps 155 kB 155 kB +73 B (+0.0%)
- memoryLocalCache
  Size
  Type Base (537d399) Merge (9bdee51) Diff
  size 99.7 kB 99.8 kB +83 B (+0.1%)
  size-with-ext-deps 170 kB 170 kB +83 B (+0.0%)
- memoryLruGarbageCollector
  Size
  Type Base (537d399) Merge (9bdee51) Diff
  size 91.7 kB 91.8 kB +73 B (+0.1%)
  size-with-ext-deps 162 kB 162 kB +73 B (+0.0%)
- namedQuery
  Size
  Type Base (537d399) Merge (9bdee51) Diff
  size 88.1 kB 88.2 kB +73 B (+0.1%)
  size-with-ext-deps 158 kB 158 kB +73 B (+0.0%)
- onSnapshot
  Size
  Type Base (537d399) Merge (9bdee51) Diff
  size 145 kB 146 kB +83 B (+0.1%)
  size-with-ext-deps 216 kB 216 kB +83 B (+0.0%)
- onSnapshotsInSync
  Size
  Type Base (537d399) Merge (9bdee51) Diff
  size 135 kB 135 kB +83 B (+0.1%)
  size-with-ext-deps 206 kB 206 kB +83 B (+0.0%)
- persistentLocalCache
  Size
  Type Base (537d399) Merge (9bdee51) Diff
  size 183 kB 183 kB +83 B (+0.0%)
  size-with-ext-deps 255 kB 255 kB +83 B (+0.0%)
- persistentMultipleTabManager
  Size
  Type Base (537d399) Merge (9bdee51) Diff
  size 219 kB 219 kB +83 B (+0.0%)
  size-with-ext-deps 291 kB 291 kB +83 B (+0.0%)
- persistentSingleTabManager
  Size
  Type Base (537d399) Merge (9bdee51) Diff
  size 183 kB 183 kB +83 B (+0.0%)
  size-with-ext-deps 255 kB 255 kB +83 B (+0.0%)
- runTransaction
  Size
  Type Base (537d399) Merge (9bdee51) Diff
  size 123 kB 123 kB +83 B (+0.1%)
  size-with-ext-deps 194 kB 194 kB +83 B (+0.0%)
- setDoc
  Size
  Type Base (537d399) Merge (9bdee51) Diff
  size 122 kB 123 kB +83 B (+0.1%)
  size-with-ext-deps 193 kB 193 kB +83 B (+0.0%)
- setIndexConfiguration
  Size
  Type Base (537d399) Merge (9bdee51) Diff
  size 90.7 kB 90.8 kB +73 B (+0.1%)
  size-with-ext-deps 161 kB 161 kB +73 B (+0.0%)
- updateDoc
  Size
  Type Base (537d399) Merge (9bdee51) Diff
  size 123 kB 123 kB +83 B (+0.1%)
  size-with-ext-deps 194 kB 194 kB +83 B (+0.0%)
- waitForPendingWrites
  Size
  Type Base (537d399) Merge (9bdee51) Diff
  size 103 kB 103 kB +83 B (+0.1%)
  size-with-ext-deps 174 kB 174 kB +83 B (+0.0%)
- writeBatch
  Size
  Type Base (537d399) Merge (9bdee51) Diff
  size 125 kB 125 kB +83 B (+0.1%)
  size-with-ext-deps 196 kB 196 kB +83 B (+0.0%)

Test Logs

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

milaGGL

LGTM

Firestore: component_provider.ts: cleanup terminate() functions

959f7eb

dconeybe added the api: firestore label Dec 24, 2023

dconeybe self-assigned this Dec 24, 2023

Firestore: component_provider.ts: stop the scheduled index backfill w…

efedb67

…hen Firestore is terminated

dconeybe marked this pull request as ready for review December 24, 2023 08:08

dconeybe requested review from a team as code owners December 24, 2023 08:08

dconeybe mentioned this pull request Dec 24, 2023

Firestore: stop the periodically-scheduled index backfill after Firestore is terminated #7907

Closed

dconeybe requested a review from milaGGL January 2, 2024 17:04

dconeybe assigned milaGGL Jan 2, 2024

milaGGL approved these changes Jan 2, 2024

View reviewed changes

dconeybe merged commit 97fabd4 into master Jan 2, 2024
51 of 54 checks passed

dconeybe deleted the dconeybe/ComponentProviderCleanupTerminateFunctions branch January 2, 2024 20:30

firebase locked and limited conversation to collaborators Feb 2, 2024

Firestore: component_provider.ts: cleanup terminate() functions #7906

Firestore: component_provider.ts: cleanup terminate() functions #7906

Conversation

dconeybe commented Dec 24, 2023 • edited

changeset-bot bot commented Dec 24, 2023 • edited

⚠️ No Changeset found

google-oss-bot commented Dec 24, 2023 • edited

Size Report 1

Affected Products

@firebase/firestore

bundle

firebase

Test Logs

google-oss-bot commented Dec 24, 2023 • edited

Size Analysis Report 1

Affected Products

@firebase/firestore

addDoc

deleteAllPersistentCacheIndexes

deleteDoc

disableNetwork

disablePersistentCacheIndexAutoCreation

enableIndexedDbPersistence

enableMultiTabIndexedDbPersistence

enableNetwork

enablePersistentCacheIndexAutoCreation

executeWrite

getAggregateFromServer

getCountFromServer

getDoc

getDocFromCache

getDocFromServer

getDocs

getDocsFromCache

getDocsFromServer

loadBundle

memoryEagerGarbageCollector

memoryLocalCache

memoryLruGarbageCollector

namedQuery

onSnapshot

onSnapshotsInSync

persistentLocalCache

persistentMultipleTabManager

persistentSingleTabManager

runTransaction

setDoc

setIndexConfiguration

updateDoc

waitForPendingWrites

writeBatch

Test Logs

milaGGL left a comment

Choose a reason for hiding this comment

dconeybe commented Dec 24, 2023 •

edited

changeset-bot bot commented Dec 24, 2023 •

edited

google-oss-bot commented Dec 24, 2023 •

edited

Size Report ¹

`@firebase/firestore`

`bundle`

`firebase`

google-oss-bot commented Dec 24, 2023 •

edited

Size Analysis Report ¹

`@firebase/firestore`

`addDoc`

`deleteAllPersistentCacheIndexes`

`deleteDoc`

`disableNetwork`

`disablePersistentCacheIndexAutoCreation`

`enableIndexedDbPersistence`

`enableMultiTabIndexedDbPersistence`

`enableNetwork`

`enablePersistentCacheIndexAutoCreation`

`executeWrite`

`getAggregateFromServer`

`getCountFromServer`

`getDoc`

`getDocFromCache`

`getDocFromServer`

`getDocs`

`getDocsFromCache`

`getDocsFromServer`

`loadBundle`

`memoryEagerGarbageCollector`

`memoryLocalCache`

`memoryLruGarbageCollector`

`namedQuery`

`onSnapshot`

`onSnapshotsInSync`

`persistentLocalCache`

`persistentMultipleTabManager`

`persistentSingleTabManager`

`runTransaction`

`setDoc`

`setIndexConfiguration`

`updateDoc`

`waitForPendingWrites`

`writeBatch`