App icon indicating copy to clipboard operation
App copied to clipboard
verified publisher icon Expensify

Animate settlement button when pay and trigger a haptic feedback

Open bernhardoj opened this issue 1 year ago • 8 comments

Details

We want to animate the settlement button when pay and trigger a heavy haptic feedback.

Fixed Issues

$ https://github.com/Expensify/App/issues/48036 PROPOSAL: https://github.com/Expensify/App/issues/48036#issuecomment-2326224712

Tests

Same as QA Steps

  • [x] Verify that no errors appear in the JS console

Offline tests

Same as QA Steps

QA Steps

  1. Open your policy expense chat
  2. Submit a request. Approve if needed.
  3. Pay the money request
  4. Verify the pay button animates (as shown here)
  5. (Android/iOS) Verify there is a vibrate when pressing the pay button
  • [x] Verify that no errors appear in the JS console

PR Author Checklist

  • [x] I linked the correct issue in the ### Fixed Issues section above
  • [x] I wrote clear testing steps that cover the changes made in this PR
    • [x] I added steps for local testing in the Tests section
    • [x] I added steps for the expected offline behavior in the Offline steps section
    • [x] I added steps for Staging and/or Production testing in the QA steps section
    • [x] I added steps to cover failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
    • [x] 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)
    • [x] 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).
  • [x] I included screenshots or videos for tests on all platforms
  • [x] I ran the tests on all platforms & verified they passed on:
    • [x] Android: Native
    • [x] Android: mWeb Chrome
    • [x] iOS: Native
    • [x] iOS: mWeb Safari
    • [x] MacOS: Chrome / Safari
    • [x] MacOS: Desktop
  • [x] 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)
  • [x] I followed proper code patterns (see Reviewing the code)
    • [x] 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)
    • [x] I verified that the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
    • [x] I verified that comments were added to code that is not self explanatory
    • [x] 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.
    • [x] I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
      • [x] 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
    • [x] 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 either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
    • [x] 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.
    • [x] I verified the JSDocs style guidelines (in STYLE.md) were followed
  • [x] If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
  • [x] I followed the guidelines as stated in the Review Guidelines
  • [x] 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)
  • [x] I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
  • [x] 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
  • [x] I verified that if a function's arguments changed that all usages have also been updated correctly
  • [x] If any new file was added I verified that:
    • [x] 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
  • [x] If a new CSS style is added I verified that:
    • [x] A similar style doesn't already exist
    • [x] The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(theme.componentBG))
  • [x] 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.
  • [x] 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)
  • [x] 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.
  • [x] 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.
  • [x] If the PR modifies the UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
    • [x] I verified that all the inputs inside a form are aligned with each other.
    • [x] I added Design label and/or tagged @Expensify/design so the design team can review the changes.
  • [x] 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.
  • [x] 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.

Screenshots/Videos

Android: Native

https://github.com/user-attachments/assets/36ef21ff-8adb-4a14-96b1-c79796c65dfe

Android: mWeb Chrome

https://github.com/user-attachments/assets/e21ef364-d8ed-448c-abac-7337e8d62a04

iOS: Native

https://github.com/user-attachments/assets/944aac32-a21a-4ed9-b5dd-83ed36b1d8a1

iOS: mWeb Safari

https://github.com/user-attachments/assets/04f48226-ecb5-4780-abd5-308f54d75cd0

MacOS: Chrome / Safari

https://github.com/user-attachments/assets/01e4d8c6-de71-4c14-b3f4-91b339eef949

MacOS: Desktop

https://github.com/user-attachments/assets/0dc31cd3-efb7-4058-b6ff-cbbb307072c9

bernhardoj avatar Sep 05 '24 04:09 bernhardoj

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

melvin-bot[bot] avatar Sep 05 '24 04:09 melvin-bot[bot]

@bernhardoj We still have issue with eslint

And I will check PR today

ZhenjaHorbach avatar Sep 05 '24 06:09 ZhenjaHorbach

Done

bernhardoj avatar Sep 05 '24 16:09 bernhardoj

Reviewer Checklist

  • [x] I have verified the author checklist is complete (all boxes are checked off).
  • [x] I verified the correct issue is linked in the ### Fixed Issues section above
  • [x] I verified testing steps are clear and they cover the changes made in this PR
    • [x] I verified the steps for local testing are in the Tests section
    • [x] I verified the steps for Staging and/or Production testing are in the QA steps section
    • [x] 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)
    • [x] 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)
  • [x] I checked that screenshots or videos are included for tests on all platforms
  • [x] I included screenshots or videos for tests on all platforms
  • [x] I verified tests pass on all platforms & I tested again on:
    • [x] Android: Native
    • [x] Android: mWeb Chrome
    • [x] iOS: Native
    • [x] iOS: mWeb Safari
    • [x] MacOS: Chrome / Safari
    • [x] MacOS: Desktop
  • [x] 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
  • [x] I verified proper code patterns were followed (see Reviewing the code)
    • [x] 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).
    • [x] I verified that the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
    • [x] I verified that comments were added to code that is not self explanatory
    • [x] 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.
    • [x] I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
    • [x] I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
    • [x] 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 either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
    • [x] 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.
    • [x] I verified the JSDocs style guidelines (in STYLE.md) were followed
  • [x] If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
  • [x] I verified that this PR follows the guidelines as stated in the Review Guidelines
  • [x] 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)
  • [x] I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
  • [x] 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
  • [x] If a new component is created I verified that:
    • [x] A similar component doesn't exist in the codebase
    • [x] All props are defined accurately and each prop has a /** comment above it */
    • [x] The file is named correctly
    • [x] The component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone
    • [x] The only data being stored in the state is data necessary for rendering and nothing else
    • [x] 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)
    • [x] 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)
    • [x] All JSX used for rendering exists in the render method
    • [x] 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
  • [x] If any new file was added I verified that:
    • [x] 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
  • [x] If a new CSS style is added I verified that:
    • [x] A similar style doesn't already exist
    • [x] The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(theme.componentBG)
  • [x] 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.
  • [x] 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)
  • [x] 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.
  • [x] 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.
  • [x] If the PR modifies the UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
    • [x] I verified that all the inputs inside a form are aligned with each other.
    • [x] I added Design label and/or tagged @Expensify/design so the design team can review the changes.
  • [x] 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.
  • [x] 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.
  • [x] I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

Screenshots/Videos

Android: Native

https://github.com/user-attachments/assets/5dc219da-2d56-4073-8d12-6befddbedc06

Android: mWeb Chrome

https://github.com/user-attachments/assets/0441d810-cf8a-4cd3-86e7-ab32472be541

iOS: Native

https://github.com/user-attachments/assets/3a546058-d2ef-49f3-a668-447e7e380281

iOS: mWeb Safari

https://github.com/user-attachments/assets/508b927a-db01-4def-8aed-0addbea57b6a

MacOS: Chrome / Safari

https://github.com/user-attachments/assets/56d5aedc-9b2f-4d29-a877-183e2d34711f

MacOS: Desktop

https://github.com/user-attachments/assets/eb5358f2-b5ac-465f-960d-2833c6481761

ZhenjaHorbach avatar Sep 05 '24 18:09 ZhenjaHorbach

@bernhardoj I have a crash when I click on the approve button and immediately click pay Could you check please ?

https://github.com/user-attachments/assets/4c6d2723-1ce4-41c0-9a7d-e8892a3183f9

ZhenjaHorbach avatar Sep 06 '24 07:09 ZhenjaHorbach

And I have a small visual bug (green line) But I hope this is a simulator problem

Снимок экрана 2024-09-06 в 09 53 50

ZhenjaHorbach avatar Sep 06 '24 07:09 ZhenjaHorbach

Hmm, I can't repro both. Can you share the crash log?

https://github.com/user-attachments/assets/deb696e0-fe4a-463e-9b86-25e337c6a477

https://github.com/user-attachments/assets/d83f6322-ccea-4c61-a114-f3aeb7bbd57d

bernhardoj avatar Sep 07 '24 09:09 bernhardoj

I will recheck today or tomorrow Maybe these were isolated cases 😅

ZhenjaHorbach avatar Sep 07 '24 10:09 ZhenjaHorbach

About second bug No longer reproducing

But about first one

Looks like this crash related with our changes

And following console Issue related with options

https://github.com/user-attachments/assets/a7894303-0e30-4ba9-a38d-668598c0fe8a

When the animation starts options becomes equal [] And when we try to get disabled we have crash

https://github.com/Expensify/App/blob/05e48180ab189d1824b080e48c452d44120a48b3/src/components/ButtonWithDropdownMenu/index.tsx#L157

And here

https://github.com/Expensify/App/blob/05e48180ab189d1824b080e48c452d44120a48b3/src/components/ButtonWithDropdownMenu/index.tsx#L160

https://github.com/Expensify/App/blob/05e48180ab189d1824b080e48c452d44120a48b3/src/components/ButtonWithDropdownMenu/index.tsx#L109

ZhenjaHorbach avatar Sep 08 '24 19:09 ZhenjaHorbach

@ZhenjaHorbach one thing I noticed in your video is that the payment option is Pay $xx with Expensify. It will be shown as long as the below condition is satisfied. https://github.com/Expensify/App/blob/498d45cc55bae4dde9f85036c75d5a421e0469e9/src/components/SettlementButton.tsx#L168-L170

After paying the request, shouldHidePaymentOptions becomes true, making the options empty. It's true because the report is not payable any more. https://github.com/Expensify/App/blob/498d45cc55bae4dde9f85036c75d5a421e0469e9/src/components/ReportActionItem/ReportPreview.tsx#L309 https://github.com/Expensify/App/blob/498d45cc55bae4dde9f85036c75d5a421e0469e9/src/components/ReportActionItem/ReportPreview.tsx#L488

So, I decided to move back to the state to play the animation to ReportPreview so we can keep showing the payment option when the animation is still running.

The root cause is just a guess though because Pay $xx with Expensify requires BA connected, but I was never able to get connected to the BA in staging, so please test if it fixes the issue.

bernhardoj avatar Sep 09 '24 11:09 bernhardoj

@ZhenjaHorbach one thing I noticed in your video is that the payment option is Pay $xx with Expensify. It will be shown as long as the below condition is satisfied.

https://github.com/Expensify/App/blob/498d45cc55bae4dde9f85036c75d5a421e0469e9/src/components/SettlementButton.tsx#L168-L170

After paying the request, shouldHidePaymentOptions becomes true, making the options empty. It's true because the report is not payable any more.

https://github.com/Expensify/App/blob/498d45cc55bae4dde9f85036c75d5a421e0469e9/src/components/ReportActionItem/ReportPreview.tsx#L309

https://github.com/Expensify/App/blob/498d45cc55bae4dde9f85036c75d5a421e0469e9/src/components/ReportActionItem/ReportPreview.tsx#L488

So, I decided to move back to the state to play the animation to ReportPreview so we can keep showing the payment option when the animation is still running.

The root cause is just a guess though because Pay $xx with Expensify requires BA connected, but I was never able to get connected to the BA in staging, so please test if it fixes the issue.

Hmm Yeah That looks like the root cause I'll check the fix today !

ZhenjaHorbach avatar Sep 09 '24 14:09 ZhenjaHorbach

And the crash was fixed Thanks !

ZhenjaHorbach avatar Sep 09 '24 17:09 ZhenjaHorbach

LGTM !

ZhenjaHorbach avatar Sep 10 '24 06:09 ZhenjaHorbach

conflicts

roryabraham avatar Sep 12 '24 16:09 roryabraham

Fixed.

bernhardoj avatar Sep 12 '24 17:09 bernhardoj

@roryabraham Done

bernhardoj avatar Sep 13 '24 12:09 bernhardoj

:hand: 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 avatar Sep 13 '24 17:09 OSBotify

🚀 Deployed to staging by https://github.com/roryabraham in version: 9.0.35-0 🚀

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

OSBotify avatar Sep 13 '24 23:09 OSBotify

🚀 Deployed to production by https://github.com/grgia in version: 9.0.35-7 🚀

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

OSBotify avatar Sep 16 '24 18:09 OSBotify

FYI, we also applied animation to the settlement button in the money report header (#53474). :D

ntdiary avatar Mar 10 '25 15:03 ntdiary