Skip to content

feat: add visibilitychange probe for proactive IDB health check#798

Draft
elirangoshen wants to merge 10 commits into
Expensify:mainfrom
callstack-internal:fix/idb-visibilitychange-probe-v2
Draft

feat: add visibilitychange probe for proactive IDB health check#798
elirangoshen wants to merge 10 commits into
Expensify:mainfrom
callstack-internal:fix/idb-visibilitychange-probe-v2

Conversation

@elirangoshen
Copy link
Copy Markdown
Contributor

@elirangoshen elirangoshen commented Jun 5, 2026

Details

Adds a proactive visibilitychange probe to the IDB connection manager, building on the reactive heal mechanism from #780.

Problem: Safari kills IDB connections for backgrounded tabs (WebKit #197050, #201483). When the user returns to the tab, the burst of writes on reconnect hits the dead cached dbp — every write fails before the reactive heal can kick in.

Solution: Register a visibilitychange listener inside createStore() that runs a lightweight readonly count() probe when the tab becomes visible. If the probe detects a dead IDB connection, it drops the stale dbp before the write burst arrives, so the first real operation opens a fresh connection.

What it does:

  • isStaleConnectionError() — union detector for all three stale connection error types (InvalidStateError, backing store corruption, connection lost)
  • visibilitychange listener with a probePromise guard — prevents a stale probe from clearing a dbp that was already replaced by a concurrent heal/retry
  • Classified req.onerror — only drops dbp for actual stale connection errors, not unrelated IDB errors
  • Diagnostic logging: logInfo on probe start ("tab became visible, checking connection health") and healthy result ("connection is healthy"); logAlert on stale detection ("stale connection detected, dropping cached connection") with the error message

Related Issues

Expensify/App#87864

Linked E/App PR

Expensify/App#92762

Automated Tests

4 new tests in tests/unit/storage/providers/createStoreTest.ts, in the describe('visibilitychange probe') block:

  • probe detects a dead connection and drops dbp
  • probe is skipped when no dbp exists yet
  • healthy connection is preserved
  • InvalidStateError synchronous throw is handled

All tests pass (npx jest tests/unit/storage/providers/createStoreTest.ts → 23 passed).

Manual Tests

Simulating Safari connection lost:

  1. Open the app in Safari, log in
  2. Switch to a different tab and wait 30+ seconds (Safari may kill IDB connections for backgrounded tabs)
  3. Switch back to the tab
  4. Verify in console: IDB visibilitychange probe: stale connection detected, dropping cached connection appears (if Safari killed the connection)
  5. Interact with the app — it should recover seamlessly

Author Checklist

  • I linked the correct issue in the ### Related Issues section above
  • I linked the corresponding Expensify/App PR in the ### Linked E/App PR section above, and verified this change against it (E/App CI passed and manual testing completed)
  • I wrote clear testing steps that cover the changes made in this PR
    • I added steps for local testing in the Tests section
    • I tested this PR with a High Traffic account against the staging or production API to ensure there are no regressions (e.g. long loading states that impact usability).
  • I included screenshots or videos for tests on all platforms
  • I ran the tests on all platforms & verified they passed on:
    • Android / native
    • Android / Chrome
    • iOS / native
    • iOS / Safari
    • MacOS / Chrome / Safari
  • I verified there are no console errors (if there's a console error not related to the PR, report it or open an issue for it to be fixed)
  • I followed proper code patterns (see Reviewing the code)
    • I verified that any callback methods that were added or modified are named for what the method does and never what callback they handle (i.e. toggleReport and not onIconClick)
    • I verified that the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
    • I verified that comments were added to code that is not self explanatory
    • I verified that any new or modified comments were clear, correct English, and explained "why" the code was doing something instead of only explaining "what" the code was doing.
    • I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named "index.js". All platform-specific files are named for the platform the code supports as outlined in the README.
    • I verified the JSDocs style guidelines (in STYLE.md) were followed
  • If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
  • I followed the guidelines as stated in the Review Guidelines
  • I tested other components that can be impacted by my changes (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar are working as expected)
  • I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
  • I verified any variables that can be defined as constants (ie. in CONST.js or at the top of the file that uses the constant) are defined as such
  • I verified that if a function's arguments changed that all usages have also been updated correctly
  • If a new component is created I verified that:
    • A similar component doesn't exist in the codebase
    • All props are defined accurately and each prop has a /** comment above it */
    • The file is named correctly
    • The component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone
    • The only data being stored in the state is data necessary for rendering and nothing else
    • If we are not using the full Onyx data that we loaded, I've added the proper selector in order to ensure the component only re-renders when the data it is using changes
    • For Class Components, any internal methods passed to components event handlers are bound to this properly so there are no scoping issues (i.e. for onClick={this.submit} the method this.submit should be bound to this in the constructor)
    • Any internal methods bound to this are necessary to be bound (i.e. avoid this.submit = this.submit.bind(this); if this.submit is never passed to a component event handler like onClick)
    • All JSX used for rendering exists in the render method
    • The component has the minimum amount of code necessary for its purpose, and it is broken down into smaller components in order to separate concerns and functions
  • If any new file was added I verified that:
    • The file has a description of what it does and/or why is needed at the top of the file if the code is not self explanatory
  • If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like Avatar is modified, I verified that Avatar is working as expected in all cases)
  • If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.
  • I have checked off every checkbox in the PR author checklist, including those that don't apply to this PR.

Screenshots/Videos

Android: Native

N/A — library-level change, IDB is web-only. No UI, no native code touched.

Android: mWeb Chrome

N/A — library-level change, IDB is web-only. No UI, no native code touched.

iOS: Native

N/A — library-level change, IDB is web-only. No UI, no native code touched.

iOS: mWeb Safari

ADD_IOS_MWEB_SAFARI_RECORDING

MacOS: Chrome / Safari

Healed (simulated error):

healed.mov

Killed connection (simulated error):

killed.mp4

Exhausted (simulated error):

exhausted.mov

Healed (simulated on Safari):

safari_error.mp4

Killed connection (simulated on Safari):

safari_killed.mp4

Exhausted (simulated on Safari):

safari_exhausted.mp4

Healed offline (simulated on Chrome):

offline.mp4

leshniak and others added 9 commits May 26, 2026 14:29
Register a visibilitychange listener inside createStore() that runs a
lightweight readonly probe when the tab returns to foreground. If the
probe detects a dead IDB connection (connection lost, backing store
error, or InvalidStateError), it drops the cached dbp so the next real
operation opens a fresh connection instead of failing.

This prevents the ReconnectApp write storm from hitting a dead IDB
connection after Safari backgrounds a tab.

Addresses Expensify/App#87864.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
- Probe start: logInfo when tab becomes visible and probe begins
- Probe healthy: logInfo confirming connection is healthy
- Probe stale: logAlert with error details when stale connection detected
- Heal attempts/success/exhaustion/non-recoverable: same as Expensify#780
- Updated test assertions to match new log messages and levels

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
The "connection is healthy" log was emitted synchronously after
count(), before the IDB request completed. If the request later
failed via onerror, both healthy and stale logs would fire for
the same visibility event. Now only logs on actual success.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
In some environments DOMException does not inherit from Error.
Use (error instanceof Error || error instanceof DOMException) for all
three detection functions to avoid missing IDB errors in those envs.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Avoid silently mislabeling future error categories as connection lost.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
…-internal/react-native-onyx into fix/idb-visibilitychange-probe
- Remove the `typeof document !== 'undefined'` guard; IDBKeyValProvider
  runs on web only, where document is always defined.
- Drop the App-specific "ReconnectApp" reference from the probe comment.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@elirangoshen elirangoshen changed the title [HOLD] feat: add visibilitychange probe for proactive IDB health check feat: add visibilitychange probe for proactive IDB health check Jun 5, 2026
elirangoshen added a commit to callstack-internal/Expensify-App that referenced this pull request Jun 5, 2026
Pins onyx to callstack-internal/react-native-onyx@e3a8cc5d (Expensify/react-native-onyx#798)
so E/App CI runs the full suite against the proactive IDB visibilitychange probe change.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
The visibilitychange probe adds a separate .then branch off the cached
open promise. If the tab becomes visible while dbp is still a pending
indexedDB.open() that later rejects, that branch rejected with no handler,
surfacing an unhandled rejection on foregrounding. Add a .catch on the
probe chain (cacheOpenPromise already clears dbp on its own branch).

Addresses PR Expensify#788 review (chatgpt-codex-connector).

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@elirangoshen
Copy link
Copy Markdown
Contributor Author

@codex review

elirangoshen added a commit to callstack-internal/Expensify-App that referenced this pull request Jun 5, 2026
Pins onyx to callstack-internal/react-native-onyx@7ac9c50a (Expensify/react-native-onyx#798)
so E/App CI runs the full suite against the proactive IDB visibilitychange probe change.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Copy link
Copy Markdown

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 7ac9c50ac0

ℹ️ About Codex in GitHub

Codex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".

// Safari kills IDB connections for backgrounded tabs. By probing as soon as
// the tab becomes visible, we drop the stale dbp early so the first real
// operation opens a fresh connection instead of failing.
document.addEventListener('visibilitychange', () => {
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Guard visibility listener outside document contexts

In non-window browser contexts that still support IndexedDB, such as Web Workers/service workers, document is undefined while indexedDB is available (MDN documents WorkerGlobalScope.indexedDB: https://developer.mozilla.org/en-US/docs/Web/API/WorkerGlobalScope/indexedDB). Because createStore() now touches document during initialization, Onyx.init() throws before the store can be created in those contexts, whereas the previous implementation could use IndexedDB there. Wrap this listener setup in a typeof document !== 'undefined' check so worker-based consumers keep working and only window tabs install the foreground probe.

Useful? React with 👍 / 👎.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

its only run in web and we had this change before and we reverted it

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants