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

feat: Step 3 UI #51667

Merged
merged 30 commits into from
Nov 7, 2024
Merged

feat: Step 3 UI #51667

merged 30 commits into from
Nov 7, 2024

Conversation

MrMuzyk
Copy link
Contributor

@MrMuzyk MrMuzyk commented Oct 29, 2024

Details

This PR introduces UI for step 3 in global reimbursements flow.

Fixed Issues

$ #50899
PROPOSAL:

Tests

Same as QA steps

  • Verify that no errors appear in the JS console

Offline tests

QA Steps

  • Have debug mode enabled
  • Go to workspace with currency set to CAD, EUR, GBP or AUD
  • Connect Bank Account
  • Go to step 3
  • UI gathering all required data for this step should be visible
  • Verify that no errors appear in the JS console

Note:
AddressFormFields component was updated. While everything should remain exactly the same following places were affected by this:

  • Address Form in EnablePayments
  • Address Form in BusinessInfo sub step in Reimbursements for USD accounts
  • Address Form in PersonalInfo sub step in Reimbursements for USD accounts
  • Address Form in BeneficialOwnerInfo sub step in Reimbursements for USD accounts

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
steo3-android-native.mp4
Android: mWeb Chrome
step3-android-chrome.mp4
iOS: Native
step3-ios-native.mp4
iOS: mWeb Safari
step3-ios-safari.mp4
MacOS: Chrome / Safari
step3-web.mp4
MacOS: Desktop
step3-desktop.mp4

Copy link

melvin-bot bot commented Oct 29, 2024

Hey! I see that you made changes to our Form component. Make sure to update the docs in FORMS.md accordingly. Cheers!

src/languages/es.ts Outdated Show resolved Hide resolved
@MrMuzyk MrMuzyk marked this pull request as ready for review October 31, 2024 13:03
@MrMuzyk MrMuzyk requested a review from a team as a code owner October 31, 2024 13:03
@melvin-bot melvin-bot bot requested review from hungvu193 and removed request for a team October 31, 2024 13:03
Copy link

melvin-bot bot commented Oct 31, 2024

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

@hungvu193
Copy link
Contributor

I'll review this weekend!

@hungvu193
Copy link
Contributor

I think we missed some regexes for zipcode:

zipcode.mov

Here's the old regex for zipcode:

if (countrySpecificZipRegex) {
if (!countrySpecificZipRegex.test(values.zipPostCode?.trim().toUpperCase())) {
if (ValidationUtils.isRequiredFulfilled(values.zipPostCode?.trim())) {
errors.zipPostCode = translate('privatePersonalDetails.error.incorrectZipFormat', {zipFormat: countryZipFormat});
} else {
errors.zipPostCode = translate('common.error.fieldRequired');
}
}
} else if (!CONST.GENERIC_ZIP_CODE_REGEX.test(values?.zipPostCode?.trim()?.toUpperCase() ?? '')) {
errors.zipPostCode = translate('privatePersonalDetails.error.incorrectZipFormat');
}

@hungvu193
Copy link
Contributor

Also please add the validation for invalid phone number:

Screen.Recording.2024-11-04.at.13.19.56.mov

@hungvu193
Copy link
Contributor

If we choose other country that don't have state option visible, we should also remove the validation for it:

Screen.Recording.2024-11-04.at.13.24.51.mov

@MrMuzyk
Copy link
Contributor Author

MrMuzyk commented Nov 4, 2024

I think we missed some regexes for zipcode:

This seems to me like a regex for US zipcodes only (I've tried to enter mine which is Polish and it wasn't passing). I'll try to find a universal one.

@MrMuzyk
Copy link
Contributor Author

MrMuzyk commented Nov 4, 2024

@hungvu193 I've fixed all of the comments and got approval on translations. Everything should work correctly now. Validation for zipCode is rather loose because of how diverse these codes can be.

I might have to look into typings in FormProvider in the new method I've added but Im not 100% sure.

@hungvu193
Copy link
Contributor

I got this crashed while entering VBBA flow, I don't think it comes from our PR, so can you please merge main again? ty

Screen.Recording.2024-11-05.at.09.23.26.mov

@hungvu193
Copy link
Contributor

Here's the offending PR btw, looks like it's still in progress (#51981)

@MrMuzyk
Copy link
Contributor Author

MrMuzyk commented Nov 5, 2024

@hungvu193 I've applied the fix from the offending PR in here so you can finish review process

@hungvu193
Copy link
Contributor

Thanks I'll continue the testing 👍

@hungvu193
Copy link
Contributor

hungvu193 commented Nov 5, 2024

If we choose other country that don't have state option visible, we should also remove the validation for it:

@MrMuzyk Now, we have another bug, State field sometimes appears with non-us country.
Sometimes, State field won't appear with US country.

Screen.Recording.2024-11-05.at.16.41.01.mov

@MrMuzyk
Copy link
Contributor Author

MrMuzyk commented Nov 5, 2024

@MrMuzyk Now, we have another bug, State field sometimes appears with non-us country.
Sometimes, State field won't appear with US country.

It's probably caused by the fact that when user comes back to any of the sub steps from the confirmation screen we don't want to save anything he changed unless he confirms it. Condition to display state field probably is based on draft value. Looking for a fix now

@MrMuzyk
Copy link
Contributor Author

MrMuzyk commented Nov 5, 2024

@hungvu193 I've fixed known issues and found and fixed a few more edge cases when it came to autocomplete and editing from confirmation screen. You can check again

@hungvu193
Copy link
Contributor

Thank you. I'll check again in a while 💯

@hungvu193
Copy link
Contributor

I still can reproduce the issue, here are the steps:

  1. Go to Address page.
  2. Choose US, press Submit without filling in the state.
  3. Choose the state.
  4. Choose another country.
Screen.Recording.2024-11-05.at.22.19.29.mov

@MrMuzyk
Copy link
Contributor Author

MrMuzyk commented Nov 6, 2024

@hungvu193 Fixed that issue and rebased with latest main

Copy link
Contributor

@hungvu193 hungvu193 left a comment

Choose a reason for hiding this comment

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

All good so far! One comment left.

src/libs/ValidationUtils.ts Outdated Show resolved Hide resolved
@hungvu193
Copy link
Contributor

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 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 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 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.
  • I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

Screenshots/Videos

Android: Native
Screen.Recording.2024-11-06.at.18.24.29.mov
Android: mWeb Chrome
Screen.Recording.2024-11-06.at.18.14.47.mov
iOS: Native
ios.mov
iOS: mWeb Safari
mSfari.mov
MacOS: Chrome / Safari
Screen.Recording.2024-11-06.at.18.02.34.mov
MacOS: Desktop
Desktop.mov

Copy link
Contributor

@hungvu193 hungvu193 left a comment

Choose a reason for hiding this comment

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

Tests well!

@melvin-bot melvin-bot bot requested a review from madmax330 November 6, 2024 11:27
@madmax330 madmax330 merged commit 2ef91b8 into Expensify:main Nov 7, 2024
19 of 21 checks passed
@OSBotify
Copy link
Contributor

OSBotify commented Nov 7, 2024

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

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.

4 participants