perf: create reportAttributes derived value by TMisiukiewicz · Pull Request #58476 · Expensify/App

TMisiukiewicz · 2025-03-14T12:45:24Z

Explanation of Change

Create reportAttributes derived value to store report-specific attributes and improve performance of heavy calculations.

Before:

getReportName was calculated each time getOrderedReportIDs was called. For sending 5 messages on chat, it took 2.5s in total to generate report names

After:

report name is called once when the app is being opened, and then whenever report changes, it re-generates only it's name instead of generating all. Updating a single report name took 10ms and reading it 5 times was 24ms in total.

Fixed Issues

$ #59350
PROPOSAL:

Tests

FAB -> create new chat -> Room
Create a new room with any name of your choice
Press the chat header
Press the room name
Edit the room name and save
Verify the name has changed on details screen

Verify that no errors appear in the JS console

Offline tests

QA Steps

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

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Android: Native

android.mov

Android: mWeb Chrome

iOS: Native

ios.mp4

iOS: mWeb Safari

MacOS: Chrome / Safari

web.mov

MacOS: Desktop

desktop.mov

…attributes-derived-value

…tributes-derived-value

…attributes-derived-value

TMisiukiewicz · 2025-04-03T11:37:42Z

Tests are fixed, Typescript check should be green once we merge Onyx bump from #59191

TMisiukiewicz · 2025-04-11T11:33:08Z

@hoangzinh I addressed the comments, just had some problems with writing tests for the getReportName. I can't find the reason why I can't get getReportNameInternal properly mocked. I skipped writing those for now and added only simple test scenarios.

hoangzinh · 2025-04-11T13:30:11Z

Thanks @TMisiukiewicz. Can you take this last comment please #58476 (comment)

TMisiukiewicz · 2025-04-11T07:06:01Z

src/libs/actions/OnyxDerived/index.ts

-                    Log.info(`[OnyxDerived] value for key ${key} changed, updating it in Onyx`, false, {old: derivedValue ?? null, new: newDerivedValue ?? null});
-                    derivedValue = newDerivedValue;
-                    Onyx.set(key, derivedValue ?? null);
+            const recomputeDerivedValue = (sourceKey?: string, sourceValue?: unknown) => {


Previously, the compute function received only the current derived value as its second parameter. Now it gets a context object that includes sourceValue, keyed by the dependency that triggered the change. This allows tracking which specific dependency caused the recomputation.

This unlocks smarter downstream logic - compute can selectively recompute only affected items instead of the entire collection, like reportAttributes already does.

This behavior only applies to collections with waitForCollectionCallback: true. For non-collection dependencies or those without the flag, sourceValue is undefined since it’s always equal to the current value anyway

TMisiukiewicz · 2025-04-11T07:06:30Z

src/libs/ReportUtils.ts

+    // Basic report name is generated in derived value, so if only report was passed to the function and it's cached, we can immediately return the cached value
+    if (report && !policy && !parentReportActionParam && !personalDetails && !invoiceReceiverPolicy && reportAttributes?.[report.reportID]) {


Yeah good idea 👍

TMisiukiewicz · 2025-04-11T07:16:19Z

src/libs/actions/OnyxDerived/configs/reportAttributes.ts

+
+/**
+ * This derived value is used to get the report attributes for the report.
+ * Dependency on ONYXKEYS.PERSONAL_DETAILS_LIST is to ensure that the report attributes are generated after the personal details are available.


Some report names are generated based on information stored in personal details - this ensures we calculate them only if this information is available so we do not miss anything

TMisiukiewicz · 2025-04-11T14:10:18Z

@hoangzinh huh, I think all my comments were not visible to you before? I just noticed all of them have status Pending and I had to go to Files and press Finish the review for them to appear, sorry about that 💀

hoangzinh · 2025-04-11T14:34:23Z

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: 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 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: Native

Screen.Recording.2025-04-14.at.21.59.11.android.mov

Android: mWeb Chrome

Screen.Recording.2025-04-14.at.22.01.04.android.chrome.mov

iOS: Native

Screen.Recording.2025-04-14.at.22.05.34.ios.mov

iOS: mWeb Safari

Screen.Recording.2025-04-14.at.22.03.47.ios.safari.mov

MacOS: Chrome / Safari

Screen.Recording.2025-04-14.at.20.42.03.web.mov

MacOS: Desktop

Screen.Recording.2025-04-14.at.20.47.08.desktop.mov

hoangzinh · 2025-04-11T15:21:22Z

@TMisiukiewicz @mountiny, with derived value reportName, should we clean up the existing cache mechanism? Or should we leave it there?

App/src/libs/ReportUtils.ts

Lines 4570 to 4578 in 604acb6

    
           const cacheKey = getCacheKey(report); 
        
           if (reportID) { 
        
               const reportNameFromCache = reportNameCache.get(cacheKey); 
        
               if (reportNameFromCache?.reportName && reportNameFromCache.reportName === report?.reportName && reportNameFromCache.reportName !== CONST.REPORT.DEFAULT_REPORT_NAME) { 
        
                   return reportNameFromCache.reportName; 
        
               } 
        
           }

hoangzinh · 2025-04-11T15:27:58Z

@TMisiukiewicz It seems we have to invalidate/recalculate the cache when the language is changed.

Screen.Recording.2025-04-11.at.22.25.34.mov

TMisiukiewicz · 2025-04-14T06:04:33Z

with derived value reportName, should we clean up the existing cache mechanism? Or should we leave it there?

yeah seems like it's now redundant, removed it

TMisiukiewicz · 2025-04-14T06:24:10Z

It seems we have to invalidate/recalculate the cache when the language is changed.

@hoangzinh I've updated the dependencies to recalculate on locale change as well

hoangzinh

LGTM

mountiny · 2025-04-14T15:29:47Z

All yours @mjasikowski

mjasikowski

Just a small NAB comment

mjasikowski · 2025-04-15T08:56:26Z

src/libs/actions/OnyxDerived/types.ts

+type DerivedValueContext<Key extends OnyxKey, Deps extends NonEmptyTuple<Exclude<OnyxKey, Key>>> = {
+    currentValue?: OnyxValue<Key>;
+    sourceValues?: {
+        [K in Deps[number] as K extends OnyxCollectionKey ? K : never]?: K extends keyof OnyxCollectionValuesMapping ? OnyxCollection<OnyxCollectionValuesMapping[K]> : never;
+    };
+};
+


NAB, but is there any way to simplify this by creating helper types, with Partial and/or adding a comment? I'm getting old and I would have to whip out my notepad to solve the boolean logic to get the resulting type right now.

thanks for your comment, mind checking if it is easier to read now?

thanks @TMisiukiewicz - it still borders on arcane, but is way easier to understand what's going on. Thank you!

…tributes-derived-value

OSBotify · 2025-04-15T13:26:26Z

✋ 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-04-16T21:38:53Z

🚀 Deployed to staging by https://github.com/mjasikowski in version: 9.1.29-0 🚀

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

github-actions · 2025-04-18T20:30:48Z

🚀 Deployed to production by https://github.com/marcaaron in version: 9.1.29-10 🚀

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

TMisiukiewicz added 8 commits March 13, 2025 12:44

add onyx source value to derived values

f5c0355

pass sourceValues to compute for collection keys

47f2872

fix types

189608f

add report attributes derived value

46c2cf5

generate report name for reports

70ae349

Merge branch 'main' into perf/create-report-attributes-derived-value

6805b5f

add comments to type

15dbb15

fix iteration of reportAttributes

d703077

TMisiukiewicz mentioned this pull request Mar 14, 2025

feat: expose callback trigger value for collections Expensify/react-native-onyx#622

Merged

42 tasks

TMisiukiewicz added 6 commits March 17, 2025 08:40

always set onyx derived value

f7083d7

Merge branch 'main' into perf/create-report-attributes-derived-value

c870ebe

Merge branch 'main' into perf/create-report-attributes-derived-value

d83d30d

Merge remote-tracking branch 'upstream/main' into perf/create-report-…

c65ca4c

…attributes-derived-value

Merge branch 'main' into perf/create-report-attributes-derived-value

de67ca6

Merge branch 'main' into perf/create-report-attributes-derived-value

753ee26

mountiny assigned TMisiukiewicz Mar 31, 2025

TMisiukiewicz added 8 commits March 31, 2025 15:04

Merge remote-tracking branch 'upstream/main' into perf/create-report-…

fad7276

…attributes-derived-value

fix navigateAfterOnboardingTest

a50796f

Merge branch 'main' into perf/create-report-attributes-derived-value

92b3891

Merge remote-tracking branch 'origin/main' into perf/create-report-at…

991681b

…tributes-derived-value

fix GroupChatNameTest

ebb56f0

do not calculate if empty personal details

a30eedc

Merge branch 'main' into perf/create-report-attributes-derived-value

41f9412

expect error on ts compute args

7a941fe

adhorodyski approved these changes Apr 3, 2025

View reviewed changes

Merge remote-tracking branch 'upstream/main' into perf/create-report-…

0daf3b1

…attributes-derived-value

mountiny mentioned this pull request Apr 4, 2025

[No QA] add derived values guidelines to readme #59650

Merged

51 tasks

TMisiukiewicz added 2 commits April 7, 2025 08:54

Merge branch 'main' into perf/create-report-attributes-derived-value

5c986cd

update personal details description

249b7b9

add basic tests for getReportName

9156f6b

TMisiukiewicz commented Apr 11, 2025

View reviewed changes

remove report name cache

d29f863

recompute report attributes on locale change

4a9f804

hoangzinh approved these changes Apr 14, 2025

View reviewed changes

melvin-bot bot requested a review from mjasikowski April 14, 2025 15:09

mjasikowski previously approved these changes Apr 15, 2025

View reviewed changes

TMisiukiewicz added 2 commits April 15, 2025 14:50

Merge remote-tracking branch 'origin/main' into perf/create-report-at…

fb8ea68

…tributes-derived-value

improve readability of onyxderived types

c1802c2

TMisiukiewicz dismissed mjasikowski’s stale review via c1802c2 April 15, 2025 12:55

mjasikowski approved these changes Apr 15, 2025

View reviewed changes

mjasikowski merged commit ea14b5b into Expensify:main Apr 15, 2025
19 checks passed

TMisiukiewicz mentioned this pull request Apr 15, 2025

[Due for payment 2025-05-30] [CRITICAL] Investigate performance issues when deleting expenses from Reports page #59825

Closed

18 tasks

github-actions bot mentioned this pull request Apr 16, 2025

Deploy Checklist: New Expensify 2025-04-16 #60369

Closed

87 tasks

nkdengineer mentioned this pull request Apr 17, 2025

[Due for payment 2025-05-07] Expense - Report header is blank briefly after opening transaction thread #60391

Closed

8 tasks

arosiclair mentioned this pull request Apr 17, 2025

[$250] Track expense -"Hidden No activity yet" is displayed for the tracked and opened offline expense #60452

Closed

18 tasks

nkdengineer mentioned this pull request Apr 21, 2025

[$250] (Archived) title not showing up for admins and announce room in offline mode #60033

Closed

18 tasks

truph01 mentioned this pull request Apr 22, 2025

[Due for payment 2025-05-14] [$250] Group - Group created offline, shows members Emails on LHN and members names on Search. #60602

Closed

8 tasks

		// Basic report name is generated in derived value, so if only report was passed to the function and it's cached, we can immediately return the cached value
		if (report && !policy && !parentReportActionParam && !personalDetails && !invoiceReceiverPolicy && reportAttributes?.[report.reportID]) {

Conversation

TMisiukiewicz commented Mar 14, 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!

TMisiukiewicz commented Apr 3, 2025

Uh oh!

TMisiukiewicz commented Apr 11, 2025

Uh oh!

hoangzinh commented Apr 11, 2025

Uh oh!

TMisiukiewicz Apr 11, 2025

Choose a reason for hiding this comment

Uh oh!

TMisiukiewicz Apr 11, 2025

Choose a reason for hiding this comment

Uh oh!

TMisiukiewicz Apr 11, 2025

Choose a reason for hiding this comment

Uh oh!

TMisiukiewicz commented Apr 11, 2025

Uh oh!

hoangzinh commented Apr 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer Checklist

Screenshots/Videos

Uh oh!

hoangzinh commented Apr 11, 2025

Uh oh!

hoangzinh commented Apr 11, 2025

Uh oh!

TMisiukiewicz commented Apr 14, 2025

Uh oh!

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

Uh oh!

Uh oh!

hoangzinh left a comment

Choose a reason for hiding this comment

Uh oh!

mountiny commented Apr 14, 2025

Uh oh!

mjasikowski left a comment

Choose a reason for hiding this comment

Uh oh!

mjasikowski Apr 15, 2025

Choose a reason for hiding this comment

Uh oh!

TMisiukiewicz Apr 15, 2025

Choose a reason for hiding this comment

Uh oh!

mjasikowski Apr 15, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

OSBotify commented Apr 15, 2025

Uh oh!

github-actions bot commented Apr 16, 2025

Uh oh!

github-actions bot commented Apr 18, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

TMisiukiewicz commented Mar 14, 2025 •

edited

Loading

hoangzinh commented Apr 11, 2025 •

edited

Loading

TMisiukiewicz commented Apr 14, 2025 •

edited

Loading