@midwayjs/core 4.0.0-beta.11 → 4.0.0-beta.12

package/dist/baseFramework.js

@@ -22,6 +22,7 @@ const middlewareManager_1 = require("./common/middlewareManager");
 const middlewareService_1 = require("./service/middlewareService");
 const filterManager_1 = require("./common/filterManager");
 const mockService_1 = require("./service/mockService");
+const traceService_1 = require("./service/traceService");
 const util = require("util");
 const asyncContextManager_1 = require("./common/asyncContextManager");
 const guardManager_1 = require("./common/guardManager");
@@ -180,6 +181,22 @@ class BaseFramework {
                 ctx.getApp = () => {
                     return this.getApplication();
                 };
+                if (!Object.getOwnPropertyDescriptor(ctx, 'traceId')) {
+                    Object.defineProperty(ctx, 'traceId', {
+                        get: () => {
+                            try {
+                                return this.getApplicationContext()
+                                    .get(traceService_1.MidwayTraceService)
+                                    .getTraceId();
+                            }
+                            catch {
+                                return undefined;
+                            }
+                        },
+                        enumerable: true,
+                        configurable: true,
+                    });
+                }
                 return ctx;
             },
             addConfigObject: (obj) => {
@@ -235,7 +252,7 @@ class BaseFramework {
                     // run simulator context setup
                     await this.mockService.runSimulatorContextSetup(ctx, this.app);
                     this.mockService.applyContextMocks(this.app, ctx);
-                    let returnResult = undefined;
+                    let returnResult;
                     try {
                         const result = await next();
                         returnResult = await this.filterManager.runResultFilter(result, ctx);

package/dist/common/asyncContextManager.js

@@ -125,7 +125,6 @@ class AsyncLocalStorageContextManager {
              * It isn't possible to tell Typescript that contextWrapper is the same as T
              * so we forced to cast as any here.
              */
-            // eslint-disable-next-line @typescript-eslint/no-explicit-any
             return contextWrapper;
         }
         return target;

package/dist/common/dataSourceManager.d.ts

@@ -4,7 +4,7 @@ import { MidwayPriorityManager } from './priorityManager';
 export declare abstract class DataSourceManager<T, ConnectionOpts extends BaseDataSourceManagerConfigOption<Record<string, any>, ENTITY_CONFIG_KEY> = BaseDataSourceManagerConfigOption<Record<string, any>, 'entities'>, ENTITY_CONFIG_KEY extends string = 'entities'> implements IDataSourceManager<T, ConnectionOpts> {
     protected dataSource: Map<string, T>;
     protected options: DataSourceManagerConfigOption<ConnectionOpts, ENTITY_CONFIG_KEY>;
-    protected modelMapping: WeakMap<object, any>;
+    protected modelMapping: WeakMap<WeakKey, any>;
     private innerDefaultDataSourceName;
     protected dataSourcePriority: Record<string, string>;
     private creatingDataSources;

package/dist/common/fileDetector.js

@@ -82,6 +82,7 @@ class CommonJSFileDetector extends AbstractFileDetector {
     async loadAsync(container, namespace) {
         this.options = this.options || {};
         const loadDirs = [].concat(this.options.loadDir ?? container.get('baseDir'));
+        const importQuery = `${Date.now()}_${Math.random()}`;
         for (const dir of loadDirs) {
             const fileResults = (0, glob_1.run)(DEFAULT_GLOB_PATTERN.concat(this.options.pattern || []), {
                 cwd: dir,
@@ -105,6 +106,7 @@ class CommonJSFileDetector extends AbstractFileDetector {
             for (const file of fileResults) {
                 const exports = await (0, util_1.loadModule)(file, {
                     loadMode: 'esm',
+                    importQuery,
                 });
                 // add module to set
                 container.bindClass(exports, {

package/dist/common/webGenerator.js

@@ -128,7 +128,9 @@ class WebControllerGenerator {
                 // eslint-disable-next-line prefer-spread
                 newRouter[routeInfo.requestMethod.toLowerCase()].apply(newRouter, routerArgs);
             }
-            routerHandler && routerHandler(newRouter);
+            if (routerHandler) {
+                routerHandler(newRouter);
+            }
         }
     }
 }

package/dist/config/config.default.d.ts

@@ -1,4 +1,4 @@
-import type { MidwayAppInfo, MidwayCoreDefaultConfig } from '../interface';
-declare const _default: (appInfo: MidwayAppInfo) => MidwayCoreDefaultConfig;
+import type { MidwayCoreDefaultConfig } from '../interface';
+declare const _default: () => MidwayCoreDefaultConfig;
 export default _default;
 //# sourceMappingURL=config.default.d.ts.map

package/dist/config/config.default.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const util_1 = require("../util/");
-exports.default = (appInfo) => {
+exports.default = () => {
     const isDevelopment = (0, util_1.isDevelopmentEnvironment)((0, util_1.getCurrentEnvironment)());
     return {
         core: {
@@ -13,6 +13,11 @@ exports.default = (appInfo) => {
         asyncContextManager: {
             enable: true,
         },
+        tracing: {
+            enable: true,
+            onError: 'ignore',
+            logOnError: false,
+        },
         midwayLogger: {
             default: {
                 level: 'info',

package/dist/context/componentLoader.js

@@ -165,7 +165,7 @@ class ComponentConfigurationLoader {
         if (objs) {
             const keys = Object.keys(objs);
             for (const key of keys) {
-                if (typeof objs[key] !== undefined) {
+                if (typeof objs[key] !== 'undefined') {
                     this.container.registerObject(key, objs[key]);
                 }
             }

package/dist/context/container.js

@@ -13,6 +13,7 @@ const events_1 = require("events");
 const types_1 = require("../util/types");
 const util_1 = require("../util");
 const metadataManager_1 = require("../decorator/metadataManager");
+const constants_2 = require("../functional/constants");
 const debug = util.debuglog('midway:debug');
 const debugBind = util.debuglog('midway:bind');
 const debugSpaceLength = 9;
@@ -68,6 +69,12 @@ class MidwayContainer {
                 if (types_1.Types.isClass(module) || types_1.Types.isFunction(module)) {
                     this.bindModule(module, options);
                 }
+                else if (module && typeof module === 'object') {
+                    const functionalApiController = metadataManager_1.MetadataManager.getOwnMetadata(constants_2.FUNCTIONAL_API_CONTROLLER_CLASS_KEY, module) || module[constants_2.FUNCTIONAL_API_CONTROLLER_CLASS_KEY];
+                    if (types_1.Types.isClass(functionalApiController)) {
+                        this.bindModule(functionalApiController, options);
+                    }
+                }
             }
         }
     }

package/dist/decorator/common/tracer.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Internal metadata key for trace method decorator.
+ */
+export declare const TRACE_KEY = "decorator:open_telemetry_key";
+/**
+ * Mark a method to create an OpenTelemetry span for its invocation.
+ */
+export declare function Trace(spanName: string): MethodDecorator;
+//# sourceMappingURL=tracer.d.ts.map

package/dist/decorator/common/tracer.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TRACE_KEY = void 0;
+exports.Trace = Trace;
+const decoratorManager_1 = require("../decoratorManager");
+/**
+ * Internal metadata key for trace method decorator.
+ */
+exports.TRACE_KEY = 'decorator:open_telemetry_key';
+/**
+ * Mark a method to create an OpenTelemetry span for its invocation.
+ */
+function Trace(spanName) {
+    return decoratorManager_1.DecoratorManager.createCustomMethodDecorator(exports.TRACE_KEY, {
+        spanName,
+    });
+}
+//# sourceMappingURL=tracer.js.map

package/dist/decorator/constant.d.ts

@@ -49,6 +49,7 @@ export declare const LOGGER_KEY = "logger";
 export declare const APPLICATION_KEY = "common:application";
 export declare const MAIN_APPLICATION_KEY = "common:main_application";
 export declare const APPLICATION_CONTEXT_KEY = "common:application_context";
+export declare const FUNCTIONAL_API_CONTROLLER_KEY = "functional:api_controller";
 export declare const CLASS_KEY_CONSTRUCTOR = "midway:class_key_constructor";
 export declare const MAIN_MODULE_KEY = "__main__";
 //# sourceMappingURL=constant.d.ts.map

package/dist/decorator/constant.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.MAIN_APPLICATION_KEY = exports.APPLICATION_KEY = exports.LOGGER_KEY = exports.PLUGIN_KEY = exports.CONFIG_KEY = exports.MS_HSF_METHOD_KEY = exports.MS_DUBBO_METHOD_KEY = exports.MS_GRPC_METHOD_KEY = exports.MS_PROVIDER_KEY = exports.MS_PRODUCER_KEY = exports.MS_CONSUMER_KEY = exports.WS_EVENT_KEY = exports.WS_CONTROLLER_KEY = exports.MODULE_TASK_QUEUE_OPTIONS = exports.MODULE_TASK_QUEUE_KEY = exports.MODULE_TASK_TASK_LOCAL_OPTIONS = exports.MODULE_TASK_TASK_LOCAL_KEY = exports.MODULE_TASK_METADATA = exports.MODULE_TASK_KEY = exports.WEB_RESPONSE_RENDER = exports.WEB_RESPONSE_CONTENT_TYPE = exports.WEB_RESPONSE_HEADER = exports.WEB_RESPONSE_REDIRECT = exports.WEB_RESPONSE_HTTP_CODE = exports.WEB_RESPONSE_KEY = exports.WEB_ROUTER_PARAM_KEY = exports.WEB_ROUTER_KEY = exports.CONTROLLER_KEY = exports.SERVERLESS_FUNC_KEY = exports.FUNC_KEY = exports.CUSTOM_PARAM_INJECT_KEY = exports.CUSTOM_METHOD_INJECT_KEY = exports.CUSTOM_PROPERTY_INJECT_KEY = exports.CONSTRUCTOR_INJECT_KEY = exports.PROPERTY_INJECT_KEY = exports.SCOPE_KEY = exports.PROVIDE_KEY = exports.OBJECT_DEFINITION_KEY = exports.PRE_START_MODULE_KEY = exports.FACTORY_SERVICE_CLIENT_KEY = exports.MOCK_KEY = exports.GUARD_KEY = exports.MATCH_KEY = exports.CATCH_KEY = exports.ASPECT_KEY = exports.FRAMEWORK_KEY = exports.CONFIGURATION_OBJECT_KEY = exports.CONFIGURATION_KEY = exports.SCHEDULE_KEY = exports.ALL_VALUE_KEY = void 0;
-exports.MAIN_MODULE_KEY = exports.CLASS_KEY_CONSTRUCTOR = exports.APPLICATION_CONTEXT_KEY = void 0;
+exports.MAIN_MODULE_KEY = exports.CLASS_KEY_CONSTRUCTOR = exports.FUNCTIONAL_API_CONTROLLER_KEY = exports.APPLICATION_CONTEXT_KEY = void 0;
 // got all value with no property name
 exports.ALL_VALUE_KEY = 'common:all_value_key';
 // common
@@ -69,6 +69,7 @@ exports.LOGGER_KEY = 'logger';
 exports.APPLICATION_KEY = 'common:application';
 exports.MAIN_APPLICATION_KEY = 'common:main_application';
 exports.APPLICATION_CONTEXT_KEY = 'common:application_context';
+exports.FUNCTIONAL_API_CONTROLLER_KEY = 'functional:api_controller';
 ////////////////////////////////////////// inject keys
 // constructor key
 exports.CLASS_KEY_CONSTRUCTOR = 'midway:class_key_constructor';

package/dist/decorator/index.d.ts

@@ -11,6 +11,7 @@ export * from './common/middleware';
 export * from './common/guard';
 export * from './common/pipe';
 export * from './common/mock';
+export * from './common/tracer';
 export * from './faas/serverlessTrigger';
 export * from './web/controller';
 export * from './web/paramMapping';

package/dist/decorator/index.js

@@ -32,6 +32,7 @@ __exportStar(require("./common/middleware"), exports);
 __exportStar(require("./common/guard"), exports);
 __exportStar(require("./common/pipe"), exports);
 __exportStar(require("./common/mock"), exports);
+__exportStar(require("./common/tracer"), exports);
 // faas
 __exportStar(require("./faas/serverlessTrigger"), exports);
 // web

package/dist/decorator/metadataManager.js

@@ -388,7 +388,6 @@ class MetadataManager {
     }
     static validCacheConstruct(target) {
         const metadata = this.getOrCreateMetaObject(target);
-        // eslint-disable-next-line no-prototype-builtins
         if (!metadata[this.cacheSymbol]) {
             metadata[this.cacheSymbol] = Object.create(null);
         }
@@ -422,7 +421,6 @@ class MetadataManager {
         return ret === ObjectType.Instance ? target.constructor : target;
     }
     static ensureTargetType(target, type) {
-        // eslint-disable-next-line no-prototype-builtins
         const ret = this.getOwnProperty(target, this.isClassSymbol);
         if (!ret) {
             this.setOwnProperty(target, this.isClassSymbol, type);

package/dist/decorator/web/requestMapping.d.ts

@@ -34,6 +34,10 @@ export interface RouterOption {
      * ignore global prefix
      */
     ignoreGlobalPrefix?: boolean;
+    /**
+     * internal flag for whether ignoreGlobalPrefix is explicitly configured on route
+     */
+    __ignoreGlobalPrefixConfigured?: boolean;
 }
 export declare const RequestMethod: {
     GET: string;

package/dist/decorator/web/requestMapping.js

@@ -28,7 +28,9 @@ const RequestMapping = (metadata = defaultMetadata) => {
     const routerName = metadata.routerName;
     const middleware = metadata.middleware;
     return (target, key, descriptor) => {
-        metadataManager_1.MetadataManager.attachMetadata(__1.WEB_ROUTER_KEY, {
+        const hasIgnoreGlobalPrefix = Object.prototype.hasOwnProperty.call(metadata, 'ignoreGlobalPrefix') &&
+            metadata?.ignoreGlobalPrefix !== undefined;
+        const routerMeta = {
             path,
             requestMethod,
             routerName,
@@ -36,8 +38,17 @@ const RequestMapping = (metadata = defaultMetadata) => {
             middleware,
             summary: metadata?.summary || '',
             description: metadata?.description || '',
-            ignoreGlobalPrefix: metadata?.ignoreGlobalPrefix ?? false,
-        }, target);
+            ignoreGlobalPrefix: hasIgnoreGlobalPrefix
+                ? metadata?.ignoreGlobalPrefix
+                : false,
+        };
+        Object.defineProperty(routerMeta, '__ignoreGlobalPrefixConfigured', {
+            value: hasIgnoreGlobalPrefix,
+            enumerable: false,
+            configurable: false,
+            writable: false,
+        });
+        metadataManager_1.MetadataManager.attachMetadata(__1.WEB_ROUTER_KEY, routerMeta, target);
         return descriptor;
     };
 };

package/dist/error/framework.d.ts

@@ -45,8 +45,20 @@ export declare class MidwayConfigMissingError extends MidwayError {
 export declare class MidwayInvalidConfigError extends MidwayError {
     constructor(message?: string);
 }
+export interface DuplicateRouteErrorEntry {
+    source: 'functional' | 'decorator';
+    handler: string;
+}
+export interface DuplicateRouteErrorPayload {
+    code: 'MIDWAY_DUPLICATE_ROUTE';
+    method: string;
+    fullPath: string;
+    current: DuplicateRouteErrorEntry;
+    existing: DuplicateRouteErrorEntry;
+}
 export declare class MidwayDuplicateRouteError extends MidwayError {
-    constructor(routerUrl: string, existPos: string, existPosOther: string);
+    payload?: DuplicateRouteErrorPayload;
+    constructor(routerUrl: string, existPos: string, existPosOther: string, payload?: DuplicateRouteErrorPayload);
 }
 export declare class MidwayUseWrongMethodError extends MidwayError {
     constructor(wrongMethod: string, replacedMethod: string, describeKey?: string);

package/dist/error/framework.js

@@ -73,8 +73,10 @@ class MidwayInvalidConfigError extends base_1.MidwayError {
 }
 exports.MidwayInvalidConfigError = MidwayInvalidConfigError;
 class MidwayDuplicateRouteError extends base_1.MidwayError {
-    constructor(routerUrl, existPos, existPosOther) {
+    payload;
+    constructor(routerUrl, existPos, existPosOther, payload) {
         super(`Duplicate router "${routerUrl}" at "${existPos}" and "${existPosOther}"`, exports.FrameworkErrorEnum.DUPLICATE_ROUTER);
+        this.payload = payload;
     }
 }
 exports.MidwayDuplicateRouteError = MidwayDuplicateRouteError;

package/dist/functional/adapter.d.ts

@@ -0,0 +1,4 @@
+import { RouteManifestItem } from '../service/webRouterService';
+export type RouteManifestAdapter<TOutput = unknown, TOptions = Record<string, unknown>> = (manifest: RouteManifestItem[], options?: TOptions) => TOutput;
+export declare function adaptRouteManifest<TOutput, TOptions = Record<string, unknown>>(manifest: RouteManifestItem[], adapter: RouteManifestAdapter<TOutput, TOptions>, options?: TOptions): TOutput;
+//# sourceMappingURL=adapter.d.ts.map

package/dist/functional/adapter.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.adaptRouteManifest = adaptRouteManifest;
+function adaptRouteManifest(manifest, adapter, options) {
+    return adapter(manifest, options);
+}
+//# sourceMappingURL=adapter.js.map

package/dist/functional/api.d.ts

@@ -0,0 +1,68 @@
+import { NextFunction } from '../interface';
+export interface FunctionalRouteInput {
+    params?: unknown;
+    query?: unknown;
+    body?: unknown;
+    headers?: unknown;
+}
+export interface FunctionalRouteHandlerArgs {
+    input: FunctionalRouteInput;
+    ctx: any;
+    next?: NextFunction;
+}
+export interface FunctionalRouteDefinition {
+    method: string;
+    path: string | RegExp;
+    options: FunctionalRouteOptions;
+    handle: (args: FunctionalRouteHandlerArgs) => Promise<unknown> | unknown;
+}
+export interface FunctionalRouteOptions {
+    routerName?: string;
+    middleware?: any[];
+    summary?: string;
+    description?: string;
+    ignoreGlobalPrefix?: boolean;
+    input?: FunctionalRouteInput;
+    output?: unknown;
+}
+export type FunctionalControllerOptions = {
+    sensitive?: boolean;
+    middleware?: any[];
+    alias?: string[];
+    description?: string;
+    tagName?: string;
+    ignoreGlobalPrefix?: boolean;
+    version?: string | string[];
+    versionType?: 'URI' | 'HEADER' | 'MEDIA_TYPE' | 'CUSTOM';
+    versionPrefix?: string;
+};
+export interface FunctionalApiModuleMeta {
+    prefix: string;
+    ignoreGlobalPrefix?: boolean;
+    version?: string | string[];
+    versionType?: 'URI' | 'HEADER' | 'MEDIA_TYPE' | 'CUSTOM';
+    versionPrefix?: string;
+}
+export interface RouteBuilder {
+    input(schema: FunctionalRouteOptions['input']): RouteBuilder;
+    output(schema: FunctionalRouteOptions['output']): RouteBuilder;
+    middleware(mw: any[]): RouteBuilder;
+    meta(options: Omit<FunctionalRouteOptions, 'input' | 'output'>): RouteBuilder;
+    handle(fn: FunctionalRouteDefinition['handle']): FunctionalRouteDefinition;
+}
+interface RouteBuilderInternal extends RouteBuilder {
+    __isRouteBuilder: true;
+    __build: () => FunctionalRouteDefinition;
+}
+export declare function defineApi(prefix: string, factory: (api: {
+    get(path?: string | RegExp): RouteBuilder;
+    post(path?: string | RegExp): RouteBuilder;
+    put(path?: string | RegExp): RouteBuilder;
+    delete(path?: string | RegExp): RouteBuilder;
+    patch(path?: string | RegExp): RouteBuilder;
+    options(path?: string | RegExp): RouteBuilder;
+    head(path?: string | RegExp): RouteBuilder;
+    all(path?: string | RegExp): RouteBuilder;
+}) => Record<string, FunctionalRouteDefinition | RouteBuilderInternal>, controllerOptions?: FunctionalControllerOptions): Record<string, FunctionalRouteDefinition>;
+export {};
+//# sourceMappingURL=api.d.ts.map