fix: comment linking e2e test by kirillzyusko · Pull Request #43986 · Expensify/App

kirillzyusko · 2024-06-19T12:01:58Z

Details

Fixed flaky comment linking test.

Caution

Even after merging this PR CI still may fail, because for main variant it will use a version from latest release and this version will not have changes from this PR.

The original problem was in the order of onLayout/onViewableItemsChanged events. Typically onViewableItemsChanged was firing first, then onLayout produced an expected measurement and after 3s we were reading data that was sent in onViewableItemsChanged.

But if we read this data and it is missing, then our test just hangs and then fails due to timeout restriction (I think it again can happen because of the fact that this test is executed in last order and the phone may be overheated and CPU can be slightly throttling).

In this PR I re-worked an approach and now we:

don't use hardcoded interval - instead of that we emit and subscribe to events;
listen to events simultaneously and finish test only when both events (measurement + visible item) arrived.

After these changes I re-assembled both apps and run test (also put my device to direct sun beams and put a case on it - in this case it overheats much faster). I could successfully pass all 4 test suite 3 times, so I think it's stable now (before I was getting the error on the hals of the first execution).

Fixed Issues

$ #43972
$ #43941
$ #43928
PROPOSAL: N/A

Tests

run e2e pipeline and be sure that it's green;

Offline tests

N/A

QA Steps

N/A

PR Author Checklist

Screenshots/Videos

Android: Native

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

melvin-bot · 2024-06-19T12:02:03Z

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

kirillzyusko · 2024-06-19T12:09:15Z

Tagging @perunt for review since he wrote this test originally 👀

perunt

Test passed. I have only one question about the deprecated DeviceEventEmitter, but I see we're already using it in the codebase

perunt · 2024-06-19T12:40:43Z

 import React, {forwardRef, useMemo} from 'react';
 import type {FlatListProps, ScrollViewProps, ViewToken} from 'react-native';
-import {FlatList} from 'react-native';
+import {DeviceEventEmitter, FlatList} from 'react-native';


DeviceEventEmitter is deprecated, but we can use NativeEventEmitter instead

Yeah, currently we don't use NativeEventEmitter anywhere in the codebase, so I think now it's better to keep DeviceEventEmitter and later (when needed) we can re-work all code pieces at once.

perunt · 2024-06-19T12:57:17Z

+                console.debug('[E2E] Error while submitting test results:', err);
+            });
+
+        const subscription = DeviceEventEmitter.addListener('onViewableItemsChanged', (res) => {


Would it fire when we open the first chat? It looks like it would, so we can skip it or change the log '[E2E] Message verification failed,' as it may look like an error, but it would be expected behavior since we only want to check it for entry.name === SWITCH_REPORT

mountiny · 2024-06-19T15:34:59Z

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

mountiny

changes look good to me, thanks

OSBotify · 2024-06-19T15:56:28Z

✋ 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 · 2024-06-19T21:53:55Z

🚀 Deployed to staging by https://github.com/mountiny in version: 1.4.86-0 🚀

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

OSBotify · 2024-06-19T22:18:37Z

🚀 Deployed to staging by https://github.com/mountiny in version: 1.4.86-0 🚀

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

OSBotify · 2024-06-19T22:52:36Z

🚀 Deployed to staging by https://github.com/mountiny in version: 1.4.86-0 🚀

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

OSBotify · 2024-06-21T21:23:14Z

🚀 Deployed to production by https://github.com/AndrewGable in version: 9.0.0-9 🚀

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

fix: comment linking e2e test

55973ec

kirillzyusko requested a review from a team as a code owner June 19, 2024 12:01

melvin-bot Bot requested review from ikevin127 and removed request for a team June 19, 2024 12:02

mountiny assigned kirillzyusko Jun 19, 2024

perunt approved these changes Jun 19, 2024

View reviewed changes

fix: changes after review

ccece49

mountiny approved these changes Jun 19, 2024

View reviewed changes

mountiny merged commit de66757 into Expensify:main Jun 19, 2024

marcaaron mentioned this pull request Jun 19, 2024

[HOLD for payment 2024-06-28] Investigate workflow job failing on main: e2ePerformanceTests / Run E2E tests in AWS device farm #43972

Closed

srikarparsi mentioned this pull request Jun 19, 2024

Investigate workflow job failing on main: e2ePerformanceTests / Run E2E tests in AWS device farm #44024

Closed

github-actions Bot mentioned this pull request Jun 19, 2024

Deploy Checklist: New Expensify 2024-06-19 #44047

Closed

59 tasks

Uh oh!

Conversation

kirillzyusko commented Jun 19, 2024 • edited by mountiny Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

Uh oh!

melvin-bot Bot commented Jun 19, 2024

Uh oh!

kirillzyusko commented Jun 19, 2024

Uh oh!

perunt left a comment

Choose a reason for hiding this comment

Uh oh!

perunt Jun 19, 2024

Choose a reason for hiding this comment

Uh oh!

kirillzyusko Jun 19, 2024

Choose a reason for hiding this comment

Uh oh!

perunt Jun 19, 2024

Choose a reason for hiding this comment

Uh oh!

mountiny commented Jun 19, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer Checklist

Screenshots/Videos

Uh oh!

mountiny left a comment

Choose a reason for hiding this comment

Uh oh!

OSBotify commented Jun 19, 2024

Uh oh!

OSBotify commented Jun 19, 2024

Uh oh!

OSBotify commented Jun 19, 2024

Uh oh!

OSBotify commented Jun 19, 2024

Uh oh!

OSBotify commented Jun 21, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

kirillzyusko commented Jun 19, 2024 •

edited by mountiny

Loading

mountiny commented Jun 19, 2024 •

edited

Loading