[No QA]Separate e2e test runs #29656

ospfranco · 2023-10-16T07:36:15Z

Details

We are attempting to reduce variance on e2e tests by separating the runs of the main (baseline) and any delta branch by queueing two separate AWS Device Farm runs.

Currently e2e have to much variance, reporting performance regressions on innocuous changes. After some testing, it was shown that there is a memory leak somewhere (maybe RN itself? found this issue over the weekend). Therefore running subsequent tests on the same device/session causes a performance regression that has nothing to do with the App code.

This is one alternative where we separate the runs on two AWS DF sessions, each with a brand new rebooted device. With the hope they will decay/regress at the same rate and therefore eliminate some of the variance in case the changes do not have a regression themselves.

Internal discussion here:

https://expensify.slack.com/archives/C05LX9D6E07/p1697185949611829

Fixed Issues

$ #29660

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: mWeb Chrome
- iOS: Native
- iOS: mWeb 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 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
  - 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
- If we are not using the full Onyx data that we loaded, I've added the proper selector in order to ensure the component only re-renders when the data it is using changes
- 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 author 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

…results

# Conflicts: # .github/workflows/e2ePerformanceTests.yml

melvin-bot · 2023-10-16T07:36:56Z

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

nkuoch · 2023-10-16T07:56:05Z

PR description to update

melvin-bot · 2023-10-16T09:07:35Z

npm has a package.json file and a package-lock.json file. It seems you updated one without the other, which is usually a sign of a mistake. If you are updating a package make sure that you update the version in package.json then run npm install

AndrewGable · 2023-10-16T19:10:41Z

Going to push to my own branch as we can't run the tests on a fork.

…ilds

…/separate-test-runs

AndrewGable · 2023-10-23T15:36:43Z

.tool-versions

@@ -0,0 +1 @@
+nodejs 16.15.1


Why is this required? We have this in package.json

ah, sorry. I use ASDF to handle per-project environments. That way I don't have to switch installs or use multiple tools (nvm, ruby-env, etc). This is just a file that describes which version is needed.

Let's remove, we use and recommend nvm: https://github.com/Expensify/App#getting-started

AndrewGable · 2023-10-23T15:37:26Z

package.json

@@ -49,7 +49,9 @@
    "analyze-packages": "ANALYZE_BUNDLE=true webpack --config config/webpack/webpack.common.js --env envFile=.env.production",
    "symbolicate:android": "npx metro-symbolicate android/app/build/generated/sourcemaps/react/release/index.android.bundle.map",
    "symbolicate:ios": "npx metro-symbolicate main.jsbundle.map",
-    "test:e2e": "node tests/e2e/testRunner.js --development",
+    "test:e2e:main": "node tests/e2e/testRunner.js --development --branch main --skipCheckout",


Why have branch as a param if it's always main?

Remnant of local testing. Doesn't really matter, doesn't change the behavior of the testing script.

AndrewGable · 2023-10-23T15:39:48Z

tests/e2e/config.js


    ENTRY_FILE: 'src/libs/E2E/reactNativeLaunchingTest.js',

    // The port of the testing server that communicates with the app
    SERVER_PORT: 4723,

    // The amount of times a test should be executed for average performance metrics
-    RUNS: 90,
+    RUNS: 30,


Can we try 60 as a middle ground?

AndrewGable · 2023-10-23T15:40:19Z

tests/e2e/manually_trigger_aws_df.sh

+
+set -ex
+
+PROJECT_ARN=arn:aws:devicefarm:us-west-2:015174472939:project:741d1dac-84e7-4c6f-84ed-b41a2209319d


Assume this was a testing script we want to remove?

AndrewGable · 2023-10-23T15:41:13Z

tests/e2e/utils/execAsync.js

@@ -1,40 +1,52 @@
-const {exec} = require('node:child_process');
+const {exec} = require('child_process');
+// const _ = require('underscore');


Remove line if its no longer needed

AndrewGable · 2023-10-23T15:41:26Z

tests/e2e/utils/execAsync.js

+        // if (_.keys(env).length !== 0) {
+        //     Logger.log(`environment variables:`, JSON.stringify(finalEnv, null, 2));
+        // }


Suggested change

// if (_.keys(env).length !== 0) {

// Logger.log(`environment variables:`, JSON.stringify(finalEnv, null, 2));

// }

AndrewGable · 2023-10-23T17:27:06Z

.github/workflows/e2ePerformanceTests.yml

+
+      - name: Check if test failed, if so post the results and add the DeployBlocker label
+        run: |
+          if grep -q '🔴' ./Host_Machine_Files/\$WORKING_DIRECTORY/output.md; then


Is this directory correct? Or should it just be ./output.md?

You are right, should be ./output.md

AndrewGable · 2023-10-23T18:01:48Z

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

Web

N/A - Tests only

Mobile Web - Chrome

N/A - Tests only

Mobile Web - Safari

N/A - Tests only

Desktop

N/A - Tests only

iOS

N/A - Tests only

Android

N/A - Tests only

OSBotify · 2023-10-23T18:11:55Z

✋ 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-10-24T01:59:59Z

🚀 Deployed to staging by https://github.com/AndrewGable in version: 1.3.90-0 🚀

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

OSBotify · 2023-10-25T16:36:53Z

🚀 Deployed to production by https://github.com/marcaaron in version: 1.3.90-2 🚀

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

OSBotify · 2023-10-25T17:01:41Z

🚀 Deployed to staging by https://github.com/AndrewGable in version: 1.3.91-0 🚀

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

OSBotify · 2023-10-26T22:43:42Z

🚀 Deployed to production by https://github.com/marcaaron in version: 1.3.91-8 🚀

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

ospfranco added 2 commits October 16, 2023 09:33

Run main and delta tests in different AWS device farm runs and merge …

4f35243

…results

Merge branch 'main' into osp/separate-test-runs

e40a174

# Conflicts: # .github/workflows/e2ePerformanceTests.yml

ospfranco requested a review from a team as a code owner October 16, 2023 07:36

melvin-bot bot requested review from nkuoch and removed request for a team October 16, 2023 07:36

mountiny requested a review from AndrewGable October 16, 2023 09:04

mountiny assigned ospfranco Oct 16, 2023

ospfranco and others added 19 commits October 17, 2023 07:52

Update paths and restore file_artifacts on aws step

86c5d71

Only delete json result file if it exists

073ea41

Re-insert deleting the output container

a357848

Handle skip checkout flag to avoid git operation on CI

8944963

Revert Customer Artifacts.zip

d1531a0

Update script to make it a bit more undestandable and run in local bu…

a855c92

…ilds

Handle not passing branch name

5861ca7

Move variable configuration to top of file

38d4b88

Update config.local and fix detected appPath

8fb3826

Update configs

61ae5b7

Logs improvements

8df571c

Correct paths on when running merge script

78d1e5f

use traditional child_process import

ccae18e

fix node setup

95cc214

Merge branch 'main' of github.com:margelo/expensify-app-fork into osp…

cf86f38

…/separate-test-runs

Install underscore

175cd23

Remove underscore step

b095730

Move buildMode param below dev flag setting

2cf1f75

add env variable to asyncExec

4900518

hannojg and others added 11 commits October 19, 2023 18:28

add logging for replacing mock API

809355f

Add more logs to metro config

fb4b503

test: skip checking out release version

744323a

Remove check for previous artifacts

57db0ac

Do not use extended name on generated baseline apk

7b245f4

Simple script to trigger an aws device farm run

5a90797

Remove logging on replaced paths

bbcad66

Fix name of download in baseline apk

301221f

correct actions for e2e workflow

4fcdc0c

Restore generated artifact name

fd5c610

ADd version tag to Download baseline APK step

2e73a3f

AndrewGable reviewed Oct 23, 2023

View reviewed changes

PR comments

5653b5d

AndrewGable reviewed Oct 23, 2023

View reviewed changes

Change path of output file on printing error results to github

6c6061f

AndrewGable changed the title ~~Separate e2e test runs~~ [No QA]Separate e2e test runs Oct 23, 2023

AndrewGable approved these changes Oct 23, 2023

View reviewed changes

AndrewGable merged commit c50054a into Expensify:main Oct 23, 2023
15 checks passed

AndrewGable deleted the osp/separate-test-runs branch October 23, 2023 18:06

AndrewGable mentioned this pull request Oct 23, 2023

[WIP]Andrew e2e split #29707

Merged

59 tasks

OSBotify mentioned this pull request Oct 24, 2023

Deploy Checklist: New Expensify 2023-10-24 #30224

Closed

43 tasks

melvin-bot bot mentioned this pull request Oct 25, 2023

[HOLD for payment 2023-11-21] [HOLD for payment 2023-11-09] [HOLD for payment 2023-11-01] Improve the reliability of the E2E testing suite #29660

Closed

OSBotify mentioned this pull request Oct 25, 2023

Deploy Checklist: New Expensify 2023-10-25 #30365

Closed

99 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[No QA]Separate e2e test runs #29656

[No QA]Separate e2e test runs #29656

ospfranco commented Oct 16, 2023 •

edited by AndrewGable

Loading

melvin-bot bot commented Oct 16, 2023

nkuoch commented Oct 16, 2023

melvin-bot bot commented Oct 16, 2023

AndrewGable commented Oct 16, 2023

AndrewGable Oct 23, 2023

ospfranco Oct 23, 2023

AndrewGable Oct 23, 2023

AndrewGable Oct 23, 2023

ospfranco Oct 23, 2023

AndrewGable Oct 23, 2023

ospfranco Oct 23, 2023

AndrewGable Oct 23, 2023

ospfranco Oct 23, 2023

AndrewGable Oct 23, 2023

AndrewGable Oct 23, 2023

AndrewGable Oct 23, 2023

ospfranco Oct 23, 2023

AndrewGable commented Oct 23, 2023 •

edited

Loading

OSBotify commented Oct 23, 2023

OSBotify commented Oct 24, 2023

OSBotify commented Oct 25, 2023

OSBotify commented Oct 25, 2023

OSBotify commented Oct 26, 2023


		set -ex

		PROJECT_ARN=arn:aws:devicefarm:us-west-2:015174472939:project:741d1dac-84e7-4c6f-84ed-b41a2209319d

	// if (_.keys(env).length !== 0) {
	// Logger.log(`environment variables:`, JSON.stringify(finalEnv, null, 2));
	// }

[No QA]Separate e2e test runs #29656

[No QA]Separate e2e test runs #29656

Conversation

ospfranco commented Oct 16, 2023 • edited by AndrewGable Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Oct 16, 2023

nkuoch commented Oct 16, 2023

melvin-bot bot commented Oct 16, 2023

AndrewGable commented Oct 16, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

AndrewGable commented Oct 23, 2023 • edited Loading

Reviewer Checklist

Screenshots/Videos

OSBotify commented Oct 23, 2023

OSBotify commented Oct 24, 2023

OSBotify commented Oct 25, 2023

OSBotify commented Oct 25, 2023

OSBotify commented Oct 26, 2023

ospfranco commented Oct 16, 2023 •

edited by AndrewGable

Loading

AndrewGable commented Oct 23, 2023 •

edited

Loading