feat: migrate PressableWithSecondaryInteraction to function component #25398

BeeMargarida · 2023-08-17T13:55:09Z

Details

Refactored PressableWithSecondaryInteraction (web) from class to function component

Fixed Issues

$ #16192

Tests

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
- If we are not using the full Onyx data that we loaded, I've added the proper selector in order to ensure the component only re-renders when the data it is using changes
- 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 author checklist, including those that don't apply to this PR.

Screenshots/Videos

Web

safari_t.mp4

chrome_t.mp4

Mobile Web - Chrome

mchrome_t.mp4

Mobile Web - Safari

msafari_t.mp4

Desktop

desktop_t.mp4

iOS

ios_t.mp4

Android

android_t.mp4

src/components/PressableWithSecondaryInteraction/index.js

melvin-bot · 2023-08-17T15:10:27Z

@0xmiroslav @marcaaron One of you needs to 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]

0xmiros

Looks good

src/components/PressableWithSecondaryInteraction/index.js

BeeMargarida · 2023-08-21T12:45:32Z

Updated 👍

marcaaron · 2023-08-22T19:46:19Z

@0xmiroslav working on the checklist? Lmk when this is ready for me 🙇‍♂️

BeeMargarida · 2023-08-25T08:43:52Z

@0xmiroslav Any update?

BeeMargarida · 2023-08-28T09:09:49Z

I'll be OOO this week, but someone from Callstack will pick this up if necessary

0xmiros · 2023-08-31T11:01:27Z

Please add any test case affected by this PR in QA step

0xmiros · 2023-08-31T12:05:39Z

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

mchrome.mov

Mobile Web - Safari

msafari.mov

Desktop

desktop.mov

iOS

ios.mov

Android

android.mov

0xmiros

LGTM!

marcaaron · 2023-09-01T21:53:20Z

I believe we are on a merge freeze at the moment so I am holding for a bit - unless this fixes a critical bug or something.

…eraction-to-functional

BeeMargarida · 2023-09-11T08:45:35Z

PR updated with main, ready for merge

BeeMargarida · 2023-09-13T09:13:56Z

@0xmiroslav @marcaaron Pinging about this, so that it does not get forgotten

0xmiros · 2023-09-13T09:20:26Z

Please also re-test after merging main

BeeMargarida · 2023-09-13T09:26:54Z

Please also re-test after merging main

Re-tested, seems to be working fine 👍

BeeMargarida · 2023-09-15T09:26:33Z

@0xmiroslav Hi, any update? Is anything blocking this?

0xmiros · 2023-09-15T09:30:58Z

LGTM! Already approved by me.

melvin-bot · 2023-09-15T20:22:46Z

@marcaaron looks like this was merged without a test passing. Please add a note explaining why this was done and remove the Emergency label if this is not an emergency.

OSBotify · 2023-09-15T20:27:40Z

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

0xmiros · 2023-09-16T07:00:10Z

@BeeMargarida Seems like our PR caused console error in Hoverable component. Can you please check?

Repro step: hover LHN option items

Screen.Recording.2023-09-16.at.8.58.55.AM.mov

0xmiros · 2023-09-16T07:06:18Z

Also, emoji reaction right click not working

Screen.Recording.2023-09-16.at.9.04.13.AM.mov

0xmiros · 2023-09-16T07:30:58Z

src/components/PressableWithSecondaryInteraction/index.js

-            e.preventDefault();
+        if (forwardedRef) {
+            if (_.isFunction(forwardedRef)) {
+                forwardedRef(pressableRef);


Suggested change

forwardedRef(pressableRef);

forwardedRef(pressableRef.current);

I think this will fix both issues

raised PR for this fix: #27576

OSBotify · 2023-09-18T10:40:03Z

🚀 Deployed to staging by https://github.com/marcaaron in version: 1.3.71-0 🚀

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

OSBotify · 2023-09-20T08:12:33Z

🚀 Deployed to production by https://github.com/thienlnam in version: 1.3.71-12 🚀

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

feat: migrate PressableWithSecondaryInteraction to function component

d1391af

fabioh8010 reviewed Aug 17, 2023

View reviewed changes

src/components/PressableWithSecondaryInteraction/index.js Outdated Show resolved Hide resolved

src/components/PressableWithSecondaryInteraction/index.js Outdated Show resolved Hide resolved

src/components/PressableWithSecondaryInteraction/index.js Outdated Show resolved Hide resolved

BeeMargarida added 3 commits August 17, 2023 15:14

refactor: code improvements

aa4e245

refactor: simplify

dfd1896

fix: add missing comment

46d11cf

BeeMargarida requested a review from fabioh8010 August 17, 2023 14:19

thiagobrez reviewed Aug 17, 2023

View reviewed changes

src/components/PressableWithSecondaryInteraction/index.js Outdated Show resolved Hide resolved

thiagobrez reviewed Aug 17, 2023

View reviewed changes

src/components/PressableWithSecondaryInteraction/index.js Outdated Show resolved Hide resolved

refactor: simplify

c1dd861

BeeMargarida requested a review from thiagobrez August 17, 2023 14:36

thiagobrez reviewed Aug 17, 2023

View reviewed changes

src/components/PressableWithSecondaryInteraction/index.js Outdated Show resolved Hide resolved

BeeMargarida added 2 commits August 17, 2023 15:48

revert: useEffect dependencies

56aff08

docs: add more info to onSecondaryInteraction doc

3a0f647

BeeMargarida marked this pull request as ready for review August 17, 2023 15:10

BeeMargarida requested a review from a team as a code owner August 17, 2023 15:10

melvin-bot bot requested review from 0xmiros and marcaaron and removed request for a team and fabioh8010 August 17, 2023 15:10

0xmiros reviewed Aug 21, 2023

View reviewed changes

src/components/PressableWithSecondaryInteraction/index.js Show resolved Hide resolved

revert: restore comment

ba3fc9b

0xmiros approved these changes Aug 31, 2023

View reviewed changes

Merge branch 'main' into feat/16192-migrate-pressableWithSecondaryInt…

0692a55

…eraction-to-functional

marcaaron approved these changes Sep 15, 2023

View reviewed changes

marcaaron merged commit 5fb9a0f into Expensify:main Sep 15, 2023

melvin-bot bot added the Emergency label Sep 15, 2023

0xmiros reviewed Sep 16, 2023

View reviewed changes

0xmiros mentioned this pull request Sep 16, 2023

fix wrong pass of pressable ref #27576

Merged

59 tasks

Pluto0104 mentioned this pull request Sep 17, 2023

[$500] Dev: Web - Right clicking on the LHN no longer opens the context menu #27625

Closed

6 tasks

OSBotify mentioned this pull request Sep 18, 2023

Deploy Checklist: New Expensify 2023-09-18 #27654

Closed

91 tasks

melvin-bot bot mentioned this pull request Sep 20, 2023

[HOLD for payment 2023-09-27] [$250] Migrate PressableWithSecondaryInteraction/index.js to function component #16192

Closed

1 task

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: migrate PressableWithSecondaryInteraction to function component #25398

feat: migrate PressableWithSecondaryInteraction to function component #25398

BeeMargarida commented Aug 17, 2023 •

edited

Loading

melvin-bot bot commented Aug 17, 2023

0xmiros left a comment

BeeMargarida commented Aug 21, 2023

marcaaron commented Aug 22, 2023

BeeMargarida commented Aug 25, 2023

BeeMargarida commented Aug 28, 2023

0xmiros commented Aug 31, 2023

0xmiros commented Aug 31, 2023

0xmiros left a comment

marcaaron commented Sep 1, 2023

BeeMargarida commented Sep 11, 2023

BeeMargarida commented Sep 13, 2023

0xmiros commented Sep 13, 2023

BeeMargarida commented Sep 13, 2023

BeeMargarida commented Sep 15, 2023

0xmiros commented Sep 15, 2023

melvin-bot bot commented Sep 15, 2023

OSBotify commented Sep 15, 2023

0xmiros commented Sep 16, 2023

0xmiros commented Sep 16, 2023

0xmiros Sep 16, 2023

0xmiros Sep 16, 2023

OSBotify commented Sep 18, 2023

OSBotify commented Sep 20, 2023

	forwardedRef(pressableRef);
	forwardedRef(pressableRef.current);

feat: migrate PressableWithSecondaryInteraction to function component #25398

feat: migrate PressableWithSecondaryInteraction to function component #25398

Conversation

BeeMargarida commented Aug 17, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Aug 17, 2023

0xmiros left a comment

Choose a reason for hiding this comment

BeeMargarida commented Aug 21, 2023

marcaaron commented Aug 22, 2023

BeeMargarida commented Aug 25, 2023

BeeMargarida commented Aug 28, 2023

0xmiros commented Aug 31, 2023

0xmiros commented Aug 31, 2023

Reviewer Checklist

Screenshots/Videos

0xmiros left a comment

Choose a reason for hiding this comment

marcaaron commented Sep 1, 2023

BeeMargarida commented Sep 11, 2023

BeeMargarida commented Sep 13, 2023

0xmiros commented Sep 13, 2023

BeeMargarida commented Sep 13, 2023

BeeMargarida commented Sep 15, 2023

0xmiros commented Sep 15, 2023

melvin-bot bot commented Sep 15, 2023

OSBotify commented Sep 15, 2023

0xmiros commented Sep 16, 2023

0xmiros commented Sep 16, 2023

0xmiros Sep 16, 2023

Choose a reason for hiding this comment

0xmiros Sep 16, 2023

Choose a reason for hiding this comment

OSBotify commented Sep 18, 2023

OSBotify commented Sep 20, 2023

BeeMargarida commented Aug 17, 2023 •

edited

Loading