[No QA] [TS migration] Migrate 'TransactionUtils.js' lib to TypeScript by VickyStash · Pull Request #28005 · Expensify/App

VickyStash · 2023-09-22T11:14:32Z

Details

Migrate 'TransactionUtils.js' lib to TypeScript

Fixed Issues

$ #24893
PROPOSAL: N/A

Tests

Verify that no errors appear in the JS console

Make sure the Request Money functionality works as expected

Offline tests

QA Steps

Verify that no errors appear in the JS console

Make sure the Request Money functionality works as expected

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 / Chrome
- iOS / native
- iOS / 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 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
- If we are not using the full Onyx data that we loaded, I've added the proper selector in order to ensure the component only re-renders when the data it is using changes
- 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(themeColors.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 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 author checklist, including those that don't apply to this PR.

Screenshots/Videos

Web

Web.mov

Mobile Web - Chrome

android.google.mp4

Mobile Web - Safari

ios.safari.mp4

Desktop

Desktop.mov

iOS

ios.mov

Android

Android.mov

src/libs/TransactionUtils.ts

rezkiy37

Left a couple comments.

src/libs/TransactionUtils.ts

# Conflicts: # src/libs/TransactionUtils.js # src/types/onyx/Transaction.ts

src/libs/TransactionUtils.ts

rezkiy37

Left a comment. Besides, LGTM.

melvin-bot · 2023-09-26T06:11:28Z

@aimane-chnaif 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 · 2023-09-26T06:29:22Z

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

blazejkustra

LGTM, SWM still need to do the checklist.

blazejkustra · 2023-09-26T06:54:08Z

src/libs/TransactionUtils.ts

+    };
+}
+
+function hasReceipt(transaction: Transaction | undefined | null): boolean {


Suggested change

function hasReceipt(transaction: Transaction | undefined | null): boolean {

function hasReceipt(transaction?: Transaction | null): boolean {

@blazejkustra This way, it will be possible to call TransactionUtils.hasReceipt(); without any arguments, I am not sure that it's expected

BartoszGrajdek · 2023-09-26T08:09:26Z

Reviewing...

BartoszGrajdek · 2023-09-26T08:26:04Z

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 / Chrome
- iOS / native
- iOS / 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(themeColors.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 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

Web

web.mov

Mobile Web - Chrome

chrome.mov

Mobile Web - Safari

safari.mov

Desktop

desktop.mov

iOS

ios.mov

Android

android.mov

BartoszGrajdek · 2023-09-26T08:26:44Z

LGTM! Make sure to check suggestions from Błażej @VickyStash

# Conflicts: # src/libs/TransactionUtils.js # src/types/onyx/OriginalMessage.ts # src/types/onyx/Transaction.ts

melvin-bot · 2023-10-02T10:55:46Z

Congrats, that’s your 5th PR merged! 🎉 Do you know about the ContributorPlus role? It’s an opportunity to earn more in the Expensify Open Source community. Keep up the great work - thanks!

OSBotify · 2023-10-02T11:03:00Z

✋ 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 · 2023-10-02T17:45:43Z

🚀 Deployed to staging by https://github.com/cristipaval in version: 1.3.76-0 🚀

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

mountiny · 2023-10-03T09:54:59Z

src/libs/TransactionUtils.ts

+ * Return the merchant field from the transaction, return the modifiedMerchant if present.
+ */
+function getMerchant(transaction: Transaction): string {
+    return transaction?.modifiedMerchant ?? transaction?.merchant ?? '';


This caused a deploy blocker, the ?? operator only returns the right side of the operator if transaction?.modifiedMerchant is null but the transaction?.modifiedMerchant value in this case is `` an empty string so we return an empty string by mistake

mountiny · 2023-10-03T09:55:43Z

src/libs/TransactionUtils.ts

+ * Return the created field from the transaction, return the modifiedCreated if present.
+ */
+function getCreated(transaction: Transaction): string {
+    const created = transaction?.modifiedCreated ?? transaction?.created ?? '';


This caused a deploy blocker, the ?? operator only returns the right side of the operator if transaction?. modifiedCreated is null but the transaction?. modifiedCreated value in this case is `` an empty string so we return an empty string by mistake

OSBotify · 2023-10-03T15:46:40Z

🚀 Deployed to production by https://github.com/mountiny in version: 1.3.76-6 🚀

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

OSBotify · 2023-10-03T16:11:03Z

🚀 Deployed to staging by https://github.com/cristipaval in version: 1.3.77-0 🚀

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

OSBotify · 2023-10-05T00:17:53Z

🚀 Deployed to production by https://github.com/mountiny in version: 1.3.77-7 🚀

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

neil-marcellini · 2023-10-18T00:21:03Z

src/libs/TransactionUtils.ts

+ * Filters the waypoints which are valid and returns those
+ */
+function getValidWaypoints(waypoints: WaypointCollection, reArrangeIndexes = false): WaypointCollection {
+    const sortedIndexes = Object.keys(waypoints).map(getWaypointIndex).sort();


@VickyStash I think this introduced a regression or is at least part of the cause for this issue #29621.

By default Array.prototype.sort() does the following. "The default sort order is ascending, built upon converting the elements into strings, then comparing their sequences of UTF-16 code units values.". So therefore the waypoints get out of order when you have 10+ because the number indexes are sorted as strings.

I'm working on a fix, which should be easy for this piece.

cc @cristipaval since you reviewed as well

[TS migration] Migrate 'TransactionUtils.js' lib

884a83f

adhorodyski reviewed Sep 22, 2023

View reviewed changes

src/libs/TransactionUtils.ts Outdated Show resolved Hide resolved

kubabutkiewicz reviewed Sep 22, 2023

View reviewed changes

src/libs/TransactionUtils.ts Outdated Show resolved Hide resolved

kubabutkiewicz reviewed Sep 22, 2023

View reviewed changes

src/libs/TransactionUtils.ts Outdated Show resolved Hide resolved

kubabutkiewicz reviewed Sep 22, 2023

View reviewed changes

src/libs/TransactionUtils.ts Outdated Show resolved Hide resolved

kubabutkiewicz reviewed Sep 22, 2023

View reviewed changes

src/libs/TransactionUtils.ts Outdated Show resolved Hide resolved

rezkiy37 reviewed Sep 22, 2023

View reviewed changes

src/libs/TransactionUtils.ts Show resolved Hide resolved

rezkiy37 reviewed Sep 22, 2023

View reviewed changes

src/libs/TransactionUtils.ts Outdated Show resolved Hide resolved

rezkiy37 reviewed Sep 22, 2023

View reviewed changes

fabioh8010 reviewed Sep 22, 2023

View reviewed changes

VickyStash added 4 commits September 22, 2023 18:46

Add falsy transactions filtering, code improvements

c94f2ab

Merge branch 'main' into ts-migration/transactionUtils-lib

93d4f04

# Conflicts: # src/libs/TransactionUtils.js # src/types/onyx/Transaction.ts

Resolve conflicts

5064097

Update types

4e27e29

rezkiy37 reviewed Sep 25, 2023

View reviewed changes

src/libs/TransactionUtils.ts Outdated Show resolved Hide resolved

rezkiy37 reviewed Sep 25, 2023

View reviewed changes

Code improvement

8e776e6

fabioh8010 approved these changes Sep 25, 2023

View reviewed changes

VickyStash marked this pull request as ready for review September 26, 2023 06:11

VickyStash requested a review from a team as a code owner September 26, 2023 06:11

melvin-bot bot requested review from aimane-chnaif and removed request for a team September 26, 2023 06:11

aimane-chnaif approved these changes Sep 26, 2023

View reviewed changes

melvin-bot bot requested a review from cristipaval September 26, 2023 06:29

blazejkustra approved these changes Sep 26, 2023

View reviewed changes

VickyStash added 2 commits September 28, 2023 15:26

Merge branch 'main' into ts-migration/transactionUtils-lib

22452d5

# Conflicts: # src/libs/TransactionUtils.js # src/types/onyx/OriginalMessage.ts # src/types/onyx/Transaction.ts

Resolve conflicts

15aed9b

cristipaval approved these changes Oct 2, 2023

View reviewed changes

cristipaval merged commit 1b94d11 into Expensify:main Oct 2, 2023

OSBotify mentioned this pull request Oct 2, 2023

Deploy Checklist: New Expensify 2023-10-02 #28635

Closed

namhihi237 mentioned this pull request Oct 3, 2023

[HOLD for payment 2023-10-12] [HOLD for payment 2023-10-10] [$500] Android- IOU-App crashes when saving the selected date & merchant/date field not shown #28690

Closed

6 tasks

mountiny reviewed Oct 3, 2023

View reviewed changes

melvin-bot bot mentioned this pull request Oct 3, 2023

[HOLD for payment 2023-10-10] [TS migration] Migrate 'TransactionUtils.js' lib to TypeScript #24893

Closed

OSBotify mentioned this pull request Oct 3, 2023

Deploy Checklist: New Expensify 2023-10-03 #28727

Closed

neil-marcellini reviewed Oct 18, 2023

View reviewed changes

neil-marcellini mentioned this pull request Oct 19, 2023

Fix distance waypoint ordering #29843

Merged

59 tasks

	function hasReceipt(transaction: Transaction \| undefined \| null): boolean {
	function hasReceipt(transaction?: Transaction \| null): boolean {

Conversation

VickyStash commented Sep 22, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

rezkiy37 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

rezkiy37 left a comment

Choose a reason for hiding this comment

Uh oh!

melvin-bot bot commented Sep 26, 2023

Uh oh!

melvin-bot bot commented Sep 26, 2023

Uh oh!

blazejkustra left a comment

Choose a reason for hiding this comment

Uh oh!

blazejkustra Sep 26, 2023

Choose a reason for hiding this comment

Uh oh!

VickyStash Sep 26, 2023

Choose a reason for hiding this comment

Uh oh!

BartoszGrajdek commented Sep 26, 2023

Uh oh!

BartoszGrajdek commented Sep 26, 2023

Reviewer Checklist

Screenshots/Videos

Uh oh!

BartoszGrajdek commented Sep 26, 2023

Uh oh!

melvin-bot bot commented Oct 2, 2023

Uh oh!

OSBotify commented Oct 2, 2023

Uh oh!

OSBotify commented Oct 2, 2023

Uh oh!

mountiny Oct 3, 2023

Choose a reason for hiding this comment

Uh oh!

mountiny Oct 3, 2023

Choose a reason for hiding this comment

Uh oh!

OSBotify commented Oct 3, 2023

Uh oh!

OSBotify commented Oct 3, 2023

Uh oh!

OSBotify commented Oct 5, 2023

Uh oh!

neil-marcellini Oct 18, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

neil-marcellini Oct 18, 2023

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

VickyStash commented Sep 22, 2023 •

edited

Loading

neil-marcellini Oct 18, 2023 •

edited

Loading