Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: use pressable with press feedback #19391

Conversation

BeeMargarida
Copy link
Contributor

Details

  1. Made a new component that uses the already existing withDelayToggleButtonState and makes the logic of showing a checkmark icon and different tooltip text once the pressable was pressed.
  2. Used new component in CodesPage buttons
  3. Change the already existing CopyTextToClipboard component to use the new component, since it's the same logic

NOTE: the icon in Settings -> Profile -> Contact Method is not being displayed in Android. I checked in main and asked other people if they were experiencing the same, and it seems it's a problem. However, it's not related with this change.

Fixed Issues

$ #19180
#19180 (comment)

Tests

  1. Go to Settings -> Security -> Two-factor authentication
  2. Check that the buttons contain icons and change the icons when pressed
  3. Go to Settings -> Profile -> Contact Method
  4. Check that no regressions in the '[email protected]' clipboard text was made
  5. Go to a chat -> click on the user name
  6. Check that the copy icon next to the email suffered no regression
  • Verify that no errors appear in the JS console

Offline tests

Not relevant.

QA Steps

  1. Go to Settings -> Security -> Two-factor authentication
  2. Check that the buttons contain icons and change the icons when pressed
  3. Go to Settings -> Profile -> Contact Method
  4. Check that no regressions in the '[email protected]' clipboard text was made
  5. Go to a chat -> click on the user name
  6. Check that the copy icon next to the email suffered no regression
  • 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_tiny.mp4
Mobile Web - Chrome
mChrome.mov
Mobile Web - Safari
mSafari.mov
Desktop
desktop.mov
iOS
ios_tiny.mp4
Android
android.mov

thiagobrez
thiagobrez previously approved these changes May 22, 2023
Copy link
Contributor

@thiagobrez thiagobrez left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Copy link
Contributor

@ArekChr ArekChr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Overall LGTM 👌

src/components/PressableWithDelayToggle.js Outdated Show resolved Hide resolved
src/components/PressableWithDelayToggle.js Show resolved Hide resolved
src/components/PressableWithDelayToggle.js Outdated Show resolved Hide resolved
src/components/PressableWithDelayToggle.js Outdated Show resolved Hide resolved
@BeeMargarida BeeMargarida marked this pull request as ready for review May 23, 2023 09:06
@BeeMargarida BeeMargarida requested a review from a team as a code owner May 23, 2023 09:06
@melvin-bot melvin-bot bot requested review from MonilBhavsar and rushatgabhane and removed request for a team May 23, 2023 09:06
@melvin-bot
Copy link

melvin-bot bot commented May 23, 2023

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

@rushatgabhane
Copy link
Member

rushatgabhane commented May 25, 2023

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
Screen.Recording.2023-05-25.at.16.11.51.mov
Mobile Web - Chrome
Screen.Recording.2023-05-30.at.17.56.33.mov
Mobile Web - Safari
Screen.Recording.2023-05-30.at.17.57.05.mov
Desktop
iOS
Screen.Recording.2023-05-25.at.16.20.11.mov
Android
WhatsApp.Video.2023-05-30.at.20.24.31.mp4

Copy link
Member

@rushatgabhane rushatgabhane left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@BeeMargarida tests well! Request two minor changes

/** The icon to display once the pressable is pressed */
iconChecked: PropTypes.func,

/** If the component should be inline with text or not */
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This comment should describe when / why would we use this prop

containerStyles={styles.flexRow}
text={props.isDelayButtonStateComplete ? props.tooltipTextChecked : props.tooltipText}
>
<Text
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There is a console error caused by this line -

image

Failed prop type: Invalid prop containerStyles of type object supplied to Tooltip, expected an array.
at Tooltip (webpack-internal:///./src/components/Tooltip/index.js:49:86)
at withWindowDimensions(Tooltip)
at div
at eval (webpack-internal:///./node_modules/@expensify/react-native-web/dist/exports/View/index.js:52:25)
at Pressable (webpack-internal:///./node_modules/@expensify/react-native-web/dist/exports/Pressable/index.js:40:24)
at PressableWithDelayToggle (webpack-internal:///./src/components/PressableWithDelayToggle.js:94:29)

@rushatgabhane
Copy link
Member

rushatgabhane commented May 25, 2023

@BeeMargarida On Android I'm getting this weird bug where the recovery codes overflow.
Device - Pixel 5

Can you repro this?

image

@BeeMargarida
Copy link
Contributor Author

I'm currently OOO until 1st of June, but @thiagobrez will take it from me

@thiagobrez
Copy link
Contributor

Hey! Looking into this now

@thiagobrez
Copy link
Contributor

Hey @rushatgabhane!

This comment should describe when / why would we use this prop

There is a console error caused by this line -

These 2 are done, just pushed the fix ✅

On Android I'm getting this weird bug where the recovery codes overflow.
Device - Pixel 5

This one is being fixed by this PR: #19260

Let me know what you think 🙌🏻

@MonilBhavsar
Copy link
Contributor

@rushatgabhane would you be able to take a look today, so we can merge this 🚀

@rushatgabhane
Copy link
Member

@thiagobrez thank you!

rushatgabhane
rushatgabhane previously approved these changes May 30, 2023
Copy link
Member

@rushatgabhane rushatgabhane left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

{textComponent}
</View>
{this.props.shouldShowRightIcon && (
<View style={styles.justifyContentCenter}>
<View style={[styles.justifyContentCenter, styles.ml1, ...this.props.iconStyles]}>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks like this has caused issues in such button components

Screenshot 2023-05-31 at 1 02 54 PM

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@MonilBhavsar Seems like the left icon styles were also being applied to the right icon. Fixed ✅

@MonilBhavsar
Copy link
Contributor

@thiagobrez the app crashes when we go to workspace > any workspace > bills. Could you please check. Thanks

@BeeMargarida
Copy link
Contributor Author

the app crashes when we go to workspace > any workspace > bills

@MonilBhavsar Should be fixed now!

@MonilBhavsar
Copy link
Contributor

Sorry for not noticing earlier. But while we're here, can we please also update the "Copy" button inside verify page, to be pressable with feedack.

@BeeMargarida
Copy link
Contributor Author

@MonilBhavsar Updated!

Screen.Recording.2023-06-05.at.12.41.10.mov

onPress={() => Clipboard.setString(props.account.twoFactorAuthSecretKey)}
medium
styles={[styles.button, styles.buttonMedium, styles.twoFactorAuthCodesButton]}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the change!
I wonder if we can remove the minimum width property from styles.twoFactorAuthCodesButton here as button looks wider. @shawnborton would like to hear your thoughts

Screenshot 2023-06-05 at 5 18 47 PM

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I suppose we can get rid of it here, yeah.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! @BeeMargarida can we please remove styles.twoFactorAuthCodesButton. Thanks!

Copy link
Contributor Author

@BeeMargarida BeeMargarida Jun 5, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@MonilBhavsar @BeeMargarida I believe this minWidth was there to keep the width of these 2 buttons consistent (per design). Maybe we could remove only from the copy button, not from the whole style definition

Screenshot 2023-06-05 at 15 58 57

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oops, just saw that Ana did exactly that. Ignore me!

Copy link
Contributor

@MonilBhavsar MonilBhavsar left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! 🚀

@MonilBhavsar MonilBhavsar merged commit 9a3c9b6 into Expensify:main Jun 5, 2023
@OSBotify
Copy link
Contributor

OSBotify commented Jun 5, 2023

✋ 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
Copy link
Contributor

OSBotify commented Jun 5, 2023

🚀 Deployed to staging by https://github.com/MonilBhavsar in version: 1.3.24-0 🚀

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

@OSBotify
Copy link
Contributor

OSBotify commented Jun 7, 2023

🚀 Deployed to production by https://github.com/roryabraham in version: 1.3.24-5 🚀

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

@OSBotify
Copy link
Contributor

OSBotify commented Jun 7, 2023

🚀 Deployed to production by https://github.com/roryabraham in version: 1.3.24-5 🚀

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

fill={StyleUtils.getIconFillColor(getButtonState(hovered, pressed, props.isDelayButtonStateComplete))}
style={props.iconStyles}
width={variables.iconSizeSmall}
height={variables.iconSizeSmall}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi, we forgot to pass props.inline to <Icon /> causing #22259

onPress={this.copyToClipboard}
style={[styles.flexRow, styles.cursorPointer]}
suppressHighlighting
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Coming from #24591

We are missing the prop suppressHighlighting if the PressableWithDelayToggle uses the Text component.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

9 participants