@elastic/synthetics 1.5.3 → 1.7.0

package/src/formatter/javascript.ts

@@ -101,23 +101,15 @@ function toAssertCall(pageAlias: string, action: Action) {
 }
 
 function toSignalMap(action: Action) {
-  let waitForNavigation: Signal | undefined;
-  let assertNavigation: Signal | undefined;
   let popup: Signal | undefined;
   let download: Signal | undefined;
   let dialog: Signal | undefined;
   for (const signal of action.signals) {
-    if (signal.name === 'navigation' && signal.isAsync)
-      waitForNavigation = signal;
-    else if (signal.name === 'navigation' && !signal.isAsync)
-      assertNavigation = signal;
-    else if (signal.name === 'popup') popup = signal;
+    if (signal.name === 'popup') popup = signal;
     else if (signal.name === 'download') download = signal;
     else if (signal.name === 'dialog') dialog = signal;
   }
   return {
-    waitForNavigation,
-    assertNavigation,
     popup,
     download,
     dialog,
@@ -280,8 +272,7 @@ export class SyntheticsGenerator extends JavaScriptLanguageGenerator {
     if (isAssert && action.command) {
       formatter.add(toAssertCall(pageAlias, action));
     } else {
-      const actionCall = super._generateActionCall(action);
-      formatter.add(`await ${subject}.${actionCall};`);
+      formatter.add(super._generateActionCall(subject, action));
     }
 
     if (signals.popup)

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

@@ -63,7 +63,23 @@ export type {
 export type { default as Runner } from './core/runner';
 export type { Reporter, ReporterOptions } from './reporters';
 
-export type { SyntheticsConfig } from './common_types';
+export type {
+  SyntheticsConfig,
+  StepEndResult,
+  JourneyEndResult,
+  JourneyStartResult,
+  JourneyResult,
+  StepResult,
+  StartEvent,
+} from './common_types';
+
+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.`
       );
     }
   }

package/src/push/request.ts

@@ -47,6 +47,7 @@ export async function sendRequest(options: APIRequestOptions) {
       'content-type': 'application/json',
       'user-agent': `Elastic/Synthetics ${version}`,
       'kbn-xsrf': 'true',
+      'x-elastic-internal-origin': 'elastic-synthetics',
     },
     // align with the default timeout of the kibana route
     headersTimeout: 2 * 60 * 1000,

package/src/reporters/base.ts

@@ -35,7 +35,7 @@ import {
 } from '../common_types';
 import { Journey, Step } from '../dsl';
 
-function renderDuration(durationMs) {
+export function renderDuration(durationMs) {
   return parseInt(durationMs);
 }
 

package/src/reporters/build_kite_cli.ts

@@ -0,0 +1,111 @@
+/**
+ * MIT License
+ *
+ * Copyright (c) 2020-present, Elastic NV
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ *
+ */
+
+import { red, green, cyan } from 'kleur/colors';
+import { ReporterOptions } from '.';
+
+import BaseReporter, { renderDuration } from './base';
+import { indent, now, symbols } from '../helpers';
+import {
+  JourneyEndResult,
+  JourneyStartResult,
+  StepEndResult,
+} from '../common_types';
+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();
+
+  constructor(options: ReporterOptions = {}) {
+    super(options);
+  }
+
+  override onJourneyStart(journey: Journey, {}: JourneyStartResult) {
+    this.write(`\n--- Journey: ${journey.name}`);
+  }
+
+  override onStepEnd(journey: Journey, step: Step, result: StepEndResult) {
+    super.onStepEnd(journey, step, result);
+    if (!this.journeys.has(journey.name)) {
+      this.journeys.set(journey.name, []);
+    }
+    this.journeys.get(journey.name)?.push({ name: step.name, ...result });
+  }
+
+  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)`;
+    this.write(message);
+  }
+
+  override onEnd() {
+    const { failed, succeeded, skipped } = this.metrics;
+    const total = failed + succeeded + skipped;
+
+    if (total > 0) {
+      const failedJourneys = Array.from(this.journeys.entries()).filter(
+        ([, steps]) => steps.some(step => step.status === 'failed')
+      );
+
+      // if more than 5 journeys, we also report failed journeys at the end
+      if (failedJourneys.length > 0 && this.journeys.size > 5) {
+        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)`;
+            this.write(indent(message));
+            if (error) {
+              this.write(renderError(serializeError(error)));
+            }
+          });
+        });
+      }
+    }
+
+    let message = '\n';
+    if (total === 0) {
+      message = 'No tests found!';
+      message += ` (${renderDuration(now())} ms) \n`;
+      this.write(message);
+      return;
+    }
+
+    message += succeeded > 0 ? green(` ${succeeded} passed`) : '';
+    message += failed > 0 ? red(` ${failed} failed`) : '';
+    message += skipped > 0 ? cyan(` ${skipped} skipped`) : '';
+    message += ` (${renderDuration(now() / 1000)} seconds) \n`;
+    this.write(message);
+  }
+}

package/src/reporters/index.ts

@@ -33,13 +33,18 @@ import {
   JourneyStartResult,
   StepEndResult,
 } from '../common_types';
+import BuildKiteCLIReporter from './build_kite_cli';
 
 export type ReporterOptions = {
   fd?: number;
   colors?: boolean;
   dryRun?: boolean;
 };
-export type BuiltInReporterName = 'default' | 'json' | 'junit';
+export type BuiltInReporterName =
+  | 'default'
+  | 'json'
+  | 'junit'
+  | 'buildkite-cli';
 export type ReporterInstance = new (opts: ReporterOptions) => Reporter;
 export const reporters: {
   [key in BuiltInReporterName]: ReporterInstance;
@@ -47,6 +52,7 @@ export const reporters: {
   default: BaseReporter,
   json: JSONReporter,
   junit: JUnitReporter,
+  'buildkite-cli': BuildKiteCLIReporter,
 };
 
 export interface Reporter {