verteilen-core 1.4.15 → 1.4.19

package/dist/client/analysis.d.ts

@@ -1,6 +1,9 @@
 import { WebSocket } from 'ws';
 import { Header, Messager, Messager_log } from "../interface";
 import { Client } from './client';
+/**
+ * The analysis worker. decode the message received from cluster server
+ */
 export declare class ClientAnalysis {
     private messager;
     private messager_log;
@@ -11,12 +14,26 @@ export declare class ClientAnalysis {
     private resource_thread;
     private resource_cache;
     constructor(_messager: Messager, _messager_log: Messager_log, _client: Client);
+    /**
+     * Analysis the package
+     * @param h Package
+     * @param source Websocket instance
+     * @return
+     * * 0: Successfully execute command
+     * * 1: The header is undefined, cannot process
+     * * 2: Cannot find the header name match with function typeMap
+     */
     analysis: (h: Header | undefined, source: WebSocket) => 0 | 1 | 2;
     private execute_job;
     private release;
     private set_database;
     private set_libs;
     private exec_checker;
+    /**
+     * Network delay request
+     * @param data Dummy value, should always be 0
+     * @param source The cluster server websocket instance
+     */
     private pong;
     private plugin_info;
     private get_releases;

package/dist/client/analysis.js

@@ -34,6 +34,11 @@ var __importStar = (this && this.__importStar) || (function () {
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ClientAnalysis = void 0;
+// ========================
+//                           
+//      Share Codebase     
+//                           
+// ========================
 const child_process_1 = require("child_process");
 const interface_1 = require("../interface");
 const client_1 = require("./client");
@@ -42,6 +47,9 @@ const shell_1 = require("./shell");
 const fs_1 = require("fs");
 const path = __importStar(require("path"));
 const os = __importStar(require("os"));
+/**
+ * The analysis worker. decode the message received from cluster server
+ */
 class ClientAnalysis {
     messager;
     messager_log;
@@ -58,6 +66,15 @@ class ClientAnalysis {
         this.shell = new shell_1.ClientShell(_messager, _messager_log, this.client);
         this.exec = [];
     }
+    /**
+     * Analysis the package
+     * @param h Package
+     * @param source Websocket instance
+     * @return
+     * * 0: Successfully execute command
+     * * 1: The header is undefined, cannot process
+     * * 2: Cannot find the header name match with function typeMap
+     */
     analysis = (h, source) => {
         const typeMap = {
             'execute_job': this.execute_job,
@@ -135,6 +152,11 @@ class ClientAnalysis {
         }
         return r;
     };
+    /**
+     * Network delay request
+     * @param data Dummy value, should always be 0
+     * @param source The cluster server websocket instance
+     */
     pong = (data, source) => {
         const h = { name: 'pong', data: data };
         source.send(JSON.stringify(h));

package/dist/client/client.d.ts

@@ -1,5 +1,9 @@
 import { WebSocket } from 'ws';
 import { Messager, Messager_log, PluginNode } from '../interface';
+/**
+ * **Compute Client**\
+ * The calculation node worker
+ */
 export declare class Client {
     plugins: PluginNode;
     private httpss;
@@ -9,14 +13,27 @@ export declare class Client {
     private messager_log;
     private analysis;
     private updatehandle;
+    /**
+     * Get connected client count
+     */
     get count(): number;
+    /**
+     * Get connected client list instance
+     */
     get clients(): Array<WebSocket>;
     constructor(_messager: Messager, _messager_log: Messager_log);
     Dispose(): void;
+    /**
+     * Start a websocket server, and waiting for cluster server to connect
+     */
     Init: () => Promise<void>;
     Destroy: () => void;
     Release: () => void;
     savePlugin: () => void;
+    /**
+     * The node update function, It will do things below
+     * * Send system info to cluster server
+     */
     private update;
     private loadPlugins;
     private get_pem;

package/dist/client/client.js

@@ -34,6 +34,11 @@ var __importStar = (this && this.__importStar) || (function () {
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Client = void 0;
+// ========================
+//                           
+//      Share Codebase     
+//                           
+// ========================
 const path = __importStar(require("path"));
 const tcp_port_used_1 = require("tcp-port-used");
 const ws = __importStar(require("ws"));
@@ -43,6 +48,10 @@ const fs_1 = require("fs");
 const os = __importStar(require("os"));
 const pem = __importStar(require("pem"));
 const https = __importStar(require("https"));
+/**
+ * **Compute Client**\
+ * The calculation node worker
+ */
 class Client {
     plugins = { plugins: [] };
     httpss = undefined;
@@ -52,9 +61,15 @@ class Client {
     messager_log;
     analysis;
     updatehandle;
+    /**
+     * Get connected client count
+     */
     get count() {
         return this.sources.length;
     }
+    /**
+     * Get connected client list instance
+     */
     get clients() {
         return this.sources;
     }
@@ -68,6 +83,9 @@ class Client {
     Dispose() {
         clearInterval(this.updatehandle);
     }
+    /**
+     * Start a websocket server, and waiting for cluster server to connect
+     */
     Init = async () => {
         let port_result = interface_1.PORT;
         let canbeuse = false;
@@ -144,6 +162,10 @@ class Client {
             (0, fs_1.mkdirSync)(f, { recursive: true });
         (0, fs_1.writeFileSync)(pluginPath, JSON.stringify(this.plugins, null, 4));
     };
+    /**
+     * The node update function, It will do things below
+     * * Send system info to cluster server
+     */
     update = () => {
         this.analysis.forEach(x => x.update(this));
     };
@@ -179,16 +201,17 @@ class Client {
         });
     };
     static workerPath = (filename = "worker", extension = ".exe") => {
+        // @ts-ignore
         const isExe = process.pkg?.entrypoint != undefined;
         const exe = process.platform == 'win32' ? filename + extension : filename;
         let workerExe = "";
         let p = 0;
-        if (isExe && path.basename(process.execPath) == (process.platform ? "app.exe" : 'app')) {
+        if (isExe && path.basename(process.execPath) == (process.platform ? "app.exe" : 'app')) { // Node build
             workerExe = path.join(process.execPath, "..", "bin", exe);
             p = 1;
         }
         else if ((process.mainModule && process.mainModule.filename.indexOf('app.asar') !== -1) ||
-            process.argv.filter(a => a.indexOf('app.asar') !== -1).length > 0) {
+            process.argv.filter(a => a.indexOf('app.asar') !== -1).length > 0) { // Electron package
             workerExe = path.join("bin", exe);
             p = 2;
         }
@@ -196,22 +219,29 @@ class Client {
             workerExe = path.join(process.cwd(), "bin", exe);
             p = 3;
         }
-        else {
+        else { // Node un-build
             workerExe = Client.isTypescript() ? path.join(__dirname, "bin", exe) : path.join(__dirname, "..", "bin", exe);
             p = 4;
         }
         return workerExe;
     };
     static isTypescript = () => {
+        // if this file is typescript, we are running typescript :D
+        // this is the best check, but fails when actionhero is compiled to js though...
         const extension = path.extname(__filename);
         if (extension === ".ts") {
             return true;
         }
+        // are we running via a ts-node/ts-node-dev shim?
         const lastArg = process.execArgv[process.execArgv.length - 1];
         if (lastArg && path.parse(lastArg).name.indexOf("ts-node") > 0) {
             return true;
         }
         try {
+            /**
+             * Are we running in typescript at the moment?
+             * see https://github.com/TypeStrong/ts-node/pull/858 for more details
+             */
             return process[Symbol.for("ts-node.register.instance")] ||
                 (process.env.NODE_ENV === "test" &&
                     process.env.ACTIONHERO_TEST_FILE_EXTENSION !== "js")

package/dist/client/cluster.d.ts

@@ -1 +1,4 @@
+/**
+ * The entry point for the cluster thread.
+ */
 export declare function RUN(): void;

package/dist/client/cluster.js

@@ -1,6 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.RUN = RUN;
+// ========================
+//                           
+//      Share Codebase     
+//                           
+// ========================
 const interface_1 = require("../interface");
 const http_1 = require("./http");
 const job_execute_1 = require("./job_execute");
@@ -16,6 +21,11 @@ process.stdin.on('data', (chunk) => {
         setTimeout(process.exit(1), 1000);
     }
 });
+/**
+ * The message handle for reply
+ * @param msg Message
+ * @param tag Message prefix
+ */
 const messager = (msg, tag) => {
     const d = {
         name: 'messager',
@@ -24,6 +34,11 @@ const messager = (msg, tag) => {
     };
     console.log(JSON.stringify(d));
 };
+/**
+ * The message handle for reply with print on screen ffeature
+ * @param msg Message
+ * @param tag Message prefix
+ */
 const messager_log = (msg, tag, meta) => {
     const d = {
         name: 'messager_log',
@@ -32,6 +47,10 @@ const messager_log = (msg, tag, meta) => {
     };
     console.log(JSON.stringify(d));
 };
+/**
+ * Return the error message to main thread
+ * @param err Error instance
+ */
 const ERROR = (err) => {
     const d = {
         name: "error",
@@ -41,6 +60,9 @@ const ERROR = (err) => {
     console.log(JSON.stringify(d));
     process.exit(1);
 };
+/**
+ * Job execute task
+ */
 const execute_job = () => {
     if (process.env.job == undefined || process.env.plugin == undefined) {
         process.exit(1);
@@ -54,6 +76,9 @@ const execute_job = () => {
     })
         .catch(err => ERROR(err));
 };
+/**
+ * Query resource task
+ */
 const execute_resource = () => {
     const r = new resource_1.ClientResource();
     messager("Resource query");
@@ -67,6 +92,9 @@ const execute_resource = () => {
         console.log(JSON.stringify(h));
     }).catch(err => ERROR(err));
 };
+/**
+ * Query http task
+ */
 const execute_http = () => {
     const m = process.env.method || 'GET';
     const u = process.env.url || '';
@@ -74,7 +102,11 @@ const execute_http = () => {
     const r = new http_1.ClientHTTP(u, m, p);
     r.RUN();
 };
+/**
+ * The entry point for the cluster thread.
+ */
 function RUN() {
+    // The cluster currently spawn should execute a job
     switch (process.env.type) {
         case 'JOB':
             execute_job();

package/dist/client/database.d.ts

@@ -1,10 +1,26 @@
 import WebSocket from "ws";
 import { Setter } from "../interface";
+/**
+ * The database feedback helper\
+ * Update the main database container on the cluster server
+ */
 export declare class ClientDatabase {
     private source;
     constructor(_source: WebSocket | undefined);
+    /**
+     * Update database number on the cluster server
+     * @param data Target KeyValue
+     */
     feedbacknumber: (data: Setter) => void;
+    /**
+     * Update database boolean on the cluster server
+     * @param data Target KeyValue
+     */
     feedbackboolean: (data: Setter) => void;
+    /**
+     * Update database string on the cluster server
+     * @param data Target KeyValue
+     */
     feedbackstring: (data: Setter) => void;
     feedbackobject: (data: Setter) => void;
     feedbacklist: (data: Setter) => void;

package/dist/client/database.js

@@ -1,17 +1,33 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ClientDatabase = void 0;
+/**
+ * The database feedback helper\
+ * Update the main database container on the cluster server
+ */
 class ClientDatabase {
     source;
     constructor(_source) {
         this.source = _source;
     }
+    /**
+     * Update database number on the cluster server
+     * @param data Target KeyValue
+     */
     feedbacknumber = (data) => {
         this.feedback("feedback_number", data);
     };
+    /**
+     * Update database boolean on the cluster server
+     * @param data Target KeyValue
+     */
     feedbackboolean = (data) => {
         this.feedback("feedback_boolean", data);
     };
+    /**
+     * Update database string on the cluster server
+     * @param data Target KeyValue
+     */
     feedbackstring = (data) => {
         this.feedback("feedback_string", data);
     };

package/dist/client/execute.d.ts

@@ -1,6 +1,9 @@
 import { WebSocket } from 'ws';
 import { Job, Libraries, Messager, Messager_log, Database, Setter } from "../interface";
 import { Client } from "./client";
+/**
+ * Execute worker, Execute the job container
+ */
 export declare class ClientExecute {
     uuid: string;
     private database;
@@ -12,13 +15,43 @@ export declare class ClientExecute {
     private messager_log;
     get count(): number;
     constructor(_uuid: string, _messager: Messager, _messager_log: Messager_log, _client: Client);
+    /**
+     * The stop signal, It will trying to kill the process if currently running
+     */
     stop_job: () => void;
+    /**
+     * The entry function to execute the job container
+     * @param job Target job
+     */
     execute_job: (job: Job, source: WebSocket) => void;
     private execute_job_worker;
     private job_finish;
+    /**
+     * Update database, Called by cluster server
+     * @param data Target container
+     */
     set_database: (data: Database) => void;
+    /**
+     * Update libraries, Called by cluster server
+     * @param data Target container
+     */
     set_libs: (data: Libraries) => void;
+    /**
+     * Update database string, Called by cluster server
+     * @deprecated The method should not be used
+     * @param data Target keyvalue
+     */
     set_string: (data: Setter) => void;
+    /**
+     * Update database number, Called by cluster server
+     * @deprecated The method should not be used
+     * @param data Target keyvalue
+     */
     set_number: (data: Setter) => void;
+    /**
+     * Update database boolean, Called by cluster server
+     * @deprecated The method should not be used
+     * @param data Target keyvalue
+     */
     set_boolean: (data: Setter) => void;
 }

package/dist/client/execute.js

@@ -1,12 +1,20 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ClientExecute = void 0;
+// ========================
+//                           
+//      Share Codebase     
+//                           
+// ========================
 const child_process_1 = require("child_process");
 const ws_1 = require("ws");
 const interface_1 = require("../interface");
 const i18n_1 = require("../plugins/i18n");
 const client_1 = require("./client");
 const database_1 = require("./database");
+/**
+ * Execute worker, Execute the job container
+ */
 class ClientExecute {
     uuid;
     database = undefined;
@@ -25,6 +33,9 @@ class ClientExecute {
         this.messager = _messager;
         this.messager_log = _messager_log;
     }
+    /**
+     * The stop signal, It will trying to kill the process if currently running
+     */
     stop_job = () => {
         this.messager_log(`[Execute] Stop All: ${this.workers.length}`);
         this.workers.forEach(x => {
@@ -34,6 +45,10 @@ class ClientExecute {
             x.stdin.end();
         });
     };
+    /**
+     * The entry function to execute the job container
+     * @param job Target job
+     */
     execute_job = (job, source) => {
         this.messager_log(`[Execute] ${job.uuid}  ${job.category == interface_1.JobCategory.Execution ? i18n_1.i18n.global.t(interface_1.JobTypeText[job.type]) : i18n_1.i18n.global.t(interface_1.JobType2Text[job.type])}`, job.uuid, job.runtime_uuid);
         this.tag = job.uuid;
@@ -138,12 +153,25 @@ class ClientExecute {
         }
         this.tag = '';
     }
+    /**
+     * Update database, Called by cluster server
+     * @param data Target container
+     */
     set_database = (data) => {
         this.database = data;
     };
+    /**
+     * Update libraries, Called by cluster server
+     * @param data Target container
+     */
     set_libs = (data) => {
         this.libraries = data;
     };
+    /**
+     * Update database string, Called by cluster server
+     * @deprecated The method should not be used
+     * @param data Target keyvalue
+     */
     set_string = (data) => {
         if (this.database == undefined)
             return;
@@ -152,6 +180,11 @@ class ClientExecute {
             this.database.containers[index].value = data.value;
         this.messager_log(`[Database string sync] ${data.key} = ${data.value}`);
     };
+    /**
+     * Update database number, Called by cluster server
+     * @deprecated The method should not be used
+     * @param data Target keyvalue
+     */
     set_number = (data) => {
         if (this.database == undefined)
             return;
@@ -160,6 +193,11 @@ class ClientExecute {
             this.database.containers[index].value = data.value;
         this.messager_log(`[Database number sync] ${data.key} = ${data.value}`);
     };
+    /**
+     * Update database boolean, Called by cluster server
+     * @deprecated The method should not be used
+     * @param data Target keyvalue
+     */
     set_boolean = (data) => {
         if (this.database == undefined)
             return;

package/dist/client/javascript.d.ts

@@ -13,8 +13,31 @@ export declare class ClientJavascript {
     message: any;
     http: any;
     constructor(_messager: Messager, _messager_log: Messager_log, _getjob: Getjob);
+    /**
+     * Before running the js scripts, We must init first.\
+     * ! Otherwise it won't work or throw error
+     * @param _messager Message habndle
+     * @param _messager_log Message habndle with print on screen feature
+     * @param _clientos OS worker
+     * @param _para Database worker
+     * @param _getlib library getter method
+     * @param _getpara Database getter method
+     * @param _getjob Job getter method
+     */
     static Init: (_messager: Messager, _messager_log: Messager, _clientos: ClientOS, _para: ClientJobDatabase, _getlib: Getlib, _getpara: Getpara, _getjob: Getjob) => void;
+    /**
+     * Running js\
+     * With reference libraries\
+     * @param js js script text
+     * @param libs Libraries header names
+     * @returns Calcuate result
+     */
     JavascriptExecuteWithLib: (javascript: string, libs: Array<string>, log?: Messager) => Promise<any>;
+    /**
+     * Running js
+     * @param js js script text
+     * @returns Calcuate result
+     */
     JavascriptExecute: (javascript: string, log?: Messager) => Promise<any>;
     private getJavascriptEnv;
     private filename;

package/dist/client/javascript.js

@@ -34,6 +34,11 @@ var __importStar = (this && this.__importStar) || (function () {
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ClientJavascript = exports.safeEval = void 0;
+// ========================
+//                           
+//      Share Codebase     
+//                           
+// ========================
 const vm = __importStar(require("vm"));
 const interface_1 = require("../interface");
 const path = __importStar(require("path"));
@@ -73,6 +78,7 @@ let para = undefined;
 let waiting = 0;
 const tag = () => getjob?.()?.uuid ?? 'unknown';
 const runtime = () => getjob?.()?.runtime_uuid ?? 'unknown';
+//#region Global
 function has(key, checker) {
     const p = getpara?.() ?? undefined;
     if (p == undefined)
@@ -231,6 +237,7 @@ function setselect(key, value) {
     target.value = value;
     para?.feedbackobject({ key: key, value: value });
 }
+//#endregion
 class ClientJavascript {
     path;
     os;
@@ -298,6 +305,17 @@ class ClientJavascript {
             patch: this.httpPatch,
         };
     }
+    /**
+     * Before running the js scripts, We must init first.\
+     * ! Otherwise it won't work or throw error
+     * @param _messager Message habndle
+     * @param _messager_log Message habndle with print on screen feature
+     * @param _clientos OS worker
+     * @param _para Database worker
+     * @param _getlib library getter method
+     * @param _getpara Database getter method
+     * @param _getjob Job getter method
+     */
     static Init = (_messager, _messager_log, _clientos, _para, _getlib, _getpara, _getjob) => {
         messager = _messager;
         messager_log = _messager_log;
@@ -307,6 +325,13 @@ class ClientJavascript {
         getpara = _getpara;
         getjob = _getjob;
     };
+    /**
+     * Running js\
+     * With reference libraries\
+     * @param js js script text
+     * @param libs Libraries header names
+     * @returns Calcuate result
+     */
     JavascriptExecuteWithLib = (javascript, libs, log) => {
         waiting = 0;
         let context = this.getJavascriptEnv(interface_1.JavascriptLib.ALL, log);
@@ -335,6 +360,11 @@ class ClientJavascript {
             }, 100);
         });
     };
+    /**
+     * Running js
+     * @param js js script text
+     * @returns Calcuate result
+     */
     JavascriptExecute = (javascript, log) => {
         waiting = 0;
         let context = this.getJavascriptEnv(interface_1.JavascriptLib.OS | interface_1.JavascriptLib.MESSAGE | interface_1.JavascriptLib.HTTP | interface_1.JavascriptLib.PATH, log);
@@ -497,12 +527,16 @@ class ClientJavascript {
     readfile(path) {
         return clientos?.file_read({ path: path });
     }
+    //#region Databases
     async wait(time) {
         return new Promise((resolve) => setTimeout(resolve, time * 1000));
     }
     async sleep(n) {
         Atomics.wait(new Int32Array(new SharedArrayBuffer(4)), 0, 0, n * 1000);
     }
+    //#endregion
+    //#endregion
+    //#region Http
     async httpGet(url, p) {
         return this.httpGo('GET', url, p.toObject());
     }

package/dist/client/job_database.d.ts

@@ -1,5 +1,9 @@
 import { Setter } from "../interface";
 export declare class ClientJobDatabase {
+    /**
+     * Update database number on the cluster server
+     * @param data Target KeyValue
+     */
     feedbacknumber: (data: Setter) => void;
     feedbackboolean: (data: Setter) => void;
     feedbackstring: (data: Setter) => void;

package/dist/client/job_database.js

@@ -2,6 +2,10 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ClientJobDatabase = void 0;
 class ClientJobDatabase {
+    /**
+     * Update database number on the cluster server
+     * @param data Target KeyValue
+     */
     feedbacknumber = (data) => {
         this.feedback("feedbacknumber", data);
     };