[TS migration] Migrate 'SettlementButton.js' component to TypeScript PART-2 #35877

ZhenjaHorbach · 2024-02-06T08:00:07Z

Details

Fixed Issues

$ #25100
PROPOSAL: #25100 (comment)

Tests

Go to request money
Select the Distance tab
Enter any waypoints
Select any workspace
Create request
Make sure SettlementButton works correctly on Report Preview
Press on Report Preview
Make sure SettlementButton works correctly on Money Report Header

Verify that no errors appear in the JS console

Offline tests

Go to request money
Select the Distance tab
Enter any waypoints
Select any workspace
Create request
Make sure SettlementButton works correctly on Report Preview
Press on Report Preview
Make sure SettlementButton works correctly on Money Report Header

QA Steps

Go to request money
Select the Distance tab
Enter any waypoints
Select any workspace
Create request
Make sure SettlementButton works correctly on Report Preview
Press on Report Preview
Make sure SettlementButton works correctly on Money Report Header

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Android: Native

screen-recording-2024-01-03-at-160854_EbleMEvi.mp4

Android: mWeb Chrome

android-web_4bVb1NIW.mp4

iOS: Native

ios_4Ez0lS3G.mp4

iOS: mWeb Safari

ios_iC6C6JXX.mp4

MacOS: Chrome / Safari

web_frW2qrPs.1.mp4

MacOS: Desktop

desktop_YabzuIQv.mp4

melvin-bot · 2024-02-06T08:00:12Z

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

ZhenjaHorbach · 2024-02-06T08:05:43Z

@hoangzinh
Hello
Can you take a look at this PR ?)

hoangzinh · 2024-02-06T09:13:08Z

src/components/SettlementButton.tsx

@@ -49,7 +49,7 @@ type SettlementButtonProps = SettlementButtonOnyxProps & {
    chatReportID?: string;

    /** The IOU/Expense report we are paying */
-    iouReport?: OnyxEntry<Report> | EmptyObject;
+    iouReport?: OnyxEntry<Report> | Report | EmptyObject;


it looks weird to have both OnyxEntry<Report> and Report

In fact, I did this more for clarification
Since we can pass both these types
But this does not affect typing

But I can delete)

hoangzinh · 2024-02-06T09:34:17Z

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

Screen.Recording.2024-02-06.at.16.59.22.android.mov

Android: mWeb Chrome

Screen.Recording.2024-02-06.at.17.01.54.android.chrome.mov

iOS: Native

Screen.Recording.2024-02-06.at.17.08.35.ios.mov

iOS: mWeb Safari

Screen.Recording.2024-02-06.at.17.07.42.ios.safari.mov

MacOS: Chrome / Safari

Screen.Recording.2024-02-06.at.16.50.10.web.mov

MacOS: Desktop

Screen.Recording.2024-02-06.at.17.02.58.desktop.mov

mountiny

Jumping in early to fix the typecheck failing on main

OSBotify · 2024-02-06T10:19:32Z

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

Swor71 · 2024-02-06T13:11:09Z

src/components/SettlementButton.tsx

@@ -197,7 +197,7 @@ function SettlementButton({
        }

        if (iouPaymentType === CONST.IOU.REPORT_ACTION_TYPE.APPROVE) {
-            IOU.approveMoneyRequest(iouReport);
+            IOU.approveMoneyRequest(iouReport ?? {});


@ZhenjaHorbach @mountiny
shouldn't this be moved to the if check? Are we sure we want to pass in an empty object to that function when the report action type is approved and I would assume - ready to process? Seems some of the keys would end up like report_undefined etc.

In theory this may never happen )
But following the iouReport typing it can be null

And you mean not call IOU.approveMoneyRequest when iouReport is empty ?

well imo if that can happen the function should handle such case.

also, if it can be null as you say, it will crash, if you attempt to access any props on it

I am not familiar with this part of the code, just stumbled upon that today when we were fixing the latest main merge on a different pr so I am not sure if not calling IOU.approveMoneyRequest in such case is valid, just applying some logic here, but it might be flawed as stated above.

OSBotify · 2024-02-07T10:10:06Z

🚀 Deployed to staging by https://github.com/mountiny in version: 1.4.38-0 🚀

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

kavimuru · 2024-02-07T10:11:17Z

@mountiny this seems similar to this PR #33866. Could we skip this one and check it off in the list?

OSBotify · 2024-02-07T10:26:39Z

🚀 Deployed to staging by https://github.com/mountiny in version: 1.4.38-0 🚀

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

OSBotify · 2024-02-08T18:21:57Z

🚀 Deployed to production by https://github.com/marcaaron in version: 1.4.38-6 🚀

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

Fix ts issues

49413b1

ZhenjaHorbach requested a review from a team as a code owner February 6, 2024 08:00

melvin-bot bot requested review from hoangzinh and removed request for a team February 6, 2024 08:00

ZhenjaHorbach mentioned this pull request Feb 6, 2024

[TS migration] Migrate 'SettlementButton.js' component to TypeScript #33866

Merged

50 tasks

Fix ts issues x2

4146050

hoangzinh reviewed Feb 6, 2024

View reviewed changes

Fix ts issues x3

abcf695

hoangzinh approved these changes Feb 6, 2024

View reviewed changes

melvin-bot bot requested a review from AndrewGable February 6, 2024 10:09

mountiny approved these changes Feb 6, 2024

View reviewed changes

mountiny merged commit 25e6a00 into Expensify:main Feb 6, 2024
16 of 17 checks passed

Swor71 reviewed Feb 6, 2024

View reviewed changes

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

Deploy Checklist: New Expensify 2024-02-07 #35983

Closed

49 tasks

ishpaul777 mentioned this pull request Feb 7, 2024

[HOLD for payment 2024-02-19] [HOLD for payment 2024-02-15] [HOLD FOR PAYMENT: 15th Feburary] [$500] IOU - Payment option reverts back to 'Pay with Expensify' #36066

Closed

6 tasks

melvin-bot bot mentioned this pull request Feb 8, 2024

[HOLD for payment 2024-02-15] [$250] [TS migration] Migrate 'SettlementButton.js' component to TypeScript #25100

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[TS migration] Migrate 'SettlementButton.js' component to TypeScript PART-2 #35877

[TS migration] Migrate 'SettlementButton.js' component to TypeScript PART-2 #35877

ZhenjaHorbach commented Feb 6, 2024

melvin-bot bot commented Feb 6, 2024

ZhenjaHorbach commented Feb 6, 2024

hoangzinh Feb 6, 2024

ZhenjaHorbach Feb 6, 2024

ZhenjaHorbach Feb 6, 2024

ZhenjaHorbach Feb 6, 2024

hoangzinh commented Feb 6, 2024 •

edited

Loading

mountiny left a comment

OSBotify commented Feb 6, 2024

Swor71 Feb 6, 2024

ZhenjaHorbach Feb 6, 2024 •

edited

Loading

Swor71 Feb 6, 2024 •

edited

Loading

OSBotify commented Feb 7, 2024

kavimuru commented Feb 7, 2024

OSBotify commented Feb 7, 2024

OSBotify commented Feb 8, 2024

[TS migration] Migrate 'SettlementButton.js' component to TypeScript PART-2 #35877

[TS migration] Migrate 'SettlementButton.js' component to TypeScript PART-2 #35877

Conversation

ZhenjaHorbach commented Feb 6, 2024

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Feb 6, 2024

ZhenjaHorbach commented Feb 6, 2024

hoangzinh Feb 6, 2024

Choose a reason for hiding this comment

ZhenjaHorbach Feb 6, 2024

Choose a reason for hiding this comment

ZhenjaHorbach Feb 6, 2024

Choose a reason for hiding this comment

ZhenjaHorbach Feb 6, 2024

Choose a reason for hiding this comment

hoangzinh commented Feb 6, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

mountiny left a comment

Choose a reason for hiding this comment

OSBotify commented Feb 6, 2024

Swor71 Feb 6, 2024

Choose a reason for hiding this comment

ZhenjaHorbach Feb 6, 2024 • edited Loading

Choose a reason for hiding this comment

Swor71 Feb 6, 2024 • edited Loading

Choose a reason for hiding this comment

OSBotify commented Feb 7, 2024

kavimuru commented Feb 7, 2024

OSBotify commented Feb 7, 2024

OSBotify commented Feb 8, 2024

hoangzinh commented Feb 6, 2024 •

edited

Loading

ZhenjaHorbach Feb 6, 2024 •

edited

Loading

Swor71 Feb 6, 2024 •

edited

Loading