appwrite-cli 4.2.0 → 4.2.2

package/lib/commands/health.js

@@ -9,382 +9,584 @@ const { Command } = require('commander');
 const { sdkForProject, sdkForConsole } = require('../sdks')
 const { parse, actionRunner, parseInteger, parseBool, commandDescriptions, success, log } = require('../parser')
 const { localConfig, globalConfig } = require("../config");
+const { File } = require('undici');
+const { ReadableStream } = require('stream/web');
+
+/**
+ * @param {fs.ReadStream} readStream
+ * @returns {ReadableStream}
+ */
+function convertReadStreamToReadableStream(readStream) {
+  return new ReadableStream({
+    start(controller) {
+      readStream.on("data", (chunk) => {
+        controller.enqueue(chunk);
+      });
+      readStream.on("end", () => {
+        controller.close();
+      });
+      readStream.on("error", (err) => {
+        controller.error(err);
+      });
+    },
+    cancel() {
+      readStream.destroy();
+    },
+  });
+}
 
 const health = new Command("health").description(commandDescriptions['health']).configureHelp({
     helpWidth: process.stdout.columns || 80
-  })
+})
 
-const healthGet = async ({ parseOutput = true, sdk = undefined}) => {
+/**
+ * @typedef {Object} HealthGetRequestParams
+ * @property {boolean} parseOutput
+ * @property {libClient | undefined} sdk
+ */
 
+/**
+ * @param {HealthGetRequestParams} params
+ */
+const healthGet = async ({ parseOutput = true, sdk = undefined}) => {
     let client = !sdk ? await sdkForProject() : sdk;
     let apiPath = '/health';
     let payload = {};
+
     let response = undefined;
+
     response = await client.call('get', apiPath, {
         'content-type': 'application/json',
     }, payload);
-    
+
     if (parseOutput) {
         parse(response)
         success()
     }
+    
     return response;
 }
 
-const healthGetAntivirus = async ({ parseOutput = true, sdk = undefined}) => {
+/**
+ * @typedef {Object} HealthGetAntivirusRequestParams
+ * @property {boolean} parseOutput
+ * @property {libClient | undefined} sdk
+ */
 
+/**
+ * @param {HealthGetAntivirusRequestParams} params
+ */
+const healthGetAntivirus = async ({ parseOutput = true, sdk = undefined}) => {
     let client = !sdk ? await sdkForProject() : sdk;
     let apiPath = '/health/anti-virus';
     let payload = {};
+
     let response = undefined;
+
     response = await client.call('get', apiPath, {
         'content-type': 'application/json',
     }, payload);
-    
+
     if (parseOutput) {
         parse(response)
         success()
     }
+    
     return response;
 }
 
-const healthGetCache = async ({ parseOutput = true, sdk = undefined}) => {
+/**
+ * @typedef {Object} HealthGetCacheRequestParams
+ * @property {boolean} parseOutput
+ * @property {libClient | undefined} sdk
+ */
 
+/**
+ * @param {HealthGetCacheRequestParams} params
+ */
+const healthGetCache = async ({ parseOutput = true, sdk = undefined}) => {
     let client = !sdk ? await sdkForProject() : sdk;
     let apiPath = '/health/cache';
     let payload = {};
+
     let response = undefined;
+
     response = await client.call('get', apiPath, {
         'content-type': 'application/json',
     }, payload);
-    
+
     if (parseOutput) {
         parse(response)
         success()
     }
+    
     return response;
 }
 
-const healthGetDB = async ({ parseOutput = true, sdk = undefined}) => {
+/**
+ * @typedef {Object} HealthGetDBRequestParams
+ * @property {boolean} parseOutput
+ * @property {libClient | undefined} sdk
+ */
 
+/**
+ * @param {HealthGetDBRequestParams} params
+ */
+const healthGetDB = async ({ parseOutput = true, sdk = undefined}) => {
     let client = !sdk ? await sdkForProject() : sdk;
     let apiPath = '/health/db';
     let payload = {};
+
     let response = undefined;
+
     response = await client.call('get', apiPath, {
         'content-type': 'application/json',
     }, payload);
-    
+
     if (parseOutput) {
         parse(response)
         success()
     }
+    
     return response;
 }
 
-const healthGetPubSub = async ({ parseOutput = true, sdk = undefined}) => {
+/**
+ * @typedef {Object} HealthGetPubSubRequestParams
+ * @property {boolean} parseOutput
+ * @property {libClient | undefined} sdk
+ */
 
+/**
+ * @param {HealthGetPubSubRequestParams} params
+ */
+const healthGetPubSub = async ({ parseOutput = true, sdk = undefined}) => {
     let client = !sdk ? await sdkForProject() : sdk;
     let apiPath = '/health/pubsub';
     let payload = {};
+
     let response = undefined;
+
     response = await client.call('get', apiPath, {
         'content-type': 'application/json',
     }, payload);
-    
+
     if (parseOutput) {
         parse(response)
         success()
     }
+    
     return response;
 }
 
-const healthGetQueue = async ({ parseOutput = true, sdk = undefined}) => {
+/**
+ * @typedef {Object} HealthGetQueueRequestParams
+ * @property {boolean} parseOutput
+ * @property {libClient | undefined} sdk
+ */
 
+/**
+ * @param {HealthGetQueueRequestParams} params
+ */
+const healthGetQueue = async ({ parseOutput = true, sdk = undefined}) => {
     let client = !sdk ? await sdkForProject() : sdk;
     let apiPath = '/health/queue';
     let payload = {};
+
     let response = undefined;
+
     response = await client.call('get', apiPath, {
         'content-type': 'application/json',
     }, payload);
-    
+
     if (parseOutput) {
         parse(response)
         success()
     }
+    
     return response;
 }
 
-const healthGetQueueBuilds = async ({ threshold, parseOutput = true, sdk = undefined}) => {
-    /* @param {number} threshold */
+/**
+ * @typedef {Object} HealthGetQueueBuildsRequestParams
+ * @property {number} threshold Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
+ * @property {boolean} parseOutput
+ * @property {libClient | undefined} sdk
+ */
 
+/**
+ * @param {HealthGetQueueBuildsRequestParams} params
+ */
+const healthGetQueueBuilds = async ({ threshold, parseOutput = true, sdk = undefined}) => {
     let client = !sdk ? await sdkForProject() : sdk;
     let apiPath = '/health/queue/builds';
     let payload = {};
-
-    /** Query Params */
     if (typeof threshold !== 'undefined') {
         payload['threshold'] = threshold;
     }
+
     let response = undefined;
+
     response = await client.call('get', apiPath, {
         'content-type': 'application/json',
     }, payload);
-    
+
     if (parseOutput) {
         parse(response)
         success()
     }
+    
     return response;
 }
 
-const healthGetQueueCertificates = async ({ threshold, parseOutput = true, sdk = undefined}) => {
-    /* @param {number} threshold */
+/**
+ * @typedef {Object} HealthGetQueueCertificatesRequestParams
+ * @property {number} threshold Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
+ * @property {boolean} parseOutput
+ * @property {libClient | undefined} sdk
+ */
 
+/**
+ * @param {HealthGetQueueCertificatesRequestParams} params
+ */
+const healthGetQueueCertificates = async ({ threshold, parseOutput = true, sdk = undefined}) => {
     let client = !sdk ? await sdkForProject() : sdk;
     let apiPath = '/health/queue/certificates';
     let payload = {};
-
-    /** Query Params */
     if (typeof threshold !== 'undefined') {
         payload['threshold'] = threshold;
     }
+
     let response = undefined;
+
     response = await client.call('get', apiPath, {
         'content-type': 'application/json',
     }, payload);
-    
+
     if (parseOutput) {
         parse(response)
         success()
     }
+    
     return response;
 }
 
+/**
+ * @typedef {Object} HealthGetQueueDatabasesRequestParams
+ * @property {string} name Queue name for which to check the queue size
+ * @property {number} threshold Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
+ * @property {boolean} parseOutput
+ * @property {libClient | undefined} sdk
+ */
+
+/**
+ * @param {HealthGetQueueDatabasesRequestParams} params
+ */
 const healthGetQueueDatabases = async ({ name, threshold, parseOutput = true, sdk = undefined}) => {
-    /* @param {string} name */
-    /* @param {number} threshold */
-
     let client = !sdk ? await sdkForProject() : sdk;
     let apiPath = '/health/queue/databases';
     let payload = {};
-
-    /** Query Params */
     if (typeof name !== 'undefined') {
         payload['name'] = name;
     }
     if (typeof threshold !== 'undefined') {
         payload['threshold'] = threshold;
     }
+
     let response = undefined;
+
     response = await client.call('get', apiPath, {
         'content-type': 'application/json',
     }, payload);
-    
+
     if (parseOutput) {
         parse(response)
         success()
     }
+    
     return response;
 }
 
-const healthGetQueueDeletes = async ({ threshold, parseOutput = true, sdk = undefined}) => {
-    /* @param {number} threshold */
+/**
+ * @typedef {Object} HealthGetQueueDeletesRequestParams
+ * @property {number} threshold Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
+ * @property {boolean} parseOutput
+ * @property {libClient | undefined} sdk
+ */
 
+/**
+ * @param {HealthGetQueueDeletesRequestParams} params
+ */
+const healthGetQueueDeletes = async ({ threshold, parseOutput = true, sdk = undefined}) => {
     let client = !sdk ? await sdkForProject() : sdk;
     let apiPath = '/health/queue/deletes';
     let payload = {};
-
-    /** Query Params */
     if (typeof threshold !== 'undefined') {
         payload['threshold'] = threshold;
     }
+
     let response = undefined;
+
     response = await client.call('get', apiPath, {
         'content-type': 'application/json',
     }, payload);
-    
+
     if (parseOutput) {
         parse(response)
         success()
     }
+    
     return response;
 }
 
-const healthGetQueueFunctions = async ({ threshold, parseOutput = true, sdk = undefined}) => {
-    /* @param {number} threshold */
+/**
+ * @typedef {Object} HealthGetQueueFunctionsRequestParams
+ * @property {number} threshold Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
+ * @property {boolean} parseOutput
+ * @property {libClient | undefined} sdk
+ */
 
+/**
+ * @param {HealthGetQueueFunctionsRequestParams} params
+ */
+const healthGetQueueFunctions = async ({ threshold, parseOutput = true, sdk = undefined}) => {
     let client = !sdk ? await sdkForProject() : sdk;
     let apiPath = '/health/queue/functions';
     let payload = {};
-
-    /** Query Params */
     if (typeof threshold !== 'undefined') {
         payload['threshold'] = threshold;
     }
+
     let response = undefined;
+
     response = await client.call('get', apiPath, {
         'content-type': 'application/json',
     }, payload);
-    
+
     if (parseOutput) {
         parse(response)
         success()
     }
+    
     return response;
 }
 
-const healthGetQueueLogs = async ({ threshold, parseOutput = true, sdk = undefined}) => {
-    /* @param {number} threshold */
+/**
+ * @typedef {Object} HealthGetQueueLogsRequestParams
+ * @property {number} threshold Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
+ * @property {boolean} parseOutput
+ * @property {libClient | undefined} sdk
+ */
 
+/**
+ * @param {HealthGetQueueLogsRequestParams} params
+ */
+const healthGetQueueLogs = async ({ threshold, parseOutput = true, sdk = undefined}) => {
     let client = !sdk ? await sdkForProject() : sdk;
     let apiPath = '/health/queue/logs';
     let payload = {};
-
-    /** Query Params */
     if (typeof threshold !== 'undefined') {
         payload['threshold'] = threshold;
     }
+
     let response = undefined;
+
     response = await client.call('get', apiPath, {
         'content-type': 'application/json',
     }, payload);
-    
+
     if (parseOutput) {
         parse(response)
         success()
     }
+    
     return response;
 }
 
-const healthGetQueueMails = async ({ threshold, parseOutput = true, sdk = undefined}) => {
-    /* @param {number} threshold */
+/**
+ * @typedef {Object} HealthGetQueueMailsRequestParams
+ * @property {number} threshold Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
+ * @property {boolean} parseOutput
+ * @property {libClient | undefined} sdk
+ */
 
+/**
+ * @param {HealthGetQueueMailsRequestParams} params
+ */
+const healthGetQueueMails = async ({ threshold, parseOutput = true, sdk = undefined}) => {
     let client = !sdk ? await sdkForProject() : sdk;
     let apiPath = '/health/queue/mails';
     let payload = {};
-
-    /** Query Params */
     if (typeof threshold !== 'undefined') {
         payload['threshold'] = threshold;
     }
+
     let response = undefined;
+
     response = await client.call('get', apiPath, {
         'content-type': 'application/json',
     }, payload);
-    
+
     if (parseOutput) {
         parse(response)
         success()
     }
+    
     return response;
 }
 
-const healthGetQueueMessaging = async ({ threshold, parseOutput = true, sdk = undefined}) => {
-    /* @param {number} threshold */
+/**
+ * @typedef {Object} HealthGetQueueMessagingRequestParams
+ * @property {number} threshold Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
+ * @property {boolean} parseOutput
+ * @property {libClient | undefined} sdk
+ */
 
+/**
+ * @param {HealthGetQueueMessagingRequestParams} params
+ */
+const healthGetQueueMessaging = async ({ threshold, parseOutput = true, sdk = undefined}) => {
     let client = !sdk ? await sdkForProject() : sdk;
     let apiPath = '/health/queue/messaging';
     let payload = {};
-
-    /** Query Params */
     if (typeof threshold !== 'undefined') {
         payload['threshold'] = threshold;
     }
+
     let response = undefined;
+
     response = await client.call('get', apiPath, {
         'content-type': 'application/json',
     }, payload);
-    
+
     if (parseOutput) {
         parse(response)
         success()
     }
+    
     return response;
 }
 
-const healthGetQueueMigrations = async ({ threshold, parseOutput = true, sdk = undefined}) => {
-    /* @param {number} threshold */
+/**
+ * @typedef {Object} HealthGetQueueMigrationsRequestParams
+ * @property {number} threshold Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
+ * @property {boolean} parseOutput
+ * @property {libClient | undefined} sdk
+ */
 
+/**
+ * @param {HealthGetQueueMigrationsRequestParams} params
+ */
+const healthGetQueueMigrations = async ({ threshold, parseOutput = true, sdk = undefined}) => {
     let client = !sdk ? await sdkForProject() : sdk;
     let apiPath = '/health/queue/migrations';
     let payload = {};
-
-    /** Query Params */
     if (typeof threshold !== 'undefined') {
         payload['threshold'] = threshold;
     }
+
     let response = undefined;
+
     response = await client.call('get', apiPath, {
         'content-type': 'application/json',
     }, payload);
-    
+
     if (parseOutput) {
         parse(response)
         success()
     }
+    
     return response;
 }
 
-const healthGetQueueWebhooks = async ({ threshold, parseOutput = true, sdk = undefined}) => {
-    /* @param {number} threshold */
+/**
+ * @typedef {Object} HealthGetQueueWebhooksRequestParams
+ * @property {number} threshold Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
+ * @property {boolean} parseOutput
+ * @property {libClient | undefined} sdk
+ */
 
+/**
+ * @param {HealthGetQueueWebhooksRequestParams} params
+ */
+const healthGetQueueWebhooks = async ({ threshold, parseOutput = true, sdk = undefined}) => {
     let client = !sdk ? await sdkForProject() : sdk;
     let apiPath = '/health/queue/webhooks';
     let payload = {};
-
-    /** Query Params */
     if (typeof threshold !== 'undefined') {
         payload['threshold'] = threshold;
     }
+
     let response = undefined;
+
     response = await client.call('get', apiPath, {
         'content-type': 'application/json',
     }, payload);
-    
+
     if (parseOutput) {
         parse(response)
         success()
     }
+    
     return response;
 }
 
-const healthGetStorageLocal = async ({ parseOutput = true, sdk = undefined}) => {
+/**
+ * @typedef {Object} HealthGetStorageLocalRequestParams
+ * @property {boolean} parseOutput
+ * @property {libClient | undefined} sdk
+ */
 
+/**
+ * @param {HealthGetStorageLocalRequestParams} params
+ */
+const healthGetStorageLocal = async ({ parseOutput = true, sdk = undefined}) => {
     let client = !sdk ? await sdkForProject() : sdk;
     let apiPath = '/health/storage/local';
     let payload = {};
+
     let response = undefined;
+
     response = await client.call('get', apiPath, {
         'content-type': 'application/json',
     }, payload);
-    
+
     if (parseOutput) {
         parse(response)
         success()
     }
+    
     return response;
 }
 
-const healthGetTime = async ({ parseOutput = true, sdk = undefined}) => {
+/**
+ * @typedef {Object} HealthGetTimeRequestParams
+ * @property {boolean} parseOutput
+ * @property {libClient | undefined} sdk
+ */
 
+/**
+ * @param {HealthGetTimeRequestParams} params
+ */
+const healthGetTime = async ({ parseOutput = true, sdk = undefined}) => {
     let client = !sdk ? await sdkForProject() : sdk;
     let apiPath = '/health/time';
     let payload = {};
+
     let response = undefined;
+
     response = await client.call('get', apiPath, {
         'content-type': 'application/json',
     }, payload);
-    
+
     if (parseOutput) {
         parse(response)
         success()
     }
+    
     return response;
 }
 
-
 health
     .command(`get`)
     .description(`Check the Appwrite HTTP server is up and responsive.`)
@@ -486,7 +688,6 @@ health
     .description(`Check the Appwrite server time is synced with Google remote NTP server. We use this technology to smoothly handle leap seconds with no disruptive events. The [Network Time Protocol](https://en.wikipedia.org/wiki/Network_Time_Protocol) (NTP) is used by hundreds of millions of computers and devices to synchronize their clocks over the Internet. If your computer sets its own clock, it likely uses NTP.`)
     .action(actionRunner(healthGetTime))
 
-
 module.exports = {
     health,
     healthGet,
@@ -507,4 +708,4 @@ module.exports = {
     healthGetQueueWebhooks,
     healthGetStorageLocal,
     healthGetTime
-};
+};