Change Display Name to Functional Component #20953

srikarparsi · 2023-06-16T23:40:56Z

Details

Fixed Issues

$ #16141

Tests

Open New Dot
Ensure that the display names are shown properly
On web and desktop, ensure that hovering over the name displays a tooltip with the right data.

Verify that no errors appear in the JS console

Offline tests

QA Steps

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 / Chrome
- iOS / native
- iOS / 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 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(themeColors.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 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 author checklist, including those that don't apply to this PR.

Screenshots/Videos

Web

Mobile Web - Chrome

Mobile Web - Safari

Desktop

iOS

Android

melvin-bot · 2023-06-16T23:41:01Z

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

aimane-chnaif · 2023-06-20T14:33:24Z

@srikarparsi is this ready for review? Lint failing.

srikarparsi · 2023-06-20T17:02:57Z

Hi @aimane-chnaif, I just added it as a draft to finish working on later but I should get this ready to review today and will ping you once I do.

srikarparsi · 2023-07-06T06:16:06Z

Hi @gedu! I tried addressing the feedback in this comment but didn't completely understand one thing. Why can't getTooltipShiftX(index) be called inside a lamda function as shiftHorizontal={() => getTooltipShiftX(index)}? I may have missed some other things as well as I am still learning about React Hooks so please let me know if I have missed any other changes.

srikarparsi · 2023-07-06T16:41:57Z

@aimane-chnaif @gedu, can we make this useCallback have an empty dependency array? containerLayout and childRefs don't change except when the component is mounted so not sure if we have to include them in the dependency array.

aimane-chnaif · 2023-07-06T16:45:44Z

can we make this useCallback have an empty dependency array?

No problem as long as it doesn't need recalculation during component lifecycle. but just make sure to add additional comment (https://github.com/Expensify/App/blob/main/contributingGuides/STYLE.md#what-is-the-exhaustive-deps-lint-rule-can-i-ignore-it).

merge main to run

gedu · 2023-07-06T23:41:12Z

Hi @gedu! I tried addressing the feedback in this #16141 (comment) but didn't completely understand one thing. Why can't getTooltipShiftX(index) be called inside a lamda function as shiftHorizontal={() => getTooltipShiftX(index)}? I may have missed some other things as well as I am still learning about React Hooks so please let me know if I have missed any other changes.

Because the component TooltipRenderedOnPageBody uses that props as dependency of the useMemo and that lamda isn't a stable function, it gets recreated after every frame, so will re-executed the hook

srikarparsi · 2023-07-12T06:00:32Z

Hi @gedu! I tried finding a couple of ways to avoid using the lambda function but I couldn't find any good ones. The only option I could come find is getTooltipShiftX.bind(null, index) but I believe this has the same problem of copying the function. I'm not sure if I'm overlooking something simple but would you recommend an approach to avoid the lambda?

gedu · 2023-07-12T06:31:20Z

Hi @gedu! I tried finding a couple of ways to avoid using the lambda function but I couldn't find any good ones. The only option I could come find is getTooltipShiftX.bind(null, index) but I believe this has the same problem of copying the function. I'm not sure if I'm overlooking something simple but would you recommend an approach to avoid the lambda?

Yes, first I would split the component because if tooltipEnabled is false we don't need any state, callbacks, etc.

function DisplayNames(props) {
    if (!props.tooltipEnabled) {
        return (
            <DisplayNamesWithoutTooltip
                textStyles={props.textStyles}
                numberOfLines={props.numberOfLines}
                fullTitle={props.fullTitle}
            />
        );
    }

    // eslint-disable-next-line react/jsx-props-no-spreading
    return <DisplayNamesTooltip {...props} />;
}

Then in the _.map I would create a new Component to handle better this lambda function

function UserTooltipItem(props) {
    const tooltipIndexBridge = useCallback(() => props.getTooltipShiftX(index), [props.getTooltipShiftX, props.index]);

    return (
        <Fragment key={props.index}>
            <UserDetailsTooltip
                // props
                shiftHorizontal={tooltipIndexBridge}
            >
            // All the code from _.map
 }

And you use it like:

_.map(props.displayNamesWithTooltips, ({displayName, accountID, avatar, login}, index) => (
                      <UserTooltipItem key={index} getTooltipShiftX={getTooltipShiftX} //pass the props you need />
))}

Hope this makes sense

srikarparsi · 2023-07-13T03:51:41Z

Thanks for the tip @gedu! I went ahead with your advice and created a bridge function within the map so that we're not re-creating the getTooltipShiftX function on multiple renders. I did keep it all in the same component though since I didn't think it was worth creating a new UserToolTipItem component to handle this functionality.

I also do agree that we should split the component based on tooltipEnabled but I think this should be done in a different PR as I think it would make sense to focus on just the refactor to a functional component.

Do you think you could take a look at this whenever you get a chance? @gedu @aimane-chnaif

gedu · 2023-07-13T06:41:57Z

@srikarparsi you have a Lint error, you can't have useCallback inside of a callback

gedu · 2023-07-14T14:27:05Z

I also do agree that we should split the component based on tooltipEnabled but I think this should be done in a different PR

Just notice this, In my opinion, there is no better time than now while refactoring the component, you don't even have to create a new file, can be in the same file, but well I think could be @aimane-chnaif call

created a function for usertooltipitem

srikarparsi · 2023-07-17T08:25:43Z

Just notice this, In my opinion, there is no better time than now while refactoring the component, you don't even have to create a new file, can be in the same file, but well I think could be @aimane-chnaif call

Yeah that is true I agree, I'll ask internally to make sure that refactoring components as a whole can be done with refactoring to functional components as we usually like to keep PRs focussed and will make the change if all is okay. I'll also fix lint with this change.

aimane-chnaif

There are several lint errors to fix

Screen.Recording.2023-07-20.at.7.30.00.AM.mov

srikarparsi · 2023-07-24T03:04:10Z

Hi @aimane-chnaif, yeah I changed the title to "WIP (work in progress)" because I was working on some other bugs but I'll fix these and re-request review tomorrow or the day after.

gedu · 2023-08-02T10:21:05Z

I think it is in good shape, great job migrating the component.

I'm not in a C+ role, just supporting here so the final call will be from @aimane-chnaif , who will be checking and testing deeper than me

srikarparsi · 2023-08-03T19:18:14Z

Hi @aimane-chnaif, can you please take a look at this whenever you get a chance

aimane-chnaif · 2023-08-04T08:59:49Z

reviewing shortly

srikarparsi · 2023-08-08T05:48:54Z

bump @aimane-chnaif

srikarparsi · 2023-08-10T06:00:32Z

Hi @aimane-chnaif, did you have a chance to look at this? If you're busy, please let me know and I can ask if there are other C+s who have a spare cycle.

aimane-chnaif · 2023-08-11T07:06:01Z

I will review this by end of this week

aimane-chnaif

Looks good. Just minor feedback:

Also, please pull main

src/components/DisplayNames/DisplayNamesWithTooltip.js

merge main

srikarparsi · 2023-08-17T02:28:18Z

Thanks @aimane-chnaif, made those changes so this is ready for re-review.

aimane-chnaif · 2023-08-17T07:37:28Z

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 / Chrome
- iOS / native
- iOS / 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(themeColors.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 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

Web

web.mov

Mobile Web - Chrome

Mobile Web - Safari

Desktop

desktop.mov

iOS

Android

aimane-chnaif

LGTM 🎉

melvin-bot · 2023-08-17T07:38:33Z

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

PauloGasparSv

LGTM, tested on Web too and is working fine!

OSBotify · 2023-08-17T13:43:09Z

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

OSBotify · 2023-08-21T22:26:13Z

🚀 Deployed to staging by https://github.com/PauloGasparSv in version: 1.3.56-0 🚀

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

OSBotify · 2023-08-24T03:09:14Z

🚀 Deployed to production by https://github.com/roryabraham in version: 1.3.56-24 🚀

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

abdulrahuman5196 · 2023-10-10T15:57:56Z

src/components/DisplayNames/DisplayNamesWithTooltip.js

+        setIsEllipsisActive(
+            containerRef.current && containerRef.current.offsetWidth && containerRef.current.scrollWidth && containerRef.current.offsetWidth < containerRef.current.scrollWidth,
+        );
+    }, []);


Ellipsis is not updated when the fullTitle prop is changed which is lead to this issue - #27545

Change Display Name to Functional Component

5b427bb

srikarparsi requested a review from a team as a code owner June 16, 2023 23:40

melvin-bot bot requested review from aimane-chnaif and removed request for a team June 16, 2023 23:40

srikarparsi added 2 commits July 6, 2023 01:59

fix linter issues

82e25ab

wrap getTooltipShiftX in useCallback

02f8551

don't unnecessarily re-render getTooltipShiftX function

b0c6a0a

srikarparsi added 4 commits July 6, 2023 12:53

empty dependency array

819e2bd

prettier

bf44327

Merge branch 'main' into srikar-refactorDisplayNames

2fb8276

merge main to run

wrap childRefs in useRef and fix imports

d232719

srikarparsi changed the title ~~[Draft][WIP]Change Display Name to Functional Component~~ Change Display Name to Functional Component Jul 6, 2023

remove use of lambda function for getTooltipShiftX

b614760

moved UserTooltipItem to a different component

6438951

created a function for usertooltipitem

srikarparsi changed the title ~~Change Display Name to Functional Component~~ [WIP] Change Display Name to Functional Component Jul 17, 2023

aimane-chnaif reviewed Jul 20, 2023

View reviewed changes

srikarparsi requested a review from aimane-chnaif August 1, 2023 17:24

srikarparsi added 4 commits August 2, 2023 10:34

incorporate changes from pr 23990

36e042b

merge conflict

0385a63

add missed import

2f91a58

prettier

562f809

srikarparsi self-assigned this Aug 2, 2023

aimane-chnaif reviewed Aug 15, 2023

View reviewed changes

src/components/DisplayNames/DisplayNamesWithTooltip.js Outdated Show resolved Hide resolved

src/components/DisplayNames/DisplayNamesWithTooltip.js Outdated Show resolved Hide resolved

srikarparsi added 2 commits August 16, 2023 22:17

Merge branch 'main' into srikar-refactorDisplayNames

310b932

merge main

remove containerRef dependency and wrap toolTipShift in useCallback

3d44ae0

prettier

040cf96

aimane-chnaif approved these changes Aug 17, 2023

View reviewed changes

melvin-bot bot requested review from PauloGasparSv and removed request for gedu August 17, 2023 07:38

PauloGasparSv approved these changes Aug 17, 2023

View reviewed changes

PauloGasparSv merged commit 63d87ba into main Aug 17, 2023

PauloGasparSv deleted the srikar-refactorDisplayNames branch August 17, 2023 13:38

OSBotify mentioned this pull request Aug 21, 2023

Deploy Checklist: New Expensify 2023-08-21 #25625

Closed

abdulrahuman5196 reviewed Oct 10, 2023

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Change Display Name to Functional Component #20953

Change Display Name to Functional Component #20953

srikarparsi commented Jun 16, 2023 •

edited

Loading

melvin-bot bot commented Jun 16, 2023

aimane-chnaif commented Jun 20, 2023

srikarparsi commented Jun 20, 2023

srikarparsi commented Jul 6, 2023

srikarparsi commented Jul 6, 2023

aimane-chnaif commented Jul 6, 2023

gedu commented Jul 6, 2023

srikarparsi commented Jul 12, 2023

gedu commented Jul 12, 2023

srikarparsi commented Jul 13, 2023

gedu commented Jul 13, 2023

gedu commented Jul 14, 2023

srikarparsi commented Jul 17, 2023 •

edited

Loading

aimane-chnaif left a comment

srikarparsi commented Jul 24, 2023

gedu commented Aug 2, 2023

srikarparsi commented Aug 3, 2023

aimane-chnaif commented Aug 4, 2023

srikarparsi commented Aug 8, 2023

srikarparsi commented Aug 10, 2023 •

edited

Loading

aimane-chnaif commented Aug 11, 2023

aimane-chnaif left a comment •

edited

Loading

srikarparsi commented Aug 17, 2023

aimane-chnaif commented Aug 17, 2023

aimane-chnaif left a comment

melvin-bot bot commented Aug 17, 2023

PauloGasparSv left a comment

OSBotify commented Aug 17, 2023

OSBotify commented Aug 21, 2023

OSBotify commented Aug 24, 2023

abdulrahuman5196 Oct 10, 2023

Change Display Name to Functional Component #20953

Change Display Name to Functional Component #20953

Conversation

srikarparsi commented Jun 16, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Jun 16, 2023

aimane-chnaif commented Jun 20, 2023

srikarparsi commented Jun 20, 2023

srikarparsi commented Jul 6, 2023

srikarparsi commented Jul 6, 2023

aimane-chnaif commented Jul 6, 2023

gedu commented Jul 6, 2023

srikarparsi commented Jul 12, 2023

gedu commented Jul 12, 2023

srikarparsi commented Jul 13, 2023

gedu commented Jul 13, 2023

gedu commented Jul 14, 2023

srikarparsi commented Jul 17, 2023 • edited Loading

aimane-chnaif left a comment

Choose a reason for hiding this comment

srikarparsi commented Jul 24, 2023

gedu commented Aug 2, 2023

srikarparsi commented Aug 3, 2023

aimane-chnaif commented Aug 4, 2023

srikarparsi commented Aug 8, 2023

srikarparsi commented Aug 10, 2023 • edited Loading

aimane-chnaif commented Aug 11, 2023

aimane-chnaif left a comment • edited Loading

Choose a reason for hiding this comment

srikarparsi commented Aug 17, 2023

aimane-chnaif commented Aug 17, 2023

Reviewer Checklist

Screenshots/Videos

aimane-chnaif left a comment

Choose a reason for hiding this comment

melvin-bot bot commented Aug 17, 2023

PauloGasparSv left a comment

Choose a reason for hiding this comment

OSBotify commented Aug 17, 2023

OSBotify commented Aug 21, 2023

OSBotify commented Aug 24, 2023

abdulrahuman5196 Oct 10, 2023

Choose a reason for hiding this comment

srikarparsi commented Jun 16, 2023 •

edited

Loading

srikarparsi commented Jul 17, 2023 •

edited

Loading

srikarparsi commented Aug 10, 2023 •

edited

Loading

aimane-chnaif left a comment •

edited

Loading