Fix: Do not modify room name on the UI in RoomNameInput. #8512

eVoloshchak · 2022-04-06T16:44:04Z

Details

This fix is a result of the audit of all of the forms that aimed to fix any inconsistencies with modifying user input. During the audit it was discovered that RoomNameInput is modifying user's input. As per expected behaviour, I removed modification of user's input on the UI side, while modified room name is still passed to parent components internally.

Fixed Issues

#7524

Tests

Navigate to the New room screen
Enter room name that contains spaces and/or special characters, verify that input isn't modified
Enter room name that contains uppercase, verify that input isn't modified
Enter room name longer than 80 characters, verify that input isn't modified
After creating a room, verify that the name of the newly created room was modified to follow conventions (no spaces or special characters, lowercase, trimmed to 80 characters max)

PR Review Checklist

Contributor (PR Author) Checklist

PR Reviewer Checklist

QA Steps

Navigate to the New room screen
Enter room name that contains spaces and/or special characters, verify that input isn't modified
Enter room name that contains uppercase, verify that input isn't modified
Enter room name longer than 80 characters, verify that input isn't modified
After creating a room, verify that the name of the newly created room was modified to follow conventions (no spaces or special characters, lowercase, trimmed to 80 characters max)

Screenshots

Web

before.mp4

after.mp4

Mobile Web

22-04-06-19-15-35.mp4

Android

22-04-06-19-20-59.mp4

rushatgabhane · 2022-04-07T09:23:21Z

src/components/RoomNameInput.js

@@ -73,7 +73,7 @@ class RoomNameInput extends Component {
        const target = nativeEvent.target;
        const selection = target.selectionStart;
        const modifiedRoomName = this.modifyRoomName(roomName);
-        this.setState({roomName: modifiedRoomName}, () => {
+        this.setState({roomName: `${CONST.POLICY.ROOM_PREFIX}${roomName}`}, () => {


@eVoloshchak can't we get rid of the value prop from TextInput, roomName from state, and the entire selection logic?

@eVoloshchak can't we get rid of the value prop from TextInput, roomName from state, and the entire selection logic?

We can, I've updated the PR

rushatgabhane · 2022-04-07T14:22:08Z

src/components/RoomNameInput.js


        this.setModifiedRoomName = this.setModifiedRoomName.bind(this);
    }

    /**
-     * Sets the modified room name in the state and calls the onChangeText callback
+     * Calls the onChangeText callback with a modified room name
     * @param {Event} event
     */
    setModifiedRoomName(event) {
        const nativeEvent = event.nativeEvent;
        const roomName = nativeEvent.text;


One last change :)

Suggested change

const roomName = nativeEvent.text;

const roomName = event.nativeEvent.text;

rushatgabhane · 2022-04-07T22:43:04Z

src/components/RoomNameInput.js

@@ -108,7 +96,7 @@ class RoomNameInput extends Component {
                prefixCharacter={CONST.POLICY.ROOM_PREFIX}
                placeholder={this.props.translate('newRoomPage.social')}
                onChange={this.setModifiedRoomName}
-                value={this.state.roomName.substring(1)}
+                defaultValue={this.props.initialValue}


@eVoloshchak sorry that I didn't notice this earlier -

Passing initialValue shows an extra #.
We could fix this by not displaying the first character of initialValue (gotta be careful about the edge cases tho). Please let me know if you have any better ideas to fix this.

I believe we can remove initialValue prop from WorkspaceNewRoomPage.

Passing initialValue shows an extra #.
We could fix this by not displaying the first character of initialValue (gotta be careful about the edge cases tho). Please let me know if you have any better ideas to fix this.

Yup, my bad, omitting first character was actually implemented before.

I believe we can remove initialValue prop from WorkspaceNewRoomPage.

We can, updated the PR

deetergp · 2022-04-08T18:17:47Z

src/components/RoomNameInput.js

@@ -108,7 +96,7 @@ class RoomNameInput extends Component {
                prefixCharacter={CONST.POLICY.ROOM_PREFIX}
                placeholder={this.props.translate('newRoomPage.social')}
                onChange={this.setModifiedRoomName}
-                value={this.state.roomName.substring(1)}
+                defaultValue={this.props.initialValue.substring(1)}


Can you please add a comment here explaining why the substring() is needed?

Can you please add a comment here explaining why the substring() is needed?

Done

…name

deetergp

Looks good, thanks!

rushatgabhane · 2022-04-08T20:19:30Z

src/components/RoomNameInput.js

@@ -108,7 +96,7 @@ class RoomNameInput extends Component {
                prefixCharacter={CONST.POLICY.ROOM_PREFIX}
                placeholder={this.props.translate('newRoomPage.social')}
                onChange={this.setModifiedRoomName}
-                value={this.state.roomName.substring(1)}
+                defaultValue={this.props.initialValue.substring(1)} // Since room name always starts with a prefix, we omit the first character


@eVoloshchak NAB: This makes it easier to read the comment

Suggested change

defaultValue={this.props.initialValue.substring(1)} // Since room name always starts with a prefix, we omit the first character

// Since room name always starts with a prefix, we omit the first character to avoid displaying it twice.

defaultValue={this.props.initialValue.substring(1)}

@eVoloshchak NAB: This makes it easier to read the comment

This results in a following linter error: Expected no line gap between “onChange” and “defaultValue” react/jsx-props-no-multi-space.
But if you remove the gap, it breaks another rule: Expected line before comment lines-around-comment.
I couldn't find a way to satisfy both lines-around-comment and jsx-props-no-multi-space (they seem to contradict each other), please let me know if I'm missing something

Ohhh interesting. I'll raise it on slack, but for now please just update this comment.
Everything else looks great!

Suggested change

defaultValue={this.props.initialValue.substring(1)} // Since room name always starts with a prefix, we omit the first character

defaultValue={this.props.initialValue.substring(1)} // Since the room name always starts with a prefix, we omit the first character to avoid displaying it twice.

rushatgabhane

@deetergp LGTM! 🎉

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 verified tests pass on all platforms & I tested again on:
- iOS / native
- Android / native
- iOS / Safari
- Android / Chrome
- MacOS / Chrome
- 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 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 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 was added in all src/languages/* files
- I verified any copy / text that was added to the app is correct English and approved by marketing by tagging the marketing team 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 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 */
- Any functional components have the displayName property
- 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 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 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.

rushatgabhane · 2022-04-10T19:15:56Z

Screen recs for iOS and Desktop because the PR author missed them

Screen.Recording.2022-04-11.at.12.40.17.AM.mov

Screen.Recording.2022-04-11.at.12.44.52.AM.mov

deetergp

LGTM!

OSBotify · 2022-04-12T18:14:35Z

✋ 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 · 2022-04-13T16:15:57Z

🚀 Deployed to staging by @deetergp in version: 1.1.55-0 🚀

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

OSBotify · 2022-04-18T22:03:35Z

🚀 Deployed to staging by @deetergp in version: 1.1.55-0 🚀

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

mvtglobally · 2022-04-20T01:01:42Z

We are unable to fully verify this PR due to known issue #8534

OSBotify · 2022-04-20T18:47:30Z

🚀 Deployed to production by @yuwenmemon in version: 1.1.55-2 🚀

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

Do not modify room name on the UI

c9ad470

eVoloshchak requested a review from a team as a code owner April 6, 2022 16:44

melvin-bot bot removed the request for review from a team April 6, 2022 16:44

AndrewGable requested a review from a team April 6, 2022 19:22

melvin-bot bot requested review from deetergp and rushatgabhane and removed request for a team April 6, 2022 19:22

rushatgabhane reviewed Apr 7, 2022

View reviewed changes

Make RoomNameInput uncontrolled

145d32f

rushatgabhane reviewed Apr 7, 2022

View reviewed changes

Cleanup

82aac6b

rushatgabhane reviewed Apr 7, 2022

View reviewed changes

eVoloshchak added 2 commits April 8, 2022 13:50

Do not display first character of the initialValue

e8ad73d

Do not pass initial value to RoomNameInput

db97925

deetergp requested changes Apr 8, 2022

View reviewed changes

eVoloshchak added 2 commits April 8, 2022 22:21

Add a comment explaining why we omitting the first character of room …

503cc31

…name

Fix linter error

4537b7c

deetergp previously approved these changes Apr 8, 2022

View reviewed changes

rushatgabhane reviewed Apr 8, 2022

View reviewed changes

Update comment

db7f343

eVoloshchak dismissed deetergp’s stale review via db7f343 April 9, 2022 07:21

rushatgabhane approved these changes Apr 9, 2022

View reviewed changes

rushatgabhane mentioned this pull request Apr 11, 2022

[HOLD for payment 2022-05-20][$1000] - Audit forms and fix inconsistencies with modifying user input #7524

Closed

20 tasks

deetergp assigned deetergp and eVoloshchak and unassigned deetergp Apr 12, 2022

deetergp approved these changes Apr 12, 2022

View reviewed changes

deetergp merged commit 8419bd4 into Expensify:main Apr 12, 2022

Julesssss mentioned this pull request Apr 13, 2022

Deploy Checklist: New Expensify 2022-04-13 #8631

Closed

25 tasks

Stutikuls mentioned this pull request Apr 18, 2022

[low] Chrome + Jaws: New chat(+) dropdown expanded/collapsed state is not announced. #8667

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix: Do not modify room name on the UI in RoomNameInput. #8512

Fix: Do not modify room name on the UI in RoomNameInput. #8512

eVoloshchak commented Apr 6, 2022

rushatgabhane Apr 7, 2022 •

edited

Loading

eVoloshchak Apr 7, 2022

rushatgabhane Apr 7, 2022

rushatgabhane Apr 7, 2022

eVoloshchak Apr 8, 2022

rushatgabhane Apr 8, 2022

deetergp Apr 8, 2022

eVoloshchak Apr 8, 2022

deetergp left a comment

rushatgabhane Apr 8, 2022

eVoloshchak Apr 8, 2022

rushatgabhane Apr 8, 2022

rushatgabhane left a comment •

edited

Loading

rushatgabhane commented Apr 10, 2022

deetergp left a comment

OSBotify commented Apr 12, 2022

OSBotify commented Apr 13, 2022

OSBotify commented Apr 18, 2022

mvtglobally commented Apr 20, 2022

OSBotify commented Apr 20, 2022

	const roomName = nativeEvent.text;
	const roomName = event.nativeEvent.text;

	defaultValue={this.props.initialValue.substring(1)} // Since room name always starts with a prefix, we omit the first character
	defaultValue={this.props.initialValue.substring(1)} // Since the room name always starts with a prefix, we omit the first character to avoid displaying it twice.

Fix: Do not modify room name on the UI in RoomNameInput. #8512

Fix: Do not modify room name on the UI in RoomNameInput. #8512

Conversation

eVoloshchak commented Apr 6, 2022

Details

Fixed Issues

Tests

PR Review Checklist

Contributor (PR Author) Checklist

PR Reviewer Checklist

QA Steps

Screenshots

Web

Mobile Web

Android

rushatgabhane Apr 7, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

deetergp left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rushatgabhane left a comment • edited Loading

Choose a reason for hiding this comment

rushatgabhane commented Apr 10, 2022

deetergp left a comment

Choose a reason for hiding this comment

OSBotify commented Apr 12, 2022

OSBotify commented Apr 13, 2022

OSBotify commented Apr 18, 2022

mvtglobally commented Apr 20, 2022

OSBotify commented Apr 20, 2022

rushatgabhane Apr 7, 2022 •

edited

Loading

rushatgabhane left a comment •

edited

Loading