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 'MoneyRequestConfirmationList.js' component to TypeScript #37716

Conversation

kubabutkiewicz
Copy link
Contributor

@kubabutkiewicz kubabutkiewicz commented Mar 5, 2024

Details

Fixed Issues

$ #25138

Tests

  1. Login to app

  2. Click on FAB icon

  3. Select Send Money

  4. Go through all steps for sending money

  5. Verify all is working

  6. Login to app

  7. Click on FAB icon

  8. Select Money Request

  9. When selecting user click on Split button

  10. Finish that process

  11. Click on Split report to open confirmation list

  12. Verify it look and work well

  13. Login to app

  14. To go Workspace chat

  15. Click '+' icon

  16. Select Split Bill

  17. Select scan option

  18. Go through this process

  19. Verify that everything look and work well

  • Verify that no errors appear in the JS console

Offline tests

QA Steps

  1. Login to app

  2. Click on FAB icon

  3. Select Send Money

  4. Go through all steps for sending money

  5. Verify all is working

  6. Login to app

  7. Click on FAB icon

  8. Select Money Request

  9. When selecting user click on Split button

  10. Finish that process

  11. Click on Split report to open confirmation list

  12. Verify it look and work well

  13. Login to app

  14. To go Workspace chat

  15. Click '+' icon

  16. Select Split Bill

  17. Select scan option

  18. Go through this process

  19. Verify that everything look and work well

  • 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
android.mp4
Android: mWeb Chrome
mchrome.mp4
iOS: Native
ios.mp4
iOS: mWeb Safari
msafari.mp4
MacOS: Chrome / Safari
web.mp4
MacOS: Desktop
desktop.mp4

src/components/MoneyRequestConfirmationList.tsx Outdated Show resolved Hide resolved
src/components/MoneyRequestConfirmationList.tsx Outdated Show resolved Hide resolved
src/components/MoneyRequestConfirmationList.tsx Outdated Show resolved Hide resolved
@@ -589,8 +592,9 @@ function MoneyRequestConfirmationList(props) {
]);

const {image: receiptImage, thumbnail: receiptThumbnail} =
props.receiptPath && props.receiptFilename ? ReceiptUtils.getThumbnailAndImageURIs(transaction, props.receiptPath, props.receiptFilename) : {};
receiptPath && receiptFilename ? ReceiptUtils.getThumbnailAndImageURIs(transaction, receiptPath, receiptFilename) : ({} as ReceiptUtils.ThumbnailAndImageURI);
Copy link
Contributor

Choose a reason for hiding this comment

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

You can simplify it if you want

const receipt =  receiptPath && receiptFilename ? ReceiptUtils.getThumbnailAndImageURIs(transaction, receiptPath, receiptFilename) : null;
const receiptImage = receipt?.image;
const receiptThumbnail = receipt?.thumbnail;

src/components/MoneyRequestConfirmationList.tsx Outdated Show resolved Hide resolved
src/languages/types.ts Outdated Show resolved Hide resolved
src/libs/OptionsListUtils.ts Outdated Show resolved Hide resolved
@@ -33,7 +33,7 @@ type FileNameAndExtension = {
* @param receiptPath
* @param receiptFileName
*/
function getThumbnailAndImageURIs(transaction: OnyxEntry<Transaction>, receiptPath: string | null = null, receiptFileName: string | null = null): ThumbnailAndImageURI {
function getThumbnailAndImageURIs(transaction: OnyxEntry<Transaction> | undefined, receiptPath: string | null = null, receiptFileName: string | null = null): ThumbnailAndImageURI {
Copy link
Contributor

Choose a reason for hiding this comment

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

I think you can pass null instead of undefined to keep typing easier. To simplify you can add null as a default value in MoneyRequestConfirmationList. What do you think?

Suggested change
function getThumbnailAndImageURIs(transaction: OnyxEntry<Transaction> | undefined, receiptPath: string | null = null, receiptFileName: string | null = null): ThumbnailAndImageURI {
function getThumbnailAndImageURIs(transaction: OnyxEntry<Transaction>, receiptPath: string | null = null, receiptFileName: string | null = null): ThumbnailAndImageURI {

Copy link
Contributor Author

Choose a reason for hiding this comment

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

At the beginning I did that but then I realised I need to do it in a lot of places and decided that adding undefined to this type will be more readable

@@ -140,11 +140,11 @@ function hasReceipt(transaction: Transaction | undefined | null): boolean {
return !!transaction?.receipt?.state || hasEReceipt(transaction);
}

function isMerchantMissing(transaction: Transaction) {
if (transaction.modifiedMerchant && transaction.modifiedMerchant !== '') {
function isMerchantMissing(transaction: OnyxEntry<Transaction> | undefined) {
Copy link
Contributor

Choose a reason for hiding this comment

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

Same for every | undefined update in this file

Copy link
Contributor

Choose a reason for hiding this comment

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

I agree, could we avoid this?

Comment on lines 560 to 561
onPress={(_event, value) => confirm(value as PaymentMethodType)}
options={splitOrRequestOptions}
Copy link
Contributor

Choose a reason for hiding this comment

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

Since ButtonWithDropdownMenu has genric in typing, you can try to update splitOrRequestOptions typing to include PaymentMethodType instead of string. Though iouType and PaymentMethodType are not aligned, so there will be another TS problem.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I ended up typing confirm fn to by IouType | PaymentMethodType | undefined since I check and here from value we can only IouType based on implementation of splitOrRequestOptions but looking and implementation of sendMoney which is called inside confirm, sendMoney expects that the type will be PaymentMethodType which is odd since from my understanding it will never happen here

src/components/MoneyRequestConfirmationList.tsx Outdated Show resolved Hide resolved
src/components/MoneyRequestConfirmationList.tsx Outdated Show resolved Hide resolved
src/components/MoneyRequestConfirmationList.tsx Outdated Show resolved Hide resolved
@@ -140,11 +140,11 @@ function hasReceipt(transaction: Transaction | undefined | null): boolean {
return !!transaction?.receipt?.state || hasEReceipt(transaction);
}

function isMerchantMissing(transaction: Transaction) {
if (transaction.modifiedMerchant && transaction.modifiedMerchant !== '') {
function isMerchantMissing(transaction: OnyxEntry<Transaction> | undefined) {
Copy link
Contributor

Choose a reason for hiding this comment

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

I agree, could we avoid this?

src/components/MoneyRequestConfirmationList.tsx Outdated Show resolved Hide resolved
src/components/MoneyRequestConfirmationList.tsx Outdated Show resolved Hide resolved
src/components/MoneyRequestConfirmationList.tsx Outdated Show resolved Hide resolved
src/components/MoneyRequestConfirmationList.tsx Outdated Show resolved Hide resolved
src/components/MoneyRequestConfirmationList.tsx Outdated Show resolved Hide resolved
@@ -589,8 +590,9 @@ function MoneyRequestConfirmationList(props) {
]);

const {image: receiptImage, thumbnail: receiptThumbnail} =
props.receiptPath && props.receiptFilename ? ReceiptUtils.getThumbnailAndImageURIs(transaction, props.receiptPath, props.receiptFilename) : {};
receiptPath && receiptFilename ? ReceiptUtils.getThumbnailAndImageURIs(transaction ?? null, receiptPath, receiptFilename) : ({} as ReceiptUtils.ThumbnailAndImageURI);
Copy link
Contributor

Choose a reason for hiding this comment

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

You decided to skip this comment or is it just lost?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I decided to skip it I think its fine to leave it as it was

src/components/MoneyRequestConfirmationList.tsx Outdated Show resolved Hide resolved
@kubabutkiewicz kubabutkiewicz marked this pull request as ready for review March 8, 2024 14:51
@kubabutkiewicz kubabutkiewicz requested a review from a team as a code owner March 8, 2024 14:51
@melvin-bot melvin-bot bot requested review from fedirjh and removed request for a team March 8, 2024 14:51
Copy link

melvin-bot bot commented Mar 8, 2024

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

...participant,
isDisabled: ReportUtils.isOptimisticPersonalDetail(participant.accountID),
isDisabled: ReportUtils.isOptimisticPersonalDetail(participant.accountID ?? -1),
Copy link
Contributor

Choose a reason for hiding this comment

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

Should we modify ReportUtils.isOptimisticPersonalDetail to allow either number or undefined, then early exit if it's undefined there? Use a default value here doesn't look good to me.

Copy link
Contributor Author

@kubabutkiewicz kubabutkiewicz Mar 11, 2024

Choose a reason for hiding this comment

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

Currently when passing -1 or undefined its returning true so to not changing logic I would leave it as it is
image

...participant,
isDisabled: ReportUtils.isOptimisticPersonalDetail(participant.accountID),
isDisabled: ReportUtils.isOptimisticPersonalDetail(participant.accountID ?? -1),
Copy link
Contributor

Choose a reason for hiding this comment

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

Same as above

return;
}
Navigation.navigate(ROUTES.MONEY_REQUEST_TAG.getRoute(props.iouType, props.reportID));
Navigation.navigate(
Copy link
Contributor

Choose a reason for hiding this comment

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

Are we missing moving condition isEditingSplitBill from old component?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Adjusted 😄

@hoangzinh
Copy link
Contributor

hoangzinh commented Mar 10, 2024

Hi @fedirjh, This PR comes from here #25138 (comment). Let @kubabutkiewicz and me continue to work on it. Thanks

@hoangzinh
Copy link
Contributor

hoangzinh commented Mar 12, 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 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-03-12.at.19.16.22.android.mov
Android: mWeb Chrome
Screen.Recording.2024-03-12.at.18.41.45.android.chrome.mov
iOS: Native
Screen.Recording.2024-03-12.at.19.19.39.ios.mov
iOS: mWeb Safari
Screen.Recording.2024-03-12.at.19.21.49.ios.safari.mov
MacOS: Chrome / Safari
Screen.Recording.2024-03-12.at.07.23.43.web.mp4
MacOS: Desktop
Screen.Recording.2024-03-12.at.18.36.03.desktop.mov

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.

LGTM. Tested on:

  • Send money
  • Split bill with a WS
  • Split bill with an individual user

@AndrewGable AndrewGable merged commit eb6213f into Expensify:main Mar 12, 2024
16 checks passed
@OSBotify
Copy link
Contributor

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

@OSBotify
Copy link
Contributor

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

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

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/luacmartins in version: 1.4.51-3 🚀

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.

6 participants