clever-tools 4.2.0 → 4.4.0

package/src/models/drain.js

@@ -1,133 +1,29 @@
-import cliparse from 'cliparse';
-
-const DRAIN_TYPES = [
-  { id: 'TCPSyslog', structuredDataParameters: 'OPTIONAL' },
-  { id: 'UDPSyslog', structuredDataParameters: 'OPTIONAL' },
-  { id: 'HTTP', credentials: 'OPTIONAL' },
-  { id: 'ElasticSearch', credentials: 'MANDATORY', indexPrefix: 'OPTIONAL' },
-  { id: 'DatadogHTTP' },
-  { id: 'NewRelicHTTP', apiKey: 'MANDATORY' },
-];
-
-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.",
-    );
-  }
-
-  const body = {
-    url: drainTargetURL,
-    drainType: drainTargetType,
-  };
-  if (credentialsExist(drainTargetCredentials)) {
-    body.credentials = {
-      username: drainTargetCredentials.username || '',
-      password: drainTargetCredentials.password || '',
-    };
-  }
-  if (keyExist(drainTargetConfig)) {
-    body.APIKey = drainTargetConfig.apiKey;
-  }
-  if (indexPrefixExist(drainTargetConfig)) {
-    body.indexPrefix = drainTargetConfig.indexPrefix;
-  }
-  if (structuredDataParametersExist(drainTargetConfig)) {
-    body.structuredDataParameters = drainTargetConfig.structuredDataParameters;
-  }
-  return body;
-}
-
-export function authorizeDrainCreation(drainTargetType, drainTargetCredentials, drainTargetConfig) {
-  if (drainTypeExists(drainTargetType)) {
-    // retrieve field for drain type ('mandatory', 'optional', undefined)
-    const credStatus = fieldStatus(drainTargetType).credentials;
-    const keyStatus = fieldStatus(drainTargetType).apiKey;
-    const indexPrefixStatus = fieldStatus(drainTargetType).indexPrefix;
-    const structuredDataParametersStatus = fieldStatus(drainTargetType).structuredDataParameters;
-
-    if (credStatus === 'MANDATORY') {
-      return credentialsExist(drainTargetCredentials);
-    }
-    if (credStatus === 'OPTIONAL') {
-      return true;
-    }
-    if (!credStatus && !keyStatus) {
-      return credentialsEmpty(drainTargetCredentials);
-    }
-
-    if (keyStatus === 'MANDATORY') {
-      return keyExist(drainTargetConfig);
-    }
-    if (keyStatus === 'OPTIONAL') {
-      return true;
-    }
-    if (!keyStatus) {
-      return keyEmpty(drainTargetConfig);
-    }
-
-    if (indexPrefixStatus === 'MANDATORY') {
-      return indexPrefixExist(drainTargetConfig);
-    }
-    if (indexPrefixStatus === 'OPTIONAL') {
-      return true;
-    }
-    if (!indexPrefixStatus) {
-      return indexPrefixEmpty(drainTargetConfig);
-    }
-
-    if (structuredDataParametersStatus === 'MANDATORY') {
-      return structuredDataParametersExist(drainTargetConfig);
-    }
-    if (structuredDataParametersStatus === 'OPTIONAL') {
-      return true;
-    }
-    if (!structuredDataParametersStatus) {
-      return structuredDataParametersEmpty(drainTargetConfig);
-    }
-  }
-}
-
-function fieldStatus(drainTargetType) {
-  return DRAIN_TYPES.find(({ id }) => id === drainTargetType);
-}
-
-function drainTypeExists(drainTargetType) {
-  return DRAIN_TYPES.some(({ id }) => id === drainTargetType);
-}
-
-function credentialsExist({ username, password }) {
-  return username != null && password != null;
-}
-
-function credentialsEmpty({ username, password }) {
-  return username == null && password == null;
-}
-
-function indexPrefixExist({ indexPrefix }) {
-  return indexPrefix != null;
-}
-
-function indexPrefixEmpty({ indexPrefix }) {
-  return indexPrefix == null;
-}
-
-function structuredDataParametersExist({ structuredDataParameters }) {
-  return structuredDataParameters != null;
-}
-
-function structuredDataParametersEmpty({ structuredDataParameters }) {
-  return structuredDataParameters == null;
-}
-
-function keyExist({ apiKey }) {
-  return apiKey != null;
-}
-
-function keyEmpty({ apiKey }) {
-  return apiKey == null;
-}
-
-export function listDrainTypes() {
-  return cliparse.autocomplete.words(DRAIN_TYPES.map((type) => type.id));
+export const DRAIN_TYPES = {
+  DATADOG: { apiCode: 'DATADOG', cliCode: 'datadog', label: 'Datadog' },
+  ELASTICSEARCH: { apiCode: 'ELASTICSEARCH', cliCode: 'elasticsearch', label: 'Elasticsearch' },
+  NEWRELIC: { apiCode: 'NEWRELIC', cliCode: 'newrelic', label: 'New Relic' },
+  OVH_TCP: { apiCode: 'OVH_TCP', cliCode: 'ovh-tcp', label: 'OVH TCP' },
+  RAW_HTTP: { apiCode: 'RAW_HTTP', cliCode: 'raw-http', label: 'Raw HTTP' },
+  SYSLOG_TCP: { apiCode: 'SYSLOG_TCP', cliCode: 'syslog-tcp', label: 'Syslog TCP' },
+  SYSLOG_UDP: { apiCode: 'SYSLOG_UDP', cliCode: 'syslog-udp', label: 'Syslog UDP' },
+};
+
+export const DRAIN_TYPE_CLI_CODES = Object.values(DRAIN_TYPES).map(({ cliCode }) => cliCode);
+
+export function formatDrain(rawDrain) {
+  const drainType = DRAIN_TYPES[rawDrain.recipient.type];
+  const drainDetails = [
+    ['ID', rawDrain.id],
+    ['Status', rawDrain.status.status],
+    ['Execution status', rawDrain.execution.status],
+    ['URL', rawDrain.recipient.url],
+    ['Type', drainType.label],
+    ['Custom index', rawDrain.recipient.index],
+    ['SD parameters', rawDrain.recipient.rfc5424StructuredDataParameters],
+    ['Message output rate', Math.floor(rawDrain.backlog.msgRateOut * 60) + ' messages/minute'],
+    ['Message throughput', Math.floor(rawDrain.backlog.msgRateOut) + ' bytes/second'],
+    ['Backlog', rawDrain.backlog.msgBacklog + ' pending messages'],
+    ['Last error', rawDrain.execution.lastError],
+  ];
+  return Object.fromEntries(drainDetails.filter(([_name, value]) => value != null));
 }

package/src/models/ids-resolver.js

@@ -1,6 +1,8 @@
 import { getSummary } from '@clevercloud/client/esm/api/v2/user.js';
 import { Logger } from '../logger.js';
+import * as User from '../models/user.js';
 import { loadIdsCache, writeIdsCache } from './configuration.js';
+import * as Organisation from './organisation.js';
 import { sendToApi } from './send-to-api.js';
 
 /*
@@ -171,3 +173,12 @@ export async function findAddonsByAddonProvider(provider) {
 
   return candidates;
 }
+
+/**
+ * Get the owner ID from an Organisation ID or name
+ * @param {object} orgIdOrName The Organisation ID or name
+ * @returns {Promise<string>} The owner ID
+ */
+export async function getOwnerIdFromOrgIdOrName(orgIdOrName) {
+  return orgIdOrName != null ? Organisation.getId(orgIdOrName) : User.getCurrentId();
+}

package/src/models/ng.js

@@ -9,10 +9,9 @@ import crypto from 'node:crypto';
 import { searchNetworkGroupOrResource } from '../clever-client/ng.js';
 import { styleText } from '../lib/style-text.js';
 import { Logger } from '../logger.js';
+import { getOwnerIdFromOrgIdOrName } from './ids-resolver.js';
 import { checkMembersToLink } from './ng-resources.js';
-import * as Organisation from './organisation.js';
 import { sendToApi } from './send-to-api.js';
-import * as User from './user.js';
 
 export const POLLING_TIMEOUT_MS = 30_000;
 export const POLLING_INTERVAL_MS = 1000;
@@ -38,7 +37,7 @@ export const NG_MEMBER_PREFIXES = {
  */
 export async function create(label, description, tags, membersIds, orgaIdOrName) {
   const id = `ng_${crypto.randomUUID()}`;
-  const ownerId = await getOwnerIdFromOrgaIdOrName(orgaIdOrName);
+  const ownerId = await getOwnerIdFromOrgIdOrName(orgaIdOrName);
 
   if (membersIds?.length > 0) {
     checkMembersToLink(membersIds);
@@ -126,7 +125,7 @@ export async function getPeerConfig(peerIdOrLabel, ngIdOrLabel, orgaIdOrName) {
  * @returns {Promise<Array<Object>>} The Network Groups
  */
 export async function getNG(networkGroupId, orgaIdOrName) {
-  const ownerId = await getOwnerIdFromOrgaIdOrName(orgaIdOrName);
+  const ownerId = await getOwnerIdFromOrgIdOrName(orgaIdOrName);
 
   Logger.info(`Get Network Group ${networkGroupId} for owner ${ownerId}`);
   const result = await getNetworkGroup({ networkGroupId, ownerId }).then(sendToApi);
@@ -141,7 +140,7 @@ export async function getNG(networkGroupId, orgaIdOrName) {
  * @returns {Promise<Array<Object>>} The Network Groups
  */
 export async function getAllNGs(orgaIdOrName) {
-  const ownerId = await getOwnerIdFromOrgaIdOrName(orgaIdOrName);
+  const ownerId = await getOwnerIdFromOrgIdOrName(orgaIdOrName);
 
   Logger.info(`Listing Network Groups from owner ${ownerId}`);
   const result = await listNetworkGroups({ ownerId }).then(sendToApi);
@@ -159,7 +158,7 @@ export async function getAllNGs(orgaIdOrName) {
  * @returns {Promise<Object>} Found results
  */
 export async function searchNgOrResource(idOrLabel, orgaIdOrName, type = 'all', exactMatch = true) {
-  const ownerId = await getOwnerIdFromOrgaIdOrName(orgaIdOrName);
+  const ownerId = await getOwnerIdFromOrgIdOrName(orgaIdOrName);
 
   // If idOrLabel is a string we use it, or we look through multiple keys
   const query =
@@ -265,12 +264,3 @@ async function pollNetworkGroup(ownerId, ngId, { waitForMembers = null, waitForD
     pollOnce();
   });
 }
-
-/**
- * Get the owner ID from an Organisation ID or name
- * @param {object} orgaIdOrName The Organisation ID or name
- * @returns {Promise<string>} The owner ID
- */
-async function getOwnerIdFromOrgaIdOrName(orgaIdOrName) {
-  return orgaIdOrName != null ? Organisation.getId(orgaIdOrName) : User.getCurrentId();
-}

package/src/parsers.js

@@ -100,12 +100,13 @@ export function orgaIdOrName(string) {
 const addonIdRegex = /^addon_[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$/i;
 const operatorIdRegex =
   /^(keycloak|otoroshi|matomo|metabase)_[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$/i;
+const ulidRegex = /^(kubernetes)_[0-9A-HJ-NP-TV-Z]{26}$/i;
 
 export function addonIdOrName(string) {
   if (string.match(addonIdRegex)) {
     return cliparse.parsers.success({ addon_id: string });
   }
-  if (string.match(operatorIdRegex)) {
+  if (string.match(operatorIdRegex) || string.match(ulidRegex)) {
     return cliparse.parsers.success({ operator_id: string });
   }
   return cliparse.parsers.success({ addon_name: string });