Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[TS migration] Migrate 'WorkspaceNewRoom' page to TypeScript #34742

Conversation

pac-guerreiro
Copy link
Contributor

@pac-guerreiro pac-guerreiro commented Jan 18, 2024

Details

Fixed Issues

$#25188
PROPOSAL: N/A

Tests

  1. Make sure you're a member of a workspace or create one first!
  2. On homepage, press ( + ) button and select Start chat
  3. Select Room tab
  4. Check that the page renders correctly and that the inputs work correctly
  5. Fill the necessary data and then press Create room below.
  6. Check that the room was created with the data that you filled on the previous step.

Offline tests

Same as tests.

QA Steps

Same as tests.

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: mWeb Chrome
    • iOS: Native
    • iOS: mWeb 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 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 the PR modifies the form input styles:
    • I verified that all the inputs inside a form are aligned with each other.
    • I added Design label so the design team can review the changes.
  • 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.

Screenshots/Videos

Android: Native

Screenshot_1705685198

Android: mWeb Chrome

Screenshot_1705685618

iOS: Native

Simulator Screenshot - Expensify - App - 2024-01-19 at 17 25 22

iOS: mWeb Safari

Simulator Screenshot - Expensify - Safari - 2024-01-19 at 17 34 35

MacOS: Chrome / Safari Screenshot 2024-01-19 at 17 31 08
MacOS: Desktop Screenshot 2024-01-19 at 17 29 30

@pac-guerreiro
Copy link
Contributor Author

This work is blocked by #31972

@pac-guerreiro pac-guerreiro force-pushed the pac-guerreiro/refactor/migrate-workspacenewroompage-to-typescript branch from 21a8ee6 to 31581f9 Compare January 18, 2024 16:38
src/components/ScreenWrapper.tsx Show resolved Hide resolved
src/pages/workspace/WorkspaceNewRoomPage.tsx Show resolved Hide resolved
src/pages/workspace/WorkspaceNewRoomPage.tsx Outdated Show resolved Hide resolved
src/pages/workspace/WorkspaceNewRoomPage.tsx Outdated Show resolved Hide resolved
src/pages/workspace/WorkspaceNewRoomPage.tsx Outdated Show resolved Hide resolved
Copy link
Contributor

@VickyStash VickyStash left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@pac-guerreiro pac-guerreiro marked this pull request as ready for review January 23, 2024 10:03
@pac-guerreiro pac-guerreiro requested a review from a team as a code owner January 23, 2024 10:03
@melvin-bot melvin-bot bot requested review from arosiclair and removed request for a team January 23, 2024 10:04
Copy link

melvin-bot bot commented Jan 23, 2024

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

@arosiclair
Copy link
Contributor

Code seems good on first glance.

@VickyStash @filip-solecki can one of you complete the checklist please? Thanks!

@situchan
Copy link
Contributor

C+ is supposed to checklist on TS migration PRs but seems missing here.
I can do if needed.

@arosiclair arosiclair requested a review from situchan January 24, 2024 15:25
@arosiclair
Copy link
Contributor

@situchan please review

Copy link
Contributor

@situchan situchan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code looks good. Testing

src/pages/workspace/WorkspaceNewRoomPage.tsx Outdated Show resolved Hide resolved
@situchan
Copy link
Contributor

@pac-guerreiro please pull main. Context here, thanks!

@situchan
Copy link
Contributor

situchan commented Jan 26, 2024

ok, so TS check failing after pull main.
Also fix conflict.

@pac-guerreiro pac-guerreiro force-pushed the pac-guerreiro/refactor/migrate-workspacenewroompage-to-typescript branch from 9039af6 to c8fa793 Compare January 29, 2024 23:02
@pac-guerreiro
Copy link
Contributor Author

@situchan Typescript issues and conflicts resolved! Thanks 😄

Copy link
Contributor

@situchan situchan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

please resolve conflict

label={translate('workspace.common.workspace')}
items={workspaceOptions}
value={policyID}
onValueChange={setPolicyID}
onValueChange={(value) => setPolicyID(value as typeof policyID)}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No way to avoid this typecast? I don't see such pattern throughout the app.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Screenshot 2024-02-07 at 12 46 44

@situchan Sadly, it's not possible at the moment 😞

onValueChange type is hardcoded to expect an unknown value, which creates a type error.

This should be resolved when #35584 is merged!

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks like it was just merged a few days ago. You mind updating this now?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Screenshot 2024-02-21 at 22 10 09

@arosiclair @situchan type assertion is still needed 😅

…oompage-to-typescript

# Conflicts:
#	src/libs/ErrorUtils.ts
#	src/libs/ValidationUtils.ts
#	src/pages/workspace/WorkspaceNewRoomPage.tsx
@pac-guerreiro
Copy link
Contributor Author

Conflicts resolved!

@pac-guerreiro
Copy link
Contributor Author

@situchan Conflicts resolved 😄

@situchan
Copy link
Contributor

@pac-guerreiro conflicts again

…oompage-to-typescript

# Conflicts:
#	src/pages/workspace/WorkspaceNewRoomPage.tsx
@pac-guerreiro
Copy link
Contributor Author

@situchan Conflicts resolved again

@situchan
Copy link
Contributor

situchan commented Feb 15, 2024

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 the PR modifies the form input styles:
    • I verified that all the inputs inside a form are aligned with each other.
    • I added Design label so the design team can review the changes.
  • 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.mov
Android: mWeb Chrome
mchrome.mov
iOS: Native
ios.mov
iOS: mWeb Safari
msafari.mov
MacOS: Chrome / Safari
web.mov
MacOS: Desktop
desktop.mov

@arosiclair
Copy link
Contributor

@situchan please prioritize this review so we can close this out without more conflicts, thanks

Copy link
Contributor

@situchan situchan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

:shipit:

Copy link

melvin-bot bot commented Feb 19, 2024

🎯 @situchan, thanks for reviewing and testing this PR! 🎉

An E/App issue has been created to issue payment here: #36789.

@situchan
Copy link
Contributor

@arosiclair all yours

@situchan
Copy link
Contributor

Also, hoping this PR would get merged sooner than #34654

@situchan
Copy link
Contributor

#34654 was merged earlier.
@pac-guerreiro please sync main again

@pac-guerreiro pac-guerreiro force-pushed the pac-guerreiro/refactor/migrate-workspacenewroompage-to-typescript branch from 93dd85a to 4e062c4 Compare February 21, 2024 17:49
@pac-guerreiro
Copy link
Contributor Author

@situchan conflicts resolved!

@situchan
Copy link
Contributor

@pac-guerreiro please avoid force-push once review started.

Is this just your change?

Screenshot 2024-02-22 at 12 04 29 AM

@pac-guerreiro
Copy link
Contributor Author

@situchan Sorry, I won't do it again! I just wanted to make amends to my last commit 😅

Those were my changes!

@situchan
Copy link
Contributor

@arosiclair all yours

@arosiclair arosiclair merged commit 440c43e into Expensify:main Feb 22, 2024
15 checks passed
@OSBotify
Copy link
Contributor

✋ 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
Copy link
Contributor

🚀 Deployed to staging by https://github.com/arosiclair in version: 1.4.44-0 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/puneetlath in version: 1.4.44-13 🚀

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

Comment on lines +142 to +147
if (!(((wasLoading && !isLoading) || (isOffline && isLoading)) && isEmptyObject(errorFields))) {
return;
}
Navigation.dismissModal(newRoomReportID);
// eslint-disable-next-line react-hooks/exhaustive-deps -- we just want this to update on changing the form State
}, [props.formState]);
}, [isLoading, errorFields]);
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am working on a PR and I am seeing a lint failure in this file: https://github.com/Expensify/App/actions/runs/8103662907/job/22148730565?pr=37556#step:4:19

Warning: 147:8 warning React Hook useEffect has missing dependencies: 'isOffline', 'newRoomReportID', and 'wasLoading'. Either include them or remove the dependency array react-hooks/exhaustive-deps

Questions are:

  1. Should I include those other variables like it is suggesting?
  2. Why is this failing lint now and not when this PR was merged?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

        // eslint-disable-next-line react-hooks/exhaustive-deps 

@iwiznia because you removed this comment in your PR

https://github.com/Expensify/App/pull/37556/files#diff-80df02834ebf2f103e25089bc976474c23f483a5c1188f54eb1f48f847860849L147

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh thanks! 🤦
For some reason my IDE was marking that line as an error... thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants