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

Chrome mWeb - scan button provides no feedback #30094

Conversation

lukemorawski
Copy link
Contributor

@lukemorawski lukemorawski commented Oct 20, 2023

Details

This addreses an issue where a web scan flow would not work on iOS Chrome.
Root cause was mounting and unmounting a video element by the tab navigator when navigating trough tabs in receipt selector.
For some unknown reason chrome was not handling this well.
Now the camera, through an additional hook, is listening to tab navigation events and renders the webcam compononent when tab is fully focused and transition animation has ended.

Fixed Issues

$ #29990
PROPOSAL: no proposal

Tests

  • same as QA steps
  • Verify that no errors appear in the JS console

Offline tests

  • same as QA steps

QA Steps

  • go to money request page
  • chose Manual or Distance (not Scan)
  • refresh the page
  • tap on Scan
  • app should ask for camera permissions now
  • 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: mWeb Chrome
    • iOS: Native
    • iOS: mWeb 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
      • 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

iOS: mWeb Chrome
web.ios.chrome.480.mov
Android: mWeb Chrome
web.android.chrome.mov
iOS: mWeb Safari
web.ios.safari.mov

@lukemorawski lukemorawski requested a review from a team as a code owner October 20, 2023 17:13
@melvin-bot melvin-bot bot requested review from Ollyws and removed request for a team October 20, 2023 17:13
@melvin-bot
Copy link

melvin-bot bot commented Oct 20, 2023

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

@lukemorawski lukemorawski mentioned this pull request Oct 20, 2023
62 tasks
@trjExpensify trjExpensify requested review from situchan and removed request for Ollyws October 20, 2023 17:18
@situchan
Copy link
Contributor

I tested on android chrome but I am not requested to grant/deny permission anymore.
What I did was: press device back button when permission alert showed and then refresh app.

XRecorder_21102023_040017.mp4

@lukemorawski
Copy link
Contributor Author

@situchan this happens only on android chrome, or anywhere else?

@situchan
Copy link
Contributor

@situchan this happens only on android chrome, or anywhere else?

android chrome.

On iOS, there's only option to allow/reject permission. No way to dismiss. Once rejected, it's expected not to show prompt again.

@lukemorawski
Copy link
Contributor Author

@situchan yep, this is how iOS deals with permissions

@situchan
Copy link
Contributor

Bug still exists on iOS chrome.
Followed repro step exactly same as #29990 (comment)

RPReplay_Final1697826416.MP4

@situchan
Copy link
Contributor

I think below is 100% reproducible step.

  1. Open FAB > Request money > Select Scan tab
  2. Grant permission if prompted
  3. Verify that camera view shows
  4. Click Back button to go to LHN
  5. Refresh app (key to reproduce)
  6. Open FAB > Request money

@situchan
Copy link
Contributor

We should find the real root cause why this is reproducible only after refresh.
Without refresh, this issue doesn't happen.

@lukemorawski
Copy link
Contributor Author

@situchan try now

@lukemorawski
Copy link
Contributor Author

I think below is 100% reproducible step.

  1. Open FAB > Request money > Select Scan tab
  2. Grant permission if prompted
  3. Verify that camera view shows
  4. Click Back button to go to LHN
  5. Refresh app (key to reproduce)
  6. Open FAB > Request money

Tried that now and it works on my iOS Chrome

@situchan
Copy link
Contributor

Still doesn't work for me

@lukemorawski
Copy link
Contributor Author

@situchan one more little fix

@situchan
Copy link
Contributor

Works on iOS chrome. Checking android

@situchan
Copy link
Contributor

I think we're almost close. Can we fix infinite loading as well?

Repro step:

  1. FAB > Request money > Scan tab
  2. Refresh app

@lukemorawski
Copy link
Contributor Author

@situchan fixed the infinite loader after refresh

@lukemorawski lukemorawski requested a review from situchan October 21, 2023 19:33
@tgolen
Copy link
Contributor

tgolen commented Nov 9, 2023

Sure, I've triggered one for you. It should post here shortly.

@OSBotify
Copy link
Contributor

OSBotify commented Nov 9, 2023

🧪🧪 Use the links below to test this adhoc build on Android, iOS, Desktop, and Web. Happy testing! 🧪🧪

Android 🤖 iOS 🍎
https://ad-hoc-expensify-cash.s3.amazonaws.com/android/30094/index.html https://ad-hoc-expensify-cash.s3.amazonaws.com/ios/30094/index.html
Android iOS
Desktop 💻 Web 🕸️
https://ad-hoc-expensify-cash.s3.amazonaws.com/desktop/30094/NewExpensify.dmg https://30094.pr-testing.expensify.com
Desktop Web

@situchan
Copy link
Contributor

@lukemorawski I tested latest changes. camera doesn't show at all on native
Also pull main.

Copy link
Contributor

@situchan situchan left a comment

Choose a reason for hiding this comment

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

Not ready to merge yet

@lukemorawski lukemorawski requested a review from tgolen November 13, 2023 18:40
@lukemorawski
Copy link
Contributor Author

@situchan @tgolen made some fixes, please check now

@situchan
Copy link
Contributor

Please also pull main. The branch is very old

Comment on lines 22 to 24
* @param {Object} params - The parameters object.
* @param {number} params.tabIndex - The index of the tab for which focus status is being determined.
* @returns {boolean} Returns `true` if the tab is both animation-focused and screen-focused, otherwise `false`.
Copy link
Contributor

Choose a reason for hiding this comment

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

Would you mind applying this change, then I think it should be all ready to merge.

@lukemorawski
Copy link
Contributor Author

@tgolen done

@tgolen
Copy link
Contributor

tgolen commented Nov 14, 2023

A few conflicts popped up now, sorry!

@lukemorawski
Copy link
Contributor Author

@tgolen ok, merged with main. Had to remove a HOC that was wrapping up NavigationAwareCamera.native component as it was basically duplicating the functionality from the hook introduced in this PR.

Copy link
Contributor

@tgolen tgolen left a comment

Choose a reason for hiding this comment

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

Looking good, just a final lint error.

@lukemorawski
Copy link
Contributor Author

@tgolen done, sorry about that

@situchan
Copy link
Contributor

One sec, I will do final test in a few min

Copy link
Contributor

@situchan situchan left a comment

Choose a reason for hiding this comment

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

Tested on all platforms. Looks good

@melvin-bot melvin-bot bot requested a review from tgolen November 15, 2023 15:21
@tgolen tgolen merged commit 0a4ca7b into Expensify:main Nov 15, 2023
16 checks passed
@lukemorawski
Copy link
Contributor Author

amen!

@OSBotify
Copy link
Contributor

✋ 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

🚀 Deployed to production by https://github.com/mountiny in version: 1.4.0-3 🚀

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

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

Successfully merging this pull request may close these issues.

4 participants