patchright-core 1.48.2 → 1.49.0

package/lib/server/codegen/csharp.js

@@ -130,6 +130,8 @@ class CSharpLanguageGenerator {
           const assertion = action.value ? `ToHaveValueAsync(${quote(action.value)})` : `ToBeEmptyAsync()`;
           return `await Expect(${subject}.${this._asLocator(action.selector)}).${assertion};`;
         }
+      case 'assertSnapshot':
+        return `await Expect(${subject}.${this._asLocator(action.selector)}).ToMatchAriaSnapshotAsync(${quote(action.snapshot)});`;
     }
   }
   _asLocator(selector) {
@@ -149,6 +151,7 @@ class CSharpLanguageGenerator {
       using var playwright = await Playwright.CreateAsync();
       await using var browser = await playwright.${toPascal(options.browserName)}.LaunchAsync(${formatObject(options.launchOptions, '    ', 'BrowserTypeLaunchOptions')});
       var context = await browser.NewContextAsync(${formatContextOptions(options.contextOptions, options.deviceName)});`);
+    if (options.contextOptions.recordHar) formatter.add(`      await context.RouteFromHARAsync(${quote(options.contextOptions.recordHar.path)});`);
     formatter.newLine();
     return formatter.format();
   }
@@ -173,6 +176,7 @@ class CSharpLanguageGenerator {
     formatter.add(`    [${this._mode === 'nunit' ? 'Test' : 'TestMethod'}]
     public async Task MyTest()
     {`);
+    if (options.contextOptions.recordHar) formatter.add(`    await context.RouteFromHARAsync(${quote(options.contextOptions.recordHar.path)});`);
     return formatter.format();
   }
   generateFooter(saveStorage) {
@@ -238,29 +242,20 @@ function getPropertyName(key) {
 function toPascal(value) {
   return value[0].toUpperCase() + value.slice(1);
 }
-function convertContextOptions(options) {
-  const result = {
-    ...options
+function formatContextOptions(contextOptions, deviceName) {
+  let options = {
+    ...contextOptions
   };
-  if (options.recordHar) {
-    result['recordHarPath'] = options.recordHar.path;
-    result['recordHarContent'] = options.recordHar.content;
-    result['recordHarMode'] = options.recordHar.mode;
-    result['recordHarOmitContent'] = options.recordHar.omitContent;
-    result['recordHarUrlFilter'] = options.recordHar.urlFilter;
-    delete result.recordHar;
-  }
-  return result;
-}
-function formatContextOptions(options, deviceName) {
+  // recordHAR is replaced with routeFromHAR in the generated code.
+  delete options.recordHar;
   const device = deviceName && _deviceDescriptors.deviceDescriptors[deviceName];
   if (!device) {
     if (!Object.entries(options).length) return '';
-    return formatObject(convertContextOptions(options), '    ', 'BrowserNewContextOptions');
+    return formatObject(options, '    ', 'BrowserNewContextOptions');
   }
   options = (0, _language.sanitizeDeviceOptions)(device, options);
   if (!Object.entries(options).length) return `playwright.Devices[${quote(deviceName)}]`;
-  return formatObject(convertContextOptions(options), '    ', `BrowserNewContextOptions(playwright.Devices[${quote(deviceName)}])`);
+  return formatObject(options, '    ', `BrowserNewContextOptions(playwright.Devices[${quote(deviceName)}])`);
 }
 class CSharpFormatter {
   constructor(offset = 0) {

package/lib/server/codegen/java.js

@@ -108,7 +108,7 @@ class JavaLanguageGenerator {
       case 'navigate':
         return `${subject}.navigate(${quote(action.url)});`;
       case 'select':
-        return `${subject}.${this._asLocator(action.selector, inFrameLocator)}.selectOption(${formatSelectOption(action.options.length > 1 ? action.options : action.options[0])});`;
+        return `${subject}.${this._asLocator(action.selector, inFrameLocator)}.selectOption(${formatSelectOption(action.options.length === 1 ? action.options[0] : action.options)});`;
       case 'assertText':
         return `assertThat(${subject}.${this._asLocator(action.selector, inFrameLocator)}).${action.substring ? 'containsText' : 'hasText'}(${quote(action.text)});`;
       case 'assertChecked':
@@ -120,6 +120,8 @@ class JavaLanguageGenerator {
           const assertion = action.value ? `hasValue(${quote(action.value)})` : `isEmpty()`;
           return `assertThat(${subject}.${this._asLocator(action.selector, inFrameLocator)}).${assertion};`;
         }
+      case 'assertSnapshot':
+        return `assertThat(${subject}.${this._asLocator(action.selector, inFrameLocator)}).matchesAriaSnapshot(${quote(action.snapshot)});`;
     }
   }
   _asLocator(selector, inFrameLocator) {
@@ -153,6 +155,7 @@ class JavaLanguageGenerator {
         try (Playwright playwright = Playwright.create()) {
           Browser browser = playwright.${options.browserName}().launch(${formatLaunchOptions(options.launchOptions)});
           BrowserContext context = browser.newContext(${formatContextOptions(options.contextOptions, options.deviceName)});`);
+    if (options.contextOptions.recordHar) formatter.add(`          context.routeFromHAR(${quote(options.contextOptions.recordHar.path)});`);
     return formatter.format();
   }
   generateFooter(saveStorage) {
@@ -190,7 +193,6 @@ function formatLaunchOptions(options) {
   return lines.join('\n');
 }
 function formatContextOptions(contextOptions, deviceName) {
-  var _options$recordHar, _options$recordHar2, _options$recordHar3, _options$recordHar4, _options$recordHar5, _options$recordHar6, _options$recordHar7;
   const lines = [];
   if (!Object.keys(contextOptions).length && !deviceName) return '';
   const device = deviceName ? _deviceDescriptors.deviceDescriptors[deviceName] : {};
@@ -208,11 +210,6 @@ function formatContextOptions(contextOptions, deviceName) {
   if (options.isMobile) lines.push(`  .setIsMobile(${options.isMobile})`);
   if (options.locale) lines.push(`  .setLocale(${quote(options.locale)})`);
   if (options.proxy) lines.push(`  .setProxy(new Proxy(${quote(options.proxy.server)}))`);
-  if ((_options$recordHar = options.recordHar) !== null && _options$recordHar !== void 0 && _options$recordHar.content) lines.push(`  .setRecordHarContent(HarContentPolicy.${(_options$recordHar2 = options.recordHar) === null || _options$recordHar2 === void 0 ? void 0 : _options$recordHar2.content.toUpperCase()})`);
-  if ((_options$recordHar3 = options.recordHar) !== null && _options$recordHar3 !== void 0 && _options$recordHar3.mode) lines.push(`  .setRecordHarMode(HarMode.${(_options$recordHar4 = options.recordHar) === null || _options$recordHar4 === void 0 ? void 0 : _options$recordHar4.mode.toUpperCase()})`);
-  if ((_options$recordHar5 = options.recordHar) !== null && _options$recordHar5 !== void 0 && _options$recordHar5.omitContent) lines.push(`  .setRecordHarOmitContent(true)`);
-  if ((_options$recordHar6 = options.recordHar) !== null && _options$recordHar6 !== void 0 && _options$recordHar6.path) lines.push(`  .setRecordHarPath(Paths.get(${quote(options.recordHar.path)}))`);
-  if ((_options$recordHar7 = options.recordHar) !== null && _options$recordHar7 !== void 0 && _options$recordHar7.urlFilter) lines.push(`  .setRecordHarUrlFilter(${quote(options.recordHar.urlFilter)})`);
   if (options.serviceWorkers) lines.push(`  .setServiceWorkers(ServiceWorkerPolicy.${options.serviceWorkers.toUpperCase()})`);
   if (options.storageState) lines.push(`  .setStorageStatePath(Paths.get(${quote(options.storageState)}))`);
   if (options.timezoneId) lines.push(`  .setTimezoneId(${quote(options.timezoneId)})`);

package/lib/server/codegen/javascript.js

@@ -4,6 +4,7 @@ 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");
@@ -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,8 @@ class JavaScriptLanguageGenerator {
           const assertion = action.value ? `toHaveValue(${quote(action.value)})` : `toBeEmpty()`;
           return `${this._isTest ? '' : '// '}await expect(${subject}.${this._asLocator(action.selector)}).${assertion};`;
         }
+      case 'assertSnapshot':
+        return `${this._isTest ? '' : '// '}await expect(${subject}.${this._asLocator(action.selector)}).toMatchAriaSnapshot(${quoteMultiline(action.snapshot)});`;
     }
   }
   _asLocator(selector) {
@@ -119,11 +122,12 @@ 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) formatter.add(`  await page.routeFromHAR(${quote(options.contextOptions.recordHar.path)});`);
     return formatter.format();
   }
   generateTestFooter(saveStorage) {
@@ -136,7 +140,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 +174,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 +199,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 +232,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/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) {
@@ -135,6 +137,7 @@ from playwright.sync_api import Page, expect
 ${fixture}
 
 def test_example(page: Page) -> None {`);
+      if (options.contextOptions.recordHar) formatter.add(`    page.route_from_har(${quote(options.contextOptions.recordHar.path)})`);
     } else if (this._isAsync) {
       formatter.add(`
 import asyncio
@@ -145,6 +148,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 (options.contextOptions.recordHar) formatter.add(`    await page.route_from_har(${quote(options.contextOptions.recordHar.path)})`);
     } else {
       formatter.add(`
 import re
@@ -154,6 +158,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 (options.contextOptions.recordHar) formatter.add(`    context.route_from_har(${quote(options.contextOptions.recordHar.path)})`);
     }
     return formatter.format();
   }
@@ -205,24 +210,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

@@ -9,6 +9,7 @@ var _instrumentation = require("./instrumentation");
 var _recorder = require("./recorder");
 var _recorderApp = require("./recorder/recorderApp");
 var _utils = require("../utils");
+var _ariaSnapshot = require("./ariaSnapshot");
 /**
  * Copyright (c) Microsoft Corporation.
  *
@@ -118,8 +119,10 @@ class DebugController extends _instrumentation.SdkObject {
     };
     this._autoCloseTimer = setTimeout(heartBeat, 30000);
   }
-  async highlight(selector) {
-    for (const recorder of await this._allRecorders()) recorder.setHighlightedSelector(this._sdkLanguage, selector);
+  async highlight(params) {
+    for (const recorder of await this._allRecorders()) {
+      if (params.ariaTemplate) recorder.setHighlightedAriaTemplate((0, _ariaSnapshot.parseYamlForAriaSnapshot)(params.ariaTemplate));else if (params.selector) recorder.setHighlightedSelector(this._sdkLanguage, params.selector);
+    }
   }
   async hideHighlight() {
     // Hide all active recorder highlights.
@@ -197,10 +200,10 @@ 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,
+      selector: elementInfo.selector,
       locator
     });
   }