Extend implementation of Haptic Feedback #17095

robertKozik · 2023-04-06T19:38:06Z

Details

Implement 4 functions in our existing Haptic Feedback library:

success
error
press
longPress

Fixed Issues

$ #16987
PROPOSAL: https://docs.google.com/document/d/1yHHs4IfaMxB2q7eW8Hyt7ew4rNtY6HdduPKdf-Q2ZxE/edit#bookmark=id.u88dj4n6qfzc

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 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:
- [ X 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 correct English and 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 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

…r, press, long press fhpatic functions

MelvinBot · 2023-04-07T21:56:54Z

@Santhosh-Sellavel @arosiclair 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]

Santhosh-Sellavel · 2023-04-10T18:25:17Z

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 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 correct English and 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

N/A

Santhosh-Sellavel

LGTM!

I've tested it on Android by changing the code, I can feel the impact for each type. ~~Can you test it on iOS @arosiclair?~~

Santhosh-Sellavel

LGTM, I managed to test this on iOS device. I can feel the impact between types here too!

All you @arosiclair, thanks!

OSBotify · 2023-04-10T20:45:20Z

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

Santhosh-Sellavel · 2023-04-11T16:28:30Z

@arosiclair or @robertKozik Can you assign me the issue

OSBotify · 2023-04-11T21:26:28Z

🚀 Deployed to staging by https://github.com/arosiclair in version: 1.2.99-0 🚀

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

OSBotify · 2023-04-13T03:02:29Z

🚀 Deployed to production by https://github.com/francoisl in version: 1.2.99-6 🚀

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

rushatgabhane · 2023-05-20T10:10:15Z

src/components/PressableWithSecondaryInteraction/index.native.js

@@ -20,7 +20,7 @@ const PressableWithSecondaryInteraction = (props) => {
            onPress={props.onPress}
            onLongPress={(e) => {
                e.preventDefault();
-                HapticFeedback.trigger();
+                HapticFeedback.longPress();


@roryabraham @robertKozik
Nitpick: I don't think we should change the haptic feedback just for consistency across iOS and Android (and for one single native file).

Install the android app, and long press a message - it's a very 2010 era type vibration and doesn't feel good.

You can try long pressing a message on Android whatsapp / slack for comparison - it's a nice and short bip.

It's a small UX polish but worth the extra android file we'll create.

There was a feature request for it before - https://expensify.slack.com/archives/C01GTK53T8Q/p1627669368027700

And it seems like we've undone that.
What do you think?

Heh, now that you point it out I think I agree.

Maybe we just try changing it to impactMedium and see if that helps, but effectHeavyClick does seem like the way to go on Android.

I wasn't aware of that during the designing and implementation of this PR. The main point of it was to differentiate haptics between the various types of interactions. The pattern of haptic response can be discussed and changed, so I'm open to that.

I agree we can change things up between platforms as long as we have a consistent gesture system within our app.

sounds good :)

robertKozik added 3 commits April 6, 2023 21:34

merge haptic native implementations into one, implement success, erro…

b34119c

…r, press, long press fhpatic functions

change removed haptic trigger function to longPress

c977f4c

change removed haptic trigger function to longPress/press

ff0b335

robertKozik marked this pull request as ready for review April 7, 2023 21:56

robertKozik requested a review from a team as a code owner April 7, 2023 21:56

melvin-bot bot requested review from arosiclair and Santhosh-Sellavel and removed request for a team April 7, 2023 21:56

Santhosh-Sellavel reviewed Apr 10, 2023

View reviewed changes

Santhosh-Sellavel approved these changes Apr 10, 2023

View reviewed changes

arosiclair approved these changes Apr 10, 2023

View reviewed changes

arosiclair merged commit c31a259 into Expensify:main Apr 10, 2023

roryabraham mentioned this pull request Apr 10, 2023

[HOLD for payment 2023-05-09] [Accessible Pressable] Create GenericPressable, PressableWithFeedback, PressableWithoutFeedback; #16988

Closed

OSBotify mentioned this pull request Apr 11, 2023

Deploy Checklist: New Expensify 2023-04-11 #17298

Closed

26 tasks

MelvinBot mentioned this pull request Apr 13, 2023

[HOLD for payment 2023-04-20] [Accessible Pressable] Extend implementation of Haptic Feedback #16987

Closed

rushatgabhane reviewed May 20, 2023

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Extend implementation of Haptic Feedback #17095

Extend implementation of Haptic Feedback #17095

robertKozik commented Apr 6, 2023 •

edited

Loading

MelvinBot commented Apr 7, 2023

Santhosh-Sellavel commented Apr 10, 2023

Santhosh-Sellavel left a comment •

edited

Loading

Santhosh-Sellavel left a comment •

edited

Loading

OSBotify commented Apr 10, 2023

Santhosh-Sellavel commented Apr 11, 2023

OSBotify commented Apr 11, 2023

OSBotify commented Apr 13, 2023

rushatgabhane May 20, 2023 •

edited

Loading

rushatgabhane May 20, 2023

rushatgabhane May 20, 2023 •

edited

Loading

roryabraham May 22, 2023

roryabraham May 22, 2023

robertKozik May 22, 2023

roryabraham May 22, 2023

rushatgabhane May 22, 2023

Extend implementation of Haptic Feedback #17095

Extend implementation of Haptic Feedback #17095

Conversation

robertKozik commented Apr 6, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

MelvinBot commented Apr 7, 2023

Santhosh-Sellavel commented Apr 10, 2023

Reviewer Checklist

Screenshots/Videos

Santhosh-Sellavel left a comment • edited Loading

Choose a reason for hiding this comment

Santhosh-Sellavel left a comment • edited Loading

Choose a reason for hiding this comment

OSBotify commented Apr 10, 2023

Santhosh-Sellavel commented Apr 11, 2023

OSBotify commented Apr 11, 2023

OSBotify commented Apr 13, 2023

rushatgabhane May 20, 2023 • edited Loading

Choose a reason for hiding this comment

rushatgabhane May 20, 2023

Choose a reason for hiding this comment

rushatgabhane May 20, 2023 • edited Loading

Choose a reason for hiding this comment

roryabraham May 22, 2023

Choose a reason for hiding this comment

roryabraham May 22, 2023

Choose a reason for hiding this comment

robertKozik May 22, 2023

Choose a reason for hiding this comment

roryabraham May 22, 2023

Choose a reason for hiding this comment

rushatgabhane May 22, 2023

Choose a reason for hiding this comment

robertKozik commented Apr 6, 2023 •

edited

Loading

Santhosh-Sellavel left a comment •

edited

Loading

Santhosh-Sellavel left a comment •

edited

Loading

rushatgabhane May 20, 2023 •

edited

Loading

rushatgabhane May 20, 2023 •

edited

Loading