Fix/33760 doubled display name on search page #33966

koko57 · 2024-01-04T17:14:24Z

Details

Fixed Issues

$ #33760

Tests

[User A] Request money from User B.
[User B] Pay the request.
[User A] Click on the IOU preview to open IOU report.
[User A] Click Search icon.
Verify that the payer's name [Payer:] is not doubled in the preview in Search list.

Verify that no errors appear in the JS console

Offline tests

n/a

QA Steps

[User A] Request money from User B.
[User B] Pay the request.
[User A] Click on the IOU preview to open IOU report.
[User A] Click Search icon.
Verify that the payer's name [Payer:] is not doubled in the preview in Search list.

Verify that no errors appear in the JS console

PR Author Checklist

I linked the correct issue in the ### Fixed Issues section above
I wrote clear testing steps that cover the changes made in this PR
- I added steps for local testing in the Tests section
- I added steps for the expected offline behavior in the Offline steps section
- I added steps for Staging and/or Production testing in the QA steps section
- I added steps to cover failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
- I turned off my network connection and tested it while offline to ensure it matches the expected behavior (i.e. verify the default avatar icon is displayed if app is offline)
- I tested this PR with a High Traffic account against the staging or production API to ensure there are no regressions (e.g. long loading states that impact usability).
I included screenshots or videos for tests on all platforms
I ran the tests on all platforms & verified they passed on:
- Android / native
- Android / Chrome
- iOS / native
- iOS / Safari
- MacOS / Chrome / Safari
- MacOS / Desktop
I verified there are no console errors (if there's a console error not related to the PR, report it or open an issue for it to be fixed)
I followed proper code patterns (see Reviewing the code)
- I verified that any callback methods that were added or modified are named for what the method does and never what callback they handle (i.e. toggleReport and not onIconClick)
- I verified that the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
- I verified that comments were added to code that is not self explanatory
- I verified that any new or modified comments were clear, correct English, and explained "why" the code was doing something instead of only explaining "what" the code was doing.
- I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
  - If any non-english text was added/modified, I verified the translation was requested/reviewed in #expensify-open-source and it was approved by an internal Expensify engineer. Link to Slack message:
- I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
- I verified any copy / text that was added to the app is grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is approved by marketing by adding the Waiting for Copy label for a copy review on the original GH to get the correct copy.
- I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named "index.js". All platform-specific files are named for the platform the code supports as outlined in the README.
- I verified the JSDocs style guidelines (in STYLE.md) were followed
If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
I followed the guidelines as stated in the Review Guidelines
I tested other components that can be impacted by my changes (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar are working as expected)
I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
I verified any variables that can be defined as constants (ie. in CONST.js or at the top of the file that uses the constant) are defined as such
I verified that if a function's arguments changed that all usages have also been updated correctly
If a new component is created I verified that:
- A similar component doesn't exist in the codebase
- All props are defined accurately and each prop has a /** comment above it */
- The file is named correctly
- The component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone
- The only data being stored in the state is data necessary for rendering and nothing else
- 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
  - 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 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 author checklist, including those that don't apply to this PR.

Screenshots/Videos

Android: Native

n/a

Android: mWeb Chrome

n/a

iOS: Native

n/a

iOS: mWeb Safari

n/a

MacOS: Chrome / Safari

MacOS: Desktop

melvin-bot · 2024-01-04T17:15:05Z

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

situchan · 2024-01-04T17:19:39Z

Does this require C+ review?

src/libs/OptionsListUtils.js

koko57 · 2024-01-08T11:36:58Z

@situchan @mountiny ready for review 🙂

situchan · 2024-01-08T11:57:06Z

reviewing

paultsimura · 2024-01-08T12:51:48Z

Hey, just a heads up: there is a PR I was working on – it's already approved, and I think this PR will break it, as we were accounting for the lastMessageText to contain the lastActorDisplayName (current behavior in main).
What should be the process to align these 2 PRs together?

situchan · 2024-01-08T13:11:33Z

src/libs/OptionsListUtils.js

+        const shouldDisplayLastActorName = lastAction && lastAction.actionName !== CONST.REPORT.ACTIONS.TYPE.REPORTPREVIEW && lastAction.actionName !== CONST.REPORT.ACTIONS.TYPE.IOU;
+
+        if (shouldDisplayLastActorName && lastActorDisplayName && lastMessageTextFromReport) {
+            lastMessageText = `${lastActorDisplayName}: ${lastMessageTextFromReport}`;


Let's define util function whether to add prefix or not and use it in both here and SidebarUtils

App/src/libs/SidebarUtils.ts

Lines 401 to 402 in 3ee24ec

} else if (lastAction?.actionName !== CONST.REPORT.ACTIONS.TYPE.REPORTPREVIEW && lastActorDisplayName && lastMessageTextFromReport) {

result.alternateText = `${lastActorDisplayName}: ${lastMessageText}`;

We should make alternateText consistent between LHN and search page.

situchan · 2024-01-08T13:15:38Z

src/libs/OptionsListUtils.js

+                reportAction.actionName !== CONST.REPORT.ACTIONS.TYPE.CREATED &&
+                reportAction.pendingAction !== CONST.RED_BRICK_ROAD_PENDING_ACTION.DELETE,
+        );
+        visibleReportActionItems[reportID] = reportActionsForDisplay[reportActionsForDisplay.length - 1];


This code is also duplicated with SidebarUtils.
Let's try to avoid duplication as much as possible

yes, but I think that the whole code for generating could be extracted to a separate function - we would not need a separate function for getting lastActorDisplayName then. I even wanted to do this in this PR, but it's a lot of changes, so I wanted to fix the issue this way, then take care of this refactor in a follow-up. Let me know what you think about that cc @mountiny

In this case I agree to handle this in a follow up PR to get the fix in and limit chances of regressions. Will you handle the follow up @koko57 ?

yeah, of course! 😊

koko57 · 2024-01-08T15:08:14Z

@paultsimura

Hey, just a heads up: there is a PR I was working on – it's already approved, and I think this PR will break it, as we were accounting for the lastMessageText to contain the lastActorDisplayName (current behavior in main). What should be the process to align these 2 PRs together?

My latest changes kind of restore the previous logic excluding only IOUs and report previews. Tested with your change - it works fine

mountiny · 2024-01-09T14:07:34Z

Making a build for a quick test

github-actions · 2024-01-09T14:29:59Z

🧪🧪 Use the links below to test this adhoc build on Android, iOS, Desktop, and Web. Happy testing! 🧪🧪

Android 🤖	iOS 🍎
https://ad-hoc-expensify-cash.s3.amazonaws.com/android/33966/index.html	https://ad-hoc-expensify-cash.s3.amazonaws.com/ios/33966/index.html

Desktop 💻	Web 🕸️
https://ad-hoc-expensify-cash.s3.amazonaws.com/desktop/33966/NewExpensify.dmg	https://33966.pr-testing.expensify.com

👀 View the workflow run that generated this build 👀

situchan · 2024-01-09T15:03:25Z

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: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

web.mov

MacOS: Desktop

mountiny

Thank you tests well!

OSBotify · 2024-01-09T22: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.

OSBotify · 2024-01-10T06:21:11Z

🚀 Deployed to staging by https://github.com/mountiny in version: 1.4.24-0 🚀

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

OSBotify · 2024-01-11T08:52:51Z

🚀 Deployed to production by https://github.com/thienlnam in version: 1.4.24-3 🚀

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

koko57 added 3 commits January 3, 2024 09:41

fix: remove doubled name for IOUs previews in SearchPage

16b3280

fix: resolve conflicts

2a924ae

Merge branch 'main' into fix/33760-doubled-displayName-on-searchPage

6eff84d

koko57 marked this pull request as ready for review January 4, 2024 17:14

koko57 requested a review from a team as a code owner January 4, 2024 17:14

melvin-bot bot requested review from madmax330 and removed request for a team January 4, 2024 17:15

koko57 mentioned this pull request Jan 4, 2024

[$500] [HOLD for payment 2024-01-18] Web - Double <Payer:> for IOU report preview in Search #33760

Closed

6 tasks

paultsimura reviewed Jan 4, 2024

View reviewed changes

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

paultsimura reviewed Jan 4, 2024

View reviewed changes

src/libs/OptionsListUtils.js Show resolved Hide resolved

fix: restore getDisplayNameOrDefault

11e24a3

mountiny assigned koko57 Jan 5, 2024

mountiny requested review from mountiny and situchan January 5, 2024 18:09

koko57 added 3 commits January 8, 2024 09:21

Merge branch 'main' into fix/33760-doubled-displayName-on-searchPage

a3f2abc

fix: display actor name for threads

37e83cd

fix: run prettier

4b985db

situchan reviewed Jan 8, 2024

View reviewed changes

mountiny added the Ready To Build label Jan 9, 2024

situchan approved these changes Jan 9, 2024

View reviewed changes

mountiny approved these changes Jan 9, 2024

View reviewed changes

mountiny merged commit 3810e65 into Expensify:main Jan 9, 2024
16 of 21 checks passed

github-actions bot mentioned this pull request Jan 10, 2024

Deploy Checklist: New Expensify 2024-01-10 #34203

Closed

54 tasks

koko57 mentioned this pull request Jan 11, 2024

[Awaiting C+ payment confo] Fix issues with the LHN previews and report actions surrounding iou/expenseReports when owed and paid. #30042

Closed

6 tasks

koko57 mentioned this pull request Jan 12, 2024

[HOLD for payment 2024-03-13] [MEDIUM] Follow-ups to the LHN previews #34411

Closed

6 tasks

mountiny mentioned this pull request Mar 13, 2024

[Clean-up] Unify the logic for getting alternateText for getOptions and getOptionData #38220

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix/33760 doubled display name on search page #33966

Fix/33760 doubled display name on search page #33966

koko57 commented Jan 4, 2024 •

edited by mountiny

Loading

melvin-bot bot commented Jan 4, 2024

situchan commented Jan 4, 2024

koko57 commented Jan 8, 2024

situchan commented Jan 8, 2024

paultsimura commented Jan 8, 2024

situchan Jan 8, 2024 •

edited

Loading

situchan Jan 8, 2024

koko57 Jan 8, 2024

mountiny Jan 9, 2024

koko57 Jan 9, 2024

koko57 commented Jan 8, 2024

mountiny commented Jan 9, 2024

github-actions bot commented Jan 9, 2024

situchan commented Jan 9, 2024

mountiny left a comment

OSBotify commented Jan 9, 2024

OSBotify commented Jan 10, 2024

OSBotify commented Jan 11, 2024

	} else if (lastAction?.actionName !== CONST.REPORT.ACTIONS.TYPE.REPORTPREVIEW && lastActorDisplayName && lastMessageTextFromReport) {
	result.alternateText = `${lastActorDisplayName}: ${lastMessageText}`;

Fix/33760 doubled display name on search page #33966

Fix/33760 doubled display name on search page #33966

Conversation

koko57 commented Jan 4, 2024 • edited by mountiny Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Jan 4, 2024

situchan commented Jan 4, 2024

koko57 commented Jan 8, 2024

situchan commented Jan 8, 2024

paultsimura commented Jan 8, 2024

situchan Jan 8, 2024 • edited Loading

Choose a reason for hiding this comment

situchan Jan 8, 2024

Choose a reason for hiding this comment

koko57 Jan 8, 2024

Choose a reason for hiding this comment

mountiny Jan 9, 2024

Choose a reason for hiding this comment

koko57 Jan 9, 2024

Choose a reason for hiding this comment

koko57 commented Jan 8, 2024

mountiny commented Jan 9, 2024

github-actions bot commented Jan 9, 2024

situchan commented Jan 9, 2024

Reviewer Checklist

Screenshots/Videos

mountiny left a comment

Choose a reason for hiding this comment

OSBotify commented Jan 9, 2024

OSBotify commented Jan 10, 2024

OSBotify commented Jan 11, 2024

koko57 commented Jan 4, 2024 •

edited by mountiny

Loading

situchan Jan 8, 2024 •

edited

Loading