Skip to content

[Better Expense Report View] Add messages count ChatBubble to MoneyRequestReportView rows#58626

Merged
mountiny merged 13 commits into
Expensify:mainfrom
software-mansion-labs:korytko/comments-in-money-request-report-view
Mar 21, 2025
Merged

[Better Expense Report View] Add messages count ChatBubble to MoneyRequestReportView rows#58626
mountiny merged 13 commits into
Expensify:mainfrom
software-mansion-labs:korytko/comments-in-money-request-report-view

Conversation

@JakubKorytko
Copy link
Copy Markdown
Contributor

@JakubKorytko JakubKorytko commented Mar 18, 2025

Explanation of Change

This PR extends PR 58360 by adding a ChatBubble column that displays the total number of messages and whether the thread has been read recently; its background color is green or the default theme.

Things to note:

  1. This PR needs to be merged after 58360.
  2. This is not a reactive component in terms of re-rendering on message count change - and I don't think it should be, it should re-render based on row updates (parent component) to avoid additional re-renders.
  3. Column spacing is slightly off because there is no checkbox at the moment, so padding-left is wrong, but this padding issue will be fixed in the 58360. This will cause this PR to fix gaps completely.

Fixed Issues

$ #57508
PROPOSAL: N/A

Tests

Important: in order to test change function canUseTableReportView to return true, or have BETA tableReportView set

  1. Open Search, go to Expense Reports
  2. Click on any report
  3. Verify that the number of messages for each report is correct and that unread treads have a green background.

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 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 used JaimeGPT to get English > Spanish translation. I then posted it 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.ts 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 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.
  • I added unit tests for any new feature or bug fix in this PR to help automatically prevent regressions in this user flow.
  • 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

Android-Web

iOS: Native
iOS: mWeb Safari

iOS-Web

MacOS: Chrome / Safari

Web

MacOS: Desktop

@JakubKorytko JakubKorytko changed the title [WIP] [Better Expense Report View] Add messages count ChatBubble to MoneyRequestReportView rows [Better Expense Report View] Add messages count ChatBubble to MoneyRequestReportView rows Mar 18, 2025
@JakubKorytko
Copy link
Copy Markdown
Contributor Author

Waiting for 58360 to be merged.

@JakubKorytko JakubKorytko marked this pull request as ready for review March 19, 2025 18:43
@JakubKorytko JakubKorytko requested review from a team as code owners March 19, 2025 18:43
@melvin-bot melvin-bot Bot removed the request for review from a team March 19, 2025 18:43
@melvin-bot
Copy link
Copy Markdown

melvin-bot Bot commented Mar 19, 2025

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

@github-actions
Copy link
Copy Markdown
Contributor

🚧 @mountiny has triggered a test app build. You can view the workflow run here.

Comment thread src/components/MoneyRequestReportView/MoneyRequestReportTransactionList.tsx Outdated
Comment thread src/components/TransactionItemRow/DataCells/ChatBubbleCell.tsx Outdated
Comment thread src/components/TransactionItemRow/DataCells/ChatBubbleCell.tsx Outdated
Comment thread src/components/TransactionItemRow/DataCells/ChatBubbleCell.tsx Outdated
Comment thread src/styles/index.ts Outdated
Comment thread src/styles/index.ts Outdated
@shawnborton
Copy link
Copy Markdown
Contributor

Left you some design comments, let's try to align this with our mockups please - thanks!

@github-actions
Copy link
Copy Markdown
Contributor

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

Android 🤖 iOS 🍎
❌ FAILED ❌ ❌ FAILED ❌
The QR code can't be generated, because the Android build failed The QR code can't be generated, because the iOS build failed
Android Hybrid 🤖🔄 iOS Hybrid 🍎🔄
https://ad-hoc-expensify-cash.s3.amazonaws.com/android/58626-hybrid/index.html https://ad-hoc-expensify-cash.s3.amazonaws.com/ios/58626-hybrid/index.html
Android Hybrid iOS Hybrid
Desktop 💻 Web 🕸️
https://ad-hoc-expensify-cash.s3.amazonaws.com/desktop/58626/NewExpensify.dmg https://58626.pr-testing.expensify.com
Desktop Web

👀 View the workflow run that generated this build 👀

@mountiny
Copy link
Copy Markdown
Contributor

image

testing on the adhoc build definitely feels slower than on staging - might need to also focus on performance once we clean up the logic and design cc @Kicu

Comment thread src/components/TransactionItemRow/DataCells/ChatBubbleCell.tsx Outdated
Comment thread src/components/TransactionItemRow/DataCells/ChatBubbleCell.tsx Outdated
Comment thread src/components/TransactionItemRow/DataCells/ChatBubbleCell.tsx Outdated
Comment thread src/components/TransactionItemRow/DataCells/ChatBubbleCell.tsx Outdated
Comment thread src/components/TransactionItemRow/DataCells/ChatBubbleCell.tsx Outdated
Comment thread src/components/TransactionItemRow/index.tsx Outdated
Comment thread src/styles/index.ts Outdated
@Kicu
Copy link
Copy Markdown
Contributor

Kicu commented Mar 20, 2025

@mountiny

might need to also focus on performance once we clean up the logic and design

Thanks for pointing out. Though I did want to focus on performance from the get go, that's why I decided to create a fresh component and copy things from ReportScreen VS adding a bunch of new flags to already heavy ReportScreen :| I had hoped this will make the whole thing faster.
I will keep performance in mind and we'll circle back to this.

containerStyles={[styles.ml3, styles.mt0, styles.mb2]}
transaction={transactionItem}
/>
{hasCategoryOrTag && (
Copy link
Copy Markdown
Contributor

@DylanDylann DylanDylann Mar 20, 2025

Choose a reason for hiding this comment

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

In the wide screen, for displaying category, tag, error, chat bubble, I suggest we should split it into two column first

<View style={[styles.flexColumn ,....>
       <View style={[styles.flexRow ,....>
                  ...... Displaying Category, Tag
       </View>
       <View>
                  ...... Chat bubble
       </View>
</View>

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.

This will be more readable and avoid duplicated code as I think. Please correct me If I missed anything

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.

@JakubKorytko What do you think about my suggestion here?

@JakubKorytko
Copy link
Copy Markdown
Contributor Author

Thanks for the comments, I've addressed them all.
I tried my best to improve performance on my changes, reduced the code of calculating message count and its data by about 80% and memorized it since it is the only relevant function on this PR in terms of performance.

However, I am not sure about 1 particular style that is line height. In the figma, the line height is really specific (11.6 for mobile, 12 for web/desktop), and I couldn't find it anywhere in the code. I've done it this way:

const elementSize = shouldUseNarrowLayout ? variables.iconSizeSmall : variables.iconSizeNormal;
const fontSize = shouldUseNarrowLayout ? variables.fontSizeXXSmall : variables.fontSizeExtraSmall;
const lineHeight = shouldUseNarrowLayout ? 11.6 : 12;
return (
threadMessages.count > 0 && (
<View style={[styles.dFlex, styles.alignItemsCenter, styles.justifyContentCenter, styles.textAlignCenter, StyleUtils.getWidthAndHeightStyle(elementSize)]}>
<Icon
src={ChatBubbleCounter}
additionalStyles={styles.pAbsolute}
fill={threadMessages.isUnread ? theme.iconMenu : theme.icon}
width={elementSize}
height={elementSize}
/>
<Text style={[styles.textBold, StyleUtils.getLineHeightStyle(lineHeight), StyleUtils.getColorStyle(theme.appBG), StyleUtils.getFontSizeStyle(fontSize)]}>
{threadMessages.count}
</Text>
</View>
)
);
}

Please, let me know if you want me to add 2 new variables to styles, set it to similar existing value or leave it as it is.

@luacmartins
Copy link
Copy Markdown
Contributor

@JakubKorytko I think we'd just use variables.lineHeightXSmall in that case. @shawnborton or @dannymcclain can you confirm?

@DylanDylann
Copy link
Copy Markdown
Contributor

Just DM @JakubKorytko to discuss about #58626 (comment). Waiting for him to update it

Copy link
Copy Markdown
Contributor

@luacmartins luacmartins left a comment

Choose a reason for hiding this comment

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

Additionally, the columns are still misaligned a few pixels
Screenshot 2025-03-20 at 12 53 14 PM

Comment on lines +39 to +40
nextToRBR: shouldShowChatBubbleComponent && !hasCategoryOrTag,
nextToCategoryOrTag: shouldShowChatBubbleComponent && hasCategoryOrTag,
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.

Why do we need this object? Shouldn't we always show it near the end of the row, next to the total?

@dannymcclain
Copy link
Copy Markdown
Contributor

However, I am not sure about 1 particular style that is line height. In the figma, the line height is really specific (11.6 for mobile, 12 for web/desktop), and I couldn't find it anywhere in the code. I've done it this way:

I think we'd just use variables.lineHeightXSmall in that case. @shawnborton or @dannymcclain can you confirm?

Yes the line-height can be 12 everywhere. I think that weird specific value (11.6) just came from scaling the type. No need to accommodate that value.

@shawnborton
Copy link
Copy Markdown
Contributor

Yup, totally agree with that. The real important thing here is that the text is just perfectly vertically centered within the box. The line height technically shouldn't matter too much (we could literally make it just 1) but I think using 12 for both is fine.

@DylanDylann
Copy link
Copy Markdown
Contributor

DylanDylann commented Mar 21, 2025

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 Screenshot 2025-03-22 at 00 24 56
Android: mWeb Chrome Screenshot 2025-03-22 at 00 22 31
iOS: Native Screenshot 2025-03-22 at 00 22 02
iOS: mWeb Safari Screenshot 2025-03-22 at 00 15 49
MacOS: Chrome / Safari Screenshot 2025-03-22 at 00 14 58
MacOS: Desktop Screenshot 2025-03-22 at 00 15 13

@melvin-bot melvin-bot Bot requested a review from mountiny March 21, 2025 17:25
Copy link
Copy Markdown
Contributor

@luacmartins luacmartins left a comment

Choose a reason for hiding this comment

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

The changes in this PR look good. A couple of things that we want to align on in a follow up:

  1. The receipt background color is incorrect
    Correct one:
    Screenshot 2025-03-21 at 11 29 09 AM

This PR
Screenshot 2025-03-21 at 11 29 37 AM

  1. The padding on the row is incorrect
    Correct

Screenshot 2025-03-21 at 11 29 14 AM

This PR
Screenshot 2025-03-21 at 11 29 31 AM

Copy link
Copy Markdown
Contributor

@mountiny mountiny left a comment

Choose a reason for hiding this comment

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

Agreed on the feedback, but great to move this ahead!

@mountiny mountiny merged commit 01ea794 into Expensify:main Mar 21, 2025
@OSBotify
Copy link
Copy Markdown
Contributor

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

@github-actions
Copy link
Copy Markdown
Contributor

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

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

@github-actions
Copy link
Copy Markdown
Contributor

🚀 Deployed to production by https://github.com/cristipaval in version: 9.1.17-1 🚀

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

8 participants