@elastic/synthetics 1.14.0 → 1.16.0

package/src/cli.ts

@@ -27,6 +27,8 @@
 
 import { program, Option } from 'commander';
 import { cwd } from 'process';
+import { bold } from 'kleur/colors';
+import { resolve } from 'path';
 import { CliArgs, PushOptions } from './common_types';
 import { reporters } from './reporters';
 import {
@@ -36,7 +38,7 @@ import {
 } from './options';
 import { globalSetup } from './loader';
 import { run } from './';
-import { runner } from './core';
+import { runner } from './core/globals';
 import { SyntheticsLocations } from './dsl/monitor';
 import { push, loadSettings, validatePush, warnIfThrottled } from './push';
 import {
@@ -45,13 +47,13 @@ import {
   renderLocations,
   LocationCmdOptions,
 } from './locations';
-import { resolve } from 'path';
 import { Generator } from './generator';
-import { error } from './helpers';
+import { error, write } from './helpers';
 import { LocationsMap } from './locations/public-locations';
 import { createLightweightMonitors } from './push/monitor';
 import { getVersion } from './push/kibana_api';
 import { installTransform } from './core/transform';
+import { totp, TOTPCmdOptions } from './core/mfa';
 
 /* eslint-disable-next-line @typescript-eslint/no-var-requires */
 const { name, version } = require('../package.json');
@@ -65,6 +67,7 @@ const {
   configOpt,
   tags,
   match,
+  fields,
 } = getCommonCommandOpts();
 
 program
@@ -191,9 +194,9 @@ program
     '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(fields)
   .addOption(match)
   .addOption(params)
   .addOption(playwrightOpts)
@@ -214,7 +217,7 @@ program
         'push'
       )) as PushOptions;
       await validatePush(options, settings);
-      const monitors = runner.buildMonitors(options);
+      const monitors = runner._buildMonitors(options);
       if ((options as CliArgs).throttling == null) {
         warnIfThrottled(monitors);
       }
@@ -272,4 +275,20 @@ program
     }
   });
 
+// TOTP command
+program
+  .command('totp <secret>')
+  .description('Generate a Time-based One-Time token using the provided secret.')
+  .option('--issuer <issuer>', 'Provider or Service the secret is associated with.')
+  .option('--label <label>', 'Account Identifier (default: SyntheticsTOTP)')
+  .action((secret, cmdOpts: TOTPCmdOptions) => {
+    try {
+      const token = totp(secret, cmdOpts)
+      write(bold(`OTP Token: ${token}`));
+    } catch (e) {
+      error(e);
+      process.exit(1);
+    }
+  });
+
 program.parse(process.argv);

package/src/common_types.ts

@@ -32,9 +32,10 @@ import {
   Page,
   APIRequestContext,
 } from 'playwright-core';
-import { Step } from './dsl';
+import { Journey, Step } from './dsl';
 import { BuiltInReporterName, ReporterInstance } from './reporters';
 import { AlertConfig, MonitorConfig } from './dsl/monitor';
+import { RunnerInfo } from './core/runner';
 
 export type VoidCallback = () => void;
 export type Location = {
@@ -51,9 +52,10 @@ export type Params = Record<string, any>;
 export type HooksArgs = {
   env: string;
   params: Params;
+  info: RunnerInfo;
 };
 export type HooksCallback = (args: HooksArgs) => void;
-export type StatusValue = 'succeeded' | 'failed' | 'skipped';
+export type StatusValue = 'pending' | 'succeeded' | 'failed' | 'skipped';
 
 export type NetworkConditions = {
   offline: boolean;
@@ -221,6 +223,7 @@ type BaseArgs = {
   schedule?: MonitorConfig['schedule'];
   locations?: MonitorConfig['locations'];
   privateLocations?: MonitorConfig['privateLocations'];
+  fields?: MonitorConfig['fields'];
 };
 
 export type CliArgs = BaseArgs & {
@@ -255,6 +258,7 @@ export type PushOptions = Partial<ProjectSettings> &
     kibanaVersion?: string;
     yes?: boolean;
     tags?: Array<string>;
+    fields?: MonitorConfig['fields'];
     alert?: AlertConfig;
     retestOnFailure?: MonitorConfig['retestOnFailure'];
     enabled?: boolean;
@@ -282,12 +286,10 @@ export type SyntheticsConfig = {
 };
 
 /** Runner Payload types */
-export type JourneyResult = {
-  status: StatusValue;
-  error?: Error;
+export type JourneyResult = Partial<Journey> & {
   networkinfo?: PluginOutput['networkinfo'];
   browserconsole?: PluginOutput['browserconsole'];
-  steps?: Array<StepResult>;
+  stepsresults?: Array<StepResult>;
 };
 
 export type TestError = {
@@ -299,9 +301,6 @@ export type TestError = {
 };
 
 export type StepResult = {
-  status: StatusValue;
-  url?: string;
-  error?: Error;
   pagemetrics?: PageMetrics;
   filmstrips?: PluginOutput['filmstrips'];
   metrics?: PluginOutput['metrics'];
@@ -321,14 +320,8 @@ export type JourneyStartResult = {
 
 export type JourneyEndResult = JourneyStartResult &
   JourneyResult & {
-    start: number;
-    end: number;
     browserDelay: number;
     options: RunOptions;
-    timestamp: number;
   };
 
-export type StepEndResult = StepResult & {
-  start: number;
-  end: number;
-};
+export type StepEndResult = StepResult

package/src/core/gatherer.ts

@@ -43,25 +43,37 @@ const DEFAULT_TIMEOUT = 50000;
  */
 export class Gatherer {
   static browser: ChromiumBrowser;
+  static pluginManager: PluginManager;
 
-  static async setupDriver(options: RunOptions): Promise<Driver> {
-    log('Gatherer: setup driver');
-    const { wsEndpoint, playwrightOptions } = options;
+  static async launchBrowser(options: RunOptions) {
+    if (Gatherer.browser != null) {
+      return;
+    }
 
-    if (Gatherer.browser == null) {
-      if (wsEndpoint) {
-        log(`Gatherer: connecting to WS endpoint: ${wsEndpoint}`);
-        Gatherer.browser = await chromium.connect(wsEndpoint);
-      } else {
-        Gatherer.browser = await chromium.launch({
-          ...playwrightOptions,
-          args: [
-            ...(playwrightOptions?.headless ? ['--disable-gpu'] : []),
-            ...(playwrightOptions?.args ?? []),
-          ],
-        });
-      }
+    log('Gatherer: setup browser');
+    const { wsEndpoint, playwrightOptions } = options;
+    if (wsEndpoint) {
+      log(`Gatherer: connecting to WS endpoint: ${wsEndpoint}`);
+      Gatherer.browser = await chromium.connect(wsEndpoint);
+    } else {
+      Gatherer.browser = await chromium.launch({
+        ...playwrightOptions,
+        args: [
+          ...(playwrightOptions?.headless ? ['--disable-gpu'] : []),
+          ...(playwrightOptions?.args ?? []),
+        ],
+      });
     }
+    // Register sig int handler to close the browser
+    process.on('SIGINT', async () => {
+      await Gatherer.stop();
+      process.exit(130);
+    });
+  }
+
+  static async setupDriver(options: RunOptions): Promise<Driver> {
+    await Gatherer.launchBrowser(options);
+    const { playwrightOptions } = options;
     const context = await Gatherer.browser.newContext({
       ...playwrightOptions,
       userAgent: await Gatherer.getUserAgent(playwrightOptions?.userAgent),
@@ -84,12 +96,6 @@ export class Gatherer {
     const page = await context.newPage();
     const client = await context.newCDPSession(page);
     const request = await apiRequest.newContext({ ...playwrightOptions });
-
-    // Register sig int handler to close the browser
-    process.on('SIGINT', async () => {
-      await Gatherer.closeBrowser();
-      process.exit(130);
-    });
     return { browser: Gatherer.browser, context, page, client, request };
   }
 
@@ -126,14 +132,6 @@ export class Gatherer {
     }
   }
 
-  static async closeBrowser() {
-    log(`Gatherer: closing browser`);
-    if (Gatherer.browser) {
-      await Gatherer.browser.close();
-      Gatherer.browser = null;
-    }
-  }
-
   /**
    * Starts recording all events related to the v8 devtools protocol
    * https://chromedevtools.github.io/devtools-protocol/v8/
@@ -141,13 +139,18 @@ export class Gatherer {
   static async beginRecording(driver: Driver, options: RunOptions) {
     log('Gatherer: started recording');
     const { network, metrics } = options;
-    const pluginManager = new PluginManager(driver);
-    pluginManager.registerAll(options);
-    const plugins = [await pluginManager.start('browserconsole')];
-    network && plugins.push(await pluginManager.start('network'));
-    metrics && plugins.push(await pluginManager.start('performance'));
+    Gatherer.pluginManager = new PluginManager(driver);
+    Gatherer.pluginManager.registerAll(options);
+    const plugins = [await Gatherer.pluginManager.start('browserconsole')];
+    network && plugins.push(await Gatherer.pluginManager.start('network'));
+    metrics && plugins.push(await Gatherer.pluginManager.start('performance'));
     await Promise.all(plugins);
-    return pluginManager;
+    return Gatherer.pluginManager;
+  }
+
+  static async endRecording() {
+    log('Gatherer: ended recording');
+    await Gatherer.pluginManager.unregisterAll();
   }
 
   static async dispose(driver: Driver) {
@@ -157,6 +160,10 @@ export class Gatherer {
   }
 
   static async stop() {
-    await Gatherer.closeBrowser();
+    log(`Gatherer: closing browser`);
+    if (Gatherer.browser) {
+      await Gatherer.browser.close();
+      Gatherer.browser = null;
+    }
   }
 }

package/src/core/globals.ts

@@ -0,0 +1,37 @@
+/**
+ * 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 Runner from './runner';
+
+/**
+ * Use a gloabl Runner which would be accessed by the runtime and
+ * required to handle the local vs global invocation through CLI
+ */
+const SYNTHETICS_RUNNER = Symbol.for('SYNTHETICS_RUNNER');
+if (!global[SYNTHETICS_RUNNER]) {
+  global[SYNTHETICS_RUNNER] = new Runner();
+}
+
+export const runner: Runner = global[SYNTHETICS_RUNNER];

package/src/core/index.ts

@@ -30,23 +30,12 @@ import {
   JourneyWithAnnotations,
   StepWithAnnotations,
 } from '../dsl';
-import Runner from './runner';
+import { runner } from "./globals"
 import { VoidCallback, HooksCallback, Location } from '../common_types';
 import { wrapFnWithLocation } from '../helpers';
 import { log } from './logger';
 import { MonitorConfig } from '../dsl/monitor';
 
-/**
- * Use a gloabl Runner which would be accessed by the runtime and
- * required to handle the local vs global invocation through CLI
- */
-const SYNTHETICS_RUNNER = Symbol.for('SYNTHETICS_RUNNER');
-if (!global[SYNTHETICS_RUNNER]) {
-  global[SYNTHETICS_RUNNER] = new Runner();
-}
-
-export const runner: Runner = global[SYNTHETICS_RUNNER];
-
 const createJourney = (type?: 'skip' | 'only') =>
   wrapFnWithLocation(
     (
@@ -59,12 +48,10 @@ const createJourney = (type?: 'skip' | 'only') =>
         options = { name: options, id: options };
       }
       const j = new Journey(options, callback, location);
-
       if (type) {
         j[type] = true;
       }
-
-      runner.addJourney(j);
+      runner._addJourney(j);
       return j;
     }
   );
@@ -77,7 +64,7 @@ const createStep = (type?: 'skip' | 'soft' | 'only') =>
   wrapFnWithLocation(
     (location: Location, name: string, callback: VoidCallback) => {
       log(`Step register: ${name}`);
-      const step = runner.currentJourney?.addStep(name, callback, location);
+      const step = runner.journey?._addStep(name, callback, location);
       if (type) {
         step[type] = true;
       }
@@ -96,32 +83,32 @@ export const monitor = {
      * If the context is inside journey, then set it to journey context
      * otherwise set to the global monitor which will be used for all journeys
      */
-    if (runner.currentJourney) {
-      runner.currentJourney.updateMonitor(config);
+    if (runner.journey) {
+      runner.journey._updateMonitor(config);
     } else {
-      runner.updateMonitor(config);
+      runner._updateMonitor(config);
     }
   }),
 };
 
 export const beforeAll = (callback: HooksCallback) => {
-  runner.addHook('beforeAll', callback);
+  runner._addHook('beforeAll', callback);
 };
 
 export const afterAll = (callback: HooksCallback) => {
-  runner.addHook('afterAll', callback);
+  runner._addHook('afterAll', callback);
 };
 
 export const before = (callback: HooksCallback) => {
-  if (!runner.currentJourney) {
+  if (!runner.journey) {
     throw new Error('before is called outside of the journey context');
   }
-  return runner.currentJourney.addHook('before', callback);
+  return runner.journey._addHook('before', callback);
 };
 
 export const after = (callback: HooksCallback) => {
-  if (!runner.currentJourney) {
+  if (!runner.journey) {
     throw new Error('after is called outside of the journey context');
   }
-  return runner.currentJourney.addHook('after', callback);
+  return runner.journey._addHook('after', callback);
 };

package/src/core/mfa.ts

@@ -60,6 +60,11 @@ type TOTPOptions = {
   period?: number
 };
 
+export type TOTPCmdOptions = {
+  issuer?: string
+  label?: string
+};
+
 export function totp(secret?: string, options: TOTPOptions = {}) {
   return new TOTP({ label: "SyntheticsTOTP", secret, ...options }).generate();
 }