[NoQA] dev: improve e2e tests DX #37008

hannojg · 2024-02-21T10:30:48Z

Details

I changed a few things to increase the DX of the e2e tests (because right now it's kinda hard to work with it).

Improve logging

While improving the stability of the e2e tests I noticed that the logging was not the best it could be. I was debugging an issue and the log file I got from AWS looked like this (the test failed, but it printed it succeeded. Its hard to read that log in general as it contains some weird characters and the formatting is off):

Example of a previous log:

or here is an example where we would have pages long the same log lines:

Also its missing timestamps, which makes it hard to connect events from different logs.

Example of a new log:

I cleaned up the logging utilities, made it easier to understand, and now a output looks like this:

Also the log file is now in better shape, containing no weird chars, long line breaks, or endless logs of the same:

Remove unused code

There was a lot of code which no-one really seemed to use, and which made understanding the logic in the testRunner module harder to understand.

Before the testRunner was containing a lot of logic for build the app. In reality the developer or CI system is building the app before conducting any e2e tests, so that logic was never really used.

Due to that the code of the testRunner went from 439 loc to 249 loc.

Update documentation

As I removed a lot of code I updated the documentation to reflect the latest state of the e2e tests.

Fixed Issues

$
PROPOSAL:

Tests

Dev/CI only change, no tests needed.

Offline tests

QA Steps

Dev/CI only change, no tests needed.

PR Author Checklist

Screenshots/Videos

Dev/CI only change, no screenshots needed.

Android: Native

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

…test-runner-suite-logging

melvin-bot · 2024-02-21T14:33:12Z

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

melvin-bot · 2024-02-21T14:41:42Z

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

mountiny · 2024-02-21T14:41:52Z

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(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 form input styles:
- I verified that all the inputs inside a form are aligned with each other.
- I added Design label 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

looks good to me, thanks for testing locally

@AndrewGable all yours

OSBotify · 2024-02-21T16:24:58Z

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

VickyStash · 2024-02-22T08:46:39Z

tests/e2e/utils/logger.js

-            error(`\r❌ ${text} ${getTimeText()}\n`);
-        },
-    };
+module.exports = {


@hannojg What was the reason of changing es6 export with module.exports?

I have a TS check failing in one of my Draft PRs after this update, so I want to make sure if it was on a purpose or just by accident

Oh I think that happened by accidence, Feel free to change back to es6 export !

OSBotify · 2024-02-26T21:10:29Z

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

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

OSBotify · 2024-02-28T23:59:05Z

🚀 Deployed to production by https://github.com/puneetlath in version: 1.4.44-13 🚀

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

hannojg added 8 commits February 16, 2024 18:24

wip

396f62c

reduce logging noise

9065540

Merge branch 'main' of github.com:Expensify/App into dev/improve-e2e-…

a5de092

…test-runner-suite-logging

remove more unused code

3838200

fix scripts

82352fd

fixing logger

a48e49b

massively simply logging in e2e tests

36338e8

simplify trim logic

061fcdb

hannojg changed the title ~~dev: improve e2e tests~~ dev: improve e2e tests DX Feb 21, 2024

hannojg added 2 commits February 21, 2024 15:19

Update test readme

443c58e

docs update

455400e

hannojg marked this pull request as ready for review February 21, 2024 14:32

hannojg requested a review from a team as a code owner February 21, 2024 14:32

melvin-bot bot requested review from grgia and removed request for a team February 21, 2024 14:33

mountiny requested a review from AndrewGable February 21, 2024 14:41

mountiny changed the title ~~dev: improve e2e tests DX~~ [NoQA] dev: improve e2e tests DX Feb 21, 2024

mountiny assigned hannojg Feb 21, 2024

mountiny approved these changes Feb 21, 2024

View reviewed changes

AndrewGable approved these changes Feb 21, 2024

View reviewed changes

AndrewGable merged commit a6c1847 into Expensify:main Feb 21, 2024
20 of 21 checks passed

VickyStash reviewed Feb 22, 2024

View reviewed changes

github-actions bot mentioned this pull request Feb 26, 2024

Deploy Checklist: New Expensify 2024-02-26 #37224

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[NoQA] dev: improve e2e tests DX #37008

[NoQA] dev: improve e2e tests DX #37008

hannojg commented Feb 21, 2024 •

edited

Loading

melvin-bot bot commented Feb 21, 2024

melvin-bot bot commented Feb 21, 2024

mountiny commented Feb 21, 2024 •

edited

Loading

mountiny left a comment

OSBotify commented Feb 21, 2024

VickyStash Feb 22, 2024

VickyStash Feb 22, 2024

hannojg Feb 22, 2024

OSBotify commented Feb 26, 2024

OSBotify commented Feb 28, 2024

[NoQA] dev: improve e2e tests DX #37008

[NoQA] dev: improve e2e tests DX #37008

Conversation

hannojg commented Feb 21, 2024 • edited Loading

Details

Improve logging

Remove unused code

Update documentation

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Feb 21, 2024

melvin-bot bot commented Feb 21, 2024

mountiny commented Feb 21, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

mountiny left a comment

Choose a reason for hiding this comment

OSBotify commented Feb 21, 2024

VickyStash Feb 22, 2024

Choose a reason for hiding this comment

VickyStash Feb 22, 2024

Choose a reason for hiding this comment

hannojg Feb 22, 2024

Choose a reason for hiding this comment

OSBotify commented Feb 26, 2024

OSBotify commented Feb 28, 2024

hannojg commented Feb 21, 2024 •

edited

Loading

mountiny commented Feb 21, 2024 •

edited

Loading