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

Feature: Update merchant to be empty and with validation #32486

Conversation

waterim
Copy link
Contributor

@waterim waterim commented Dec 5, 2023

Details

This PR is about to add an error message when merchant is empty on expense reports in request money and split bill

Fixed Issues

$ #32222

Tests

  1. Login to the app
  2. Click on "Request money" or "Split bill"
  3. Select an amount
    For IOU request:
  4. Select user, not a workspace
  5. Merchant should be empty and no validation errors
  6. You are able to create a request with empty merchant
  7. Create request
  8. Go to edit page
  9. No (empty) string visible for the merchant
  10. Try to edit with empty string the merchant
  11. You were able to edit with empty string
    For Expense request:
  12. Select a workspace
  13. Look that merchant is empty, but validation error is appear that you need to provide a merchant
  14. Create request
  15. Go to edit page
  16. try to edit merchant as empty field
  17. validation error will appear

———-

IOU

  1. Global Create + > “Request money”
  2. Enter an amount
  3. Choose an individual
  4. Verify the merchant is empty on the confirmation page
  5. Click confirm to create the request
  6. Verify you aren’t prompted to enter a merchant name to proceed with creating the request
  7. Click the report preview component to navigate to the expense report
  8. Verify the request preview component doesn’t contain a “faux” merchant (i.e none, unknown merchant etc)
  9. Click the request preview component to navigate to the transaction thread
  10. Verify the merchant field is empty
  11. Click into the merchant field
  12. Verify the merchant edit field is empty
  13. Enter a merchant name
  14. Verify you were able to enter a merchant
  15. Navigate back to the expense report view
  16. Verify the request preview component contains the merchant name entered
  • Verify that no errors appear in the JS console

Offline tests

N/A automated tests

QA Steps

Same as tests

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

Copy link
Contributor

@rezkiy37 rezkiy37 left a comment

Choose a reason for hiding this comment

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

Left comments.

@waterim waterim marked this pull request as ready for review December 6, 2023 13:26
@waterim waterim requested a review from a team as a code owner December 6, 2023 13:26
@melvin-bot melvin-bot bot requested review from eVoloshchak and removed request for a team December 6, 2023 13:26
Copy link

melvin-bot bot commented Dec 6, 2023

@eVoloshchak 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

@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.

@waterim I think there was one condition not clear and that is when you are using SmartScan so submitting a picture receipt we still do not require a merchant and it should work the same as it does now and set the (none) partial merchant optimistically

@waterim
Copy link
Contributor Author

waterim commented Dec 7, 2023

@mountiny Okay, pushed changes, removed required for isScanRequest expense report, now it works as before my changes.
If I understand you correctly only this required in smart scan was an issue, right?

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.

@waterim thanks, getting closer, is this the cleanest way to add the merchant empty check to this form? also wont the reset of the money request remove the Request from merchant too?

src/components/MoneyRequestConfirmationList.js Outdated Show resolved Hide resolved
src/libs/actions/IOU.js Outdated Show resolved Hide resolved
src/components/MoneyRequestConfirmationList.js Outdated Show resolved Hide resolved
src/pages/EditRequestMerchantPage.js Outdated Show resolved Hide resolved
src/pages/EditRequestPage.js Show resolved Hide resolved
src/pages/iou/MoneyRequestMerchantPage.js Outdated Show resolved Hide resolved
@mountiny
Copy link
Contributor

I ma making a test build for easier testing

@OSBotify

This comment has been minimized.

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.

BUG: Requesting manual money from group policy is possible without merchant, the field should be required and it should not be hidden behind the Show More
image

There is also some weird bug here, which is also repro in staging, however, from the video you can see the merchant is set to Request for a second which seems to be a bug in the optimistic data as the merchant should be (none) in this case and hence it should show as empty

Screen.Recording.2023-12-14.at.17.37.16.mp4

@waterim
Copy link
Contributor Author

waterim commented Dec 15, 2023

@mountiny Damn, thats super weird, this happens after I merged main into this branch..

…chant-field-required-for-requests-on-group-policies
@waterim
Copy link
Contributor Author

waterim commented Dec 15, 2023

I cant even see console.logs in MoneyRequestConfirmationList.js component..

@waterim
Copy link
Contributor Author

waterim commented Dec 15, 2023

Okay, I found, there was some refactor and all my code is unused now.. :D
All new IOU steps are in use right now.
image
image

Now the component I need to update is: IOURequestStepConfirmation, IOURequestStepMerchant etc., but what is this change was about? We still have MoneyRequestConfirmationList component, but we use IOURequestStepConfirmation even not for IOU, but for expense reports etc.

And it means that I need to update now all new components, right @mountiny ?
Because now my changes are just unused and thats why you can't see the validation, and "Request" appear

Copy link
Contributor

🧪🧪 Use the links below to test this adhoc build on Android, iOS, Desktop, and Web. Happy testing! 🧪🧪

Android 🤖 iOS 🍎
https://ad-hoc-expensify-cash.s3.amazonaws.com/android/32486/index.html https://ad-hoc-expensify-cash.s3.amazonaws.com/ios/32486/index.html
Android iOS
Desktop 💻 Web 🕸️
❌ FAILED ❌ https://32486.pr-testing.expensify.com
The QR code can't be generated, because the Desktop build failed Web

👀 View the workflow run that generated this build 👀

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.

Code is looking good to me

@mountiny
Copy link
Contributor

mountiny commented Dec 27, 2023

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

Video included in another comment

Android: Native
Android: mWeb Chrome
iOS: Native
iOS: mWeb Safari
MacOS: Chrome / Safari
MacOS: Desktop

@mountiny
Copy link
Contributor

@koko57 @waterim

Been testing around and noticed two issues:

  • the merchant validation should only happen on submission according to our guidelines. When you are creating the request, the merchant fields should not show as required. the error should pop up only once the form has been submitted and the required merchant field is empty
  • On the split bill screen or in Scan request the merchant field shows up as required, but then it disappears as correctly it should not be there when scanning in workspace as we are running smartscan
Screen.Recording.2023-12-27.at.16.34.28.mp4

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.

Couple notes in comment above

@koko57
Copy link
Contributor

koko57 commented Dec 28, 2023

@mountiny I think I fixed the first issue, will push the changes in a minute. I just wanted to ask - if we fill in the merchant field it should disappear (I mean move to the hidden fields under Show more button)?

Screen.Recording.2023-12-28.at.10.18.56.mp4

It's a current behaviour, I changed it in my commit and now it's visible for workspace request. Let me know if I should restore hiding of this field.

For the second issue - I don't really understand, could you explain what is the expected behavior here? And is it on recording? In which second it starts?

@mountiny
Copy link
Contributor

image

the issue if that the merchant should not even be visible for receipt scan creation. We run smartscan which should fill in the merchant so its not useful to have it in there.

In the video you could see that the merchant was showing in the scan flow which is incorrect

if we fill in the merchant field it should disappear (I mean move to the hidden fields under Show more button)?

It should not disappear, for manual requests for workspaces, the merchant is required so it should be visible at all times

The bug there is that the field is showing as required when you navigate to the page immediately, thats not how we handle required fields, it should start showing as required only once the user click the button to proceed and the merchant is missing/ validation fails

@koko57
Copy link
Contributor

koko57 commented Dec 29, 2023

It should not disappear, for manual requests for workspaces, the merchant is required so it should be visible at all times

@mountiny so in my last commit, I applied this change for this field to be always visible

The bug there is that the field is showing as required when you navigate to the page immediately, thats not how we handle required fields, it should start showing as required only once the user click the button to proceed and the merchant is missing/ validation fails

yes, now it's fixed and validates the field after clicking submit.

Thanks for explaining the issue with the Scan request, I'll take care of it 🙂

@koko57
Copy link
Contributor

koko57 commented Dec 29, 2023

@mountiny for scans - it should be fixed now

Copy link
Contributor

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.

Tested new changes and it works well, thank you very much!

@mountiny mountiny merged commit d4e0db5 into Expensify:main Dec 29, 2023
15 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.

@OSBotify
Copy link
Contributor

🚀 Deployed to staging by https://github.com/mountiny in version: 1.4.20-0 🚀

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

@@ -618,6 +618,7 @@ export default {
genericSmartscanFailureMessage: 'Transaction is missing fields',
atLeastTwoDifferentWaypoints: 'Please enter at least two different addresses',
splitBillMultipleParticipantsErrorMessage: 'Split bill is only allowed between a single workspace or individual users. Please update your selection.',
invalidMerchant: 'Please enter a corrent merchant.',
Copy link
Contributor

Choose a reason for hiding this comment

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

typo - #33781

@OSBotify
Copy link
Contributor

OSBotify commented Jan 2, 2024

🚀 Deployed to production by https://github.com/marcaaron in version: 1.4.20-3 🚀

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

@situchan
Copy link
Contributor

Coming from #33786:
Manual request with scan receipt case was not considered.

@@ -500,7 +503,7 @@ function MoneyRequestConfirmationList(props) {
}

const shouldShowSettlementButton = props.iouType === CONST.IOU.TYPE.SEND;
const shouldDisableButton = selectedParticipants.length === 0;
const shouldDisableButton = selectedParticipants.length === 0 || shouldDisplayMerchantError;
Copy link
Contributor

Choose a reason for hiding this comment

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

Coming from #38130:

Form Submit buttons should not be disabled or blocked from being pressed

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants