[TS migration] Migrate 'BootSplash' lib to TypeScript #24846 #27762
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
arthurmfgtab
changed the title
rezkiy37
reviewed
Sep 19, 2023
src/libs/BootSplash/index.native.ts
Outdated
|
|
||
| const BootSplash = NativeModules.BootSplash; | ||
| const BootSplash: BootSplashModule = NativeModules.BootSplash; |
There was a problem hiding this comment.
Can we create a global type for NativeModules.BootSplash?
Suggested change
| const BootSplash: BootSplashModule = NativeModules.BootSplash; | |
| const BootSplash: BootSplashModule = NativeModules.BootSplash; |
There was a problem hiding this comment.
@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.
There was a problem hiding this comment.
Ok, that makes sense
fabioh8010
reviewed
Sep 19, 2023
src/libs/BootSplash/index.native.ts
Outdated
|
|
||
| const BootSplash = NativeModules.BootSplash; | ||
| const BootSplash: BootSplashModule = NativeModules.BootSplash; |
There was a problem hiding this comment.
@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.
src/libs/BootSplash/index.ts
Outdated
Comment on lines
4
to
6
| function resolveAfter(delay: number) { | ||
| return new Promise((resolve) => setTimeout(resolve, delay)); | ||
| } |
There was a problem hiding this comment.
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)); | |
| } |
| @@ -9,16 +10,20 @@ function hide() { | |||
|
|
|||
| return document.fonts.ready.then(() => { | |||
There was a problem hiding this comment.
Add hide() return type
function hide(): Promise<void> {
src/libs/BootSplash/index.native.ts
Outdated
|
|
||
| const BootSplash = NativeModules.BootSplash; | ||
| const BootSplash: BootSplashModule = NativeModules.BootSplash; | ||
|
|
||
| function hide() { |
There was a problem hiding this comment.
Suggested change
| function hide() { | |
| function hide(): Promise<void> { |
melvin-bot
bot
requested review from
jjcoffee
and removed request for
a team
jjcoffee
approved these changes
Sep 21, 2023
|
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
approved these changes
Sep 21, 2023
fabioh8010
approved these changes
Sep 21, 2023
|
Reviewing... |
|
LGTM! |
BartoszGrajdek
approved these changes
Sep 21, 2023
Reviewer Checklist
Screenshots/VideosWebweb.movMobile Web - Chromechrome.movMobile Web - Safarisafari.movDesktopdesktop.moviOSios.movAndroidandroid.mov |
amyevans
approved these changes
Sep 21, 2023
|
✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release. |
96 tasks
|
🚀 Deployed to staging by https://github.com/amyevans in version: 1.3.73-0 🚀
|
This was referenced Sep 25, 2023
|
🚀 Deployed to production by https://github.com/mountiny in version: 1.3.73-1 🚀
|
|
🚀 Deployed to staging by https://github.com/amyevans in version: 1.3.74-0 🚀
|
|
🚀 Deployed to production by https://github.com/chiragsalian in version: 1.3.74-3 🚀
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Details
Fixed Issues
$ #24846
PROPOSAL: N/A
Tests
Offline tests
N/A
QA Steps
N/A
PR Author Checklist
### Fixed Issuessection aboveTestssectionOffline stepssectionQA stepssectiontoggleReportand notonIconClick)myBool && <MyComponent />.src/languages/*files and using the translation methodWaiting for Copylabel for a copy review on the original GH to get the correct copy.STYLE.md) were followedAvatar, I verified the components usingAvatarare working as expected)/** comment above it */thisproperly so there are no scoping issues (i.e. foronClick={this.submit}the methodthis.submitshould be bound tothisin the constructor)thisare necessary to be bound (i.e. avoidthis.submit = this.submit.bind(this);ifthis.submitis never passed to a component event handler likeonClick)StyleUtils.getBackgroundAndBorderStyle(themeColors.componentBG))Avataris modified, I verified thatAvataris working as expected in all cases)ScrollViewcomponent to make it scrollable when more elements are added to the page.mainbranch was merged into this PR after a review, I tested again and verified the outcome was still expected according to theTeststeps.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