Fix: Do not modify room name on the UI in RoomNameInput. by eVoloshchak · Pull Request #8512 · Expensify/App

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

        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

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

                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

                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

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

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

	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.

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

Uh oh!

rushatgabhane Apr 7, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

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!

deetergp left a comment

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!

rushatgabhane left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

rushatgabhane commented Apr 10, 2022

Uh oh!

deetergp left a comment

Choose a reason for hiding this comment

Uh oh!

OSBotify commented Apr 12, 2022

Uh oh!

OSBotify commented Apr 13, 2022

Uh oh!

OSBotify commented Apr 18, 2022

Uh oh!

mvtglobally commented Apr 20, 2022

Uh oh!

OSBotify commented Apr 20, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

rushatgabhane Apr 7, 2022 •

edited

Loading

rushatgabhane left a comment •

edited

Loading