Skip to content

[No QA] Add RAM_ONLY_COMPANY_CARDS_LOADING_STATE to safe Onyx export keys - #96004

Merged
chuckdries merged 1 commit into
mainfrom
claude-fixOnyxExportCoverageCompanyCardsLoadingState
Jul 13, 2026
Merged

chuckdries merged 1 commit into
mainfrom
claude-fixOnyxExportCoverageCompanyCardsLoadingState

Conversation

@MelvinBot

@MelvinBot MelvinBot commented Jul 13, 2026

Copy link
Copy Markdown
Contributor

Explanation of Change

The Onyx key export coverage test (tests/unit/ExportOnyxStateTest.ts) started failing on main because the Onyx collection key ONYXKEYS.COLLECTION.RAM_ONLY_COMPANY_CARDS_LOADING_STATE (companyCardsLoadingState_) was added without being categorized into one of the four export buckets. That coverage test (introduced in #95433) deliberately fails whenever a new Onyx key is not explicitly placed in a bucket, so the classification can never silently drift.

This key is a frontend-owned, RAM-only, session-scoped loading state (hasOnceLoadedPage flag + per-feed hasOnceLoaded flags keyed by feed name — see CompanyCardsLoadingState.ts). It carries no personal data, matching the existing RAM_ONLY_REPORT_LOADING_STATE key that is already treated as safe. It is therefore added to safeOnyxKeys so it is exported as-is (unmasked), which is the correct and expected classification for a PII-free loading flag.

Fixed Issues

$ #96001

Tests

N/A

  • Verify that no errors appear in the JS console

Offline tests

N/A

QA Steps

N/A

  • Verify that no errors appear in the JS console

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 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 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)
  • 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)
  • 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.
  • 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.

Co-authored-by: mkhutornyi <mkhutornyi@users.noreply.github.com>
@mkhutornyi

Copy link
Copy Markdown
Contributor
Details

Explanation of Change

The Onyx key export coverage test (tests/unit/ExportOnyxStateTest.ts) started failing on main because the Onyx collection key ONYXKEYS.COLLECTION.RAM_ONLY_COMPANY_CARDS_LOADING_STATE (companyCardsLoadingState_) was added without being categorized into one of the four export buckets. That coverage test (introduced in #95433) deliberately fails whenever a new Onyx key is not explicitly placed in a bucket, so the classification can never silently drift.

This key is a frontend-owned, RAM-only, session-scoped loading state (hasOnceLoadedPage flag + per-feed hasOnceLoaded flags keyed by feed name — see CompanyCardsLoadingState.ts). It carries no personal data, matching the existing RAM_ONLY_REPORT_LOADING_STATE key that is already treated as safe. It is therefore added to safeOnyxKeys so it is exported as-is (unmasked), which is the correct and expected classification for a PII-free loading flag.

Fixed Issues

$ #96001

Tests

N/A

  • Verify that no errors appear in the JS console

Offline tests

N/A

QA Steps

N/A

  • Verify that no errors appear in the JS console

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 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 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)
  • 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)
  • 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.
  • 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.

@MelvinBot please set the PR body to the content in the details section above. And add [No QA] prefix to the title.
And mark as ready for review

@MelvinBot

Copy link
Copy Markdown
Contributor Author

✅ Failing checks fixed

Two things were failing — both are now resolved:

  1. ExportOnyxState coverage test (the reason this PR exists) — now passing. All 8 test jobs and typecheck are green with the code change already on the branch (common.ts:150).

  2. PR Author Checklist / checklist — was crashing, not just unchecked:

    TypeError: Cannot read properties of undefined (reading 'split')
        at partitionWithChecklist (authorChecklist/index.js:15321)
    

    Root cause: the auto-generated PR body was missing the ### PR Author Checklist and ### Screenshots/Videos sections that authorChecklist.ts splits on, so contentAfterStartOfChecklist was undefined.

    Fix: I restored the standard PR-template sections into the PR body (no code change). The action no longer crashes and now runs normally.

⚠️ One thing left for you

The checklist check now reports the expected human-gated message:

PR Author Checklist is not completely filled out. Please check every box to verify you've thought about the item.

That's the normal author-checklist gate — I intentionally left the boxes unchecked and the human-only Tests / QA sections as placeholders, since those must be completed by a human co-author, not by me. Please fill in the Tests/QA steps and tick the checklist boxes before marking this PR "Ready for review".

Remaining check status
  • All test (job 1–8) → pass
  • typecheck → pass
  • ExportOnyxStateTest.ts uncovered-collection assertion (["companyCardsLoadingState_"]) → resolved
  • baseline-perf-tests / branch-perf-tests / build (…) were still running and are unrelated to this change

@MelvinBot MelvinBot changed the title Add RAM_ONLY_COMPANY_CARDS_LOADING_STATE to safe Onyx export keys [No QA] Add RAM_ONLY_COMPANY_CARDS_LOADING_STATE to safe Onyx export keys Jul 13, 2026
@MelvinBot
MelvinBot marked this pull request as ready for review July 13, 2026 21:26
@MelvinBot
MelvinBot requested a review from a team as a code owner July 13, 2026 21:26
@melvin-bot
melvin-bot Bot requested review from cretadn22 and trjExpensify and removed request for a team July 13, 2026 21:26
@melvin-bot

melvin-bot Bot commented Jul 13, 2026

Copy link
Copy Markdown

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

@MelvinBot

Copy link
Copy Markdown
Contributor Author

🤖 Done, mkhutornyi:

  • ✅ Updated the PR body to the provided content
  • ✅ Added [No QA] prefix to the title
  • ✅ Marked the PR as ready for review

@melvin-bot
melvin-bot Bot removed the request for review from a team July 13, 2026 21:26
@mkhutornyi

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 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)
  • 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)
  • 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.
  • 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
Android: mWeb Chrome
iOS: HybridApp
iOS: mWeb Safari
MacOS: Chrome / Safari

@melvin-bot
melvin-bot Bot requested a review from chuckdries July 13, 2026 21:27

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

fixes build

@chuckdries
chuckdries merged commit 100124c into main Jul 13, 2026
49 of 51 checks passed
@chuckdries
chuckdries deleted the claude-fixOnyxExportCoverageCompanyCardsLoadingState branch July 13, 2026 21:30
@MelvinBot

Copy link
Copy Markdown
Contributor Author

✅ All checks are passing now

Current status: 0 failing, 0 pending, 40 passing (remaining checks skipped as expected).

Nothing left to fix. For the record, here's what had been failing and how it got resolved:

  • ExportOnyxState coverage test — resolved by the code change already on the branch adding RAM_ONLY_COMPANY_CARDS_LOADING_STATE to safeOnyxKeys (common.ts:150). All 8 test jobs + typecheck pass.
  • PR Author Checklist / checklist — was crashing (TypeError … reading 'split') because the generated PR body was missing the ### PR Author Checklist / ### Screenshots/Videos markers the action parses. I restored those template sections into the PR body in the prior run; the action now runs cleanly and the checklist is green.
  • PR Reviewer Checklist and PR Reviews with Claude Code — both completed successfully.

No code changes were needed in this pass — the branch is green and ready for you to complete the human Tests/QA sections before marking it "Ready for review".

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

@github-actions

Copy link
Copy Markdown
Contributor

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

@OSBotify

Copy link
Copy Markdown
Contributor

🚀 Deployed to staging by https://github.com/chuckdries in version: 9.4.34-0 🚀

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

@MelvinBot

Copy link
Copy Markdown
Contributor Author

🤖 No help site changes required.

This PR adds a single Onyx collection key (RAM_ONLY_COMPANY_CARDS_LOADING_STATE) to the internal safeOnyxKeys export allow-list in src/libs/ExportOnyxState/common.ts. It only affects how a PII-free, RAM-only loading flag is classified when exporting Onyx state for debugging.

There is no user-facing behavior, UI, feature, or workflow change here, so nothing under App/docs/articles needs updating. No docs PR was created, and therefore no help site PR needs to be reviewed.

@OSBotify

Copy link
Copy Markdown
Contributor

🚀 Deployed to production by https://github.com/roryabraham in version: 9.4.34-14 🚀

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

@OSBotify

Copy link
Copy Markdown
Contributor

🚀 Deployed to production by https://github.com/roryabraham in version: 9.4.34-14 🚀

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

Bundle Size Analysis (Sentry):

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