@elastic/synthetics 1.0.0-beta.8 → 1.0.0

package/src/push/utils.ts

@@ -0,0 +1,77 @@
+/**
+ * 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 { progress, removeTrailingSlash } from '../helpers';
+import { green, red, grey, yellow } from 'kleur/colors';
+import { PushOptions } from '../common_types';
+
+export function logDiff<T extends Set<string>>(
+  newIDs: T,
+  changedIDs: T,
+  removedIDs: T,
+  unchangedIDs: T
+) {
+  progress(
+    'Monitor Diff: ' +
+      green(`Added(${newIDs.size}) `) +
+      yellow(`Updated(${changedIDs.size}) `) +
+      red(`Removed(${removedIDs.size}) `) +
+      grey(`Unchanged(${unchangedIDs.size})`)
+  );
+}
+
+export function getChunks(arr: any[], size: number) {
+  const chunks = [];
+  for (let i = 0; i < arr.length; i += size) {
+    chunks.push(arr.slice(i, i + size));
+  }
+  return chunks;
+}
+
+type Operation =
+  | 'status'
+  | 'bulk_get'
+  | 'bulk_update'
+  | 'bulk_delete'
+  | 'legacy'
+  | 'location';
+
+export function generateURL(options: PushOptions, operation: Operation) {
+  const url = removeTrailingSlash(options.url);
+  switch (operation) {
+    case 'status':
+      return `${url}/s/${options.space}/api/status`;
+    case 'bulk_get':
+    case 'bulk_update':
+    case 'bulk_delete':
+      return `${url}/s/${options.space}/api/synthetics/project/${options.id}/monitors`;
+    case 'legacy':
+      return `${url}/s/${options.space}/api/synthetics/service/project/monitors`;
+    case 'location':
+      return `${url}/internal/uptime/service/locations`;
+    default:
+      throw new Error('Invalid operation');
+  }
+}

package/src/reporters/base.ts

@@ -25,7 +25,6 @@
 
 import SonicBoom from 'sonic-boom';
 import { green, red, cyan } from 'kleur/colors';
-import Runner from '../core/runner';
 import {
   symbols,
   indent,
@@ -33,7 +32,13 @@ import {
   findPWLogsIndexes,
   rewriteErrorStack,
 } from '../helpers';
-import { ReporterOptions } from './reporter';
+import { Reporter, ReporterOptions } from '.';
+import {
+  JourneyEndResult,
+  JourneyStartResult,
+  StepEndResult,
+} from '../common_types';
+import { Journey, Step } from '../dsl';
 
 function renderError(error) {
   let output = '';
@@ -58,68 +63,74 @@ function renderDuration(durationMs) {
   return parseInt(durationMs);
 }
 
-export default class BaseReporter {
+export default class BaseReporter implements Reporter {
   stream: SonicBoom;
   fd: number;
+  metrics = {
+    succeeded: 0,
+    failed: 0,
+    skipped: 0,
+  };
 
-  constructor(public runner: Runner, options: ReporterOptions = {}) {
+  constructor(options: ReporterOptions = {}) {
     this.fd = options.fd || process.stdout.fd;
-    this.stream = new SonicBoom({ fd: this.fd, sync: true });
-    this._registerListeners();
-    this.runner.on('end', () => this.stream.flush());
+    /**
+     * minLength is set to 1 byte to make sure we flush the
+     * content even if its the last byte on the stream buffer
+     * before destroying the pipe with underlying file descriptor
+     */
+    this.stream = new SonicBoom({ fd: this.fd, sync: true, minLength: 1 });
   }
 
-  _registerListeners() {
-    const result = {
-      succeeded: 0,
-      failed: 0,
-      skipped: 0,
-    };
-
-    this.runner.on('journey:start', ({ journey }) => {
-      this.write(`\nJourney: ${journey.name}`);
-    });
-
-    this.runner.on('step:end', ({ step, start, end, error, status }) => {
-      const message = `${symbols[status]}  Step: '${
-        step.name
-      }' ${status} (${renderDuration((end - start) * 1000)} ms)`;
-      this.write(indent(message));
-      error && this.write(renderError(error));
-      result[status]++;
-    });
-
-    this.runner.on('journey:end', ({ error }) => {
-      const { failed, succeeded, skipped } = result;
-      const total = failed + succeeded + skipped;
+  onJourneyStart(journey: Journey, {}: JourneyStartResult) {
+    this.write(`\nJourney: ${journey.name}`);
+  }
 
-      /**
-       * Render the error on the terminal only when no steps could
-       * be executed which means the error happened in one of the hooks
-       */
-      if (total === 0 && error) {
-        this.write(renderError(error));
-      }
-    });
+  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)`;
+    this.write(indent(message));
+    error && this.write(renderError(error));
+    this.metrics[status]++;
+  }
 
-    this.runner.on('end', () => {
-      const { failed, succeeded, skipped } = result;
-      const total = failed + succeeded + skipped;
+  /* eslint-disable @typescript-eslint/no-unused-vars */
+  onJourneyEnd(_: Journey, { error }: JourneyEndResult) {
+    const { failed, succeeded, skipped } = this.metrics;
+    const total = failed + succeeded + skipped;
+    /**
+     * Render the error on the terminal only when no steps could
+     * be executed which means the error happened in one of the hooks
+     */
+    if (total === 0 && error) {
+      this.write(renderError(error));
+    }
+  }
 
-      let message = '\n';
-      if (total === 0) {
-        message = 'No tests found!';
-        message += ` (${renderDuration(now())} ms) \n`;
-        this.write(message);
-        return;
-      }
+  onEnd() {
+    const { failed, succeeded, skipped } = this.metrics;
+    const total = failed + succeeded + skipped;
 
-      message += succeeded > 0 ? green(` ${succeeded} passed`) : '';
-      message += failed > 0 ? red(` ${failed} failed`) : '';
-      message += skipped > 0 ? cyan(` ${skipped} skipped`) : '';
+    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())} ms) \n`;
+    this.write(message);
+
+    // flushSync is used here to make sure all the data from the underlying
+    // SonicBoom stream buffer is completely written to the fd before closing
+    // the process
+    this.stream.flushSync();
   }
 
   write(message) {

package/src/reporters/index.ts

@@ -26,11 +26,34 @@
 import BaseReporter from './base';
 import JSONReporter from './json';
 import JUnitReporter from './junit';
-import Reporter, { ReporterOptions } from './reporter';
+import { Journey, Step } from '../dsl';
+import {
+  StartEvent,
+  JourneyEndResult,
+  JourneyStartResult,
+  StepEndResult,
+} from '../common_types';
 
-export { Reporter, ReporterOptions };
-export const reporters = {
+export type ReporterOptions = { fd?: number; colors?: boolean };
+export type BuiltInReporterName = 'default' | 'json' | 'junit';
+export type ReporterInstance = new (opts: ReporterOptions) => Reporter;
+export const reporters: {
+  [key in BuiltInReporterName]: ReporterInstance;
+} = {
   default: BaseReporter,
   json: JSONReporter,
   junit: JUnitReporter,
 };
+
+export interface Reporter {
+  onStart?(params: StartEvent): void;
+  onJourneyRegister?(journey: Journey): void;
+  onJourneyStart?(journey: Journey, result: JourneyStartResult): void;
+  onStepStart?(journey: Journey, step: Step): void;
+  onStepEnd?(journey: Journey, step: Step, result: StepEndResult): void;
+  onJourneyEnd?(
+    journey: Journey,
+    result: JourneyEndResult
+  ): void | Promise<void>;
+  onEnd?(): void | Promise<void>;
+}