@e-mc/module 0.7.1 → 0.8.0

package/LICENSE

@@ -1,11 +1,11 @@
-Copyright 2023 An Pham
-
-Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
-
-1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
-
-2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
-
-3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
-
+Copyright 2023 An Pham
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
+
 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

package/index.d.ts

@@ -1,5 +1,5 @@
-import type { ModuleConstructor } from '../types/lib';
-
-declare const Module: ModuleConstructor;
-
+import type { ModuleConstructor } from '../types/lib';
+
+declare const Module: ModuleConstructor;
+
 export = Module;

package/index.js

@@ -74,6 +74,7 @@ const SETTINGS = {
     session_id: 0,
     message: true,
     stack_trace: false,
+    abort: true,
     unknown: true,
     system: true,
     node: true,
@@ -321,8 +322,38 @@ function isFailed(options) {
     }
     return false;
 }
+function getErrorCause(err, out, visited) {
+    let message;
+    if (visited) {
+        message = SETTINGS.stack_trace && err.stack || err.message;
+    }
+    else {
+        visited = new WeakSet();
+    }
+    visited.add(err);
+    if (err.hasOwnProperty('cause')) { // eslint-disable-line no-prototype-builtins
+        const cause = err.cause;
+        if (cause instanceof Error) {
+            if (message) {
+                out.push(message);
+            }
+            if (!visited.has(cause)) {
+                getErrorCause(cause, out, visited);
+            }
+            return;
+        }
+        if ((0, types_1.isString)(cause)) {
+            message = message ? message + ` (${cause})` : cause; // eslint-disable-line @typescript-eslint/restrict-template-expressions
+        }
+    }
+    if (message) {
+        out.push(message);
+    }
+}
 function getErrorMessage(err) {
-    return SETTINGS.stack_trace && err.stack || err.message || err.toString() || "Unknown" /* ERR_MESSAGE.UNKNOWN */;
+    const cause = [];
+    getErrorCause(err, cause);
+    return (SETTINGS.stack_trace && err.stack || err.message || err.toString() || "Unknown" /* ERR_MESSAGE.UNKNOWN */) + (cause.length ? cause.map((value, index) => `\n\nCause #${cause.length - index}: ` + value).join('') : '');
 }
 function writeLine(value) {
     PROCESS_STDOUT.write((!LOG_NEWLINE ? '\n' : '') + value + '\n');
@@ -525,14 +556,15 @@ function tryIncrementDir(value, increment) {
     } while (increment-- > 0);
     return [outErr, -1];
 }
+const hideAbort = (err) => err.name === 'AbortError' && SETTINGS.abort === false;
 const asFile = (value) => value instanceof URL ? value.protocol === 'file:' ? url.fileURLToPath(value) : '' : value;
 const wrapQuote = (value) => '"' + value.replace(/"/g, '\\"') + '"';
 const isFunction = (value) => typeof value === 'function';
 const isFileURL = (value) => /^file:\/\//i.test(value);
 const errorDirectory = (value) => (0, types_1.errorValue)("Path is not a directory" /* ERR_MESSAGE.NOT_DIRECTORY */, value);
 const sanitizePath = (value) => (0, types_1.isString)(value) ? path.resolve(value.trim()) : '';
-const ensureDir = (value) => value[value.length - 1] !== path.sep ? value + path.sep : value;
-const trimDir = (value) => value[value.length - 1] === path.sep ? value.substring(0, value.length - 1) : value;
+const ensureDir = (value) => value.endsWith(path.sep) ? value : value + path.sep;
+const trimDir = (value) => value.endsWith(path.sep) ? value.substring(0, value.length - 1) : value;
 const getExtension = (value) => path.extname(value).toLowerCase().substring(1);
 const hasString = (item, value) => (0, types_1.isString)(value) && (item === value || Array.isArray(item) && item.includes(value));
 const getCpuTimes = () => os.cpus().reduce((a, b) => a + b.times.user + b.times.sys, 0) * 1000 /* TIME.S */;
@@ -558,7 +590,7 @@ class Module extends EventEmitter {
         this[_f] = new AbortController();
         this[_g] = null;
     }
-    static get VERSION() { return "0.7.1" /* INTERNAL.VERSION */; }
+    static get VERSION() { return "0.8.0" /* INTERNAL.VERSION */; }
     static get LOG_TYPE() { return types_1.LOG_TYPE; }
     static get STATUS_TYPE() { return types_1.STATUS_TYPE; }
     static get MAX_TIMEOUT() { return 2147483647; }
@@ -637,6 +669,10 @@ class Module extends EventEmitter {
         return true;
     }
     static formatMessage(type, title, value, message, options = {}) {
+        const error = !!message && message instanceof Error;
+        if (error && hideAbort(message)) {
+            return;
+        }
         if (options.type) {
             type |= options.type;
         }
@@ -675,14 +711,13 @@ class Module extends EventEmitter {
         const formatValue = format.value;
         const id = sessionId && SETTINGS.session_id ? ' ' + sessionId.padStart(SETTINGS.session_id, '0') + ' ' : '';
         const titleIndent = options.titleIndent ? typeof options.titleIndent === 'number' ? Math.max(options.titleIndent, 0) : 0 : -1;
-        let output, error, hint, valueWidth = Math.max(formatValue.width - (id ? SETTINGS.session_id + 1 : 0), 1), titleJustify = options.titleJustify || ((type & 512 /* LOG_VALUE.FAIL */) || options.failed ? 'center' : formatTitle.justify);
+        let output, hint, valueWidth = Math.max(formatValue.width - (id ? SETTINGS.session_id + 1 : 0), 1), titleJustify = options.titleJustify || ((type & 512 /* LOG_VALUE.FAIL */) || options.failed ? 'center' : formatTitle.justify);
         if (Array.isArray(value)) {
             hint = value[1] ?? '';
             value = value[0];
         }
-        if (message && message instanceof Error) {
+        if (error) {
             message = getErrorMessage(message);
-            error = true;
         }
         if (messageUnitIndent) {
             let indentChar;
@@ -724,7 +759,7 @@ class Module extends EventEmitter {
                         indent = match[1];
                         if (bgAltColor) {
                             try {
-                                indent = (bgAltColor[0] === '#' ? chalk.bgHex(bgAltColor) : chalk[bgAltColor])(indent);
+                                indent = (bgAltColor.startsWith('#') ? chalk.bgHex(bgAltColor) : chalk[bgAltColor])(indent);
                             }
                             catch {
                             }
@@ -747,10 +782,10 @@ class Module extends EventEmitter {
                 try {
                     let current = bold ? chalk.bold : chalk;
                     if (typeof color === 'string' && color.length > 1) {
-                        current = color[0] === '#' ? current.hex(color) : current[color];
+                        current = color.startsWith('#') ? current.hex(color) : current[color];
                     }
                     if (typeof bgColor === 'string' && bgColor.length > 1) {
-                        current = bgColor[0] === '#' ? current.bgHex(bgColor) : current[bgColor];
+                        current = bgColor.startsWith('#') ? current.bgHex(bgColor) : current[bgColor];
                     }
                     return indent + current(content);
                 }
@@ -1291,7 +1326,7 @@ class Module extends EventEmitter {
         let result = paths[0] || '';
         for (let i = 1; i < paths.length; ++i) {
             const trailing = paths[i];
-            result += (trailing[0] !== '/' && result[result.length - 1] !== '/' ? '/' : '') + trailing;
+            result += (!trailing.startsWith('/') && !result.endsWith('/') ? '/' : '') + trailing;
         }
         return result;
     }
@@ -1383,7 +1418,7 @@ class Module extends EventEmitter {
         }
         return false;
     }
-    static copyDir(src, dest, move, recursive = true) {
+    static async copyDir(src, dest, move, recursive = true) {
         const srcOut = sanitizePath(asFile(src));
         if (!srcOut || !this.isDir(srcOut)) {
             return Promise.reject(errorDirectory(asFile(src) || "Unknown" /* ERR_MESSAGE.UNKNOWN */));
@@ -1583,7 +1618,7 @@ class Module extends EventEmitter {
         }
         return null;
     }
-    static resolveMime(data) {
+    static async resolveMime(data) {
         return typeof data === 'string' ? filetype.fromFile(data) : filetype.fromBuffer(data);
     }
     static lookupMime(value, extension) {
@@ -1869,7 +1904,7 @@ class Module extends EventEmitter {
         return true;
     }
     static sanitizeCmd(value) {
-        if (value.indexOf(' ') !== -1) {
+        if (value.includes(' ')) {
             return PLATFORM_WIN32 ? wrapQuote(value) : value.replace(/[ ]/g, '\\ ');
         }
         return value;
@@ -1900,7 +1935,7 @@ class Module extends EventEmitter {
                             }
                             value = quoted[2];
                         }
-                        if (value.indexOf(' ') !== -1) {
+                        if (value.includes(' ')) {
                             value = wrapQuote(value);
                         }
                     }
@@ -1935,7 +1970,7 @@ class Module extends EventEmitter {
         }
         return (typeof values === 'string' ? result[0] : result);
     }
-    static purgeMemory(percent = 1, limit = 0) {
+    static async purgeMemory(percent = 1, limit = 0) {
         if (typeof limit === 'boolean') {
             limit = 0;
         }
@@ -1968,7 +2003,7 @@ class Module extends EventEmitter {
                 CACHE_TOTAL = stored.length - result;
             }
         }
-        return Promise.resolve(result);
+        return result;
     }
     static canWrite(name) {
         switch (name) {
@@ -2176,11 +2211,13 @@ class Module extends EventEmitter {
                         }
                         break;
                     }
-                    default:
-                        if (attr in SETTINGS) {
-                            SETTINGS[attr] = logger[attr];
+                    default: {
+                        const value = logger[attr];
+                        if (attr in SETTINGS && value !== undefined) {
+                            SETTINGS[attr] = value;
                         }
                         break;
+                    }
                 }
             }
             if (broadcast?.out) {
@@ -2311,7 +2348,7 @@ class Module extends EventEmitter {
             result = output;
         }
         if (filename) {
-            const trailing = (filename[0] === '.' ? (0, types_1.generateUUID)() : '') + filename;
+            const trailing = (filename.startsWith('.') ? (0, types_1.generateUUID)() : '') + filename;
             if (result) {
                 return path.join(result, trailing);
             }
@@ -2783,7 +2820,7 @@ class Module extends EventEmitter {
         }
         return false;
     }
-    allSettled(tasks, rejected, options) {
+    async allSettled(tasks, rejected, options) {
         rejected || (rejected = "Unknown" /* ERR_MESSAGE.UNKNOWN */);
         return Promise.allSettled(tasks).then(result => {
             const items = [];
@@ -3004,7 +3041,7 @@ class Module extends EventEmitter {
             }
         }
         if (message) {
-            if (this._logEnabled) {
+            if (this._logEnabled && !(message instanceof Error && hideAbort(message))) {
                 if (fatal) {
                     const timeStamp = Date.now();
                     this.addLog(types_1.STATUS_TYPE.FATAL, message, timeStamp, options.startTime && getTimeOffset(options.startTime, timeStamp));
@@ -3221,9 +3258,9 @@ class Module extends EventEmitter {
         }
         this._host = null;
     }
-    abort() {
+    abort(reason) {
         if (!this.aborted) {
-            this[kAbortHandler].abort();
+            this[kAbortHandler].abort(reason);
         }
     }
     willAbort(value) {
@@ -3250,14 +3287,14 @@ class Module extends EventEmitter {
         const aborting = this._hostEvents.includes('abort');
         if (value.aborted) {
             if (aborting) {
-                this.abort();
+                this.abort(new Error("Aborted by host" /* ERR_MESSAGE.ABORTED_HOST */));
             }
         }
         else if (!value.subProcesses.has(this)) {
             this.abortable = value.willAbort(this);
             value.modules.add(this);
             if (aborting) {
-                value.signal.addEventListener('abort', this[kAbortEvent] = () => this.abort(), { once: true });
+                value.signal.addEventListener('abort', this[kAbortEvent] = () => this.abort(new Error("Aborted by host" /* ERR_MESSAGE.ABORTED_HOST */)), { once: true });
             }
         }
     }

package/lib-v4.d.ts

@@ -1,5 +1,5 @@
-import type { IModuleLibV4 } from '../types/lib/compat-v4';
-
-declare const LibV4: IModuleLibV4;
-
+import type { IModuleLibV4 } from '../types/lib/compat-v4';
+
+declare const LibV4: IModuleLibV4;
+
 export = LibV4;

package/lib-v4.js

@@ -135,7 +135,7 @@ function getFunctions(values, absolute, sync = true, outFailed) {
     return result;
 }
 exports.getFunctions = getFunctions;
-function allSettled(tasks, rejected, options) {
+async function allSettled(tasks, rejected, options) {
     if (rejected) {
         return Promise.allSettled(tasks).then(result => {
             const items = [];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@e-mc/module",
-  "version": "0.7.1",
+  "version": "0.8.0",
   "description": "Module base class for E-mc.",
   "main": "index.js",
   "types": "index.d.ts",
@@ -20,7 +20,7 @@
   "license": "BSD 3-Clause",
   "homepage": "https://github.com/anpham6/e-mc#readme",
   "dependencies": {
-    "@e-mc/types": "0.7.1",
+    "@e-mc/types": "0.8.0",
     "abort-controller": "^3.0.0",
     "chalk": "4.1.2",
     "event-target-shim": "^5.0.1",