@elastic/synthetics 1.0.0-beta.8 → 1.0.0

package/README.md

@@ -1,8 +1,9 @@
-[![Build Status](https://apm-ci.elastic.co/job/apm-agent-rum/job/elastic-synthetics/job/master/badge/icon)](https://apm-ci.elastic.co/job/apm-agent-rum/job/elastic-synthetics/job/master/)
-# Experimental Synthetics Agent
+[![ci](https://github.com/elastic/synthetics/actions/workflows/ci.yml/badge.svg)](https://github.com/elastic/synthetics/actions/workflows/ci.yml)
+[![e2e](https://github.com/elastic/synthetics/actions/workflows/e2e.yml/badge.svg)](https://github.com/elastic/synthetics/actions/workflows/e2e.yml)
+
+# Synthetics Agent
 
 Synthetic Monitoring with Real Browsers.
-**Please note this is an unsupported experimental project. Expect things to break and change!**
 
 ## Usage
 
@@ -20,7 +21,7 @@ npx @elastic/synthetics [options] [dir] [files] file
 
 ## Documentation
 
-- [Introduction](https://www.elastic.co/guide/en/observability/current/synthetic-monitoring.html)
+- [Introduction](https://www.elastic.co/guide/en/observability/current/monitor-uptime-synthetics.html#monitoring-synthetics)
 - [CLI Options](https://www.elastic.co/guide/en/observability/current/synthetics-command-reference.html#elastic-synthetics-command)
 - [Syntax](https://www.elastic.co/guide/en/observability/current/synthetics-create-test.html#synthetics-syntax)
 - [Creating a Journey](https://www.elastic.co/guide/en/observability/current/synthetics-create-test.html#synthetics-create-journey)

package/dist/cli.js

@@ -24,184 +24,158 @@
  * THE SOFTWARE.
  *
  */
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
+const commander_1 = require("commander");
 const process_1 = require("process");
-const path_1 = require("path");
-const deepmerge_1 = __importDefault(require("deepmerge"));
+const reporters_1 = require("./reporters");
+const options_1 = require("./options");
+const loader_1 = require("./loader");
+const _1 = require("./");
 const core_1 = require("./core");
-const logger_1 = require("./core/logger");
-const parse_args_1 = __importStar(require("./parse_args"));
+const monitor_1 = require("./dsl/monitor");
+const push_1 = require("./push");
+const locations_1 = require("./locations");
+const path_1 = require("path");
+const generator_1 = require("./generator");
 const helpers_1 = require("./helpers");
-const _1 = require("./");
-const config_1 = require("./config");
-const resolvedCwd = process_1.cwd();
-/**
- * Set debug based on DEBUG ENV and -d flags
- * namespace - synthetics
- */
-const namespace = 'synthetics';
-if (process.env.DEBUG === namespace || Boolean(parse_args_1.options.debug)) {
-    process.env.DEBUG = '1';
-}
-const loadInlineScript = source => {
-    const scriptFn = new Function('step', 'page', 'browser', 'params', source);
-    core_1.journey('inline', async ({ page, browser, params }) => {
-        scriptFn.apply(null, [core_1.step, page, browser, params]);
-    });
-};
-async function readStdin() {
-    const chunks = [];
-    process_1.stdin.resume();
-    process_1.stdin.setEncoding('utf-8');
-    for await (const chunk of process_1.stdin) {
-        chunks.push(chunk);
-    }
-    return chunks.join();
-}
-function requireSuites(suites) {
-    for (const suite of suites) {
-        require(suite);
-    }
-}
-/**
- * Handle both directory and files that are passed through TTY
- * and add them to suites
- */
-async function prepareSuites(inputs) {
-    const suites = new Set();
-    const addSuite = absPath => {
-        logger_1.log(`Processing file: ${absPath}`);
-        suites.add(require.resolve(absPath));
-    };
-    /**
-     * Match all files inside the directory with the
-     * .journey.{mjs|cjs|js|ts) extensions
-     */
-    const pattern = parse_args_1.options.pattern
-        ? new RegExp(parse_args_1.options.pattern, 'i')
-        : /.+\.journey\.([mc]js|[jt]s?)$/;
-    /**
-     * Ignore node_modules by default when running suites
-     */
-    const ignored = /node_modules/i;
-    for (const input of inputs) {
-        const absPath = path_1.resolve(resolvedCwd, input);
+const public_locations_1 = require("./locations/public-locations");
+const monitor_2 = require("./push/monitor");
+/* eslint-disable-next-line @typescript-eslint/no-var-requires */
+const { name, version } = require('../package.json');
+const { params, pattern, tags, match, playwrightOpts } = (0, options_1.getCommonCommandOpts)();
+commander_1.program
+    .name(`npx ${name}`)
+    .usage('[options] [dir] [files] file')
+    .option('-c, --config <path>', 'configuration path (default: synthetics.config.js)')
+    .addOption(pattern)
+    .addOption(tags)
+    .addOption(match)
+    .addOption(params)
+    .addOption(new commander_1.Option('--reporter <value>', `output reporter format`).choices(Object.keys(reporters_1.reporters)))
+    .option('--inline', 'Run inline journeys from heartbeat')
+    .option('-r, --require <modules...>', 'module(s) to preload')
+    .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('--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')
+    .option('--throttling <config>', 'JSON object to throttle network conditions for download and upload throughput in megabits/second and latency in milliseconds. Ex: { "download": 10, "upload": 5, "latency": 200 }.', options_1.parseThrottling)
+    .option('--no-throttling', 'Turns off default network throttling.', options_1.parseThrottling)
+    .addOption(playwrightOpts)
+    .version(version)
+    .description('Run synthetic tests')
+    .action(async (cliArgs) => {
+    const tearDown = await (0, loader_1.globalSetup)(cliArgs, commander_1.program.args);
+    try {
+        const options = (0, options_1.normalizeOptions)(cliArgs);
+        const results = await (0, _1.run)(options);
         /**
-         * Validate for package.json file before running
-         * the suites
+         * Exit with error status if any journey fails
          */
-        helpers_1.findPkgJsonByTraversing(absPath, resolvedCwd);
-        if (helpers_1.isDirectory(absPath)) {
-            await helpers_1.totalist(absPath, (rel, abs) => {
-                if (pattern.test(rel) && !ignored.test(rel)) {
-                    addSuite(abs);
+        if (!options.quietExitCode) {
+            for (const result of Object.values(results)) {
+                if (result.status === 'failed') {
+                    process.exit(1);
                 }
-            });
-        }
-        else {
-            addSuite(absPath);
+            }
         }
     }
-    return suites.values();
-}
-(async () => {
-    if (parse_args_1.options.inline) {
-        const source = await readStdin();
-        loadInlineScript(source);
+    catch (e) {
+        console.error(e);
+        process.exit(1);
     }
-    else {
-        /**
-         * Preload modules before running the suites
-         */
-        const modules = [].concat(parse_args_1.options.require || []).filter(Boolean);
-        for (const name of modules) {
-            if (helpers_1.isDepInstalled(name)) {
-                require(name);
-            }
-            else {
-                throw new Error(`cannot find module '${name}'`);
-            }
-        }
-        /**
-         * Transform `.ts` files out of the box by invoking
-         * the `ts-node` via `transpile-only` mode that compiles
-         * TS files without doing any extensive type checks
-         */
-        /* eslint-disable-next-line @typescript-eslint/no-var-requires */
-        require('ts-node').register({
-            transpileOnly: true,
-            compilerOptions: {
-                esModuleInterop: true,
-                allowJs: true,
-                target: 'es2018',
-            },
+    finally {
+        tearDown();
+    }
+});
+// Push command
+commander_1.program
+    .command('push')
+    .description('Push all journeys in the current directory to create monitors within the Kibana monitor management UI')
+    .addOption(new commander_1.Option('--auth <auth>', 'API key used for Kibana authentication(https://www.elastic.co/guide/en/kibana/master/api-keys.html).')
+    .env('SYNTHETICS_API_KEY')
+    .makeOptionMandatory(true))
+    .option('--schedule <time-in-minutes>', "schedule in minutes for the pushed monitors. Setting `10`, for example, configures monitors which don't have an interval defined to run every 10 minutes.", parseInt)
+    .addOption(new commander_1.Option('--locations <locations...>', 'default list of locations from which your monitors will run.').choices(monitor_1.SyntheticsLocations))
+    .option('--private-locations <locations...>', 'default list of private locations from which your monitors will run.')
+    .option('--url <url>', 'Kibana URL to upload the monitors')
+    .option('--id <id>', 'project id that will be used for logically grouping monitors')
+    .option('--space <space>', 'the target Kibana spaces for the pushed monitors — spaces help you organise pushed monitors.')
+    .option('-y, --yes', 'skip all questions and run non-interactively')
+    .addOption(pattern)
+    .addOption(tags)
+    .addOption(match)
+    .addOption(params)
+    .addOption(playwrightOpts)
+    .action(async (cmdOpts) => {
+    const workDir = (0, process_1.cwd)();
+    const tearDown = await (0, loader_1.globalSetup)({ inline: false, ...commander_1.program.opts() }, [
+        workDir,
+    ]);
+    try {
+        const settings = await (0, push_1.loadSettings)();
+        const options = (0, options_1.normalizeOptions)({
+            ...commander_1.program.opts(),
+            ...settings,
+            ...cmdOpts,
         });
-        /**
-         * Handle piped files by reading the STDIN
-         * ex: ls example/suites/*.js | npx @elastic/synthetics
-         */
-        const files = parse_args_1.default.args.length > 0
-            ? parse_args_1.default.args
-            : (await readStdin()).split('\n').filter(Boolean);
-        const suites = await prepareSuites(files);
-        requireSuites(suites);
+        (0, push_1.validateSettings)(options);
+        await (0, push_1.catchIncorrectSettings)(settings, options);
+        const monitors = core_1.runner.buildMonitors(options);
+        if (options.throttling == null) {
+            (0, push_1.warnIfThrottled)(monitors);
+        }
+        monitors.push(...(await (0, monitor_2.createLightweightMonitors)(workDir, options)));
+        await (0, push_1.push)(monitors, options);
+    }
+    catch (e) {
+        e && console.error(e);
+        process.exit(1);
+    }
+    finally {
+        tearDown();
+    }
+});
+// Init command
+commander_1.program
+    .command('init [dir]')
+    .description('Initialize Elastic synthetics project')
+    .action(async (dir = '') => {
+    try {
+        const generator = await new generator_1.Generator((0, path_1.resolve)(process.cwd(), dir));
+        await generator.setup();
+    }
+    catch (e) {
+        e && (0, helpers_1.error)(e);
+        process.exit(1);
     }
-    /**
-     * Use the NODE_ENV variable to control the environment
-     */
-    const environment = process.env['NODE_ENV'] || 'development';
-    /**
-     * Validate and handle configs
-     */
-    const config = config_1.readConfig(environment, parse_args_1.options.config);
-    const params = deepmerge_1.default(config.params, parse_args_1.options.suiteParams || {}, parse_args_1.options.params || {});
-    const playwrightOptions = deepmerge_1.default(config.playwrightOptions, {
-        headless: parse_args_1.options.headless,
-        chromiumSandbox: parse_args_1.options.sandbox,
-    });
-    /**
-     * use JSON reporter if json flag is enabled
-     */
-    const reporter = parse_args_1.options.json ? 'json' : parse_args_1.options.reporter;
-    const results = await _1.run({
-        params: Object.freeze(params),
-        environment,
-        reporter,
-        playwrightOptions,
-        ...parse_args_1.options,
-    });
-    /**
-     * Exit with error status if any journey fails
-     */
-    for (const result of Object.values(results)) {
-        if (result.status === 'failed') {
-            process.exit(1);
+});
+// Locations command
+commander_1.program
+    .command('locations')
+    .description(`List all locations to run the synthetics monitors. Pass optional '--url' and '--auth' to list private locations.`)
+    .option('--url <url>', 'Kibana URL to fetch all public and private locations')
+    .option('--auth <auth>', 'API key used for Kibana authentication(https://www.elastic.co/guide/en/kibana/master/api-keys.html).')
+    .action(async (cmdOpts) => {
+    try {
+        let locations = Object.keys(public_locations_1.LocationsMap);
+        if (cmdOpts.auth && cmdOpts.url) {
+            const allLocations = await (0, locations_1.getLocations)(cmdOpts);
+            locations = (0, locations_1.formatLocations)(allLocations);
         }
+        (0, locations_1.renderLocations)(locations);
+    }
+    catch (e) {
+        e && (0, helpers_1.error)(e);
+        process.exit(1);
     }
-})().catch(e => {
-    console.error(e);
-    process.exit(1);
 });
+commander_1.program.parse(process.argv);
 //# sourceMappingURL=cli.js.map

package/dist/cli.js.map

@@ -1 +1 @@
-{"version":3,"file":"cli.js","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":";;AAEA;;;;;;;;;;;;;;;;;;;;;;;GAuBG;;;;;;;;;;;;;;;;;;;;;;;;AAEH,qCAAqC;AACrC,+BAA+B;AAC/B,0DAA8B;AAC9B,iCAAuC;AACvC,0CAAoC;AACpC,2DAAgD;AAChD,uCAKmB;AACnB,yBAAyB;AACzB,qCAAsC;AAEtC,MAAM,WAAW,GAAG,aAAG,EAAE,CAAC;AAC1B;;;GAGG;AACH,MAAM,SAAS,GAAG,YAAY,CAAC;AAC/B,IAAI,OAAO,CAAC,GAAG,CAAC,KAAK,KAAK,SAAS,IAAI,OAAO,CAAC,oBAAO,CAAC,KAAK,CAAC,EAAE;IAC7D,OAAO,CAAC,GAAG,CAAC,KAAK,GAAG,GAAG,CAAC;CACzB;AAED,MAAM,gBAAgB,GAAG,MAAM,CAAC,EAAE;IAChC,MAAM,QAAQ,GAAG,IAAI,QAAQ,CAAC,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,CAAC,CAAC;IAC3E,cAAO,CAAC,QAAQ,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,EAAE,EAAE,EAAE;QACpD,QAAQ,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,WAAI,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC,CAAC;IACtD,CAAC,CAAC,CAAC;AACL,CAAC,CAAC;AAEF,KAAK,UAAU,SAAS;IACtB,MAAM,MAAM,GAAG,EAAE,CAAC;IAClB,eAAK,CAAC,MAAM,EAAE,CAAC;IACf,eAAK,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;IAC3B,IAAI,KAAK,EAAE,MAAM,KAAK,IAAI,eAAK,EAAE;QAC/B,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;KACpB;IACD,OAAO,MAAM,CAAC,IAAI,EAAE,CAAC;AACvB,CAAC;AAED,SAAS,aAAa,CAAC,MAAwB;IAC7C,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE;QAC1B,OAAO,CAAC,KAAK,CAAC,CAAC;KAChB;AACH,CAAC;AAED;;;GAGG;AACH,KAAK,UAAU,aAAa,CAAC,MAAgB;IAC3C,MAAM,MAAM,GAAG,IAAI,GAAG,EAAU,CAAC;IACjC,MAAM,QAAQ,GAAG,OAAO,CAAC,EAAE;QACzB,YAAG,CAAC,oBAAoB,OAAO,EAAE,CAAC,CAAC;QACnC,MAAM,CAAC,GAAG,CAAC,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC;IACvC,CAAC,CAAC;IACF;;;OAGG;IACH,MAAM,OAAO,GAAG,oBAAO,CAAC,OAAO;QAC7B,CAAC,CAAC,IAAI,MAAM,CAAC,oBAAO,CAAC,OAAO,EAAE,GAAG,CAAC;QAClC,CAAC,CAAC,+BAA+B,CAAC;IACpC;;OAEG;IACH,MAAM,OAAO,GAAG,eAAe,CAAC;IAEhC,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE;QAC1B,MAAM,OAAO,GAAG,cAAO,CAAC,WAAW,EAAE,KAAK,CAAC,CAAC;QAC5C;;;WAGG;QACH,iCAAuB,CAAC,OAAO,EAAE,WAAW,CAAC,CAAC;QAC9C,IAAI,qBAAW,CAAC,OAAO,CAAC,EAAE;YACxB,MAAM,kBAAQ,CAAC,OAAO,EAAE,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE;gBACnC,IAAI,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE;oBAC3C,QAAQ,CAAC,GAAG,CAAC,CAAC;iBACf;YACH,CAAC,CAAC,CAAC;SACJ;aAAM;YACL,QAAQ,CAAC,OAAO,CAAC,CAAC;SACnB;KACF;IACD,OAAO,MAAM,CAAC,MAAM,EAAE,CAAC;AACzB,CAAC;AAED,CAAC,KAAK,IAAI,EAAE;IACV,IAAI,oBAAO,CAAC,MAAM,EAAE;QAClB,MAAM,MAAM,GAAG,MAAM,SAAS,EAAE,CAAC;QACjC,gBAAgB,CAAC,MAAM,CAAC,CAAC;KAC1B;SAAM;QACL;;WAEG;QACH,MAAM,OAAO,GAAG,EAAE,CAAC,MAAM,CAAC,oBAAO,CAAC,OAAO,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QACjE,KAAK,MAAM,IAAI,IAAI,OAAO,EAAE;YAC1B,IAAI,wBAAc,CAAC,IAAI,CAAC,EAAE;gBACxB,OAAO,CAAC,IAAI,CAAC,CAAC;aACf;iBAAM;gBACL,MAAM,IAAI,KAAK,CAAC,uBAAuB,IAAI,GAAG,CAAC,CAAC;aACjD;SACF;QACD;;;;WAIG;QACH,iEAAiE;QACjE,OAAO,CAAC,SAAS,CAAC,CAAC,QAAQ,CAAC;YAC1B,aAAa,EAAE,IAAI;YACnB,eAAe,EAAE;gBACf,eAAe,EAAE,IAAI;gBACrB,OAAO,EAAE,IAAI;gBACb,MAAM,EAAE,QAAQ;aACjB;SACF,CAAC,CAAC;QACH;;;WAGG;QACH,MAAM,KAAK,GACT,oBAAO,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC;YACrB,CAAC,CAAC,oBAAO,CAAC,IAAI;YACd,CAAC,CAAC,CAAC,MAAM,SAAS,EAAE,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QACtD,MAAM,MAAM,GAAG,MAAM,aAAa,CAAC,KAAK,CAAC,CAAC;QAC1C,aAAa,CAAC,MAAM,CAAC,CAAC;KACvB;IAED;;OAEG;IACH,MAAM,WAAW,GAAG,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,IAAI,aAAa,CAAC;IAC7D;;OAEG;IACH,MAAM,MAAM,GAAG,mBAAU,CAAC,WAAW,EAAE,oBAAO,CAAC,MAAM,CAAC,CAAC;IACvD,MAAM,MAAM,GAAG,mBAAK,CAClB,MAAM,CAAC,MAAM,EACb,oBAAO,CAAC,WAAW,IAAI,EAAE,EACzB,oBAAO,CAAC,MAAM,IAAI,EAAE,CACrB,CAAC;IACF,MAAM,iBAAiB,GAAG,mBAAK,CAAC,MAAM,CAAC,iBAAiB,EAAE;QACxD,QAAQ,EAAE,oBAAO,CAAC,QAAQ;QAC1B,eAAe,EAAE,oBAAO,CAAC,OAAO;KACjC,CAAC,CAAC;IACH;;OAEG;IACH,MAAM,QAAQ,GAAG,oBAAO,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,oBAAO,CAAC,QAAQ,CAAC;IAE1D,MAAM,OAAO,GAAG,MAAM,MAAG,CAAC;QACxB,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC;QAC7B,WAAW;QACX,QAAQ;QACR,iBAAiB;QACjB,GAAG,oBAAO;KACX,CAAC,CAAC;IAEH;;OAEG;IACH,KAAK,MAAM,MAAM,IAAI,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE;QAC3C,IAAI,MAAM,CAAC,MAAM,KAAK,QAAQ,EAAE;YAC9B,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;SACjB;KACF;AACH,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE;IACb,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IACjB,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AAClB,CAAC,CAAC,CAAC"}
+{"version":3,"file":"cli.js","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":";;AAEA;;;;;;;;;;;;;;;;;;;;;;;GAuBG;;AAEH,yCAA4C;AAC5C,qCAA8B;AAE9B,2CAAwC;AACxC,uCAImB;AACnB,qCAAuC;AACvC,yBAAyB;AACzB,iCAAgC;AAChC,2CAAoD;AACpD,iCAMgB;AAChB,2CAKqB;AACrB,+BAA+B;AAC/B,2CAAwC;AACxC,uCAAkC;AAClC,mEAA4D;AAC5D,4CAA2D;AAE3D,iEAAiE;AACjE,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC,iBAAiB,CAAC,CAAC;AAErD,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,cAAc,EAAE,GAAG,IAAA,8BAAoB,GAAE,CAAC;AAEhF,mBAAO;KACJ,IAAI,CAAC,OAAO,IAAI,EAAE,CAAC;KACnB,KAAK,CAAC,8BAA8B,CAAC;KACrC,MAAM,CACL,qBAAqB,EACrB,oDAAoD,CACrD;KACA,SAAS,CAAC,OAAO,CAAC;KAClB,SAAS,CAAC,IAAI,CAAC;KACf,SAAS,CAAC,KAAK,CAAC;KAChB,SAAS,CAAC,MAAM,CAAC;KACjB,SAAS,CACR,IAAI,kBAAM,CAAC,oBAAoB,EAAE,wBAAwB,CAAC,CAAC,OAAO,CAChE,MAAM,CAAC,IAAI,CAAC,qBAAS,CAAC,CACvB,CACF;KACA,MAAM,CAAC,UAAU,EAAE,oCAAoC,CAAC;KACxD,MAAM,CAAC,4BAA4B,EAAE,sBAAsB,CAAC;KAC5D,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,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,MAAM,CACL,uBAAuB,EACvB,oLAAoL,EACpL,yBAAe,CAChB;KACA,MAAM,CACL,iBAAiB,EACjB,uCAAuC,EACvC,yBAAe,CAChB;KACA,SAAS,CAAC,cAAc,CAAC;KACzB,OAAO,CAAC,OAAO,CAAC;KAChB,WAAW,CAAC,qBAAqB,CAAC;KAClC,MAAM,CAAC,KAAK,EAAE,OAAgB,EAAE,EAAE;IACjC,MAAM,QAAQ,GAAG,MAAM,IAAA,oBAAW,EAAC,OAAO,EAAE,mBAAO,CAAC,IAAI,CAAC,CAAC;IAC1D,IAAI;QACF,MAAM,OAAO,GAAG,IAAA,0BAAgB,EAAC,OAAO,CAAC,CAAC;QAC1C,MAAM,OAAO,GAAG,MAAM,IAAA,MAAG,EAAC,OAAO,CAAC,CAAC;QACnC;;WAEG;QACH,IAAI,CAAC,OAAO,CAAC,aAAa,EAAE;YAC1B,KAAK,MAAM,MAAM,IAAI,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE;gBAC3C,IAAI,MAAM,CAAC,MAAM,KAAK,QAAQ,EAAE;oBAC9B,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;iBACjB;aACF;SACF;KACF;IAAC,OAAO,CAAC,EAAE;QACV,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QACjB,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;KACjB;YAAS;QACR,QAAQ,EAAE,CAAC;KACZ;AACH,CAAC,CAAC,CAAC;AAEL,eAAe;AACf,mBAAO;KACJ,OAAO,CAAC,MAAM,CAAC;KACf,WAAW,CACV,uGAAuG,CACxG;KACA,SAAS,CACR,IAAI,kBAAM,CACR,eAAe,EACf,sGAAsG,CACvG;KACE,GAAG,CAAC,oBAAoB,CAAC;KACzB,mBAAmB,CAAC,IAAI,CAAC,CAC7B;KACA,MAAM,CACL,8BAA8B,EAC9B,2JAA2J,EAC3J,QAAQ,CACT;KACA,SAAS,CACR,IAAI,kBAAM,CACR,4BAA4B,EAC5B,8DAA8D,CAC/D,CAAC,OAAO,CAAC,6BAAmB,CAAC,CAC/B;KACA,MAAM,CACL,oCAAoC,EACpC,sEAAsE,CACvE;KACA,MAAM,CAAC,aAAa,EAAE,mCAAmC,CAAC;KAC1D,MAAM,CACL,WAAW,EACX,8DAA8D,CAC/D;KACA,MAAM,CACL,iBAAiB,EACjB,8FAA8F,CAC/F;KACA,MAAM,CAAC,WAAW,EAAE,8CAA8C,CAAC;KACnE,SAAS,CAAC,OAAO,CAAC;KAClB,SAAS,CAAC,IAAI,CAAC;KACf,SAAS,CAAC,KAAK,CAAC;KAChB,SAAS,CAAC,MAAM,CAAC;KACjB,SAAS,CAAC,cAAc,CAAC;KACzB,MAAM,CAAC,KAAK,EAAE,OAAoB,EAAE,EAAE;IACrC,MAAM,OAAO,GAAG,IAAA,aAAG,GAAE,CAAC;IACtB,MAAM,QAAQ,GAAG,MAAM,IAAA,oBAAW,EAAC,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,mBAAO,CAAC,IAAI,EAAE,EAAE,EAAE;QACvE,OAAO;KACR,CAAC,CAAC;IACH,IAAI;QACF,MAAM,QAAQ,GAAG,MAAM,IAAA,mBAAY,GAAE,CAAC;QACtC,MAAM,OAAO,GAAG,IAAA,0BAAgB,EAAC;YAC/B,GAAG,mBAAO,CAAC,IAAI,EAAE;YACjB,GAAG,QAAQ;YACX,GAAG,OAAO;SACX,CAAgB,CAAC;QAClB,IAAA,uBAAgB,EAAC,OAAO,CAAC,CAAC;QAC1B,MAAM,IAAA,6BAAsB,EAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;QAChD,MAAM,QAAQ,GAAG,aAAM,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;QAC/C,IAAK,OAAmB,CAAC,UAAU,IAAI,IAAI,EAAE;YAC3C,IAAA,sBAAe,EAAC,QAAQ,CAAC,CAAC;SAC3B;QACD,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,MAAM,IAAA,mCAAyB,EAAC,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC;QACtE,MAAM,IAAA,WAAI,EAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;KAC/B;IAAC,OAAO,CAAC,EAAE;QACV,CAAC,IAAI,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QACtB,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;KACjB;YAAS;QACR,QAAQ,EAAE,CAAC;KACZ;AACH,CAAC,CAAC,CAAC;AAEL,eAAe;AACf,mBAAO;KACJ,OAAO,CAAC,YAAY,CAAC;KACrB,WAAW,CAAC,uCAAuC,CAAC;KACpD,MAAM,CAAC,KAAK,EAAE,GAAG,GAAG,EAAE,EAAE,EAAE;IACzB,IAAI;QACF,MAAM,SAAS,GAAG,MAAM,IAAI,qBAAS,CAAC,IAAA,cAAO,EAAC,OAAO,CAAC,GAAG,EAAE,EAAE,GAAG,CAAC,CAAC,CAAC;QACnE,MAAM,SAAS,CAAC,KAAK,EAAE,CAAC;KACzB;IAAC,OAAO,CAAC,EAAE;QACV,CAAC,IAAI,IAAA,eAAK,EAAC,CAAC,CAAC,CAAC;QACd,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;KACjB;AACH,CAAC,CAAC,CAAC;AAEL,oBAAoB;AACpB,mBAAO;KACJ,OAAO,CAAC,WAAW,CAAC;KACpB,WAAW,CACV,kHAAkH,CACnH;KACA,MAAM,CAAC,aAAa,EAAE,sDAAsD,CAAC;KAC7E,MAAM,CACL,eAAe,EACf,sGAAsG,CACvG;KACA,MAAM,CAAC,KAAK,EAAE,OAA2B,EAAE,EAAE;IAC5C,IAAI;QACF,IAAI,SAAS,GAAG,MAAM,CAAC,IAAI,CAAC,+BAAY,CAAC,CAAC;QAC1C,IAAI,OAAO,CAAC,IAAI,IAAI,OAAO,CAAC,GAAG,EAAE;YAC/B,MAAM,YAAY,GAAG,MAAM,IAAA,wBAAY,EAAC,OAAO,CAAC,CAAC;YACjD,SAAS,GAAG,IAAA,2BAAe,EAAC,YAAY,CAAC,CAAC;SAC3C;QACD,IAAA,2BAAe,EAAC,SAAS,CAAC,CAAC;KAC5B;IAAC,OAAO,CAAC,EAAE;QACV,CAAC,IAAI,IAAA,eAAK,EAAC,CAAC,CAAC,CAAC;QACd,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;KACjB;AACH,CAAC,CAAC,CAAC;AAEL,mBAAO,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC"}

package/dist/common_types.d.ts

@@ -22,11 +22,16 @@
  * THE SOFTWARE.
  *
  */
-import { BrowserContextOptions, LaunchOptions } from 'playwright-chromium';
-import { Protocol } from 'playwright-chromium/types/protocol';
+import { BrowserContextOptions, LaunchOptions, CDPSession, ChromiumBrowser, ChromiumBrowserContext, Page, APIRequestContext } from 'playwright-chromium';
 import { Step } from './dsl';
-import { reporters } from './reporters';
+import { BuiltInReporterName, ReporterInstance } from './reporters';
+import { MonitorConfig } from './dsl/monitor';
 export declare type VoidCallback = () => void;
+export declare type Location = {
+    file: string;
+    line: number;
+    column: number;
+};
 export declare type Params = Record<string, any>;
 export declare type HooksArgs = {
     env: string;
@@ -34,7 +39,19 @@ export declare type HooksArgs = {
 };
 export declare type HooksCallback = (args: HooksArgs) => void;
 export declare type StatusValue = 'succeeded' | 'failed' | 'skipped';
-export declare type Reporters = keyof typeof reporters;
+export declare type NetworkConditions = {
+    offline: boolean;
+    downloadThroughput: number;
+    uploadThroughput: number;
+    latency: number;
+};
+export declare type Driver = {
+    browser: ChromiumBrowser;
+    context: ChromiumBrowserContext;
+    page: Page;
+    client: CDPSession;
+    request: APIRequestContext;
+};
 export declare type TraceOutput = {
     name: string;
     type: string;
@@ -65,26 +82,61 @@ export declare type BrowserInfo = {
     name: string;
     version: string;
 };
+export declare type Screenshot = {
+    timestamp: number;
+    step: Step;
+    data: string;
+};
+export declare type SecurityDetails = {
+    issuer?: string;
+    protocol?: string;
+    subjectName?: string;
+    validFrom?: number;
+    validTo?: number;
+};
+export declare type Request = {
+    method: string;
+    url: string;
+    headers: Record<string, string>;
+    bytes?: number;
+    body?: {
+        bytes: number;
+    };
+    referrer?: string;
+};
+export declare type Response = {
+    url?: string;
+    status: number;
+    statusText?: string;
+    mimeType?: string;
+    headers: Record<string, string>;
+    bytes?: number;
+    body?: {
+        bytes: number;
+    };
+    transferSize?: number;
+    redirectURL?: string;
+    securityDetails?: SecurityDetails;
+    remoteIPAddress?: string;
+    remotePort?: number;
+    fromServiceWorker?: boolean;
+};
 export declare type NetworkInfo = {
     url: string;
     browser: BrowserInfo;
-    method: string;
     type: string;
-    request: Protocol.Network.Request;
-    response?: Protocol.Network.Response;
+    request: Request;
+    response: Response;
     isNavigationRequest: boolean;
     requestSentTime: number;
     loadEndTime: number;
     responseReceivedTime: number;
-    status: number;
     resourceSize: number;
     transferSize: number;
-    timings?: {
+    timings: {
         blocked: number;
-        queueing: number;
         dns: number;
         ssl: number;
-        proxy: number;
         connect: number;
         send: number;
         wait: number;
@@ -92,9 +144,11 @@ export declare type NetworkInfo = {
         total: number;
     };
 } & DefaultPluginOutput;
+export declare type PageMetrics = Record<string, number>;
 export declare type BrowserMessage = {
     text: string;
     type: string;
+    error?: Error;
 } & DefaultPluginOutput;
 export declare type PluginOutput = {
     filmstrips?: Array<Filmstrip>;
@@ -104,40 +158,110 @@ export declare type PluginOutput = {
     metrics?: PerfMetrics;
 };
 export declare type ScreenshotOptions = 'on' | 'off' | 'only-on-failure';
-export declare type CliArgs = {
-    capability?: Array<string>;
-    config?: string;
-    outfd?: number;
-    headless?: boolean;
+export declare type ThrottlingOptions = {
+    download?: number;
+    upload?: number;
+    latency?: number;
+};
+declare type BaseArgs = {
+    params?: Params;
     screenshots?: ScreenshotOptions;
-    ssblocks?: boolean;
-    metrics?: boolean;
-    filmstrips?: boolean;
-    trace?: boolean;
     dryRun?: boolean;
-    network?: boolean;
-    pauseOnError?: boolean;
-    reporter?: Reporters;
+    match?: string;
+    tags?: Array<string>;
+    outfd?: number;
     wsEndpoint?: string;
+    pauseOnError?: boolean;
+    ignoreHttpsErrors?: boolean;
+    playwrightOptions?: PlaywrightOptions;
+    quietExitCode?: boolean;
+    throttling?: MonitorConfig['throttling'];
+    schedule?: MonitorConfig['schedule'];
+    locations?: MonitorConfig['locations'];
+    privateLocations?: MonitorConfig['privateLocations'];
+};
+export declare type CliArgs = BaseArgs & {
+    config?: string;
+    reporter?: BuiltInReporterName;
+    pattern?: string;
+    inline?: boolean;
+    require?: Array<string>;
     sandbox?: boolean;
-    json?: boolean;
+    richEvents?: boolean;
+    capability?: Array<string>;
+    ignoreHttpsErrors?: boolean;
+};
+export declare type RunOptions = BaseArgs & {
+    metrics?: boolean;
+    ssblocks?: boolean;
+    network?: boolean;
+    trace?: boolean;
+    filmstrips?: boolean;
+    environment?: string;
+    playwrightOptions?: PlaywrightOptions;
+    networkConditions?: NetworkConditions;
+    reporter?: BuiltInReporterName | ReporterInstance;
+};
+export declare type PushOptions = Partial<ProjectSettings> & {
+    auth: string;
+    schedule?: MonitorConfig['schedule'];
+    locations?: MonitorConfig['locations'];
+    privateLocations?: MonitorConfig['privateLocations'];
+    yes?: boolean;
     pattern?: string;
-    inline: boolean;
     match?: string;
     tags?: Array<string>;
-    require: Array<string>;
-    debug?: boolean;
-    /**
-     * @deprecated use `params` instead
-     */
-    suiteParams?: Params;
-    params?: Params;
-    richEvents?: boolean;
 };
-export declare type PlaywrightOptions = LaunchOptions & BrowserContextOptions;
+export declare type ProjectSettings = {
+    id: string;
+    url: string;
+    space: string;
+};
+export declare type PlaywrightOptions = LaunchOptions & BrowserContextOptions & {
+    testIdAttribute?: string;
+    actionTimeout?: number;
+    navigationTimeout?: number;
+};
 export declare type SyntheticsConfig = {
     params?: Params;
     playwrightOptions?: PlaywrightOptions;
+    monitor?: MonitorConfig;
+    project?: ProjectSettings;
+};
+/** Runner Payload types */
+export declare type JourneyResult = {
+    status: StatusValue;
+    error?: Error;
+    networkinfo?: PluginOutput['networkinfo'];
+    browserconsole?: PluginOutput['browserconsole'];
+};
+export declare type StepResult = {
+    status: StatusValue;
+    url?: string;
+    error?: Error;
+    pagemetrics?: PageMetrics;
+    filmstrips?: PluginOutput['filmstrips'];
+    metrics?: PluginOutput['metrics'];
+    traces?: PluginOutput['traces'];
+};
+/** Reporter and Runner contract */
+export declare type StartEvent = {
+    numJourneys: number;
+    networkConditions?: NetworkConditions;
+};
+export declare type JourneyStartResult = {
+    timestamp: number;
+    params?: Params;
+};
+export declare type JourneyEndResult = JourneyStartResult & JourneyResult & {
+    start: number;
+    end: number;
+    options: RunOptions;
+    timestamp: number;
+};
+export declare type StepEndResult = StepResult & {
+    start: number;
+    end: number;
 };
 export {};
 //# sourceMappingURL=common_types.d.ts.map