@elastic/synthetics/src/core/index.ts

Elastic synthetic monitoring agent

/**
 * 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 {
  Journey,
  JourneyCallback,
  JourneyOptions,
  JourneyWithAnnotations,
  StepWithAnnotations,
} from '../dsl';
import { runner as runnerGlobal } from './globals';
import { VoidCallback, HooksCallback, Location } from '../common_types';
import { wrapFnWithLocation } from '../helpers';
import { log } from './logger';
import { MonitorConfig } from '../dsl/monitor';

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;
    }
  );

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) => {
    /**
     * If the context is inside journey, then set it to journey context
     * otherwise set to the global monitor which will be used for all journeys
     */
    if (runner.currentJourney) {
      runner.currentJourney._updateMonitor(config);
    } else {
      runner._updateMonitor(config);
    }
  }),
};

export const beforeAll = (callback: HooksCallback) => {
  runner._addHook('beforeAll', callback);
};

export const afterAll = (callback: HooksCallback) => {
  runner._addHook('afterAll', callback);
};

export const before = (callback: HooksCallback) => {
  if (!runner.currentJourney) {
    throw new Error('before is called outside of the journey context');
  }
  return runner.currentJourney._addHook('before', callback);
};

export const after = (callback: HooksCallback) => {
  if (!runner.currentJourney) {
    throw new Error('after is called outside of the journey context');
  }
  return runner.currentJourney._addHook('after', callback);
};

export const runner = runnerGlobal;