[TS migration] Migrate 'Report.js' lib to TypeScript #28730

blazejkustra · 2023-10-03T15:54:22Z

Details

Migration of Report.js to Typescript.

Fixed Issues

$ #24931
PROPOSAL: N/A

Tests

Test report screen generally
- Sending messages,
- Adding emojis,
- Removing/editing chat messages,
- Requesting money
- Other general flows
Optionally test beta functionality too
Please verify that the flow, as described here, works accordingly.

Create a chat report between two users
Leave several comments on the chat report
On any message that is not the last message create a thread
Leave another message on the thread report
Delete the parent message (top/first) of the thread report
Verify in the LHN that:
- The subtitle of the initial chat has the correct "last message"
- The title of the thread chat says [Deleted message] and it's subtitle reflects the correct "last message" for the thread.

Offline tests

N/A

QA Steps

Same as tests

PR Author Checklist

I linked the correct issue in the ### Fixed Issues section above
I wrote clear testing steps that cover the changes made in this PR
- I added steps for local testing in the Tests section
- I added steps for the expected offline behavior in the Offline steps section
- I added steps for Staging and/or Production testing in the QA steps section
- I added steps to cover failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
- I turned off my network connection and tested it while offline to ensure it matches the expected behavior (i.e. verify the default avatar icon is displayed if app is offline)
- I tested this PR with a High Traffic account against the staging or production API to ensure there are no regressions (e.g. long loading states that impact usability).
I included screenshots or videos for tests on all platforms
I ran the tests on all platforms & verified they passed on:
- Android / native
- Android / 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
  - 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

a-web.2.webm

Mobile Web - Safari

i-web.mp4

Desktop

desktop.mov

iOS

ios.mp4

Android

android.webm

src/libs/actions/Report.ts

src/libs/EmojiUtils.ts

melvin-bot · 2023-12-05T12:50:15Z

@allroundexperts @ One of you needs to 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]

blazejkustra · 2023-12-08T09:15:41Z

@allroundexperts I resolved the conflicts and merged the newest main 👌

allroundexperts · 2023-12-10T23:18:58Z

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 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.2023-12-11.at.5.59.59.AM.mov

Android: mWeb Chrome

Screen.Recording.2023-12-11.at.5.53.36.AM.mov

iOS: Native

Screen.Recording.2023-12-11.at.5.51.57.AM.mov

iOS: mWeb Safari

Screen.Recording.2023-12-11.at.5.50.30.AM.mov

MacOS: Chrome / Safari

Screen.Recording.2023-12-11.at.5.45.16.AM.mov

MacOS: Desktop

Screen.Recording.2023-12-11.at.5.49.05.AM.mov

allroundexperts

Testing well. Approving it since I don't want to block the merge as this gets conflicts fast.

melvin-bot · 2023-12-11T01:21:08Z

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

fabioh8010 · 2023-12-11T08:33:18Z

@blazejkustra we have typecheck errors now.

blazejkustra · 2023-12-11T08:34:25Z

Yep, I'm on it!

blazejkustra · 2023-12-11T09:01:06Z

@NikkiWines all yours! Tagging you as this PR gets conflicts pretty fast 😅

NikkiWines

Couple NABs but nothing worth holding the PR over. Looks good overall!

NikkiWines · 2023-12-12T01:20:47Z

src/libs/actions/Report.ts

+                : Object.keys(report).reduce<Record<string, null>>((acc, key) => {
+                      acc[key] = null;
+                      return acc;


NAB: We prefer non-abbreviated variable names so account would be better here.

NikkiWines · 2023-12-12T03:21:12Z

src/libs/actions/Report.ts

+    const failureData: OnyxUpdate[] = [
+        {
+            onyxMethod: Onyx.METHOD.MERGE,
+            key: `${ONYXKEYS.COLLECTION.REPORT_METADATA}${reportID}`,
+            value: {
+                isLoadingInitialReportActions: false,
+            },
+        },
+    ];


NAB: Since failureData is the same as successData here, we could probably de-dupe this and just use one object called finallyData for such cases (there are a few instances in this file).

I don't think we have any style guidelines about this though, so not a blocker.

NikkiWines · 2023-12-12T02:01:06Z

src/libs/actions/Report.ts

+    if (typingStatus.userLogin) {
+        normalizedStatus = {[typingStatus.userLogin]: true};
+    } else {
+        normalizedStatus = typingStatus;


NAB: This could be a ternary

NikkiWines · 2023-12-12T02:02:24Z

src/libs/actions/Report.ts

 Onyx.connect({
    key: ONYXKEYS.SESSION,
-    callback: (val) => {
+    callback: (value) => {


Nice, thanks for updating all these variable names 🙌

NikkiWines · 2023-12-12T03:22:40Z

src/types/onyx/PersonalDetails.ts

@@ -76,6 +76,8 @@ type PersonalDetails = {
    payPalMeAddress?: string;
 };

+type PersonalDetailsList = Record<string, PersonalDetails>;
+


NAB: Extra blank line

OSBotify · 2023-12-12T03:28:42Z

✋ 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-12-13T11:28:49Z

🚀 Deployed to staging by https://github.com/NikkiWines in version: 1.4.12-0 🚀

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

OSBotify · 2023-12-13T11:49:32Z

🚀 Deployed to staging by https://github.com/NikkiWines in version: 1.4.12-0 🚀

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

OSBotify · 2023-12-13T12:17:06Z

🚀 Deployed to staging by https://github.com/NikkiWines in version: 1.4.12-0 🚀

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

OSBotify · 2023-12-14T15:23:49Z

🚀 Deployed to production by https://github.com/Julesssss in version: 1.4.12-2 🚀

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

blazejkustra added 3 commits October 3, 2023 17:52

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

56de552

Merge branch 'main' into ts-migration/Report

1e8b624

Migrate first 1000 lines of Report.ts

1269110

blazejkustra commented Oct 6, 2023

View reviewed changes

src/libs/actions/Report.ts Show resolved Hide resolved

Finish migrating Report.ts

dcb222d

blazejkustra changed the title ~~[TS migration] Migrate 'Report.js' lib to TypeScript~~ [HOLD] [TS migration] Migrate 'Report.js' lib to TypeScript Oct 20, 2023

blazejkustra added 14 commits November 28, 2023 08:49

Merge branch 'main' into ts-migration/Report

3fca4b7

Adjust imports, comments up to line 100

4fea06b

Update pusher types

d686dcc

Migrate report actions, up to line 400

321f78d

Migrate openReport

f8a3e31

Fix type problems with NotificationPreference

aa93c7e

Migrate API actions

475bbb8

Migrate next portion of Report utils

a66d6f7

Start migrating emoji reactions

11c2b2f

Remove unused imports

55a955f

Migrate the rest of Report.js

5ea6bd7

Fix a typo after refactoring

66fc2df

Fix imports

057c3c1

Fix tests after migration

e41d524

blazejkustra changed the title ~~[HOLD] [TS migration] Migrate 'Report.js' lib to TypeScript~~ [TS migration] Migrate 'Report.js' lib to TypeScript Nov 28, 2023

BartoszGrajdek reviewed Nov 29, 2023

View reviewed changes

src/libs/actions/Report.ts Outdated Show resolved Hide resolved

src/libs/actions/Report.ts Outdated Show resolved Hide resolved

kowczarz reviewed Nov 29, 2023

View reviewed changes

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

Adjust the code after internal review

0fca53f

blazejkustra requested review from BartoszGrajdek and kowczarz November 29, 2023 17:13

blazejkustra added 2 commits November 29, 2023 18:54

Merge branch 'main' into ts-migration/Report

ff75cb8

Fix typecheck after merging main

e731ade

BartoszGrajdek approved these changes Nov 30, 2023

View reviewed changes

Merge branch 'main' into ts-migration/Report

55ca6d1

blazejkustra requested a review from a team as a code owner December 5, 2023 12:50

melvin-bot bot requested review from allroundexperts and removed request for a team and kowczarz December 5, 2023 12:50

blazejkustra mentioned this pull request Dec 5, 2023

[TS migration] Migrate 'Tooltip' component to TypeScript #31544

Merged

51 tasks

blazejkustra added 3 commits December 7, 2023 10:39

Merge branch 'main' into ts-migration/Report

7f6c168

Clear the logic in leaveRoom util

41471e9

Merge branch 'main' into ts-migration/Report

2273962

blazejkustra added 2 commits December 8, 2023 16:06

Merge branch 'main' into ts-migration/Report

fb517ac

Fix typecheck

089dca8

allroundexperts approved these changes Dec 11, 2023

View reviewed changes

melvin-bot bot requested a review from NikkiWines December 11, 2023 01:21

blazejkustra added 2 commits December 11, 2023 09:56

Merge branch 'main' into ts-migration/Report

5e32cc6

Fix typecheck

33cb7fc

NikkiWines approved these changes Dec 12, 2023

View reviewed changes

NikkiWines merged commit 4029eed into Expensify:main Dec 12, 2023
16 checks passed

github-actions bot mentioned this pull request Dec 13, 2023

[$500] Deploy Checklist: New Expensify 2023-12-13 #32963

Closed

64 tasks

ishpaul777 mentioned this pull request Dec 13, 2023

[HOLD for payment 2023-12-26] Room - Unable to leave public room #33010

Closed

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[TS migration] Migrate 'Report.js' lib to TypeScript #28730

[TS migration] Migrate 'Report.js' lib to TypeScript #28730

blazejkustra commented Oct 3, 2023 •

edited

Loading

melvin-bot bot commented Dec 5, 2023

blazejkustra commented Dec 8, 2023

allroundexperts commented Dec 10, 2023 •

edited

Loading

allroundexperts left a comment

melvin-bot bot commented Dec 11, 2023

fabioh8010 commented Dec 11, 2023

blazejkustra commented Dec 11, 2023

blazejkustra commented Dec 11, 2023

NikkiWines left a comment

NikkiWines Dec 12, 2023

NikkiWines Dec 12, 2023

NikkiWines Dec 12, 2023

NikkiWines Dec 12, 2023

NikkiWines Dec 12, 2023

OSBotify commented Dec 12, 2023

OSBotify commented Dec 13, 2023

OSBotify commented Dec 13, 2023

OSBotify commented Dec 13, 2023

OSBotify commented Dec 14, 2023

[TS migration] Migrate 'Report.js' lib to TypeScript #28730

[TS migration] Migrate 'Report.js' lib to TypeScript #28730

Conversation

blazejkustra commented Oct 3, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Dec 5, 2023

blazejkustra commented Dec 8, 2023

allroundexperts commented Dec 10, 2023 • edited Loading

Reviewer Checklist

Screenshots/Videos

allroundexperts left a comment

Choose a reason for hiding this comment

melvin-bot bot commented Dec 11, 2023

fabioh8010 commented Dec 11, 2023

blazejkustra commented Dec 11, 2023

blazejkustra commented Dec 11, 2023

NikkiWines left a comment

Choose a reason for hiding this comment

NikkiWines Dec 12, 2023

Choose a reason for hiding this comment

NikkiWines Dec 12, 2023

Choose a reason for hiding this comment

NikkiWines Dec 12, 2023

Choose a reason for hiding this comment

NikkiWines Dec 12, 2023

Choose a reason for hiding this comment

NikkiWines Dec 12, 2023

Choose a reason for hiding this comment

OSBotify commented Dec 12, 2023

OSBotify commented Dec 13, 2023

OSBotify commented Dec 13, 2023

OSBotify commented Dec 13, 2023

OSBotify commented Dec 14, 2023

blazejkustra commented Oct 3, 2023 •

edited

Loading

allroundexperts commented Dec 10, 2023 •

edited

Loading