@checkly/playwright-core 1.48.22 → 1.51.11-beta.2

package/lib/server/codegen/javascript.js

@@ -4,9 +4,10 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.JavaScriptLanguageGenerator = exports.JavaScriptFormatter = void 0;
+exports.quoteMultiline = quoteMultiline;
 var _language = require("./language");
-var _deviceDescriptors = require("../deviceDescriptors");
 var _utils = require("../../utils");
+var _deviceDescriptors = require("../deviceDescriptors");
 /**
  * Copyright (c) Microsoft Corporation.
  *
@@ -92,7 +93,7 @@ class JavaScriptLanguageGenerator {
       case 'navigate':
         return `await ${subject}.goto(${quote(action.url)});`;
       case 'select':
-        return `await ${subject}.${this._asLocator(action.selector)}.selectOption(${formatObject(action.options.length > 1 ? action.options : action.options[0])});`;
+        return `await ${subject}.${this._asLocator(action.selector)}.selectOption(${formatObject(action.options.length === 1 ? action.options[0] : action.options)});`;
       case 'assertText':
         return `${this._isTest ? '' : '// '}await expect(${subject}.${this._asLocator(action.selector)}).${action.substring ? 'toContainText' : 'toHaveText'}(${quote(action.text)});`;
       case 'assertChecked':
@@ -104,6 +105,11 @@ class JavaScriptLanguageGenerator {
           const assertion = action.value ? `toHaveValue(${quote(action.value)})` : `toBeEmpty()`;
           return `${this._isTest ? '' : '// '}await expect(${subject}.${this._asLocator(action.selector)}).${assertion};`;
         }
+      case 'assertSnapshot':
+        {
+          const commentIfNeeded = this._isTest ? '' : '// ';
+          return `${commentIfNeeded}await expect(${subject}.${this._asLocator(action.selector)}).toMatchAriaSnapshot(${quoteMultiline(action.snapshot, `${commentIfNeeded}  `)});`;
+        }
     }
   }
   _asLocator(selector) {
@@ -119,11 +125,17 @@ class JavaScriptLanguageGenerator {
   }
   generateTestHeader(options) {
     const formatter = new JavaScriptFormatter();
-    const useText = formatContextOptions(options.contextOptions, options.deviceName);
+    const useText = formatContextOptions(options.contextOptions, options.deviceName, this._isTest);
     formatter.add(`
       import { test, expect${options.deviceName ? ', devices' : ''} } from '@playwright/test';
 ${useText ? '\ntest.use(' + useText + ');\n' : ''}
       test('test', async ({ page }) => {`);
+    if (options.contextOptions.recordHar) {
+      const url = options.contextOptions.recordHar.urlFilter;
+      formatter.add(`  await page.routeFromHAR(${quote(options.contextOptions.recordHar.path)}${url ? `, ${formatOptions({
+        url
+      }, false)}` : ''});`);
+    }
     return formatter.format();
   }
   generateTestFooter(saveStorage) {
@@ -136,7 +148,8 @@ ${useText ? '\ntest.use(' + useText + ');\n' : ''}
 
       (async () => {
         const browser = await ${options.browserName}.launch(${formatObjectOrVoid(options.launchOptions)});
-        const context = await browser.newContext(${formatContextOptions(options.contextOptions, options.deviceName)});`);
+        const context = await browser.newContext(${formatContextOptions(options.contextOptions, options.deviceName, false)});`);
+    if (options.contextOptions.recordHar) formatter.add(`        await context.routeFromHAR(${quote(options.contextOptions.recordHar.path)});`);
     return formatter.format();
   }
   generateStandaloneFooter(saveStorage) {
@@ -169,8 +182,13 @@ function formatObjectOrVoid(value, indent = '  ') {
   const result = formatObject(value, indent);
   return result === '{}' ? '' : result;
 }
-function formatContextOptions(options, deviceName) {
+function formatContextOptions(options, deviceName, isTest) {
   const device = deviceName && _deviceDescriptors.deviceDescriptors[deviceName];
+  // recordHAR is replaced with routeFromHAR in the generated code.
+  options = {
+    ...options,
+    recordHar: undefined
+  };
   if (!device) return formatObjectOrVoid(options);
   // Filter out all the properties from the device descriptor.
   let serializedObject = formatObjectOrVoid((0, _language.sanitizeDeviceOptions)(device, options));
@@ -189,10 +207,12 @@ class JavaScriptFormatter {
     this._baseOffset = ' '.repeat(offset);
   }
   prepend(text) {
-    this._lines = text.trim().split('\n').map(line => line.trim()).concat(this._lines);
+    const trim = isMultilineString(text) ? line => line : line => line.trim();
+    this._lines = text.trim().split('\n').map(trim).concat(this._lines);
   }
   add(text) {
-    this._lines.push(...text.trim().split('\n').map(line => line.trim()));
+    const trim = isMultilineString(text) ? line => line : line => line.trim();
+    this._lines.push(...text.trim().split('\n').map(trim));
   }
   newLine() {
     this._lines.push('');
@@ -220,4 +240,14 @@ function wrapWithStep(description, body) {
   return description ? `await test.step(\`${description}\`, async () => {
 ${body}
 });` : body;
+}
+function quoteMultiline(text, indent = '  ') {
+  const escape = text => text.replace(/\\/g, '\\\\').replace(/`/g, '\\`').replace(/\$\{/g, '\\${');
+  const lines = text.split('\n');
+  if (lines.length === 1) return '`' + escape(text) + '`';
+  return '`\n' + lines.map(line => indent + escape(line).replace(/\${/g, '\\${')).join('\n') + `\n${indent}\``;
+}
+function isMultilineString(text) {
+  var _text$match;
+  return (_text$match = text.match(/`[\S\s]*`/)) === null || _text$match === void 0 ? void 0 : _text$match[0].includes('\n');
 }

package/lib/server/codegen/jsonl.js

@@ -32,7 +32,7 @@ class JsonlLanguageGenerator {
     const locator = actionInContext.action.selector ? JSON.parse((0, _utils.asLocator)('jsonl', actionInContext.action.selector)) : undefined;
     const entry = {
       ...actionInContext.action,
-      pageAlias: actionInContext.frame.pageAlias,
+      ...actionInContext.frame,
       locator
     };
     return JSON.stringify(entry);

package/lib/server/codegen/languages.js

@@ -4,10 +4,10 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.languageSet = languageSet;
+var _csharp = require("./csharp");
 var _java = require("./java");
 var _javascript = require("./javascript");
 var _jsonl = require("./jsonl");
-var _csharp = require("./csharp");
 var _python = require("./python");
 /**
  * Copyright (c) Microsoft Corporation.
@@ -26,5 +26,5 @@ var _python = require("./python");
  */
 
 function languageSet() {
-  return new Set([new _java.JavaLanguageGenerator('junit'), new _java.JavaLanguageGenerator('library'), new _javascript.JavaScriptLanguageGenerator( /* isPlaywrightTest */false), new _javascript.JavaScriptLanguageGenerator( /* isPlaywrightTest */true), new _python.PythonLanguageGenerator( /* isAsync */false, /* isPytest */true), new _python.PythonLanguageGenerator( /* isAsync */false, /* isPytest */false), new _python.PythonLanguageGenerator( /* isAsync */true, /* isPytest */false), new _csharp.CSharpLanguageGenerator('mstest'), new _csharp.CSharpLanguageGenerator('nunit'), new _csharp.CSharpLanguageGenerator('library'), new _jsonl.JsonlLanguageGenerator()]);
+  return new Set([new _java.JavaLanguageGenerator('junit'), new _java.JavaLanguageGenerator('library'), new _javascript.JavaScriptLanguageGenerator(/* isPlaywrightTest */false), new _javascript.JavaScriptLanguageGenerator(/* isPlaywrightTest */true), new _python.PythonLanguageGenerator(/* isAsync */false, /* isPytest */true), new _python.PythonLanguageGenerator(/* isAsync */false, /* isPytest */false), new _python.PythonLanguageGenerator(/* isAsync */true, /* isPytest */false), new _csharp.CSharpLanguageGenerator('mstest'), new _csharp.CSharpLanguageGenerator('nunit'), new _csharp.CSharpLanguageGenerator('library'), new _jsonl.JsonlLanguageGenerator()]);
 }

package/lib/server/codegen/python.js

@@ -114,6 +114,8 @@ class PythonLanguageGenerator {
           const assertion = action.value ? `to_have_value(${quote(action.value)})` : `to_be_empty()`;
           return `expect(${subject}.${this._asLocator(action.selector)}).${assertion};`;
         }
+      case 'assertSnapshot':
+        return `expect(${subject}.${this._asLocator(action.selector)}).to_match_aria_snapshot(${quote(action.snapshot)})`;
     }
   }
   _asLocator(selector) {
@@ -121,6 +123,7 @@ class PythonLanguageGenerator {
   }
   generateHeader(options) {
     const formatter = new PythonFormatter();
+    const recordHar = options.contextOptions.recordHar;
     if (this._isPyTest) {
       const contextOptions = formatContextOptions(options.contextOptions, options.deviceName, true /* asDict */);
       const fixture = contextOptions ? `
@@ -130,11 +133,12 @@ def browser_context_args(browser_context_args, playwright) {
     return {${contextOptions}}
 }
 ` : '';
-      formatter.add(`${options.deviceName ? 'import pytest\n' : ''}import re
+      formatter.add(`${options.deviceName || contextOptions ? 'import pytest\n' : ''}import re
 from playwright.sync_api import Page, expect
 ${fixture}
 
 def test_example(page: Page) -> None {`);
+      if (recordHar) formatter.add(`    page.route_from_har(${quote(recordHar.path)}${typeof recordHar.urlFilter === 'string' ? `, url=${quote(recordHar.urlFilter)}` : ''})`);
     } else if (this._isAsync) {
       formatter.add(`
 import asyncio
@@ -145,6 +149,7 @@ from playwright.async_api import Playwright, async_playwright, expect
 async def run(playwright: Playwright) -> None {
     browser = await playwright.${options.browserName}.launch(${formatOptions(options.launchOptions, false)})
     context = await browser.new_context(${formatContextOptions(options.contextOptions, options.deviceName)})`);
+      if (recordHar) formatter.add(`    await context.route_from_har(${quote(recordHar.path)}${typeof recordHar.urlFilter === 'string' ? `, url=${quote(recordHar.urlFilter)}` : ''})`);
     } else {
       formatter.add(`
 import re
@@ -154,6 +159,7 @@ from playwright.sync_api import Playwright, sync_playwright, expect
 def run(playwright: Playwright) -> None {
     browser = playwright.${options.browserName}.launch(${formatOptions(options.launchOptions, false)})
     context = browser.new_context(${formatContextOptions(options.contextOptions, options.deviceName)})`);
+      if (recordHar) formatter.add(`    context.route_from_har(${quote(recordHar.path)}${typeof recordHar.urlFilter === 'string' ? `, url=${quote(recordHar.urlFilter)}` : ''})`);
     }
     return formatter.format();
   }
@@ -205,24 +211,15 @@ function formatOptions(value, hasArguments, asDict) {
     return `${(0, _utils.toSnakeCase)(key)}=${formatValue(value[key])}`;
   }).join(', ');
 }
-function convertContextOptions(options) {
-  const result = {
-    ...options
-  };
-  if (options.recordHar) {
-    result['record_har_path'] = options.recordHar.path;
-    result['record_har_content'] = options.recordHar.content;
-    result['record_har_mode'] = options.recordHar.mode;
-    result['record_har_omit_content'] = options.recordHar.omitContent;
-    result['record_har_url_filter'] = options.recordHar.urlFilter;
-    delete result.recordHar;
-  }
-  return result;
-}
 function formatContextOptions(options, deviceName, asDict) {
+  // recordHAR is replaced with routeFromHAR in the generated code.
+  options = {
+    ...options,
+    recordHar: undefined
+  };
   const device = deviceName && _deviceDescriptors.deviceDescriptors[deviceName];
-  if (!device) return formatOptions(convertContextOptions(options), false, asDict);
-  return `**playwright.devices[${quote(deviceName)}]` + formatOptions(convertContextOptions((0, _language.sanitizeDeviceOptions)(device, options)), true, asDict);
+  if (!device) return formatOptions(options, false, asDict);
+  return `**playwright.devices[${quote(deviceName)}]` + formatOptions((0, _language.sanitizeDeviceOptions)(device, options), true, asDict);
 }
 class PythonFormatter {
   constructor(offset = 0) {

package/lib/server/debugController.js

@@ -4,11 +4,14 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.DebugController = void 0;
-var _processLauncher = require("../utils/processLauncher");
 var _instrumentation = require("./instrumentation");
+var _processLauncher = require("./utils/processLauncher");
 var _recorder = require("./recorder");
-var _recorderApp = require("./recorder/recorderApp");
 var _utils = require("../utils");
+var _ariaSnapshot = require("../utils/isomorphic/ariaSnapshot");
+var _utilsBundle = require("../utilsBundle");
+var _recorderApp = require("./recorder/recorderApp");
+var _locatorParser = require("../utils/isomorphic/locatorParser");
 /**
  * Copyright (c) Microsoft Corporation.
  *
@@ -34,9 +37,6 @@ class DebugController extends _instrumentation.SdkObject {
       },
       instrumentation: (0, _instrumentation.createInstrumentation)()
     }, undefined, 'DebugController');
-    this._autoCloseTimer = void 0;
-    // TODO: remove in 1.27
-    this._autoCloseAllowed = false;
     this._trackHierarchyListener = void 0;
     this._playwright = void 0;
     this._sdkLanguage = 'javascript';
@@ -47,20 +47,17 @@ class DebugController extends _instrumentation.SdkObject {
     this._codegenId = codegenId;
     this._sdkLanguage = sdkLanguage;
   }
-  setAutoCloseAllowed(allowed) {
-    this._autoCloseAllowed = allowed;
-  }
   dispose() {
     this.setReportStateChanged(false);
-    this.setAutoCloseAllowed(false);
   }
   setReportStateChanged(enabled) {
     if (enabled && !this._trackHierarchyListener) {
       this._trackHierarchyListener = {
-        onPageOpen: () => this._emitSnapshot(),
-        onPageClose: () => this._emitSnapshot()
+        onPageOpen: () => this._emitSnapshot(false),
+        onPageClose: () => this._emitSnapshot(false)
       };
       this._playwright.instrumentation.addListener(this._trackHierarchyListener, null);
+      this._emitSnapshot(true);
     } else if (!enabled && this._trackHierarchyListener) {
       this._playwright.instrumentation.removeListener(this._trackHierarchyListener);
       this._trackHierarchyListener = undefined;
@@ -82,7 +79,6 @@ class DebugController extends _instrumentation.SdkObject {
         recorder.hideHighlightedSelector();
         recorder.setMode('none');
       }
-      this.setAutoCloseEnabled(true);
       return;
     }
     if (!this._playwright.allBrowsers().length) await this._playwright.chromium.launch(internalMetadata, {
@@ -107,19 +103,14 @@ class DebugController extends _instrumentation.SdkObject {
       if (params.mode !== 'inspecting') recorder.setOutput(this._codegenId, params.file);
       recorder.setMode(params.mode);
     }
-    this.setAutoCloseEnabled(true);
-  }
-  async setAutoCloseEnabled(enabled) {
-    if (!this._autoCloseAllowed) return;
-    if (this._autoCloseTimer) clearTimeout(this._autoCloseTimer);
-    if (!enabled) return;
-    const heartBeat = () => {
-      if (!this._playwright.allPages().length) (0, _processLauncher.gracefullyProcessExitDoNotHang)(0);else this._autoCloseTimer = setTimeout(heartBeat, 5000);
-    };
-    this._autoCloseTimer = setTimeout(heartBeat, 30000);
   }
-  async highlight(selector) {
-    for (const recorder of await this._allRecorders()) recorder.setHighlightedSelector(this._sdkLanguage, selector);
+  async highlight(params) {
+    // Assert parameters validity.
+    if (params.selector) (0, _locatorParser.unsafeLocatorOrSelectorAsSelector)(this._sdkLanguage, params.selector, 'data-testid');
+    const ariaTemplate = params.ariaTemplate ? (0, _ariaSnapshot.parseAriaSnapshotUnsafe)(_utilsBundle.yaml, params.ariaTemplate) : undefined;
+    for (const recorder of await this._allRecorders()) {
+      if (ariaTemplate) recorder.setHighlightedAriaTemplate(ariaTemplate);else if (params.selector) recorder.setHighlightedSelector(this._sdkLanguage, params.selector);
+    }
   }
   async hideHighlight() {
     // Hide all active recorder highlights.
@@ -141,23 +132,9 @@ class DebugController extends _instrumentation.SdkObject {
       reason: 'Close all browsers requested'
     })));
   }
-  _emitSnapshot() {
-    const browsers = [];
-    let pageCount = 0;
-    for (const browser of this._playwright.allBrowsers()) {
-      const b = {
-        contexts: []
-      };
-      browsers.push(b);
-      for (const context of browser.contexts()) {
-        const c = {
-          pages: []
-        };
-        b.contexts.push(c);
-        for (const page of context.pages()) c.pages.push(page.mainFrame().url());
-        pageCount += context.pages().length;
-      }
-    }
+  _emitSnapshot(initial) {
+    const pageCount = this._playwright.allPages().length;
+    if (initial && !pageCount) return;
     this.emit(DebugController.Events.StateChanged, {
       pageCount
     });
@@ -197,11 +174,12 @@ class InspectingRecorderApp extends _recorderApp.EmptyRecorderApp {
     this._debugController = void 0;
     this._debugController = debugController;
   }
-  async setSelector(selector) {
-    const locator = (0, _utils.asLocator)(this._debugController._sdkLanguage, selector);
+  async elementPicked(elementInfo) {
+    const locator = (0, _utils.asLocator)(this._debugController._sdkLanguage, elementInfo.selector);
     this._debugController.emit(DebugController.Events.InspectRequested, {
-      selector,
-      locator
+      selector: elementInfo.selector,
+      locator,
+      ariaSnapshot: elementInfo.ariaSnapshot
     });
   }
   async setSources(sources) {

package/lib/server/debugger.js

@@ -121,7 +121,7 @@ function shouldPauseBeforeStep(metadata) {
   if (!metadata.apiName) return false;
   // Always stop on 'close'
   if (metadata.method === 'close') return true;
-  if (metadata.method === 'waitForSelector' || metadata.method === 'waitForEventInfo') return false; // Never stop on those, primarily for the test harness.
+  if (metadata.method === 'waitForSelector' || metadata.method === 'waitForEventInfo' || metadata.method === 'querySelector' || metadata.method === 'querySelectorAll') return false; // Never stop on those, primarily for the test harness.
   const step = metadata.type + '.' + metadata.method;
   // Stop before everything that generates snapshot. But don't stop before those marked as pausesBeforeInputActions
   // since we stop in them on a separate instrumentation signal.

package/lib/server/deviceDescriptors.js

@@ -5,7 +5,7 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.deviceDescriptors = void 0;
 var _deviceDescriptorsSource = _interopRequireDefault(require("./deviceDescriptorsSource.json"));
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
 /**
  * Copyright 2017 Google Inc. All rights reserved.
  * Modifications copyright (c) Microsoft Corporation.