[HOLD] feat: add visibilitychange probe for proactive IDB health check#788
[HOLD] feat: add visibilitychange probe for proactive IDB health check#788leshniak wants to merge 9 commits into
Conversation
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>
bcd1f6e to
b63de8b
Compare
There was a problem hiding this comment.
💡 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) => { |
There was a problem hiding this comment.
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 👍 / 👎.
There was a problem hiding this comment.
@elirangoshen have you checked this comment? Is it still relevant?
|
hold for my review 🙏 |
|
@fabioh8010 agree - updated. |
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>
…al' into fix/idb-visibilitychange-probe
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
left a comment
There was a problem hiding this comment.
@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') { |
There was a problem hiding this comment.
Why do we need to have this condition? As IDB is used in web platforms only this is supposed to be always defined, right?
| // 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. |
There was a problem hiding this comment.
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>
|
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. Its in draft now and i'm working to make it ready soon. |
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>
|
@arosiclair Could you close this PR? Explanation here. |
Details
HOLD until #780 will be merged
Adds a proactive
visibilitychangeprobe 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
visibilitychangelistener insidecreateStore()that runs a lightweight readonlycount()probe when the tab becomes visible. If the probe detects a dead IDB connection, it drops the staledbpbefore 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)visibilitychangelistener withprobePromiseguard — prevents stale probe from clearing adbpthat was already replaced by a concurrent heal/retryreq.onerror— only dropsdbpfor actual stale connection errors, not unrelated IDB errorslogInfoon probe start ("tab became visible, checking connection health") and healthy result ("connection is healthy");logAlerton stale detection ("stale connection detected, dropping cached connection") with error messagetypeof document !== 'undefined'for SSR/Node safetyDepends 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:
IDB visibilitychange probe: stale connection detected, dropping cached connectionappears (if Safari killed the connection)Author Checklist
### Related Issuessection aboveTestssectiontoggleReportand notonIconClick)myBool && <MyComponent />.STYLE.md) were followedAvatar, I verified the components usingAvatarare working as expected)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