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 'ReportActionItemMoneyRequest' component to TypeScript #34564

Conversation

VickyStash
Copy link
Contributor

@VickyStash VickyStash commented Jan 16, 2024

Details

[TS migration] Migrate 'ReportActionItemMoneyRequest' component to TypeScript

Fixed Issues

$ #31983
PROPOSAL: N/A

Tests

  • Verify that no errors appear in the JS console
  1. Open app
  2. Log in with any account that has a workspace

Requests to another User

  1. Create several Manual and Scan money requests to another user.
  2. Open the chat with that user and click on the grouped requests report preview.
  3. Make sure the money requests preview looks as expected. They have the correct amount and currency. If the Scan request is still in progress, the message should say Receipt scan in progress....
  4. Tap on Manual Money request preview to open its view. Make sure it looks as expected and has all the necessary data. You can also update Description/Date fields.
  5. Tap on Scan Money request preview to open its view. Make sure it looks same way as before and has all the necessary data.

Requests to Workspace

  1. Create several Manual,Scan and Distance money requests to the workspace.
  2. Open the workspace chat and click on the grouped requests report preview.
  3. Make sure the money requests preview looks as expected. The Distance request preview should have a map (or default image if the request is still processed) with a distance, currency and amount of money as well as the distance value.
  4. Tap on Distance Money request preview to open its view. Make sure it looks the same way as before and has all the necessary data.

Offline tests

  1. Open app
  2. Log in with any account that has a workspace
  3. Create several Manual,Scan and Distance money requests to the workspace.
  4. Open the workspace chat and click on the grouped requests report preview.
  5. Make sure the money requests preview looks as expected.
  6. Go offline
  7. Delete a money request
  8. Make sure that the request skeleton shows the correct amount and currency.

QA Steps

  • Verify that no errors appear in the JS console

Same as in Tests + Offline Tests sections

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
android1.mp4
Android: mWeb Chrome
android_web1.mp4
iOS: Native
ios1.mp4
iOS: mWeb Safari
ios_web1.mp4
MacOS: Chrome / Safari
web1.mp4
MacOS: Desktop
desktop1.mp4

…mponent

# Conflicts:
#	src/components/ReportActionItem/MoneyRequestView.tsx
…mponent

# Conflicts:
#	src/components/ReportActionItem/MoneyRequestPreview.tsx
#	src/pages/home/report/ContextMenu/ReportActionContextMenu.ts
…mponent

# Conflicts:
#	src/types/onyx/Policy.ts
…mponent

# Conflicts:
#	src/types/onyx/TransactionViolation.ts
#	src/types/onyx/index.ts
Comment on lines -242 to 238
const getDisplayDeleteAmountText = () => {
const {amount, currency} = ReportUtils.getTransactionDetails(props.action.originalMessage);

if (isDistanceRequest) {
return CurrencyUtils.convertToDisplayString(TransactionUtils.getAmount(props.action.originalMessage), currency);
}
const getDisplayDeleteAmountText = (): string => {
const iouOriginalMessage: IOUMessage | EmptyObject = action?.actionName === CONST.REPORT.ACTIONS.TYPE.IOU ? action.originalMessage : {};
const {amount = 0, currency = CONST.CURRENCY.USD} = iouOriginalMessage;

return CurrencyUtils.convertToDisplayString(amount, currency);
};
Copy link
Contributor Author

Choose a reason for hiding this comment

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

During this file migration, it turned out that originalMessage of action is passed to methods where transaction is expected to get the amount and currency values. Though originalMessage doesn't look like transaction at all
image
After some testing I've find out that the functionality of getDisplayDeleteAmountText function can be simplified.

…mponent

# Conflicts:
#	src/components/ReportActionItem/MoneyRequestPreview.tsx
…mponent

# Conflicts:
#	src/components/ReportActionItem/MoneyRequestView.tsx
#	src/libs/ReceiptUtils.ts
…mponent

# Conflicts:
#	src/types/onyx/Policy.ts
…mponent

# Conflicts:
#	src/types/onyx/Policy.ts
…mponent

# Conflicts:
#	src/pages/home/report/ContextMenu/PopoverReportActionContextMenu.tsx
…mponent

# Conflicts:
#	src/components/ReportActionItem/MoneyRequestAction.tsx
#	src/components/ReportActionItem/MoneyRequestPreview.tsx
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! LGTM

@VickyStash VickyStash marked this pull request as ready for review January 29, 2024 12:09
@VickyStash VickyStash requested a review from a team as a code owner January 29, 2024 12:09
@VickyStash
Copy link
Contributor Author

@rushatgabhane kind bump 🙂

@VickyStash
Copy link
Contributor Author

@rushatgabhane Hey, any ETA on reviewing this one? 🙂

@rushatgabhane
Copy link
Member

rushatgabhane commented Feb 2, 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 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

WhatsApp Image 2024-02-02 at 22 06 51

Android: mWeb Chrome image
iOS: Native image image
iOS: mWeb Safari image
MacOS: Chrome / Safari image image image
MacOS: Desktop

Copy link
Member

@rushatgabhane rushatgabhane left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link

melvin-bot bot commented Feb 2, 2024

We did not find an internal engineer to review this PR, trying to assign a random engineer to #31983 as well as to this PR... Please reach out for help on Slack if no one gets assigned!

@fabioh8010
Copy link
Contributor

@mountiny Could we assign a engineer here? Looks like Melvin didn't assign anyone.
@VickyStash Please fix conflicts 🙂

@rushatgabhane
Copy link
Member

@aldo-expensify all yours!

@aldo-expensify
Copy link
Contributor

@VickyStash there are conflicts now, please resolve 🙏

…mponent

# Conflicts:
#	src/components/ReportActionItem/MoneyRequestPreview.tsx
#	src/components/ReportActionItem/MoneyRequestView.tsx
@VickyStash
Copy link
Contributor Author

@aldo-expensify Done 👌

@aldo-expensify
Copy link
Contributor

aldo-expensify commented Feb 2, 2024

Thank you!, this is a huge (maybe "huge" was too exaggerated) big PR, I skim read the changes and didn't see anything wrong, I hope everything is fine 🥲

@aldo-expensify aldo-expensify merged commit de633ac into Expensify:main Feb 2, 2024
15 checks passed
@OSBotify
Copy link
Contributor

OSBotify commented Feb 2, 2024

✋ 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

OSBotify commented Feb 5, 2024

🚀 Cherry-picked to staging by https://github.com/thienlnam in version: 1.4.36-5 🚀

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

@Expensify/applauseleads please QA this PR and check it off on the deploy checklist if it passes.

1 similar comment
@OSBotify
Copy link
Contributor

OSBotify commented Feb 5, 2024

🚀 Cherry-picked to staging by https://github.com/thienlnam in version: 1.4.36-5 🚀

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

@Expensify/applauseleads please QA this PR and check it off on the deploy checklist if it passes.

<Text style={[styles.textLabel, styles.colorMuted]}>{translate('iou.pendingConversionMessage')}</Text>
)}
{shouldShowDescription && <RenderHTML html={parser.replace(merchantOrDescription)} />}
{shouldShowMerchant && <Text style={[styles.textLabelSupporting, styles.textNormal]}>{merchantOrDescription}</Text>}
</View>
{props.isBillSplit && !_.isEmpty(participantAccountIDs) && requestAmount > 0 && (
{isBillSplit && participantAccountIDs.length > 0 && requestAmount && requestAmount > 0 && (
Copy link
Contributor

Choose a reason for hiding this comment

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

@VickyStash Native app crashes on this line. Can you please raise quick PR fixing that?

Suggested change
{isBillSplit && participantAccountIDs.length > 0 && requestAmount && requestAmount > 0 && (
{isBillSplit && participantAccountIDs.length > 0 && !!requestAmount && requestAmount > 0 && (
Screenshot 2024-02-06 at 9 15 57 PM

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@situchan I'm taking a look

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@situchan could you please provide me steps for reproduction so I can be sure the issue is fixed?

Copy link
Contributor

Choose a reason for hiding this comment

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

I tested that solution myself. Works well.
I was just testing #35876. Please try to follow QA step on that PR.

Copy link
Contributor

Choose a reason for hiding this comment

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

So that happens when requestAmount = 0
Try this:
A request $10 from B
B request $10 (same amount) from A

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@situchan I got what you mean and it makes sense to me, but I'm still not able to trigger this case on the main, could you please provide me reproduction video 🙏

Navigation.navigate(ROUTES.SPLIT_BILL_DETAILS.getRoute(chatReportID, reportActionID));
return;
}

// If the childReportID is not present, we need to create a new thread
const childReportID = lodashGet(action, 'childReportID', 0);
const childReportID = action?.childReportID ?? '0';
Copy link
Contributor

@youssef-lr youssef-lr Feb 6, 2024

Choose a reason for hiding this comment

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

@VickyStash heads up! All IDs must be numbers, this created this bug #35904. :)

Copy link
Contributor

Choose a reason for hiding this comment

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

accountIDs are numbers and reportIDs are strings, right? 🤔

Copy link
Contributor

@aldo-expensify aldo-expensify Feb 6, 2024

Choose a reason for hiding this comment

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

@youssef-lr reportIDs are expected to be string, otherwise they can overflow, right?
Unless this changed lately

Copy link
Contributor

Choose a reason for hiding this comment

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

Yeah sorry my bad, they are all numbers in the backend, but in JS reportIDs & reportActionIDs are strings. In this specific example it doesn't make sense to use '0', because the condition below this line evaluates to false when it should evaluate to true if (!childReportID) {

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@youssef-lr you are right, my bad!

Copy link
Contributor

@aldo-expensify aldo-expensify Feb 6, 2024

Choose a reason for hiding this comment

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

Commented in your PR @youssef-lr , I don't think we should default to 0 either

Copy link
Contributor

Choose a reason for hiding this comment

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

Yeah that sounds good, updated.

@OSBotify
Copy link
Contributor

OSBotify commented Feb 7, 2024

🚀 Deployed to production by https://github.com/Julesssss in version: 1.4.37-7 🚀

platform result
🤖 android 🤖 success ✅
🖥 desktop 🖥 success ✅
🍎 iOS 🍎 failure ❌
🕸 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.

9 participants