Use else-ifs to establish precedence for room name validations #14068

yuwenmemon · 2023-01-06T19:18:46Z

Details

Update the validation code to use else-ifs so we can more clearly establish the precedence for which validation errors get shown.

Fixed Issues

$ #14010

Tests

Login with account that has policyRooms beta enabled
Click FAB -> New Room
Don't input anything and just click "Create Room" button
Make sure "Please enter a room name message shows below Room Name input field
Type in #admins, make sure "A room on this workspace already uses this name" error shows

===

Create a room
Go to that room in the LHN
Go to the room settings page
Do the same steps as above.

Verify that no errors appear in the JS console

Offline tests

Repeat the steps as above, but while offline, ensure the behavior is the same

QA Steps

Conduct both the steps in Tests and Offline Tests above.
Verify that no errors appear in the JS console

PR Author Checklist

I linked the correct issue in the ### Fixed Issues section above
I wrote clear testing steps that cover the changes made in this PR
- I added steps for local testing in the Tests section
- I added steps for the expected offline behavior in the Offline steps section
- I added steps for Staging and/or Production testing in the QA steps section
- I added steps to cover 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 tested this PR with a High Traffic account against the staging or production API to ensure there are no regressions (e.g. long loading states that impact usability).
I included screenshots or videos for tests on all platforms
I ran the tests on all platforms & verified they passed on:
- Android / native
- Android / Chrome
- iOS / native
- iOS / Safari
- MacOS / Chrome / Safari
- 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 followed proper code patterns (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 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 correct English and 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 followed the guidelines as stated in the Review Guidelines
I tested other components that can be impacted by my changes (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar are working as expected)
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
I verified that if a function's arguments changed that all usages have also been updated correctly
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(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.
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.
I have checked off every checkbox in the PR author checklist, including those that don't apply to this PR.

Screenshots/Videos

Web

Mobile Web - Chrome

Mobile Web - Safari

Desktop

iOS

Android

melvin-bot · 2023-01-06T19:19:17Z

@thesahindia @marcaaron One of you needs to 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]

fedirjh · 2023-01-06T19:23:59Z

@yuwenmemon same changes should be applied to ReportSettingsPage.js

App/src/pages/ReportSettingsPage.js

Lines 93 to 99 in 91f761f

    
           // Show error if the room name already exists 
        
           if (ValidationUtils.isExistingRoomName(values.newRoomName, this.props.reports, this.props.report.policyID)) { 
        
               errors.newRoomName = this.props.translate('newRoomPage.roomAlreadyExistsError'); 
        
           } 
        
           // We error if the user doesn't enter a room name or left blank 
        
           if (!values.newRoomName || values.newRoomName === CONST.POLICY.ROOM_PREFIX) {

fedirjh · 2023-01-06T19:32:35Z

src/pages/workspace/WorkspaceNewRoomPage.js

+            // Third priority: We error if the room name already exists.
+            errors.roomName = this.props.translate('newRoomPage.roomAlreadyExistsError');
+        } else if (!ValidationUtils.isValidRoomName(values.roomName)) {
+            // Fourth priority: We error if the room name has invalid characters


I think this should be 2nd priority , we shouldn't validate for existing or reserved before we validate that the name has invalid characters

Sure, but I also don't think it matters. We would never have an existing or reserved room with invalid characters.

sure, I meant we don't have to run checks (existing or reserved) when roomName is invalid

thesahindia · 2023-01-06T20:39:03Z

Testing...

fedirjh

LGTM !

thesahindia · 2023-01-06T20:46:07Z

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 / Chrome
- iOS / native
- iOS / 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 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 correct English and 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(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.
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.
I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

Screenshots/Videos

Web

Screen.Recording.2023-01-07.at.2.11.54.AM.mov

Screen.Recording.2023-01-07.at.2.10.40.AM.mov

Mobile Web - Chrome

Mobile Web - Safari

Desktop

iOS

Android

thesahindia

Looks good and works well!

github-actions · 2023-01-06T21:26:45Z

Performance Comparison Report 📊

Significant Changes To Duration

Name	Duration
TTI	776.463 ms → 688.096 ms (-88.366 ms, -11.4%) 🟢

Show details

Name	Duration
TTI	Baseline Mean: 776.463 ms Stdev: 36.732 ms (4.7%) Runs: 710.4326740000397 719.1714500000235 721.1777949999087 739.213194000069 740.5343520001043 746.5196799999103 749.6393279999029 749.9920059998985 756.441010999959 756.6962659999263 757.1035400000401 757.8160129999742 761.9934010000434 762.2591180000454 769.7318869999144 770.2888299999759 771.9026009999216 781.0258470000699 783.2929310000036 787.6018950000871 793.3395169998985 800.3223260000814 802.9889789998997 807.1134339999408 811.7507700000424 823.4144939999096 831.9750449999701 836.7723550000228 842.5223250000272 850.8424490001053 Current Mean: 688.096 ms Stdev: 33.225 ms (4.8%) Runs: 639.6989190001041 648.2637899999972 648.3373690000735 649.2602440000046 649.3323270000983 651.7150820000097 658.4737110000569 659.3243579999544 661.4431040000636 663.0963339998852 664.0349260000512 667.9643270000815 672.8353299999144 679.5373919999693 685.7220850000158 686.2985900000203 693.0266350000165 702.361925000092 703.4168209999334 707.2895539999008 708.4720910000615 712.6746239999775 713.3533689999022 713.7179360000882 714.6987729999237 716.3507910000626 718.9008480000775 721.2422070000321 759.31416300009 772.7237080000341

Meaningless Changes To Duration

Show entries

Name	Duration
nativeLaunch	9.100 ms → 9.933 ms (+0.833 ms, +9.2%)
regularAppStart	0.016 ms → 0.015 ms (-0.000 ms, -0.7%)
runJsBundle	188.563 ms → 186.387 ms (-2.175 ms, -1.2%)

Show details

Name	Duration
nativeLaunch	Baseline Mean: 9.100 ms Stdev: 1.165 ms (12.8%) Runs: 8 8 8 8 8 8 8 8 8 8 8 9 9 9 9 9 9 9 9 9 9 9 10 10 10 10 11 11 12 12 Current Mean: 9.933 ms Stdev: 1.692 ms (17.0%) Runs: 8 8 8 8 8 8 9 9 9 9 9 9 9 9 10 10 10 10 10 10 10 10 11 11 11 11 13 13 14 14
regularAppStart	Baseline Mean: 0.016 ms Stdev: 0.002 ms (12.5%) Runs: 0.013426999794319272 0.013508999953046441 0.013753999955952168 0.013794000027701259 0.01395700010471046 0.013998000184074044 0.014038000022992492 0.014119999948889017 0.014282000018283725 0.014283000025898218 0.014404000015929341 0.014404000015929341 0.014405000023543835 0.014527000021189451 0.014607999939471483 0.014649000018835068 0.014688999857753515 0.014851999934762716 0.015217999927699566 0.015503000002354383 0.01599099999293685 0.01672299997881055 0.016927000135183334 0.017619000049307942 0.018065999960526824 0.01823000004515052 0.018391999881714582 0.01863600010983646 0.019287000177428126 0.020629999926313758 Current Mean: 0.015 ms Stdev: 0.002 ms (10.0%) Runs: 0.013101999880746007 0.013549000024795532 0.013550000032410026 0.013631999958306551 0.013672000030055642 0.013712000101804733 0.01399700017645955 0.014322000090032816 0.01436399994418025 0.014445000095292926 0.01448600017465651 0.014567000092938542 0.014811000088229775 0.014973999932408333 0.01513600000180304 0.015177000081166625 0.015299000078812242 0.015339999925345182 0.015625 0.015746999997645617 0.01603199983946979 0.016195000149309635 0.016357999993488193 0.016765000065788627 0.017048999899998307 0.017130000051110983 0.017171000130474567 0.017253000056371093 0.018065999960526824 0.018595000030472875 0.018880999879911542
runJsBundle	Baseline Mean: 188.563 ms Stdev: 29.748 ms (15.8%) Runs: 153 154 154 155 159 163 164 164 168 168 170 170 171 172 172 173 173 177 188 195 197 200 206 211 212 215 227 231 233 237 244 258 Current Mean: 186.387 ms Stdev: 25.008 ms (13.4%) Runs: 157 159 161 162 164 166 166 168 169 170 171 171 171 172 173 178 183 184 184 186 188 198 198 204 204 208 215 225 232 232 259

github-actions · 2023-01-06T21:26:47Z

@Expensify/mobile-deployers 📣 Please look into this performance regression as it's a deploy blocker.

yuwenmemon · 2023-01-06T21:28:16Z

Duration actually went down - removing the label

OSBotify · 2023-01-06T22:23:57Z

🚀 Deployed to staging by @puneetlath in version: 1.2.50-6 🚀

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

OSBotify · 2023-01-09T18:04:50Z

🚀 Deployed to production by @Julesssss in version: 1.2.50-14 🚀

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

Use else-ifs to establish precedence for room name validations

022fd8f

yuwenmemon self-assigned this Jan 6, 2023

yuwenmemon requested a review from a team as a code owner January 6, 2023 19:18

melvin-bot bot requested review from marcaaron and thesahindia and removed request for a team January 6, 2023 19:19

puneetlath previously approved these changes Jan 6, 2023

View reviewed changes

Make similar changes on the report settings page

5d51e0c

yuwenmemon dismissed puneetlath’s stale review via 5d51e0c January 6, 2023 20:16

puneetlath approved these changes Jan 6, 2023

View reviewed changes

fedirjh suggested changes Jan 6, 2023

View reviewed changes

fedirjh approved these changes Jan 6, 2023

View reviewed changes

thesahindia approved these changes Jan 6, 2023

View reviewed changes

puneetlath merged commit 40ec7d2 into main Jan 6, 2023

puneetlath deleted the yuwen-validateRoomCreation branch January 6, 2023 21:03

OSBotify mentioned this pull request Jan 6, 2023

Deploy Checklist: New Expensify 2023-01-06 #14067

Closed

36 tasks

github-actions bot added the DeployBlockerCash This issue or pull request should block deployment label Jan 6, 2023

yuwenmemon removed the DeployBlockerCash This issue or pull request should block deployment label Jan 6, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Use else-ifs to establish precedence for room name validations #14068

Use else-ifs to establish precedence for room name validations #14068

yuwenmemon commented Jan 6, 2023 •

edited

Loading

melvin-bot bot commented Jan 6, 2023

fedirjh commented Jan 6, 2023

fedirjh Jan 6, 2023

yuwenmemon Jan 6, 2023

fedirjh Jan 6, 2023

thesahindia commented Jan 6, 2023

fedirjh left a comment •

edited

Loading

thesahindia commented Jan 6, 2023 •

edited

Loading

thesahindia left a comment

github-actions bot commented Jan 6, 2023

github-actions bot commented Jan 6, 2023

yuwenmemon commented Jan 6, 2023

OSBotify commented Jan 6, 2023

OSBotify commented Jan 9, 2023

Use else-ifs to establish precedence for room name validations #14068

Use else-ifs to establish precedence for room name validations #14068

Conversation

yuwenmemon commented Jan 6, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Jan 6, 2023

fedirjh commented Jan 6, 2023

fedirjh Jan 6, 2023

Choose a reason for hiding this comment

yuwenmemon Jan 6, 2023

Choose a reason for hiding this comment

fedirjh Jan 6, 2023

Choose a reason for hiding this comment

thesahindia commented Jan 6, 2023

fedirjh left a comment • edited Loading

Choose a reason for hiding this comment

thesahindia commented Jan 6, 2023 • edited Loading

Reviewer Checklist

Screenshots/Videos

thesahindia left a comment

Choose a reason for hiding this comment

github-actions bot commented Jan 6, 2023

Performance Comparison Report 📊

Significant Changes To Duration

Meaningless Changes To Duration

github-actions bot commented Jan 6, 2023

yuwenmemon commented Jan 6, 2023

OSBotify commented Jan 6, 2023

OSBotify commented Jan 9, 2023

yuwenmemon commented Jan 6, 2023 •

edited

Loading

fedirjh left a comment •

edited

Loading

thesahindia commented Jan 6, 2023 •

edited

Loading