[NoQA] Add sleep cooldowns to e2e tests #30635

ospfranco · 2023-10-31T14:47:46Z

Details

We are still seeing potentially flaky results on the e2e tests. Our tests on a local device, have shown there is a lot of variance due to thermal throttling. We also discovered that killing the app and immediately starting it again would cause a warm boot instead of a cold boot, which seems to skew the numbers and add a greater variance to the results.

Before doing another major refactoring of the tests, we decided to give sleep cooldowns a try.

a) Add a large cooldown period at the beginning of each test suite, such as limiting the variance of heat build-up from our own runs but at the same time from any previous run on the device in the device farm.

b) A smaller cooldown between tests should help the phone clear caches and do a cold boot, thus eliminating caching variance and limiting the effects of thermal throttling.

In our tests, these cooldowns cut down the standard deviation of the tests in half. So we expect to see flakiness on the production system also go down. As a side note, the reported TTI/bundle load time also went up, but this is an artifact of previously measuring warm boots, instead of cold boots.

Fixed Issues

$
PROPOSAL:

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

Screenshots/Videos

Android: Native

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

melvin-bot · 2023-10-31T14:48:24Z

@aldo-expensify 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]

ospfranco · 2023-10-31T14:53:46Z

tests/e2e/testRunner.js

+        const coolDownLogs = Logger.progressInfo(`Cooling down for ${config.COOL_DOWN / 1000}s`);
+        coolDownLogs.updateText(`Cooling down for ${config.COOL_DOWN / 1000}s`);
+
+        await sleep(config.BOOT_COOL_DOWN);


Having the cooldown right at the beginning should hopefully lower the chances of heat throttling from the previous run (which we have no control over and will be a completely different AWS DF customer/app). It also gives the time to cool down between test suites.

ospfranco · 2023-10-31T14:54:27Z

tests/e2e/testRunner.js

+            await killApp('android', config.APP_PACKAGE);
+
+            testLog.updateText(`Coolin down phone 🧊 ${config.SUITE_COOL_DOWN / 1000}s\n`);
+            await sleep(config.SUITE_COOL_DOWN);


Adding the cool down between booting the app again, had the side-effect of actually causing a cold boot, which increased TTI/bundle load JS times significantly but also stabilized standard deviation.

tests/e2e/testRunner.js

Co-authored-by: Aldo Canepa Garay <[email protected]>

mountiny

Coming from here this seems to have helped so going to merge this

mountiny · 2023-11-01T10:39:39Z

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 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 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 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 · 2023-11-01T10:46:34Z

✋ 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 · 2023-11-02T10:38:17Z

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

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

OSBotify · 2023-11-06T22:08:20Z

🚀 Deployed to production by https://github.com/puneetlath in version: 1.3.95-9 🚀

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

OSBotify · 2023-11-06T22:35:40Z

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

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

OSBotify · 2023-11-09T22:53:13Z

🚀 Deployed to production by https://github.com/puneetlath in version: 1.3.96-15 🚀

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

ospfranco added 4 commits October 31, 2023 13:14

Move sleep to beginning of each test

071bacb

Add cooldown between tests

0682682

Allow sleep between runs

f8acc3c

Modify runs and cooldowns

5da00d1

ospfranco requested a review from a team as a code owner October 31, 2023 14:47

melvin-bot bot requested review from aldo-expensify and removed request for a team October 31, 2023 14:48

Remove ESLINT comment

9a8800d

ospfranco commented Oct 31, 2023

View reviewed changes

ospfranco added 2 commits October 31, 2023 15:54

Remove modified package script

0bf5289

Add code comments

2af3d61

AndrewGable self-requested a review October 31, 2023 15:05

Increate timeout to AWS DF action

c6adba2

aldo-expensify reviewed Oct 31, 2023

View reviewed changes

tests/e2e/testRunner.js Outdated Show resolved Hide resolved

Update tests/e2e/testRunner.js

4a2e3eb

Co-authored-by: Aldo Canepa Garay <[email protected]>

mountiny changed the title ~~Add sleep cooldowns to e2e tests~~ [NoQ] Add sleep cooldowns to e2e tests Nov 1, 2023

mountiny changed the title ~~[NoQ] Add sleep cooldowns to e2e tests~~ [NoQA] Add sleep cooldowns to e2e tests Nov 1, 2023

mountiny approved these changes Nov 1, 2023

View reviewed changes

mountiny merged commit a6b0b54 into Expensify:main Nov 1, 2023

OSBotify mentioned this pull request Nov 2, 2023

Deploy Checklist: New Expensify 2023-11-02 #30752

Closed

OSBotify mentioned this pull request Nov 6, 2023

Deploy Checklist: New Expensify 2023-11-06 #30929

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[NoQA] Add sleep cooldowns to e2e tests #30635

[NoQA] Add sleep cooldowns to e2e tests #30635

ospfranco commented Oct 31, 2023 •

edited

Loading

melvin-bot bot commented Oct 31, 2023

ospfranco Oct 31, 2023

ospfranco Oct 31, 2023

mountiny left a comment

mountiny commented Nov 1, 2023 •

edited

Loading

OSBotify commented Nov 1, 2023

OSBotify commented Nov 2, 2023

OSBotify commented Nov 6, 2023

OSBotify commented Nov 6, 2023

OSBotify commented Nov 9, 2023

[NoQA] Add sleep cooldowns to e2e tests #30635

[NoQA] Add sleep cooldowns to e2e tests #30635

Conversation

ospfranco commented Oct 31, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Oct 31, 2023

ospfranco Oct 31, 2023

Choose a reason for hiding this comment

ospfranco Oct 31, 2023

Choose a reason for hiding this comment

mountiny left a comment

Choose a reason for hiding this comment

mountiny commented Nov 1, 2023 • edited Loading

Reviewer Checklist

Screenshots/Videos

OSBotify commented Nov 1, 2023

OSBotify commented Nov 2, 2023

OSBotify commented Nov 6, 2023

OSBotify commented Nov 6, 2023

OSBotify commented Nov 9, 2023

ospfranco commented Oct 31, 2023 •

edited

Loading

mountiny commented Nov 1, 2023 •

edited

Loading