@elastic/synthetics 1.0.0-beta.21 → 1.0.0-beta.24

package/src/options.ts

@@ -0,0 +1,116 @@
+/**
+ * MIT License
+ *
+ * Copyright (c) 2020-present, Elastic NV
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ *
+ */
+
+import merge from 'deepmerge';
+import { readConfig } from './config';
+import { parseNetworkConditions } from './helpers';
+import type { CliArgs, RunOptions } from './common_types';
+
+/**
+ * Set debug based on DEBUG ENV and -d flags
+ * namespace - synthetics
+ */
+const namespace = 'synthetics';
+if (process.env.DEBUG && process.env.DEBUG.includes(namespace)) {
+  process.env.DEBUG = '1';
+}
+
+export function normalizeOptions(cliArgs: CliArgs): RunOptions {
+  const options: RunOptions = {
+    ...cliArgs,
+    environment: process.env['NODE_ENV'] || 'development',
+  };
+  /**
+   * Group all events that can be consumed by heartbeat and
+   * eventually by the Synthetics UI.
+   */
+  if (cliArgs.richEvents) {
+    options.reporter = cliArgs.reporter ?? 'json';
+    options.ssblocks = true;
+    options.network = true;
+    options.trace = true;
+    options.quietExitCode = true;
+  }
+
+  if (cliArgs.capability) {
+    const supportedCapabilities = [
+      'trace',
+      'network',
+      'filmstrips',
+      'metrics',
+      'ssblocks',
+    ];
+    /**
+     * trace - record chrome trace events(LCP, FCP, CLS, etc.) for all journeys
+     * network - capture network information for all journeys
+     * filmstrips - record detailed filmstrips for all journeys
+     * metrics - capture performance metrics (DOM Nodes, Heap size, etc.) for each step
+     * ssblocks - Dedupes the screenshots in to blocks to save storage space
+     */
+    for (const flag of cliArgs.capability) {
+      if (supportedCapabilities.includes(flag)) {
+        options[flag] = true;
+      } else {
+        console.warn(
+          `Missing capability "${flag}", current supported capabilities are ${supportedCapabilities.join(
+            ', '
+          )}`
+        );
+      }
+    }
+  }
+
+  /**
+   * Validate and read synthetics config file
+   * based on the environment
+   */
+  const config =
+    cliArgs.config || !cliArgs.inline
+      ? readConfig(options.environment, cliArgs.config)
+      : {};
+
+  options.params = Object.freeze(merge(config.params, cliArgs.params || {}));
+
+  /**
+   * Favor playwright options passed via cli to inline playwright options
+   */
+  options.playwrightOptions = merge.all([
+    config.playwrightOptions || {},
+    cliArgs.playwrightOptions || {},
+    {
+      headless: cliArgs.headless,
+      chromiumSandbox: cliArgs.sandbox,
+      ignoreHTTPSErrors: cliArgs.ignoreHttpsErrors,
+    },
+  ]);
+
+  if (cliArgs.throttling) {
+    options.networkConditions = parseNetworkConditions(
+      cliArgs.throttling as string
+    );
+  }
+
+  return options;
+}

package/src/plugins/network.ts

@@ -23,7 +23,7 @@
  *
  */
 
-import { Protocol } from 'playwright-chromium/types/protocol';
+import { Protocol } from 'playwright-core/types/protocol';
 import { NetworkInfo, BrowserInfo, Driver } from '../common_types';
 import { Step } from '../dsl';
 import { getTimestamp } from '../helpers';
@@ -64,14 +64,14 @@ export class NetworkManager {
   }
 
   _onRequestWillBeSent(event: Protocol.Network.requestWillBeSentPayload) {
-    const { requestId, request, timestamp, type, loaderId } = event;
-    const { url, method } = request;
+    const { url, method, postData, headers } = event.request;
     /**
      * Data URI should not show up as network requests
      */
     if (url.startsWith('data:')) {
       return;
     }
+    const { requestId, timestamp, type, loaderId } = event;
     const isNavigationRequest = requestId == loaderId && type === 'Document';
     const record = this._findNetworkRecord(requestId);
     /**
@@ -81,11 +81,13 @@ export class NetworkManager {
      */
     if (record) {
       if (event.redirectResponse) {
+        record.response.redirectURL = url;
         const response = event.redirectResponse;
         const data = Object.assign(event, {
           type: event.type,
           response,
           encodedDataLength: response.encodedDataLength,
+          hasExtraInfo: false,
         });
         this._onResponseReceived(data);
         this._onLoadingFinished(data);
@@ -117,15 +119,23 @@ export class NetworkManager {
       step: this._currentStep,
       timestamp: getTimestamp(),
       url,
-      request,
       type,
-      method,
-      requestSentTime: timestamp,
+      request: {
+        url,
+        method,
+        headers,
+        bytes: postData?.length || 0,
+      },
+      response: {
+        status: -1,
+        mimeType: 'x-unknown',
+        headers: {},
+        timing: null,
+      },
       isNavigationRequest,
-      status: 0,
-      loadEndTime: -1,
+      requestSentTime: timestamp,
       responseReceivedTime: -1,
-      response: null,
+      loadEndTime: -1,
       resourceSize: 0,
       transferSize: 0,
       timings: null,
@@ -147,6 +157,7 @@ export class NetworkManager {
       ...record.request.headers,
       ...headers,
     };
+    record.request.referrer = record.request.headers?.Referer;
   }
 
   _onDataReceived(event: Protocol.Network.dataReceivedPayload) {
@@ -165,12 +176,31 @@ export class NetworkManager {
     if (!record) {
       return;
     }
-    Object.assign(record, {
+
+    record.responseReceivedTime = timestamp;
+    record.transferSize = response.encodedDataLength;
+    record.response = {
+      url: response.url,
       status: response.status,
-      response,
-      responseReceivedTime: timestamp,
-      transferSize: response.encodedDataLength,
-    });
+      protocol: response.protocol,
+      statusText: response.statusText,
+      headers: response.headers,
+      mimeType: response.mimeType,
+      remoteIPAddress: response.remoteIPAddress,
+      remotePort: response.remotePort,
+      fromServiceWorker: response.fromServiceWorker,
+      redirectURL: record.response.redirectURL,
+      timing: response.timing,
+    };
+    if (response.securityDetails) {
+      record.response.securityDetails = {
+        protocol: response.securityDetails.protocol,
+        subjectName: response.securityDetails.subjectName,
+        issuer: response.securityDetails.issuer,
+        validFrom: response.securityDetails.validFrom,
+        validTo: response.securityDetails.validTo,
+      };
+    }
   }
 
   _onLoadingFinished(event: Protocol.Network.loadingFinishedPayload) {
@@ -194,6 +224,9 @@ export class NetworkManager {
     }
     if (encodedDataLength >= 0) {
       record.transferSize = encodedDataLength;
+      record.response.body = {
+        bytes: encodedDataLength,
+      };
     }
     record.loadEndTime = endTime;
     record.timings = calculateTimings(record);
@@ -250,17 +283,6 @@ export function calculateTimings(record: NetworkInfo) {
     receive: -1,
     total: -1,
   };
-  const { requestSentTime, loadEndTime, responseReceivedTime } = record;
-
-  /**
-   * Handle when request failed and no responseReceived event was
-   * fired for that particular request
-   * Eg: connection refused by remote host
-   */
-  const response = record.response || {
-    timing: null,
-    fromServiceWorker: false,
-  };
 
   const toMilliseconds = (time: number) => (time === -1 ? -1 : time * 1000);
   const calculateDiffInMs = (
@@ -293,6 +315,8 @@ export function calculateTimings(record: NetworkInfo) {
       calculateDiffInMs(name, startTime + start / 1000, startTime + end / 1000);
     }
   };
+  const { requestSentTime, loadEndTime, responseReceivedTime, response } =
+    record;
   const timing = response.timing;
   const actResRcvdTime = getResponseReceivedTime(timing, responseReceivedTime);
   const issueTime = requestSentTime;

package/src/reporters/base.ts

@@ -70,8 +70,13 @@ export default class BaseReporter {
      * before destroying the pipe with underlying file descriptor
      */
     this.stream = new SonicBoom({ fd: this.fd, sync: true, minLength: 1 });
+
+    // flushSync is used here to make sure all the data from the underlying
+    // SonicBoom stream buffer is completely written to the fd before closing
+    // the process
+    this.runner.on('end', () => this.stream.flushSync());
+
     this._registerListeners();
-    this.runner.on('end', () => this.stream.flush());
   }
 
   _registerListeners() {

package/src/reporters/json.ts

@@ -40,6 +40,7 @@ import { Journey, Step } from '../dsl';
 import snakeCaseKeys from 'snakecase-keys';
 import {
   NetworkInfo,
+  SecurityDetails,
   NetworkConditions,
   TraceOutput,
   StatusValue,
@@ -47,7 +48,6 @@ import {
   Params,
   Screenshot,
 } from '../common_types';
-import { Protocol } from 'playwright-chromium/types/protocol';
 import { PageMetrics } from '../plugins';
 
 /* eslint-disable @typescript-eslint/no-var-requires */
@@ -72,7 +72,7 @@ type Payload = {
   start?: number;
   end?: number;
   url?: string;
-  status?: StatusValue | number;
+  status?: StatusValue;
   pagemetrics?: PageMetrics;
   params?: Params;
   type?: OutputType;
@@ -94,7 +94,7 @@ type OutputFields = {
   };
   error?: Error;
   root_fields?: Record<string, unknown>;
-  payload?: Payload | NetworkInfo;
+  payload?: Payload;
   blob?: string;
   blob_mime?: string;
 };
@@ -143,41 +143,12 @@ function formatVersion(protocol: string | undefined) {
   }
 }
 
-function formatRequest(request: Protocol.Network.Request) {
-  const postData = request.postData ? request.postData : '';
-  return {
-    ...request,
-    body: {
-      bytes: postData.length,
-      content: postData,
-    },
-    referrer: request.headers?.Referer,
-  };
-}
-
-function formatResponse(response: Protocol.Network.Response) {
-  if (!response) {
-    return;
-  }
-  return {
-    ...response,
-    body: {
-      bytes: response.encodedDataLength,
-    },
-    status_code: response.status,
-  };
-}
-
-function formatTLS(tls: Protocol.Network.SecurityDetails) {
+function formatTLS(tls: SecurityDetails) {
   if (!tls) {
     return;
   }
-  const cipher = `${tls.keyExchange ? tls.keyExchange + '_' : ''}${
-    tls.cipher
-  }_${tls.keyExchangeGroup}`;
   const [name, version] = tls.protocol.toLowerCase().split(' ');
   return {
-    cipher,
     server: {
       x509: {
         issuer: {
@@ -191,7 +162,7 @@ function formatTLS(tls: Protocol.Network.SecurityDetails) {
       },
     },
     version_protocol: name,
-    version: version,
+    version,
   };
 }
 
@@ -207,16 +178,14 @@ export function formatNetworkFields(network: NetworkInfo) {
     },
     http: {
       version: formatVersion(response?.protocol),
-      request: formatRequest(request),
-      response: formatResponse(response),
+      request,
+      response,
     },
     tls: formatTLS(response?.securityDetails),
   };
 
   const pickItems: Array<keyof NetworkInfo> = [
     'browser',
-    'status',
-    'method',
     'type',
     'isNavigationRequest',
     'requestSentTime',
@@ -343,7 +312,7 @@ export async function gatherScreenshots(
 }
 
 export default class JSONReporter extends BaseReporter {
-  _registerListeners() {
+  override _registerListeners() {
     /**
      * report the number of journeys that exists on a suite which
      * could be used for better sharding

package/src/reporters/junit.ts

@@ -52,7 +52,7 @@ export default class JUnitReporter extends BaseReporter {
   private totalFailures = 0;
   private totalSkipped = 0;
 
-  _registerListeners() {
+  override _registerListeners() {
     const journeyMap = new Map<string, XMLEntry>();
 
     this.runner.on('journey:start', ({ journey }) => {

package/src/sdk/trace-processor.ts

@@ -111,7 +111,7 @@ export type LHProcessedTrace = {
  * metrics based on multiple navigations instead of a single navigation.
  */
 export class TraceProcessor extends LighthouseTraceProcessor {
-  static _isNavigationStartOfInterest(event) {
+  static override _isNavigationStartOfInterest(event) {
     return (
       event.name === 'navigationStart' &&
       (!event.args.data ||

package/dist/parse_args.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"parse_args.d.ts","sourceRoot":"","sources":["../src/parse_args.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AAGH,OAAO,EAAE,OAAO,EAAE,MAAM,gBAAgB,CAAC;AAuFzC,QAAA,MAAM,OAAO,6BAA8B,CAAC;AAC5C,QAAA,MAAM,OAAO,SAA4B,CAAC;AA0C1C,OAAO,EAAE,OAAO,EAAE,CAAC;AACnB,eAAe,OAAO,CAAC"}

package/dist/parse_args.js

@@ -1,103 +0,0 @@
-"use strict";
-/**
- * MIT License
- *
- * Copyright (c) 2020-present, Elastic NV
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy
- * of this software and associated documentation files (the "Software"), to deal
- * in the Software without restriction, including without limitation the rights
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- * copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in
- * all copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
- * THE SOFTWARE.
- *
- */
-var _a;
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.options = void 0;
-const commander_1 = require("commander");
-const reporters_1 = require("./reporters");
-const helpers_1 = require("./helpers");
-/* eslint-disable-next-line @typescript-eslint/no-var-requires */
-const { name, version } = require('../package.json');
-commander_1.program
-    .name(`npx ${name}`)
-    .usage('[options] [dir] [files] file')
-    .option('-c, --config <path>', 'configuration path (default: synthetics.config.js)')
-    .option('-p, --params <jsonstring>', 'JSON object that gets injected to all journeys', JSON.parse)
-    .addOption(new commander_1.Option('--reporter <value>', `output repoter format`).choices(Object.keys(reporters_1.reporters)))
-    .option('-d, --debug', 'print debug logs info')
-    .option('--pattern <pattern>', 'RegExp file patterns to search inside directory')
-    .option('--inline', 'Run inline journeys from heartbeat')
-    .option('-r, --require <modules...>', 'module(s) to preload')
-    .option('--no-headless', 'run browser in headful mode')
-    .option('--sandbox', 'enable chromium sandboxing', false)
-    .option('--rich-events', 'Mimics a heartbeat run')
-    .option('--capability <features...>', 'Enable capabilities through feature flags')
-    .addOption(new commander_1.Option('--screenshots [flag]', 'take screenshots at end of each step')
-    .choices(['on', 'off', 'only-on-failure'])
-    .default('on'))
-    .option('--dry-run', "don't actually execute anything, report only registered journeys")
-    .option('--match <name>', 'run only journeys with a name or tags that matches the glob')
-    .option('--tags <name...>', 'run only journeys with the given tag(s), or globs')
-    .option('--outfd <fd>', 'specify a file descriptor for logs. Default is stdout', parseInt)
-    .option('--ws-endpoint <endpoint>', 'Browser WebSocket endpoint to connect to')
-    .option('--pause-on-error', 'pause on error until a keypress is made in the console. Useful during development')
-    .option('--ignore-https-errors', 'ignores any HTTPS errors in sites being tested, including ones related to unrecognized certs or signatures. This can be insecure!')
-    .option('--quiet-exit-code', 'always return 0 as an exit code status, regardless of test pass / fail. Only return > 0 exit codes on internal errors where the suite could not be run')
-    .addOption(new commander_1.Option('--throttling <d/u/l>', 'List of options to throttle network conditions for download throughput (d) in megabits/second, upload throughput (u) in megabits/second and latency (l) in milliseconds.').default(helpers_1.DEFAULT_NETWORK_CONDITIONS_ARG))
-    .option('--no-throttling', 'Turns off default network throttling.')
-    .option('--playwright-options <jsonstring>', 'JSON object to pass in custom Playwright options for the agent. Options passed will be merged with Playwright options defined in your synthetics.config.js file. Options defined via --playwright-options take precedence.', JSON.parse)
-    .version(version)
-    .description('Run synthetic tests');
-const command = commander_1.program.parse(process.argv);
-const options = command.opts();
-exports.options = options;
-/**
- * Group all events that can be consumed by heartbeat and
- * eventually by the Synthetics UI.
- */
-if (options.richEvents) {
-    options.reporter = (_a = options.reporter) !== null && _a !== void 0 ? _a : 'json';
-    options.ssblocks = true;
-    options.network = true;
-    options.quietExitCode = true;
-    options.trace = true;
-}
-if (options.capability) {
-    const supportedCapabilities = [
-        'trace',
-        'network',
-        'filmstrips',
-        'metrics',
-        'ssblocks',
-    ];
-    /**
-     * trace - record chrome trace events(LCP, FCP, CLS, etc.) for all journeys
-     * network - capture network information for all journeys
-     * filmstrips - record detailed filmstrips for all journeys
-     * metrics - capture performance metrics (DOM Nodes, Heap size, etc.) for each step
-     * ssblocks - Dedupes the screenshots in to blocks to save storage space
-     */
-    for (const flag of options.capability) {
-        if (supportedCapabilities.includes(flag)) {
-            options[flag] = true;
-        }
-        else {
-            console.warn(`Missing capability "${flag}", current supported capabilities are ${supportedCapabilities.join(', ')}`);
-        }
-    }
-}
-exports.default = command;
-//# sourceMappingURL=parse_args.js.map

package/dist/parse_args.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"parse_args.js","sourceRoot":"","sources":["../src/parse_args.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;;;;GAuBG;;;;AAEH,yCAA4C;AAE5C,2CAAwC;AACxC,uCAA2D;AAE3D,iEAAiE;AACjE,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC,iBAAiB,CAAC,CAAC;AAErD,mBAAO;KACJ,IAAI,CAAC,OAAO,IAAI,EAAE,CAAC;KACnB,KAAK,CAAC,8BAA8B,CAAC;KACrC,MAAM,CACL,qBAAqB,EACrB,oDAAoD,CACrD;KACA,MAAM,CACL,2BAA2B,EAC3B,gDAAgD,EAChD,IAAI,CAAC,KAAK,CACX;KACA,SAAS,CACR,IAAI,kBAAM,CAAC,oBAAoB,EAAE,uBAAuB,CAAC,CAAC,OAAO,CAC/D,MAAM,CAAC,IAAI,CAAC,qBAAS,CAAC,CACvB,CACF;KACA,MAAM,CAAC,aAAa,EAAE,uBAAuB,CAAC;KAC9C,MAAM,CACL,qBAAqB,EACrB,iDAAiD,CAClD;KACA,MAAM,CAAC,UAAU,EAAE,oCAAoC,CAAC;KACxD,MAAM,CAAC,4BAA4B,EAAE,sBAAsB,CAAC;KAC5D,MAAM,CAAC,eAAe,EAAE,6BAA6B,CAAC;KACtD,MAAM,CAAC,WAAW,EAAE,4BAA4B,EAAE,KAAK,CAAC;KACxD,MAAM,CAAC,eAAe,EAAE,wBAAwB,CAAC;KACjD,MAAM,CACL,4BAA4B,EAC5B,2CAA2C,CAC5C;KACA,SAAS,CACR,IAAI,kBAAM,CAAC,sBAAsB,EAAE,sCAAsC,CAAC;KACvE,OAAO,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,iBAAiB,CAAC,CAAC;KACzC,OAAO,CAAC,IAAI,CAAC,CACjB;KACA,MAAM,CACL,WAAW,EACX,kEAAkE,CACnE;KACA,MAAM,CACL,gBAAgB,EAChB,6DAA6D,CAC9D;KACA,MAAM,CACL,kBAAkB,EAClB,mDAAmD,CACpD;KACA,MAAM,CACL,cAAc,EACd,uDAAuD,EACvD,QAAQ,CACT;KACA,MAAM,CACL,0BAA0B,EAC1B,0CAA0C,CAC3C;KACA,MAAM,CACL,kBAAkB,EAClB,mFAAmF,CACpF;KACA,MAAM,CACL,uBAAuB,EACvB,mIAAmI,CACpI;KACA,MAAM,CACL,mBAAmB,EACnB,wJAAwJ,CACzJ;KACA,SAAS,CACR,IAAI,kBAAM,CACR,sBAAsB,EACtB,0KAA0K,CAC3K,CAAC,OAAO,CAAC,wCAA8B,CAAC,CAC1C;KACA,MAAM,CAAC,iBAAiB,EAAE,uCAAuC,CAAC;KAClE,MAAM,CAAC,mCAAmC,EAAE,4NAA4N,EAAE,IAAI,CAAC,KAAK,CAAC;KACrR,OAAO,CAAC,OAAO,CAAC;KAChB,WAAW,CAAC,qBAAqB,CAAC,CAAC;AAEtC,MAAM,OAAO,GAAG,mBAAO,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;AAC5C,MAAM,OAAO,GAAG,OAAO,CAAC,IAAI,EAAa,CAAC;AA0CjC,0BAAO;AAxChB;;;GAGG;AACH,IAAI,OAAO,CAAC,UAAU,EAAE;IACtB,OAAO,CAAC,QAAQ,GAAG,MAAA,OAAO,CAAC,QAAQ,mCAAI,MAAM,CAAC;IAC9C,OAAO,CAAC,QAAQ,GAAG,IAAI,CAAC;IACxB,OAAO,CAAC,OAAO,GAAG,IAAI,CAAC;IACvB,OAAO,CAAC,aAAa,GAAG,IAAI,CAAC;IAC7B,OAAO,CAAC,KAAK,GAAG,IAAI,CAAC;CACtB;AAED,IAAI,OAAO,CAAC,UAAU,EAAE;IACtB,MAAM,qBAAqB,GAAG;QAC5B,OAAO;QACP,SAAS;QACT,YAAY;QACZ,SAAS;QACT,UAAU;KACX,CAAC;IACF;;;;;;OAMG;IACH,KAAK,MAAM,IAAI,IAAI,OAAO,CAAC,UAAU,EAAE;QACrC,IAAI,qBAAqB,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE;YACxC,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;SACtB;aAAM;YACL,OAAO,CAAC,IAAI,CACV,uBAAuB,IAAI,yCAAyC,qBAAqB,CAAC,IAAI,CAC5F,IAAI,CACL,EAAE,CACJ,CAAC;SACH;KACF;CACF;AAGD,kBAAe,OAAO,CAAC"}

package/src/parse_args.ts

@@ -1,158 +0,0 @@
-/**
- * MIT License
- *
- * Copyright (c) 2020-present, Elastic NV
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy
- * of this software and associated documentation files (the "Software"), to deal
- * in the Software without restriction, including without limitation the rights
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- * copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in
- * all copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
- * THE SOFTWARE.
- *
- */
-
-import { program, Option } from 'commander';
-import { CliArgs } from './common_types';
-import { reporters } from './reporters';
-import { DEFAULT_NETWORK_CONDITIONS_ARG } from './helpers';
-
-/* eslint-disable-next-line @typescript-eslint/no-var-requires */
-const { name, version } = require('../package.json');
-
-program
-  .name(`npx ${name}`)
-  .usage('[options] [dir] [files] file')
-  .option(
-    '-c, --config <path>',
-    'configuration path (default: synthetics.config.js)'
-  )
-  .option(
-    '-p, --params <jsonstring>',
-    'JSON object that gets injected to all journeys',
-    JSON.parse
-  )
-  .addOption(
-    new Option('--reporter <value>', `output repoter format`).choices(
-      Object.keys(reporters)
-    )
-  )
-  .option('-d, --debug', 'print debug logs info')
-  .option(
-    '--pattern <pattern>',
-    'RegExp file patterns to search inside directory'
-  )
-  .option('--inline', 'Run inline journeys from heartbeat')
-  .option('-r, --require <modules...>', 'module(s) to preload')
-  .option('--no-headless', 'run browser in headful mode')
-  .option('--sandbox', 'enable chromium sandboxing', false)
-  .option('--rich-events', 'Mimics a heartbeat run')
-  .option(
-    '--capability <features...>',
-    'Enable capabilities through feature flags'
-  )
-  .addOption(
-    new Option('--screenshots [flag]', 'take screenshots at end of each step')
-      .choices(['on', 'off', 'only-on-failure'])
-      .default('on')
-  )
-  .option(
-    '--dry-run',
-    "don't actually execute anything, report only registered journeys"
-  )
-  .option(
-    '--match <name>',
-    'run only journeys with a name or tags that matches the glob'
-  )
-  .option(
-    '--tags <name...>',
-    'run only journeys with the given tag(s), or globs'
-  )
-  .option(
-    '--outfd <fd>',
-    'specify a file descriptor for logs. Default is stdout',
-    parseInt
-  )
-  .option(
-    '--ws-endpoint <endpoint>',
-    'Browser WebSocket endpoint to connect to'
-  )
-  .option(
-    '--pause-on-error',
-    'pause on error until a keypress is made in the console. Useful during development'
-  )
-  .option(
-    '--ignore-https-errors',
-    'ignores any HTTPS errors in sites being tested, including ones related to unrecognized certs or signatures. This can be insecure!'
-  )
-  .option(
-    '--quiet-exit-code',
-    'always return 0 as an exit code status, regardless of test pass / fail. Only return > 0 exit codes on internal errors where the suite could not be run'
-  )
-  .addOption(
-    new Option(
-      '--throttling <d/u/l>',
-      'List of options to throttle network conditions for download throughput (d) in megabits/second, upload throughput (u) in megabits/second and latency (l) in milliseconds.'
-    ).default(DEFAULT_NETWORK_CONDITIONS_ARG)
-  )
-  .option('--no-throttling', 'Turns off default network throttling.')
-  .option('--playwright-options <jsonstring>', 'JSON object to pass in custom Playwright options for the agent. Options passed will be merged with Playwright options defined in your synthetics.config.js file. Options defined via --playwright-options take precedence.', JSON.parse)
-  .version(version)
-  .description('Run synthetic tests');
-
-const command = program.parse(process.argv);
-const options = command.opts() as CliArgs;
-
-/**
- * Group all events that can be consumed by heartbeat and
- * eventually by the Synthetics UI.
- */
-if (options.richEvents) {
-  options.reporter = options.reporter ?? 'json';
-  options.ssblocks = true;
-  options.network = true;
-  options.quietExitCode = true;
-  options.trace = true;
-}
-
-if (options.capability) {
-  const supportedCapabilities = [
-    'trace',
-    'network',
-    'filmstrips',
-    'metrics',
-    'ssblocks',
-  ];
-  /**
-   * trace - record chrome trace events(LCP, FCP, CLS, etc.) for all journeys
-   * network - capture network information for all journeys
-   * filmstrips - record detailed filmstrips for all journeys
-   * metrics - capture performance metrics (DOM Nodes, Heap size, etc.) for each step
-   * ssblocks - Dedupes the screenshots in to blocks to save storage space
-   */
-  for (const flag of options.capability) {
-    if (supportedCapabilities.includes(flag)) {
-      options[flag] = true;
-    } else {
-      console.warn(
-        `Missing capability "${flag}", current supported capabilities are ${supportedCapabilities.join(
-          ', '
-        )}`
-      );
-    }
-  }
-}
-
-export { options };
-export default command;