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

Fix immediately prompt for Camera permission in scan request flow #37817

Merged
merged 14 commits into from
Mar 27, 2024

Conversation

dukenv0307
Copy link
Contributor

@dukenv0307 dukenv0307 commented Mar 6, 2024

Details

Fix immediately prompt for Camera permission in scan request flow

Fixed Issues

$ #37737
PROPOSAL: #37737 (comment)

Tests / QA Steps

  • For native Android / IOS / mWeb
  1. Reset permission of the app
  2. Go to FAB > Request Money > Scan
  3. Verify that the camera request permission prompt doesn't appear
  4. Click on the Continue button or capture icon
  5. Verify that the camera request permission prompt appears
  6. Accept the permission and verify that we can capture the photo
  • For web/desktop
  1. Go to FAB > Request Money > Scan
  2. Verify that no prompt appears
  • Verify that no errors appear in the JS console

Offline tests

Same as above

  • 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 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)
    • 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 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(theme.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 the PR modifies the form input styles:
    • I verified that all the inputs inside a form are aligned with each other.
    • I added Design label so the design team can review the changes.
  • 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.

Screenshots/Videos

Android: Native
Screen.Recording.2024-03-06.at.16.46.49.mov
Record_2024-03-08-14-25-53_1498f0e32f9498230c0f1d86a461cae3.mp4
Android: mWeb Chrome
Screen.Recording.2024-03-18.at.23.01.55.mov
iOS: Native
Screen.Recording.2024-03-06.at.16.59.24.mov
iOS: mWeb Safari
original-813F2D99-A3E1-46F7-867D-CC240246AADB.mp4
MacOS: Chrome / Safari
Screen.Recording.2024-03-06.at.16.47.34.mov
MacOS: Desktop
Screen.Recording.2024-03-06.at.17.37.48.mov

@dukenv0307 dukenv0307 marked this pull request as ready for review March 7, 2024 08:58
@dukenv0307 dukenv0307 requested a review from a team as a code owner March 7, 2024 08:58
@melvin-bot melvin-bot bot requested review from cubuspl42 and removed request for a team March 7, 2024 08:58
Copy link

melvin-bot bot commented Mar 7, 2024

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

@dukenv0307
Copy link
Contributor Author

@Julesssss Can you add build label, I need to test the camera in scan flow to make sure the old issue #34750 doesn't happen in this PR.

@Julesssss
Copy link
Contributor

Yep, build in progress. I also want to manually test some other cases:

  • User presses continue, approves our modal, enables OS permission
  • User presses continue, approves our modal, rejects OS permission
  • User presses continue, disapproves our modal, uploads image
  • User previously rejected us 2 times, approves our modal, approves our modal and manually re-enables permission

Copy link
Contributor

github-actions bot commented Mar 7, 2024

🧪🧪 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/37817/index.html https://ad-hoc-expensify-cash.s3.amazonaws.com/ios/37817/index.html
Android iOS
Desktop 💻 Web 🕸️
❌ FAILED ❌ https://37817.pr-testing.expensify.com
The QR code can't be generated, because the Desktop build failed Web

👀 View the workflow run that generated this build 👀

@cubuspl42
Copy link
Contributor

The code looks good

@cubuspl42
Copy link
Contributor

@dukenv0307

Would you execute these extra testing steps? I agree that we should ensure to cover all corner cases, and these are great starting points.

@dukenv0307
Copy link
Contributor Author

I'm testing it, will upload the screenshot for it soon.

@dukenv0307
Copy link
Contributor Author

User presses continue, approves our modal, rejects OS permission
User presses continue, disapproves our modal, uploads image
User previously rejected us 2 times, approves our modal, approves our modal and manually re-enables permission

androi-1.mp4

User presses continue, approves our modal, enables OS permission

Record_2024-03-08-14-25-53_1498f0e32f9498230c0f1d86a461cae3.mp4

@cubuspl42 Tested extra testing steps.

@dukenv0307
Copy link
Contributor Author

dukenv0307 commented Mar 8, 2024

Seem like I can't install adhoc for IOS because I'm not added to adhoc device list

@cubuspl42
Copy link
Contributor

@dukenv0307 This might be a dumb question, but why is the ad-hock build needed? Why is a local build not suitable?

@Julesssss
Copy link
Contributor

I'm not added to adhoc device list

We've had trouble doing this as Apple make the process very annoying, but send me your UUID and I'll try and add your device to our list.

but why is the ad-hock build needed? Why is a local build not suitable?

Maybe there is another reason, but I use AdHoc builds for any test that requires us to background the mobile app, as I'm not convinced the dev builds behave exactly the same way.

@dukenv0307
Copy link
Contributor Author

@dukenv0307 This might be a dumb question, but why is the ad-hock build needed? Why is a local build not suitable?

@cubuspl42 Just wanna test the camera on the real device and confirm that works when we accept the permission. In other cases of the PR, I tested it locally.

@cubuspl42
Copy link
Contributor

@dukenv0307 If you're in the Apple Developer Program, you can build for the real device yourself. Otherwise, yeah, you'll need the ad-hock build.

@dukenv0307
Copy link
Contributor Author

I was added to the list of devices to build Adhoc in IOS, it takes a few days to install Adhoc after adding.

@cubuspl42
Copy link
Contributor

Please merge main

@dukenv0307
Copy link
Contributor Author

@cubuspl42 Merged main.

@cubuspl42
Copy link
Contributor

My results for iOS / Web (physical iPhone):

delay-camera-permission-prompt-ios-web-compressed.mp4

Is this expected?

@dukenv0307
Copy link
Contributor Author

Yeah, it's expected.

@cubuspl42
Copy link
Contributor

cubuspl42 commented Mar 13, 2024

Please update the testing steps then

@dukenv0307
Copy link
Contributor Author

Update the test steps for manually case here #37817 or the case you tested above?

Verify that the camera request permission prompt appears
Accept the permission and verify that we can capture the photo

If it's the case that you tested above, I already mentioned it in the test steps.

@cubuspl42
Copy link
Contributor

On this video, I'm showing that this step fails on iOS/Web:

Verify that the camera request permission prompt doesn't appear

I'm immediately prompted for the camera permission after opening the Request Money / Scan tab.

@dukenv0307
Copy link
Contributor Author

@cubuspl42 I updated the test steps for each platform.

@cubuspl42
Copy link
Contributor

I asked on the GH issue to confirm this: #37737 (comment)

@dukenv0307
Copy link
Contributor Author

@cubuspl42 I updated the Explanier UI on mWeb, please help to review again.

@cubuspl42
Copy link
Contributor

I found this issue on iOS Web (maybe affects Android Web too?):

delay-camera-permission-prompt-ios-web-compressed.mp4

If I navigate from "Manual" to the "Scan" tab after opening the new money request route, I get an infinite loader. I need to re-enter the tab to make things right.

@dukenv0307
Copy link
Contributor Author

I found this issue on iOS Web (maybe affects Android Web too?):

Yes, I also can reproduce this on Android Web. Fixing now.

@cubuspl42
Copy link
Contributor

@dukenv0307 Are you working on this? 🙂

@dukenv0307
Copy link
Contributor Author

dukenv0307 commented Mar 26, 2024

@cubuspl42 I fixed it here 1fee194,

missed adding an update after it's fixed sorry.

@cubuspl42
Copy link
Contributor

Please merge main, we're over 1000 commits behind.

I'm testing the newest changes.

@dukenv0307
Copy link
Contributor Author

@cubuspl42 I updated.

@cubuspl42
Copy link
Contributor

cubuspl42 commented Mar 27, 2024

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: mWeb Chrome
    • iOS: Native
    • iOS: mWeb 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(theme.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 the PR modifies the form input styles:
    • I verified that all the inputs inside a form are aligned with each other.
    • I added Design label so the design team can review the changes.
  • 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

Android: Native
delay-camera-permission-prompt-2-android-compressed.mp4
Android: mWeb Chrome
delay-camera-permission-prompt-2-android-web-compressed.mp4
iOS: Native
delay-camera-permission-prompt-2-ios-compressed.mp4
iOS: mWeb Safari
delay-camera-permission-prompt-2-ios-web-compressed.mp4
MacOS: Chrome / Safari
MacOS: Desktop

@melvin-bot melvin-bot bot requested a review from Julesssss March 27, 2024 13:30
Copy link
Contributor

@Julesssss Julesssss left a comment

Choose a reason for hiding this comment

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

Video captures look great to me, thanks both.

@Julesssss Julesssss closed this Mar 27, 2024
@Julesssss
Copy link
Contributor

What... I didn't see that button 😕

@Julesssss Julesssss reopened this Mar 27, 2024
@Julesssss
Copy link
Contributor

Ignoring the flakey performance check

@Julesssss Julesssss merged commit 5d554e3 into Expensify:main Mar 27, 2024
18 of 19 checks passed
@melvin-bot melvin-bot bot added the Emergency label Mar 27, 2024
Copy link

melvin-bot bot commented Mar 27, 2024

@Julesssss looks like this was merged without a test passing. Please add a note explaining why this was done and remove the Emergency label if this is not an emergency.

@Julesssss
Copy link
Contributor

Not an emergency, the perf test is flakey

@OSBotify
Copy link
Contributor

🚀 Deployed to staging by https://github.com/Julesssss in version: 1.4.58-0 🚀

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

@OSBotify
Copy link
Contributor

OSBotify commented Apr 2, 2024

🚀 Deployed to production by https://github.com/Beamanator in version: 1.4.58-8 🚀

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

<ActivityIndicator
size={CONST.ACTIVITY_INDICATOR_SIZE.LARGE}
style={[styles.flex1]}
color={theme.textSupporting}
/>
)}
{cameraPermissionState === 'denied' && (
{cameraPermissionState !== 'granted' && isQueriedPermissionState && (
Copy link
Contributor

Choose a reason for hiding this comment

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

We haven't handled the case when user denied and camera permission prompt never shows again. Resulting in #50485.

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.

5 participants