Skip to content

New Feature: Support NewDot Unreported Expenses#60077

Merged
marcaaron merged 4 commits intoExpensify:mainfrom
ikevin127:ikevin127-supportUnreportedExpenses
Apr 16, 2025
Merged

New Feature: Support NewDot Unreported Expenses#60077
marcaaron merged 4 commits intoExpensify:mainfrom
ikevin127:ikevin127-supportUnreportedExpenses

Conversation

@ikevin127
Copy link
Copy Markdown
Contributor

@ikevin127 ikevin127 commented Apr 11, 2025

Explanation of Change

  1. Enhanced the openReport function in Report.ts to handle creating transaction threads for unreported expenses by:

    • Looking for the transaction data in Onyx
    • Finding the self DM report ID
    • Creating optimistic report data for the transaction thread
    • Creating optimistic parent report action on the self DM
    • Setting up the relationship between the thread and the parent report
  2. Updated the Search component to properly handle unreported expenses by:

    • Checking reportID === CONST.REPORT.UNREPORTED_REPORTID
    • Creating a new reportID for transaction threads
    • Passing the necessary parameters to create transaction threads including the transactionID

✅ The ReportScreen component already had the necessary logic to handle creating transaction threads when receiving a transactionID parameter (from previous draft PR).

🔄 These changes ensure that when a user clicks on an unreported expense in search results, we:

  1. Generate a new report ID for the transaction thread
  2. Create an optimistic transaction thread with a link to the self DM as the parent report
  3. Create an optimistic money request action on the self DM
  4. Pass the transactionID to the OpenReport API command to create the actual thread and parent action on the backend

This will allow users to view and interact with all historical unreported expenses, whether or not they were already added to the self DM chat.

Fixed Issues

$ #59863
PROPOSAL:

Tests

Prerequisite: Must have a very old unreported expense that was created in OldDot.

  1. Locate a very old unreported expense that was created in OldDot.
  2. Sign in to NewDot (can use staging or production API)
  3. Navigate to "Reports" and locate the old unreported expense.
  4. Tap the expense.
  5. Verify that it loads correctly.
  6. Verify in Onyx data that it now has both a transaction thread and a money request preview report action belonging to the self DM report.
  7. Verify that the transaction appears in the self dm chat.
  • Verify that no errors appear in the JS console

Offline tests

We should still be able to navigate to the transaction thread while offline.

QA Steps

Same as Tests. But can skip step 6.

  • 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 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
iOS: mWeb Safari
MacOS: Chrome / Safari
MacOS: Desktop

Copy link
Copy Markdown
Contributor

@marcaaron marcaaron left a comment

Choose a reason for hiding this comment

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

Thanks @ikevin127. This is looking really great!

Comment thread src/libs/API/parameters/OpenReportParams.ts
Comment thread src/libs/actions/Report.ts Outdated
Comment thread src/pages/home/ReportScreen.tsx
Comment thread src/libs/actions/Report.ts
Comment thread src/libs/actions/Report.ts Outdated
},
});

parameters.parentReportActionID = generatedReportActionID;
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.

Suggested change
parameters.parentReportActionID = generatedReportActionID;

Actually, the backend logic is going to check that we don't have this. It roughly does something like

if (!doesReportExist && !parentReportActionID && unreportedTransactionID) {
    // ... create the transaction thread   
}

Comment thread src/pages/home/ReportScreen.tsx
@marcaaron
Copy link
Copy Markdown
Contributor

Looking good. Almost there - just one small thing to address. Thanks!

@ikevin127
Copy link
Copy Markdown
Contributor Author

@marcaaron Great, applied the changes - shout if other changes are needed 👍 Please let me know when the backend PR is merged and whether this requires futher testing from my side (including steps) or you'll only test internally and we add [NoQA] here.

@ikevin127 ikevin127 marked this pull request as ready for review April 16, 2025 01:00
@ikevin127 ikevin127 requested a review from a team as a code owner April 16, 2025 01:00
@melvin-bot melvin-bot Bot requested review from rayane-d and removed request for a team April 16, 2025 01:00
@melvin-bot
Copy link
Copy Markdown

melvin-bot Bot commented Apr 16, 2025

@rayane-d 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]

@marcaaron
Copy link
Copy Markdown
Contributor

Gonna test this now. I was going to tag @puneetlath in to help test this. But realized I have a few super old reported expenses in my expensifail.com account.

@marcaaron
Copy link
Copy Markdown
Contributor

@rayane-d you can review the code if you want. testing will be hard.

Copy link
Copy Markdown
Contributor

@marcaaron marcaaron left a comment

Choose a reason for hiding this comment

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

This is working super well.

@marcaaron
Copy link
Copy Markdown
Contributor

Screenshot 2025-04-15 at 3 37 40 PM
Screenshot 2025-04-15 at 3 38 06 PM
Screenshot 2025-04-15 at 3 39 29 PM

@marcaaron
Copy link
Copy Markdown
Contributor

marcaaron commented Apr 16, 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: 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
Android: mWeb Chrome
iOS: Native
iOS: mWeb Safari
MacOS: Chrome / Safari
MacOS: Desktop

@marcaaron marcaaron removed the request for review from rayane-d April 16, 2025 01:43
@marcaaron
Copy link
Copy Markdown
Contributor

Actually this will just be a bit too hard to test @rayane-d I'm gonna drop you from the requested reviewers.

@marcaaron marcaaron merged commit 18021e0 into Expensify:main Apr 16, 2025
18 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.

@puneetlath
Copy link
Copy Markdown
Contributor

Should the "join" button be showing at the top of the unreported expense? I would've though you are automatically a participant in it.

@marcaaron
Copy link
Copy Markdown
Contributor

Nice spot. I think I must have missed something in the backend. I'll take a look. I don't think it's super bad to have that button there for now.

@marcaaron
Copy link
Copy Markdown
Contributor

Hmm actually seems like they should always be participants according to backend logic. Lemme check the test report again.

@marcaaron
Copy link
Copy Markdown
Contributor

Oh but it should have a default "HIDDEN" notification preference:

https://github.com/Expensify/Auth/blob/61ac54d907d4dd267857b3eaaf8d1d0aecccde3f/auth/lib/Transaction.cpp#L2471C1-L2488C1

So they are participants, but still must explicitly "Join"?

Here's the App logic: https://github.com/Expensify/App/blob/e37d15d210447cdd50bd6e65a3400a476dfd2f04/src/libs/ReportUtils.ts#L9225C1-L9249C2

It must be failing all these conditions.

@marcaaron
Copy link
Copy Markdown
Contributor

I'm not too sure what's happening with that because we're using the exact same logic we use when calling CreateTransaction for an unreported expense.

@github-actions
Copy link
Copy Markdown
Contributor

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

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

@puneetlath
Copy link
Copy Markdown
Contributor

Interesting. I definitely think it's fine for now and can be handled in a follow-up. Maybe we're treating it the way we do a chat thread with a "hidden" notification preference, which is an indication that you haven't "joined" it. Whereas with an expense report/expense thread, if you are a member of the report, then you have "joined" it, even if you have a "hidden" notification preference.

@github-actions
Copy link
Copy Markdown
Contributor

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

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants