clever-tools 4.5.1 → 4.6.0

package/src/models/configuration.js

@@ -1,140 +0,0 @@
-import { promises as fs } from 'node:fs';
-import path from 'node:path';
-import xdg from 'xdg';
-import { Logger } from '../logger.js';
-
-const CONFIG_FILES = {
-  MAIN: 'clever-tools.json',
-  IDS_CACHE: 'ids-cache.json',
-  EXPERIMENTAL_FEATURES_FILE: 'clever-tools-experimental-features.json',
-};
-
-function getConfigDir() {
-  return process.platform === 'win32'
-    ? path.resolve(process.env.APPDATA, 'clever-cloud')
-    : xdg.basedir.configPath('clever-cloud');
-}
-
-function getConfigPath(configFile) {
-  return path.resolve(getConfigDir(), configFile);
-}
-
-// Every function which need 'clever-cloud' directory, need to call it before
-async function ensureConfigDirExists() {
-  await fs.mkdir(getConfigDir(), { mode: 0o700, recursive: true });
-}
-
-export async function loadOAuthConf() {
-  Logger.debug('Load configuration from environment variables');
-  if (process.env.CLEVER_TOKEN != null && process.env.CLEVER_SECRET != null) {
-    return {
-      source: 'environment variables',
-      token: process.env.CLEVER_TOKEN,
-      secret: process.env.CLEVER_SECRET,
-    };
-  }
-  Logger.debug('Load configuration from ' + conf.CONFIGURATION_FILE);
-  try {
-    const rawFile = await fs.readFile(conf.CONFIGURATION_FILE);
-    const { token, secret } = JSON.parse(rawFile);
-    return {
-      source: 'configuration file',
-      token,
-      secret,
-    };
-  } catch (error) {
-    Logger.info(`Cannot load configuration from ${conf.CONFIGURATION_FILE}\n${error.message}`);
-    return {
-      source: 'none',
-    };
-  }
-}
-
-export async function writeOAuthConf(oauthData) {
-  Logger.debug('Write the tokens in the configuration file…');
-  try {
-    await ensureConfigDirExists();
-    await fs.writeFile(conf.CONFIGURATION_FILE, JSON.stringify(oauthData));
-  } catch (error) {
-    throw new Error(`Cannot write configuration to ${conf.CONFIGURATION_FILE}\n${error.message}`);
-  }
-}
-
-export async function loadIdsCache() {
-  const cachePath = getConfigPath(CONFIG_FILES.IDS_CACHE);
-  try {
-    const rawFile = await fs.readFile(cachePath);
-    return JSON.parse(rawFile);
-  } catch (error) {
-    Logger.info(`Cannot load IDs cache from ${cachePath}\n${error.message}`);
-    return {
-      owners: {},
-      addons: {},
-    };
-  }
-}
-
-export async function writeIdsCache(ids) {
-  const cachePath = getConfigPath(CONFIG_FILES.IDS_CACHE);
-  const idsJson = JSON.stringify(ids);
-  try {
-    await ensureConfigDirExists();
-    await fs.writeFile(cachePath, idsJson);
-  } catch (error) {
-    throw new Error(`Cannot write IDs cache to ${cachePath}\n${error.message}`);
-  }
-}
-
-export async function getFeatures() {
-  Logger.debug('Get features configuration from ' + conf.EXPERIMENTAL_FEATURES_FILE);
-  try {
-    const rawFile = await fs.readFile(conf.EXPERIMENTAL_FEATURES_FILE);
-    return JSON.parse(rawFile);
-  } catch (error) {
-    if (error.code !== 'ENOENT') {
-      throw new Error(`Cannot get experimental features configuration from ${conf.EXPERIMENTAL_FEATURES_FILE}`);
-    }
-    return {};
-  }
-}
-
-export async function setFeature(feature, value) {
-  const currentFeatures = await getFeatures();
-  const newFeatures = { ...currentFeatures, ...{ [feature]: value } };
-
-  try {
-    await ensureConfigDirExists();
-    await fs.writeFile(conf.EXPERIMENTAL_FEATURES_FILE, JSON.stringify(newFeatures, null, 2));
-  } catch {
-    throw new Error(`Cannot write experimental features configuration to ${conf.EXPERIMENTAL_FEATURES_FILE}`);
-  }
-}
-
-const defaultConf = {
-  API_HOST: 'https://api.clever-cloud.com',
-  AUTH_BRIDGE_HOST: 'https://api-bridge.clever-cloud.com',
-  SSH_GATEWAY: 'ssh@sshgateway-clevercloud-customers.services.clever-cloud.com',
-
-  // the disclosure of these tokens is not considered as a vulnerability. Do not report this to our security service.
-  OAUTH_CONSUMER_KEY: 'T5nFjKeHH4AIlEveuGhB5S3xg8T19e',
-  OAUTH_CONSUMER_SECRET: 'MgVMqTr6fWlf2M0tkC2MXOnhfqBWDT',
-
-  APP_CONFIGURATION_FILE: path.resolve('.', '.clever.json'),
-  CONFIGURATION_FILE: getConfigPath(CONFIG_FILES.MAIN),
-  EXPERIMENTAL_FEATURES_FILE: getConfigPath(CONFIG_FILES.EXPERIMENTAL_FEATURES_FILE),
-
-  API_DOC_URL: 'https://www.clever.cloud/developers/api',
-  DOC_URL: 'https://www.clever.cloud/developers/doc',
-  CONSOLE_URL: 'https://console.clever-cloud.com',
-  CONSOLE_TOKEN_URL: 'https://console.clever-cloud.com/cli-oauth',
-  GOTO_URL: 'https://console.clever-cloud.com/goto',
-};
-
-export const conf = Object.fromEntries(
-  Object.entries(defaultConf).map(([name, value]) => {
-    if (process.env[name] != null) {
-      return [name, process.env[name]];
-    }
-    return [name, value];
-  }),
-);

package/src/models/log-v4.js

@@ -1,189 +0,0 @@
-import { ApplicationLogStream } from '@clevercloud/client/esm/streams/application-logs.js';
-import { styleText } from '../lib/style-text.js';
-import { Logger } from '../logger.js';
-import { conf } from './configuration.js';
-import { waitForDeploymentEnd, waitForDeploymentStart } from './deployments.js';
-import { getBest } from './domain.js';
-import * as ExitStrategy from './exit-strategy-option.js';
-import { JsonArray } from './json-array.js';
-import { getHostAndTokens, processError } from './send-to-api.js';
-import { Deferred } from './utils.js';
-
-const RESET_COLOR = '\x1B[0m';
-
-// 2000 logs per 100ms maximum
-const THROTTLE_ELEMENTS = 2000;
-const THROTTLE_PER_IN_MILLISECONDS = 100;
-
-const retryConfiguration = {
-  enabled: true,
-  initRetryTimeout: 3000,
-  maxRetryCount: 10,
-};
-
-export async function displayLogs(params) {
-  const deferred = params.deferred || new Deferred();
-  const { apiHost, tokens } = await getHostAndTokens();
-  const { ownerId, appId, filter, since, until, deploymentId, format } = params;
-
-  if (format === 'json' && until == null) {
-    throw new Error('"json" format is only applicable with a limiting parameter such as `--until`');
-  }
-
-  const logStream = new ApplicationLogStream({
-    apiHost,
-    tokens,
-    ownerId,
-    appId,
-    connectionTimeout: 10_000,
-    retryConfiguration,
-    since,
-    until,
-    deploymentId,
-    filter,
-    throttleElements: THROTTLE_ELEMENTS,
-    throttlePerInMilliseconds: THROTTLE_PER_IN_MILLISECONDS,
-  });
-
-  // Properly close the stream
-  process.once('SIGINT', (signal) => logStream.close(signal));
-  const jsonArray = new JsonArray();
-
-  logStream
-    .on('open', () => {
-      Logger.debug(styleText('blue', `Logs stream (open) ${JSON.stringify({ appId, filter, deploymentId })}`));
-      if (format === 'json') {
-        jsonArray.open();
-      }
-    })
-    .on('error', (event) => {
-      Logger.debug(styleText('red', `Logs stream (error) ${event.error.message}`));
-    })
-    .onLog((log) => {
-      switch (format) {
-        case 'json':
-          jsonArray.push(log);
-          return;
-        case 'json-stream':
-          Logger.println(JSON.stringify(log));
-          return;
-        case 'human':
-        default:
-          if (log.message === RESET_COLOR) {
-            return;
-          }
-          Logger.println(formatLogLine(log));
-      }
-    });
-
-  // start() is blocking until end of stream
-  logStream
-    .start()
-    .then(() => {
-      if (format === 'json') {
-        jsonArray.close();
-      }
-      return deferred.resolve();
-    })
-    .catch(processError)
-    .catch((error) => deferred.reject(error));
-
-  return logStream;
-}
-
-export async function watchDeploymentAndDisplayLogs(options) {
-  const { ownerId, appId, deploymentId, commitId, knownDeployments, quiet, redeployDate, exitStrategy } = options;
-
-  ExitStrategy.plotQuietWarning(exitStrategy, quiet);
-  // If in quiet mode, we only log start/finished deployment messages
-  if (!quiet) {
-    Logger.println(`   ${styleText('blue', '→ Waiting for deployment to start…')}`);
-  }
-  const deployment = await waitForDeploymentStart({ ownerId, appId, deploymentId, commitId, knownDeployments });
-  Logger.println(`   ${styleText('green', `✓ Deployment started ${styleText('grey', `(${deployment.uuid})`)}`)}`);
-
-  if (exitStrategy === 'deploy-start') {
-    return;
-  }
-
-  const deferred = new Deferred();
-  let logsStream;
-
-  if (!quiet) {
-    // About the deferred…
-    // If displayLogs() throws an error,
-    // the async function we're in (watchDeploymentAndDisplayLogs) will stop here and the error will be passed to the parent.
-    // displayLogs() defines callback listeners so if it catches error in those callbacks,
-    // it has no proper way to bubble up the error here.
-    // Using the deferred enables this.
-    logsStream = await displayLogs({ ownerId, appId, deploymentId: deployment.uuid, since: redeployDate, deferred });
-  }
-
-  if (!quiet) {
-    Logger.println(`   ${styleText('blue', '→ Waiting for application logs…')}`);
-  }
-
-  // Wait for deployment end (or an error thrown by logs with the deferred)
-  const deploymentEnded = await Promise.race([
-    waitForDeploymentEnd({ ownerId, appId, deploymentId: deployment.uuid }),
-    deferred.promise,
-  ]);
-
-  if (!quiet && exitStrategy !== 'never') {
-    logsStream.close(quiet ? 'quiet' : 'follow');
-  }
-
-  // deploymentEnded can be undefined if deferred resolved (e.g., stream closed via SIGINT)
-  if (deploymentEnded == null) {
-    return;
-  }
-
-  if (deploymentEnded.state === 'OK') {
-    Logger.println('');
-
-    // There can be applications without any domain, so we don't fail if we can't get one
-    const favouriteDomain = await getBest(appId, ownerId).catch(() => null);
-
-    if (favouriteDomain) {
-      Logger.println(
-        `${styleText(['bold', 'green'], '✓ Access your application:')} ${styleText(['underline', 'bold'], `https://${favouriteDomain.fqdn}`)}`,
-      );
-    }
-
-    Logger.println(
-      `${styleText(['bold', 'blue'], '→ Manage your application:')} ${styleText(['underline', 'bold'], `${conf.GOTO_URL}/${appId}`)}`,
-    );
-  } else if (deploymentEnded.state === 'CANCELLED') {
-    throw new Error('Deployment was cancelled. Please check the activity');
-  } else {
-    throw new Error('Deployment failed. Please check the logs');
-  }
-}
-
-function formatLogLine(log) {
-  const { date, message } = log;
-  if (isDeploymentSuccessMessage(log)) {
-    return `${date.toISOString()}: ${styleText(['bold', 'green'], message)}`;
-  } else if (isDeploymentFailedMessage(log)) {
-    return `${date.toISOString()}: ${styleText(['bold', 'red'], message)}`;
-  } else if (isBuildSucessMessage(log)) {
-    return `${date.toISOString()}: ${styleText(['bold', 'blue'], message)}`;
-  }
-  return `${date.toISOString()}: ${message}${RESET_COLOR}`;
-}
-
-function isCleverMessage(log) {
-  return log.service !== 'bas-deploy.service';
-}
-
-function isDeploymentSuccessMessage(log) {
-  return isCleverMessage(log) && log.message.toLowerCase().startsWith('successfully deployed in');
-}
-
-function isDeploymentFailedMessage(log) {
-  return isCleverMessage(log) && log.message.toLowerCase().startsWith('deploy failed in');
-}
-
-function isBuildSucessMessage(log) {
-  return isCleverMessage(log) && log.message.toLowerCase().startsWith('build succeeded in');
-}