feat(logs): support addon logs

Author: miton18

package-lock.json

@@ -26,7 +26,7 @@
     "scripts/*.sh"
   ],
   "dependencies": {
-    "@clevercloud/client": "9.2.0",
+    "@clevercloud/client": "file:../clever-client.js",
     "@inquirer/prompts": "7.3.2",
     "cliparse": "0.5.0",
     "colors": "1.4.0",

package.json

@@ -4,7 +4,7 @@ import * as Log from '../models/log-v4.js';
 import { Logger } from '../logger.js';
 import { Deferred } from '../models/utils.js';
 import colors from 'colors/safe.js';
-import { resolveAddonId } from '../models/ids-resolver.js';
+import { resolveAddonId,  resolveRealId, resolveOwnerId  } from '../models/ids-resolver.js';
 
 export async function appLogs (params) {
   const { alias, app: appIdOrName, addon: addonIdOrRealId, after: since, before: until, search, 'deployment-id': deploymentId, format } = params.options;
@@ -13,18 +13,14 @@ export async function appLogs (params) {
   const filter = (search !== '') ? search : null;
   const isForHuman = (format === 'human');
 
-  // TODO: drop when addons are migrated to the v4 API
   if (addonIdOrRealId != null) {
-    const addonId = await resolveAddonId(addonIdOrRealId);
-    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 });
+    return addonLogs({addonIdOrRealId, isForHuman, since, until, filter, format, since, until, deploymentId, format, filter});
   }
 
+  applicationLogs({appIdOrName, alias, isForHuman})
+}
+
+async function applicationLogs({appIdOrName, alias, isForHuman, since, until, deploymentId, format, filter}) {
   const { ownerId, appId } = await Application.resolveId(appIdOrName, alias);
 
   if (isForHuman) {
@@ -35,3 +31,22 @@ export async function appLogs (params) {
   await Log.displayLogs({ ownerId, appId, since, until, filter, deploymentId, format, deferred });
   return deferred.promise;
 }
+
+async function addonLogs({addonIdOrRealId, isForHuman, since, until, filter, format}) {
+  let addonId = addonIdOrRealId
+  if(addonId.startsWith("addon_")) {
+    addonId = await resolveRealId(addonIdOrRealId);
+  }
+
+  const ownerId = await resolveOwnerId(addonId)
+
+  if (isForHuman) {
+    Logger.println(colors.blue('Waiting for addon logs…'));
+  }
+
+  const deferred = new Deferred();
+  console.log({ ownerId, addonId, since, until, filter, format, deferred })
+  await Log.displayAddonLogs({ ownerId, addonId, since, until, filter, format, deferred });
+  return deferred.promise;
+}
+

src/commands/logs.js

@@ -0,0 +1,105 @@
+
+// Wait for https://github.com/CleverCloud/clever-client.js/pull/129 to be merged
+const _cleverCloudSse = require('@clevercloud/client/cjs/streams/clever-cloud-sse.js');
+
+const RESOURCE_LOG_EVENT_NAME = 'RESOURCE_LOG';
+
+class ApplicationAddonLogStream extends _cleverCloudSse.default {
+  /**
+   * @param {object} options
+   * @param {string} options.apiHost
+   * @param {object} options.tokens
+   * @param {string} options.tokens.OAUTH_CONSUMER_KEY
+   * @param {string} options.tokens.OAUTH_CONSUMER_SECRET
+   * @param {string} options.tokens.API_OAUTH_TOKEN
+   * @param {string} options.tokens.API_OAUTH_TOKEN_SECRET
+   * @param {string} options.ownerId
+   * @param {string} options.addonId
+   * @param {number} options.connectionTimeout
+   * @param {object} options.retryConfiguration
+   * @param {boolean} options.retryConfiguration.enabled
+   * @param {number} options.retryConfiguration.backoffFactor
+   * @param {number} options.retryConfiguration.initRetryTimeout
+   * @param {number} options.retryConfiguration.maxRetryCount
+   * @param {Date} options.since
+   * @param {Date} options.until
+   * @param {number} options.limit
+   * @param {string} options.filter
+   * @param {string} options.field[]
+   * @param {number} options.throttleElements
+   * @param {number} options.throttlePerInMilliseconds
+   */
+  constructor({
+    apiHost,
+    tokens,
+    ownerId,
+    addonId,
+    retryConfiguration,
+    connectionTimeout,
+    ...options
+  }) {
+    super(apiHost, tokens, retryConfiguration ?? {}, connectionTimeout);
+    this._ownerId = ownerId;
+    this._addonId = addonId;
+    this._options = options; // Count the number of logs, so we can update the "limit" query param on pause/resume or error/retry
+
+    this._logsCount = 0;
+    this.onLog(() => {
+      this._logsCount++;
+    });
+  }
+  /**
+   * compute full URL with query params
+   * @returns {URL}
+   */
+
+
+  getUrl() {
+    return this.buildUrl(`/v4/logs/organisations/${this._ownerId}/resources/${this._addonId}/logs`, { ...this._options,
+      // in case of pause() then resume():
+      // we don' t want N another logs, we want the initial passed number less the events count already received
+      limit: this._computedLimit(),
+      service: 'all' // TODO: debug
+    });
+  } // compute the number of events to retrieve, based on elements already received
+
+
+  _computedLimit() {
+    if (this._options.limit == null) {
+      return null;
+    }
+
+    return Math.max(this._options.limit - this._logsCount, 0);
+  }
+  /**
+   * override default method
+   */
+
+
+  transform(event, data) {
+    if (event !== RESOURCE_LOG_EVENT_NAME) {
+      return data;
+    }
+
+    const log = JSON.parse(data);
+
+    if (log.date) {
+      log.date = new Date(log.date);
+    }
+
+    return log;
+  }
+  /**
+   * shortcut for .on('APPLICATION_LOG', (event) => ...)
+   * @param {Function} fn which handle logs
+   * @returns {any}
+   */
+
+
+  onLog(fn) {
+    return this.on(RESOURCE_LOG_EVENT_NAME, event => fn(event.data));
+  }
+
+}
+
+module.exports = {ApplicationAddonLogStream}

src/models/AddonLogs.js

@@ -52,7 +52,7 @@ export async function resolveRealId (id) {
     return realId;
   }
 
-  throw new Error(`Add-on ${id} does not exist foo`);
+  throw new Error(`Add-on ${id} does not exist`);
 }
 
 async function getIdFromCacheOrSummary (callback) {