@elastic/synthetics/src/locations/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 { sendReqAndHandleError } from '../push/request';
import { indent, write } from '../helpers';
import { generateURL } from '../push/utils';

export type LocationCmdOptions = {
  auth: string;
  url: string;
};

type LocationMetadata = {
  id: string;
  label: string;
  isServiceManaged: boolean;
};

export type LocationAPIResponse = {
  locations: Array<LocationMetadata>;
};

export const PRIVATE_KEYWORD = '(private)';

export async function getLocations(options: LocationCmdOptions) {
  const resp = await sendReqAndHandleError<LocationAPIResponse>({
    url: generateURL(options, 'location'),
    method: 'GET',
    auth: options.auth,
  });
  return resp.locations;
}

export function formatLocations(locations: Array<LocationMetadata>) {
  const publicLocations: Array<string> = [];
  const privateLocations: Array<string> = [];
  for (const location of locations) {
    let name = location.label;
    if (location.isServiceManaged) {
      [, name] = name.includes('-') ? name.split('-') : [, name];
      name = name.toLowerCase().trim().split(' ').join('_');
      publicLocations.push(name);
    } else {
      privateLocations.push(name);
    }
  }

  return {
    publicLocations,
    privateLocations,
    allLocations: publicLocations.concat(
      privateLocations.map(loc => `${loc} ${PRIVATE_KEYWORD}`)
    ),
  };
}

export function groupLocations(locations: Array<string>) {
  const grouped = { locations: [], privateLocations: [] };
  for (const loc of locations) {
    if (loc.includes(PRIVATE_KEYWORD)) {
      grouped.privateLocations.push(loc.replace(PRIVATE_KEYWORD, '').trim());
    } else {
      grouped.locations.push(loc);
    }
  }
  return grouped;
}

export function renderLocations({
  publicLocations,
  privateLocations = [],
}: {
  privateLocations?: Array<string>;
  publicLocations: Array<string>;
}) {
  let outer = '';
  if (publicLocations.length) {
    outer = 'Public locations: \n';
    let inner = '';
    for (const location of publicLocations) {
      inner += `* ${location}\n`;
    }
    outer += indent(inner);
  }
  if (privateLocations.length > 0) {
    outer += '\nPrivate locations: \n';
    let privateInner = '';
    for (const location of privateLocations) {
      privateInner += `* ${location}\n`;
    }
    outer += indent(privateInner);
  }
  outer += `\nSet default location for monitors via
  - Synthetics config file 'monitors.locations' | 'monitors.privateLocations' field
  - Monitor API 'monitor.use({ locations: ["japan"], privateLocations: ["custom-location"] }')`;

  write(outer);
}