Skip to content
This repository was archived by the owner on Jan 30, 2025. It is now read-only.

Commit c2d3403

Browse files
committed
docs: apply more suggestions from code review
1 parent 0c16cdf commit c2d3403

File tree

3 files changed

+23
-44
lines changed

3 files changed

+23
-44
lines changed

FAQ.md

Lines changed: 0 additions & 20 deletions
This file was deleted.

README.md

Lines changed: 2 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -49,29 +49,20 @@ See our [project roadmap](ROADMAP.md) for more details.
4949

5050
- [Releases](https://github.com/grafana/xk6-browser/releases)
5151
- [API Documentation](https://k6.io/docs/javascript-api/xk6-browser/api/) - This documents how to use our API and its current state with xk6-browser.
52-
- [Examples](/examples) - The examples from our API documentation are also available as standalone files. You can run them in a Docker container using Docker Compose with:
53-
54-
```bash
55-
docker-compose run -T xk6-browser run - <examples/browser_on.js
56-
```
5752

5853
## Get help
5954

60-
- Go to our [FAQ](/FAQ.md) to answer your most asked questions about xk6-browser.
6155
- If you're having issues installing or running xk6-browser, refer to [TROUBLESHOOTING](/TROUBLESHOOTING.md).
6256
- To get help about usage, report bugs, suggest features, and discuss xk6-browser with other users see [SUPPORT.md](SUPPORT.md).
57+
- Community discussion happens at the [xk6-browser forum](https://community.k6.io/c/xk6-browser/14).
6358

64-
## Additional Resources
59+
## Additional resources
6560

6661
To find out more about xk6-browser or browser testing in general, check out the following links.
6762

6863
**Note:** since our API is still transitioning, some of the code snippets from the links below might be inaccurate, though the concepts should still be correct. For the latest, refer to our up-to-date [API documentation](https://k6.io/docs/javascript-api/xk6-browser/api/).
6964

7065
- [Introducing browser automation and end-to-end web testing with k6](https://k6.io/blog/announcing-xk6-browser-testing/) - A blog post from our CEO, Robin Gustafsson, where he introduced xk6-browser.
71-
- [Real Browser Testing with xk6-browser](https://youtu.be/y04wavsZxSs) - A video tutorial from our Developer Advocate, Nicole van der Hoeven, where she demonstrated how to get started with xk6-browser.
72-
- [Browser testing and API load testing in the same script with k6](https://youtu.be/Y4qDAaJgxV0) - Office Hours episode where we first introduced xk6-browser.
7366
- [What is Browser Testing](https://youtu.be/ieQwRy9UVo4) - An introductory chat with our DevRel team about what browser testing is and why we need to test with browsers.
7467
- [Getting started with xk6-browser](https://youtu.be/CRSTQ6n05hM) - Office Hours episode where our DevRel team shared insights on how to get started with xk6-browser and the state of browser testing with k6
7568
- [Hybrid Performance Testing with k6](https://www.youtube.com/watch?v=nZlleGaf5Ro) - Office Hours episode where our DevRel team talked about what a hybrid performance testing is and how xk6-browser can help.
76-
- [A Medley of Frontend and Backend Performance Testing](https://youtu.be/Pa2FBI2k1qc) - A talk from our Developer Advocate, Marie Cruz, where she explained what frontend and backend performance testing and also features xk6-browser.
77-

ROADMAP.md

Lines changed: 21 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,29 @@ xk6-browser roadmap
33

44
xk6-browser is a [k6](https://k6.io/) extension that will become part of the k6 core once it reaches its stability goals. The project adds browser automation support to k6, expanding the testing capabilities of the k6 ecosystem to include real-world user simulation in addition to API/performance testing. This allows web developers to test their applications fully end-to-end in a way that previously wasn't possible with k6 alone.
55

6-
We consider browser automation to be an important part of web-application testing, and we have big goals in mind for xk6-browser. In the spirit of transparency, we'd like to share our roadmap for the project with the k6 community.
7-
We hope that users can plan ahead, trusting the k6 and Grafana's commitment to its success.
6+
We consider browser automation to be an important part of web-application testing, and we have big goals in mind for xk6-browser. In the spirit of transparency, we'd like to share our roadmap for the project with the k6 community. We hope that users can plan ahead, trusting the k6 and Grafana's commitment to its success. With that in mind, we'll detail some of our important status updates, our short, mid and long-term goals. Most of these will be worked on concurrently, and reaching them will be a gradual process. The timeframes are also not set in stone, but rather serve as tentative targets that the team is aiming for.
87

9-
With that in mind, we'll detail some of our short, mid and long-term goals. Most of these will be worked on concurrently, and reaching them will be a gradual process. The timeframes are also not set in stone, but rather serve as tentative targets that the team is aiming for.
8+
Status updates
9+
----------------
10+
11+
- **Is this production ready?**<br>
12+
No, not yet. We're focused on making the extension stable and reliable, as that's our top priority, before adding more features.
13+
14+
- **Is this extension supported in k6 Cloud?**<br>
15+
No, not yet. We take the security of our customer data very seriously and currently, we are analyzing the implications of running browser instances in the cloud.
16+
17+
- **It doesn't work with my Chromium/Chrome version, why?**<br>
18+
CDP evolves and there are differences between different versions of Chromium, sometimes quite subtle. The codebase is continuously tested with the two latest major releases of Google Chrome.
19+
20+
- **Are Firefox or WebKit-based browsers supported?**<br>
21+
Not yet. There are differences in CDP coverage between Chromium, Firefox, and WebKit-based browsers. xk6-browser is initially only targetting Chromium-based browsers.
22+
23+
- **Are all features of Playwright supported?**<br>
24+
No. Playwright's API is pretty large and some of the functionality only makes sense if it's implemented using async operations: event listening, request interception, waiting for events, etc. This requires the existence of an event loop per VU in k6, which was only [recently added](https://github.com/grafana/k6/issues/882). Most of the current xk6-browser API is synchronous and thus lacks some of the functionality that requires asynchronicity, but we're gradually migrating existing methods to return a `Promise`, and adding new ones that will follow the same API.
25+
26+
Expect breaking changes during this transition. We'll point them out in the release notes as well as proposed migration plan.
1027

28+
Note that `async`/`await` is still under development and is not supported in k6 scripts. If you wish to use this syntax you'll have to transform your script beforehand with an updated Babel version. See the [k6-template-es6 project](https://github.com/grafana/k6-template-es6) and [this comment](https://github.com/grafana/k6/issues/779#issuecomment-964027280) for details.
1129

1230
Short-term goals
1331
----------------
@@ -34,16 +52,6 @@ These are goals achievable within 3-6 months, tentatively done by Q3 2022.
3452
When the extension is usable in k6 Cloud; i.e. scripts can run and test results are shown. Frontend changes are not required at this stage.
3553

3654

37-
- **Update [API documentation](https://k6.io/docs/javascript-api/xk6-browser/).**<br>
38-
The current documentation is not up-to-date, which makes using xk6-browser outside of the examples quite difficult.
39-
40-
*How will we achieve this?*<br>
41-
We are prioritizing documentation work in all upcoming development cycles.
42-
43-
*Definition of Done*<br>
44-
When the documentation reflects the state of the current API.
45-
46-
4755
Mid-term goals
4856
--------------
4957

0 commit comments

Comments
 (0)