@elastic/synthetics 1.6.0 → 1.7.1

package/src/core/index.ts

@@ -23,7 +23,13 @@
  *
  */
 
-import { Journey, JourneyCallback, JourneyOptions } from '../dsl';
+import {
+  Journey,
+  JourneyCallback,
+  JourneyOptions,
+  JourneyWithAnnotations,
+  StepWithAnnotations,
+} from '../dsl';
 import Runner from './runner';
 import { VoidCallback, HooksCallback, Location } from '../common_types';
 import { wrapFnWithLocation } from '../helpers';
@@ -41,28 +47,48 @@ if (!global[SYNTHETICS_RUNNER]) {
 
 export const runner: Runner = global[SYNTHETICS_RUNNER];
 
-export const journey = wrapFnWithLocation(
-  (
-    location: Location,
-    options: JourneyOptions | string,
-    callback: JourneyCallback
-  ) => {
-    log(`Journey register: ${JSON.stringify(options)}`);
-    if (typeof options === 'string') {
-      options = { name: options, id: options };
+const createJourney = (type?: 'skip' | 'only') =>
+  wrapFnWithLocation(
+    (
+      location: Location,
+      options: JourneyOptions | string,
+      callback: JourneyCallback
+    ) => {
+      log(`Journey register: ${JSON.stringify(options)}`);
+      if (typeof options === 'string') {
+        options = { name: options, id: options };
+      }
+      const j = new Journey(options, callback, location);
+
+      if (type) {
+        j[type] = true;
+      }
+
+      runner.addJourney(j);
+      return j;
     }
-    const j = new Journey(options, callback, location);
-    runner.addJourney(j);
-    return j;
-  }
-);
+  );
 
-export const step = wrapFnWithLocation(
-  (location: Location, name: string, callback: VoidCallback) => {
-    log(`Step register: ${name}`);
-    return runner.currentJourney?.addStep(name, callback, location);
-  }
-);
+export const journey = createJourney() as JourneyWithAnnotations;
+journey.skip = createJourney('skip');
+journey.only = createJourney('only');
+
+const createStep = (type?: 'skip' | 'soft' | 'only') =>
+  wrapFnWithLocation(
+    (location: Location, name: string, callback: VoidCallback) => {
+      log(`Step register: ${name}`);
+      const step = runner.currentJourney?.addStep(name, callback, location);
+      if (type) {
+        step[type] = true;
+      }
+      return step;
+    }
+  );
+
+export const step = createStep() as StepWithAnnotations;
+step.skip = createStep('skip');
+step.soft = createStep('soft');
+step.only = createStep('only');
 
 export const monitor = {
   use: wrapFnWithLocation((location: Location, config: MonitorConfig) => {

package/src/core/runner.ts

@@ -256,19 +256,30 @@ export default class Runner {
     options: RunOptions
   ) {
     const results: Array<StepResult> = [];
+    const isOnlyExists = journey.steps.filter(s => s.only).length > 0;
     let skipStep = false;
     for (const step of journey.steps) {
       const start = monotonicTimeInSeconds();
       this.#reporter?.onStepStart?.(journey, step);
       let data: StepResult = { status: 'succeeded' };
-      if (skipStep) {
+      /**
+       * Skip the step
+       * - if the step is marked as skip
+       * - if the previous step fails and the current step is not marked as soft
+       * - if the step is not marked as only and there are steps marked as only
+       */
+      if (
+        step.skip ||
+        (skipStep && !step.only) ||
+        (isOnlyExists && !step.only)
+      ) {
         data.status = 'skipped';
       } else {
         data = await this.runStep(step, context, options);
         /**
          * skip next steps if the previous step returns error
          */
-        if (data.error) skipStep = true;
+        if (data.error && !step.soft) skipStep = true;
       }
       this.#reporter?.onStepEnd?.(journey, step, {
         start,
@@ -366,6 +377,7 @@ export default class Runner {
           result.error = stepResult.error;
         }
       }
+      result.steps = stepResults;
       await this.runAfterHook(journey, hookArgs);
     } catch (e) {
       result.status = 'failed';
@@ -410,6 +422,11 @@ export default class Runner {
     const monitors: Monitor[] = [];
     for (const journey of this.journeys) {
       this.#currentJourney = journey;
+      if (journey.skip) {
+        throw new Error(
+          `Journey ${journey.name} is skipped. Please remove the journey.skip annotation and try again.`
+        );
+      }
       /**
        * Execute dummy callback to get all monitor specific
        * configurations for the current journey
@@ -436,6 +453,14 @@ export default class Runner {
     }).catch(e => (this.hookError = e));
 
     const { dryRun, match, tags } = options;
+    /**
+     * Skip other journeys when using `.only`
+     */
+    const onlyJournerys = this.journeys.filter(j => j.only);
+    if (onlyJournerys.length > 0) {
+      this.journeys = onlyJournerys;
+    }
+
     for (const journey of this.journeys) {
       /**
        * Used by heartbeat to gather all registered journeys
@@ -444,7 +469,7 @@ export default class Runner {
         this.#reporter.onJourneyRegister?.(journey);
         continue;
       }
-      if (!journey.isMatch(match, tags)) {
+      if (!journey.isMatch(match, tags) || journey.skip) {
         continue;
       }
       const journeyResult: JourneyResult = this.hookError

package/src/core/transform.ts

@@ -81,9 +81,6 @@ export function commonOptions(): CommonOptions {
    */
   return {
     minify: false,
-    minifyIdentifiers: false,
-    minifySyntax: false,
-    minifyWhitespace: false,
     sourcemap: 'both',
     sourcesContent: false,
     platform: 'node',

package/src/dsl/journey.ts

@@ -61,6 +61,8 @@ export class Journey {
   steps: Step[] = [];
   hooks: Hooks = { before: [], after: [] };
   monitor: Monitor;
+  skip = false;
+  only = false;
 
   constructor(
     options: JourneyOptions,
@@ -107,3 +109,19 @@ export class Journey {
     return isMatch(this.tags, this.name, tagsPattern, matchPattern);
   }
 }
+
+type JourneyType = (
+  options: string | JourneyOptions,
+  callback: JourneyCallback
+) => Journey;
+
+export type JourneyWithAnnotations = JourneyType & {
+  /**
+   * Skip this journey and all its steps
+   */
+  skip: JourneyType;
+  /**
+   * Run only this journey and skip rest of the journeys
+   */
+  only: JourneyType;
+};

package/src/dsl/step.ts

@@ -30,6 +30,9 @@ export class Step {
   index: number;
   callback: VoidCallback;
   location?: Location;
+  skip = false;
+  soft = false;
+  only = false;
 
   constructor(
     name: string,
@@ -43,3 +46,20 @@ export class Step {
     this.location = location;
   }
 }
+
+type StepType = (name: string, callback: VoidCallback) => Step;
+
+export type StepWithAnnotations = StepType & {
+  /**
+   * Skip this step on the journey
+   */
+  skip: StepType;
+  /**
+   * Failure of soft step will not skip rest of the steps in the journey
+   */
+  soft: StepType;
+  /**
+   * Run only this step and skip rest of the steps in the journey
+   */
+  only: StepType;
+};

package/src/helpers.ts

@@ -312,7 +312,7 @@ export function wrapFnWithLocation<A extends unknown[], R>(
   };
 }
 
-// Safely parse ND JSON (Newline delimitted JSON) chunks
+// Safely parse ND JSON (Newline delimited JSON) chunks
 export function safeNDJSONParse(data: string | string[]) {
   // data may not be at proper newline boundaries, so we make sure everything is split
   // on proper newlines

package/src/index.ts

@@ -73,7 +73,13 @@ export type {
   StartEvent,
 } from './common_types';
 
-export type { Journey, JourneyCallback } from './dsl';
+export type {
+  Journey,
+  JourneyCallback,
+  JourneyWithAnnotations,
+  JourneyOptions,
+  StepWithAnnotations,
+} from './dsl';
 
 export type {
   Action,

package/src/push/bundler.ts

@@ -31,7 +31,8 @@ import archiver from 'archiver';
 import { commonOptions } from '../core/transform';
 import { SyntheticsBundlePlugin } from './plugin';
 
-const SIZE_LIMIT_KB = 800;
+// 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);
@@ -48,6 +49,7 @@ export class Bundler {
         entryPoints: [absPath],
         bundle: true,
         write: false,
+        minifyWhitespace: true,
         sourcemap: 'inline',
         external: ['@elastic/synthetics'],
         plugins: [SyntheticsBundlePlugin()],
@@ -100,7 +102,7 @@ export class Bundler {
     const sizeKb = size / 1024;
     if (sizeKb > SIZE_LIMIT_KB) {
       throw new Error(
-        `You have monitors whose size exceeds the ${SIZE_LIMIT_KB}KB limit.`
+        `Bundled monitor code exceeds the recommended ${SIZE_LIMIT_KB}KB limit. Please check your dependencies and try again.`
       );
     }
   }