@midwayjs/core 4.0.0-alpha.1 → 4.0.0-beta.2

package/dist/util/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Utils = exports.findProjectEntryFileSync = exports.findProjectEntryFile = exports.isConfigurationExport = exports.createPromiseTimeoutInvokeChain = exports.isTypeScriptEnvironment = exports.toAsyncFunction = exports.merge = exports.generateRandomId = exports.getParamNames = exports.sleep = exports.wrapAsync = exports.isIncludeProperty = exports.wrapMiddleware = exports.pathMatching = exports.toPathMatch = exports.transformRequestObjectByType = exports.deprecatedOutput = exports.getCurrentDateString = exports.delegateTargetProperties = exports.delegateTargetMethod = exports.delegateTargetAllPrototypeMethod = exports.delegateTargetPrototypeMethod = exports.joinURLPath = exports.getUserHome = exports.parsePrefix = exports.safelyGet = exports.loadModuleSync = exports.loadModule = exports.safeRequire = exports.getCurrentEnvironment = exports.isDevelopmentEnvironment = void 0;
+exports.Utils = exports.findProjectEntryFileSync = exports.findProjectEntryFile = exports.isConfigurationExport = exports.isTypeScriptEnvironment = exports.toAsyncFunction = exports.merge = exports.generateRandomId = exports.getParamNames = exports.sleep = exports.wrapAsync = exports.isIncludeProperty = exports.wrapMiddleware = exports.pathMatching = exports.toPathMatch = exports.transformRequestObjectByType = exports.deprecatedOutput = exports.getCurrentDateString = exports.delegateTargetProperties = exports.delegateTargetMethod = exports.delegateTargetAllPrototypeMethod = exports.delegateTargetPrototypeMethod = exports.joinURLPath = exports.getUserHome = exports.parsePrefix = exports.safelyGet = exports.loadModuleSync = exports.loadModule = exports.safeRequire = exports.getCurrentEnvironment = exports.isDevelopmentEnvironment = void 0;
 const path_1 = require("path");
 const fs_1 = require("fs");
 const util_1 = require("util");
@@ -458,11 +458,16 @@ function wrapAsync(handler) {
     };
 }
 exports.wrapAsync = wrapAsync;
-function sleep(sleepTime = 1000) {
+function sleep(sleepTime = 1000, abortController) {
     return new Promise(resolve => {
-        setTimeout(() => {
+        const timeoutHandler = setTimeout(() => {
             resolve();
         }, sleepTime);
+        if (abortController) {
+            abortController.signal.addEventListener('abort', () => {
+                clearTimeout(timeoutHandler);
+            });
+        }
     });
 }
 exports.sleep = sleep;
@@ -530,70 +535,6 @@ function isTypeScriptEnvironment() {
     return TS_MODE_PROCESS_FLAG === 'true' || !!require.extensions['.ts'];
 }
 exports.isTypeScriptEnvironment = isTypeScriptEnvironment;
-/**
- * Create a Promise that resolves after the specified time
- * @param options
- */
-async function createPromiseTimeoutInvokeChain(options) {
-    if (!options.onSuccess) {
-        options.onSuccess = async (result) => {
-            return result;
-        };
-    }
-    options.isConcurrent = options.isConcurrent ?? true;
-    options.promiseItems = options.promiseItems.map(item => {
-        if (item instanceof Promise) {
-            return { item };
-        }
-        else {
-            return item;
-        }
-    });
-    // filter promise
-    options.promiseItems = options.promiseItems.filter(item => {
-        return item['item'] instanceof Promise;
-    });
-    if (options.isConcurrent) {
-        // For each check item, we create a timeout Promise
-        const checkPromises = options.promiseItems.map(item => {
-            const timeoutPromise = new Promise((_, reject) => {
-                // The timeout Promise fails after the specified time
-                setTimeout(() => reject(new error_1.MidwayCodeInvokeTimeoutError(options.methodName, item['timeout'] ?? options.timeout)), item['timeout'] ?? options.timeout);
-            });
-            // We use Promise.race to wait for either the check item or the timeout Promise
-            return (Promise.race([item['item'], timeoutPromise])
-                // If the check item Promise resolves, we set the result to success
-                .then(re => {
-                return options.onSuccess(re, item['meta']);
-            })
-                // If the timeout Promise resolves (i.e., the check item Promise did not resolve in time), we set the result to failure
-                .catch(err => {
-                return options.onFail(err, item['meta']);
-            }));
-        });
-        return Promise.all(checkPromises);
-    }
-    else {
-        const results = [];
-        for (const item of options.promiseItems) {
-            const timeoutPromise = new Promise((_, reject) => {
-                setTimeout(() => reject(new error_1.MidwayCodeInvokeTimeoutError(options.methodName, item['timeout'] ?? options.timeout)), item['timeout'] ?? options.timeout);
-            });
-            try {
-                const result = await Promise.race([item['item'], timeoutPromise]).then(re => {
-                    return options.onSuccess(re, item['meta']);
-                });
-                results.push(result);
-            }
-            catch (error) {
-                results.push(options.onFail(error, item['meta']));
-                break;
-            }
-        }
-        return results;
-    }
-}
-exports.createPromiseTimeoutInvokeChain = createPromiseTimeoutInvokeChain;
 function getFileNameWithSuffix(fileName) {
     return isTypeScriptEnvironment() ? `${fileName}.ts` : `${fileName}.js`;
 }

package/dist/util/network.d.ts

@@ -0,0 +1,10 @@
+declare function getIpv4Address(): string;
+declare function getIpv6Address(): string;
+declare function getHostname(): string;
+export declare const NetworkUtils: {
+    getIpv4Address: typeof getIpv4Address;
+    getIpv6Address: typeof getIpv6Address;
+    getHostname: typeof getHostname;
+};
+export {};
+//# sourceMappingURL=network.d.ts.map

package/dist/util/network.js

@@ -0,0 +1,40 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NetworkUtils = void 0;
+const os = require("os");
+// get ipv4 and ipv6 address
+function getIpv4Address() {
+    const interfaces = os.networkInterfaces();
+    for (const key in interfaces) {
+        if (interfaces[key]) {
+            for (const item of interfaces[key]) {
+                if (item.family === 'IPv4' && !item.internal) {
+                    return item.address;
+                }
+            }
+        }
+    }
+    return '';
+}
+function getIpv6Address() {
+    const interfaces = os.networkInterfaces();
+    for (const key in interfaces) {
+        if (interfaces[key]) {
+            for (const item of interfaces[key]) {
+                if (item.family === 'IPv6' && !item.internal) {
+                    return item.address;
+                }
+            }
+        }
+    }
+    return '';
+}
+function getHostname() {
+    return os.hostname();
+}
+exports.NetworkUtils = {
+    getIpv4Address,
+    getIpv6Address,
+    getHostname,
+};
+//# sourceMappingURL=network.js.map

package/dist/util/pathFileUtil.d.ts

@@ -16,7 +16,7 @@ export declare function getFileContentSync(filePath: any, encoding?: BufferEncod
  */
 export declare function normalizePath(baseDir: any, p: any): any;
 export declare function getModuleRequirePathList(moduleName: string): string[];
-export declare const PathFileUtil: {
+export declare const PathFileUtils: {
     isPath: typeof isPath;
     isPathEqual: typeof isPathEqual;
     getFileContentSync: typeof getFileContentSync;

package/dist/util/pathFileUtil.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.PathFileUtil = exports.getModuleRequirePathList = exports.normalizePath = exports.getFileContentSync = exports.isPathEqual = exports.isPath = void 0;
+exports.PathFileUtils = exports.getModuleRequirePathList = exports.normalizePath = exports.getFileContentSync = exports.isPathEqual = exports.isPath = void 0;
 const path_1 = require("path");
 const fs_1 = require("fs");
 function isPath(p) {
@@ -75,7 +75,7 @@ function getModuleRequirePathList(moduleName) {
     return modulePathList;
 }
 exports.getModuleRequirePathList = getModuleRequirePathList;
-exports.PathFileUtil = {
+exports.PathFileUtils = {
     isPath,
     isPathEqual,
     getFileContentSync,

package/dist/util/timeout.d.ts

@@ -0,0 +1,57 @@
+/// <reference types="node" />
+/**
+ * Create a Promise that resolves after the specified time
+ * @param options
+ */
+export declare function createPromiseTimeoutInvokeChain<Result>(options: {
+    /**
+     * The promise items to be executed
+     */
+    promiseItems: Array<{
+        /**
+         * The promise item function, it will be executed in the timeout chain, and accept the abortController from the function call
+         */
+        item: (...args: any[]) => Promise<any>;
+        /**
+         * The promise item name, it will be used in error message
+         */
+        itemName?: string;
+        /**
+         * The promise item meta, which will be passed to the onSuccess and onFail callback
+         */
+        meta?: any;
+        /**
+         * The promise item timeout time
+         */
+        timeout?: number;
+    }>;
+    /**
+     * The default promise item timeout time, it used to set the timeout time in promiseItems if not provided
+     */
+    itemTimeout?: number;
+    /**
+     * The total execution timeout time
+     */
+    timeout?: number;
+    /**
+     * The method name, just for error message
+     */
+    methodName: string;
+    /**
+     * The success callback, if not provided, will ignore the result
+     */
+    onSuccess?: (result: any, meta: any) => Result | Promise<Result>;
+    /**
+     * The fail callback, if not provided, will throw error
+     */
+    onFail?: (err: Error, meta: any) => Result | Promise<Result>;
+    /**
+     * Whether to execute concurrently, default is true, if false, will execute sequentially by for loop
+     */
+    isConcurrent?: boolean;
+    /**
+     * The abort controller, if provided, will abort the timeout waiting and stop the execution
+     */
+    abortController?: AbortController;
+}): Promise<Result[]>;
+//# sourceMappingURL=timeout.d.ts.map

package/dist/util/timeout.js

@@ -0,0 +1,144 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createPromiseTimeoutInvokeChain = void 0;
+const error_1 = require("../error");
+/**
+ * Create a Promise that resolves after the specified time
+ * @param options
+ */
+async function createPromiseTimeoutInvokeChain(options) {
+    if (!options.onSuccess) {
+        options.onSuccess = async (result) => {
+            return result;
+        };
+    }
+    options.isConcurrent = options.isConcurrent ?? true;
+    // abort controller
+    const abortController = options.abortController ?? new AbortController();
+    // total timeout
+    let totalExecutionTimeoutHandler;
+    const itemTimeoutHandlers = [];
+    let totalTimeoutPromise;
+    if (options.timeout) {
+        totalTimeoutPromise = new Promise((_, reject) => {
+            totalExecutionTimeoutHandler = setTimeout(() => {
+                reject(new error_1.MidwayCodeInvokeTimeoutError(options.methodName, options.timeout));
+            }, options.timeout);
+        });
+    }
+    abortController.signal.addEventListener('abort', () => {
+        itemTimeoutHandlers.forEach(handler => {
+            clearTimeout(handler);
+        });
+        if (totalExecutionTimeoutHandler) {
+            clearTimeout(totalExecutionTimeoutHandler);
+        }
+    });
+    const realPromiseItems = options.promiseItems.filter(item => {
+        return typeof item['item'] === 'function';
+    });
+    if (options.isConcurrent) {
+        // For each check item, we create a timeout Promise
+        const checkPromises = realPromiseItems.map(item => {
+            const itemTimeout = item['timeout'] ?? options.itemTimeout;
+            const timeoutPromise = itemTimeout
+                ? new Promise((_, reject) => {
+                    // The timeout Promise fails after the specified time
+                    itemTimeoutHandlers.push(setTimeout(() => reject(new error_1.MidwayCodeInvokeTimeoutError(options.methodName, itemTimeout, item['itemName'])), itemTimeout));
+                })
+                : null;
+            // We use Promise.race to wait for either the check item or the timeout Promise
+            return (Promise.race([
+                Promise.resolve(item['item'](abortController)),
+                timeoutPromise,
+            ])
+                // If the check item Promise resolves, we set the result to success
+                .then(re => {
+                return options.onSuccess(re, item['meta']);
+            })
+                // If the timeout Promise resolves (i.e., the check item Promise did not resolve in time), we set the result to failure
+                .catch(err => {
+                if (options.onFail) {
+                    return options.onFail?.(err, item['meta']);
+                }
+                else {
+                    throw err;
+                }
+            }));
+        });
+        if (totalTimeoutPromise) {
+            return Promise.race([Promise.all(checkPromises), totalTimeoutPromise])
+                .finally(() => {
+                abortController.abort();
+            })
+                .then(results => {
+                return results;
+            })
+                .finally(() => {
+                abortController.abort();
+            });
+        }
+        else {
+            return Promise.all(checkPromises)
+                .finally(() => {
+                abortController.abort();
+            })
+                .then(results => {
+                return results;
+            });
+        }
+    }
+    else {
+        // 串行执行
+        const results = [];
+        // 包装整个串行执行过程
+        const serialExecution = async () => {
+            for (const item of realPromiseItems) {
+                const itemTimeout = item['timeout'] ?? options.itemTimeout;
+                const timeoutPromise = itemTimeout
+                    ? new Promise((_, reject) => {
+                        itemTimeoutHandlers.push(setTimeout(() => reject(new error_1.MidwayCodeInvokeTimeoutError(options.methodName, itemTimeout, item['itemName'])), itemTimeout));
+                    })
+                    : null;
+                try {
+                    const result = await Promise.race([
+                        Promise.resolve(item['item'](abortController)),
+                        timeoutPromise,
+                    ].filter(Boolean));
+                    results.push(await options.onSuccess(result, item['meta']));
+                }
+                catch (error) {
+                    if (options.onFail) {
+                        results.push(await options.onFail(error, item['meta']));
+                        break;
+                    }
+                    else {
+                        throw error;
+                    }
+                }
+            }
+            return results;
+        };
+        // 将整个串行执行过程与总超时竞争
+        if (totalTimeoutPromise) {
+            return Promise.race([serialExecution(), totalTimeoutPromise])
+                .then(results => {
+                return results;
+            })
+                .finally(() => {
+                abortController.abort();
+            });
+        }
+        else {
+            return serialExecution()
+                .then(results => {
+                return results;
+            })
+                .finally(() => {
+                abortController.abort();
+            });
+        }
+    }
+}
+exports.createPromiseTimeoutInvokeChain = createPromiseTimeoutInvokeChain;
+//# sourceMappingURL=timeout.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@midwayjs/core",
-  "version": "4.0.0-alpha.1",
+  "version": "4.0.0-beta.2",
   "description": "midway core",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
@@ -24,7 +24,7 @@
   "devDependencies": {
     "@midwayjs/logger": "^3.0.0",
     "eventsource": "2.0.2",
-    "koa": "2.15.3",
+    "koa": "2.16.2",
     "mm": "3.4.0",
     "raw-body": "2.5.2",
     "sinon": "17.0.2"
@@ -40,7 +40,7 @@
     "url": "https://github.com/midwayjs/midway.git"
   },
   "engines": {
-    "node": ">=16"
+    "node": ">=20"
   },
   "madge": {
     "detectiveOptions": {
@@ -61,5 +61,5 @@
       "types": "./dist/functional/index.d.ts"
     }
   },
-  "gitHead": "14bb4da91805a1cf52f190c0d37a74b395dd6372"
+  "gitHead": "53bfef4c5279da5f09025e4610bdbf64f94f60bd"
 }