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.

Sign up for GitHub

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

Jump to bottom

[TS migration] Migrate 'IOU.js' lib to TypeScript #34092

Merged
merged 97 commits into from
Feb 5, 2024
Merged

[TS migration] Migrate 'IOU.js' lib to TypeScript #34092

merged 97 commits into from
Feb 5, 2024

Conversation

VickyStash
Copy link
Contributor

@VickyStash VickyStash commented Jan 8, 2024 •
edited
Loading

Details

[TS migration] Migrate 'IOU.js' lib to TypeScript

Fixed Issues

$ #24926
PROPOSAL: N/A

Tests

  • Verify that no errors appear in the JS console

Make sure the Money Request / Split bill functionality works the same way as before. You can use next flows to test it.

First flows: Using FAB button

Manual Money Request
  1. Press FAB button -> Request Money
  2. Select Manual money request
  3. Try to update the currency and change it back
  4. Enter value -> Press next
  5. Select a user to split request with
  6. Update description/merchant/date and press Request button.
  7. Make sure a request is successfully created and open it.
  8. Update description/merchant/date again
  9. In the top right corner, tap on the three dots menu -> Add receipt
  10. Attach any photo of a receipt
  11. Tap on the attached receipt -> menu in the top right corner
  12. Test that receipt Replace and Delete works as expected.
  13. Delete created Money Request.
Scan Money Request
  1. Press FAB button -> Request Money
  2. Select Scan money request
  3. Select a photo of any receipt
  4. Select a user to split request with
  5. Press request button
  6. Make sure a money request with scanning in progress is created
  7. Open it and update the description.
  8. Check it later to see scanned results.
Distance Money Request
  1. Press FAB button -> Request Money
  2. Select Distance money request
  3. Select start and finish locations, press next
  4. Select a workspace to share request with
  5. Update description/category
  6. Press request button
  7. Make sure a distance money request is created, open it
  8. Try to update distance points, make sure the request is updated as well
  9. Update description/date/category
  10. Delete the created Money Request.

Second flows: Chat with another user:

Manual Money Request
  1. Open any chat with another user -> Press the plus button in the input
  2. Request Money -> Select Manual money request
  3. Try to update the currency and change it back
  4. Enter value -> Press next
  5. Update amount/description/merchant/date and press Request button.
  6. Make sure the request is successfully created and open it.
  7. Update description/merchant/date again
  8. Delete created Money Request.
Scan Money Request
  1. Open any chat with another user -> Press the plus button in the input
  2. Request Money -> Select Scan money request
  3. Select a photo of any receipt
  4. Press request button
  5. Make sure a money request with scanning in progress is created
  6. Open it and update the description.
  7. Check it later to see scanned results.

Third flows: Workspace chat

Split bill -> Manual
  1. Open any workspace chat-> Press the plus button in the input
  2. Split bill -> Select Manual option
  3. Try to update the currency and change it back
  4. Enter value -> Press next
  5. Add merchant/description, update date, and press Split button.
  6. Make sure the split is created successfully, open it, and check the details.
Split bill -> Scan
  1. Open any workspace chat-> Press the plus button in the input
  2. Split bill -> Select Scan option
  3. Select a photo of any receipt
  4. Add category/description and press Split button.
  5. Make sure the split is created successfully, open it, and check the details (the merchant field can be missed, but it should be populated when scanning is finished)
  6. Check it later to see scanned results.
Split bill -> Distance
  1. Open any workspace chat-> Press the plus button in the input
  2. Split bill -> Select the Distance option
  3. Select start and finish locations, press next
  4. Update the description/category and press Split button
  5. Make sure the split is created successfully, open it, and check the details
Money Request-> Manual
  1. Open any workspace chat-> Press the plus button in the input
  2. Request Money -> Select Manual money request
  3. Enter value -> Press next
  4. Update amount/description/merchant/date/category and press Request button.
  5. Make sure the request is successfully created and open it.
  6. Update description/merchant/date/category again
  7. Delete created Money Request.
Money Request -> Scan
  1. Open any workspace chat-> Press the plus button in the input
  2. Request Money -> Select Scan money request
  3. Select a photo of any receipt
  4. Press request button
  5. Make sure a money request with scanning in progress is created
  6. Open it and update the description.
  7. Check it later to see scanned results.
Money Request -> Distance
  1. Open any workspace chat-> Press the plus button in the input
  2. Request Money -> Select Distance money request
  3. Select start and finish locations, press next
  4. Update description/category
  5. Press request button
  6. Make sure a distance money request is created, open it
  7. Try to update distance points, make sure the request is updated as well
  8. Update description/date/category
  9. Delete the created Money Request.

Offline tests

N/A

QA Steps

  • Verify that no errors appear in the JS console

Same as in the Tests section

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

@VickyStash
Migrate Onyx.connect methods to TS
996ee26
@VickyStash
Migrate simple functions
b7af44a
@VickyStash
Migrate startMoneyRequest_temporaryForRefactor and resetMoneyRequestI…
519852e 
…nfo functions
@VickyStash
Migrate buildOnyxDataForMoneyRequest function
e5f8cc3
@VickyStash
Migrate getMoneyRequestInformation function
98a1e6b
@VickyStash
Fix failing Money request
19035e5
@VickyStash
Migrate createDistanceRequest and requestMoney functions
ad41a60
@VickyStash
Migrate startSplitBill function
578cc50
@VickyStash
Merge branch 'main' into ts-migration/iou
7b55077 
# Conflicts:
#	src/libs/ReportUtils.ts
@VickyStash
Replace Split type with Participant
8f0418d
@VickyStash
Migrate completeSplitBill function
417e173
@VickyStash
Merge branch 'main' into ts-migration/iou
6c962b3
@VickyStash
Migrate getIOUReportID, navigateToNextPage and setMoneyRequestPartici…
ecdd7dd 
…pantsFromReport functions
@VickyStash
Migrate approveMoneyRequest, submitReport, detachReceipt, replaceRece…
016c19e 
…ipt functions
@VickyStash
Migrate createSplitsAndOnyxData function
012cd76
@VickyStash
Merge branch 'main' into ts-migration/iou
041bde6 
# Conflicts:
#	src/libs/IOUUtils.ts
#	src/libs/ReportUtils.ts
#	src/libs/TransactionUtils.ts
#	src/libs/actions/IOU.ts
#	src/types/onyx/Transaction.ts
#	src/types/onyx/index.ts
@VickyStash
Migrate getReceiptError function; fix type imports after merging main
4711e1c
@VickyStash
Migrate splitBill and splitBillAndOpenReport functions
372785b
@VickyStash
Migrate getUpdateMoneyRequestParams function
4e7fab0
@VickyStash
Migrate updateMoneyRequestDate, updateDistanceRequest, editMoneyReque…
cdcb7d5 
…st, updateMoneyRequestAmountAndCurrency functions
@VickyStash
Migrate setDraftSplitTransaction, editRegularMoneyRequest functions
c71ae90
@VickyStash
Migrate getSendMoneyParams function
9aad84a
@VickyStash
Migrate deleteMoneyRequest function
6357670
@VickyStash
Migrate getPayMoneyRequestParams and payMoneyRequest functions
992fdea
@VickyStash
Get rid of lodashGet and underscore usage
6f658cd
@VickyStash
Fix TS errors
4c7928b
@VickyStash
Merge branch 'main' into ts-migration/iou
490f208 
# Conflicts:
#	src/libs/actions/IOU.ts
@VickyStash
TS fixes after merging main
e60ebaa
@VickyStash
Lint fixes
36420a7
@VickyStash
Minor code improvements
d082cd4
@aimane-chnaif
Copy link
Contributor

@roryabraham thanks for reviewing as urgency.

Conflicts again! @VickyStash if you can fix conflict soon, I will do another round of review and testing during weekend so we can quickly merge before another conflict.

@VickyStash
Merge branch 'main' into ts-migration/iou
59262ed 
# Conflicts:
#	src/ONYXKEYS.ts
#	src/components/OfflineWithFeedback.tsx
#	src/libs/actions/IOU.ts
#	src/types/onyx/Transaction.ts
@VickyStash
Lint fix
c445c5e
@VickyStash
Copy link
Contributor Author

@aimane-chnaif @roryabraham Conflicts are resolved! 🙂

aimane-chnaif
aimane-chnaif reviewed Feb 4, 2024
View reviewed changes
src/libs/actions/IOU.ts
Comment on lines 701 to 702
payeeAccountID = userAccountID,
payeeEmail = currentUserEmail,
Copy link
Contributor

Choose a reason for hiding this comment

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

These 2 params don't exist on main. Not sure why git diff doesn't indicate that.

Copy link
Contributor

Choose a reason for hiding this comment

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

oh ok, so you changed order of theses params

@aimane-chnaif
Copy link
Contributor

Re-tested all possible cases of money request flow. No issues found.
But let's still be on a look out for any regressions since this is large PR.

@roryabraham all yours for merge

@VickyStash
Copy link
Contributor Author

@aimane-chnaif @roryabraham I've resolved comments one more time, let's try to merge it today

@aimane-chnaif
Copy link
Contributor

@VickyStash please fix conflict again

@aimane-chnaif
Copy link
Contributor

Hope it would be the last one. @roryabraham is ready to merge immediately once fixed

@VickyStash
Merge branch 'main' into ts-migration/iou
5359633 
# Conflicts:
#	src/libs/actions/IOU.ts
@roryabraham roryabraham merged commit b7a3fca into Expensify:main Feb 5, 2024
15 checks passed
@OSBotify
Copy link
Contributor

OSBotify commented Feb 5, 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.

@github-actions github-actions bot mentioned this pull request Feb 5, 2024
Closed
66 tasks
@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.

@cristipaval cristipaval mentioned this pull request Feb 6, 2024
Merged
50 tasks
cristipaval
cristipaval reviewed Feb 6, 2024
View reviewed changes
src/libs/actions/IOU.ts
@@ -3103,7 +3073,7 @@ function getSendMoneyParams(report, amount, currency, comment, paymentMethodType
paymentMethodType,
transactionID: optimisticTransaction.transactionID,
newIOUReportDetails,
createdReportActionID: isNewChat ? optimisticCreatedAction.reportActionID : 0,
createdReportActionID: isNewChat ? optimisticCreatedAction.reportActionID : '',
Copy link
Contributor

Choose a reason for hiding this comment

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

This created a warning on the server, polluting the logs. It should be '0' instead of an empty string, as the server expects an integer. Here's a PR that fixes it

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Got it, thank you!

Copy link
Contributor

Choose a reason for hiding this comment

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

@VickyStash As PR already raised thanks to @cristipaval, can you please co-review #35918?

@lanitochka17 lanitochka17 mentioned this pull request Feb 6, 2024
Closed
6 tasks
@lanitochka17
Copy link

This PR is failing because of issue #35942

The issue is reproducible in: Android, mWeb, IOS

Bug6369674_1707243456539.az_recorder_20240206_180530.1.mp4
Bug6369674_1707243456496.az_recorder_20240206_175443.1.mp4

@aimane-chnaif
Copy link
Contributor

aimane-chnaif commented Feb 6, 2024 •
edited
Loading

This PR is failing because of issue #35942

The issue is reproducible in: Android, mWeb, IOS

Bug6369674_1707243456539.az_recorder_20240206_180530.1.mp4
Bug6369674_1707243456496.az_recorder_20240206_175443.1.mp4

yes, it's caused by another PR #34564 and the fix is being CPed

@lanitochka17 lanitochka17 mentioned this pull request Feb 6, 2024
Closed
6 tasks
@melvin-bot melvin-bot bot mentioned this pull request Feb 7, 2024
Closed
@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 ✅

@blimpich blimpich mentioned this pull request Feb 13, 2024
Merged
50 tasks
@lakchote lakchote mentioned this pull request Feb 27, 2024
Closed
6 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@aimane-chnaif aimane-chnaif aimane-chnaif approved these changes

@rezkiy37 rezkiy37 rezkiy37 requested changes

@BartoszGrajdek BartoszGrajdek BartoszGrajdek left review comments

@mountiny mountiny mountiny left review comments

@kubabutkiewicz kubabutkiewicz kubabutkiewicz left review comments

@cristipaval cristipaval cristipaval left review comments

@filip-solecki filip-solecki filip-solecki approved these changes

@roryabraham roryabraham roryabraham approved these changes

@blazejkustra blazejkustra blazejkustra approved these changes

@fabioh8010 fabioh8010 fabioh8010 approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.