[TS migration] Migrate 'Expensify.js' file to TypeScript #35296

dukenv0307 · 2024-01-29T04:34:07Z

Details

migrate Expensify.js to typescript

Remove prop-type and default prop
Use hook instead of HOC

Fixed Issues

$ #25231
PROPOSAL: None

Tests

Run app
Verify that app is opened successfully

Verify that no errors appear in the JS console

Offline tests

None

QA Steps

Run app
Verify that app is opened successfully

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

Screen.Recording.2024-01-29.at.11.28.33.mov

Android: mWeb Chrome

Screen.Recording.2024-01-29.at.11.25.45.mov

iOS: Native

iOS: mWeb Safari

Screen.Recording.2024-01-29.at.11.22.28.mov

MacOS: Chrome / Safari

Screen.Recording.2024-01-29.at.11.21.45.mov

MacOS: Desktop

Screen.Recording.2024-01-29.at.11.32.48.mov

melvin-bot · 2024-01-29T08:00:13Z

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

fabioh8010 · 2024-01-30T11:54:10Z

src/Expensify.tsx

+    isCheckingPublicRoom: OnyxEntry<boolean>;
+    session: OnyxEntry<Session>;
+    updateAvailable: OnyxEntry<boolean>;
+    isSidebarLoaded: OnyxEntry<boolean>;
+    screenShareRequest: OnyxEntry<ScreenShareRequest>;
+    focusModeNotification: OnyxEntry<boolean>;


Please keep the previous comments

fabioh8010 · 2024-01-30T11:54:36Z

src/Expensify.tsx

+    session = {
+        authToken: undefined,
+        accountID: undefined,
+    },


Suggested change

session = {

authToken: undefined,

accountID: undefined,

},

Why do we remove it?

If session can be null because it's an Onyx value and we are just setting authToken and accountID to undefined here, it looks to me that this default object is useless. Could you try to remove it and test if it works correctly?

fabioh8010 · 2024-01-30T11:54:45Z

src/Expensify.tsx

+    },
+    updateAvailable = false,
+    isSidebarLoaded = false,
+    screenShareRequest = null,


Suggested change

screenShareRequest = null,

fabioh8010 · 2024-01-30T11:56:10Z

src/Expensify.tsx

@@ -157,8 +130,14 @@ function Expensify(props) {
                Log.info('[BootSplash] splash screen status', false, {appState, status});

                if (status === 'visible') {
-                    const propsToLog = _.omit(props, ['children', 'session']);
-                    propsToLog.isAuthenticated = isAuthenticated;
+                    const propsToLog = {


Suggested change

const propsToLog = {

const propsToLog: Omit<ExpensifyProps, 'children' | 'session'> = {

fabioh8010 · 2024-01-30T11:59:29Z

src/libs/Notification/PushNotification/subscribePushNotification/index.ts

 import Onyx from 'react-native-onyx';
 import subscribeToReportCommentPushNotifications from '@libs/Notification/PushNotification/subscribeToReportCommentPushNotifications';
 import ONYXKEYS from '@src/ONYXKEYS';
 import PushNotification from '..';

+export default function subscribePushNotification(notificationID: OnyxEntry<string>) {


@arosiclair Could you take a look at this changes? Expensify.js was importing subscribePushNotification which actually didn't exist until now in this PR. Should we just remove the import from Expensify.js and leave this file unchanged?

That was first added in this PR and the module should still exist here. It's only purpose is to subscribe the callback and it's written in a separate module just to avoid require cycles. So we should keep the import and the module since removing it would break push notifications. Though we can probably remove the unnecessary variable from it like so:

import './libs/Notification/PushNotification/subscribePushNotification';

Ohh yes, my VSCode was not taking me to the file, thought it didn't exist 😅 Thanks @arosiclair !

arosiclair · 2024-01-30T15:33:03Z

src/Expensify.tsx

 import * as Growl from './libs/Growl';
 import Log from './libs/Log';
 import migrateOnyx from './libs/migrateOnyx';
 import Navigation from './libs/Navigation/Navigation';
 import NavigationRoot from './libs/Navigation/NavigationRoot';
 import NetworkConnection from './libs/NetworkConnection';
 import PushNotification from './libs/Notification/PushNotification';
-// eslint-disable-next-line no-unused-vars
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
 import subscribePushNotification from './libs/Notification/PushNotification/subscribePushNotification';


Suggested change

import subscribePushNotification from './libs/Notification/PushNotification/subscribePushNotification';

import './libs/Notification/PushNotification/subscribePushNotification';

dukenv0307 · 2024-02-02T04:32:27Z

@fabioh8010 I updated.

src/libs/Navigation/NavigationRoot.tsx

src/Expensify.tsx

Co-authored-by: Fábio Henriques <fabio.lacerda@outlook.com>

dukenv0307 · 2024-02-06T02:06:25Z

@fabioh8010 I updated.

mollfpr · 2024-02-07T14:06:24Z

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

35296.Android.mp4

Android: mWeb Chrome

35296.mWeb-Chrome.mp4

iOS: Native

Uploading 35296 iOS.mp4…

iOS: mWeb Safari

35296.mWeb-Safari.mp4

MacOS: Chrome / Safari

35296.Web.mp4

MacOS: Desktop

35296.Desktop.mp4

melvin-bot · 2024-02-07T14:09:16Z

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

mollfpr · 2024-02-08T18:36:15Z

@lakchote This PR ready for review!

blazejkustra · 2024-02-12T12:56:51Z

@dukenv0307 Can you rename the PR so it matches issue title?

mollfpr · 2024-02-13T04:32:10Z

Friendly bump @lakchote and @dukenv0307 for the above comment, thanks!

dukenv0307 · 2024-02-13T16:29:34Z

@mollfpr @blazejkustra Updated.

dukenv0307 · 2024-02-19T08:11:50Z

@lakchote Please help to review the PR when you have a chance.

blazejkustra · 2024-02-26T17:08:40Z

Typescript check is failing, let's wrap this PR up! 😀

dukenv0307 · 2024-02-27T02:37:26Z

@blazejkustra Merged main to fix ts error.

situchan

TS error still happens here

dukenv0307 · 2024-02-27T03:51:54Z

Fixed now.

mollfpr · 2024-03-01T06:42:32Z

DM'ed @lakchote for a review!

OSBotify · 2024-03-01T07:34:24Z

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

lakchote · 2024-03-01T08:30:26Z

@mollfpr @dukenv0307 it causes a regression in e2e tests

#37586

I have submitted a revert PR here

dukenv0307 · 2024-03-01T09:00:08Z

@lakchote I replied here #37586 (comment)

lakchote · 2024-03-01T09:18:24Z

@lakchote I replied here #37586 (comment)

Thanks, please dismiss my comment. It was a false positive.

OSBotify · 2024-03-04T21:02:35Z

🚀 Deployed to staging by https://github.com/lakchote in version: 1.4.47-0 🚀

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

OSBotify · 2024-03-06T21:51:37Z

🚀 Deployed to production by https://github.com/roryabraham in version: 1.4.47-10 🚀

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

situchan · 2024-05-22T05:39:49Z

src/Expensify.tsx

 import StartupTimer from './libs/StartupTimer';
 // This lib needs to be imported, but it has nothing to export since all it contains is an Onyx connection
-// eslint-disable-next-line no-unused-vars
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
 import UnreadIndicatorUpdater from './libs/UnreadIndicatorUpdater';


Unfortunately, this line caused unexpected regression. This was not a problem before migrating to TS.
More details: #38256 (comment)

dukenv0307 added 2 commits January 29, 2024 11:30

migrate Expensify.js to typescript

52b43ac

use unknow type instead of never

b5d14c2

dukenv0307 marked this pull request as ready for review January 29, 2024 08:00

dukenv0307 requested a review from a team as a code owner January 29, 2024 08:00

melvin-bot bot removed the request for review from a team January 29, 2024 08:00

melvin-bot bot requested a review from mollfpr January 29, 2024 08:00

fabioh8010 reviewed Jan 30, 2024

View reviewed changes

arosiclair reviewed Jan 30, 2024

View reviewed changes

dukenv0307 added 6 commits January 31, 2024 11:24

merge main and add suggestion

03ecd78

fix lint

4311f86

resolve conflict

0d61e64

fix lint

caf60b8

resolve conflict

e11209a

fix lint

6832b59

fabioh8010 reviewed Feb 2, 2024

View reviewed changes

src/libs/Navigation/NavigationRoot.tsx Outdated Show resolved Hide resolved

src/Expensify.tsx Outdated Show resolved Hide resolved

dukenv0307 and others added 6 commits February 6, 2024 00:09

Update src/libs/Navigation/NavigationRoot.tsx

fb222e6

Co-authored-by: Fábio Henriques <fabio.lacerda@outlook.com>

Update src/Expensify.tsx

2893050

Co-authored-by: Fábio Henriques <fabio.lacerda@outlook.com>

Merge branch 'main' into fix/25231

b0c8631

fix lint

d13efa7

fix ts error

ff2b86e

fix lint

254a114

fabioh8010 approved these changes Feb 6, 2024

View reviewed changes

mollfpr approved these changes Feb 7, 2024

View reviewed changes

dukenv0307 changed the title ~~migrate Expensify.js to typescript~~ [TS migration] Migrate 'Expensify.js' file to TypeScript Feb 13, 2024

blazejkustra approved these changes Feb 14, 2024

View reviewed changes

Merge branch 'main' into fix/25231

79e039f

dukenv0307 mentioned this pull request Feb 23, 2024

[HOLD for payment 2024-03-13] [$250] [TS migration] Migrate 'Expensify.js' file to TypeScript #25231

Closed

Merge branch 'main' into fix/25231

6bea3ea

situchan suggested changes Feb 27, 2024

View reviewed changes

remove unused ts-expect-error

2749c45

Merge branch 'main' into fix/25231

8a6a30f

lakchote approved these changes Mar 1, 2024

View reviewed changes

lakchote merged commit c8d92b7 into Expensify:main Mar 1, 2024
15 checks passed

github-actions bot mentioned this pull request Mar 1, 2024

Investigate workflow job failing on main: e2ePerformanceTests / Run E2E tests in AWS device farm #37586

Closed

lakchote mentioned this pull request Mar 1, 2024

[No QA] Revert [TS migration] Migrate 'Expensify.js' file to TypeScript #37588

Closed

50 tasks

github-actions bot mentioned this pull request Mar 4, 2024

Deploy Checklist: New Expensify 2024-03-04 #37698

Closed

97 tasks

situchan reviewed May 22, 2024

View reviewed changes

situchan mentioned this pull request May 22, 2024

[HOLD for payment 2024-04-03] HIGH: [Reliability] [$500] Unread fevicon does not show for new messages / unread messages #38256

Closed

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[TS migration] Migrate 'Expensify.js' file to TypeScript #35296

[TS migration] Migrate 'Expensify.js' file to TypeScript #35296

dukenv0307 commented Jan 29, 2024

melvin-bot bot commented Jan 29, 2024

fabioh8010 Jan 30, 2024

dukenv0307 Jan 31, 2024

fabioh8010 Jan 30, 2024

dukenv0307 Jan 31, 2024

fabioh8010 Feb 1, 2024

fabioh8010 Jan 30, 2024

fabioh8010 Jan 30, 2024

fabioh8010 Jan 30, 2024

arosiclair Jan 30, 2024 •

edited

Loading

fabioh8010 Jan 30, 2024

arosiclair Jan 30, 2024

dukenv0307 commented Feb 2, 2024

dukenv0307 commented Feb 6, 2024

mollfpr commented Feb 7, 2024 •

edited

Loading

melvin-bot bot commented Feb 7, 2024

mollfpr commented Feb 8, 2024

blazejkustra commented Feb 12, 2024

mollfpr commented Feb 13, 2024

dukenv0307 commented Feb 13, 2024

dukenv0307 commented Feb 19, 2024

blazejkustra commented Feb 26, 2024

dukenv0307 commented Feb 27, 2024

situchan left a comment

dukenv0307 commented Feb 27, 2024

mollfpr commented Mar 1, 2024

OSBotify commented Mar 1, 2024

lakchote commented Mar 1, 2024

dukenv0307 commented Mar 1, 2024

lakchote commented Mar 1, 2024

OSBotify commented Mar 4, 2024

OSBotify commented Mar 6, 2024

situchan May 22, 2024

	const propsToLog = {
	const propsToLog: Omit<ExpensifyProps, 'children' \| 'session'> = {

	import subscribePushNotification from './libs/Notification/PushNotification/subscribePushNotification';
	import './libs/Notification/PushNotification/subscribePushNotification';

[TS migration] Migrate 'Expensify.js' file to TypeScript #35296

[TS migration] Migrate 'Expensify.js' file to TypeScript #35296

Conversation

dukenv0307 commented Jan 29, 2024

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Jan 29, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

arosiclair Jan 30, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dukenv0307 commented Feb 2, 2024

dukenv0307 commented Feb 6, 2024

mollfpr commented Feb 7, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

melvin-bot bot commented Feb 7, 2024

mollfpr commented Feb 8, 2024

blazejkustra commented Feb 12, 2024

mollfpr commented Feb 13, 2024

dukenv0307 commented Feb 13, 2024

dukenv0307 commented Feb 19, 2024

blazejkustra commented Feb 26, 2024

dukenv0307 commented Feb 27, 2024

situchan left a comment

Choose a reason for hiding this comment

dukenv0307 commented Feb 27, 2024

mollfpr commented Mar 1, 2024

OSBotify commented Mar 1, 2024

lakchote commented Mar 1, 2024

dukenv0307 commented Mar 1, 2024

lakchote commented Mar 1, 2024

OSBotify commented Mar 4, 2024

OSBotify commented Mar 6, 2024

Choose a reason for hiding this comment

arosiclair Jan 30, 2024 •

edited

Loading

mollfpr commented Feb 7, 2024 •

edited

Loading