Repository navigation
[NoQA] Guard PERSISTED_ONGOING_REQUESTS callback against own-write stale overwrites - #91166
Conversation
…rwrites The PERSISTED_ONGOING_REQUESTS Onyx callback unconditionally overwrote the in-memory ongoingRequest with whatever value Onyx delivered. When multiple Onyx writes to this key happened in quick succession during queue processing (processNextPersistedRequest, updateOngoingRequest, endRequestAndRemoveFromQueue), out-of-order callback delivery could resurrect a stale truthy ongoingRequest after it had already been cleared — triggering a spurious flush() via triggerInitializationCallback() and causing a 3rd fetch in MiddlewareTest. Add a pendingOwnOngoingRequestWrites counter that is incremented synchronously before each own write and decremented when the write promise settles. The callback now skips when this counter is > 0 (own-write in flight), preserving the authoritative in-memory state while still allowing external writes (crash recovery, cross-tab) to update ongoingRequest when the counter is 0. Co-authored-by: dmkt9 <dmkt9@users.noreply.github.com>
|
Can you finalize this one when you get a moment please @dmkt9 |
|
I am working on this now. |
|
@MelvinBot update your checklist:
|
|
✅ Done! Updated the PR:
|
|
All checks on this PR are currently passing — there are no failing checks to fix. Every required check (ESLint, Prettier, typecheck, all 8 test jobs, builds, CLA, perf-tests, etc.) shows as If you were seeing failures earlier, they may have been transient/flaky and have since resolved on re-run. |
|
@MelvinBot mark as ready |
|
✅ PR marked as ready for review. |
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 235263c6f4
ℹ️ 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".
| persistedRequests = []; | ||
| pendingSaveOperations = []; | ||
| knownRequestIDs.clear(); | ||
| pendingOwnOngoingRequestWrites = 0; |
There was a problem hiding this comment.
Avoid resetting own-write counter during clear()
clear() now force-resets pendingOwnOngoingRequestWrites to 0, but this function is used in production sign-out flow (src/libs/actions/Session/index.ts, cleanupSession). If there are in-flight Onyx.set/multiSet writes when clear() runs, their .finally() handlers still decrement afterward, driving the counter negative; subsequent single writes then toggle between -1 and 0, so the pendingOwnOngoingRequestWrites > 0 guard in the PERSISTED_ONGOING_REQUESTS callback no longer activates. This re-opens stale own-write overwrites of ongoingRequest after sign-out/relogin and can retrigger duplicate queue flushes.
Useful? React with 👍 / 👎.
There was a problem hiding this comment.
Good catch — clear() is indeed called in production during sign-out (cleanupSession), so in-flight .finally() handlers can drive the counter negative after the reset.
Fixed in 509ffc2 by clamping all decrements: pendingOwnOngoingRequestWrites = Math.max(0, pendingOwnOngoingRequestWrites - 1) across all 6 .finally() handlers in PersistedRequests.ts. All existing tests pass.
|
The only failing check is All code checks are passing: tests (jobs 1–8), typecheck, ESLint, Prettier, builds, perf-tests, Storybook, CLA, and codecov. No code fix is needed here. Please complete the author checklist to resolve the failing check. |
Reviewer Checklist
Screenshots/VideosAndroid: HybridAppAndroid: mWeb ChromeiOS: HybridAppiOS: mWeb SafariMacOS: Chrome / Safari |
…ounter clear() resets pendingOwnOngoingRequestWrites to 0 during sign-out, but in-flight Onyx write .finally() handlers can still fire afterwards and decrement the counter below zero. This breaks the > 0 guard in the PERSISTED_ONGOING_REQUESTS callback after re-login, re-opening the stale own-write overwrite bug. Co-authored-by: dmkt9 <dmkt9@users.noreply.github.com>
|
@marcochavezf Please copy/paste the Reviewer Checklist from here into a new comment on this PR and complete it. If you have the K2 extension, you can simply click: [this button] |
|
Done — removed all All 45 tests pass (PersistedRequests, MiddlewareTest, SequentialQueueTest, LoggingMiddlewareTest, LoadTestMiddlewareTest). |
|
MelvinBot has made 5 consecutive commits trying to fix CI failures. Automatic CI fix dispatches are now paused for this PR. Next steps: A human should review the recent commits and resolve the conflicting CI errors manually. |
|
@MelvinBot update the |
|
Updated the Explanation of Change section to reflect the current implementation: replaced the |
|
@OlimpiaZurek When you get a chance, could you please take a look at this? Thank you. |
|
In general this should be low harm, I'm just generally concerned we do not have SQ's logic and implementation documented well (so it's harded to evaluate such PRs), but this is a separate topic I want to tackle now and mentioned in Slack. This looks like a true bug in rare cases so it's a 🟢 . |
Reviewer Checklist
Screenshots/VideosAndroid: HybridAppAndroid: mWeb ChromeiOS: HybridAppiOS: mWeb SafariMacOS: Chrome / Safari |
mountiny
left a comment
There was a problem hiding this comment.
Reviewer Checklist
- I have verified the author checklist is complete (all boxes are checked off).
- I verified the correct issue is linked in the
### Fixed Issuessection above - I verified testing steps are clear and they cover the changes made in this PR
- I verified the steps for local testing are in the
Testssection - I verified the steps for Staging and/or Production testing are in the
QA stepssection - I verified the steps cover any possible failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
- I turned off my network connection and tested it while offline to ensure it matches the expected behavior (i.e. verify the default avatar icon is displayed if app is offline)
- I verified the steps for local testing are in the
- I checked that screenshots or videos are included for tests on all platforms
- I included screenshots or videos for tests on all platforms
- I verified that the composer does not automatically focus or open the keyboard on mobile unless explicitly intended. This includes checking that returning the app from the background does not unexpectedly open the keyboard.
- I verified tests pass on all platforms & I tested again on:
- Android: HybridApp
- Android: mWeb Chrome
- iOS: HybridApp
- iOS: mWeb Safari
- MacOS: Chrome / Safari
- If there are any errors in the console that are unrelated to this PR, I either fixed them (preferred) or linked to where I reported them in Slack
- I verified proper code patterns were followed (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.
toggleReportand notonIconClick). - 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 any copy / text shown in the product is localized by adding it to
src/languages/*files and using the translation method - I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
- I verified any copy / text that was added to the app is grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
- 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
- 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.
- If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
- I verified that this PR follows the guidelines as stated in the Review Guidelines
- I verified other components that can be impacted by these changes have been tested, and I retested again (i.e. if the PR modifies a shared library or component like
Avatar, I verified the components usingAvatarhave been tested & I retested again) - 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.ts or at the top of the file that uses the constant) are defined as such
- 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
- For Class Components, any internal methods passed to components event handlers are bound to
thisproperly so there are no scoping issues (i.e. foronClick={this.submit}the methodthis.submitshould be bound tothisin the constructor) - Any internal methods bound to
thisare necessary to be bound (i.e. avoidthis.submit = this.submit.bind(this);ifthis.submitis never passed to a component event handler likeonClick) - 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 a new CSS style is added I verified that:
- A similar style doesn't already exist
- The style can't be created with an existing StyleUtils function (i.e.
StyleUtils.getBackgroundAndBorderStyle(theme.componentBG)
- If the PR modifies code that runs when editing or sending messages, I tested and verified there is no unexpected behavior for all supported markdown - URLs, single line code, code blocks, quotes, headings, bold, strikethrough, and italic.
- 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
Avataris modified, I verified thatAvataris working as expected in all cases) - If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.
- If the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
- If the PR modifies the UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
- I verified that all the inputs inside a form are aligned with each other.
- I added
Designlabel and/or tagged@Expensify/designso the design team can review the changes.
- If a new page is added, I verified it's using the
ScrollViewcomponent to make it scrollable when more elements are added to the page. - For any bug fix or new feature in this PR, I verified that sufficient unit tests are included to prevent regressions in this flow.
- If the
mainbranch was merged into this PR after a review, I tested again and verified the outcome was still expected according to theTeststeps. - I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.
Screenshots/Videos
Android: HybridApp
Android: mWeb Chrome
iOS: HybridApp
iOS: mWeb Safari
MacOS: Chrome / Safari
|
@mountiny looks like this was merged without a test passing. Please add a note explaining why this was done and remove the |
|
🚧 @mountiny has triggered a test Expensify/App build. You can view the workflow run here. |
|
🧪🧪 Use the links below to test this adhoc build on Android, iOS, and Web. Happy testing! 🧪🧪
|
|
🚀 Deployed to staging by https://github.com/mountiny in version: 9.3.91-0 🚀
Bundle Size Analysis (Sentry): |
Help site review: no changes requiredI reviewed the changes in this PR and no updates to the help site ( Why: This is a purely internal fix to the request-queue plumbing. It adds a I also searched @dmkt9, since no help site changes are required, no linked docs PR was created. Please confirm this assessment matches the current behavior; if you believe a help article is affected, let me know which one and I'll draft the update. |
|
🚀 Deployed to staging by https://github.com/mountiny in version: 9.3.94-0 🚀
Bundle Size Analysis (Sentry): |
Help site review: no documentation changes requiredI reviewed the changes in this PR and no updates to the help site ( Why: This is a purely internal bug fix in the request-queue / Onyx persistence layer with no customer-facing impact:
There is no new or changed UI, feature, setting, label, button, workflow, billing, or integration behavior here. The PR is also marked @dmkt9, no help site PR was created because this change has no user-facing behavior to document. If you believe a specific article is affected, let me know which one and I'll take another look. |
|
🚀 Deployed to production by https://github.com/luacmartins in version: 9.3.94-0 🚀
|
Explanation of Change
The
PERSISTED_ONGOING_REQUESTSOnyx callback unconditionally overwrote the in-memoryongoingRequestwith whatever value Onyx delivered. When multiple Onyx writes to this key happened in quick succession during queue processing (processNextPersistedRequest,updateOngoingRequest,endRequestAndRemoveFromQueue), out-of-order callback delivery could resurrect a stale truthyongoingRequestafter it had already been cleared — triggering a spuriousflush()viatriggerInitializationCallback()and causing a 3rd fetch.This adds a
knownOngoingRequestIDsset (mirroring the existingknownRequestIDspattern forPERSISTED_REQUESTS) that tracks therequestIDof every ongoing request this tab has processed. ThePERSISTED_ONGOING_REQUESTScallback now checks incoming values against this set and returns early — before updating the in-memoryongoingRequest— when the value is an own-write echo. This prevents stale serialized copies from polluting the in-memory state thatgetPersistedOngoingRequest()returns, while still allowing genuine cross-tab and crash-recovery updates through.Fixed Issues
$ #90660
PROPOSAL: #90660 (comment)
Tests
N/A
Offline tests
Same as Tests
QA Steps
Same as Tests
PR Author Checklist
### Fixed Issuessection aboveTestssectionOffline stepssectionQA stepssectiontoggleReportand notonIconClick)src/languages/*files and using the translation methodSTYLE.md) were followedAvatar, I verified the components usingAvatarare working as expected)StyleUtils.getBackgroundAndBorderStyle(theme.componentBG))npm run compress-svg)Avataris modified, I verified thatAvataris working as expected in all cases)Designlabel and/or tagged@Expensify/designso the design team can review the changes.ScrollViewcomponent to make it scrollable when more elements are added to the page.mainbranch was merged into this PR after a review, I tested again and verified the outcome was still expected according to theTeststeps.AI Tests
tests/unit/MiddlewareTest.tstests/unit/SequentialQueueTest.tstests/unit/PersistedRequests.tstests/unit/LoggingMiddlewareTest.tstests/unit/LoadTestMiddlewareTest.tsnpm run typechecknpm run prettierScreenshots/Videos
Android: Native
Android: mWeb Chrome
iOS: Native
iOS: mWeb Safari
MacOS: Chrome / Safari