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: 50485 mWeb/Chrome - IOU- Continue and green button not working in scan page #52087

Merged
merged 11 commits into from
Nov 28, 2024

Conversation

layacat
Copy link
Contributor

@layacat layacat commented Nov 6, 2024

Explanation of Change

Update the docs and explanation for IOU camera flow.

Fixed Issues

$ #50485
PROPOSAL: #50485 (comment)

Tests

[mWeb only]

Precondition: App has never asked for camera permission before. Might need to clear the browser cache to reset permission settings.

  1. Tap FAB > Create expense > Scan > Continue
  2. Deny camera access
  3. Verify Camera access still hasn't been granted, please follow these instructions. message and Continue button appears
  4. Tap these instructions
  5. Verify Expensify help site opens with How can I enable camera permission for a website on mobile browsers? highlighted
  6. Follow the instructions in help site to grant camera access
  7. Refresh the site
  8. Verify camera is enabled in IOU Scan page
  • Verify that no errors appear in the JS console

Offline tests

N/A

QA Steps

// TODO: These must be filled out, or the issue title must include "[No QA]."

How to enable camera permission for a website on mobile browsers?

Google Chrome:

  1. Open Chrome.
  2. To the right of the address bar, tap More icon › Settings.
  3. Tap Site settingsCamera.
  4. Tap to turn the microphone or camera on or off.
    • If you find the site you want to use under Blocked, tap the site › Allow.
  5. Refresh the site.

Safari:

  1. Open Safari.
  2. To the left of the address bar, tap More icon › Site settingsCamera.
  3. Tap Allow to grant permission.
  4. Tap Done.
  5. Refresh the site.

[mWeb only]

Precondition: App has never asked for camera permission before. Might need to clear the browser cache to reset permission settings.

  1. Tap FAB > Create expense > Scan > Continue
  2. Deny camera access
  3. Verify Camera access still hasn't been granted, please follow these instructions. message and Continue button appears
  4. Tap these instructions
  5. Verify Expensify help site opens
  6. Follow the instructions in the How to enable camera permission for a website on mobile browsers? section above to grant camera access
  7. Back to App and refresh it
  8. Verify camera is enabled in IOU Scan page
  • 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 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 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.

Screenshots/Videos

Android: Native

Screenshot_1730946104

Android: mWeb Chrome

android web

Screenshot 2024-11-21 at 17 15 52
iOS: Native

Simulator Screenshot - iPhone 15 Pro Max - 2024-11-07 at 10 30 29

iOS: mWeb Safari ios web
MacOS: Chrome / Safari web Screenshot 2024-11-21 at 17 15 32
MacOS: Desktop desktop

@layacat layacat marked this pull request as ready for review November 7, 2024 01:45
@layacat layacat requested a review from a team as a code owner November 7, 2024 01:45
@melvin-bot melvin-bot bot requested review from dominictb and removed request for a team November 7, 2024 01:45
Copy link

melvin-bot bot commented Nov 7, 2024

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

@layacat
Copy link
Contributor Author

layacat commented Nov 7, 2024

It's ready for review. I'll complete the screenshots in the meantime

@dominictb
Copy link
Contributor

Please copy the Tests steps to the QA Steps. Refrain from "Same as...".

@layacat
Copy link
Contributor Author

layacat commented Nov 11, 2024

I'm working on it

@dominictb
Copy link
Contributor

@layacat Ping me when you're done.

@layacat
Copy link
Contributor Author

layacat commented Nov 14, 2024

Sure. I'm having issue with running the docs project. I'll keep you posted

@dominictb
Copy link
Contributor

@layacat any new updates?

@layacat
Copy link
Contributor Author

layacat commented Nov 19, 2024

I'm updating the docs section with your advice. I'll also address all the review comments in one go.

@layacat
Copy link
Contributor Author

layacat commented Nov 20, 2024

@dominictb What do you think about this? I linked user to FAQ section if they click here:

mbbrs.mov

@dominictb
Copy link
Contributor

dominictb commented Nov 20, 2024

@layacat Looks much better. How about just the FAQ question? The info box seems an extra step and quite redundant to me.

@layacat
Copy link
Contributor Author

layacat commented Nov 20, 2024

I updated. Please check

Copy link
Contributor

@dominictb dominictb left a comment

Choose a reason for hiding this comment

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

Please do it very carefully this time to speed up the PR! I already included the changes with detailed text for you.

@layacat
Copy link
Contributor Author

layacat commented Nov 21, 2024

All Done. Please check again.

@dominictb
Copy link
Contributor

@layacat Please update your screenshots and videos as well showing the final flow and text. We need marketing approval on the text.

@layacat
Copy link
Contributor Author

layacat commented Nov 21, 2024

Sure. I've added.

@dominictb
Copy link
Contributor

dominictb commented Nov 21, 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.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

Screenshot_1732185812

Android: mWeb Chrome

Tested on emulator using mocked camera.

Screen.Recording.2024-11-21.at.17.47.05-compressed.mov
iOS: Native

Simulator Screenshot - iPhone 16 - 2024-11-21 at 17 48 47

iOS: mWeb Safari

Tested on simulator using mocked camera.

Screen.Recording.2024-11-21.at.17.37.13-compressed.mov
MacOS: Chrome / Safari

Screenshot 2024-11-21 at 17 39 56

MacOS: Desktop

Screenshot 2024-11-21 at 17 50 07

@dominictb
Copy link
Contributor

dominictb commented Nov 21, 2024

@layacat Please update Tests and QA Tests:

[mWeb only]

**Precondition**: App has never asked for camera permission before. Might need to clear the browser cache to reset permission settings.

1. Tap FAB > Create expense > Scan > Continue
2. Deny camera access
3. Verify `Camera access still hasn't been granted, please follow these instructions.` message and `Continue` button appears
4. Tap `these instructions`
5. Verify Expensify help site opens with `How can I enable camera permission for a website on mobile browsers?` highlighted
6. Follow the instructions in help site to grant camera access
7. Refresh the site
8. Verify camera is enabled in IOU Scan page

…nse.md


Update end of line dot.

Co-authored-by: Dominic <165644294+dominictb@users.noreply.github.com>
@dominictb
Copy link
Contributor

@layacat You missed the QA Steps

Screenshot 2024-11-21 at 17 44 08

@layacat
Copy link
Contributor Author

layacat commented Nov 21, 2024

Updated.

Copy link
Contributor

@dominictb dominictb left a comment

Choose a reason for hiding this comment

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

LGTM

@melvin-bot melvin-bot bot requested a review from Julesssss November 21, 2024 10:50
@dominictb
Copy link
Contributor

dominictb commented Nov 21, 2024

@Julesssss Need your help here:

  1. What's the procedure to get approval on help site article text? Do we need Waiting for Copy label?
  2. AFAIK, QA cannot test help site changes on staging, can they? If so how can we test it, or need to wait for production deployment and retest later?

@dominictb
Copy link
Contributor

dominictb commented Nov 21, 2024

@layacat Thanks for your collaborative attitude to get this done ASAP today 🚀

However next time please be more mindful, careful and attentive to details. Refine your changes before requesting review. Think about other similar cases/places. So we can avoid back-to-back conversations for just several very minor changes.

@Julesssss
Copy link
Contributor

  1. What's the procedure to get approval on help site article text? Do we need Waiting for Copy label?
  2. AFAIK, QA cannot test help site changes on staging, can they? If so how can we test it, or need to wait for production deployment and retest later?

Hey @dominictb. Yeah that sounds correct looking at internal instructions. We can review it briefly on prod before paying out 👍

@Julesssss
Copy link
Contributor

I requested copy review here.

@dominictb
Copy link
Contributor

dominictb commented Nov 22, 2024

@layacat Because QA cannot test Help docs on staging, please update QA Steps as follow:

<details>
<summary>How to enable camera permission for a website on mobile browsers?</summary>

<h4>Google Chrome:</h4>

1. Open Chrome.
2. To the right of the address bar, tap More icon › **Settings**.
3. Tap **Site settings** › **Camera**.
4. Tap to turn the microphone or camera on or off.
    - If you find the site you want to use under **Blocked**, tap the site › **Allow**.
6. Refresh the site.

<h4>Safari:</h4>

1. Open Safari.
2. To the left of the address bar, tap More icon › **Site settings** › **Camera**.
3. Tap **Allow** to grant permission.
4. Tap **Done**.
5. Refresh the site.
</details>

[mWeb only]

**Precondition**: App has never asked for camera permission before. Might need to clear the browser cache to reset permission settings.

1. Tap FAB > Create expense > Scan > Continue
2. Deny camera access
3. Verify `Camera access still hasn't been granted, please follow these instructions.` message and `Continue` button appears
4. Tap `these instructions`
5. Verify Expensify help site opens
6. Follow the instructions in the **How to enable camera permission for a website on mobile browsers?** section above to grant camera access
7. Back to App and refresh it
8. Verify camera is enabled in IOU Scan page

@dominictb
Copy link
Contributor

And remove "Same as Tests" from Offline tests. If we're offline, we cannot open Help site.

@layacat
Copy link
Contributor Author

layacat commented Nov 22, 2024

Thanks. I updated

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.

Copy was approved. Lets merge

@Julesssss Julesssss merged commit 43640b1 into Expensify:main Nov 28, 2024
23 of 25 checks passed
@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.

Copy link
Contributor

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

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

Copy link
Contributor

🚀 Deployed to production by https://github.com/mountiny in version: 9.0.68-7 🚀

platform result
🤖 android 🤖 skipped 🚫
🖥 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