Skip to content

[HOLD] feat: add visibilitychange probe for proactive IDB health check#788

Closed
leshniak wants to merge 9 commits into
Expensify:mainfrom
callstack-internal:fix/idb-visibilitychange-probe
Closed

[HOLD] feat: add visibilitychange probe for proactive IDB health check#788
leshniak wants to merge 9 commits into
Expensify:mainfrom
callstack-internal:fix/idb-visibilitychange-probe

Conversation

@leshniak

@leshniak leshniak commented May 20, 2026

Copy link
Copy Markdown
Contributor

Details

HOLD until #780 will be merged

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 Expensify tab, the app fires a ReconnectApp write storm that 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 storm 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 probePromise guard — prevents 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 error message
  • Guarded by typeof document !== 'undefined' for SSR/Node safety

Depends on: #780 (reactive heal mechanism)

Related Issues

Expensify/App#87864

Automated Tests

4 new tests in tests/unit/storage/providers/createStoreTest.ts:

Visibilitychange probe (4): probe detects dead connection + drops dbp, skipped when no dbp, healthy connection preserved, InvalidStateError sync throw handled

All 456 tests pass.

Manual Test Steps

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 Expensify 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 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

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

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

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 3 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>
@leshniak leshniak force-pushed the fix/idb-visibilitychange-probe branch from bcd1f6e to b63de8b Compare May 26, 2026 13:07
@leshniak leshniak marked this pull request as ready for review May 27, 2026 08:02
@leshniak leshniak requested a review from a team as a code owner May 27, 2026 08:02
@melvin-bot melvin-bot Bot requested review from arosiclair and removed request for a team May 27, 2026 08:03

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

Copy link
Copy Markdown

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: b63de8b399

ℹ️ 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".

throw error;
};

probePromise.then((db) => {

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 Handle probe promise rejections

When the tab becomes visible while dbp is still a pending indexedDB.open() and that open later rejects (for example with the same backing-store or connection-lost errors handled below), this separate probePromise.then(...) chain rejects without any rejection handler. The original store operation may catch its own chain, but the promise returned by this then is ignored, so browsers can emit an unhandled rejection during foregrounding; add a rejection handler/catch for the probe path.

Useful? React with 👍 / 👎.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

@elirangoshen have you checked this comment? Is it still relevant?

@fabioh8010

Copy link
Copy Markdown
Contributor

hold for my review 🙏

@fabioh8010

Copy link
Copy Markdown
Contributor

@leshniak This PR seem to have many of the changes from #780, I think it's best to put this one on HOLD until that PR is merged, will facilitate review.

@leshniak leshniak changed the title feat: add visibilitychange probe for proactive IDB health check [HOLD] feat: add visibilitychange probe for proactive IDB health check May 28, 2026
@leshniak

Copy link
Copy Markdown
Contributor Author

@fabioh8010 agree - updated.

leshniak and others added 5 commits May 29, 2026 12:18
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

@fabioh8010 fabioh8010 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

@elirangoshen let's double check the test steps/screen recordings again, and please add for iOS: mWeb Safari too.
If you can't edit the PR body feel free to close this one and open another one by yourself as author

// Safari kills IDB connections for backgrounded tabs. By probing before
// the ReconnectApp write storm hits, we drop the stale dbp early so the
// first real operation opens a fresh connection instead of failing.
if (typeof document !== 'undefined') {

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Why do we need to have this condition? As IDB is used in web platforms only this is supposed to be always defined, right?

Comment on lines +135 to +138
// Proactive IDB health check when tab returns to foreground.
// Safari kills IDB connections for backgrounded tabs. By probing before
// the ReconnectApp write storm hits, we drop the stale dbp early so the
// first real operation opens a fresh connection instead of failing.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Remove mentions of ReconnectApp

- 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 commented Jun 5, 2026

Copy link
Copy Markdown
Contributor

Closing in favor of a new PR opened by me as author (per @fabioh8010's suggestion, since I couldn't edit this PR's body). The new PR carries the full template checklist + the requested review changes.

#798

Its in draft now and i'm working to make it ready soon.

elirangoshen added a commit to callstack-internal/react-native-onyx that referenced this pull request Jun 5, 2026
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>
@fabioh8010

Copy link
Copy Markdown
Contributor

@arosiclair Could you close this PR? Explanation here.

@arosiclair arosiclair closed this Jun 8, 2026
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.

4 participants