From 17994608424de5268985e64115e1ae41d77e7893 Mon Sep 17 00:00:00 2001 From: ankur22 Date: Thu, 7 Dec 2023 11:44:22 +0000 Subject: [PATCH 1/3] Update browser module imports Ensure that that the examples import browser and not chromium for the browser module examples throughout the documentation. --- .../browser/locator/dispatchevent.md | 15 ++++++++------- .../next/testing-guides/load-testing-websites.md | 4 +--- .../page-object-model-pattern.md | 4 +--- 3 files changed, 10 insertions(+), 13 deletions(-) diff --git a/docs/sources/next/javascript-api/k6-experimental/browser/locator/dispatchevent.md b/docs/sources/next/javascript-api/k6-experimental/browser/locator/dispatchevent.md index 3e07e4439a..67bf42c2ac 100644 --- a/docs/sources/next/javascript-api/k6-experimental/browser/locator/dispatchevent.md +++ b/docs/sources/next/javascript-api/k6-experimental/browser/locator/dispatchevent.md @@ -9,11 +9,11 @@ Dispatches HTML DOM event types e.g. `'click'`. -| Parameter | Type | Defaults | Description | -| --------------- | ------ | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| type | string | `''` | DOM event type e.g. `'click'`. | -| eventInit | object | `null` | Optional event specific properties. See [eventInit](#eventinit) for more details. | -| options | object | `null` | | +| Parameter | Type | Defaults | Description | +| --------------- | ------ | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| type | string | `''` | DOM event type e.g. `'click'`. | +| eventInit | object | `null` | Optional event specific properties. See [eventInit](#eventinit) for more details. | +| options | object | `null` | | | options.timeout | number | `30000` | Maximum time in milliseconds. Pass `0` to disable the timeout. Default is overridden by the `setDefaultTimeout` option on [BrowserContext](https://grafana.com/docs/k6//javascript-api/k6-experimental/browser/browsercontext/) or [Page](https://grafana.com/docs/k6//javascript-api/k6-experimental/browser/page/). | @@ -35,15 +35,16 @@ Since eventInit is event-specific, please refer to the events documentation for {{< code >}} ```javascript -import { chromium } from 'k6/experimental/browser'; +import { browser } from 'k6/experimental/browser'; export default async function () { - const browser = chromium.launch(); const page = browser.newPage(); await page.goto('https://test.k6.io/browser.php'); const button = page.locator('#counter-button'); button.dispatchEvent('click'); + + page.close(); } ``` diff --git a/docs/sources/next/testing-guides/load-testing-websites.md b/docs/sources/next/testing-guides/load-testing-websites.md index 20a585459b..a60e833eab 100644 --- a/docs/sources/next/testing-guides/load-testing-websites.md +++ b/docs/sources/next/testing-guides/load-testing-websites.md @@ -190,11 +190,10 @@ The following is an example of a browser-based load testing script in k6 using t ```javascript -import { chromium } from 'k6/experimental/browser'; +import { browser } from 'k6/experimental/browser'; import { sleep } from 'k6'; export default async function () { - const browser = chromium.launch({ headless: false }); const page = browser.newPage(); // 01. Go to the homepage @@ -217,7 +216,6 @@ export default async function () { sleep(1); } finally { page.close(); - browser.close(); } } ``` diff --git a/docs/sources/next/using-k6-browser/recommended-practices/page-object-model-pattern.md b/docs/sources/next/using-k6-browser/recommended-practices/page-object-model-pattern.md index dec965a291..1e6db6544e 100644 --- a/docs/sources/next/using-k6-browser/recommended-practices/page-object-model-pattern.md +++ b/docs/sources/next/using-k6-browser/recommended-practices/page-object-model-pattern.md @@ -73,14 +73,13 @@ You can import the `Homepage` class within your test class and invoke the method {{< code >}} ```javascript -import { chromium } from 'k6/experimental/browser'; +import { browser } from 'k6/experimental/browser'; import { expect } from 'https://jslib.k6.io/k6chaijs/4.3.4.0/index.js'; import { Homepage } from '../pages/homepage.js'; import { bookingData } from '../data/booking-data.js'; export default async function () { - const browser = chromium.launch(); const page = browser.newPage(); const { name } = bookingData; @@ -92,7 +91,6 @@ export default async function () { expect(homepage.getVerificationMessage()).to.contain(name); page.close(); - browser.close(); } ``` From 3f3b846d2c3b0270dde8fdf9d26e21ee91d84f4b Mon Sep 17 00:00:00 2001 From: ankur22 Date: Thu, 7 Dec 2023 11:47:21 +0000 Subject: [PATCH 2/3] Update the browser imports for v0.47.x docs --- .../browser/locator/dispatchevent.md | 15 ++++++++------- .../testing-guides/load-testing-websites.md | 4 +--- .../page-object-model-pattern.md | 4 +--- 3 files changed, 10 insertions(+), 13 deletions(-) diff --git a/docs/sources/v0.47.x/javascript-api/k6-experimental/browser/locator/dispatchevent.md b/docs/sources/v0.47.x/javascript-api/k6-experimental/browser/locator/dispatchevent.md index 3e07e4439a..67bf42c2ac 100644 --- a/docs/sources/v0.47.x/javascript-api/k6-experimental/browser/locator/dispatchevent.md +++ b/docs/sources/v0.47.x/javascript-api/k6-experimental/browser/locator/dispatchevent.md @@ -9,11 +9,11 @@ Dispatches HTML DOM event types e.g. `'click'`. -| Parameter | Type | Defaults | Description | -| --------------- | ------ | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| type | string | `''` | DOM event type e.g. `'click'`. | -| eventInit | object | `null` | Optional event specific properties. See [eventInit](#eventinit) for more details. | -| options | object | `null` | | +| Parameter | Type | Defaults | Description | +| --------------- | ------ | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| type | string | `''` | DOM event type e.g. `'click'`. | +| eventInit | object | `null` | Optional event specific properties. See [eventInit](#eventinit) for more details. | +| options | object | `null` | | | options.timeout | number | `30000` | Maximum time in milliseconds. Pass `0` to disable the timeout. Default is overridden by the `setDefaultTimeout` option on [BrowserContext](https://grafana.com/docs/k6//javascript-api/k6-experimental/browser/browsercontext/) or [Page](https://grafana.com/docs/k6//javascript-api/k6-experimental/browser/page/). | @@ -35,15 +35,16 @@ Since eventInit is event-specific, please refer to the events documentation for {{< code >}} ```javascript -import { chromium } from 'k6/experimental/browser'; +import { browser } from 'k6/experimental/browser'; export default async function () { - const browser = chromium.launch(); const page = browser.newPage(); await page.goto('https://test.k6.io/browser.php'); const button = page.locator('#counter-button'); button.dispatchEvent('click'); + + page.close(); } ``` diff --git a/docs/sources/v0.47.x/testing-guides/load-testing-websites.md b/docs/sources/v0.47.x/testing-guides/load-testing-websites.md index 20a585459b..a60e833eab 100644 --- a/docs/sources/v0.47.x/testing-guides/load-testing-websites.md +++ b/docs/sources/v0.47.x/testing-guides/load-testing-websites.md @@ -190,11 +190,10 @@ The following is an example of a browser-based load testing script in k6 using t ```javascript -import { chromium } from 'k6/experimental/browser'; +import { browser } from 'k6/experimental/browser'; import { sleep } from 'k6'; export default async function () { - const browser = chromium.launch({ headless: false }); const page = browser.newPage(); // 01. Go to the homepage @@ -217,7 +216,6 @@ export default async function () { sleep(1); } finally { page.close(); - browser.close(); } } ``` diff --git a/docs/sources/v0.47.x/using-k6-browser/recommended-practices/page-object-model-pattern.md b/docs/sources/v0.47.x/using-k6-browser/recommended-practices/page-object-model-pattern.md index b7e714117f..d30b96b67d 100644 --- a/docs/sources/v0.47.x/using-k6-browser/recommended-practices/page-object-model-pattern.md +++ b/docs/sources/v0.47.x/using-k6-browser/recommended-practices/page-object-model-pattern.md @@ -73,14 +73,13 @@ You can import the `Homepage` class within your test class and invoke the method {{< code >}} ```javascript -import { chromium } from 'k6/experimental/browser'; +import { browser } from 'k6/experimental/browser'; import { expect } from 'https://jslib.k6.io/k6chaijs/4.3.4.0/index.js'; import { Homepage } from '../pages/homepage.js'; import { bookingData } from '../data/booking-data.js'; export default async function () { - const browser = chromium.launch(); const page = browser.newPage(); const { name } = bookingData; @@ -92,7 +91,6 @@ export default async function () { expect(homepage.getVerificationMessage()).to.contain(name); page.close(); - browser.close(); } ``` From 0fab32e983a9cdf1c0e1e3f0e41ca0092278e6f9 Mon Sep 17 00:00:00 2001 From: ankur22 Date: Thu, 7 Dec 2023 11:56:54 +0000 Subject: [PATCH 3/3] Update the browser imports for v0.48.x docs --- .../browser/locator/dispatchevent.md | 15 ++++++++------- .../testing-guides/load-testing-websites.md | 4 +--- .../page-object-model-pattern.md | 4 +--- 3 files changed, 10 insertions(+), 13 deletions(-) diff --git a/docs/sources/v0.48.x/javascript-api/k6-experimental/browser/locator/dispatchevent.md b/docs/sources/v0.48.x/javascript-api/k6-experimental/browser/locator/dispatchevent.md index 3e07e4439a..67bf42c2ac 100644 --- a/docs/sources/v0.48.x/javascript-api/k6-experimental/browser/locator/dispatchevent.md +++ b/docs/sources/v0.48.x/javascript-api/k6-experimental/browser/locator/dispatchevent.md @@ -9,11 +9,11 @@ Dispatches HTML DOM event types e.g. `'click'`. -| Parameter | Type | Defaults | Description | -| --------------- | ------ | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| type | string | `''` | DOM event type e.g. `'click'`. | -| eventInit | object | `null` | Optional event specific properties. See [eventInit](#eventinit) for more details. | -| options | object | `null` | | +| Parameter | Type | Defaults | Description | +| --------------- | ------ | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| type | string | `''` | DOM event type e.g. `'click'`. | +| eventInit | object | `null` | Optional event specific properties. See [eventInit](#eventinit) for more details. | +| options | object | `null` | | | options.timeout | number | `30000` | Maximum time in milliseconds. Pass `0` to disable the timeout. Default is overridden by the `setDefaultTimeout` option on [BrowserContext](https://grafana.com/docs/k6//javascript-api/k6-experimental/browser/browsercontext/) or [Page](https://grafana.com/docs/k6//javascript-api/k6-experimental/browser/page/). | @@ -35,15 +35,16 @@ Since eventInit is event-specific, please refer to the events documentation for {{< code >}} ```javascript -import { chromium } from 'k6/experimental/browser'; +import { browser } from 'k6/experimental/browser'; export default async function () { - const browser = chromium.launch(); const page = browser.newPage(); await page.goto('https://test.k6.io/browser.php'); const button = page.locator('#counter-button'); button.dispatchEvent('click'); + + page.close(); } ``` diff --git a/docs/sources/v0.48.x/testing-guides/load-testing-websites.md b/docs/sources/v0.48.x/testing-guides/load-testing-websites.md index 20a585459b..a60e833eab 100644 --- a/docs/sources/v0.48.x/testing-guides/load-testing-websites.md +++ b/docs/sources/v0.48.x/testing-guides/load-testing-websites.md @@ -190,11 +190,10 @@ The following is an example of a browser-based load testing script in k6 using t ```javascript -import { chromium } from 'k6/experimental/browser'; +import { browser } from 'k6/experimental/browser'; import { sleep } from 'k6'; export default async function () { - const browser = chromium.launch({ headless: false }); const page = browser.newPage(); // 01. Go to the homepage @@ -217,7 +216,6 @@ export default async function () { sleep(1); } finally { page.close(); - browser.close(); } } ``` diff --git a/docs/sources/v0.48.x/using-k6-browser/recommended-practices/page-object-model-pattern.md b/docs/sources/v0.48.x/using-k6-browser/recommended-practices/page-object-model-pattern.md index dec965a291..1e6db6544e 100644 --- a/docs/sources/v0.48.x/using-k6-browser/recommended-practices/page-object-model-pattern.md +++ b/docs/sources/v0.48.x/using-k6-browser/recommended-practices/page-object-model-pattern.md @@ -73,14 +73,13 @@ You can import the `Homepage` class within your test class and invoke the method {{< code >}} ```javascript -import { chromium } from 'k6/experimental/browser'; +import { browser } from 'k6/experimental/browser'; import { expect } from 'https://jslib.k6.io/k6chaijs/4.3.4.0/index.js'; import { Homepage } from '../pages/homepage.js'; import { bookingData } from '../data/booking-data.js'; export default async function () { - const browser = chromium.launch(); const page = browser.newPage(); const { name } = bookingData; @@ -92,7 +91,6 @@ export default async function () { expect(homepage.getVerificationMessage()).to.contain(name); page.close(); - browser.close(); } ```