{"id":20390474,"url":"https://github.com/checkly/headless-benchmarks","last_synced_at":"2025-04-12T11:21:31.794Z","repository":{"id":40201515,"uuid":"314612349","full_name":"checkly/headless-benchmarks","owner":"checkly","description":"Benchmarking scripts for Puppeteer, Playwright, WebDriverIO  \u0026 Cypress.","archived":false,"fork":false,"pushed_at":"2021-02-08T21:22:26.000Z","size":302,"stargazers_count":34,"open_issues_count":1,"forks_count":2,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-04-11T16:07:36.246Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/checkly.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-11-20T16:41:49.000Z","updated_at":"2024-02-27T05:22:27.000Z","dependencies_parsed_at":"2022-06-26T21:14:52.937Z","dependency_job_id":null,"html_url":"https://github.com/checkly/headless-benchmarks","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/checkly%2Fheadless-benchmarks","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/checkly%2Fheadless-benchmarks/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/checkly%2Fheadless-benchmarks/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/checkly%2Fheadless-benchmarks/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/checkly","download_url":"https://codeload.github.com/checkly/headless-benchmarks/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248558129,"owners_count":21124223,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-15T03:25:09.534Z","updated_at":"2025-04-12T11:21:31.775Z","avatar_url":"https://github.com/checkly.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Headless benchmarks\n\nBenchmarking scripts for Puppeteer, Playwright, WebDriverIO (running against standalone Selenium server and devtools) and Cypress.\n\n## Setup\n\n### Local\n\nInstall the needed packages using `npm i`\nFor WebDriverIO Selenium runs you will also need to install and run the Selenium Standalone Server:\n```\n./node_modules/.bin/selenium-standalone install\n./node_modules/.bin/selenium-standalone start\n``` \n\n### For scripts running against Danube\n\n[Danube](https://danube-webshop.herokuapp.com) is a fully static demo website, and needs no further setup to be run against.\nScripts running against Danube are already set up to export credentials for you as follows: \n\n```\nexport USER_EMAIL=user@email.com\nexport USER_PASSWORD=supersecure1\n```\n\nWhen running Cypress, remember to export the above variables with the `CYPRESS_` prefix added, e.g. `CYPRESS_USER_EMAIL=...`.\n\n### For scripts running against Checkly\n\nBefore kicking off any benchmarks against Checkly, create a placeholder check, as well as a placeholder snippet (note the id of the snippet, which is displayed at the end of the URL on the snippet page, e.g. `https://app.checklyhq.com/snippets/6395`)\n\nScripts running against Checkly will require you to set the following:\n\n```\nexport URL=https://app.checklyhq.com\nexport EMAIL=\u003cyour checkly email\u003e\nexport PASSWORD=\u003cyour checkly password\u003e\nexport SNIPPET_ID=\u003cyour placeholder snippet id\u003e\n```\n\nWhen running Cypress, remember to export the above variables with the `CYPRESS_` prefix added, e.g. `CYPRESS_EMAIL=...`.\n\n**Note: like most production web applications under active development, Checkly changes very often. Therefore, you might need to adjust your scripts (especially selectors) to reflect the latest changes.** \n\n## Running the benchmarks\n\nScripts are in place for each website+tool combination.\n\nYou only need to provide a number of iterations and a label for your run, e.g.:\n\n```./bench-danube-plwr.sh 1000 my-label```\n\nTimings and logs for each run are stored under `results`.\n\n## Automation scripts\n\nThe goal is to have stable scripts that are as similar as possible across tools, i.e. scripts that perform the same high-level operations in the browser, regardless of the small differences under the hood (which are expected due to differences between the automation tools and APIs). \n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcheckly%2Fheadless-benchmarks","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcheckly%2Fheadless-benchmarks","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcheckly%2Fheadless-benchmarks/lists"}