[No QA] Clean up jest mocks #12097

marcaaron · 2022-10-24T19:59:59Z

Details

Some cleanup for the jest tests and moves some individual mocks in the global jest/setup.js file to individual user mocks files. We should adopt this practice moving forward. No app code was touched besides tests here so I don't think we need to test on all platforms.

Fixed Issues

$ https://github.com/Expensify/Expensify/issues/228440

Tests

N/A

QA Steps

N/A

PR Review Checklist

PR Author Checklist

PR Reviewer Checklist

The reviewer will copy/paste it into a new comment and complete it after the author checklist is completed

Screenshots

Web

Mobile Web - Chrome

Mobile Web - Safari

Desktop

iOS

Android

Santhosh-Sellavel · 2022-10-25T19:46:37Z

jest/setup.js

-// The main app uses a NativeModule called BootSplash to show/hide a splash screen. Since we can't use this in the node environment
-// where tests run we simulate a behavior where the splash screen is always hidden (similar to web which has no splash screen at all).
-jest.mock('../src/libs/BootSplash', () => ({
-    hide: jest.fn(),
-    getVisibilityStatus: jest.fn().mockResolvedValue('hidden'),
-}));


Do we no longer need it?

tests seem to pass without it so guessing whatever we needed it for we don't need it anymore.

Santhosh-Sellavel · 2022-10-25T19:47:37Z

tests/unit/NetworkTest.js

-// Set up manual mocks for methods used in the actions so our test does not fail.
-jest.mock('../../src/libs/Notification/PushNotification', () => ({
-    // There is no need for a jest.fn() since we don't need to make assertions against it.
-    register: () => {},
-    deregister: () => {},
-}));
-


Don't we need this anymore?

same as the other comment

Santhosh-Sellavel · 2022-10-25T21:41:43Z

Resolve conflicts

techievivek

Looks good. 🎉

Santhosh-Sellavel · 2022-10-26T18:42:24Z

Thanks, quick question @marcaaron shouldn't we capture this practice in markdown/docs?

Santhosh-Sellavel · 2022-10-26T18:46:40Z

Screenshots are not applicable here.

PR Reviewer Checklist

Looks good!
C+ Reviewed
🎀 👀 🎀

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:
- iOS / native
- Android / native
- iOS / Safari
- Android / Chrome
- MacOS / Chrome
- 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 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 was added in all src/languages/* files
- I verified any copy / text that was added to the app is correct English and 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 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 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.
I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

Santhosh-Sellavel

Looks good, just have a question here #12097 (comment)

marcaaron · 2022-10-26T19:19:57Z

shouldn't we capture this practice in markdown/docs?

Yeah I think that's a good idea. Let me add something.

Santhosh-Sellavel

Looks good, thanks!

melvin-bot · 2022-10-26T20:07:49Z

@techievivek looks like this was merged without the checklist test passing. Please add a note explaining why this was done and remove the Emergency label if this is not an emergency.

techievivek · 2022-10-26T20:08:26Z

Not an emergency, tests were passing.

OSBotify · 2022-10-26T20:12:39Z

✋ 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 · 2022-10-26T23:19:37Z

🚀 Deployed to staging by @techievivek in version: 1.2.20-0 🚀

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

OSBotify · 2022-10-28T02:24:19Z

🚀 Deployed to production by @chiragsalian in version: 1.2.20-3 🚀

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

marcaaron added 3 commits October 24, 2022 09:34

add manual mocks

733f8cf

mock more node_modules

48d6a9c

Clean up

2e73a6b

marcaaron requested a review from a team as a code owner October 24, 2022 20:00

marcaaron self-assigned this Oct 24, 2022

melvin-bot bot requested review from Santhosh-Sellavel and techievivek and removed request for a team October 24, 2022 20:00

Santhosh-Sellavel reviewed Oct 25, 2022

View reviewed changes

Fix conflicts

99308ef

marcaaron requested a review from Santhosh-Sellavel October 25, 2022 22:22

techievivek previously approved these changes Oct 26, 2022

View reviewed changes

Santhosh-Sellavel previously approved these changes Oct 26, 2022

View reviewed changes

add some documentation

53b16c1

marcaaron dismissed stale reviews from Santhosh-Sellavel and techievivek via 53b16c1 October 26, 2022 19:25

fix link

9c10fa9

Santhosh-Sellavel approved these changes Oct 26, 2022

View reviewed changes

techievivek approved these changes Oct 26, 2022

View reviewed changes

techievivek merged commit 523acdf into main Oct 26, 2022

techievivek deleted the marcaaron-fix-jest-mocks branch October 26, 2022 20:07

melvin-bot bot added the Emergency label Oct 26, 2022

techievivek removed the Emergency label Oct 26, 2022

OSBotify mentioned this pull request Oct 26, 2022

Deploy Checklist: New Expensify 2022-10-26 #12165

Closed

28 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[No QA] Clean up jest mocks #12097

[No QA] Clean up jest mocks #12097

marcaaron commented Oct 24, 2022 •

edited

Loading

Santhosh-Sellavel Oct 25, 2022

marcaaron Oct 25, 2022

Santhosh-Sellavel Oct 25, 2022

Santhosh-Sellavel Oct 25, 2022

marcaaron Oct 25, 2022

Santhosh-Sellavel commented Oct 25, 2022

techievivek left a comment

Santhosh-Sellavel commented Oct 26, 2022

Santhosh-Sellavel commented Oct 26, 2022

PR Reviewer Checklist

Santhosh-Sellavel left a comment

marcaaron commented Oct 26, 2022

Santhosh-Sellavel left a comment

melvin-bot bot commented Oct 26, 2022

techievivek commented Oct 26, 2022

OSBotify commented Oct 26, 2022

OSBotify commented Oct 26, 2022

OSBotify commented Oct 28, 2022

[No QA] Clean up jest mocks #12097

[No QA] Clean up jest mocks #12097

Conversation

marcaaron commented Oct 24, 2022 • edited Loading

Details

Fixed Issues

Tests

QA Steps

PR Review Checklist

PR Author Checklist

PR Reviewer Checklist

Screenshots

Web

Mobile Web - Chrome

Mobile Web - Safari

Desktop

iOS

Android

Santhosh-Sellavel Oct 25, 2022

Choose a reason for hiding this comment

marcaaron Oct 25, 2022

Choose a reason for hiding this comment

Santhosh-Sellavel Oct 25, 2022

Choose a reason for hiding this comment

Santhosh-Sellavel Oct 25, 2022

Choose a reason for hiding this comment

marcaaron Oct 25, 2022

Choose a reason for hiding this comment

Santhosh-Sellavel commented Oct 25, 2022

techievivek left a comment

Choose a reason for hiding this comment

Santhosh-Sellavel commented Oct 26, 2022

Santhosh-Sellavel commented Oct 26, 2022

PR Reviewer Checklist

Santhosh-Sellavel left a comment

Choose a reason for hiding this comment

marcaaron commented Oct 26, 2022

Santhosh-Sellavel left a comment

Choose a reason for hiding this comment

melvin-bot bot commented Oct 26, 2022

techievivek commented Oct 26, 2022

OSBotify commented Oct 26, 2022

OSBotify commented Oct 26, 2022

OSBotify commented Oct 28, 2022

marcaaron commented Oct 24, 2022 •

edited

Loading