Repository navigation
decompose ReportScreen 6c: extract not-found guards #86720
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
Changes from all commits
e45e5af
34023b8
44ab2fe
d2f196a
aff5858
ce5ec3f
0c0dfd2
41157e5
f0de8a0
f28552f
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,185 @@ | ||
| import {useRoute} from '@react-navigation/native'; | ||
| import type {ReactNode} from 'react'; | ||
| import React, {useEffect, useState} from 'react'; | ||
| import type {OnyxEntry} from 'react-native-onyx'; | ||
| import FullPageNotFoundView from '@components/BlockingViews/FullPageNotFoundView'; | ||
| import useCurrentUserPersonalDetails from '@hooks/useCurrentUserPersonalDetails'; | ||
| import useOnyx from '@hooks/useOnyx'; | ||
| import useReportIsArchived from '@hooks/useReportIsArchived'; | ||
| import useResponsiveLayout from '@hooks/useResponsiveLayout'; | ||
| import useThemeStyles from '@hooks/useThemeStyles'; | ||
| import getNonEmptyStringOnyxID from '@libs/getNonEmptyStringOnyxID'; | ||
| import Log from '@libs/Log'; | ||
| import Navigation from '@libs/Navigation/Navigation'; | ||
| import {isReportActionVisible, isWhisperAction} from '@libs/ReportActionsUtils'; | ||
| import {canUserPerformWriteAction} from '@libs/ReportUtils'; | ||
| import ONYXKEYS from '@src/ONYXKEYS'; | ||
| import {getReportActionByIDSelector} from '@src/selectors/ReportAction'; | ||
| import {isLoadingInitialReportActionsSelector} from '@src/selectors/ReportMetaData'; | ||
| import type {ReportActions} from '@src/types/onyx'; | ||
|
|
||
| type LinkedActionNotFoundGuardProps = { | ||
| children: ReactNode; | ||
| }; | ||
|
|
||
| // eslint-disable-next-line rulesdir/no-negated-variables | ||
| function LinkedActionNotFoundGuard({children}: LinkedActionNotFoundGuardProps) { | ||
| const route = useRoute(); | ||
| const routeParams = route.params as {reportActionID?: string} | undefined; | ||
| const reportActionIDFromRoute = routeParams?.reportActionID; | ||
|
|
||
| if (!reportActionIDFromRoute) { | ||
| return children; | ||
| } | ||
|
|
||
| return ( | ||
| <LinkedActionNotFoundGate | ||
| key={reportActionIDFromRoute} | ||
| reportActionIDFromRoute={reportActionIDFromRoute} | ||
| > | ||
| {children} | ||
| </LinkedActionNotFoundGate> | ||
| ); | ||
| } | ||
|
|
||
| type LinkedActionNotFoundGateProps = { | ||
| reportActionIDFromRoute: string; | ||
| children: ReactNode; | ||
| }; | ||
|
|
||
| // eslint-disable-next-line rulesdir/no-negated-variables | ||
| function LinkedActionNotFoundGate({reportActionIDFromRoute, children}: LinkedActionNotFoundGateProps) { | ||
|
adhorodyski marked this conversation as resolved.
Resolved
|
||
| const route = useRoute(); | ||
| const routeParams = route.params as {reportID?: string; reportActionID?: string} | undefined; | ||
| const reportIDFromRoute = getNonEmptyStringOnyxID(routeParams?.reportID); | ||
|
|
||
| const styles = useThemeStyles(); | ||
| const {accountID: currentUserAccountID} = useCurrentUserPersonalDetails(); | ||
| const {shouldUseNarrowLayout} = useResponsiveLayout(); | ||
|
|
||
| const [report] = useOnyx(`${ONYXKEYS.COLLECTION.REPORT}${reportIDFromRoute}`); | ||
| const [isLoadingInitialReportActions = true] = useOnyx(`${ONYXKEYS.COLLECTION.REPORT_METADATA}${reportIDFromRoute}`, { | ||
| selector: isLoadingInitialReportActionsSelector, | ||
| }); | ||
| const [linkedAction] = useOnyx(`${ONYXKEYS.COLLECTION.REPORT_ACTIONS}${reportIDFromRoute}`, { | ||
| selector: (actions: OnyxEntry<ReportActions>) => getReportActionByIDSelector(actions, reportActionIDFromRoute), | ||
| }); | ||
| const [visibleReportActionsData] = useOnyx(ONYXKEYS.DERIVED.VISIBLE_REPORT_ACTIONS); | ||
|
|
||
| const isReportArchived = useReportIsArchived(reportIDFromRoute); | ||
|
|
||
| // --- Linked action status --- | ||
| const actionReportID = linkedAction?.reportID ?? reportIDFromRoute; | ||
| const hasNoActionReportID = !!linkedAction && !actionReportID; | ||
| const isActionHidden = | ||
| !!linkedAction && !!actionReportID && !isReportActionVisible(linkedAction, actionReportID, canUserPerformWriteAction(report, isReportArchived), visibleReportActionsData); | ||
| const isLinkedActionDeleted = hasNoActionReportID || isActionHidden; | ||
|
|
||
| const isLinkedActionInaccessibleWhisper = !!linkedAction && isWhisperAction(linkedAction) && !(linkedAction?.whisperedToAccountIDs ?? []).includes(currentUserAccountID); | ||
|
|
||
| // Track whether the linked action was ever loaded and visible during this mount. | ||
| // Set during render (React-supported pattern for adjusting state based on props). | ||
| // The key={reportActionIDFromRoute} on the gate ensures this resets on navigation to a different action. | ||
| const [wasEverVisible, setWasEverVisible] = useState(false); | ||
| if (linkedAction && !isLinkedActionDeleted && !wasEverVisible) { | ||
| setWasEverVisible(true); | ||
| } | ||
|
|
||
| // Track whether isLoadingInitialReportActions has been true at least once during this mount. | ||
| // For previously loaded reports, stale metadata may already have isLoadingInitialReportActions: false | ||
| // before openReport() fires its optimistic update — without this guard we'd flash "not found". | ||
| const [hasSeenLoadingCycle, setHasSeenLoadingCycle] = useState(false); | ||
| if (isLoadingInitialReportActions && !hasSeenLoadingCycle) { | ||
| setHasSeenLoadingCycle(true); | ||
| } | ||
|
|
||
| // Show "comment not found" when: | ||
| // 1. The linked action doesn't exist in the report's actions collection (after loading completes) | ||
| // 2. The linked action exists but is deleted/hidden, and was never visible during this mount | ||
| // (if it gets deleted while viewing, the effect below navigates away instead) | ||
| // Note: the inaccessible whisper case is handled separately by the whisper effect. | ||
| // | ||
| // This intentionally does NOT guard against "report actions exist but the filtered/paginated | ||
| // view is empty" — that's a report view concern, not a linked-action-not-found concern. | ||
| // Showing "comment not found" for an action that exists in the collection is incorrect. | ||
| // eslint-disable-next-line rulesdir/no-negated-variables | ||
| const shouldShowNotFoundLinkedAction = | ||
| (!isLinkedActionInaccessibleWhisper && isLinkedActionDeleted && !wasEverVisible) || (hasSeenLoadingCycle && !isLoadingInitialReportActions && !linkedAction); | ||
|
|
||
| useEffect(() => { | ||
| if (!shouldShowNotFoundLinkedAction) { | ||
| return; | ||
| } | ||
|
|
||
| Log.info('[ReportScreen] Displaying NotFound Page for linked action', false, { | ||
| reportIDFromRoute, | ||
| reportActionIDFromRoute, | ||
| isLoadingInitialReportActions, | ||
| hasSeenLoadingCycle, | ||
| isLinkedActionDeleted, | ||
| isLinkedActionInaccessibleWhisper, | ||
| wasEverVisible, | ||
| linkedActionExists: !!linkedAction, | ||
| }); | ||
| }, [ | ||
| shouldShowNotFoundLinkedAction, | ||
| reportIDFromRoute, | ||
| reportActionIDFromRoute, | ||
| isLoadingInitialReportActions, | ||
| hasSeenLoadingCycle, | ||
| isLinkedActionDeleted, | ||
| isLinkedActionInaccessibleWhisper, | ||
| wasEverVisible, | ||
| linkedAction, | ||
| ]); | ||
|
|
||
| // Action was deleted while we were viewing it — navigate away | ||
| useEffect(() => { | ||
| if (!isLinkedActionDeleted || !wasEverVisible) { | ||
| return; | ||
| } | ||
| Navigation.setParams({reportActionID: ''}); | ||
|
Comment on lines
+136
to
+141
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. There's another case of action being deleted but should not show not found page. Issue: Expense - Not here page opens after moving IOU report to workspace We fixed it by striping the stale reportActionID from any
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. @aimane-chnaif This is only a refactor PR, we’re not changing anything, just moving it into a new component. |
||
| }, [isLinkedActionDeleted, wasEverVisible]); | ||
|
|
||
| // Handle inaccessible whisper | ||
| useEffect(() => { | ||
| if (!isLinkedActionInaccessibleWhisper) { | ||
| return; | ||
| } | ||
| let ignore = false; | ||
| Navigation.isNavigationReady().then(() => { | ||
| if (ignore) { | ||
| return; | ||
| } | ||
| Navigation.setParams({reportActionID: ''}); | ||
| }); | ||
| return () => { | ||
| ignore = true; | ||
| }; | ||
| }, [isLinkedActionInaccessibleWhisper]); | ||
|
|
||
| const navigateToEndOfReport = () => { | ||
| Navigation.setParams({reportActionID: ''}); | ||
| }; | ||
|
|
||
| return ( | ||
| <FullPageNotFoundView | ||
|
adhorodyski marked this conversation as resolved.
Resolved
|
||
| shouldShow={shouldShowNotFoundLinkedAction} | ||
| subtitleKey="notFound.commentYouLookingForCannotBeFound" | ||
| subtitleStyle={[styles.textSupporting]} | ||
| shouldShowBackButton={shouldUseNarrowLayout} | ||
| onBackButtonPress={navigateToEndOfReport} | ||
| shouldShowLink | ||
|
adhorodyski marked this conversation as resolved.
Resolved
|
||
| linkTranslationKey="notFound.goToChatInstead" | ||
| subtitleKeyBelowLink="notFound.contactConcierge" | ||
| onLinkPress={navigateToEndOfReport} | ||
| shouldDisplaySearchRouter | ||
| > | ||
| {children} | ||
| </FullPageNotFoundView> | ||
| ); | ||
| } | ||
|
|
||
| LinkedActionNotFoundGuard.displayName = 'LinkedActionNotFoundGuard'; | ||
|
|
||
| export default LinkedActionNotFoundGuard; | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,115 @@ | ||
| import {useRoute} from '@react-navigation/native'; | ||
| import type {ReactNode} from 'react'; | ||
| import React, {useEffect} from 'react'; | ||
| import FullPageNotFoundView from '@components/BlockingViews/FullPageNotFoundView'; | ||
| import useNetwork from '@hooks/useNetwork'; | ||
| import useOnyx from '@hooks/useOnyx'; | ||
| import useParentReportAction from '@hooks/useParentReportAction'; | ||
| import useResponsiveLayout from '@hooks/useResponsiveLayout'; | ||
| import useThemeStyles from '@hooks/useThemeStyles'; | ||
| import getNonEmptyStringOnyxID from '@libs/getNonEmptyStringOnyxID'; | ||
| import Log from '@libs/Log'; | ||
| import Navigation from '@libs/Navigation/Navigation'; | ||
| import {isReportTransactionThread, isValidReportIDFromPath} from '@libs/ReportUtils'; | ||
| import {getParentReportActionDeletionStatus} from '@libs/TransactionNavigationUtils'; | ||
| import CONST from '@src/CONST'; | ||
| import ONYXKEYS from '@src/ONYXKEYS'; | ||
| import {isLoadingInitialReportActionsSelector} from '@src/selectors/ReportMetaData'; | ||
|
|
||
| type ReportNotFoundGuardProps = { | ||
| children: ReactNode; | ||
| }; | ||
|
|
||
| // eslint-disable-next-line rulesdir/no-negated-variables | ||
| function ReportNotFoundGuard({children}: ReportNotFoundGuardProps) { | ||
| const styles = useThemeStyles(); | ||
| const route = useRoute(); | ||
| const routeParams = route.params as {reportID?: string} | undefined; | ||
| const reportIDFromRoute = getNonEmptyStringOnyxID(routeParams?.reportID); | ||
|
|
||
| const {isOffline} = useNetwork(); | ||
| const {shouldUseNarrowLayout} = useResponsiveLayout(); | ||
|
|
||
| const [report] = useOnyx(`${ONYXKEYS.COLLECTION.REPORT}${reportIDFromRoute}`); | ||
| const [parentReportMetadata] = useOnyx(`${ONYXKEYS.COLLECTION.REPORT_METADATA}${report?.parentReportID}`); | ||
| const [userLeavingStatus = false] = useOnyx(`${ONYXKEYS.COLLECTION.REPORT_USER_IS_LEAVING_ROOM}${reportIDFromRoute}`); | ||
| const [isLoadingInitialReportActions = true] = useOnyx(`${ONYXKEYS.COLLECTION.REPORT_METADATA}${reportIDFromRoute}`, { | ||
| selector: isLoadingInitialReportActionsSelector, | ||
| }); | ||
| const [isLoadingReportData = true] = useOnyx(ONYXKEYS.IS_LOADING_REPORT_DATA); | ||
| const [isLoadingApp] = useOnyx(ONYXKEYS.IS_LOADING_APP); | ||
| const [deleteTransactionNavigateBackUrl] = useOnyx(ONYXKEYS.NVP_DELETE_TRANSACTION_NAVIGATE_BACK_URL); | ||
|
|
||
| const parentReportAction = useParentReportAction(report); | ||
| const reportID = report?.reportID; | ||
| const isOptimisticDelete = report?.statusNum === CONST.REPORT.STATUS_NUM.CLOSED; | ||
|
|
||
| const {isParentActionMissingAfterLoad, isParentActionDeleted} = getParentReportActionDeletionStatus({ | ||
| parentReportID: report?.parentReportID, | ||
| parentReportActionID: report?.parentReportActionID, | ||
| parentReportAction, | ||
| parentReportMetadata, | ||
| isOffline, | ||
| }); | ||
| const isDeletedTransactionThread = isReportTransactionThread(report) && (isParentActionDeleted || isParentActionMissingAfterLoad); | ||
|
|
||
| const isInvalidReportPath = !!routeParams?.reportID && !isValidReportIDFromPath(routeParams.reportID); | ||
| const isLoading = isLoadingApp !== false || isLoadingReportData || (!isOffline && !!isLoadingInitialReportActions); | ||
| const reportExists = !!reportID || (!isDeletedTransactionThread && isOptimisticDelete) || userLeavingStatus; | ||
|
|
||
| // eslint-disable-next-line rulesdir/no-negated-variables | ||
| const shouldShowNotFoundPage = !deleteTransactionNavigateBackUrl && (isDeletedTransactionThread || isInvalidReportPath || (!isLoading && !reportExists)); | ||
|
|
||
| useEffect(() => { | ||
| if (!shouldShowNotFoundPage) { | ||
| return; | ||
| } | ||
|
|
||
| Log.info('[ReportScreen] Displaying NotFound Page', false, { | ||
| isLoadingApp, | ||
| isLoadingReportData, | ||
| isOffline, | ||
| isLoadingInitialReportActions, | ||
| reportID, | ||
| isOptimisticDelete, | ||
| userLeavingStatus, | ||
| reportIDFromPath: routeParams?.reportID, | ||
| deleteTransactionNavigateBackUrl, | ||
| isDeletedTransactionThread, | ||
| isParentActionDeleted, | ||
| isParentActionMissingAfterLoad, | ||
| }); | ||
|
adhorodyski marked this conversation as resolved.
Resolved
|
||
| }, [ | ||
| shouldShowNotFoundPage, | ||
| isLoadingApp, | ||
| isLoadingReportData, | ||
| isOffline, | ||
| isLoadingInitialReportActions, | ||
| reportID, | ||
| isOptimisticDelete, | ||
| userLeavingStatus, | ||
| routeParams?.reportID, | ||
| deleteTransactionNavigateBackUrl, | ||
| isDeletedTransactionThread, | ||
| isParentActionDeleted, | ||
| isParentActionMissingAfterLoad, | ||
| ]); | ||
|
|
||
| return ( | ||
| <FullPageNotFoundView | ||
| shouldShow={shouldShowNotFoundPage} | ||
| subtitleKey="notFound.noAccess" | ||
| subtitleStyle={[styles.textSupporting]} | ||
| shouldShowBackButton={shouldUseNarrowLayout} | ||
| onBackButtonPress={Navigation.goBack} | ||
| shouldShowLink={false} | ||
| shouldDisplaySearchRouter | ||
| > | ||
| {children} | ||
| </FullPageNotFoundView> | ||
| ); | ||
| } | ||
|
|
||
| ReportNotFoundGuard.displayName = 'ReportNotFoundGuard'; | ||
|
|
||
| export default ReportNotFoundGuard; | ||
Uh oh!
There was an error while loading. Please reload this page.