Make getReportDetails a pure function by cretadn22 · Pull Request #61670 · Expensify/App

cretadn22 · 2025-05-08T09:06:52Z

Explanation of Change

Fixed Issues

$ #61258
PROPOSAL: #61258 (comment)

Tests

Create 2 reports
Add some expenses on each report
Move expense from report 1 to report 2 and verify that the moved transaction message displays correctly

Verify that no errors appear in the JS console

Offline tests

Create 2 reports
Add some expenses on each report
Move expense from report 1 to report 2 and verify that the moved transaction message displays correctly

QA Steps

// TODO: These must be filled out, or the issue title must include "[No QA]."

Create 2 reports
Add some expenses on each report
Move expense from report 1 to report 2 and verify that the moved transaction message displays correctly

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Android: Native

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

melvin-bot · 2025-05-08T09:06:58Z

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

eVoloshchak · 2025-05-13T15:38:46Z

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

Android: mWeb Chrome

iOS: HybridApp

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

eVoloshchak · 2025-05-14T18:54:37Z

Create 2 reports
Add some expenses on each report
Move expense from report 1 to report 2 and verify that the moved transaction message displays correctly

For me, this already works correctly on staging (before fix). @cretadn22, are these steps supposed to fail on staging?

cretadn22 · 2025-05-15T14:31:07Z

@eVoloshchak This PR doesn't fix any bug, it is only a refactor. The above test step is only to verify that everything still works well after this change, we can skip the test steps if you want

eVoloshchak · 2025-05-19T08:18:12Z

@cretadn22, according to #61049 (comment)

This can be a problem because getReportName() relies on data from ONYXKEYS.DERIVED.REPORT_ATTRIBUTES, and if the view components are not connected to this Onyx key, then when data in ONYXKEYS.DERIVED.REPORT_ATTRIBUTES changes, the UI will not reflect those changes.

Is this a theoretical scenario? Or is there a set of steps we could perform to reproduce this bug?
It would be perfect if we could have test steps to really test for this bug, if possible

cretadn22 · 2025-05-22T13:13:15Z

Is this a theoretical scenario? Or is there a set of steps we could perform to reproduce this bug?
It would be perfect if we could have test steps to really test for this bug, if possible

@eVoloshchak I can't see any problem. Do you have any idea?

eVoloshchak · 2025-05-26T16:34:07Z

@cretadn22, I also can't find any scenario where UI would not be updated. Let's stick with the original test steps then. Could you pull the latest main please?

cretadn22 · 2025-05-29T12:49:56Z

@eVoloshchak I merged the main

eVoloshchak · 2025-06-02T08:53:38Z

Still experiencing a problem with HybridApp build (cannot properly test this on native platforms), expect an update shortly

eVoloshchak

LGTM!

src/libs/ReportUtils.ts

luacmartins · 2025-06-10T16:20:49Z

@cretadn22 TS checks are failing

src/libs/ReportUtils.ts

cretadn22 · 2025-06-11T18:26:53Z

@luacmartins @tgolen I updated all comments

tgolen

Thank you!

tgolen · 2025-06-11T19:30:52Z

src/libs/ReportUtils.ts

                formattedName += ` (${translateLocal('common.archived')})`;
            }
-            return formatReportLastMessageText(formattedName);
+            return formatReportLastMessageText(formattedName) ?? report?.reportName ?? '';


Ah, dang. Sucks that this had to be added so many places. It would really help if this function only had one return, but that's not your fault.

OSBotify · 2025-06-11T19:44:48Z

✋ 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 · 2025-06-11T22:34:22Z

🚀 Deployed to staging by https://github.com/luacmartins in version: 9.1.65-0 🚀

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

martasudol · 2025-06-12T06:37:47Z

Changes from this PR in getMovedTransactionMessage caused TS check failure:

Error: src/libs/OptionsListUtils.ts(781,37): error TS2554: Expected 2-3 arguments, but got 1.
Error: Process completed with exit code 2.

MonilBhavsar · 2025-06-12T09:01:29Z

This PR caused regression #64031

luacmartins · 2025-06-12T14:22:28Z

@cretadn22 this PR was reverted because it caused these blockers:

@cretadn22 let's create a new PR to reimplement the changes in this PR, taking into account the issues above. Additionally, can we please include automated tests for these changes?

github-actions · 2025-06-12T22:10:39Z

🚀 Deployed to production by https://github.com/Julesssss in version: 9.1.65-1 🚀

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

make getReportDetails pure

4296af6

cretadn22 requested a review from a team as a code owner May 8, 2025 09:06

melvin-bot bot requested a review from eVoloshchak May 8, 2025 09:06

melvin-bot bot removed the request for review from a team May 8, 2025 09:06

luacmartins assigned cretadn22 May 21, 2025

new main

15df3e9

eVoloshchak approved these changes Jun 4, 2025

View reviewed changes

melvin-bot bot requested a review from luacmartins June 4, 2025 14:37

luacmartins requested changes Jun 4, 2025

View reviewed changes

src/libs/ReportUtils.ts Outdated Show resolved Hide resolved

src/libs/ReportUtils.ts Outdated Show resolved Hide resolved

cretadn22 added 4 commits June 6, 2025 23:26

new main

c652e1a

remove getReportDetails

f57121b

fix type error

d9ffc26

fix errors

27a6d67

tgolen requested changes Jun 11, 2025

View reviewed changes

src/libs/ReportUtils.ts Outdated Show resolved Hide resolved

src/libs/ReportUtils.ts Outdated Show resolved Hide resolved

cretadn22 added 3 commits June 12, 2025 01:00

apply suggestion

eb36352

modify

d107aa4

apply suggestion

7416613

tgolen approved these changes Jun 11, 2025

View reviewed changes

luacmartins approved these changes Jun 11, 2025

View reviewed changes

luacmartins merged commit fb250c6 into Expensify:main Jun 11, 2025
19 checks passed

github-actions bot mentioned this pull request Jun 11, 2025

Deploy Checklist: New Expensify 2025-06-11 #64018

Closed

25 tasks

mitarachim mentioned this pull request Jun 12, 2025

Transaction message shows incorrect report name #64028

Closed

8 tasks

This was referenced Jun 12, 2025

Remove redundant ReadNewestAction calls on hold expense #63342

Merged

LoadingBar rendering improvements #63025

Merged

MonilBhavsar mentioned this pull request Jun 12, 2025

Report - After moving expense to a report on WS, system message, shows incorrect report name #64031

Closed

8 tasks

MonilBhavsar mentioned this pull request Jun 12, 2025

[CP Staging] Revert "Make getReportDetails a pure function" #64064

Merged

luacmartins mentioned this pull request Jun 12, 2025

[Due for payment 2025-08-01] [$250] Make getReportDetails a pure function #61258

Closed

eVoloshchak mentioned this pull request Jun 19, 2025

Make getReportDetails a pure function - Recreate #64088

Merged

51 tasks

Conversation

cretadn22 commented May 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Explanation of Change

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

Uh oh!

melvin-bot bot commented May 8, 2025

Uh oh!

eVoloshchak commented May 13, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer Checklist

Screenshots/Videos

Uh oh!

eVoloshchak commented May 14, 2025

Uh oh!

cretadn22 commented May 15, 2025

Uh oh!

eVoloshchak commented May 19, 2025

Uh oh!

cretadn22 commented May 22, 2025

Uh oh!

eVoloshchak commented May 26, 2025

Uh oh!

cretadn22 commented May 29, 2025

Uh oh!

eVoloshchak commented Jun 2, 2025

Uh oh!

eVoloshchak left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

luacmartins commented Jun 10, 2025

Uh oh!

Uh oh!

Uh oh!

cretadn22 commented Jun 11, 2025

Uh oh!

tgolen left a comment

Choose a reason for hiding this comment

Uh oh!

tgolen Jun 11, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

OSBotify commented Jun 11, 2025

Uh oh!

github-actions bot commented Jun 11, 2025

Uh oh!

martasudol commented Jun 12, 2025

Uh oh!

MonilBhavsar commented Jun 12, 2025

Uh oh!

luacmartins commented Jun 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented Jun 12, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

cretadn22 commented May 8, 2025 •

edited

Loading

eVoloshchak commented May 13, 2025 •

edited

Loading

luacmartins commented Jun 12, 2025 •

edited

Loading