Skip to content

Fixed race conditions and redundant writes in OnyxDerived initialisation - #82161

Merged
mountiny merged 4 commits into
Expensify:mainfrom
shubham1206agra:test-change
Feb 25, 2026
Merged

mountiny merged 4 commits into
Expensify:mainfrom
shubham1206agra:test-change

Conversation

@shubham1206agra

@shubham1206agra shubham1206agra commented Feb 11, 2026 •

Copy link
Copy Markdown
Contributor

Explanation of Change

Fixed Issues

$ #83426

Tests

  1. Open App
  2. Verify that the report names in LHN and report header is correct.
  3. Go to Reports tab.
  4. Verify that all ToDo sections data is correct.
  • Verify that no errors appear in the JS console

Offline tests

Same as Tests

QA Steps

Same as Tests

PR Author Checklist

  • I linked the correct issue in the ### Fixed 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 added steps for the expected offline behavior in the Offline steps section
    • I added steps for Staging and/or Production testing in the QA steps section
    • I added steps to cover 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 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: mWeb Chrome
    • iOS: Native
    • iOS: mWeb 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 verified there are no new alerts related to the canBeMissing param for useOnyx
  • 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 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
      • If any non-english text was added/modified, I used JaimeGPT to get English > Spanish translation. I then posted it in #expensify-open-source and it was approved by an internal Expensify engineer. Link to Slack message:
    • 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
  • 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.ts 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 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 new assets were added or existing ones were modified, I verified that:
    • The assets are optimized and compressed (for SVG files, run npm run compress-svg)
    • The assets load correctly across all supported platforms.
  • 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 Avatar is modified, I verified that Avatar is 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 Design label and/or tagged @Expensify/design so the design team can review the changes.
  • If a new page is added, I verified it's using the ScrollView component to make it scrollable when more elements are added to the page.
  • I added unit tests for any new feature or bug fix in this PR to help automatically prevent regressions in this user flow.
  • 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.

Screenshots/Videos

Screen.Recording.2026-02-25.at.3.49.16.PM.mov

@fabioh8010

Copy link
Copy Markdown
Contributor

@shubham1206agra Could you check if these concerns/follow-ups raised by Claude make sense?


Proposal Review: Fix race conditions in OnyxDerived initialisation

Context

This is a review of a proposal (with draft PR #82161) that claims to fix race conditions in OnyxDerived/index.ts during app startup. The proposal identifies three bugs in the current initialization flow and proposes two changes: removing tupleGet and deferring Onyx.set until all connections are established.

Key files examined:

  • src/libs/actions/OnyxDerived/index.ts (the initialization logic)
  • src/libs/actions/OnyxDerived/configs/reportAttributes.ts (most complex derived config, 10 dependencies)

Verdict: The proposal is technically sound

All three problems identified are real and verifiable in the source code. The proposed solutions are correct. Below is a detailed breakdown.


Problem 1: tupleGet computes with uninitialised data — CONFIRMED

Claim: tupleGet callback calls compute(dependencyValues, ...) before assigning dependencyValues = values, so the initial computation always runs on an array of undefined values.

Verification (index.ts lines 38-48):

OnyxUtils.tupleGet(dependencies).then((values) => {
    // ...
    derivedValue = compute(dependencyValues, initialContext);  // <-- uses EMPTY array
    dependencyValues = values;                                  // <-- assignment AFTER compute
    setDerivedValue(key, derivedValue ?? null);
});

This is clearly a bug — the compute runs against new Array(totalConnections) (all undefined), NOT against values. Furthermore, the context passes areAllConnectionsSet: false, so configs like reportAttributes short-circuit to {reports: {}, locale: null}. The entire tupleGet path produces useless output.

Problem 2: tupleGet overwrites fresher connection data — CONFIRMED

Claim: Connection callbacks can fire before tupleGet resolves, writing values to dependencyValues[i]. When tupleGet resolves, dependencyValues = values replaces the entire array reference, discarding fresher values.

Verification: dependencyValues is declared with let (line 31). setDependencyValue captures it via closure (line 52). After dependencyValues = values on line 46, any previously written connection values are lost because they were in the old array. This is a real race condition, though in practice both paths read from the same Onyx storage so the values are similar.

Problem 3: Disk-cached value immediately overwritten — CONFIRMED

Claim: When a valid derived value is restored from disk, the subsequent connection callbacks still call recomputeDerivedValue, which computes with areAllConnectionsSet: false and overwrites the cached value with empty defaults.

Verification: When storedDerivedValue is truthy (line 35), the code skips tupleGet but still sets up all connection listeners (lines 91-137). Each listener calls recomputeDerivedValue. Until all N connections have fired, areAllConnectionsSet is false, so reportAttributes.compute returns {reports: {}, locale: null}, and setDerivedValue writes this empty default to Onyx — overwriting the valid cached value. This happens N-1 times before the last connection sets the flag.


Solution Assessment

Remove tupleGet — Correct

Given that:

  • It computes with empty data (bug in argument order)
  • It creates a race condition by reassigning the array reference
  • It's redundant since connections already populate values incrementally

Removal is the right call. The let → const change for dependencyValues is also correct since the only reassignment was in the removed block.

Defer Onyx.set until all connections are established — Correct

The early return in recomputeDerivedValue:

if (!areAllConnectionsSet) {
    return;  // dependency values still accumulate via setDependencyValue
}

This is placed after checkAndMarkConnectionInitialized (so connection tracking still works) and connection callbacks still call setDependencyValue before recomputeDerivedValue (so values accumulate correctly). Only computation and Onyx writes are deferred.

This fixes:

  • Disk-cached values no longer overwritten with empty defaults
  • N-1 unnecessary Onyx.set calls eliminated per derived key
  • No partial-data computations

Concerns / Follow-up items

1. areAllConnectionsSet becomes dead code in compute functions

After this change, compute is only ever called when areAllConnectionsSet === true. The guard in reportAttributes.ts (lines 79-84) becomes unreachable dead code:

if (!areAllConnectionsSet) {
    return {
        reports: {},
        locale: null,
    };
}

Not a bug, but should be cleaned up in a follow-up or in the same PR.

2. Locale connection uses initWithStoredValues: false

The NVP_PREFERRED_LOCALE dependency connects to ARE_TRANSLATIONS_LOADING with initWithStoredValues: false (line 109). This callback only fires when translations finish loading, NOT on initial storage restore. This means areAllConnectionsSet for reportAttributes depends on translations loading successfully.

This is NOT a new issue — the existing code already has the same dependency since reportAttributes.compute checks areAllConnectionsSet. But it's worth noting that the proposal doesn't make this better or worse.

3. Cold start with no disk cache

With the old code, the app would write empty defaults immediately. With the new code, no derived value exists in Onyx until all connections fire. In practice this is equivalent — consumers got {reports: {}, locale: null} before, and now they get undefined/null. Both are "no data" states. The timing to get a useful value is the same.

4. Configs that don't check areAllConnectionsSet

Some derived configs (e.g. todos.ts, outstandingReportsByPolicyID.ts) don't check areAllConnectionsSet in their compute functions. With the current code on main, they compute with partial data. With this proposal, they correctly wait for all connections before computing. This is actually an improvement — the responsibility is centralised in the framework rather than requiring each compute function to defensively check.

5. Performance claims

The reported numbers (cold start -9.5%, warm start -13.3%) are plausible given the elimination of:

  • N-1 unnecessary Onyx.set calls per derived key during init
  • The tupleGet Promise.all overhead
  • Cascading re-renders from writing empty defaults

Overall Assessment

The proposal is well-reasoned and correct. It identifies real bugs (not theoretical), the solutions are minimal and focused, and the changes don't introduce new issues. The main suggestion would be to also clean up the now-dead areAllConnectionsSet checks in compute functions (like reportAttributes.ts lines 79-84) either in this PR or a follow-up.

@shubham1206agra

Copy link
Copy Markdown
Contributor Author

@fabioh8010 1st is the valid concern. I can remove this dead code.

2nd one is not related to this PR. If it actually becomes a problem, we have bigger issues at hand such as bootsplash not getting removed.

The 3rd one looks valid, but since we already assume that any Onyx value can be undefined, we already have this issue handled throughout the codebase.

@shubham1206agra
shubham1206agra marked this pull request as ready for review February 25, 2026 10:21
@shubham1206agra
shubham1206agra requested review from a team as code owners February 25, 2026 10:21
@melvin-bot
melvin-bot Bot requested review from JmillsExpensify and linhvovan29546 and removed request for a team February 25, 2026 10:21
@melvin-bot

melvin-bot Bot commented Feb 25, 2026

Copy link
Copy Markdown

@linhvovan29546 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]

@shubham1206agra shubham1206agra changed the title Fix race condition on cold start in derived value system Fix race conditions and redundant writes in OnyxDerived initialisation Feb 25, 2026
@shubham1206agra shubham1206agra changed the title Fix race conditions and redundant writes in OnyxDerived initialisation Fixed race conditions and redundant writes in OnyxDerived initialisation Feb 25, 2026

@JmillsExpensify JmillsExpensify 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.

No product review required.

@linhvovan29546

linhvovan29546 commented Feb 25, 2026 •

Copy link
Copy Markdown
Contributor

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 Issues section 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 Tests section
    • I verified the steps for Staging and/or Production testing are in the QA steps section
    • 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 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. toggleReport and not onIconClick).
    • 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
  • 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 using Avatar have 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 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 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 Avatar is modified, I verified that Avatar is 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 Design label and/or tagged @Expensify/design so the design team can review the changes.
  • If a new page is added, I verified it's using the ScrollView component 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 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 reviewer checklist, including those that don't apply to this PR.

Screenshots/Videos

Android: HybridApp
Screen.Recording.2026-02-25.at.20.20.35.mov
Android: mWeb Chrome
Screen.Recording.2026-02-25.at.20.21.48.mov
iOS: HybridApp
Screen.Recording.2026-02-25.at.19.36.26.mov
iOS: mWeb Safari
Screen.Recording.2026-02-25.at.19.32.47.mov
MacOS: Chrome / Safari
Screen.Recording.2026-02-25.at.19.27.27.mov
Screen.Recording.2026-02-25.at.19.26.23.mov

@linhvovan29546

Copy link
Copy Markdown
Contributor

@shubham1206agra My Android app is stuck on the splash screen, I can’t reproduce the issue on the main branch. See the recording below at 00:35

Screen.Recording.2026-02-25.at.19.47.34.mov

@shubham1206agra

Copy link
Copy Markdown
Contributor Author

@shubham1206agra My Android app is stuck on the splash screen, I can’t reproduce the issue on the main branch. See the recording below at 00:35
Screen.Recording.2026-02-25.at.19.47.34.mov

@linhvovan29546 This seems odd since this system is not connected to Bootsplash logic in any way.

@shubham1206agra

Copy link
Copy Markdown
Contributor Author

@linhvovan29546 Also, check the logs please

@linhvovan29546

Copy link
Copy Markdown
Contributor

@shubham1206agra I can reproduce this on main after pulling the latest main branch locally, so it’s not caused by this PR.

@melvin-bot
melvin-bot Bot requested a review from mountiny February 25, 2026 13:27

@mountiny mountiny 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.

Thanks for the changes, lets keep an eye out for any odd bugs

@mountiny
mountiny merged commit 6b64304 into Expensify:main Feb 25, 2026
32 of 33 checks passed
@github-actions

Copy link
Copy Markdown
Contributor

🚧 @mountiny has triggered a test Expensify/App build. You can view the workflow run here.

@OSBotify

Copy link
Copy Markdown
Contributor

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

@OSBotify

Copy link
Copy Markdown
Contributor

🚀 Deployed to staging by https://github.com/mountiny in version: 9.3.27-0 🚀

platform result
🕸 web 🕸 success ✅
🤖 android 🤖 success ✅
🍎 iOS 🍎 success ✅

@OSBotify

OSBotify commented Mar 2, 2026

Copy link
Copy Markdown
Contributor

🚀 Deployed to production by https://github.com/blimpich in version: 9.3.27-8 🚀

platform result
🕸 web 🕸 success ✅
🤖 android 🤖 success ✅
🍎 iOS 🍎 success ✅

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.

6 participants