@elastic/synthetics 1.0.0-beta.4 → 1.0.0-beta.40

package/templates/.github/workflows/run-synthetics.yml

@@ -0,0 +1,27 @@
+name: Elastic Synthetics Tests
+on:
+  push:
+    branches: [main, master]
+  pull_request:
+    branches: [main, master]
+  schedule:
+    - cron: '* 0 * * *'
+jobs:
+  test:
+    defaults:
+      run:
+        working-directory: ./advanced-examples
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 18
+      - run: npm install
+      - run: "SYNTHETICS_JUNIT_FILE='junit-synthetics.xml' npx @elastic/synthetics . --reporter=junit"
+      - name: Publish Unit Test Results
+        uses: EnricoMi/publish-unit-test-result-action@v2
+        if: always()
+        with:
+          junit_files: '**/junit-*.xml'
+          check_name: Elastic Synthetics Tests

package/templates/README.md

@@ -0,0 +1,21 @@
+## Get started with Elastic Synthetics!
+
+Browse the directory structure here to see an example skeleton of an [Elastic Synthetics](https://www.elastic.co/observability/synthetic-monitoring) project.
+Make sure to [read the docs](https://www.elastic.co/guide/en/observability/current/monitor-uptime-synthetics.html) as well if you're unfamiliar with Elastic Synthetics.
+
+This directory was created with the command `npx @elastic/synthetics <target-directory>`, with `<target-directory>` being the name of the directory you'd like it to make.
+You can always use this command to scafold new Synthetics projects.
+
+Key places to look:
+
+- The `synthetics.config.ts` file contains configuration for your project.
+- The `journeys` directory contains both basic and more advanced examples of using synthetics. It tests a publicly hosted [Todos List](https://elastic.github.io/synthetics-demo/).
+- The `.github` directory contains an example github action, demonstrating the use of a CI service for automatically running tests on merges and PR creation.
+
+To run the tests locally, use the following command:
+
+```bash
+npm run test
+```
+
+Curious to learn more? [Read the docs](https://www.elastic.co/guide/en/observability/current/monitor-uptime-synthetics.html) to learn about pushing configurations to an Elastic cloud stack and more.

package/templates/journeys/advanced-example-helpers.ts

@@ -0,0 +1,54 @@
+import { step, Page, expect } from '@elastic/synthetics';
+
+// This file contains helper files for advanced-example.journey.ts
+// The functions here let you write more concise tests  and re-use functionality
+// across tests.
+
+export const loadAppStep = (page: Page, url: string) => {
+  step('launch app', async () => {
+    await page.goto(url);
+  });
+};
+
+export const addTaskStep = (page: Page, task: string) => {
+  step(`add task ${task}`, async () => {
+    const input = await page.locator('input.new-todo');
+    await input.type(task);
+    await input.press('Enter');
+  });
+};
+
+const todosSelector = 'ul.todo-list li.todo';
+
+export const findTask = async (page: Page, task: string) => {
+  return await page.locator(`${todosSelector} >> text="${task}"`);
+};
+
+export const assertTaskListCountStep = async (page: Page, count: number) => {
+  step(`check that task list has exactly ${count} elements`, async () => {
+    const tasks = await page.locator(todosSelector);
+    expect(await tasks.count()).toBe(count);
+  });
+};
+
+export const checkForTaskStep = async (page: Page, task: string) => {
+  step(`check for task '${task}' in list`, async () => {
+    return findTask(page, task);
+  });
+};
+
+export const destroyTaskStep = async (page: Page, task: string) => {
+  step(`destroy task '${task}'`, async () => {
+    const label = await findTask(page, task);
+    // xpath indexes arrays starting at 1!!! Easy to forget!
+    const li = await label.locator('xpath=ancestor::li[1]');
+    const destroyButton = await li.locator('button');
+    // The destroy button is not visible until hovered. Setup a click test which
+    // will wait up to 30s for the button to be visible.
+    const clickFuture = destroyButton.click();
+    // now hover, making the destroy button clickable
+    await li.hover();
+    // now we are done
+    await clickFuture;
+  });
+};

package/templates/journeys/advanced-example.journey.ts

@@ -0,0 +1,43 @@
+import { journey } from '@elastic/synthetics';
+import {
+  loadAppStep,
+  addTaskStep,
+  assertTaskListCountStep,
+  checkForTaskStep,
+  destroyTaskStep,
+} from './advanced-example-helpers';
+
+// This file shows the use of re-usable functions, imported from
+// `advanced-example-helpers.ts` to make writing tests that perform
+// different combinations of similar functions simpler and with less
+// duplication.
+
+journey('addition and completion of single task', ({ page, params }) => {
+  const testText = "Don't put salt in your eyes";
+
+  loadAppStep(page, params.url);
+  addTaskStep(page, testText);
+  assertTaskListCountStep(page, 1);
+  checkForTaskStep(page, testText);
+  destroyTaskStep(page, testText);
+  assertTaskListCountStep(page, 0);
+});
+
+journey('adding and removing multiple tasks', ({ page, params }) => {
+  const testTasks = ['Task 1', 'Task 2', 'Task 3'];
+
+  loadAppStep(page, params.url);
+  testTasks.forEach(t => {
+    addTaskStep(page, t);
+  });
+
+  assertTaskListCountStep(page, 3);
+
+  // remove the middle task and check that it worked
+  destroyTaskStep(page, testTasks[1]);
+  assertTaskListCountStep(page, 2);
+
+  // add a new task and check it exists
+  addTaskStep(page, 'Task 4');
+  assertTaskListCountStep(page, 3);
+});

package/templates/journeys/example.journey.ts

@@ -0,0 +1,18 @@
+import { journey, step, monitor, expect } from '@elastic/synthetics';
+
+journey('My Example Journey', ({ page, params }) => {
+  // Only relevant for the push command to create
+  // monitors in Kibana
+  monitor.use({
+    id: 'example-monitor',
+    schedule: 10,
+  });
+  step('launch application', async () => {
+    await page.goto(params.url);
+  });
+
+  step('assert title', async () => {
+    const header = await page.locator('h1');
+    expect(await header.textContent()).toBe('todos');
+  });
+});

package/templates/lightweight/heartbeat.yml

@@ -0,0 +1,7 @@
+- type: http
+  name: Todos Lightweight
+  id: todos-lightweight
+  enabled: true
+  urls: "https://elastic.github.io/synthetics-demo/"
+  schedule: '@every 3m'
+  timeout: 16s

package/templates/synthetics.config.ts

@@ -0,0 +1,35 @@
+import type { SyntheticsConfig } from '@elastic/synthetics';
+
+export default env => {
+  const config: SyntheticsConfig = {
+    params: {
+      url: 'https://elastic.github.io/synthetics-demo/',
+    },
+    playwrightOptions: {
+      ignoreHTTPSErrors: false,
+    },
+    /**
+     * Configure global monitor settings
+     */
+    monitor: {
+      schedule: '{{schedule}}',
+      locations: ['{{locations}}'],
+      privateLocations: ['{{privateLocations}}'],
+    },
+    /**
+     * Project monitors settings
+     */
+    project: {
+      id: '{{id}}',
+      url: '{{url}}',
+      space: '{{space}}',
+    },
+  };
+  if (env !== 'development') {
+    /**
+     * Override configuration specific to environment
+     * Ex: config.params.url = ""
+     */
+  }
+  return config;
+};

package/CHANGELOG.md

@@ -1,131 +0,0 @@
-# Changelog
-
-All notable changes to this project will be documented in this file.
-
-## v1.0.0-beta.3 (2021-06-15)
-
-### Features
-
-- Capture all core-vitals and user experience metrics like FPC, LCP, CLS, User
-  timing metrics, etc via chrome tracing [#194](https://github.com/elastic/synthetics/pull/194)
-- Split the captured screenshot from each step in to 64 blocks to optimzie
-  the storage when indexed the same block in Elaticsearch [#290](https://github.com/elastic/synthetics/pull/290)
-- Add support for filtering journeys by name and tags [#300](https://github.com/elastic/synthetics/issues/300)
-- Expose `expect` assetion method in the API [#201](https://github.com/elastic/synthetics/issues/201)
-- Update Cumulative Layout Shift(CLS) metric based on
-  `maximum session window with 1 second gap, capped at 5 seconds`
-  [#301](https://github.com/elastic/synthetics/issues/301)
-- Expose time taken to complete single step under
-  `step.duration.us` [#302](https://github.com/elastic/synthetics/issues/301)
-- Expose new capabilities via `--capability` through CLI
-  options [#295](https://github.com/elastic/synthetics/issues/295)
-- Add new flag `--rich-events` which mimicks heartbeat
-  behaviour [#289](https://github.com/elastic/synthetics/pull/289).
-- Expose suite parameters from CLI and config file to
-  all hooks and journeys callbacks[#272](https://github.com/elastic/synthetics/pull/272)
-
-### Bug fixes
-
-- Move all of the trace events like FCP, LCP, User timings under
-  `browser.relative_trace`[#303](https://github.com/elastic/synthetics/pulls/303)
-- Prioritize suite params from CLI over config file [#298](https://github.com/elastic/synthetics/pull/298)
-- Report errors from `before` and `after` hooks [#273](https://github.com/elastic/synthetics/pull/273)
-
-## v1.0.0-beta.2 (2021-05-17)
-
-### Features
-
-- Allow dynamic suite parameters configuration via `synthetics.config.{js|ts}`
-  [#270](https://github.com/elastic/synthetics/issues/270)
-
-### Performance Improvements
-
-- Improve execution time of test suites by spawning journeys in isolated context
-  instead of launcing browser for each run [#274](https://github.com/elastic/synthetics/issues/274)
-
-## v1.0.0-beta.1 (2021-05-04)
-
-### Bug fixes
-
-- Exclude all data URI requests from network events [#267](https://github.com/elastic/synthetics/issues/267)
-
-## v1.0.0-beta.0 (2021-04-23)
-
-### Features
-
-- Default to JPEG images with quality 80 for individual step
-  screenshots[#233](https://github.com/elastic/synthetics/issues/233)
-
-### Bug fixes
-
-- Keep journey callback types to be synchronous to match with how steps are
-  executed synchronously[#256](https://github.com/elastic/synthetics/issues/256)
-- Report correct page URL on navigation
-  failures[#255](https://github.com/elastic/synthetics/issues/255)
-
-**NOTE: Playwright version is updated to 1.10.0**
-
-## v0.0.1-alpha14 (2021-04-14)
-
-### Features
-
-- Add support for custom reporters for the Synthetics runner
-  [#254](https://github.com/elastic/synthetics/issues/254)
-
-## v0.0.1-alpha13 (2021-04-08)
-
-### Features
-
-- Remove duplicate payload fields and keep the network fields under ECS
-  [#252](https://github.com/elastic/synthetics/issues/252)
-
-### Bug fixes
-
-- Measure the network timings for aborted and inflight network requests
-  correctly[#251](https://github.com/elastic/synthetics/pull/251)
-
-## v0.0.1-alpha12 (2021-03-31)
-
-### Features
-
-- Record transfer size and resource size for all network events
-  [#220](https://github.com/elastic/synthetics/issues/220)
-- Report the number of journeys as part of the new `synthetics/metadata` event
-  which would be used by heartbeat eventually for sharding [#247](https://github.com/elastic/synthetics/pull/247)
-
-## v0.0.1-alpha11 (2021-03-10)
-
-### Features
-
-- Expose driver type information from the agent [#239](https://github.com/elastic/synthetics/pull/239)
-
-Exposing the types allows developers to import the driver type information
-directly from the synthetics package instead of using via playwright specific
-packages which would result in inconsistent types (version mismatch or
-browser specific types).
-
-## v0.0.1-alpha10 (2021-03-04)
-
-### Features
-
-- Move all the ECS specific fields under `root_fields` [#164](https://github.com/elastic/synthetics/issues/164)
-- Add support for Junit reporter [#149](https://github.com/elastic/synthetics/issues/149)
-- Expose status field for `step/end` and `journey/end` [#230](https://github.com/elastic/synthetics/issues/230)
-
-### Bug fixes
-
-- Disable chromium sandboxing by default
-  [#225](https://github.com/elastic/synthetics/issues/225)
-
-## v0.0.1-alpha9 (2021-02-01)
-
-### Features
-
-- Add runtime seccomp profiler for the synthetics agent [#181](https://github.com/elastic/synthetics/issues/181)
-
-### Bug fixes
-
-- Exit with non-zero code when any step/journey fails [#191](https://github.com/elastic/synthetics/issues/191)
-- Calculate blocking time properly for missing network data [#187](https://github.com/elastic/synthetics/issues/187)
-- Preserve typescript source fails without transpiling to older JS versions [#195](https://github.com/elastic/synthetics/issues/195)
-- Capture redirected requests in network timing data [#180](https://github.com/elastic/synthetics/issues/180)

package/NOTICE.txt

@@ -1,221 +0,0 @@
-@elastic/synthetics
-Copyright (c) 2020-present, Elasticsearch BV
-
-
----------------------------------------------------------------------------
-This product relies on `googlechrome/lighthouse`
-
-Copyright 2017 The Lighthouse Authors. All Rights Reserved.
-
-                                 Apache License
-                           Version 2.0, January 2004
-                        http://www.apache.org/licenses/
-
-   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
-
-   1. Definitions.
-
-      "License" shall mean the terms and conditions for use, reproduction,
-      and distribution as defined by Sections 1 through 9 of this document.
-
-      "Licensor" shall mean the copyright owner or entity authorized by
-      the copyright owner that is granting the License.
-
-      "Legal Entity" shall mean the union of the acting entity and all
-      other entities that control, are controlled by, or are under common
-      control with that entity. For the purposes of this definition,
-      "control" means (i) the power, direct or indirect, to cause the
-      direction or management of such entity, whether by contract or
-      otherwise, or (ii) ownership of fifty percent (50%) or more of the
-      outstanding shares, or (iii) beneficial ownership of such entity.
-
-      "You" (or "Your") shall mean an individual or Legal Entity
-      exercising permissions granted by this License.
-
-      "Source" form shall mean the preferred form for making modifications,
-      including but not limited to software source code, documentation
-      source, and configuration files.
-
-      "Object" form shall mean any form resulting from mechanical
-      transformation or translation of a Source form, including but
-      not limited to compiled object code, generated documentation,
-      and conversions to other media types.
-
-      "Work" shall mean the work of authorship, whether in Source or
-      Object form, made available under the License, as indicated by a
-      copyright notice that is included in or attached to the work
-      (an example is provided in the Appendix below).
-
-      "Derivative Works" shall mean any work, whether in Source or Object
-      form, that is based on (or derived from) the Work and for which the
-      editorial revisions, annotations, elaborations, or other modifications
-      represent, as a whole, an original work of authorship. For the purposes
-      of this License, Derivative Works shall not include works that remain
-      separable from, or merely link (or bind by name) to the interfaces of,
-      the Work and Derivative Works thereof.
-
-      "Contribution" shall mean any work of authorship, including
-      the original version of the Work and any modifications or additions
-      to that Work or Derivative Works thereof, that is intentionally
-      submitted to Licensor for inclusion in the Work by the copyright owner
-      or by an individual or Legal Entity authorized to submit on behalf of
-      the copyright owner. For the purposes of this definition, "submitted"
-      means any form of electronic, verbal, or written communication sent
-      to the Licensor or its representatives, including but not limited to
-      communication on electronic mailing lists, source code control systems,
-      and issue tracking systems that are managed by, or on behalf of, the
-      Licensor for the purpose of discussing and improving the Work, but
-      excluding communication that is conspicuously marked or otherwise
-      designated in writing by the copyright owner as "Not a Contribution."
-
-      "Contributor" shall mean Licensor and any individual or Legal Entity
-      on behalf of whom a Contribution has been received by Licensor and
-      subsequently incorporated within the Work.
-
-   2. Grant of Copyright License. Subject to the terms and conditions of
-      this License, each Contributor hereby grants to You a perpetual,
-      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-      copyright license to reproduce, prepare Derivative Works of,
-      publicly display, publicly perform, sublicense, and distribute the
-      Work and such Derivative Works in Source or Object form.
-
-   3. Grant of Patent License. Subject to the terms and conditions of
-      this License, each Contributor hereby grants to You a perpetual,
-      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-      (except as stated in this section) patent license to make, have made,
-      use, offer to sell, sell, import, and otherwise transfer the Work,
-      where such license applies only to those patent claims licensable
-      by such Contributor that are necessarily infringed by their
-      Contribution(s) alone or by combination of their Contribution(s)
-      with the Work to which such Contribution(s) was submitted. If You
-      institute patent litigation against any entity (including a
-      cross-claim or counterclaim in a lawsuit) alleging that the Work
-      or a Contribution incorporated within the Work constitutes direct
-      or contributory patent infringement, then any patent licenses
-      granted to You under this License for that Work shall terminate
-      as of the date such litigation is filed.
-
-   4. Redistribution. You may reproduce and distribute copies of the
-      Work or Derivative Works thereof in any medium, with or without
-      modifications, and in Source or Object form, provided that You
-      meet the following conditions:
-
-      (a) You must give any other recipients of the Work or
-          Derivative Works a copy of this License; and
-
-      (b) You must cause any modified files to carry prominent notices
-          stating that You changed the files; and
-
-      (c) You must retain, in the Source form of any Derivative Works
-          that You distribute, all copyright, patent, trademark, and
-          attribution notices from the Source form of the Work,
-          excluding those notices that do not pertain to any part of
-          the Derivative Works; and
-
-      (d) If the Work includes a "NOTICE" text file as part of its
-          distribution, then any Derivative Works that You distribute must
-          include a readable copy of the attribution notices contained
-          within such NOTICE file, excluding those notices that do not
-          pertain to any part of the Derivative Works, in at least one
-          of the following places: within a NOTICE text file distributed
-          as part of the Derivative Works; within the Source form or
-          documentation, if provided along with the Derivative Works; or,
-          within a display generated by the Derivative Works, if and
-          wherever such third-party notices normally appear. The contents
-          of the NOTICE file are for informational purposes only and
-          do not modify the License. You may add Your own attribution
-          notices within Derivative Works that You distribute, alongside
-          or as an addendum to the NOTICE text from the Work, provided
-          that such additional attribution notices cannot be construed
-          as modifying the License.
-
-      You may add Your own copyright statement to Your modifications and
-      may provide additional or different license terms and conditions
-      for use, reproduction, or distribution of Your modifications, or
-      for any such Derivative Works as a whole, provided Your use,
-      reproduction, and distribution of the Work otherwise complies with
-      the conditions stated in this License.
-
-   5. Submission of Contributions. Unless You explicitly state otherwise,
-      any Contribution intentionally submitted for inclusion in the Work
-      by You to the Licensor shall be under the terms and conditions of
-      this License, without any additional terms or conditions.
-      Notwithstanding the above, nothing herein shall supersede or modify
-      the terms of any separate license agreement you may have executed
-      with Licensor regarding such Contributions.
-
-   6. Trademarks. This License does not grant permission to use the trade
-      names, trademarks, service marks, or product names of the Licensor,
-      except as required for reasonable and customary use in describing the
-      origin of the Work and reproducing the content of the NOTICE file.
-
-   7. Disclaimer of Warranty. Unless required by applicable law or
-      agreed to in writing, Licensor provides the Work (and each
-      Contributor provides its Contributions) on an "AS IS" BASIS,
-      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
-      implied, including, without limitation, any warranties or conditions
-      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
-      PARTICULAR PURPOSE. You are solely responsible for determining the
-      appropriateness of using or redistributing the Work and assume any
-      risks associated with Your exercise of permissions under this License.
-
-   8. Limitation of Liability. In no event and under no legal theory,
-      whether in tort (including negligence), contract, or otherwise,
-      unless required by applicable law (such as deliberate and grossly
-      negligent acts) or agreed to in writing, shall any Contributor be
-      liable to You for damages, including any direct, indirect, special,
-      incidental, or consequential damages of any character arising as a
-      result of this License or out of the use or inability to use the
-      Work (including but not limited to damages for loss of goodwill,
-      work stoppage, computer failure or malfunction, or any and all
-      other commercial damages or losses), even if such Contributor
-      has been advised of the possibility of such damages.
-
-   9. Accepting Warranty or Additional Liability. While redistributing
-      the Work or Derivative Works thereof, You may choose to offer,
-      and charge a fee for, acceptance of support, warranty, indemnity,
-      or other liability obligations and/or rights consistent with this
-      License. However, in accepting such obligations, You may act only
-      on Your own behalf and on Your sole responsibility, not on behalf
-      of any other Contributor, and only if You agree to indemnify,
-      defend, and hold each Contributor harmless for any liability
-      incurred by, or claims asserted against, such Contributor by reason
-      of your accepting any such warranty or additional liability.
-
-   END OF TERMS AND CONDITIONS
-
-   APPENDIX: How to apply the Apache License to your work.
-
-      To apply the Apache License to your work, attach the following
-      boilerplate notice, with the fields enclosed by brackets "[]"
-      replaced with your own identifying information. (Don't include
-      the brackets!)  The text should be enclosed in the appropriate
-      comment syntax for the file format. We also recommend that a
-      file or class name and description of purpose be included on the
-      same "printed page" as the copyright notice for easier
-      identification within third-party archives.
-
-   Copyright [yyyy] [name of copyright owner]
-
-   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.
----------------------------------------------------------------------------
-This product relies on `expect`
-
-/**
- * Copyright (c) Facebook, Inc. and its affiliates. All Rights Reserved.
- *
- * This source code is licensed under the MIT license found in the
- * LICENSE file in the root directory of this source tree.
- *
- */
----------------------------------------------------------------------------

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;AAkEzC,QAAA,MAAM,OAAO,6BAA8B,CAAC;AAC5C,QAAA,MAAM,OAAO,SAA4B,CAAC;AAwC1C,OAAO,EAAE,OAAO,EAAE,CAAC;AACnB,eAAe,OAAO,CAAC"}

package/dist/parse_args.js

@@ -1,95 +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");
-/* 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('-s, --suite-params <jsonstring>', 'suite variables', '{}')
-    .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')
-    .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')
-    .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;
-}
-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;AAExC,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,CAAC,iCAAiC,EAAE,iBAAiB,EAAE,IAAI,CAAC;KAClE,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,CAAC;KACjD,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,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;AAwCjC,0BAAO;AAtChB;;;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;CACxB;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"}