Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add LHN debugging to Debug Mode #48442

Conversation

pac-guerreiro
Copy link
Contributor

@pac-guerreiro pac-guerreiro commented Sep 3, 2024

Details

Fixed Issues

$#46992
PROPOSAL: N/A

Tests

  1. On home page, open a chat report from LHN
  2. Click on the header of the chat you just opened, then click on Debug
  3. On the Details tab, confirm that "Visible in LHN" provides the correct reason for the report to be shown on LHN
  4. Confirm that "GBR" shows the correct reason, if the report has GBR in LHN
  5. Confirm that "RBR" shows the correct reason, if the report has RBR in LHN

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

Android: mWeb Chrome

Android - Web

iOS: Native

Screenshot 2024-09-25 at 17 52 15

iOS: mWeb Safari

iOS - Safari

MacOS: Chrome / Safari MacOS - Chrome
MacOS: Desktop MacOS - Native

@pac-guerreiro pac-guerreiro marked this pull request as ready for review September 3, 2024 09:15
@pac-guerreiro pac-guerreiro requested a review from a team as a code owner September 3, 2024 09:15
@pac-guerreiro pac-guerreiro changed the title Add LHN debugging to Debug Mode [Do Not Merge Yet] Add LHN debugging to Debug Mode Sep 3, 2024
@melvin-bot melvin-bot bot requested review from blimpich and removed request for a team September 3, 2024 09:15
Copy link

melvin-bot bot commented Sep 3, 2024

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

Copy link
Contributor

@fabioh8010 fabioh8010 left a comment

Choose a reason for hiding this comment

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

Partial review for now

src/libs/DebugUtils.ts Outdated Show resolved Hide resolved
src/libs/DebugUtils.ts Outdated Show resolved Hide resolved
tests/unit/DebugUtilsTest.ts Outdated Show resolved Hide resolved
tests/unit/DebugUtilsTest.ts Outdated Show resolved Hide resolved
Copy link
Contributor

@blimpich blimpich left a comment

Choose a reason for hiding this comment

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

I realize some instances won't be possible to change but is it possible to get rid of some of the as casts we are using in this PR?

src/pages/Debug/DebugDetails.tsx Outdated Show resolved Hide resolved
src/pages/Debug/DebugDetails.tsx Outdated Show resolved Hide resolved
@pac-guerreiro pac-guerreiro force-pushed the pac-guerreiro/feature/46992-add-lhn-debugging-to-debug-mode branch from cd7391c to 31a8c94 Compare September 20, 2024 15:30
@pac-guerreiro pac-guerreiro changed the title [Do Not Merge Yet] Add LHN debugging to Debug Mode Add LHN debugging to Debug Mode Sep 23, 2024
src/libs/DebugUtils.ts Outdated Show resolved Hide resolved
src/libs/DebugUtils.ts Outdated Show resolved Hide resolved
src/libs/DebugUtils.ts Outdated Show resolved Hide resolved
src/libs/DebugUtils.ts Outdated Show resolved Hide resolved
src/libs/ReportUtils.ts Outdated Show resolved Hide resolved
src/pages/Debug/Report/DebugReportPage.tsx Outdated Show resolved Hide resolved
src/pages/Debug/Report/DebugReportPage.tsx Outdated Show resolved Hide resolved
src/pages/Debug/Report/DebugReportPage.tsx Outdated Show resolved Hide resolved
src/pages/Debug/Report/DebugReportPage.tsx Outdated Show resolved Hide resolved
Copy link
Contributor

@blimpich blimpich left a comment

Choose a reason for hiding this comment

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

one comment, otherwise looks good, will wait on Fabio to approve before giving final approval

src/languages/en.ts Outdated Show resolved Hide resolved
Copy link
Contributor

@fabioh8010 fabioh8010 left a comment

Choose a reason for hiding this comment

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

LGTM, what's missing @pac-guerreiro:

  1. Fix prettier / lint errors
  2. Add screenshots / videos

blimpich
blimpich previously approved these changes Sep 25, 2024
@pac-guerreiro
Copy link
Contributor Author

@blimpich @fabioh8010 @mountiny

PR is ready to be merged!

@DylanDylann
Copy link
Contributor

DylanDylann commented Oct 3, 2024

@pac-guerreiro The logic to display RBR still be different in LHN

Screen.Recording.2024-10-03.at.16.42.28.mov

In LHN, we display RBR in these cases. Let's mirror it for this feature

result.brickRoadIndicator = hasErrors || hasViolations ? CONST.BRICK_ROAD_INDICATOR_STATUS.ERROR : '';

result.brickRoadIndicator = CONST.BRICK_ROAD_INDICATOR_STATUS.ERROR;

{
title: translate('debug.RBR'),
subtitle: translate(`debug.${hasRBR}`),
action: reportActionRBR
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
action: reportActionRBR
action: hasRBR && reportActionRBR

@DylanDylann
Copy link
Contributor

@pac-guerreiro This bug still can reproduce.

In DebugReportPage, please help to add the third param parentReportAction with the below definition

    const [parentReportActions] = useOnyx(`${ONYXKEYS.COLLECTION.REPORT_ACTIONS}${report?.parentReportID || '-1'}`);
    const parentReportAction = parentReportActions && report?.parentReportID ? parentReportActions[report?.parentReportActionID || '-1'] : undefined;

@DylanDylann
Copy link
Contributor

DylanDylann commented Oct 4, 2024

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-04.at.15.19.51.mov
Android: mWeb Chrome
Screen.Recording.2024-10-04.at.15.17.36.mov
iOS: Native
Screen.Recording.2024-10-04.at.18.09.48.mov
iOS: mWeb Safari
Screen.Recording.2024-10-04.at.18.08.02.mov
MacOS: Chrome / Safari
Screen.Recording.2024-10-04.at.15.14.23.mov
MacOS: Desktop
Screen.Recording.2024-10-04.at.15.15.50.mov

@pac-guerreiro
Copy link
Contributor Author

@DylanDylann

Thank you for the feedback! I just pushed the changes you requested 😄

mountiny
mountiny previously approved these changes Oct 4, 2024
Copy link
Contributor

@mountiny mountiny left a comment

Choose a reason for hiding this comment

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

Small comment

@@ -234,6 +234,27 @@ function getOrderedReportIDs(
return LHNReports;
}

function isRedBrickRoad(report: Report, reportActions: OnyxEntry<ReportActions>, hasViolations: boolean, transactionViolations?: OnyxCollection<TransactionViolation[]>) {
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
function isRedBrickRoad(report: Report, reportActions: OnyxEntry<ReportActions>, hasViolations: boolean, transactionViolations?: OnyxCollection<TransactionViolation[]>) {
function shouldShowRedBrickRoad(report: Report, reportActions: OnyxEntry<ReportActions>, hasViolations: boolean, transactionViolations?: OnyxCollection<TransactionViolation[]>) {

result.brickRoadIndicator = CONST.BRICK_ROAD_INDICATOR_STATUS.ERROR;
}
}
result.brickRoadIndicator = isRedBrickRoad(report, reportActions, hasViolations, transactionViolations) ? CONST.BRICK_ROAD_INDICATOR_STATUS.ERROR : '';
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
result.brickRoadIndicator = isRedBrickRoad(report, reportActions, hasViolations, transactionViolations) ? CONST.BRICK_ROAD_INDICATOR_STATUS.ERROR : '';
result.brickRoadIndicator = shouldShowRedBrickRoad(report, reportActions, hasViolations, transactionViolations) ? CONST.BRICK_ROAD_INDICATOR_STATUS.ERROR : '';

neil-marcellini
neil-marcellini previously approved these changes Oct 4, 2024
Copy link
Contributor

@neil-marcellini neil-marcellini left a comment

Choose a reason for hiding this comment

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

The code looks great to me. I left some NAB comments that could be addressed in a follow up. I'm excited for this feature, I think things will start to make a lot more sense when bugs happen. Thanks.


for (const action of reportActionsArray) {
if (action && !isEmptyObject(action.errors)) {
Object.assign(reportActionErrors, action.errors);

if (!reportAction) {
Copy link
Contributor

Choose a reason for hiding this comment

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

NAB: Instead of this check in every iteration, and going through all actions, can we instead assign the reportAction var and then break out of the loop?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

The original code iterated over all report actions to get their errors, so if I break the loop it will affect the current app behaviour.

Since there can be multiple report actions with errors, I'm just picking the first report action that shows up

Copy link
Contributor

Choose a reason for hiding this comment

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

So if we're just picking the first one then I think we can break out of the loop. NAB, please fix in a follow up.

src/libs/OptionsListUtils.ts Show resolved Hide resolved
);
expect(reportAction).toBeUndefined();
});
// TODO: remove '.failing' once the implementation is fixed
Copy link
Contributor

Choose a reason for hiding this comment

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

NAB: Do we have an issue to track this?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Not that I'm aware of

Copy link
Contributor

Choose a reason for hiding this comment

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

Would you please create one or ask in Slack to have an issue created?

Copy link
Contributor Author

@pac-guerreiro pac-guerreiro Oct 8, 2024

Choose a reason for hiding this comment

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

@neil-marcellini I just checked and it seems there's no implementation issue.

The test is just outdated with the new implementation, so I'll fix it in this PR - #50468 - if that's okay with you? 😄

@DylanDylann
Copy link
Contributor

@pac-guerreiro Could you please resolve this PR?

@pac-guerreiro
Copy link
Contributor Author

@DylanDylann on it, will push changes in a few minutes

…g-to-debug-mode

# Conflicts:
#	src/libs/actions/IOU.ts
Copy link
Contributor

@neil-marcellini neil-marcellini left a comment

Choose a reason for hiding this comment

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

Merging this 🚀

@neil-marcellini
Copy link
Contributor

Idk why the reviewer checklist is failing, I can see that it's fully filled out, so merging.

@neil-marcellini neil-marcellini merged commit 0c4b2d1 into Expensify:main Oct 7, 2024
15 of 19 checks passed
@OSBotify
Copy link
Contributor

OSBotify commented Oct 7, 2024

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

Copy link
Contributor

github-actions bot commented Oct 7, 2024

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

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

@IuliiaHerets
Copy link

This PR is failing for Desktop because of issue #50403

Copy link
Contributor

github-actions bot commented Oct 9, 2024

🚀 Deployed to production by https://github.com/thienlnam in version: 9.0.46-5 🚀

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

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

Successfully merging this pull request may close these issues.

9 participants