Migrate withWritableReportOrNotFound from withOnyx to useOnyx

[abhinaybathina]

Details

Fixed Issues

$ #49110
PROPOSAL: #49110 (comment)

Tests

1. I've tested the overall application usability
2. Used console log statements to verify the data flow in both the versions

• Verify that no errors appear in the JS console

Offline tests

QA Steps

• 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
  • 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 the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
  • 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 verified the translation was requested/reviewed 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.js 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.
• 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

Screen.Recording.2024-09-21.at.1.56.52.AM.mov

Android: mWeb Chrome

Screen.Recording.2024-09-21.at.1.59.11.AM.mov

iOS: Native

Screen.Recording.2024-09-20.at.9.15.18.PM.mov

iOS: mWeb Safari

Screen.Recording.2024-09-21.at.2.09.28.AM.mov

MacOS: Chrome / Safari

Screen.Recording.2024-09-20.at.12.29.24.AM.mov

MacOS: Desktop

Screen.Recording.2024-09-21.at.2.15.22.AM.mov

[melvin-bot]

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

[github-actions]

CLA Assistant Lite bot All contributors have signed the CLA ✍️ ✅

[abhinaybathina]

I have read the CLA Document and I hereby sign the CLA

[brunovjk]

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 tests pass on all platforms & I tested again on:
  • Android: Native
  • Android: mWeb Chrome
  • iOS: Native
  • 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 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 the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
  • 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.js 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.
• 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: Native

49200_android_native.mov

Android: mWeb Chrome

49200_android_web.mov

iOS: Native

49200_ios_native.mov

iOS: mWeb Safari

MacOS: Chrome / Safari

49200_web_chrome.mov

MacOS: Desktop

49200_web_desktop.mov

[abhinaybathina]

Hi @brunovjk , for some reason I'm unable to re-trigger CLA assistant pipeline. Kindly help

[brunovjk]

Hi @brunovjk , for some reason I'm unable to re-trigger CLA assistant pipeline. Kindly help

I had to answer an urgent issue. I'll come back here today and help you with that. Thank you.

[brunovjk]

I'm dealing with some problems with my internet. I'll come back here as soon as I resolve it.

[brunovjk]

@abhinaybathina Sorry for the delay, we're in full swing now! I had an error when trying to submit a simple expense:

Screen.Recording.2024-09-19.at.13.39.07.mov

Could you please 'merge main' to update, so I can test again. Thanks a lot.

[abhinaybathina]

@brunovjk Sure checking

[brunovjk]

Hey @abhinaybathina, great work on the PR! I have a couple of suggestions:

1. Instead of creating a new variable const reportID = route.params.reportID;, you can directly use route.params.reportID ?? '-1' for both report and reportDraft to reduce redundancy.

2. Let's keep report = {reportID: ''} to ensure we handle missing IDs correctly and prevent the "not found" issue during new request creation.

Also, could you fill the "Screenshots/Videos" section demonstrating your test steps?

Thanks!

[abhinaybathina]

That's a good catch, fixed it now. Thank you so much!

[abhinaybathina]

@brunovjk I've added a video too, can you please check?

[brunovjk]

Hey @abhinaybathina,

Great work! Excuse but I have a couple of suggestions:

1. Use '-1' (string) instead of -1 for missing reportID (guide reference).

2. What do you think of moving the useOnyx calls right after destructuring route to improve readability :

    function WithWritableReportOrNotFound(props: Omit<TProps, keyof WithWritableReportOrNotFoundOnyxProps>, ref: ForwardedRef<TRef>) {
        const {route} = props;
        const [report = {reportID: ''}] = useOnyx(`${ONYXKEYS.COLLECTION.REPORT}${route.params.reportID ?? '-1'}`);
        const [isLoadingApp = true] = useOnyx(ONYXKEYS.IS_LOADING_APP);
        const [reportDraft] = useOnyx(`${ONYXKEYS.COLLECTION.REPORT_DRAFT}${route.params.reportID ?? '-1'}`);

Thanks!

[abhinaybathina]

Done @brunovjk. Thanks!

[brunovjk]

@abhinaybathina can you do a distance request?

Screen.Recording.2024-09-20.at.08.42.48.mov

I couldn't figure out why this is happening, in my local main it doesn't. Can you reproduce it, or maybe it's an issue on my side? Thanks.

[abhinaybathina]

Even I too thought of this solution, either way is fine. Should I make this change?

[abhinaybathina]

Since we need a default value only for this function call, we can even make it simpler by just doing this. What do you think?

const canUserPerformWriteAction = ReportUtils.canUserPerformWriteAction(report ?? {reportID: ''});

[brunovjk]

Since we need a default value only for this function call, we can even make it simpler by just doing this. What do you think?

const canUserPerformWriteAction = ReportUtils.canUserPerformWriteAction(report ?? {reportID: ''});

Ok, I did a quick test and I liked, can you made all those changes? Do not need to run, I will back to it tomorrow. Let's test carefully. Thank you.

[abhinaybathina]

Thank you for your quick reply. Pushed the changes. No worries, you can review tomorrow!

[brunovjk]

We must remove OnyxProps https://github.com/Expensify/App/blob/main/contributingGuides/STYLE.md#hooks-and-hocs

[abhinaybathina]

@brunovjk If we do this, the components which are wrapped using this HOC will be receiving the props (route, report and reportDraft) but since we are removing the type for onyx props it'll show type errors in all the components like this

[abhinaybathina]

Also, after making the change that you've suggested earlier, the props type is now having report and reportDraft as well which shouldn't be in props.

That's why I've omitted these props like this

export default function <TProps extends WithWritableReportOrNotFoundProps<MoneyRequestRouteName>, TRef>(
    WrappedComponent: ComponentType<TProps & RefAttributes<TRef>>,
    shouldIncludeDeprecatedIOUType = false,
): React.ComponentType<Omit<TProps & RefAttributes<TRef>, keyof WithWritableReportOrNotFoundOnyxProps>> {
    // eslint-disable-next-line rulesdir/no-negated-variables
    function WithWritableReportOrNotFound(props: Omit<TProps, keyof WithWritableReportOrNotFoundOnyxProps>, ref: ForwardedRef<TRef>) {
        const {route} = props;
        const [report] = useOnyx(`${ONYXKEYS.COLLECTION.REPORT}${route.params.reportID ?? '-1'}`);
        const [isLoadingApp = true] = useOnyx(ONYXKEYS.IS_LOADING_APP);
        const [reportDraft] = useOnyx(`${ONYXKEYS.COLLECTION.REPORT_DRAFT}${route.params.reportID ?? '-1'}`);

[brunovjk]

I see, it was just a suggestion, we should guide ourselves here https://github.com/Expensify/App/blob/main/contributingGuides/STYLE.md#hooks-and-hocs

@abhinaybathina

[abhinaybathina]

Understood, let me check again

[abhinaybathina]

@brunovjk, I don't think the props should be removed from here. The guide here shows the example of a functional component. I completely agree that we need to remove the onyx props in this case as we don't need it further. But the changes we are making right now is a HOC itself which provides the props to the wrapped component. In this case, we need the correct typing of the props or else it may cause type error issues in the wrapped components as we've seen in the attached image above. I am going through withPolicy.tsx file right now and have found that the same implementation has been done there also. I believe that what we already did is right and we shouldn't remove onyx props in this case. Thanks!

[brunovjk]

@brunovjk, I don't think the props should be removed from here. The guide here shows the example of a functional component. I completely agree that we need to remove the onyx props in this case as we don't need it further. But the changes we are making right now is a HOC itself which provides the props to the wrapped component. In this case, we need the correct typing of the props or else it may cause type error issues in the wrapped components as we've seen in the attached image above. I am going through withPolicy.tsx file right now and have found that the same implementation has been done there also. I believe that what we already did is right and we shouldn't remove onyx props in this case. Thanks!

I see, what do you think @blazejkustra and @roryabraham? We could indeed leave it as withPolicy.tsx for the simplicity of the issue, but I believe that at some point we will remove it, I didn't find anything about it in the slack discussions. I tested the current changes and everything works fine, left to test on android. Before approving I wanted to know your thoughts. Thank you :D

[roryabraham]

I think what we have here is fine. The Onyx props are still separate from other props in a HOC because they are passed to the wrapped component

[brunovjk]

Great, Thank you! I will complete the checklist later today.

[roryabraham]

Looks like a problem with the lint-changed lint action because it's reporting on files that weren't changed. Going to ignore and merge

[melvin-bot]

@roryabraham looks like this was merged without a test passing. Please add a note explaining why this was done and remove the Emergency label if this is not an emergency.

[OSBotify]

✋ 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]

🚀 Deployed to staging by https://github.com/roryabraham in version: 9.0.41-0 🚀

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

[github-actions]

🧪🧪 Use the links below to test this adhoc build on Android, iOS, Desktop, and Web. Happy testing! 🧪🧪

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

---

👀 View the workflow run that generated this build 👀

[github-actions]

🚀 Deployed to production by https://github.com/jasperhuangg in version: 9.0.41-10 🚀

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