Add debug option to LHN context menu #50519

pac-guerreiro · 2024-10-09T20:34:20Z

Details

Fixed Issues

$#46992
PROPOSAL:
Add option to debug a report from LHN context menu without triggering OpenReport API call. This way a user can debug the current state of the report without replacing it with the state from the API.

Tests

On home page, right-click or long press a report from LHN, then select Debug
The app should show the current state of the report without fetching a new state from the API, in debug page

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

…g-to-debug-mode

melvin-bot · 2024-10-09T20:34:25Z

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

src/pages/home/report/ContextMenu/ContextMenuActions.tsx

pac-guerreiro · 2024-10-10T08:32:11Z

@DylanDylann

I just pushed the changes you requested 😄

I did notice a possible bug during my refactor which I reported in #expensify-open-source:

Hey all, should users be allowed to copy onyx data from LHN in production?
I noticed that in the code we have a condition to hide it in production but we are using reportAction as isProduction in ContextMenuActions.tsx, which might evaluate to true in production.

src/pages/home/report/ContextMenu/BaseReportActionContextMenu.tsx

DylanDylann · 2024-10-10T09:08:22Z

@pac-guerreiro Some left comments. Please help to check

pac-guerreiro · 2024-10-10T09:23:21Z

@DylanDylann

Nice catches once again 😄

Just pushed the changes you requested!

src/pages/home/report/ContextMenu/BaseReportActionContextMenu.tsx

pac-guerreiro · 2024-10-10T10:01:48Z

@DylanDylann

Just added the missing equality check to memo!

DylanDylann · 2024-10-10T10:45:21Z

src/pages/home/report/ContextMenu/BaseReportActionContextMenu.tsx

-        // We only want to re-render when the report action that is attached to is changed
-        if (prevReportAction !== nextReportAction) {
-            return false;
-        }
-


@pac-guerreiro I am having trouble with this place. It seems lodashIsEqual(prevPropsWithoutReportActions, nextPropsWithoutReportActions); can't detect the different between prevReportAction and nextReportAction

@pac-guerreiro note that we implemented a customized function instead of lodashIsEqual function only in memo

I only want to make sure our change doesn't break any old behavior

@DylanDylann

reportActions was injected into the component by withOnyx as a prop, but I removed withOnyx and reportActions is now returned by useOnyx, so it doesn't make sense to do this check anymore inside memo.

The component will be re-rendered if useOnyx is triggered by some change to reportActions, so I think the old behaviour should be the same

DylanDylann · 2024-10-11T09:32:21Z

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.2024-10-11.at.16.41.34.mov

Android: mWeb Chrome

Screen.Recording.2024-10-11.at.16.39.30.mov

iOS: Native

Screen.Recording.2024-10-11.at.16.41.05.mov

iOS: mWeb Safari

Screen.Recording.2024-10-11.at.16.36.25.mov

MacOS: Chrome / Safari

Screen.Recording.2024-10-11.at.16.32.34.mov

MacOS: Desktop

Screen.Recording.2024-10-11.at.16.35.27.mov

neil-marcellini

Looks great thanks. I like what you did cleaning up the shouldShow arguments!

OSBotify · 2024-10-11T17:06:36Z

✋ 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 · 2024-10-15T03:31:02Z

🚀 Deployed to staging by https://github.com/neil-marcellini in version: 9.0.49-0 🚀

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

github-actions · 2024-10-17T01:45:58Z

🚀 Deployed to production by https://github.com/marcaaron in version: 9.0.49-2 🚀

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

thesahindia · 2024-11-21T11:46:10Z

src/pages/home/report/ContextMenu/BaseReportActionContextMenu.tsx

+    const [reportActions] = useOnyx(`${ONYXKEYS.COLLECTION.REPORT_ACTIONS}${reportID}`, {
+        canEvict: false,
+    });
+    const transactionID = ReportActionsUtils.getLinkedTransactionID(reportActionID, reportID);


The changes caused a regression, details here.

pac-guerreiro added 2 commits October 9, 2024 21:25

feat(debug mode): add debug option to LHN context menu

6379568

Merge branch 'main' into pac-guerreiro/feature/46992-add-lhn-debuggin…

b48302e

…g-to-debug-mode

pac-guerreiro requested a review from a team as a code owner October 9, 2024 20:34

melvin-bot bot requested review from DylanDylann and removed request for a team October 9, 2024 20:34

pac-guerreiro mentioned this pull request Oct 9, 2024

[HOLD for payment 2024-10-24] [HOLD for payment 2024-10-16] Add LHN debugging to Debug Mode #46992

Closed

DylanDylann reviewed Oct 10, 2024

View reviewed changes

src/pages/home/report/ContextMenu/ContextMenuActions.tsx Outdated Show resolved Hide resolved

src/pages/home/report/ContextMenu/ContextMenuActions.tsx Outdated Show resolved Hide resolved

refactor(debug mode): apply suggestions

7665b16

pac-guerreiro requested a review from DylanDylann October 10, 2024 08:32

DylanDylann reviewed Oct 10, 2024

View reviewed changes

src/pages/home/report/ContextMenu/BaseReportActionContextMenu.tsx Show resolved Hide resolved

src/pages/home/report/ContextMenu/BaseReportActionContextMenu.tsx Show resolved Hide resolved

fix: performance issues caused by refactor

e73413b

DylanDylann reviewed Oct 10, 2024

View reviewed changes

src/pages/home/report/ContextMenu/BaseReportActionContextMenu.tsx Show resolved Hide resolved

fix: missing equality check in memo

642069b

pac-guerreiro requested a review from DylanDylann October 10, 2024 10:01

DylanDylann reviewed Oct 10, 2024

View reviewed changes

pac-guerreiro requested a review from DylanDylann October 10, 2024 15:02

DylanDylann approved these changes Oct 11, 2024

View reviewed changes

melvin-bot bot requested a review from neil-marcellini October 11, 2024 10:57

neil-marcellini approved these changes Oct 11, 2024

View reviewed changes

neil-marcellini merged commit 0510a66 into Expensify:main Oct 11, 2024
17 of 21 checks passed

github-actions bot mentioned this pull request Oct 15, 2024

Deploy Checklist: New Expensify 2024-10-15 #50764

Closed

71 tasks

lanitochka17 mentioned this pull request Oct 15, 2024

[$250] iOS Hybrid - Lack of debug mode in the settings - Troubleshoot for IOS Hybrid app #50843

Closed

6 tasks

jayeshmangwani mentioned this pull request Oct 17, 2024

Migrated from withOnyx to useOnyx for KYCWall #50999

Merged

50 tasks

thesahindia mentioned this pull request Nov 21, 2024

[HOLD for payment 2024-11-07] [$250] Expense - Console error (app crashes on native) when copying system message to clipboard #51127

Closed

8 tasks

thesahindia reviewed Nov 21, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add debug option to LHN context menu #50519

Add debug option to LHN context menu #50519

pac-guerreiro commented Oct 9, 2024 •

edited

Loading

melvin-bot bot commented Oct 9, 2024

pac-guerreiro commented Oct 10, 2024 •

edited

Loading

DylanDylann commented Oct 10, 2024 •

edited

Loading

pac-guerreiro commented Oct 10, 2024

pac-guerreiro commented Oct 10, 2024

DylanDylann Oct 10, 2024

DylanDylann Oct 10, 2024

DylanDylann Oct 10, 2024

pac-guerreiro Oct 10, 2024 •

edited

Loading

DylanDylann commented Oct 11, 2024 •

edited

Loading

neil-marcellini left a comment

OSBotify commented Oct 11, 2024

github-actions bot commented Oct 15, 2024

github-actions bot commented Oct 17, 2024

thesahindia Nov 21, 2024

Add debug option to LHN context menu #50519

Add debug option to LHN context menu #50519

Conversation

pac-guerreiro commented Oct 9, 2024 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Oct 9, 2024

pac-guerreiro commented Oct 10, 2024 • edited Loading

DylanDylann commented Oct 10, 2024 • edited Loading

pac-guerreiro commented Oct 10, 2024

pac-guerreiro commented Oct 10, 2024

DylanDylann Oct 10, 2024

Choose a reason for hiding this comment

DylanDylann Oct 10, 2024

Choose a reason for hiding this comment

DylanDylann Oct 10, 2024

Choose a reason for hiding this comment

pac-guerreiro Oct 10, 2024 • edited Loading

Choose a reason for hiding this comment

DylanDylann commented Oct 11, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

neil-marcellini left a comment

Choose a reason for hiding this comment

OSBotify commented Oct 11, 2024

github-actions bot commented Oct 15, 2024

github-actions bot commented Oct 17, 2024

thesahindia Nov 21, 2024

Choose a reason for hiding this comment

pac-guerreiro commented Oct 9, 2024 •

edited

Loading

pac-guerreiro commented Oct 10, 2024 •

edited

Loading

DylanDylann commented Oct 10, 2024 •

edited

Loading

pac-guerreiro Oct 10, 2024 •

edited

Loading

DylanDylann commented Oct 11, 2024 •

edited

Loading