-
Notifications
You must be signed in to change notification settings - Fork 517
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #3428 from artilleryio/feat/remove-playwright-dock…
…erfile chore: remove Playwright engine's Dockerfile
- Loading branch information
Showing
2 changed files
with
2 additions
and
204 deletions.
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,197 +1,5 @@ | ||
| # artillery-engine-playwright | ||
|
|
||
| <p align="center"> | ||
| <img src="./header.png" alt="Full browser load testing with Artillery + Playwright" width="1012"> | ||
| </p> | ||
| ⚠️ *This plugin is bundled into Artillery itself. Do not install it separately.* | ||
|
|
||
| <p align="center"> | ||
| Questions, comments, feedback? ➡️ <a href="https://github.com/artilleryio/artillery/discussions">Artillery Discussion Board</a> | ||
| </p> | ||
|
|
||
| ---- | ||
|
|
||
| Ever wished you could run load tests with *real browsers*? Well, now you can. | ||
|
|
||
| This Artillery engine lets you combine Playwright with Artillery to be able to launch *a whole lot of real browsers* to do *full browser load testing*. | ||
|
|
||
| <p align="center"> | ||
| <img src="https://www.artillery.io/img/blog/artillery-playwright-load-testing-browsers.gif" alt="demo" width="500"> | ||
| </p> | ||
|
|
||
|
|
||
| ## At a glance | ||
|
|
||
| * 🤖 Run load tests with real (headless) Chrome instances | ||
| * 🛰 Run synthetic checks in CICD with the same Artillery + Playwright scripts | ||
| * 📊 See most important front-end metrics ([Largest Contentful Paint (LCP)](https://web.dev/lcp/), [First Contentful Paint (FCP)](https://web.dev/fcp/) etc) and how they are affected by high load | ||
| * ♻️ Use Playwright for load testing (full access to [`page` API](https://playwright.dev/docs/api/class-page)) | ||
| * 🏎 Create new load testing scripts 10x faster with [`playwright codegen`](https://playwright.dev/docs/codegen-intro) | ||
| * 🌐 Launch thousands of browsers, with **zero** infrastructure setup with [Artillery Pro](https://artillery.io/pro) | ||
|
|
||
| ✨ *Perfect for testing complex web apps* ✨ | ||
|
|
||
| Read the official launch blog post here: [Launching 10,000 browsers for fun and profit](https://www.artillery.io/blog/load-testing-with-real-browsers) | ||
|
|
||
| ## Why load test with browsers? | ||
|
|
||
| Load testing complex web apps can be time consuming, cumbersome, and brittle compared to load testing pure APIs and backend services. The main reason is that testing web apps requires a different level of abstraction: whereas APIs work at **endpoint** level, when testing web apps a **page** is a much more useful abstraction. | ||
|
|
||
| Summarized in the table below: | ||
|
|
||
| | | APIs & microservices | Web apps | | ||
| --- | ----------- | ----------- | | ||
| **Abstraction level** | HTTP endpoint | Whole page | | ||
| **Surface area** | Small, a handful of endpoints | Large, calls many APIs. Different APIs may be called depending on in-page actions by the user | ||
| **Formal spec** | Usually available (e.g. as an OpenAPI spec) | No formal specs for APIs used and their dependencies. You have to spend time in Dev Tools to track down all API calls | ||
| **In-page JS** | Ignored. Calls made by in-page JS have to be accounted for manually and emulated | Runs as expected, e.g. making calls to more HTTP endpoints | | ||
|
|
||
| All of those factors combined make load testing web apps with traditional approaches very frustrating and time consuming. 😞 | ||
|
|
||
| ## Quickstart | ||
|
|
||
| Create an Artillery script using the engine: | ||
|
|
||
| `hello-world.yml`: | ||
|
|
||
| ```yaml | ||
| config: | ||
| target: https://www.artillery.io | ||
| # Enable the Playwright engine: | ||
| engines: | ||
| playwright: {} | ||
| processor: "./flows.js" | ||
| scenarios: | ||
| - engine: playwright | ||
| testFunction: "helloFlow" | ||
| ``` | ||
| Use a Playwright script to describe virtual user scenario: | ||
| (Note: this script was generated with [`playwright codegen`](https://playwright.dev/docs/cli/#generate-code). `page` is an instance of [Playwright page](https://playwright.dev/docs/api/class-page/).) | ||
|
|
||
| `flows.js`: | ||
|
|
||
| ```js | ||
| module.exports = { helloFlow }; | ||
| async function helloFlow(page) { | ||
| // | ||
| // The code below is just a standard Playwright script: | ||
| // | ||
| // Go to https://artillery.io/ | ||
| await page.goto('https://artillery.io/'); | ||
| // Click text=Pricing | ||
| await page.click('text=Pricing'); | ||
| // assert.equal(page.url(), 'https://artillery.io/pro/'); | ||
| // Click text=Sign up | ||
| await page.click('text=Sign up'); | ||
| } | ||
| ``` | ||
|
|
||
| Run it: | ||
|
|
||
| ```sh | ||
| artillery run hello-world.yml | ||
| ``` | ||
|
|
||
| Artillery runs Playwright-based scenarios, and provides user-centric metrics that measure [perceived load speed](https://web.dev/user-centric-performance-metrics/#types-of-metrics) such as LCP and FCP: | ||
|
|
||
| ``` | ||
| -------------------------------- | ||
| Summary report @ 11:24:53(+0100) | ||
| -------------------------------- | ||
|
|
||
| vusers.created_by_name.Dev account signup: .................. 1 | ||
| vusers.created.total: ....................................... 1 | ||
| vusers.completed: ........................................... 1 | ||
| vusers.session_length: | ||
| min: ...................................................... 5911.7 | ||
| max: ...................................................... 5911.7 | ||
| median: ................................................... 5944.6 | ||
| p95: ...................................................... 5944.6 | ||
| p99: ...................................................... 5944.6 | ||
| browser.page.domcontentloaded: .............................. 2 | ||
| browser.page.domcontentloaded.https://artillery.io/: ........ 1 | ||
| browser.page.domcontentloaded.https://artillery.io/pro/: .... 1 | ||
| browser.page.FCP.https://artillery.io/: | ||
| min: ...................................................... 1521.1 | ||
| max: ...................................................... 1521.1 | ||
| median: ................................................... 1525.7 | ||
| p95: ...................................................... 1525.7 | ||
| p99: ...................................................... 1525.7 | ||
| browser.page.dominteractive: | ||
| min: ...................................................... 162 | ||
| max: ...................................................... 1525 | ||
| median: ................................................... 162.4 | ||
| p95: ...................................................... 162.4 | ||
| p99: ...................................................... 162.4 | ||
| browser.page.dominteractive.https://artillery.io/: | ||
| min: ...................................................... 1525 | ||
| max: ...................................................... 1525 | ||
| median: ................................................... 1525.7 | ||
| p95: ...................................................... 1525.7 | ||
| p99: ...................................................... 1525.7 | ||
| browser.page.LCP.https://artillery.io/: | ||
| min: ...................................................... 1521.1 | ||
| max: ...................................................... 1521.1 | ||
| median: ................................................... 1525.7 | ||
| p95: ...................................................... 1525.7 | ||
| p99: ...................................................... 1525.7 | ||
| browser.page.dominteractive.https://artillery.io/pro/: | ||
| min: ...................................................... 162 | ||
| max: ...................................................... 162 | ||
| median: ................................................... 162.4 | ||
| p95: ...................................................... 162.4 | ||
| p99: ...................................................... 162.4 | ||
| browser.page.FCP.https://artillery.io/pro/: | ||
| min: ...................................................... 205.3 | ||
| max: ...................................................... 205.3 | ||
| median: ................................................... 206.5 | ||
| p95: ...................................................... 206.5 | ||
| p99: ...................................................... 206.5 | ||
| browser.page.LCP.https://artillery.io/pro/: | ||
| min: ...................................................... 205.3 | ||
| max: ...................................................... 205.3 | ||
| median: ................................................... 206.5 | ||
| p95: ...................................................... 206.5 | ||
| p99: ...................................................... 206.5 | ||
| ``` | ||
| ## Documentation | ||
| 📖 Please see the docs on [https://www.artillery.io/docs/reference/engines/playwright](https://www.artillery.io/docs/reference/engines/playwright) | ||
| ## More examples | ||
| See [Artillery + Playwright examples](https://github.com/artilleryio/artillery/tree/master/examples/browser-load-testing-playwright) in the main `artillery` repo. | ||
| ## Use in Docker/CI | ||
| Use the [`Dockerfile`](./Dockerfile) which bundles Chrome, Playwright and Artillery to run your tests in CI. | ||
| **Note:** To keep the Docker image small, browsers other than Chromium are removed (the saving is ~500MB) | ||
| ## Performance (Does it scale?) | ||
| When you run load tests with browsers your **main bottleneck** is going to be memory. Memory usage is what will limit how many Chrome instances can **run in parallel** in each VM/container. (Remember that every virtual user (VUs) will run its own copy of Chrome - just like in the real world.) | ||
| Two factors will determine how many VUs will be able to run in parallel: | ||
| 1. Memory usage of the pages that the VU navigates to and uses. Lightweight pages will mean each VU uses less memory while it's running. | ||
| 1. How long each VU runs for - the longer each session, the more VUs will be running at the same time, the higher memory usage will be. | ||
| The engine tracks a `browser.memory_used_mb` metric which shows the distribution of memory usage across all pages in each scenario (in megabytes). The value is read from [`window.performance.memory.usedJSHeapSize`](https://developer.mozilla.org/en-US/docs/Web/API/Performance/memory) API. The metric is recorded for every [`load` event](https://developer.mozilla.org/en-US/docs/Web/API/Window/load_event). | ||
| Ultimately, there is no formula to determine how many VUs can be supported on a given amount of memory unfortunately as it will depend on the application and VU scenario. The rule of thumb is to scale out horizontally and run with as much memory as possible and track VU session length and memory usage of Chrome to be able to tweak the number of containers/VMs running your tests. | ||
| ## Questions, comments, feedback? | ||
| ➡️ Let us know via <a href="https://github.com/artilleryio/artillery/discussions">Artillery Discussion board</a> | ||
| ---- | ||
| ## License 📃 | ||
| MPL 2.0 | ||
| https://github.com/artilleryio/artillery/tree/main/packages/artillery |