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 'IOU' page to TypeScript #35253

Conversation

pac-guerreiro
Copy link
Contributor

@pac-guerreiro pac-guerreiro commented Jan 26, 2024

Details

Fixed Issues

$#25200
PROPOSAL: N/A

Tests

Split bill - Details (SplitBillDetailsPage.tsx & WithReportAndReportActionOrNotFound.tsx)

  1. On home screen, click on the ( + ) floating action button and select Request money
  2. Select manual, enter any valid amount and continue
  3. Click on Split on any participant and click on Add to split
  4. Click on Split {currency} {amount}
  5. Click on the newly created split preview
  6. Check that the page renders correctly and works as expected

Send money - Confirmation step (MoneyRequestConfirmationList.tsx)

  1. On home screen, click on the ( + ) floating action button and select Send money
  2. Enter any valid amount and continue
  3. Select any participant and continue
  4. Check that the confirmation page renders correctly and works as expected

NewDistanceRequestPage.tsx

  • Unable to test

NewRequestAmountPage.tsx

  • Unable to test

Offline tests

Same as tests

QA Steps

Same as tests

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

Send Money - Android
Split Details - Android

Android: mWeb Chrome

Send Money - Android Chrome
Split Details - Android Chrome

iOS: Native

Send Money - iOS
Split Details - iOS

iOS: mWeb Safari

Send Money - iOS Safari
Split Details - iOS Safari

MacOS: Chrome / Safari Send Money - Chrome Split Details - Chrome
MacOS: Desktop Send Money - MacOS Split Details - MacOS

@pac-guerreiro
Copy link
Contributor Author

pac-guerreiro commented Jan 26, 2024

This PR is dependent on #34335, #24921 and #32004

…ypescript

# Conflicts:
#	src/ONYXKEYS.ts
#	src/pages/iou/SplitBillDetailsPage.js
…ypescript

# Conflicts:
#	src/ONYXKEYS.ts
#	src/libs/actions/IOU.ts
src/libs/ReportUtils.ts Outdated Show resolved Hide resolved
src/libs/TransactionUtils.ts Outdated Show resolved Hide resolved
src/libs/TransactionUtils.ts Outdated Show resolved Hide resolved
src/libs/actions/IOU.ts Outdated Show resolved Hide resolved
src/libs/actions/IOU.ts Outdated Show resolved Hide resolved
src/pages/iou/steps/NewRequestAmountPage.tsx Outdated Show resolved Hide resolved
src/pages/iou/steps/NewRequestAmountPage.tsx Outdated Show resolved Hide resolved
src/pages/iou/steps/NewRequestAmountPage.tsx Outdated Show resolved Hide resolved
src/pages/iou/steps/NewRequestAmountPage.tsx Outdated Show resolved Hide resolved
src/pages/iou/steps/NewRequestAmountPage.tsx Outdated Show resolved Hide resolved
src/pages/iou/NewDistanceRequestPage.tsx Outdated Show resolved Hide resolved
src/pages/iou/steps/NewRequestAmountPage.tsx Show resolved Hide resolved
src/pages/iou/steps/NewRequestAmountPage.tsx Outdated Show resolved Hide resolved
src/pages/iou/steps/NewRequestAmountPage.tsx Outdated Show resolved Hide resolved
src/pages/iou/SplitBillDetailsPage.tsx Outdated Show resolved Hide resolved
src/pages/iou/SplitBillDetailsPage.tsx Outdated Show resolved Hide resolved
src/pages/iou/SplitBillDetailsPage.tsx Outdated Show resolved Hide resolved
src/pages/iou/SplitBillDetailsPage.tsx Outdated Show resolved Hide resolved
@fabioh8010
Copy link
Contributor

What's the status on this @pac-guerreiro ?

@pac-guerreiro
Copy link
Contributor Author

@fabioh8010

This is ready for re-review by our team!

src/ONYXKEYS.ts Outdated Show resolved Hide resolved
src/pages/iou/NewDistanceRequestPage.tsx Outdated Show resolved Hide resolved
src/components/DistanceRequest/index.tsx Outdated Show resolved Hide resolved
src/pages/iou/SplitBillDetailsPage.tsx Outdated Show resolved Hide resolved
src/pages/iou/SplitBillDetailsPage.tsx 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.

Great work! Left couple comments 😄

src/pages/iou/steps/NewRequestAmountPage.tsx Show resolved Hide resolved
src/pages/iou/steps/NewRequestAmountPage.tsx Outdated Show resolved Hide resolved
src/pages/iou/steps/NewRequestAmountPage.tsx Show resolved Hide resolved
src/pages/iou/steps/NewRequestAmountPage.tsx Outdated Show resolved Hide resolved
@c3024
Copy link
Contributor

c3024 commented Mar 22, 2024

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 either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
    • 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 UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
    • I verified that all the inputs inside a form are aligned with each other.
    • I added Design label and/or tagged @Expensify/design 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
iouAndroid.mp4
Android: mWeb Chrome
iouAndroidChrome.mp4
iOS: Native
iouiOS.mp4
iOS: mWeb Safari
iouiOSSafari.mp4
MacOS: Chrome / Safari
splitBillChrome.mp4
sendMoneyChrome.mp4
MacOS: Desktop
splitBillDesktop.mp4
sendMoneyDesktop.mp4

src/pages/iou/SplitBillDetailsPage.tsx Outdated Show resolved Hide resolved
src/pages/iou/SplitBillDetailsPage.tsx Outdated Show resolved Hide resolved
@c3024
Copy link
Contributor

c3024 commented Mar 24, 2024

Creating a split bill offline shows a continuous loading indicator on the group chat on this branch whereas on main it shows the optimistic report preview of the split request on the group chat correctly.

splitBillOffline.mp4

@fabioh8010
Copy link
Contributor

@pac-guerreiro bump

@pac-guerreiro
Copy link
Contributor Author

@fabioh8010 @c3024

All feedback addressed, thanks for your patience! 😄

The split bill bug should be resolved, as you can see below but give it a try once again just in case

Screen.Recording.2024-03-26.at.23.32.22.mp4

@srikarparsi
Copy link
Contributor

Hi @c3024, can you take another look at this whenever you get a chance?

@c3024
Copy link
Contributor

c3024 commented Mar 28, 2024

NewDistanceRequestPage.tsx

Unable to test

No changes are made to this file in this PR so I think this need not be tested. This is not being used anywhere and completely deprecated in #34610

NewRequestAmountPage.tsx

Unable to test

This is not used anywhere anymore and this will also be deprecated in #34614

Copy link
Contributor

@c3024 c3024 left a comment

Choose a reason for hiding this comment

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

LGTM

@blazejkustra
Copy link
Contributor

@srikarparsi All yours!

@blazejkustra
Copy link
Contributor

@pac-guerreiro Let's merge the newest main here

@pac-guerreiro
Copy link
Contributor Author

@fabioh8010 @srikarparsi @blazejkustra I merged latest main to this branch

@kubabutkiewicz
Copy link
Contributor

@srikarparsi kind bump 😄

@srikarparsi
Copy link
Contributor

Sorry about that, taking a look

Copy link
Contributor

@srikarparsi srikarparsi left a comment

Choose a reason for hiding this comment

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

lgtm as well, thanks for the changes :)

@srikarparsi srikarparsi merged commit 2d7addc into Expensify:main Mar 29, 2024
15 checks passed
Copy link

melvin-bot bot commented Mar 29, 2024

@srikarparsi looks like this was merged without a test passing. Please add a note explaining why this was done and remove the Emergency label if this is not an emergency.

@melvin-bot melvin-bot bot added the Emergency label Mar 29, 2024
@srikarparsi
Copy link
Contributor

srikarparsi commented Mar 29, 2024

No tests failed above, removing the emergency label

Screen.Recording.2024-03-29.at.1.51.48.PM.mov

@OSBotify
Copy link
Contributor

OSBotify commented Apr 2, 2024

🚀 Deployed to staging by https://github.com/srikarparsi in version: 1.4.59-0 🚀

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

@OSBotify
Copy link
Contributor

OSBotify commented Apr 8, 2024

🚀 Deployed to production by https://github.com/Julesssss in version: 1.4.60-13 🚀

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

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