[TS migration] Migrate 'BootSplash' lib to TypeScript #24846 #27762

arthurmfgtab · 2023-09-19T09:19:52Z

Details

Fixed Issues

$ #24846
PROPOSAL: N/A

Tests

Upon starting the application, the splash screen should work normally as no behaviour updates were made

Offline tests

N/A

QA Steps

N/A

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

mobile-chrome.mov

Mobile Web - Safari

mobile-safari.mov

Desktop

desktop.mov

iOS

ios.mov

Android

Screen.Recording.2023-09-21.at.01.29.21.mov

rezkiy37

LGTM.

rezkiy37 · 2023-09-19T13:22:15Z

src/libs/BootSplash/index.native.ts


-const BootSplash = NativeModules.BootSplash;
+const BootSplash: BootSplashModule = NativeModules.BootSplash;


Can we create a global type for NativeModules.BootSplash?

Suggested change

const BootSplash: BootSplashModule = NativeModules.BootSplash;

const BootSplash: BootSplashModule = NativeModules.BootSplash;

@rezkiy37 Good suggestion! Yes, it's a possibility, @arthurmfgtab you can do it by adding this inside src/types/modules/react-native.d.ts

/* eslint-disable @typescript-eslint/consistent-type-definitions */ import 'react-native'; // add this import {BootSplashModule} from '../../libs/BootSplash/types'; declare module 'react-native' { interface TextInput { // Typescript type declaration is missing in React Native for setting text selection. setSelection: (start: number, end: number) => void; } // add this interface NativeModulesStatic { BootSplash: BootSplashModule; } }

And then you can use it normally

const BootSplash = NativeModules.BootSplash;

The only downside of this approach is that TypeScript is not validated in .d.ts files, so if something is mistyped or wrong there, is difficult to know.

Ok, that makes sense

fabioh8010 · 2023-09-19T13:34:42Z

src/libs/BootSplash/index.native.ts


-const BootSplash = NativeModules.BootSplash;
+const BootSplash: BootSplashModule = NativeModules.BootSplash;


@rezkiy37 Good suggestion! Yes, it's a possibility, @arthurmfgtab you can do it by adding this inside src/types/modules/react-native.d.ts

/* eslint-disable @typescript-eslint/consistent-type-definitions */ import 'react-native'; // add this import {BootSplashModule} from '../../libs/BootSplash/types'; declare module 'react-native' { interface TextInput { // Typescript type declaration is missing in React Native for setting text selection. setSelection: (start: number, end: number) => void; } // add this interface NativeModulesStatic { BootSplash: BootSplashModule; } }

And then you can use it normally

const BootSplash = NativeModules.BootSplash;

The only downside of this approach is that TypeScript is not validated in .d.ts files, so if something is mistyped or wrong there, is difficult to know.

fabioh8010 · 2023-09-19T13:39:07Z

src/libs/BootSplash/index.ts

+function resolveAfter(delay: number) {
    return new Promise((resolve) => setTimeout(resolve, delay));
 }


Suggested change

function resolveAfter(delay: number) {

return new Promise((resolve) => setTimeout(resolve, delay));

}

function resolveAfter(delay: number): Promise<void> {

return new Promise<void>((resolve) => setTimeout(resolve, delay));

}

fabioh8010 · 2023-09-19T13:41:52Z

src/libs/BootSplash/index.ts

@@ -9,16 +10,20 @@ function hide() {

    return document.fonts.ready.then(() => {


Add hide() return type

function hide(): Promise<void> {

fabioh8010 · 2023-09-19T13:42:25Z

src/libs/BootSplash/index.native.ts


-const BootSplash = NativeModules.BootSplash;
+const BootSplash: BootSplashModule = NativeModules.BootSplash;

 function hide() {


Suggested change

function hide() {

function hide(): Promise<void> {

melvin-bot · 2023-09-21T09:12:59Z

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

jjcoffee

I have not reviewed this.

melvin-bot · 2023-09-21T09:14:45Z

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

amyevans

Code looks good, will wait on the checklist completion to merge

BartoszGrajdek · 2023-09-21T10:37:02Z

Reviewing...

BartoszGrajdek · 2023-09-21T10:47:23Z

LGTM!

BartoszGrajdek · 2023-09-21T10:48:54Z

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

OSBotify · 2023-09-21T22:48:55Z

✋ 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-09-22T13:59:41Z

🚀 Deployed to staging by https://github.com/amyevans in version: 1.3.73-0 🚀

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

OSBotify · 2023-09-25T09:34:32Z

🚀 Deployed to production by https://github.com/mountiny in version: 1.3.73-1 🚀

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

OSBotify · 2023-09-25T10:06:33Z

🚀 Deployed to staging by https://github.com/amyevans in version: 1.3.74-0 🚀

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

OSBotify · 2023-09-28T18:48:54Z

🚀 Deployed to production by https://github.com/chiragsalian in version: 1.3.74-3 🚀

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

arthurmfgtab changed the title ~~Converted to ts addresing types and files extension~~ [TS migration] Migrate 'BootSplash' lib to TypeScript #24846 Sep 19, 2023

rezkiy37 reviewed Sep 19, 2023

View reviewed changes

fabioh8010 reviewed Sep 19, 2023

View reviewed changes

arthurmfgtab and others added 3 commits September 21, 2023 00:45

Converted to ts addresing types and files extension

6353a61

Addressed PR comments

a1dff6f

optimistically update receipt state

32550a9

arthurmfgtab marked this pull request as ready for review September 21, 2023 09:12

arthurmfgtab requested a review from a team as a code owner September 21, 2023 09:12

melvin-bot bot requested review from jjcoffee and removed request for a team September 21, 2023 09:12

jjcoffee approved these changes Sep 21, 2023

View reviewed changes

melvin-bot bot requested a review from amyevans September 21, 2023 09:14

amyevans approved these changes Sep 21, 2023

View reviewed changes

fabioh8010 approved these changes Sep 21, 2023

View reviewed changes

BartoszGrajdek approved these changes Sep 21, 2023

View reviewed changes

amyevans approved these changes Sep 21, 2023

View reviewed changes

amyevans merged commit e24e431 into Expensify:main Sep 21, 2023
11 of 15 checks passed

OSBotify mentioned this pull request Sep 22, 2023

Deploy Checklist: New Expensify 2023-09-22 #28013

Closed

96 tasks

This was referenced Sep 25, 2023

Deploy Checklist: New Expensify DUPE 2023-09-25 #28118

Closed

Deploy Checklist: New Expensify 2023-09-25 #28119

Closed

melvin-bot bot mentioned this pull request Sep 25, 2023

[HOLD for payment 2023-10-02] [TS migration] Migrate 'BootSplash' lib to TypeScript #24846

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[TS migration] Migrate 'BootSplash' lib to TypeScript #24846 #27762

[TS migration] Migrate 'BootSplash' lib to TypeScript #24846 #27762

arthurmfgtab commented Sep 19, 2023 •

edited

Loading

rezkiy37 left a comment

rezkiy37 Sep 19, 2023

fabioh8010 Sep 19, 2023 •

edited

Loading

arthurmfgtab Sep 20, 2023

fabioh8010 Sep 19, 2023 •

edited

Loading

fabioh8010 Sep 19, 2023

fabioh8010 Sep 19, 2023

fabioh8010 Sep 19, 2023

melvin-bot bot commented Sep 21, 2023

jjcoffee left a comment

melvin-bot bot commented Sep 21, 2023

amyevans left a comment

BartoszGrajdek commented Sep 21, 2023

BartoszGrajdek commented Sep 21, 2023

BartoszGrajdek commented Sep 21, 2023

OSBotify commented Sep 21, 2023

OSBotify commented Sep 22, 2023

OSBotify commented Sep 25, 2023

OSBotify commented Sep 25, 2023

OSBotify commented Sep 28, 2023


		const BootSplash = NativeModules.BootSplash;
		const BootSplash: BootSplashModule = NativeModules.BootSplash;

		@@ -9,16 +10,20 @@ function hide() {

		return document.fonts.ready.then(() => {

[TS migration] Migrate 'BootSplash' lib to TypeScript #24846 #27762

[TS migration] Migrate 'BootSplash' lib to TypeScript #24846 #27762

Conversation

arthurmfgtab commented Sep 19, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

rezkiy37 left a comment

Choose a reason for hiding this comment

rezkiy37 Sep 19, 2023

Choose a reason for hiding this comment

fabioh8010 Sep 19, 2023 • edited Loading

Choose a reason for hiding this comment

arthurmfgtab Sep 20, 2023

Choose a reason for hiding this comment

fabioh8010 Sep 19, 2023 • edited Loading

Choose a reason for hiding this comment

fabioh8010 Sep 19, 2023

Choose a reason for hiding this comment

fabioh8010 Sep 19, 2023

Choose a reason for hiding this comment

fabioh8010 Sep 19, 2023

Choose a reason for hiding this comment

melvin-bot bot commented Sep 21, 2023

jjcoffee left a comment

Choose a reason for hiding this comment

melvin-bot bot commented Sep 21, 2023

amyevans left a comment

Choose a reason for hiding this comment

BartoszGrajdek commented Sep 21, 2023

BartoszGrajdek commented Sep 21, 2023

BartoszGrajdek commented Sep 21, 2023

Reviewer Checklist

Screenshots/Videos

OSBotify commented Sep 21, 2023

OSBotify commented Sep 22, 2023

OSBotify commented Sep 25, 2023

OSBotify commented Sep 25, 2023

OSBotify commented Sep 28, 2023

arthurmfgtab commented Sep 19, 2023 •

edited

Loading

fabioh8010 Sep 19, 2023 •

edited

Loading

fabioh8010 Sep 19, 2023 •

edited

Loading