TS issues related with TestHelper #42256

ZhenjaHorbach · 2024-05-16T09:43:20Z

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

melvin-bot · 2024-05-16T09:43:25Z

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

ZhenjaHorbach · 2024-05-16T09:48:02Z

@c3024
Hello
Can you approve these changes, please ?
In parallel with our PR, others were merged that create TS issues in main

Julesssss · 2024-05-16T10:22:57Z

tests/actions/PolicyCategoryTest.ts

    beforeEach(() => {
-        // @ts-expect-error TODO: Remove this once TestHelper (https://github.com/Expensify/App/issues/25318) is migrated to TypeScript.
        global.fetch = TestHelper.getGlobalFetchMock();


Do we still need this line?

We just need to remove the comment, this global.fetch = TestHelper.getGlobalFetchMock(); is necessary for the test.

Julesssss

Is there any discussion about global.fetch and mockFetch you know about? I haven't heard about it

Beamanator · 2024-05-16T11:10:10Z

Just curious, why are you getting rid of ?. in so many places? Was anything failing due to that?

ZhenjaHorbach · 2024-05-16T11:25:25Z

Is there any discussion about global.fetch and mockFetch you know about? I haven't heard about it

These changes are from PR where we removed @ts-expect-error in unnecessary places
And since the typing of a fetch is different from TestHelper.getGlobalFetchMock
And in general there are completely different methods
I added mocks

ZhenjaHorbach · 2024-05-16T11:26:16Z

Just curious, why are you getting rid of ?. in so many places? Was anything failing due to that?

This is me experimenting
To try to make the code a little cleaner

Beamanator

Ok then sorry but I'd appreciate if you revert removing ?. b/c it makes the diff a lot longer, and IMO since we already use ?. everywhere in the code it's better to keep it here. Thoughts @Julesssss ?

Beamanator · 2024-05-16T12:02:31Z

@ZhenjaHorbach can you be a bit quicker with this PR? This is causing a LOT of PRs to have a type error and cannot be merged

ZhenjaHorbach · 2024-05-16T12:06:03Z

@ZhenjaHorbach can you be a bit quicker with this PR? This is causing a LOT of PRs to have a type error and cannot be merged

Sorry
PR is actually ready
But maybe you don't mind to delete ?. ?
Because it seems extremely unnecessary

And It's me added ?. for tests in the previous PR
And looking now it looks a little dirty

And the problems with the tests were not related to this

ZhenjaHorbach · 2024-05-16T12:13:23Z

Problems were related with this

#42256 (comment)

I tried to remove
global.fetch = TestHelper.getGlobalFetchMock(); mockFetch = fetch as MockFetch;

and use only

mockFetch = TestHelper.getGlobalFetchMock();

But using the first method we mutate the original fetch and then add type which we use for tests but save original methods inside global.fetch

Is the second method we have methods only from getGlobalFetchMock what was causing problems with the tests

ZhenjaHorbach · 2024-05-16T12:14:04Z

@Beamanator
So yeah
PR is ready )

Beamanator · 2024-05-16T12:19:06Z

But maybe you don't mind to delete ?. ?
Because it seems extremely unnecessary

And the problems with the tests were not related to this

Deleting ?. is not necessary for this TS fix, which is why I would highly prefer we do NOT delete them in this PR.

ZhenjaHorbach · 2024-05-16T12:31:03Z

But maybe you don't mind to delete ?. ?
Because it seems extremely unnecessary
And the problems with the tests were not related to this

Deleting ?. is not necessary for this TS fix, which is why I would highly prefer we do NOT delete them in this PR.

Okay
As you wish )
I updated PR

Beamanator

Looks good to me! Thanks for the fixes @ZhenjaHorbach 👍

c3024 · 2024-05-16T13:00:13Z

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

c3024

LGTM

fabioh8010 · 2024-05-16T14:56:34Z

tests/actions/PolicyCategoryTest.ts

    beforeEach(() => {
-        // @ts-expect-error TODO: Remove this once TestHelper (https://github.com/Expensify/App/issues/25318) is migrated to TypeScript.
        global.fetch = TestHelper.getGlobalFetchMock();


We just need to remove the comment, this global.fetch = TestHelper.getGlobalFetchMock(); is necessary for the test.

Beamanator · 2024-05-16T16:13:13Z

Thanks @fabioh8010 for the review!

OSBotify · 2024-05-23T00:40:27Z

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

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

OSBotify · 2024-05-27T14:03:35Z

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

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

Fix ts issues related with TestHelper

89d115b

ZhenjaHorbach requested a review from a team as a code owner May 16, 2024 09:43

melvin-bot bot requested review from c3024 and removed request for a team May 16, 2024 09:43

ZhenjaHorbach mentioned this pull request May 16, 2024

Investigate workflow job failing on main: typecheck / typecheck #42252

Closed

ZhenjaHorbach mentioned this pull request May 16, 2024

Investigate workflow job failing on main: confirmPassingBuild #42253

Closed

Julesssss reviewed May 16, 2024

View reviewed changes

ZhenjaHorbach added 2 commits May 16, 2024 12:54

Fix comments

6272d95

Fix mockFetch methods

ce1658e

Test new changes

7ada5ba

Julesssss mentioned this pull request May 16, 2024

[No QA][TS migration] Migrate multiple test to typescript #37396

Merged

49 tasks

Beamanator requested changes May 16, 2024

View reviewed changes

MonilBhavsar mentioned this pull request May 16, 2024

Handle tax for split requests #40240

Merged

50 tasks

Update tests

6f28159

ZhenjaHorbach added 2 commits May 16, 2024 14:26

Reverte changes

39c9d9b

Reverte changes x2

3a9a1a5

Julesssss approved these changes May 16, 2024

View reviewed changes

Beamanator approved these changes May 16, 2024

View reviewed changes

c3024 approved these changes May 16, 2024

View reviewed changes

melvin-bot bot requested a review from grgia May 16, 2024 13:12

fabioh8010 approved these changes May 16, 2024

View reviewed changes

blazejkustra mentioned this pull request May 16, 2024

[No QA][TS migration] Remove all remaining prop-types from the project #42249

Merged

48 tasks

Beamanator merged commit 5900fea into Expensify:main May 16, 2024
16 of 18 checks passed

arosiclair mentioned this pull request May 16, 2024

Disable no-use-before-define for function declarations #42304

Merged

48 tasks

sakluger mentioned this pull request May 16, 2024

[HOLD for payment 2024-06-03] [$250] [TS Migration] Check and remove unnecessary @ts-expect-error suppressions #39130

Closed

github-actions bot mentioned this pull request May 22, 2024

Deploy Checklist: New Expensify 2024-05-22 #42496

Closed

45 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

TS issues related with TestHelper #42256

TS issues related with TestHelper #42256

ZhenjaHorbach commented May 16, 2024

melvin-bot bot commented May 16, 2024

ZhenjaHorbach commented May 16, 2024 •

edited

Loading

Julesssss May 16, 2024

fabioh8010 May 16, 2024

Julesssss left a comment

Beamanator commented May 16, 2024

ZhenjaHorbach commented May 16, 2024

ZhenjaHorbach commented May 16, 2024

Beamanator left a comment

Beamanator commented May 16, 2024

ZhenjaHorbach commented May 16, 2024 •

edited

Loading

ZhenjaHorbach commented May 16, 2024 •

edited

Loading

ZhenjaHorbach commented May 16, 2024

Beamanator commented May 16, 2024

ZhenjaHorbach commented May 16, 2024

Beamanator left a comment

c3024 commented May 16, 2024 •

edited

Loading

c3024 left a comment

fabioh8010 May 16, 2024

Beamanator commented May 16, 2024

OSBotify commented May 23, 2024

OSBotify commented May 27, 2024

TS issues related with TestHelper #42256

TS issues related with TestHelper #42256

Conversation

ZhenjaHorbach commented May 16, 2024

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented May 16, 2024

ZhenjaHorbach commented May 16, 2024 • edited Loading

Julesssss May 16, 2024

Choose a reason for hiding this comment

fabioh8010 May 16, 2024

Choose a reason for hiding this comment

Julesssss left a comment

Choose a reason for hiding this comment

Beamanator commented May 16, 2024

ZhenjaHorbach commented May 16, 2024

ZhenjaHorbach commented May 16, 2024

Beamanator left a comment

Choose a reason for hiding this comment

Beamanator commented May 16, 2024

ZhenjaHorbach commented May 16, 2024 • edited Loading

ZhenjaHorbach commented May 16, 2024 • edited Loading

ZhenjaHorbach commented May 16, 2024

Beamanator commented May 16, 2024

ZhenjaHorbach commented May 16, 2024

Beamanator left a comment

Choose a reason for hiding this comment

c3024 commented May 16, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

c3024 left a comment

Choose a reason for hiding this comment

fabioh8010 May 16, 2024

Choose a reason for hiding this comment

Beamanator commented May 16, 2024

OSBotify commented May 23, 2024

OSBotify commented May 27, 2024

ZhenjaHorbach commented May 16, 2024 •

edited

Loading

ZhenjaHorbach commented May 16, 2024 •

edited

Loading

ZhenjaHorbach commented May 16, 2024 •

edited

Loading

c3024 commented May 16, 2024 •

edited

Loading