[TS migration] Migrate 'Setup' files to TypeScript #35473

HezekielT · 2024-01-31T13:48:10Z

Details

Migrates Setup file to Typescript

Fixed Issues

$ #25228
PROPOSAL: #25228 (comment)

Tests

Open the app.
Verify that the contents are loaded and the app is working.

For Desktop

Click on the name of the app located at the top-left corner of the window right before File option.
Click on Check for updates option.
Verify it works.

Verify that no errors appear in the JS console

Offline tests

Same as Tests Section.

QA Steps

Same as Tests Section.

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

android_setUp_files.mov

Android: mWeb Chrome

mweb_setupFiles.mov

iOS: Native

ios_setupFiles.mov

iOS: mWeb Safari

safari_setupFiles.mov

MacOS: Chrome / Safari

web_setupFiles.mov

MacOS: Desktop

desktop_setupFiles.mov

melvin-bot · 2024-02-01T10:07:16Z

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

parasharrajat

We should type all the functions in these files.

1.9

HezekielT · 2024-02-06T09:17:43Z

@parasharrajat all the functions(except one) return type is void(they also accept zero parameter) and I was told that there is no need to specify the return type if it is void while migrating another component previously. That's why i didn't type the functions in these file.

Do we need to specify the return type even if it is void?

parasharrajat · 2024-02-06T18:21:36Z

Do we need to specify the return type even if it is void?

I am fine with this. Let's not add types for such functions. Only the functions with return value should be typed.

parasharrajat · 2024-02-06T19:15:02Z

Screenshots

🔲 iOS / native

Screen.Recording.2024-02-07.at.11.09.31.AM.mov

🔲 iOS / Safari

Screen.Recording.2024-02-07.at.11.11.09.AM.mov

🔲 MacOS / Desktop

Screen.Recording.2024-02-07.at.11.13.50.AM.mov

🔲 MacOS / Chrome

Screen.Recording.2024-02-07.at.10.57.01.AM.mov

🔲 Android / Chrome

Screen.Recording.2024-02-07.at.10.58.24.AM.mov

🔲 Android / native

Screen.Recording.2024-02-07.at.11.26.18.AM.mov

parasharrajat

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.

🎀 👀 🎀 C+ reviewed

melvin-bot · 2024-02-07T05:59:21Z

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

parasharrajat · 2024-02-07T05:59:45Z

@HezekielT Please merge main.

HezekielT · 2024-02-07T06:52:38Z

@parasharrajat I have merged main but Reassure Perfomance Tests is still failing.

francoisl · 2024-02-07T17:43:11Z

src/setup/platformSetup/index.website.ts

+type WebUpdater = () => {
+    init: () => void;
+    update: () => void;
+};


Not a blocker but could we not reuse PlatformSpecificUpdater insted here, somehow?

App/src/libs/checkForUpdates.ts

Lines 3 to 6 in b865932

type PlatformSpecificUpdater = {

update: () => void;

init?: () => void;

};

I think we can create a types.ts file in @src/setup/platformSetup and then add type PlatformSpecificUpdater to it and use it in both checkForUpdates and index.website.ts by importing it.

Should i do that?

I feel like it would be a little cleaner that way, in that we wouldn't have this duplicate type definition. But in a way, it also feels a little over-complicated for just this simple type...

In the end I don't have a strong opinion, @parasharrajat I'm curious what you'd recommend here.

I think we will be fine with types.ts file. There is no runtime differences.

So I have moved PlatformSpecificUpdater to types.ts and pushed those changes. @francoisl please review again when you get the chance 🙏 . Thanks! cc @parasharrajat

parasharrajat · 2024-02-08T15:08:06Z

@HezekielT Please try merging main again. I think perf tests are fixed at main.

HezekielT · 2024-02-08T17:12:41Z

@parasharrajat All checks have passed now 👍

francoisl

Looking good, thanks for the updates!

OSBotify · 2024-02-08T18:53:32Z

✋ 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 · 2024-02-12T14:20:55Z

🚀 Deployed to staging by https://github.com/francoisl in version: 1.4.40-0 🚀

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

OSBotify · 2024-02-13T18:26:16Z

🚀 Deployed to production by https://github.com/mountiny in version: 1.4.40-5 🚀

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

s77rt · 2024-03-09T12:04:10Z

src/libs/checkForUpdates.ts

@@ -16,4 +13,4 @@ function checkForUpdates(platformSpecificUpdater: PlatformSpecificUpdater) {
    }, UPDATE_INTERVAL);
 }

-module.exports = checkForUpdates;


This caused a regression #36522. After changing the export syntax from CommonJS to ESM we had to check the files that depend on that module and update them accordingly.

HezekielT and others added 11 commits January 30, 2024 17:57

used export default to make the file a module

21e645d

migrate index.js to ts

8a9c61b

added loading to session type

43e8533

migrate index.desktop to ts

1e865fe

migrate index.native to ts

3554f0b

migrate index.website to ts

16b54e7

created index.ts to address module not found issue in index.ts(setup)

22ed83b

run prettier

e74b34f

Merge branch 'Expensify:main' into TS-migration-of-Setup-files

ee4d63f

Merge branch 'Expensify:main' into TS-migration-of-Setup-files

343a578

make loading non required

b62f841

HezekielT marked this pull request as ready for review February 1, 2024 10:07

HezekielT requested a review from a team as a code owner February 1, 2024 10:07

melvin-bot bot requested review from parasharrajat and removed request for a team February 1, 2024 10:07

parasharrajat suggested changes Feb 5, 2024

View reviewed changes

HezekielT and others added 2 commits February 6, 2024 12:18

Merge branch 'Expensify:main' into TS-migration-of-Setup-files

fa1e9cf

added a type for webUpdater

70f6d7a

parasharrajat approved these changes Feb 7, 2024

View reviewed changes

Merge branch 'Expensify:main' into TS-migration-of-Setup-files

1437b78

HezekielT added 2 commits February 7, 2024 11:39

Merge branch 'Expensify:main' into TS-migration-of-Setup-files

050c367

Merge branch 'Expensify:main' into TS-migration-of-Setup-files

b865932

francoisl reviewed Feb 7, 2024

View reviewed changes

HezekielT and others added 3 commits February 8, 2024 19:11

move PlatformSpecificUpdater to types.ts

2ea6f2a

run prettier

c21f140

Merge branch 'Expensify:main' into TS-migration-of-Setup-files

b14ea7e

parasharrajat approved these changes Feb 8, 2024

View reviewed changes

melvin-bot bot requested a review from francoisl February 8, 2024 18:00

francoisl approved these changes Feb 8, 2024

View reviewed changes

francoisl merged commit 517d7f5 into Expensify:main Feb 8, 2024
17 checks passed

github-actions bot mentioned this pull request Feb 12, 2024

Deploy Checklist: New Expensify 2024-02-12 #36335

Closed

90 tasks

melvin-bot bot mentioned this pull request Feb 13, 2024

[HOLD for payment 2024-02-20] [$250] [TS migration] Migrate 'Setup' files to TypeScript #25228

Closed

s77rt mentioned this pull request Mar 9, 2024

[HOLD for payment 2024-03-20] HIGH: [$1000] MacOS App does not update via 'Check for Updates' when an update is available #36522

Closed

6 tasks

s77rt reviewed Mar 9, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[TS migration] Migrate 'Setup' files to TypeScript #35473

[TS migration] Migrate 'Setup' files to TypeScript #35473

HezekielT commented Jan 31, 2024 •

edited

Loading

melvin-bot bot commented Feb 1, 2024

parasharrajat left a comment

HezekielT commented Feb 6, 2024 •

edited

Loading

parasharrajat commented Feb 6, 2024

parasharrajat commented Feb 6, 2024 •

edited

Loading

parasharrajat left a comment

melvin-bot bot commented Feb 7, 2024

parasharrajat commented Feb 7, 2024

HezekielT commented Feb 7, 2024

francoisl Feb 7, 2024

HezekielT Feb 7, 2024

francoisl Feb 7, 2024

parasharrajat Feb 8, 2024

HezekielT Feb 8, 2024 •

edited

Loading

parasharrajat commented Feb 8, 2024

HezekielT commented Feb 8, 2024 •

edited

Loading

francoisl left a comment

OSBotify commented Feb 8, 2024

OSBotify commented Feb 12, 2024

OSBotify commented Feb 13, 2024

s77rt Mar 9, 2024

	type PlatformSpecificUpdater = {
	update: () => void;
	init?: () => void;
	};

[TS migration] Migrate 'Setup' files to TypeScript #35473

[TS migration] Migrate 'Setup' files to TypeScript #35473

Conversation

HezekielT commented Jan 31, 2024 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Feb 1, 2024

parasharrajat left a comment

Choose a reason for hiding this comment

HezekielT commented Feb 6, 2024 • edited Loading

parasharrajat commented Feb 6, 2024

parasharrajat commented Feb 6, 2024 • edited Loading

Screenshots

🔲 iOS / native

🔲 iOS / Safari

🔲 MacOS / Desktop

🔲 MacOS / Chrome

🔲 Android / Chrome

🔲 Android / native

parasharrajat left a comment

Choose a reason for hiding this comment

Reviewer Checklist

melvin-bot bot commented Feb 7, 2024

parasharrajat commented Feb 7, 2024

HezekielT commented Feb 7, 2024

francoisl Feb 7, 2024

Choose a reason for hiding this comment

HezekielT Feb 7, 2024

Choose a reason for hiding this comment

francoisl Feb 7, 2024

Choose a reason for hiding this comment

parasharrajat Feb 8, 2024

Choose a reason for hiding this comment

HezekielT Feb 8, 2024 • edited Loading

Choose a reason for hiding this comment

parasharrajat commented Feb 8, 2024

HezekielT commented Feb 8, 2024 • edited Loading

francoisl left a comment

Choose a reason for hiding this comment

OSBotify commented Feb 8, 2024

OSBotify commented Feb 12, 2024

OSBotify commented Feb 13, 2024

s77rt Mar 9, 2024

Choose a reason for hiding this comment

HezekielT commented Jan 31, 2024 •

edited

Loading

HezekielT commented Feb 6, 2024 •

edited

Loading

parasharrajat commented Feb 6, 2024 •

edited

Loading

HezekielT Feb 8, 2024 •

edited

Loading

HezekielT commented Feb 8, 2024 •

edited

Loading