@elastic/synthetics 1.2.0 → 1.4.0

package/src/cli.ts

@@ -38,13 +38,7 @@ import { globalSetup } from './loader';
 import { run } from './';
 import { runner } from './core';
 import { SyntheticsLocations } from './dsl/monitor';
-import {
-  push,
-  loadSettings,
-  validateSettings,
-  catchIncorrectSettings,
-  warnIfThrottled,
-} from './push';
+import { push, loadSettings, validatePush, warnIfThrottled } from './push';
 import {
   formatLocations,
   getLocations,
@@ -57,11 +51,13 @@ import { error } from './helpers';
 import { LocationsMap } from './locations/public-locations';
 import { createLightweightMonitors } from './push/monitor';
 import { getVersion } from './push/kibana_api';
+import { installTransform } from './core/transform';
 
 /* eslint-disable-next-line @typescript-eslint/no-var-requires */
 const { name, version } = require('../package.json');
 
-const { params, pattern, tags, match, playwrightOpts } = getCommonCommandOpts();
+const { params, pattern, playwrightOpts, auth, authMandatory } =
+  getCommonCommandOpts();
 
 program
   .name(`npx ${name}`)
@@ -71,9 +67,12 @@ program
     'configuration path (default: synthetics.config.js)'
   )
   .addOption(pattern)
-  .addOption(tags)
-  .addOption(match)
   .addOption(params)
+  .option('--tags <name...>', 'run tests with a tag that matches the glob')
+  .option(
+    '--match <name>',
+    'run tests with a name or tags that matches the glob'
+  )
   .addOption(
     new Option('--reporter <value>', `output reporter format`).choices(
       Object.keys(reporters)
@@ -81,8 +80,9 @@ program
   )
   .option('--inline', 'Run inline journeys from heartbeat')
   .option('-r, --require <modules...>', 'module(s) to preload')
-  .option('--sandbox', 'enable chromium sandboxing')
+  .option('--sandbox', 'enable chromium sand-boxing')
   .option('--rich-events', 'Mimics a heartbeat run')
+  .option('--no-headless', 'run browser in head-full mode')
   .option(
     '--capability <features...>',
     'Enable capabilities through feature flags'
@@ -160,14 +160,6 @@ program
   .description(
     'Push all journeys in the current directory to create monitors within the Kibana monitor management UI'
   )
-  .addOption(
-    new Option(
-      '--auth <auth>',
-      'API key used for Kibana authentication(https://www.elastic.co/guide/en/kibana/master/api-keys.html).'
-    )
-      .env('SYNTHETICS_API_KEY')
-      .makeOptionMandatory(true)
-  )
   .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.",
@@ -193,9 +185,8 @@ 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(authMandatory)
   .addOption(pattern)
-  .addOption(tags)
-  .addOption(match)
   .addOption(params)
   .addOption(playwrightOpts)
   .action(async (cmdOpts: PushOptions) => {
@@ -213,8 +204,7 @@ program
         },
         'push'
       ) as PushOptions;
-      validateSettings(options);
-      await catchIncorrectSettings(settings, options);
+      await validatePush(options, settings);
       const monitors = runner.buildMonitors(options);
       if ((options as CliArgs).throttling == null) {
         warnIfThrottled(monitors);
@@ -251,21 +241,26 @@ program
     `List all locations to run the synthetics monitors. Pass optional '--url' and '--auth' to list private locations.`
   )
   .option('--url <url>', 'Kibana URL to fetch all public and private locations')
-  .option(
-    '--auth <auth>',
-    'API key used for Kibana authentication(https://www.elastic.co/guide/en/kibana/master/api-keys.html).'
-  )
+  .addOption(auth)
   .action(async (cmdOpts: LocationCmdOptions) => {
+    const revert = installTransform();
+    const url = cmdOpts.url ?? (await loadSettings(true))?.url;
+
     try {
-      let locations = Object.keys(LocationsMap);
-      if (cmdOpts.auth && cmdOpts.url) {
-        const allLocations = await getLocations(cmdOpts);
-        locations = formatLocations(allLocations);
+      if (url && cmdOpts.auth) {
+        const allLocations = await getLocations({
+          url,
+          auth: cmdOpts.auth,
+        });
+        renderLocations(formatLocations(allLocations));
+      } else {
+        renderLocations({ publicLocations: Object.keys(LocationsMap) });
       }
-      renderLocations(locations);
     } catch (e) {
       e && error(e);
       process.exit(1);
+    } finally {
+      revert();
     }
   });
 

package/src/common_types.ts

@@ -34,7 +34,7 @@ import {
 } from 'playwright-chromium';
 import { Step } from './dsl';
 import { BuiltInReporterName, ReporterInstance } from './reporters';
-import { MonitorConfig } from './dsl/monitor';
+import { AlertConfig, MonitorConfig } from './dsl/monitor';
 
 export type VoidCallback = () => void;
 export type Location = {
@@ -201,6 +201,7 @@ type BaseArgs = {
   params?: Params;
   screenshots?: ScreenshotOptions;
   dryRun?: boolean;
+  pattern?: string;
   match?: string;
   tags?: Array<string>;
   outfd?: number;
@@ -212,16 +213,17 @@ type BaseArgs = {
   schedule?: MonitorConfig['schedule'];
   locations?: MonitorConfig['locations'];
   privateLocations?: MonitorConfig['privateLocations'];
+  alert?: AlertConfig;
 };
 
 export type CliArgs = BaseArgs & {
   config?: string;
   reporter?: BuiltInReporterName;
-  pattern?: string;
   inline?: boolean;
   require?: Array<string>;
   sandbox?: boolean;
   richEvents?: boolean;
+  headless?: boolean;
   capability?: Array<string>;
   ignoreHttpsErrors?: boolean;
 };
@@ -237,18 +239,12 @@ export type RunOptions = BaseArgs & {
   reporter?: BuiltInReporterName | ReporterInstance;
 };
 
-export type PushOptions = Partial<ProjectSettings> & {
-  auth: string;
-  schedule?: MonitorConfig['schedule'];
-  locations?: MonitorConfig['locations'];
-  privateLocations?: MonitorConfig['privateLocations'];
-  params?: MonitorConfig['params'];
-  kibanaVersion?: number;
-  yes?: boolean;
-  pattern?: string;
-  match?: string;
-  tags?: Array<string>;
-};
+export type PushOptions = Partial<ProjectSettings> &
+  Partial<BaseArgs> & {
+    auth: string;
+    kibanaVersion?: string;
+    yes?: boolean;
+  };
 
 export type ProjectSettings = {
   id: string;
@@ -262,6 +258,7 @@ export type PlaywrightOptions = LaunchOptions &
     actionTimeout?: number;
     navigationTimeout?: number;
   };
+
 export type SyntheticsConfig = {
   params?: Params;
   playwrightOptions?: PlaywrightOptions;

package/src/core/runner.ts

@@ -44,6 +44,7 @@ import {
   RunOptions,
   JourneyResult,
   StepResult,
+  PushOptions,
 } from '../common_types';
 import { PluginManager } from '../plugins';
 import { PerformanceManager } from '../plugins';
@@ -383,7 +384,7 @@ export default class Runner {
     await mkdir(CACHE_PATH, { recursive: true });
   }
 
-  buildMonitors(options: RunOptions) {
+  buildMonitors(options: PushOptions) {
     /**
      * Update the global monitor configuration required for
      * setting defaults
@@ -396,13 +397,12 @@ export default class Runner {
       params: options.params,
       playwrightOptions: options.playwrightOptions,
       screenshot: options.screenshots,
+      tags: options.tags,
+      alert: options.alert,
     });
 
     const monitors: Monitor[] = [];
     for (const journey of this.journeys) {
-      if (!journey.isMatch(options.match, options.tags)) {
-        continue;
-      }
       this.#currentJourney = journey;
       /**
        * Execute dummy callback to get all monitor specific

package/src/dsl/journey.ts

@@ -97,7 +97,6 @@ export class Journey {
       ...config,
     });
     this.monitor.setSource(this.location);
-    this.monitor.setContent(this.callback.toString());
     this.monitor.setFilter({ match: this.name });
   }
 

package/src/dsl/monitor.ts

@@ -44,6 +44,15 @@ export const ALLOWED_SCHEDULES = [
   1, 3, 5, 10, 15, 20, 30, 60, 120, 240,
 ] as const;
 
+export interface AlertConfig {
+  status?: {
+    enabled: boolean;
+  };
+  tls?: {
+    enabled: boolean;
+  };
+}
+
 export type MonitorConfig = {
   id?: string;
   name?: string;
@@ -62,11 +71,7 @@ export type MonitorConfig = {
   screenshot?: ScreenshotOptions;
   params?: Params;
   playwrightOptions?: PlaywrightOptions;
-  alert?: {
-    status: {
-      enabled: boolean;
-    };
-  };
+  alert?: AlertConfig;
 };
 
 type MonitorFilter = {
@@ -86,7 +91,10 @@ export class Monitor {
   update(globalOpts: MonitorConfig = {}) {
     this.config = merge(globalOpts, this.config, {
       arrayMerge(target, source) {
-        return [...new Set(source)];
+        if (source && source.length > 0) {
+          return [...new Set(source)];
+        }
+        return target;
       },
     });
   }
@@ -101,6 +109,7 @@ export class Monitor {
 
   /**
    * The underlying journey code of the monitor
+   * along with its dependencies
    */
   setContent(content = '') {
     this.content = content;

package/src/generator/index.ts

@@ -112,7 +112,8 @@ export class Generator {
     }).run();
 
     const allLocations = await getLocations({ url, auth });
-    const locChoices = formatLocations(allLocations);
+    const { allLocations: locChoices } = formatLocations(allLocations);
+
     if (locChoices.length === 0) {
       throw 'Follow the docs to set up your first private locations - https://www.elastic.co/guide/en/observability/current/uptime-set-up-choose-agent.html#private-locations';
     }

package/src/index.ts

@@ -43,6 +43,7 @@ export {
   after,
 } from './core';
 export { expect } from './core/expect';
+
 /**
  * Export all the driver related types to be consumed
  * and used by suites
@@ -53,6 +54,7 @@ export type {
   ChromiumBrowserContext,
   CDPSession,
   APIRequestContext,
+  devices,
 } from 'playwright-chromium';
 
 /**

package/src/locations/index.ts

@@ -42,7 +42,7 @@ export type LocationAPIResponse = {
   locations: Array<LocationMetadata>;
 };
 
-const PRIVATE_KEYWORD = '(private)';
+export const PRIVATE_KEYWORD = '(private)';
 
 export async function getLocations(options: LocationCmdOptions) {
   const resp = await sendReqAndHandleError<LocationAPIResponse>({
@@ -54,25 +54,33 @@ export async function getLocations(options: LocationCmdOptions) {
 }
 
 export function formatLocations(locations: Array<LocationMetadata>) {
-  const formatted: Array<string> = [];
+  const publicLocations: Array<string> = [];
+  const privateLocations: Array<string> = [];
   for (const location of locations) {
     let name = location.label;
     if (location.isServiceManaged) {
       [, name] = name.includes('-') ? name.split('-') : [, name];
       name = name.toLowerCase().trim().split(' ').join('_');
+      publicLocations.push(name);
     } else {
-      name = `${name}${PRIVATE_KEYWORD}`;
+      privateLocations.push(name);
     }
-    formatted.push(name);
   }
-  return formatted;
+
+  return {
+    publicLocations,
+    privateLocations,
+    allLocations: publicLocations.concat(
+      privateLocations.map(loc => `${loc} ${PRIVATE_KEYWORD}`)
+    ),
+  };
 }
 
 export function groupLocations(locations: Array<string>) {
   const grouped = { locations: [], privateLocations: [] };
   for (const loc of locations) {
     if (loc.includes(PRIVATE_KEYWORD)) {
-      grouped.privateLocations.push(loc.replace(PRIVATE_KEYWORD, ''));
+      grouped.privateLocations.push(loc.replace(PRIVATE_KEYWORD, '').trim());
     } else {
       grouped.locations.push(loc);
     }
@@ -80,13 +88,30 @@ export function groupLocations(locations: Array<string>) {
   return grouped;
 }
 
-export function renderLocations(locations: Array<string>) {
-  let outer = 'Available locations: \n';
-  let inner = '';
-  for (const location of locations) {
-    inner += `* ${location}\n`;
+export function renderLocations({
+  publicLocations,
+  privateLocations = [],
+}: {
+  privateLocations?: Array<string>;
+  publicLocations: Array<string>;
+}) {
+  let outer = '';
+  if (publicLocations.length) {
+    outer = 'Public locations: \n';
+    let inner = '';
+    for (const location of publicLocations) {
+      inner += `* ${location}\n`;
+    }
+    outer += indent(inner);
+  }
+  if (privateLocations.length > 0) {
+    outer += '\nPrivate locations: \n';
+    let privateInner = '';
+    for (const location of privateLocations) {
+      privateInner += `* ${location}\n`;
+    }
+    outer += indent(privateInner);
   }
-  outer += indent(inner);
   outer += `\nSet default location for monitors via
   - Synthetics config file 'monitors.locations' | 'monitors.privateLocations' field
   - Monitor API 'monitor.use({ locations: ["japan"], privateLocations: ["custom-location"] }')`;

package/src/options.ts

@@ -26,8 +26,8 @@
 import merge from 'deepmerge';
 import { createOption } from 'commander';
 import { readConfig } from './config';
-import type { CliArgs, RunOptions } from './common_types';
-import { THROTTLING_WARNING_MSG, warn } from './helpers';
+import type { CliArgs, PushOptions, RunOptions } from './common_types';
+import { THROTTLING_WARNING_MSG, error, warn } from './helpers';
 
 type Mode = 'run' | 'push';
 
@@ -106,6 +106,7 @@ export function normalizeOptions(
   );
   options.playwrightOptions = {
     ...playwrightOpts,
+    headless: cliArgs.headless ?? playwrightOpts?.headless,
     chromiumSandbox: cliArgs.sandbox ?? playwrightOpts?.chromiumSandbox,
     ignoreHTTPSErrors:
       cliArgs.ignoreHttpsErrors ?? playwrightOpts?.ignoreHTTPSErrors,
@@ -120,22 +121,33 @@ export function normalizeOptions(
       options.screenshots = cliArgs.screenshots ?? 'on';
       break;
     case 'push':
+      validatePushOptions(options as PushOptions);
       /**
        * Merge the default monitor config from synthetics.config.ts file
        * with the CLI options passed via push command
        */
       const monitor = config.monitor;
-      options.screenshots = options.screenshots ?? monitor?.screenshot;
-      options.schedule = options.schedule ?? monitor?.schedule;
-      options.locations = options.locations ?? monitor?.locations;
-      options.privateLocations =
-        options.privateLocations ?? monitor?.privateLocations;
+      for (const key of Object.keys(monitor || {})) {
+        // screenshots require special handling as the flags are different
+        if (key === 'screenshot') {
+          options.screenshots = options.screenshots ?? monitor[key];
+          continue;
+        }
+        options[key] = options[key] ?? monitor[key];
+      }
       break;
   }
-
   return options;
 }
 
+export function validatePushOptions(opts: PushOptions) {
+  if (opts.tags || opts.match) {
+    throw error(`Aborted. Invalid CLI flags.
+
+Tags and Match are not supported in push command.`);
+  }
+}
+
 /* eslint-disable-next-line @typescript-eslint/no-unused-vars */
 function toObject(value: boolean | Record<string, any>): Record<string, any> {
   const defaulVal = {};
@@ -173,20 +185,22 @@ export function getCommonCommandOpts() {
     '--pattern <pattern>',
     'RegExp pattern to match journey/monitor files that are different from the default (ex: /*.journey.(ts|js)$/)'
   );
-  const tags = createOption(
-    '--tags <name...>',
-    'run/push tests with a tag that matches the glob'
-  );
-  const match = createOption(
-    '--match <name>',
-    'run/push tests with a name or tags that matches the glob'
+
+  const apiDocsLink =
+    'API key used for Kibana authentication(https://www.elastic.co/guide/en/kibana/master/api-keys.html).';
+  const auth = createOption('--auth <auth>', apiDocsLink).env(
+    'SYNTHETICS_API_KEY'
   );
 
+  const authMandatory = createOption('--auth <auth>', apiDocsLink)
+    .env('SYNTHETICS_API_KEY')
+    .makeOptionMandatory(true);
+
   return {
+    auth,
+    authMandatory,
     params,
     playwrightOpts,
     pattern,
-    tags,
-    match,
   };
 }

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,12 +169,22 @@ 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}`);
+    }
   }
 }
 
+export async function validatePush(
+  opts: PushOptions,
+  settings: ProjectSettings
+) {
+  validateSettings(opts);
+  await catchIncorrectSettings(settings, opts);
+}
+
 export function validateSettings(opts: PushOptions) {
   const INVALID = 'Aborted. Invalid synthetics project settings.';
 

package/src/push/kibana_api.ts

@@ -125,7 +125,7 @@ export async function bulkDeleteMonitors(
 
 type StatusResponse = {
   version: {
-    number: number;
+    number: string;
   };
 };