Skip to content

Adjust #63648 PR code to new pure Onyx functions rule#63731

Merged
aldo-expensify merged 11 commits intoExpensify:mainfrom
software-mansion-labs:korytko/adjust-63648-code-to-new-onyx-rule
Jun 12, 2025
Merged

Adjust #63648 PR code to new pure Onyx functions rule#63731
aldo-expensify merged 11 commits intoExpensify:mainfrom
software-mansion-labs:korytko/adjust-63648-code-to-new-onyx-rule

Conversation

@JakubKorytko
Copy link
Copy Markdown
Contributor

@JakubKorytko JakubKorytko commented Jun 9, 2025

Explanation of Change

According to slack convo and #63648 @mountiny comments in order to unblock deploy blocker handling non-pure functions added in the PR should be corrected in this PR.

However, to make it work correctly we need to also make functions that call getOneTransactionThreadReportID pure as much as we can without changing the whole codebase in one PR.

Following functions were changed to accept reports from Onyx as a parameters instead of ID's:

  • getReportPrimaryAction
  • getSecondaryReportActions
  • getOneTransactionThreadReportID
  • isPayAtEndExpenseReport
  • getReasonAndReportActionThatHasRedBrickRoad
  • shouldReportBeInOptionList
  • getSendMoneyFlowOneTransactionThreadID
  • isOneTransactionReport
  • hasReportErrorsOtherThanFailedReceipt
  • isOneTransactionReport
  • generateReportAttributes
  • getReasonAndReportActionForRBRInLHNRow
  • getReasonForShowingRowInLHN

isOneTransactionThread is semi-pure as it is still getting chatReport from allReports.

getWorkspacesUnreadStatuses was removed as it was used nowhere.

Following components now use useOnyx for chatReport and pass it to changed functions to make it more reactive:

  • MoneyRequestReportActionsList
  • MoneyRequestReportView
  • DebugReportPage
  • ReportDetailsPage
  • ReportScreen
  • BaseReportActionContextMenu

Context why these changes were introduced: https://expensify.slack.com/archives/C05LX9D6E07/p1748457444774569

Fixed Issues

$ #63827
PROPOSAL: N/A

Tests

[Issue fixed in the original PR should still be fixed, steps copy-pasted]

  1. Open Expensify app.
  2. Open 1:1 DM.
  3. Click + > Pay user.
  4. Enter amount > Next.
  5. Click Pay elsewhere.
  6. Click on the expense preview.
  7. Verify that Send Money expense preview is displayed.

Because this is non-UI change and nothing was added but it is a huge refractor that cannot really be split into smaller parts as getOneTransactionThreadReportID is called about 40 times in the code, it is extremely hard to create test steps that are specific enough. However, what should be tested is all places where one-transaction report view can be displayed (e.g. Report view, RHP) and places where it shouldn't (e.g. LHN).

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
    • MacOS: Desktop
  • 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 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 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

Android: Native
Android: mWeb Chrome
iOS: Native
iOS: mWeb Safari
MacOS: Chrome / Safari
Web.mov
MacOS: Desktop

@JakubKorytko JakubKorytko force-pushed the korytko/adjust-63648-code-to-new-onyx-rule branch from 230e138 to 240df21 Compare June 9, 2025 11:21
@JakubKorytko JakubKorytko force-pushed the korytko/adjust-63648-code-to-new-onyx-rule branch from 358f664 to 9509710 Compare June 9, 2025 12:58
@JakubKorytko
Copy link
Copy Markdown
Contributor Author

JakubKorytko commented Jun 9, 2025

Note: ESLint check is failing but can be safely ignored as this PR is taking care of the beta flag.

@JakubKorytko JakubKorytko changed the title [WIP] Adjust #63648 PR code to new pure Onyx functions rule Adjust #63648 PR code to new pure Onyx functions rule Jun 9, 2025
@JakubKorytko JakubKorytko marked this pull request as ready for review June 9, 2025 13:09
@JakubKorytko JakubKorytko requested a review from a team as a code owner June 9, 2025 13:09
@melvin-bot melvin-bot bot requested a review from aldo-expensify June 9, 2025 13:09
@melvin-bot
Copy link
Copy Markdown

melvin-bot bot commented Jun 9, 2025

@aldo-expensify 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]

@melvin-bot melvin-bot bot removed the request for review from a team June 9, 2025 13:09
Copy link
Copy Markdown
Contributor

@aldo-expensify aldo-expensify left a comment

Choose a reason for hiding this comment

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

This looks good to me, my only concern is this comment: #63731 (comment)

Do we have to do something about these lint errors?

image

My guess is "no".

Comment on lines +388 to +389
const report = getReportOrDraftReport(reportID);
const chatReport = getReportOrDraftReport(report?.chatReportID);
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.

@JakubKorytko I'm not sure if this matters, but I see you started using getReportOrDraftReport which falls back to the ONYXKEYS.COLLECTION.REPORT_DRAFT collection if it doesn't find the report in ONYXKEYS.COLLECTION.REPORT. In the past, the code was just using ONYXKEYS.COLLECTION.REPORT, is this change safe?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Good point. I'm pretty sure it is, but just to be safe, I'll replace these calls with getReport or something similar tomorrow.

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.

Eventually we will need to replace those too but definitely not in scope of this pr

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.

Eventually we will need to replace those too but definitely not in scope of this pr

agree

@mountiny
Copy link
Copy Markdown
Contributor

mountiny commented Jun 9, 2025

Yeah no need to do anything about those

@github-actions
Copy link
Copy Markdown
Contributor

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

@allgandalf
Copy link
Copy Markdown
Contributor

allgandalf commented Jun 10, 2025

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
    • MacOS: Desktop
  • 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 there are no new alerts related to the canBeMissing param for useOnyx
  • 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.2025-06-11.at.4.34.50.PM.mov
Android: mWeb Chrome
Screen.Recording.2025-06-11.at.4.45.00.PM.mov
iOS: HybridApp
Screen.Recording.2025-06-11.at.3.12.53.PM.mov
iOS: mWeb Safari
Screen.Recording.2025-06-11.at.3.18.31.PM.mov
MacOS: Chrome / Safari
Screen.Recording.2025-06-11.at.12.26.09.PM.mov
Screen.Recording.2025-06-11.at.4.46.37.PM.mov
MacOS: Desktop
Screen.Recording.2025-06-11.at.12.34.10.PM.mov

@allgandalf
Copy link
Copy Markdown
Contributor

isOneTransactionThread was changed to accept both reports and IDs as there wasn't a clear way to change it's type. So it is semi-pure.

@JakubKorytko can you explain more with this statement, what's the problem exactly ?

@allgandalf
Copy link
Copy Markdown
Contributor

allgandalf commented Jun 10, 2025

@mountiny lets cancel the adhoc workflow, there are some updates still being pushed by @JakubKorytko

@github-actions

This comment has been minimized.

@JakubKorytko
Copy link
Copy Markdown
Contributor Author

@aldo-expensify I've changed added getReportOrDraftReport calls to directly accessing allReports because as @mountiny said, it will be removed sooner or later and I think this is the best way of getting rid of Onyx.connect in components - moving it up and closer to components in different PR's because doing it all at once would result in PR having thousands of lines changed.

Do we have to do something about these lint errors?

Can be safely ignored as #63533 is taking care of the beta flag.

can you explain more with this statement, what's the problem exactly ?

No longer a thing, it was done that way to avoid using allReports but it is safer than getReportOrDraftReport which will be deleted later anyway.

@JakubKorytko JakubKorytko force-pushed the korytko/adjust-63648-code-to-new-onyx-rule branch from 4ad3e9a to 28f8c81 Compare June 10, 2025 11:04
@github-actions
Copy link
Copy Markdown
Contributor

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

@mountiny
Copy link
Copy Markdown
Contributor

@JakubKorytko could you please get someone from SWM assigned to take over this and handle any blockers/ comments instead of you? thanks!

@JakubKorytko
Copy link
Copy Markdown
Contributor Author

@JakubKorytko could you please get someone from SWM assigned to take over this and handle any blockers/ comments instead of you? thanks!

About the comments, I will address them and get this merged, but asked SWM about someone to take care of potential blockers.

@github-actions
Copy link
Copy Markdown
Contributor

🧪🧪 Use the links below to test this adhoc build on Android, iOS, Desktop, and Web. Happy testing! 🧪🧪
Built from App PR #63731.

Android 🤖 iOS 🍎
https://ad-hoc-expensify-cash.s3.amazonaws.com/android/63731/index.html https://ad-hoc-expensify-cash.s3.amazonaws.com/ios/63731/index.html
Android iOS
Desktop 💻 Web 🕸️
https://ad-hoc-expensify-cash.s3.amazonaws.com/desktop/63731/NewExpensify.dmg https://63731.pr-testing.expensify.com
Desktop Web

👀 View the workflow run that generated this build 👀

@blazejkustra
Copy link
Copy Markdown
Contributor

but asked SWM about someone to take care of potential blockers.

Hey, that's me! I'll watch out for potential blockers (🤞 there won't be any)

Copy link
Copy Markdown
Contributor

@allgandalf allgandalf left a comment

Choose a reason for hiding this comment

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

codewise this LGTM!, I still need to perform some tests to make sure everything is correct, will update the checklist tomorrow

@mountiny
Copy link
Copy Markdown
Contributor

@blazejkustra @JakubKorytko could you please merge main once you get a chance?

@JakubKorytko
Copy link
Copy Markdown
Contributor Author

Can do a little later.

@JakubKorytko
Copy link
Copy Markdown
Contributor Author

ESLint check failing - unrelated to this PR, not something I've added and I see that it will be fixed somewhere else.

'getPolicy' is deprecated. Get the data straight from Onyx - This will be fixed as part of https://github.com/Expensify/Expensify/issues/507850

Copy link
Copy Markdown
Contributor

@allgandalf allgandalf left a comment

Choose a reason for hiding this comment

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

Code LGTM and tests well on all platforms. Hopefully no bugs should pass 🙏 ,

Thanks for taking care of this despite being ill @JakubKorytko 🙇 , get better soon!

@melvin-bot melvin-bot bot requested a review from aldo-expensify June 11, 2025 11:19
@mountiny
Copy link
Copy Markdown
Contributor

All yours @aldo-expensify

@allgandalf
Copy link
Copy Markdown
Contributor

@JakubKorytko can you fix conflicts please

@JakubKorytko
Copy link
Copy Markdown
Contributor Author

JakubKorytko commented Jun 11, 2025

@allgandalf Yeah, done, had to change getSecondaryReportActions signature though.

Pros: for the first time in this PR history - no checks failing 💅
Cons: We are close to hit 800 lines changed in total 🚀

aldo-expensify
aldo-expensify previously approved these changes Jun 11, 2025
Copy link
Copy Markdown
Contributor

@aldo-expensify aldo-expensify left a comment

Choose a reason for hiding this comment

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

LGTM

@aldo-expensify
Copy link
Copy Markdown
Contributor

Leaving unmerged in case @mountiny wants to take a final look

Copy link
Copy Markdown
Contributor

@mountiny mountiny left a comment

Choose a reason for hiding this comment

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

Ah sorry, I did not expect to wait for me, changes look good to me, thanks @JakubKorytko @blazejkustra

@allgandalf @blazejkustra lets be ready for some regressions that slipped through testing, @allgandalf could you please leave a comment listing out the tests you have done during your testing, at least some of them. Thanks!

@aldo-expensify aldo-expensify merged commit cab551a into Expensify:main Jun 12, 2025
19 checks passed
@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

🚀 Deployed to staging by https://github.com/aldo-expensify in version: 9.1.67-0 🚀

platform result
🖥 desktop 🖥 success ✅
🕸 web 🕸 success ✅
🤖 android 🤖 cancelled 🔪
🍎 iOS 🍎 cancelled 🔪

@github-actions
Copy link
Copy Markdown
Contributor

🚀 Deployed to production by https://github.com/lakchote in version: 9.1.67-2 🚀

platform result
🖥 desktop 🖥 success ✅
🕸 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