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

Perf: improve camera activation tti #26321

Merged

Conversation

hannojg
Copy link
Contributor

@hannojg hannojg commented Aug 30, 2023

Details

This PR includes two fixes to speed up the time until the camera activates:

  • We use a wide-angle-camera device, which will be initialised quicker than the device picked by default by vision camera
  • Before the camera would only be set to active as soon as the camera screen (its rendered inside a tab screen navigator) has become fully visible. Now it will activate the camera as soon as we swipe / navigate to the camera

For the last point to be possible we need to hook into the tab bar animation value, which is implemented in this PR. We apply a patch currently until its merged:

Fixed Issues

$ #26110
PROPOSAL: #26110 (comment)

Tests

  • Open the request money flow on a physical iOS device (with all betas enabled)
  • Swap between the camera tab and the others
  • Notice how the camera activates quicker

Offline tests

n/a

QA Steps

  • Same as testing

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

n/a native mobile only change

Mobile Web - Chrome

n/a native mobile only change

Mobile Web - Safari

n/a native mobile only change

Desktop

n/a native mobile only change

iOS
RPReplay_Final1693421736.MP4
Android

(Note: This is on a very weak android device)

SVID_20230830_210747_1.mp4

:

@hannojg hannojg mentioned this pull request Aug 30, 2023
59 tasks
@hannojg hannojg marked this pull request as ready for review August 30, 2023 18:58
@hannojg hannojg requested a review from a team as a code owner August 30, 2023 18:58
@melvin-bot melvin-bot bot requested review from parasharrajat and removed request for a team August 30, 2023 18:58
@melvin-bot
Copy link

melvin-bot bot commented Aug 30, 2023

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

Copy link
Contributor

@luacmartins luacmartins left a comment

Choose a reason for hiding this comment

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

LGTM left a few minor comments

src/pages/iou/ReceiptSelector/NavigationAwareCamera.js Outdated Show resolved Hide resolved

useEffect(() => {
const listenerId = tabPositionAnimation.addListener(({value}) => {
setIsCameraActive(value > 0 && value < 2);
Copy link
Contributor

Choose a reason for hiding this comment

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

Not sure if this is possible, but can we dynamically get the number of tabs so it's less brittle?

Copy link
Member

@parasharrajat parasharrajat Aug 31, 2023

Choose a reason for hiding this comment

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

this can be done via ._value but I think we want to close the camera when the user closes the tab so this looks correct.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yes, let me update the code, so its dynamic, good call!

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I made it now dynamic, wdyt?

@mountiny
Copy link
Contributor

@parasharrajat will do checklist on this one soon

@parasharrajat
Copy link
Member

Running checklist.

mountiny
mountiny previously approved these changes Aug 31, 2023
Copy link
Contributor

@mountiny mountiny left a comment

Choose a reason for hiding this comment

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

This is testing well! There is still some lag, but i assume its fine as its not really disturbing
https://github.com/Expensify/App/assets/36083550/5fa0a88c-b68f-4511-b43d-23ec5871ea75

@hannojg
Copy link
Contributor Author

hannojg commented Aug 31, 2023

Yes, we can look into further optimising that once visioncamera V3 is out of the door!

@parasharrajat
Copy link
Member

I think @mountiny you will have to ask someone else to finish the checklist on this. My device is running iOS 16.6 and my Xcode 14.2 is not able to build the app for that. I am trying to set it up but it is taking time.

@mountiny
Copy link
Contributor

@parasharrajat Are you able to run Android? I dont have a physical device, I have tested iOS so you dont have to consider that

@parasharrajat
Copy link
Member

Yes, I can test Android.

@@ -93,7 +93,7 @@ function MoneyRequestSelectorPage(props) {
<TopTab.Screen
name={CONST.TAB.SCAN}
component={ReceiptSelector}
initialParams={{reportID, iouType}}
initialParams={{reportID, iouType, pageIndex: 1}}
Copy link
Member

Choose a reason for hiding this comment

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

This seems fine for now. But as we use Onyxbased tab selection we should utilize that instead. I agree that tabs are positioned based on number so we should update the OnyxTabnavigator to have these saved with Tab IDs. In short, a more compliant solution might be the one that uses Tab ID instead of index. I hope you understand what I am trying to say here.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Hm, do you have any proposal how we'd store the tab ID (index) in the onyx tab navigator state?

Copy link
Member

Choose a reason for hiding this comment

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

I see that we are already storing the activeTab in Onyx but we can't use it here as we need the static value of the Screen index. I guess we can use the navigation state for that purpose. Given that we already know the name of the screen.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I don't have any immediate idea how to get that from the navigation state. Could you give me a pointer?

Copy link
Member

Choose a reason for hiding this comment

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

let me check..

@parasharrajat
Copy link
Member

Hmm, the build is failing on Android at buildHermes Step. Trying options.

@parasharrajat
Copy link
Member

So there is a slight delay before the camera is opened but that might be just a dev build. Mainly the camera gets activated while tab is being opened same as the code.

@parasharrajat
Copy link
Member

parasharrajat commented Aug 31, 2023

BUG: Android: The camera stays black when we go back from the Cash page after clicking the photo.

  1. Steps. Open the Scan page.
  2. Take a picture.
  3. Press the top back arrow from the Cash page.
  4. Notice the blank camera page.
Screenrecorder-2023-08-31-16-08-52-655.mp4

@hannojg
Copy link
Contributor Author

hannojg commented Aug 31, 2023

@parasharrajat that's on android? Can't reproduce on iOS right now

@hannojg
Copy link
Contributor Author

hannojg commented Aug 31, 2023

Yes, can reproduce on android

// Edit: sorry, just seen that you specified its android

@hannojg
Copy link
Contributor Author

hannojg commented Aug 31, 2023

@parasharrajat Can you please re-test? Bug should be fixed

@parasharrajat
Copy link
Member

Awesome thanks. Checking now.

Comment on lines +44 to +56
useEffect(() => {
const removeBlurListener = navigation.addListener('blur', () => {
setIsCameraActive(false);
});
const removeFocusListener = navigation.addListener('focus', () => {
setIsCameraActive(true);
});

return () => {
removeBlurListener();
removeFocusListener();
};
}, [navigation]);
Copy link
Member

Choose a reason for hiding this comment

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

we can use useFocusEffect instead of this.

@parasharrajat
Copy link
Member

lgtm.

@parasharrajat
Copy link
Member

parasharrajat commented Aug 31, 2023

Screenshots

🔲 iOS / native

This is the best I could test on iOS. but Mountiny confirmed so I think we are good here.

Screen.Recording.2023-08-31.at.11.30.48.PM.mov

🔲 iOS / Safari

Screen.Recording.2023-08-31.at.11.24.44.PM.mov

🔲 MacOS / Desktop

Screen.Recording.2023-08-31.at.11.27.58.PM.mov

🔲 MacOS / Chrome

Screen.Recording.2023-08-31.at.11.21.36.PM.mov

🔲 Android / Chrome

Screenrecorder-2023-08-31-23-22-32-199.mp4

🔲 Android / native

Screenrecorder-2023-08-31-23-15-55-671.mp4

Copy link
Member

@parasharrajat parasharrajat left a comment

Choose a reason for hiding this comment

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

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 / Chrome
    • iOS / native
    • iOS / 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(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 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.

🎀 👀 🎀 C+ reviewed

@melvin-bot melvin-bot bot requested a review from luacmartins August 31, 2023 18:02
@luacmartins luacmartins merged commit ee37a6c into Expensify:main Aug 31, 2023
@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 staging by https://github.com/luacmartins in version: 1.3.61-0 🚀

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

@OSBotify
Copy link
Contributor

OSBotify commented Sep 1, 2023

🚀 Deployed to production by https://github.com/luacmartins in version: 1.3.61-3 🚀

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

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.

5 participants