Component refactor: migrate WorkspaceNewRoomPage to function component by alexxxwork · Pull Request #22015 · Expensify/App

alexxxwork · 2023-07-01T12:54:16Z

Details

Migrate WorkspaceNewRoomPage to function component

Fixed Issues

$ #16307
PROPOSAL: #16307 (comment)

Tests

Click the Plus button on LHP
Click "New room"
Choose a Workspace and any room name
Click "Create room"
Verify that room has been created successfully

Verify that no errors appear in the JS console

Offline tests

QA Steps

Click the Plus button on LHP
Click "New room"
Choose a Workspace and any room name
Click "Create room"
Verify that room has been created successfully

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 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
  - If any non-english text was added/modified, I verified the translation was requested/reviewed in #expensify-open-source and it was approved by an internal Expensify engineer. Link to Slack message:
- 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 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 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 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 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-07-01T12:54:21Z

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

fedirjh

Looks good , left some improvements comments

fedirjh · 2023-07-02T18:47:33Z

+    if (!Permissions.canUsePolicyRooms(props.betas)) {
+        Log.info('Not showing create Policy Room page since user is not on policy rooms beta');
+        Navigation.dismissModal();
+        return null;


Maybe this block can be moved to the top

No it can't because of useCallback and useMemo - they shouldn't be called conditionally

Aha that make sense. Let's keep it as it is.

Co-authored-by: Fedi Rajhi <fedirjh@gmail.com>

alexxxwork · 2023-07-02T22:13:56Z

@fedirjh Thanks for input, added your suggestions

fedirjh · 2023-07-02T22:50:13Z

@alexxxwork could you please update the tests to include a step to verify that the room is created successfully .

fedirjh · 2023-07-02T23:31:10Z

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 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(themeColors.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 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

Web

Screen.Recording.2023-07-02.at.11.56.23.PM.mov

Mobile Web - Chrome

Screen.Recording.2023-07-03.at.12.27.49.AM.mov

Mobile Web - Safari

Screen.Recording.2023-07-03.at.12.28.54.AM.mov

Desktop

Screen.Recording.2023-07-03.at.12.03.33.AM.mov

iOS

Screen.Recording.2023-07-03.at.12.09.38.AM.mov

Android

Screen.Recording.2023-07-03.at.12.20.50.AM.mov

fedirjh

@alexxxwork There is a console error when we deep link to http://localhost:8080/workspace/new-room while we don't have the rooms beta access :

Co-authored-by: Fedi Rajhi <fedirjh@gmail.com>

alexxxwork · 2023-07-03T01:09:18Z

There is a console error when we deep link to http://localhost:8080/workspace/new-room

@fedirjh I see this error also on main so it seems we fixed an additional bug.
Have I got it right that this useEffect part is needed only for that edge case when canUsePolicyRooms changes after modal opened? Is it useful at all?

fedirjh · 2023-07-03T06:29:34Z

I see this error also on main so it seems we fixed an additional bug.

I was not aware of that 😄

Have I got it right that this useEffect part is needed only for that edge case when canUsePolicyRooms changes after modal opened? Is it useful at all?

No it's not because "canUsePolicyRooms changes after modal opened" , It seems that Navigation.dismissModal(); trigger an update state under the hook :

We are calling Navigation.dismissModal(); during the rendering in another component , that will trigger a state update during the rendering. By using useEffect, Navigation.dismissModal(); will be executed after the rendering and that will make data flow correctly. I believe this issue may arise in other places where we use similar code.

fedirjh

LGTM and tests well.

🎀 👀 🎀 C+ reviewed

OSBotify · 2023-07-03T17:33:55Z

✋ 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-07-05T17:32:23Z

🚀 Deployed to staging by https://github.com/yuwenmemon in version: 1.3.37-0 🚀

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

OSBotify · 2023-07-07T10:37:49Z

🚀 Deployed to production by https://github.com/Julesssss in version: 1.3.37-7 🚀

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

Component refactor: WorkspaceNewRoomPage

40e7522

alexxxwork requested a review from a team as a code owner July 1, 2023 12:54

melvin-bot Bot requested review from fedirjh and removed request for a team July 1, 2023 12:54

alexxxwork mentioned this pull request Jul 1, 2023

[HOLD for payment 2023-07-14] [$250] Migrate WorkspaceNewRoomPage.js to function component #16307

Closed

1 task

alexxxwork added 2 commits July 1, 2023 16:04

Fix: changes after prettier run

874ad66

Fix lint issue after prettier run

8f52363

fedirjh suggested changes Jul 2, 2023

View reviewed changes

alexxxwork and others added 2 commits July 2, 2023 13:51

Update src/pages/workspace/WorkspaceNewRoomPage.js

2d281be

Co-authored-by: Fedi Rajhi <fedirjh@gmail.com>

Add useLocalize, useMemo, minor fixes

1aa2452

fedirjh suggested changes Jul 2, 2023

View reviewed changes

Comment thread src/pages/workspace/WorkspaceNewRoomPage.js Outdated

alexxxwork and others added 2 commits July 2, 2023 17:56

Update src/pages/workspace/WorkspaceNewRoomPage.js

208cce7

Co-authored-by: Fedi Rajhi <fedirjh@gmail.com>

Fix missing import

a1848cb

fedirjh approved these changes Jul 3, 2023

View reviewed changes

melvin-bot Bot requested a review from yuwenmemon July 3, 2023 06:31

yuwenmemon approved these changes Jul 3, 2023

View reviewed changes

yuwenmemon merged commit ddbd4bb into Expensify:main Jul 3, 2023

OSBotify mentioned this pull request Jul 5, 2023

Deploy Checklist: New Expensify 2023-07-05 #22282

Closed

58 tasks

Conversation

alexxxwork commented Jul 1, 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 Jul 1, 2023

Uh oh!

fedirjh left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

fedirjh Jul 2, 2023

Choose a reason for hiding this comment

Uh oh!

alexxxwork Jul 2, 2023

Choose a reason for hiding this comment

Uh oh!

fedirjh Jul 2, 2023 • 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!

Uh oh!

alexxxwork commented Jul 2, 2023

Uh oh!

fedirjh commented Jul 2, 2023

Uh oh!

fedirjh commented Jul 2, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer Checklist

Screenshots/Videos

Uh oh!

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

Uh oh!

alexxxwork commented Jul 3, 2023

Uh oh!

fedirjh commented Jul 3, 2023

Uh oh!

fedirjh left a comment

Choose a reason for hiding this comment

Uh oh!

OSBotify commented Jul 3, 2023

Uh oh!

OSBotify commented Jul 5, 2023

Uh oh!

OSBotify commented Jul 7, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

alexxxwork commented Jul 1, 2023 •

edited

Loading

fedirjh Jul 2, 2023 •

edited

Loading

fedirjh commented Jul 2, 2023 •

edited

Loading

fedirjh left a comment •

edited

Loading