Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Load parent report action from withOnyx in report action HOC #34113

Merged
merged 30 commits into from
Feb 8, 2024

Conversation

tgolen
Copy link
Contributor

@tgolen tgolen commented Jan 8, 2024

@luacmartins I wanted you to review this to ensure I didn't end up changing any of the logic and it looked like you had the most context into the current code.

Fixed Issues

Part of #27262

Tests

  1. Run npm i and also a pod install from the ios directory
  2. Open a chat with Person A and Person B
  3. Have Person B open a thread from one of Person A's comments and add a message to the thread
  4. From inside the thread, have Person B flag the original comment from Person A (the topmost comment)
  5. Verify the Flag Comment window opens with options (if this PR were not working, this would display as a not-found page instead)
  • Verify that no errors appear in the JS console

Offline tests

Same as above

QA Steps

  1. Open a chat with Person A and Person B
  2. Have Person B open a thread from one of Person A's comments and add a message to the thread
  3. From inside the thread, have Person B flag the original comment from Person A (the topmost comment)
  4. Verify the Flag Comment window opens with options (if this PR were not working, this would display as a not-found page instead)
  • 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 UNABLE TO TEST DUE TO BROKEN EMULATOR
    • 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 approved by marketing by adding the Waiting for Copy label for a copy review on the original GH to get the correct copy.
    • 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 form input styles:
    • I verified that all the inputs inside a form are aligned with each other.
    • I added Design label 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

image

Android: mWeb Chrome
iOS: Native

image

iOS: mWeb Safari

image

MacOS: Chrome / Safari

image

MacOS: Desktop

image

@tgolen
Copy link
Contributor Author

tgolen commented Jan 8, 2024

Got stuck with the TS errors. There is a draft PR for Onyx which will probably be required: Expensify/react-native-onyx#445

@tgolen tgolen changed the title Add the data to be loaded from onyx Load parent report action from Onyx for report action HOC Jan 12, 2024
@tgolen
Copy link
Contributor Author

tgolen commented Jan 12, 2024

Now that Expensify/react-native-onyx#446 is merged, I need to update Onyx to 1.0.126 and finish this up.

@tgolen tgolen changed the title Load parent report action from Onyx for report action HOC Load parent report action from withOnyx in report action HOC Jan 12, 2024
@aimane-chnaif
Copy link
Contributor

Onyx version will be bumped in #33554. I am currently doing regression test

@@ -200,10 +199,4 @@ FlagCommentPage.displayName = 'FlagCommentPage';
export default compose(
withLocalize,
withReportAndReportActionOrNotFound,
withOnyx({
Copy link
Contributor Author

Choose a reason for hiding this comment

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

This can be removed because the parentReportAction comes from withReportAndReportActionOrNotFound now.

@tgolen tgolen self-assigned this Jan 12, 2024
@tgolen tgolen marked this pull request as ready for review January 12, 2024 21:47
@tgolen tgolen requested a review from a team as a code owner January 12, 2024 21:47
@melvin-bot melvin-bot bot removed the request for review from a team January 12, 2024 21:48
Copy link

melvin-bot bot commented Jan 12, 2024

@amyevans 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 requested a review from amyevans January 12, 2024 21:48
@luacmartins luacmartins self-requested a review January 15, 2024 17:02
@amyevans
Copy link
Contributor

@aimane-chnaif are you planning to provide a C+ review on this PR? Or should I complete the checklist?

Onyx version will be bumped in #33554. I am currently doing regression test

Looks like this got merged, @tgolen want to merge main? That should clear up the package.json/package-lock.json diff and hopefully the Snyk failures

@aimane-chnaif
Copy link
Contributor

@amyevans sure I can review

Copy link
Contributor

@luacmartins luacmartins left a comment

Choose a reason for hiding this comment

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

Changes LGTM. Agree with @amyevans that we should merge main to get rid of the Onyx diff.

@aimane-chnaif
Copy link
Contributor

I will do checklist after sync with main and unit tests are fixed

@tgolen
Copy link
Contributor Author

tgolen commented Jan 16, 2024

OK, I should be able to get this updated today.

@tgolen tgolen requested a review from luacmartins February 6, 2024 16:21
luacmartins
luacmartins previously approved these changes Feb 6, 2024
@aimane-chnaif
Copy link
Contributor

@tgolen please pull main. Hope that would fix perf-tests

Copy link
Contributor

@aimane-chnaif aimane-chnaif left a comment

Choose a reason for hiding this comment

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

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 approved by marketing by adding the Waiting for Copy label for a copy review on the original GH to get the correct copy.
    • 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 form input styles:
    • I verified that all the inputs inside a form are aligned with each other.
    • I added Design label 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
android.mov
Android: mWeb Chrome
mchrome.mov
iOS: Native
ios.mov
iOS: mWeb Safari
msafari.mov
MacOS: Chrome / Safari
Screen.Recording.2024-02-08.at.11.29.50.AM.mov
MacOS: Desktop
desktop.mov

@melvin-bot melvin-bot bot requested a review from marcochavezf February 8, 2024 10:33
Copy link

melvin-bot bot commented Feb 8, 2024

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

Copy link

melvin-bot bot commented Feb 8, 2024

🎯 @aimane-chnaif, thanks for reviewing and testing this PR! 🎉

An E/App issue has been created to issue payment here: #36119.

@aimane-chnaif
Copy link
Contributor

@tgolen still there's case when not found page briefly shows

Repro step:

  1. Go to any flag comment page
  2. Copy url
  3. Logout
  4. Enter url
  5. Login with same account
  6. Verify that app goes to flag comment page deeplink directly
Screen.Recording.2024-02-08.at.11.29.50.AM.mov

Copy link
Contributor

@luacmartins luacmartins left a comment

Choose a reason for hiding this comment

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

Seems like we have an edge case

@tgolen
Copy link
Contributor Author

tgolen commented Feb 8, 2024

I think that edgecase is fine. Do either of you feel strongly about improving that? I'll fix the conflicts this morning.

@aimane-chnaif
Copy link
Contributor

I think that edgecase is fine. Do either of you feel strongly about improving that? I'll fix the conflicts this morning.

yes if we have straightforward solution.
Otherwise someone will report this as regression

@tgolen
Copy link
Contributor Author

tgolen commented Feb 8, 2024

Practically thinking through it, when is a real user ever going to enter that flow? And if they do, what are the consequences when they do? I think it's highly unlikely anyone would ever encounter it in the real world, and the worst that can happen when they do is they see a not-found page while the report loads. IMO it is too low value to worry about. I would also explain that to anyone who reports it as a regression.

@aimane-chnaif
Copy link
Contributor

ok agree with you.
TLDR; This might also happen on Split bill detail page (tested this page as well but not reproduced yet) which uses withReportAndReportActionOrNotFound HOC

@luacmartins
Copy link
Contributor

I agree that it's enough of an edge case for it to be low value.

@tgolen
Copy link
Contributor Author

tgolen commented Feb 8, 2024

Thanks for hearing me out.

I fixed the conflicts. It was caused because both files were migrated to TS. That probably means it's worth having another last look at the code before shipping it.

@luacmartins
Copy link
Contributor

Changes LGTM. @aimane-chnaif wanna test again before we ship?

Copy link
Contributor

@aimane-chnaif aimane-chnaif left a comment

Choose a reason for hiding this comment

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

:shipit:

Screen.Recording.2024-02-08.at.7.59.05.PM.mov

@luacmartins
Copy link
Contributor

Thanks! Merging!

@luacmartins luacmartins merged commit 2988851 into main Feb 8, 2024
19 checks passed
@luacmartins luacmartins deleted the tgolen-refactor-hocsideloading branch February 8, 2024 19:02
@OSBotify
Copy link
Contributor

OSBotify commented Feb 8, 2024

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

🚀 Deployed to staging by https://github.com/luacmartins in version: 1.4.40-0 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/mountiny in version: 1.4.40-5 🚀

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

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.

5 participants