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

Remove exported getReport() #40523

Closed
wants to merge 19 commits into from
Closed

Conversation

gijoe0295
Copy link
Contributor

@gijoe0295 gijoe0295 commented Apr 19, 2024

Details

Remove exported getReport.

Fixed Issues

$ #40316
PROPOSAL: #40316 (comment)

Tests

  1. Test basic features of reports and report actions: New report, Order of reports in LHN, Send/Delete/Edit/Reply/Mark as unread message, Message context menu, Message notifications, Quick action, Hold IOU request,...
  2. Some edge cases: Fix - Add BA thread is missing Add button, incomplete thread header and "Hidden" user #38884, prevent offline navigation on money request report deletion #34320, https://github.com/Expensify/App/pull/28702/files#r1343844837
  • Verify that no errors appear in the JS console

Offline tests

NA

QA Steps

  1. Test basic features of reports and report actions: New report, Order of reports in LHN, Send/Delete/Edit/Reply/Mark as unread message, Message context menu, Message notifications, Quick action, Hold IOU request,...
  • 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-04-22.at.03.19.21-source.mov
Android: mWeb Chrome

Screenshot_1713729984

iOS: Native
Screen.Recording.2024-04-22.at.02.57.34-source.mov
Screen.Recording.2024-04-22.at.03.00.55-source.mov
iOS: mWeb Safari
Screen.Recording.2024-04-22.at.03.02.27-source.mov
MacOS: Chrome / Safari

Screenshot 2024-04-22 at 02 26 07
Screenshot 2024-04-22 at 02 39 43
Screenshot 2024-04-22 at 02 40 42
Screenshot 2024-04-22 at 02 43 41
Screenshot 2024-04-22 at 02 48 05
Screenshot 2024-04-22 at 02 49 08
Screenshot 2024-04-22 at 02 49 44

MacOS: Desktop
desktop.mov

@gijoe0295 gijoe0295 changed the title Gijoe/40316 Remove exported getReport() Apr 19, 2024
@gijoe0295 gijoe0295 marked this pull request as ready for review April 21, 2024 20:07
@gijoe0295 gijoe0295 requested a review from a team as a code owner April 21, 2024 20:07
@melvin-bot melvin-bot bot removed the request for review from a team April 21, 2024 20:07
Copy link

melvin-bot bot commented Apr 21, 2024

@s77rt 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 s77rt April 21, 2024 20:07
@gijoe0295
Copy link
Contributor Author

@s77rt Initial testing and performance comparison seems promising. Ready for your review.

Screenshot 2024-04-22 at 02 03 04

Copy link
Contributor

@s77rt s77rt left a comment

Choose a reason for hiding this comment

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

  • Resolve conflicts

src/components/LHNOptionsList/OptionRowLHN.tsx Outdated Show resolved Hide resolved
src/libs/actions/IOU.ts Outdated Show resolved Hide resolved
src/libs/actions/IOU.ts Outdated Show resolved Hide resolved
src/libs/actions/IOU.ts Outdated Show resolved Hide resolved
src/libs/actions/Report.ts Show resolved Hide resolved
src/pages/home/report/ContextMenu/ContextMenuActions.tsx Outdated Show resolved Hide resolved
src/libs/ReportUtils.ts Outdated Show resolved Hide resolved
src/libs/ReportUtils.ts Outdated Show resolved Hide resolved
Comment on lines 725 to 732
const parentReportSelector = (report: OnyxEntry<OnyxTypes.Report>): OnyxEntry<OnyxTypes.Report> =>
report && {
type: report.type,
reportID: report.reportID,
parentReportID: report.parentReportID,
parentReportActionID: report.parentReportActionID,
};

Copy link
Contributor

Choose a reason for hiding this comment

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

How did you choose this selector? As far as I can tell there is no indication on what fields we are using from parentReport

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I just deduced it from parentReport's usages and thought that might improve performance. But it's trivial anyway.

Copy link
Contributor Author

@gijoe0295 gijoe0295 Apr 23, 2024

Choose a reason for hiding this comment

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

I also saw a technique used for memoized report:

/**
* Create a lightweight Report so as to keep the re-rendering as light as possible by
* passing in only the required props.
*
* Also, this plays nicely in contrast with Onyx,
* which creates a new object every time collection changes. Because of this we can't
* put this into onyx selector as it will be the same.
*/

I think we should apply to parentReport as well. Wdyt?

Copy link
Contributor

Choose a reason for hiding this comment

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

That sounds good to me

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Updated!

if (!originalReportID || originalReportID === report.reportID) {
return;
}
const unsubscribeOnyx = onyxSubscribe({
Copy link
Contributor Author

Choose a reason for hiding this comment

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

@s77rt Instead of using reportOrID approach, I used onyxSubscribe to conditionally subscribe to originalReportID, subscription with withOnyx will increase the re-render count 40 times 😱.

Copy link
Contributor

Choose a reason for hiding this comment

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

Onyx.connect should not be used in components. Can you check for other options?

Copy link
Contributor Author

@gijoe0295 gijoe0295 Apr 26, 2024

Choose a reason for hiding this comment

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

Hmm but this is onyxSubscribe which I see was used a lot in components, for example ReportActionItemParentAction

Copy link
Contributor

Choose a reason for hiding this comment

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

The usage there also does not follow our Onyx practices.

@s77rt
Copy link
Contributor

s77rt commented May 6, 2024

@gijoe0295 Any update on the use of onyxSubscribe?

@@ -88,4 +84,13 @@ export default withOnyx<SystemChatReportFooterMessageProps, SystemChatReportFoot
key: ONYXKEYS.NVP_ACTIVE_POLICY_ID,
initialValue: null,
},
adminChatReport: {
key: ({activePolicyID, policies}) => {
Copy link
Contributor

Choose a reason for hiding this comment

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

activePolicyID and policies won't be available here. They are populated after withOnyx. Let's use useOnyx and we can avoid such problem

@@ -555,7 +574,7 @@ function ReportActionItem({
</ShowContextMenuContext.Provider>
);
} else if (action.actionName === CONST.REPORT.ACTIONS.TYPE.REIMBURSEMENT_QUEUED) {
const linkedReport = ReportUtils.isChatThread(report) ? ReportUtils.getReport(report.parentReportID) : report;
const linkedReport = ReportUtils.isChatThread(report) ? parentReport : report;
Copy link
Contributor

Choose a reason for hiding this comment

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

Looks we can get ride of the parentReport. We only need 2 props from the parent

  • reportID which can be replaced by report.parentReportID
  • ownerAccountID write an util function for that

@s77rt
Copy link
Contributor

s77rt commented May 15, 2024

@gijoe0295 Any updates on this?

@tgolen
Copy link
Contributor

tgolen commented May 17, 2024

@gijoe0295 What is the status of this PR? Can you please finish it up?

@gijoe0295
Copy link
Contributor Author

After the changes in #41465, reportDraft was included in getReport, I got to investigate further to see where it was used.

@s77rt
Copy link
Contributor

s77rt commented Jun 3, 2024

@gijoe0295 Any updates here?

@tgolen
Copy link
Contributor

tgolen commented Jun 7, 2024

@gijoe0295 What can I do to help get this moving along?

@gijoe0295 gijoe0295 closed this Jun 21, 2024
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.

3 participants