Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[TS migration] Migrate 'TextInput' component to TypeScript #31356

Merged

Conversation

kubabutkiewicz
Copy link
Contributor

@kubabutkiewicz kubabutkiewicz commented Nov 15, 2023

Details

Fixed Issues

$ #25146

Tests

  1. Login into app
  2. Go to search
  3. Type something
  4. Select a user
  5. Start a chat
  6. Send a message
  7. Create money request
  8. Create and assign a task
  • Verify that no errors appear in the JS console

Offline tests

QA Steps

  • 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(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 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.mp4
Android: mWeb Chrome
iOS: Native
ios.mp4
iOS: mWeb Safari
MacOS: Chrome / Safari
web.mp4
MacOS: Desktop
desktop.mp4

Copy link

melvin-bot bot commented Nov 15, 2023

Hey! I see that you made changes to our Form component. Make sure to update the docs in FORMS.md accordingly. Cheers!

Copy link
Contributor

@rezkiy37 rezkiy37 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Left comments.

src/components/TextInput/BaseTextInput/index.native.tsx Outdated Show resolved Hide resolved
src/components/TextInput/BaseTextInput/index.native.tsx Outdated Show resolved Hide resolved
src/components/TextInput/BaseTextInput/index.native.tsx Outdated Show resolved Hide resolved
src/components/TextInput/BaseTextInput/index.tsx Outdated Show resolved Hide resolved
src/components/TextInput/BaseTextInput/index.tsx Outdated Show resolved Hide resolved
src/components/TextInput/BaseTextInput/types.ts Outdated Show resolved Hide resolved
src/components/TextInput/TextInputLabel/index.tsx Outdated Show resolved Hide resolved
src/components/TextInput/TextInputLabel/index.tsx Outdated Show resolved Hide resolved
src/components/TextInput/BaseTextInput/index.native.tsx Outdated Show resolved Hide resolved
src/components/TextInput/BaseTextInput/index.tsx Outdated Show resolved Hide resolved
src/components/TextInput/index.native.tsx Outdated Show resolved Hide resolved
src/components/TextInput/index.native.tsx Outdated Show resolved Hide resolved
src/components/TextInput/index.tsx Outdated Show resolved Hide resolved
textInputRef.current?.setAttribute('name', name);
}
// @ts-expect-error We need to reassign this ref to the input ref
removeVisibilityListenerRef.current = Visibility.onVisibilityChange(() => {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This way you can get rid of @ts-expect-error

type RemoveVisibilityListener = () => void;
....
const removeVisibilityListenerRef = useRef<RemoveVisibilityListener>(null);
...
(removeVisibilityListenerRef.current as RemoveVisibilityListener)  = Visibility.onVisibilityChange(() => {

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@VickyStash I fixed that using different approach since what you suggested was causing another error. Let me know what you think 😄

src/components/TextInput/index.tsx Outdated Show resolved Hide resolved
@kubabutkiewicz
Copy link
Contributor Author

@fedirjh fixed!

@blazejkustra
Copy link
Contributor

@fedirjh Would you be able to look at it today/tomorrow? This is blocking a ton of other TS issues 🙏

@fedirjh
Copy link
Contributor

fedirjh commented Dec 18, 2023

Would you be able to look at it today/tomorrow? This is blocking a ton of other TS issues

@blazejkustra Already started on it , I am blocked with this issue on native after last main merge

Screenshot 2023-12-18 at 8 29 36 PM

Copy link
Contributor

@fedirjh fedirjh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Tested on all platforms except native, it looks good and tests well, found minor bug with the input error message style.

// Add +2 to width on Safari browsers so that text is not cut off due to the cursor or when changing the value
// https://github.com/Expensify/App/issues/8158
// https://github.com/Expensify/App/issues/26628
<Text
style={[...props.inputStyle, props.autoGrowHeight && styles.autoGrowHeightHiddenInput(width, maxHeight), styles.hiddenElementOutsideOfWindow, styles.visibilityHidden]}
style={[
inputStyle,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why we did not destruct this style ?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@fedirjh There is no need for spreading styles props , it will work without that

<FormHelpMessage
isError={!_.isEmpty(props.errorText)}
isError={!errorText}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
isError={!errorText}
isError={!!errorText}

This is causing a bug on web , the color of the error text is not correct.

Actual Expected
Screenshot 2023-12-19 at 6 33 41 AM Screenshot 2023-12-19 at 6 33 10 AM

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Will fix that soon

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done @fedirjh

Animated.parallel([
Animated.spring(labelTranslateY, {
toValue: translateY,
duration: styleConst.LABEL_ANIMATION_DURATION,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Won't this change affect the animation on native ?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No, actually there is no duration option in for spring animation , so it was doing nothing

@fedirjh
Copy link
Contributor

fedirjh commented Dec 19, 2023

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
CleanShot.2023-12-19.at.22.47.01.mp4
Android: mWeb Chrome
CleanShot.2023-12-19.at.06.08.56.mp4
Screenshot 2023-12-19 at 10 58 56 PM
iOS: Native
CleanShot.2023-12-19.at.19.42.40.mp4
iOS: mWeb Safari
CleanShot.2023-12-18.at.23.15.00.mp4
MacOS: Chrome / Safari
CleanShot.2023-12-19.at.05.52.33.mp4
Screenshot 2023-12-19 at 10 58 32 PM
MacOS: Desktop
CleanShot.2023-12-19.at.05.55.15.mp4
Screenshot 2023-12-19 at 11 04 08 PM

@fedirjh
Copy link
Contributor

fedirjh commented Dec 20, 2023

@kubabutkiewicz Could you please merge main ? I hope that will fix this issue #31356 (comment) .

@kubabutkiewicz
Copy link
Contributor Author

@fedirjh done! 😄

@blazejkustra
Copy link
Contributor

Bump @fedirjh 😄

Copy link
Contributor

@fedirjh fedirjh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good and tests well.

Copy link

melvin-bot bot commented Dec 28, 2023

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

@melvin-bot melvin-bot bot requested a review from Beamanator December 28, 2023 22:27
Copy link
Contributor

@Beamanator Beamanator left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! I've got a decent amount of questions, mainly asking "why" since I'm still a typescript noob :D but one or two suggestions, and I'm recommending we can add any changes in a follow-up PR since this bad boi will unblock more issues!

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

NAB - most prop descriptions in this file are pretty weak / not descriptive. Maybe they came from somewhere else in the codebase (a.k.a. weren't added new here?) but it would be best to try to make them as clear as possible... Probably in a follow-up PR


const TextInput = forwardRef((props, ref) => {
function TextInput(props: BaseTextInputProps, ref: BaseTextInputRef) {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

NAB - Question: Why aren't we destructuring props here, but we do in other files like TextInputLabel?

import isSelectorSupported from './isSelectorSupported';

/**
* Check the input is auto filled or not
*/
export default function isInputAutoFilled(input: Element): boolean {
if (!input?.matches) {
export default function isInputAutoFilled(input: (TextInput | HTMLElement) | null): boolean {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

NAB - Is input: (TextInput | HTMLElement) | null not funky? I would have expected input: (TextInput | HTMLElement | null) to work and look better, no? I'd highly appreciate a lesson why it's necessary we do this, if anyone has the time 😅

autoCompleteType?: string;
};

type BaseTextInputRef = ForwardedRef<HTMLFormElement | Component<AnimatedProps<TextInputProps>>>;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Super NAB - can we use AnimatedTextInputRef here like this?

Suggested change
type BaseTextInputRef = ForwardedRef<HTMLFormElement | Component<AnimatedProps<TextInputProps>>>;
type BaseTextInputRef = ForwardedRef<HTMLFormElement | AnimatedTextInputRef>;

const onPress = (event) => {
if (props.disabled) {
const onPress = (event?: GestureResponderEvent | KeyboardEvent) => {
if (!!inputProps.disabled || !event) {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

NAB - Why do we need !! in front of inputProps.disabled?


if (!event.isDefaultPrevented()) {
input.current.focus();
if ('isDefaultPrevented' in event && !event?.isDefaultPrevented()) {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I feel like you've done this in lots of places, and forgive my ts-noobness please :D But why do we have to check 'isDefaultPrevented' in event AND also use optional chaining event?.isDefaultPrevented?

My guess is:

  1. 'isDefaultPrevented' in event is to satisfy typescript
  2. optional chaining is to make sure isDefaultPrevented is not undefined / null

@Beamanator Beamanator merged commit 035f468 into Expensify:main Dec 30, 2023
17 of 19 checks passed
@Beamanator
Copy link
Contributor

Oh @kubabutkiewicz I would also recommend you close out old comments that don't apply anymore / are resolve, as during my review I came across some open threads and wasn't sure if you'd addressed them or forgotten about them 😅 let me know what you think!

@Beamanator
Copy link
Contributor

oops this may have broken type check on main

@fedirjh
Copy link
Contributor

fedirjh commented Dec 30, 2023

oops this may have broken type check on main

I think it's from this PR #32253 ,HeaderWithBackButton was migrated in #33214 and ChildrenProps is marked as required. However in #32253 the HeaderWithBackButton doesn’t have any child.

@shubham1206agra
Copy link
Contributor

@Beamanator #33796 will fix this

@kubabutkiewicz
Copy link
Contributor Author

Hi @Beamanator sorry I was OOO, if there is still some problem I can take a look or answer your questions!

@OSBotify
Copy link
Contributor

OSBotify commented Jan 2, 2024

🚀 Deployed to staging by https://github.com/Beamanator in version: 1.4.21-0 🚀

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

@OSBotify
Copy link
Contributor

OSBotify commented Jan 4, 2024

🚀 Deployed to production by https://github.com/marcaaron in version: 1.4.21-4 🚀

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

1 similar comment
@OSBotify
Copy link
Contributor

OSBotify commented Jan 4, 2024

🚀 Deployed to production by https://github.com/marcaaron in version: 1.4.21-4 🚀

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

@OSBotify
Copy link
Contributor

OSBotify commented Jan 4, 2024

🚀 Deployed to production by https://github.com/marcaaron in version: 1.4.21-4 🚀

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

9 participants