migrate CopyTextToClipboard to functional component by nhminhduc · Pull Request #20107 · Expensify/App

nhminhduc · 2023-06-02T22:43:35Z

Details

Fixed Issues

$ #16132
PROPOSAL: #16132 (comment)

Tests

Log in
Click to own avatar -> Go to profile in setting nav -> Contact method
The copy icon next to "receipts@expensify.com" use this component
Click to the copy icon
Paste message and check if message is in clipboard

Offline tests

Same as online

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

web.mp4

Mobile Web - Chrome

chrome.mp4

Mobile Web - Safari

safari.mov

Desktop

desktop.mov

iOS

ios.mov

Android

android.mov

melvin-bot · 2023-06-02T22:43:40Z

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

github-actions · 2023-06-02T22:43:51Z

CLA Assistant Lite bot All contributors have signed the CLA ✍️ ✅

nhminhduc · 2023-06-02T22:45:17Z

I have read the CLA Document and I hereby sign the CLA

PauloGasparSv · 2023-06-02T23:03:49Z

Re-opening this, I think it was closed by mistake : )

nhminhduc · 2023-06-02T23:42:43Z

@PauloGasparSv Tried to close+open to see if the check will go through :D

mollfpr · 2023-06-05T15:06:35Z

@nhminhduc Could you resolve the lint issues? Thanks!

mollfpr

Need to resolve the lint issue and other style problem. @nhminhduc If you using vscode, you can try the command "Format Document With..." > "Prettier - Code formatter".

mollfpr · 2023-06-05T15:19:02Z

-import withLocalize, {withLocalizePropTypes} from './withLocalize';
-import withDelayToggleButtonState, {withDelayToggleButtonStatePropTypes} from './withDelayToggleButtonState';
+import withLocalize, { withLocalizePropTypes } from './withLocalize';
+import withDelayToggleButtonState, { withDelayToggleButtonStatePropTypes } from './withDelayToggleButtonState';


@nhminhduc I think we don't add spaces between brackets.

Suggested change

import withDelayToggleButtonState, { withDelayToggleButtonStatePropTypes } from './withDelayToggleButtonState';

import withDelayToggleButtonState, {withDelayToggleButtonStatePropTypes} from './withDelayToggleButtonState';

mollfpr · 2023-06-05T15:20:09Z

+            <Text style={textStyles}>{`${text} `}</Text>
+            <Tooltip text={translate(`reportActionContextMenu.${isDelayButtonStateComplete ? 'copied' : 'copyToClipboard'}`)}>
+                <Pressable onPress={copyToClipboard}>
+                    {({ hovered, pressed }) => (


No spaces before/after bracket.

Suggested change

{({ hovered, pressed }) => (

{({hovered, pressed}) => (

mollfpr · 2023-06-05T15:21:28Z


    /** Styles to apply to the text */
-    // eslint-disable-next-line react/forbid-prop-types
    textStyles: PropTypes.arrayOf(PropTypes.object),


@nhminhduc Any reason to remove the lint disable?

Not really, it doesn't alert on my pc. But I added it again just in case.

mollfpr · 2023-06-05T15:27:58Z

-
-    copyToClipboard() {
-        if (this.props.isDelayButtonStateComplete) {
+const CopyTextToClipboard = ({ text, textStyles, translate, isDelayButtonStateComplete, toggleDelayButtonState }) => {


Don't destructure props or state. It makes the source of a given variable unclear. This guideline helps us quickly know which variables are from props, state, or from some other scope.

@nhminhduc Could you update these destruct props?

Fixed, using props instead.

mollfpr · 2023-06-05T15:57:12Z

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

20107.Web.mov

Mobile Web - Chrome

20107.mWeb.Chrome.mov

Mobile Web - Safari

20107.mWeb.Safari.mp4

Desktop

20107.Desktop.mov

iOS

20107.iOS.mp4

Android

20107.Android.mov

…ad of destruction

nhminhduc · 2023-06-05T20:32:40Z

Updated to keep up with main branch:
Using PressableWithDelayToggle component.

mollfpr · 2023-06-06T16:22:39Z

@nhminhduc Could you resolve the lint issue?

mollfpr · 2023-06-06T16:25:53Z

-        Clipboard.setString(this.props.text);
+const CopyTextToClipboard = (props) => {
+    const copyToClipboard = () => {
+        Clipboard.setString(props.text);


@nhminhduc @PauloGasparSv Do you guys agree if we wrap this with useCallback since it has dependencies of props.text?

Yes I agree

…ate-CopyTextToClipboard

…ToClipboard

nhminhduc · 2023-06-06T21:23:55Z

Added useCallback, displayName and fixed lint.

mollfpr

Thanks @nhminhduc 👍

All yours @PauloGasparSv

nhminhduc · 2023-06-07T07:24:20Z

Thanks @nhminhduc 👍

All yours @PauloGasparSv

Thank you for your time 🙇

PauloGasparSv · 2023-06-07T12:31:46Z

Hi @nhminhduc, can you please fix the linter errors here? (I think running npx prettier --write . is enough)

Will review here anyways and re-approve once that's done : )

PauloGasparSv · 2023-06-07T13:19:06Z

Tested all platforms and LGTM!

I'm double checking Android before approving because the copy icon isn't there, I'm curious if that was also happening on main and if there was an issue about it.

PauloGasparSv

LGTM!

Tested main and the copy icon doesn't show in the Contact Methods page there either.

Waiting on the linter fix to merge this

nhminhduc · 2023-06-07T19:07:18Z

Run prettier 👍

nhminhduc · 2023-06-07T20:02:55Z

I think on android the icon is showing, just the color is quite off. Not sure why.

PauloGasparSv · 2023-06-07T22:08:57Z

I think on android the icon is showing, just the color is quite off. Not sure why.

@nhminhduc do you mind updating the QA steps to use the Copy icon from somewhere else then? I think this will be reported as a problem if we don't explain in the QA section : )

nhminhduc · 2023-06-07T22:13:58Z

I think on android the icon is showing, just the color is quite off. Not sure why.

@nhminhduc do you mind updating the QA steps to use the Copy icon from somewhere else then? I think this will be reported as a problem if we don't explain in the QA section : )

I will update it tomorrow.

OSBotify · 2023-06-07T22:15:08Z

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

nhminhduc · 2023-06-08T10:27:16Z

@PauloGasparSv @mollfpr Hi, the icon in Android is indeed missing and it is a bug. But I do not think it is from this PR.
You can see above image, when I add PressableWithDelayToggle component with icon, it shows correctly in web, but not in android. This CopyTextToClipboard component are using the PressableWithDelayToggle, therefore it inherits this issue.
Should I create a bug ticket?

PauloGasparSv · 2023-06-08T14:21:01Z

Should I create a bug ticket?

I think that would be awesome @nhminhduc! So that's why, thks so much for explaining it too!

OSBotify · 2023-06-08T17:02:09Z

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

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

isagoico · 2023-06-09T13:54:00Z

This PR QA is blocked on Android because of this issue #17368. Rest of the platforms is a pass.

OSBotify · 2023-06-13T00:22:51Z

🚀 Deployed to production by https://github.com/AndrewGable in version: 1.3.26-4 🚀

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

migrate CopyTextToClipboard to functional component

99bbff8

nhminhduc requested a review from a team as a code owner June 2, 2023 22:43

melvin-bot Bot requested review from PauloGasparSv and mollfpr and removed request for a team June 2, 2023 22:43

nhminhduc closed this Jun 2, 2023

PauloGasparSv reopened this Jun 2, 2023

PauloGasparSv assigned nhminhduc Jun 2, 2023

Move props to bottom

14ae86d

nhminhduc mentioned this pull request Jun 3, 2023

[HOLD for payment 2023-06-19] [$250] Migrate CopyTextToClipboard.js to function component #16132

Closed

1 task

mollfpr requested changes Jun 5, 2023

View reviewed changes

nhminhduc added 3 commits June 5, 2023 23:17

Remove space between before and after curly brackets, use props inste…

3ef6eaa

…ad of destruction

Update with main, using PressableWithDelayToggle instead

4154ccf

Merge branch 'main' into 16132-migrate-CopyTextToClipboard

549a1a3

mollfpr reviewed Jun 6, 2023

View reviewed changes

nhminhduc added 2 commits June 7, 2023 00:21

Merge branch 'main' of github.com:nhminhduc/Expensify into 16132-migr…

82c701d

…ate-CopyTextToClipboard

Fix lint, useCallback for copyToClipboard, add displayName = CopyText…

f5ff404

…ToClipboard

mollfpr approved these changes Jun 7, 2023

View reviewed changes

PauloGasparSv previously approved these changes Jun 7, 2023

View reviewed changes

Run prettier

736a620

nhminhduc dismissed PauloGasparSv’s stale review via 736a620 June 7, 2023 19:07

PauloGasparSv approved these changes Jun 7, 2023

View reviewed changes

PauloGasparSv merged commit d55f25e into Expensify:main Jun 7, 2023

OSBotify mentioned this pull request Jun 8, 2023

Deploy Checklist: New Expensify 2023-06-08 #20466

Closed

74 tasks

nhminhduc mentioned this pull request Jun 8, 2023

PressableWithDelayToggle does not show Icon on Android #20476

Closed

6 tasks

	import withDelayToggleButtonState, { withDelayToggleButtonStatePropTypes } from './withDelayToggleButtonState';
	import withDelayToggleButtonState, {withDelayToggleButtonStatePropTypes} from './withDelayToggleButtonState';

Uh oh!

Conversation

nhminhduc commented Jun 2, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

Uh oh!

melvin-bot Bot commented Jun 2, 2023

Uh oh!

github-actions Bot commented Jun 2, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

nhminhduc commented Jun 2, 2023

Uh oh!

PauloGasparSv commented Jun 2, 2023

Uh oh!

nhminhduc commented Jun 2, 2023

Uh oh!

mollfpr commented Jun 5, 2023

Uh oh!

mollfpr left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mollfpr commented Jun 5, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer Checklist

Screenshots/Videos

Uh oh!

nhminhduc commented Jun 5, 2023

Uh oh!

mollfpr commented Jun 6, 2023

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

nhminhduc commented Jun 6, 2023

Uh oh!

mollfpr left a comment

Choose a reason for hiding this comment

Uh oh!

nhminhduc commented Jun 7, 2023

Uh oh!

PauloGasparSv commented Jun 7, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

PauloGasparSv commented Jun 7, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

PauloGasparSv left a comment

Choose a reason for hiding this comment

Uh oh!

nhminhduc commented Jun 7, 2023

Uh oh!

nhminhduc commented Jun 7, 2023

Uh oh!

PauloGasparSv commented Jun 7, 2023

Uh oh!

nhminhduc commented Jun 7, 2023

nhminhduc commented Jun 2, 2023 •

edited

Loading

github-actions Bot commented Jun 2, 2023 •

edited

Loading

mollfpr commented Jun 5, 2023 •

edited

Loading

PauloGasparSv commented Jun 7, 2023 •

edited

Loading

PauloGasparSv commented Jun 7, 2023 •

edited

Loading