@elastic/synthetics 1.17.1 → 1.18.0

package/src/core/globals.ts

@@ -34,4 +34,16 @@ if (!global[SYNTHETICS_RUNNER]) {
   global[SYNTHETICS_RUNNER] = new Runner();
 }
 
+/**
+ * Set debug based on DEBUG ENV and namespace - synthetics
+ */
+if (process.env.DEBUG && process.env.DEBUG.includes('synthetics')) {
+  process.env['__SYNTHETICS__DEBUG__'] = '1';
+}
+
 export const runner: Runner = global[SYNTHETICS_RUNNER];
+
+// is Debug mode enabled
+export function inDebugMode() {
+  return !!process.env['__SYNTHETICS__DEBUG__'];
+}

package/src/core/index.ts

@@ -30,7 +30,7 @@ import {
   JourneyWithAnnotations,
   StepWithAnnotations,
 } from '../dsl';
-import { runner } from "./globals"
+import { runner as runnerGlobal } from './globals';
 import { VoidCallback, HooksCallback, Location } from '../common_types';
 import { wrapFnWithLocation } from '../helpers';
 import { log } from './logger';
@@ -112,3 +112,5 @@ export const after = (callback: HooksCallback) => {
   }
   return runner.currentJourney._addHook('after', callback);
 };
+
+export const runner = runnerGlobal;

package/src/core/logger.ts

@@ -25,16 +25,10 @@
 
 import { grey, cyan, dim, italic } from 'kleur/colors';
 import { now } from '../helpers';
-
-/**
- * Set debug based on DEBUG ENV and namespace - synthetics
- */
-if (process.env.DEBUG && process.env.DEBUG.includes('synthetics')) {
-  process.env['__SYNTHETICS__DEBUG__'] = '1';
-}
+import { inDebugMode } from './globals';
 
 export function log(msg) {
-  if (!process.env['__SYNTHETICS__DEBUG__'] || !msg) {
+  if (!inDebugMode() || !msg) {
     return;
   }
   if (typeof msg === 'object') {

package/src/core/mfa.ts

@@ -23,48 +23,48 @@
  *
  */
 
-import { TOTP } from "otpauth";
+import { TOTP } from 'otpauth';
 
 type TOTPOptions = {
   /**
    * Provider or Service the secret is associated with
    */
-  issuer?: string
+  issuer?: string;
   /**
    * Account Identifier.
    * @default 'SyntheticsTOTP'
    */
-  label?: string
+  label?: string;
   /**
    * Include issuer prefix in label.
    */
-  issuerInLabel?: boolean
+  issuerInLabel?: boolean;
   /**
    * The encoded secret key used to generate the TOTP.
    */
-  secret?: string
+  secret?: string;
   /**
    * The algorithm used to generate the TOTP.
    * @default 'SHA1'
    */
-  algorithm?: string
+  algorithm?: string;
   /**
    * Number of digits in the generated token.
    * @default 6
    */
-  digits?: number
+  digits?: number;
   /**
    * Validity period in seconds for the token.
    * @default 30
    */
-  period?: number
+  period?: number;
 };
 
 export type TOTPCmdOptions = {
-  issuer?: string
-  label?: string
+  issuer?: string;
+  label?: string;
 };
 
 export function totp(secret?: string, options: TOTPOptions = {}) {
-  return new TOTP({ label: "SyntheticsTOTP", secret, ...options }).generate();
+  return new TOTP({ label: 'SyntheticsTOTP', secret, ...options }).generate();
 }

package/src/core/runner.ts

@@ -45,10 +45,7 @@ import {
   StepResult,
   PushOptions,
 } from '../common_types';
-import {
-  PerformanceManager,
-  filterBrowserMessages,
-} from '../plugins';
+import { PerformanceManager, filterBrowserMessages } from '../plugins';
 import { Gatherer } from './gatherer';
 import { log } from './logger';
 import { Monitor, MonitorConfig } from '../dsl/monitor';
@@ -104,7 +101,7 @@ export default class Runner implements RunnerInfo {
         type: 'jpeg',
         quality: 80,
         timeout: 5000,
-      })
+      });
       /**
        * Write the screenshot image buffer with additional details (step
        * information) which could be extracted at the end of
@@ -131,8 +128,20 @@ export default class Runner implements RunnerInfo {
     this.#hooks[type].push(callback);
   }
 
+  /**
+   * @deprecated Since version Please do not rely on the internal methods.
+   * Alias _addHook for backwards compatibility
+   */
+  addHook(type: HookType, callback: HooksCallback) {
+    this._addHook(type, callback);
+  }
+
   private buildHookArgs() {
-    return { env: this.config.environment, params: this.config.params, info: this as RunnerInfo };
+    return {
+      env: this.config.environment,
+      params: this.config.params,
+      info: this as RunnerInfo,
+    };
   }
 
   _updateMonitor(config: MonitorConfig) {
@@ -143,11 +152,27 @@ export default class Runner implements RunnerInfo {
     this.#monitor.update(config);
   }
 
+  /**
+   * @deprecated Since version Please do not rely on the internal methods.
+   * Alias _addJourney for backwards compatibility
+   */
+  updateMonitor(config: MonitorConfig) {
+    this._updateMonitor(config);
+  }
+
   _addJourney(journey: Journey) {
     this.#journeys.push(journey);
     this.#currentJourney = journey;
   }
 
+  /**
+   * @deprecated Since version 1.17.0. Please do not rely on the internal methods.
+   * Alias _addJourney for backwards compatibility
+   */
+  addJourney(journey: Journey) {
+    this._addJourney(journey);
+  }
+
   private setReporter(options: RunOptions) {
     /**
      * Set up the corresponding reporter and fallback
@@ -181,10 +206,7 @@ export default class Runner implements RunnerInfo {
     await runParallel(journey._getHook('after'), args);
   }
 
-  async #runStep(
-    step: Step,
-    options: RunOptions
-  ): Promise<StepResult> {
+  async #runStep(step: Step, options: RunOptions): Promise<StepResult> {
     log(`Runner: start step (${step.name})`);
     const { metrics, screenshots, filmstrips, trace } = options;
     /**
@@ -212,7 +234,7 @@ export default class Runner implements RunnerInfo {
       // invoke the step callback by extracting to a variable to get better stack trace
       const cb = step.cb;
       await cb();
-      step.status = "succeeded"
+      step.status = 'succeeded';
     } catch (error) {
       step.status = 'failed';
       step.error = error;
@@ -245,13 +267,10 @@ export default class Runner implements RunnerInfo {
       }
     }
     log(`Runner: end step (${step.name})`);
-    return data
+    return data;
   }
 
-  async #runSteps(
-    journey: Journey,
-    options: RunOptions
-  ) {
+  async #runSteps(journey: Journey, options: RunOptions) {
     const results: Array<StepResult> = [];
     const isOnlyExists = journey.steps.filter(s => s.only).length > 0;
     let skipStep = false;
@@ -297,7 +316,7 @@ export default class Runner implements RunnerInfo {
      * caching all screenshots and clear them at end of each journey
      */
     await mkdir(this.#screenshotPath, { recursive: true });
-    const params = options.params
+    const params = options.params;
     this.#reporter?.onJourneyStart?.(journey, {
       timestamp: getTimestamp(),
       params,
@@ -315,7 +334,10 @@ export default class Runner implements RunnerInfo {
   ) {
     // Enhance the journey results
     const pOutput = await Gatherer.pluginManager.output();
-    const bConsole = filterBrowserMessages(pOutput.browserconsole, journey.status);
+    const bConsole = filterBrowserMessages(
+      pOutput.browserconsole,
+      journey.status
+    );
     await this.#reporter?.onJourneyEnd?.(journey, {
       browserDelay: this.#browserDelay,
       timestamp: getTimestamp(),
@@ -324,7 +346,7 @@ export default class Runner implements RunnerInfo {
       browserconsole: bConsole,
     });
     await Gatherer.endRecording();
-    await Gatherer.dispose(this.#driver)
+    await Gatherer.dispose(this.#driver);
     // clear screenshots cache after each journey
     await rm(this.#screenshotPath, { recursive: true, force: true });
     return Object.assign(result, {
@@ -361,12 +383,16 @@ export default class Runner implements RunnerInfo {
     this.#currentJourney = journey;
     log(`Runner: start journey (${journey.name})`);
     let result: JourneyResult = {};
-    const hookArgs = { env: options.environment, params: options.params, info: this };
+    const hookArgs = {
+      env: options.environment,
+      params: options.params,
+      info: this,
+    };
     try {
       await this.#startJourney(journey, options);
       await this.#runBeforeHook(journey, hookArgs);
       const stepResults = await this.#runSteps(journey, options);
-      journey.status = "succeeded";
+      journey.status = 'succeeded';
       // Mark journey as failed if any one of the step fails
       for (const step of journey.steps) {
         if (step.status === 'failed') {
@@ -385,13 +411,21 @@ export default class Runner implements RunnerInfo {
       await this.#runAfterHook(journey, hookArgs).catch(e => {
         journey.status = 'failed';
         journey.error = e;
-      })
+      });
       result = await this.#endJourney(journey, result, options);
     }
     log(`Runner: end journey (${journey.name})`);
     return result;
   }
 
+  /**
+   * @deprecated Since version 1.17.0. Please do not rely on the internal methods.
+   * Alias _runJourney for backwards compatibility
+   */
+  runJourney(journey: Journey, options: RunOptions) {
+    this._runJourney(journey, options);
+  }
+
   _buildMonitors(options: PushOptions) {
     /**
      * Update the global monitor configuration required for setting defaults
@@ -426,15 +460,12 @@ export default class Runner implements RunnerInfo {
        * - filter out monitors based on matched tags and name after applying both
        *  global and local monitor configurations
        */
-      journey.cb({ params: options.params } as any);
-      const monitor = journey._getMonitor();
+
+      // TODO: Fix backwards compatibility with 1.14 and prior
+      (journey.cb ?? journey.callback)({ params: options.params } as any);
+      const monitor = journey.monitor ?? journey?._getMonitor();
       monitor.update(this.#monitor?.config);
-      if (
-        !monitor.isMatch(
-          options.grepOpts?.match,
-          options.grepOpts?.tags
-        )
-      ) {
+      if (!monitor.isMatch(options.grepOpts?.match, options.grepOpts?.tags)) {
         continue;
       }
       monitor.validate();
@@ -443,6 +474,14 @@ export default class Runner implements RunnerInfo {
     return monitors;
   }
 
+  /**
+   * @deprecated Since version 1.17.0. Please do not rely on the internal methods.
+   * Alias _buildMonitors for backwards compatibility
+   */
+  buildMonitors(options: PushOptions) {
+    this._buildMonitors(options);
+  }
+
   async #init(options: RunOptions) {
     this.setReporter(options);
     this.#reporter.onStart?.({
@@ -474,20 +513,34 @@ export default class Runner implements RunnerInfo {
       this.#journeys = onlyJournerys;
     } else {
       // filter journeys based on tags and skip annotations
-      this.#journeys = this.#journeys.filter(j => j._isMatch(grepOpts?.match, grepOpts?.tags) && !j.skip);
+      this.#journeys = this.#journeys.filter(
+        j => j._isMatch(grepOpts?.match, grepOpts?.tags) && !j.skip
+      );
     }
 
     // Used by heartbeat to gather all registered journeys
     if (dryRun) {
-      this.#journeys.forEach(journey => this.#reporter.onJourneyRegister?.(journey))
+      this.#journeys.forEach(journey =>
+        this.#reporter.onJourneyRegister?.(journey)
+      );
     } else if (this.#journeys.length > 0) {
       result = await this._runJourneys(options);
     }
-    await this.#runAfterAllHook(hookArgs).catch(async () => await this._reset());
+    await this.#runAfterAllHook(hookArgs).catch(
+      async () => await this._reset()
+    );
     await this._reset();
     return result;
   }
 
+  /**
+   * @deprecated Since version 1.17.0. Please do not rely on the internal methods.
+   * Alias _run for backwards compatibility
+   */
+  run(options: RunOptions): Promise<RunResult> {
+    return this._run(options);
+  }
+
   async _runJourneys(options: RunOptions) {
     const result: RunResult = {};
     const browserStart = monotonicTimeInSeconds();
@@ -504,6 +557,14 @@ export default class Runner implements RunnerInfo {
     return result;
   }
 
+  /**
+   * @deprecated Since version 1.17.0. Please do not rely on the internal methods.
+   * Alias _runJourneys for backwards compatibility
+   */
+  runJourneys(options: RunOptions): Promise<RunResult> {
+    return this._runJourneys(options);
+  }
+
   async _reset() {
     this.#currentJourney = null;
     this.#journeys = [];
@@ -515,4 +576,12 @@ export default class Runner implements RunnerInfo {
     await rm(CACHE_PATH, { recursive: true, force: true });
     await this.#reporter?.onEnd?.();
   }
+
+  /**
+   * @deprecated Since version 1.17.0. Please do not rely on the internal methods.
+   * Alias _reset for backwards compatibility
+   */
+  reset() {
+    return this._reset();
+  }
 }

package/src/dsl/journey.ts

@@ -31,7 +31,13 @@ import {
   APIRequestContext,
 } from 'playwright-core';
 import { Step } from './step';
-import { VoidCallback, HooksCallback, Params, Location, StatusValue } 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';
@@ -90,18 +96,50 @@ export class Journey {
     return step;
   }
 
+  /**
+   * @deprecated Since version 1.17.0. Please do not rely on the internal methods.
+   * Alias _addStep for backwards compatibility
+   */
+  addStep(name: string, cb: VoidCallback, location?: Location) {
+    this._addStep(name, cb, location);
+  }
+
   _addHook(type: HookType, cb: HooksCallback) {
     this.#hooks[type].push(cb);
   }
 
+  /**
+   * @deprecated Since version 1.17.0. Please do not rely on the internal methods.
+   * Alias _addHook for backwards compatibility
+   */
+  addHook(type: HookType, cb: HooksCallback) {
+    this._addHook(type, cb);
+  }
+
   _getHook(type: HookType) {
     return this.#hooks[type];
   }
 
+  /**
+   * @deprecated Since version 1.17.0. Please do not rely on the internal methods.
+   * Alias _getHook for backwards compatibility
+   */
+  getHook(type: HookType) {
+    this._getHook(type);
+  }
+
   _getMonitor() {
     return this.#monitor;
   }
 
+  /**
+   * @deprecated Since version 1.17.0. Please do not rely on the internal methods.
+   * Alias _getHook for backwards compatibility
+   */
+  get monitor() {
+    return this._getMonitor();
+  }
+
   _updateMonitor(config: MonitorConfig) {
     /**
      * Use defaults values from journey for monitor object (id, name and tags)
@@ -117,16 +155,40 @@ export class Journey {
     this.#monitor.setFilter({ match: this.name });
   }
 
+  /**
+   * @deprecated Since version 1.17.0. Please do not rely on the internal methods.
+   * Alias _updateMonitor for backwards compatibility
+   */
+  updateMonitor(config: MonitorConfig) {
+    this._updateMonitor(config);
+  }
+
   get cb() {
     return this.#cb;
   }
 
+  /**
+   * @deprecated Since version 1.17.0. Please do not rely on the internal methods.
+   * Alias cb for backwards compatibility
+   */
+  get callback() {
+    return this.#cb;
+  }
+
   /**
    * Matches journeys based on the provided args. Proitize tags over match
    */
   _isMatch(matchPattern: string, tagsPattern: Array<string>) {
     return isMatch(this.tags, this.name, tagsPattern, matchPattern);
   }
+
+  /**
+   * @deprecated Since version 1.17.0. Please do not rely on the internal methods.
+   * Alias _isMatch for backwards compatibility
+   */
+  isMatch(matchPattern: string, tagsPattern: Array<string>) {
+    return this._isMatch(matchPattern, tagsPattern);
+  }
 }
 
 type JourneyType = (

package/src/dsl/monitor.ts

@@ -158,6 +158,13 @@ export class Monitor {
       .digest('base64');
   }
 
+  /**
+   * Returns the size of the monitor in bytes which is sent as payload to Kibana
+   */
+  size() {
+    return JSON.stringify(this).length;
+  }
+
   validate() {
     const schedule = this.config.schedule;
     if (ALLOWED_SCHEDULES.includes(schedule)) {

package/src/dsl/step.ts

@@ -54,6 +54,14 @@ export class Step {
   get cb() {
     return this.#cb;
   }
+
+  /**
+   * @deprecated Since version 1.17.0. Please do not rely on the internal methods.
+   * Alias cb for backwards compatibility
+   */
+  get callback() {
+    return this.#cb;
+  }
 }
 
 type StepType = (name: string, callback: VoidCallback) => Step;

package/src/formatter/javascript.ts

@@ -199,7 +199,9 @@ export class SyntheticsGenerator extends JavaScriptLanguageGenerator {
     const offset = this.isProject ? 2 + stepIndent : 0 + stepIndent;
     const formatter = new JavaScriptFormatter(offset);
 
-    const locators = actionInContext.frame.framePath.map(selector => `.${super._asLocator(selector)}.contentFrame()`);
+    const locators = actionInContext.frame.framePath.map(
+      selector => `.${super._asLocator(selector)}.contentFrame()`
+    );
     const subject = `${pageAlias}${locators.join('')}`;
     const signals = toSignalMap(action);
 

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);
@@ -152,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/loader.ts

@@ -29,7 +29,7 @@ import { CliArgs } from './common_types';
 import { step, journey } from './core';
 import { log } from './core/logger';
 import { expect } from './core/expect';
-import * as mfa from "./core/mfa";
+import * as mfa from './core/mfa';
 import {
   isDepInstalled,
   isDirectory,

package/src/plugins/tracing.ts

@@ -38,7 +38,7 @@ export type TraceOptions = {
  * https://chromedevtools.github.io/devtools-protocol/tot/Tracing/
  */
 export class Tracing {
-  constructor(private driver: Driver, private options: TraceOptions) { }
+  constructor(private driver: Driver, private options: TraceOptions) {}
 
   async start() {
     log(`Plugins: started collecting trace events`);

package/src/push/bundler.ts

@@ -24,25 +24,19 @@
  */
 
 import path from 'path';
-import { stat, unlink, readFile } from 'fs/promises';
+import { unlink, readFile } from 'fs/promises';
 import { createWriteStream } from 'fs';
 import * as esbuild from 'esbuild';
 import archiver from 'archiver';
 import { commonOptions } from '../core/transform';
 import { SyntheticsBundlePlugin } from './plugin';
 
-// 1500KB Max Gzipped limit for bundled code to be pushed as Kibana project monitors.
-const SIZE_LIMIT_KB = 1500;
-
 function relativeToCwd(entry: string) {
   return path.relative(process.cwd(), entry);
 }
 
 export class Bundler {
-  moduleMap = new Map<string, string>();
-  constructor() {}
-
-  async prepare(absPath: string) {
+  async bundle(absPath: string) {
     const options: esbuild.BuildOptions = {
       ...commonOptions(),
       ...{
@@ -59,56 +53,42 @@ export class Bundler {
     if (result.errors.length > 0) {
       throw result.errors;
     }
-    this.moduleMap.set(absPath, result.outputFiles[0].text);
+    return result.outputFiles[0].text;
   }
 
-  async zip(outputPath: string) {
+  async zip(source: string, code: string, dest: string) {
     return new Promise((fulfill, reject) => {
-      const output = createWriteStream(outputPath);
+      const output = createWriteStream(dest);
       const archive = archiver('zip', {
         zlib: { level: 9 },
       });
       archive.on('error', reject);
       output.on('close', fulfill);
       archive.pipe(output);
-      for (const [path, content] of this.moduleMap.entries()) {
-        const relativePath = relativeToCwd(path);
-        // Date is fixed to Unix epoch so the file metadata is
-        // not modified everytime when files are bundled
-        archive.append(content, {
-          name: relativePath,
-          date: new Date('1970-01-01'),
-        });
-      }
+      const relativePath = relativeToCwd(source);
+      // Date is fixed to Unix epoch so the file metadata is
+      // not modified everytime when files are bundled
+      archive.append(code, {
+        name: relativePath,
+        date: new Date('1970-01-01'),
+      });
       archive.finalize();
     });
   }
 
   async build(entry: string, output: string) {
-    await this.prepare(entry);
-    await this.zip(output);
-    const data = await this.encode(output);
-    await this.checkSize(output);
+    const code = await this.bundle(entry);
+    await this.zip(entry, code, output);
+    const content = await this.encode(output);
     await this.cleanup(output);
-    return data;
+    return content;
   }
 
   async encode(outputPath: string) {
     return await readFile(outputPath, 'base64');
   }
 
-  async checkSize(outputPath: string) {
-    const { size } = await stat(outputPath);
-    const sizeKb = size / 1024;
-    if (sizeKb > SIZE_LIMIT_KB) {
-      throw new Error(
-        `Bundled monitor code exceeds the recommended ${SIZE_LIMIT_KB}KB limit. Please check your dependencies and try again.`
-      );
-    }
-  }
-
   async cleanup(outputPath: string) {
-    this.moduleMap = new Map<string, string>();
     await unlink(outputPath);
   }
 }