Improve ReportActions debugging by VickyStash · Pull Request #56867 · Expensify/App

VickyStash · 2025-02-14T08:01:59Z

Explanation of Change

Add improvements to the Debug Mode to simplify ReportActions debugging.

Fixed Issues

$ #56853
PROPOSAL: N/A

Tests

Verify that no errors appear in the JS console

Open the app and log in.
Open the developer menu by pressing CMD+D or tap the screen with four fingers at once.
Turn on Debug mode toggle on.
Open any chat.
Open any message/expense menu and tap on the Debug option. Make sure debug information for the report action is opened and works as usual. Repeat the same for several different messages.
Tap on the chat header -> select Debug in the details.
Go to the Actions tab. See that now it has a search bar, and action items have message information.
Try to search for action by text message or report action id, make sure it works as expected.

Offline tests

Same, as in the Tests section.

QA Steps

Verify that no errors appear in the JS console

Same, as in the Tests section.

PR Author Checklist

Screenshots/Videos

Android: Native

android.mp4

Android: mWeb Chrome

android_web.mp4

iOS: Native

ios.mp4

iOS: mWeb Safari

ios_web.mp4

MacOS: Chrome / Safari

web.mp4

MacOS: Desktop

desktop.mp4

…t showing

…rovements

melvin-bot · 2025-02-14T11:22:00Z

@DylanDylann 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]

VickyStash · 2025-02-17T07:46:15Z

@DylanDylann any ETA on reviewing this one?

DylanDylann · 2025-02-17T08:25:10Z

@VickyStash The system message is displayed incompletely

VickyStash · 2025-02-17T10:38:54Z

@VickyStash The system message is displayed incompletely

@DylanDylann I've investigated the issue, and it looks like the problem is in the Parser.htmlToText function.
It can parse the mention-user tag in the user message but not in the system message.

User message HTML string passed to the parser: Hi <mention-user accountID="18439984"/>, how are you?
System message HTML string passed to the parser: Assigned <mention-user accountID=18439984></mention-user> a company card! Imported transactions will appear in this chat.

I'm not sure if it should be fixed as part of this PR, any thoughts @DylanDylann ?

DylanDylann · 2025-02-17T10:44:59Z

Could you apply the same logic that we did on the report screen or on the LHN or copy to clipboard?

Screen.Recording.2025-02-17.at.17.43.58.mov

VickyStash · 2025-02-17T14:45:15Z

@DylanDylann, I've applied a fix. Could you take another look?

DylanDylann · 2025-02-18T08:15:36Z

BUG: The deleted message isn't displayed.

My suggestion: We shouldn't hide deleted messages from the report action debug list. But let's display "Deleted message", then we still can check these report actions in debug mode

Screen.Recording.2025-02-18.at.15.08.18.mov

DylanDylann · 2025-02-18T08:16:22Z

BUG: The created message displays the wrong creator

Screen.Recording.2025-02-18.at.15.09.56.mov

DylanDylann · 2025-02-18T08:17:20Z

NAB: In debug mode, we still display some messages that is hidden on the report screen. But I think it is fine, because users should see all report actions on the debug mode

VickyStash · 2025-02-18T11:32:58Z

@DylanDylann the feedback has been applied!

DylanDylann · 2025-02-19T08:46:04Z

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 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 the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
- 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.js 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.
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-02-19.at.15.50.48.mov

Android: mWeb Chrome

Screen.Recording.2025-02-19.at.15.20.27.mov

iOS: Native

Screen.Recording.2025-02-19.at.15.46.31.mov

iOS: mWeb Safari

Screen.Recording.2025-02-19.at.15.38.20.mov

MacOS: Chrome / Safari

Screen.Recording.2025-02-19.at.14.09.13.mov

MacOS: Desktop

Screen.Recording.2025-02-19.at.15.19.15.mov

puneetlath · 2025-02-19T15:02:51Z

    const [report] = useOnyx(`${ONYXKEYS.COLLECTION.REPORT}${reportID}`);
-    const canUserPerformWriteAction = ReportUtils.canUserPerformWriteAction(report);
+    const [policy] = useOnyx(`${ONYXKEYS.COLLECTION.POLICY}${report?.policyID}`);
+    const ifUserCanPerformWriteAction = canUserPerformWriteAction(report);


Any reason why we shouldn't just use the same term?

Suggested change

const ifUserCanPerformWriteAction = canUserPerformWriteAction(report);

const canUserPerformWriteAction = canUserPerformWriteAction(report);

@puneetlath it gives lint error

Ok, got it!

OSBotify · 2025-02-19T15: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-02-20T03:07:29Z

🚀 Deployed to staging by https://github.com/puneetlath in version: 9.1.2-0 🚀

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

github-actions · 2025-02-20T22:00:43Z

🚀 Deployed to production by https://github.com/francoisl in version: 9.1.2-1 🚀

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

hoangzinh · 2025-03-19T12:15:25Z

+                textInputLabel={translate('common.search')}
+                onChangeText={setSearchValue}
+                onSelectRow={(item) => Navigation.navigate(ROUTES.DEBUG_REPORT_ACTION.getRoute(reportID, item.reportActionID))}
+                ListItem={RadioListItem}


Coming from #57313, we need to pass headerMessage to display no results text. More details: #57313 (comment)

jjcoffee · 2025-12-11T14:09:10Z

+        return (sortedAllReportActions ?? [])
+            .filter(
+                (reportAction) =>
+                    reportAction.reportActionID.includes(debouncedSearchValue) || getReportActionMessageText(reportAction).toLowerCase().includes(debouncedSearchValue.toLowerCase()),


Coming from #75838, there's a discrepancy between getReportActionMessageText and getReportActionDebugText (which is used for display), so some searches were not returning results. Fixed in #76474.

VickyStash added 8 commits February 6, 2025 12:44

Use SectionList to display debug report actions. Add search and amoun…

30f5ed3

…t showing

Add navigation from the preview to the report action

4d447bb

Add debug option to report action context menu

86f5be0

Add report action message preview

7af22f8

Merge branch 'refs/heads/main' into VickyStash/feature/debug-mode-imp…

156b8bc

…rovements

Remove unnecessary changes

6e7e4a8

Lint fixes

1a3c859

Remove todo

a843fb6

VickyStash marked this pull request as ready for review February 14, 2025 11:21

VickyStash requested a review from a team as a code owner February 14, 2025 11:21

melvin-bot Bot requested a review from DylanDylann February 14, 2025 11:21

melvin-bot Bot removed the request for review from a team February 14, 2025 11:22

VickyStash mentioned this pull request Feb 14, 2025

[Due for payment 2025-02-27] Improve ReportActions debugging #56853

Closed

fabioh8010 reviewed Feb 14, 2025

View reviewed changes

Comment thread src/pages/Debug/Report/DebugReportActions.tsx Outdated

Comment thread src/pages/Debug/Report/DebugReportActions.tsx Outdated

Use useDebouncedState hook

4e0bd23

VickyStash requested a review from fabioh8010 February 14, 2025 12:17

fabioh8010 approved these changes Feb 14, 2025

View reviewed changes

Fix mention display

154e020

VickyStash added 3 commits February 18, 2025 10:55

Show deleted messages

c6b3903

Minor fix

68166ba

Improve created message display

4102bdd

DylanDylann approved these changes Feb 19, 2025

View reviewed changes

melvin-bot Bot requested a review from puneetlath February 19, 2025 08:13

DylanDylann approved these changes Feb 19, 2025

View reviewed changes

puneetlath requested changes Feb 19, 2025

View reviewed changes

puneetlath approved these changes Feb 19, 2025

View reviewed changes

puneetlath merged commit 0c3a045 into Expensify:main Feb 19, 2025

github-actions Bot mentioned this pull request Feb 20, 2025

Deploy Checklist: New Expensify 2025-02-20 #57146

Closed

30 tasks

hoangzinh reviewed Mar 19, 2025

View reviewed changes

jjcoffee reviewed Dec 11, 2025

View reviewed changes

	const ifUserCanPerformWriteAction = canUserPerformWriteAction(report);
	const canUserPerformWriteAction = canUserPerformWriteAction(report);

Uh oh!

Conversation

VickyStash commented Feb 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!

melvin-bot Bot commented Feb 14, 2025

Uh oh!

Uh oh!

Uh oh!

VickyStash commented Feb 17, 2025

Uh oh!

DylanDylann commented Feb 17, 2025

Uh oh!

VickyStash commented Feb 17, 2025

Uh oh!

DylanDylann commented Feb 17, 2025

Uh oh!

VickyStash commented Feb 17, 2025

Uh oh!

DylanDylann commented Feb 18, 2025

Uh oh!

DylanDylann commented Feb 18, 2025

Uh oh!

DylanDylann commented Feb 18, 2025

Uh oh!

VickyStash commented Feb 18, 2025

Uh oh!

DylanDylann commented Feb 19, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer Checklist

Screenshots/Videos

Uh oh!

puneetlath Feb 19, 2025

Choose a reason for hiding this comment

Uh oh!

VickyStash Feb 19, 2025

Choose a reason for hiding this comment

Uh oh!

puneetlath Feb 19, 2025

Choose a reason for hiding this comment

Uh oh!

OSBotify commented Feb 19, 2025

Uh oh!

github-actions Bot commented Feb 20, 2025

Uh oh!

github-actions Bot commented Feb 20, 2025

Uh oh!

hoangzinh Mar 19, 2025

Choose a reason for hiding this comment

Uh oh!

jjcoffee Dec 11, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

VickyStash commented Feb 14, 2025 •

edited

Loading

DylanDylann commented Feb 19, 2025 •

edited

Loading