Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ntrotner/playwright-performance-reporter
Report performance metrics by test step as an structured output
https://github.com/ntrotner/playwright-performance-reporter
e2e performance playwright playwright-typescript reporter typescript
Last synced: 10 days ago
JSON representation
Report performance metrics by test step as an structured output
- Host: GitHub
- URL: https://github.com/ntrotner/playwright-performance-reporter
- Owner: ntrotner
- License: mit
- Created: 2024-08-13T20:44:30.000Z (about 2 months ago)
- Default Branch: main
- Last Pushed: 2024-09-06T23:29:46.000Z (28 days ago)
- Last Synced: 2024-09-21T07:33:31.354Z (14 days ago)
- Topics: e2e, performance, playwright, playwright-typescript, reporter, typescript
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/playwright-performance-reporter
- Size: 350 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# playwright-performance-reporter
[](https://github.com/ntrotner/playwright-performance-reporter/actions/workflows/release.yml)
[](https://codecov.io/github/ntrotner/playwright-performance-reporter)
[](https://www.npmjs.com/package/playwright-performance-reporter)
> Metrics from the dev tools to measure performance
> [!CAUTION]
> This library is work in progress. The measurement is limited to Chromium and to a primitive test suite.
> Complex test suites/cases were not considered, which will be supported down the line.
> On the long run the goal is to
> - Support Firefox and Webkit
> - Useful amount of metrics to choose from
> - Insightful visualization of the results
## Install
```bash
npm install playwright-performance-reporter --save-dev
```
## Usage
Disable parallelism:
```ts
export default defineConfig({
...
fullyParallel: false,
workers: 1,
...
})
```
### Setup Reporter
To register the reporter, include the code blow in your playwright config.
Please see the subsections for more details about browser specific cases.
If you want to extend it with custom metrics, an entry exists for `customMetrics`, where the callback will get
the accumulator and CDP client. Please see the example below how to use it.
For ease of implementation, the passed object can implement the interface `MetricObserver`.
```ts
import type { CDP, Options, Metric } from 'playwright-performance-reporter';
const PlayWrightPerformanceReporterOptions: Options = {
outputDir: '/your/path/to/dir',
outputFile: 'output.json',
browsers: {
chromium: {
onTestStep: {
metrics: ['usedJsHeapSize', 'totalJsHeapSize'],
customMetrics: {
someMetric: {
name: 'someMetric',
onStart: (accumulator: Metric[], client: CDP.Client) => new Promise(resolve => {
client.send('Performance.getMetrics', (error, response) => { accumulator.push(response); resolve(); });
}),
onStop: (accumulator: Metric[], client: CDP.Client) => new Promise(resolve => {
client.send('Performance.getMetrics', (error, response) => { accumulator.push(response); resolve(); });
})
}
}
}
}
}
}
export default defineConfig({
...
reporter: [
['playwright-performance-reporter', PlayWrightPerformanceReporterOptions]
],
...
});
```
### Chromium
Following metrics are supported out of the box:
- usedJsHeapSize
- totalJsHeapSize
- allPerformanceMetrics
The `MetricsEngine` relies on the [Chrome DevTool Protocol (CDP)](https://chromedevtools.github.io/devtools-protocol/),
which can be accessed through HTTP and WebSocket. To allow for a connection, make sure to expose a port for the remote debugging.
The reporter will try to extract that port during start-up.
#### Setup Browser
```ts
{
name: 'chromium',
use: {
...devices['Desktop Chrome'],
launchOptions: {
args: [
'--remote-debugging-port=9222'
]
}
}
},
```
## Output
The top level is hooked into `test()`.
```json
{
...
"4dde6239d9ac8c9468f3-82e3094b06379c51b729": {
"TEST_CASE_PARENT": {
"name": " > chromium > scenarios/profile.spec.ts > Profile",
...
}
...
}
...
}
```
The content consists of steps of the test suite.
Please keep in mind that the metric request is async and is not awaited by
Playwright. This means that the browser API might still in the process of collecting the metrics,
even though Playwright instructed the browser to continue to the next step. This could lead to wrong output.
To check if the output is invalid, the values `startMeasurementOffset` and `endMeasurementOffset` are provided, which measure
the time delta in milliseconds between the request until the browser provides all metrics.
```json
{
...
"08e5cdf7227924757e4a8f402ac2167d": {
"name": "click login",
"startMetrics": [
{
"usedJsHeapSize": 8653828
},
{
"totalJsHeapSize": 12611584
}
],
"stopMetrics": [
{
"usedJsHeapSize": 8863700
},
{
"totalJsHeapSize": 12873728
}
],
"startMeasurement": 1724001218666,
"endMeasurement": 1724001218914,
"startMeasurementOffset": 4,
"endMeasurementOffset": 3
},
"f957b5d47615b372c20ea69a16f5f344": {
"name": "fill mock data",
"startMetrics": [
{
"usedJsHeapSize": 8863700
},
{
"totalJsHeapSize": 12873728
}
],
"stopMetrics": [
{
"usedJsHeapSize": 9055816
},
{
"totalJsHeapSize": 12873728
}
],
"startMeasurement": 1724001218914,
"endMeasurement": 1724001218947,
"startMeasurementOffset": 2,
"endMeasurementOffset": 2
},
...
}
```