@elastic/synthetics 1.0.0-beta.25 → 1.0.0-beta.26

package/src/cli.ts

@@ -26,12 +26,17 @@
  */
 
 import { program, Option } from 'commander';
-import { CliArgs } from './common_types';
+import { CliArgs, PushOptions } from './common_types';
 import { reporters } from './reporters';
-import { DEFAULT_NETWORK_CONDITIONS_ARG } from './helpers';
-import { normalizeOptions } from './options';
+import { normalizeOptions, parseThrottling } from './options';
 import { loadTestFiles } from './loader';
 import { run } from './';
+import { runner } from './core';
+import { SyntheticsLocations } from './dsl/monitor';
+import { push } from './push';
+import { resolve } from 'path';
+import { Generator } from './generator';
+import { error } from './helpers';
 
 /* eslint-disable-next-line @typescript-eslint/no-var-requires */
 const { name, version } = require('../package.json');
@@ -105,9 +110,10 @@ program
     '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 <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_NETWORK_CONDITIONS_ARG
+    '--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 }.',
+    parseThrottling,
+    {}
   )
   .option('--no-throttling', 'Turns off default network throttling.')
   .option(
@@ -138,13 +144,63 @@ program
     }
   });
 
+// Push command
 program
-  .command('push')
+  .command('push [files...]')
   .description(
     'Push monitors to create new montors with Kibana monitor management UI'
   )
-  .action(() => {
-    throw new Error('TODO: Implement me');
+  .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 Option(
+      '--locations <locations...>',
+      'The default list of locations from which your monitors will run.'
+    ).choices(SyntheticsLocations)
+  )
+  .requiredOption(
+    '--project <id/name>',
+    'project/repository that will be used for grouping the monitors.'
+  )
+  .requiredOption('--url <url>', 'kibana URL to upload the monitors')
+  .requiredOption(
+    '--auth <auth>',
+    'user authentication (in user:password format) or API key that will be used to communicate with Kibana.'
+  )
+  .option(
+    '--space <space>',
+    'the target Kibana spaces for the pushed monitors — spaces help you organise pushed monitors.',
+    'default'
+  )
+  .option('--delete', 'automatically delete the stale monitors.')
+  .action(async (files, cmdOpts: PushOptions) => {
+    try {
+      const cliArgs = { inline: false };
+      await loadTestFiles(cliArgs, files);
+      const options = normalizeOptions({ ...program.opts(), ...cmdOpts });
+      const monitors = runner.buildMonitors(options);
+      await push(monitors, cmdOpts);
+    } catch (e) {
+      console.error(e);
+      process.exit(1);
+    }
+  });
+
+// Init command
+program
+  .command('init <project-dir>')
+  .description('Initalize Elastic synthetics project')
+  .action(async (dir: string) => {
+    try {
+      const generator = await new Generator(resolve(process.cwd(), dir));
+      await generator.setup();
+    } catch (e) {
+      error(e);
+      process.exit(1);
+    }
   });
 
 program.parse(process.argv);

package/src/common_types.ts

@@ -32,7 +32,8 @@ import {
   Page,
 } from 'playwright-chromium';
 import { Step } from './dsl';
-import { Reporter, reporters } from './reporters';
+import { BuiltInReporterName, ReporterInstance } from './reporters';
+import { MonitorConfig } from './dsl/monitor';
 
 export type VoidCallback = () => void;
 export type Location = {
@@ -48,7 +49,6 @@ export type HooksArgs = {
 };
 export type HooksCallback = (args: HooksArgs) => void;
 export type StatusValue = 'succeeded' | 'failed' | 'skipped';
-export type Reporters = keyof typeof reporters;
 
 export type NetworkConditions = {
   offline: boolean;
@@ -171,6 +171,8 @@ export type NetworkInfo = {
   };
 } & DefaultPluginOutput;
 
+export type PageMetrics = Record<string, number>;
+
 export type BrowserMessage = {
   text: string;
   type: string;
@@ -187,6 +189,12 @@ export type PluginOutput = {
 
 export type ScreenshotOptions = 'on' | 'off' | 'only-on-failure';
 
+export type ThrottlingOptions = {
+  download?: number;
+  upload?: number;
+  latency?: number;
+};
+
 type BaseArgs = {
   params?: Params;
   screenshots?: ScreenshotOptions;
@@ -199,11 +207,14 @@ type BaseArgs = {
   ignoreHttpsErrors?: boolean;
   playwrightOptions?: PlaywrightOptions;
   quietExitCode?: boolean;
+  throttling?: ThrottlingOptions;
+  schedule?: MonitorConfig['schedule'];
+  locations?: MonitorConfig['locations'];
 };
 
 export type CliArgs = BaseArgs & {
   config?: string;
-  reporter?: Reporters;
+  reporter?: BuiltInReporterName;
   pattern?: string;
   inline?: boolean;
   require?: Array<string>;
@@ -212,7 +223,7 @@ export type CliArgs = BaseArgs & {
   richEvents?: boolean;
   capability?: Array<string>;
   ignoreHttpsErrors?: boolean;
-  throttling?: boolean | string;
+  throttling?: boolean | ThrottlingOptions;
 };
 
 export type RunOptions = BaseArgs & {
@@ -224,11 +235,64 @@ export type RunOptions = BaseArgs & {
   environment?: string;
   playwrightOptions?: PlaywrightOptions;
   networkConditions?: NetworkConditions;
-  reporter?: CliArgs['reporter'] | Reporter;
+  reporter?: BuiltInReporterName | ReporterInstance;
+};
+
+export type PushOptions = {
+  auth: string;
+  url: string;
+  project: string;
+  space: string;
+  delete: boolean;
+  schedule?: MonitorConfig['schedule'];
+  locations?: MonitorConfig['locations'];
 };
 
 export type PlaywrightOptions = LaunchOptions & BrowserContextOptions;
 export type SyntheticsConfig = {
   params?: Params;
   playwrightOptions?: PlaywrightOptions;
+  monitor?: MonitorConfig;
+};
+
+/** Runner Payload types */
+export type JourneyResult = {
+  status: StatusValue;
+  error?: Error;
+  networkinfo?: PluginOutput['networkinfo'];
+  browserconsole?: PluginOutput['browserconsole'];
+};
+
+export type StepResult = {
+  status: StatusValue;
+  url?: string;
+  error?: Error;
+  pagemetrics?: PageMetrics;
+  filmstrips?: PluginOutput['filmstrips'];
+  metrics?: PluginOutput['metrics'];
+  traces?: PluginOutput['traces'];
+};
+
+/** Reporter and Runner contract */
+export type StartEvent = {
+  numJourneys: number;
+  networkConditions?: NetworkConditions;
+};
+
+export type JourneyStartResult = {
+  timestamp: number;
+  params?: Params;
+};
+
+export type JourneyEndResult = JourneyStartResult &
+  JourneyResult & {
+    start: number;
+    end: number;
+    options: RunOptions;
+    timestamp: number;
+  };
+
+export type StepEndResult = StepResult & {
+  start: number;
+  end: number;
 };

package/src/core/gatherer.ts

@@ -26,7 +26,7 @@
 import { chromium, ChromiumBrowser, BrowserContext } from 'playwright-chromium';
 import { PluginManager } from '../plugins';
 import { log } from './logger';
-import { Driver, RunOptions } from '../common_types';
+import { Driver, NetworkConditions, RunOptions } from '../common_types';
 
 /**
  * Purpose of the Gatherer is to set up the necessary browser driver
@@ -75,7 +75,7 @@ export class Gatherer {
 
   static setNetworkConditions(
     context: BrowserContext,
-    networkConditions: RunOptions['networkConditions']
+    networkConditions: NetworkConditions
   ) {
     if (networkConditions) {
       context.on('page', page => {

package/src/core/index.ts

@@ -28,6 +28,7 @@ import Runner from './runner';
 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
@@ -63,6 +64,20 @@ export const step = wrapFnWithLocation(
   }
 );
 
+export const monitor = {
+  use: wrapFnWithLocation((location: Location, config: MonitorConfig) => {
+    /**
+     * 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);
+    } else {
+      runner.updateMonitor(config);
+    }
+  }),
+};
+
 export const beforeAll = (callback: HooksCallback) => {
   runner.addHook('beforeAll', callback);
 };

package/src/core/runner.ts

@@ -23,12 +23,11 @@
  *
  */
 
-import { once, EventEmitter } from 'events';
 import { join } from 'path';
 import { rm } from 'fs/promises';
 import { Journey } from '../dsl/journey';
 import { Step } from '../dsl/step';
-import { reporters } from '../reporters';
+import { reporters, Reporter } from '../reporters';
 import {
   CACHE_PATH,
   monotonicTimeInSeconds,
@@ -39,20 +38,20 @@ import {
   writeFileAsync,
 } from '../helpers';
 import {
-  StatusValue,
   HooksCallback,
   Params,
-  NetworkConditions,
-  PluginOutput,
   HooksArgs,
   Driver,
   Screenshot,
   RunOptions,
+  JourneyResult,
+  StepResult,
 } from '../common_types';
-import { PageMetrics, PluginManager } from '../plugins';
+import { PluginManager } from '../plugins';
 import { PerformanceManager } from '../plugins';
 import { Gatherer } from './gatherer';
 import { log } from './logger';
+import { Monitor, MonitorConfig } from '../dsl/monitor';
 
 type HookType = 'beforeAll' | 'afterAll';
 export type SuiteHooks = Record<HookType, Array<HooksCallback>>;
@@ -64,73 +63,16 @@ type JourneyContext = {
   pluginManager: PluginManager;
 };
 
-type StepResult = {
-  status: StatusValue;
-  url?: string;
-  error?: Error;
-  pagemetrics?: PageMetrics;
-  filmstrips?: PluginOutput['filmstrips'];
-  metrics?: PluginOutput['metrics'];
-  traces?: PluginOutput['traces'];
-};
-
-type JourneyResult = {
-  status: StatusValue;
-  error?: Error;
-  networkinfo?: PluginOutput['networkinfo'];
-  browserconsole?: PluginOutput['browserconsole'];
-};
-
 type RunResult = Record<string, JourneyResult>;
 
-interface StepEvent {
-  step: Step;
-  journey: Journey;
-}
-
-interface JourneyEvent {
-  journey: Journey;
-  timestamp: number;
-  params?: Params;
-}
-
-interface Events {
-  start: {
-    numJourneys: number;
-    networkConditions?: NetworkConditions;
-  };
-  'journey:register': {
-    journey: Journey;
-  };
-  'journey:start': JourneyEvent;
-  'journey:end': JourneyEvent &
-    JourneyResult & {
-      start: number;
-      end: number;
-      options: RunOptions;
-      timestamp: number;
-    };
-  'journey:end:reported': unknown;
-  'step:start': StepEvent;
-  'step:end': StepEvent &
-    StepResult & {
-      start: number;
-      end: number;
-    };
-  end: unknown;
-}
-
-export default interface Runner {
-  on<K extends keyof Events>(name: K, listener: (v: Events[K]) => void): this;
-  emit<K extends keyof Events>(event: K, args: Events[K]): boolean;
-}
-
-export default class Runner extends EventEmitter {
-  active = false;
-  currentJourney?: Journey = null;
+export default class Runner {
+  #active = false;
+  #reporter: Reporter;
+  #currentJourney?: Journey = null;
   journeys: Journey[] = [];
   hooks: SuiteHooks = { beforeAll: [], afterAll: [] };
   hookError: Error | undefined;
+  monitor?: Monitor;
   static screenshotPath = join(CACHE_PATH, 'screenshots');
 
   static async createContext(options: RunOptions): Promise<JourneyContext> {
@@ -181,13 +123,38 @@ export default class Runner extends EventEmitter {
     }
   }
 
+  get currentJourney() {
+    return this.#currentJourney;
+  }
+
   addHook(type: HookType, callback: HooksCallback) {
     this.hooks[type].push(callback);
   }
 
+  updateMonitor(config: MonitorConfig) {
+    if (!this.monitor) {
+      this.monitor = new Monitor(config);
+      return;
+    }
+    this.monitor.update(config);
+  }
+
   addJourney(journey: Journey) {
     this.journeys.push(journey);
-    this.currentJourney = journey;
+    this.#currentJourney = journey;
+  }
+
+  setReporter(options: RunOptions) {
+    /**
+     * Set up the corresponding reporter and fallback
+     * to default reporter if not provided
+     */
+    const { reporter, outfd } = options;
+    const Reporter =
+      typeof reporter === 'function'
+        ? reporter
+        : reporters[reporter] || reporters['default'];
+    this.#reporter = new Reporter({ fd: outfd });
   }
 
   async runBeforeAllHook(args: HooksArgs) {
@@ -288,7 +255,7 @@ export default class Runner extends EventEmitter {
     let skipStep = false;
     for (const step of journey.steps) {
       const start = monotonicTimeInSeconds();
-      this.emit('step:start', { journey, step });
+      this.#reporter?.onStepStart?.(journey, step);
       let data: StepResult = { status: 'succeeded' };
       if (skipStep) {
         data.status = 'skipped';
@@ -299,9 +266,7 @@ export default class Runner extends EventEmitter {
          */
         if (data.error) skipStep = true;
       }
-      this.emit('step:end', {
-        journey,
-        step,
+      this.#reporter?.onStepEnd?.(journey, step, {
         start,
         end: monotonicTimeInSeconds(),
         ...data,
@@ -315,12 +280,16 @@ export default class Runner extends EventEmitter {
   }
 
   registerJourney(journey: Journey, context: JourneyContext) {
-    this.currentJourney = journey;
+    this.#currentJourney = journey;
     const timestamp = getTimestamp();
     const { params } = context;
-    this.emit('journey:start', { journey, timestamp, params });
+    this.#reporter?.onJourneyStart?.(journey, {
+      timestamp,
+      params,
+    });
     /**
-     * Load and register the steps for the current journey
+     * Exeucute the journey callback which would
+     * register the steps for the current journey
      */
     journey.callback({ ...context.driver, params });
   }
@@ -333,8 +302,7 @@ export default class Runner extends EventEmitter {
     const end = monotonicTimeInSeconds();
     const { pluginManager, start, status, error } = result;
     const pluginOutput = await pluginManager.output();
-    this.emit('journey:end', {
-      journey,
+    await this.#reporter?.onJourneyEnd?.(journey, {
       status,
       error,
       start,
@@ -344,13 +312,6 @@ export default class Runner extends EventEmitter {
       ...pluginOutput,
       browserconsole: status == 'failed' ? pluginOutput.browserconsole : [],
     });
-    /**
-     * Wait for the all the reported events to be consumed aschronously
-     * by reporter.
-     */
-    if (options.reporter === 'json') {
-      await once(this, 'journey:end:reported');
-    }
     // clear screenshots cache after each journey
     await rm(Runner.screenshotPath, { recursive: true, force: true });
   }
@@ -360,8 +321,7 @@ export default class Runner extends EventEmitter {
    */
   async runFakeJourney(journey: Journey, options: RunOptions) {
     const start = monotonicTimeInSeconds();
-    this.emit('journey:start', {
-      journey,
+    this.#reporter.onJourneyStart?.(journey, {
       timestamp: getTimestamp(),
       params: options.params,
     });
@@ -369,24 +329,18 @@ export default class Runner extends EventEmitter {
       status: 'failed',
       error: this.hookError,
     };
-    this.emit('journey:end', {
-      journey,
+    await this.#reporter.onJourneyEnd?.(journey, {
       timestamp: getTimestamp(),
       start,
       options,
       end: monotonicTimeInSeconds(),
       ...result,
     });
-    if (options.reporter === 'json') {
-      await once(this, 'journey:end:reported');
-    }
     return result;
   }
 
   async runJourney(journey: Journey, options: RunOptions) {
-    const result: JourneyResult = {
-      status: 'succeeded',
-    };
+    const result: JourneyResult = { status: 'succeeded' };
     const context = await Runner.createContext(options);
     log(`Runner: start journey (${journey.name})`);
     try {
@@ -419,18 +373,10 @@ export default class Runner extends EventEmitter {
   }
 
   async init(options: RunOptions) {
-    const { reporter, outfd, networkConditions } = options;
-    /**
-     * Set up the corresponding reporter and fallback
-     */
-    const Reporter =
-      typeof reporter === 'function'
-        ? reporter
-        : reporters[reporter] || reporters['default'];
-    new Reporter(this, { fd: outfd });
-    this.emit('start', {
+    this.setReporter(options);
+    this.#reporter.onStart?.({
       numJourneys: this.journeys.length,
-      networkConditions,
+      networkConditions: options.networkConditions,
     });
     /**
      * Set up the directory for caching screenshots
@@ -438,12 +384,39 @@ export default class Runner extends EventEmitter {
     await mkdirAsync(CACHE_PATH, { recursive: true });
   }
 
+  buildMonitors(options: RunOptions) {
+    /**
+     * Update the global monitor configuration required for
+     * setting defaults
+     */
+    this.updateMonitor({
+      throttling: options.throttling,
+      schedule: options.schedule,
+      locations: options.locations,
+      params: options.params,
+      playwrightOptions: options.playwrightOptions,
+    });
+
+    const monitors: Monitor[] = [];
+    for (const journey of this.journeys) {
+      this.#currentJourney = journey;
+      /**
+       * Execute dummy callback to get all monitor specific
+       * configurations for the current journey
+       */
+      journey.callback({ params: options.params } as any);
+      journey.monitor.update(this.monitor?.config);
+      monitors.push(journey.monitor);
+    }
+    return monitors;
+  }
+
   async run(options: RunOptions) {
     const result: RunResult = {};
-    if (this.active) {
+    if (this.#active) {
       return result;
     }
-    this.active = true;
+    this.#active = true;
     log(`Runner: run ${this.journeys.length} journeys`);
     this.init(options);
     await this.runBeforeAllHook({
@@ -457,7 +430,7 @@ export default class Runner extends EventEmitter {
        * Used by heartbeat to gather all registered journeys
        */
       if (dryRun) {
-        this.emit('journey:register', { journey });
+        this.#reporter.onJourneyRegister?.(journey);
         continue;
       }
       if (!journey.isMatch(match, tags)) {
@@ -478,14 +451,14 @@ export default class Runner extends EventEmitter {
   }
 
   async reset() {
+    this.#currentJourney = null;
+    this.journeys = [];
+    this.#active = false;
     /**
      * Clear all cache data stored for post processing by
      * the current synthetic agent run
      */
     await rm(CACHE_PATH, { recursive: true, force: true });
-    this.currentJourney = null;
-    this.journeys = [];
-    this.active = false;
-    this.emit('end', {});
+    await this.#reporter?.onEnd?.();
   }
 }

package/src/dsl/journey.ts

@@ -27,6 +27,7 @@ import { Browser, Page, BrowserContext, CDPSession } from 'playwright-chromium';
 import micromatch, { isMatch } from 'micromatch';
 import { Step } from './step';
 import { VoidCallback, HooksCallback, Params, Location } from '../common_types';
+import { Monitor, MonitorConfig } from './monitor';
 
 export type JourneyOptions = {
   name: string;
@@ -52,6 +53,7 @@ export class Journey {
   location?: Location;
   steps: Step[] = [];
   hooks: Hooks = { before: [], after: [] };
+  monitor: Monitor;
 
   constructor(
     options: JourneyOptions,
@@ -63,6 +65,7 @@ export class Journey {
     this.tags = options.tags;
     this.callback = callback;
     this.location = location;
+    this.updateMonitor({});
   }
 
   addStep(name: string, callback: VoidCallback, location?: Location) {
@@ -74,6 +77,21 @@ export class Journey {
   addHook(type: HookType, callback: HooksCallback) {
     this.hooks[type].push(callback);
   }
+
+  updateMonitor(config: MonitorConfig) {
+    /**
+     * Use defaults values from journey for monitor object (id, name and tags)
+     */
+    this.monitor = new Monitor({
+      name: this.name,
+      id: this.id,
+      tags: this.tags ?? [],
+      ...config,
+    });
+    this.monitor.setSource(this.location);
+    this.monitor.setFilter({ match: this.name });
+  }
+
   /**
    * Matches journeys based on the provided args. Proitize tags over match
    * - tags pattern that matches only tags