clever-tools 3.8.2 → 3.9.0

package/src/models/application_configuration.js

@@ -1,9 +1,7 @@
-'use strict';
+import cliparse from 'cliparse';
+import colors from 'colors/safe.js';
 
-const cliparse = require('cliparse');
-const colors = require('colors/safe');
-
-const Logger = require('../logger.js');
+import { Logger } from '../logger.js';
 
 const CONFIG_KEYS = [
   { id: 'name', name: 'name', displayName: 'Name', kind: 'string' },
@@ -14,11 +12,11 @@ const CONFIG_KEYS = [
   { id: 'force-https', name: 'forceHttps', displayName: 'Force redirection of HTTP to HTTPS', kind: 'force-https' },
 ];
 
-function listAvailableIds () {
+export function listAvailableIds () {
   return CONFIG_KEYS.map((config) => config.id);
 }
 
-function getById (id) {
+export function getById (id) {
   const config = CONFIG_KEYS.find((config) => config.id === id);
   if (config == null) {
     Logger.error(`Invalid configuration name: ${id}.`);
@@ -44,7 +42,7 @@ function display (config, value) {
   }
 }
 
-function parse (config, value) {
+export function parse (config, value) {
   switch (config.kind) {
     case 'bool': {
       return (value !== 'false');
@@ -61,7 +59,7 @@ function parse (config, value) {
   }
 }
 
-function getUpdateOptions () {
+export function getUpdateOptions () {
   return CONFIG_KEYS
     .map((config) => getConfigOptions(config))
     .reduce((a, b) => [...a, ...b], []);
@@ -85,7 +83,7 @@ function getConfigOptions (config) {
   }
 }
 
-function parseOptions (options) {
+export function parseOptions (options) {
   const newOptions = CONFIG_KEYS
     .map((config) => parseConfigOption(config, options))
     .filter((a) => a != null);
@@ -143,22 +141,20 @@ function printConfig (app, config) {
   }
 }
 
-function printById (app, id) {
+export function printById (app, id) {
   const config = getById(id);
   if (config != null) {
     printConfig(app, config);
   }
 }
 
-function printByName (app, name) {
+export function printByName (app, name) {
   const config = CONFIG_KEYS.find((config) => config.name === name);
   printConfig(app, config);
 }
 
-function print (app) {
+export function print (app) {
   for (const config of CONFIG_KEYS) {
     printConfig(app, config);
   }
 }
-
-module.exports = { listAvailableIds, getById, getUpdateOptions, parse, parseOptions, printById, printByName, print };

package/src/models/configuration.js

@@ -1,13 +1,11 @@
-'use strict';
+import { promises as fs } from 'node:fs';
+import path from 'node:path';
 
-const { promises: fs } = require('fs');
-const path = require('path');
+import commonEnv from 'common-env';
+import mkdirp from 'mkdirp';
+import xdg from 'xdg';
 
-const commonEnv = require('common-env');
-const mkdirp = require('mkdirp');
-const xdg = require('xdg');
-
-const Logger = require('../logger.js');
+import { Logger } from '../logger.js';
 const env = commonEnv(Logger);
 
 const CONFIG_FILES = {
@@ -22,7 +20,7 @@ function getConfigPath (configFile) {
   return path.resolve(configDir, configFile);
 }
 
-async function loadOAuthConf () {
+export async function loadOAuthConf () {
   Logger.debug('Load configuration from environment variables');
   if (process.env.CLEVER_TOKEN != null && process.env.CLEVER_SECRET != null) {
     return {
@@ -49,7 +47,7 @@ async function loadOAuthConf () {
   }
 }
 
-async function writeOAuthConf (oauthData) {
+export async function writeOAuthConf (oauthData) {
   Logger.debug('Write the tokens in the configuration file…');
   const configDir = path.dirname(conf.CONFIGURATION_FILE);
   try {
@@ -61,7 +59,7 @@ async function writeOAuthConf (oauthData) {
   }
 }
 
-async function loadIdsCache () {
+export async function loadIdsCache () {
   const cachePath = getConfigPath(CONFIG_FILES.IDS_CACHE);
   try {
     const rawFile = await fs.readFile(cachePath);
@@ -76,7 +74,7 @@ async function loadIdsCache () {
   }
 }
 
-async function writeIdsCache (ids) {
+export async function writeIdsCache (ids) {
   const cachePath = getConfigPath(CONFIG_FILES.IDS_CACHE);
   const idsJson = JSON.stringify(ids);
   try {
@@ -87,7 +85,7 @@ async function writeIdsCache (ids) {
   }
 }
 
-const conf = env.getOrElseAll({
+export const conf = env.getOrElseAll({
   API_HOST: 'https://api.clever-cloud.com',
   // API_HOST: 'https://ccapi-preprod.cleverapps.io',
   LOG_WS_URL: 'wss://api.clever-cloud.com/v2/logs/logs-socket/<%- appId %>?since=<%- timestamp %>',
@@ -106,5 +104,3 @@ const conf = env.getOrElseAll({
   CLEVER_CONFIGURATION_DIR: path.resolve('.', 'clevercloud'),
   APP_CONFIGURATION_FILE: path.resolve('.', '.clever.json'),
 });
-
-module.exports = { conf, loadOAuthConf, writeOAuthConf, loadIdsCache, writeIdsCache };

package/src/models/deployments.js

@@ -1,18 +1,16 @@
-'use strict';
+import { promisify } from 'node:util';
+import { Logger } from '../logger.js';
+import { getDeployment, getAllDeployments } from '@clevercloud/client/esm/api/v2/application.js';
+import { sendToApi } from './send-to-api.js';
 
-const { promisify } = require('util');
 const delay = promisify(setTimeout);
 
-const Logger = require('../logger.js');
-const { getDeployment, getAllDeployments } = require('@clevercloud/client/cjs/api/v2/application.js');
-const { sendToApi } = require('./send-to-api.js');
-
 const DEPLOYMENT_POLLING_DELAY = 5000;
 const BACKOFF_FACTOR = 1.25;
 const INIT_RETRY_TIMEOUT = 1500;
 const MAX_RETRY_COUNT = 5;
 
-async function waitForDeploymentStart ({ ownerId, appId, deploymentId, commitId, knownDeployments }) {
+export async function waitForDeploymentStart ({ ownerId, appId, deploymentId, commitId, knownDeployments }) {
 
   return waitFor(async () => {
     try {
@@ -45,7 +43,7 @@ async function waitForDeploymentStart ({ ownerId, appId, deploymentId, commitId,
   });
 }
 
-async function waitForDeploymentEnd ({ ownerId, appId, deploymentId }) {
+export async function waitForDeploymentEnd ({ ownerId, appId, deploymentId }) {
   return waitFor(async () => {
     try {
       const deployment = await getDeployment({ id: ownerId, appId, deploymentId }).then(sendToApi);
@@ -103,5 +101,3 @@ async function waitFor (fetchResult) {
     }
   }
 }
-
-module.exports = { waitForDeploymentStart, waitForDeploymentEnd };

package/src/models/domain.js

@@ -1,12 +1,10 @@
-'use strict';
+import _ from 'lodash';
 
-const _ = require('lodash');
+import { Logger } from '../logger.js';
+import { getAllDomains, getFavouriteDomain } from '@clevercloud/client/esm/api/v2/application.js';
+import { sendToApi } from '../models/send-to-api.js';
 
-const Logger = require('../logger.js');
-const { getAllDomains, getFavouriteDomain } = require('@clevercloud/client/cjs/api/v2/application.js');
-const { sendToApi } = require('../models/send-to-api.js');
-
-async function getBest (appId, orgaId) {
+export async function getBest (appId, orgaId) {
   Logger.debug('Trying to get the favourite vhost for ' + appId);
   return getFavouriteDomain({ id: orgaId, appId }).then(sendToApi)
     .catch(async (e) => {
@@ -27,7 +25,7 @@ async function getBest (appId, orgaId) {
     });
 }
 
-function selectBest (vhosts) {
+export function selectBest (vhosts) {
   const customVhost = _.find(vhosts, (vhost) => {
     return !vhost.fqdn.endsWith('.cleverapps.io');
   });
@@ -36,5 +34,3 @@ function selectBest (vhosts) {
   });
   return customVhost || withoutDefaultDomain || vhosts[0];
 }
-
-module.exports = { getBest, selectBest };

package/src/models/drain.js

@@ -1,6 +1,4 @@
-'use strict';
-
-const autocomplete = require('cliparse').autocomplete;
+import cliparse from 'cliparse';
 
 const DRAIN_TYPES = [
   { id: 'TCPSyslog', structuredDataParameters: 'OPTIONAL' },
@@ -11,7 +9,7 @@ const DRAIN_TYPES = [
   { id: 'NewRelicHTTP', apiKey: 'MANDATORY' },
 ];
 
-function createDrainBody (appId, drainTargetURL, drainTargetType, drainTargetCredentials, drainTargetConfig) {
+export function createDrainBody (appId, drainTargetURL, drainTargetType, drainTargetCredentials, drainTargetConfig) {
 
   if (!authorizeDrainCreation(drainTargetType, drainTargetCredentials, drainTargetConfig)) {
     throw new Error("Credentials are: optional for HTTP, mandatory for ElasticSearch, NewRelicHTTP and TCPSyslog/UDPSyslog don't need them.");
@@ -39,7 +37,7 @@ function createDrainBody (appId, drainTargetURL, drainTargetType, drainTargetCre
   return body;
 }
 
-function authorizeDrainCreation (drainTargetType, drainTargetCredentials, drainTargetConfig) {
+export function authorizeDrainCreation (drainTargetType, drainTargetCredentials, drainTargetConfig) {
   if (drainTypeExists(drainTargetType)) {
     // retrieve field for drain type ('mandatory', 'optional', undefined)
     const credStatus = fieldStatus(drainTargetType).credentials;
@@ -129,12 +127,6 @@ function keyEmpty ({ apiKey }) {
   return apiKey == null;
 }
 
-function listDrainTypes () {
-  return autocomplete.words(DRAIN_TYPES.map((type) => type.id));
+export function listDrainTypes () {
+  return cliparse.autocomplete.words(DRAIN_TYPES.map((type) => type.id));
 }
-
-module.exports = {
-  createDrainBody,
-  authorizeDrainCreation,
-  listDrainTypes,
-};

package/src/models/exit-strategy-option.js

@@ -1,9 +1,7 @@
-'use strict';
+import colors from 'colors/safe.js';
+import { Logger } from '../logger.js';
 
-const colors = require('colors/safe');
-const Logger = require('../logger.js');
-
-function get (follow, exitOnDeploy) {
+export function get (follow, exitOnDeploy) {
   if (follow) {
     if (exitOnDeploy === 'deploy-start') {
       throw new Error('The `follow` and `exit-on` set to "deploy-start" options are not compatible');
@@ -15,10 +13,8 @@ function get (follow, exitOnDeploy) {
 }
 
 // plotQuietWarning: If in quiet mode and exitStrategy set to never plot a warning to indicate that the command will end
-function plotQuietWarning (exitStrategy, quiet) {
+export function plotQuietWarning (exitStrategy, quiet) {
   if (exitStrategy === 'never' && quiet) {
     Logger.println(colors.bold.yellow('The "never" exit-on strategy is not compatible with the "quiet" mode, it will exit once the deployment ends'));
   }
 }
-
-module.exports = { get, plotQuietWarning };

package/src/models/fs-utils.js

@@ -1,9 +1,7 @@
-'use strict';
+import { join } from 'node:path';
+import { promises as fs } from 'node:fs';
 
-const { join } = require('path');
-const { promises: fs } = require('fs');
-
-function findPath (dir, name) {
+export function findPath (dir, name) {
   const fullPath = join(dir, name);
   return fs.stat(fullPath)
     .then(() => dir)
@@ -15,5 +13,3 @@ function findPath (dir, name) {
       throw e;
     });
 }
-
-module.exports = { findPath };

package/src/models/git.js

@@ -1,16 +1,13 @@
-'use strict';
+import fs from 'node:fs';
+import path from 'node:path';
 
-const fs = require('fs');
-const path = require('path');
-
-const _ = require('lodash');
-const git = require('isomorphic-git');
-const http = require('./isomorphic-http-with-agent.js');
-const { autocomplete } = require('cliparse');
-
-const slugify = require('slugify');
-const { findPath } = require('./fs-utils.js');
-const { loadOAuthConf } = require('./configuration.js');
+import _ from 'lodash';
+import git from 'isomorphic-git';
+import * as http from './isomorphic-http-with-agent.js';
+import cliparse from 'cliparse';
+import slugify from 'slugify';
+import { findPath } from './fs-utils.js';
+import { loadOAuthConf } from './configuration.js';
 
 async function getRepo () {
   try {
@@ -30,7 +27,7 @@ async function onAuth () {
   };
 }
 
-async function addRemote (remoteName, url) {
+export async function addRemote (remoteName, url) {
   const repo = await getRepo();
   const safeRemoteName = slugify(remoteName);
   const allRemotes = await git.listRemotes({ ...repo });
@@ -41,7 +38,7 @@ async function addRemote (remoteName, url) {
   }
 }
 
-async function resolveFullCommitId (commitId) {
+export async function resolveFullCommitId (commitId) {
   if (commitId == null) {
     return null;
   }
@@ -57,7 +54,7 @@ async function resolveFullCommitId (commitId) {
   }
 }
 
-async function getRemoteCommit (remoteUrl) {
+export async function getRemoteCommit (remoteUrl) {
   const repo = await getRepo();
   const remoteInfos = await git.getRemoteInfo({
     ...repo,
@@ -67,7 +64,7 @@ async function getRemoteCommit (remoteUrl) {
   return _.get(remoteInfos, 'refs.heads.master');
 }
 
-async function getFullBranch (branchName) {
+export async function getFullBranch (branchName) {
   const repo = await getRepo();
   if (branchName === '') {
     const currentBranch = await git.currentBranch({ ...repo, fullname: true });
@@ -76,7 +73,7 @@ async function getFullBranch (branchName) {
   return git.expandRef({ ...repo, ref: branchName });
 };
 
-async function getBranchCommit (refspec) {
+export async function getBranchCommit (refspec) {
   const repo = await getRepo();
   const oid = await git.resolveRef({ ...repo, ref: refspec });
   // When a refspec refers to an annotated tag, the OID ref represents the annotation and not the commit directly,
@@ -85,7 +82,7 @@ async function getBranchCommit (refspec) {
   return res.oid;
 }
 
-async function isExistingTag (tag) {
+export async function isExistingTag (tag) {
   const repo = await getRepo();
   const tags = await git.listTags({
     ...repo,
@@ -93,7 +90,7 @@ async function isExistingTag (tag) {
   return tags.includes(tag);
 }
 
-async function push (remoteUrl, branchRefspec, force) {
+export async function push (remoteUrl, branchRefspec, force) {
   const repo = await getRepo();
   try {
     const push = await git.push({
@@ -117,13 +114,13 @@ async function push (remoteUrl, branchRefspec, force) {
   }
 }
 
-function completeBranches () {
+export function completeBranches () {
   return getRepo()
     .then((repo) => git.listBranches(repo))
-    .then(autocomplete.words);
+    .then(cliparse.autocomplete.words);
 }
 
-async function isShallow () {
+export async function isShallow () {
   const { dir } = await getRepo();
   try {
     await fs.promises.access(path.join(dir, '.git', 'shallow'));
@@ -133,15 +130,3 @@ async function isShallow () {
     return false;
   }
 }
-
-module.exports = {
-  addRemote,
-  resolveFullCommitId,
-  getRemoteCommit,
-  getFullBranch,
-  getBranchCommit,
-  push,
-  completeBranches,
-  isShallow,
-  isExistingTag,
-};

package/src/models/ids-resolver.js

@@ -1,6 +1,6 @@
-const { getSummary } = require('@clevercloud/client/cjs/api/v2/user.js');
-const { sendToApi } = require('./send-to-api.js');
-const { loadIdsCache, writeIdsCache } = require('./configuration.js');
+import { getSummary } from '@clevercloud/client/esm/api/v2/user.js';
+import { sendToApi } from './send-to-api.js';
+import { loadIdsCache, writeIdsCache } from './configuration.js';
 
 /*
 This system uses a simplified representation of the summary to expose IDs links:
@@ -24,11 +24,11 @@ This system uses a simplified representation of the summary to expose IDs links:
 }
  */
 
-async function resolveOwnerId (id) {
+export async function resolveOwnerId (id) {
   return getIdFromCacheOrSummary((ids) => ids.owners[id]);
 }
 
-async function resolveAddonId (id) {
+export async function resolveAddonId (id) {
 
   const addonId = await getIdFromCacheOrSummary((ids) => {
     return (ids.addons[id] != null) ? ids.addons[id].addonId : null;
@@ -41,7 +41,7 @@ async function resolveAddonId (id) {
   throw new Error(`Add-on ${id} does not exist`);
 }
 
-async function resolveRealId (id) {
+export async function resolveRealId (id) {
 
   const realId = await getIdFromCacheOrSummary((ids) => {
     return (ids.addons[id] != null) ? ids.addons[id].realId : null;
@@ -102,9 +102,3 @@ async function getIdsFromSummary () {
 
   return ids;
 }
-
-module.exports = {
-  resolveOwnerId,
-  resolveAddonId,
-  resolveRealId,
-};

package/src/models/interact.js

@@ -1,6 +1,4 @@
-'use strict';
-
-const readline = require('readline');
+import readline from 'node:readline';
 
 function ask (question) {
 
@@ -17,12 +15,10 @@ function ask (question) {
   });
 }
 
-async function confirm (question, rejectionMessage, expectedAnswers = ['yes', 'y']) {
+export async function confirm (question, rejectionMessage, expectedAnswers = ['yes', 'y']) {
   const answer = await ask(question);
   if (!expectedAnswers.includes(answer)) {
     throw new Error(rejectionMessage);
   }
   return true;
 }
-
-module.exports = { confirm };

package/src/models/isomorphic-http-with-agent.js

@@ -1,7 +1,5 @@
-'use strict';
-
-const isomotphicHttp = require('isomorphic-git/http/node');
-const https = require('https');
+import isomotphicHttp from 'isomorphic-git/http/node/index.js';
+import https from 'node:https';
 
 // We use our own HTTP plugin, so we can customize the agent used for requests and configure a long timeout (default is 5 seconds).
 
@@ -10,10 +8,6 @@ const agent = new https.Agent({
   timeout: 10 * 60 * 1000,
 });
 
-function request (params) {
+export function request (params) {
   return isomotphicHttp.request({ ...params, agent });
 }
-
-module.exports = {
-  request,
-};

package/src/models/json-array.js

@@ -1,7 +1,7 @@
 /**
  * Helper to print a real JSON array with starting `[` and ending `]`
  */
-class JsonArray {
+export class JsonArray {
   constructor () {
     this._isFirst = true;
   }
@@ -24,5 +24,3 @@ class JsonArray {
     process.stdout.write('\n]');
   }
 }
-
-module.exports = { JsonArray };

package/src/models/log-v4.js

@@ -1,11 +1,11 @@
-const { getHostAndTokens, processError } = require('./send-to-api.js');
-const colors = require('colors/safe');
-const { Deferred } = require('./utils.js');
-const Logger = require('../logger.js');
-const { waitForDeploymentEnd, waitForDeploymentStart } = require('./deployments.js');
-const { ApplicationLogStream } = require('@clevercloud/client/cjs/streams/application-logs.js');
-const { JsonArray } = require('./json-array.js');
-const ExitStrategy = require('../models/exit-strategy-option.js');
+import { getHostAndTokens, processError } from './send-to-api.js';
+import colors from 'colors/safe.js';
+import { Deferred } from './utils.js';
+import { Logger } from '../logger.js';
+import { waitForDeploymentEnd, waitForDeploymentStart } from './deployments.js';
+import { ApplicationLogStream } from '@clevercloud/client/esm/streams/application-logs.js';
+import { JsonArray } from './json-array.js';
+import * as ExitStrategy from '../models/exit-strategy-option.js';
 
 // 2000 logs per 100ms maximum
 const THROTTLE_ELEMENTS = 2000;
@@ -16,7 +16,7 @@ const retryConfiguration = {
   maxRetryCount: 6,
 };
 
-async function displayLogs (params) {
+export async function displayLogs (params) {
 
   const deferred = params.deferred || new Deferred();
   const { apiHost, tokens } = await getHostAndTokens();
@@ -83,7 +83,7 @@ async function displayLogs (params) {
   return logStream;
 }
 
-async function watchDeploymentAndDisplayLogs (options) {
+export async function watchDeploymentAndDisplayLogs (options) {
 
   const {
     ownerId,
@@ -171,5 +171,3 @@ function isDeploymentFailedMessage (log) {
 function isBuildSucessMessage (log) {
   return isCleverMessage(log) && log.message.toLowerCase().startsWith('build succeeded in');
 };
-
-module.exports = { displayLogs, watchDeploymentAndDisplayLogs };

package/src/models/log.js

@@ -1,15 +1,13 @@
-'use strict';
+import _ from 'lodash';
+import colors from 'colors/safe.js';
 
-const _ = require('lodash');
-const colors = require('colors/safe');
-
-const Logger = require('../logger.js');
-const { Deferred } = require('./utils.js');
-const { getOldLogs } = require('@clevercloud/client/cjs/api/v2/log.js');
-const { LogsStream } = require('@clevercloud/client/cjs/streams/logs.node.js');
-const { sendToApi, getHostAndTokens } = require('./send-to-api.js');
-const { waitForDeploymentEnd, waitForDeploymentStart } = require('./deployments.js');
-const ExitStrategy = require('../models/exit-strategy-option.js');
+import { Logger } from '../logger.js';
+import { Deferred } from './utils.js';
+import { getOldLogs } from '@clevercloud/client/esm/api/v2/log.js';
+import { LogsStream } from '@clevercloud/client/esm/streams/logs.node.js';
+import { sendToApi, getHostAndTokens } from './send-to-api.js';
+import { waitForDeploymentEnd, waitForDeploymentStart } from './deployments.js';
+import * as ExitStrategy from '../models/exit-strategy-option.js';
 
 function isCleverMessage (line) {
   return line._source.syslog_program === '/home/bas/rubydeployer/deployer.rb';
@@ -69,7 +67,7 @@ async function displayLiveLogs ({ appId, filter, until, deploymentId }, deferred
   return logsStream;
 }
 
-async function displayLogs ({ appAddonId, until, since, filter, deploymentId }) {
+export async function displayLogs ({ appAddonId, until, since, filter, deploymentId }) {
 
   const now = new Date();
 
@@ -101,7 +99,7 @@ async function displayLogs ({ appAddonId, until, since, filter, deploymentId })
   return deferred.promise;
 }
 
-async function watchDeploymentAndDisplayLogs ({ ownerId, appId, deploymentId, commitId, knownDeployments, quiet, exitStrategy }) {
+export async function watchDeploymentAndDisplayLogs ({ ownerId, appId, deploymentId, commitId, knownDeployments, quiet, exitStrategy }) {
 
   ExitStrategy.plotQuietWarning(exitStrategy, quiet);
   // If in quiet mode, we only log start/finished deployment messages
@@ -148,5 +146,3 @@ async function watchDeploymentAndDisplayLogs ({ ownerId, appId, deploymentId, co
     throw new Error('Deployment failed. Please check the logs');
   }
 }
-
-module.exports = { displayLogs, watchDeploymentAndDisplayLogs };

package/src/models/namespaces.js

@@ -1,20 +1,14 @@
-const Application = require('./application.js');
-const organisation = require('@clevercloud/client/cjs/api/v2/organisation.js');
-const { sendToApi } = require('./send-to-api.js');
-const { autocomplete } = require('cliparse');
-
-async function getNamespaces (ownerId) {
+import * as Application from './application.js';
+import * as organisation from '@clevercloud/client/esm/api/v2/organisation.js';
+import { sendToApi } from './send-to-api.js';
+import cliparse from 'cliparse';
+export async function getNamespaces (ownerId) {
   return organisation.getNamespaces({ id: ownerId }).then(sendToApi);
 }
 
-async function completeNamespaces () {
+export async function completeNamespaces () {
   // Sadly we do not have access to current params in complete as of now
   const { ownerId } = await Application.resolveId(null, null);
 
-  return getNamespaces(ownerId).then(autocomplete.words);
+  return getNamespaces(ownerId).then(cliparse.autocomplete.words);
 }
-
-module.exports = {
-  getNamespaces,
-  completeNamespaces,
-};