Component refactor: migrate PopoverWithMeasuredContent to function component

[alexxxwork]

Details

Migrate PopoverWithMeasuredContent to function component

Fixed Issues

$ #16191
PROPOSAL: #16191 (comment)

Tests

1. Open a chat
2. Send a message
3. Right-click the message
4. Verify that a context menu appears

• Verify that no errors appear in the JS console

Offline tests

QA Steps

1. Open a chat
2. Send a message
3. Right-click the message
4. Verify that a context menu appears

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

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

This logic is not correct. Previously this was used with the window dimensions props.

[alexxxwork]

@s77rt This is not a replace. We change withWindowDimensions to useWindowDimensions hook so hoc is not needed anymore. And we had a shouldComponentUpdate here

App/src/components/PopoverWithMeasuredContent.js

Lines 97 to 105 in e2e4057

	shouldComponentUpdate(nextProps, nextState) {
	if (this.props.isVisible && (nextProps.windowWidth !== this.props.windowWidth || nextProps.windowHeight !== this.props.windowHeight)) {
	return true;
	}
	// This component does not require re-render until any prop or state changes as we get the necessary info
	// at first render. This component is attached to each message on the Chat list thus we prevent its re-renders
	return !_.isEqual(_.omit(this.props, ['windowWidth', 'windowHeight']), _.omit(nextProps, ['windowWidth', 'windowHeight'])) || !_.isEqual(this.state, nextState);
	}

which is replaced with React.memo with props comparing function.

[s77rt]

What I meant is the comparison logic is not correct. prevProps.isVisible && !_.isEqual(prevProps, nextProps) this makes no sense and it seems to be the cause of a regression, the floating action button is broken.

[alexxxwork]

I think I'd better return windowWidth/Height props to handle this update logic - if isVisible update only on dimensions change.

[s77rt]

Let's use the hook and for the React.memo() we can omit the function parameters. The "do not update if only window dimensions change" is useless, the component will pretty much already re-render because we are passing a lot of changing data (e.g. anchorPosition is always a new object).

[alexxxwork]

No, this leads to a regression with browser window dimensions change. I'll fix the logic

[s77rt]

Interesting bug. We should fix that bug instead of hiding it. Any ideas yet on the root cause?

[alexxxwork]

@s77rt I think the root cause is that shiftedAnchorPosition left/top could be <0 on some updates. You could see it if you add console.log right before return and leave React.memo without props comparing function. So it seems to be not hiding the bug but prevent unnecessary updates.

[s77rt]

@alexxxwork This still does not explain the root cause. Something is not right, the whole content changes.

[alexxxwork]

@s77rt Last commit fixes a regression in popover position on browser window dimensions change.

[s77rt]

@alexxxwork Any update here? (regarding #22868 (comment))

[alexxxwork]

@s77rt The content changes specifically for context menu, where PopoverWithMeasuredContent is just a wrapping component and it seems to prevent updates that cause content changes in child component - BaseReportActionContextMenu. Content changes because the number of options are determined with the filter here:

App/src/pages/home/report/ContextMenu/BaseReportActionContextMenu.js

Lines 93 to 103 in 6bcd184

	{_.map(_.filter(ContextMenuActions, shouldShowFilter), (contextAction) => {
	const closePopup = !this.props.isMini;
	const payload = {
	reportAction: this.props.reportAction,
	reportID: this.props.reportID,
	draftMessage: this.props.draftMessage,
	selection: this.props.selection,
	close: () => this.setState({shouldKeepOpen: false}),
	openContextMenu: () => this.setState({shouldKeepOpen: true}),
	interceptAnonymousUser,
	};

And after some updates this filter shows only two options. This is caused by these props changing for BaseReportActionContextMenu:

            this.props.reportAction,
            this.props.anchor,
            this.props.reportID,
            this.props.isPinnedChat,
            this.props.isUnreadChat

Props are changing because they are in state in this component PopoverReportActionContextMenu.js here:

App/src/pages/home/report/ContextMenu/PopoverReportActionContextMenu.js

Lines 306 to 319 in 4a8b431

	<BaseReportActionContextMenu
	isVisible
	type={this.state.type}
	reportID={this.state.reportID}
	reportAction={this.state.reportAction}
	draftMessage={this.state.reportActionDraftMessage}
	selection={this.state.selection}
	isArchivedRoom={this.state.isArchivedRoom}
	isChronosReport={this.state.isChronosReport}
	isPinnedChat={this.state.isPinnedChat}
	isUnreadChat={this.state.isUnreadChat}
	anchor={this.contextMenuTargetNode}
	contentRef={this.contentRef}
	/>

So I think we should also convert this component to functional to ensure no regressions arise.

[alexxxwork]

The state in PopoverReportActionMenu is cleared by this callback here:

App/src/pages/home/report/ContextMenu/PopoverReportActionContextMenu.js

Line 298 in 4a8b431

onModalHide={this.runAndResetOnPopoverHide}

[s77rt]

@alexxxwork Can you please explain how is this component effected by others only when it's being a functional component. It's weird. I would expect identical behaviour whether this is written as a functional component or a class component.

[alexxxwork]

@s77rt There's an additional mount/unmount cycle of the component before the context menu opens if we use react.memo without a props comparing function. So when we see the context menu the state variables of the reportID in PopoverReportActionContextMenu is already "0" as if we close the context menu. So when it is updated it changes content.

[s77rt]

@alexxxwork Is onModalHide being called while it's open? Any suggestion on how we can fix that? It does seem like we are looking at some kind of a hidden bug

[alexxxwork]

@s77rt the additional mount/unmount cycle comes from PopoverWithMeasuredContent - it is called with wrong isContentMeasured value so Popover (and Modal in it) gets unmounted which was unintended by its design.
We can fix it replacing getDerivedStateFromProps in a right way (according to guide here):

    if (!isVisible && props.isVisible) {
        setIsVisible(() => { 
            setIsContentMeasured(props.popoverDimensions.width > 0 && props.popoverDimensions.height > 0);
            return true;
        });
    }

this check should run on every component update

Should I add these changes and keep React.memo with props comparing?

[s77rt]

@alexxxwork How would changing the dependencies solve this issue? The underlying logic will stay the same.

[alexxxwork]

@s77rt the issue comes from unmounting of child components of PopoverWithMeasuredContent. What dependencies do you mean?

[alexxxwork]

@s77rt please test latest commit

[s77rt]

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

Mobile Web - Chrome

Mobile Web - Safari

Desktop

iOS

Android

[s77rt]

LGTM! 🚀

[OSBotify]

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

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

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

[OSBotify]

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

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

[OSBotify]

🚀 Deployed to production by https://github.com/marcaaron in version: 1.3.46-2 🚀

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

[OSBotify]

🚀 Deployed to production by https://github.com/Beamanator in version: 1.3.47-6 🚀

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