@aikidosec/ci-api-client/src/output.ts

CLI api client to easily integrate the Aikido public CI API into custom deploy scripts

import ora, { Ora } from 'ora';
import { program } from './index.js';
import { AxiosError } from 'axios';
import chalk from 'chalk';

// Output a console message
export const outputLog = (message: string): void => {
  if (!process.env.QUIET) {
    console.log(message);
  }
};

// Output some message, var, .. if --debug was provided
export const outputDebug = (variable: any): void => {
  if (process.env.CLI_DEBUG == true || process.env.CLI_DEBUG == 'true') {
    console.log(
      chalk.blue(
        typeof variable == 'object' ? JSON.stringify(variable) : variable
      )
    );
  }
};

// Output an error message
// Error output should not take into account the global "quiet" option
export const outputError = (message: string, exitCode: number = 1): void => {
  program.error(message, {
    exitCode,
  });
};

export const outputHttpError = (axiosError: AxiosError): void => {
  outputDebug(axiosError);

  if (axiosError.isAxiosError) {
    if (axiosError.response) {
      const statusStr = `${axiosError.response.status} ${axiosError.response.statusText}`;
      switch (axiosError.response.status) {
        case 401:
          return outputError(
            `${statusStr}: The provided api key is most likely no longer valid and has been rotated or revoked. Visit https://app.aikido.dev/settings/integrations/continuous-integration to generate a new key.`
          );
        case 403:
          return outputError(
            `${statusStr}: Could not authenticate with the Aikido API. Please verify your Aikdio API key.`
          );
        case 500:
          return outputError(
            `${statusStr}: Something went wrong contacting the Aikido API. Please try again later.`
          );
        default:
          return outputError(
            `${statusStr}: ${
              axiosError.response.data ?? ''
            } Please contact us if this problem persists.`
          );
      }
    }

    return outputError(`${axiosError.name}: ${axiosError.message}`);
  }

  return outputError(
    'Unexpected error occurred. Please contact us if this problem persists.'
  );
};

// Start a new spinner
// The result of this function can be null if the global "quiet" option
// was set. Spinners should always be treated as optionals
// (e.g. mySpinner?.stop())
export const startSpinner = (message: string): Ora | null => {
  if (process.env.QUIET) {
    return null;
  }

  const spinner = ora(message);
  spinner.color = 'magenta';
  spinner.start();

  return spinner;
};