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

[TS migration] Migrate withFullTransactionOrNotFound HOC #36855

Merged
Show file tree
Hide file tree
Changes from 1 commit
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
78 changes: 0 additions & 78 deletions src/pages/iou/request/step/withFullTransactionOrNotFound.js

This file was deleted.

56 changes: 56 additions & 0 deletions src/pages/iou/request/step/withFullTransactionOrNotFound.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
import {useIsFocused} from '@react-navigation/native';
import type {StackScreenProps} from '@react-navigation/stack';
import type {ComponentType, ForwardedRef, RefAttributes} from 'react';
import React, {forwardRef} from 'react';
import type {OnyxCollection, OnyxEntry} from 'react-native-onyx';

Check failure on line 5 in src/pages/iou/request/step/withFullTransactionOrNotFound.tsx

View workflow job for this annotation

GitHub Actions / lint

'OnyxEntry' is defined but never used
import {withOnyx} from 'react-native-onyx';
import FullPageNotFoundView from '@components/BlockingViews/FullPageNotFoundView';
import getComponentDisplayName from '@libs/getComponentDisplayName';
import type {MoneyRequestNavigatorParamList} from '@libs/Navigation/types';
import CONST from '@src/CONST';
import ONYXKEYS from '@src/ONYXKEYS';
import type SCREENS from '@src/SCREENS';
import type {Transaction} from '@src/types/onyx';

type WithFullTransactionOrNotFoundOnyxProps = {
/** Indicated whether the report data is loading */
transaction: OnyxCollection<Transaction>;
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
transaction: OnyxCollection<Transaction>;
transaction: OnyxEntry<Transaction>;

};

type WithFullTransactionOrNotFoundProps = WithFullTransactionOrNotFoundOnyxProps & StackScreenProps<MoneyRequestNavigatorParamList, typeof SCREENS.MONEY_REQUEST.STEP_DATE>;

export default function <TProps extends WithFullTransactionOrNotFoundProps, TRef>(WrappedComponent: ComponentType<TProps & RefAttributes<TRef>>) {
// eslint-disable-next-line rulesdir/no-negated-variables
function WithFullTransactionOrNotFound(props: TProps, ref: ForwardedRef<TRef>) {
const transactionID = props.route.params.transactionID;
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
const transactionID = props.route.params.transactionID;
const transactionID = props.transaction?.transactionID;

Let's be cautious with these changes, before the file was getting from props 👀


const isFocused = useIsFocused();

// If the transaction does not have a transactionID, then the transaction no longer exists in Onyx as a full transaction and the not-found page should be shown.
// In addition, the not-found page should be shown only if the component screen's route is active (i.e. is focused).
// This is to prevent it from showing when the modal is being dismissed while navigating to a different route (e.g. on requesting money).
if (!transactionID) {
return <FullPageNotFoundView shouldShow={isFocused} />;
}

return (
<WrappedComponent
// eslint-disable-next-line react/jsx-props-no-spreading
{...props}
ref={ref}
/>
);
}

WithFullTransactionOrNotFound.displayName = `withFullTransactionOrNotFound(${getComponentDisplayName(WrappedComponent)})`;

return withOnyx<TProps & RefAttributes<TRef>, WithFullTransactionOrNotFoundOnyxProps>({
transaction: {
key: ({route}) => {

Check failure on line 49 in src/pages/iou/request/step/withFullTransactionOrNotFound.tsx

View workflow job for this annotation

GitHub Actions / typecheck

Type '({ route }: Omit<TProps & RefAttributes<TRef>, "transaction"> & Partial<WithFullTransactionOrNotFoundOnyxProps>) => `transactions_${string}` | `transactionsDraft_${string}`' is not assignable to type '"iou" | "task" | "user" | "account" | "accountManagerReportID" | "isFirstTimeNewExpensifyUser" | "activeClients" | "deviceID" | "isSidebarLoaded" | "isSearchingForReports" | ... 398 more ... | ((props: Omit<...> & Partial<...>) => "policyMemberList_")'.
const transactionID = route.params.transactionID ?? 0;
const userAction = route.params.action ?? CONST.IOU.ACTION.CREATE;
return `${userAction === CONST.IOU.ACTION.CREATE ? ONYXKEYS.COLLECTION.TRANSACTION_DRAFT : ONYXKEYS.COLLECTION.TRANSACTION}${transactionID}`;
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
return `${userAction === CONST.IOU.ACTION.CREATE ? ONYXKEYS.COLLECTION.TRANSACTION_DRAFT : ONYXKEYS.COLLECTION.TRANSACTION}${transactionID}`;
if (userAction === CONST.IOU.ACTION.CREATE) {
return `${ONYXKEYS.COLLECTION.TRANSACTION_DRAFT}${transactionID}` as `${typeof ONYXKEYS.COLLECTION.TRANSACTION}${string}`;
}
return `${ONYXKEYS.COLLECTION.TRANSACTION}${transactionID}`;

Isn't pretty solution but I'm afraid we don't have other options

},
},
})(forwardRef(WithFullTransactionOrNotFound));
}
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
}
}
export type {WithFullTransactionOrNotFoundProps};

Also, let's export the type (it will be used in the future)

Loading