@checkly/playwright-core 1.42.12 → 1.42.13

package/lib/checkly/sWatcher.js

@@ -0,0 +1,150 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _promises = _interopRequireDefault(require("fs/promises"));
+var _path = _interopRequireDefault(require("path"));
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+class SWatcher {
+  constructor() {
+    this._outsideRequestsData = [];
+    // Test steps (api calls, assertions) data.
+    this._stepsData = new Map();
+    // Tracking test.step calls.
+    this._testStepIds = [];
+    // Tracking internal step to the matching test.step.
+    this._testStepRawStepData = {};
+  }
+
+  /**
+   * This is to track when a `test.step` statement starts and ends.
+   */
+  appendCurrentTestStepId() {
+    this._testStepIds = [...this._testStepIds, this.getRandomStepId()];
+  }
+
+  /**
+   * This is to add the "test.step" internal Playwright *step* data.
+   *
+   * @param {Object} rawStep
+   */
+  setCurrentTestStepRawStepData(rawStep) {
+    this._testStepRawStepData = {
+      [this.getCurrentTestStepId()]: rawStep
+    };
+  }
+
+  /**
+   * This is to get the parent test.step internal step data when we have nested test.step.
+   * It's useful to tell Playwright that it belongs to a particular test.step otherwise by default PW just adds this
+   * test.step to the root.
+   *
+   * @returns {Object|undefined}
+   */
+  getParentTestStepRawStepData() {
+    return this._testStepRawStepData[this.getParentTestStepId()];
+  }
+
+  /**
+   *
+   * @returns {*}
+   */
+  getCurrentTestStepRawStepData() {
+    return this._testStepRawStepData[this.getCurrentTestStepId()];
+  }
+
+  /**
+   * When a test.step is done, we remove the ID from the tracking array.
+   */
+  removeCurrentTestStepId() {
+    // Current step is always at the end of this._testStepIds
+    this._testStepIds = this._testStepIds.filter(testStepId => testStepId !== this.getCurrentTestStepId());
+  }
+
+  /**
+   * Get n-1 test.step ID.
+   *
+   * @returns {string|null}
+   */
+  getParentTestStepId() {
+    if (this._testStepIds.length <= 1) return null;
+    const [parentTestStepId] = this._testStepIds.slice(-2);
+    return parentTestStepId;
+  }
+
+  /**
+   * Get current test.step ID.
+   *
+   * @returns {string|undefined}
+   */
+  getCurrentTestStepId() {
+    const [currentTestStepId] = this._testStepIds.slice(-1);
+    return currentTestStepId;
+  }
+
+  /**
+   * This is to track when a step (api call, assertion) starts/ends.
+   *
+   * @param {string} stepId
+   */
+  setCurrentStepId(stepId) {
+    this._stepsData.set(stepId, []);
+    this._stepId = stepId;
+  }
+
+  /**
+   * Get a step data (api call with request, body etc.; assertion with expected data etc.).
+   *
+   * @param {string} stepId
+   * @returns {Object}
+   */
+  getStepData(stepId) {
+    return this._stepsData.get(stepId);
+  }
+
+  /**
+   * For some reason, when we have two tests with both api calls and the first test is failing, the stepId counter
+   * is wrong because it set the same stepId for two different api call. This might be a race condition issue with
+   * Playwright.
+   *
+   * To fix this, we use a random string instead of a simple counter.
+   *
+   * @returns {string}
+   */
+  getRandomStepId() {
+    return (Math.random() + 1).toString(36).substring(7);
+  }
+
+  /**
+   * This adds the extra data to the current step (api call, assertion).
+   *
+   * @param {Object} data
+   */
+  appendCurrentStepData(data) {
+    // StepId is defined which means we are inside a step.
+    if (this._stepId) {
+      this._stepsData.set(this._stepId, [...(this._stepsData.get(this._stepId) || []), data]);
+      return;
+    }
+
+    // If stepId is null then it's probably a request without steps
+    // In this case, we push data to a different array in order to track the amount of API call made
+    // to bill it properly.
+    this._outsideRequestsData.push(data);
+  }
+  async dispose() {
+    // @todo rename getRandomStepId to getRandomId
+    await _promises.default.writeFile(_path.default.join(process.env.TEMP_DIR, `apiCalls-${this.getRandomStepId()}.json`), JSON.stringify({
+      outsideRequestsData: this._outsideRequestsData.filter(({
+        checklyStepCategory
+      }) => checklyStepCategory === 'api-call'),
+      stepsData: Array.from(this._stepsData).filter(([, [{
+        checklyStepCategory
+      } = {}]]) => checklyStepCategory === 'api-call')
+    }));
+  }
+}
+var _default = exports.default = new SWatcher();
+//# sourceMappingURL=sWatcher.js.map

package/lib/cli/cli.js

@@ -0,0 +1,62 @@
+#!/usr/bin/env node
+
+/**
+ * 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.
+ */
+
+/* eslint-disable no-console */
+"use strict";
+
+var _utils = require("../utils");
+var _program = _interopRequireDefault(require("./program"));
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+function printPlaywrightTestError(command) {
+  const packages = [];
+  for (const pkg of ['playwright', 'playwright-chromium', 'playwright-firefox', 'playwright-webkit']) {
+    try {
+      require.resolve(pkg);
+      packages.push(pkg);
+    } catch (e) {}
+  }
+  if (!packages.length) packages.push('playwright');
+  const packageManager = (0, _utils.getPackageManager)();
+  if (packageManager === 'yarn') {
+    console.error(`Please install @playwright/test package before running "yarn playwright ${command}"`);
+    console.error(`  yarn remove ${packages.join(' ')}`);
+    console.error('  yarn add -D @playwright/test');
+  } else if (packageManager === 'pnpm') {
+    console.error(`Please install @playwright/test package before running "pnpm exec playwright ${command}"`);
+    console.error(`  pnpm remove ${packages.join(' ')}`);
+    console.error('  pnpm add -D @playwright/test');
+  } else {
+    console.error(`Please install @playwright/test package before running "npx playwright ${command}"`);
+    console.error(`  npm uninstall ${packages.join(' ')}`);
+    console.error('  npm install -D @playwright/test');
+  }
+}
+const kExternalPlaywrightTestCommands = [['test', 'Run tests with Playwright Test.'], ['show-report', 'Show Playwright Test HTML report.'], ['merge-reports', 'Merge Playwright Test Blob reports']];
+function addExternalPlaywrightTestCommands() {
+  for (const [command, description] of kExternalPlaywrightTestCommands) {
+    const playwrightTest = _program.default.command(command).allowUnknownOption(true);
+    playwrightTest.description(`${description} Available in @playwright/test package.`);
+    playwrightTest.action(async () => {
+      printPlaywrightTestError(command);
+      (0, _utils.gracefullyProcessExitDoNotHang)(1);
+    });
+  }
+}
+if (!process.env.PW_LANG_NAME) addExternalPlaywrightTestCommands();
+_program.default.parse(process.argv);
+//# sourceMappingURL=cli.js.map

package/lib/client/channelOwner.js

@@ -185,7 +185,7 @@ class ChannelOwner extends _events.EventEmitter {
       const result = await _zones.zones.run('apiZone', apiZone, async () => {
         return await func(apiZone);
       });
-      csi === null || csi === void 0 || csi.onApiCallEnd(callCookie);
+      csi === null || csi === void 0 || csi.onApiCallEnd(callCookie, null, result);
       logApiCall(logger, `<= ${apiName} succeeded`, isInternal);
       return result;
     } catch (e) {

package/lib/client/fetch.js

@@ -56,9 +56,6 @@ class APIRequest {
       storageState,
       tracesDir
     })).request);
-    // Checkly related code.
-    //@ts-ignore
-    context.__sWatcher__ = options.sWatcher;
     this._contexts.add(context);
     context._request = this;
     context._tracing._tracesDir = tracesDir;
@@ -132,7 +129,13 @@ class APIRequestContext extends _channelOwner.ChannelOwner {
       ...options
     });
   }
+  async writeApiCallToDisk(options) {
+    try {
+      await _fs.default.promises.writeFile(_path.default.join(process.env.TEMP_DIR, 'apiCall-' + (Math.random() + 1).toString(36).substring(7) + '.txt'), options.url !== undefined ? options.url : options.request.url());
+    } catch {}
+  }
   async _innerFetch(options = {}) {
+    this.writeApiCallToDisk(options);
     return await this._wrapApiCall(async () => {
       var _options$request, _options$request2, _options$request3;
       (0, _utils.assert)(options.request || typeof options.url === 'string', 'First argument must be either URL string or Request');
@@ -206,8 +209,6 @@ class APIRequestContext extends _channelOwner.ChannelOwner {
         ...fixtures,
         ...(0, _fetch.getClientCertificates)(options)
       });
-      //@ts-ignore
-      (0, _fetch.setSWatcherCurrentStepData)(this.__sWatcher__, result);
       return new APIResponse(this, result.response);
     });
   }
@@ -297,6 +298,9 @@ class APIResponse {
     }) => `  ${name}: ${value}`);
     return `APIResponse: ${this.status()} ${this.statusText()}\n${headers.join('\n')}`;
   }
+  initializer() {
+    return this._initializer;
+  }
   _fetchUid() {
     return this._initializer.fetchUid;
   }

package/lib/common/debugLogger.js

@@ -0,0 +1,91 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.debugLogger = exports.RecentLogsCollector = void 0;
+var _utilsBundle = require("../utilsBundle");
+var _fs = _interopRequireDefault(require("fs"));
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+/**
+ * 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.
+ */
+
+const debugLoggerColorMap = {
+  'api': 45,
+  // cyan
+  'protocol': 34,
+  // green
+  'install': 34,
+  // green
+  'download': 34,
+  // green
+  'browser': 0,
+  // reset
+  'socks': 92,
+  // purple
+  'error': 160,
+  // red,
+  'channel': 33,
+  // blue
+  'server': 45,
+  // cyan
+  'server:channel': 34,
+  // green
+  'server:metadata': 33 // blue
+};
+
+class DebugLogger {
+  constructor() {
+    this._debuggers = new Map();
+    if (process.env.DEBUG_FILE) {
+      const ansiRegex = new RegExp(['[\\u001B\\u009B][[\\]()#;?]*(?:(?:(?:[a-zA-Z\\d]*(?:;[-a-zA-Z\\d\\/#&.:=?%@~_]*)*)?\\u0007)', '(?:(?:\\d{1,4}(?:;\\d{0,4})*)?[\\dA-PR-TZcf-ntqry=><~]))'].join('|'), 'g');
+      const stream = _fs.default.createWriteStream(process.env.DEBUG_FILE);
+      _utilsBundle.debug.log = data => {
+        stream.write(data.replace(ansiRegex, ''));
+        stream.write('\n');
+      };
+    }
+  }
+  log(name, message) {
+    let cachedDebugger = this._debuggers.get(name);
+    if (!cachedDebugger) {
+      cachedDebugger = (0, _utilsBundle.debug)(`pw:${name}`);
+      this._debuggers.set(name, cachedDebugger);
+      cachedDebugger.color = debugLoggerColorMap[name] || 0;
+    }
+    cachedDebugger(message);
+  }
+  isEnabled(name) {
+    return _utilsBundle.debug.enabled(`pw:${name}`);
+  }
+}
+const debugLogger = exports.debugLogger = new DebugLogger();
+const kLogCount = 150;
+class RecentLogsCollector {
+  constructor() {
+    this._logs = [];
+  }
+  log(message) {
+    this._logs.push(message);
+    if (this._logs.length === kLogCount * 2) this._logs.splice(0, kLogCount);
+  }
+  recentLogs() {
+    if (this._logs.length > kLogCount) return this._logs.slice(-kLogCount);
+    return this._logs;
+  }
+}
+exports.RecentLogsCollector = RecentLogsCollector;
+//# sourceMappingURL=debugLogger.js.map