App icon indicating copy to clipboard operation
App copied to clipboard

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

Open ZhenjaHorbach opened this issue 1 year ago • 25 comments

Details

Fixed Issues

$ https://github.com/Expensify/App/issues/25100 PROPOSAL: https://github.com/Expensify/App/issues/25100#issuecomment-1860945360

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
  • [x] 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
  • [x] Verify that no errors appear in the JS console

PR Author Checklist

  • [x] I linked the correct issue in the ### Fixed Issues section above
  • [x] I wrote clear testing steps that cover the changes made in this PR
    • [x] I added steps for local testing in the Tests section
    • [x] I added steps for the expected offline behavior in the Offline steps section
    • [x] I added steps for Staging and/or Production testing in the QA steps section
    • [x] I added steps to cover failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
    • [x] 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)
    • [x] 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).
  • [x] I included screenshots or videos for tests on all platforms
  • [x] I ran the tests on all platforms & verified they passed on:
    • [x] Android: Native
    • [x] Android: mWeb Chrome
    • [x] iOS: Native
    • [x] iOS: mWeb Safari
    • [x] MacOS: Chrome / Safari
    • [x] MacOS: Desktop
  • [x] 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)
  • [x] I followed proper code patterns (see Reviewing the code)
    • [x] 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)
    • [x] I verified that the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
    • [x] I verified that comments were added to code that is not self explanatory
    • [x] 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.
    • [x] I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
      • [x] 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:
    • [x] I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
    • [x] 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.
    • [x] 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.
    • [x] I verified the JSDocs style guidelines (in STYLE.md) were followed
  • [x] If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
  • [x] I followed the guidelines as stated in the Review Guidelines
  • [x] 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)
  • [x] I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
  • [x] 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
  • [x] I verified that if a function's arguments changed that all usages have also been updated correctly
  • [x] If any new file was added I verified that:
    • [x] 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
  • [x] If a new CSS style is added I verified that:
    • [x] A similar style doesn't already exist
    • [x] The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(theme.componentBG))
  • [x] 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.
  • [x] 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)
  • [x] 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.
  • [x] 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.
  • [x] If the PR modifies the form input styles:
    • [x] I verified that all the inputs inside a form are aligned with each other.
    • [x] I added Design label so the design team can review the changes.
  • [x] 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.
  • [x] 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

https://github.com/Expensify/App/assets/68128028/0d9cd697-215a-4a45-8bc1-4d1549d4ce3d

Android: mWeb Chrome

https://github.com/Expensify/App/assets/68128028/0f03e542-3e55-49ce-b47a-15be03a12cab

iOS: Native

https://github.com/Expensify/App/assets/68128028/d90983d8-b211-41a1-b084-2f1ec0db5c22

iOS: mWeb Safari

https://github.com/Expensify/App/assets/68128028/b7eb5918-a473-4b57-ba17-3d4c760737f1

MacOS: Chrome / Safari

https://github.com/Expensify/App/assets/68128028/8cbaa0fc-707b-4f8a-9a68-5d01196221a1

MacOS: Desktop

https://github.com/Expensify/App/assets/68128028/e1b57e20-0347-4c36-8116-a3042547ccff

ZhenjaHorbach avatar Jan 03 '24 09:01 ZhenjaHorbach

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

melvin-bot[bot] avatar Jan 03 '24 09:01 melvin-bot[bot]

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

blazejkustra avatar Jan 05 '24 10:01 blazejkustra

@kubabutkiewicz @blazejkustra @hoangzinh

Hello ) PR is ready)

ZhenjaHorbach avatar Jan 08 '24 08:01 ZhenjaHorbach

@hoangzinh

Hello ) PR is ready)

ZhenjaHorbach avatar Jan 15 '24 15:01 ZhenjaHorbach

Yup, I will try to review asap

hoangzinh avatar Jan 15 '24 15:01 hoangzinh

Reviewer Checklist

  • [x] I have verified the author checklist is complete (all boxes are checked off).
  • [x] I verified the correct issue is linked in the ### Fixed Issues section above
  • [x] I verified testing steps are clear and they cover the changes made in this PR
    • [x] I verified the steps for local testing are in the Tests section
    • [x] I verified the steps for Staging and/or Production testing are in the QA steps section
    • [x] 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)
    • [x] 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)
  • [x] I checked that screenshots or videos are included for tests on all platforms
  • [x] I included screenshots or videos for tests on all platforms
  • [x] I verified tests pass on all platforms & I tested again on:
    • [x] Android: Native
    • [x] Android: mWeb Chrome
    • [x] iOS: Native
    • [x] iOS: mWeb Safari
    • [x] MacOS: Chrome / Safari
    • [x] MacOS: Desktop
  • [x] 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
  • [x] I verified proper code patterns were followed (see Reviewing the code)
    • [x] 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).
    • [x] I verified that the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
    • [x] I verified that comments were added to code that is not self explanatory
    • [x] 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.
    • [x] I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
    • [x] I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
    • [x] 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.
    • [x] 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.
    • [x] I verified the JSDocs style guidelines (in STYLE.md) were followed
  • [x] If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
  • [x] I verified that this PR follows the guidelines as stated in the Review Guidelines
  • [x] 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)
  • [x] I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
  • [x] 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
  • [x] If a new component is created I verified that:
    • [x] A similar component doesn't exist in the codebase
    • [x] All props are defined accurately and each prop has a /** comment above it */
    • [x] The file is named correctly
    • [x] The component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone
    • [x] The only data being stored in the state is data necessary for rendering and nothing else
    • [x] 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)
    • [x] 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)
    • [x] All JSX used for rendering exists in the render method
    • [x] 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
  • [x] If any new file was added I verified that:
    • [x] 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
  • [x] If a new CSS style is added I verified that:
    • [x] A similar style doesn't already exist
    • [x] The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(theme.componentBG)
  • [x] 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.
  • [x] 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)
  • [x] 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.
  • [x] 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.
  • [x] If the PR modifies the form input styles:
    • [x] I verified that all the inputs inside a form are aligned with each other.
    • [x] I added Design label so the design team can review the changes.
  • [x] 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.
  • [x] 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.
  • [x] I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

Screenshots/Videos

Android: Native

https://github.com/Expensify/App/assets/9639873/ed640c53-bcd5-460e-980a-157b25e05999

Android: mWeb Chrome

https://github.com/Expensify/App/assets/9639873/147c10c4-3315-485a-9d11-a4160bbd262a

iOS: Native

https://github.com/Expensify/App/assets/9639873/c099e0c6-70e7-48d3-ae91-19c20c7c4f4c

iOS: mWeb Safari

https://github.com/Expensify/App/assets/9639873/24349229-0b46-47dd-8437-af5a6e77bd5d

MacOS: Chrome / Safari

https://github.com/Expensify/App/assets/9639873/3829633e-c35f-4f8a-a6ed-0b2cdb9bf62d

MacOS: Desktop

https://github.com/Expensify/App/assets/9639873/2acca0df-6f67-420f-9412-db5cef53652a

hoangzinh avatar Jan 16 '24 13:01 hoangzinh

@ZhenjaHorbach thanks for the updates. One last thing. I think the 2nd test step should be

- 2. Select the manual tab
+ 2. Select the Distance tab

hoangzinh avatar Jan 16 '24 23:01 hoangzinh

@ZhenjaHorbach thanks for the updates. One last thing. I think the 2nd test step should be

- 2. Select the manual tab
+ 2. Select the Distance tab

Oh, yeah You are right Thanks ) Done )

ZhenjaHorbach avatar Jan 17 '24 07:01 ZhenjaHorbach

Looking good, but conflicts. Will give a final review when they are resolved.

AndrewGable avatar Jan 19 '24 16:01 AndrewGable

Looking good, but conflicts. Will give a final review when they are resolved.

Give me 5 minutes)

ZhenjaHorbach avatar Jan 19 '24 16:01 ZhenjaHorbach

Waiting for response from https://github.com/Expensify/App/pull/33714#issuecomment-1899988170 and https://github.com/Expensify/App/pull/33714#issuecomment-1900842271

ZhenjaHorbach avatar Jan 19 '24 18:01 ZhenjaHorbach

@ZhenjaHorbach perf-tests & TS checks are failed. Please help to check the PR checklist.

hoangzinh avatar Jan 22 '24 01:01 hoangzinh

Waiting for response from https://github.com/Expensify/App/pull/33714#issuecomment-1899988170 and https://github.com/Expensify/App/pull/33714#issuecomment-1900842271

Still waiting

ZhenjaHorbach avatar Jan 22 '24 07:01 ZhenjaHorbach

@hoangzinh I hope this was the last commit )))

ZhenjaHorbach avatar Jan 22 '24 09:01 ZhenjaHorbach

@hoangzinh - Can you re-review? I've seen a few merges with main that introduce issues and would love to make sure this isn't one of them 😄

AndrewGable avatar Jan 22 '24 22:01 AndrewGable

Sure, I will try to review & test again today

hoangzinh avatar Jan 23 '24 09:01 hoangzinh

Please sync this branch with the newest main. Context here, thanks!

blazejkustra avatar Jan 25 '24 15:01 blazejkustra

Please sync this branch with the newest main. Context here, thanks!

Done ) And @blazejkustra can you please help with this question ?) https://github.com/Expensify/App/pull/33866#discussion_r1465179347 Thanks )

ZhenjaHorbach avatar Jan 25 '24 15:01 ZhenjaHorbach

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

ZhenjaHorbach avatar Jan 31 '24 17:01 ZhenjaHorbach

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

hoangzinh avatar Feb 01 '24 09:02 hoangzinh

@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 avatar Feb 01 '24 10:02 ZhenjaHorbach

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

ZhenjaHorbach avatar Feb 04 '24 20:02 ZhenjaHorbach

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

AndrewGable avatar Feb 05 '24 18:02 AndrewGable

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 ))

ZhenjaHorbach avatar Feb 05 '24 18:02 ZhenjaHorbach

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

AndrewGable avatar Feb 05 '24 18:02 AndrewGable

TS check failing on main. Caused by this PR

situchan avatar Feb 06 '24 06:02 situchan

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 avatar Feb 06 '24 07:02 ZhenjaHorbach

https://github.com/Expensify/App/pull/35877 PR with fixes

ZhenjaHorbach avatar Feb 06 '24 08:02 ZhenjaHorbach

🚀 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 avatar Feb 07 '24 10:02 OSBotify

🚀 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 avatar Feb 07 '24 10:02 OSBotify