Issue/36520 android scan second tap on capture button causes error to show up by agent3bood · Pull Request #37182 · Expensify/App

agent3bood · 2024-02-25T16:17:44Z

Details

Fix bug where a second tap on the camera button on native will show an error message.
There were three things fixed in this PR

Changed capturePhoto to return a Promise so it works properly with the native implementation of useSingleExecution.
Introduce new variable didCapturePhoto to prevent another call to capturePhoto while navigation is triggered and the user is still on the camera screen.
Added focus listener to reset the didCapturePhoto when the user navigate back to the scan screen.

Fixed Issues

$ #36520
PROPOSAL: #36520 (comment)

Tests

Launch New Expensify app
Tap + > Request money
Go to Scan
Tap on the capture button twice
Verify that no errors popup appear in the app

Verify that no errors appear in the JS console

Offline tests

same as tests

QA Steps

same as tests

PR Author Checklist

Screenshots/Videos

Android: Native

Screen_Recording_20240225-103944_New.Expensify.Dev.mp4

Android: mWeb Chrome

Screen_Recording_20240225-180953_Chrome.mp4

iOS: Native

RPReplay_Final1708876872.MP4

iOS: mWeb Safari

RPReplay_Final1708874323.MP4

MacOS: Chrome / Safari

Screen.Recording.2024-02-25.at.10.52.00.mov

MacOS: Desktop

Screen.Recording.2024-02-25.at.18.22.21.mov

Prevent calling the function while navigation is going on

…-Scan---Second-tap-on-capture-button-causes-error-to-show-up

melvin-bot · 2024-02-25T16:17:49Z

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

github-actions · 2024-02-25T16:18:00Z

CLA Assistant Lite bot All contributors have signed the CLA ✍️ ✅

agent3bood · 2024-02-25T16:19:41Z

I have read the CLA Document and I hereby sign the CLA

hoangzinh · 2024-02-27T10:59:43Z

Thanks @agent3bood I will review the PR today

hoangzinh · 2024-02-27T15:39:45Z

src/components/Pressable/GenericPressable/BaseGenericPressable.tsx

        const {shortcutKey, descriptionKey, modifiers} = keyboardShortcut;
-        return KeyboardShortcut.subscribe(shortcutKey, onPressHandler, descriptionKey, modifiers, true, false, 0, false);
-    }, [keyboardShortcut, onPressHandler]);
+        return KeyboardShortcut.subscribe(shortcutKey, singleExecution(onKeyboardShortcutPressHandler), descriptionKey, modifiers, true, false, 0, false);


Instead of workaround by introducing a new callback here, we can update the type there, what do you think

App/src/libs/KeyboardShortcut/index.ts

Line 134 in 174a032

callback: (event?: KeyboardEvent) => void,

callback: (event?: KeyboardEvent) => void | Promise<void>

If I update the signature then it would mean the KeyboardShortcut.subscribe is able to handle the promise, but actually is is not handling futures.

it makes sense. Then why do we need wrapped by singleExecution here? In the previous logic we don't have.

Removed singleExecution, it is not required here.

hoangzinh · 2024-02-27T15:47:17Z

src/pages/iou/request/step/IOURequestStepScan/index.native.js

    const [cameraPermissionStatus, setCameraPermissionStatus] = useState(undefined);
    const askedForPermission = useRef(false);

+    const [didCapturePhoto, setDidCapturePhoto] = useState(false);


without this check, it still works fine on my simulator with double tap/triple tap. Is there any case that we need those checks?

Screen.Recording.2024-02-27.at.22.44.45.mov

Without this part it will work for second/third tap, but if you keep tapping until the page transition then it will show the same error message as before.
As I explained in the issue, after the photo is taken navigation will kick off, using this code will block taking new photo while navigation is in progress.

Because if we use this technique, it appears that the hook useSingleExecution is not useful anymore. If we haven't had a global fix in useSingleExecution yet, I think we can scope the fix in second/third tap. About keep tapping until the page transition, it's a very edge case, I don't think normal users would do that.

Reverted, tested with second/third tap and it works fine.

Could be a feature request: show animation once photo is taken, something like circular progress while the navigates to next step.

it's a good idea. But let's focus on fixing bug first. Thanks for updating, I will try to complete review checklist today

hoangzinh · 2024-02-27T15:48:29Z

@agent3bood could you add the order number to your test steps?

This reverts commit aa0a8af.

hoangzinh · 2024-02-28T10:05:31Z

@agent3bood it looks like you override the checkbox requirement. Usually, it's Verify that no errors appear in the JS console. For the assertion step, you can add step 5, in this case, to verify the expectation. I.e: this PR #37398

agent3bood · 2024-02-28T10:10:55Z

@agent3bood it looks like you override the checkbox requirement. Usually, it's Verify that no errors appear in the JS console. For the assertion step, you can add step 5, in this case, to verify the expectation. I.e: this PR #37398

Done.

hoangzinh · 2024-02-28T10:18:47Z

Perfect, last but not least, could you confirm this checkbox with your change in this PR?

Verify that no errors appear in the JS console

agent3bood · 2024-02-28T10:21:35Z

Perfect, last but not least, could you confirm this checkbox with your change in this PR?

Verify that no errors appear in the JS console

Done.

src/components/Pressable/GenericPressable/BaseGenericPressable.tsx

hoangzinh · 2024-02-28T10:47:26Z

@agent3bood I found a bug when do testing in Android Chrome, when I did double tap on the capture button, it took to next step without error but the selection list is loading forever

Screen.Recording.2024-02-28.at.17.45.27.mov

agent3bood · 2024-02-28T11:45:06Z

@agent3bood I found a bug when do testing in Android Chrome, when I did double tap on the capture button, it took to next step without error but the selection list is loading forever

Screen.Recording.2024-02-28.at.17.45.27.mov

I was able to reproduce this on Android emulator for both my branch and production as well.
On device it works fine, Android & iOS, what do you suggest we do here?

Recording if from production site.

Screen.Recording.2024-02-28.at.14.43.54.mov

hoangzinh · 2024-02-28T15:23:41Z

Thanks @agent3bood after deep dive into the root cause, I found that:

When we double-tap on capture button, this event is not triggered

App/src/components/ScreenWrapper.tsx

Lines 167 to 175 in 3100b18

    
           const unsubscribeTransitionEnd = navigation.addListener('transitionEnd', (event) => { 
        
               // Prevent firing the prop callback when user is exiting the page. 
        
               if (event?.data?.closing) { 
        
                   return; 
        
               } 
        
               setDidScreenTransitionEnd(true); 
        
               onEntryTransitionEnd?.(); 
        
           });

It leads to didScreenTransitionEnd is still false
Cause this line is an empty array

App/src/pages/iou/request/MoneyTemporaryForRefactorRequestParticipantsSelector.js

Line 340 in 3100b18

sections={didScreenTransitionEnd && isOptionsDataReady ? sections : CONST.EMPTY_ARRAY}

=> It shows the skeleton view. Given it also happens in the main branch and it's not straightforward to fix. It's fine for me to leave it as it is. As least we confirmed it's only happen on simulators

hoangzinh · 2024-02-28T15:24:37Z

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

Screen.Recording.2024-02-28.at.17.53.04.android.mov

Android: mWeb Chrome

Screen.Recording.2024-02-28.at.22.25.15.andoird.chrome.mov

iOS: Native

I don't have a real IOS device, and in the IOS simulator, we can not turn on camera https://stackoverflow.com/a/50523741

Screen.Recording.2024-02-28.at.17.59.40.ios.mov

iOS: mWeb Safari

Screen.Recording.2024-02-28.at.17.49.48.ios.safari.mov

MacOS: Chrome / Safari

Screen.Recording.2024-02-28.at.17.29.32.web.mov

MacOS: Desktop

Screen.Recording.2024-02-28.at.17.31.03.desktop.mov

hoangzinh

LGTM

techievivek · 2024-02-28T16:33:45Z

@agent3bood Linter seems to be complaining, can you please check it and fix. Thanks.

…-Scan---Second-tap-on-capture-button-causes-error-to-show-up # Conflicts: # src/pages/iou/request/step/IOURequestStepParticipants.js

OSBotify · 2024-02-29T14:17:20Z

✋ 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 · 2024-02-29T23:43:31Z

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

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

kavimuru · 2024-03-01T15:28:31Z

Issue #36520 is still reproducible in android and iOS when tapping capture button multiple times. Evidence attached.
https://platform.applause.com/services/links/v1/external/06e6b9891f9f2c712d094cd32f0bf03ffa6680bb4456ced254da373c7ba92054
https://platform.applause.com/services/links/v1/external/263470c4f06e28cab133fa1075e41ceb6861ae6b3f6d5dfd4ed498702d4886b1

agent3bood · 2024-03-01T17:27:51Z

@kavimuru I am aware of this behavior and did had a solution for it, but after a discussion with @hoangzinh we decided to remove it.
Please read more here #37182 (comment)

hoangzinh · 2024-03-01T22:26:22Z

would like to here your thought here #37182 (comment) @techievivek

OSBotify · 2024-03-04T20:25:45Z

🚀 Deployed to production by https://github.com/roryabraham in version: 1.4.46-2 🚀

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

agent3bood added 3 commits February 22, 2024 14:29

fix: camera button double tap

a1c45ee

lock capturePhoto

aa0a8af

Prevent calling the function while navigation is going on

Merge remote-tracking branch 'origin/main' into issue/36520-Android--…

0efe105

…-Scan---Second-tap-on-capture-button-causes-error-to-show-up

agent3bood requested a review from a team as a code owner February 25, 2024 16:17

melvin-bot bot requested review from hoangzinh and removed request for a team February 25, 2024 16:17

hoangzinh reviewed Feb 27, 2024

View reviewed changes

agent3bood added 2 commits February 28, 2024 11:08

revert using singleExecution on keyboard shortcut

41be9d6

Revert "lock capturePhoto"

acb167f

This reverts commit aa0a8af.

hoangzinh reviewed Feb 28, 2024

View reviewed changes

src/components/Pressable/GenericPressable/BaseGenericPressable.tsx Outdated Show resolved Hide resolved

cleanup

43f7693

hoangzinh approved these changes Feb 28, 2024

View reviewed changes

melvin-bot bot requested a review from techievivek February 28, 2024 15:40

techievivek previously approved these changes Feb 28, 2024

View reviewed changes

lint

720a759

agent3bood dismissed techievivek’s stale review via 720a759 February 28, 2024 16:59

Merge remote-tracking branch 'origin/main' into issue/36520-Android--…

1a12f49

…-Scan---Second-tap-on-capture-button-causes-error-to-show-up # Conflicts: # src/pages/iou/request/step/IOURequestStepParticipants.js

techievivek assigned agent3bood Feb 29, 2024

techievivek approved these changes Feb 29, 2024

View reviewed changes

techievivek merged commit 104565b into Expensify:main Feb 29, 2024

github-actions bot mentioned this pull request Feb 29, 2024

Deploy Checklist: New Expensify 2024-02-29 #37578

Closed

36 tasks

greg-schroeder mentioned this pull request Mar 2, 2024

[C+ Checklist Needs Completion] [$500] Android - Scan - Second tap on capture button causes error to show up #36520

Closed

6 tasks

Conversation

agent3bood commented Feb 25, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

Uh oh!

melvin-bot bot commented Feb 25, 2024

Uh oh!

github-actions bot commented Feb 25, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

agent3bood commented Feb 25, 2024

Uh oh!

hoangzinh commented Feb 27, 2024

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

hoangzinh commented Feb 27, 2024

Uh oh!

hoangzinh commented Feb 28, 2024

Uh oh!

agent3bood commented Feb 28, 2024

Uh oh!

hoangzinh commented Feb 28, 2024

Uh oh!

agent3bood commented Feb 28, 2024

Uh oh!

Uh oh!

hoangzinh commented Feb 28, 2024

Uh oh!

agent3bood commented Feb 28, 2024

Uh oh!

hoangzinh commented Feb 28, 2024

Uh oh!

hoangzinh commented Feb 28, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer Checklist

Screenshots/Videos

Uh oh!

hoangzinh left a comment

Choose a reason for hiding this comment

Uh oh!

techievivek commented Feb 28, 2024

Uh oh!

OSBotify commented Feb 29, 2024

Uh oh!

OSBotify commented Feb 29, 2024

Uh oh!

kavimuru commented Mar 1, 2024

Uh oh!

agent3bood commented Mar 1, 2024

Uh oh!

hoangzinh commented Mar 1, 2024

Uh oh!

OSBotify commented Mar 4, 2024

Uh oh!

Reviewers

Assignees

Labels

agent3bood commented Feb 25, 2024 •

edited

Loading

github-actions bot commented Feb 25, 2024 •

edited

Loading

hoangzinh commented Feb 28, 2024 •

edited

Loading