update xk6-browser code examples to async/await

gatsby-node.js

@@ -213,8 +213,8 @@ const topLevelLinks = [
     submenu: [
       { label: 'k6 API', to: `/javascript-api/` },
       {
-        label: 'xk6-browser',
-        to: `/javascript-api/xk6-browser/`,
+        label: 'k6 browser',
+        to: `/javascript-api/k6-browser/`,
       },
       {
         label: 'xk6-disruptor',
@@ -465,7 +465,7 @@ function getTopLevelPagesProps({
       (item) =>
         item !== 'jslib' &&
         item !== 'xk6-disruptor' &&
-        item !== 'xk6-browser' &&
+        item !== 'k6-browser' &&
         item !== 'extensions',
     )
     .map((name) => {
@@ -649,7 +649,7 @@ function getDocPagesProps({
       }
 
       // data for github button on the right
-      // currently we only show it for jslib, xk6-browser, xk6-disruptor pages
+      // currently we only show it for jslib, k6-browser, xk6-disruptor pages
       let githubUrl = null;
       let githubTitle = '';
 
@@ -705,43 +705,40 @@ function getDocPagesProps({
         }));
       }
 
-      // add prefix to xk6-browser pages slugs and sidebar links
-      if (slug.startsWith('xk6-browser/')) {
+      // add prefix to k6-browser pages slugs and sidebar links
+      if (slug.startsWith('k6-browser/')) {
         slug = `javascript-api/${slug}`;
-        if (slug.includes('xk6-browser/get-started/welcome')) {
+        if (slug.includes('k6-browser/get-started/welcome')) {
           // make the section root out of the welcome page
-          slug = `javascript-api/xk6-browser/`;
+          slug = `javascript-api/k6-browser/`;
         }
 
         replacePathsInSidebarTree(
           sidebarTree,
-          '/xk6-browser',
-          '/javascript-api/xk6-browser',
+          '/k6-browser',
+          '/javascript-api/k6-browser',
         );
         replacePathsInSidebarTree(
           sidebarTree,
-          '/javascript-api/xk6-browser/get-started/welcome',
-          '/javascript-api/xk6-browser',
+          '/javascript-api/k6-browser/get-started/welcome',
+          '/javascript-api/k6-browser',
         );
 
         githubUrl = 'https://github.com/grafana/xk6-browser';
-        githubTitle = 'xk6-browser';
+        githubTitle = 'k6 browser';
 
         breadcrumbs = breadcrumbs.map((item) => ({
           ...item,
-          name: item.name === 'Xk6-browser' ? 'xk6-browser' : item.name,
-          path: item.path.replace(
-            '/xk6-browser',
-            '/javascript-api/xk6-browser',
-          ),
+          name: item.name === 'K6-browser' ? 'k6 browser' : item.name,
+          path: item.path.replace('/k6-browser', '/javascript-api/k6-browser'),
         }));
       }
 
       let hideBreadcrumbs = false;
       if (
         slug === 'javascript-api/jslib/' ||
         slug === 'javascript-api/xk6-disruptor/' ||
-        slug === 'javascript-api/xk6-browser/'
+        slug === 'javascript-api/k6-browser/'
       ) {
         hideBreadcrumbs = true;
       }
@@ -1182,7 +1179,7 @@ async function createDocPages({
   // create data for rendering docs navigation
   const topLevelNames = Object.keys(sidebar.children).filter(
     (name) =>
-      name !== 'xk6-browser' && name !== 'xk6-disruptor' && name !== 'jslib',
+      name !== 'k6-browser' && name !== 'xk6-disruptor' && name !== 'jslib',
   );
 
   getDocPagesProps({
@@ -1234,8 +1231,8 @@ const createRedirects = ({ actions }) => {
     isPermanent: true,
   });
   createRedirect({
-    fromPath: '/javascript-api/xk6-browser/get-started/welcome/',
-    toPath: '/javascript-api/xk6-browser/',
+    fromPath: '/javascript-api/k6-browser/get-started/welcome/',
+    toPath: '/javascript-api/k6-browser/',
     redirectInBrowser: true,
     isPermanent: true,
   });
@@ -1725,59 +1722,59 @@ const createRedirects = ({ actions }) => {
       '/cloud/cloud-faq/general-questions/',
     '/misc/usage-reports': '/misc/usage-collection/',
     '/using-k6/using-node-modules': '/using-k6/modules/',
-    '/javascript-api/k6-x-browser/': '/javascript-api/xk6-browser/',
+    '/javascript-api/k6-x-browser/': '/javascript-api/k6-browser/',
+    '/javascript-api/xk6-browser/': '/javascript-api/k6-browser/',
     '/javascript-api/k6-x-browser/browser/':
-      '/javascript-api/xk6-browser/api/browser/',
-    '/javascript-api/xk6-browser/browser/':
-      '/javascript-api/xk6-browser/api/browser/',
+      '/javascript-api/k6-browser/api/browser/',
+    '/javascript-api/k6-browser/browser/':
+      '/javascript-api/k6-browser/api/browser/',
     '/javascript-api/k6-x-browser/browsercontext/':
-      '/javascript-api/xk6-browser/api/browsercontext/',
-    '/javascript-api/xk6-browser/browsercontext/':
-      '/javascript-api/xk6-browser/api/browsercontext/',
+      '/javascript-api/k6-browser/api/browsercontext/',
+    '/javascript-api/k6-browser/browsercontext/':
+      '/javascript-api/k6-browser/api/browsercontext/',
     '/javascript-api/k6-x-browser/browsertype/':
-      '/javascript-api/xk6-browser/api/browsertype/',
-    '/javascript-api/xk6-browser/browsertype/':
-      '/javascript-api/xk6-browser/api/browsertype/',
+      '/javascript-api/k6-browser/api/browsertype/',
+    '/javascript-api/k6-browser/browsertype/':
+      '/javascript-api/k6-browser/api/browsertype/',
     '/javascript-api/k6-x-browser/elementhandle/':
-      '/javascript-api/xk6-browser/api/elementhandle/',
-    '/javascript-api/xk6-browser/elementhandle/':
-      '/javascript-api/xk6-browser/api/elementhandle/',
+      '/javascript-api/k6-browser/api/elementhandle/',
+    '/javascript-api/k6-browser/elementhandle/':
+      '/javascript-api/k6-browser/api/elementhandle/',
     '/javascript-api/k6-x-browser/frame/':
-      '/javascript-api/xk6-browser/api/frame/',
-    '/javascript-api/xk6-browser/frame/':
-      '/javascript-api/xk6-browser/api/frame/',
+      '/javascript-api/k6-browser/api/frame/',
+    '/javascript-api/k6-browser/frame/':
+      '/javascript-api/k6-browser/api/frame/',
     '/javascript-api/k6-x-browser/jshandle/':
-      '/javascript-api/xk6-browser/api/jshandle/',
-    '/javascript-api/xk6-browser/jshandle/':
-      '/javascript-api/xk6-browser/api/jshandle/',
+      '/javascript-api/k6-browser/api/jshandle/',
+    '/javascript-api/k6-browser/jshandle/':
+      '/javascript-api/k6-browser/api/jshandle/',
     '/javascript-api/k6-x-browser/keyboard/':
-      '/javascript-api/xk6-browser/api/keyboard/',
-    '/javascript-api/xk6-browser/keyboard/':
-      '/javascript-api/xk6-browser/api/keyboard/',
+      '/javascript-api/k6-browser/api/keyboard/',
+    '/javascript-api/k6-browser/keyboard/':
+      '/javascript-api/k6-browser/api/keyboard/',
     '/javascript-api/k6-x-browser/locator/':
-      '/javascript-api/xk6-browser/api/locator/',
-    '/javascript-api/xk6-browser/locator/':
-      '/javascript-api/xk6-browser/api/locator/',
+      '/javascript-api/k6-browser/api/locator/',
+    '/javascript-api/k6-browser/locator/':
+      '/javascript-api/k6-browser/api/locator/',
     '/javascript-api/k6-x-browser/mouse/':
-      '/javascript-api/xk6-browser/api/mouse/',
-    '/javascript-api/xk6-browser/mouse/':
-      '/javascript-api/xk6-browser/api/mouse/',
+      '/javascript-api/k6-browser/api/mouse/',
+    '/javascript-api/k6-browser/mouse/':
+      '/javascript-api/k6-browser/api/mouse/',
     '/javascript-api/k6-x-browser/page/':
-      '/javascript-api/xk6-browser/api/page/',
-    '/javascript-api/xk6-browser/page/':
-      '/javascript-api/xk6-browser/api/page/',
+      '/javascript-api/k6-browser/api/page/',
+    '/javascript-api/k6-browser/page/': '/javascript-api/k6-browser/api/page/',
     '/javascript-api/k6-x-browser/request/':
-      '/javascript-api/xk6-browser/api/request/',
-    '/javascript-api/xk6-browser/request/':
-      '/javascript-api/xk6-browser/api/request/',
+      '/javascript-api/k6-browser/api/request/',
+    '/javascript-api/k6-browser/request/':
+      '/javascript-api/k6-browser/api/request/',
     '/javascript-api/k6-x-browser/response/':
-      '/javascript-api/xk6-browser/api/response/',
-    '/javascript-api/xk6-browser/response/':
-      '/javascript-api/xk6-browser/api/response/',
+      '/javascript-api/k6-browser/api/response/',
+    '/javascript-api/k6-browser/response/':
+      '/javascript-api/k6-browser/api/response/',
     '/javascript-api/k6-x-browser/touchscreen/':
-      '/javascript-api/xk6-browser/api/touchscreen/',
-    '/javascript-api/xk6-browser/touchscreen/':
-      '/javascript-api/xk6-browser/api/touchscreen/',
+      '/javascript-api/k6-browser/api/touchscreen/',
+    '/javascript-api/k6-browser/touchscreen/':
+      '/javascript-api/k6-browser/api/touchscreen/',
     ...newJavascriptURLsRedirects,
   };
 

src/components/blocks/header/nav/header-nav.view.js

@@ -16,18 +16,18 @@ export const isJsAPIActiveLink = (path) => {
     // getting the same piece from window and removing possible trailing slash
     const actualPath = window.location.pathname.replace(/\/$/, '');
 
-    // avoid highlighting k6 api link if xk6-browser or jslib was selected
+    // avoid highlighting k6 api link if k6 browser or jslib was selected
     if (actualPath.includes('javascript-api/jslib')) {
       isActiveLink =
         givenPath.includes('javascript-api/jslib') &&
         actualPath.includes(givenPath);
-    } else if (actualPath.includes('javascript-api/xk6-browser')) {
+    } else if (actualPath.includes('javascript-api/k6-browser')) {
       isActiveLink =
-        givenPath.includes('javascript-api/xk6-browser') &&
+        givenPath.includes('javascript-api/k6-browser') &&
         actualPath.includes(givenPath);
     } else {
       isActiveLink =
-        !givenPath.includes('javascript-api/xk6-browser') &&
+        !givenPath.includes('javascript-api/k6-browser') &&
         !givenPath.includes('javascript-api/jslib') &&
         actualPath.includes(givenPath);
     }

src/components/pages/doc-welcome/k6-does-not/k6-does-not.component.js

@@ -24,7 +24,7 @@ export const K6DoesNot = () => {
           <p>{t('welcome.k6-does-not.browser.description')}</p>
           <p>
             {t('welcome.k6-does-not.browser.testing.text')}{' '}
-            <Link className={'link'} to={'/javascript-api/xk6-browser/'}>
+            <Link className={'link'} to={'/javascript-api/k6-browser/'}>
               {t('welcome.k6-does-not.browser.testing.link')}
             </Link>
             , {t('welcome.k6-does-not.browser.testing.text2')}.

src/components/pages/doc-welcome/use-cases/use-cases.view.js

@@ -65,8 +65,8 @@ export const UseCases = () => {
           </Heading>
           <p>
             {t('welcome.use-cases.browser-testing.pre-description')}
-            <Link className={'link'} to={'/javascript-api/xk6-browser/'}>
-              xk6-browser
+            <Link className={'link'} to={'/javascript-api/k6-browser/'}>
+              k6 browser
             </Link>
             {t('welcome.use-cases.browser-testing.description')}
           </p>

src/components/shared/browser-class-list/browser-class-list.view.js

@@ -6,55 +6,55 @@ import React from 'react';
 const links = [
   {
     title: 'Browser',
-    url: '/javascript-api/xk6-browser/browser/',
+    url: '/javascript-api/k6-browser/browser/',
   },
   {
     title: 'BrowserContext',
-    url: '/javascript-api/xk6-browser/browsercontext/',
+    url: '/javascript-api/k6-browser/browsercontext/',
   },
   {
     title: 'BrowserType',
-    url: '/javascript-api/xk6-browser/browsertype/',
+    url: '/javascript-api/k6-browser/browsertype/',
   },
   {
     title: 'ElementHandle',
-    url: '/javascript-api/xk6-browser/elementhandle/',
+    url: '/javascript-api/k6-browser/elementhandle/',
   },
   {
     title: 'Frame',
-    url: '/javascript-api/xk6-browser/frame/',
+    url: '/javascript-api/k6-browser/frame/',
   },
   {
     title: 'JSHandle',
-    url: '/javascript-api/xk6-browser/jshandle',
+    url: '/javascript-api/k6-browser/jshandle',
   },
   {
     title: 'Keyboard',
-    url: '/javascript-api/xk6-browser/keyboard',
+    url: '/javascript-api/k6-browser/keyboard',
   },
   {
     title: 'Locator',
-    url: '/javascript-api/xk6-browser/locator',
+    url: '/javascript-api/k6-browser/locator',
   },
   {
     title: 'Mouse',
-    url: '/javascript-api/xk6-browser/mouse/',
+    url: '/javascript-api/k6-browser/mouse/',
   },
   {
     title: 'Page',
-    url: '/javascript-api/xk6-browser/page/',
+    url: '/javascript-api/k6-browser/page/',
   },
   {
     title: 'Request',
-    url: '/javascript-api/xk6-browser/request/',
+    url: '/javascript-api/k6-browser/request/',
   },
   {
     title: 'Response',
-    url: '/javascript-api/xk6-browser/response/',
+    url: '/javascript-api/k6-browser/response/',
   },
   {
     title: 'Touchscreen',
-    url: '/javascript-api/xk6-browser/touchscreen/',
+    url: '/javascript-api/k6-browser/touchscreen/',
   },
 ];
 

src/components/shared/browser-wip/browser-wip.js

@@ -4,7 +4,7 @@ import WIPIcon from 'svg/work-in-progress.inline.svg';
 
 const BrowserWIP = () => (
   <p style={{ verticalAlign: 'middle' }}>
-    <WIPIcon /> xk6-browser is in <CodeInline>beta</CodeInline> - we are working
+    <WIPIcon /> k6 browser is in <CodeInline>beta</CodeInline> - we are working
     to cover more Playwright APIs.
   </p>
 );

src/components/shared/seo/seo.view.js

@@ -7,7 +7,7 @@ import { LATEST_VERSION } from 'utils/versioning';
 
 const getPageHref = (host, slug) => {
   if (
-    slug.match(/^\/?xk6-browser\/.*/g) ||
+    slug.match(/^\/?k6-browser\/.*/g) ||
     slug.match(/^\/?xk6-disruptor\/.*/g) ||
     slug.match(/^\/?jslib\/.*/g)
   ) {

src/components/shared/tooltip/bnit/bnit.js

@@ -4,7 +4,7 @@ import NITIcon from 'svg/not-implemented.inline.svg';
 
 import Tooltip from '../tooltip';
 
-// BNIT = xk6-browser "Not Implemented" tooltip
+// BNIT = k6 browser "Not Implemented" tooltip
 const BNIT = ({ id }) =>
   id ? (
     <Tooltip value="Not implemented">

src/components/shared/tooltip/bwipt/bwipt.js

@@ -4,7 +4,7 @@ import WIPIcon from 'svg/work-in-progress.inline.svg';
 
 import Tooltip from '../tooltip';
 
-// BWIPT = xk6-browser "Work in Progress" tooltip
+// BWIPT = k6 browser "Work in Progress" tooltip
 const BWIPT = ({ id }) =>
   id ? (
     <Tooltip value="Work in Progress">

src/data/doc-extensions/extensions.json

@@ -36,18 +36,6 @@
       "official": false,
       "categories": ["Observability"]
     },
-    {
-      "name": "xk6-browser",
-      "description": "Browser automation and end-to-end web testing",
-      "url": "https://github.com/grafana/xk6-browser",
-      "logo": "",
-      "author": {
-        "name": "",
-        "url": ""
-      },
-      "official": false,
-      "categories": ["Browser"]
-    },
     {
       "name": "xk6-websockets",
       "description": "A WHATWG WebSockets API specification implementation for k6 that might replace k6/ws in the future.",

src/data/markdown/docs/02 javascript api/07 k6-experimental.md

@@ -7,6 +7,7 @@ excerpt: "k6 experimental APIs"
 
 | Modules                                                           | Description                                                                                                                                  |
 | ------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------- |
+| [browser](/javascript-api/k6-browser/) | Provides browser-level APIs to interact with browsers and collect frontend performance metrics as part of your k6 tests.  |
 | [redis](/javascript-api/k6-experimental/redis/) | Functionality to interact with [Redis](https://redis.io/). |
 | [timers](/javascript-api/k6-experimental/timers/) | `setTimeout`, `clearTimeout`, `setInterval`, `clearInterval`  |
 | [websockets](/javascript-api/k6-experimental/websockets/) | Implements the browser's [WebSocket API](https://developer.mozilla.org/en-US/docs/Web/API/WebSocket).  |

src/data/markdown/docs/30 k6-browser/01 Get started.md

@@ -0,0 +1,12 @@
+---
+title: 'Get started'
+excerpt: ''
+---
+
+[Welcome](/javascript-api/k6-browser/)
+
+[Running browser tests](/javascript-api/k6-browser/get-started/running-browser-tests/)
+
+[Browser metrics](/javascript-api/k6-browser/get-started/browser-metrics/)
+
+[Selecting elements](/javascript-api/k6-browser/get-started/selecting-elements/)