[TS Migration] Improve Form #35584

blazejkustra · 2024-02-01T17:48:25Z

Details

Fixed ✅ onPress is defined to receive a single GestureResponderEvent argument, but in reality it can receive different treatment depending on the input that it's used with
Fixed ✅ Currently, the object returned by validate is just a Record<string, string>, but we know that the return type should be a map of formInputID: translationKey
Done ✅ Use constants for a form inputIDs
Fixed ✅ FormValueType is defined loosely as string | boolean | Date, but I'd think that the value type would depend on which form is being referenced.
Done ✅ NAB improvement that would be nice to see is if we could eliminate the need to define every form key and type twice

Fixed Issues

$ #35318
PROPOSAL: #32992 (comment)

Tests

Test the app throughly, ideally all Forms.
Manually check inputs defined in src/components/Form/inputs/, and compare it with what was used in InputWrappers before

Workspace new room:

Log in
Press + button > Press Start chat > Switch to # Room
Check if errors appears when incorrect data is typed in
Check if when spaces are replaced with -
Type correct data and create a new room

Room name:

Log in
If there are no rooms, create a new one (steps above)
In the chat room press its name > Press Settings > Press Room name
Check if the room name is propagated
Check if errors appears when incorrect data is typed in
Check if when spaces are replaced with -
Type correct data and update the name of the room

Edit room name without change:

Go to home screen
Go to + > Start chat > Room.
Create a room with a valid name.
Go to the room > Click header > Settings.
Click Room name.
Click Save without any edit.

Waypoint editor

After logging in press + button > Request money
Open Distance tab
Press start
On next screen start typing the address
Press Save
You should be navigated back and the address should be saved.

ValidationStep

Ensure you're connected with staging server
Go to workspace > Add Bank Account
Click Connect Manually, Routing Number: 011401533, Account number: 1111222233331111 > Continue
I next step fill out Legal Business Name: Alberta Bobbeth Charleson, Tax ID number: 123456789 (any nine digits), addres must be US based and valid, any date > Save & Continue
In next step First name: Alberta, Last name: Charleson, Toggle confirmation you are authorized to use company bank > Save & Continue
In Beneficial Owners Toggle terms and conditions, Toggle confirmation that the information provided is true and accurate
Query our DB, to get validation amounts and enter it in fields.

AddDebitCardPage:

Log in
Press on your profile picture to open Settings > Wallet
If wallet is empty press Add payment method
Fill form with correct data
Save the card data

Full list of forms with detailed test steps in PRs

https://github.com//issues/28878 https://github.com//issues/28879 https://github.com//issues/28877 https://github.com//issues/28876 https://github.com//issues/28875 https://github.com//issues/28874 https://github.com//issues/28873 https://github.com//issues/28872 https://github.com//issues/28871 https://github.com//issues/28870 https://github.com//issues/29997 https://github.com//issues/29998 https://github.com//issues/30000 https://github.com//issues/30002 https://github.com//issues/30003 https://github.com//issues/30004 https://github.com//issues/30006 https://github.com//issues/30008 https://github.com//issues/31559 https://github.com//issues/31562 https://github.com//issues/31566 https://github.com//issues/31565 https://github.com//issues/31612 https://github.com//issues/33356 https://github.com//issues/30305 https://github.com//issues/30306 https://github.com//issues/30307 https://github.com//issues/30308 https://github.com//issues/30310 https://github.com//issues/30311 https://github.com//issues/30312 https://github.com//issues/30314 https://github.com//issues/30316 https://github.com//issues/31561 https://github.com//issues/31563 https://github.com//issues/31564 https://github.com//issues/31560 https://github.com//issues/32064

Offline tests

N/A

QA Steps

Same as tests

PR Author Checklist

Screenshots/Videos

Android: Native

android.webm

Android: mWeb Chrome

android-web.webm

iOS: Native

ios.mp4

iOS: mWeb Safari

ios-web.mp4

MacOS: Chrome / Safari

web.mov

MacOS: Desktop

desktop.mov

melvin-bot · 2024-02-01T17:48:30Z

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

fabioh8010 · 2024-02-02T08:50:46Z

Hey @blazejkustra Could you take a look a this PR too?

blazejkustra · 2024-02-02T10:20:18Z

@fabioh8010 I discussed it with @barttom on slack and he prepared another PR on top of it 👍

…exist

src/ONYXKEYS.ts

src/components/Form/types.ts

src/components/KYCWall/BaseKYCWall.tsx

src/components/createOnyxContext.tsx

src/types/modules/react-native-onyx.d.ts

src/types/onyx/Form.ts

udiff] external = difft

blazejkustra · 2024-02-12T07:38:20Z

@abdulrahuman5196 Can you please prioritize this issue? It gets a lot of conflicts and type errors with changes on main, if you have any questions. I'm here to assist you 😄

abdulrahuman5196 · 2024-02-12T07:39:37Z

Hi, @blazejkustra Sorry, Didn't see the last comment. Will re-review now

abdulrahuman5196 · 2024-02-12T07:45:03Z

@blazejkustra I did check on high level and have no further comments.

But given the PRs size and test range, I would need probability today and tomorrow(hopefully today alone) to check if anything is causing issues. Will on the same.

abdulrahuman5196 · 2024-02-12T07:45:16Z

Could you kindly fix the lint code meanwhile

blazejkustra · 2024-02-12T08:04:44Z

@abdulrahuman5196 Prettier fixed ✅ Thanks for a quick response!

abdulrahuman5196 · 2024-02-13T12:14:14Z

FYI: Working on this. Will close out sooner. Meanwhile kindly check on conflicts and lint arised(I assume this PR might be prune to more if we leave it out).

blazejkustra · 2024-02-13T18:04:56Z

@abdulrahuman5196 I just merged the newest main and adjusted the code after bank refactor 😮‍💨

abdulrahuman5196 · 2024-02-13T18:19:08Z

@blazejkustra I just completed testing all the flows mentioned. Came here to comment the checklist.

Seems now I have to test the new bank change as well. 😞

abdulrahuman5196 · 2024-02-13T20:44:47Z

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

Android: Native

Screen.Recording.2024-02-13.at.11.09.03.PM.mp4

Screen.Recording.2024-02-14.at.1.48.37.AM.mp4

Screen.Recording.2024-02-14.at.1.56.17.AM.mp4

Android: mWeb Chrome

Screen.Recording.2024-02-13.at.11.18.34.PM.mp4

Screen.Recording.2024-02-14.at.1.58.35.AM.mp4

Screen.Recording.2024-02-14.at.2.02.00.AM.mp4

iOS: Native

Screen.Recording.2024-02-13.at.10.59.30.PM.mp4

Screen.Recording.2024-02-14.at.1.32.07.AM.mp4

Screen.Recording.2024-02-14.at.1.36.47.AM.mp4

iOS: mWeb Safari

Screen.Recording.2024-02-13.at.11.30.16.PM.mp4

Screen.Recording.2024-02-14.at.1.40.52.AM.mp4

Screen.Recording.2024-02-14.at.1.44.32.AM.mp4

MacOS: Chrome / Safari

Screen.Recording.2024-02-13.at.9.45.54.PM.mp4

Screen.Recording.2024-02-14.at.1.12.15.AM.mp4

Screen.Recording.2024-02-14.at.1.16.14.AM.mp4

MacOS: Desktop

Screen.Recording.2024-02-13.at.10.43.04.PM.mp4

Screen.Recording.2024-02-14.at.1.19.41.AM.mp4

Screen.Recording.2024-02-14.at.1.28.49.AM.mp4

abdulrahuman5196

Changes looks good and works well. Reviewers checklist is also complete.

All yours. @roryabraham

🎀 👀 🎀
C+ Reviewed

roryabraham · 2024-02-13T21:05:55Z

src/libs/actions/BankAccounts.ts

@@ -427,7 +427,7 @@ function connectBankAccountManually(bankAccountID: number, accountNumber?: strin
 /**
 * Verify the user's identity via Onfido
 */
-function verifyIdentityForBankAccount(bankAccountID: number, onfidoData: OnfidoData) {
+function verifyIdentityForBankAccount(bankAccountID: number, onfidoData: Record<string, unknown>) {


NABish but this seems sus – why are we using Record<string, unknown> here?

Let's do it but in a different PR, here the type for onfidoData is added

roryabraham · 2024-02-13T21:18:29Z

src/types/form/AddDebitCardForm.ts

+ ACCEPT_TERMS: 'acceptTerms',
+} as const;
+
+type AddDebitCardForm = Form<{


NAB / can be done in a follow-up, but there's nothing here to guarantee that the keys of the form type for a given form match the INPUT_IDS for that form. I can add keys and remove them and there's no errors.

roryabraham · 2024-02-13T21:20:00Z

Going to merge this to avoid conflicts. Would love to see follow-ups for the couple concerns listed in my last review

OSBotify · 2024-02-13T21:24:34Z

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

roryabraham · 2024-02-14T01:10:58Z

src/ONYXKEYS.ts

+ [ONYXKEYS.FORMS.NEW_ROOM_FORM]: FormTypes.NewRoomForm;
+ [ONYXKEYS.FORMS.ROOM_SETTINGS_FORM]: FormTypes.Form;
+ [ONYXKEYS.FORMS.NEW_TASK_FORM]: FormTypes.Form;
+ [ONYXKEYS.FORMS.EDIT_TASK_FORM]: FormTypes.Form;


Sorry for not seeing this earlier, but why are there all these types that are just FormTypes.Form, even though we have more specific types for these forms, such as the one defined in src/types/form/EditTaskForm ?

I think it was adjusted at some point and I made a mistake while resolving conflicts. I'll fix it in a follow up 👍

OSBotify · 2024-02-15T05:36:16Z

🚀 Deployed to staging by https://github.com/roryabraham in version: 1.4.42-0 🚀

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

kavimuru · 2024-02-15T11:33:30Z

@blazejkustra @abdulrahuman5196 can we ignore "Full list of forms with detailed test steps"?

blazejkustra · 2024-02-15T12:09:20Z

I think you can test just some of forms, that should be enough

OSBotify · 2024-02-19T23:34:24Z

🚀 Deployed to production by https://github.com/chiragsalian in version: 1.4.42-5 🚀

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

blazejkustra added 7 commits February 1, 2024 18:41

Use more accurate type for ONYXKEYS.FORMS.PERSONAL_BANK_ACCOUNT form

4f109b2

Clean form onyx values

5a9b7fa

Move InputWrapperProps to InputWrapper file

1865489

Add more generic types to FormWrapper

ea73d4f

Move RegisterInput to FormContext file

8a06c0a

Improve Form types, rename utility types

ede25e5

Fix type errors in validation functions

35356da

blazejkustra changed the title ~~[TS Migration] Improve form validation return type~~ [TS Migration] Improve Form Feb 1, 2024

blazejkustra added 5 commits February 2, 2024 15:19

Merge branch 'main' into ts/improve-form

c5e9982

Clean ONYXKEYS

fbadba9

Remove OnyxFormKeyWithoutDraft, now OnyxFormKey and OnyxFormDraftKey …

6e2bf36

…exist

Use OnyxKey instead of OnyxKeys

e4caa67

Add ts-expect-error to all reimburesementAccount usage

06ee35e