@checkly/playwright-core 1.41.2-beta.3 → 1.41.2-beta.4

package/lib/checkly/fetch.js

@@ -0,0 +1,106 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.setSWatcherCurrentStepData = exports.parseQueryParameters = exports.initializeTimings = exports.getTimings = exports.getRequestHeaders = exports.getClientCertificates = exports.getBody = exports.addRequestListeners = void 0;
+/**
+ * Get client custom certificates.
+ *
+ * @param {Object} options
+ * @returns Object
+ */
+const getClientCertificates = options => {
+  if (!options.certs) return {};
+  return {
+    cert: options.cert,
+    key: options.key,
+    passphrase: options.passphrase,
+    ca: options.ca
+  };
+};
+exports.getClientCertificates = getClientCertificates;
+const setSWatcherCurrentStepData = (sWatcher, result) => {
+  if (!sWatcher) return;
+  sWatcher.appendCurrentStepData({
+    ...result.response,
+    checklyStepCategory: 'api-call'
+  });
+};
+exports.setSWatcherCurrentStepData = setSWatcherCurrentStepData;
+const getRequestHeaders = headers => {
+  return Object.entries(headers).map(([key, value]) => {
+    return {
+      name: key,
+      value: value
+    };
+  });
+};
+exports.getRequestHeaders = getRequestHeaders;
+const parseQueryParameters = url => {
+  const searchParams = new URL(url).searchParams;
+  const parameters = [];
+  for (const [name, value] of searchParams.entries()) {
+    parameters.push({
+      name,
+      value
+    });
+  }
+  return parameters;
+};
+exports.parseQueryParameters = parseQueryParameters;
+const getTimings = eventTimes => {
+  const {
+    agent,
+    values
+  } = eventTimes;
+  const end = performance.now() - values.startTimeNow;
+  const socket = values.socket || 0;
+  const lookup = values.lookup || socket;
+  const connect = values.connect || lookup;
+  const response = values.response || connect;
+  return {
+    wait: agent ? socket - lookup : socket,
+    dns: agent ? lookup : lookup - socket,
+    tcp: agent ? connect - socket : connect - lookup,
+    firstByte: response - connect,
+    download: end - response,
+    total: end
+  };
+};
+exports.getTimings = getTimings;
+const getBody = body => {
+  const responseBodySizeLimit = 100000;
+  //@ts-ignore
+  const bodyAsText = Buffer.byteLength(body, 'utf-8') > responseBodySizeLimit ? body.slice(0, responseBodySizeLimit).toString('utf8') + '...' : body.toString('utf8');
+  try {
+    return JSON.parse(bodyAsText);
+  } catch {
+    return bodyAsText;
+  }
+};
+exports.getBody = getBody;
+const initializeTimings = () => {
+  return {
+    values: {
+      startTimeNow: performance.now()
+    },
+    agent: false
+  };
+};
+exports.initializeTimings = initializeTimings;
+const addRequestListeners = (request, timings) => {
+  request.on('socket', socket => {
+    timings.values.socket = performance.now() - timings.values.startTimeNow;
+    socket.on('connect', () => {
+      timings.values.connect = performance.now() - timings.values.startTimeNow;
+    });
+    socket.on('lookup', () => {
+      timings.values.lookup = performance.now() - timings.values.startTimeNow;
+    });
+    socket.on('secureConnect', () => {
+      timings.values.tlsHandshake = performance.now() - timings.values.startTimeNow;
+    });
+  });
+};
+exports.addRequestListeners = addRequestListeners;

package/lib/client/fetch.js

@@ -13,6 +13,7 @@ var _channelOwner = require("./channelOwner");
 var _network = require("./network");
 var _tracing = require("./tracing");
 var _errors = require("./errors");
+var _fetch = require("playwright-core/lib/checkly/fetch");
 let _Symbol$asyncDispose, _Symbol$asyncDispose2, _util$inspect$custom;
 /**
  * Copyright (c) Microsoft Corporation.
@@ -55,6 +56,9 @@ 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;
@@ -198,8 +202,12 @@ class APIRequestContext extends _channelOwner.ChannelOwner {
         failOnStatusCode: options.failOnStatusCode,
         ignoreHTTPSErrors: options.ignoreHTTPSErrors,
         maxRedirects: maxRedirects,
-        ...fixtures
+        tokenizedURL: options.tokenizedURL,
+        ...fixtures,
+        ...(0, _fetch.getClientCertificates)(options)
       });
+      //@ts-ignore
+      (0, _fetch.setSWatcherCurrentStepData)(this.__sWatcher__, result);
       return new APIResponse(this, result.response);
     });
   }
@@ -251,6 +259,9 @@ class APIResponse {
   headersArray() {
     return this._headers.headersArray();
   }
+  timings() {
+    return this._initializer.timings;
+  }
   async body() {
     try {
       const result = await this._request._channel.fetchResponseBody({

package/lib/protocol/validator.js

@@ -207,7 +207,12 @@ _validatorPrimitives.scheme.APIRequestContextFetchParams = (0, _validatorPrimiti
   timeout: (0, _validatorPrimitives.tOptional)(_validatorPrimitives.tNumber),
   failOnStatusCode: (0, _validatorPrimitives.tOptional)(_validatorPrimitives.tBoolean),
   ignoreHTTPSErrors: (0, _validatorPrimitives.tOptional)(_validatorPrimitives.tBoolean),
-  maxRedirects: (0, _validatorPrimitives.tOptional)(_validatorPrimitives.tNumber)
+  maxRedirects: (0, _validatorPrimitives.tOptional)(_validatorPrimitives.tNumber),
+  tokenizedURL: (0, _validatorPrimitives.tOptional)(_validatorPrimitives.tString),
+  cert: (0, _validatorPrimitives.tOptional)(_validatorPrimitives.tString),
+  key: (0, _validatorPrimitives.tOptional)(_validatorPrimitives.tString),
+  ca: (0, _validatorPrimitives.tOptional)(_validatorPrimitives.tString),
+  passphrase: (0, _validatorPrimitives.tOptional)(_validatorPrimitives.tString)
 });
 _validatorPrimitives.scheme.APIRequestContextFetchResult = (0, _validatorPrimitives.tObject)({
   response: (0, _validatorPrimitives.tType)('APIResponse')
@@ -240,7 +245,23 @@ _validatorPrimitives.scheme.APIResponse = (0, _validatorPrimitives.tObject)({
   url: _validatorPrimitives.tString,
   status: _validatorPrimitives.tNumber,
   statusText: _validatorPrimitives.tString,
-  headers: (0, _validatorPrimitives.tArray)((0, _validatorPrimitives.tType)('NameValue'))
+  headers: (0, _validatorPrimitives.tArray)((0, _validatorPrimitives.tType)('NameValue')),
+  requestHeaders: (0, _validatorPrimitives.tArray)((0, _validatorPrimitives.tType)('NameValue')),
+  responseHeaders: (0, _validatorPrimitives.tArray)((0, _validatorPrimitives.tType)('NameValue')),
+  body: (0, _validatorPrimitives.tOptional)(_validatorPrimitives.tAny),
+  method: _validatorPrimitives.tString,
+  tokenizedURL: (0, _validatorPrimitives.tOptional)(_validatorPrimitives.tString),
+  timings: (0, _validatorPrimitives.tObject)({
+    wait: (0, _validatorPrimitives.tOptional)(_validatorPrimitives.tNumber),
+    dns: (0, _validatorPrimitives.tOptional)(_validatorPrimitives.tNumber),
+    lookup: (0, _validatorPrimitives.tOptional)(_validatorPrimitives.tNumber),
+    connect: (0, _validatorPrimitives.tOptional)(_validatorPrimitives.tNumber),
+    tcp: (0, _validatorPrimitives.tOptional)(_validatorPrimitives.tNumber),
+    firstByte: (0, _validatorPrimitives.tOptional)(_validatorPrimitives.tNumber),
+    download: (0, _validatorPrimitives.tOptional)(_validatorPrimitives.tNumber),
+    total: (0, _validatorPrimitives.tOptional)(_validatorPrimitives.tNumber)
+  }),
+  queryParams: (0, _validatorPrimitives.tOptional)((0, _validatorPrimitives.tArray)((0, _validatorPrimitives.tType)('NameValue')))
 });
 _validatorPrimitives.scheme.LifecycleEvent = (0, _validatorPrimitives.tEnum)(['load', 'domcontentloaded', 'networkidle', 'commit']);
 _validatorPrimitives.scheme.LocalUtilsInitializer = (0, _validatorPrimitives.tObject)({

package/lib/server/chromium/videoRecorder.js

@@ -25,7 +25,7 @@ var _instrumentation = require("../instrumentation");
  * limitations under the License.
  */
 
-const fps = 25;
+const fps = 12;
 class VideoRecorder {
   static async launch(page, ffmpegPath, options) {
     if (!options.outputFile.endsWith('.webm')) throw new Error('File must have .webm extension');

package/lib/server/dispatchers/networkDispatchers.js

@@ -199,7 +199,14 @@ class APIRequestContextDispatcher extends _dispatcher.Dispatcher {
         status: fetchResponse.status,
         statusText: fetchResponse.statusText,
         headers: fetchResponse.headers,
-        fetchUid: fetchResponse.fetchUid
+        fetchUid: fetchResponse.fetchUid,
+        requestHeaders: fetchResponse.requestHeaders,
+        responseHeaders: fetchResponse.responseHeaders,
+        timings: fetchResponse.timings,
+        queryParams: fetchResponse.queryParams,
+        body: fetchResponse.body,
+        method: fetchResponse.method,
+        tokenizedURL: fetchResponse.tokenizedURL
       }
     };
   }

package/lib/server/fetch.js

@@ -9,6 +9,7 @@ var https = _interopRequireWildcard(require("https"));
 var _stream = require("stream");
 var _url = _interopRequireDefault(require("url"));
 var _zlib = _interopRequireDefault(require("zlib"));
+var _perf_hooks = require("perf_hooks");
 var _timeoutSettings = require("../common/timeoutSettings");
 var _userAgent = require("../utils/userAgent");
 var _utils = require("../utils");
@@ -21,6 +22,7 @@ var _instrumentation = require("./instrumentation");
 var _progress = require("./progress");
 var _tracing = require("./trace/recorder/tracing");
 var _network = require("./network");
+var _fetch = require("playwright-core/lib/checkly/fetch");
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function (nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
 function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || typeof obj !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
@@ -124,7 +126,9 @@ class APIRequestContext extends _instrumentation.SdkObject {
       maxRedirects: params.maxRedirects === 0 ? -1 : params.maxRedirects === undefined ? 20 : params.maxRedirects,
       timeout,
       deadline,
-      __testHookLookup: params.__testHookLookup
+      __testHookLookup: params.__testHookLookup,
+      tokenizedURL: params.tokenizedURL,
+      ...(0, _fetch.getClientCertificates)(params)
     };
     // rejectUnauthorized = undefined is treated as true in node 12.
     if (params.ignoreHTTPSErrors || defaults.ignoreHTTPSErrors) options.rejectUnauthorized = false;
@@ -139,7 +143,14 @@ class APIRequestContext extends _instrumentation.SdkObject {
     if (params.failOnStatusCode && (fetchResponse.status < 200 || fetchResponse.status >= 400)) throw new Error(`${fetchResponse.status} ${fetchResponse.statusText}`);
     return {
       ...fetchResponse,
-      fetchUid
+      fetchUid,
+      requestHeaders: (0, _fetch.getRequestHeaders)(headers),
+      responseHeaders: fetchResponse.headers,
+      queryParams: (0, _fetch.parseQueryParameters)(fetchResponse.url),
+      url: params.tokenizedURL || fetchResponse.url,
+      timings: (0, _fetch.getTimings)(fetchResponse.timings),
+      body: (0, _fetch.getBody)(fetchResponse.body),
+      method: options.method
     };
   }
   _parseSetCookieHeader(responseUrl, setCookie) {
@@ -195,7 +206,9 @@ class APIRequestContext extends _instrumentation.SdkObject {
         ...options,
         agent
       };
+      const timings = (0, _fetch.initializeTimings)();
       const request = requestConstructor(url, requestOptions, async response => {
+        timings.values.response = _perf_hooks.performance.now() - timings.values.startTimeNow;
         const notifyRequestFinished = body => {
           const requestFinishedEvent = {
             requestEvent,
@@ -292,6 +305,7 @@ class APIRequestContext extends _instrumentation.SdkObject {
         response.on('aborted', () => reject(new Error('aborted')));
         const chunks = [];
         const notifyBodyFinished = () => {
+          timings.values.endAt = _perf_hooks.performance.now();
           const body = Buffer.concat(chunks);
           notifyRequestFinished(body);
           fulfill({
@@ -299,7 +313,15 @@ class APIRequestContext extends _instrumentation.SdkObject {
             status: response.statusCode || 0,
             statusText: response.statusMessage || '',
             headers: toHeadersArray(response.rawHeaders),
-            body
+            body,
+            timings: {
+              //@ts-ignore
+              values: {
+                ...timings.values,
+                ..._happyEyeballs.httpHappyEyeballsTimings.values
+              },
+              agent: _happyEyeballs.httpHappyEyeballsTimings.agent || timings.agent
+            }
           });
         };
         let body = response;
@@ -328,6 +350,7 @@ class APIRequestContext extends _instrumentation.SdkObject {
         body.on('data', chunk => chunks.push(chunk));
         body.on('end', notifyBodyFinished);
       });
+      (0, _fetch.addRequestListeners)(request, timings);
       request.on('error', reject);
       const disposeListener = () => {
         reject(new Error('Request context disposed.'));

package/lib/utils/happy-eyeballs.js

@@ -4,7 +4,7 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.createSocket = createSocket;
-exports.httpsHappyEyeballsAgent = exports.httpHappyEyeballsAgent = void 0;
+exports.httpsHappyEyeballsAgent = exports.httpHappyEyeballsTimings = exports.httpHappyEyeballsAgent = void 0;
 var dns = _interopRequireWildcard(require("dns"));
 var http = _interopRequireWildcard(require("http"));
 var https = _interopRequireWildcard(require("https"));
@@ -33,6 +33,15 @@ function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj &&
 // https://www.rfc-editor.org/rfc/rfc8305
 // Same as in Chromium (https://source.chromium.org/chromium/chromium/src/+/5666ff4f5077a7e2f72902f3a95f5d553ea0d88d:net/socket/transport_connect_job.cc;l=102)
 const connectionAttemptDelayMs = 300;
+const timings = {
+  values: {
+    startTimeNow: 0,
+    socket: 0,
+    connect: 0,
+    lookup: 0
+  },
+  agent: false
+};
 class HttpHappyEyeballsAgent extends http.Agent {
   createConnection(options, oncreate) {
     // There is no ambiguity in case of IP address.
@@ -42,6 +51,8 @@ class HttpHappyEyeballsAgent extends http.Agent {
 }
 class HttpsHappyEyeballsAgent extends https.Agent {
   createConnection(options, oncreate) {
+    timings.values.startTimeNow = performance.now();
+    timings.agent = true;
     // There is no ambiguity in case of IP address.
     if (net.isIP(clientRequestArgsToHostName(options))) return tls.connect(options);
     createConnectionAsync(options, oncreate, /* useTLS */true).catch(err => oncreate === null || oncreate === void 0 ? void 0 : oncreate(err));
@@ -49,6 +60,7 @@ class HttpsHappyEyeballsAgent extends https.Agent {
 }
 const httpsHappyEyeballsAgent = exports.httpsHappyEyeballsAgent = new HttpsHappyEyeballsAgent();
 const httpHappyEyeballsAgent = exports.httpHappyEyeballsAgent = new HttpHappyEyeballsAgent();
+const httpHappyEyeballsTimings = exports.httpHappyEyeballsTimings = timings;
 async function createSocket(host, port) {
   return new Promise((resolve, reject) => {
     if (net.isIP(host)) {
@@ -97,10 +109,13 @@ async function createConnectionAsync(options, oncreate, useTLS) {
       port: options.port,
       host: address
     });
+    // Socket created
+    timings.values.socket = performance.now() - timings.values.startTimeNow;
 
     // Each socket may fire only one of 'connect', 'timeout' or 'error' events.
     // None of these events are fired after socket.destroy() is called.
     socket.on('connect', () => {
+      timings.values.connect = performance.now() - timings.values.startTimeNow;
       connected.resolve();
       oncreate === null || oncreate === void 0 ? void 0 : oncreate(null, socket);
       // TODO: Cache the result?
@@ -126,6 +141,7 @@ async function lookupAddresses(hostname) {
     family: 0,
     verbatim: true
   });
+  timings.values.lookup = performance.now() - timings.values.startTimeNow;
   let firstFamily = addresses.filter(({
     family
   }) => family === 6);