@athenna/http 1.3.0 → 1.3.1

package/index.d.ts

@@ -11,8 +11,10 @@ export * from './src/Facades/Server';
 export * from './src/Http';
 export * from './src/Router/Router';
 export * from './src/Kernels/HttpKernel';
+export * from './src/Exceptions/Exception';
 export * from './src/Providers/HttpRouteProvider';
 export * from './src/Providers/HttpServerProvider';
+export * from './src/Handlers/HttpExceptionHandler';
 export * from './src/Contracts/MiddlewareContract';
 export * from './src/Contracts/Context/ContextContract';
 export * from './src/Contracts/Context/HandlerContract';

package/index.js

@@ -23,8 +23,10 @@ __exportStar(require("./src/Facades/Server"), exports);
 __exportStar(require("./src/Http"), exports);
 __exportStar(require("./src/Router/Router"), exports);
 __exportStar(require("./src/Kernels/HttpKernel"), exports);
+__exportStar(require("./src/Exceptions/Exception"), exports);
 __exportStar(require("./src/Providers/HttpRouteProvider"), exports);
 __exportStar(require("./src/Providers/HttpServerProvider"), exports);
+__exportStar(require("./src/Handlers/HttpExceptionHandler"), exports);
 __exportStar(require("./src/Contracts/MiddlewareContract"), exports);
 __exportStar(require("./src/Contracts/Context/ContextContract"), exports);
 __exportStar(require("./src/Contracts/Context/HandlerContract"), exports);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@athenna/http",
-  "version": "1.3.0",
+  "version": "1.3.1",
   "description": "The Athenna Http server. Built on top of fastify",
   "license": "MIT",
   "author": "João Lenon <lenon@athenna.io>",

package/src/Exceptions/Exception.d.ts

@@ -0,0 +1,12 @@
+/**
+ * @athenna/http
+ *
+ * (c) João Lenon <lenon@athenna.io>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+import { Exception as SecException } from '@secjs/utils';
+export declare class Exception extends SecException {
+    constructor(message?: string, statusCode?: number, code?: string, help?: string);
+}

package/src/Exceptions/Exception.js

@@ -0,0 +1,18 @@
+"use strict";
+/**
+ * @athenna/http
+ *
+ * (c) João Lenon <lenon@athenna.io>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Exception = void 0;
+const utils_1 = require("@secjs/utils");
+class Exception extends utils_1.Exception {
+    constructor(message = 'Internal server exception.', statusCode = 500, code = 'INTERNAL_SERVER_ERROR', help) {
+        super(message, statusCode, code, help);
+    }
+}
+exports.Exception = Exception;

package/src/Handlers/HttpExceptionHandler.d.ts

@@ -0,0 +1,27 @@
+import { ErrorContextContract } from '../Contracts/Context/Error/ErrorContextContract';
+export declare class HttpExceptionHandler {
+    /**
+     * Set if error logs will come with stack.
+     *
+     * @protected
+     */
+    protected addStack: boolean;
+    /**
+     * Error codes that should be ignored by Log.
+     *
+     * @protected
+     */
+    protected ignoreCodes: string[];
+    /**
+     * Error statuses that should be ignored by Log.
+     *
+     * @protected
+     */
+    protected ignoreStatuses: string[];
+    /**
+     * The global exception handler of all HTTP requests.
+     *
+     * @param ctx
+     */
+    handle({ error, response }: ErrorContextContract): Promise<void>;
+}

package/src/Handlers/HttpExceptionHandler.js

@@ -0,0 +1,71 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HttpExceptionHandler = void 0;
+const logger_1 = require("@athenna/logger");
+const utils_1 = require("@secjs/utils");
+const config_1 = require("@athenna/config");
+class HttpExceptionHandler {
+    constructor() {
+        /**
+         * Set if error logs will come with stack.
+         *
+         * @protected
+         */
+        this.addStack = false;
+        /**
+         * Error codes that should be ignored by Log.
+         *
+         * @protected
+         */
+        this.ignoreCodes = [];
+        /**
+         * Error statuses that should be ignored by Log.
+         *
+         * @protected
+         */
+        this.ignoreStatuses = [];
+    }
+    /**
+     * The global exception handler of all HTTP requests.
+     *
+     * @param ctx
+     */
+    async handle({ error, response }) {
+        const code = error.code || error.name;
+        const statusCode = error.statusCode || error.status || 500;
+        const body = {
+            statusCode,
+            code: utils_1.String.toSnakeCase(`${code}`).toUpperCase(),
+            name: error.name,
+            message: error.message,
+            stack: error.stack,
+        };
+        if (error.help) {
+            body.help = error.help;
+        }
+        const isInternalServerError = statusCode === 500;
+        const isDebugMode = config_1.Config.get('app.debug');
+        if (isInternalServerError && !isDebugMode) {
+            body.name = 'Internal server error';
+            body.message = 'An internal server exception has occurred.';
+            delete body.stack;
+        }
+        if (this.ignoreCodes.includes(code) ||
+            this.ignoreStatuses.includes(statusCode)) {
+            return response.status(statusCode).send(body);
+        }
+        const logConfig = {
+            formatterConfig: {
+                context: 'ExceptionHandler',
+            },
+        };
+        if (this.addStack) {
+            logger_1.Log.error(`[${body.statusCode}] ${body.code}::${body.message}\nStack: ${body.stack}`, logConfig);
+        }
+        else {
+            logger_1.Log.error(`[${body.statusCode}] ${body.code}::${body.message}`, logConfig);
+        }
+        return response.status(statusCode).send(body);
+    }
+}
+exports.HttpExceptionHandler = HttpExceptionHandler;

package/src/Http.d.ts

@@ -70,7 +70,10 @@ export declare class Http {
      * @param type {handle,intercept,terminate}
      * @return void
      */
-    use(handler: HandleHandlerContract | InterceptHandlerContract | TerminateHandlerContract, type?: 'handle' | 'intercept' | 'terminate'): void;
+    use(handler: HandleHandlerContract): any;
+    use(handler: HandleHandlerContract, type: 'handle'): any;
+    use(handler: InterceptHandlerContract, type: 'intercept'): any;
+    use(handler: TerminateHandlerContract, type: 'terminate'): any;
     request(): LightMyRequest.Chain;
     request(options: InjectOptions | string): Promise<LightMyRequest.Response>;
     /**

package/src/Http.js

@@ -71,13 +71,6 @@ class Http {
     getRoutes(options) {
         return this.server.printRoutes(options);
     }
-    /**
-     * Print all routes registered.
-     *
-     * @param handler {HandleHandlerContract,InterceptHandlerContract,TerminateHandlerContract}
-     * @param type {handle,intercept,terminate}
-     * @return void
-     */
     use(handler, type = 'handle') {
         let hookName = 'preHandler';
         let handlerType = 'createDoneHandler';

package/src/Kernels/HttpKernel.d.ts

@@ -45,4 +45,10 @@ export declare abstract class HttpKernel {
      * @return void
      */
     registerLogMiddleware(): Promise<void>;
+    /**
+     * Register the requestId handle middleware.
+     *
+     * @return void
+     */
+    registerRequestIdMiddleware(): Promise<void>;
 }

package/src/Kernels/HttpKernel.js

@@ -1,11 +1,29 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.HttpKernel = void 0;
 const logger_1 = require("@athenna/logger");
 const config_1 = require("@athenna/config");
 const Server_1 = require("../Facades/Server");
 const utils_1 = require("@secjs/utils");
-const HttpErrorHandler_1 = require("../Handlers/HttpErrorHandler");
 class HttpKernel {
     /**
      * Register all global and named middlewares to the server.
@@ -76,7 +94,14 @@ class HttpKernel {
         if (config_1.Config.get('http.noErrorHandler')) {
             return;
         }
-        Server_1.Server.setErrorHandler(HttpErrorHandler_1.HttpErrorHandler.handler);
+        let extension = 'js';
+        if (config_1.Env('NODE_TS') === 'true') {
+            extension = 'ts';
+        }
+        const path = utils_1.Path.app(`Http/Exceptions/Handler.${extension}`);
+        const Handler = utils_1.resolveModule(await Promise.resolve().then(() => __importStar(require(path))));
+        const handler = new Handler();
+        Server_1.Server.setErrorHandler(handler.handle.bind(handler));
     }
     /**
      * Register log terminate middleware
@@ -92,5 +117,19 @@ class HttpKernel {
             return ctx.next();
         }, 'terminate');
     }
+    /**
+     * Register the requestId handle middleware.
+     *
+     * @return void
+     */
+    async registerRequestIdMiddleware() {
+        if (config_1.Config.get('http.noRequestId')) {
+            return;
+        }
+        Server_1.Server.use(async (ctx) => {
+            ctx.data.requestId = utils_1.Token.generate('ath');
+            return ctx.next();
+        }, 'handle');
+    }
 }
 exports.HttpKernel = HttpKernel;

package/src/Handlers/HttpErrorHandler.d.ts

@@ -1,12 +0,0 @@
-/**
- * @athenna/http
- *
- * (c) João Lenon <lenon@athenna.io>
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-import { ErrorContextContract } from '../Contracts/Context/Error/ErrorContextContract';
-export declare class HttpErrorHandler {
-    static handler({ error, response }: ErrorContextContract): void | Promise<void>;
-}

package/src/Handlers/HttpErrorHandler.js

@@ -1,46 +0,0 @@
-"use strict";
-/**
- * @athenna/http
- *
- * (c) João Lenon <lenon@athenna.io>
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.HttpErrorHandler = void 0;
-const utils_1 = require("@secjs/utils");
-const logger_1 = require("@athenna/logger");
-const config_1 = require("@athenna/config");
-class HttpErrorHandler {
-    static handler({ error, response }) {
-        const code = error.code || error.name;
-        const statusCode = error.statusCode || error.status || 500;
-        const body = {
-            statusCode,
-            code: utils_1.String.toSnakeCase(`${code}`).toUpperCase(),
-            name: error.name,
-            message: error.message,
-            stack: error.stack,
-        };
-        if (error.help) {
-            body.help = error.help;
-        }
-        const isInternalServerError = statusCode === 500;
-        const isDebugMode = config_1.Config.get('app.debug');
-        if (isInternalServerError && !isDebugMode) {
-            body.name = 'Internal server error';
-            body.message = 'An internal server exception has occurred.';
-            delete body.stack;
-        }
-        if (isDebugMode) {
-            logger_1.Log.error(`Error: ${JSON.stringify(body, null, 2)}`, {
-                formatterConfig: {
-                    context: HttpErrorHandler.name,
-                },
-            });
-        }
-        return response.status(statusCode).send(body);
-    }
-}
-exports.HttpErrorHandler = HttpErrorHandler;