Reports with "report not found" error cause Inbox tab RBR by pac-guerreiro · Pull Request #51675 · Expensify/App

pac-guerreiro · 2024-10-29T15:37:57Z

Details

Fixed Issues

$#51488
PROPOSAL: #51488 (comment)

Tests

On web:

Open a report that doesn't exist from the browser URL (e.g. /r/12345)
Verify that inbox tab is not showing a red dot aka 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

…not-found-error-cause-inbox-tab-rbr

melvin-bot · 2024-10-29T15:38:02Z

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

DylanDylann · 2024-10-30T01:39:20Z

@pac-guerreiro Type script failed

DylanDylann · 2024-10-30T01:45:48Z

src/libs/WorkspacesSettingsUtils.ts

+
    // If policyID is undefined, then all reports are checked whether they contain any brick road
-    const policyReports = policyID ? Object.values(allReports).filter((report) => report?.policyID === policyID) : Object.values(allReports);
+    const policyReports = Object.values(allReports).filter((report) => !policyID || report?.policyID === policyID);


@pac-guerreiro Why do you change this? I think the previous way would have been better. It avoids the loop if policyID is undefined and saves more condition checks. Wdyt?

@DylanDylann You're totally right! I just looked at that line and thought I could simplify it 😅

I'll just revert this change, thanks

DylanDylann · 2024-10-30T01:51:47Z

src/libs/Navigation/AppNavigator/createCustomBottomTabNavigator/DebugTabView.tsx

    const navigateTo = useCallback(() => {
        if (selectedTab === SCREENS.HOME && !!chatTabBrickRoad) {
-            const report = getChatTabBrickRoadReport(activeWorkspaceID);
+            const report = getChatTabBrickRoadReport(activeWorkspaceID, currentReportID, reports, betas, policies, priorityMode, transactionViolations);


Could we use chatTabBrickRoad directly instead of getChatTabBrickRoadReport function?

chatTabBrickRoad doesn't include the report that I need to redirect the user

getChatTabBrickRoad return a report, right?

@DylanDylann nope, it returns a BrickRoad

DylanDylann · 2024-10-30T01:53:27Z

@fedirjh Please ignore this PR, I will take over it. Thanks

DylanDylann · 2024-10-30T01:58:31Z

@pac-guerreiro The rest looks fine

…not-found-error-cause-inbox-tab-rbr

pac-guerreiro · 2024-10-31T00:55:45Z

@DylanDylann all feedback was addressed 😄

…not-found-error-cause-inbox-tab-rbr

pac-guerreiro · 2024-10-31T16:20:48Z

@DylanDylann I just addressed the eslint issue 😄

DylanDylann · 2024-10-31T16:28:10Z

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.23.45.47.mov

Android: mWeb Chrome

Screen.Recording.2024-10-31.at.23.42.33.mov

iOS: Native

Screen.Recording.2024-10-31.at.23.46.56.mov

iOS: mWeb Safari

Screen.Recording.2024-10-31.at.23.47.35.mov

MacOS: Chrome / Safari

Screen.Recording.2024-10-31.at.23.39.59.mov

MacOS: Desktop

Screen.Recording.2024-10-31.at.23.41.26.mov

pac-guerreiro · 2024-11-05T07:39:54Z

Waiting for the final review from @puneetlath

puneetlath

For my understanding, what's the difference between src/libs/Navigation/AppNavigator/createCustomPlatformStackBottomTabNavigator/BottomTabBar.tsx and src/libs/Navigation/AppNavigator/createCustomBottomTabNavigator/BottomTabBar.tsx? It feels like there's a lot of duplicated code between the two.

puneetlath · 2024-11-05T20:42:03Z

src/libs/Navigation/AppNavigator/createCustomBottomTabNavigator/BottomTabBar.tsx

-    }, [activeWorkspaceID, transactionViolations, reports, reportActions]);
+        setChatTabBrickRoad(getChatTabBrickRoad(activeWorkspaceID, currentReportID, reports, betas, policies, priorityMode, transactionViolations));
+        // We need to get a new brick road state when report actions are updated, otherwise we'll be showing an outdated brick road.
+        // That's why reportActions is added as a dependency here


Hmm, why is this comment just about reportActions. All of these are needed since any of them can affect the RBR, right?

@puneetlath I left the comment specific for reportActions because they are not being used inside the effect explicitly. So to prevent someone from removing the prop from the dependencies list I added that comment 😄

Ah ok I see. That makes sense.

src/libs/Navigation/AppNavigator/createCustomPlatformStackBottomTabNavigator/BottomTabBar.tsx

pac-guerreiro · 2024-11-06T16:10:07Z

For my understanding, what's the difference between src/libs/Navigation/AppNavigator/createCustomPlatformStackBottomTabNavigator/BottomTabBar.tsx and src/libs/Navigation/AppNavigator/createCustomBottomTabNavigator/BottomTabBar.tsx? It feels like there's a lot of duplicated code between the two.

I feel the same as you, I would have two components, one with the common UI and logic and the other one with platform specific logic. But honestly I don't know what's the purpose of having the two components.

puneetlath · 2024-11-06T16:43:53Z

I feel the same as you, I would have two components, one with the common UI and logic and the other one with platform specific logic. But honestly I don't know what's the purpose of having the two components.

Maybe it's worth bringing to the #open-source room. We don't have to refactor it in this PR, but if there's an opportunity to get rid of duplicated logic, that would be great.

OSBotify · 2024-11-06T16:56:00Z

✋ 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-11-07T13:08:50Z

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

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

github-actions · 2024-11-11T18:14:25Z

🚀 Deployed to production by https://github.com/francoisl in version: 9.0.59-3 🚀

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

rayane-d · 2025-02-03T21:18:56Z

src/libs/WorkspacesSettingsUtils.ts

+    transactionViolations: OnyxCollection<TransactionViolation[]>,
+    policyMemberAccountIDs: number[] = [],
+): OnyxEntry<Report> {
+    const reportIDs = SidebarUtils.getOrderedReportIDs(currentReportId, reports, betas, policies, priorityMode, transactionViolations, policyID, policyMemberAccountIDs);


Using SidebarUtils.getOrderedReportIDs when calculating GBR/RBR state caused a performance issue: #55173
Proposal: #54802 (comment)
PR: #55260

pac-guerreiro added 2 commits October 29, 2024 15:21

fix: RBR showing in inbox tab because of a report not included in LHN

81b6b6e

Merge branch 'main' into pac-guerreiro/fix/51488-reports-with-report-…

6c5b958

…not-found-error-cause-inbox-tab-rbr

pac-guerreiro requested a review from a team as a code owner October 29, 2024 15:37

melvin-bot bot requested review from fedirjh and removed request for a team October 29, 2024 15:38

DylanDylann reviewed Oct 30, 2024

View reviewed changes

pac-guerreiro added 2 commits October 31, 2024 00:53

chore: revert changes

f56b1f3

Merge branch 'main' into pac-guerreiro/fix/51488-reports-with-report-…

32e0ffa

…not-found-error-cause-inbox-tab-rbr

pac-guerreiro added 2 commits October 31, 2024 16:04

chore: resolve eslint issues

7a069b3

Merge branch 'main' into pac-guerreiro/fix/51488-reports-with-report-…

acba675

…not-found-error-cause-inbox-tab-rbr

DylanDylann approved these changes Oct 31, 2024

View reviewed changes

melvin-bot bot requested a review from puneetlath October 31, 2024 16:48

puneetlath requested changes Nov 5, 2024

View reviewed changes

pac-guerreiro mentioned this pull request Nov 6, 2024

Debug - "Clicking on View button leads to not here page when opening invalid URL #52104

Closed

8 tasks

puneetlath approved these changes Nov 6, 2024

View reviewed changes

puneetlath merged commit 0a8f897 into Expensify:main Nov 6, 2024

github-actions bot mentioned this pull request Nov 7, 2024

Deploy Checklist: New Expensify 2024-11-07 #52178

Closed

60 tasks

melvin-bot bot mentioned this pull request Nov 11, 2024

[HOLD for payment 2024-11-18] Reports with "report not found" error cause Inbox tab RBR #51488

Closed

rayane-d reviewed Feb 3, 2025

View reviewed changes

Conversation

pac-guerreiro commented Oct 29, 2024

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

Uh oh!

melvin-bot bot commented Oct 29, 2024

Uh oh!

DylanDylann commented Oct 30, 2024

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

DylanDylann commented Oct 30, 2024

Uh oh!

DylanDylann commented Oct 30, 2024

Uh oh!

pac-guerreiro commented Oct 31, 2024

Uh oh!

pac-guerreiro commented Oct 31, 2024

Uh oh!

DylanDylann commented Oct 31, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer Checklist

Screenshots/Videos

Uh oh!

pac-guerreiro commented Nov 5, 2024

Uh oh!

puneetlath left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

pac-guerreiro commented Nov 6, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

puneetlath commented Nov 6, 2024

Uh oh!

OSBotify commented Nov 6, 2024

Uh oh!

github-actions bot commented Nov 7, 2024

Uh oh!

github-actions bot commented Nov 11, 2024

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

DylanDylann commented Oct 31, 2024 •

edited

Loading

pac-guerreiro commented Nov 6, 2024 •

edited

Loading