clever-tools 3.1.0 → 3.4.0

package/README.md

@@ -10,11 +10,6 @@ Clever Tools are availables from many channels. The simpler way to install them,
 npm install -g clever-tools
 ```
 
-If you want to install our latest beta release, you can run:
-
-```sh
-npm install -g clever-tools@beta
-```
 We also distribute binaries and packages for multiple systems and tools:
 
 * [GNU/Linux](docs/setup-systems.md#gnulinux)
@@ -93,6 +88,7 @@ Where `type` is one of:
 Where region is one of:
 
 - `par` (Paris, [Clever Cloud](https://www.clever-cloud.com/infrastructure/))
+- `grahds` (Gravelines, HDS servers, OVHcloud)
 - `rbx` (Roubaix, OVHcloud)
 - `rbxhds` (Roubaix, HDS servers, OVHcloud)
 - `scw` (Paris, [Scaleway DC5](https://www.clever-cloud.com/blog/press/2023/01/17/clever-cloud-and-scaleway-join-forces-to-unveil-a-sovereign-european-paas-offering/))
@@ -161,5 +157,5 @@ clever deploy
 
 ## Automated releases
 
-This project uses Jenkins to build binaries, package them and release them automatically on the various repositories.
+This project uses GitHub Actions to build binaries, package them and release them automatically on the various repositories.
 If you want to know more or if you need to release a new version, please read [RELEASE.md](./RELEASE.md) carefully.

package/bin/clever.js

@@ -90,7 +90,10 @@ function run () {
       description: 'Application ID (or name, if unambiguous)',
       parser: Parsers.appIdOrName,
     }),
-    appNameCreation: cliparse.argument('app-name', { description: 'Application name' }),
+    appNameCreation: cliparse.argument('app-name', {
+      description: 'Application name (optional, current directory name is used if not specified)',
+      default: '',
+    }),
     backupId: cliparse.argument('backup-id', { description: 'A Database backup ID (format: UUID)' }),
     databaseId: cliparse.argument('database-id', { description: 'Any database ID (format: addon_UUID, postgresql_UUID, mysql_UUID, ...)' }),
     drainId: cliparse.argument('drain-id', { description: 'Drain ID' }),
@@ -132,6 +135,7 @@ function run () {
     sourceableEnvVarsList: cliparse.flag('add-export', { description: 'Display sourceable env variables setting' }),
     accesslogsFormat: getOutputFormatOption(['simple', 'extended', 'clf']),
     addonEnvFormat: getOutputFormatOption(['shell']),
+    logsFormat: getOutputFormatOption(['json-stream']),
     accesslogsFollow: cliparse.flag('follow', {
       aliases: ['f'],
       description: 'Display access logs continuously (ignores before/until, after/since)',
@@ -180,6 +184,12 @@ function run () {
       metavar: 'commit id',
       description: 'Restart the application with a specific commit ID',
     }),
+    gitTag: cliparse.option('tag', {
+      aliases: ['t'],
+      default: '',
+      metavar: 'tag',
+      description: 'Tag to push (none by default)',
+    }),
     databaseId: cliparse.option('database-id', {
       metavar: 'database_id',
       description: 'The Database ID (e.g.: postgresql_xxx)',
@@ -345,7 +355,7 @@ function run () {
       parser: Parsers.commaSeparated,
     }),
     showAllActivity: cliparse.flag('show-all', { description: 'Show all activity' }),
-    showAll: cliparse.flag('show-all', { description: 'Show all available dependencies' }),
+    showAll: cliparse.flag('show-all', { description: 'Show all available add-ons and applications' }),
     loginToken: cliparse.option('token', {
       metavar: 'token',
       description: 'Directly give an existing token',
@@ -559,7 +569,7 @@ function run () {
   const addonCreateCommand = cliparse.command('create', {
     description: 'Create an addon',
     args: [args.addonProvider, args.addonName],
-    options: [opts.linkAddon, opts.confirmAddonCreation, opts.addonPlan, opts.addonRegion, opts.addonVersion, opts.addonOptions],
+    options: [opts.linkAddon, opts.confirmAddonCreation, opts.addonPlan, opts.addonRegion, opts.addonVersion, opts.addonOptions, opts.humanJsonOutputFormat],
   }, addon('create'));
   const addonDeleteCommand = cliparse.command('delete', {
     description: 'Delete an addon',
@@ -643,7 +653,7 @@ function run () {
   const deploy = lazyRequirePromiseModule('../src/commands/deploy.js');
   const deployCommand = cliparse.command('deploy', {
     description: 'Deploy an application',
-    options: [opts.alias, opts.branch, opts.quiet, opts.forceDeploy, opts.followDeployLogs, opts.sameCommitPolicy],
+    options: [opts.alias, opts.branch, opts.gitTag, opts.quiet, opts.forceDeploy, opts.followDeployLogs, opts.sameCommitPolicy],
   }, deploy('deploy'));
 
   // DIAG COMMAND
@@ -754,7 +764,7 @@ function run () {
   const logs = lazyRequirePromiseModule('../src/commands/logs.js');
   const logsCommand = cliparse.command('logs', {
     description: 'Fetch application logs, continuously',
-    options: [opts.alias, opts.before, opts.after, opts.search, opts.deploymentId, opts.addonId],
+    options: [opts.alias, opts.before, opts.after, opts.search, opts.deploymentId, opts.addonId, opts.logsFormat],
   }, logs('appLogs'));
 
   // MAKE DEFAULT COMMAND

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "clever-tools",
-  "version": "3.1.0",
+  "version": "3.4.0",
   "description": "Command Line Interface for Clever Cloud.",
   "main": "bin/clever.js",
   "keywords": [
@@ -25,14 +25,14 @@
     "scripts/*.sh"
   ],
   "dependencies": {
-    "@clevercloud/client": "^8.0.2",
+    "@clevercloud/client": "^8.1.2",
     "clf-date": "^0.2.0",
     "cliparse": "^0.3.3",
     "colors": "1.4.0",
     "common-env": "^6.4.0",
     "curlconverter": "^3.21.0",
     "eventsource": "^1.1.0",
-    "isomorphic-git": "^1.25.0",
+    "isomorphic-git": "^1.25.3",
     "linux-release-info": "^3.0.0",
     "lodash": "^4.17.21",
     "mkdirp": "^1.0.4",

package/src/commands/addon.js

@@ -34,7 +34,14 @@ async function list (params) {
 
 async function create (params) {
   const [providerName, name] = params.args;
-  const { link: linkedAppAlias, plan: planName, region, yes: skipConfirmation, org: orgaIdOrName } = params.options;
+  const {
+    link: linkedAppAlias,
+    plan: planName,
+    region,
+    yes: skipConfirmation,
+    org: orgaIdOrName,
+    format,
+  } = params.options;
   const version = params.options['addon-version'];
   const addonOptions = parseAddonOptions(params.options.option);
 
@@ -42,36 +49,55 @@ async function create (params) {
     ? await Organisation.getId(orgaIdOrName)
     : await User.getCurrentId();
 
+  const addonToCreate = {
+    ownerId,
+    name,
+    providerName,
+    planName,
+    region,
+    skipConfirmation,
+    version,
+    addonOptions,
+  };
+
   if (linkedAppAlias != null) {
     const linkedAppData = await AppConfig.getAppDetails({ alias: linkedAppAlias });
-    if (orgaIdOrName != null && linkedAppData.ownerId !== ownerId) {
+    if (orgaIdOrName != null && linkedAppData.ownerId !== ownerId && format === 'human') {
       Logger.warn('The specified application does not belong to the specified organisation. Ignoring the `--org` option');
     }
     const newAddon = await Addon.create({
+      ...addonToCreate,
       ownerId: linkedAppData.ownerId,
-      name,
-      providerName,
-      planName,
-      region,
-      skipConfirmation,
-      version,
-      addonOptions,
     });
     await Addon.link(linkedAppData.ownerId, linkedAppData.appId, { addon_id: newAddon.id });
-    Logger.println(`Addon ${name} (id: ${newAddon.id}) successfully created and linked to the application`);
+    displayAddon(format, newAddon, `Add-on created and linked to application ${linkedAppAlias} successfully!`);
   }
   else {
-    const newAddon = await Addon.create({
-      ownerId,
-      name,
-      providerName,
-      planName,
-      region,
-      skipConfirmation,
-      version,
-      addonOptions,
-    });
-    Logger.println(`Addon ${name} (id: ${newAddon.id}) successfully created`);
+    const newAddon = await Addon.create(addonToCreate);
+    displayAddon(format, newAddon, 'Add-on created successfully!');
+  }
+}
+
+function displayAddon (format, addon, message) {
+  switch (format) {
+
+    case 'json': {
+      Logger.printJson({
+        id: addon.id,
+        realId: addon.realId,
+        name: addon.name,
+      });
+      break;
+    }
+
+    case 'human':
+    default:
+      Logger.println([
+        message,
+        `ID: ${addon.id}`,
+        `Real ID: ${addon.realId}`,
+        `Name: ${addon.name}`,
+      ].join('\n'));
   }
 }
 

package/src/commands/create.js

@@ -1,17 +1,21 @@
 'use strict';
 
+const path = require('path');
 const Application = require('../models/application.js');
 const AppConfig = require('../models/app_configuration.js');
 const Logger = require('../logger.js');
 
 async function create (params) {
   const { type: typeName } = params.options;
-  const [name] = params.args;
+  const [rawName] = params.args;
   const { org: orgaIdOrName, alias, region, github: githubOwnerRepo, format } = params.options;
   const { apps } = await AppConfig.loadApplicationConf();
-  
+
+  // Application name is optionnal, use current directory name if not specified (empty string)
+  const name = (rawName !== '') ? rawName : getCurrentDirectoryName();
+
   AppConfig.checkAlreadyLinked(apps, name, alias);
-  
+
   const github = getGithubDetails(githubOwnerRepo);
   const app = await Application.create(name, typeName, region, orgaIdOrName, github);
   await AppConfig.addLinkedApplication(app, alias);
@@ -19,13 +23,19 @@ async function create (params) {
   switch (format) {
 
     case 'json': {
-      console.log(JSON.stringify(app, null, 2));
+      Logger.printJson({
+        id: app.id,
+        name: app.name,
+        deployUrl: app.deployUrl,
+      });
       break;
     }
 
     case 'human':
     default:
-      Logger.println('Your application has been successfully created!');
+      Logger.println('Application created successfully!');
+      Logger.println(`ID: ${app.id}`);
+      Logger.println(`Name: ${name}`);
   }
 };
 
@@ -36,4 +46,8 @@ function getGithubDetails (githubOwnerRepo) {
   }
 }
 
+function getCurrentDirectoryName () {
+  return path.basename(process.cwd());
+}
+
 module.exports = { create };

package/src/commands/deploy.js

@@ -13,12 +13,12 @@ const { sendToApi } = require('../models/send-to-api.js');
 // Once the API call to redeploy() has been triggered successfully,
 // the rest (waiting for deployment state to evolve and displaying logs) is done with auto retry (resilient to network failures)
 async function deploy (params) {
-  const { alias, branch: branchName, quiet, force, follow, 'same-commit-policy': sameCommitPolicy } = params.options;
+  const { alias, branch: branchName, tag: tagName, quiet, force, follow, 'same-commit-policy': sameCommitPolicy } = params.options;
 
   const appData = await AppConfig.getAppDetails({ alias });
   const { ownerId, appId } = appData;
-  const branchRefspec = await git.getFullBranch(branchName);
 
+  const branchRefspec = await getBranchToDeploy(branchName, tagName);
   const commitIdToPush = await git.getBranchCommit(branchRefspec);
   const remoteHeadCommitId = await git.getRemoteCommit(appData.deployUrl);
   const deployedCommitId = await Application.get(ownerId, appId)
@@ -43,7 +43,7 @@ async function deploy (params) {
       default: {
         const upToDateMessage = `The clever-cloud application is up-to-date (${colors.green(remoteHeadCommitId)}).\nYou can set a policy with 'same-commit-policy' to handle differently when remote HEAD has the same commit as the one to push.\nOr try this command to restart the application:`;
         if (commitIdToPush !== deployedCommitId) {
-          const restartWithId = `clever restart --commit ${commitIdToPush}`
+          const restartWithId = `clever restart --commit ${commitIdToPush}`;
           throw new Error(`${upToDateMessage}\n${colors.yellow(restartWithId)}`);
         }
         throw new Error(`${upToDateMessage}\n${colors.yellow('clever restart')}`);
@@ -66,7 +66,8 @@ async function deploy (params) {
   const knownDeployments = await getAllDeployments({ id: ownerId, appId, limit: 5 }).then(sendToApi);
 
   Logger.println('Pushing source code to Clever Cloud…');
-  await git.push(appData.deployUrl, branchRefspec, force)
+
+  await git.push(appData.deployUrl, commitIdToPush, force)
     .catch(async (e) => {
       const isShallow = await git.isShallow();
       if (isShallow) {
@@ -86,4 +87,20 @@ async function restartOnSameCommit (ownerId, appId, commitIdToPush, quiet, follo
   return Log.watchDeploymentAndDisplayLogs({ ownerId, appId, deploymentId: restart.deploymentId, quiet, follow });
 }
 
+async function getBranchToDeploy (branchName, tagName) {
+  if (tagName) {
+    const useTag = await git.isExistingTag(tagName);
+    if (useTag) {
+      const tagRefspec = await git.getFullBranch(tagName);
+      return tagRefspec;
+    }
+    else {
+      throw new Error(`Tag ${tagName} doesn't exist locally`);
+    }
+  }
+  else {
+    return await git.getFullBranch(branchName);
+  }
+}
+
 module.exports = { deploy };

package/src/commands/logs.js

@@ -5,26 +5,35 @@ const LogV2 = require('../models/log.js');
 const Log = require('../models/log-v4.js');
 const Logger = require('../logger.js');
 const { Deferred } = require('../models/utils.js');
+const colors = require('colors/safe');
 
 async function appLogs (params) {
-  const { alias, after: since, before: until, search, 'deployment-id': deploymentId } = params.options;
+  const { alias, addon: addonId, after: since, before: until, search, 'deployment-id': deploymentId, format } = params.options;
 
   // ignore --search ""
   const filter = (search !== '') ? search : null;
 
   const { appId, ownerId } = await AppConfig.getAppDetails({ alias });
 
-  Logger.println('Waiting for application logs…');
+  const isForHuman = (format === 'human');
 
   // TODO: drop when addons are migrated to the v4 API
-  if (params.addon) {
-    const { addon: addonId } = params.options;
-    const appAddonId = addonId || await AppConfig.getAppDetails({ alias }).then(({ appId }) => appId);
-    return LogV2.displayLogs({ appAddonId, since, until, filter, deploymentId });
+  if (addonId) {
+    if (isForHuman) {
+      Logger.println(colors.blue('Waiting for addon logs…'));
+    }
+    else {
+      throw new Error(`"${format}" format is not yet available for add-on logs`);
+    }
+    return LogV2.displayLogs({ appAddonId: addonId, since, until, filter, deploymentId });
+  }
+
+  if (isForHuman) {
+    Logger.println(colors.blue('Waiting for application logs…'));
   }
 
   const deferred = new Deferred();
-  await Log.displayLogs({ ownerId, appId, since, until, filter, deploymentId, deferred });
+  await Log.displayLogs({ ownerId, appId, since, until, filter, deploymentId, format, deferred });
   return deferred.promise;
 }
 

package/src/logger.js

@@ -52,6 +52,11 @@ const Logger = _(['debug', 'info', 'warn', 'error'])
 // No decoration for Logger.println
 Logger.println = console.log;
 
+// No decoration for Logger.println
+Logger.printJson = (obj) => {
+  console.log(JSON.stringify(obj, null, 2));
+};
+
 // No decoration for Logger.printErrorLine
 Logger.printErrorLine = console.error;
 

package/src/models/application.js

@@ -17,7 +17,7 @@ function listAvailableTypes () {
   return autocomplete.words(['docker', 'elixir', 'go', 'gradle', 'haskell', 'jar', 'maven', 'meteor', 'node', 'php', 'play1', 'play2', 'python', 'ruby', 'rust', 'sbt', 'static-apache', 'war']);
 };
 
-const AVAILABLE_ZONES = ['par', 'rbx', 'rbxhds', 'scw', 'jed', 'mtl', 'sgp', 'syd', 'wsw'];
+const AVAILABLE_ZONES = ['par', 'grahds', 'rbx', 'rbxhds', 'scw', 'jed', 'mtl', 'sgp', 'syd', 'wsw'];
 
 function listAvailableZones () {
   return autocomplete.words(AVAILABLE_ZONES);

package/src/models/git.js

@@ -78,7 +78,19 @@ async function getFullBranch (branchName) {
 
 async function getBranchCommit (refspec) {
   const repo = await getRepo();
-  return git.resolveRef({ ...repo, ref: refspec });
+  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,
+  // that's why we need a call to `readCommit`.
+  const res = await git.readCommit({ ...repo, ref: refspec, oid });
+  return res.oid;
+}
+
+async function isExistingTag (tag) {
+  const repo = await getRepo();
+  const tags = await git.listTags({
+    ...repo,
+  });
+  return tags.includes(tag);
 }
 
 async function push (remoteUrl, branchRefspec, force) {
@@ -131,4 +143,5 @@ module.exports = {
   push,
   completeBranches,
   isShallow,
+  isExistingTag,
 };

package/src/models/log-v4.js

@@ -1,4 +1,4 @@
-const { getHostAndTokens } = require('./send-to-api.js');
+const { getHostAndTokens, processError } = require('./send-to-api.js');
 const colors = require('colors/safe');
 const { Deferred } = require('./utils.js');
 const Logger = require('../logger.js');
@@ -9,17 +9,28 @@ const { ApplicationLogStream } = require('@clevercloud/client/cjs/streams/applic
 const THROTTLE_ELEMENTS = 2000;
 const THROTTLE_PER_IN_MILLISECONDS = 100;
 
+const retryConfiguration = {
+  enabled: true,
+  maxRetryCount: 6,
+};
+
 async function displayLogs (params) {
 
   const deferred = params.deferred || new Deferred();
   const { apiHost, tokens } = await getHostAndTokens();
-  const { ownerId, appId, filter, since, until, deploymentId } = params;
+  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,
@@ -30,21 +41,41 @@ async function displayLogs (params) {
 
   // Properly close the stream
   process.once('SIGINT', (signal) => logStream.close(signal));
+  const jsonArray = new JsonArray();
 
   logStream
     .on('open', (event) => {
-      Logger.debug(`stream opened! ${JSON.stringify({ appId, filter, deploymentId })}`);
+      Logger.debug(colors.blue(`Logs stream (open) ${JSON.stringify({ appId, filter, deploymentId })}`));
+      if (format === 'json') {
+        jsonArray.open();
+      }
     })
     .on('error', (event) => {
-      Logger.error(`an error occured: ${event.detail}`);
+      Logger.debug(colors.red(`Logs stream (error) ${event.error.message}`));
     })
     .onLog((log) => {
-      Logger.println(formatLogLine(log));
+      switch (format) {
+        case 'json':
+          jsonArray.push(log);
+          return;
+        case 'json-stream':
+          Logger.printJson(log);
+          return;
+        case 'human':
+        default:
+          Logger.println(formatLogLine(log));
+      }
     });
 
   // start() is blocking until end of stream
   logStream.start()
-    .then((reason) => deferred.resolve())
+    .then((reason) => {
+      if (format === 'json') {
+        jsonArray.close();
+      }
+      return deferred.resolve();
+    })
+    .catch(processError)
     .catch((error) => deferred.reject(error));
 
   return logStream;
@@ -134,3 +165,30 @@ function isBuildSucessMessage (log) {
 };
 
 module.exports = { displayLogs, watchDeploymentAndDisplayLogs };
+
+/**
+ * Helper to print a real JSON array with starting `[` and ending `]`
+ */
+class JsonArray {
+  constructor () {
+    this._isFirst = true;
+  }
+
+  open () {
+    process.stdout.write('[\n');
+  }
+
+  push (log) {
+    if (this._isFirst) {
+      this._isFirst = false;
+    }
+    else {
+      process.stdout.write(',\n');
+    }
+    process.stdout.write(`  ${JSON.stringify(log)}`);
+  }
+
+  close () {
+    process.stdout.write('\n]');
+  }
+}

package/src/models/send-to-api.js

@@ -23,12 +23,22 @@ async function sendToApi (requestParams) {
     .then(prefixUrl(conf.API_HOST))
     .then(addOauthHeader(tokens))
     .then((requestParams) => {
-      if (process.env.CLEVER_VERBOSE) {
-        Logger.debug(`${requestParams.method.toUpperCase()} ${requestParams.url} ? ${JSON.stringify(requestParams.queryParams)}`);
-      }
+      Logger.debug(`${requestParams.method.toUpperCase()} ${requestParams.url} ? ${JSON.stringify(requestParams.queryParams)}`);
       return requestParams;
     })
-    .then((requestParams) => request(requestParams, { retry: 1 }));
+    .then(request)
+    .catch(processError);
+}
+
+function processError (error) {
+  const code = error.code ?? error?.cause?.code;
+  if (code === 'EAI_AGAIN') {
+    throw new Error('Cannot reach the Clever Cloud API, please check your internet connection.', { cause: error });
+  }
+  if (code === 'ECONNRESET') {
+    throw new Error('The connection to the Clever Cloud API was closed abruptly, please try again.', { cause: error });
+  }
+  throw error;
 }
 
 function sendToWarp10 (requestParams) {
@@ -45,4 +55,4 @@ async function getHostAndTokens () {
   };
 }
 
-module.exports = { sendToApi, sendToWarp10, getHostAndTokens };
+module.exports = { sendToApi, sendToWarp10, getHostAndTokens, processError };