[TS migration] Migrate 'HeaderGap' component to TypeScript #32567

SzymczakJ · 2023-12-06T14:24:55Z

Details

Migrate 'HeaderGap' component to TypeScript. During this task i noticed that webpack doesn't include .desktop.tsx files in bundle when running desktop app and desktop app wouldn't work if we wanted to write some desktop specific code, I've put out a PR that fixes this. Without that PR all components that have .desktop.tsx files won't work properly.
I also changed SplashScreenHider so that it's typed better(so it doesn't say it returns null, but ReactNode), because it was a similar case to HeaderGap component(more details in comments below).

Fixed Issues

$ #24990
PROPOSAL: N/A

Tests

Test HeaderGap usage in main flows of the app(for example check if HeaderGap exists between Header Back Button and top edge of window(only on desktop) on Profile Page)
Verify that no errors appear in the JS console

Offline tests

N/A

QA Steps

Same as tests

PR Author Checklist

Screenshots/Videos

Android: Native

Android: mWeb Chrome

iOS: Native

ios.mov

iOS: mWeb Safari

iosweb.mov

MacOS: Chrome / Safari

web.mov

MacOS: Desktop

desktop.mov

src/components/HeaderGap/index.tsx

blazejkustra · 2023-12-08T10:09:58Z

src/components/HeaderGap/index.desktop.tsx

+import useThemeStyles from '@styles/useThemeStyles';
+import HeaderGapComponent from './types';
+
+// eslint-disable-next-line react/function-component-definition, react/prop-types


@SzymczakJ Let's actually disable react/prop-types rule globally (.eslintrc.js) for Typescript files.

VickyStash · 2023-12-11T13:40:34Z

src/components/HeaderGap/index.tsx

+import HeaderGapComponent from './types';
+
+// eslint-disable-next-line react/function-component-definition
+const HeaderGap: HeaderGapComponent = () => null;
+
+HeaderGap.displayName = 'HeaderGap';
+export default HeaderGap;


Maybe we can keep function component definition and keep it this way for example to follow our common rules. Also this was we can get rid of elsint ignore in index.desktop.tsx file.
@SzymczakJ @blazejkustra what do you think?

Suggested change

import HeaderGapComponent from './types';

// eslint-disable-next-line react/function-component-definition

const HeaderGap: HeaderGapComponent = () => null;

HeaderGap.displayName = 'HeaderGap';

export default HeaderGap;

import type {HeaderGapProps} from './types';

// eslint-disable-next-line @typescript-eslint/no-unused-vars

function HeaderGap({styles}: HeaderGapProps) {

return null;

}

HeaderGap.displayName = 'HeaderGap';

export default HeaderGap;

Good idea, changed component the way you wanted. What do you think?

VickyStash · 2023-12-11T15:47:27Z

src/components/HeaderGap/index.desktop.tsx

+import HeaderGapProps from './types';
+
+function HeaderGap({styles}: HeaderGapProps) {
+    const themeStyles = useThemeStyles();


Suggested change

const themeStyles = useThemeStyles();

const themeStyles = useThemeStyles();

VickyStash · 2023-12-11T16:26:12Z

src/components/HeaderGap/index.tsx

+import HeaderGapProps from './types';
+
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+function HeaderGap({styles}: HeaderGapProps): ReactNode {


We usually don't add return type to components

Without it the return type would be null, that's why it was initially typed like this:

const HeaderGap: HeaderGapComponent = () => null;

We already have something similar with SplashScreenHider for example.

And the component seems to work as expected.

But if you think it's better to keep your initial typing I'm okay with that!

@VickyStash I think we need to adjust SplashScreenHider return type. Default implementation index.tsx returns null, but native implementation index.native.tsx returns an Element. The problem is that typescript infers the type from default implementation so whenever you use this component it's treated like it returns null which isn't entirely true..

And the component seems to work as expected.

It does, but the type is misleading 😅

But if you think it's better to keep your initial typing I'm okay with that!

I think the most clean is to make it an exception and leave the return type for HeaderGap and SplashScreenHider, as it is now

@SzymczakJ Let's move the return type to types.ts and reuse this type in implementations. Go ahead and adjust SplashScreenHider as well, thanks!

Fixed comments! @VickyStash @blazejkustra what do you think?

VickyStash

LGTM

melvin-bot · 2023-12-13T10:29:58Z

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

Ollyws · 2023-12-13T13:26:42Z

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

N/A

Android: mWeb Chrome

N/A

iOS: Native

N/A

iOS: mWeb Safari

N/A

MacOS: Chrome / Safari

N/A

MacOS: Desktop

Ollyws

LGTM.

marcochavezf

Also LGTM, thank you guys! 🚀

OSBotify · 2023-12-13T17:21: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-14T16:05:52Z

🚀 Deployed to staging by https://github.com/marcochavezf in version: 1.4.13-0 🚀

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

OSBotify · 2023-12-14T16:45:40Z

🚀 Deployed to staging by https://github.com/marcochavezf in version: 1.4.13-0 🚀

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

OSBotify · 2023-12-19T02:01:58Z

🚀 Deployed to production by https://github.com/jasperhuangg in version: 1.4.13-8 🚀

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

SzymczakJ added 2 commits December 5, 2023 15:22

migrate HeaderGap to TS

4f5e306

fix PR comments

e311ced

SzymczakJ mentioned this pull request Dec 6, 2023

[NoQA] change webpack config and rename .web files to .website files #32548

Merged

51 tasks

blazejkustra reviewed Dec 7, 2023

View reviewed changes

src/components/HeaderGap/index.tsx Show resolved Hide resolved

fix typing

9e6366a

blazejkustra approved these changes Dec 7, 2023

View reviewed changes

blazejkustra reviewed Dec 8, 2023

View reviewed changes

disable prop-types globally

442d966

VickyStash reviewed Dec 11, 2023

View reviewed changes

SzymczakJ added 2 commits December 11, 2023 16:05

Merge branch 'main' into @szymczak/24990

1ba1b48

fix PR comments

47a827d

SzymczakJ requested a review from VickyStash December 11, 2023 15:33

VickyStash reviewed Dec 11, 2023

View reviewed changes

fix PR comments

d209076

SzymczakJ requested a review from VickyStash December 13, 2023 10:14

VickyStash approved these changes Dec 13, 2023

View reviewed changes

SzymczakJ marked this pull request as ready for review December 13, 2023 10:29

SzymczakJ requested a review from a team as a code owner December 13, 2023 10:29

melvin-bot bot requested review from Ollyws and removed request for a team December 13, 2023 10:29

Ollyws approved these changes Dec 13, 2023

View reviewed changes

melvin-bot bot requested a review from marcochavezf December 13, 2023 13:39

marcochavezf approved these changes Dec 13, 2023

View reviewed changes

marcochavezf merged commit 946a686 into Expensify:main Dec 13, 2023
17 of 19 checks passed

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

Deploy Checklist: New Expensify 2023-12-14 #33072

Closed

77 tasks

melvin-bot bot mentioned this pull request Dec 19, 2023

[HOLD for payment 2023-12-26] [HOLD for payment 2023-12-18] [TS migration] Migrate 'HeaderGap' component to TypeScript #24990

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[TS migration] Migrate 'HeaderGap' component to TypeScript #32567

[TS migration] Migrate 'HeaderGap' component to TypeScript #32567

SzymczakJ commented Dec 6, 2023 •

edited

Loading

blazejkustra Dec 8, 2023

VickyStash Dec 11, 2023

SzymczakJ Dec 11, 2023

VickyStash Dec 11, 2023

VickyStash Dec 11, 2023

blazejkustra Dec 11, 2023

VickyStash Dec 11, 2023

blazejkustra Dec 12, 2023

blazejkustra Dec 12, 2023

SzymczakJ Dec 13, 2023

VickyStash left a comment

melvin-bot bot commented Dec 13, 2023

Ollyws commented Dec 13, 2023

Ollyws left a comment

marcochavezf left a comment

OSBotify commented Dec 13, 2023

OSBotify commented Dec 14, 2023

OSBotify commented Dec 14, 2023

OSBotify commented Dec 19, 2023

	const themeStyles = useThemeStyles();
	const themeStyles = useThemeStyles();

[TS migration] Migrate 'HeaderGap' component to TypeScript #32567

[TS migration] Migrate 'HeaderGap' component to TypeScript #32567

Conversation

SzymczakJ commented Dec 6, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

VickyStash left a comment

Choose a reason for hiding this comment

melvin-bot bot commented Dec 13, 2023

Ollyws commented Dec 13, 2023

Reviewer Checklist

Screenshots/Videos

Ollyws left a comment

Choose a reason for hiding this comment

marcochavezf left a comment

Choose a reason for hiding this comment

OSBotify commented Dec 13, 2023

OSBotify commented Dec 14, 2023

OSBotify commented Dec 14, 2023

OSBotify commented Dec 19, 2023

SzymczakJ commented Dec 6, 2023 •

edited

Loading