@elastic/synthetics 1.14.0 → 1.16.0

package/src/dsl/journey.ts

@@ -31,9 +31,10 @@ import {
   APIRequestContext,
 } from 'playwright-core';
 import { Step } from './step';
-import { VoidCallback, HooksCallback, Params, Location } from '../common_types';
+import { VoidCallback, HooksCallback, Params, Location, StatusValue } from '../common_types';
 import { Monitor, MonitorConfig } from './monitor';
 import { isMatch } from '../helpers';
+import { RunnerInfo } from '../core/runner';
 
 export type JourneyOptions = {
   name: string;
@@ -43,69 +44,87 @@ export type JourneyOptions = {
 
 type HookType = 'before' | 'after';
 export type Hooks = Record<HookType, Array<HooksCallback>>;
-export type JourneyCallback = (options: {
+type JourneyCallbackOpts = {
   page: Page;
   context: BrowserContext;
   browser: Browser;
   client: CDPSession;
   params: Params;
   request: APIRequestContext;
-}) => void;
+  info: RunnerInfo;
+};
+export type JourneyCallback = (options: JourneyCallbackOpts) => void;
 
 export class Journey {
-  name: string;
-  id?: string;
-  tags?: string[];
-  callback: JourneyCallback;
-  location?: Location;
-  steps: Step[] = [];
-  hooks: Hooks = { before: [], after: [] };
-  monitor: Monitor;
+  readonly name: string;
+  readonly id?: string;
+  readonly tags?: string[];
+  readonly location?: Location;
+  readonly steps: Step[] = [];
+  #cb: JourneyCallback;
+  #hooks: Hooks = { before: [], after: [] };
+  #monitor: Monitor;
   skip = false;
   only = false;
+  _startTime = 0;
+  duration = -1;
+  status: StatusValue = 'pending';
+  error?: Error;
 
   constructor(
     options: JourneyOptions,
-    callback: JourneyCallback,
+    cb: JourneyCallback,
     location?: Location
   ) {
     this.name = options.name;
     this.id = options.id || options.name;
     this.tags = options.tags;
-    this.callback = callback;
+    this.#cb = cb;
     this.location = location;
-    this.updateMonitor({});
+    this._updateMonitor({});
   }
 
-  addStep(name: string, callback: VoidCallback, location?: Location) {
-    const step = new Step(name, this.steps.length + 1, callback, location);
+  _addStep(name: string, cb: VoidCallback, location?: Location) {
+    const step = new Step(name, this.steps.length + 1, cb, location);
     this.steps.push(step);
     return step;
   }
 
-  addHook(type: HookType, callback: HooksCallback) {
-    this.hooks[type].push(callback);
+  _addHook(type: HookType, cb: HooksCallback) {
+    this.#hooks[type].push(cb);
+  }
+
+  _getHook(type: HookType) {
+    return this.#hooks[type];
+  }
+
+  _getMonitor() {
+    return this.#monitor;
   }
 
-  updateMonitor(config: MonitorConfig) {
+  _updateMonitor(config: MonitorConfig) {
     /**
      * Use defaults values from journey for monitor object (id, name and tags)
      */
-    this.monitor = new Monitor({
+    this.#monitor = new Monitor({
       name: this.name,
       id: this.id,
       type: 'browser',
       tags: this.tags ?? [],
       ...config,
     });
-    this.monitor.setSource(this.location);
-    this.monitor.setFilter({ match: this.name });
+    this.#monitor.setSource(this.location);
+    this.#monitor.setFilter({ match: this.name });
+  }
+
+  get cb() {
+    return this.#cb;
   }
 
   /**
    * Matches journeys based on the provided args. Proitize tags over match
    */
-  isMatch(matchPattern: string, tagsPattern: Array<string>) {
+  _isMatch(matchPattern: string, tagsPattern: Array<string>) {
     return isMatch(this.tags, this.name, tagsPattern, matchPattern);
   }
 }

package/src/dsl/monitor.ts

@@ -58,6 +58,7 @@ export type MonitorConfig = {
   name?: string;
   type?: string;
   tags?: string[];
+  fields?: Record<string, string>;
   schedule?: typeof ALLOWED_SCHEDULES[number];
   enabled?: boolean;
   locations?: SyntheticsLocationsType[];

package/src/dsl/step.ts

@@ -23,28 +23,37 @@
  *
  */
 
-import { Location, VoidCallback } from '../common_types';
+import { Location, StatusValue, VoidCallback } from '../common_types';
 
 export class Step {
-  name: string;
-  index: number;
-  callback: VoidCallback;
-  location?: Location;
+  readonly name: string;
+  readonly index: number;
+  readonly location?: Location;
+  #cb: VoidCallback;
   skip = false;
   soft = false;
   only = false;
+  _startTime = 0;
+  duration = -1;
+  status: StatusValue = 'pending';
+  error?: Error;
+  url?: string;
 
   constructor(
     name: string,
     index: number,
-    callback: VoidCallback,
+    cb: VoidCallback,
     location: Location
   ) {
     this.name = name;
     this.index = index;
-    this.callback = callback;
+    this.#cb = cb;
     this.location = location;
   }
+
+  get cb() {
+    return this.#cb;
+  }
 }
 
 type StepType = (name: string, callback: VoidCallback) => Step;

package/src/helpers.ts

@@ -41,7 +41,7 @@ import micromatch from 'micromatch';
 
 const SEPARATOR = '\n';
 
-export function noop() {}
+export function noop() { }
 
 export function indent(lines: string, tab = '   ') {
   return lines.replace(/^/gm, tab);
@@ -54,6 +54,7 @@ export function indent(lines: string, tab = '   ') {
 const NO_UTF8_SUPPORT = process.platform === 'win32';
 export const symbols = {
   warning: yellow(NO_UTF8_SUPPORT ? '!' : '⚠'),
+  pending: yellow(NO_UTF8_SUPPORT ? '!' : '⚠'),
   skipped: cyan('-'),
   progress: cyan('>'),
   succeeded: green(NO_UTF8_SUPPORT ? 'ok' : '✓'),
@@ -151,8 +152,8 @@ export function findPkgJsonByTraversing(resolvePath, cwd) {
   if (resolvePath === parentDirectory) {
     throw red(
       `Could not find package.json file in: "${cwd}"\n` +
-        `It is recommended to run the agent in an NPM project.\n` +
-        `You can create one by running "npm init -y" in the project folder.`
+      `It is recommended to run the agent in an NPM project.\n` +
+      `You can create one by running "npm init -y" in the project folder.`
     );
   }
   return findPkgJsonByTraversing(parentDirectory, cwd);

package/src/index.ts

@@ -23,11 +23,11 @@
  *
  */
 
-import { runner } from './core';
+import { runner } from './core/globals';
 import { RunOptions } from './common_types';
 
 export async function run(options: RunOptions) {
-  return runner.run(options);
+  return runner._run(options);
 }
 
 /**

package/src/options.ts

@@ -70,6 +70,9 @@ export async function normalizeOptions(
       : {};
 
   options.params = Object.freeze(merge(config.params, cliArgs.params || {}));
+  options.fields = Object.freeze(
+    merge(config.monitor?.fields ?? {}, cliArgs?.fields || {})
+  );
 
   /**
    * Merge playwright options from CLI and Synthetics config
@@ -233,6 +236,24 @@ export function getCommonCommandOpts() {
     '--match <name>',
     'run/push tests with a name or tags that matches a pattern'
   );
+  const fields = createOption(
+    '--fields <jsonstring>',
+    'add fields to the monitor(s) in the format { "key": "value"}'
+  ).argParser((fieldsStr: string) => {
+    const fields = JSON.parse(fieldsStr);
+    if (typeof fields !== 'object') {
+      throw new Error('Invalid fields format');
+    }
+    // make sure all values are strings
+    return Object.entries(fields).reduce((acc, [key, value]) => {
+      if (typeof value !== 'string') {
+        acc[key] = JSON.stringify(value);
+      } else {
+        acc[key] = value;
+      }
+      return acc;
+    }, {});
+  });
 
   return {
     auth,
@@ -243,6 +264,7 @@ export function getCommonCommandOpts() {
     configOpt,
     tags,
     match,
+    fields,
   };
 }
 

package/src/push/index.ts

@@ -223,11 +223,10 @@ export function validateSettings(opts: PushOptions) {
   - CLI '--schedule <mins>'
   - Config file 'monitors.schedule' field`;
   } else if (opts.schedule && !ALLOWED_SCHEDULES.includes(opts.schedule)) {
-    reason = `Set default schedule(${
-      opts.schedule
-    }) to one of the allowed values - ${ALLOWED_SCHEDULES.join(',')}`;
+    reason = `Set default schedule(${opts.schedule
+      }) to one of the allowed values - ${ALLOWED_SCHEDULES.join(',')}`;
   } else if (
-    opts.locations.length > 0 &&
+    (opts.locations ?? []).length > 0 &&
     (opts?.playwrightOptions?.clientCertificates ?? []).filter(cert => {
       return cert.certPath || cert.keyPath || cert.pfxPath;
     }).length > 0

package/src/push/monitor.ts

@@ -268,6 +268,7 @@ export function buildMonitorFromYaml(
     enabled: config.enabled ?? options.enabled,
     locations: options.locations,
     tags: options.tags,
+    fields: parseFields(config, options.fields),
     ...normalizeConfig(config),
     retestOnFailure,
     privateLocations,
@@ -311,6 +312,25 @@ export const parseAlertConfig = (
   return Object.keys(result).length > 0 ? result : undefined;
 };
 
+export const parseFields = (
+  config: MonitorConfig,
+  gFields?: Record<string, string>
+) => {
+  // get all keys starting with `label.`
+  const keys = Object.keys(config).filter(key => key.startsWith('fields.'));
+  const fields = {};
+  for (const key of keys) {
+    fields[key.replace('fields.', '')] = config[key];
+    delete config[key];
+  }
+  if (gFields) {
+    for (const key of Object.keys(gFields)) {
+      fields[key] = gFields[key];
+    }
+  }
+  return Object.keys(fields).length > 0 ? fields : undefined;
+};
+
 export function getAlertKeyValue(
   key: 'status' | 'tls',
   config: MonitorConfig,

package/src/reporters/base.ts

@@ -28,12 +28,8 @@ import { green, red, cyan, gray } from 'kleur/colors';
 import { renderError, serializeError } from './reporter-util';
 import { symbols, indent, now } from '../helpers';
 import { Reporter, ReporterOptions } from '.';
-import {
-  JourneyEndResult,
-  JourneyStartResult,
-  StepEndResult,
-} from '../common_types';
 import { Journey, Step } from '../dsl';
+import { JourneyEndResult, JourneyStartResult, StepResult } from '../common_types';
 
 export function renderDuration(durationMs) {
   return parseInt(durationMs);
@@ -66,14 +62,14 @@ export default class BaseReporter implements Reporter {
     this.metrics.registered++;
   }
 
-  onJourneyStart(journey: Journey, {}: JourneyStartResult) {
+  onJourneyStart(journey: Journey, { }: JourneyStartResult) {
     this.write(`\nJourney: ${journey.name}`);
   }
 
-  onStepEnd(_: Journey, step: Step, result: StepEndResult) {
-    const { status, end, start, error } = result;
+  onStepEnd(_: Journey, step: Step, { }: StepResult) {
+    const { status, error } = step;
     const message = `${symbols[status]}  Step: '${step.name}' ${status} ${gray(
-      '(' + renderDuration((end - start) * 1000) + ' ms)'
+      '(' + renderDuration(step.duration * 1000) + ' ms)'
     )}`;
     this.write(indent(message));
     if (error) {
@@ -84,15 +80,15 @@ export default class BaseReporter implements Reporter {
   }
 
   /* eslint-disable @typescript-eslint/no-unused-vars */
-  onJourneyEnd(_: Journey, { error }: JourneyEndResult) {
+  onJourneyEnd(journey: Journey, { }: JourneyEndResult) {
     const { failed, succeeded, skipped } = this.metrics;
     const total = failed + succeeded + skipped;
     /**
      * Render the error on the terminal only when no steps could
      * be executed which means the error happened in one of the hooks
      */
-    if (total === 0 && error) {
-      const message = renderError(serializeError(error));
+    if (total === 0 && journey.error) {
+      const message = renderError(serializeError(journey.error));
       this.write(indent(message) + '\n');
     }
   }

package/src/reporters/build_kite_cli.ts

@@ -37,13 +37,13 @@ import { Journey, Step } from '../dsl';
 import { renderError, serializeError } from './reporter-util';
 
 export default class BuildKiteCLIReporter extends BaseReporter {
-  journeys: Map<string, Array<StepEndResult & { name: string }>> = new Map();
+  journeys: Map<string, Array<Step>> = new Map();
 
   constructor(options: ReporterOptions = {}) {
     super(options);
   }
 
-  override onJourneyStart(journey: Journey, {}: JourneyStartResult) {
+  override onJourneyStart(journey: Journey, { }: JourneyStartResult) {
     this.write(`\n--- Journey: ${journey.name}`);
   }
 
@@ -52,15 +52,12 @@ export default class BuildKiteCLIReporter extends BaseReporter {
     if (!this.journeys.has(journey.name)) {
       this.journeys.set(journey.name, []);
     }
-    this.journeys.get(journey.name)?.push({ name: step.name, ...result });
+    this.journeys.get(journey.name)?.push(step);
   }
 
-  override async onJourneyEnd(journey: Journey, endResult: JourneyEndResult) {
-    const { start, end, status } = endResult;
-    super.onJourneyEnd(journey, endResult);
-    const message = `${symbols[status]} Took (${renderDuration(
-      end - start
-    )} seconds)`;
+  override async onJourneyEnd(journey: Journey, result: JourneyEndResult) {
+    super.onJourneyEnd(journey, result);
+    const message = `${symbols[journey.status]} Took (${renderDuration(journey.duration)} seconds)`;
     this.write(message);
   }
 
@@ -78,16 +75,14 @@ export default class BuildKiteCLIReporter extends BaseReporter {
         failedJourneys.forEach(([journeyName, steps]) => {
           const name = red(`Journey: ${journeyName} :slightly_frowning_face:`);
           this.write(`\n+++ ${name}`);
-          steps.forEach(stepResult => {
-            const { status, end, start, error, name: stepName } = stepResult;
-            const message = `${
-              symbols[status]
-            }  Step: '${stepName}' ${status} (${renderDuration(
-              (end - start) * 1000
-            )} ms)`;
+          steps.forEach(step => {
+            const message = `${symbols[step.status]
+              }  Step: '${step.name}' ${step.status} (${renderDuration(
+                step.duration * 1000
+              )} ms)`;
             this.write(indent(message));
-            if (error) {
-              this.write(renderError(serializeError(error)));
+            if (step.error) {
+              this.write(renderError(serializeError(step.error)));
             }
           });
         });

package/src/reporters/json.ts

@@ -91,13 +91,16 @@ type Duration = {
   };
 };
 
+type JourneyInfo = Omit<Partial<Journey>, 'duration'> & Duration;
+type StepInfo = Omit<Partial<Step>, 'duration'> & Duration;
+
 type OutputFields = {
   type: OutputType;
   _id?: string;
-  journey?: Partial<Journey> & Duration;
+  journey?: Partial<Journey>;
   timestamp?: number;
   url?: string;
-  step?: Partial<Step> & Duration;
+  step?: Partial<Step>;
   error?: Error;
   root_fields?: Record<string, unknown>;
   payload?: Payload;
@@ -251,36 +254,35 @@ function formatJSONError(error: Error | any) {
 }
 
 function journeyInfo(
-  journey: OutputFields['journey'],
+  journey: Partial<Journey>,
   type: OutputFields['type'],
-  status: Payload['status']
 ) {
   if (!journey) {
     return;
   }
-  return {
-    name: journey.name,
-    id: journey.id,
-    tags: journey.tags,
-    status: type === 'journey/end' ? status : undefined,
-    duration: journey.duration,
-  };
+  const info: JourneyInfo = { name: journey.name, id: journey.id, tags: journey.tags };
+  const isEnd = type === 'journey/end';
+  if (isEnd) {
+    info.status = journey.status;
+    info.duration = { us: getDurationInUs(journey.duration) };
+  }
+  return info;
 }
 
 function stepInfo(
-  step: OutputFields['step'],
+  step: Partial<Step>,
   type: OutputFields['type'],
-  status: Payload['status']
-) {
+): Omit<Partial<Step>, 'duration'> & Duration {
   if (!step) {
     return;
   }
-  return {
-    name: step.name,
-    index: step.index,
-    status: type === 'step/end' ? status : undefined,
-    duration: step.duration,
-  };
+  const info: StepInfo = { name: step.name, index: step.index };
+  const isEnd = type === 'step/end';
+  if (isEnd) {
+    info.status = step.status;
+    info.duration = { us: getDurationInUs(step.duration) };
+  }
+  return info;
 }
 
 export async function getScreenshotBlocks(screenshot: Buffer) {
@@ -391,7 +393,7 @@ export default class JSONReporter extends BaseReporter {
       type: 'journey/start',
       journey,
       timestamp,
-      payload: { source: journey.callback.toString() },
+      payload: { source: journey.cb.toString() },
     });
   }
 
@@ -399,11 +401,6 @@ export default class JSONReporter extends BaseReporter {
     journey: Journey,
     step: Step,
     {
-      start,
-      end,
-      error,
-      url,
-      status,
       pagemetrics,
       traces,
       metrics,
@@ -432,18 +429,13 @@ export default class JSONReporter extends BaseReporter {
     this.writeJSON({
       type: 'step/end',
       journey,
-      step: {
-        ...step,
-        duration: {
-          us: getDurationInUs(end - start),
-        },
-      },
-      url,
-      error,
+      step,
+      url: step.url,
+      error: step.error,
       payload: {
-        source: step.callback.toString(),
-        url,
-        status,
+        source: step.cb.toString(),
+        url: step.url,
+        status: step.status,
         pagemetrics,
       },
     });
@@ -453,20 +445,16 @@ export default class JSONReporter extends BaseReporter {
     journey: Journey,
     {
       timestamp,
-      start,
-      end,
       browserDelay,
       networkinfo,
       browserconsole,
-      status,
-      error,
       options,
     }: JourneyEndResult
   ) {
     const { ssblocks, screenshots } = options;
     const writeScreenshots =
       screenshots === 'on' ||
-      (screenshots === 'only-on-failure' && status === 'failed');
+      (screenshots === 'only-on-failure' && journey.status === 'failed');
     if (writeScreenshots) {
       await gatherScreenshots(
         join(CACHE_PATH, 'screenshots'),
@@ -522,16 +510,11 @@ export default class JSONReporter extends BaseReporter {
 
     this.writeJSON({
       type: 'journey/end',
-      journey: {
-        ...journey,
-        duration: {
-          us: getDurationInUs(end - start),
-        },
-      },
+      journey,
       timestamp,
-      error,
+      error: journey.error,
       payload: {
-        status,
+        status: journey.status,
         // convert from monotonic seconds time to microseconds
         browser_delay_us: getDurationInUs(browserDelay),
         // timestamp in microseconds at which the current node process began, measured in Unix time.
@@ -613,8 +596,8 @@ export default class JSONReporter extends BaseReporter {
       type,
       _id,
       '@timestamp': timestamp || getTimestamp(),
-      journey: journeyInfo(journey, type, payload?.status),
-      step: stepInfo(step, type, payload?.status),
+      journey: journeyInfo(journey, type),
+      step: stepInfo(step, type),
       root_fields: { ...(root_fields || {}), ...getMetadata() },
       payload,
       blob,

package/src/reporters/junit.ts

@@ -28,7 +28,6 @@ import { dirname } from 'path';
 import {
   JourneyEndResult,
   JourneyStartResult,
-  StepEndResult,
 } from '../common_types';
 import { Journey, Step } from '../dsl';
 import { indent, now } from '../helpers';
@@ -60,7 +59,7 @@ export default class JUnitReporter extends BaseReporter {
   private totalSkipped = 0;
   #journeyMap = new Map<string, XMLEntry>();
 
-  override onJourneyStart(journey: Journey, {}: JourneyStartResult) {
+  override onJourneyStart(journey: Journey, { }: JourneyStartResult) {
     if (!this.#journeyMap.has(journey.name)) {
       const entry = {
         name: 'testsuite',
@@ -80,7 +79,6 @@ export default class JUnitReporter extends BaseReporter {
   override onStepEnd(
     journey: Journey,
     step: Step,
-    { status, error, start, end }: StepEndResult
   ) {
     if (!this.#journeyMap.has(journey.name)) {
       return;
@@ -91,23 +89,23 @@ export default class JUnitReporter extends BaseReporter {
       attributes: {
         name: step.name,
         classname: journey.name + ' ' + step.name,
-        time: end - start,
+        time: step.duration,
       },
       children: [],
     };
 
     entry.attributes.tests++;
-    if (status === 'failed') {
+    if (step.status === 'failed') {
       caseEntry.children.push({
         name: 'failure',
         attributes: {
-          message: error.message,
-          type: error.name,
+          message: step.error?.message,
+          type: step.error?.name,
         },
-        text: stripAnsiCodes(serializeError(error).stack),
+        text: stripAnsiCodes(serializeError(step.error).stack),
       });
       entry.attributes.failures++;
-    } else if (status === 'skipped') {
+    } else if (step.status === 'skipped') {
       caseEntry.children.push({
         name: 'skipped',
         attributes: {
@@ -119,7 +117,7 @@ export default class JUnitReporter extends BaseReporter {
     entry.children.push(caseEntry);
   }
 
-  override onJourneyEnd(journey: Journey, {}: JourneyEndResult) {
+  override onJourneyEnd(journey: Journey, { }: JourneyEndResult) {
     if (!this.#journeyMap.has(journey.name)) {
       return;
     }