Skip to content

Fix isOneTransactionReport#64734

Closed
JakubKorytko wants to merge 9 commits intoExpensify:mainfrom
software-mansion-labs:korytko/fix-isOneTransactionReport
Closed

Fix isOneTransactionReport#64734
JakubKorytko wants to merge 9 commits intoExpensify:mainfrom
software-mansion-labs:korytko/fix-isOneTransactionReport

Conversation

@JakubKorytko
Copy link
Contributor

@JakubKorytko JakubKorytko commented Jun 23, 2025

Explanation of Change

The function getOneTransactionThreadReportID never returns null; it always returns undefined. Therefore, isOneTransactionReport always returns true.

What has been done:

  • ReportUtilsGetIconsTest was brought back and corrected.
  • Fixed EnforceActionExportRestrictions.
  • isOneTransactionReport return value was corrected.

As this is a refractor of a helper method that is used in other report functions, it is difficult to specify the exact test steps and videos. However, I don't think it should be marked as 'no QA', so I indicated the areas of the app that are most affected in the tests section.

Fixed Issues

$ #64333
PROPOSAL: N/A

Tests

  1. Open Expensify App
  2. Open any DM's in the domain
  3. Enter the report with only one transaction
  4. Verify that in the header you see only one avatar
  5. Open any other report in DM's with more than 1 transaction
  6. Verify that you can see both users avatars
  7. Go to any workspace
  8. Open report with only one expense
  9. Verify that you see the simplified version of the icons in the header (workspace icon is smaller than the user avatar)
  10. Open other report with more than one expense
  11. Verify that workspace icon and user avatar in the header are the same size

Offline tests

Same as tests

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
iOS: Native
iOS: mWeb Safari
MacOS: Chrome / Safari
MacOS: Desktop

@JakubKorytko JakubKorytko force-pushed the korytko/fix-isOneTransactionReport branch from 6fb7b67 to a7eada7 Compare June 23, 2025 11:30
@JakubKorytko JakubKorytko changed the title [WIP] Fix isOneTransactionReport Fix isOneTransactionReport Jun 24, 2025
@JakubKorytko JakubKorytko marked this pull request as ready for review June 24, 2025 08:58
@JakubKorytko JakubKorytko requested a review from a team as a code owner June 24, 2025 08:58
@melvin-bot melvin-bot bot requested review from allroundexperts and removed request for a team June 24, 2025 08:58
@melvin-bot
Copy link

melvin-bot bot commented Jun 24, 2025

@allroundexperts 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
Copy link
Contributor

allroundexperts commented Jun 24, 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 that the composer does not automatically focus or open the keyboard on mobile unless explicitly intended. This includes checking that returning the app from the background does not unexpectedly open the keyboard.
  • I verified tests pass on all platforms & I tested again on:
    • Android: HybridApp
    • Android: mWeb Chrome
    • iOS: HybridApp
    • 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 there are no new alerts related to the canBeMissing param for useOnyx
  • 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 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.ts 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.
  • For any bug fix or new feature in this PR, I verified that sufficient unit tests are included to prevent regressions in this 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.
  • I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

Screenshots/Videos

Android: HybridApp

Unable to build android

Android: mWeb Chrome
Screen.Recording.2025-06-29.at.3.46.26.AM.mov
iOS: HybridApp
Screen.Recording.2025-06-29.at.3.42.06.AM.mov
iOS: mWeb Safari
Screen.Recording.2025-06-29.at.3.40.20.AM.mov
MacOS: Chrome / Safari
Screen.Recording.2025-06-29.at.3.35.06.AM.mov
MacOS: Desktop
Screen.Recording.2025-06-29.at.3.37.29.AM.mov

@allroundexperts
Copy link
Contributor

Verify that if a report contains only one expense and the expense should be paid later, either at checkout for hotels or drop off for car rental, user shouldn't be allowed to approve nor pay such report (canApproveIOU, canIOUBePaid -> isPayAtEndExpenseReport)

@JakubKorytko This seems to be failing. I created an expense in the future as an employee, and am still able to approve and pay it as a admin.

Screen.Recording.2025-06-25.at.5.09.12.AM.mov

@JakubKorytko
Copy link
Contributor Author

@allroundexperts I believe this only applies to hotel and car rental reservations.

either at checkout for hotels or drop off for car rental

/**
* Whether an expense is going to be paid later, either at checkout for hotels or drop off for car rental
*/
function isPayAtEndExpense(transaction: Transaction | undefined | null): boolean {
return !!transaction?.receipt?.reservationList?.some((reservation) => reservation.paymentType === 'PAY_AT_HOTEL' || reservation.paymentType === 'PAY_AT_VENDOR');
}

@allroundexperts
Copy link
Contributor

@JakubKorytko On each platform, when you open the single transaction report, it initially shows two icons, and after the transaction gets loaded, it shows the correct number of icons.

Screen.Recording.2025-06-29.at.3.46.26.AM.mov

@JakubKorytko
Copy link
Contributor Author

On each platform, when you open the single transaction report, it initially shows two icons, and after the transaction gets loaded, it shows the correct number of icons.

@allroundexperts I know this might seem wrong, but I can't think of any other way to get the avatar count when the data hasn't loaded yet.
Should there be one avatar by default? Or two? Should there be a placeholder of any kind? I don't think it's that bad as it is right now, but I'll cc @Expensify/design in for their opinion on this.

You can check on the staging to see that the icon hasn't changed at all because the code was incorrect.

@shawnborton
Copy link
Contributor

The diagonal avatar/2 avatar case is typically the edge case - it ONLY happens when an IOU report has expenses from two separate people. I would prefer we default to a single avatar in the loading state if we can.

@JakubKorytko
Copy link
Contributor Author

JakubKorytko commented Jun 30, 2025

@shawnborton Sorry, I used the wrong terminology. This isn't the same issue. It's not a case of two versus one avatar, but rather the user avatar being in a subscript.

There is a difference here. So, should the user avatar be in a subscript by default or not?
Currently on the staging this logic doesn't seem to work at all so I fixed it but as @allroundexperts mentioned, it has to have transaction loaded.

@shawnborton
Copy link
Contributor

CleanShot 2025-06-30 at 10 48 42@2x

I don't think there is any real case where we would show a diagonal avatar that has a user and a workspace. So yeah, subscript by default makes the most sense here.

Copy link
Contributor

@allroundexperts allroundexperts left a comment

Choose a reason for hiding this comment

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

Works good!

@melvin-bot melvin-bot bot requested a review from grgia June 30, 2025 08:55
@JakubKorytko
Copy link
Contributor Author

I don't think there is any real case where we would show a diagonal avatar that has a user and a workspace.

A little suprised by that, it probably didn't work for a while but in the code actually we want to show this type of avatar on every report that is not a single transaction report view. Line 8812 below:

App/src/libs/ReportUtils.ts

Lines 8789 to 8830 in af6db62

/**
* Show subscript on expense chats / threads and expense requests
*/
function shouldReportShowSubscript(report: OnyxEntry<Report>): boolean {
// This will get removed as part of https://github.com/Expensify/App/issues/59961
// eslint-disable-next-line deprecation/deprecation
if (isArchivedNonExpenseReport(report, !!getReportNameValuePairs(report?.reportID)?.private_isArchived) && !isWorkspaceThread(report)) {
return false;
}
if (isPolicyExpenseChat(report) && !isChatThread(report) && !isTaskReport(report) && !report?.isOwnPolicyExpenseChat) {
return true;
}
if (isPolicyExpenseChat(report) && !isThread(report) && !isTaskReport(report)) {
return true;
}
if (isExpenseRequest(report)) {
return true;
}
if (isExpenseReport(report) && isOneTransactionReport(report)) {
return true;
}
if (isWorkspaceTaskReport(report)) {
return true;
}
if (isWorkspaceThread(report)) {
return true;
}
if (isInvoiceRoom(report) || isInvoiceReport(report)) {
return true;
}
return false;
}

Subscript is basically the non-diagonal workspace - user avatar so I'm a little confused about what to do with this.

@shawnborton
Copy link
Contributor

Sorry, I think we may be speaking past each other and not understanding each other correctly.

I am saying, the subscript avatar here:
CleanShot 2025-06-30 at 11 35 28@2x

That is really the only avatar we need for workspace expenses.

We never want to use this one AFAIK:
CleanShot 2025-06-30 at 11 35 46@2x

@JakubKorytko
Copy link
Contributor Author

@shawnborton Okay then, so we need to remove isOneTransactionReport call from above condition.

Right now, though, I think this PR's branch should be merged into #64802, and this PR should be closed, as the two overlap dangerously and will cause many conflicts. I believe this would make things much cleaner as they are both around avatars at this point.

I'm not sure how to handle @allroundexperts payment though. cc: @mountiny @trjExpensify for opinion on this.

@trjExpensify
Copy link
Contributor

We can pay out @allroundexperts for the review here as it's approved. 👍

@JakubKorytko
Copy link
Contributor Author

Closing as it was merged into #64802

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.

5 participants