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 camera not working on the second time opening it #53194

Merged
merged 9 commits into from
Dec 5, 2024

Conversation

QichenZhu
Copy link
Contributor

@QichenZhu QichenZhu commented Nov 27, 2024

Explanation of Change

Fixed Issues

$ #51337
PROPOSAL: #51337 (comment)

Tests

  1. Open New Expensify in mobile Chrome.
  2. Tap FAB > Create Expense > Scan.
  3. If camera permission isn't granted yet, tap Continue and Allow.
  4. Take a picture.
  5. Tap the back arrow (<) in the top left corner to return to the Scan page.
  6. Verify the camera works.
  • Verify that no errors appear in the JS console

Offline tests

  1. Open New Expensify in mobile Chrome.
  2. Tap FAB > Create Expense > Scan.
  3. If camera permission isn't granted yet, tap Continue and Allow.
  4. Take a picture.
  5. Tap the back arrow (<) in the top left corner to return to the Scan page.
  6. Verify the camera works.

QA Steps

  1. Open New Expensify in mobile Chrome.
  2. Tap FAB > Create Expense > Scan.
  3. If camera permission isn't granted yet, tap Continue and Allow.
  4. Take a picture.
  5. Tap the back arrow (<) in the top left corner to return to the Scan page.
  6. Verify the camera works.
  • 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 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 used JaimeGPT to get English > Spanish translation. I then posted it 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.ts 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 UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
    • I verified that all the inputs inside a form are aligned with each other.
    • I added Design label and/or tagged @Expensify/design 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.
  • I added unit tests for any new feature or bug fix in this PR to help automatically prevent regressions in this user flow.
  • 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
android-native.mp4
Android: mWeb Chrome
android-web.mp4
iOS: Native
ios-native.mp4
iOS: mWeb Safari
ios-safari.mp4
ios-chrome.mp4
MacOS: Chrome / Safari (Not Applicable)

Test steps are not applicable on this platform.

mac-web

MacOS: Desktop (Not Applicable)

Test steps are not applicable on this platform.

mac-desktop

@QichenZhu
Copy link
Contributor Author

@ishpaul777 This PR is almost ready, but two issues remain:

  1. The camera view is sometimes cut off as mentioned before. This is a suspected commit: 98519f0.

  2. While repeating the test steps, the camera randomly stops working on some devices (see 00:43 in the video). Still looking into it.

screenRecording-28-11-2024-1-33.mp4

@QichenZhu QichenZhu marked this pull request as ready for review November 28, 2024 08:31
@QichenZhu QichenZhu requested a review from a team as a code owner November 28, 2024 08:31
@melvin-bot melvin-bot bot requested a review from ishpaul777 November 28, 2024 08:31
Copy link

melvin-bot bot commented Nov 28, 2024

@ishpaul777 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 melvin-bot bot removed the request for review from a team November 28, 2024 08:31
@QichenZhu
Copy link
Contributor Author

QichenZhu commented Nov 28, 2024

@ishpaul777 I need your guidance on whether the two mentioned issues are blockers for this PR and the next steps.

@ishpaul777
Copy link
Contributor

The camera view is sometimes cut off as mentioned before. This is a suspected commit: 98519f0.

I think this is not related to this PR so treat it is as NAB, but if you can found a fix and fix is straightforward, lets fix it as well

While repeating the test steps, the camera randomly stops working on some devices (see 00:43 in the video). Still looking into it.

this one looks like blocker becuase this is exact thing are trying to fix

@QichenZhu QichenZhu marked this pull request as draft November 29, 2024 03:27
@QichenZhu QichenZhu marked this pull request as ready for review November 30, 2024 11:34
@QichenZhu
Copy link
Contributor Author

@ishpaul777 The two related issues seem resolved.

@ishpaul777
Copy link
Contributor

@QichenZhu Could you add some details on what was the problem and how these changes fix it?

@QichenZhu
Copy link
Contributor Author

@ishpaul777 Sure! Actually, there were 3 (maybe 4) different problems.

1. Main issue #51337

requestCameraPermission() used videoConstraints but didn’t include it in the dependency array. Resolved by removing the use of videoConstraints from requestCameraPermission() and recalculating it every time the camera starts.

2. Random camera crash on some old iOS versions

Sometimes the camera started normally but stopped working within one second. Reproducible in Safari and Chrome on iOS 17.5 and 17.7.2 but seems resolved on iOS 18. I suspect the camera view resized on startup, causing iOS to fail rendering it. Fixed by setting display to none during this process.

3. Cropped camera view

I think this was just another form of the same issue as above on different iOS versions.

4. Random camera init failure in Chrome

Safari and Chrome behaved differently because Browser.isMobileSafari() only matches Safari. Resolved by changing it to Browser.isMobileWebkit(), which matches both Safari and Chrome, so they initialize in the same way.

if (Browser.isMobileSafari() && stream.getTracks().length > 0) {

@ishpaul777
Copy link
Contributor

ishpaul777 commented Dec 3, 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 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 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 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.ts 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 UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
    • I verified that all the inputs inside a form are aligned with each other.
    • I added Design label and/or tagged @Expensify/design 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.
  • For any bug fix or new feature in this PR, I verified that sufficient unit tests are included to prevent regressions in this flow.
  • 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
Record_2024-12-04-04-11-39.mp4
Android: mWeb Chrome
Record_2024-12-04-03-33-37.mp4
iOS: Native
trim.96E08D14-F849-4ABF-9FF3-B48F5E552A2F.MOV
iOS: mWeb Safari
trim.2335DA68-7255-4C5E-B6F2-B3526CF4D171.MOV
trim.5C14B610-93F3-4C06-94FD-629CF38434E2.MOV
MacOS: Chrome / Safari

Camera feature not available on desktop

MacOS: Desktop

Camera feature not available on desktop

@ishpaul777
Copy link
Contributor

Bug: App crashes on android when navigating back after scanning receipt

Record_2024-12-04-03-39-03.mp4

@QichenZhu
Copy link
Contributor Author

Bug: App crashes on android when navigating back after scanning receipt

@ishpaul777 This PR only changes web files and types, so it's unlikely to cause this. I just tested merging this PR into main and it works fine on Android. Do you need me to merge main into this PR?

@ishpaul777
Copy link
Contributor

Yea please lets try merging main

@ishpaul777
Copy link
Contributor

okay seems to eb resolved after merging main 👍, please update author checklist it seems to be changed recently

@QichenZhu
Copy link
Contributor Author

Thanks! Checklist updated.

@ishpaul777
Copy link
Contributor

1 similar comment
@ishpaul777
Copy link
Contributor

@QichenZhu
Copy link
Contributor Author

QichenZhu commented Dec 3, 2024

Can you please add unit tests ? https://expensify.enterprise.slack.com/archives/C01GTK53T8Q/p1733148961659549

I suggest not adding unit tests because: 1. The main issue and other related issues require running on specific iOS versions on physical devices to reproduce, which is not practical to mock. 2. The main issue can be easily caught by eslint if we hadn't suppressed the warning. This PR removes the suppression, so unit tests wouldn't really add much value.

@melvin-bot melvin-bot bot requested a review from techievivek December 4, 2024 17:29
@ishpaul777
Copy link
Contributor

ishpaul777 commented Dec 4, 2024

@techievivek Do you agree with ^ reasoning to not add unit tests for this bug fix, it makes sense to me but i defer decision to you 🙇 Thanks!

@techievivek
Copy link
Contributor

Yes, I think we can skip this since it’s an iOS-specific version issue. As @QichenZhu mentioned, this could have been caught by the linter itself, and now since we have already removed the suppression, that is fine.

@techievivek
Copy link
Contributor

I have checked off For any bug fix or new feature in this PR, I verified that sufficient [unit tests](https://github.com/Expensify/App/blob/main/tests/README.md) are included to prevent regressions in this flow. based on above points so we can move forward with merge.

@techievivek techievivek merged commit 0ff0cdf into Expensify:main Dec 5, 2024
18 of 21 checks passed
@OSBotify
Copy link
Contributor

OSBotify commented Dec 5, 2024

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

Copy link
Contributor

github-actions bot commented Dec 5, 2024

🚀 Deployed to staging by https://github.com/techievivek in version: 9.0.72-0 🚀

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

Copy link
Contributor

github-actions bot commented Dec 5, 2024

🚀 Deployed to staging by https://github.com/techievivek in version: 9.0.72-0 🚀

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

Copy link
Contributor

github-actions bot commented Dec 9, 2024

🚀 Deployed to production by https://github.com/luacmartins in version: 9.0.72-1 🚀

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

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

Successfully merging this pull request may close these issues.

4 participants