[Refactor] Form validation translated error

[fedirjh]

cc @luacmartins

Details

This pr is a follow-up to the previous changes made in PR #19324 and PR #20093. While those PRs introduced initial updates to improve error handling by implementing key-based error storage, it was identified that there are still remaining form validation methods that require updates to align with the new mechanism.

The purpose of this follow-up PR is to comprehensively cover all form validation methods and ensure they return the error key rather than the translated string. By doing so, we aim to achieve consistent and streamlined error handling across the entire application, eliminating any remnants of the old translation-based approach.

Fixed Issues

$ #20472
#20093
#20093 (comment)

Tests

Test 1 : Workspace Room Name

1. Open create new workspace room name form
2. Test that all error messages are displayed correctly, we have 4 errors:
   • Reserved room name : e.g admins
   • Invalid room name : e.g TestName . Room names can only include lowercase letters, numbers and hyphens
   • Empty room name
   • Used room name: enter an existing room name
3. Select an existing room
4. Click edit room
5. Test that all error messages are displayed correctly similar to step 2

Test 2 : Task Title

1. Open create new Task form
2. Leave task title empty and verify that error message is displayed Please enter a title
3. Create new task and navigate to it
4. Click edit task title
5. Enter empty task title and verify that error message is displayed Please enter a title

Test 3 : Personal Details

1. Open Settings -> Profile -> Display Name
2. Enter invalid name and verify the errors are displayed , we have 2 error
   • Name cannot contain a comma or semicolon
   • First name cannot contain the words Expensify or Concierge
   • Enter this name Concierge;, and verify both errors are displayed
3. Open Settings -> Profile -> Personal details -> Legal Name
4. Enter invalid name and verify the errors are displayed , we have 2 error
   • This field is required.
   • Name cannot contain a comma or semicolon
5. Open Settings -> Profile -> Personal details -> Date of birth
6. Leave it empty an press save. Verify that empty error message is displayed
7. Open Settings -> Profile -> Personal details -> Home address
8. Leave all inputs empty.
9. Verify that every input has an error message

Test 4 : Secondary Contact

1. Open Settings -> Profile -> Contact methods -> New Contact Method
2. Verify that error message are displayed for every invalid case , we have 3 errors:
   • The Entered Contact Method already exists. -> used contact
   • Contact method is required. -> empty contact
   • Invalid contact method. -> invalid contact

Test 5 : Security

1. Open Settings -> Security -> Change password
2. Leave inputs empty and press save
3. Verify that error are displayed
4. Open Settings -> Security -> Close Account
5. Leave inputs empty and press close account
6. Verify that error are displayed

Test 6 : Debit Card

1. Open Settings -> Payments -> Add debit card
2. Leave all fields empty and press save
3. Verify that all errors are displayed

Test 7 : Workspace

1. Open Settings -> workspaces -> Select workspace -> settings
2. Leave name as empty and press save
3. Verify an error message is displayed You need to define a name for your workspace.
4. Navigate to Reimbursements -> Track distance
5. Enter an invalid Rate
6. Verify Verify an error message is displayed Please enter a valid rate

Test 8 : Manual Bank Account

1. Open Settings -> workspaces -> Select workspace -> Bank Account -> Add Manual Bank
2. Enter invalid routing and account number and press Continue
3. Verify Error messages are displayed properly
4. Enter valid information and press continue to reach Company information step
5. Leave all fields empty and press continue
6. Verify Error messages are displayed properly for every form field
7. Enter valid information and press continue to reach Personal information step
8. Leave all fields empty and press continue
9. Verify Error messages are displayed properly for every form field

• Verify that no errors appear in the JS console

Offline tests

QA Steps

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

Mobile Web - Chrome

Mobile Web - Safari

Desktop

iOS

Android

[luacmartins]

@fedirjh let me know when this is ready for review

[fedirjh]

Web Tests

Test 1 : Workspace Room Name

Test 2 : Task Title

Test 3 : Profile Details

Test 4 : Secondary Contact

Test 5 : Security

Test 6 : Debit Card

Test 7 : Workspace

Test 8 : Bank Account

---

IOS Tests

Test 1 : Workspace Room Name

Test 2 : Task Title

Test 3 : Profile Details

Test 4 : Secondary Contact

Test 5 : Security

Test 6 : Debit Card

Test 7 : Workspace

Test 8 : Bank Account

---

mWeb Safari Tests

Test 1 : Workspace Room Name

Test 2 : Task Title

Test 3 : Profile Details

Test 4 : Secondary Contact

Test 5 : Security

Test 6 : Debit Card

Test 7 : Workspace

Test 8 : Bank Account

---

Android Tests

Test 1 : Workspace Room Name

Test 2 : Task Title

Test 3 : Profile Details

Test 4 : Secondary Contact

Test 5 : Security

Test 6 : Debit Card

Test 7 : Workspace

Test 8 : Bank Account

---

mWeb Chrome Tests

Test 1 : Workspace Room Name

Test 2 : Task Title

Test 3 : Profile Details

Test 4 : Secondary Contact

Test 5 : Security

Test 6 : Debit Card

Test 7 : Workspace

Test 8 : Bank Account

---

Desktop Tests

Test 1 : Workspace Room Name

Test 2 : Task Title

Test 3 : Profile Details

Test 4 : Secondary Contact

Test 5 : Security

Test 6 : Debit Card

Test 7 : Workspace

Test 8 : Bank Account

[fedirjh]

As you see video, translate is done 2 times. So 2nd time, already translated message is passed as key, throw error and return key (translated message) as fallback.

Translate is done twice only for concatenated errors (multiline errors) generated by ErrorUtils.addErrorMessage. I pushed a fix for that.

[0xmiroslav]

One minor thing:

• Typo in Test1:

Reserved room name : e.g admin > admins

[0xmiroslav]

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

Personal Details

web-3.mov

Mobile Web - Chrome

Manual Bank Account

mchrome-8.mov

mchrome-8.2.mov

Mobile Web - Safari

Task Title

msafari-2.mov

Desktop

Secondary Contact, Security, Debit Card

desktop4-6.mov

iOS

Workspace Room Name

ios-1.mov

ios-1.2.mov

Android

Workspace

android-7.mov

[0xmiroslav]

Tested all possible cases.
@luacmartins all yours!

[0xmiroslav]

Oops! I thought you applied my suggestion

[luacmartins]

LGTM. @fedirjh we have conflicts

[luacmartins]

LGTM! @stitesExpensify all yours

[luacmartins]

Gonna merge to avoid more conflicts since we are touching 34 files.

[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/luacmartins in version: 1.3.28-0 🚀

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

[OSBotify]

🚀 Deployed to production by https://github.com/AndrewGable in version: 1.3.28-5 🚀

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