fix: Transaction report shows multiline title for expense with multiline description #42631

nkdengineer · 2024-05-27T09:01:10Z

Details

Fixed Issues

$ #41584
PROPOSAL: #41584 (comment)

Tests

Go to FAB > Submit expense
Submit an expense containing multiline description and no merchant
Click on the search icon
If the transaction report does not show up in Search list, go to transaction thread and edit the description while maintaining multiline format
Verify that: The transaction report in search list will show single line title

Verify that no errors appear in the JS console

Offline tests

QA Steps

Go to FAB > Submit expense
Submit an expense containing multiline description and no merchant
Click on the search icon
If the transaction report does not show up in Search list, go to transaction thread and edit the description while maintaining multiline format
Verify that: The transaction report in search list will show single line title

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Android: Native

android.mov

Android: mWeb Chrome

android-mweb.mov

iOS: Native

ios.mov

iOS: mWeb Safari

ios-mweb.mov

MacOS: Chrome / Safari

web.mov

MacOS: Desktop

desktop.mov

…ine description

melvin-bot · 2024-05-27T09:23:09Z

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

DylanDylann · 2024-05-30T08:12:43Z

src/libs/ReportUtils.ts

@@ -3153,7 +3153,7 @@ function getReportName(report: OnyxEntry<Report>, policy: OnyxEntry<Policy> = nu
            if (isArchivedRoom(report)) {
                formattedName += ` (${Localize.translateLocal('common.archived')})`;
            }
-            return formattedName;
+            return formattedName.replace(/(\r\n|\n|\r)/gm, ' ');


App/src/libs/ReportUtils.ts

Line 3155 in e8ae3c5

return formattedName;

Should we apply the same fix in here?

@nkdengineer Could we use formatReportLastMessageText function instead of replacing manually?

Should we apply the same fix in here?

I think we can apply the same for this to prevent the same bug in the feature.

Could we use formatReportLastMessageText function instead of replacing manually?

Yes we can use this function.

nkdengineer · 2024-05-30T11:36:23Z

@DylanDylann I updated.

nkdengineer · 2024-06-04T03:16:20Z

@DylanDylann Any update here.

DylanDylann · 2024-06-04T07:38:38Z

src/libs/ReportUtils.ts

@@ -3266,7 +3266,7 @@ function getReportName(report: OnyxEntry<Report>, policy: OnyxEntry<Policy> = nu
    }

    if (formattedName) {
-        return formattedName;
+        return formatReportLastMessageText(formattedName);


I am not sure if it is necessary or not, could you explain why we need to update this?

@DylanDylann The update here is to prevent similar bugs in the future if the formattedName variable ever contains a line break.

DylanDylann · 2024-06-04T07:51:29Z

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 UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
- I verified that all the inputs inside a form are aligned with each other.
- I added Design label and/or tagged @Expensify/design 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

MacOS: Desktop

OSBotify · 2024-06-04T11:51:03Z

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

kbecciv · 2024-06-04T20:17:56Z

This PR is failing because of issue #41584

The issue is reproducible in: Web ( QA team is checked on Web for now)

42631.web.mp4

OSBotify · 2024-06-06T12:35:25Z

🚀 Deployed to production by https://github.com/Julesssss in version: 1.4.79-11 🚀

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

fix: Transaction report shows multiline title for expense with multil…

2cc73ac

…ine description

nkdengineer marked this pull request as ready for review May 27, 2024 09:23

nkdengineer requested a review from a team as a code owner May 27, 2024 09:23

melvin-bot bot removed the request for review from a team May 27, 2024 09:23

melvin-bot bot requested a review from DylanDylann May 27, 2024 09:23

nkdengineer mentioned this pull request May 27, 2024

[HOLD for payment 2024-06-13] [$250] Search - Transaction report shows multiline title for expense with multiline description #41584

Closed

6 tasks

DylanDylann reviewed May 30, 2024

View reviewed changes

nkdengineer added 2 commits May 30, 2024 18:33

Merge branch 'main' into fix/41584

61ec11b

use formatReportLastMessageText function

652c8b2

Merge branch 'main' into fix/41584

0490629

DylanDylann reviewed Jun 4, 2024

View reviewed changes

DylanDylann approved these changes Jun 4, 2024

View reviewed changes

melvin-bot bot requested a review from cristipaval June 4, 2024 08:07

cristipaval approved these changes Jun 4, 2024

View reviewed changes

cristipaval merged commit 9705eff into Expensify:main Jun 4, 2024
17 of 19 checks passed

github-actions bot mentioned this pull request Jun 4, 2024

Deploy Checklist: New Expensify 2024-06-04 #43037

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: Transaction report shows multiline title for expense with multiline description #42631

fix: Transaction report shows multiline title for expense with multiline description #42631

nkdengineer commented May 27, 2024

melvin-bot bot commented May 27, 2024

DylanDylann May 30, 2024

DylanDylann May 30, 2024

nkdengineer May 30, 2024

nkdengineer commented May 30, 2024

nkdengineer commented Jun 4, 2024

DylanDylann Jun 4, 2024

nkdengineer Jun 4, 2024

DylanDylann commented Jun 4, 2024 •

edited

Loading

OSBotify commented Jun 4, 2024

kbecciv commented Jun 4, 2024

OSBotify commented Jun 6, 2024

fix: Transaction report shows multiline title for expense with multiline description #42631

fix: Transaction report shows multiline title for expense with multiline description #42631

Conversation

nkdengineer commented May 27, 2024

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented May 27, 2024

DylanDylann May 30, 2024

Choose a reason for hiding this comment

DylanDylann May 30, 2024

Choose a reason for hiding this comment

nkdengineer May 30, 2024

Choose a reason for hiding this comment

nkdengineer commented May 30, 2024

nkdengineer commented Jun 4, 2024

DylanDylann Jun 4, 2024

Choose a reason for hiding this comment

nkdengineer Jun 4, 2024

Choose a reason for hiding this comment

DylanDylann commented Jun 4, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

OSBotify commented Jun 4, 2024

kbecciv commented Jun 4, 2024

OSBotify commented Jun 6, 2024

DylanDylann commented Jun 4, 2024 •

edited

Loading