fix: [Violations] Distance - Incorrect error message when distance amount is changed to smaller amount.

[Krishna2323]

Details

Fixed Issues

$ #41401
PROPOSAL: #41401 (comment)

Tests

1. Go to Submit expense > Scan > Add valid receipt > Select workspace > Submit
2. Wait for scanning to complete, once completed edit the amount to a higher value
3. Verify Amount greater than scanned receipt error appears below amount field
4. Go to Submit expense > Distance > Select 2 waypoints > Select workspace > Submit
5. Open transaction page > Wait for amount to be calculated > Edit the amount to higher value
6. Verify Amount differs from calculated distance error appears below amount field

• Verify that no errors appear in the JS console

Offline tests

1. Go to Submit expense > Scan > Add valid receipt > Select workspace > Submit
2. Wait for scanning to complete, once completed edit the amount to a higher value
3. Verify Amount greater than scanned receipt error appears below amount field
4. Go to Submit expense > Distance > Select 2 waypoints > Select workspace > Submit
5. Open transaction page > Wait for amount to be calculated > Edit the amount to higher value
6. Verify Amount differs from calculated distance error appears below amount field

QA Steps

1. Go to Submit expense > Scan > Add valid receipt > Select workspace > Submit
2. Wait for scanning to complete, once completed edit the amount to a higher value
3. Verify Amount greater than scanned receipt error appears below amount field
4. Go to Submit expense > Distance > Select 2 waypoints > Select workspace > Submit
5. Open transaction page > Wait for amount to be calculated > Edit the amount to higher value
6. Verify Amount differs from calculated distance error appears below amount field

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

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

[melvin-bot]

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

[Krishna2323]

@JmillsExpensify @sobitneupane, I found one more issue in this PR. We only show the Receipt Verified audit, but when we have violation notices, we don't show the 'Issue/Issues found' text. The reason for that is I misunderstood this comment and hid the 'Issue/Issues found' message along with Receipt Verified message until the receipt status is SCANCOMPLETE but in case of issue while scanning, the receipt status is to OPEN.

I have fixed the above issue, now it will show Issue/Issues found if we have receipt violations and receipt is present.

Yes we shouldn't show the taxRateChanged note on NewDot, as it is being deprecated given that we have implemented that feature differently vs OldDot.

One more question on the above comment: do we also need to remove the taxAmountChanged notice, along with taxRateChanged, from NewDot?

App/src/CONST.ts

Line 3622 in 550e83b

TAX_AMOUNT_CHANGED: 'taxAmountChanged',

App/src/CONST.ts

Line 3624 in 550e83b

TAX_RATE_CHANGED: 'taxRateChanged',

Bug

[sobitneupane]

Screenshots/Videos

Android: Native

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

Screen.Recording.2024-05-07.at.14.22.47.mov

MacOS: Desktop

[sobitneupane]

@Krishna2323 Have we considered different types as mentioned here? Can you please complete the PR Author checklist. Please include the test cases for different types.

[Krishna2323]

One more question on the above comment: do we also need to remove the taxAmountChanged notice, along with taxRateChanged, from NewDot?

@JmillsExpensify bump on the question.

[Krishna2323]

Have we considered different types as mentioned #41401 (comment)?

Code has been updated according to this, will update test cases and recordings after getting clarification on the question above.

[JmillsExpensify]

Whoops, sorry missed this.

One more question on the above comment: do we also need to remove the taxAmountChanged notice, along with taxRateChanged, from NewDot?

Yes, that's correct. We aren't going to show these on NewDot, as both will generate system messages when changed. We also show what tax rate is "default" in a parallel initiative that's currently in implementation for track tracking in New Expensify.

[JmillsExpensify]

Just confirming that the above response makes sense?

[Krishna2323]

@JmillsExpensify, yup thats clear to me, updating the PR in few moments.

[Krishna2323]

@sobitneupane, you can review the code changes now. However, I'm not sure what to add in the test cases. Could you provide some guidance? Several types of amount notices are there.

[sobitneupane]

However, I'm not sure what to add in the test cases. Could you provide some guidance? Several types of amount notices are there.

@Krishna2323 You can include the test cases based on this expected output.

Verify that the notice violations related to Amount is shown below the amount field and other notice violations like date below the specific field(#41401 (comment)).

Let's show all these cases under the amount field, since a) we think it's more impactful/intuitive to highlight that the amount is greater than the receipt, than the other way around; and b) the field you need to take action on in order to fix the violation is the amount field, not the receipt field

Verify notice violations based on their type

{data: {type: 'distance'}}
{data: {type: 'card'}}
{data: {type: 'smartscan'}}
{data: {type: 'smartscan', displayPercentVariance: $displayPercentVariance}}

You can also include Tests for the bug you discussed here.

Basically, the tests should cover the changes made in the PR. You can add multiple set of test cases.

[sobitneupane]

In distance request, I can still see the wrong error message.

[Krishna2323]

In distance request, I can still see the wrong error message.

I guess this requires backend change, @cead22 can you pls confirm?

[JmillsExpensify]

I think you mean @cead22

[Krishna2323]

I think you mean @cead22

yeah 🥶

[cead22]

Yes, I'll get the PR for that submitted tomorrow

[cead22]

I submitted the PR for review

[Krishna2323]

@cead22, any update on the backend PR?

[cead22]

Yeah it's live as of yesterday morning (PT)

[sobitneupane]

@Krishna2323 The violation message are being shown below the Receipt instead of respective field.

[cead22]

@Krishna2323 The violation message are being shown below the Receipt instead of respective field.

That means we might not be using violationFields or the flow that uses violationFields to get the mapping of violation -> field to show violation

[cead22]

@Krishna2323 please put this at the top of your priority list so we can merge this this week (ideally today/tomorrow)

[Krishna2323]

Will start working on the suggestions in a hour.

[Krishna2323]

@sobitneupane @cead22, I mistakenly added modified amount violation here while resolving conflict, thats why the violation was shown under receipt. I have removed that and also CONST.VIOLATIONS.MODIFIED_DATE because I believe the date violation should also be shown under date field.

[Krishna2323]

@sobitneupane @cead22, can you pls check again, I have tested this.

[cead22]

@Krishna2323 what about #41649 (comment) ?

[sobitneupane]

@Krishna2323 Please make sure to test the PR in your end after each change.

[Krishna2323]

@sobitneupane, tested again 😵‍💫

[Krishna2323]

@sobitneupane @cead22, updated shouldShowAuditMessage, now this is will be enough for handling violation messages and audit result both. It works correctly as per my testing.

[OSBotify]

✋ 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]

🚀 Deployed to staging by https://github.com/cead22 in version: 9.0.7-3 🚀

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

[OSBotify]

🚀 Cherry-picked to staging by https://github.com/thienlnam in version: 9.0.7-4 🚀

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

@Expensify/applauseleads please QA this PR and check it off on the deploy checklist if it passes.

[OSBotify]

🚀 Deployed to production by https://github.com/thienlnam in version: 9.0.7-8 🚀

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

[OSBotify]

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

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