[Debug Mode] Add transaction and violation data to debug mode

[pac-guerreiro]

Details

Fixed Issues

$#50335
PROPOSAL:

• Add transaction debug page, with details, json and violations tabs
• Add transaction violation page
• Add button to redirect user from report debug page to transaction report page
• Add button to redirect user from report action debug page to transaction report page

Tests

1. Enable debug mode in Troubleshoot
2. Open an expense thread (create one if you don't have any)
3. Enter debug view then check if there's a button named View transaction in details tab
4. Click the button and check the details, json and violations tabs
5. Confirm that any field you modify in details tab is saved correctly
6. On violations tab, try creating and modifying a violation and check that the UI shows your changes in real time

Offline tests

Same as tests

QA Steps

Same as tests

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 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
    • If any non-english text was added/modified, I verified the translation was requested/reviewed 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.js 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.
• 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.-.Native.mp4

Android: mWeb Chrome

Android.-.Chrome.mp4

iOS: Native

iOS.-.Native.mp4

iOS: mWeb Safari

iOS.-.Safari.mp4

MacOS: Chrome / Safari

MacOS.-.Chrome.mp4

MacOS: Desktop

MacOS.-.Native.mp4

[pac-guerreiro]

Todo:

• Create DebugUtils.validateTransactionDraftProperty plus unit tests
• Finish transaction violations tab
• Create button in debug report page to redirect to debug transaction page
• Add screen recordings
• Add QA testing steps

[pac-guerreiro]

I didn't have much time as I wanted to work on this today but here goes my update!

Today's update:

• Create DebugUtils.validateTransactionDraftProperty

Todo:

• Add remaining property validations to DebugUtils.validateTransactionDraftProperty
• Add unit tests for DebugUtils.validateTransactionDraftProperty
• Do some manual tests by modifying transaction data and saving it
• Finish transaction violations tab
• Create button in debug report page to redirect to debug transaction page
• Add screen recordings
• Add QA testing steps

[pac-guerreiro]

Today's update:

• Add remaining property validations to DebugUtils.validateTransactionDraftProperty
• Add unit tests for DebugUtils.validateTransactionDraftProperty
• Do some manual tests by modifying transaction data and saving it

Todo:

• Create TRANSACTION_FORM_INPUT_IDS
• Finish transaction violations tab
• Create button in debug report page to redirect to debug transaction page
• Add screen recordings
• Add QA testing steps

[pac-guerreiro]

Today's update:

• Create TRANSACTION_FORM_INPUT_IDS
• Create button in debug report page to redirect to debug transaction page
• Create button in debug report action page to redirect to debug transaction page
• Create button in debug transaction to redirect to report

Todo:

• Finish transaction violations tab
• Add screen recordings
• Add QA testing steps

[pac-guerreiro]

Today's update:

• Add transaction violation creation page

Todo:

• Fix issue where newly created transaction violation replaces all existing transaction violations
• Add transaction violation page to allow users to modify data, view JSON data representation and delete data
• Finish transaction violations tab
• Add screen recordings
• Add QA testing steps

[pac-guerreiro]

Today's update:

• Fix issue where newly created transaction violation replaces all existing transaction violations
• Add transaction violation page to allow users to modify data, view JSON data representation and delete data
• Finish transaction violations tab

Todo:

• Fix stale transaction violation data after updating a violation until the app is refreshed
• Refactor debug details constant field options. There are field name collisions between data types
• Add screen recordings
• Add QA testing steps

[pac-guerreiro]

Today's update:

• Fix stale transaction violation data after updating a violation until the app is refreshed
• Refactor debug details constant field options. There are field name collisions between data types

Todo:

• Add missing field names in debug details constant field options
• Add screen recordings
• Add QA testing steps

[pac-guerreiro]

@puneetlath @fabioh8010

All feedback addressed and conflicts resolved! Thanks for your feedback 😄

[puneetlath]

@pac-guerreiro can you merge main on this one? Then I'll give it a final review.

[pac-guerreiro]

@puneetlath

Sorry for the delay, I just resolved the remaining conflicts 😄

Today I noticed that debug report page was not saving data properly, can you confirm this?

[puneetlath]

Thanks for resolving the conflicts! Looks like we have some typescript failures now.

[puneetlath]

Today I noticed that debug report page was not saving data properly, can you confirm this?

In this PR or in the live app?

[pac-guerreiro]

@puneetlath just resolved the typescript issues!

In this PR or in the live app?

In main branch, so I guess at least in staging

[pac-guerreiro]

@puneetlath

I just confirmed that the problem is also present on this PR. I just pushed a fix for it 😄

The problem was that we we're saving debug data using Onyx.merge, which doesn't recognise implicit property removals from objects. So I replaced this method with Onyx.set, which replaces all the data.

[puneetlath]

So sorry @pac-guerreiro. This has conflicts again. If you ping me on Slack after resolving the conflicts, I can merge quickly.

[pac-guerreiro]

@puneetlath conflicts resolved 😄

[OSBotify]

✋ 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]

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

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

[github-actions]

🚀 Deployed to production by https://github.com/mountiny in version: 9.0.66-8 🚀

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