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

Debug mode for Inbox tab GBR doesn't handle multi-policy #51425

Conversation

pac-guerreiro
Copy link
Contributor

@pac-guerreiro pac-guerreiro commented Oct 24, 2024

Details

Fixed Issues

$#51271
PROPOSAL:

  • Add reportID to optimistic reports in order to fix debug mode showing reports with undefined reportID in url
  • Also map existing reports with no reportID with their collection key
  • Debug mode now redirects user to debug report page instead of report page to help diagnose what's happening and allow for deletion
  • Debug report page now shows a View Report button to redirect the user to the report page. This is useful when we don't access the debug report page from the report page.

Tests

On web

  1. Open a report that doesn't exist from the url (e.g. r/123456)
  2. The view above the bottom navigation bar will show up a message saying There's a report with errors
  3. Clicking on View button will open the RHP with the debug report page with the data of the offending report
  4. Deleting the report will clear the RBR

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: mWeb Chrome
Android.-.Chrome.mp4
iOS: Native
iOS: mWeb Safari
iOS.-.Safari.mp4
MacOS: Chrome / Safari
MacOS.-.Chrome.mp4
MacOS: Desktop

@pac-guerreiro
Copy link
Contributor Author

Today's update:

  • Add reportID to optimistic report
  • Extract reportID from report key to prevent redirecting the user to reports with undefined IDs
  • Add View Report button in debug report page

Todo:

  • Prevent report from being re-fetched after deleting it from debug report page
  • Add screen recordings
  • Add QA steps

@pac-guerreiro pac-guerreiro marked this pull request as ready for review October 25, 2024 21:18
@pac-guerreiro pac-guerreiro requested a review from a team as a code owner October 25, 2024 21:18
@melvin-bot melvin-bot bot requested a review from DylanDylann October 25, 2024 21:18
Copy link

melvin-bot bot commented Oct 25, 2024

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

@melvin-bot melvin-bot bot removed the request for review from a team October 25, 2024 21:18
@pac-guerreiro
Copy link
Contributor Author

@puneetlath @DylanDylann

I'm setting this PR as ready for review although it's missing QA steps and screen recordings for native app.

I'll add these next Monday!

@pac-guerreiro
Copy link
Contributor Author

@puneetlath @DylanDylann

I wasn't able to find steps to test this on native platforms yet. Will continue my research tomorrow!

@DylanDylann
Copy link
Contributor

@pac-guerreiro Sorry for my delay

@DylanDylann
Copy link
Contributor

We are displaying the error indicator on LHN even though there are no error reports. It confused me

Screenshot 2024-10-29 at 16 12 59

@DylanDylann
Copy link
Contributor

On LHN, we use useReportIDs hook to filter and sort reports first

const {orderedReportIDs, currentReportID, policyMemberAccountIDs} = useReportIDs();

I think we should apply the logic in useReportIDs into getChatTabBrickRoadReport to make it consistent

@DylanDylann
Copy link
Contributor

I wasn't able to find steps to test this on native platforms yet. Will continue my research tomorrow!

  • Android: open the deep link from Terminal: npx uri-scheme open new-expensify://concierge --android
  • iOS: open the deep link from Terminal: npx uri-scheme open new-expensify://concierge --ios
  • Desktop: open the deep link from console: window.location.href="/settings/workspaces"

Anyways, I can help you with this step

@pac-guerreiro
Copy link
Contributor Author

We are displaying the error indicator on LHN even though there are no error reports. It confused me

This is known and will be addressed here - #51488

@pac-guerreiro
Copy link
Contributor Author

On LHN, we use useReportIDs hook to filter and sort reports first

const {orderedReportIDs, currentReportID, policyMemberAccountIDs} = useReportIDs();

I think we should apply the logic in useReportIDs into getChatTabBrickRoadReport to make it consistent

I think that's the solution for #51488

@pac-guerreiro
Copy link
Contributor Author

I wasn't able to find steps to test this on native platforms yet. Will continue my research tomorrow!

  • Android: open the deep link from Terminal: npx uri-scheme open new-expensify://concierge --android
  • iOS: open the deep link from Terminal: npx uri-scheme open new-expensify://concierge --ios
  • Desktop: open the deep link from console: window.location.href="/settings/workspaces"

Anyways, I can help you with this step

Oh nice, today I learned 😄

But I was aiming for reproduction steps inside the app it self as an user, do you know how to use deep links without the terminal or console?

Also there's a case that I am not able to reproduce which is a workspace chat that existed but then the user started receiving not found errors.

Here is the onyx data for a report where this happens:

"report_8056514671453445": {
    "chatReportID": "5966879180236894",
    "chatType": "",
    "currency": "USD",
    "description": "",
    "errorFields": {
      "notFound": {
        "1729100863505463": "Report not found",
        "1729614594061340": "Report not found",
        "1729614643262146": "Report not found",
        "1729615320612665": "Report not found",
        "1729615341326930": "Report not found",
        "1729615344962131": "Report not found",
        "1729616332028548": "Report not found",
        "1729616365333863": "Report not found"
      }
    },
    "hasOutstandingChildRequest": false,
    "hasOutstandingChildTask": false,
    "hasParentAccess": true,
    "isCancelledIOU": false,
    "isOwnPolicyExpenseChat": false,
    "isPinned": false,
    "isWaitingOnBankAccount": false,
    "lastActionType": "IOU",
    "lastActorAccountID": "12032073",
    "lastMessageHtml": "$0.00 expense",
    "lastMessageText": "$0.00 expense",
    "lastReadSequenceNumber": 0,
    "lastVisibleActionCreated": "2024-10-16 17:42:06.439",
    "lastVisibleActionLastModified": "2024-10-16 17:42:06.439",
    "nonReimbursableTotal": 0,
    "notificationPreference": "hidden",
    "oldPolicyName": "",
    "parentReportActionID": "3470603815071771046",
    "parentReportID": "5966879180236894",
    "permissions": [],
    "private_isArchived": "",
    "reportID": "8056514671453445",
    "reportName": "Expense Report #8056514671453445",
    "stateNum": 1,
    "statusNum": 1,
    "total": -13794,
    "type": "expense",
    "unheldTotal": -13794,
    "welcomeMessage": "",
    "writeCapability": "all"
  }

@@ -236,7 +237,10 @@ function DebugDetails({data, children, onSave, onDelete, validate}: DebugDetails
text={translate('common.delete')}
onPress={() => {
onDelete();
Navigation.goBack();
// Dismiss the current report screen and replace it with Concierge Chat
Copy link
Contributor

Choose a reason for hiding this comment

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

@pac-guerreiro Why should we do that?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@DylanDylann This is a workaround I found to prevent the app from fetching the report data again, it's based on this:

Screenshot 2024-10-29 at 10 21 22

But now that I'm seeing this again, I think I should just use Report.navigateToConciergeChatAndDeleteReport instead of duplicating code

src/libs/actions/Report.ts Outdated Show resolved Hide resolved
src/libs/WorkspacesSettingsUtils.ts Outdated Show resolved Hide resolved
…R in LHN"

This reverts commit a3b1513.

# Conflicts:
#	src/libs/WorkspacesSettingsUtils.ts
@pac-guerreiro
Copy link
Contributor Author

@DylanDylann I just reverted the commits that added reportID to reports that were missing it

@pac-guerreiro
Copy link
Contributor Author

@DylanDylann I replaced the old logic to navigate after deleting a report with navigateToConciergeChatAndDeleteReport function

@DylanDylann
Copy link
Contributor

DylanDylann commented Oct 31, 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-31.at.11.51.21.mov
Android: mWeb Chrome
Screen.Recording.2024-10-31.at.11.50.03.mov
iOS: Native
Screen.Recording.2024-10-31.at.11.48.54.mov
iOS: mWeb Safari
Screen.Recording.2024-10-31.at.11.45.00.mov
MacOS: Chrome / Safari
Screen.Recording.2024-10-31.at.11.42.51.mov
MacOS: Desktop
Screen.Recording.2024-10-31.at.11.46.49.mov

@melvin-bot melvin-bot bot requested a review from puneetlath October 31, 2024 08:14
@pac-guerreiro
Copy link
Contributor Author

Waiting for the final review from @puneetlath

@puneetlath puneetlath merged commit 5a63cc5 into Expensify:main Nov 5, 2024
17 checks passed
@OSBotify
Copy link
Contributor

OSBotify commented Nov 5, 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 Nov 6, 2024

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

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

@IuliiaHerets
Copy link

This PR is failing because of issue #52104

Copy link
Contributor

github-actions bot commented Nov 7, 2024

🚀 Deployed to production by https://github.com/Julesssss in version: 9.0.58-2 🚀

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

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.

5 participants