Fix issue with option disappearing when selected for new contacts by thienlnam · Pull Request #30017 · Expensify/App

thienlnam · 2023-10-19T19:33:07Z

Details

Fixed Issues

$ #29917
PROPOSAL:

Tests

Same as QA

Offline tests

Same as online

QA Steps

Create a new split / group chat
Select multiple participants
Search for a contact you have not chatted with and is not in your contacts list
Add them to the group and verify the option does not disappear

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 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
- If we are not using the full Onyx data that we loaded, I've added the proper selector in order to ensure the component only re-renders when the data it is using changes
- 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 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 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

Android: Native

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

Screen.Recording.2023-10-19.at.12.44.07.PM.mov

MacOS: Chrome / Safari

Screen.Recording.2023-10-19.at.12.43.24.PM.mov

MacOS: Desktop

https://github.com/Expensify/App/assets/30609178/ee01f410-c980-4eb8-8345-d5f2f12880b8

cloudflare-workers-and-pages · 2023-10-19T19:35:16Z

Deploying with Cloudflare Pages

Latest commit:	`39afd7b`
Status:	✅ Deploy successful!
Preview URL:	https://faf8d1da.helpdot.pages.dev
Branch Preview URL:	https://jack-fixerrorfornewaccounts.helpdot.pages.dev

View logs

melvin-bot · 2023-10-19T19:48:18Z

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

allroundexperts · 2023-10-19T19:49:39Z

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(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 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 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-10-20.at.1.03.16.AM.mov

Mobile Web - Chrome

Screen.Recording.2023-10-20.at.1.19.41.AM.mov

Mobile Web - Safari

Screen.Recording.2023-10-20.at.1.21.15.AM.mov

Desktop

Screen.Recording.2023-10-20.at.1.17.56.AM.mov

iOS

Screen.Recording.2023-10-20.at.1.22.05.AM.mov

Android

Screen.Recording.2023-10-20.at.1.20.24.AM.mov

allroundexperts · 2023-10-19T20:06:53Z

src/pages/iou/steps/MoneyRequstParticipantsPage/MoneyRequestParticipantsSelector.js

+            const selectedParticipantsWithoutDetails = _.filter(participants, (participant) => {
+                const accountID = lodashGet(participant, 'accountID', null);
+                const isPartOfSearchTerm = participant.searchText.toLowerCase().includes(searchTerm.trim().toLowerCase());
+                const isReportInRecentReports = _.some(newChatOptions.recentReports, (report) => report.accountID === accountID);
+                const isReportInPersonalDetails = _.some(newChatOptions.personalDetails, (personalDetail) => personalDetail.accountID === accountID);
+                return isPartOfSearchTerm && !isReportInRecentReports && !isReportInPersonalDetails;
+            });
+
+            newSections.push({
+                title: undefined,
+                data: _.map(selectedParticipantsWithoutDetails, (participant) => {
+                    const isPolicyExpenseChat = lodashGet(participant, 'isPolicyExpenseChat', false);
+                    return isPolicyExpenseChat ? OptionsListUtils.getPolicyExpenseReportOption(participant) : OptionsListUtils.getParticipantsOption(participant, personalDetails);
+                }),
+                shouldShow: !_.isEmpty(selectedParticipantsWithoutDetails),
+                indexOffset,
+            });
+            indexOffset += selectedParticipantsWithoutDetails.length;


Isn't this almost the same as above? If so, it makes sense to move this to a common place.

allroundexperts · 2023-10-19T20:38:33Z

src/pages/NewChatPage.js

-            });
-            indexOffset += selectedParticipantsWithoutDetails.length;
-        }
+        indexOffset = OptionsListUtils.formatSectionsFromSearchTerm(searchTerm, sectionsList, selectedOptions, filteredRecentReports, filteredPersonalDetails, {}, false, indexOffset);


Instead of silently mutating the sectionsList, I think it would be better to return the list along with the index offset. Let me know what you think.

Yeah I was thinking this might be odd just returning the index offset, I can update this

neonbhai · 2023-10-19T20:54:16Z

Hi @thienlnam, contributor here,

Suggestion:

Instead of getting the selected options by passing true here:

App/src/pages/iou/steps/MoneyRequstParticipantsPage/MoneyRequestParticipantsSelector.js

Line 240 in 1bfd5f1

true,

And then in the end filtering from recent report and personal details in this PR,

Why don't we just exclude selected participants from getOptions() and instead search selected participants cleanly:

This would mean:

pass false here:

App/src/pages/iou/steps/MoneyRequstParticipantsPage/MoneyRequestParticipantsSelector.js

Line 240 in 1bfd5f1

true,

search selected participants cleanly:
In the else block for this:

App/src/pages/iou/steps/MoneyRequstParticipantsPage/MoneyRequestParticipantsSelector.js

Line 108 in 1bfd5f1

if (searchTerm === '') {

else {
      // filter logic:
      const searchedParticipants = _.filter(participants, (participant) =>   participant.searchText.toLowerCase().includes(searchTerm.trim().toLowerCase()));
    
      // push the searched participants into the list. We only change data to map searchedParticipants.
      newSections.push({
          title: undefined,
          data: _.map(searchedParticipants, (participant) => {
              const isPolicyExpenseChat = lodashGet(participant, 'isPolicyExpenseChat', false);
              return isPolicyExpenseChat ? OptionsListUtils.getPolicyExpenseReportOption(participant) : OptionsListUtils.getParticipantsOption(participant, personalDetails);
          }),
          shouldShow: true,
          indexOffset,
      });
      indexOffset += searchedParticipants.length;
}

This would keep selected participants on top of list, and they will not be returned by getOptions() so no need to filter.
Also new User to Invite search will work:

Screencast.from.20-10-23.02.17.39.AM.IST.webm

thienlnam · 2023-10-19T21:01:25Z

hmm that's actually a pretty good suggestion, let me implement it rq

thienlnam · 2023-10-19T21:09:04Z

Screen.Recording.2023-10-19.at.2.06.30.PM.mov

I like the idea, though after testing it I'm realizing the only downside(?) is that a selected participant moves from one of the lists to the selected list and it creates this jump when selecting / unselecting

neonbhai · 2023-10-19T21:12:06Z

@thienlnam, this looks like it's because of the header message. We don't want "No results found" when we clearly have results.

We can change this:

App/src/libs/OptionsListUtils.js

Lines 1556 to 1558 in 3b3d3d1

    
           if (hasMatchedParticipant && (isValidEmail || isValidPhone)) { 
        
               return ''; 
        
           }

to

if (hasMatchedParticipant || (isValidEmail || isValidPhone)) {
    return '';
}

and move it above these conditions

thienlnam · 2023-10-19T21:15:11Z

The header message is a separate thing, but I'm more mentioning the bouncing around with search. It's more prominent when you're searching and have more contacts but this is the example

With your changes:

Screen.Recording.2023-10-19.at.2.15.48.PM.mov

Currently:
https://github.com/Expensify/App/assets/30609178/fa33b44d-a0ce-4fa6-ba63-fe894fb66329

thienlnam · 2023-10-19T21:18:36Z

For right now, I think the second feels a bit smoother so let's just continue with that now but once we get more feedback on the UX we can explore different explanations, but thanks for the suggestion!

allroundexperts · 2023-10-19T21:19:36Z

@thienlnam Lint is failing.

thienlnam · 2023-10-19T21:19:57Z

@allroundexperts Just updated hahah ⚡

src/libs/OptionsListUtils.js

allroundexperts

Looks good!

melvin-bot · 2023-10-19T21:43:17Z

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

neonbhai · 2023-10-19T21:51:15Z

I checked out this PR, and am seeing major lag (3-4s) when selecting participants in a high traffic account (large personal details array)

Screencast.from.20-10-23.03.15.33.AM.IST.webm

cc: @allroundexperts @thienlnam

marcochavezf

Code LGTM

marcochavezf · 2023-10-19T21:59:09Z

I checked out this PR, and am seeing major lag (3-4s) when selecting participants in a high traffic account (large personal details array)

I think we can improve the lag in a follow-up PR, I will merge the PR since it's impacting the selection of participants

OSBotify · 2023-10-19T22:05:18Z

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

Fix issue with option disappearing when selected for new contacts (cherry picked from commit 550dbf5)

OSBotify · 2023-10-19T23:01:01Z

🚀 Cherry-picked to staging by https://github.com/francoisl in version: 1.3.87-4 🚀

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

@Expensify/applauseleads please QA this PR and check it off on the deploy checklist if it passes.

OSBotify · 2023-10-20T21:06:52Z

🚀 Deployed to production by https://github.com/francoisl in version: 1.3.87-12 🚀

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

add fix

c6d70dc

thienlnam self-assigned this Oct 19, 2023

thienlnam added 2 commits October 19, 2023 12:38

Add comment to help clarify what is happening

36d67a9

Duplicate changes to New Group

7148df6

thienlnam marked this pull request as ready for review October 19, 2023 19:48

thienlnam requested a review from a team as a code owner October 19, 2023 19:48

melvin-bot bot removed the request for review from a team October 19, 2023 19:48

melvin-bot bot requested a review from abdulrahuman5196 October 19, 2023 19:48

thienlnam requested review from allroundexperts and removed request for abdulrahuman5196 October 19, 2023 19:49

allroundexperts reviewed Oct 19, 2023

View reviewed changes

thienlnam added 4 commits October 19, 2023 13:31

Add new method for formatting sections

f13440e

Replace the money request participants with the method

ba0990f

Replace new chat page with this method

42afc18

prettier

688df15

thienlnam requested a review from allroundexperts October 19, 2023 20:35

allroundexperts reviewed Oct 19, 2023

View reviewed changes

Return more items

89888a7

thienlnam requested a review from allroundexperts October 19, 2023 20:58

fix the throw on newChatPage

fbc9070

allroundexperts reviewed Oct 19, 2023

View reviewed changes

src/libs/OptionsListUtils.js Outdated Show resolved Hide resolved

Remove the unneeded function param

a3d3afb

thienlnam requested a review from allroundexperts October 19, 2023 21:26

allroundexperts reviewed Oct 19, 2023

View reviewed changes

src/libs/OptionsListUtils.js Outdated Show resolved Hide resolved

Clean up the utility method

39afd7b

thienlnam requested a review from allroundexperts October 19, 2023 21:37

allroundexperts approved these changes Oct 19, 2023

View reviewed changes

melvin-bot bot requested a review from marcochavezf October 19, 2023 21:43

marcochavezf approved these changes Oct 19, 2023

View reviewed changes

marcochavezf merged commit 550dbf5 into main Oct 19, 2023

marcochavezf deleted the jack-fixErrorForNewAccounts branch October 19, 2023 21:59

thienlnam mentioned this pull request Oct 19, 2023

Speed up filtering in OptionList #30030

Draft

59 tasks

OSBotify pushed a commit that referenced this pull request Oct 19, 2023

Merge pull request #30017 from Expensify/jack-fixErrorForNewAccounts

705f920

Fix issue with option disappearing when selected for new contacts (cherry picked from commit 550dbf5)

OSBotify mentioned this pull request Oct 19, 2023

Deploy Checklist: New Expensify 2023-10-18 #29926

Closed

64 tasks

melvin-bot bot mentioned this pull request Oct 20, 2023

[HOLD for payment 2023-10-30] [HOLD for payment 2023-10-27] [$500] New user disappears from search results when selected #29917

Closed

6 tasks

Conversation

thienlnam commented Oct 19, 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!

cloudflare-workers-and-pages bot commented Oct 19, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Deploying with Cloudflare Pages

Uh oh!

melvin-bot bot commented Oct 19, 2023

Uh oh!

allroundexperts commented Oct 19, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer Checklist

Screenshots/Videos

Uh oh!

allroundexperts Oct 19, 2023

Choose a reason for hiding this comment

Uh oh!

thienlnam Oct 19, 2023

Choose a reason for hiding this comment

Uh oh!

allroundexperts Oct 19, 2023

Choose a reason for hiding this comment

Uh oh!

thienlnam Oct 19, 2023

Choose a reason for hiding this comment

Uh oh!

neonbhai commented Oct 19, 2023

Suggestion:

Uh oh!

thienlnam commented Oct 19, 2023

Uh oh!

thienlnam commented Oct 19, 2023

Uh oh!

neonbhai commented Oct 19, 2023

Uh oh!

thienlnam commented Oct 19, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

thienlnam commented Oct 19, 2023

Uh oh!

allroundexperts commented Oct 19, 2023

Uh oh!

thienlnam commented Oct 19, 2023

Uh oh!

Uh oh!

Uh oh!

allroundexperts left a comment

Choose a reason for hiding this comment

Uh oh!

melvin-bot bot commented Oct 19, 2023

Uh oh!

neonbhai commented Oct 19, 2023

Uh oh!

marcochavezf left a comment

Choose a reason for hiding this comment

Uh oh!

marcochavezf commented Oct 19, 2023

Uh oh!

OSBotify commented Oct 19, 2023

Uh oh!

OSBotify commented Oct 19, 2023

Uh oh!

OSBotify commented Oct 20, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

thienlnam commented Oct 19, 2023 •

edited

Loading

cloudflare-workers-and-pages bot commented Oct 19, 2023 •

edited

Loading

allroundexperts commented Oct 19, 2023 •

edited

Loading

thienlnam commented Oct 19, 2023 •

edited

Loading