internal(browser): Add waitForTimeout to editor and debugger (#1169)

Author: allansson

package-lock.json

@@ -0,0 +1,22 @@
+// Generated by Grafana k6 Studio (0.0.0-vitest) on 2023-10-01T00:00:00.000Z
+
+import { browser } from "k6/browser";
+
+export const options = {
+  scenarios: {
+    default: {
+      executor: "shared-iterations",
+      options: { browser: { type: "chromium" } },
+    },
+  },
+};
+
+export default async function () {
+  const page = await browser.newPage();
+
+  try {
+    await page.waitForTimeout(1500);
+  } finally {
+    await page?.close();
+  }
+}

src/codegen/browser/__snapshots__/browser/wait-for-timeout-statement.ts

@@ -53,6 +53,7 @@ function isBrowserScenario(scenario: ir.Scenario) {
       case 'WaitForExpression':
       case 'WaitForOptionsExpression':
       case 'WaitForNavigationExpression':
+      case 'WaitForTimeoutExpression':
         return true
 
       case 'Identifier':

src/codegen/browser/code/options.ts

@@ -469,6 +469,19 @@ function emitWaitForNavigationExpression(
     .done()
 }
 
+function emitWaitForTimeoutExpression(
+  context: ScenarioContext,
+  expression: ir.WaitForTimeoutExpression
+): ts.Expression {
+  const target = emitExpression(context, expression.target)
+
+  return new ExpressionBuilder(target)
+    .member('waitForTimeout')
+    .call([literal({ value: expression.timeout })])
+    .await(context)
+    .done()
+}
+
 function emitPromiseAllExpression(
   context: ScenarioContext,
   expression: ir.PromiseAllExpression
@@ -571,6 +584,9 @@ function emitExpression(
     case 'WaitForNavigationExpression':
       return emitWaitForNavigationExpression(context, expression)
 
+    case 'WaitForTimeoutExpression':
+      return emitWaitForTimeoutExpression(context, expression)
+
     case 'PromiseAllExpression':
       return emitPromiseAllExpression(context, expression)
 

src/codegen/browser/code/scenario.ts

@@ -1221,6 +1221,30 @@ it('should emit a waitFor statement', async ({ expect }) => {
   )
 })
 
+it('should emit page.waitForTimeout', async ({ expect }) => {
+  const script = await emitScript({
+    defaultScenario: {
+      nodes: [
+        {
+          type: 'page',
+          nodeId: 'page',
+        },
+        {
+          type: 'wait-for-timeout',
+          nodeId: 'wait-for-timeout',
+          timeout: 1500,
+          inputs: { page: { nodeId: 'page' } },
+        },
+      ],
+    },
+    scenarios: {},
+  })
+
+  await expect(script).toMatchFileSnapshot(
+    '__snapshots__/browser/wait-for-timeout-statement.ts'
+  )
+})
+
 it('should emit merged try-finally blocks', async ({ expect }) => {
   const script = await emitScript({
     defaultScenario: {

src/codegen/browser/codegen.test.ts

@@ -152,6 +152,12 @@ export interface WaitForNavigationExpression {
   target: Expression
 }
 
+export interface WaitForTimeoutExpression {
+  type: 'WaitForTimeoutExpression'
+  target: Expression
+  timeout: number
+}
+
 export interface PromiseAllExpression {
   type: 'PromiseAllExpression'
   expressions: Expression[]
@@ -237,6 +243,7 @@ export type Expression =
   | WaitForExpression
   | WaitForOptionsExpression
   | WaitForNavigationExpression
+  | WaitForTimeoutExpression
   | PromiseAllExpression
 
 export interface VariableDeclaration {