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

Check and remove unnecessary @ts-expect-error suppressions #40627

Merged
merged 27 commits into from
May 16, 2024

Conversation

ZhenjaHorbach
Copy link
Contributor

@ZhenjaHorbach ZhenjaHorbach commented Apr 20, 2024

Details

Fixed Issues

$ #39130
PROPOSAL: #39130 (comment)

Tests

Nothing to test. All changes are related to TS only

  • Verify that no errors appear in the JS console

Offline tests

Nothing to test. All changes are related to TS only

QA Steps

Nothing to test. All changes are related to TS only

  • 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 either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
    • 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(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 UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
    • I verified that all the inputs inside a form are aligned with each other.
    • I added Design label and/or tagged @Expensify/design 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

NA

Android: mWeb Chrome

NA

iOS: Native

NA

iOS: mWeb Safari

NA

MacOS: Chrome / Safari

NA

MacOS: Desktop

NA

@ZhenjaHorbach ZhenjaHorbach requested a review from a team as a code owner April 20, 2024 13:26
@melvin-bot melvin-bot bot removed the request for review from a team April 20, 2024 13:26
Copy link

melvin-bot bot commented Apr 20, 2024

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

@melvin-bot melvin-bot bot requested a review from Julesssss April 20, 2024 13:26
@c3024
Copy link
Contributor

c3024 commented Apr 21, 2024

@ZhenjaHorbach

Is this done? Melvin did not auto request a review from me because you made the PR ready for review without adding the issue number in the template. If this is ready please complete the checklist.

@ZhenjaHorbach
Copy link
Contributor Author

ZhenjaHorbach commented Apr 21, 2024

@ZhenjaHorbach

Is this done? Melvin did not auto request a review from me because you made the PR ready for review without adding the issue number in the template. If this is ready please complete the checklist.

Hello
Sorry
My fault
I forgot to add issue number

But in any case, the PR is about 50 percent ready)

I will write to you when the PR is ready for review )

@ZhenjaHorbach
Copy link
Contributor Author

ZhenjaHorbach commented Apr 22, 2024

Hello )
@blazejkustra @fabioh8010
I have a few questions for you )

  1. Do we need to remove this rule from github/actions ?
  2. We have some cases, when problem with library and we don't know when this problem will be fixed. Do we need to write a patch for this?
  3. We have this rule inside patches. Do we need to fix it ?
  4. In addition to // @ts-expect-error: ONYXKEYS.REIMBURSEMENT_ACCOUNT is conflicting with ONYXKEYS.FORMS.REIMBURSEMENT_ACCOUNT_FORM, we also have // @ts-expect-error: ONYXKEYS.PERSONAL_BANK_ACCOUNT is conflicting with ONYXKEYS.FORMS.PERSONAL_BANK_ACCOUNT_FORM for example . Do we need to fix it ?

@blazejkustra
Copy link
Contributor

Do we need to remove this rule from github/actions ?

We have this rule inside patches. Do we need to fix it ?

I think, I'm missing what rule are we talking about 😄

We have some cases, when problem with library and we don't know when this problem will be fixed. Do we need to write a patch for this?

Please link what are the issues 🤔

In addition to // @ts-expect-error: ONYXKEYS.REIMBURSEMENT_ACCOUNT is conflicting with ONYXKEYS.FORMS.REIMBURSEMENT_ACCOUNT_FORM, we also have // @ts-expect-error: ONYXKEYS.PERSONAL_BANK_ACCOUNT is conflicting with ONYXKEYS.FORMS.PERSONAL_BANK_ACCOUNT_FORM for example . Do we need to fix it ?

These have to stay unfortunately

@ZhenjaHorbach
Copy link
Contributor Author

Do we need to remove this rule from github/actions ?

We have this rule inside patches. Do we need to fix it ?

I think, I'm missing what rule are we talking about 😄

We have some cases, when problem with library and we don't know when this problem will be fixed. Do we need to write a patch for this?

Please link what are the issues 🤔

In addition to // @ts-expect-error: ONYXKEYS.REIMBURSEMENT_ACCOUNT is conflicting with ONYXKEYS.FORMS.REIMBURSEMENT_ACCOUNT_FORM, we also have // @ts-expect-error: ONYXKEYS.PERSONAL_BANK_ACCOUNT is conflicting with ONYXKEYS.FORMS.PERSONAL_BANK_ACCOUNT_FORM for example . Do we need to fix it ?

These have to stay unfortunately

These are Github/actions
Снимок экрана 2024-04-22 в 16 00 31

and sorry about the rule inside patches
I looked in the wrong place

And problem with libraries
For example:

// @ts-expect-error there is a type mismatch in typescipt types for MediaStreamTrack microsoft/TypeScript#39010

// @ts-expect-error - This line imports a module from 'pdfjs-dist' package which lacks TypeScript typings.

@@ -74,7 +74,7 @@ type ExpensifyOnyxProps = {

type ExpensifyProps = ExpensifyOnyxProps;

const SplashScreenHiddenContext = React.createContext({});
const SplashScreenHiddenContext = React.createContext<{isSplashHidden?: boolean}>({});
Copy link
Contributor

Choose a reason for hiding this comment

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

Let's extract the type to a separate type

Comment on lines 7 to 8
const keys1 = Object.keys(obj1) as Array<keyof typeof obj1>;
const keys2 = Object.keys(obj2) as Array<keyof typeof obj2>;
Copy link
Contributor

Choose a reason for hiding this comment

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

Are these assertions necessary?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

If we remove we will have this ts-issue

Снимок экрана 2024-04-22 в 16 22 10

Copy link
Contributor

Choose a reason for hiding this comment

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

Let's improve shallowCompare:

function shallowCompare(obj1?: Record<string, unknown>, obj2?: Record<string, unknown>): boolean {
    if (!obj1 && !obj2) {
        return true;
    }

    if (obj1 && obj2) {
        const keys1 = Object.keys(obj1);
        const keys2 = Object.keys(obj2);
        return keys1.length === keys2.length && keys1.every((key) => obj1[key] === obj2[key]);
    }

    return false;
}

export default shallowCompare;

And then you have to make the following adjustments:

diff --git a/src/libs/Navigation/AppNavigator/getPartialStateDiff.ts b/src/libs/Navigation/AppNavigator/getPartialStateDiff.ts
index 4c18e161c9..5061c75007 100644
--- a/src/libs/Navigation/AppNavigator/getPartialStateDiff.ts
+++ b/src/libs/Navigation/AppNavigator/getPartialStateDiff.ts
@@ -53,7 +53,7 @@ function getPartialStateDiff(state: State<RootStackParamList>, templateState: St
             (stateTopmostCentralPane &&
                 templateStateTopmostCentralPane &&
                 stateTopmostCentralPane.name !== templateStateTopmostCentralPane.name &&
-                !shallowCompare(stateTopmostCentralPane.params, templateStateTopmostCentralPane.params))
+                !shallowCompare(stateTopmostCentralPane.params as Record<string, unknown> | undefined, templateStateTopmostCentralPane.params as Record<string, unknown> | undefined))
         ) {
             // We need to wrap central pane routes in the central pane navigator.
             diff[NAVIGATORS.CENTRAL_PANE_NAVIGATOR] = templateStateTopmostCentralPane;
@@ -73,7 +73,7 @@ function getPartialStateDiff(state: State<RootStackParamList>, templateState: St
             (stateTopmostFullScreen &&
                 templateStateTopmostFullScreen &&
                 stateTopmostFullScreen.name !== templateStateTopmostFullScreen.name &&
-                !shallowCompare(stateTopmostFullScreen.params, templateStateTopmostFullScreen.params))
+                !shallowCompare(stateTopmostFullScreen.params as Record<string, unknown> | undefined, templateStateTopmostFullScreen.params as Record<string, unknown> | undefined))
         ) {
             diff[NAVIGATORS.FULL_SCREEN_NAVIGATOR] = fullScreenDiff;
         }
diff --git a/src/libs/Navigation/linkTo.ts b/src/libs/Navigation/linkTo.ts
index 863cb102ad..b21a24a76e 100644
--- a/src/libs/Navigation/linkTo.ts
+++ b/src/libs/Navigation/linkTo.ts
@@ -153,7 +153,7 @@ export default function linkTo(navigation: NavigationContainerRef<RootStackParam
         const isTargetNavigatorOnTop = topRouteName === action.payload.name;
 
         const isTargetScreenDifferentThanCurrent = Boolean(topmostCentralPaneRoute && topmostCentralPaneRoute.name !== action.payload.params?.screen);
-        const areParamsDifferent = !shallowCompare(topmostCentralPaneRoute?.params, action.payload.params?.params);
+        const areParamsDifferent = !shallowCompare(topmostCentralPaneRoute?.params as Record<string, unknown> | undefined, action.payload.params?.params);
 
         // In case if type is 'FORCED_UP' we replace current screen with the provided. This means the current screen no longer exists in the stack
         if (type === CONST.NAVIGATION.TYPE.FORCED_UP) {

@@ -49,7 +49,7 @@ import SendButton from './SendButton';
type ComposerRef = {
blur: () => void;
focus: (shouldDelay?: boolean) => void;
replaceSelectionWithText: (text: string, shouldAddTrailSpace: boolean) => void;
replaceSelectionWithText: (text: string, shouldAddTrailSpace: Emoji) => void;
Copy link
Contributor

Choose a reason for hiding this comment

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

How about this?

Suggested change
replaceSelectionWithText: (text: string, shouldAddTrailSpace: Emoji) => void;
replaceSelectionWithText: OnEmojiSelected;

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Good catch )

Comment on lines 120 to 123
(text: string | undefined) => {
if (text === undefined) {
return;
}
Copy link
Contributor

Choose a reason for hiding this comment

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

We need to test this change 👍

Copy link
Contributor

Choose a reason for hiding this comment

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

+1

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I removed this changes
Because we can pass only string and undefined in this function is not needed

@@ -91,13 +91,12 @@ function StateSelectionPage() {
shouldShowBackButton
onBackButtonPress={() => {
const backTo = params?.backTo ?? '';
let backToRoute = '';
let backToRoute = '' as Route;
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggestion:

                    let backToRoute: Route | undefined;

                    if (backTo) {
                        backToRoute = appendParam(backTo, 'state', currentState ?? '');
                    }

                    Navigation.goBack(backToRoute);

I think we should fix appendParam so that it returns a Route type. This way we can avoid assertion in this file

@blazejkustra
Copy link
Contributor

These are Github/actions

That's unusual, can you investigate why these // ts-expect-errors are added to JS files in the first place? (you don't need to remove them, but at least let's understand why they exist)

And problem with libraries For example:

Let's try to fix these library ts expect errors, you can augment types from other libraries like we do in src/types/modules.

@blazejkustra
Copy link
Contributor

@ZhenjaHorbach Let me know once PR is ready for review again 😄

@ZhenjaHorbach
Copy link
Contributor Author

@ZhenjaHorbach Let me know once PR is ready for review again 😄

No problem )
I'm going to make this PR completely today or tomorrow)

@grgia grgia requested review from c3024 and grgia April 29, 2024 11:56
grgia
grgia previously approved these changes Apr 30, 2024
Copy link
Contributor

@grgia grgia left a comment

Choose a reason for hiding this comment

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

Changes look good

@c3024
Copy link
Contributor

c3024 commented Apr 30, 2024

@ZhenjaHorbach

Is this complete? If it is, please complete the checklist and bump me. Thanks.

@ZhenjaHorbach
Copy link
Contributor Author

@ZhenjaHorbach

Is this complete? If it is, please complete the checklist and bump me. Thanks.

It's not over yet)
The issue turned out to be more difficult than I thought
But I'm gradually adding changes)

@ZhenjaHorbach
Copy link
Contributor Author

ZhenjaHorbach commented May 1, 2024

@fabioh8010 @blazejkustra
Hello )

I'm working on PR
And I have a question
Should we remove the OptionsSelector in this PR?
Am I mistaken, or did we already have a ticket related to the complete removal of OptionsSelector?

{/** @ts-expect-error This component is deprecated and will not be migrated to TypeScript (context: https://expensify.slack.com/archives/C01GTK53T8Q/p1709232289899589?thread_ts=1709156803.359359&cid=C01GTK53T8Q) */}
<OptionsSelector
sections={optionSelectorSections}
onSelectRow={canModifyParticipants ? selectParticipant : navigateToReportOrUserDetail}
onAddToSelection={selectParticipant}
onConfirmSelection={confirm}
selectedOptions={selectedOptions}
canSelectMultipleOptions={canModifyParticipants}
disableArrowKeysActions={!canModifyParticipants}
boldStyle
showTitleTooltip
shouldTextInputAppearBelowOptions
shouldShowTextInput={false}
shouldUseStyleForChildren={false}
optionHoveredStyle={canModifyParticipants ? styles.hoveredComponentBG : {}}
footerContent={footerContent}
listStyles={listStyles}
shouldAllowScrollingChildren
>

@ZhenjaHorbach
Copy link
Contributor Author

@blazejkustra @fabioh8010

I can share the current status
I fixed everything except some places where we don't need to remove this rule and where I haven't figured out how to remove it
And I need some advice if you don't mind

Don't need to remove

  1. // @ts-expect-error the test is asserting that it's undefined, so the TS error is normal

Here we are trying to test non-existent methods

  1. // @ts-expect-error Any code inside `sanitizedInput` that gets evaluated by `eval()` will be executed in the context of the current this value.

Here we are trying to get non-existent this

Haven't figured out how to remove rules

I tried to remove this rule but as a result we need to change many types inside React-navigation library and I'm not sure how much that makes sense

  1. // @ts-expect-error -- it's a static getter

I tried updating GithubUtils types but it didn't help

  1. // @ts-expect-error Override shouldn't be done on private methods wait until https://github.com/kiegroup/act-js/issues/77 is resolved or try to create a params workaround

I tried updating types using d.ts files but it didn't help. More precisely, the types refer to our files with types, but the error does not disappear

@fabioh8010
Copy link
Contributor

@blazejkustra @fabioh8010

I can share the current status I fixed everything except some places where we don't need to remove this rule and where I haven't figured out how to remove it And I need some advice if you don't mind

Don't need to remove

  1. // @ts-expect-error the test is asserting that it's undefined, so the TS error is normal

Here we are trying to test non-existent methods

  1. // @ts-expect-error Any code inside `sanitizedInput` that gets evaluated by `eval()` will be executed in the context of the current this value.

Here we are trying to get non-existent this

Haven't figured out how to remove rules

I tried to remove this rule but as a result we need to change many types inside React-navigation library and I'm not sure how much that makes sense

  1. // @ts-expect-error -- it's a static getter

I tried updating GithubUtils types but it didn't help

  1. // @ts-expect-error Override shouldn't be done on private methods wait until https://github.com/kiegroup/act-js/issues/77 is resolved or try to create a params workaround

I tried updating types using d.ts files but it didn't help. More precisely, the types refer to our files with types, but the error does not disappear

@ZhenjaHorbach I think all these ones are okay to leave in the codebase, in some cases isn't really possible to remove and that's understandable.

@ZhenjaHorbach
Copy link
Contributor Author

@blazejkustra @fabioh8010
I can share the current status I fixed everything except some places where we don't need to remove this rule and where I haven't figured out how to remove it And I need some advice if you don't mind
Don't need to remove

  1. // @ts-expect-error the test is asserting that it's undefined, so the TS error is normal

Here we are trying to test non-existent methods

  1. // @ts-expect-error Any code inside `sanitizedInput` that gets evaluated by `eval()` will be executed in the context of the current this value.

Here we are trying to get non-existent this
Haven't figured out how to remove rules

I tried to remove this rule but as a result we need to change many types inside React-navigation library and I'm not sure how much that makes sense

  1. // @ts-expect-error -- it's a static getter

I tried updating GithubUtils types but it didn't help

  1. // @ts-expect-error Override shouldn't be done on private methods wait until https://github.com/kiegroup/act-js/issues/77 is resolved or try to create a params workaround

I tried updating types using d.ts files but it didn't help. More precisely, the types refer to our files with types, but the error does not disappear

@ZhenjaHorbach I think all these ones are okay to leave in the codebase, in some cases isn't really possible to remove and that's understandable.

Sounds great)
Thank you )

@c3024
In this case, PR is ready

@c3024
Copy link
Contributor

c3024 commented May 10, 2024

Please remove WIP and merge main. Failing checks might pass.

@ZhenjaHorbach ZhenjaHorbach changed the title [WIP] Check and remove unnecessary @ts-expect-error suppressions Check and remove unnecessary @ts-expect-error suppressions May 10, 2024
@ZhenjaHorbach
Copy link
Contributor Author

ZhenjaHorbach commented May 10, 2024

Please remove WIP and merge main. Failing checks might pass.

I see that "Test GitHub Actions workflows" check is failing, I had the same problem on my branch. It isn't caused by your changes

I merged main
But "Test GitHub Actions workflows" still failed (
But following this comment, this is expected

@c3024
Copy link
Contributor

c3024 commented May 10, 2024

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 either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
    • 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 UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
    • I verified that all the inputs inside a form are aligned with each other.
    • I added Design label and/or tagged @Expensify/design 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
Android: mWeb Chrome
iOS: Native
iOS: mWeb Safari
MacOS: Chrome / Safari
MacOS: Desktop

Copy link
Contributor

@c3024 c3024 left a comment

Choose a reason for hiding this comment

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

LGTM

@melvin-bot melvin-bot bot requested a review from grgia May 10, 2024 11:39
Copy link
Contributor

@grgia grgia left a comment

Choose a reason for hiding this comment

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

Seems like there's more changes in this PR besides @ts-expect-error suppressions could you explain in the description?

@grgia grgia requested a review from c3024 May 15, 2024 09:44
@grgia
Copy link
Contributor

grgia commented May 15, 2024

@ZhenjaHorbach could you ping me and @c3024 when you are ready for final review?

@ZhenjaHorbach
Copy link
Contributor Author

Seems like there's more changes in this PR besides @ts-expect-error suppressions could you explain in the description?

Sorry for delay
There's actually only one place where I made additional changes
#40627 (comment)
But we've already discussed this

In other places there are cases when I updated the types in the libs, for example
As a result, I needed to update other places

@ZhenjaHorbach
Copy link
Contributor Author

ZhenjaHorbach commented May 15, 2024

@ZhenjaHorbach could you ping me and @c3024 when you are ready for final review?

And PR is ready

In the last commits I reverted changes in IOUTest file and added new changes back
Because it's much faster than fixing conflicts

So technically I didn't change anything much )

@c3024
But if you want you can check again )

Copy link
Contributor

@c3024 c3024 left a comment

Choose a reason for hiding this comment

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

LGTM

@melvin-bot melvin-bot bot requested a review from grgia May 16, 2024 03:41
@OSBotify
Copy link
Contributor

🚀 Deployed to staging by https://github.com/grgia in version: 1.4.75-0 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/puneetlath in version: 1.4.75-1 🚀

platform result
🤖 android 🤖 success ✅
🖥 desktop 🖥 success ✅
🍎 iOS 🍎 success ✅
🕸 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.

6 participants