patchright-core 1.48.2

package/lib/server/codegen/python.js

@@ -0,0 +1,265 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.PythonLanguageGenerator = void 0;
+var _language = require("./language");
+var _utils = require("../../utils");
+var _deviceDescriptors = require("../deviceDescriptors");
+/**
+ * Copyright (c) Microsoft Corporation.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+class PythonLanguageGenerator {
+  constructor(isAsync, isPyTest) {
+    this.id = void 0;
+    this.groupName = 'Python';
+    this.name = void 0;
+    this.highlighter = 'python';
+    this._awaitPrefix = void 0;
+    this._asyncPrefix = void 0;
+    this._isAsync = void 0;
+    this._isPyTest = void 0;
+    this.id = isPyTest ? 'python-pytest' : isAsync ? 'python-async' : 'python';
+    this.name = isPyTest ? 'Pytest' : isAsync ? 'Library Async' : 'Library';
+    this._isAsync = isAsync;
+    this._isPyTest = isPyTest;
+    this._awaitPrefix = isAsync ? 'await ' : '';
+    this._asyncPrefix = isAsync ? 'async ' : '';
+  }
+  generateAction(actionInContext) {
+    const action = actionInContext.action;
+    if (this._isPyTest && (action.name === 'openPage' || action.name === 'closePage')) return '';
+    const pageAlias = actionInContext.frame.pageAlias;
+    const formatter = new PythonFormatter(4);
+    if (action.name === 'openPage') {
+      formatter.add(`${pageAlias} = ${this._awaitPrefix}context.new_page()`);
+      if (action.url && action.url !== 'about:blank' && action.url !== 'chrome://newtab/') formatter.add(`${this._awaitPrefix}${pageAlias}.goto(${quote(action.url)})`);
+      return formatter.format();
+    }
+    const locators = actionInContext.frame.framePath.map(selector => `.${this._asLocator(selector)}.content_frame`);
+    const subject = `${pageAlias}${locators.join('')}`;
+    const signals = (0, _language.toSignalMap)(action);
+    if (signals.dialog) formatter.add(`  ${pageAlias}.once("dialog", lambda dialog: dialog.dismiss())`);
+    let code = `${this._awaitPrefix}${this._generateActionCall(subject, actionInContext)}`;
+    if (signals.popup) {
+      code = `${this._asyncPrefix}with ${pageAlias}.expect_popup() as ${signals.popup.popupAlias}_info {
+        ${code}
+      }
+      ${signals.popup.popupAlias} = ${this._awaitPrefix}${signals.popup.popupAlias}_info.value`;
+    }
+    if (signals.download) {
+      code = `${this._asyncPrefix}with ${pageAlias}.expect_download() as download${signals.download.downloadAlias}_info {
+        ${code}
+      }
+      download${signals.download.downloadAlias} = ${this._awaitPrefix}download${signals.download.downloadAlias}_info.value`;
+    }
+    formatter.add(code);
+    return formatter.format();
+  }
+  _generateActionCall(subject, actionInContext) {
+    const action = actionInContext.action;
+    switch (action.name) {
+      case 'openPage':
+        throw Error('Not reached');
+      case 'closePage':
+        return `${subject}.close()`;
+      case 'click':
+        {
+          let method = 'click';
+          if (action.clickCount === 2) method = 'dblclick';
+          const options = (0, _language.toClickOptionsForSourceCode)(action);
+          const optionsString = formatOptions(options, false);
+          return `${subject}.${this._asLocator(action.selector)}.${method}(${optionsString})`;
+        }
+      case 'check':
+        return `${subject}.${this._asLocator(action.selector)}.check()`;
+      case 'uncheck':
+        return `${subject}.${this._asLocator(action.selector)}.uncheck()`;
+      case 'fill':
+        return `${subject}.${this._asLocator(action.selector)}.fill(${quote(action.text)})`;
+      case 'setInputFiles':
+        return `${subject}.${this._asLocator(action.selector)}.set_input_files(${formatValue(action.files.length === 1 ? action.files[0] : action.files)})`;
+      case 'press':
+        {
+          const modifiers = (0, _language.toKeyboardModifiers)(action.modifiers);
+          const shortcut = [...modifiers, action.key].join('+');
+          return `${subject}.${this._asLocator(action.selector)}.press(${quote(shortcut)})`;
+        }
+      case 'navigate':
+        return `${subject}.goto(${quote(action.url)})`;
+      case 'select':
+        return `${subject}.${this._asLocator(action.selector)}.select_option(${formatValue(action.options.length === 1 ? action.options[0] : action.options)})`;
+      case 'assertText':
+        return `expect(${subject}.${this._asLocator(action.selector)}).${action.substring ? 'to_contain_text' : 'to_have_text'}(${quote(action.text)})`;
+      case 'assertChecked':
+        return `expect(${subject}.${this._asLocator(action.selector)}).${action.checked ? 'to_be_checked()' : 'not_to_be_checked()'}`;
+      case 'assertVisible':
+        return `expect(${subject}.${this._asLocator(action.selector)}).to_be_visible()`;
+      case 'assertValue':
+        {
+          const assertion = action.value ? `to_have_value(${quote(action.value)})` : `to_be_empty()`;
+          return `expect(${subject}.${this._asLocator(action.selector)}).${assertion};`;
+        }
+    }
+  }
+  _asLocator(selector) {
+    return (0, _utils.asLocator)('python', selector);
+  }
+  generateHeader(options) {
+    const formatter = new PythonFormatter();
+    if (this._isPyTest) {
+      const contextOptions = formatContextOptions(options.contextOptions, options.deviceName, true /* asDict */);
+      const fixture = contextOptions ? `
+
+@pytest.fixture(scope="session")
+def browser_context_args(browser_context_args, playwright) {
+    return {${contextOptions}}
+}
+` : '';
+      formatter.add(`${options.deviceName ? 'import pytest\n' : ''}import re
+from playwright.sync_api import Page, expect
+${fixture}
+
+def test_example(page: Page) -> None {`);
+    } else if (this._isAsync) {
+      formatter.add(`
+import asyncio
+import re
+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)})`);
+    } else {
+      formatter.add(`
+import re
+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)})`);
+    }
+    return formatter.format();
+  }
+  generateFooter(saveStorage) {
+    if (this._isPyTest) {
+      return '';
+    } else if (this._isAsync) {
+      const storageStateLine = saveStorage ? `\n    await context.storage_state(path=${quote(saveStorage)})` : '';
+      return `\n    # ---------------------${storageStateLine}
+    await context.close()
+    await browser.close()
+
+
+async def main() -> None:
+    async with async_playwright() as playwright:
+        await run(playwright)
+
+
+asyncio.run(main())
+`;
+    } else {
+      const storageStateLine = saveStorage ? `\n    context.storage_state(path=${quote(saveStorage)})` : '';
+      return `\n    # ---------------------${storageStateLine}
+    context.close()
+    browser.close()
+
+
+with sync_playwright() as playwright:
+    run(playwright)
+`;
+    }
+  }
+}
+exports.PythonLanguageGenerator = PythonLanguageGenerator;
+function formatValue(value) {
+  if (value === false) return 'False';
+  if (value === true) return 'True';
+  if (value === undefined) return 'None';
+  if (Array.isArray(value)) return `[${value.map(formatValue).join(', ')}]`;
+  if (typeof value === 'string') return quote(value);
+  if (typeof value === 'object') return JSON.stringify(value);
+  return String(value);
+}
+function formatOptions(value, hasArguments, asDict) {
+  const keys = Object.keys(value).filter(key => value[key] !== undefined).sort();
+  if (!keys.length) return '';
+  return (hasArguments ? ', ' : '') + keys.map(key => {
+    if (asDict) return `"${(0, _utils.toSnakeCase)(key)}": ${formatValue(value[key])}`;
+    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) {
+  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);
+}
+class PythonFormatter {
+  constructor(offset = 0) {
+    this._baseIndent = void 0;
+    this._baseOffset = void 0;
+    this._lines = [];
+    this._baseIndent = ' '.repeat(4);
+    this._baseOffset = ' '.repeat(offset);
+  }
+  prepend(text) {
+    this._lines = text.trim().split('\n').map(line => line.trim()).concat(this._lines);
+  }
+  add(text) {
+    this._lines.push(...text.trim().split('\n').map(line => line.trim()));
+  }
+  newLine() {
+    this._lines.push('');
+  }
+  format() {
+    let spaces = '';
+    const lines = [];
+    this._lines.forEach(line => {
+      if (line === '') return lines.push(line);
+      if (line === '}') {
+        spaces = spaces.substring(this._baseIndent.length);
+        return;
+      }
+      line = spaces + line;
+      if (line.endsWith('{')) {
+        spaces += this._baseIndent;
+        line = line.substring(0, line.length - 1).trimEnd() + ':';
+      }
+      return lines.push(this._baseOffset + line);
+    });
+    return lines.join('\n');
+  }
+}
+function quote(text) {
+  return (0, _utils.escapeWithQuotes)(text, '\"');
+}

package/lib/server/codegen/types.js

@@ -0,0 +1,5 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});

package/lib/server/console.js

@@ -0,0 +1,57 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.ConsoleMessage = void 0;
+/**
+ * Copyright (c) Microsoft Corporation.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+class ConsoleMessage {
+  constructor(page, type, text, args, location) {
+    this._type = void 0;
+    this._text = void 0;
+    this._args = void 0;
+    this._location = void 0;
+    this._page = void 0;
+    this._page = page;
+    this._type = type;
+    this._text = text;
+    this._args = args;
+    this._location = location || {
+      url: '',
+      lineNumber: 0,
+      columnNumber: 0
+    };
+  }
+  page() {
+    return this._page;
+  }
+  type() {
+    return this._type;
+  }
+  text() {
+    if (this._text === undefined) this._text = this._args.map(arg => arg.preview()).join(' ');
+    return this._text;
+  }
+  args() {
+    return this._args;
+  }
+  location() {
+    return this._location;
+  }
+}
+exports.ConsoleMessage = ConsoleMessage;

package/lib/server/cookieStore.js

@@ -0,0 +1,185 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.CookieStore = void 0;
+exports.domainMatches = domainMatches;
+exports.parseRawCookie = parseRawCookie;
+var _network = require("./network");
+/**
+ * Copyright (c) Microsoft Corporation.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+class Cookie {
+  constructor(data) {
+    this._raw = void 0;
+    this._raw = data;
+  }
+  name() {
+    return this._raw.name;
+  }
+
+  // https://datatracker.ietf.org/doc/html/rfc6265#section-5.4
+  matches(url) {
+    if (this._raw.secure && url.protocol !== 'https:' && url.hostname !== 'localhost') return false;
+    if (!domainMatches(url.hostname, this._raw.domain)) return false;
+    if (!pathMatches(url.pathname, this._raw.path)) return false;
+    return true;
+  }
+  equals(other) {
+    return this._raw.name === other._raw.name && this._raw.domain === other._raw.domain && this._raw.path === other._raw.path;
+  }
+  networkCookie() {
+    return this._raw;
+  }
+  updateExpiresFrom(other) {
+    this._raw.expires = other._raw.expires;
+  }
+  expired() {
+    if (this._raw.expires === -1) return false;
+    return this._raw.expires * 1000 < Date.now();
+  }
+}
+class CookieStore {
+  constructor() {
+    this._nameToCookies = new Map();
+  }
+  addCookies(cookies) {
+    for (const cookie of cookies) this._addCookie(new Cookie(cookie));
+  }
+  cookies(url) {
+    const result = [];
+    for (const cookie of this._cookiesIterator()) {
+      if (cookie.matches(url)) result.push(cookie.networkCookie());
+    }
+    return result;
+  }
+  allCookies() {
+    const result = [];
+    for (const cookie of this._cookiesIterator()) result.push(cookie.networkCookie());
+    return result;
+  }
+  _addCookie(cookie) {
+    let set = this._nameToCookies.get(cookie.name());
+    if (!set) {
+      set = new Set();
+      this._nameToCookies.set(cookie.name(), set);
+    }
+    // https://datatracker.ietf.org/doc/html/rfc6265#section-5.3
+    for (const other of set) {
+      if (other.equals(cookie)) set.delete(other);
+    }
+    set.add(cookie);
+    CookieStore.pruneExpired(set);
+  }
+  *_cookiesIterator() {
+    for (const [name, cookies] of this._nameToCookies) {
+      CookieStore.pruneExpired(cookies);
+      for (const cookie of cookies) yield cookie;
+      if (cookies.size === 0) this._nameToCookies.delete(name);
+    }
+  }
+  static pruneExpired(cookies) {
+    for (const cookie of cookies) {
+      if (cookie.expired()) cookies.delete(cookie);
+    }
+  }
+}
+exports.CookieStore = CookieStore;
+function parseRawCookie(header) {
+  const pairs = header.split(';').filter(s => s.trim().length > 0).map(p => {
+    let key = '';
+    let value = '';
+    const separatorPos = p.indexOf('=');
+    if (separatorPos === -1) {
+      // If only a key is specified, the value is left undefined.
+      key = p.trim();
+    } else {
+      // Otherwise we assume that the key is the element before the first `=`
+      key = p.slice(0, separatorPos).trim();
+      // And the value is the rest of the string.
+      value = p.slice(separatorPos + 1).trim();
+    }
+    return [key, value];
+  });
+  if (!pairs.length) return null;
+  const [name, value] = pairs[0];
+  const cookie = {
+    name,
+    value
+  };
+  for (let i = 1; i < pairs.length; i++) {
+    const [name, value] = pairs[i];
+    switch (name.toLowerCase()) {
+      case 'expires':
+        const expiresMs = +new Date(value);
+        // https://datatracker.ietf.org/doc/html/rfc6265#section-5.2.1
+        if (isFinite(expiresMs)) {
+          if (expiresMs <= 0) cookie.expires = 0;else cookie.expires = Math.min(expiresMs / 1000, _network.kMaxCookieExpiresDateInSeconds);
+        }
+        break;
+      case 'max-age':
+        const maxAgeSec = parseInt(value, 10);
+        if (isFinite(maxAgeSec)) {
+          // From https://datatracker.ietf.org/doc/html/rfc6265#section-5.2.2
+          // If delta-seconds is less than or equal to zero (0), let expiry-time
+          // be the earliest representable date and time.
+          if (maxAgeSec <= 0) cookie.expires = 0;else cookie.expires = Math.min(Date.now() / 1000 + maxAgeSec, _network.kMaxCookieExpiresDateInSeconds);
+        }
+        break;
+      case 'domain':
+        cookie.domain = value.toLocaleLowerCase() || '';
+        if (cookie.domain && !cookie.domain.startsWith('.') && cookie.domain.includes('.')) cookie.domain = '.' + cookie.domain;
+        break;
+      case 'path':
+        cookie.path = value || '';
+        break;
+      case 'secure':
+        cookie.secure = true;
+        break;
+      case 'httponly':
+        cookie.httpOnly = true;
+        break;
+      case 'samesite':
+        switch (value.toLowerCase()) {
+          case 'none':
+            cookie.sameSite = 'None';
+            break;
+          case 'lax':
+            cookie.sameSite = 'Lax';
+            break;
+          case 'strict':
+            cookie.sameSite = 'Strict';
+            break;
+        }
+        break;
+    }
+  }
+  return cookie;
+}
+function domainMatches(value, domain) {
+  if (value === domain) return true;
+  // Only strict match is allowed if domain doesn't start with '.' (host-only-flag is true in the spec)
+  if (!domain.startsWith('.')) return false;
+  value = '.' + value;
+  return value.endsWith(domain);
+}
+function pathMatches(value, path) {
+  if (value === path) return true;
+  if (!value.endsWith('/')) value = value + '/';
+  if (!path.endsWith('/')) path = path + '/';
+  return value.startsWith(path);
+}