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

Display smartscan errors BELOW the field #27735

Merged
merged 3 commits into from
Sep 27, 2023
Merged

Display smartscan errors BELOW the field #27735

merged 3 commits into from
Sep 27, 2023

Conversation

Gonals
Copy link
Contributor

@Gonals Gonals commented Sep 19, 2023

Details

Fixed Issues

#26832
PROPOSAL:

Tests

  1. Set up Smartscan if you haven't yet. I'd recommend clearing any existing receipts in there to make this easier.
  2. Run bwm.sh
  3. Create a new receipt money request from newDot by going to + -> Request Money -> Scan and sending a random image. A "Smartscanning" transaction should be created.
  4. Wait for a bit for bwm to do its thing (you are waiting for SmartScan?receiptID=XXX).
  5. Log into expensify.com.dev/expensiworks/
  6. Find the receipt you just uploaded (if you cleared up the other ones, it'll be the only one!) and indicate you don't know the amount.
  7. Wait for another bit for bwm to do its thing (confirm nothing fails)
  8. Confirm the Money Request fields get update correctly, with the missing fields. The errors should be BELOW the fields now:
Screenshot 2023-09-19 at 12 27 12 PM
  • Verify that no errors appear in the JS console

Offline tests

None

QA Steps

  1. Create a new receipt money request from newDot by going to + -> Request Money -> Scan and sending a receipt with a missing amount. A "Smartscanning" transaction should be created.
  2. Wait until it smartscans (can take a while)
  3. Confirm the Money Request fields get updated correctly, with the missing fields. Confirm the errors are BELOW the fields:
Screenshot 2023-09-19 at 12 27 12 PM
  • 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 / 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 Screenshot 2023-09-19 at 12 27 12 PM
Mobile Web - Chrome Screenshot 2023-09-19 at 4 10 56 PM
Mobile Web - Safari Screenshot 2023-09-19 at 3 30 44 PM
Desktop Screenshot 2023-09-19 at 3 14 00 PM
iOS Screenshot 2023-09-19 at 4 24 34 PM
Android Screenshot 2023-09-19 at 4 04 55 PM

@Gonals Gonals requested a review from a team as a code owner September 19, 2023 03:42
@Gonals Gonals self-assigned this Sep 19, 2023
@melvin-bot melvin-bot bot requested review from cristipaval and removed request for a team September 19, 2023 03:43
@melvin-bot
Copy link

melvin-bot bot commented Sep 19, 2023

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

@Gonals Gonals changed the title [WIP] Display smartscan errors BELOW the field Display smartscan errors BELOW the field Sep 19, 2023
@Gonals
Copy link
Contributor Author

Gonals commented Sep 19, 2023

Screenshots added. Ready for review, @cristipaval!

@Gonals
Copy link
Contributor Author

Gonals commented Sep 22, 2023

bump @cristipaval !

@cristipaval
Copy link
Contributor

Added @sobitneupane as he seems to be the C+ assigned to the issue. I don't know why Melvin did not assign him in the first place.

@cristipaval
Copy link
Contributor

I'll review after, @sobitneupane

@Gonals
Copy link
Contributor Author

Gonals commented Sep 25, 2023

I don't know why Melvin did not assign him in the first place.

C+ can't really fully test, as this requires handling smartscan and they don't have access to it

@cristipaval
Copy link
Contributor

aah, good point @Gonals, I'll test it then 👍

@cristipaval
Copy link
Contributor

Expensiworks is driving me crazy! I just can't make it show an uploaded receipt, BWM keeps retrying to parse the receipts

Screenshot 2023-09-25 at 23 53 47

I'm going to try again tomorrow as I already spent some time on this. Feel free to also reassign, @Gonals

@Gonals
Copy link
Contributor Author

Gonals commented Sep 26, 2023

@sobitneupane, you may be able to test this by uploading a receipt with no merchant and waiting for it to get smartscanned.

Alternatively, try uploading this receipt. It should automatically parse after a few seconds (maybe a bit longer). After that, changing the Merchant to Unknown Merchant should trigger the error message.

Can you give it a shot?
IMG_0293-2023-09-26 03_14_27 846

@sobitneupane
Copy link
Contributor

Working on it now.

Copy link
Contributor

@sobitneupane sobitneupane 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 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 reviewer checklist, including those that don't apply to this PR.

Screenshots/Videos

Web Screenshot 2023-09-26 at 12 54 00 Screenshot 2023-09-26 at 13 16 16
Mobile Web - Chrome Screenshot 2023-09-26 at 13 06 06 Screenshot 2023-09-26 at 13 17 45
Mobile Web - Safari Screenshot 2023-09-26 at 13 00 26 Screenshot 2023-09-26 at 13 15 19
Desktop Screenshot 2023-09-26 at 13 11 38 Screenshot 2023-09-26 at 13 17 04
iOS Screenshot 2023-09-26 at 13 18 02
Android Screenshot 2023-09-26 at 13 13 41 Screenshot 2023-09-26 at 13 15 56

@melvin-bot melvin-bot bot requested a review from Julesssss September 26, 2023 07:34
@melvin-bot
Copy link

melvin-bot bot commented Sep 26, 2023

@Julesssss 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
Copy link

melvin-bot bot commented Sep 26, 2023

🎯 @sobitneupane, thanks for reviewing and testing this PR! 🎉

An E/App issue has been created to issue payment here: #28231.

@sobitneupane
Copy link
Contributor

Just to confirm:

We are showing Red Dot on Report and not on the transaction thread.
Screenshot 2023-09-26 at 13 20 53

@Julesssss
Copy link
Contributor

@Julesssss 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: HERE

This seems to have been a bug ^ Ignoring

@cristipaval
Copy link
Contributor

Alright, managed to test this one on my local env. It looks like @aimane-chnaif already tested on all platforms. I will merge this.

@cristipaval cristipaval merged commit cf9ad20 into main Sep 27, 2023
17 of 18 checks passed
@cristipaval cristipaval deleted the alberto-moveError branch September 27, 2023 09:45
@aimane-chnaif aimane-chnaif mentioned this pull request Sep 27, 2023
58 tasks
@@ -266,6 +266,11 @@ const MenuItem = React.forwardRef((props, ref) => {
{props.description}
</Text>
)}
{props.error && (
Copy link
Contributor

Choose a reason for hiding this comment

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

Alright, managed to test this one on my local env. It looks like @aimane-chnaif already tested on all platforms. I will merge this.

I tested but console error is very annoying, happening on every page which uses MenuItem.

Screen.Recording.2023-09-27.at.12.57.23.PM.mov

I raised quick PR to fix that:
#28314

@OSBotify
Copy link
Contributor

🚀 Deployed to staging by https://github.com/cristipaval in version: 1.3.75-0 🚀

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

@OSBotify
Copy link
Contributor

OSBotify commented Oct 2, 2023

🚀 Deployed to production by https://github.com/mountiny in version: 1.3.75-12 🚀

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

@OSBotify
Copy link
Contributor

OSBotify commented Oct 2, 2023

🚀 Deployed to staging by https://github.com/cristipaval in version: 1.3.76-0 🚀

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

@OSBotify
Copy link
Contributor

OSBotify commented Oct 3, 2023

🚀 Deployed to production by https://github.com/mountiny in version: 1.3.76-6 🚀

platform result
🤖 android 🤖 success ✅
🖥 desktop 🖥 success ✅
🍎 iOS 🍎 failure ❌
🕸 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.

6 participants