Optimistic report name computation by sosek108 · Pull Request #65862 · Expensify/App

sosek108 · 2025-07-10T13:55:10Z

Explanation of Change

This PR introduces optimistic Custom Report Names for New Expensify, enabling real-time, formula-based report titles that update as expense data changes. When a formula part can’t be computed due to missing data, the system falls back to the original formula definition to show which parts weren’t evaluated. The implementation remains compatible with Classic Expensify formulas while leveraging New Expensify’s real-time architecture and Onyx optimistic updates, providing expected visible changes even without network. This PR lays the groundwork for full computation of report formulas, to be delivered step by step in follow-up PRs.

Fixed Issues

$ #59689
PROPOSAL:

Tests

Follow QA Steps fields below

Offline tests

Before running tests ensure your account has access to BETA functionality useCustomReportNamesNewExpensify.

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.

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

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

Test Case 2 – Date Fields Comparison

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

Test Case 3 – Currency and Total Display

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

Test Case 4 – Substring Function

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

Test Case 5 – Transaction Addition Impact

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

Test Case 6 – Policy Name Change Impact

Go to Workspaces
Select a workspace you admin
Go to Reports section
Edit Default report title with:
Report from {report:policyname}
Save the formula
Create new report via FAB
Note the current report title
Go to Workspace settings
Change workspace name
Return to reports and verify existing report titles updated with the new workspace name

PR Author Checklist

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

Perfrormance tracking

neil-marcellini

Here is a partial review. I will do more later.

src/libs/CustomFormula.ts

…other suggestions

src/libs/OptimisticReportNames.ts

neil-marcellini

Here's another partial review

.github/actions/javascript/checkAndroidStatus/index.js

src/CONST/index.ts

src/libs/OptimisticReportNames.ts

sosek108 · 2025-08-04T17:22:35Z

Status

question: Should both report type and dates be using system localization mechanism?

question 2: I’ve used that on expensify.com SSetNameValuePair('useCustomReportNamesNewExpensify', 'true');, and it seams that backend values are working fine, but I don’t see this beta on frontend and therefore Permissisons.canUseCustomReportNames returns false. Should I do anything else?
I’ve updated beta name to be same as backend.
I’ve implemented date formats from design doc and updated calculation of startdate and created to consume proper values.
I agree that indendation and connections could be done cleaner - I will handle that next step alongside with whole PR cleanup when we confirm that logic is fine.

Next steps:

report type computation
date / report from localization if needed (to be confirmed)
code cleanup and more efficient connections
validate test cases

@neil-marcellini

neil-marcellini · 2025-08-04T17:32:19Z

Let's not worry about localization for now, because we don't do that on the backend.
Odd, I can look into that later

Here is a spreadsheet of the date formats that are relatively useful. I'm still ensuring all of these are supported by the new backend system, but let's plan to support all these on the frontend. We can create a separate PR to support all the date formats, for now we can keep it more simple.

neil-marcellini

Here's another partial review. I will continue to review the rest.

src/libs/Formula.ts

src/libs/CustomFormula.ts

src/libs/OptimisticReportNames.ts

src/CONST/index.ts

neil-marcellini

I have reviewed all the code now. Lots of tweaks needed. Let's really try to break this down into manageable chunks and create issues to track other pieces that we want to add in subsequent PRs.

Thanks for the hard work so far!

src/libs/Formula.ts

src/libs/OptimisticReportNames.ts

tests/unit/FormulaTest.ts

tests/unit/OptimisticReportNamesTest.ts

neil-marcellini · 2025-08-14T17:08:09Z

For Test Case 2, the report created field shows the date and time while the report start date has the date part only. I imagine we want to keep this consistent.

Interesting. Let's see how it compares to OldDot. We're just trying to match the functionality there.

OldDot does the same thing so I don't think it's a problem, at least not a significant one. All good.

neil-marcellini

Thanks for the updates

akinwale · 2025-08-14T18:39:11Z

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

65862-web.mp4

MacOS: Desktop

akinwale · 2025-08-14T18:40:21Z

@sosek108 In offline mode, the Save button gets stuck loading after I click on it, so I am unable to change the formula afterwards (see end of video). Is this expected behaviour?

Screen.Recording.2025-08-14.at.19.34.34.mp4

akinwale · 2025-08-18T13:13:49Z

@sosek108 bump on #65862 (comment) icymi.

sosek108 · 2025-08-18T15:51:01Z

@sosek108 In offline mode, the Save button gets stuck loading after I click on it, so I am unable to change the formula afterwards (see end of video). Is this expected behaviour?

Screen.Recording.2025-08-14.at.19.34.34.mp4

I personally did not touch that button and this behaviour comes from main. So I suggest we don't stop the merge because of that, but I agree that it does not look well.

@neil-marcellini @akinwale I suggest that we create another issue to handle that and do that in follow up PR

akinwale

LGTM.

neil-marcellini

Sweet, let's do this. Thanks for the hard work guys.

OSBotify · 2025-08-19T19:22:56Z

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

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

OSBotify · 2025-08-22T17:29:18Z

🚀 Deployed to production by https://github.com/AndrewGable in version: 9.1.97-5 🚀

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

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>

Initial implementation of optimistic report name computation

8cd69d2

sosek108 mentioned this pull request Jul 10, 2025

[Tracking] Optimistic report title formula computation #59689

Closed

2 tasks

sosek108 and others added 8 commits July 11, 2025 12:50

Introduce tests for Optimistic Report Names. Add Logging and

08b84d3

Perfrormance tracking

Add tests for Optimistic Report Names

58b5f65

Introduce reassure tests

2810b00

Merge branch 'main' into feat/optimistic-report-title

7b36cbd

fix: imports

0d66c9c

chore: run prettier

33b27a1

fix: do not show unsupported fields, add spaces between parts

27b9b41

fix: minor fix

86ac06b

neil-marcellini requested changes Jul 31, 2025

View reviewed changes

koko57 added 3 commits August 1, 2025 09:22

fix: add freetext to cspell

d7e912c

chore: rename CustomFormula to Formula, add missing spaces, adderess …

a16b79d

…other suggestions

fix: imports

04755c6

koko57 reviewed Aug 1, 2025

View reviewed changes

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

koko57 added 2 commits August 1, 2025 11:27

fix: date formatting

03f09be

fix: revert adding spaces

0b4681f

neil-marcellini requested changes Aug 1, 2025

View reviewed changes

.github/actions/javascript/checkAndroidStatus/index.js Show resolved Hide resolved

src/CONST/index.ts Show resolved Hide resolved

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

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

sosek108 added 6 commits August 4, 2025 15:37

Merge branch 'main' into feat/optimistic-report-title

2711fc6

Rename beta to match backend value

9ec9e17

Add test cases for spaces around free text

e358534

Get valid date for startdate formula part

b3c7c2b

More optimal way to get oldest report action

4339a7d

startdate and created date computation. date formats

6d2a77b

neil-marcellini requested changes Aug 4, 2025

View reviewed changes

neil-marcellini requested changes Aug 5, 2025

View reviewed changes

sosek108 added 2 commits August 5, 2025 09:42

Merge branch 'main' into feat/optimistic-report-title

c0dd1f0

format report types

4a9391f

neil-marcellini approved these changes Aug 14, 2025

View reviewed changes

akinwale approved these changes Aug 18, 2025

View reviewed changes

melvin-bot bot requested a review from neil-marcellini August 18, 2025 15:55

neil-marcellini approved these changes Aug 18, 2025

View reviewed changes

neil-marcellini merged commit 71f02c6 into Expensify:main Aug 18, 2025
22 of 24 checks passed

VickyStash mentioned this pull request Aug 18, 2025

Support one transaction thread report creation if it wasn't created optimistically #68290

Merged

51 tasks

roryabraham mentioned this pull request Aug 18, 2025

Revert "Optimistic report name computation" #68686

Closed

This was referenced Aug 19, 2025

[No QA] Fixed reassure tests for optimistic report name computation #68726

Merged

Introduce transactions updates into the optimistic report name formula #68737

Merged

OSBotify mentioned this pull request Aug 19, 2025

Deploy Checklist: New Expensify 2025-08-19 #68779

Closed

67 tasks

jponikarchuk mentioned this pull request Aug 19, 2025

Expense - Report amount in the report title on the report preview reverts to 0.00 #68793

Closed

8 tasks

lanitochka17 mentioned this pull request Aug 19, 2025

[HOLD 67823][$250] [ORTF] - report:created and report:startdate not optimistically computed #68803

Closed

16 tasks

sosek108 mentioned this pull request Aug 25, 2025

Reimplementation of Optimistic report names functionality #69147

Merged

49 tasks

neil-marcellini mentioned this pull request Aug 25, 2025

[Due for payment 2025-09-19] [$250] Optimistic report name computation causing unexpected log out? #69175

Closed

Conversation

sosek108 commented Jul 10, 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!

neil-marcellini left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

neil-marcellini left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

sosek108 commented Aug 4, 2025

Status

Uh oh!

neil-marcellini commented Aug 4, 2025

Uh oh!

neil-marcellini left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

neil-marcellini left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

neil-marcellini commented Aug 14, 2025

Uh oh!

neil-marcellini left a comment

Choose a reason for hiding this comment

Uh oh!

akinwale commented Aug 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer Checklist

Screenshots/Videos

Uh oh!

akinwale commented Aug 14, 2025

Uh oh!

akinwale commented Aug 18, 2025

Uh oh!

sosek108 commented Aug 18, 2025

Uh oh!

akinwale left a comment

Choose a reason for hiding this comment

Uh oh!

neil-marcellini left a comment

Choose a reason for hiding this comment

Uh oh!

sosek108 commented Jul 10, 2025 •

edited

Loading

akinwale commented Aug 14, 2025 •

edited

Loading