[TS migration] Migrate RoomInvitePage to typescript #34956

SzymczakJ · 2024-01-23T10:10:53Z

Details

Fixed Issues

$ #31993
PROPOSAL: N/A

Tests

Test main flows of the app(sending messages, logging, requesting money)
Create room and try to invite users, verify that everything works on invite page.

Offline tests

N/A

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

androidinvite.mov

Android: mWeb Chrome

androidwebinvite.mov

iOS: Native

iosinvite.mov

iOS: mWeb Safari

ioswebinvite.mov

MacOS: Chrome / Safari

webinvite.mov

MacOS: Desktop

desktopinvite.mov

src/pages/RoomInvitePage.tsx

src/libs/OptionsListUtils.ts

kubabutkiewicz · 2024-02-06T11:02:05Z

src/pages/RoomInvitePage.tsx


        sectionsArr.push({
            title: translate('common.contacts'),
            data: personalDetailsFormatted,
-            shouldShow: !_.isEmpty(personalDetailsFormatted),


why this was removed?

shouldShow is not used anywhere in SelectionList(sectionArr is data for SectionList) so I've removed it.
Double checked if everything works.

SzymczakJ · 2024-02-09T09:44:25Z

@kubabutkiewicz fixed comments 😅

SzymczakJ · 2024-02-09T10:46:11Z

@kubabutkiewicz fixed comments

melvin-bot · 2024-02-09T11:01:45Z

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

mananjadhav · 2024-02-09T11:51:26Z

I’ll check this once I am online. Quick question, is the unit test failure related to this PR?

SzymczakJ · 2024-02-09T13:38:44Z

@mananjadhav tests failure was related to this PR but I've already fixed them

mananjadhav · 2024-02-09T16:15:16Z

src/libs/OptionsListUtils.ts

@@ -1837,12 +1836,8 @@ function getShareDestinationOptions(
 * @param member - personalDetails or userToInvite
 * @param config - keys to overwrite the default values
 */
-function formatMemberForList(member: ReportUtils.OptionData, config: ReportUtils.OptionData | EmptyObject = {}): MemberForList | undefined {


have we checked all usages to see that it's okay to remove config?

Double checked if everything works. This method is used only in two places and none of them use config param.

mananjadhav · 2024-02-09T16:15:38Z

src/libs/OptionsListUtils.ts

@@ -1837,12 +1836,8 @@ function getShareDestinationOptions(
 * @param member - personalDetails or userToInvite
 * @param config - keys to overwrite the default values
 */
-function formatMemberForList(member: ReportUtils.OptionData, config: ReportUtils.OptionData | EmptyObject = {}): MemberForList | undefined {
-    if (!member) {


do we have any case where this could error?

Same as above, every usage of this function has member of ReportUtils.OptionData type, not undefined or null, so we don't need this check. Future usages are going to be checked by typecheck.

mananjadhav · 2024-02-12T19:30:44Z

src/pages/RoomInvitePage.tsx

-    const [personalDetails, setPersonalDetails] = useState([]);
-    const [userToInvite, setUserToInvite] = useState(null);
+    const [selectedOptions, setSelectedOptions] = useState<ReportUtils.OptionData[]>([]);
+    const [invitePersonalDetails, setPersonalDetails] = useState<ReportUtils.OptionData[]>([]);


should we rename the set state method? I was a bit confused when tracking where was invitePersonalDetails updated.

Suggested change

const [invitePersonalDetails, setPersonalDetails] = useState<ReportUtils.OptionData[]>([]);

const [invitePersonalDetails, setInvitePersonalDetails] = useState<ReportUtils.OptionData[]>([]);

Good point, should have renamed it when I was renaming personalDetails into invitePersonalDetails

mananjadhav · 2024-02-12T19:31:30Z

src/pages/RoomInvitePage.tsx

-                const isOptionInPersonalDetails = _.some(personalDetails, (personalDetail) => personalDetail.accountID === accountID);
+            filterSelectedOptions = selectedOptions.filter((option) => {
+                const accountID = option?.accountID;
+                const isOptionInPersonalDetails = invitePersonalDetails.some((personalDetail) => accountID && personalDetail.accountID && personalDetail.accountID === accountID);


Suggested change

const isOptionInPersonalDetails = invitePersonalDetails.some((personalDetail) => accountID && personalDetail.accountID && personalDetail.accountID === accountID);

const isOptionInPersonalDetails = invitePersonalDetails.some((personalDetail) => accountID && personalDetail?.accountID === accountID);

mananjadhav · 2024-02-12T20:08: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: 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-room-invite.mov

Android: mWeb Chrome

mweb-chrome-room-invite.mov

iOS: Native

ios-room-invite.mov

iOS: mWeb Safari

mweb-safari-room-invite.mov

MacOS: Chrome / Safari

web-room-invite.mov

MacOS: Desktop

desktop-room-invite_BQ57Sn8D.mp4

SzymczakJ · 2024-02-13T11:05:11Z

@mananjadhav fixed comments

melvin-bot · 2024-02-13T17:15:10Z

We did not find an internal engineer to review this PR, trying to assign a random engineer to #31993 as well as to this PR... Please reach out for help on Slack if no one gets assigned!

OSBotify · 2024-02-13T18:05:23Z

✋ 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 · 2024-02-15T05:23:34Z

🚀 Deployed to production by https://github.com/thienlnam in version: 1.4.41-12 🚀

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

ishpaul777 · 2024-04-02T21:43:31Z

src/pages/RoomInvitePage.tsx

+                const isPartOfSearchTerm = option.text?.toLowerCase().includes(searchValue) ?? option.login?.toLowerCase().includes(searchValue);
+                return isPartOfSearchTerm ?? isOptionInPersonalDetails;


This caused a regression here #38324

SzymczakJ added 6 commits January 23, 2024 10:46

migrate RoomInvitePage to TS

76485b5

delete room invite page

c8ec7be

Merge branch 'main' into @szymczak/RoomInvitePage

034d2f6

fix RoomInvitePage after SectionList merge

a178b52

merge changes that were commited before starting to work on RoomInvite

e6b768b

fix bugs introduced in migration

f6e7461

blazejkustra suggested changes Feb 1, 2024

View reviewed changes

src/pages/RoomInvitePage.tsx Outdated Show resolved Hide resolved

src/pages/RoomInvitePage.tsx Outdated Show resolved Hide resolved

src/pages/RoomInvitePage.tsx Outdated Show resolved Hide resolved

src/pages/RoomInvitePage.tsx Outdated Show resolved Hide resolved

SzymczakJ added 3 commits February 1, 2024 16:06

Merge branch 'main' into @szymczak/RoomInvitePage

c6b0586

fix pr comments

08f3a1d

fix pr comments

a4d0cfe

blazejkustra approved these changes Feb 1, 2024

View reviewed changes

fix linter

647f7b5

kubabutkiewicz reviewed Feb 6, 2024

View reviewed changes

Merge branch 'main' into @szymczak/RoomInvitePage

ec95735

SzymczakJ requested a review from kubabutkiewicz February 7, 2024 10:51

fix pr comments

6f283d8

kubabutkiewicz approved these changes Feb 9, 2024

View reviewed changes

SzymczakJ marked this pull request as ready for review February 9, 2024 10:48

SzymczakJ requested a review from a team as a code owner February 9, 2024 10:48

melvin-bot bot requested review from mananjadhav and removed request for a team February 9, 2024 11:01

fix tests

3def67f

SzymczakJ added 2 commits February 9, 2024 15:19

fix tests

698d51d

fix tests

7289436

mananjadhav reviewed Feb 9, 2024

View reviewed changes

SzymczakJ added 2 commits February 12, 2024 12:02

Merge branch 'main' into @szymczak/RoomInvitePage

bde558c

fix linter

7392964

SzymczakJ requested a review from mananjadhav February 12, 2024 11:51

mananjadhav reviewed Feb 12, 2024

View reviewed changes

fix pr comments

2870cdf

mananjadhav approved these changes Feb 13, 2024

View reviewed changes

melvin-bot bot requested a review from aldo-expensify February 13, 2024 17:15

aldo-expensify approved these changes Feb 13, 2024

View reviewed changes

aldo-expensify merged commit e90415d into Expensify:main Feb 13, 2024
17 of 19 checks passed

github-actions bot mentioned this pull request Feb 13, 2024

Deploy Checklist: New Expensify 2024-02-13 #36429

Closed

kbecciv mentioned this pull request Feb 14, 2024

[$500] MEDIUM: Web - Request money is not displayed in recent messages it was included in a previous request #36501

Closed

6 tasks

rlinoz mentioned this pull request Mar 14, 2024

Fix room invite selected options filter #38327

Merged

50 tasks

ishpaul777 reviewed Apr 2, 2024

View reviewed changes

ishpaul777 mentioned this pull request Apr 2, 2024

[HOLD for payment 2024-03-25] Invite - Selected contacts with names disappeared from the invite listing page #38324

Closed

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[TS migration] Migrate RoomInvitePage to typescript #34956

[TS migration] Migrate RoomInvitePage to typescript #34956

SzymczakJ commented Jan 23, 2024 •

edited

Loading

kubabutkiewicz Feb 6, 2024

SzymczakJ Feb 7, 2024

SzymczakJ commented Feb 9, 2024

SzymczakJ commented Feb 9, 2024

melvin-bot bot commented Feb 9, 2024

mananjadhav commented Feb 9, 2024

SzymczakJ commented Feb 9, 2024

mananjadhav Feb 9, 2024

SzymczakJ Feb 12, 2024

mananjadhav Feb 9, 2024

SzymczakJ Feb 12, 2024

mananjadhav Feb 12, 2024

SzymczakJ Feb 13, 2024

mananjadhav Feb 12, 2024

mananjadhav commented Feb 12, 2024 •

edited

Loading

SzymczakJ commented Feb 13, 2024

melvin-bot bot commented Feb 13, 2024

OSBotify commented Feb 13, 2024

OSBotify commented Feb 15, 2024

ishpaul777 Apr 2, 2024

	const [invitePersonalDetails, setPersonalDetails] = useState<ReportUtils.OptionData[]>([]);
	const [invitePersonalDetails, setInvitePersonalDetails] = useState<ReportUtils.OptionData[]>([]);

	const isOptionInPersonalDetails = invitePersonalDetails.some((personalDetail) => accountID && personalDetail.accountID && personalDetail.accountID === accountID);
	const isOptionInPersonalDetails = invitePersonalDetails.some((personalDetail) => accountID && personalDetail?.accountID === accountID);

		const isPartOfSearchTerm = option.text?.toLowerCase().includes(searchValue) ?? option.login?.toLowerCase().includes(searchValue);
		return isPartOfSearchTerm ?? isOptionInPersonalDetails;

[TS migration] Migrate RoomInvitePage to typescript #34956

[TS migration] Migrate RoomInvitePage to typescript #34956

Conversation

SzymczakJ commented Jan 23, 2024 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

Choose a reason for hiding this comment

Choose a reason for hiding this comment

SzymczakJ commented Feb 9, 2024

SzymczakJ commented Feb 9, 2024

melvin-bot bot commented Feb 9, 2024

mananjadhav commented Feb 9, 2024

SzymczakJ commented Feb 9, 2024

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

mananjadhav commented Feb 12, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

SzymczakJ commented Feb 13, 2024

melvin-bot bot commented Feb 13, 2024

OSBotify commented Feb 13, 2024

OSBotify commented Feb 15, 2024

Choose a reason for hiding this comment

SzymczakJ commented Jan 23, 2024 •

edited

Loading

mananjadhav commented Feb 12, 2024 •

edited

Loading