[TS migration] Migrate 'compose.js' lib to TypeScript #26970

blazejkustra · 2023-09-07T15:14:26Z

Details

Migration of 'compose.js' to Typescript. This function was copied from Redux codebase (link). However these types didn't work when I tested it, so I adjusted them in this commit according to how lodash.flow is typed here.

The problem is that compose wraps functions from right, meanwhile lodash.flow works the other way around (f1(f2(f3(...))) vs f3(f2(f1(...)))). I tried using lodash.flowRight types but it has almost the same type definition as redux.compose, both doesn't work.

Code for testing:

// src/libs/test.ts

/* eslint-disable @typescript-eslint/no-unused-vars */
import {ComponentType, ForwardRefExoticComponent, ForwardRefRenderFunction, PropsWithoutRef, RefAttributes} from 'react';
import compose from './compose';

type TranslateUtilsProps = Record<string, unknown>;

declare function withLocalize<T>(wrappedComponent: ComponentType<T>): ForwardRefRenderFunction<unknown, T & TranslateUtilsProps>;

declare function withWindowDimensions<T extends JSX.IntrinsicAttributes>(wrappedComponent: React.ComponentType<T>): ForwardRefExoticComponent<PropsWithoutRef<T> & RefAttributes<unknown>>;

type WithThemeProps = {
    primaryColor: string;
};

declare function withTheme<TProps>(wrappedComponent: ComponentType<TProps>): ComponentType<Omit<TProps, keyof WithThemeProps>>;

type WithSomethingProps = {
    something: string;
};

declare function withSomething<TProps>(wrappedComponent: ComponentType<TProps>): ComponentType<Omit<TProps, keyof WithSomethingProps>>;

type AvatarWithDisplayNameProps = {test: string} & WithThemeProps & WithSomethingProps;

declare function AvatarWithDisplayName(props: AvatarWithDisplayNameProps): React.JSX.Element;

const composeTest1 = compose(withTheme, withSomething, withWindowDimensions, withLocalize)(AvatarWithDisplayName);
const normalTest1 = withTheme(withSomething(AvatarWithDisplayName));

const composeTest2 = compose(withTheme, withSomething)(AvatarWithDisplayName);
const normalTest2 = withTheme(withSomething(AvatarWithDisplayName));

declare function flowRight<A extends unknown[], R1, R2>(f2: (a: R1) => R2, f1: (...args: A) => R1): (...args: A) => R2;
declare function flowLeft<A extends unknown[], R1, R2>(f1: (...args: A) => R1, f2: (a: R1) => R2): (...args: A) => R2;

const composeTest3 = flowRight(withSomething, withTheme)(AvatarWithDisplayName);
const composeTest4 = flowLeft(withSomething, withTheme)(AvatarWithDisplayName);

Fixed Issues

$ #24788
PROPOSAL: N/A

Tests

Verify that no errors appear in the JS console
Verify that the app works as expected overall

Offline tests

N/A

QA Steps

N/A

PR Author Checklist

Screenshots/Videos

Web

web.mov

Mobile Web - Chrome

a-web.mov

Mobile Web - Safari

i-web.mov

Desktop

desktop.mov

iOS

ios.mov

Android

blazejkustra · 2023-09-07T15:32:04Z

@hayata-suenaga @fabioh8010 I need your eyes on this PR as it is quite tricky, everything is explained in the PR's description (Fabio is ooo so he'll probably see this in the upcoming week).

fabioh8010 · 2023-09-12T00:12:54Z

Hi @blazejkustra, could you provide more info about why Redux and flowRight types didn't work? What type of problems are you having?

hayata-suenaga · 2023-09-12T02:42:27Z

let me know if you need input from me @blazejkustra @fabioh8010 🙇

blazejkustra · 2023-09-12T11:05:28Z

type Func<T extends unknown[], R> = (...a: T) => R;

export default function compose(): <R>(a: R) => R;

export default function compose<F extends Function>(f: F): F;

/* two functions */
export default function compose<A, T extends unknown[], R>(f1: (a: A) => R, f2: Func<T, A>): Func<T, R>;

/* three functions */
export default function compose<A, B, T extends unknown[], R>(f1: (b: B) => R, f2: (a: A) => B, f3: Func<T, A>): Func<T, R>;

/* four functions */
export default function compose<A, B, C, T extends unknown[], R>(f1: (c: C) => R, f2: (b: B) => C, f3: (a: A) => B, f4: Func<T, A>): Func<T, R>;

/* rest */
export default function compose<R>(f1: (a: unknown) => R, ...funcs: Function[]): (...args: unknown[]) => R;

export default function compose<R>(...funcs: Function[]): (...args: unknown[]) => R;

export default function compose(...funcs: Function[]): Function {
    if (funcs.length === 0) {
        // infer the argument type so it is usable in inference down the line
        return <T>(arg: T) => arg;
    }

    if (funcs.length === 1) {
        return funcs[0];
    }

    return funcs.reduce(
        (a, b) =>
            (...args: any) =>
                a(b(...args)),
    );
}

const composed = compose(withInjected, withInjected2); // Func<unknown[], unknown>
const y = composed(AvatarWithDisplayName); // unknown

@fabioh8010 I can't get it to work at all, I either get errors or unknown as in the snippet above. It's not inferring correctly or I'm missing something 🤷

melvin-bot · 2023-09-26T15:13:09Z

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

fabioh8010

As we discussed previously on Slack, I agree that we have to keep the typing order of the compose function reversed in order to work, while the compose implementation won't change.

LGTM, CK still need to do the checklist.

kubabutkiewicz · 2023-09-27T15:08:52Z

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.mp4

Mobile Web - Chrome

mobile-chrome.mp4

Mobile Web - Safari

mobile-safari.mp4

Desktop

desktop.mp4

iOS

ios.mp4

Android

android.mp4

blazejkustra · 2023-09-29T08:43:37Z

@mananjadhav can you approve the PR so that an internal is assigned?

mananjadhav

Approving as per the Typescript migration guidelines.

melvin-bot · 2023-10-02T16:24:11Z

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

mananjadhav · 2023-10-02T16:49:41Z

Thanks for notifying @blazejkustra I missed the notification regarding C+ enabled for TS PR. I'll work on the checklist.

mananjadhav · 2023-10-02T18:19:15Z

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-compose-migration.mov

Mobile Web - Chrome

mweb-chrome-compose-migration.mov

Mobile Web - Safari

mweb-safari-compose-migration.mov

Desktop

desktop-compose-migration.mov

iOS

ios-compose-migration.mov

Android

android-compose-migration.mov

mananjadhav · 2023-10-02T19:53:34Z

@stitesExpensify All yours.

🎀 👀 🎀 C+ reviewed.

OSBotify · 2023-10-03T10:05:17Z

✋ 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-10-03T16:08:30Z

🚀 Deployed to staging by https://github.com/stitesExpensify in version: 1.3.77-0 🚀

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

OSBotify · 2023-10-05T00:15:20Z

🚀 Deployed to production by https://github.com/mountiny in version: 1.3.77-7 🚀

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

blazejkustra added 2 commits September 7, 2023 16:57

[TS migration] Migrate 'compose.js' lib to TypeScript

f6a5dc3

Fix redux types

eb0774c

Merge branch 'main' into ts-migration/compose

065b5ee

blazejkustra marked this pull request as ready for review September 26, 2023 15:13

blazejkustra requested a review from a team as a code owner September 26, 2023 15:13

melvin-bot bot requested review from mananjadhav and removed request for a team September 26, 2023 15:13

fabioh8010 approved these changes Sep 27, 2023

View reviewed changes

kubabutkiewicz approved these changes Sep 27, 2023

View reviewed changes

mananjadhav approved these changes Oct 2, 2023

View reviewed changes

melvin-bot bot requested a review from stitesExpensify October 2, 2023 16:24

stitesExpensify approved these changes Oct 3, 2023

View reviewed changes

stitesExpensify merged commit 029d009 into Expensify:main Oct 3, 2023
14 of 15 checks passed

OSBotify mentioned this pull request Oct 3, 2023

Deploy Checklist: New Expensify 2023-10-03 #28727

Closed

melvin-bot bot mentioned this pull request Oct 5, 2023

[HOLD for payment 2023-10-12] [TS migration] Migrate 'compose.js' lib to TypeScript #24788

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[TS migration] Migrate 'compose.js' lib to TypeScript #26970

[TS migration] Migrate 'compose.js' lib to TypeScript #26970

blazejkustra commented Sep 7, 2023 •

edited

Loading

blazejkustra commented Sep 7, 2023

fabioh8010 commented Sep 12, 2023

hayata-suenaga commented Sep 12, 2023

blazejkustra commented Sep 12, 2023 •

edited

Loading

melvin-bot bot commented Sep 26, 2023

fabioh8010 left a comment

kubabutkiewicz commented Sep 27, 2023

blazejkustra commented Sep 29, 2023

mananjadhav left a comment

melvin-bot bot commented Oct 2, 2023

mananjadhav commented Oct 2, 2023

mananjadhav commented Oct 2, 2023 •

edited

Loading

mananjadhav commented Oct 2, 2023

OSBotify commented Oct 3, 2023

OSBotify commented Oct 3, 2023

OSBotify commented Oct 5, 2023

[TS migration] Migrate 'compose.js' lib to TypeScript #26970

[TS migration] Migrate 'compose.js' lib to TypeScript #26970

Conversation

blazejkustra commented Sep 7, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

blazejkustra commented Sep 7, 2023

fabioh8010 commented Sep 12, 2023

hayata-suenaga commented Sep 12, 2023

blazejkustra commented Sep 12, 2023 • edited Loading

melvin-bot bot commented Sep 26, 2023

fabioh8010 left a comment

Choose a reason for hiding this comment

kubabutkiewicz commented Sep 27, 2023

Reviewer Checklist

Screenshots/Videos

blazejkustra commented Sep 29, 2023

mananjadhav left a comment

Choose a reason for hiding this comment

melvin-bot bot commented Oct 2, 2023

mananjadhav commented Oct 2, 2023

mananjadhav commented Oct 2, 2023 • edited Loading

Reviewer Checklist

Screenshots/Videos

mananjadhav commented Oct 2, 2023

OSBotify commented Oct 3, 2023

OSBotify commented Oct 3, 2023

OSBotify commented Oct 5, 2023

blazejkustra commented Sep 7, 2023 •

edited

Loading

blazejkustra commented Sep 12, 2023 •

edited

Loading

mananjadhav commented Oct 2, 2023 •

edited

Loading