[CLEAN] Synthetic Benchmark PR #73208 - Use existing selfDM report

[tomerqodo]

User description

Benchmark PR Expensify#73208

Type: Clean (correct implementation)

Original PR Title: Use existing selfDM report
Original PR Description:

Explanation of Change

SelfDM reports will be created during account creation and will have notification preference equal to hidden by default. Optimistically creating selfDM reports during onboarding is causing bugs with new behaviour so this PR removes that logic

Fixed Issues

$ https://github.com/Expensify/Expensify/issues/556957
PROPOSAL: n/a

Tests

1. Create new account
2. Fill onboarding using any path
3. Verify that it's possible to find selfDM
4. Verify that after any action selfDM notification preference is updated to muted.

• Verify that no errors appear in the JS console

Offline tests

1. Create expense on workspace chat
2. Go offline
3. Go to Expense
4. Click on report field and "Remove from report"
5. Verify that self DM is created
6. Go online
7. Verify that there's only one self DM chat and nothing flickers

QA Steps

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

1. Create new account
2. Fill onboarding using any path
3. Verify that it's possible to find selfDM
4. Verify that after any action selfDM notification preference is updated to muted.

• Verify that no errors appear in the JS console

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 new assets were added or existing ones were modified, I verified that:
  • The assets are optimized and compressed (for SVG files, run npm run compress-svg)
  • The assets load correctly across all supported platforms.
• 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

android-web.mov

iOS: Native

ios.mov

iOS: mWeb Safari

ios-web.mov

MacOS: Chrome / Safari

web.mov

MacOS: Desktop

Original PR URL: Expensify#73208

---

PR Type

Enhancement, Bug fix

---

Description

• Store selfDM report ID from OpenApp response in Onyx state

• Use cached selfDM ID instead of searching through all reports

• Pass selfDM report ID parameter to transaction report changes

• Optimize selfDM report lookup with memoization in multiple pages

---

Diagram Walkthrough

flowchart LR
  A["OpenApp Response"] -->|"Store in Onyx"| B["SELF_DM_REPORT_ID"]
  B -->|"Cache in ReportUtils"| C["findSelfDMReportID()"]
  C -->|"Pass as parameter"| D["changeTransactionsReport()"]
  D -->|"Use for unreported expenses"| E["Self DM Report"]

Loading

File Walkthrough

	Relevant files
Configuration changes	1 files ONYXKEYS.ts Add SELF_DM_REPORT_ID Onyx key definition                                +4/-0
Enhancement	9 files ReportUtils.ts Cache selfDM ID and optimize lookup logic                                +20/-7    Transaction.ts Accept selfDM ID parameter in changeTransactionsReport      +8/-9      AddUnreportedExpense.tsx Memoize and pass selfDM report ID to transaction changes  +3/-1      NewReportWorkspaceSelectionPage.tsx Memoize and pass selfDM report ID to transaction changes  +3/-1      ProfilePage.tsx Memoize selfDM ID and add eslint disable comment                  +4/-2      SearchTransactionsChangeReport.tsx Memoize and pass selfDM ID to all transaction report changes +15/-2    TrackExpensePage.tsx Use named imports and findSelfDMReportID function                +7/-7      IOURequestEditReport.tsx Memoize and pass selfDM ID to transaction report changes  +14/-2    IOURequestStepReport.tsx Memoize and pass selfDM ID to all transaction changes        +15/-3
Tests	2 files IOUTest.ts Pass selfDM ID to changeTransactionsReport in tests            +11/-2    TransactionTest.ts Pass selfDM ID parameter in transaction test                          +4/-1
Formatting	2 files index.native.tsx Add eslint disable comment for restricted imports                +1/-0      index.tsx Add eslint disable comment for restricted imports                +1/-0

---

[qodo-code-review]

PR Compliance Guide 🔍

Below is a summary of compliance checks for this PR:

Security Compliance
🟢	No security concerns identified No security vulnerabilities detected by AI analysis. Human verification advised for critical code.
Ticket Compliance
⚪	🎫 No ticket provided Create ticket/issue
Codebase Duplication Compliance
⚪	Codebase context is not defined Follow the guide to enable codebase context checks.
Custom Compliance
🟢	Generic: Meaningful Naming and Self-Documenting Code Objective: Ensure all identifiers clearly express their purpose and intent, making code self-documenting Status: Passed Learn more about managing compliance generic rules or creating your own custom rules
	Generic: Secure Error Handling Objective: To prevent the leakage of sensitive system information through error messages while providing sufficient detail for internal debugging. Status: Passed Learn more about managing compliance generic rules or creating your own custom rules
	Generic: Secure Logging Practices Objective: To ensure logs are useful for debugging and auditing without exposing sensitive information like PII, PHI, or cardholder data. Status: Passed Learn more about managing compliance generic rules or creating your own custom rules
	Generic: Security-First Input Validation and Data Handling Objective: Ensure all data inputs are validated, sanitized, and handled securely to prevent vulnerabilities Status: Passed Learn more about managing compliance generic rules or creating your own custom rules
⚪	Generic: Comprehensive Audit Trails Objective: To create a detailed and reliable record of critical system actions for security analysis and compliance. Status: Audit coverage: New flows for changing transactions’ reports and creating/using selfDM reports were added without visible additions to auditing/logging of these critical actions. Referred Code function changeTransactionsReport( transactionIDs: string[], isASAPSubmitBetaEnabled: boolean, accountID: number, email: string, newReport?: OnyxEntry<Report>, policy?: OnyxEntry<Policy>, reportNextStep?: OnyxEntry<ReportNextStepDeprecated>, policyCategories?: OnyxEntry<PolicyCategories>, selfDMReportIDParam?: string, ) { const reportID = newReport?.reportID ?? CONST.REPORT.UNREPORTED_REPORT_ID; const transactions = transactionIDs.map((id) => allTransactions?.[id]).filter((t): t is NonNullable<typeof t> => t !== undefined); const transactionIDToReportActionAndThreadData: Record<string, TransactionThreadInfo> = {}; const updatedReportTotals: Record<string, number> = {}; const updatedReportNonReimbursableTotals: Record<string, number> = {}; const updatedReportUnheldNonReimbursableTotals: Record<string, number> = {}; // Store current violations for each transaction to restore on failure const currentTransactionViolations: Record<string, TransactionViolation[]> = {}; ... (clipped 596 lines) Learn more about managing compliance generic rules or creating your own custom rules
	Generic: Robust Error Handling and Edge Case Management Objective: Ensure comprehensive error handling that provides meaningful context and graceful degradation Status: Missing null checks: Functions like findSelfDMReportID and consumers assume a valid selfDM ID and may build URLs or compare IDs without explicit fallback handling/logging when the ID is absent. Referred Code function findSelfDMReportID(): string | undefined { if (!allReports) { return; } if (selfDMReportID) { return selfDMReportID; } const selfDMReport = Object.values(allReports).find((report) => isSelfDM(report) && !isThread(report)); return selfDMReport?.reportID; } /** Learn more about managing compliance generic rules or creating your own custom rules

Compliance status legend

🟢 - Fully Compliant
🟡 - Partial Compliant
🔴 - Not Compliant
⚪ - Requires Further Human Verification
🏷️ - Compliance label

[qodo-code-review]

PR Code Suggestions ✨

Explore these optional code suggestions:

Category	Suggestion	Impact
Possible issue	Handle null value from Onyx Update the Onyx.connectWithoutView callback to reset selfDMReportID to undefined if the Onyx value becomes nullish, preventing the use of stale data. src/libs/ReportUtils.ts [1210-1219] let selfDMReportID: string | undefined; Onyx.connectWithoutView({ key: ONYXKEYS.SELF_DM_REPORT_ID, callback: (value) => { - if (!value) { - return; - } - selfDMReportID = value; + selfDMReportID = value ?? undefined; }, }); Apply / Chat Suggestion importance[1-10]: 7 __ Why: The suggestion correctly identifies a potential stale data issue and provides a simple fix to ensure the module-level variable is reset when the Onyx value is cleared.	Medium
High-level	Refactor to centralize selfDM report creation The logic for optimistically creating a selfDM report is duplicated across prepareOnboardingOnyxData and changeTransactionsReport. This should be extracted into a single utility function to improve maintainability and ensure consistency. Examples: src/libs/ReportUtils.ts [11707-11713] let selfDMReport = allReports?.[`${ONYXKEYS.COLLECTION.REPORT}${findSelfDMReportID()}`]; let createdAction: ReportAction; if (!selfDMReport) { const currentTime = DateUtils.getDBTime(); selfDMReport = buildOptimisticSelfDMReport(currentTime); createdAction = buildOptimisticCreatedReportAction(currentUserEmail ?? '', currentTime); selfDMParameters = {reportID: selfDMReport.reportID, createdReportActionID: createdAction.reportActionID}; src/libs/actions/Transaction.ts [728-732] if (!selfDMReport && reportID === CONST.REPORT.UNREPORTED_REPORT_ID) { const currentTime = DateUtils.getDBTime(); selfDMReport = buildOptimisticSelfDMReport(currentTime); selfDMCreatedReportAction = buildOptimisticCreatedReportAction(email ?? '', currentTime); selfDMReportID = selfDMReport.reportID; Solution Walkthrough: Before: // In src/libs/ReportUtils.ts function prepareOnboardingOnyxData(...) { // ... if (isPersonalSpendOrTrackWorkspace) { let selfDMReport = allReports?.[...]; if (!selfDMReport) { const currentTime = DateUtils.getDBTime(); selfDMReport = buildOptimisticSelfDMReport(currentTime); // ... more logic to create optimistic data } } } // In src/libs/actions/Transaction.ts function changeTransactionsReport(...) { // ... if (!selfDMReport && reportID === CONST.REPORT.UNREPORTED_REPORT_ID) { const currentTime = DateUtils.getDBTime(); selfDMReport = buildOptimisticSelfDMReport(currentTime); // ... more logic to create optimistic data } } After: // In a new utility file or existing one e.g., ReportUtils.ts function getOrCreateOptimisticSelfDMReport() { let selfDMReport = allReports?.[`${ONYXKEYS.COLLECTION.REPORT}${findSelfDMReportID()}`]; if (selfDMReport) { return { selfDMReport, optimisticData: [] }; } const currentTime = DateUtils.getDBTime(); selfDMReport = buildOptimisticSelfDMReport(currentTime); const createdAction = buildOptimisticCreatedReportAction(...); // ... logic to build optimistic data array return { selfDMReport, optimisticData }; } // In src/libs/ReportUtils.ts function prepareOnboardingOnyxData(...) { // ... const { selfDMReport, optimisticData } = getOrCreateOptimisticSelfDMReport(); // ... use the returned values } // In src/libs/actions/Transaction.ts function changeTransactionsReport(...) { // ... const { selfDMReport, optimisticData } = getOrCreateOptimisticSelfDMReport(); // ... use the returned values } Suggestion importance[1-10]: 6 __ Why: The suggestion correctly identifies duplicated logic for optimistic selfDM report creation in prepareOnboardingOnyxData and changeTransactionsReport, which is a valid code quality concern that improves maintainability.	Low
More