clever-tools 3.6.0 → 3.7.0

package/README.md

@@ -70,9 +70,3 @@ If you want to know more or if you need to release a new version, please read [R
 ## License
 
 This project is licensed under the [Apache-2.0](https://spdx.org/licenses/Apache-2.0.html).
-
-We're using a CJS bundled version of a file from [curlconverter](https://github.com/curlconverter/curlconverter):
-
-* The project is licensed with [MIT](https://github.com/curlconverter/curlconverter/blob/master/LICENSE)
-* The copyright is at the top the file `vendors/curlconverter-parse`
-* The details are explained in [README_VENDORS.md](vendors/README_VENDORS.md)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "clever-tools",
-  "version": "3.6.0",
+  "version": "3.7.0",
   "description": "Command Line Interface for Clever Cloud.",
   "main": "bin/clever.js",
   "keywords": [
@@ -27,10 +27,10 @@
   "dependencies": {
     "@clevercloud/client": "^8.1.2",
     "clf-date": "^0.2.0",
-    "cliparse": "^0.3.3",
+    "cliparse": "0.3.5",
     "colors": "1.4.0",
     "common-env": "^6.4.0",
-    "curlconverter": "^4.9.0",
+    "curlconverter": "^3.21.0",
     "duration-js": "^4.0.0",
     "eventsource": "^1.1.0",
     "iso8601-duration": "^2.1.2",
@@ -78,7 +78,6 @@
     "pkg-fetch": "3.5.2"
   },
   "scripts": {
-    "bundle-curlconverter": "rollup -c rollup-curlconverter.config.js",
     "pretest": "npm run lint",
     "test": "grunt test",
     "lint": "eslint bin src scripts",

package/src/command-options.js

@@ -22,14 +22,14 @@ function getSameCommitPolicyOption () {
   const availablePolicies = ['error', 'ignore', 'restart', 'rebuild'];
   return cliparse.option('same-commit-policy', {
     aliases: ['p'],
-    metavar: 'same-commit-policy',
+    metavar: 'policy',
     parser: (policy) => {
       return availablePolicies.includes(policy)
         ? cliparse.parsers.success(policy)
-        : cliparse.parsers.error(`The output policy must be one of ${availablePolicies.join(', ')}`);
+        : cliparse.parsers.error(`the policy must be one of ${availablePolicies.join(', ')}`);
     },
     default: 'error',
-    description: `Which policy to apply when the local commit is the same as the remote one. Available policies are (${availablePolicies.join(', ')})`,
+    description: `What to do when local and remote commit are identical (${availablePolicies.join(', ')})`,
     complete () {
       return cliparse.autocomplete.words(availablePolicies);
     },

package/src/commands/activity.js

@@ -31,10 +31,11 @@ function getColoredState (state, isLast) {
 // We use examples of maximum width text to have a clean display
 const formatActivityTable = formatTable([
   moment().format(),
+  47,
   'IN PROGRESS',
   'downscale',
-  // a git commit id is 40 chars long
-  40,
+  // a git commit id is 8 chars long
+  8,
   0,
 ]);
 
@@ -42,9 +43,10 @@ function formatActivityLine (event) {
   return formatActivityTable([
     [
       moment(event.date).format(),
+      event.uuid,
       getColoredState(event.state, event.isLast),
       event.action,
-      event.commit || 'not specified',
+      event?.commit?.substring(0, 8) ?? 'N/A',
       event.cause,
     ],
   ]);
@@ -77,11 +79,11 @@ function handleEvent (previousEvent, event) {
 }
 
 function onEvent (previousEvent, newEvent) {
-  const { event, date, data: { state, action, commit, cause } } = newEvent;
+  const { event, date, data: { uuid, state, action, commit, cause } } = newEvent;
   if (event !== 'DEPLOYMENT_ACTION_BEGIN' && event !== 'DEPLOYMENT_ACTION_END') {
     return previousEvent;
   }
-  return handleEvent(previousEvent, { date, state, action, commit, cause, isLast: true });
+  return handleEvent(previousEvent, { date, uuid, state, action, commit, cause, isLast: true });
 }
 
 async function activity (params) {

package/src/commands/addon.js

@@ -15,22 +15,6 @@ const { sendToApi } = require('../models/send-to-api.js');
 const { toNameEqualsValueString } = require('@clevercloud/client/cjs/utils/env-vars.js');
 const { resolveAddonId } = require('../models/ids-resolver.js');
 
-function getPlan (inputPlan, providerName) {
-
-  // Return user plan
-  if (inputPlan !== '') {
-    return inputPlan;
-  }
-
-  // Choose a default plan based on the add-on provider
-  switch (providerName) {
-    case 'kv':
-      return 'alpha';
-    default:
-      return 'dev';
-  }
-}
-
 async function list (params) {
   const { org: orgaIdOrName, format } = params.options;
 
@@ -74,7 +58,7 @@ async function create (params) {
   const [providerName, name] = params.args;
   const {
     link: linkedAppAlias,
-    plan: inputPlan,
+    plan: planName,
     region,
     yes: skipConfirmation,
     org: orgaIdOrName,
@@ -82,7 +66,6 @@ async function create (params) {
   } = params.options;
   const version = params.options['addon-version'];
   const addonOptions = parseAddonOptions(params.options.option);
-  const planName = getPlan(inputPlan, providerName);
 
   const ownerId = (orgaIdOrName != null)
     ? await Organisation.getId(orgaIdOrName)
@@ -143,8 +126,8 @@ function displayAddon (format, addon, providerName, message) {
       if (providerName === 'kv') {
         const materiaMessage = [
           '',
-          colors.yellow(`/!\\ The MateriaDB ${providerName.toUpperCase()} provider is in Alpha testing phase, don't store sensitive or production grade data`),
-          'You can easily use MateriaDB KV with \'redis-cli\', with such commands:',
+          colors.yellow(`/!\\ The Materia ${providerName.toUpperCase()} provider is in Alpha testing phase, don't store sensitive or production grade data`),
+          'You can easily use Materia KV with \'redis-cli\', with such commands:',
           colors.blue(`source <(clever addon env ${addon.id} -F shell)`),
           colors.blue('redis-cli -h $KV_HOST -p $KV_PORT --tls'),
         ].join('\n');

package/src/commands/curl.js

@@ -5,7 +5,7 @@ const { loadOAuthConf, conf } = require('../models/configuration.js');
 const { addOauthHeader } = require('@clevercloud/client/cjs/oauth.js');
 const Logger = require('../logger.js');
 const colors = require('colors/safe');
-const curlParser = require('../../vendors/curlconverter-parse.js');
+const curlconverter = require('curlconverter');
 
 async function loadTokens () {
   const tokens = await loadOAuthConf();
@@ -49,7 +49,12 @@ async function curl () {
     return;
   }
 
-  const requestParams = await parseCurlCommand(['curl', ...curlArgs]);
+  // WARNING: Version 3.x of curlconverter uses a fork of yargs.
+  // For "reasons", when the command has a help param, it stops the parsing and triggers a very short and localized version of some help (WAT?).
+  // That's why we remove the help param before parsing and "reinstate" it before execution.
+  const curlArgsNoHelp = curlArgs.filter((arg) => arg !== '--help' && arg !== '-h');
+  const curlCommand = ['curl', ...curlArgsNoHelp].join(' ');
+  const requestParams = await parseCurlCommand(curlCommand);
 
   // We only allow request to the respective API_HOST
   if (!requestParams.url.startsWith(conf.API_HOST)) {
@@ -78,23 +83,15 @@ async function curl () {
 
 async function parseCurlCommand (curlCommand) {
 
-  const [request] = curlParser.parse(curlCommand);
-  const url = request.urls[0];
+  const jsonString = curlconverter.toJsonString(curlCommand);
+  const curlRequestParams = JSON.parse(jsonString);
 
   return {
-    method: url.method.toString(),
-    url: url.urlWithoutQueryArray.toString(),
-    headers: transformCurlConverterWordsToObject(request.headers.headers),
-    queryParams: transformCurlConverterWordsToObject(url.queryDict),
+    method: curlRequestParams.method,
+    url: curlRequestParams.url,
+    headers: curlRequestParams.headers,
+    queryParams: curlRequestParams.queries,
   };
 }
 
-function transformCurlConverterWordsToObject (words = []) {
-  return Object.fromEntries(
-    words.map(([key, value]) => {
-      return [key.toString(), value.toString()];
-    }),
-  );
-}
-
 module.exports = { curl };

package/src/models/addon.js

@@ -26,7 +26,7 @@ async function getProvider (providerName) {
   const providers = await listProviders();
   const provider = providers.find((p) => p.id === providerName);
   if (provider == null) {
-    throw new Error('invalid provider name');
+    throw new Error(`Invalid provider name. Available providers: ${providers.map((p) => p.id).join(', ')}`);
   }
   return provider;
 }
@@ -136,22 +136,17 @@ function validateAddonVersionAndOptions (region, version, addonOptions, provider
 async function create ({ ownerId, name, providerName, planName, region, skipConfirmation, version, addonOptions }) {
 
   // TODO: We should be able to use it without {}
-  const providers = await listProviders();
+  const provider = await getProvider(providerName);
 
-  const provider = providers.find((p) => p.id === providerName);
-  if (provider == null) {
-    throw new Error('invalid provider name');
-  }
   if (!provider.regions.includes(region)) {
-    throw new Error(`invalid region name. Available regions: ${provider.regions.join(', ')}`);
+    throw new Error(`Invalid region name. Available regions: ${provider.regions.join(', ')}`);
   }
-
-  const plan = provider.plans.find((p) => p.slug.toLowerCase() === planName.toLowerCase());
-  if (plan == null) {
-    const availablePlans = provider.plans.map((p) => p.slug);
-    throw new Error(`invalid plan name. Available plans: ${availablePlans.join(', ')}`);
+  if (provider.plans.length === 0) {
+    throw new Error(`No plans available for provider ${providerName}`);
   }
 
+  const plan = getPlan(planName, provider.plans);
+
   const providerInfos = await getProviderInfos(provider.id);
   const planType = plan.features.find(({ name }) => name.toLowerCase() === 'type');
 
@@ -289,6 +284,20 @@ function parseAddonOptions (options) {
   }, {});
 }
 
+function getPlan (planName, plans) {
+  // if no plan specified, pick the cheapest one
+  if (planName == null || planName === '') {
+    return plans.sort((p1, p2) => p1.price - p2.price)[0];
+  }
+
+  const plan = plans.find((p) => p.slug.toLowerCase() === planName.toLowerCase());
+  if (plan == null) {
+    const availablePlans = plans.map((p) => p.slug);
+    throw new Error(`Invalid plan name. Available plans: ${availablePlans.join(', ')}`);
+  }
+  return plan;
+}
+
 module.exports = {
   completePlan,
   completeRegion,