fix: mock animation completion callback to trigger setState #17956

WoLewicki · 2023-04-25T09:23:08Z

Details

Fix the tests for navigation refactor by mocking InteractionManager's runAfterInteractions method so it triggers it's callback immediately, making the state change work correctly and showing the tested content. This method would normally be triggered after the native animation is completed, we would have to mock waiting for the animation end and more state changes, which I couldn't have achieved despite testing many approaches, so it seems easier to just run the callback immediately.

Fixed Issues

Related to #11768
PROPOSAL: GH_LINK_ISSUE(COMMENT)

Tests

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 / Chrome
- iOS / native
- iOS / 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 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 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 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 author checklist, including those that don't apply to this PR.

Screenshots/Videos

Web

There are no screenshots since those are jest tests, so there is no visual output for those kind of issues.

Mobile Web - Chrome

Mobile Web - Safari

Desktop

iOS

Android

MelvinBot · 2023-04-25T09:23:47Z

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

adamgrzybowski · 2023-04-25T09:43:10Z

cc @mountiny

tgolen · 2023-04-25T18:41:47Z

src/pages/home/sidebar/SidebarLinks.js

@@ -142,7 +142,7 @@ class SidebarLinks extends React.Component {

        return (
            <View
-                accessibilityElementsHidden={!this.props.isFocused}
+                isFocused={this.props.isFocused}


Is all this necessary for mocking jest? I can't imagine it is, so it's just strange to see these changes in this PR

accessibilityElementsHidden was used before both for checking the value in tests and probably to mock the navigation behavior of accessibility (see: https://github.com/react-navigation/react-navigation/blob/9fe34b445fcb86e5666f61e144007d7540f014fa/packages/stack/src/views/Stack/CardContainer.tsx#L242). If we still want to check if this route is focused or not, we need to keep a way of doing it. If you know a better way to do it, it would be great 😅

OK, that explains why accessibilityElementsHidden is there in the first place, but I guess I am still not quite understanding why it needs to change from accessibilityElementsHidden to isFocused. We can't keep the original way, or it's not desired for some reason?

Hmm accessibilityElementsHidden should not be needed anymore, but we can keep it. I just wanted a prop that does not do anything so I didn't destroy any of the behaviors, but since the screen is not focused when this prop is set, it should all work just fine.

tgolen · 2023-04-25T18:42:54Z

tests/ui/UnreadIndicatorsTest.js

@@ -31,6 +31,14 @@ jest.setTimeout(30000);

 jest.mock('../../src/libs/Notification/LocalNotification');

+// we need to mock it for the ReportScreen to update its state immediately for tests to pass


Please be sure to capitalize the first word in every comment. Also, this comment is only a partial explanation of why the mocking is necessary. Can you please improve it so that it also says why the state isn't updating immediately in the first place and why the tests fail when it doesn't update immediately?

I just saw that we have a special file for adding the mocks to react-native, so I'll move this mock there. Should I add a comment there or maybe just in the PR?

Ah, thanks for moving it to the __mocks__ folder! Can you please add the comment there in the file?

mountiny

@WoLewicki Thanks for raising this PR, I agree with @tgolen comments.

Could you also always make sure you link the navigation refactor issue this is related to? I know this is a leftover from the previous PR but it would be great to have an issue linked for context. Thank you!

dont forget to fill in the checklist too and note why you are not adding any screenshots

mountiny · 2023-04-25T19:29:53Z

Reviewer Checklist

This is handling jest tests to work with the new Navigation architecture so there is nothing to test in the App

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

No screenshots, PR is changing automated tests.

Web

Mobile Web - Chrome

Mobile Web - Safari

Desktop

iOS

Android

WoLewicki · 2023-04-26T13:08:42Z

Ok, I answered the comments and updated the code and description. Could you take another look?

mountiny

Thank you @WoLewicki!

All yours @tgolen

tgolen

Looks great. Thank you!

OSBotify · 2023-06-06T22:04:55Z

🚀 Deployed to staging by https://github.com/tgolen in version: 1.3.25-1 🚀

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

isagoico · 2023-06-06T22:21:02Z

@mountiny @WoLewicki @tgolen Hello! Any QA needed for this PR?

OSBotify · 2023-06-08T17:39:38Z

🚀 Deployed to production by https://github.com/roryabraham in version: 1.3.25-8 🚀

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

fix: mock animation completion callback to trigger setState

2807556

WoLewicki requested a review from a team as a code owner April 25, 2023 09:23

melvin-bot bot requested review from tgolen and removed request for a team April 25, 2023 09:23

staszekscp approved these changes Apr 25, 2023

View reviewed changes

tgolen requested changes Apr 25, 2023

View reviewed changes

mountiny self-requested a review April 25, 2023 19:27

mountiny assigned WoLewicki Apr 25, 2023

mountiny reviewed Apr 25, 2023

View reviewed changes

fix: move InteractionManager mock to dedicated file

8be6a05

fix: restore old prop and add comment

bcbfccb

mountiny requested a review from tgolen April 26, 2023 21:15

mountiny approved these changes Apr 26, 2023

View reviewed changes

tgolen approved these changes Apr 26, 2023

View reviewed changes

tgolen merged commit f474545 into Expensify:navigation-refactor Apr 26, 2023

OSBotify mentioned this pull request Jun 6, 2023

Deploy Checklist: New Expensify 2023-06-06 #20312

Closed

31 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: mock animation completion callback to trigger setState #17956

fix: mock animation completion callback to trigger setState #17956

WoLewicki commented Apr 25, 2023 •

edited by mountiny

Loading

MelvinBot commented Apr 25, 2023

adamgrzybowski commented Apr 25, 2023

tgolen Apr 25, 2023

WoLewicki Apr 26, 2023

tgolen Apr 26, 2023

WoLewicki Apr 26, 2023

tgolen Apr 25, 2023

WoLewicki Apr 26, 2023

tgolen Apr 26, 2023

mountiny left a comment •

edited

Loading

mountiny commented Apr 25, 2023 •

edited

Loading

WoLewicki commented Apr 26, 2023

mountiny left a comment

tgolen left a comment

OSBotify commented Jun 6, 2023

isagoico commented Jun 6, 2023

OSBotify commented Jun 8, 2023

		@@ -31,6 +31,14 @@ jest.setTimeout(30000);

		jest.mock('../../src/libs/Notification/LocalNotification');

		// we need to mock it for the ReportScreen to update its state immediately for tests to pass

fix: mock animation completion callback to trigger setState #17956

fix: mock animation completion callback to trigger setState #17956

Conversation

WoLewicki commented Apr 25, 2023 • edited by mountiny Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

MelvinBot commented Apr 25, 2023

adamgrzybowski commented Apr 25, 2023

tgolen Apr 25, 2023

Choose a reason for hiding this comment

WoLewicki Apr 26, 2023

Choose a reason for hiding this comment

tgolen Apr 26, 2023

Choose a reason for hiding this comment

WoLewicki Apr 26, 2023

Choose a reason for hiding this comment

tgolen Apr 25, 2023

Choose a reason for hiding this comment

WoLewicki Apr 26, 2023

Choose a reason for hiding this comment

tgolen Apr 26, 2023

Choose a reason for hiding this comment

mountiny left a comment • edited Loading

Choose a reason for hiding this comment

mountiny commented Apr 25, 2023 • edited Loading

Reviewer Checklist

Screenshots/Videos

WoLewicki commented Apr 26, 2023

mountiny left a comment

Choose a reason for hiding this comment

tgolen left a comment

Choose a reason for hiding this comment

OSBotify commented Jun 6, 2023

isagoico commented Jun 6, 2023

OSBotify commented Jun 8, 2023

WoLewicki commented Apr 25, 2023 •

edited by mountiny

Loading

mountiny left a comment •

edited

Loading

mountiny commented Apr 25, 2023 •

edited

Loading