feat: PersonalInfo Step by MrMuzyk · Pull Request #30576 · Expensify/App

MrMuzyk · 2023-10-30T12:48:44Z

Details

updated personal info step in VBBA flow
replaced contents of RequestorStep with PersonalInfoStep (temporary solution untill base of the process is refactored)

Fixed Issues

$ #30253
PROPOSAL:

Tests

Enter adding bank account process for the workspace
Get to PersonalInfo step
Verify that no errors appear in the JS console

Offline tests

QA Steps

Enter adding bank account process for the workspace
Get to PersonalInfo step
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 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 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 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

Android: Native

android.native.mov

Android: mWeb Chrome

android.chrome.mov

iOS: Native

Screen.Recording.2023-10-27.at.12.08.32.mov

iOS: mWeb Safari

ios.safari.mov

MacOS: Chrome / Safari

web.mov

MacOS: Desktop

desktop.mov

…ify/App into michal/personal-info-page

…into michal/personal-info-page

https://github.com/gedu/App into michal/personal-info-page

…into michal/personal-info-page

…ify/App into michal/personal-info-page

melvin-bot · 2023-10-30T12:48:49Z

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

src/pages/ReimbursementAccount/PersonalInfo/PersonalInfo.js

src/components/Form/FormWrapper.js

src/languages/es.ts

src/pages/ReimbursementAccount/PersonalInfo/PersonalInfo.js

melvin-bot · 2023-10-31T12:28:35Z

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

MrMuzyk · 2023-10-31T12:31:02Z

@shubham1206agra

Hey, as I've needed changes from this PR #30426 I've pulled it to this branch. You can obviously completely ignore these files. I haven't modified them in any way and they will be gone from diff once Marcin's PR is merged to our feature branch

shubham1206agra · 2023-10-31T12:33:25Z

@MrMuzyk I am also reviewing the linked PR, and I have approved it already.
So I will test this PR accordingly

MrMuzyk · 2023-10-31T13:48:07Z

I've found an issue with method that gets initial step. Pushed a fix for that

shubham1206agra · 2023-11-01T13:44:12Z

@MrMuzyk Can you resolve conflicts?

…ify/App into michal/personal-info-page

MrMuzyk · 2023-11-03T09:56:34Z

On second thought, I'll dig a bit deeper to see if we really can't save the DateOfBirth on the input change

gedu · 2023-11-03T10:54:09Z

@shubham1206agra bumping for review

shubham1206agra · 2023-11-03T10:58:09Z

Screen.Recording.2023-11-03.at.4.26.49.PM.mov

@MrMuzyk Please see this. I think I get it this time

MrMuzyk · 2023-11-03T11:11:42Z

@shubham1206agra
I'm developing next steps and I cant keep switching back and forth. Can we agree on the approach where you do the complete review of the whole PR and point out everything that isn't right and then I will do a round of fixing?

shubham1206agra · 2023-11-03T13:47:31Z

In mWeb, see the name page; the next button is hiding behind the keyboard.
While navigating from the confirm page, I think we should disable the back button.
On the confirm page, maybe navigate to the previous step, i.e., business info on the back button.
We can save data by pressing the next button (I don't know if it's required)
@MrMuzyk Can you see this and comment?

MrMuzyk · 2023-11-03T13:59:39Z

In mWeb, see the name page; the next button is hiding behind the keyboard. While navigating from the confirm page, I think we should disable the back button. On the confirm page, maybe navigate to the previous step, i.e., business info on the back button. We can save data by pressing the next button (I don't know if it's required) @MrMuzyk Can you see this and comment?

Sure, Ill have a look at it. Anything regarding the code itselft?

MrMuzyk · 2023-11-03T14:15:26Z

@shubham1206agra

In mWeb, see the name page; the next button is hiding behind the keyboard.

On any specific substep or all of them?

While navigating from the confirm page, I think we should disable the back button.

Thats not really my decision. I'd have to get a confirmation from designer what to do with ti

On the confirm page, maybe navigate to the previous step, i.e., business info on the back button.

This logic will be reworked in this issue #30235 Each step will get its own route and we will be able to correctly navigate between them. I'll have a look if i can fix it real quick for now but I wouldnt focus too much on it. Its not in final state yet

We can save data by pressing the next button (I don't know if it's required)

Can you please elaborate a bit more on this? Data is persisted between the sub steps in onyx. Final API.write is performed only at Confirm as requested

shubham1206agra · 2023-11-03T14:31:39Z

In mWeb, see the name page; the next button is hiding behind the keyboard.

On any specific substep or all of them?

Only on first substep

While navigating from the confirm page, I think we should disable the back button.

Thats not really my decision. I'd have to get a confirmation from designer what to do with ti

We can tackle this later

On the confirm page, maybe navigate to the previous step, i.e., business info on the back button.

This logic will be reworked in this issue #30235 Each step will get its own route and we will be able to correctly navigate between them. I'll have a look if i can fix it real quick for now but I wouldnt focus too much on it. Its not in final state yet

Ok

We can save data by pressing the next button (I don't know if it's required)

Can you please elaborate a bit more on this? Data is persisted between the sub steps in onyx. Final API.write is performed only at Confirm as requested

#30576 (comment)

@MrMuzyk

MrMuzyk · 2023-11-06T11:57:22Z

@shubham1206agra
Hey, I've pushed a commit with multiple fixes. Please have a look. The button shouldnt be obscured by keyboard anymore and values are now saved correctly as a draft upon every input change. If you drop out of the process and come back to it you will land correctly where you left off. You might want to check the whole process again.

shubham1206agra · 2023-11-06T12:17:51Z

When I change devices, the data gets filled, but it shows empty at the Confirmation step.
Can you check this?

shubham1206agra · 2023-11-06T12:19:39Z

MrMuzyk · 2023-11-06T12:20:31Z

@shubham1206agra
That is correct, I've just noticed this. It was fine when I was going through the step but not when returning. Fixing it as we speak

MrMuzyk · 2023-11-06T12:46:27Z

@shubham1206agra
Should be good now

shubham1206agra · 2023-11-06T13:04:49Z

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(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 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 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.2023-11-03.at.6.45.17.PM.mov

Android: mWeb Chrome

Screen.Recording.2023-11-03.at.5.08.49.PM.mov

iOS: Native

Screen.Recording.2023-11-03.at.5.34.13.PM.mov

iOS: mWeb Safari

Screen.Recording.2023-11-03.at.4.56.33.PM.mov

MacOS: Chrome / Safari

Screen.Recording.2023-11-03.at.4.47.52.PM.mov

MacOS: Desktop

Screen.Recording.2023-11-03.at.5.23.27.PM.mov

…ify/App into michal/personal-info-page

MrMuzyk · 2023-11-07T11:02:30Z

Had to add one more change. I've noticed that user was being prompted incorrect default substep when he already saved data in confirm substep. Adjusted values fed to method that sets initial subteps so it also takes BE values into the account

mountiny · 2023-11-06T15:46:36Z

src/languages/es.ts

        isControllingOfficerError: 'Debe ser un oficial controlador con autorización para operar la cuenta bancaria de la compañía',
    },
+    personalInfoStep: {
+        personalInfo: 'Información Personal',


Did you get these translations verified in Slack?

mountiny

LGTM

mountiny · 2023-11-07T13:48:23Z

src/pages/ReimbursementAccount/PersonalInfo/HelpLinks.js

+    containerStyles: PropTypes.arrayOf(PropTypes.object),
+
+    /** Translate function */
+    translate: PropTypes.func.isRequired,


Any reason we prefer passing the translate function here instead of using the hook here?

MrMuzyk added 9 commits October 25, 2023 11:20

feat: personal info page

d7ef177

feat: substeps

ea52ce1

Merge branch 'vit-tieredBankAccountFlow' of https://github.com/Expens…

31dc2cf

…ify/App into michal/personal-info-page

Merge branch 'marcin/30239-useSubStep-hook' of github.com:Swor71/App …

8ea2e86

…into michal/personal-info-page

Merge branch 'edu/vbba_setup_flow/30237_interactive_sub_step_header' of

5a086ab

https://github.com/gedu/App into michal/personal-info-page

Merge branch 'marcin/30239-useSubStep-hook' of github.com:Swor71/App …

3538899

…into michal/personal-info-page

feat: more of personal info

95c2716

feat: begining of cleanup

cf4c1ec

Merge branch 'vit-tieredBankAccountFlow' of https://github.com/Expens…

75c976c

…ify/App into michal/personal-info-page

Swor71 reviewed Oct 30, 2023

View reviewed changes

src/pages/ReimbursementAccount/PersonalInfo/PersonalInfo.js Show resolved Hide resolved