Refactor FlagCommentPage to access parent report directly from Onyx #38356

tgolen · 2024-03-14T20:22:22Z

Fixed Issues

Part of #27262

Tests

Sign into NewDot as User A
Send a message from User B to User A
As User A, open up the new message in a thread
Verify you can flag the first message in the thread as offensive

Verify that no errors appear in the JS console

Offline tests

Same as the above

QA Steps

Same as the above

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

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

melvin-bot · 2024-03-14T20:22:49Z

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

ishpaul777 · 2024-03-14T20:27:44Z

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

Record_2024-03-15-02-50-55.mp4

Android: mWeb Chrome

Record_2024-03-15-03-00-44.mp4

iOS: Native

Screen.Recording.2024-03-15.at.2.26.20.AM.mov

iOS: mWeb Safari

Screen.Recording.2024-03-15.at.2.37.32.AM.mov

MacOS: Chrome / Safari

Screen.Recording.2024-03-15.at.2.39.15.AM.mov

MacOS: Desktop

Screen.Recording.2024-03-15.at.3.29.28.AM.mov

ishpaul777 · 2024-03-14T20:28:30Z

Lint and tests failing :(

tgolen · 2024-03-14T20:34:55Z

Oops, sorry! Fixed them and updated the branch.

ishpaul777 · 2024-03-14T20:35:50Z

Thank you!

ishpaul777 · 2024-03-14T20:44:28Z

tests/actions/EnforceActionExportRestrictions.js

Can we use ts ?

oh i see there are type errors as methods are undefined

Oh, good suggestion! I didn't even think of it. Let me try.

tgolen · 2024-03-14T20:52:35Z

Updated with tests written in TS

ishpaul777 · 2024-03-14T21:01:05Z

src/libs/actions/Task.ts

+function getParentReport(report: OnyxEntry<OnyxTypes.Report> | EmptyObject): OnyxEntry<OnyxTypes.Report> | EmptyObject {
+    if (!report?.parentReportID) {
+        return {};
+    }
+    return allReports?.[`${ONYXKEYS.COLLECTION.REPORT}${report.parentReportID}`] ?? {};
+}


I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)

Seems we are intentionally doing this, but just mentioning...

The correct pattern to use is that every file will use it's own withOnyx or Onyx.connect() to access the Onyx data it needs. This prevents data from becoming stale

found this explaination justifiable 👌

Thanks for pointing it out!

ishpaul777 · 2024-03-14T21:23:27Z

Bug: I see Not-found page on flag as offensive page for a second for android. video:

Record_2024-03-15-02-50-55.mp4

tgolen · 2024-03-14T21:45:41Z

Hm, are you sure that's not happening before? The not-found component doesn't appear to depend on the parentReport at all, so nothing should have changed for it.

ishpaul777 · 2024-03-14T21:53:48Z

just checked on main, can reproduce i'll report in slack if there's no issue already 👍

ishpaul777

LGTM!

melvin-bot · 2024-03-14T22:01:52Z

@MariaHCD 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 · 2024-03-14T22:01:55Z

🎯 @ishpaul777, thanks for reviewing and testing this PR! 🎉

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

arosiclair

LGTM. Looking forward to this reducing pesky dependency cycles 👍

OSBotify · 2024-03-18T16:30:58Z

🚀 Deployed to staging by https://github.com/arosiclair in version: 1.4.54-0 🚀

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

OSBotify · 2024-03-19T23:12:02Z

🚀 Deployed to production by https://github.com/AndrewGable in version: 1.4.54-4 🚀

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

tgolen added 5 commits March 14, 2024 12:29

Mark method as deprecated

2bfd0b5

Get parent report from onyx

94e658f

Remove outside calls for getting parent report

f5f252c

Enforce that method should never be exported

26766e7

Fix TS errors and DRY code

4f24c58

tgolen self-assigned this Mar 14, 2024

tgolen requested a review from a team as a code owner March 14, 2024 20:22

melvin-bot bot removed the request for review from a team March 14, 2024 20:22

melvin-bot bot requested a review from arosiclair March 14, 2024 20:22

Fix import path and style

444e68d

ishpaul777 reviewed Mar 14, 2024

View reviewed changes

tgolen added 2 commits March 14, 2024 14:51

Write tests in TS

4e597ab

Fix typo

b5da053

tgolen mentioned this pull request Mar 14, 2024

Remove ReportActionsUtils.getParentReportAction(), ReportUtils.getParentReport(), TransactionUtils.getLinkedTransaction(), ReportUtils.getPolicy(), and TransactionUtils.getTransaction() #27262

Closed

25 tasks

ishpaul777 reviewed Mar 14, 2024

View reviewed changes

ishpaul777 approved these changes Mar 14, 2024

View reviewed changes

melvin-bot bot requested a review from MariaHCD March 14, 2024 22:01

melvin-bot bot mentioned this pull request Mar 14, 2024

[HOLD FOR PAYMENT MAR 26] Payment issue for E/App PR#38356 #38360

Closed

MariaHCD approved these changes Mar 15, 2024

View reviewed changes

arosiclair approved these changes Mar 15, 2024

View reviewed changes

arosiclair merged commit 80e5c70 into main Mar 15, 2024

arosiclair deleted the tgolen-refactor-sideloading-flagcommentpage branch March 15, 2024 14:13

github-actions bot mentioned this pull request Mar 18, 2024

Deploy Checklist: New Expensify 2024-03-18 #38489

Closed

65 tasks

Refactor FlagCommentPage to access parent report directly from Onyx #38356

Refactor FlagCommentPage to access parent report directly from Onyx #38356

Uh oh!

Conversation

tgolen commented Mar 14, 2024

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

Uh oh!

melvin-bot bot commented Mar 14, 2024

Uh oh!

ishpaul777 commented Mar 14, 2024 • edited by MariaHCD Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer Checklist

Screenshots/Videos

Uh oh!

ishpaul777 commented Mar 14, 2024

Uh oh!

tgolen commented Mar 14, 2024

Uh oh!

ishpaul777 commented Mar 14, 2024

Uh oh!

ishpaul777 Mar 14, 2024

Choose a reason for hiding this comment

Uh oh!

ishpaul777 Mar 14, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

tgolen Mar 14, 2024

Choose a reason for hiding this comment

Uh oh!

tgolen commented Mar 14, 2024

Uh oh!

ishpaul777 Mar 14, 2024

Choose a reason for hiding this comment

Uh oh!

ishpaul777 Mar 14, 2024

Choose a reason for hiding this comment

Uh oh!

tgolen Mar 14, 2024

Choose a reason for hiding this comment

Uh oh!

ishpaul777 commented Mar 14, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

tgolen commented Mar 14, 2024

Uh oh!

ishpaul777 commented Mar 14, 2024

Uh oh!

ishpaul777 left a comment

Choose a reason for hiding this comment

Uh oh!

melvin-bot bot commented Mar 14, 2024

Uh oh!

melvin-bot bot commented Mar 14, 2024

Uh oh!

arosiclair left a comment

Choose a reason for hiding this comment

Uh oh!

OSBotify commented Mar 18, 2024

Uh oh!

OSBotify commented Mar 19, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

ishpaul777 commented Mar 14, 2024 •

edited by MariaHCD

Loading

ishpaul777 Mar 14, 2024 •

edited

Loading

ishpaul777 commented Mar 14, 2024 •

edited

Loading