Refactor the way of displaying errors in several forms

[TMisiukiewicz]

Details

This PR implements displaying multiple error messages in forms where applicable and refactoring the validation conditions in several forms to avoid displaying errors that does not make sense together.

Fixed Issues

$ #15156
PROPOSAL: #15156 (comment)

Tests

1. Navigate to /settings/payments/enable-payments page
2. In Date of Birth input type 31/01/0001
3. Verify that two errors appeared under the input
4. Change year to 2011
5. Verify that only one error is displayed under the input
6. Change year to 2000
7. Verify that no errors are displayed under the input

To do the next tests, change in src/libs/Permissions.js is needed. In line :78 (canUsePolicyRooms function) change it to return true;

1. Open FAB on the left sidebar
2. Click "New room"
3. In Room name type test, and blur from the input
4. Verify error is displayed under the input
5. Focus on input and remove the comma
6. Verify no errors are displayed under the input
7. Save the form and create a room
8. Open room details
9. Enter settings
10. Repeat steps 3-6
11. Save the form and verify name of the room has changed

• Verify that no errors appear in the JS console

Offline tests

n/a

QA Steps

1. Navigate to /settings/payments/enable-payments page
2. In Date of Birth input type 31/01/0001
3. Verify that two errors appeared under the input
4. Change year to 2011
5. Verify that only one error is displayed under the input
6. Change year to 2000
7. Verify that no errors are displayed under the input

To do the next tests, change in src/libs/Permissions.js is needed. In line :78 (canUsePolicyRooms function) change it to return true;

1. Open FAB on the left sidebar
2. Click "New room"
3. In Room name type test, and blur from the input
4. Verify error is displayed under the input
5. Focus on input and remove the comma
6. Verify no errors are displayed under the input
7. Save the form and create a room
8. Open room details
9. Enter settings
10. Repeat steps 3-6
11. Save the form and verify name of the room has changed

• 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 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 correct English and 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
  • 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 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

WEB.mov

Mobile Web - Chrome

ANDROID.WEB.mov

Mobile Web - Safari

iOS.WEB.mov

Desktop

DESKTOP.mov

iOS

iOS.mov

Android

ANDROID.mov

[TMisiukiewicz]

good point noticed by @ArekChr that since we operate on an object reference, we don't need to reassign the returned value to errors again. Updated it also in the previously merged DisplayNamePage

[ArekChr]

LGTM 👌

[MelvinBot]

@neil-marcellini @mollfpr One of you needs to 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]

[neil-marcellini]

Looking pretty good but there are a couple small details that we should change.

Nitpick: Technically, this person is way over 18 years old, 😂 so let's show one error message which is "Please enter a valid date of birth".

[github-actions]

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

[koko57]

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

[koko57]

I followed your suggestion on reverting to two separate errors for restricted and existing room names and changed the roomNameReservedError message a little bit - I didn’t use the same pattern as in name’s containsReservedWord error message, because here we are checking for the exact #admins and #announce names and we are able to create a name including both words like e.g. #ck-admins. (Or maybe we should change the validation here?) If it doesn’t sound ok or you have an idea for a different message, please let me know, I’ll change it.

[neil-marcellini]

Thanks, looks pretty good. From what I read in Slack I think from we want an error message for each default room name. We can use a translation function like this to achieve that.

App/src/languages/en.js

Line 64 in bb8dff1

addressLine: ({lineNumber}) => `Address line ${lineNumber}`,

#admins is a default room on all workspaces. Please choose another name.
#announce is a default room on all workspaces. Please choose another name.

[neil-marcellini]

Looks good. We need to update the copy and I think there's also still the birth date issue. After that it's good to go!

[koko57]

So as we discussed in this thread: https://expensify.slack.com/archives/C01GTK53T8Q/p1679309038849709 I've changed the roomNameReservedError to the message suggested by Neil.

for now it looks like this and works for creating new room and updating the existing one.

[koko57]

@neil-marcellini Regarding the issue with date - should it be handled like here: on the personal details date of birth page?

[neil-marcellini]

@neil-marcellini Regarding the issue with date - should it be handled like here: on the personal details date of birth page?

Yes, except the date format in the error message doesn't match, so we should fix that! There's so many little problems with these error messages.

[koko57]

@neil-marcellini I've fixed the issue with displaying two error messages. I've also noticed that we have a new date picker implemented by Arek on DOB page (PR) which has an yyyy-mm-dd format for all the platforms. The old date picker which is still used in some forms has a proper yyyy-mm-dd format for iOS and Android, for the web it has dd/mm/yyyy format. So maybe we could use the old error messages (like on the screenshots) for now for the old date pickers until they are changed for the new one? We also have a different minimal age requirement for the DOB in personal details (5) and the rest of the DOB pickers (18). Please let me know if we can leave it for now as it is or we should think of another solution.

[neil-marcellini]

@koko57 Ah ok, thanks for the research an explanation. That sounds good to me.

[neil-marcellini]

Please update the QA steps for the room name to ask the user to sign into an expensifail.com account, since those accounts are on the defaultRooms beta and we can't modify the code during QA.

Other than that it tests well and the code looks great. Thanks!

[neil-marcellini]

@mollfpr please review complete the checklist when you have time.

[mollfpr]

@neil-marcellini On it, thanks for the ping!

[mollfpr]

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

Screenshots/Videos

Web

15978.Web.-.Enable.payment.mov

15978.Web.-.Display.name.mov

15978.Web.-.Room.mov

Mobile Web - Chrome

15978.mWeb-Chrome.-.Room.mp4

15978.mWeb-Chrome.-.Display.name.mp4

15978.mWeb-Chrome.-.Enable.payment.mp4

Mobile Web - Safari

15978.mWeb-Safari.-.Room.mp4

15978.mWeb-Safari.-.Display.name.mp4

15978.mWeb-Safari.-.Enable.payment.mp4

Desktop

15978.Desktop.-.Room.mp4

15978.Desktop.-.Display.name.mp4

15978.Desktop.-.Enable.payment.mp4

iOS

15978.iOS.-.Room.mp4

15978.iOS.-.Display.name.mp4

15978.iOS.-.Enable.payment.mp4

Android

15978.Android.-.Display.name.mp4

15978.Android.-.Room.mp4

15978.Android.-.Enable.payment.mp4

[mollfpr]

Good work on this PR @koko57 👍

We just need to add the test for the display name form to the test step and we are good to go 🚀

[neil-marcellini]

We didn't really change much in relation to the display name page so I'm going to go ahead and merge this. Thanks everyone!

[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/neil-marcellini in version: 1.2.89-0 🚀

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

[OSBotify]

🚀 Deployed to production by https://github.com/luacmartins in version: 1.2.89-0 🚀

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