[Form Provider Refactor] RoomNameInput fixes by kowczarz · Pull Request #32432 · Expensify/App

kowczarz · 2023-12-04T15:08:51Z

Details

Followup to #30996

Fixed Issues

$ #32398
PROPOSAL: #32398 (comment)
$ #32399
$ #32386

Tests

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.

Check for consistent errors:

Go to home screen
Go to + > Start chat > Room.
Click Create room without entering room name.
Type [[<<> (don't copy paste) in the name field.

Ensure input can be re-focused:

Open the App
Log in with any Expensify account
Press + button > Press Start chat > Switch to # Room
Enter incorrect data for receiving an error
Focus on another input field
Try to focus again on the name input field

Verify that no errors appear in the JS console

Offline tests

Same as above

QA Steps

Same as above

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Android: Native

android.native_H.265.mp4

Android: mWeb Chrome

android.web_H.265.mp4

iOS: Native

ios.native_H.265.mp4

iOS: mWeb Safari

ios.web_H.265.mp4

MacOS: Chrome / Safari

web_H.265.mp4

MacOS: Desktop

desktop_H.265.mp4

melvin-bot · 2023-12-04T15:08:57Z

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

…changes

This reverts commit a60110b.

melvin-bot · 2023-12-06T17:08:52Z

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

kowczarz · 2023-12-06T17:09:20Z

Cc. @luacmartins

s77rt · 2023-12-06T20:20:58Z

src/components/RoomNameInput/index.js

-        <TextInput
+        <InputWrapper
+            InputComponent={TextInput}
+            inputID={inputID}


I don't think this is the best to do here. Using InputWrapper inside RoomNameInput to wrap TextInput feels a littler over-engineered. I would rather prefer InputWrapper to wrap RoomNameInput. InputWrapper should wrap the highest-level input.

RoomNameInput > InputWrapper > TextInput ❌
InputWrapper > RoomNameInput > TextInput ✅

PS: We also have a problem with that structure on NewDatePicker

It would look better if we have moved the InputWrapper outside the component, but that would require dividing the logic of RoomNameInput between the component and screens where it's used. Since the logic of room input is quite complex and the current refactor has already caused some regressions in this PR I would only migrate the input to FormProvider. As soon as we will be sure the current changes won't introduce any regressions I would refactor the RoomNameInput according your suggestions in a separate PR.

I'm trying to get rid of the valueParser and displayParser that we are passing to the Form. The FromProvider should not handle those. We should instead call the onInputChange in the RoomNameInput and supply the modified value.

This approach should result in the least code changes.

but that would require dividing the logic of RoomNameInput between the component and screens

Can you please elaborate on this one?

I'm trying to get rid of the valueParser and displayParser that we are passing to the Form. The FromProvider should not handle those. We should instead call the onInputChange in the RoomNameInput and supply the modified value.

That would be great, but since we need to display different value than the one that is sent to Onyx, I couldn't find any better solution.

The second part I managed to move, I didn't spot that I forgot to move some props.

we need to display different value than the one that is sent to Onyx

This is already handled within <RoomNameInput />: value={value.substring(1)}.

Let's consider this scenario:

Revert all the changes in this PR

In places that we use RoomNameInput (i.e. RoomNamePage and WorkspaceNewRoomPage), replace <RoomNameInput ... /> with <InputWrapper InputComponent={RoomNameInput} ... />

What could go wrong in this case?

@s77rt Ok, I reverted some changes, I think now it should look fine.

Thanks. This is looking much better. I still see some changes to src/components/RoomNameInput/ that does not look needed. And in src/libs/RoomNameInputUtils.ts too Can you please check again?

Will do it tomorrow

src/components/Form/FormProvider.js

src/components/RoomNameInput/index.js

src/components/RoomNameInput/index.native.js

src/pages/settings/Report/RoomNamePage.js

s77rt · 2023-12-13T14:39:12Z

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

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

luacmartins · 2023-12-13T16:40:00Z

We're so close. @kowczarz could you please address the latest comments? Let's get this merged today.

…name-edit-error # Conflicts: # src/components/Form/FormProvider.js # src/pages/workspace/WorkspaceNewRoomPage.js

kowczarz · 2023-12-14T13:22:44Z

Hey @luacmartins, sorry I didn't manage to fix it yesterday, since I had to leave office earlier, but now it's ready.

s77rt · 2023-12-14T13:28:56Z

@kowczarz Lint please

s77rt · 2023-12-14T13:41:59Z

The "Ensure draft works" test can be removed.

luacmartins

LGTM! Thanks for working on this!

OSBotify · 2023-12-14T16:44:40Z

✋ 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 · 2023-12-19T02:43:12Z

🚀 Deployed to staging by https://github.com/luacmartins in version: 1.4.14-0 🚀

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

OSBotify · 2023-12-19T03:46:33Z

🚀 Deployed to staging by https://github.com/luacmartins in version: 1.4.14-0 🚀

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

OSBotify · 2023-12-21T05:14:08Z

🚀 Deployed to production by https://github.com/jasperhuangg in version: 1.4.14-6 🚀

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

kowczarz added 2 commits December 4, 2023 19:37

Fix error shows up when saving existing and valid room name with any …

28d0ba9

…changes

Revert "Revert "[Form Provider Refactor] RoomNameInput fixes""

9fa1591

This reverts commit a60110b.

kowczarz force-pushed the kowczarz/fix-room-name-edit-error branch from d1142ac to 9fa1591 Compare December 4, 2023 18:38

kowczarz changed the title ~~Fix Room - Error shows up when saving existing and valid room name with any changes~~ [Form Provider Refactor] RoomNameInput fixes Dec 4, 2023

Fix inconsistent error message

b9fc2f4

kowczarz mentioned this pull request Dec 5, 2023

[HOLD for payment 2023-12-12] Android - Room - Hard to focus the name input field after the error message appears #32402

Closed

6 tasks

Fix last character of input fields is removed after coming back to form

cc75622

blazejkustra approved these changes Dec 6, 2023

View reviewed changes

kowczarz marked this pull request as ready for review December 6, 2023 17:08

kowczarz requested a review from a team as a code owner December 6, 2023 17:08

melvin-bot bot requested review from s77rt and removed request for a team December 6, 2023 17:08

luacmartins self-requested a review December 6, 2023 17:21

s77rt suggested changes Dec 6, 2023

View reviewed changes

kowczarz added 2 commits December 8, 2023 16:03

Code review changes

02756ba

Revert RoomNameInput changes

c56d3af

kowczarz force-pushed the kowczarz/fix-room-name-edit-error branch from 026ca81 to c56d3af Compare December 12, 2023 15:30

kowczarz added 3 commits December 12, 2023 16:32

Cleanup

f54b326

Cleanup

abbca90

RoomNameInput cleanup

f0ac1bd

kowczarz force-pushed the kowczarz/fix-room-name-edit-error branch from 02a3a50 to f0ac1bd Compare December 12, 2023 15:49

s77rt mentioned this pull request Dec 12, 2023

[Pay meow][$1000] Legal name - When tapping on the Legal Last Name field, the error message alternates between 'This field is required' and 'Name can only include Latin characters #31391

Closed

6 tasks

shubham1206agra reviewed Dec 12, 2023

View reviewed changes

src/components/Form/FormProvider.js Outdated Show resolved Hide resolved

kowczarz added 3 commits December 13, 2023 11:44

Remove unnecessary change

885ba8d

Revert changes in RoomNameInputUtils

b750a6b

Cleanup

6e66e3f

kowczarz requested a review from s77rt December 13, 2023 10:47

s77rt suggested changes Dec 13, 2023

View reviewed changes

src/components/RoomNameInput/index.js Show resolved Hide resolved

src/components/RoomNameInput/index.native.js Show resolved Hide resolved

s77rt suggested changes Dec 13, 2023

View reviewed changes

src/pages/settings/Report/RoomNamePage.js Show resolved Hide resolved

kowczarz added 3 commits December 14, 2023 12:26

Fix prop types error

06c1735

Revert changes in RoomNameInputUtils

8c701f2

Merge remote-tracking branch 'expensify/main' into kowczarz/fix-room-…

dd91de4

…name-edit-error # Conflicts: # src/components/Form/FormProvider.js # src/pages/workspace/WorkspaceNewRoomPage.js

Lint fix

31f79a6

kowczarz force-pushed the kowczarz/fix-room-name-edit-error branch from 730731c to 31f79a6 Compare December 14, 2023 13:33

s77rt approved these changes Dec 14, 2023

View reviewed changes

melvin-bot bot requested a review from tgolen December 14, 2023 13:42

luacmartins approved these changes Dec 14, 2023

View reviewed changes

luacmartins merged commit 2c822e5 into Expensify:main Dec 14, 2023

shubham1206agra mentioned this pull request Dec 17, 2023

[HOLD on PR 32432] [$500] Task - task title displays and removes error in few seconds on enter #33187

Closed

6 tasks

github-actions bot mentioned this pull request Dec 19, 2023

Deploy Checklist: New Expensify 2023-12-19 #33264

Closed

98 tasks

mateuuszzzzz mentioned this pull request Feb 16, 2024

[TS Migration] Migrate 'RoomNameInput' to TypeScript #36676

Merged

49 tasks

Conversation

kowczarz commented Dec 4, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

Uh oh!

melvin-bot bot commented Dec 4, 2023

Uh oh!

melvin-bot bot commented Dec 6, 2023

Uh oh!

kowczarz commented Dec 6, 2023

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

s77rt commented Dec 13, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer Checklist

Screenshots/Videos

Uh oh!

luacmartins commented Dec 13, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

kowczarz commented Dec 14, 2023

Uh oh!

s77rt commented Dec 14, 2023

Uh oh!

s77rt commented Dec 14, 2023

Uh oh!

luacmartins left a comment

Choose a reason for hiding this comment

Uh oh!

OSBotify commented Dec 14, 2023

Uh oh!

OSBotify commented Dec 19, 2023

Uh oh!

OSBotify commented Dec 19, 2023

Uh oh!

OSBotify commented Dec 21, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

kowczarz commented Dec 4, 2023 •

edited

Loading

s77rt commented Dec 13, 2023 •

edited

Loading

luacmartins commented Dec 13, 2023 •

edited

Loading