clever-tools 3.13.1 → 4.0.0

package/src/models/addon.js

@@ -1,21 +1,26 @@
-import cliparse from 'cliparse';
-
-import { get as getAddon, getAll as getAllAddons, getAllEnvVars, remove as removeAddon, create as createAddon, update as updateAddon } from '@clevercloud/client/esm/api/v2/addon.js';
+import {
+  create as createAddon,
+  get as getAddon,
+  getAll as getAllAddons,
+  getAllEnvVars,
+  remove as removeAddon,
+  update as updateAddon,
+} from '@clevercloud/client/esm/api/v2/addon.js';
+import { getAllLinkedAddons, linkAddon, unlinkAddon } from '@clevercloud/client/esm/api/v2/application.js';
 import { getAllAddonProviders } from '@clevercloud/client/esm/api/v2/product.js';
 import { getSummary } from '@clevercloud/client/esm/api/v2/user.js';
 import { getAddonProvider } from '@clevercloud/client/esm/api/v4/addon-providers.js';
-
+import cliparse from 'cliparse';
 import { confirm } from '../lib/prompts.js';
 import { Logger } from '../logger.js';
-import { sendToApi } from '../models/send-to-api.js';
 import { resolveOwnerId } from './ids-resolver.js';
-import { getAllLinkedAddons, linkAddon, unlinkAddon } from '@clevercloud/client/esm/api/v2/application.js';
+import { sendToApi } from './send-to-api.js';
 
-export function listProviders () {
+export function listProviders() {
   return getAllAddonProviders({}).then(sendToApi);
 }
 
-export async function getProvider (providerName) {
+export async function getProvider(providerName) {
   const providers = await listProviders();
   const provider = providers.find((p) => p.id === providerName);
   if (provider == null) {
@@ -24,8 +29,9 @@ export async function getProvider (providerName) {
   return provider;
 }
 
-export function getProviderInfos (providerName) {
-  return getAddonProvider({ providerId: providerName }).then(sendToApi)
+export function getProviderInfos(providerName) {
+  return getAddonProvider({ providerId: providerName })
+    .then(sendToApi)
     .catch(() => {
       // An error can occur because the add-on api doesn't implement this endpoint yet
       // This is fine, just ignore it
@@ -34,7 +40,7 @@ export function getProviderInfos (providerName) {
     });
 }
 
-export async function list (ownerId, appId, showAll) {
+export async function list(ownerId, appId, showAll) {
   const allAddons = await getAllAddons({ id: ownerId }).then(sendToApi);
 
   if (appId == null) {
@@ -43,9 +49,8 @@ export async function list (ownerId, appId, showAll) {
   }
 
   const myAddons = await getAllLinkedAddons({ id: ownerId, appId }).then(sendToApi);
-
-  if (showAll == null) {
-    return myAddons;
+  if (!showAll) {
+    return myAddons.map((addon) => ({ ...addon, isLinked: true }));
   }
 
   const myAddonIds = myAddons.map((addon) => addon.id);
@@ -55,7 +60,7 @@ export async function list (ownerId, appId, showAll) {
   });
 }
 
-function validateAddonVersionAndOptions (region, version, addonOptions, providerInfos, planType) {
+function validateAddonVersionAndOptions(region, version, addonOptions, providerInfos, planType) {
   if (providerInfos != null) {
     if (version != null) {
       const type = planType.value.toLowerCase();
@@ -63,16 +68,18 @@ function validateAddonVersionAndOptions (region, version, addonOptions, provider
         const cluster = providerInfos.clusters.find(({ zone }) => zone === region);
         if (cluster == null) {
           throw new Error(`Can't find cluster for region ${region}`);
+        } else if (cluster.version !== version) {
+          throw new Error(
+            `Invalid version ${version}, selected shared cluster only supports version ${cluster.version}`,
+          );
         }
-        else if (cluster.version !== version) {
-          throw new Error(`Invalid version ${version}, selected shared cluster only supports version ${cluster.version}`);
-        }
-      }
-      else if (type === 'dedicated') {
+      } else if (type === 'dedicated') {
         const availableVersions = Object.keys(providerInfos.dedicated);
         const hasVersion = availableVersions.find((availableVersion) => availableVersion === version);
         if (hasVersion == null) {
-          throw new Error(`Invalid version ${addonOptions.version}, available versions are: ${availableVersions.join(', ')}`);
+          throw new Error(
+            `Invalid version ${addonOptions.version}, available versions are: ${availableVersions.join(', ')}`,
+          );
         }
       }
     }
@@ -91,8 +98,7 @@ function validateAddonVersionAndOptions (region, version, addonOptions, provider
         }
 
         availableOptions = cluster.features;
-      }
-      else if (type === 'dedicated') {
+      } else if (type === 'dedicated') {
         availableOptions = providerInfos.dedicated[chosenVersion].features;
       }
 
@@ -103,8 +109,7 @@ function validateAddonVersionAndOptions (region, version, addonOptions, provider
           let availableOptionsError = null;
           if (optionNames.length > 0) {
             availableOptionsError = `Available options are: ${optionNames}.`;
-          }
-          else {
+          } else {
             availableOptionsError = 'No options are available for this plan.';
           }
 
@@ -117,17 +122,15 @@ function validateAddonVersionAndOptions (region, version, addonOptions, provider
       version: chosenVersion,
       ...addonOptions,
     };
-  }
-  else {
+  } else {
     if (version != null) {
-      throw new Error('You provided a version for an add-on that doesn\'t support choosing the version.');
+      throw new Error("You provided a version for an add-on that doesn't support choosing the version.");
     }
     return {};
   }
 }
 
-export async function create ({ ownerId, name, providerName, planName, region, skipConfirmation, version, addonOptions }) {
-
+export async function create({ ownerId, name, providerName, planName, region, version, addonOptions }) {
   // TODO: We should be able to use it without {}
   const provider = await getProvider(providerName);
 
@@ -148,7 +151,9 @@ export async function create ({ ownerId, name, providerName, planName, region, s
   // This missing feature should have been added during the add-on's development phase
   // The console has a similar check so I believe we shouldn't hit this
   if (providerInfos != null && planType == null) {
-    throw new Error('Internal error. The selected plan misses the TYPE feature. Please contact our support with the command line you used');
+    throw new Error(
+      'Internal error. The selected plan misses the TYPE feature. Please contact our support with the command line you used',
+    );
   }
 
   const createOptions = validateAddonVersionAndOptions(region, version, addonOptions, providerInfos, planType);
@@ -167,7 +172,7 @@ export async function create ({ ownerId, name, providerName, planName, region, s
   return createdAddon;
 }
 
-async function getByName (ownerId, addonNameOrRealId) {
+async function getByName(ownerId, addonNameOrRealId) {
   const addons = await getAllAddons({ id: ownerId }).then(sendToApi);
   const filteredAddons = addons.filter(({ name, realId }) => {
     return name === addonNameOrRealId || realId === addonNameOrRealId;
@@ -181,7 +186,7 @@ async function getByName (ownerId, addonNameOrRealId) {
   throw new Error('Ambiguous addon name');
 }
 
-async function getId (ownerId, addon) {
+async function getId(ownerId, addon) {
   if (addon.addon_id) {
     return addon.addon_id;
   }
@@ -189,44 +194,41 @@ async function getId (ownerId, addon) {
   return addonDetails.id;
 }
 
-export async function link (ownerId, appId, addon) {
+export async function link(ownerId, appId, addon) {
   const addonId = await getId(ownerId, addon);
   return linkAddon({ id: ownerId, appId }, JSON.stringify(addonId)).then(sendToApi);
 }
 
-export async function unlink (ownerId, appId, addon) {
+export async function unlink(ownerId, appId, addon) {
   const addonId = await getId(ownerId, addon);
   return unlinkAddon({ id: ownerId, appId, addonId }).then(sendToApi);
 }
 
-export async function deleteAddon (ownerId, addonIdOrName, skipConfirmation) {
+export async function deleteAddon(ownerId, addonIdOrName, skipConfirmation) {
   const addonId = await getId(ownerId, addonIdOrName);
 
   if (!skipConfirmation) {
-    await confirm(
-      'Deleting the add-on can\'t be undone, are you sure?',
-      'No confirmation, aborting add-on deletion',
-    );
+    await confirm("Deleting the add-on can't be undone, are you sure?", 'No confirmation, aborting add-on deletion');
   }
 
   return removeAddon({ id: ownerId, addonId }).then(sendToApi);
 }
 
-export async function rename (ownerId, addon, name) {
+export async function rename(ownerId, addon, name) {
   const addonId = await getId(ownerId, addon);
   return updateAddon({ id: ownerId, addonId }, { name }).then(sendToApi);
 }
 
-export function completeRegion () {
+export function completeRegion() {
   return cliparse.autocomplete.words(['par', 'mtl']);
 }
 
 // TODO: We need to fix this
-export function completePlan () {
+export function completePlan() {
   return cliparse.autocomplete.words(['dev', 's', 'm', 'l', 'xl', 'xxl']);
 }
 
-export async function findById (addonId) {
+export async function findById(addonId) {
   const { user, organisations } = await getSummary({}).then(sendToApi);
   for (const orga of [user, ...organisations]) {
     for (const simpleAddon of orga.addons) {
@@ -242,7 +244,7 @@ export async function findById (addonId) {
   throw new Error(`Could not find add-on with ID: ${addonId}`);
 }
 
-export async function findByName (addonName) {
+export async function findByName(addonName) {
   const { user, organisations } = await getSummary({}).then(sendToApi);
   for (const orga of [user, ...organisations]) {
     for (const simpleAddon of orga.addons) {
@@ -258,8 +260,7 @@ export async function findByName (addonName) {
   throw new Error(`Could not find add-on with name ${addonName}`);
 }
 
-export async function findOwnerId (org, addonId) {
-
+export async function findOwnerId(org, addonId) {
   if (org != null && org.orga_id != null) {
     return org.orga_id;
   }
@@ -272,12 +273,12 @@ export async function findOwnerId (org, addonId) {
   throw new Error(`Add-on ${addonId} does not exist`);
 }
 
-export function parseAddonOptions (options) {
+export function parseAddonOptions(options) {
   if (options == null) {
     return {};
   }
 
-  const pairs = options.split(/,(?=\w+=)/) || [];
+  const pairs = options.split(/,(?=\w+(?:-\w+)*=)/) || [];
 
   return pairs.reduce((options, pair) => {
     const [key, ...valueParts] = pair.split('=');
@@ -290,14 +291,11 @@ export function parseAddonOptions (options) {
     let formattedValue = value;
     if (value === 'true' || value === 'enabled') {
       formattedValue = 'true';
-    }
-    else if (value === 'false' || value === 'disabled') {
+    } else if (value === 'false' || value === 'disabled') {
       formattedValue = 'false';
-    }
-    else if (typeof key === 'string') {
+    } else if (typeof key === 'string') {
       formattedValue = value;
-    }
-    else {
+    } else {
       throw new Error(`Can't parse option value: ${value}. Accepted values are: enabled, disabled, true, false`);
     }
 
@@ -306,7 +304,7 @@ export function parseAddonOptions (options) {
   }, {});
 }
 
-function getPlan (planName, plans) {
+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];

package/src/models/app_configuration.js

@@ -1,15 +1,13 @@
+import _ from 'lodash';
 import { promises as fs } from 'node:fs';
 import path from 'node:path';
-
-import _ from 'lodash';
 import { slugify } from '../lib/slugify.js';
-
 import { Logger } from '../logger.js';
-import * as User from './user.js';
 import { conf } from './configuration.js';
+import * as User from './user.js';
 
 // TODO: Maybe use fs-utils findPath()
-export async function loadApplicationConf (ignoreParentConfig = false, pathToFolder) {
+export async function loadApplicationConf(ignoreParentConfig = false, pathToFolder) {
   if (pathToFolder == null) {
     pathToFolder = path.dirname(conf.APP_CONFIGURATION_FILE);
   }
@@ -19,17 +17,16 @@ export async function loadApplicationConf (ignoreParentConfig = false, pathToFol
   try {
     const contents = await fs.readFile(fullPath);
     return JSON.parse(contents);
-  }
-  catch (error) {
+  } catch (error) {
     Logger.info('Cannot load app configuration from ' + conf.APP_CONFIGURATION_FILE + ' (' + error + ')');
     if (ignoreParentConfig || path.parse(pathToFolder).root === pathToFolder) {
       return { apps: [] };
     }
     return loadApplicationConf(ignoreParentConfig, path.normalize(path.join(pathToFolder, '..')));
   }
-};
+}
 
-export async function addLinkedApplication (appData, alias, ignoreParentConfig) {
+export async function addLinkedApplication(appData, alias, ignoreParentConfig) {
   const currentConfig = await loadApplicationConf(ignoreParentConfig);
 
   const appEntry = {
@@ -50,9 +47,9 @@ export async function addLinkedApplication (appData, alias, ignoreParentConfig)
   }
 
   return persistConfig(currentConfig);
-};
+}
 
-export async function removeLinkedApplication ({ appId, alias }) {
+export async function removeLinkedApplication({ appId, alias }) {
   const currentConfig = await loadApplicationConf();
   const appToUnlink = currentConfig.apps.find((a) => a.app_id === appId || a.alias === alias);
   if (appToUnlink == null) {
@@ -70,9 +67,9 @@ export async function removeLinkedApplication ({ appId, alias }) {
 
   await persistConfig(newConfig);
   return true;
-};
+}
 
-export function findApp (config, alias) {
+export function findApp(config, alias) {
   if (_.isEmpty(config.apps)) {
     throw new Error('There is no linked or targeted application. Use `--app` option or `clever link` command.');
   }
@@ -83,7 +80,9 @@ export function findApp (config, alias) {
       throw new Error(`There are no applications matching alias ${alias}`);
     }
     if (secondAppByAlias != null) {
-      throw new Error(`There are several applications matching alias ${alias}. This should not happen, your \`.clever.json\` should be fixed.`);
+      throw new Error(
+        `There are several applications matching alias ${alias}. This should not happen, your \`.clever.json\` should be fixed.`,
+      );
     }
     return appByAlias;
   }
@@ -91,7 +90,7 @@ export function findApp (config, alias) {
   return findDefaultApp(config);
 }
 
-export function checkAlreadyLinked (apps, name, alias) {
+export function checkAlreadyLinked(apps, name, alias) {
   const appAliasExists = apps.some((app) => app.alias != null && app.alias === alias);
   if (appAliasExists) {
     throw new Error(`An application is already linked with the alias '${alias}'`);
@@ -103,7 +102,7 @@ export function checkAlreadyLinked (apps, name, alias) {
   }
 }
 
-function findDefaultApp (config) {
+function findDefaultApp(config) {
   if (_.isEmpty(config.apps)) {
     throw new Error('There is no linked or targeted application. Use `--app` option or `clever link` command.');
   }
@@ -111,7 +110,9 @@ function findDefaultApp (config) {
   if (config.default != null) {
     const defaultApp = _.find(config.apps, { app_id: config.default });
     if (defaultApp == null) {
-      throw new Error('The default application is not listed anymore. This should not happen, your `.clever.json` should be fixed.');
+      throw new Error(
+        'The default application is not listed anymore. This should not happen, your `.clever.json` should be fixed.',
+      );
     }
     return defaultApp;
   }
@@ -121,10 +122,12 @@ function findDefaultApp (config) {
   }
 
   const aliases = _.map(config.apps, 'alias').join(', ');
-  throw new Error(`Several applications are linked. You can specify one with the "--alias" option. Run "clever applications" to list linked applications. Available aliases: ${aliases}`);
+  throw new Error(
+    `Several applications are linked. You can specify one with the "--alias" option. Run "clever applications" to list linked applications. Available aliases: ${aliases}`,
+  );
 }
 
-async function getAppDetailsForId (appId) {
+async function getAppDetailsForId(appId) {
   const config = await loadApplicationConf();
 
   if (_.isEmpty(config.apps)) {
@@ -136,19 +139,19 @@ async function getAppDetailsForId (appId) {
     throw new Error(`There are no applications matching id '${appId}'`);
   }
   if (secondAppById != null) {
-    throw new Error(`There are several applications matching id '${appId}'.`
-      + 'This should not happen, your `.clever.json` should be fixed.');
+    throw new Error(
+      `There are several applications matching id '${appId}'.` +
+        'This should not happen, your `.clever.json` should be fixed.',
+    );
   }
 
   return appById;
 }
 
-export async function getAppDetails ({ alias }) {
+export async function getAppDetails({ alias }) {
   const config = await loadApplicationConf();
   const app = findApp(config, alias);
-  const ownerId = (app.org_id != null)
-    ? app.org_id
-    : await User.getCurrentId();
+  const ownerId = app.org_id != null ? app.org_id : await User.getCurrentId();
   return {
     appId: app.app_id,
     ownerId: ownerId,
@@ -156,24 +159,23 @@ export async function getAppDetails ({ alias }) {
     name: app.name,
     alias: app.alias,
   };
-};
+}
 
-export async function getMostNaturalName (appId) {
+export async function getMostNaturalName(appId) {
   try {
     const details = await getAppDetailsForId(appId);
     return details.alias || details.name || appId;
-  }
-  catch {
+  } catch {
     return appId;
   }
 }
 
-function persistConfig (modifiedConfig) {
+function persistConfig(modifiedConfig) {
   const jsonContents = JSON.stringify(modifiedConfig, null, 2);
   return fs.writeFile(conf.APP_CONFIGURATION_FILE, jsonContents);
-};
+}
 
-export async function setDefault (alias) {
+export async function setDefault(alias) {
   const config = await loadApplicationConf();
   const app = findApp(config, alias);
   const newConfig = { ...config, default: app.app_id };