Remove the side-loading of data in Task action from the ReportActionUtils by tgolen · Pull Request #37340 · Expensify/App

tgolen · 2024-02-27T18:58:33Z

Details

This will ensure that the Task action is using data that it is directly connected to.

Fixed Issues

Part of #27262

Tests

Sign into NewDot
Assign a task to someone
Delete that task
Verify it was deleted

Verify that no errors appear in the JS console

Offline tests

Same as the tests.

QA Steps

Same as the tests

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 I was not able to test here due to broken emulator locally
- 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

2024-02-27_11-57-28.mp4

Android: mWeb Chrome

iOS: Native

2024-02-27_11-35-33.mp4

iOS: mWeb Safari

2024-02-27_11-31-01.mp4

MacOS: Chrome / Safari

2024-02-27_11-24-56.mp4

MacOS: Desktop

2024-02-27_11-29-15.mp4

melvin-bot · 2024-02-27T18:59:04Z

@youssef-lr 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]

jjcoffee · 2024-02-28T11:06:59Z

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-native-2024-02-28_16.11.40.mp4

Android: mWeb Chrome

android-chrome-2024-02-28_16.16.53.mp4

iOS: Native

ios-native-2024-02-28_16.04.54.mp4

iOS: mWeb Safari

ios-safari-2024-02-28_16.06.39.mp4

MacOS: Chrome / Safari

desktop-chrome-2024-02-28_15.57.23.mp4

MacOS: Desktop

desktop-app-2024-02-28_16.01.58.mp4

jjcoffee

Tests well & LGTM!

melvin-bot · 2024-02-28T15:18:10Z

@cead22 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-02-28T15:18:14Z

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

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

youssef-lr

LGTM

cead22 · 2024-02-28T20:59:34Z

src/libs/actions/Task.ts

+/**
+ * Returns the parentReportAction if the given report is a thread/task.
+ *
+ * @deprecated Use Onyx.connect() or withOnyx() instead


Why is this deprecated if it's new?

Oops, this is copy/paste. I'll remove it.

cead22 · 2024-02-28T21:01:34Z

src/libs/actions/Task.ts

+ * @deprecated Use Onyx.connect() or withOnyx() instead
+ */
+function getParentReportAction(report: OnyxEntry<OnyxTypes.Report>): ReportAction | Record<string, never> {
+    if (!report?.parentReportID || !report.parentReportActionID) {


Why do we need to check for parentReportID? Can you explain in a comment?

Comment added (but it's kind of self-explanatory too when you look at the next line and see how those properties are used).

cead22 · 2024-02-28T21:06:53Z

src/libs/actions/Task.ts

+ *
+ * @deprecated Use Onyx.connect() or withOnyx() instead
+ */
+function getParentReportAction(report: OnyxEntry<OnyxTypes.Report>): ReportAction | Record<string, never> {


Would it be possible and make sense to pass Report here and to deleteTask instead of OnyxEntry<OnyxTypes.Report>, so that we don't have to check report?? It looks like we only call deleteTask in one place

It looks like before we were using props.report.reportName and not props.report?.reportName

I could revert the changes in deleteTask to go back to using const taskReport = ReportUtils.getReport(taskReportID); which returns a Report and not a OnyxEntry<OnyxTypes.Report>, but here is why I removed it.

The view already has the full report object from Onyx

The view was passing 4 properties of the report object to deleteTask and then getting the full report object from ReportUtils.getReport()

This is inefficient and leads to really bad code and possibly stale data

By using the same report reference in all the methods, it's assured that the report object will always be correct

Oh yeah I think the change you made was an improvement, so I wasn't suggesting reverting back to the old version, just to go from getParentReportAction(report: OnyxEntry<OnyxTypes.Report>): to getParentReportAction(report: Report):, and remove a lot of ? that would be unnecessary. Is that doable?

You can't simply cast one type to another like that, but I asked about it in Slack and I at least found a way to remove all the optional chaining by adding an early return at the beginning of the method.

That works. I was thinking not just updating the param type --that was to illustrate what I meant, but also the function call Session.checkIfActionIsAllowed(Task.deleteTask(props.report));, with something like Session.checkIfActionIsAllowed(Task.deleteTask(props.report as Report)); or whatever TS magic helps with that.

I like checking before and returning early tho 👍

tgolen · 2024-03-04T18:10:31Z

@cead22 I merged main into this which fixed the failing TS check. This is ready to be merged now.

cead22 · 2024-03-04T18:19:18Z

👍 I was leaving it for Youssef

OSBotify · 2024-03-04T21:04:29Z

🚀 Deployed to staging by https://github.com/cead22 in version: 1.4.47-0 🚀

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

OSBotify · 2024-03-06T21:53:31Z

🚀 Deployed to production by https://github.com/roryabraham in version: 1.4.47-10 🚀

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

Refactor and simplify delete task

9870988

tgolen self-assigned this Feb 27, 2024

tgolen requested a review from a team as a code owner February 27, 2024 18:58

tgolen mentioned this pull request Feb 27, 2024

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

Closed

25 tasks

melvin-bot bot requested review from youssef-lr and removed request for a team February 27, 2024 18:59

tgolen requested a review from jjcoffee February 28, 2024 15:14

jjcoffee approved these changes Feb 28, 2024

View reviewed changes

melvin-bot bot requested a review from cead22 February 28, 2024 15:18

melvin-bot bot mentioned this pull request Feb 28, 2024

[HOLD for payment 2024-03-13] Payment issue for E/App PR#37340 #37433

Closed

youssef-lr previously approved these changes Feb 28, 2024

View reviewed changes

cead22 reviewed Feb 28, 2024

View reviewed changes

Improve comments

b47c44a

tgolen dismissed youssef-lr’s stale review via b47c44a February 28, 2024 22:26

tgolen added 2 commits February 29, 2024 12:09

Remove oiptional chaining

dc3aef2

Merge branch 'main' into tgolen-refactor-sideloading

f1dac85

cead22 approved these changes Feb 29, 2024

View reviewed changes

Merge branch 'main' into tgolen-refactor-sideloading

d172d48

cead22 merged commit 7ac41e5 into main Mar 4, 2024

cead22 deleted the tgolen-refactor-sideloading branch March 4, 2024 18:19

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

Deploy Checklist: New Expensify 2024-03-04 #37698

Closed

97 tasks

lanitochka17 mentioned this pull request Mar 5, 2024

[HIGH] [$500] Task - "This is the beginning of your chat" instead of last message shown in LHN after refreshing #37760

Closed

6 tasks

Conversation

tgolen commented Feb 27, 2024

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

Uh oh!

melvin-bot bot commented Feb 27, 2024

Uh oh!

jjcoffee commented Feb 28, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer Checklist

Screenshots/Videos

Uh oh!

jjcoffee left a comment

Choose a reason for hiding this comment

Uh oh!

melvin-bot bot commented Feb 28, 2024

Uh oh!

melvin-bot bot commented Feb 28, 2024

Uh oh!

youssef-lr left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

tgolen commented Mar 4, 2024

Uh oh!

cead22 commented Mar 4, 2024

Uh oh!

OSBotify commented Mar 4, 2024

Uh oh!

OSBotify commented Mar 6, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

jjcoffee commented Feb 28, 2024 •

edited

Loading