@soundworks/core/src/common/logger.js

Open-source creative coding framework for distributed applications based on Web technologies

import chalk from 'chalk';

/**
 * @private
 */
const logger = {
  verbose: true,

  configure(verbose) {
    this.verbose = verbose;
  },

  title(msg) {
    if (!this.verbose) {
      return;
    }

    console.log(chalk.cyan(`+ ${msg}`));
  },

  log(msg) {
    if (!this.verbose) {
      return;
    }

    console.log(msg);
  },

  warn(msg) {
    if (!this.verbose) {
      return;
    }

    console.warn(chalk.yellow(msg));
  },

  error(msg) {
    if (!this.verbose) {
      return;
    }

    console.error(chalk.red(msg));
  },

  ip(protocol, address, port) {
    if (!this.verbose) {
      return;
    }

    console.log(`    ${protocol}://${address}:${chalk.green(port)}`);
  },

  pluginStart(name) {
    if (!this.verbose) {
      return;
    }

    console.log(`    ${name} ${chalk.yellow('start...')}`);
  },

  pluginStarted(name) {
    if (!this.verbose) {
      return;
    }

    console.log(`    ${name} ${chalk.cyan('started')}`);
  },

  pluginReady(name) {
    if (!this.verbose) {
      return;
    }

    console.log(`    ${name} ${chalk.green('ready')}`);
  },

  pluginErrored(name) {
    if (!this.verbose) {
      return;
    }

    console.log(`    ${name} ${chalk.red('errors')}`);
  },

  warnVersionDiscrepancies(clientRole, clientVersion, serverVersion) {
    console.warn(`
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!

WARNING

Version discrepancies between server and "${clientRole}" client:
+ server: ${serverVersion} | client: ${clientVersion}

This might lead to unexpected behavior, you should consider to re-install your
dependencies on both your server and clients.

!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!`);
  },

  deprecated(oldAPI, newAPI, lastSupportedVersion) {
    if (!lastSupportedVersion) {
      throw new Error(`Invalid 'logger.deprecated call: a deprecation version is required`);
    }

    const msg = `DEPRECATION WARNING: \`${oldAPI}\` is deprecated (last supported version: ${lastSupportedVersion}) and will be removed in the next major revision, please use ${newAPI} instead.\n`;
    console.warn(chalk.yellow(msg));
  },

  removed(oldAPI, hint, lastSupportedVersion) {
    if (!lastSupportedVersion) {
      throw new Error(`Invalid 'logger.deprecated call: a deprecation version is required`);
    }

    const msg = `[Removed API] ${oldAPI} has been removed (last supported version: ${lastSupportedVersion}), please use ${hint} instead.`;
    throw new Error(msg);
  },

  httpsCertsInfos(httpsCertsInfos) {
    if (!this.verbose) {
      return;
    }

    this.title(`https certificates infos`);

    if (httpsCertsInfos.selfSigned) {
      this.log(`    self-signed: ${httpsCertsInfos.selfSigned ? 'true' : 'false'}`);
      this.log(chalk.yellow`    > INVALID CERTIFICATE (self-signed)`);
    } else {
      this.log(`    valid from: ${httpsCertsInfos.validFrom}`);
      this.log(`    valid to:   ${httpsCertsInfos.validTo}`);

      if (!httpsCertsInfos.isValid) {
        this.error(chalk.red`    -------------------------------------------`);
        this.error(chalk.red`    > INVALID CERTIFICATE                      `);
        this.error(chalk.red`    i.e. you pretend to be safe but you are not`);
        this.error(chalk.red`    -------------------------------------------`);
      } else {
        if (httpsCertsInfos.daysRemaining < 5) {
          this.log(chalk.red`    > CERTIFICATE IS VALID... BUT ONLY ${httpsCertsInfos.daysRemaining} DAYS LEFT, PLEASE CONSIDER UPDATING YOUR CERTS!`);
        } else if (httpsCertsInfos.daysRemaining < 15) {
          this.log(chalk.yellow`    > CERTIFICATE IS VALID - only ${httpsCertsInfos.daysRemaining} days left, be careful...`);
        } else {
          this.log(chalk.green`    > CERTIFICATE IS VALID (${httpsCertsInfos.daysRemaining} days left)`);
        }
      }
    }
  },
};

export default logger;