Skip to content

Reimplementation of Optimistic report names functionality#69147

Merged
neil-marcellini merged 20 commits intoExpensify:mainfrom
callstack-internal:feat/combined-optimistic-report-names
Sep 10, 2025
Merged

Reimplementation of Optimistic report names functionality#69147
neil-marcellini merged 20 commits intoExpensify:mainfrom
callstack-internal:feat/combined-optimistic-report-names

Conversation

@sosek108
Copy link
Copy Markdown
Contributor

@sosek108 sosek108 commented Aug 25, 2025

Explanation of Change

This PR combines the functionality from three previously reverted PRs:

Key Features:

  • Real-time, formula-based report titles that update as expense data changes
  • Support for report fields: type, startdate, total, currency, policyname, created
  • Functions: frontpart, substr, domain for string manipulation
  • Optimistic updates work offline and provide visible changes without network
  • Transaction updates trigger report name recalculation
  • Performance optimized with caching and targeted updates
  • Beta flag controlled: authAutoReportTitle

Implementation Details:

  • Formula.ts: Formula parsing and computation engine
  • OptimisticReportNames.ts: Main logic for report name updates
  • OptimisticReportNamesConnectionManager.ts: Onyx data context manager
  • Enhanced API middleware to process optimistic data
  • Performance and unit tests included

Fixed Issues

$ #69175
$ #59689
PROPOSAL:

Tests

Follow QA Steps fields below

Offline tests

  1. Turn on Force offline mode and do same steps as in QA Steps section.

Report titles should be properly formated

QA Steps

Before running tests ensure your account has access to BETA functionality useCustomReportNamesNewExpensify. To add yourself to the beta, please follow the pre-testing steps as described in this document.

The report titles should not flicker in any case. By flicker I mean that you can see the report title change value 2 times on any of described action.

Test Case 1 – All Report Fields Combined

  1. Go to Workspaces
  2. Select a workspace you admin
  3. Go to Reports section
  4. Edit Default report title with:
    {report:type} - {report:total} from {report:policyname} on {report:startdate}
  5. Save the formula
  6. Create new report via FAB
  7. Add at least one expense transaction
  8. Verify title shows:
    Custom Expense Report - USD$X.XX from [WorkspaceName] on [StartDate]

Test Case 2 – Date Fields Comparison

  1. Go to Workspaces
  2. Select a workspace you admin
  3. Go to Reports section
  4. Edit Default report title with:
    Created {report:created} vs Started {report:startdate}
  5. Save the formula
  6. Create new report via FAB
  7. Add expense transaction with different date than report creation
  8. Verify title shows both creation date and start date correctly

Test Case 3 – Currency and Total Display

  1. Go to Workspaces
  2. Select a workspace you admin
  3. Go to Reports section
  4. Edit Default report title with:
    {report:currency} {report:total} report
  5. Save the formula
  6. Create new report via FAB
  7. Add expense transaction with amount
  8. Verify title shows: [Currency] [Amount] report

Test Case 4 – Substring Function

  1. Go to Workspaces
  2. Select a workspace you admin
  3. Go to Reports section
  4. Edit Default report title with:
    ID: {report:type|substr:0:3}-{report:total|substr:1:4}
  5. Save the formula
  6. Create new report via FAB
  7. Add expense transaction with amount
  8. Verify title shows truncated type and amount (e.g., ID: Exp-23.5)

Test Case 5 – Transaction Addition Impact

  1. Go to Workspaces
  2. Select a workspace you admin
  3. Go to Reports section
  4. Edit Default report title with:
    Total: {report:total} Start: {report:startdate}
  5. Save the formula
  6. Create new report via FAB
  7. Add first expense transaction (note the title)
  8. Add second expense transaction with different date
  9. Verify title updates total amount and possibly start date

Test Case 6 – Policy Name Change Impact

  1. Go to Workspaces
  2. Select a workspace you admin
  3. Go to Reports section
  4. Edit Default report title with:
    Report from {report:policyname}
  5. Save the formula
  6. Create new report via FAB
  7. Note the current report title
  8. Go to Workspace settings
  9. Change workspace name
  10. Return to reports and verify existing report titles updated with the new workspace name

Test case 7 - Transactions

  1. Sign in with an account on OldDot
  2. Open the JS console and enter this to enable the backend beta SSetNameValuePair('useCustomReportNamesNewExpensify', 'true');
  3. Got to Workspaces, select your workspace and go to Reports subpage
  4. Edit Default report title to Report from {report:startdate}
  5. Create new report and add two transactions
    a. first with date 2025-08-16
    b. second with date 2025-08-17
  6. Check if report's name is equal to Report from 2025-08-16
  7. Go to Account -> Troubleshoot and enable Force offline option
  8. Go back to newly created report
  9. Edit second transaction's date to 2025-08-14
  10. Check if report's name is equal to Report from 2025-08-14
  11. Turn back transaction's date to 2025-08-17
  12. Check if report's name is equal to Report from 2025-08-16
  13. Add new transaction with date 2025-08-05
  14. Check if report's name is equal to Report from 2025-08-05

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 verified there are no new alerts related to the canBeMissing param for useOnyx
  • 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
Nagranie.z.ekranu.2025-08-11.o.15.24.45.mov
iOS: mWeb Safari
MacOS: Chrome / Safari
Nagranie.z.ekranu.2025-08-11.o.15.08.40.mov
MacOS: Desktop
Nagranie.z.ekranu.2025-08-11.o.15.19.39.mov

This PR combines the functionality from three previously reverted PRs:
- Expensify#65862: Initial optimistic Custom Report Names implementation
- Expensify#68726: Fix for reassure performance tests
- Expensify#68737: Extended transaction support for report name computation

### Key Features:
- Real-time, formula-based report titles that update as expense data changes
- Support for report fields: type, startdate, total, currency, policyname, created
- Functions: frontpart, substr, domain for string manipulation
- Optimistic updates work offline and provide visible changes without network
- Transaction updates trigger report name recalculation
- Performance optimized with caching and targeted updates
- Beta flag controlled: authAutoReportTitle

### Implementation Details:
- Formula.ts: Formula parsing and computation engine
- OptimisticReportNames.ts: Main logic for report name updates
- OptimisticReportNamesConnectionManager.ts: Onyx data context manager
- Enhanced API middleware to process optimistic data
- Performance and unit tests included

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>
@github-actions
Copy link
Copy Markdown
Contributor

🚧 @jasperhuangg has triggered a test Expensify/App build. You can view the workflow run here.

@github-actions

This comment has been minimized.

@sosek108
Copy link
Copy Markdown
Contributor Author

Test is failing, but this comes from main.

Test failing: IOURequestEditReportCommon › RBR › should not show DotIndicator when the report has brickRoadIndicator.
Test was mentioned on Slack https://expensify.slack.com/archives/C01GTK53T8Q/p1756286581236359

@github-actions
Copy link
Copy Markdown
Contributor

🚧 @jasperhuangg has triggered a test Expensify/App build. You can view the workflow run here.

@github-actions
Copy link
Copy Markdown
Contributor

🧪🧪 Use the links below to test this adhoc build on Android, iOS, Desktop, and Web. Happy testing! 🧪🧪
Built from App PR #69147.

Android 🤖 iOS 🍎
https://ad-hoc-expensify-cash.s3.amazonaws.com/android/69147/index.html ⏩ SKIPPED ⏩
Android The build for iOS was skipped
Desktop 💻 Web 🕸️
⏩ SKIPPED ⏩ ⏩ SKIPPED ⏩
The build for Desktop was skipped The build for Web was skipped

👀 View the workflow run that generated this build 👀

@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Sep 2, 2025

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

@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Sep 2, 2025

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

@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Sep 2, 2025

🧪🧪 Use the links below to test this adhoc build on Android, iOS, Desktop, and Web. Happy testing! 🧪🧪
Built from App PR #69147.

Android 🤖 iOS 🍎
https://ad-hoc-expensify-cash.s3.amazonaws.com/android/69147/index.html ⏩ SKIPPED ⏩
Android The build for iOS was skipped
Desktop 💻 Web 🕸️
⏩ SKIPPED ⏩ ⏩ SKIPPED ⏩
The build for Desktop was skipped The build for Web was skipped

👀 View the workflow run that generated this build 👀

@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Sep 2, 2025

🧪🧪 Use the links below to test this adhoc build on Android, iOS, Desktop, and Web. Happy testing! 🧪🧪
Built from App PR #69147.

Android 🤖 iOS 🍎
https://ad-hoc-expensify-cash.s3.amazonaws.com/android/69147/index.html ⏩ SKIPPED ⏩
Android The build for iOS was skipped
Desktop 💻 Web 🕸️
⏩ SKIPPED ⏩ ⏩ SKIPPED ⏩
The build for Desktop was skipped The build for Web was skipped

👀 View the workflow run that generated this build 👀

Copy link
Copy Markdown
Contributor Author

@sosek108 sosek108 left a comment

Choose a reason for hiding this comment

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

@neil-marcellini I've applied changes according to your comments

Copy link
Copy Markdown
Contributor

@neil-marcellini neil-marcellini left a comment

Choose a reason for hiding this comment

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

Good to go from me. Thanks!

/**
* Extract transaction ID from an Onyx key
*/
// eslint-disable-next-line @typescript-eslint/no-unused-vars -- this will be used in near future
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.

NAB: can be done in a follow-up. We can remove this ESLint disable comment because we use this function now.

}

/**
* Get all reports associated with a policy ID
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.

NAB: can be done in a follow up. Please update the comment to make it accurate.

@neil-marcellini
Copy link
Copy Markdown
Contributor

@sosek108 I updated the description with a link to a document that describes how to set up the beta. @akinwale would you please do a C+ review now? If you find any bugs, please report them here, but they also don't need to be blockers as this is under a beta. You should request changes if you see a problem that would affect users outside the beta or if there's some really bad code I missed.

@akinwale
Copy link
Copy Markdown
Contributor

akinwale commented Sep 10, 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
Android: mWeb Chrome
iOS: HybridApp
iOS: mWeb Safari
MacOS: Chrome / Safari
69147-web-1.mp4
69147-web-2.mp4
MacOS: Desktop

Copy link
Copy Markdown
Contributor

@akinwale akinwale left a comment

Choose a reason for hiding this comment

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

LGTM.

@neil-marcellini neil-marcellini merged commit b7cd111 into Expensify:main Sep 10, 2025
23 of 26 checks passed
@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.

@OSBotify
Copy link
Copy Markdown
Contributor

🚀 Deployed to staging by https://github.com/neil-marcellini in version: 9.2.9-0 🚀

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

@mvtglobally
Copy link
Copy Markdown

@neil-marcellini @trjExpensify Can we use Expensifail account for this PR? Would it be automatically added to BETA?

@sosek108
Copy link
Copy Markdown
Contributor Author

@mvtglobally it should be not automatically turned on on Expensifail accounts as there is check if the beta here is explicitly enabled.

It'd be great to check that though

@OSBotify
Copy link
Copy Markdown
Contributor

🚀 Deployed to staging by https://github.com/neil-marcellini in version: 9.2.11-0 🚀

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

@mvtglobally
Copy link
Copy Markdown

@sosek108
thanks for the clarification.
When we run the Pre-testing steps on Web, Can we use the same account on Hybrid app or MWeb and logic will apply or this PR is only executable in the same browser/session where Console changes were applied?

@sosek108
Copy link
Copy Markdown
Contributor Author

@mvtglobally these changes are applied to the account, so you'd need different account to test this with / without beta flag

@neil-marcellini
Copy link
Copy Markdown
Contributor

Yes to be extra clear, once it's applied to the account it can be in any browser session or device.

@neil-marcellini
Copy link
Copy Markdown
Contributor

@mvtglobally I recently learned that the beta updates are only sent to app when a user signs in, and not automatically, at least using this beta which is somewhat "special". If you follow the pre-testing steps exactly in the document, setting the beta on OldDot, then signing in on NewDot, it should work as desired.

I will also create an issue to immediately send updates for the beta so that we have more control moving forward.

@neil-marcellini
Copy link
Copy Markdown
Contributor

@OSBotify
Copy link
Copy Markdown
Contributor

🚀 Deployed to production by https://github.com/francoisl in version: 9.2.12-4 🚀

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

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.

7 participants