fix: Remove withCurrentReportID HOC #54702

etCoderDysto · 2025-01-01T06:33:52Z

Explanation of Change

In this PR we replace withCurrentReportID HOC with useCurrentReportID hook, and remove the withCurrentReportID HOC from withCurrentReportID.tsx

Fixed Issues

$ #50510
PROPOSAL: #50510 (comment)

Tests

Same as QA steps

Verify that no errors appear in the JS console

Offline tests

Same as QA steps

QA Steps

// TODO: These must be filled out, or the issue title must include "[No QA]."

Verify that no errors appear in the JS console

Navigate to LHN
Open a report
Verify that you are navigated to the report you have opened from the LHN
Send a message
Reply in thread
Click 'from' link on header
Verify that you are returned to the right parent message report
Try opening other reports form LHN
Verify that you are navigated to the right report

PR Author Checklist

Screenshots/Videos

Android: Native

android.mp4

Android: mWeb Chrome

android.chrome.mp4

iOS: Native

iOS.mp4

iOS: mWeb Safari

ios.safari.mp4

MacOS: Chrome / Safari

web.mp4

MacOS: Desktop

Desktop.mp4

…eportID-usage

melvin-bot · 2025-01-01T07:12:36Z

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

etCoderDysto · 2025-01-01T07:30:15Z

~~I am working the changed files ESLint error.~~ ✅

dominictb · 2025-01-02T15:55:47Z

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

Screen.Recording.2025-01-02.at.22.51.57.mov

Android: mWeb Chrome

Screen.Recording.2025-01-02.at.22.44.35.mov

iOS: Native

Screen.Recording.2025-01-02.at.22.50.29.mov

iOS: mWeb Safari

Screen.Recording.2025-01-02.at.22.46.35.mov

MacOS: Chrome / Safari

Screen.Recording.2025-01-02.at.22.42.16.mov

MacOS: Desktop

Screen.Recording.2025-01-02.at.22.54.19.mov

luacmartins · 2025-01-02T16:10:04Z

src/components/withCurrentReportID.tsx

-import type {ComponentType, ForwardedRef, RefAttributes} from 'react';
-import React, {createContext, forwardRef, useCallback, useMemo, useState} from 'react';
-import getComponentDisplayName from '@libs/getComponentDisplayName';
+import React, {createContext, useCallback, useMemo, useState} from 'react';


Isn't the idea to just get rid of this whole file? I only see one place using updateCurrentReportID, which could also be removed if I'm not mistaken.

@luacmartins I don't think we can remove updateCurrentReportID. We are using updateCurrentReportID to update the currentReportID when there is a navigation state change. That helps sync the LHN item focused on LHN, and the currently opened report. If we don't do that, when select an item from LHN, the corresponding report will be opened but the LHN item won't be focused. The issue video is can be found at the bottom.

We call updateCurrentReportID with the new navigation state 

App/src/libs/Navigation/NavigationRoot.tsx

Lines 172 to 173 in 04cd7b0

setTimeout(() => {

currentReportIDValue?.updateCurrentReportID(state);

Then we get the new navigation’s reportID here and updated currentReportID with the new navigation state reportID

App/src/components/withCurrentReportID.tsx

Lines 28 to 30 in 575a66d

const updateCurrentReportID = useCallback(

(state: NavigationState) => {

const reportID = Navigation.getTopmostReportId(state);

Then LHN item will be updated with the new currentReportID, and the right item will be focused.  

App/src/components/LHNOptionsList/OptionRowLHNData.tsx

Line 36 in 04cd7b0

const isReportFocused = isFocused && currentReportIDValue?.currentReportID === reportID;

But, I believe we can move CurrentReportIDContextProviderfrom withCurrentReportID.tsx to useCurrentReportID.tsx and delete withCurrentReportID.tsx file. Should I do that?

POC

Screen.Recording.2025-01-03.at.1.49.03.in.the.afternoon.mp4

Yes, I think we'd want to move from the HOC to the hook fully. Let's migrate that code.

Sure! I will do that.

dominictb · 2025-01-07T03:00:46Z

@etCoderDysto What is the ETA for this?

etCoderDysto · 2025-01-07T09:12:30Z

@etCoderDysto What is the ETA for this?

Sorry for the delay. I will make the changes my by tomorrow.

luacmartins · 2025-01-07T18:05:54Z

Thanks! Looking forward to the update

…urrentReportID

…n app.tsx

…ince it is not used anywhere else

…it is not used anywhere else

etCoderDysto · 2025-01-07T20:09:54Z

@dominictb @luacmartins PR is ready for further review. I have migrated all the code form withCurrentReportID to useCurrentReportID, and deleted withCurrentReportID.

dominictb · 2025-01-08T02:47:13Z

looks good

OSBotify · 2025-01-08T16:46:11Z

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

github-actions · 2025-01-10T03:57:52Z

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

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

github-actions · 2025-01-11T03:25:38Z

🚀 Deployed to production by https://github.com/thienlnam in version: 9.0.83-5 🚀

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

github-actions · 2025-01-13T13:58:59Z

🚀 Deployed to production by https://github.com/thienlnam in version: 9.0.83-5 🚀

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

etCoderDysto added 3 commits December 31, 2024 11:27

remove with withCurrentReportID from ReportScreen

0bd8984

remove withCurrentReportID HOC from withCurrentReportID file

cf74dcc

Merge remote-tracking branch 'upstream/main' into remove-withCurrentR…

34508e9

…eportID-usage

etCoderDysto marked this pull request as ready for review January 1, 2025 07:12

etCoderDysto requested a review from a team as a code owner January 1, 2025 07:12

melvin-bot bot requested a review from dominictb January 1, 2025 07:12

melvin-bot bot removed the request for review from a team January 1, 2025 07:12

etCoderDysto added 2 commits January 1, 2025 13:16

fix lint

7edd16a

fix typecheck

575a66d

dominictb approved these changes Jan 2, 2025

View reviewed changes

melvin-bot bot requested a review from luacmartins January 2, 2025 15:56

luacmartins requested changes Jan 2, 2025

View reviewed changes

luacmartins self-requested a review January 7, 2025 18:05

etCoderDysto added 9 commits January 7, 2025 22:07

move CurrentReportIDContextProvider and all other code blocks to useC…

a024e36

…urrentReportID

use CurrentReportIDContextProvider exported from useCurrentReportID i…

d248160

…n app.tsx

move named exports at the bottom of the file

dc4c422

use CurrentReportIDContextProvider from useCurrentReportID hook

6408eb7

remove CurrentReportIDContext from useCurrentReportID named exports s…

ba9e6de

…ince it is not used anywhere else

remove withCurrentReportIDDefaultProps from useCurrentReportID since …

5d6082f

…it is not used anywhere else

CurrentReportIDContextValue from useCurrentReportId

952a9c3

delete withCurrentReportID hoc

cca8360

Merge branch 'main' into remove-withCurrentReportID-usage

3a3b5d5

luacmartins approved these changes Jan 8, 2025

View reviewed changes

luacmartins merged commit 24c0237 into Expensify:main Jan 8, 2025
16 checks passed

github-actions bot mentioned this pull request Jan 10, 2025

Deploy Checklist: New Expensify 2025-01-10 #55051

Closed

54 tasks

melvin-bot bot mentioned this pull request Jan 11, 2025

[HOLD for payment 2025-01-18] [$250] Remove withCurrentReportID HOC #50510

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: Remove withCurrentReportID HOC #54702

fix: Remove withCurrentReportID HOC #54702

etCoderDysto commented Jan 1, 2025 •

edited

Loading

melvin-bot bot commented Jan 1, 2025

etCoderDysto commented Jan 1, 2025 •

edited

Loading

dominictb commented Jan 2, 2025

luacmartins Jan 2, 2025

etCoderDysto Jan 3, 2025

luacmartins Jan 3, 2025

etCoderDysto Jan 7, 2025

dominictb commented Jan 7, 2025

etCoderDysto commented Jan 7, 2025

luacmartins commented Jan 7, 2025

etCoderDysto commented Jan 7, 2025

dominictb commented Jan 8, 2025

OSBotify commented Jan 8, 2025

github-actions bot commented Jan 10, 2025

github-actions bot commented Jan 11, 2025

github-actions bot commented Jan 13, 2025

	setTimeout(() => {
	currentReportIDValue?.updateCurrentReportID(state);

	const updateCurrentReportID = useCallback(
	(state: NavigationState) => {
	const reportID = Navigation.getTopmostReportId(state);

fix: Remove withCurrentReportID HOC #54702

fix: Remove withCurrentReportID HOC #54702

Conversation

etCoderDysto commented Jan 1, 2025 • edited Loading

Explanation of Change

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Jan 1, 2025

etCoderDysto commented Jan 1, 2025 • edited Loading

dominictb commented Jan 2, 2025

Reviewer Checklist

Screenshots/Videos

luacmartins Jan 2, 2025

Choose a reason for hiding this comment

etCoderDysto Jan 3, 2025

Choose a reason for hiding this comment

luacmartins Jan 3, 2025

Choose a reason for hiding this comment

etCoderDysto Jan 7, 2025

Choose a reason for hiding this comment

dominictb commented Jan 7, 2025

etCoderDysto commented Jan 7, 2025

luacmartins commented Jan 7, 2025

etCoderDysto commented Jan 7, 2025

dominictb commented Jan 8, 2025

OSBotify commented Jan 8, 2025

github-actions bot commented Jan 10, 2025

github-actions bot commented Jan 11, 2025

github-actions bot commented Jan 13, 2025

etCoderDysto commented Jan 1, 2025 •

edited

Loading

etCoderDysto commented Jan 1, 2025 •

edited

Loading