@midwayjs/core 3.4.13 → 3.5.0

package/dist/common/dataSourceManager.d.ts

@@ -19,7 +19,7 @@ export declare abstract class DataSourceManager<T> {
      * @param dataSourceName
      */
     isConnected(dataSourceName: string): Promise<boolean>;
-    createInstance(config: any, clientName: any, options?: CreateInstanceOptions): Promise<T | void>;
+    createInstance(config: any, clientName: any, options?: CreateDataSourceInstanceOptions): Promise<T | void>;
     /**
      * get data source name by model or repository
      * @param modelOrRepository
@@ -32,7 +32,14 @@ export declare abstract class DataSourceManager<T> {
     stop(): Promise<void>;
 }
 export declare function globModels(globString: string, appDir: string): any[];
-export interface CreateInstanceOptions {
+export interface CreateDataSourceInstanceOptions {
+    /**
+     * @default false
+     */
+    validateConnection?: boolean;
+    /**
+     * @default true
+     */
     cacheInstance?: boolean | undefined;
 }
 //# sourceMappingURL=dataSourceManager.d.ts.map

package/dist/common/dataSourceManager.js

@@ -19,7 +19,7 @@ class DataSourceManager {
     async initDataSource(options, appDir) {
         this.options = options;
         if (!options.dataSource) {
-            throw new error_1.MidwayParameterError('DataSourceManager must set options.dataSource.');
+            throw new error_1.MidwayParameterError('[DataSourceManager] must set options.dataSource.');
         }
         for (const dataSourceName in options.dataSource) {
             const dataSourceOptions = options.dataSource[dataSourceName];
@@ -45,7 +45,8 @@ class DataSourceManager {
             }
             // create data source
             const opts = {
-                cacheInstance: options.cacheInstance, // will default true
+                cacheInstance: options.cacheInstance,
+                validateConnection: options.validateConnection,
             };
             await this.createInstance(dataSourceOptions, dataSourceName, opts);
         }
@@ -79,12 +80,22 @@ class DataSourceManager {
         const cache = options && typeof options.cacheInstance === 'boolean'
             ? options.cacheInstance
             : true;
-        // options.default will be merge in to options.clients[id]
+        const validateConnection = (options && options.validateConnection) || false;
+        // options.clients[id] will be merged with options.default
         const configNow = (0, extend_1.extend)(true, {}, this.options['default'], config);
         const client = await this.createDataSource(configNow, clientName);
         if (cache && clientName && client) {
             this.dataSource.set(clientName, client);
         }
+        if (validateConnection) {
+            if (!client) {
+                throw new error_1.MidwayCommonError(`[DataSourceManager] ${clientName} initialization failed.`);
+            }
+            const connected = await this.checkConnected(client);
+            if (!connected) {
+                throw new error_1.MidwayCommonError(`[DataSourceManager] ${clientName} is not connected.`);
+            }
+        }
         return client;
     }
     /**

package/dist/error/framework.d.ts

@@ -18,6 +18,7 @@ export declare const FrameworkErrorEnum: {
     readonly INVALID_CONFIG: "MIDWAY_10014";
     readonly DUPLICATE_CLASS_NAME: "MIDWAY_10015";
     readonly DUPLICATE_CONTROLLER_PREFIX_OPTIONS: "MIDWAY_10016";
+    readonly RETRY_OVER_MAX_TIME: "MIDWAY_10017";
 };
 export declare class MidwayCommonError extends MidwayError {
     constructor(message: string);
@@ -70,4 +71,7 @@ export declare class MidwayDuplicateClassNameError extends MidwayError {
 export declare class MidwayDuplicateControllerOptionsError extends MidwayError {
     constructor(prefix: string, existController: string, existControllerOther: string);
 }
+export declare class MidwayRetryExceededMaxTimesError extends MidwayError {
+    constructor(methodName: any, times: number, err: Error);
+}
 //# sourceMappingURL=framework.d.ts.map

package/dist/error/framework.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.MidwayDuplicateControllerOptionsError = exports.MidwayDuplicateClassNameError = exports.MidwayInconsistentVersionError = exports.MidwayUtilHttpClientTimeoutError = exports.MidwayMissingImportComponentError = exports.MidwaySingletonInjectRequestError = exports.MidwayUseWrongMethodError = exports.MidwayDuplicateRouteError = exports.MidwayResolverMissingError = exports.MidwayInvalidConfigError = exports.MidwayConfigMissingError = exports.MidwayFeatureNotImplementedError = exports.MidwayFeatureNoLongerSupportedError = exports.MidwayDefinitionNotFoundError = exports.MidwayParameterError = exports.MidwayCommonError = exports.FrameworkErrorEnum = void 0;
+exports.MidwayRetryExceededMaxTimesError = exports.MidwayDuplicateControllerOptionsError = exports.MidwayDuplicateClassNameError = exports.MidwayInconsistentVersionError = exports.MidwayUtilHttpClientTimeoutError = exports.MidwayMissingImportComponentError = exports.MidwaySingletonInjectRequestError = exports.MidwayUseWrongMethodError = exports.MidwayDuplicateRouteError = exports.MidwayResolverMissingError = exports.MidwayInvalidConfigError = exports.MidwayConfigMissingError = exports.MidwayFeatureNotImplementedError = exports.MidwayFeatureNoLongerSupportedError = exports.MidwayDefinitionNotFoundError = exports.MidwayParameterError = exports.MidwayCommonError = exports.FrameworkErrorEnum = void 0;
 const base_1 = require("./base");
 exports.FrameworkErrorEnum = (0, base_1.registerErrorCode)('midway', {
     UNKNOWN: 10000,
@@ -20,6 +20,7 @@ exports.FrameworkErrorEnum = (0, base_1.registerErrorCode)('midway', {
     INVALID_CONFIG: 10014,
     DUPLICATE_CLASS_NAME: 10015,
     DUPLICATE_CONTROLLER_PREFIX_OPTIONS: 10016,
+    RETRY_OVER_MAX_TIME: 10017,
 });
 class MidwayCommonError extends base_1.MidwayError {
     constructor(message) {
@@ -136,4 +137,12 @@ class MidwayDuplicateControllerOptionsError extends base_1.MidwayError {
     }
 }
 exports.MidwayDuplicateControllerOptionsError = MidwayDuplicateControllerOptionsError;
+class MidwayRetryExceededMaxTimesError extends base_1.MidwayError {
+    constructor(methodName, times, err) {
+        super(`Invoke "${methodName}" retries exceeded the maximum number of times(${times}), error: ${err.message}`, exports.FrameworkErrorEnum.RETRY_OVER_MAX_TIME, {
+            cause: err,
+        });
+    }
+}
+exports.MidwayRetryExceededMaxTimesError = MidwayRetryExceededMaxTimesError;
 //# sourceMappingURL=framework.js.map

package/dist/index.d.ts

@@ -21,7 +21,7 @@ export { MidwayDecoratorService } from './service/decoratorService';
 export { MidwayMockService } from './service/mockService';
 export { RouterInfo, DynamicRouterInfo, RouterPriority, RouterCollectorOptions, MidwayWebRouterService, } from './service/webRouterService';
 export { MidwayServerlessFunctionService, WebRouterCollector, } from './service/slsFunctionService';
-export { DataSourceManager } from './common/dataSourceManager';
+export { CreateDataSourceInstanceOptions, DataSourceManager, } from './common/dataSourceManager';
 export * from './service/pipelineService';
 export * from './util/contextUtil';
 export * from './common/serviceFactory';
@@ -31,6 +31,7 @@ export * from './common/webGenerator';
 export * from './common/middlewareManager';
 export * from './util/pathToRegexp';
 export * from './util/httpclient';
+export * from './util/retry';
 export * from './common/filterManager';
 export * from './common/applicationManager';
 export * from './setup';

package/dist/index.js

@@ -77,6 +77,7 @@ __exportStar(require("./common/webGenerator"), exports);
 __exportStar(require("./common/middlewareManager"), exports);
 __exportStar(require("./util/pathToRegexp"), exports);
 __exportStar(require("./util/httpclient"), exports);
+__exportStar(require("./util/retry"), exports);
 __exportStar(require("./common/filterManager"), exports);
 __exportStar(require("./common/applicationManager"), exports);
 __exportStar(require("./setup"), exports);

package/dist/util/retry.d.ts

@@ -0,0 +1,20 @@
+/**
+ * wrap async function with retry
+ * @param retryFn
+ * @param retryTimes
+ * @param options
+ */
+export declare function retryWithAsync<T extends (...args: any[]) => Promise<unknown>>(retryFn: T, retryTimes?: number, options?: {
+    throwOriginError?: boolean;
+    retryInterval?: number;
+}): (...args: Parameters<T>) => ReturnType<T>;
+/**
+ * wrap sync function with retry
+ * @param retryFn
+ * @param retryTimes
+ * @param options
+ */
+export declare function retryWith<T extends (...args: any[]) => unknown>(retryFn: T, retryTimes?: number, options?: {
+    throwOriginError?: boolean;
+}): (...args: Parameters<T>) => ReturnType<T>;
+//# sourceMappingURL=retry.d.ts.map

package/dist/util/retry.js

@@ -0,0 +1,63 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.retryWith = exports.retryWithAsync = void 0;
+const error_1 = require("../error");
+const decorator_1 = require("@midwayjs/decorator");
+/**
+ * wrap async function with retry
+ * @param retryFn
+ * @param retryTimes
+ * @param options
+ */
+function retryWithAsync(retryFn, retryTimes = 1, options = {}) {
+    let defaultRetry = retryTimes;
+    let error;
+    return (async (...args) => {
+        do {
+            try {
+                return await retryFn(...args);
+            }
+            catch (err) {
+                error = err;
+            }
+            if (options.retryInterval >= 0) {
+                await (0, decorator_1.sleep)(options.retryInterval);
+            }
+        } while (defaultRetry-- > 0);
+        if (options.throwOriginError) {
+            throw error;
+        }
+        else {
+            throw new error_1.MidwayRetryExceededMaxTimesError(retryFn.name || 'anonymous', retryTimes, error);
+        }
+    });
+}
+exports.retryWithAsync = retryWithAsync;
+/**
+ * wrap sync function with retry
+ * @param retryFn
+ * @param retryTimes
+ * @param options
+ */
+function retryWith(retryFn, retryTimes = 1, options = {}) {
+    let defaultRetry = retryTimes;
+    let error;
+    return ((...args) => {
+        do {
+            try {
+                return retryFn(...args);
+            }
+            catch (err) {
+                error = err;
+            }
+        } while (defaultRetry-- > 0);
+        if (options.throwOriginError) {
+            throw error;
+        }
+        else {
+            throw new error_1.MidwayRetryExceededMaxTimesError(retryFn.name || 'anonymous', retryTimes, error);
+        }
+    });
+}
+exports.retryWith = retryWith;
+//# sourceMappingURL=retry.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@midwayjs/core",
-  "version": "3.4.13",
+  "version": "3.5.0",
   "description": "midway core",
   "main": "dist/index",
   "typings": "dist/index.d.ts",
@@ -25,6 +25,7 @@
     "koa": "2.13.4",
     "midway-test-component": "*",
     "mm": "3.2.0",
+    "pg": "^8.8.0",
     "raw-body": "2.5.1",
     "sinon": "14.0.0"
   },
@@ -45,5 +46,5 @@
   "engines": {
     "node": ">=12"
   },
-  "gitHead": "bde878f01df0a4b27919eea367d100b5ee5edb04"
+  "gitHead": "4200e30d1af97a7817c36899c4ffc41a7d97c06d"
 }