[NoQA] e2e: terminate app only when all network requests were finished #43038

kirillzyusko · 2024-06-04T15:09:32Z

Details

A follow-up for #42991

In #42991 we've decided to fix the problem by reinstalling the app. It indeed fixes the problem, but after a talk with @hannojg we've came to conclusion, that original design is to cache all network requests before actual test execution (so our queue shouldn't keep growing).

Below is a breakdown why we have a growing queue:

When we do our first warm up - we don't send ReconnectApp - instead we send OpenApp and we get cache for this endpoint (this is the logic in app to send OpenApp instead of ReconnectApp I believe).

When our first test gets executed -> we send ReconnectApp, our cache is empty, we put a real HTTP request. Its execution is too long, so we don't remove it from the queue, because test execution is faster, so by the end of first test suite we have N requests in a queue)

To fix this problem I decided:

always run test two times (so that both OpenApp and ReconnectApp gets cached) - it's not mandatory but I decided to be consistent;
we terminate app only when there is no active requests (actual for warmup stage - for a real execution we read all values from cache so this function doesn't bring a big delay).

It reminds a first approach that I took in #42991 but we don't add client code and we make tests execution as it was originally designed.

Fixed Issues

$ #42987 #42163
PROPOSAL: N/A

Tests

run e2e pipeline from this PR and it should be 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-04T15:09:38Z

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

hannojg

some considerations, but overall lgtm!

src/libs/E2E/tests/chatOpeningTest.e2e.ts

hannojg · 2024-06-04T17:12:18Z

tests/e2e/config.ts

@@ -68,7 +68,6 @@ export default {
    TESTS_CONFIG: {
        [TEST_NAMES.AppStartTime]: {
            name: TEST_NAMES.AppStartTime,
-            warmupRuns: 1,


is it correct that we removed that here? if so, why?

@hannojg because on first app start we call OpenApp endpoint, but when we run app the second time we call ReconnectApp (and there is no cache for ReconnectApp).

Technically it doesn't make such big difference (for this particular test), because we'll update cache second time and it will not affect test results. But I thought it could be better to be consistent and run warmup for all tests two times.

s77rt · 2024-06-04T20:31:11Z

Testing locally the app is stuck at the login flow but that's probably just me. Other than that this does not seem to need a C+ review. Let me know otherwise

hannojg · 2024-06-05T09:11:54Z

LGTM now! 😊

hannojg · 2024-06-17T04:32:42Z

@mountiny can you help us getting this merged? Thanks! 😊

mountiny · 2024-06-17T11:01:23Z

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

OSBotify · 2024-06-17T17:50:25Z

✋ 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-17T23:47:38Z

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

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

OSBotify · 2024-06-18T00:05:04Z

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

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

OSBotify · 2024-06-18T16:01:49Z

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

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

OSBotify · 2024-06-21T16:48:39Z

🚀 Deployed to production by https://github.com/AndrewGable in version: 1.4.85-7 🚀

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

e2e: terminate app only when all network requests were finished

25cecda

kirillzyusko requested a review from a team as a code owner June 4, 2024 15:09

melvin-bot bot requested review from s77rt and removed request for a team June 4, 2024 15:09

hannojg reviewed Jun 4, 2024

View reviewed changes

chore: changes after review

f985b24

kirillzyusko changed the title ~~e2e: terminate app only when all network requests were finished~~ [NoQA] e2e: terminate app only when all network requests were finished Jun 6, 2024

mountiny assigned kirillzyusko Jun 17, 2024

mountiny self-requested a review June 17, 2024 11:01

Merge branch 'main' into e2e/terminate-app-only-when-no-active-requests

fae2bf2

mountiny approved these changes Jun 17, 2024

View reviewed changes

mountiny merged commit 2ac6dd6 into Expensify:main Jun 17, 2024
16 checks passed

github-actions bot mentioned this pull request Jun 17, 2024

Deploy Checklist: New Expensify 2024-06-17 #43871

Closed

44 tasks

melvin-bot bot mentioned this pull request Jun 21, 2024

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

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[NoQA] e2e: terminate app only when all network requests were finished #43038

[NoQA] e2e: terminate app only when all network requests were finished #43038

kirillzyusko commented Jun 4, 2024 •

edited

Loading

melvin-bot bot commented Jun 4, 2024

hannojg left a comment

hannojg Jun 4, 2024

kirillzyusko Jun 5, 2024

s77rt commented Jun 4, 2024

hannojg commented Jun 5, 2024

hannojg commented Jun 17, 2024

mountiny commented Jun 17, 2024 •

edited

Loading

OSBotify commented Jun 17, 2024

OSBotify commented Jun 17, 2024

OSBotify commented Jun 18, 2024

OSBotify commented Jun 18, 2024

OSBotify commented Jun 21, 2024

[NoQA] e2e: terminate app only when all network requests were finished #43038

[NoQA] e2e: terminate app only when all network requests were finished #43038

Conversation

kirillzyusko commented Jun 4, 2024 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Jun 4, 2024

hannojg left a comment

Choose a reason for hiding this comment

hannojg Jun 4, 2024

Choose a reason for hiding this comment

kirillzyusko Jun 5, 2024

Choose a reason for hiding this comment

s77rt commented Jun 4, 2024

hannojg commented Jun 5, 2024

hannojg commented Jun 17, 2024

mountiny commented Jun 17, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

OSBotify commented Jun 17, 2024

OSBotify commented Jun 17, 2024

OSBotify commented Jun 18, 2024

OSBotify commented Jun 18, 2024

OSBotify commented Jun 21, 2024

kirillzyusko commented Jun 4, 2024 •

edited

Loading

mountiny commented Jun 17, 2024 •

edited

Loading