[TS migration] Migrate 'withReportAndPrivateNotesOrNotFound.js' HOC to TypeScript

[pac-guerreiro]

Details

Fixed Issues

$ https://github.com/Expensify/App/issues/31925 PROPOSAL: N/A

Tests

1. Start a new chat or open an existing one.
2. At the top of the chat, click on the user name and their profile will slide from the right of the screen.
3. Click on Private notes
4. Create a new note and save it.
5. Check that it displays correctly on a list

Offline tests

Same as tests.

QA Steps

Same as tests.

PR Author Checklist

• [x] I linked the correct issue in the ### Fixed Issues section above
• [x] I wrote clear testing steps that cover the changes made in this PR
  • [x] I added steps for local testing in the Tests section
  • [x] I added steps for the expected offline behavior in the Offline steps section
  • [x] I added steps for Staging and/or Production testing in the QA steps section
  • [x] I added steps to cover failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
  • [x] 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)
  • [x] 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).
• [x] I included screenshots or videos for tests on all platforms
• [x] I ran the tests on all platforms & verified they passed on:
  • [x] Android: Native
  • [x] Android: mWeb Chrome
  • [x] iOS: Native
  • [x] iOS: mWeb Safari
  • [x] MacOS: Chrome / Safari
  • [x] MacOS: Desktop
• [x] 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)
• [x] I followed proper code patterns (see Reviewing the code)
  • [x] 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)
  • [x] I verified that the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
  • [x] I verified that comments were added to code that is not self explanatory
  • [x] 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.
  • [x] I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
    • [x] 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:
  • [x] I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
  • [x] 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 approved by marketing by adding the Waiting for Copy label for a copy review on the original GH to get the correct copy.
  • [x] 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.
  • [x] I verified the JSDocs style guidelines (in STYLE.md) were followed
• [x] If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
• [x] I followed the guidelines as stated in the Review Guidelines
• [x] 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)
• [x] I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
• [x] 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
• [x] I verified that if a function's arguments changed that all usages have also been updated correctly
• [x] If any new file was added I verified that:
  • [x] 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
• [x] If a new CSS style is added I verified that:
  • [x] A similar style doesn't already exist
  • [x] The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(theme.componentBG))
• [x] 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.
• [x] 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)
• [x] 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.
• [x] 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.
• [x] If the PR modifies the form input styles:
  • [x] I verified that all the inputs inside a form are aligned with each other.
  • [x] I added Design label so the design team can review the changes.
• [x] 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.
• [x] 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

https://github.com/Expensify/App/assets/48553277/ca75efa0-42d0-4ad4-83b9-2518b36c8b5a

Android: mWeb Chrome

https://github.com/Expensify/App/assets/48553277/c6a2a311-645c-45e6-b02e-1fe57c746e4a

iOS: Native

https://github.com/Expensify/App/assets/48553277/65519601-5873-4766-a85a-8d0fa07b6325

iOS: mWeb Safari

https://github.com/Expensify/App/assets/48553277/dda8e5b4-5b2e-44ae-92d2-debcb11b0ca6

MacOS: Chrome / Safari

https://github.com/Expensify/App/assets/48553277/e2c88f61-3f2b-4d1c-ba4c-e3598ef1724d

MacOS: Desktop

https://github.com/Expensify/App/assets/48553277/42cafc33-e7f6-4f66-9374-ab1acb321363

[melvin-bot[bot]]

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

[cubuspl42]

Looks good, I left a minor comment 👍

[fabioh8010]

cc @pac-guerreiro

[pac-guerreiro]

@cubuspl42

Sorry, I'll add the missing info in the PR description 😉

[pac-guerreiro]

@cubuspl42 Missing info added! Thank you for your patience! 🙏

[cubuspl42]

@pac-guerreiro No worries! Sadly, some more actions are required:

• TypeScript Checks are failing
• We've got some conflicts

[cubuspl42]

@pac-guerreiro Please ping me when all checks (except PR Reviewer Checklist) are passing

[pac-guerreiro]

@cubuspl42 Issues resolved! 😄

[cubuspl42]

At the top of the chat, click on the user name and their profile will slide from the right of the screen.

A linguistic / cultural hint. We shouldn't assume the gender or pronouns of the user.

[cubuspl42]

Could you check this out? When I tried to edit an existing note, an endless spinner shows up. I tried switching between main and PR branch and it actually seems to work on main, making this a regression.

https://github.com/Expensify/App/assets/2590174/e43c500f-fa7a-4f8b-9772-8b07e33fe6f4

[pac-guerreiro]

@cubuspl42 Great catch! Found the culprit and just pushed the fix! Thanks 😄

[cubuspl42]

@pac-guerreiro Checks, mate!

[pac-guerreiro]

@cubuspl42 Typechecks are now passing! Thanks @VickyStash 🙏

[cubuspl42]

@pac-guerreiro Are you sure the spinner problem is fixed?

On the latest code:

https://github.com/Expensify/App/assets/2590174/3e0165df-84e4-4ef6-a742-d00109db1010

I checked again that it works on main.

[pac-guerreiro]

@cubuspl42 Sorry, it seems I only fixed part of the problem, which was when the user already had private notes.

I just applied a fix for the situation you reported when there are no private notes yet.

Let me know if there's any remaining problem here and thanks for your patience! 😄

[cubuspl42]

Let us take a step back here. As GitHub is not displaying the diff side-by-side, I'll post a screenshot from the IDE:

Why is the shouldShowFullScreenLoadingIndicator condition so different?

As I understand it, TypeScript migrations should be relatively 1:1 regarding the business logic unless we have good reasons to act otherwise.

I understand that it was a "fix" to the code not working (https://github.com/Expensify/App/pull/34014/commits/9b6db9430dda9e55f3eba98e544e61f24a6a0391), but can't we achieve working code with a 1:1 migration? If it is impossible or difficult, could you explain why?

[cubuspl42]

Reviewer Checklist

• [x] I have verified the author checklist is complete (all boxes are checked off).
• [x] I verified the correct issue is linked in the ### Fixed Issues section above
• [x] I verified testing steps are clear and they cover the changes made in this PR
  • [x] I verified the steps for local testing are in the Tests section
  • [x] I verified the steps for Staging and/or Production testing are in the QA steps section
  • [x] 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)
  • [x] 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)
• [x] I checked that screenshots or videos are included for tests on all platforms
• [x] I included screenshots or videos for tests on all platforms
• [x] I verified tests pass on all platforms & I tested again on:
  • [x] Android: Native
  • [x] Android: mWeb Chrome
  • [x] iOS: Native
  • [x] iOS: mWeb Safari
  • [x] MacOS: Chrome / Safari
  • [x] MacOS: Desktop
• [x] 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
• [x] I verified proper code patterns were followed (see Reviewing the code)
  • [x] 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).
  • [x] I verified that the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
  • [x] I verified that comments were added to code that is not self explanatory
  • [x] 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.
  • [x] I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
  • [x] I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
  • [x] 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 approved by marketing by adding the Waiting for Copy label for a copy review on the original GH to get the correct copy.
  • [x] 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.
  • [x] I verified the JSDocs style guidelines (in STYLE.md) were followed
• [x] If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
• [x] I verified that this PR follows the guidelines as stated in the Review Guidelines
• [x] 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)
• [x] I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
• [x] 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
• [x] If a new component is created I verified that:
  • [x] A similar component doesn't exist in the codebase
  • [x] All props are defined accurately and each prop has a /** comment above it */
  • [x] The file is named correctly
  • [x] The component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone
  • [x] The only data being stored in the state is data necessary for rendering and nothing else
  • [x] 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)
  • [x] 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)
  • [x] All JSX used for rendering exists in the render method
  • [x] 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
• [x] If any new file was added I verified that:
  • [x] 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
• [x] If a new CSS style is added I verified that:
  • [x] A similar style doesn't already exist
  • [x] The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(theme.componentBG)
• [x] 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.
• [x] 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)
• [x] 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.
• [x] 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.
• [x] If the PR modifies the form input styles:
  • [x] I verified that all the inputs inside a form are aligned with each other.
  • [x] I added Design label so the design team can review the changes.
• [x] 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.
• [x] 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.
• [x] I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

Screenshots/Videos

Android: Native

https://github.com/Expensify/App/assets/2590174/e0e0378b-0eef-46bd-bfa5-14a7162e1177

Android: mWeb Chrome

https://github.com/Expensify/App/assets/2590174/9ff53220-c6cd-434e-894b-cc2e991ac7f6

iOS: Native

https://github.com/Expensify/App/assets/2590174/90c335ea-a0b8-4849-908d-fc89d7ba9869

iOS: mWeb Safari

https://github.com/Expensify/App/assets/2590174/1d92e7b5-73be-4a1e-b549-ef1944283716

MacOS: Chrome / Safari

https://github.com/Expensify/App/assets/2590174/1e680d3a-3c77-4cee-84b0-6867f970c1c9

MacOS: Desktop

[melvin-bot[bot]]

We did not find an internal engineer to review this PR, trying to assign a random engineer to #31925 as well as to this PR... Please reach out for help on Slack if no one gets assigned!

[cubuspl42]

@pac-guerreiro Could you also maybe merge main one last time? We're over 1000 commits behind

[pac-guerreiro]

@cubuspl42 Main rebased 😄

[cubuspl42]

@cristipaval Would you please review this PR, as you were assigned to https://github.com/Expensify/App/issues/31925?

[cristipaval]

Sure I will

[OSBotify]

:hand: 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]

🚀 Deployed to production by https://github.com/thienlnam in version: 1.4.41-12 🚀

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