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

Make Mobile Web and Native App Scanning Consistent #28411

Merged
merged 14 commits into from
Oct 11, 2023

Conversation

lukemorawski
Copy link
Contributor

@lukemorawski lukemorawski commented Sep 28, 2023

Details

This PR adds a direct camera view to the receipt scan flow on mobile web, much like in a native ios/android experience.
Button left to the camera shutter still allows to access photo library/files or to use the OS camera modal.
Button to the right can turn on the flashlight/torch, though it's availability depends on the browser capabilities (currently iOS Safari doesn't allow for this).
If open in a desktop environment, there still the previous attachment picker/drag'n'drop screen available.

Fixed Issues

$ #28204
PROPOSAL: no proposal

Tests

Same as QA Steps

Offline tests

Same as QA Steps

QA Steps

  • open the app in a mobile web browser
  • create a new money request
  • choose scan in the top tabs
  • use the new camera view
  • 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
    • 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
    • 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 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

Web
Mobile Web - Chrome
Mobile Web - Safari
RPReplay_Final1696513318.mov
Desktop
iOS
Android

@@ -10,51 +10,67 @@ const propTypes = {

/* Forwarded ref */
forwardedRef: refPropTypes.isRequired,

Copy link
Contributor

Choose a reason for hiding this comment

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

Following the guidelines, it's necessary to add a description for all props

@lukemorawski lukemorawski marked this pull request as ready for review September 29, 2023 15:41
@lukemorawski lukemorawski requested a review from a team as a code owner September 29, 2023 15:41
@melvin-bot melvin-bot bot requested review from cubuspl42 and removed request for a team September 29, 2023 15:41
@melvin-bot
Copy link

melvin-bot bot commented Sep 29, 2023

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

ios/Podfile.lock Outdated
@@ -783,7 +783,7 @@ PODS:
- React-Core
- RNReactNativeHapticFeedback (1.14.0):
- React-Core
- RNReanimated (3.5.4):
- RNReanimated (3.4.0):
Copy link
Contributor

Choose a reason for hiding this comment

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

A downgrade?

Copy link
Contributor

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.

const navigation = useNavigation();
const [isCameraActive, setIsCameraActive] = useState(navigation.isFocused());

// Get the animation value from the tab navigator. Its a value between 0 and the
Copy link
Contributor

Choose a reason for hiding this comment

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

Its -> It's

Copy link
Contributor

@cubuspl42 cubuspl42 Oct 5, 2023

Choose a reason for hiding this comment

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

@lukemorawski All threads have to be handled

Copy link
Contributor

Choose a reason for hiding this comment

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


// Get the animation value from the tab navigator. Its a value between 0 and the
// number of pages we render in the tab navigator. When we even just slightly start to scroll to the camera page,
// (value is e.g. 0.001 on animation start) we want to activate the camera, so its as fast as possible active.
Copy link
Contributor

Choose a reason for hiding this comment

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

its -> it's

Also, the sentence structure in the comment isn't proper English, the comment could be passed through GPT or another tool with a prompt like "Improve language correctness"

Copy link
Contributor

Choose a reason for hiding this comment

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

if (!cameraRef.current.getScreenshot) {
return;
}
const imageB64 = cameraRef.current.getScreenshot();
Copy link
Contributor

Choose a reason for hiding this comment

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

Nit: imageB64 -> imageBase64 ?

@cubuspl42
Copy link
Contributor

@lukemorawski

  1. Don't leave QA Steps empty
    • You can, for example, move the content from "Tests" to "QA Steps", and in "Tests" write "Same as QA Steps"
  2. Describe a simple scenario for the case different than the mobile web, which prevents regressions

<View style={[styles.uploadReceiptView(isSmallScreenWidth)]}>
{!isDraggingOver ? (
<View style={[styles.flex1, !Browser.isMobile() && styles.uploadReceiptView(isSmallScreenWidth)]}>
{!isDraggingOver && Browser.isMobile() && (
Copy link
Contributor

Choose a reason for hiding this comment

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

This becomes a wall of text...

How about...

const buildPrimarySection= () => {
  if (Browser.isMobile()) {
    return buildMobilePrimarySection();
  } else {
    return buildDesktopPrimarySection();
  }
}

// ...

{!isDraggingOver && buildPrimarySection()|

This way, we highlight that this is a mobile/desktop switch, and one of them always renders.

The refactored fragments could be either local functions in this component (with no arguments), private functions in this module (with appropriate arguments introduced), or even new components, whichever you find preferable.

Copy link
Contributor

Choose a reason for hiding this comment

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

@lukemorawski

made some amendments

Looks good! Please also check the other threads with minor comments.

@lukemorawski
Copy link
Contributor Author

@cubuspl42 made some amendments

@cubuspl42
Copy link
Contributor

@lukemorawski We're 869 commits behind, let's merge main in

@lukemorawski
Copy link
Contributor Author

@cubuspl42 merged, no conflicts

@cubuspl42
Copy link
Contributor

@lukemorawski

new-web-scan-flow-android-web-compressed.mp4

I don't know; maybe it's something on my side, but shouldn't I be prompted about the appropriate permission?

@lukemorawski
Copy link
Contributor Author

@cubuspl42 are you running it in an emulator?

@cubuspl42
Copy link
Contributor

Yes! Is it unsupported?

@lukemorawski
Copy link
Contributor Author

lukemorawski commented Oct 4, 2023

ah, yes you are :) Then you need to add that address (with port number) to the white list:
chrome://flags/#unsafely-treat-insecure-origin-as-secure

Video streaming works only on https connections

@cubuspl42
Copy link
Contributor

cubuspl42 commented Oct 4, 2023

@lukemorawski Any tricks for iOS Safari? :)

Also, do you know any tricks for the spinning wheel on Native? Might also be emulator-related, and works same on main.

Edit: Damn, it's just not existing.

new-web-scan-flow-ios.mp4

@AndrewGable
Copy link
Contributor

@JmillsExpensify was testing and noticed that there is a brief flash of a small camera viewport (around the 4 second mark). Can we clean this up so it doesn't load the camera view until it knows the correct size to display? Maybe a loading spinner?

RPReplay_Final1696540586.MP4

@lukemorawski
Copy link
Contributor Author

@JmillsExpensify was testing and noticed that there is a brief flash of a small camera viewport (around the 4 second mark). Can we clean this up so it doesn't load the camera view until it knows the correct size to display? Maybe a loading spinner?

RPReplay_Final1696540586.MP4

This might be bit tricky, but I'll see what can be done.

@lukemorawski
Copy link
Contributor Author

@JmillsExpensify Added some changing to styling, though that weird resize/flash is much more tricky to tackle.
It doesn't seem be connected to any DOM event (i.e. resize), or react re-render. It looks like video element is just internally resizing it's content to it's layout. The only way to hide that "resizing" to appear was to delay the element to appear, by changing it's opacity using setTimeout, but that's a bit to hacky to be acceptable.
Maybe we could create a separate ticket for it to move this issue forward, or should I continue to find an acceptable workaround?

@JmillsExpensify
Copy link

JmillsExpensify commented Oct 9, 2023

The only way to hide that "resizing" to appear was to delay the element to appear, by changing it's opacity using setTimeout, but that's a bit to hacky to be acceptable.
Maybe we could create a separate ticket for it to move this issue forward, or should I continue to find an acceptable workaround?

I actually think we might have done this on native when we saw a similar issue, specifically chancing the opacity? @AndrewGable would know for sure, one way or another. In any case, given that I'm one of the only ones seeing it, it could also have something to do with my account (I have a "heavy load" account with thousands of reports; on iPhone 14 Pro). All in all, I'm fine tackling this in a follow-up.

@MitchExpensify
Copy link
Contributor

Seeing as we're not considering @JmillsExpensify 's lag experience a blocker, and the padding issue is relatively straightforward, what is you best estimate at when this might be finished @lukemorawski ? Anything else in our way currently?

@lukemorawski
Copy link
Contributor Author

@MitchExpensify padding is finished already. PR is ready to be re-reviewed.

@AndrewGable
Copy link
Contributor

Kicked off another adhoc build to test this.

@AndrewGable
Copy link
Contributor

FYI now consistently get the bug @JmillsExpensify was seeing 😢 - I think it might be a blocker if others see it too.

RPReplay_Final1696969957.MP4

@lukemorawski
Copy link
Contributor Author

@AndrewGable I had a dream tonight about a possible solution and have one more thing to try :) If that won't work, then the only thing left is to show the camera view after few hundred ms, to cover this bug.

@lukemorawski
Copy link
Contributor Author

@AndrewGable I think it's fixed! The solution is so ridiculously simple, though completely unexpected. Tested only on one iPhone device.

@AndrewGable
Copy link
Contributor

Nice! I will re-build and test once more!

@OSBotify
Copy link
Contributor

Copy link
Contributor

@AndrewGable AndrewGable left a comment

Choose a reason for hiding this comment

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

Looks great on my phone, nice fix! Just waiting on a few others to test then I will merge.

@AndrewGable AndrewGable merged commit 9e6af2b into Expensify:main Oct 11, 2023
14 checks passed
@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.

@luacmartins
Copy link
Contributor

luacmartins commented Oct 13, 2023

FYI this PR caused this regression because ReceiptSelector is also used outside the tab navigator and the useTabAnimation hook used in NavigationAwareCamera throws.

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/jasperhuangg in version: 1.3.83-11 🚀

platform result
🤖 android 🤖 skipped 🚫
🖥 desktop 🖥 skipped 🚫
🍎 iOS 🍎 skipped 🚫
🕸 web 🕸 skipped 🚫

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/jasperhuangg in version: 1.3.83-11 🚀

platform result
🤖 android 🤖 skipped 🚫
🖥 desktop 🖥 skipped 🚫
🍎 iOS 🍎 skipped 🚫
🕸 web 🕸 skipped 🚫

1 similar comment
@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/jasperhuangg in version: 1.3.83-11 🚀

platform result
🤖 android 🤖 skipped 🚫
🖥 desktop 🖥 skipped 🚫
🍎 iOS 🍎 skipped 🚫
🕸 web 🕸 skipped 🚫

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/jasperhuangg in version: 1.3.83-11 🚀

platform result
🤖 android 🤖 failure ❌
🖥 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.

8 participants