[TS migration] Migrate 'Form' component to TypeScript #32992

blazejkustra · 2023-12-13T18:13:35Z

Details

Migration of Form to Typescript.

Fixed Issues

$ #31972
PROPOSAL: N/A

Tests

Test different kinds of forms.

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 · 2023-12-13T18:13:40Z

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

[diff] external = difft

src/components/FloatingActionButton/index.js

src/components/Form/FormProvider.tsx

src/components/Form/types.ts

src/pages/home/sidebar/SidebarScreen/FloatingActionButtonAndPopover.js

src/components/Form/FormWrapper.tsx

# Conflicts: # src/pages/settings/Wallet/WalletPage/WalletPage.js

src/components/Form/FormProvider.tsx

src/components/Form/types.ts

src/libs/ValidationUtils.ts

src/pages/settings/Wallet/WalletPage/WalletPage.js

kowczarz · 2024-01-04T15:59:18Z

FYI: #33960 can cause some conflicts, but I think, they will be easy to resolve

blazejkustra · 2024-01-24T17:21:04Z

@kbecciv @allroundexperts Should be fixed now, thanks for reporting

mountiny · 2024-01-24T17:28:25Z

https://github.com/Expensify/App/actions/runs/7643946994

github-actions · 2024-01-24T17:38:52Z

🧪🧪 Use the links below to test this adhoc build on Android, iOS, Desktop, and Web. Happy testing! 🧪🧪

Android 🤖	iOS 🍎
❌ FAILED ❌	❌ FAILED ❌
The QR code can't be generated, because the android build failed	The QR code can't be generated, because the iOS build failed
Desktop 💻	Web 🕸️
https://ad-hoc-expensify-cash.s3.amazonaws.com/desktop/32992/NewExpensify.dmg	https://32992.pr-testing.expensify.com

👀 View the workflow run that generated this build 👀

allroundexperts · 2024-01-25T00:16:13Z

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-01-25.at.5.27.06.AM.mov

Android: mWeb Chrome

Screen.Recording.2024-01-25.at.5.26.02.AM.mov

iOS: Native

Screen.Recording.2024-01-25.at.5.24.31.AM.mov

iOS: mWeb Safari

Screen.Recording.2024-01-25.at.5.22.37.AM.mov

MacOS: Chrome / Safari

screen-recording-2024-01-25-at-51331-am_OD80Ca13.mp4

MacOS: Desktop

Screen.Recording.2024-01-25.at.5.20.18.AM.mov

allroundexperts

This is looking pretty good to me. The drafts are working fine along with the error handling.

melvin-bot · 2024-01-25T00:31:02Z

We did not find an internal engineer to review this PR, trying to assign a random engineer to #31972 as well as to this PR... Please reach out for help on Slack if no one gets assigned!

dangrous

Okay! I think this makes sense, and it looks like it tests well. I'm going to go ahead and merge and we can monitor to see how it goes.

Looks like there are some follow up pieces noted in the discussions too, so we should just make sure those happen when they can!

OSBotify · 2024-01-25T15:18:25Z

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

allroundexperts · 2024-01-25T20:41:25Z

@mountiny Since this was a pretty big PR, (I spent quite some time on it), Is it possible to raise the review compensation to $500? Thanks!

mountiny · 2024-01-26T14:51:14Z

I think thats valid

roryabraham

Thanks for working on this PR. Some feedback I'd like to see addressed in a follow-up PR, if possible.

The Errors type used by FormProvider is just a Record<string, string>. Server errors can prettymuch be any string mapped to any string, but client errors (like the ones returned by the function passed to FormProvider's validate prop), should be an object where the keys are strictly one of the inputID values for one of the child InputWrapper components, and the values should strictly be a localized string.

I encountered this because I used a constant for my form's inputIDs:

<FormProvider
    ...
    validate={() => {
        if (reason) {
            return {};
        }
        return {
            // TS error here, because {"reason": string} is not assignable to Record<string, string>
            [CONST.EXIT_SURVEY.REASON_INPUT_ID]: translate('common.error.fieldRequired');
        };
    }}
>
    <InputWrapper
        InputComponent={RadioButtons}
        inputID={CONST.EXIT_SURVEY.REASON_INPUT_ID}
        ...
    />
</FormProvider

I can fix this with some type widening:

        return {
            // TS error here, because {"reason": string} is not assignable to Record<string, string>
-             [CONST.EXIT_SURVEY.REASON_INPUT_ID]: translate('common.error.fieldRequired');
+             [CONST.EXIT_SURVEY.REASON_INPUT_ID as string]: translate('common.error.fieldRequired'); 
        };

But we're kind of missing an opportunity here to capture the fact that we know what keys are valid in the object to be returned from validate. I think we can / should standardize on using constants for form inputIDs. @blazejkustra What do you think?

blazejkustra · 2024-01-29T09:30:53Z

client errors (like the ones returned by the function passed to FormProvider's validate prop), should be an object where the keys are strictly one of the inputID values for one of the child InputWrapper components,

That should be a quick fix! @roryabraham can you create a ticket for that?

/** Callback to validate the form */
validate?: (values: OnyxFormValuesFields<TFormID>) => Errors;

// after
validate?: (values: OnyxFormValuesFields<TFormID>) => Record<keyof OnyxFormValuesFields<TFormID>, TranslationPaths>;

and the values should strictly be a localized string.

Shouldn't it be a translation path instead of a localized string?

{
  [CONST.EXIT_SURVEY.REASON_INPUT_ID]: 'common.error.fieldRequired'; // not `translate('common.error.fieldRequired');`
};

I think we can / should standardize on using constants for form inputIDs. @blazejkustra What do you think?

I love standardization and constants, so I'm all for it 😆 @roryabraham can you create a ticket for that too? I think we should be able to do it in one PR (there are 116 results in 52 files for inputID=).

roryabraham · 2024-01-29T15:31:54Z

Shouldn't it be a translation path instead of a localized string?

Looks like you are right. I was using a translated string, but I think that I was doing it wrong. All the more reason these changes will be good 😉

roryabraham · 2024-01-29T15:38:14Z

@blazejkustra I created #35318, can you comment for assignment plz?

OSBotify · 2024-01-29T19:23:33Z

🚀 Deployed to staging by https://github.com/dangrous in version: 1.4.33-0 🚀

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

pac-guerreiro · 2024-01-29T22:31:38Z

@blazejkustra
Great work you did here pal! I'd like to share some thought about the new changes:

ValidInputs - every time we add a new or remove an old input component we'll need to update this type, otherwise the code will break. It would be great if we could define a set of rules that every input must follow to be accepted by InputWrapper, thus reducing the need to maintain more code 😄
BaseInputProps - onValueChange assumes that it's argument is unknown, which causes type mismatch errors that can only be resolved by type casting like (value) => handler(value as MyType). It would be great if we could infer this type from either the value, defaultValue or the argument of onInputChange prop from the wrapped component 😄

OSBotify · 2024-01-31T02:30:24Z

🚀 Deployed to production by https://github.com/francoisl in version: 1.4.33-5 🚀

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

Start migrating new form

4eeca48

This was referenced Dec 13, 2023

[HOLD for payment 2024-02-07] [$250] [TS migration] Migrate 'Form' component to TypeScript #31972

Closed

[TS migration] Migrate 'FormAlertWrapper.js' component to TypeScript #32798

Merged

blazejkustra added 3 commits December 14, 2023 14:49

Merge branch 'main' into ts/NewForm

8359837

[diff] external = difft

Merge branch 'main' into ts/NewForm

0d3e243

Type FormProvider

22b5aaa

kowczarz reviewed Dec 18, 2023

View reviewed changes

kowczarz added 4 commits December 18, 2023 14:13

Revert FAB changes

2cba56d

Fix FormActions types

f74be36

Fix FormWrapper types

6b93011

Review changes

91239d5

kowczarz force-pushed the ts/NewForm branch from 20d744a to 91239d5 Compare December 19, 2023 11:26

Update onyx keys

b0d589c

kowczarz force-pushed the ts/NewForm branch from 126281c to b0d589c Compare December 19, 2023 15:15

kowczarz added 3 commits December 20, 2023 15:32

Merge remote-tracking branch 'expensify/main' into ts/NewForm

010c221

Update temporary types

e4136e9

WIP

2fb8f0e

kowczarz reviewed Jan 2, 2024

View reviewed changes

src/components/Form/FormWrapper.tsx Outdated Show resolved Hide resolved

kowczarz added 4 commits January 3, 2024 15:51

Cleanup types and comments

c353d74

Merge remote-tracking branch 'expensify/main' into ts/NewForm

2496e97

# Conflicts: # src/pages/settings/Wallet/WalletPage/WalletPage.js

Cleanup

91aca42

Fix TS errors

592efa8

blazejkustra commented Jan 3, 2024

View reviewed changes

kowczarz and others added 5 commits January 3, 2024 18:05

Fix lint

f32eb83

Remove redundant code

078b577

Merge branch 'main' into ts/NewForm

1f3d8dd

Fix type imports

c68ff38

WIP: Improve Form types

c09b5d8

blazejkustra added 2 commits January 24, 2024 15:03

Merge branch 'main' into ts/NewForm

d4cc5be

Fix that user wasn't able to focus errors in the form

18a10b9

allroundexperts approved these changes Jan 25, 2024

View reviewed changes

blazejkustra added 2 commits January 25, 2024 11:42

Merge branch 'main' into ts/NewForm

8181d2b

Remove ts-expect-error after merging main

2f91117

mountiny requested review from dangrous and removed request for kubabutkiewicz January 25, 2024 10:56

blazejkustra added 2 commits January 25, 2024 13:46

Merge branch 'main' into ts/NewForm

197cbef

Merge branch 'main' into ts/NewForm

2fa4582

dangrous approved these changes Jan 25, 2024

View reviewed changes

dangrous merged commit 83a7535 into Expensify:main Jan 25, 2024
15 checks passed

roryabraham reviewed Jan 27, 2024

View reviewed changes

roryabraham mentioned this pull request Jan 29, 2024

[HOLD for payment 2024-02-26] [TS Migration] Improve form validation return type #35318

Closed

github-actions bot mentioned this pull request Jan 29, 2024

Deploy Checklist: New Expensify 2024-01-29 #35328

Closed

blazejkustra mentioned this pull request Feb 2, 2024

[TS Migration] Improve Form #35584

Merged

50 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[TS migration] Migrate 'Form' component to TypeScript #32992

[TS migration] Migrate 'Form' component to TypeScript #32992

blazejkustra commented Dec 13, 2023 •

edited

Loading

melvin-bot bot commented Dec 13, 2023

kowczarz commented Jan 4, 2024

blazejkustra commented Jan 24, 2024

mountiny commented Jan 24, 2024

github-actions bot commented Jan 24, 2024

allroundexperts commented Jan 25, 2024 •

edited

Loading

allroundexperts left a comment

melvin-bot bot commented Jan 25, 2024

dangrous left a comment

OSBotify commented Jan 25, 2024

allroundexperts commented Jan 25, 2024

mountiny commented Jan 26, 2024

roryabraham left a comment

blazejkustra commented Jan 29, 2024

roryabraham commented Jan 29, 2024

roryabraham commented Jan 29, 2024

OSBotify commented Jan 29, 2024

pac-guerreiro commented Jan 29, 2024

OSBotify commented Jan 31, 2024

[TS migration] Migrate 'Form' component to TypeScript #32992

[TS migration] Migrate 'Form' component to TypeScript #32992

Conversation

blazejkustra commented Dec 13, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Dec 13, 2023

kowczarz commented Jan 4, 2024

blazejkustra commented Jan 24, 2024

mountiny commented Jan 24, 2024

github-actions bot commented Jan 24, 2024

allroundexperts commented Jan 25, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

allroundexperts left a comment

Choose a reason for hiding this comment

melvin-bot bot commented Jan 25, 2024

dangrous left a comment

Choose a reason for hiding this comment

OSBotify commented Jan 25, 2024

allroundexperts commented Jan 25, 2024

mountiny commented Jan 26, 2024

roryabraham left a comment

Choose a reason for hiding this comment

blazejkustra commented Jan 29, 2024

roryabraham commented Jan 29, 2024

roryabraham commented Jan 29, 2024

OSBotify commented Jan 29, 2024

pac-guerreiro commented Jan 29, 2024

OSBotify commented Jan 31, 2024

blazejkustra commented Dec 13, 2023 •

edited

Loading

allroundexperts commented Jan 25, 2024 •

edited

Loading