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

Fix crash app when opening split bill detail page by deep link #23977

Merged
merged 6 commits into from
Aug 2, 2023
Merged
Show file tree
Hide file tree
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
153 changes: 153 additions & 0 deletions src/pages/home/report/withReportAndReportActionOrNotFound.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,153 @@
import PropTypes from 'prop-types';
import React, {useEffect, useCallback} from 'react';
import {withOnyx} from 'react-native-onyx';
import _ from 'underscore';
import getComponentDisplayName from '../../../libs/getComponentDisplayName';
import NotFoundPage from '../../ErrorPage/NotFoundPage';
import ONYXKEYS from '../../../ONYXKEYS';
import reportPropTypes from '../../reportPropTypes';
import reportActionPropTypes from './reportActionPropTypes';
import FullscreenLoadingIndicator from '../../../components/FullscreenLoadingIndicator';
import * as ReportUtils from '../../../libs/ReportUtils';
import * as ReportActionsUtils from '../../../libs/ReportActionsUtils';
import * as Report from '../../../libs/actions/Report';
import compose from '../../../libs/compose';
import withWindowDimensions from '../../../components/withWindowDimensions';

export default function (WrappedComponent) {
const propTypes = {
/** The HOC takes an optional ref as a prop and passes it as a ref to the wrapped component.
* That way, if a ref is passed to a component wrapped in the HOC, the ref is a reference to the wrapped component, not the HOC. */
forwardedRef: PropTypes.func,

/** The report currently being looked at */
report: reportPropTypes,

/** Array of report actions for this report */
reportActions: PropTypes.shape(reportActionPropTypes),

/** The policies which the user has access to */
policies: PropTypes.objectOf(
PropTypes.shape({
/** The policy name */
name: PropTypes.string,

/** The type of the policy */
type: PropTypes.string,
}),
),

/** Route params */
route: PropTypes.shape({
params: PropTypes.shape({
/** Report ID passed via route */
reportID: PropTypes.string,

/** ReportActionID passed via route */
reportActionID: PropTypes.string,
}),
}).isRequired,

/** Beta features list */
betas: PropTypes.arrayOf(PropTypes.string),

/** Indicated whether the report data is loading */
isLoadingReportData: PropTypes.bool,

/** Is the window width narrow, like on a mobile device? */
isSmallScreenWidth: PropTypes.bool.isRequired,
};

const defaultProps = {
forwardedRef: () => {},
reportActions: {},
report: {},
policies: {},
betas: [],
isLoadingReportData: true,
};

// eslint-disable-next-line rulesdir/no-negated-variables
function WithReportAndReportActionOrNotFound(props) {
const getReportAction = useCallback(() => {
let reportAction = props.reportActions[`${props.route.params.reportActionID}`];

// Handle threads if needed
if (reportAction === undefined || reportAction.reportActionID === undefined) {
reportAction = ReportActionsUtils.getParentReportAction(props.report);
}

return reportAction;
}, [props.report, props.reportActions, props.route.params.reportActionID]);

const reportAction = getReportAction();

// For small screen, we don't call openReport API when we go to a sub report page by deeplink
// So we need to call openReport here for small screen
useEffect(() => {
if (!props.isSmallScreenWidth || (!_.isEmpty(props.report) && !_.isEmpty(reportAction))) {
return;
}
Report.openReport(props.route.params.reportID);
// eslint-disable-next-line react-hooks/exhaustive-deps
}, []);
Copy link
Collaborator

Choose a reason for hiding this comment

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

We're only left with this now @dukenv0307? Do we need to disable the exhaustive-deps check? Why not add the props.isSmallScreenWidth, props.report, props.route.params.reportID to the dependencies?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I think we only need to call this API one time here.

Copy link
Collaborator

Choose a reason for hiding this comment

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

Are we sure?

  1. What happens when we're on Desktop/Web and resize the browser? and then perform the steps?
  2. Assume that we've got more than one Split bill requests URL shared on chat, and we click on both one after the other?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Cool will add dependence again.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Updated.

Copy link
Collaborator

Choose a reason for hiding this comment

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

Hey,
Sorry I should've been clear. I am not saying always need to add the dependencies. I wanted to know if it is required? If not, then we add a comment why certain properties are not required.

For example,

  • I feel isSmallScreenWidth is required
  • I am not confident about props.report?
  • and I am pretty sure we don't need route.params.reportID as that would mean opening a new URL, which should probably reload the whole component, thereby calling useEffect

Please correct me if I my understanding is wrong? May be you could test at your end?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

isSmallScreenWidth and route.param.reportID will be fine because inn native if we already open a split bill and we open other by deeplink maybe this component will not unmount.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@mananjadhav updated, help to check again.

Copy link
Collaborator

Choose a reason for hiding this comment

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

thanks @dukenv0307. I'll test this in an hour.


// Perform all the loading checks
const isLoadingReport = props.isLoadingReportData && (_.isEmpty(props.report) || !props.report.reportID);
Copy link
Collaborator

@mananjadhav mananjadhav Aug 2, 2023

Choose a reason for hiding this comment

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

I understand these checks are complex, but we generally try to early return. Is it possible to structure the code:

// Perform all the loading checks
 const isLoadingReport  = ...;
 const isLoadingReportAction = ....;

 if ((isLoadingReport || isLoadingReportAction) && !shouldHideReport) {
    return <FullscreenLoadingIndicator />;
}


// Perform the access/not found checks
const shouldHideReport
if (shouldHideReport || _.isEmpty(reportAction)) {
    return <NotFoundPage />;
}

const isLoadingReportAction = _.isEmpty(props.reportActions) || (props.report.isLoadingReportActions && _.isEmpty(getReportAction()));
const shouldHideReport = !isLoadingReport && (_.isEmpty(props.report) || !props.report.reportID || !ReportUtils.canAccessReport(props.report, props.policies, props.betas));
Copy link
Collaborator

Choose a reason for hiding this comment

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

Possible to move this check after the return <FullScreenLoadingIndicator>?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

testing again if it's possible


if ((isLoadingReport || isLoadingReportAction) && !shouldHideReport) {
Copy link
Collaborator

Choose a reason for hiding this comment

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

Inline with the above comment, anyway to remove !shouldHideReport from here so that the flag is only initialized after this block?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

This check is necessary here. if reportID is not found props.reportAction is true and isLoadingReportAction is true, so we need shouldHideReport here to return false if the report doesn't exist.

Copy link
Collaborator

Choose a reason for hiding this comment

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

Okay thanks.

return <FullscreenLoadingIndicator />;
}

// Perform the access/not found checks
if (shouldHideReport || _.isEmpty(reportAction)) {
Copy link
Collaborator

Choose a reason for hiding this comment

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

Please check my comment above and then I feel shouldHideReport won't be needed, the conditions can be put here inline.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I will check and re-test again.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Some reports contain data but we can not access this report by ReportUtils.canAccessReport fucntion, so this check is necessary to display not found page.

return <NotFoundPage />;
}

const rest = _.omit(props, ['forwardedRef']);
return (
<WrappedComponent
// eslint-disable-next-line react/jsx-props-no-spreading
{...rest}
ref={props.forwardedRef}
/>
);
}

WithReportAndReportActionOrNotFound.propTypes = propTypes;
WithReportAndReportActionOrNotFound.defaultProps = defaultProps;
WithReportAndReportActionOrNotFound.displayName = `withReportAndReportActionOrNotFound(${getComponentDisplayName(WrappedComponent)})`;

// eslint-disable-next-line rulesdir/no-negated-variables
const withReportAndReportActionOrNotFound = React.forwardRef((props, ref) => (
<WithReportAndReportActionOrNotFound
// eslint-disable-next-line react/jsx-props-no-spreading
{...props}
forwardedRef={ref}
/>
));

return compose(
withWindowDimensions,
withOnyx({
report: {
key: ({route}) => `${ONYXKEYS.COLLECTION.REPORT}${route.params.reportID}`,
},
isLoadingReportData: {
key: ONYXKEYS.IS_LOADING_REPORT_DATA,
},
betas: {
key: ONYXKEYS.BETAS,
},
policies: {
key: ONYXKEYS.COLLECTION.POLICY,
},
reportActions: {
key: ({route}) => `${ONYXKEYS.COLLECTION.REPORT_ACTIONS}${route.params.reportID}`,
Copy link
Collaborator

Choose a reason for hiding this comment

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

Original code explicitly added toString(). Would this break something if we don't put toString?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I think that fine because we wrap it in `` that is a string.

canEvict: false,
},
}),
)(withReportAndReportActionOrNotFound);
}
20 changes: 2 additions & 18 deletions src/pages/iou/SplitBillDetailsPage.js
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ import withLocalize, {withLocalizePropTypes} from '../../components/withLocalize
import compose from '../../libs/compose';
import reportActionPropTypes from '../home/report/reportActionPropTypes';
import reportPropTypes from '../reportPropTypes';
import withReportOrNotFound from '../home/report/withReportOrNotFound';
import withReportAndReportActionOrNotFound from '../home/report/withReportAndReportActionOrNotFound';
import FullPageNotFoundView from '../../components/BlockingViews/FullPageNotFoundView';
import CONST from '../../CONST';
import HeaderWithBackButton from '../../components/HeaderWithBackButton';
Expand Down Expand Up @@ -50,18 +50,6 @@ const defaultProps = {
reportActions: {},
};

/**
* Get the reportID for the associated chatReport
*
* @param {Object} route
* @param {Object} route.params
* @param {String} route.params.reportID
* @returns {String}
*/
function getReportID(route) {
return route.params.reportID.toString();
}

function SplitBillDetailsPage(props) {
const reportAction = props.reportActions[`${props.route.params.reportActionID.toString()}`];
const participantAccountIDs = reportAction.originalMessage.participantAccountIDs;
Expand Down Expand Up @@ -108,14 +96,10 @@ SplitBillDetailsPage.displayName = 'SplitBillDetailsPage';

export default compose(
withLocalize,
withReportOrNotFound,
withReportAndReportActionOrNotFound,
withOnyx({
personalDetails: {
key: ONYXKEYS.PERSONAL_DETAILS_LIST,
},
reportActions: {
key: ({route}) => `${ONYXKEYS.COLLECTION.REPORT_ACTIONS}${getReportID(route)}`,
canEvict: false,
},
}),
)(SplitBillDetailsPage);