@elastic/synthetics 1.0.0-beta.3 → 1.0.0-beta.30

package/src/core/runner.ts

@@ -23,9 +23,8 @@
  *
  */
 
-import { once, EventEmitter } from 'events';
 import { join } from 'path';
-import { mkdirSync, rmdirSync, writeFileSync } from 'fs';
+import { rm } from 'fs/promises';
 import { Journey } from '../dsl/journey';
 import { Step } from '../dsl/step';
 import { reporters, Reporter } from '../reporters';
@@ -33,109 +32,62 @@ import {
   CACHE_PATH,
   monotonicTimeInSeconds,
   getTimestamp,
-  now,
   runParallel,
+  generateUniqueId,
+  mkdirAsync,
+  writeFileAsync,
 } from '../helpers';
 import {
-  StatusValue,
   HooksCallback,
   Params,
-  PluginOutput,
-  CliArgs,
   HooksArgs,
+  Driver,
+  Screenshot,
+  RunOptions,
+  JourneyResult,
+  StepResult,
 } from '../common_types';
 import { PluginManager } from '../plugins';
-import { PerformanceManager, Metrics } from '../plugins';
-import { Driver, Gatherer } from './gatherer';
+import { PerformanceManager } from '../plugins';
+import { Gatherer } from './gatherer';
 import { log } from './logger';
+import { Monitor, MonitorConfig } from '../dsl/monitor';
 
-export type RunOptions = Omit<
-  CliArgs,
-  | 'debug'
-  | 'json'
-  | 'pattern'
-  | 'inline'
-  | 'require'
-  | 'suiteParams'
-  | 'reporter'
-  | 'richEvents'
-  | 'capability'
-> & {
-  params?: Params;
-  reporter?: CliArgs['reporter'] | Reporter;
-};
+type HookType = 'beforeAll' | 'afterAll';
+export type SuiteHooks = Record<HookType, Array<HooksCallback>>;
 
-type BaseContext = {
+type JourneyContext = {
   params?: Params;
   start: number;
-  end?: number;
-};
-
-type JourneyContext = BaseContext & {
   driver: Driver;
   pluginManager: PluginManager;
 };
 
-type StepResult = {
-  status: StatusValue;
-  url?: string;
-  metrics?: Metrics;
-  error?: Error;
-};
-
-type JourneyResult = {
-  status: StatusValue;
-  error?: Error;
-};
-
 type RunResult = Record<string, JourneyResult>;
 
-type HookType = 'beforeAll' | 'afterAll';
-export type SuiteHooks = Record<HookType, Array<HooksCallback>>;
-
-interface Events {
-  start: { numJourneys: number };
-  'journey:register': {
-    journey: Journey;
-  };
-  'journey:start': {
-    journey: Journey;
-    timestamp: number;
-    params: Params;
-  };
-  'journey:end': BaseContext &
-    JourneyResult &
-    PluginOutput & {
-      journey: Journey;
-      ssblocks?: boolean;
-    };
-  'journey:end:reported': unknown;
-  'step:start': { journey: Journey; step: Step };
-  'step:end': StepResult & {
-    start: number;
-    end: number;
-    journey: Journey;
-    step: Step;
-  };
-  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: [] };
-  screenshotPath = join(CACHE_PATH, 'screenshots');
+  hookError: Error | undefined;
+  monitor?: Monitor;
+  static screenshotPath = join(CACHE_PATH, 'screenshots');
 
   static async createContext(options: RunOptions): Promise<JourneyContext> {
-    const start = monotonicTimeInSeconds();
     const driver = await Gatherer.setupDriver(options);
+    /**
+     * Do not include browser launch/context creation duration
+     * as part of journey duration
+     */
+    const start = monotonicTimeInSeconds();
     const pluginManager = await Gatherer.beginRecording(driver, options);
+    /**
+     * For each journey we create the screenshots folder for
+     * caching all screenshots and clear them at end of each journey
+     */
+    await mkdirAsync(this.screenshotPath, { recursive: true });
     return {
       start,
       params: options.params,
@@ -144,13 +96,65 @@ export default class Runner extends EventEmitter {
     };
   }
 
+  async captureScreenshot(page: Driver['page'], step: Step) {
+    const buffer = await page
+      .screenshot({
+        type: 'jpeg',
+        quality: 80,
+        timeout: 5000,
+      })
+      .catch(() => {});
+    /**
+     * Write the screenshot image buffer with additional details (step
+     * information) which could be extracted at the end of
+     * each journey without impacting the step timing information
+     */
+    if (buffer) {
+      const fileName = `${generateUniqueId()}.json`;
+      const screenshot: Screenshot = {
+        step,
+        timestamp: getTimestamp(),
+        data: buffer.toString('base64'),
+      };
+      await writeFileAsync(
+        join(Runner.screenshotPath, fileName),
+        JSON.stringify(screenshot)
+      );
+    }
+  }
+
+  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) {
@@ -182,7 +186,7 @@ export default class Runner extends EventEmitter {
       status: 'succeeded',
     };
     log(`Runner: start step (${step.name})`);
-    const { metrics, screenshots } = options;
+    const { metrics, screenshots, filmstrips, trace } = options;
     const { driver, pluginManager } = context;
     /**
      * URL needs to be the first navigation request of any step
@@ -193,39 +197,49 @@ export default class Runner extends EventEmitter {
       if (!data.url && req.isNavigationRequest()) {
         data.url = req.url();
       }
-      driver.page.off('request', captureUrl);
+      driver.context.off('request', captureUrl);
     };
-    driver.page.on('request', captureUrl);
+    driver.context.on('request', captureUrl);
+
     try {
+      /**
+       * Set up plugin manager context and also register
+       * step level plugins
+       */
+      const traceEnabled = trace || filmstrips;
       pluginManager.onStep(step);
+      traceEnabled && (await pluginManager.start('trace'));
+      // call the step definition
       await step.callback();
+      /**
+       * Collect all step level metrics
+       */
       if (metrics) {
-        data.metrics = await pluginManager.get(PerformanceManager).getMetrics();
+        data.pagemetrics = await (
+          pluginManager.get('performance') as PerformanceManager
+        ).getMetrics();
+      }
+      if (traceEnabled) {
+        const traceOutput = await pluginManager.stop('trace');
+        Object.assign(data, traceOutput);
       }
     } catch (error) {
       data.status = 'failed';
       data.error = error;
     } finally {
-      data.url ??= driver.page.url();
-      if (screenshots) {
-        await driver.page.waitForLoadState('load');
-        const buffer = await driver.page.screenshot({
-          type: 'jpeg',
-          quality: 80,
-        });
-        /**
-         * Write the screenshot image buffer with additional details (step
-         * information) which could be extracted at the end of
-         * each journey without impacting the step timing information
-         */
-        const fileName = now().toString() + '.json';
-        writeFileSync(
-          join(this.screenshotPath, fileName),
-          JSON.stringify({
-            step,
-            data: buffer.toString('base64'),
-          })
-        );
+      /**
+       * Capture screenshot for the newly created pages
+       * via popup or new windows/tabs
+       *
+       * Last open page will get us the correct screenshot
+       */
+      const pages = driver.context.pages();
+      const page = pages[pages.length - 1];
+      if (page) {
+        data.url ??= page.url();
+        if (screenshots && screenshots !== 'off') {
+          await this.captureScreenshot(page, step);
+        }
       }
     }
     log(`Runner: end step (${step.name})`);
@@ -241,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';
@@ -252,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,
@@ -268,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 });
   }
@@ -283,34 +299,50 @@ export default class Runner extends EventEmitter {
     result: JourneyContext & JourneyResult,
     options: RunOptions
   ) {
-    const { pluginManager, start, params, status, error } = result;
+    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,
-      params,
       start,
-      end: monotonicTimeInSeconds(),
-      ssblocks: options.ssblocks,
+      end,
+      timestamp: getTimestamp(),
+      options,
       ...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 });
   }
 
-  async runJourney(journey: Journey, options: RunOptions) {
+  /**
+   * Simulate a journey run to capture errors in the beforeAll hook
+   */
+  async runFakeJourney(journey: Journey, options: RunOptions) {
+    const start = monotonicTimeInSeconds();
+    this.#reporter.onJourneyStart?.(journey, {
+      timestamp: getTimestamp(),
+      params: options.params,
+    });
     const result: JourneyResult = {
-      status: 'succeeded',
+      status: 'failed',
+      error: this.hookError,
     };
-    log(`Runner: start journey (${journey.name})`);
+    await this.#reporter.onJourneyEnd?.(journey, {
+      timestamp: getTimestamp(),
+      start,
+      options,
+      end: monotonicTimeInSeconds(),
+      ...result,
+    });
+    return result;
+  }
+
+  async runJourney(journey: Journey, options: RunOptions) {
+    const result: JourneyResult = { status: 'succeeded' };
     const context = await Runner.createContext(options);
+    log(`Runner: start journey (${journey.name})`);
     try {
       this.registerJourney(journey, context);
       const hookArgs = {
@@ -340,68 +372,100 @@ export default class Runner extends EventEmitter {
     return result;
   }
 
-  init(options: RunOptions) {
-    const { reporter, outfd } = options;
+  async init(options: RunOptions) {
+    this.setReporter(options);
+    this.#reporter.onStart?.({
+      numJourneys: this.journeys.length,
+      networkConditions: options.networkConditions,
+    });
     /**
-     * Set up the corresponding reporter and fallback
+     * Set up the directory for caching screenshots
      */
-    const Reporter =
-      typeof reporter === 'function'
-        ? reporter
-        : reporters[reporter] || reporters['default'];
-    new Reporter(this, { fd: outfd });
-    this.emit('start', { numJourneys: this.journeys.length });
+    await mkdirAsync(CACHE_PATH, { recursive: true });
+  }
+
+  buildMonitors(options: RunOptions) {
     /**
-     * Set up the directory for caching screenshots
+     * Update the global monitor configuration required for
+     * setting defaults
      */
-    mkdirSync(this.screenshotPath, { recursive: true });
+    this.updateMonitor({
+      throttling: options.throttling,
+      schedule: options.schedule,
+      locations: options.locations,
+      params: options.params,
+      playwrightOptions: options.playwrightOptions,
+    });
+
+    const { match, tags } = options;
+
+    const monitors: Monitor[] = [];
+    for (const journey of this.journeys) {
+      if (!journey.isMatch(match, tags)) {
+        continue;
+      }
+
+      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({
       env: options.environment,
       params: options.params,
-    });
+    }).catch(e => (this.hookError = e));
+
     const { dryRun, match, tags } = options;
     for (const journey of this.journeys) {
       /**
        * 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)) {
         continue;
       }
-      const journeyResult = await this.runJourney(journey, options);
+      const journeyResult: JourneyResult = this.hookError
+        ? await this.runFakeJourney(journey, options)
+        : await this.runJourney(journey, options);
       result[journey.name] = journeyResult;
-      await Gatherer.stop();
     }
+    await Gatherer.stop();
     await this.runAfterAllHook({
       env: options.environment,
       params: options.params,
     });
-    this.reset();
+    await this.reset();
     return result;
   }
 
-  reset() {
+  async reset() {
+    this.#currentJourney = null;
+    this.journeys = [];
+    this.#active = false;
     /**
      * Clear all cache data stored for post processing by
      * the current synthetic agent run
      */
-    rmdirSync(CACHE_PATH, { recursive: true });
-    this.currentJourney = null;
-    this.journeys = [];
-    this.active = false;
-    this.emit('end', {});
+    await rm(CACHE_PATH, { recursive: true, force: true });
+    await this.#reporter?.onEnd?.();
   }
 }

package/src/dsl/journey.ts

@@ -26,7 +26,8 @@
 import { Browser, Page, BrowserContext, CDPSession } from 'playwright-chromium';
 import micromatch, { isMatch } from 'micromatch';
 import { Step } from './step';
-import { VoidCallback, HooksCallback, Params } from '../common_types';
+import { VoidCallback, HooksCallback, Params, Location } from '../common_types';
+import { Monitor, MonitorConfig } from './monitor';
 
 export type JourneyOptions = {
   name: string;
@@ -49,18 +50,26 @@ export class Journey {
   id?: string;
   tags?: string[];
   callback: JourneyCallback;
+  location?: Location;
   steps: Step[] = [];
   hooks: Hooks = { before: [], after: [] };
+  monitor: Monitor;
 
-  constructor(options: JourneyOptions, callback: JourneyCallback) {
+  constructor(
+    options: JourneyOptions,
+    callback: JourneyCallback,
+    location?: Location
+  ) {
     this.name = options.name;
-    this.id = options.id;
+    this.id = options.id || options.name;
     this.tags = options.tags;
     this.callback = callback;
+    this.location = location;
+    this.updateMonitor({});
   }
 
-  addStep(name: string, callback: VoidCallback) {
-    const step = new Step(name, this.steps.length + 1, callback);
+  addStep(name: string, callback: VoidCallback, location?: Location) {
+    const step = new Step(name, this.steps.length + 1, callback, location);
     this.steps.push(step);
     return step;
   }
@@ -68,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

package/src/dsl/locations.ts

@@ -0,0 +1,38 @@
+/**
+ * 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.
+ *
+ */
+
+// DO NOT EDIT - UPDATE WITH `npm run build:locations`
+export const LocationsMap = {
+  japan: 'asia-northeast1-a',
+  india: 'asia-south1-a',
+  singapore: 'asia-southeast1-a',
+  australia_east: 'australia-southeast1-a',
+  united_kingdom: 'europe-west2-a',
+  germany: 'europe-west3-a',
+  canada_east: 'northamerica-northeast1-a',
+  brazil: 'southamerica-east1-a',
+  us_east: 'us-east4-a',
+  us_west: 'us-west1-a',
+};