[TS migration] Migrate withFullTransactionOrNotFound HOC by ruben-rebelo · Pull Request #36855 · Expensify/App

ruben-rebelo · 2024-02-20T10:11:14Z

Details

[TS migration] Migrate *withFullTransactionOrNotFound HOC to TypeScript

Fixed Issues

$ #36123
PROPOSAL: N/A

Tests

Verify that no errors appear in the JS console
Open the app and log in
Navigate to any chat
Press plus and request money
Following the request money process should work as before

Offline tests

N/A

QA Steps

Verify that no errors appear in the JS console

Same as in the Tests section.

PR Author Checklist

Screenshots/Videos

Android: Native

8mb.video-2W7-OcZXZfPw.mp4

Android: mWeb Chrome

android-web.mov

iOS: Native

ios-native.mov

iOS: mWeb Safari

ios-web.mov

MacOS: Chrome / Safari

macos-web.mov

MacOS: Desktop

macos-native.mov

fabioh8010 · 2024-02-20T10:54:13Z

src/pages/iou/request/step/withFullTransactionOrNotFound.tsx

+
+type WithFullTransactionOrNotFoundOnyxProps = {
+    /** Indicated whether the report data is loading */
+    transaction: OnyxCollection<Transaction>;


Suggested change

transaction: OnyxCollection<Transaction>;

transaction: OnyxEntry<Transaction>;

fabioh8010 · 2024-02-20T10:55:18Z

src/pages/iou/request/step/withFullTransactionOrNotFound.tsx

+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;


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 👀

fabioh8010 · 2024-02-20T10:56:10Z

src/pages/iou/request/step/withFullTransactionOrNotFound.tsx

+            key: ({route}) => {
+                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}`;


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

fabioh8010 · 2024-02-20T11:16:43Z

src/pages/iou/request/step/withFullTransactionOrNotFound.tsx

+            },
+        },
+    })(forwardRef(WithFullTransactionOrNotFound));
+}


Suggested change

}

}

export type {WithFullTransactionOrNotFoundProps};

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

melvin-bot · 2024-02-28T08:44:32Z

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

fedirjh · 2024-02-28T22:15:40Z

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 approved by marketing by adding the Waiting for Copy label for a copy review on the original GH to get the correct copy.
- 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 form input styles:
- I verified that all the inputs inside a form are aligned with each other.
- I added Design label 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

CleanShot.2024-02-28.at.23.41.25.mp4

Android: mWeb Chrome

CleanShot.2024-02-28.at.23.44.10.mp4

iOS: Native

Simulator.Screen.Recording.-.iPhone.15.Pro.-.2024-02-28.at.23.54.33.mp4

iOS: mWeb Safari

Simulator.Screen.Recording.-.iPhone.15.Pro.-.2024-02-28.at.23.56.10.mp4

MacOS: Chrome / Safari

CleanShot.2024-02-28.at.23.20.18.mp4

MacOS: Desktop

CleanShot.2024-02-28.at.23.52.27.mp4

fedirjh

LGTM

melvin-bot · 2024-02-28T23:00:02Z

We did not find an internal engineer to review this PR, trying to assign a random engineer to #36123 as well as to this PR... Please reach out for help on Slack if no one gets assigned!

OSBotify · 2024-02-29T23:43:13Z

🚀 Deployed to staging by https://github.com/tylerkaraszewski in version: 1.4.46-0 🚀

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

OSBotify · 2024-03-04T20:25:27Z

🚀 Deployed to production by https://github.com/roryabraham in version: 1.4.46-2 🚀

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

fabioh8010 · 2024-03-22T08:46:28Z

Hey @ruben-rebelo This PR was reverted, are you working on this, right?

ruben-rebelo · 2024-03-22T09:02:17Z

@fabioh8010 Yes, that is correct!

fabioh8010 · 2024-03-26T06:44:20Z

Any updates @ruben-rebelo ?

ruben-rebelo · 2024-03-26T10:53:43Z

Just created an draft pr getting this back with the issue fixes, here is the PR: 38990

[TS migration] Migrate withFullTransactionOrNotFound HOC

ac334ba

fabioh8010 reviewed Feb 20, 2024

View reviewed changes

[TS migration] Type changes

ef01395

fabioh8010 approved these changes Feb 20, 2024

View reviewed changes

blazejkustra approved these changes Feb 27, 2024

View reviewed changes

ruben-rebelo marked this pull request as ready for review February 28, 2024 08:44

ruben-rebelo requested a review from a team as a code owner February 28, 2024 08:44

melvin-bot bot requested review from fedirjh and removed request for a team February 28, 2024 08:44

fedirjh approved these changes Feb 28, 2024

View reviewed changes

melvin-bot bot requested a review from tylerkaraszewski February 28, 2024 23:00

tylerkaraszewski approved these changes Feb 29, 2024

View reviewed changes

tylerkaraszewski merged commit ac78311 into Expensify:main Feb 29, 2024

tylerkaraszewski mentioned this pull request Feb 29, 2024

Revert "[TS migration] Migrate withFullTransactionOrNotFound HOC" #37572

Merged

github-actions bot mentioned this pull request Feb 29, 2024

Deploy Checklist: New Expensify 2024-02-29 #37578

Closed

36 tasks

melvin-bot bot mentioned this pull request Mar 4, 2024

[HOLD for payment 2024-04-25] [HOLD for payment 2024-04-15] [HOLD for payment 2024-03-11] [TS migration] Migrate 'withFullTransactionOrNotFound.js' HOC to TypeScript #36123

Closed

	transaction: OnyxCollection<Transaction>;
	transaction: OnyxEntry<Transaction>;

	const transactionID = props.route.params.transactionID;
	const transactionID = props.transaction?.transactionID;

-                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}`;

-}
+}
+export type {WithFullTransactionOrNotFoundProps};

Conversation

ruben-rebelo commented Feb 20, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

Uh oh!

fabioh8010 Feb 20, 2024

Choose a reason for hiding this comment

Uh oh!

fabioh8010 Feb 20, 2024

Choose a reason for hiding this comment

Uh oh!

fabioh8010 Feb 20, 2024

Choose a reason for hiding this comment

Uh oh!

fabioh8010 Feb 20, 2024

Choose a reason for hiding this comment

Uh oh!

melvin-bot bot commented Feb 28, 2024

Uh oh!

fedirjh commented Feb 28, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer Checklist

Screenshots/Videos

Uh oh!

fedirjh left a comment

Choose a reason for hiding this comment

Uh oh!

melvin-bot bot commented Feb 28, 2024

Uh oh!

OSBotify commented Feb 29, 2024

Uh oh!

OSBotify commented Mar 4, 2024

Uh oh!

fabioh8010 commented Mar 22, 2024

Uh oh!

ruben-rebelo commented Mar 22, 2024

Uh oh!

fabioh8010 commented Mar 26, 2024

Uh oh!

ruben-rebelo commented Mar 26, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

ruben-rebelo commented Feb 20, 2024 •

edited

Loading

fedirjh commented Feb 28, 2024 •

edited

Loading