firebase-js-sdk icon indicating copy to clipboard operation
firebase-js-sdk copied to clipboard
verified publisher icon firebase

firestore: minor refactor of listener registration of "versionchange" indexedb events

Open dconeybe opened this issue 6 months ago • 4 comments

This PR modifies the SimpleDb class by deleting the setVersionChangeListener() method and replacing it with a new setDatabaseDeletedListener() method. The new method abstracts away the details of IndexedDb events and simply lets the caller get notified of the event in which it is interested, namely, impending or past deletion of the IndexedDb database.

This PR is the first step in a multi-step chain of PRs that will unify the callback for "versionchange" events with newVersion===null and detection of "clear site data" button being pressed in web browsers. The latter logic was added in PR #8871 but was problematic in at least one case (issue #9056). The ultimate goal is to provide an experimental setting with which affected customers can opt out of the drastic response of the Firestore SDK to "close" events on the IndexedDb database when it appears that such an event is in response to the "clear site data" button being clicked, which can result in corruption of the IndexedDb database if ignored.

dconeybe avatar Jun 09 '25 19:06 dconeybe

🦋 Changeset detected

Latest commit: 2d3cd31172ce9a728bf757411755d88d9cd7533a

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

changeset-bot[bot] avatar Jun 09 '25 19:06 changeset-bot[bot]

Size Report 1

Affected Products

  • @firebase/firestore

    TypeBase (b97eab3)Merge (ff8259b)Diff
    browser385 kB386 kB+627 B (+0.2%)
    main596 kB596 kB+510 B (+0.1%)
    module385 kB386 kB+627 B (+0.2%)
    react-native386 kB386 kB+627 B (+0.2%)

  • bundle

    TypeBase (b97eab3)Merge (ff8259b)Diff
    firestore (CSI Auto Indexing Disable and Delete)280 kB280 kB+566 B (+0.2%)
    firestore (CSI Auto Indexing Enable)280 kB280 kB+566 B (+0.2%)
    firestore (Persistence)311 kB311 kB+315 B (+0.1%)
    firestore (Query Cursors)256 kB256 kB+251 B (+0.1%)
    firestore (Query)254 kB254 kB+251 B (+0.1%)
    firestore (Read data once)242 kB242 kB+251 B (+0.1%)
    firestore (Read Write w Persistence)336 kB336 kB+566 B (+0.2%)
    firestore (Realtime updates)244 kB244 kB+251 B (+0.1%)
    firestore (Transaction)221 kB221 kB+251 B (+0.1%)
    firestore (Write data)220 kB221 kB+251 B (+0.1%)

  • firebase

    TypeBase (b97eab3)Merge (ff8259b)Diff
    firebase-compat.js802 kB803 kB+548 B (+0.1%)
    firebase-firestore-compat.js347 kB348 kB+548 B (+0.2%)
    firebase-firestore.js449 kB449 kB+627 B (+0.1%)

Test Logs

google-oss-bot avatar Jun 09 '25 19:06 google-oss-bot

Size Analysis Report 1

Affected Products

  • @firebase/firestore

    • addDoc

      Size

      TypeBase (b97eab3)Merge (ff8259b)Diff
      size135 kB135 kB+248 B (+0.2%)
      size-with-ext-deps207 kB207 kB+251 B (+0.1%)

    • clearIndexedDbPersistence

      Size

      TypeBase (b97eab3)Merge (ff8259b)Diff
      size25.1 kB25.6 kB+466 B (+1.9%)
      size-with-ext-deps95.5 kB96.0 kB+468 B (+0.5%)

      Dependency

      TypeBase (b97eab3)Merge (ff8259b)Diff
      functions

      16 dependencies

      __PRIVATE__fail
__PRIVATE_argToString
__PRIVATE_checkForAndReportiOSError
__PRIVATE_cloneLongPollingOptions
__PRIVATE_getAndroidVersion
__PRIVATE_getMessageOrStack
__PRIVATE_hardAssert
__PRIVATE_indexedDbStoragePrefix
__PRIVATE_isIndexedDbTransactionError
__PRIVATE_logDebug
__PRIVATE_logError
__PRIVATE_validateIsNotUsedTogether
__PRIVATE_wrapRequest
clearIndexedDbPersistence
fail
getDocument

      17 dependencies

      __PRIVATE__fail
__PRIVATE_argToString
__PRIVATE_checkForAndReportiOSError
__PRIVATE_cloneLongPollingOptions
__PRIVATE_getAndroidVersion
__PRIVATE_getMessageOrStack
__PRIVATE_hardAssert
__PRIVATE_indexedDbStoragePrefix
__PRIVATE_isIndexedDbTransactionError
__PRIVATE_logDebug
__PRIVATE_logError
__PRIVATE_logWarn
__PRIVATE_validateIsNotUsedTogether
__PRIVATE_wrapRequest
clearIndexedDbPersistence
fail
getDocument

      + __PRIVATE_logWarn

    • deleteAllPersistentCacheIndexes

      Size

      TypeBase (b97eab3)Merge (ff8259b)Diff
      size97.3 kB97.6 kB+248 B (+0.3%)
      size-with-ext-deps169 kB169 kB+251 B (+0.1%)

    • deleteDoc

      Size

      TypeBase (b97eab3)Merge (ff8259b)Diff
      size125 kB125 kB+248 B (+0.2%)
      size-with-ext-deps197 kB197 kB+251 B (+0.1%)

    • disableNetwork

      Size

      TypeBase (b97eab3)Merge (ff8259b)Diff
      size113 kB114 kB+248 B (+0.2%)
      size-with-ext-deps185 kB186 kB+251 B (+0.1%)

    • disablePersistentCacheIndexAutoCreation

      Size

      TypeBase (b97eab3)Merge (ff8259b)Diff
      size97.3 kB97.5 kB+248 B (+0.3%)
      size-with-ext-deps169 kB169 kB+251 B (+0.1%)

    • enableIndexedDbPersistence

      Size

      TypeBase (b97eab3)Merge (ff8259b)Diff
      size189 kB190 kB+314 B (+0.2%)
      size-with-ext-deps262 kB262 kB+315 B (+0.1%)

    • enableMultiTabIndexedDbPersistence

      Size

      TypeBase (b97eab3)Merge (ff8259b)Diff
      size226 kB226 kB+314 B (+0.1%)
      size-with-ext-deps298 kB298 kB+315 B (+0.1%)

    • enableNetwork

      Size

      TypeBase (b97eab3)Merge (ff8259b)Diff
      size113 kB114 kB+248 B (+0.2%)
      size-with-ext-deps185 kB186 kB+251 B (+0.1%)

    • enablePersistentCacheIndexAutoCreation

      Size

      TypeBase (b97eab3)Merge (ff8259b)Diff
      size97.3 kB97.5 kB+248 B (+0.3%)
      size-with-ext-deps169 kB169 kB+251 B (+0.1%)

    • executeWrite

      Size

      TypeBase (b97eab3)Merge (ff8259b)Diff
      size124 kB124 kB+248 B (+0.2%)
      size-with-ext-deps196 kB196 kB+251 B (+0.1%)

    • getAggregateFromServer

      Size

      TypeBase (b97eab3)Merge (ff8259b)Diff
      size121 kB121 kB+248 B (+0.2%)
      size-with-ext-deps193 kB193 kB+251 B (+0.1%)

    • getCountFromServer

      Size

      TypeBase (b97eab3)Merge (ff8259b)Diff
      size121 kB122 kB+248 B (+0.2%)
      size-with-ext-deps193 kB193 kB+251 B (+0.1%)

    • getDoc

      Size

      TypeBase (b97eab3)Merge (ff8259b)Diff
      size156 kB156 kB+248 B (+0.2%)
      size-with-ext-deps228 kB228 kB+251 B (+0.1%)

    • getDocFromCache

      Size

      TypeBase (b97eab3)Merge (ff8259b)Diff
      size105 kB105 kB+248 B (+0.2%)
      size-with-ext-deps177 kB177 kB+251 B (+0.1%)

    • getDocFromServer

      Size

      TypeBase (b97eab3)Merge (ff8259b)Diff
      size156 kB156 kB+248 B (+0.2%)
      size-with-ext-deps228 kB228 kB+251 B (+0.1%)

    • getDocs

      Size

      TypeBase (b97eab3)Merge (ff8259b)Diff
      size157 kB158 kB+248 B (+0.2%)
      size-with-ext-deps229 kB230 kB+251 B (+0.1%)

    • getDocsFromCache

      Size

      TypeBase (b97eab3)Merge (ff8259b)Diff
      size113 kB113 kB+248 B (+0.2%)
      size-with-ext-deps185 kB185 kB+251 B (+0.1%)

    • getDocsFromServer

      Size

      TypeBase (b97eab3)Merge (ff8259b)Diff
      size157 kB157 kB+248 B (+0.2%)
      size-with-ext-deps229 kB229 kB+251 B (+0.1%)

    • loadBundle

      Size

      TypeBase (b97eab3)Merge (ff8259b)Diff
      size123 kB123 kB+248 B (+0.2%)
      size-with-ext-deps195 kB195 kB+251 B (+0.1%)

    • namedQuery

      Size

      TypeBase (b97eab3)Merge (ff8259b)Diff
      size98.2 kB98.4 kB+248 B (+0.3%)
      size-with-ext-deps170 kB170 kB+251 B (+0.1%)

    • onSnapshot

      Size

      TypeBase (b97eab3)Merge (ff8259b)Diff
      size158 kB158 kB+248 B (+0.2%)
      size-with-ext-deps230 kB230 kB+251 B (+0.1%)

    • onSnapshotsInSync

      Size

      TypeBase (b97eab3)Merge (ff8259b)Diff
      size147 kB147 kB+248 B (+0.2%)
      size-with-ext-deps219 kB219 kB+251 B (+0.1%)

    • persistentLocalCache

      Size

      TypeBase (b97eab3)Merge (ff8259b)Diff
      size185 kB186 kB+314 B (+0.2%)
      size-with-ext-deps258 kB258 kB+315 B (+0.1%)

    • persistentMultipleTabManager

      Size

      TypeBase (b97eab3)Merge (ff8259b)Diff
      size221 kB222 kB+314 B (+0.1%)
      size-with-ext-deps293 kB294 kB+315 B (+0.1%)

    • persistentSingleTabManager

      Size

      TypeBase (b97eab3)Merge (ff8259b)Diff
      size185 kB185 kB+314 B (+0.2%)
      size-with-ext-deps257 kB258 kB+315 B (+0.1%)

    • runTransaction

      Size

      TypeBase (b97eab3)Merge (ff8259b)Diff
      size135 kB135 kB+248 B (+0.2%)
      size-with-ext-deps207 kB207 kB+251 B (+0.1%)

    • setDoc

      Size

      TypeBase (b97eab3)Merge (ff8259b)Diff
      size134 kB134 kB+248 B (+0.2%)
      size-with-ext-deps206 kB206 kB+251 B (+0.1%)

    • setIndexConfiguration

      Size

      TypeBase (b97eab3)Merge (ff8259b)Diff
      size101 kB101 kB+248 B (+0.2%)
      size-with-ext-deps172 kB173 kB+251 B (+0.1%)

    • updateDoc

      Size

      TypeBase (b97eab3)Merge (ff8259b)Diff
      size134 kB135 kB+248 B (+0.2%)
      size-with-ext-deps206 kB207 kB+251 B (+0.1%)

    • waitForPendingWrites

      Size

      TypeBase (b97eab3)Merge (ff8259b)Diff
      size114 kB114 kB+248 B (+0.2%)
      size-with-ext-deps186 kB186 kB+251 B (+0.1%)

    • writeBatch

      Size

      TypeBase (b97eab3)Merge (ff8259b)Diff
      size136 kB137 kB+248 B (+0.2%)
      size-with-ext-deps208 kB209 kB+251 B (+0.1%)

Test Logs

google-oss-bot avatar Jun 09 '25 20:06 google-oss-bot

It looks like setVersionChangeListener was only ever used in the context of db deletion. I wonder if there will be a scenario in the future where an actual version change callback will be needed? If it does happen, we'll just have to bring back the setVersionChangeListener function.

Yeah for sure. It seems unlikely IMO since it's been this way for years and years! But we can definitely always add it back. Thanks for the review!

dconeybe avatar Jun 20 '25 21:06 dconeybe