Remove export ReportUtil.getReport function #43632

nkdengineer · 2024-06-13T05:49:13Z

Details

Use useOnyx() to load the data in view components
Use Onyx.connect() to load the data in other action files
Remove the usage of ReportUtils.getReport() and prevent it from being exported by adding a test to EnforceActionExportRestrictions.ts

Fixed Issues

$ #40316
PROPOSAL: #40316 (comment)

Tests

Verify that getReport function isn't exported and is only used in the local action files
Verify that we use useOnyx() to load the data in view components

Ancestor test

As user A create a group chat with user B
Open the group chat and send a message
Reply in thread of the message above
Verify that the thread divider line is clickable and tap on it will get the user go to the correct ancestor report
Mention user C in the thread and then invite this user to the thread
As user C open the thread and verify that the thread divider line is not clickable

Copy to clipboard test

Submit an expense
Hover or long press on the report preview action and select Copy to clipboard
Paste the message to the composer and verify that the copied message is correct

Verify that no errors appear in the JS console

Offline tests

Same as above

QA Steps

Ancestor test

As user A create a group chat with user B
Open the group chat and send a message
Reply in thread of the message above
Verify that the thread divider line is clickable and tap on it will get the user go to the correct ancestor report
Mention user C in the thread and then invite this user to the thread
As user C open the thread and verify that the thread divider line is not clickable

Copy to clipboard test

Submit an expense
Hover or long press on the report preview action and select Copy to clipboard
Paste the message to the composer and verify that the copied message is correct

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Android: Native

Ancestor test

Screen.Recording.2024-06-13.at.12.53.18.mov

Copy to clipboard test

Screen.Recording.2024-06-13.at.12.53.50.mov

Android: mWeb Chrome

Ancestor test

Screen.Recording.2024-06-13.at.12.52.34.mov

Copy to clipboard test

Screen.Recording.2024-06-13.at.12.52.46.mov

iOS: Native

Ancestor test

Screen.Recording.2024-06-13.at.13.01.31.mov

Copy to clipboard test

Screen.Recording.2024-06-13.at.13.01.50.mov

iOS: mWeb Safari

Ancestor test

Screen.Recording.2024-06-13.at.12.54.51.mov

Copy to clipboard test

Screen.Recording.2024-06-13.at.12.55.07.mov

MacOS: Chrome / Safari

Ancestor test

Screen.Recording.2024-06-13.at.12.51.14.mov

Copy to clipboard test

Screen.Recording.2024-06-13.at.12.51.27.mov

MacOS: Desktop

Ancestor test

Screen.Recording.2024-06-13.at.12.58.30.mov

Copy to clipboard test

Screen.Recording.2024-06-13.at.12.58.40.mov

melvin-bot · 2024-06-13T06:02:41Z

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

s77rt · 2024-06-14T00:31:35Z

src/components/HTMLEngineProvider/HTMLRenderers/MentionReportRenderer.tsx

@@ -61,7 +59,7 @@ function MentionReportRenderer({style, tnode, TDefaultRenderer, reports, ...defa
    const htmlAttributeReportID = tnode.attributes.reportid;

    const currentReportID = useCurrentReportID();
-    const currentReport = getReport(currentReportID?.currentReportID);
+    const [currentReport] = useOnyx(`${ONYXKEYS.COLLECTION.REPORT}${currentReportID?.currentReportID}`);


getReport returns either the report or the draft report. Are we sure that in this case we are only interested in the report? (Please double check on other instances too). You may refer to #40668 and its PRs to see where we may need to fallback to the draft report.

@s77rt I checked the mentioned PR when investigating this PR. The draft report is only used when we move transaction from track expense. It will be cleared in optimistic data when we confirm to move the transaction from track expense and it's not used to display any other UI of the App.

src/components/Attachments/AttachmentCarousel/extractAttachments.ts

src/libs/OptionsListUtils.ts

src/libs/actions/IOU.ts

src/libs/actions/Report.ts

src/libs/actions/Task.ts

src/pages/home/ReportScreen.tsx

src/pages/home/report/ContextMenu/BaseReportActionContextMenu.tsx

src/pages/home/report/ReportActionItemParentAction.tsx

s77rt · 2024-06-15T11:11:01Z

There is a function getReportPolicyID that we should remove as well

Co-authored-by: Abdelhafidh Belalia <16493223+s77rt@users.noreply.github.com>

nkdengineer · 2024-06-17T04:22:09Z

@s77rt I updated. please help to check again.

src/components/Attachments/AttachmentCarousel/index.native.tsx

src/components/Attachments/AttachmentCarousel/index.tsx

src/libs/ReportUtils.ts

tests/actions/EnforceActionExportRestrictions.ts

s77rt · 2024-06-17T18:00:55Z

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

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

s77rt · 2024-06-17T18:02:00Z

After creating a group chat the app crashes

Screen.Recording.2024-06-17.at.6.48.44.PM.mov

Co-authored-by: Abdelhafidh Belalia <16493223+s77rt@users.noreply.github.com>

nkdengineer · 2024-06-18T08:00:00Z

@s77rt I fixed the bug above and updated your suggestion, please help to check again.

src/components/HTMLEngineProvider/HTMLRenderers/MentionReportRenderer.tsx

src/components/LHNOptionsList/OptionRowLHN.tsx

src/pages/home/report/ReportAttachments.tsx

src/pages/home/report/SystemChatReportFooterMessage.tsx

src/pages/iou/HoldReasonPage.tsx

s77rt · 2024-06-18T15:08:12Z

Bug: Can't submit an expense (IOU info keep resetting)

Screen.Recording.2024-06-18.at.4.06.57.PM.mov

nkdengineer · 2024-06-19T03:51:44Z

@s77rt I updated to fallback reportID to -1

Bug: Can't submit an expense (IOU info keep resetting)

I can't reproduce this bug now.

src/components/LHNOptionsList/OptionRowLHN.tsx

src/components/SettlementButton.tsx

tgolen · 2024-06-19T15:33:21Z

src/libs/ReportUtils.ts

@@ -1227,7 +1227,8 @@ function isClosedExpenseReportWithNoExpenses(report: OnyxEntry<Report>): boolean
 /**
 * Whether the provided report is an archived room
 */
-function isArchivedRoom(report: OnyxInputOrEntry<Report> | EmptyObject, reportNameValuePairs?: OnyxInputOrEntry<ReportNameValuePairs> | EmptyObject): boolean {
+function isArchivedRoom(reportOrID: OnyxInputOrEntry<Report> | EmptyObject | string, reportNameValuePairs?: OnyxInputOrEntry<ReportNameValuePairs> | EmptyObject): boolean {


I was looking at this one (and also isInvoiceRoom above) and I don't really like that the first param could be either a reportID (string) or a report (object). It makes the code feel much less uncertain and if I was looking at it, I'd be wondering when I should use a reportID vs just a report. Some suggestions I have:

Keep it two separate parameters for clarity (reportID, report)

Make two separate methods

Anywhere that is only using the reportID, have it get the report from the collection first and then these methods would only have a report parameter.

I was looking at this one (and also isInvoiceRoom above) and I don't really like that the first param could be either a reportID (string) or a report (object). It makes the code feel much less uncertain and if I was looking at it, I'd be wondering when I should use a reportID vs just a report. Some suggestions I have:

It's the same way we use for other functions like isMoneyRequestReport, isMoneyRequest,...

OK, I don't think that is a pattern that we should be following, so let's not do it here.

@tgolen I updated with two separate methods.

src/libs/actions/ReportActions.ts

tgolen

Thanks!

tgolen · 2024-06-20T12:41:00Z

I really appreciate you stepping in and taking this one over.

OSBotify · 2024-06-20T12:51:07Z

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

war-in · 2024-06-21T10:23:29Z

Hi all 👋 I think this PR broke the room mentions 😅
Currently, reports on the main are displayed as IDs

This is the draft PR which should fix the issue.
Please let me know if the issue should be created and who should I ping 🙏

nkdengineer · 2024-06-21T10:43:46Z

@war-in I can take this and raise a PR to fix this issue.

nkdengineer · 2024-06-21T10:49:22Z

@war-in Or you can mention this issue #40316 in link issue of proposal description. So the current C+ and internal of our issue can be assigned.

war-in · 2024-06-21T10:50:37Z

@war-in Or you can mention this issue #40316 in link issue of proposal description. So the current C+ and internal of our issue can be assigned.

Thanks for linking! I'll write a comment there :)

OSBotify · 2024-06-21T21:43:34Z

🚀 Deployed to staging by https://github.com/tgolen in version: 9.0.1-0 🚀

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

OSBotify · 2024-06-25T19:44:11Z

🚀 Deployed to production by https://github.com/yuwenmemon in version: 9.0.1-19 🚀

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

Remove export ReportUtil.getReport function

ab30c65

nkdengineer marked this pull request as ready for review June 13, 2024 06:02

nkdengineer requested a review from a team as a code owner June 13, 2024 06:02

melvin-bot bot requested review from s77rt and removed request for a team June 13, 2024 06:02

nkdengineer mentioned this pull request Jun 13, 2024

[HOLD for payment 2024-07-10] [HOLD for payment 2024-07-02] [$500] Remove exported ReportUtils.getReport() #40316

Closed

s77rt reviewed Jun 14, 2024

View reviewed changes

merge main

febcc44

s77rt suggested changes Jun 15, 2024

View reviewed changes

src/pages/home/report/ReportActionItemParentAction.tsx Outdated Show resolved Hide resolved

src/pages/home/report/ReportActionItemParentAction.tsx Outdated Show resolved Hide resolved

nkdengineer and others added 4 commits June 17, 2024 10:46

Merge branch 'main' into fix/40316

248662d

rename function

395f4a0

Update src/pages/home/report/ReportActionItemParentAction.tsx

d202401

Co-authored-by: Abdelhafidh Belalia <16493223+s77rt@users.noreply.github.com>

Update src/pages/home/report/ReportActionItemParentAction.tsx

a4edb06

Co-authored-by: Abdelhafidh Belalia <16493223+s77rt@users.noreply.github.com>

nkdengineer added 2 commits June 17, 2024 17:04

Merge branch 'main' into fix/40316

b81d971

remove unnecessary test

be3b5ad

s77rt suggested changes Jun 17, 2024

View reviewed changes

nkdengineer and others added 5 commits June 18, 2024 14:31

Merge branch 'main' into fix/40316

80d887b

Update src/components/Attachments/AttachmentCarousel/index.native.tsx

0eac7b7

Co-authored-by: Abdelhafidh Belalia <16493223+s77rt@users.noreply.github.com>

Update src/components/Attachments/AttachmentCarousel/index.tsx

d6aa995

Co-authored-by: Abdelhafidh Belalia <16493223+s77rt@users.noreply.github.com>

rename function

91b8570

fix app crash bug

55e868b

nkdengineer added 2 commits June 18, 2024 15:01

edit comment

72ba079

fix lint

834d19a

edit comment

65bba3d

s77rt suggested changes Jun 18, 2024

View reviewed changes

nkdengineer added 3 commits June 19, 2024 10:23

merge main

6056602

resolve conflict

ae9f408

fallback reportID to -1

82204dd

s77rt approved these changes Jun 19, 2024

View reviewed changes

melvin-bot bot requested a review from tgolen June 19, 2024 11:40

tgolen requested changes Jun 19, 2024

View reviewed changes

nkdengineer commented Jun 19, 2024

View reviewed changes

src/libs/actions/ReportActions.ts Show resolved Hide resolved

nkdengineer added 3 commits June 20, 2024 10:23

Merge branch 'main' into fix/40316

e293b98

edit comment

0c14761

create a separate method

45a3c12

tgolen approved these changes Jun 20, 2024

View reviewed changes

tgolen merged commit 9a6019a into Expensify:main Jun 20, 2024
17 checks passed

war-in mentioned this pull request Jun 21, 2024

[HOLD for payment 2024-07-10] [HOLD for payment 2024-07-02] Mention - Report mention #admins is not styled when editing comment in room chat #42521

Closed

6 tasks

github-actions bot mentioned this pull request Jun 21, 2024

Deploy Checklist: New Expensify 2024-06-21 #44186

Closed

bernhardoj mentioned this pull request Jul 16, 2024

Fix: Add red dot to one transaction reports #44810

Merged

50 tasks

nkdengineer mentioned this pull request Sep 25, 2024

[$125] Remove deprecated ReportActionUtils.getParentReportAction method #49551

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Remove export ReportUtil.getReport function #43632

Remove export ReportUtil.getReport function #43632

nkdengineer commented Jun 13, 2024 •

edited

Loading

melvin-bot bot commented Jun 13, 2024

s77rt Jun 14, 2024

nkdengineer Jun 14, 2024

s77rt commented Jun 15, 2024

nkdengineer commented Jun 17, 2024

s77rt commented Jun 17, 2024 •

edited

Loading

s77rt commented Jun 17, 2024

nkdengineer commented Jun 18, 2024

s77rt commented Jun 18, 2024

nkdengineer commented Jun 19, 2024

tgolen Jun 19, 2024

nkdengineer Jun 19, 2024

tgolen Jun 19, 2024

nkdengineer Jun 20, 2024

tgolen left a comment

tgolen commented Jun 20, 2024

OSBotify commented Jun 20, 2024

war-in commented Jun 21, 2024

nkdengineer commented Jun 21, 2024

nkdengineer commented Jun 21, 2024

war-in commented Jun 21, 2024

OSBotify commented Jun 21, 2024

OSBotify commented Jun 25, 2024

Remove export ReportUtil.getReport function #43632

Remove export ReportUtil.getReport function #43632

Conversation

nkdengineer commented Jun 13, 2024 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Jun 13, 2024

s77rt Jun 14, 2024

Choose a reason for hiding this comment

nkdengineer Jun 14, 2024

Choose a reason for hiding this comment

s77rt commented Jun 15, 2024

nkdengineer commented Jun 17, 2024

s77rt commented Jun 17, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

s77rt commented Jun 17, 2024

nkdengineer commented Jun 18, 2024

s77rt commented Jun 18, 2024

nkdengineer commented Jun 19, 2024

tgolen Jun 19, 2024

Choose a reason for hiding this comment

nkdengineer Jun 19, 2024

Choose a reason for hiding this comment

tgolen Jun 19, 2024

Choose a reason for hiding this comment

nkdengineer Jun 20, 2024

Choose a reason for hiding this comment

tgolen left a comment

Choose a reason for hiding this comment

tgolen commented Jun 20, 2024

OSBotify commented Jun 20, 2024

war-in commented Jun 21, 2024

nkdengineer commented Jun 21, 2024

nkdengineer commented Jun 21, 2024

war-in commented Jun 21, 2024

OSBotify commented Jun 21, 2024

OSBotify commented Jun 25, 2024

nkdengineer commented Jun 13, 2024 •

edited

Loading

s77rt commented Jun 17, 2024 •

edited

Loading