Fix: VisionCamera session is not deinitialized/recycled when screen gets unmounted on `native-stack` #49936

chrispader · 2024-09-30T14:22:44Z

Details

Fixes an issue with [email protected] where the CameraSession doesn't get de-initialized and/or recycled, when the screen gets popped/unmounted from the Navigation stack in @react-navigation/native-stack.

Note

This PR is needed in #37891

Since the fixing patch is based on another patch that we introduced in #45289, we can't (yet) create an upstream issue for this.

I raised this issue Margelo-internally so we can fix this once react-native-vision-camera is fully migrated to the New Architecture.

We should also think about updating react-native-vision-camera to the latest (stable) version, because there are some new changes related to New Arch support.

Fixed Issues

$ #49988
$ #37891
PROPOSAL: #37891 (comment)

Tests

Verify that no errors appear in the JS console

Open the App on a physical iOS device
Click the FAB and go to "Submit expense"
Make sure the camera starts up.
Navigate back to the Home screen
Make sure, the "green camera indicator" in the iOS StatusBar/Dynamic Island/Notch disappears.
Go to "Submit expense" again and make sure the camera starts up again.

Offline tests

QA Steps

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Android: Native

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

melvin-bot · 2024-09-30T14:23:15Z

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

ishpaul777 · 2024-09-30T15:49:34Z

I can take this review, (c+ on #37891 where this is orignally found)

mountiny · 2024-10-01T13:00:09Z

patches/react-native-vision-camera+4.0.0-beta.13+001+rn75-compatibility.patch

@chrispader can you please create an issue in Expensify and link it here that will track removing these patches once we add support upstream? We can then make it monthly and make sure this gets done over time

mountiny · 2024-10-01T14:13:04Z

@chrispader it seems like the ios build failed in the vision camera step https://github.com/Expensify/App/actions/runs/11125757985

ishpaul777 · 2024-10-01T14:36:24Z

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 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.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 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.
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

WhatsApp.Video.2024-10-02.at.10.19.10.PM.mp4

Android: mWeb Chrome

WhatsApp.Video.2024-10-02.at.10.30.17.PM.mp4

iOS: Native

![Uploading 372942263...]

trim.10425D8E-0197-4CD8-946E-971DCE7B1A8B.MOV

iOS: mWeb Safari

ScreenRecording_10-02-2024.21-47-11_1.mov

MacOS: Chrome / Safari

MacOS: Desktop

chrispader · 2024-10-01T16:54:05Z

@mountiny not sure why the iOS build fails, the throwing line is not changed by the patch, but i just re-applied the patch and removed some unused code.

Could you please trigger another ad-hoc build?

ishpaul777 · 2024-10-01T17:40:58Z

I tried to build locally with new commits, it still fails @chrispader

…nted on `native-stack`

mountiny · 2024-10-02T11:55:52Z

@chrispader running a new build. Can you check this out, please? https://github.com/Expensify/App/actions/runs/11143292660

github-actions · 2024-10-02T12:34:28Z

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

👀 View the workflow run that generated this build 👀

chrispader · 2024-10-02T13:56:42Z

@mountiny @ishpaul777 just updated the patches. Now it should work!

github-actions · 2024-10-02T14:46:05Z

🧪🧪 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/49936/index.html	https://ad-hoc-expensify-cash.s3.amazonaws.com/ios/49936/index.html

Desktop 💻	Web 🕸️
https://ad-hoc-expensify-cash.s3.amazonaws.com/desktop/49936/NewExpensify.dmg	https://49936.pr-testing.expensify.com

👀 View the workflow run that generated this build 👀

ishpaul777 · 2024-10-03T11:05:51Z

@mountiny Ready for your review!

mountiny

Thanks @ishpaul777 @chrispader !

OSBotify · 2024-10-03T23:42:35Z

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

github-actions · 2024-10-04T21:17:08Z

🚀 Deployed to staging by https://github.com/mountiny in version: 9.0.45-1 🚀

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

github-actions · 2024-10-07T22:33:46Z

🚀 Deployed to production by https://github.com/thienlnam in version: 9.0.45-4 🚀

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

chrispader requested a review from a team as a code owner September 30, 2024 14:22

melvin-bot bot requested review from mjasikowski and removed request for a team September 30, 2024 14:23

chrispader mentioned this pull request Sep 30, 2024

[NoQA] Perf: PlatormStackNavigation - Use @react-navigation/native-stack on mobile platforms #37891

Merged

48 tasks

mountiny requested a review from ishpaul777 October 1, 2024 09:09

mountiny assigned chrispader Oct 1, 2024

mountiny added the Ready To Build label Oct 1, 2024

mountiny requested changes Oct 1, 2024

View reviewed changes

chrispader requested a review from mountiny October 1, 2024 13:05

This comment has been minimized.

Sign in to view

chrispader mentioned this pull request Oct 1, 2024

Migrate E/App to use PlatformStackNavigation #49937

Merged

50 tasks

chrispader added 3 commits October 2, 2024 13:08

fix: VisionCamera session is not deinitialized when screen gets unmou…

73db225

…nted on `native-stack`

update patch

a0aa19d

fix: patches

00944c0

chrispader force-pushed the @chrispader/fix-vision-camera-session-not-stopped-on-screen-unmount branch from 4c25476 to 00944c0 Compare October 2, 2024 13:56

ishpaul777 approved these changes Oct 2, 2024

View reviewed changes

mountiny approved these changes Oct 3, 2024

View reviewed changes

mountiny merged commit 464f2b7 into Expensify:main Oct 3, 2024
9 checks passed

github-actions bot mentioned this pull request Oct 4, 2024

Deploy Checklist: New Expensify 2024-10-04 #50274

Closed

53 tasks

melvin-bot bot mentioned this pull request Oct 7, 2024

[HOLD App#50650] Tracking: Remove VisionCamera CameraSession on Fabricpatch once the library was fully migrated to New Arch #49988

Open

rezkiy37 mentioned this pull request Nov 21, 2024

BUG: Receipt is deleted if app is killed while request is in queue #51761

Open

8 tasks

ishpaul777 mentioned this pull request Dec 9, 2024

[$250] LOW: Investigate using native-stack on native platforms instead of stack #29948

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix: VisionCamera session is not deinitialized/recycled when screen gets unmounted on `native-stack` #49936

Fix: VisionCamera session is not deinitialized/recycled when screen gets unmounted on `native-stack` #49936

chrispader commented Sep 30, 2024 •

edited

Loading

melvin-bot bot commented Sep 30, 2024

ishpaul777 commented Sep 30, 2024

mountiny Oct 1, 2024

This comment has been minimized.

mountiny commented Oct 1, 2024

ishpaul777 commented Oct 1, 2024 •

edited

Loading

chrispader commented Oct 1, 2024

ishpaul777 commented Oct 1, 2024 •

edited

Loading

mountiny commented Oct 2, 2024

github-actions bot commented Oct 2, 2024

chrispader commented Oct 2, 2024

github-actions bot commented Oct 2, 2024

ishpaul777 commented Oct 3, 2024

mountiny left a comment

OSBotify commented Oct 3, 2024

github-actions bot commented Oct 4, 2024

github-actions bot commented Oct 7, 2024

Fix: VisionCamera session is not deinitialized/recycled when screen gets unmounted on native-stack #49936

Fix: VisionCamera session is not deinitialized/recycled when screen gets unmounted on native-stack #49936

Conversation

chrispader commented Sep 30, 2024 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Sep 30, 2024

ishpaul777 commented Sep 30, 2024

mountiny Oct 1, 2024

Choose a reason for hiding this comment

This comment has been minimized.

mountiny commented Oct 1, 2024

ishpaul777 commented Oct 1, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

chrispader commented Oct 1, 2024

ishpaul777 commented Oct 1, 2024 • edited Loading

mountiny commented Oct 2, 2024

github-actions bot commented Oct 2, 2024

chrispader commented Oct 2, 2024

github-actions bot commented Oct 2, 2024

ishpaul777 commented Oct 3, 2024

mountiny left a comment

Choose a reason for hiding this comment

OSBotify commented Oct 3, 2024

github-actions bot commented Oct 4, 2024

github-actions bot commented Oct 7, 2024

Fix: VisionCamera session is not deinitialized/recycled when screen gets unmounted on `native-stack` #49936

Fix: VisionCamera session is not deinitialized/recycled when screen gets unmounted on `native-stack` #49936

chrispader commented Sep 30, 2024 •

edited

Loading

ishpaul777 commented Oct 1, 2024 •

edited

Loading

ishpaul777 commented Oct 1, 2024 •

edited

Loading