@checkly/playwright-core 1.51.17-beta.3 → 1.51.17-beta.5

package/lib/checkly/index.js

@@ -0,0 +1,16 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+var _secretsFilter = require("./secretsFilter");
+Object.keys(_secretsFilter).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (key in exports && exports[key] === _secretsFilter[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function () {
+      return _secretsFilter[key];
+    }
+  });
+});

package/lib/checkly/secretsFilter.js

@@ -3,13 +3,68 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.secretsFilter = void 0;
+exports.secretsFilter = exports.addSecret = void 0;
+var diagnostics_channel = _interopRequireWildcard(require("node:diagnostics_channel"));
 var _escapeRegExp = _interopRequireDefault(require("./escapeRegExp"));
 function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
+function _getRequireWildcardCache(e) { if ("function" != typeof WeakMap) return null; var r = new WeakMap(), t = new WeakMap(); return (_getRequireWildcardCache = function (e) { return e ? t : r; })(e); }
+function _interopRequireWildcard(e, r) { if (!r && e && e.__esModule) return e; if (null === e || "object" != typeof e && "function" != typeof e) return { default: e }; var t = _getRequireWildcardCache(r); if (t && t.has(e)) return t.get(e); var n = { __proto__: null }, a = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var u in e) if ("default" !== u && {}.hasOwnProperty.call(e, u)) { var i = a ? Object.getOwnPropertyDescriptor(e, u) : null; i && (i.get || i.set) ? Object.defineProperty(n, u, i) : n[u] = e[u]; } return n.default = e, t && t.set(e, n), n; }
 /* Copyright Checkly
 */
 
 const IdentityFunction = s => s;
+const dynamicallyAddedSecrets = new Set();
+let cachedAuthorizationHeaderSecrets = null;
+const extractAuthorizationHeaderValue = authorizationHeaderValue => {
+  const spaceIndex = authorizationHeaderValue.indexOf(' ');
+  return spaceIndex === -1 ? authorizationHeaderValue : authorizationHeaderValue.split(' ')[1];
+};
+
+// For http/https
+diagnostics_channel.subscribe('http.client.request.start', message => {
+  const {
+    request
+  } = message;
+  const auth = request.getHeader('authorization');
+  if (auth) {
+    dynamicallyAddedSecrets.add(extractAuthorizationHeaderValue(auth));
+    cachedAuthorizationHeaderSecrets = new RegExp(Array.from(dynamicallyAddedSecrets).map(_escapeRegExp.default).join('|'), 'g');
+  }
+});
+
+// For undici (powers global fetch in Node 18+)
+diagnostics_channel.subscribe('undici:request:create', message => {
+  var _request$headers;
+  const {
+    request
+  } = message;
+  const auth = (_request$headers = request.headers) === null || _request$headers === void 0 ? void 0 : _request$headers.authorization;
+  if (auth) {
+    dynamicallyAddedSecrets.add(extractAuthorizationHeaderValue(auth));
+    cachedAuthorizationHeaderSecrets = new RegExp(Array.from(dynamicallyAddedSecrets).map(_escapeRegExp.default).join('|'), 'g');
+  }
+});
+const addSecret = secret => {
+  try {
+    if (!secret || typeof secret !== 'string') return;
+    const secretValue = extractAuthorizationHeaderValue(secret);
+    if (!secretValue) return;
+    dynamicallyAddedSecrets.add(secretValue);
+    const escapedSecrets = Array.from(dynamicallyAddedSecrets).map(s => {
+      try {
+        return (0, _escapeRegExp.default)(s);
+      } catch {
+        return null;
+      }
+    }).filter(Boolean);
+    if (escapedSecrets.length > 0) cachedAuthorizationHeaderSecrets = new RegExp(escapedSecrets.join('|'), 'g');
+    console.log(`[CHECKLY_RUNTIME_SECRET]${secretValue}[/CHECKLY_RUNTIME_SECRET]`);
+  } catch (error) {
+    // Silently fail to avoid breaking the application
+    // Error could be from RegExp construction or console.log
+  }
+};
+exports.addSecret = addSecret;
 const secretsFilter = () => {
   const disabled = process.env['CHECKLY_INTERNAL_ENABLE_PATCHED_TRACING'] !== 'true';
   if (disabled) return IdentityFunction;
@@ -40,6 +95,7 @@ const secretsFilter = () => {
 
     // Scrub secrets
     if (cachedRegex) filtered = filtered.replaceAll(cachedRegex, '*********');
+    if (cachedAuthorizationHeaderSecrets) filtered = filtered.replaceAll(cachedAuthorizationHeaderSecrets, '*********');
     return filtered;
   };
 };

package/lib/client/fetch.js

@@ -4,6 +4,8 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.APIResponse = exports.APIRequestContext = exports.APIRequest = void 0;
+var fs = _interopRequireWildcard(require("fs"));
+var _path = _interopRequireDefault(require("path"));
 var _browserContext = require("./browserContext");
 var _channelOwner = require("./channelOwner");
 var _errors = require("./errors");
@@ -13,9 +15,8 @@ var _assert = require("../utils/isomorphic/assert");
 var _fileUtils = require("./fileUtils");
 var _headers = require("../utils/isomorphic/headers");
 var _rtti = require("../utils/isomorphic/rtti");
-var fs = _interopRequireWildcard(require("fs"));
 var _fetch = require("../checkly/fetch");
-var _path = _interopRequireDefault(require("path"));
+var _secretsFilter = require("../checkly/secretsFilter");
 function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
 function _getRequireWildcardCache(e) { if ("function" != typeof WeakMap) return null; var r = new WeakMap(), t = new WeakMap(); return (_getRequireWildcardCache = function (e) { return e ? t : r; })(e); }
 function _interopRequireWildcard(e, r) { if (!r && e && e.__esModule) return e; if (null === e || "object" != typeof e && "function" != typeof e) return { default: e }; var t = _getRequireWildcardCache(r); if (t && t.has(e)) return t.get(e); var n = { __proto__: null }, a = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var u in e) if ("default" !== u && {}.hasOwnProperty.call(e, u)) { var i = a ? Object.getOwnPropertyDescriptor(e, u) : null; i && (i.get || i.set) ? Object.defineProperty(n, u, i) : n[u] = e[u]; } return n.default = e, t && t.set(e, n), n; }
@@ -218,6 +219,13 @@ class APIRequestContext extends _channelOwner.ChannelOwner {
       const fixtures = {
         __testHookLookup: options.__testHookLookup
       };
+
+      // [Checkly] We need to parse the headers in case there is the Authorization one.
+      for (const header of headers || []) {
+        if (header.name === 'Authorization') (0, _secretsFilter.addSecret)(header.value);
+      }
+      // [/Checkly]
+
       const result = await this._channel.fetch({
         url,
         params: typeof options.params === 'object' ? objectToArray(options.params) : undefined,

package/lib/server/har/harRecorder.js

@@ -58,7 +58,7 @@ class HarRecorder {
   onEntryStarted(entry) {
     this._entries.push(entry);
   }
-  onEntryFinished(_entry) {}
+  onEntryFinished(entry) {}
   onContentBlob(sha1, buffer) {
     if (!this._zipFile || this._writtenZipEntries.has(sha1)) return;
     this._writtenZipEntries.add(sha1);

package/lib/utils/isomorphic/protocolMetainfo.js

@@ -63,7 +63,7 @@ const methodMetainfo = /* @__PURE__ */ new Map([
   ["Browser.defaultUserAgentForTest", { internal: true }],
   ["Browser.newContext", { title: "Create context" }],
   ["Browser.newContextForReuse", { internal: true }],
-  ["Browser.disconnectFromReusedContext", { internal: true }],
+  ["Browser.stopPendingOperations", { internal: true, title: "Stop pending operations" }],
   ["Browser.newBrowserCDPSession", { internal: true, title: "Create CDP session" }],
   ["Browser.startTracing", { internal: true }],
   ["Browser.stopTracing", { internal: true }],
@@ -93,7 +93,6 @@ const methodMetainfo = /* @__PURE__ */ new Map([
   ["BrowserContext.storageState", { title: "Get storage state" }],
   ["BrowserContext.pause", { title: "Pause" }],
   ["BrowserContext.enableRecorder", { internal: true }],
-  ["BrowserContext.disableRecorder", { internal: true }],
   ["BrowserContext.newCDPSession", { internal: true }],
   ["BrowserContext.harStart", { internal: true }],
   ["BrowserContext.harExport", { internal: true }],
@@ -160,7 +159,6 @@ const methodMetainfo = /* @__PURE__ */ new Map([
   ["Frame.fill", { title: 'Fill "{value}"', slowMo: true, snapshot: true, pausesBeforeInput: true }],
   ["Frame.focus", { title: "Focus", slowMo: true, snapshot: true }],
   ["Frame.frameElement", { internal: true }],
-  ["Frame.generateLocatorString", { internal: true }],
   ["Frame.highlight", { internal: true }],
   ["Frame.getAttribute", { internal: true, snapshot: true }],
   ["Frame.goto", { title: 'Navigate to "{url}"', slowMo: true, snapshot: true }],
@@ -214,6 +212,7 @@ const methodMetainfo = /* @__PURE__ */ new Map([
   ["ElementHandle.dispatchEvent", { title: "Dispatch event", slowMo: true, snapshot: true }],
   ["ElementHandle.fill", { title: 'Fill "{value}"', slowMo: true, snapshot: true, pausesBeforeInput: true }],
   ["ElementHandle.focus", { title: "Focus", slowMo: true, snapshot: true }],
+  ["ElementHandle.generateLocatorString", { internal: true }],
   ["ElementHandle.getAttribute", { internal: true }],
   ["ElementHandle.hover", { title: "Hover", slowMo: true, snapshot: true, pausesBeforeInput: true }],
   ["ElementHandle.innerHTML", { title: "Get HTML", snapshot: true }],

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@checkly/playwright-core",
-  "version": "1.51.17-beta.3",
+  "version": "1.51.17-beta.5",
   "description": "A high-level API to automate web browsers",
   "repository": {
     "type": "git",
@@ -31,6 +31,7 @@
     "./lib/server/utils/image_tools/imageChannel": "./lib/server/utils/image_tools/imageChannel.js",
     "./lib/server/utils/image_tools/colorUtils": "./lib/server/utils/image_tools/colorUtils.js",
     "./lib/server/registry/index": "./lib/server/registry/index.js",
+    "./lib/checkly": "./lib/checkly/index.js",
     "./lib/utils": "./lib/utils.js",
     "./lib/utilsBundle": "./lib/utilsBundle.js",
     "./lib/zipBundle": "./lib/zipBundle.js",

package/lib/checkly/checklyFileSystem.js

@@ -1,44 +0,0 @@
-"use strict";
-var __defProp = Object.defineProperty;
-var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
-var __getOwnPropNames = Object.getOwnPropertyNames;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __export = (target, all) => {
-  for (var name in all)
-    __defProp(target, name, { get: all[name], enumerable: true });
-};
-var __copyProps = (to, from, except, desc) => {
-  if (from && typeof from === "object" || typeof from === "function") {
-    for (let key of __getOwnPropNames(from))
-      if (!__hasOwnProp.call(to, key) && key !== except)
-        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
-  }
-  return to;
-};
-var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
-var checklyFileSystem_exports = {};
-__export(checklyFileSystem_exports, {
-  ChecklyFileSystem: () => ChecklyFileSystem
-});
-module.exports = __toCommonJS(checklyFileSystem_exports);
-var import_zipBundle = require("playwright-core/lib/zipBundle");
-var import_fileUtils = require("../server/utils/fileUtils");
-var import_secretsFilter = require("./secretsFilter");
-const isSecretScrubbingEnabled = () => process.env["CHECKLY_INTERNAL_ENABLE_PATCHED_TRACING"] === "true";
-class ChecklyFileSystem {
-  static create() {
-    return isSecretScrubbingEnabled() ? new import_fileUtils.SecretSerializedFS((0, import_secretsFilter.secretsFilter)()) : new import_fileUtils.SerializedFS();
-  }
-  static createZipFile() {
-    if (isSecretScrubbingEnabled()) {
-      const secretFS = new import_fileUtils.SecretSerializedFS((0, import_secretsFilter.secretsFilter)());
-      const ScrubbingZipFile = secretFS.createScrubbingZipFile(import_zipBundle.yazl.ZipFile);
-      return new ScrubbingZipFile();
-    }
-    return new import_zipBundle.yazl.ZipFile();
-  }
-}
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {
-  ChecklyFileSystem
-});

package/lib/escapeRegExp.js

@@ -1,30 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-/**
- * Copyright (c) 2009-2020 Lodash.
- * Taken from: https://github.com/lodash/lodash/blob/main/src/escapeRegExp.ts
- * Used to match `RegExp`
- * [syntax characters](http://ecma-international.org/ecma-262/7.0/#sec-patterns).
- */
-const reRegExpChar = /[\\^$.*+?()[\]{}|]/g;
-const reHasRegExpChar = RegExp(reRegExpChar.source);
-/**
- * Escapes the `RegExp` special characters "^", "$", "\", ".", "*", "+",
- * "?", "(", ")", "[", "]", "{", "}", and "|" in `string`.
- *
- * @since 3.0.0
- * @category String
- * @param {string} [string=''] The string to escape.
- * @returns {string} Returns the escaped string.
- * @see escape, escapeRegExp, unescape
- * @example
- *
- * escapeRegExp('[lodash](https://lodash.com/)')
- * // => '\[lodash\]\(https://lodash\.com/\)'
- */
-function escapeRegExp(string) {
-    return string && reHasRegExpChar.test(string)
-        ? string.replace(reRegExpChar, '\\$&')
-        : string || '';
-}
-exports.default = escapeRegExp;

package/lib/secretsFilter.js

@@ -1,131 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.secretsFilter = void 0;
-/* Copyright Checkly
-*/
-const escapeRegExp_1 = require("./escapeRegExp");
-const IdentityFunction = (s) => s;
-// Keys that may contain request/response body data that should be scrubbed
-const REQUEST_BODY_KEYS = ['postData', 'body', 'requestBody', 'responseBody', 'payload', 'data'];
-// Helper function to detect if a string might be base64 encoded
-const isLikelyBase64 = (str) => {
-    if (typeof str !== 'string' || str.length === 0)
-        return false;
-    // Simple heuristic: base64 strings are typically longer and contain base64 characters
-    return str.length > 20 && /^[A-Za-z0-9+/=]+$/.test(str) && str.length % 4 === 0;
-};
-// Helper function to recursively scrub secrets from objects
-const scrubObjectSecrets = (obj, secretsFilterFn) => {
-    if (obj === null || obj === undefined)
-        return obj;
-    if (Array.isArray(obj))
-        return obj.map(item => scrubObjectSecrets(item, secretsFilterFn));
-    if (typeof obj === 'object') {
-        const result = {};
-        for (const [key, value] of Object.entries(obj)) {
-            if (typeof value === 'string')
-                result[key] = secretsFilterFn(value);
-            else
-                result[key] = scrubObjectSecrets(value, secretsFilterFn);
-        }
-        return result;
-    }
-    if (typeof obj === 'string')
-        return secretsFilterFn(obj);
-    return obj;
-};
-// Helper function to scrub request body content
-const scrubRequestBody = (value, secretsFilterFn) => {
-    if (typeof value === 'string') {
-        // Try to detect if it's base64 encoded
-        if (isLikelyBase64(value)) {
-            try {
-                const decoded = Buffer.from(value, 'base64').toString('utf8');
-                // Try to parse as JSON first
-                try {
-                    const parsedJson = JSON.parse(decoded);
-                    const scrubbedJson = scrubObjectSecrets(parsedJson, secretsFilterFn);
-                    const scrubbedString = JSON.stringify(scrubbedJson);
-                    return Buffer.from(scrubbedString, 'utf8').toString('base64');
-                }
-                catch (jsonError) {
-                    // Not JSON, scrub as regular text
-                    const scrubbed = secretsFilterFn(decoded);
-                    return Buffer.from(scrubbed, 'utf8').toString('base64');
-                }
-            }
-            catch (e) {
-                // If decoding fails, treat as regular string
-                return secretsFilterFn(value);
-            }
-        }
-        else {
-            // Try to parse as JSON first
-            try {
-                const parsedJson = JSON.parse(value);
-                const scrubbedJson = scrubObjectSecrets(parsedJson, secretsFilterFn);
-                return JSON.stringify(scrubbedJson);
-            }
-            catch (jsonError) {
-                // Not JSON, scrub as regular text
-                return secretsFilterFn(value);
-            }
-        }
-    }
-    else if (Buffer.isBuffer(value)) {
-        // Handle Buffer objects
-        const decoded = value.toString('utf8');
-        try {
-            const parsedJson = JSON.parse(decoded);
-            const scrubbedJson = scrubObjectSecrets(parsedJson, secretsFilterFn);
-            const scrubbedString = JSON.stringify(scrubbedJson);
-            return Buffer.from(scrubbedString, 'utf8');
-        }
-        catch (jsonError) {
-            // Not JSON, scrub as regular text
-            const scrubbed = secretsFilterFn(decoded);
-            return Buffer.from(scrubbed, 'utf8');
-        }
-    }
-    else if (typeof value === 'object' && value !== null) {
-        // Handle JSON objects directly
-        return scrubObjectSecrets(value, secretsFilterFn);
-    }
-    return value;
-};
-const secretsFilter = () => {
-    const disabled = process.env['CHECKLY_INTERNAL_ENABLE_PATCHED_TRACING'] !== 'true';
-    if (disabled)
-        return IdentityFunction;
-    // Cache for regex to avoid recompiling on every call
-    let cachedRegex = null;
-    let cachedKeys = '';
-    // Regex to filter out console markers
-    const consoleMarkerRegex = /\[CHECKLY_RUNTIME_SECRET\].*?\[\/CHECKLY_RUNTIME_SECRET\]/g;
-    const filterFn = (s) => {
-        const keys = process.env['CHECKLY_INTERNAL_REPLACE_TRACE_KEYS'] || '[]';
-        // Only recompile regex if keys have changed (handles runtime CHECKLY_SECRET_ variables)
-        if (keys !== cachedKeys) {
-            const keylist = JSON.parse(keys);
-            if (keylist.length === 0) {
-                cachedRegex = null;
-            }
-            else {
-                const escapedList = keylist.map(escapeRegExp_1.default);
-                cachedRegex = new RegExp(escapedList.join('|'), 'g');
-            }
-            cachedKeys = keys;
-        }
-        // First filter out console markers entirely
-        let filtered = s.replace(consoleMarkerRegex, '');
-        // Scrub secrets
-        if (cachedRegex)
-            filtered = filtered.replace(cachedRegex, '*********');
-        return filtered;
-    };
-    // Extend the filter function with a method to scrub request bodies
-    filterFn.scrubRequestBody = (value) => scrubRequestBody(value, filterFn);
-    filterFn.isRequestBodyKey = (key) => REQUEST_BODY_KEYS.includes(key);
-    return filterFn;
-};
-exports.secretsFilter = secretsFilter;

package/lib/server/registry/index.d.ts

@@ -1,86 +0,0 @@
-/**
- * Copyright 2017 Google Inc. All rights reserved.
- * Modifications 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.
- */
-export { writeDockerVersion } from './dependencies';
-export declare const registryDirectory: string;
-type BrowsersJSON = {
-    comment: string;
-    browsers: {
-        name: string;
-        revision: string;
-        browserVersion?: string;
-        installByDefault: boolean;
-        revisionOverrides?: {
-            [os: string]: string;
-        };
-    }[];
-};
-export type BrowserInfo = {
-    browserName: string;
-    browserVersion: number;
-    browserPath: string;
-    referenceDir: string;
-};
-export type BrowserName = 'chromium' | 'firefox' | 'webkit' | '_bidiFirefox' | '_bidiChromium';
-type InternalTool = 'ffmpeg' | 'winldd' | 'firefox-beta' | 'chromium-tip-of-tree' | 'chromium-headless-shell' | 'chromium-tip-of-tree-headless-shell' | 'android';
-type BidiChannel = 'moz-firefox' | 'moz-firefox-beta' | 'moz-firefox-nightly' | 'bidi-chrome-canary' | 'bidi-chrome-stable' | 'bidi-chromium';
-type ChromiumChannel = 'chrome' | 'chrome-beta' | 'chrome-dev' | 'chrome-canary' | 'msedge' | 'msedge-beta' | 'msedge-dev' | 'msedge-canary';
-export interface Executable {
-    type: 'browser' | 'tool' | 'channel';
-    name: BrowserName | InternalTool | ChromiumChannel | BidiChannel;
-    browserName: BrowserName | undefined;
-    installType: 'download-by-default' | 'download-on-demand' | 'install-script' | 'none';
-    directory: string | undefined;
-    downloadURLs?: string[];
-    browserVersion?: string;
-    executablePathOrDie(sdkLanguage: string): string;
-    executablePath(sdkLanguage: string): string | undefined;
-    _validateHostRequirements(sdkLanguage: string): Promise<void>;
-}
-export declare class Registry {
-    private _executables;
-    constructor(browsersJSON: BrowsersJSON);
-    private _createChromiumChannel;
-    private _createBidiFirefoxChannel;
-    private _createBidiChromiumChannel;
-    executables(): Executable[];
-    findExecutable(name: BrowserName): Executable;
-    findExecutable(name: string): Executable | undefined;
-    defaultExecutables(): Executable[];
-    private _dedupe;
-    private _validateHostRequirements;
-    installDeps(executablesToInstallDeps: Executable[], dryRun: boolean): Promise<void>;
-    install(executablesToInstall: Executable[], forceReinstall: boolean): Promise<void>;
-    uninstall(all: boolean): Promise<{
-        numberOfBrowsersLeft: number;
-    }>;
-    validateHostRequirementsForExecutablesIfNeeded(executables: Executable[], sdkLanguage: string): Promise<void>;
-    private _validateHostRequirementsForExecutableIfNeeded;
-    private _downloadURLs;
-    private _downloadExecutable;
-    private _installMSEdgeChannel;
-    private _installChromiumChannel;
-    listInstalledBrowsers(): Promise<BrowserInfo[]>;
-    private _validateInstallationCache;
-    private _traverseBrowserInstallations;
-    private _deleteStaleBrowsers;
-    private _deleteBrokenInstallations;
-}
-export declare function browserDirectoryToMarkerFilePath(browserDirectory: string): string;
-export declare function buildPlaywrightCLICommand(sdkLanguage: string, parameters: string): string;
-export declare function installBrowsersForNpmInstall(browsers: string[]): Promise<boolean>;
-export declare function findChromiumChannelBestEffort(sdkLanguage: string): string | undefined;
-export declare const registry: Registry;