@elastic/synthetics 1.3.0 → 1.5.0

package/src/plugins/browser-console.ts

@@ -23,13 +23,16 @@
  *
  */
 
-import type { ConsoleMessage } from 'playwright-core';
-import { BrowserMessage, Driver } from '../common_types';
+import type { ConsoleMessage, WebError } from 'playwright-core';
+import { BrowserMessage, Driver, StatusValue } from '../common_types';
 import { log } from '../core/logger';
 import { Step } from '../dsl';
 import { getTimestamp } from '../helpers';
 
-const defaultMessageLimit = 1000;
+const DEFAULT_MSG_LIMIt = 1000;
+const SUCCESSFUL_MSG_LIMIT = 100;
+
+const allowedTypes = ['error', 'warning', 'log'];
 
 export class BrowserConsole {
   private messages: BrowserMessage[] = [];
@@ -42,7 +45,7 @@ export class BrowserConsole {
       return;
     }
     const type = msg.type();
-    if (type === 'error' || type === 'warning') {
+    if (allowedTypes.includes(type)) {
       const { name, index } = this._currentStep;
       this.messages.push({
         timestamp: getTimestamp(),
@@ -55,11 +58,12 @@ export class BrowserConsole {
     }
   };
 
-  private pageErrorEventListener = (error: Error) => {
+  private webErrorListener = (webErr: WebError) => {
     if (!this._currentStep) {
       return;
     }
     const { name, index } = this._currentStep;
+    const error = webErr.error();
     this.messages.push({
       timestamp: getTimestamp(),
       text: error.message,
@@ -72,7 +76,7 @@ export class BrowserConsole {
   };
 
   private enforceMessagesLimit() {
-    if (this.messages.length > defaultMessageLimit) {
+    if (this.messages.length > DEFAULT_MSG_LIMIt) {
       this.messages.splice(0, 1);
     }
   }
@@ -80,13 +84,40 @@ export class BrowserConsole {
   start() {
     log(`Plugins: started collecting console events`);
     this.driver.context.on('console', this.consoleEventListener);
-    this.driver.page.on('pageerror', this.pageErrorEventListener);
+    this.driver.context.on('weberror', this.webErrorListener);
   }
 
   stop() {
     this.driver.context.off('console', this.consoleEventListener);
-    this.driver.page.off('pageerror', this.pageErrorEventListener);
+    this.driver.context.off('weberror', this.webErrorListener);
     log(`Plugins: stopped collecting console events`);
     return this.messages;
   }
 }
+
+export function filterBrowserMessages(
+  messages: BrowserMessage[],
+  status: StatusValue
+) {
+  if (status == 'skipped') {
+    return [];
+  } else if (status === 'failed' || messages.length <= SUCCESSFUL_MSG_LIMIT) {
+    return messages;
+  }
+  // collect 100 messages from the browser console when the test is successful,
+  // giving priority to errors and warnings
+  const result = messages.filter(msg => msg.type === 'error');
+  if (result.length >= SUCCESSFUL_MSG_LIMIT) {
+    return result.slice(-SUCCESSFUL_MSG_LIMIT);
+  }
+
+  // collect warnings
+  result.push(...messages.filter(msg => msg.type === 'warning'));
+  if (result.length >= SUCCESSFUL_MSG_LIMIT) {
+    return result.slice(-SUCCESSFUL_MSG_LIMIT);
+  }
+
+  // collect logs
+  result.push(...messages.filter(msg => msg.type === 'log'));
+  return result.slice(-SUCCESSFUL_MSG_LIMIT);
+}

package/src/plugins/network.ts

@@ -23,7 +23,7 @@
  *
  */
 
-import { Page, Request, Response } from 'playwright-chromium';
+import { Frame, Page, Request, Response } from 'playwright-core';
 import { NetworkInfo, BrowserInfo, Driver } from '../common_types';
 import { log } from '../core/logger';
 import { Step } from '../dsl';
@@ -93,6 +93,17 @@ export class NetworkManager {
     race.then(() => this._barrierPromises.delete(race));
   }
 
+  private _nullableFrameBarrier(req: Request): Frame | null {
+    try {
+      return req.frame();
+    } catch (_) {
+      // frame might be unavailable for certain requests if they are issued
+      // before the frame is created - true for navigation requests
+      // https://playwright.dev/docs/api/class-request#request-frame
+    }
+    return null;
+  }
+
   async start() {
     log(`Plugins: started collecting network events`);
     const { client, context } = this.driver;
@@ -226,7 +237,8 @@ export class NetworkManager {
     };
     this._calcTotalTime(networkEntry, timing);
 
-    const page = request.frame().page();
+    const frame = this._nullableFrameBarrier(request);
+    const page = frame?.page();
     this._addBarrier(
       page,
       request.allHeaders().then(reqHeaders => {
@@ -278,7 +290,8 @@ export class NetworkManager {
       return;
     }
 
-    const page = request.frame().page();
+    const frame = this._nullableFrameBarrier(request);
+    const page = frame?.page();
     this._addBarrier(
       page,
       request.sizes().then(sizes => {

package/src/push/index.ts

@@ -73,8 +73,12 @@ export async function push(monitors: Monitor[], options: PushOptions) {
     return await pushLegacy(monitors, options);
   }
 
-  const local = getLocalMonitors(monitors);
   const { monitors: remote } = await bulkGetMonitors(options);
+
+  progress(`bundling ${monitors.length} monitors`);
+  const schemas = await buildMonitorSchema(monitors, true);
+  const local = getLocalMonitors(schemas);
+
   const { newIDs, changedIDs, removedIDs, unchangedIDs } = diffMonitorHashIDs(
     local,
     remote
@@ -83,9 +87,6 @@ export async function push(monitors: Monitor[], options: PushOptions) {
 
   const updatedMonitors = new Set<string>([...changedIDs, ...newIDs]);
   if (updatedMonitors.size > 0) {
-    const toBundle = monitors.filter(m => updatedMonitors.has(m.config.id));
-    progress(`bundling ${toBundle.length} monitors`);
-    const schemas = await buildMonitorSchema(toBundle, true);
     const chunks = getChunks(schemas, CHUNK_SIZE);
     for (const chunk of chunks) {
       await liveProgress(
@@ -159,7 +160,7 @@ export function formatDuplicateError(monitors: Set<Monitor>) {
 
 const INSTALLATION_HELP = `Run 'npx @elastic/synthetics init' to create project with default settings.`;
 
-export async function loadSettings() {
+export async function loadSettings(ignoreMissing = false) {
   try {
     const config = await readConfig(process.env['NODE_ENV'] || 'development');
     // Missing config file, fake throw to capture as missing file
@@ -168,9 +169,11 @@ export async function loadSettings() {
     }
     return config.project || ({} as ProjectSettings);
   } catch (e) {
-    throw error(`Aborted (missing synthetics config file), Project not set up correctly.
+    if (!ignoreMissing) {
+      throw error(`Aborted (missing synthetics config file), Project not set up correctly.
 
 ${INSTALLATION_HELP}`);
+    }
   }
 }
 

package/src/push/kibana_api.ts

@@ -124,8 +124,8 @@ export async function bulkDeleteMonitors(
 }
 
 type StatusResponse = {
-  version: {
-    number: number;
+  kibana: {
+    version: string;
   };
 };
 
@@ -135,7 +135,8 @@ export async function getVersion(options: PushOptions) {
     method: 'GET',
     auth: options.auth,
   });
-  return data.version.number;
+
+  return data.kibana.version;
 }
 
 export type LegacyAPISchema = {

package/src/push/monitor.ts

@@ -110,12 +110,12 @@ export function diffMonitors(
   return result;
 }
 
-export function getLocalMonitors(monitors: Monitor[]) {
+export function getLocalMonitors(schemas: MonitorSchema[]) {
   const data: MonitorHashID[] = [];
-  for (const monitor of monitors) {
+  for (const schema of schemas) {
     data.push({
-      journey_id: monitor.config.id,
-      hash: monitor.hash(),
+      journey_id: schema.id,
+      hash: schema.hash,
     });
   }
   return data;
@@ -137,14 +137,20 @@ export async function buildMonitorSchema(monitors: Monitor[], isV2: boolean) {
       ...config,
       locations: translateLocation(config.locations),
     };
-    if (isV2) {
-      schema.hash = monitor.hash();
-    }
+
     if (type === 'browser') {
       const outPath = join(bundlePath, config.name + '.zip');
       const content = await bundler.build(source.file, outPath);
+      monitor.setContent(content);
       Object.assign(schema, { content, filter });
     }
+    /**
+     * Generate hash only after the bundled content is created
+     * to capture code changes in imported files
+     */
+    if (isV2) {
+      schema.hash = monitor.hash();
+    }
     schemas.push(schema);
   }
 
@@ -236,12 +242,15 @@ export function buildMonitorFromYaml(
     config['private_locations'] ||
     config.privateLocations ||
     options.privateLocations;
-  delete config['private_locations'];
+  const retestOnFailure =
+    config['retest_on_failure'] ?? options.retestOnFailure;
   const alertConfig = parseAlertConfig(config, options.alert);
+
   const mon = new Monitor({
     locations: options.locations,
     tags: options.tags,
-    ...config,
+    ...normalizeConfig(config),
+    retestOnFailure,
     privateLocations,
     schedule: schedule || options.schedule,
     alert: alertConfig,
@@ -257,6 +266,14 @@ export function buildMonitorFromYaml(
   return mon;
 }
 
+// Deletes unncessary fields from the lightweight monitor config
+//  that is not supported by the Kibana API
+function normalizeConfig(config: MonitorConfig) {
+  delete config['private_locations'];
+  delete config['retest_on_failure'];
+  return config;
+}
+
 export const parseAlertConfig = (
   config: MonitorConfig,
   gConfig?: AlertConfig

package/src/push/utils.ts

@@ -64,7 +64,7 @@ export function generateURL(options: PushOptions, operation: Operation) {
   const url = removeTrailingSlash(options.url);
   switch (operation) {
     case 'status':
-      return `${url}/s/${options.space}/api/status`;
+      return `${url}/s/${options.space}/api/stats`;
     case 'bulk_get':
     case 'bulk_update':
     case 'bulk_delete':
@@ -81,7 +81,7 @@ export function generateURL(options: PushOptions, operation: Operation) {
 /**
  * Bulk API is supported for push monitors only from 8.6.0 and above
  */
-export function isBulkAPISupported(version: number) {
+export function isBulkAPISupported(version: string) {
   return semver.satisfies(version, '>=8.6.0');
 }
 
@@ -103,6 +103,6 @@ export function isLightweightMonitorSupported(
  * Lighweight monitor param options are supported only from
  * 8.7.2 and above
  */
-export function isParamOptionSupported(version: number) {
+export function isParamOptionSupported(version: string) {
   return semver.satisfies(version, '>=8.7.2');
 }

package/src/reporters/base.ts

@@ -24,14 +24,9 @@
  */
 
 import SonicBoom from 'sonic-boom';
-import { green, red, cyan } from 'kleur/colors';
-import {
-  symbols,
-  indent,
-  now,
-  findPWLogsIndexes,
-  rewriteErrorStack,
-} from '../helpers';
+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,
@@ -40,25 +35,6 @@ import {
 } from '../common_types';
 import { Journey, Step } from '../dsl';
 
-function renderError(error) {
-  let output = '';
-  const outer = indent('');
-  const inner = indent(outer);
-  const container = outer + '---\n';
-  output += container;
-  let stack = error.stack;
-  if (stack) {
-    output += inner + 'stack: |-\n';
-    stack = rewriteErrorStack(stack, findPWLogsIndexes(stack));
-    const lines = String(stack).split('\n');
-    for (const line of lines) {
-      output += inner + '  ' + line + '\n';
-    }
-  }
-  output += container;
-  return red(output);
-}
-
 function renderDuration(durationMs) {
   return parseInt(durationMs);
 }
@@ -66,14 +42,17 @@ function renderDuration(durationMs) {
 export default class BaseReporter implements Reporter {
   stream: SonicBoom;
   fd: number;
+  dryRun: boolean;
   metrics = {
     succeeded: 0,
     failed: 0,
     skipped: 0,
+    registered: 0,
   };
 
   constructor(options: ReporterOptions = {}) {
     this.fd = options.fd || process.stdout.fd;
+    this.dryRun = options.dryRun ?? false;
     /**
      * minLength is set to 1 byte to make sure we flush the
      * content even if its the last byte on the stream buffer
@@ -82,17 +61,25 @@ export default class BaseReporter implements Reporter {
     this.stream = new SonicBoom({ fd: this.fd, sync: true, minLength: 1 });
   }
 
+  onJourneyRegister(journey: Journey): void {
+    this.write(`\nJourney: ${journey.name}`);
+    this.metrics.registered++;
+  }
+
   onJourneyStart(journey: Journey, {}: JourneyStartResult) {
     this.write(`\nJourney: ${journey.name}`);
   }
 
   onStepEnd(_: Journey, step: Step, result: StepEndResult) {
     const { status, end, start, error } = result;
-    const message = `${symbols[status]}  Step: '${
-      step.name
-    }' ${status} (${renderDuration((end - start) * 1000)} ms)`;
+    const message = `${symbols[status]}  Step: '${step.name}' ${status} ${gray(
+      '(' + renderDuration((end - start) * 1000) + ' ms)'
+    )}`;
     this.write(indent(message));
-    error && this.write(renderError(error));
+    if (error) {
+      const message = renderError(serializeError(error));
+      this.write(indent(message) + '\n');
+    }
     this.metrics[status]++;
   }
 
@@ -105,14 +92,20 @@ export default class BaseReporter implements Reporter {
      * be executed which means the error happened in one of the hooks
      */
     if (total === 0 && error) {
-      this.write(renderError(error));
+      const message = renderError(serializeError(error));
+      this.write(indent(message) + '\n');
     }
   }
 
   onEnd() {
-    const { failed, succeeded, skipped } = this.metrics;
+    const { failed, succeeded, skipped, registered } = this.metrics;
     const total = failed + succeeded + skipped;
 
+    if (this.dryRun) {
+      this.write(`\n${registered} journey(s) registered`);
+      return;
+    }
+
     let message = '\n';
     if (total === 0) {
       message = 'No tests found!';

package/src/reporters/index.ts

@@ -34,7 +34,11 @@ import {
   StepEndResult,
 } from '../common_types';
 
-export type ReporterOptions = { fd?: number; colors?: boolean };
+export type ReporterOptions = {
+  fd?: number;
+  colors?: boolean;
+  dryRun?: boolean;
+};
 export type BuiltInReporterName = 'default' | 'json' | 'junit';
 export type ReporterInstance = new (opts: ReporterOptions) => Reporter;
 export const reporters: {

package/src/reporters/json.ts

@@ -28,8 +28,8 @@ import { join } from 'path';
 import sharp from 'sharp';
 import { createHash } from 'crypto';
 import BaseReporter from './base';
+import { renderError, serializeError, stripAnsiCodes } from './reporter-util';
 import {
-  formatError,
   getTimestamp,
   CACHE_PATH,
   totalist,
@@ -189,6 +189,36 @@ export function formatNetworkFields(network: NetworkInfo) {
   return { ecs, payload };
 }
 
+/**
+ * formatJSONError formats the error in a structured format
+ * we restructure the error with code frame and stack trace for test errors
+ */
+function formatJSONError(error: Error | any, type: OutputType) {
+  if (error == null) {
+    return;
+  }
+
+  /**
+   * Do not process browser errors - console.error and unhandled exceptions
+   */
+  if (type != null && type === 'journey/browserconsole') {
+    return {
+      name: error.name,
+      message: error.message,
+      stack: error.stack,
+    };
+  }
+
+  /**
+   * Do not highlight source for these errors and strip ANSI codes
+   */
+  return {
+    name: error.name,
+    message: stripAnsiCodes(error.message.split('\n')[0]),
+    stack: stripAnsiCodes(renderError(serializeError(error, false))),
+  };
+}
+
 function journeyInfo(
   journey: OutputFields['journey'],
   type: OutputFields['type'],
@@ -317,7 +347,7 @@ export default class JSONReporter extends BaseReporter {
     });
   }
 
-  onJourneyRegister(journey: Journey): void {
+  override onJourneyRegister(journey: Journey): void {
     this.writeJSON({
       type: 'journey/register',
       journey,
@@ -550,7 +580,7 @@ export default class JSONReporter extends BaseReporter {
       payload,
       blob,
       blob_mime,
-      error: formatError(error),
+      error: formatJSONError(error, type),
       url,
       package_version: version,
     });

package/src/reporters/junit.ts

@@ -31,8 +31,9 @@ import {
   StepEndResult,
 } from '../common_types';
 import { Journey, Step } from '../dsl';
-import { formatError, indent, now } from '../helpers';
+import { indent, now } from '../helpers';
 import BaseReporter from './base';
+import { serializeError, stripAnsiCodes } from './reporter-util';
 
 type XMLEntry = {
   name: string;
@@ -97,14 +98,13 @@ export default class JUnitReporter extends BaseReporter {
 
     entry.attributes.tests++;
     if (status === 'failed') {
-      const { name, message, stack } = formatError(error);
       caseEntry.children.push({
         name: 'failure',
         attributes: {
-          message,
-          type: name,
+          message: error.message,
+          type: error.name,
         },
-        text: stack,
+        text: stripAnsiCodes(serializeError(error).stack),
       });
       entry.attributes.failures++;
     } else if (status === 'skipped') {