Skip to content

[Audit][Implementation] use max 5 names to generate Report name - #37907

Merged
deetergp merged 1 commit into
Expensify:mainfrom
callstack-internal:jbroma/perf/report-display-name-slice
Mar 8, 2024
Merged

deetergp merged 1 commit into
Expensify:mainfrom
callstack-internal:jbroma/perf/report-display-name-slice

Conversation

@jbroma

@jbroma jbroma commented Mar 7, 2024 •

Copy link
Copy Markdown
Contributor

Details

PR is a part of Callstack performance audit of the app

In this PR, the number of participants used to determine the Report name via getReportName is limited to first 5 participants other than current user. This change allows to cap the performance impact of getReportName.

In some cases, when the number of participants is big, we were needlessly calculating getDisplayNameForParticipant where in the end, we wouldn't be able to display it since the output is trimmed afterwards anyways.

$ #37925
PROPOSAL: #34494

Tests

  1. Create Group chat with 8 people
  2. Verify the name of the chat is listed from the group participants up to 5 of them without your name
  • Verify that no errors appear in the JS console

Offline tests

QA Steps

Same as tests

  • 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: 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 either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
    • 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
Android: mWeb Chrome
iOS: Native
iOS: mWeb Safari
MacOS: Chrome / Safari Screenshot 2024-03-07 at 17 47 08
MacOS: Desktop

@jbroma
jbroma marked this pull request as ready for review March 8, 2024 09:53
@jbroma
jbroma requested a review from a team as a code owner March 8, 2024 09:53
@melvin-bot
melvin-bot Bot requested review from deetergp and removed request for a team March 8, 2024 09:53
@melvin-bot

melvin-bot Bot commented Mar 8, 2024

Copy link
Copy Markdown

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

@mountiny
mountiny requested a review from mollfpr March 8, 2024 11:03
Comment thread src/libs/ReportUtils.ts
// Not a room or PolicyExpenseChat, generate title from participants
const participantAccountIDs = report?.participantAccountIDs ?? [];
// Not a room or PolicyExpenseChat, generate title from first 5 other participants
const participantAccountIDs = report?.participantAccountIDs?.slice(0, 6) ?? [];

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Are we sure the current user is going to be returned in the first six results?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I have the same thoughts, but looking and the next line, we filter out the current user accountID and pop the rest if it's still six accountIDs.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Fair point. I was only looking at the changed code. Still wouldn't it be cleaner/easier if we took a slice of paricipantsWithoutCurrentUser to make this?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Sorry guys for this delay, just to clarify: this PR was only intended to improve the performance - on big accounts the .filter() loop simply took ages and looping through all these items is redundant from the product perspective (please see the pinned proposal and investigation). Hope this helps :)

@mollfpr

mollfpr commented Mar 8, 2024 •

Copy link
Copy Markdown
Contributor

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 either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
    • 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
37907.Android.mp4
Android: mWeb Chrome
37907.mWeb-Chrome.mp4
iOS: Native
37907.iOS.mov
iOS: mWeb Safari
37907.mWeb-Safari.mov
MacOS: Chrome / Safari
37907.mWeb-Chrome.mp4
MacOS: Desktop
37907.Desktop.mp4

@mollfpr mollfpr left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM 👍

For the test steps and QA steps, I have suggestion to get easier notice the changes this PR made. Instead of verifying the list in LHN, we can verify it in the display name in the search list or in the report detail page.

@melvin-bot

melvin-bot Bot commented Mar 8, 2024

Copy link
Copy Markdown

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

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

@deetergp

Copy link
Copy Markdown
Contributor

This is a little too little and a little too late, but this PR did not fix the problem. @jbroma your tests had display names that were so long the title was truncated after the first four. And @mollfpr it was obvious in your desktop tests it wasn't fixed: 8 names are shown.

@deetergp

Copy link
Copy Markdown
Contributor

Regression here #38052

@dragnoir

Copy link
Copy Markdown
Contributor

@deetergp The problem is that

1- here

const title = ReportUtils.isGroupChat(report) ? getGroupChatName(report) : ReportUtils.getReportName(reportHeaderData);

When we ask for the title , ReportUtils.isGroupChat(props.report) turns true then we get the title value from getGroupChatName(props.report) and not from ReportUtils.getReportName(reportHeaderData) . Unfortunately all the updates on this PR are only on getReportName

2- Even if we fix the issue mentioned on (1), on a group of chat with 8 participants, the component HeaderView will not use title to display the names.

We are getting the list to be displayed from here:

const displayNamesWithTooltips = ReportUtils.getDisplayNamesWithTooltips(participantPersonalDetails, isMultipleParticipant, undefined, isSelfDM);

and this will be a prop for the DisplayNamesWithToolTip component.

Back to the issue of this PR:

In some cases, when the number of participants is big, we were needlessly calculating getDisplayNameForParticipant where in the end, we wouldn't be able to display it since the output is trimmed afterwards anyways

As I understand, we are fixing getReportName by limiting the number of participants to 5 so we can limit the call to the function getDisplayNameForParticipant .

Note: getDisplayNameForParticipant is using getPersonalDetailsForAccountID to get the user details (wish I think is part of the bad performance)

After this quick analysis, I can said that we are limiting the call to getPersonalDetailsForAccountID from 8 to 5 for a better performance.

Issue not fixed and persist somewhere else:

As I mentioned above, we are fixing getReportName but we are not calling it (no limit to 5, no performance). Beside that, the HeaderView component is calling getPersonalDetailsForAccountID 8 times (the issue we are trying to solve is again on HeaderView) here

const participantPersonalDetails = OptionsListUtils.getPersonalDetailsForAccountIDs(participants, personalDetails);

For that, solving this issue and enhancing performance, I am suggesting limiting the number of participants here

const participants = isSelfDM ? [session?.accountID ?? -1] : report?.participantAccountIDs ?? [];

in my proposal

This way, we limit the display to just 5 participants and we call the function getPersonalDetailsForAccountID just 5 times.

@mollfpr

mollfpr commented Mar 12, 2024

Copy link
Copy Markdown
Contributor

@deetergp This PR doesn't fix the issue #38052 in the first place, but instead, this is an improvement on the performance.

@OSBotify

Copy link
Copy Markdown
Contributor

🚀 Deployed to production by https://github.com/luacmartins in version: 1.4.50-5 🚀

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

@deetergp

Copy link
Copy Markdown
Contributor

I'm confused here @mollfpr @jbroma. This PR's description says:

In this PR, the number of participants used to determine the Report name via getReportName is limited to first 5 participants other than current user. This change allows to cap the performance impact of getReportName.

Yet as it turns out, that is not what is happening. Despite these changes, we are still seeing more than five names in the report title. Am I missing something here? I think we need to treat this as a regression and fix it.

@jbroma

jbroma commented Mar 13, 2024

Copy link
Copy Markdown
Contributor Author

@deetergp,

this PR was limited to just fixing performance aspect of the fallback name used as last resort, by the looks of it we might apply the same logic in getAdminRoomInvitedParticipants which also constructs name from participants username - but that case wasn't that common during performance audit, so it never surfaced.

@Pujan92

Pujan92 commented Mar 15, 2024 •

Copy link
Copy Markdown
Contributor

@jbroma @mollfpr @deetergp To confirm, the ellipsis tooltip also shows max 5 names and seems the user can't see all names in tooltip. Is that fine?

Screen.Recording.2024-03-15.at.15.24.38.mov

In some cases, when the number of participants is big, we were needlessly calculating getDisplayNameForParticipant where in the end, we wouldn't be able to display it since the output is trimmed afterwards anyways.

But we show in the tooltip earlier which might be useful for the users.

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