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 'SettlementButton.js' component to TypeScript #33866

Conversation

ZhenjaHorbach
Copy link
Contributor

@ZhenjaHorbach ZhenjaHorbach commented Jan 3, 2024

Details

Fixed Issues

$ #25100
PROPOSAL: #25100 (comment)

Tests

  1. Go to request money
  2. Select the Distance tab
  3. Enter any waypoints
  4. Select any workspace
  5. Create request
  6. Make sure SettlementButton works correctly on Report Preview
  7. Press on Report Preview
  8. Make sure SettlementButton works correctly on Money Report Header
  • Verify that no errors appear in the JS console

Offline tests

  1. Go to request money
  2. Select the Distance tab
  3. Enter any waypoints
  4. Select any workspace
  5. Create request
  6. Make sure SettlementButton works correctly on Report Preview
  7. Press on Report Preview
  8. Make sure SettlementButton works correctly on Money Report Header

QA Steps

  1. Go to request money
  2. Select the Distance tab
  3. Enter any waypoints
  4. Select any workspace
  5. Create request
  6. Make sure SettlementButton works correctly on Report Preview
  7. Press on Report Preview
  8. Make sure SettlementButton works correctly on Money Report Header
  • Verify that no errors appear in the JS console

PR Author Checklist

  • I linked the correct issue in the ### Fixed Issues section above
  • I wrote clear testing steps that cover the changes made in this PR
    • I added steps for local testing in the Tests section
    • I added steps for the expected offline behavior in the Offline steps section
    • I added steps for Staging and/or Production testing in the QA steps section
    • I added steps to cover 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 tested this PR with a High Traffic account against the staging or production API to ensure there are no regressions (e.g. long loading states that impact usability).
  • I included screenshots or videos for tests on all platforms
  • I ran the tests on all platforms & verified they passed on:
    • Android: Native
    • Android: mWeb Chrome
    • iOS: Native
    • iOS: mWeb Safari
    • MacOS: Chrome / Safari
    • MacOS: Desktop
  • I verified there are no console errors (if there's a console error not related to the PR, report it or open an issue for it to be fixed)
  • I followed proper code patterns (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
      • If any non-english text was added/modified, I verified the translation was requested/reviewed in #expensify-open-source and it was approved by an internal Expensify engineer. Link to Slack message:
    • 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 followed the guidelines as stated in the Review Guidelines
  • I tested other components that can be impacted by my changes (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar are working as expected)
  • 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
  • I verified that if a function's arguments changed that all usages have also been updated correctly
  • 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.

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

@ZhenjaHorbach ZhenjaHorbach requested a review from a team as a code owner January 3, 2024 09:04
@melvin-bot melvin-bot bot requested review from hoangzinh and removed request for a team January 3, 2024 09:04
Copy link

melvin-bot bot commented Jan 3, 2024

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

src/components/SettlementButton.tsx Outdated Show resolved Hide resolved
src/components/SettlementButton.tsx Outdated Show resolved Hide resolved
src/components/SettlementButton.tsx Outdated Show resolved Hide resolved
src/components/SettlementButton.tsx Outdated Show resolved Hide resolved
src/components/SettlementButton.tsx Outdated Show resolved Hide resolved
src/components/SettlementButton.tsx Outdated Show resolved Hide resolved
src/components/SettlementButton.tsx Outdated Show resolved Hide resolved
src/components/SettlementButton.tsx Outdated Show resolved Hide resolved
src/components/SettlementButton.tsx Outdated Show resolved Hide resolved
src/components/SettlementButton.tsx Outdated Show resolved Hide resolved
src/components/SettlementButton.tsx Outdated Show resolved Hide resolved
src/components/SettlementButton.tsx Outdated Show resolved Hide resolved
src/components/SettlementButton.tsx Outdated Show resolved Hide resolved
src/components/SettlementButton.tsx Show resolved Hide resolved
src/components/SettlementButton.tsx Show resolved Hide resolved
@blazejkustra
Copy link
Contributor

Also a kind request, change PR title so it reflects issue title: [TS migration] Migrate 'SettlementButton.js' component to TypeScript

@ZhenjaHorbach ZhenjaHorbach changed the title Migrate SettlementButton component to TypeScript [TS migration] Migrate 'SettlementButton.js' component to TypeScript Jan 5, 2024
@ZhenjaHorbach
Copy link
Contributor Author

@kubabutkiewicz
@blazejkustra
@hoangzinh

Hello )
PR is ready)

src/components/SettlementButton.tsx Outdated Show resolved Hide resolved
src/components/SettlementButton.tsx Outdated Show resolved Hide resolved
src/ONYXKEYS.ts Outdated Show resolved Hide resolved
Copy link
Contributor

@blazejkustra blazejkustra left a comment

Choose a reason for hiding this comment

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

LGTM, please merge the newest main

@ZhenjaHorbach
Copy link
Contributor Author

@hoangzinh

Hello )
PR is ready)

@hoangzinh
Copy link
Contributor

Yup, I will try to review asap

@ZhenjaHorbach
Copy link
Contributor Author

@blazejkustra
@hoangzinh
I hope this time everything is ready)

@hoangzinh
Copy link
Contributor

hoangzinh commented Feb 1, 2024

@ZhenjaHorbach overall LGTM, but could you help to resolve conflict + perf-test is failed? Thanks

@ZhenjaHorbach
Copy link
Contributor Author

ZhenjaHorbach commented Feb 1, 2024

@ZhenjaHorbach overall LGTM, but could you help to resolve conflict + perf-test is failed? Thanks

Done )
And I'm not the only one with performance issues
https://expensify.slack.com/archives/C01GTK53T8Q/p1706732738472299

@ZhenjaHorbach
Copy link
Contributor Author

@AndrewGable
Hello )
Can you merge this PR, please?)

AndrewGable
AndrewGable previously approved these changes Feb 5, 2024
@AndrewGable
Copy link
Contributor

Conflicts:
Screenshot 2024-02-05 at 11 12 11 AM

@ZhenjaHorbach
Copy link
Contributor Author

Conflicts: Screenshot 2024-02-05 at 11 12 11 AM

Sorry ((
When I updated the branch yesterday
There were no conflicts ((

But now, PR is ready, again ))

@AndrewGable
Copy link
Contributor

All good - @hoangzinh, can you give this a quick once over before I merge?

Copy link
Contributor

@hoangzinh hoangzinh left a comment

Choose a reason for hiding this comment

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

All goods. Tested as well

@melvin-bot melvin-bot bot requested a review from AndrewGable February 6, 2024 00:46
@AndrewGable AndrewGable merged commit 500dd09 into Expensify:main Feb 6, 2024
17 checks passed
@situchan
Copy link
Contributor

situchan commented Feb 6, 2024

TS check failing on main. Caused by this PR

@ZhenjaHorbach
Copy link
Contributor Author

ZhenjaHorbach commented Feb 6, 2024

TS check failing on main. Caused by this PR

Sorry
A couple of hours before this PR, another TS PR was merged
I'll fix it now

@ZhenjaHorbach
Copy link
Contributor Author

#35877
PR with fixes

@OSBotify
Copy link
Contributor

OSBotify commented Feb 7, 2024

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

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

@OSBotify
Copy link
Contributor

OSBotify commented Feb 7, 2024

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

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

@OSBotify
Copy link
Contributor

OSBotify commented Feb 8, 2024

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

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

@@ -200,14 +182,14 @@ function SettlementButton({

// Put the preferred payment method to the front of the array, so it's shown as default
if (paymentMethod) {
return _.sortBy(buttonOptions, (method) => (method.value === paymentMethod ? 0 : 1));
return buttonOptions.sort((method) => (method.value === paymentMethod ? 0 : 1));
Copy link
Contributor

@ishpaul777 ishpaul777 Feb 19, 2024

Choose a reason for hiding this comment

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

This caused a regression here #36066, RC- syntax different between Array.sort and sortBy

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

8 participants