@athenna/http 4.24.0 → 4.26.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@athenna/http",
-  "version": "4.24.0",
+  "version": "4.26.0",
   "description": "The Athenna Http server. Built on top of fastify.",
   "license": "MIT",
   "author": "João Lenon <lenon@athenna.io>",
@@ -29,6 +29,7 @@
   "scripts": {
     "build": "node node_modules/@athenna/tsconfig/src/build.js",
     "lint:fix": "eslint \"{bin,src,tests}/**/*.ts\" --fix",
+    "benchmark": "node --no-warnings --enable-source-maps --import=@athenna/tsconfig tests/benchmarks/ServerTest.ts",
     "test": "npm run --silent lint:fix && node --enable-source-maps --import=@athenna/tsconfig bin/test.ts",
     "test:debug": "cross-env NODE_DEBUG=athenna:* node --inspect --enable-source-maps --import=@athenna/tsconfig bin/test.ts",
     "test:coverage": "c8 npm run --silent test"
@@ -88,6 +89,7 @@
     "@fastify/swagger-ui": "^3.0.0",
     "@typescript-eslint/eslint-plugin": "^6.7.4",
     "@typescript-eslint/parser": "^6.7.4",
+    "autocannon": "^7.15.0",
     "commitizen": "^4.2.6",
     "cz-conventional-changelog": "^3.3.0",
     "eslint": "^8.36.0",
@@ -100,6 +102,7 @@
     "foreground-child": "^2.0.0",
     "husky": "^3.1.0",
     "lint-staged": "^12.5.0",
+    "ora": "^8.0.1",
     "prettier": "^2.8.7"
   },
   "c8": {

package/src/context/Request.d.ts

@@ -11,7 +11,7 @@ export declare class Request {
     /**
      * The fastify request object.
      */
-    request: FastifyRequest;
+    private request;
     constructor(request: FastifyRequest);
     /**
      * Get the request id.
@@ -235,6 +235,10 @@ export declare class Request {
      * ```
      */
     except(keys: string[]): any;
+    /**
+     * Get the original fastify request.
+     */
+    getFastifyRequest(): FastifyRequest;
     /**
      * Add the hostname and port to the url.
      */

package/src/context/Request.js

@@ -295,6 +295,12 @@ export class Request {
         });
         return body;
     }
+    /**
+     * Get the original fastify request.
+     */
+    getFastifyRequest() {
+        return this.request;
+    }
     /**
      * Add the hostname and port to the url.
      */

package/src/context/Response.d.ts

@@ -8,17 +8,16 @@
  */
 import type { FastifyReply } from 'fastify';
 import type { SendOptions } from '@fastify/static';
-import type { Request } from '#src/context/Request';
 import type { FastifyHelmetOptions } from '@fastify/helmet';
 export declare class Response {
     /**
      * The fastify response object.
      */
-    response: FastifyReply;
+    private response;
     /**
      * The request object from request context.
      */
-    request: Request;
+    private request;
     constructor(response: FastifyReply, request?: Request);
     /**
      * Verify if the response has been already sent. Keep
@@ -213,4 +212,8 @@ export declare class Response {
      * ```
      */
     helmet(options: FastifyHelmetOptions): Response;
+    /**
+     * Get the original fastify response.
+     */
+    getFastifyResponse(): FastifyReply;
 }

package/src/context/Response.js

@@ -97,7 +97,7 @@ export class Response {
      */
     async view(view, data) {
         const content = await View.render(view, { ...data, request: this.request });
-        await this.safeHeader('Content-Type', 'text/html; charset=utf-8').response.send(content);
+        await this.safeHeader('Content-Type', 'text/html; charset=utf-8').send(content);
         this.response.body = content;
         return this;
     }
@@ -233,4 +233,10 @@ export class Response {
         this.response.helmet(options);
         return this;
     }
+    /**
+     * Get the original fastify response.
+     */
+    getFastifyResponse() {
+        return this.response;
+    }
 }

package/src/handlers/FastifyHandler.js

@@ -19,9 +19,11 @@ export class FastifyHandler {
             if (!req.data) {
                 req.data = {};
             }
-            const request = new Request(req);
-            const response = new Response(res, request);
-            return handler({ request, response, data: req.data });
+            const ctx = {};
+            ctx.data = req.data;
+            ctx.request = new Request(req);
+            ctx.response = new Response(res, ctx.request);
+            await handler(ctx);
         };
     }
     /**
@@ -38,19 +40,17 @@ export class FastifyHandler {
             if (!req.data) {
                 req.data = {};
             }
-            const request = new Request(req);
-            const response = new Response(res, request);
             if (Is.Json(payload)) {
                 payload = JSON.parse(payload);
             }
             res.body = payload;
-            payload = await handler({
-                request,
-                response,
-                status: response.statusCode,
-                data: req.data
-            });
-            res.body = payload;
+            const ctx = {};
+            ctx.data = req.data;
+            ctx.request = new Request(req);
+            ctx.response = new Response(res, ctx.request);
+            ctx.status = ctx.response.statusCode;
+            payload = await handler(ctx);
+            req.body = payload;
             if (Is.Object(payload)) {
                 payload = JSON.stringify(payload);
             }
@@ -65,15 +65,13 @@ export class FastifyHandler {
             if (!req.data) {
                 req.data = {};
             }
-            const request = new Request(req);
-            const response = new Response(res, request);
-            await handler({
-                request,
-                response,
-                data: req.data,
-                status: res.statusCode,
-                responseTime: res.elapsedTime
-            });
+            const ctx = {};
+            ctx.data = req.data;
+            ctx.request = new Request(req);
+            ctx.response = new Response(res, ctx.request);
+            ctx.status = ctx.response.statusCode;
+            ctx.responseTime = ctx.response.elapsedTime;
+            await handler(ctx);
         };
     }
     /**
@@ -84,14 +82,12 @@ export class FastifyHandler {
             if (!req.data) {
                 req.data = {};
             }
-            const request = new Request(req);
-            const response = new Response(res, request);
-            await handler({
-                request,
-                response,
-                data: req.data,
-                error
-            });
+            const ctx = {};
+            ctx.data = req.data;
+            ctx.request = new Request(req);
+            ctx.response = new Response(res, ctx.request);
+            ctx.error = error;
+            await handler(ctx);
         };
     }
 }

package/src/router/Router.d.ts

@@ -44,6 +44,16 @@ export declare class Router {
      * Creates a new route resource.
      */
     resource(resource: string, controller?: any): RouteResource;
+    /**
+     * This method is a convenient shortcut to render a view without
+     * defining an explicit handler.
+     */
+    view(pattern: string, view: string, data?: any): Route;
+    /**
+     * This method is a convenient shortcut to redirect a route without
+     * defining an explicit handler.
+     */
+    redirect(pattern: string, url: string, status?: number): Route;
     /**
      * Define a route that handles all common HTTP methods.
      */

package/src/router/Router.js

@@ -79,6 +79,24 @@ export class Router {
         }
         return resourceInstance;
     }
+    /**
+     * This method is a convenient shortcut to render a view without
+     * defining an explicit handler.
+     */
+    view(pattern, view, data) {
+        return this.route(pattern, ['GET', 'HEAD'], ctx => {
+            return ctx.response.view(view, data);
+        });
+    }
+    /**
+     * This method is a convenient shortcut to redirect a route without
+     * defining an explicit handler.
+     */
+    redirect(pattern, url, status) {
+        return this.route(pattern, ['GET', 'HEAD'], ctx => {
+            return ctx.response.redirectTo(url, status);
+        });
+    }
     /**
      * Define a route that handles all common HTTP methods.
      */

package/src/server/ServerImpl.js

@@ -125,7 +125,7 @@ export class ServerImpl {
         if (!this.isListening) {
             return;
         }
-        await this.fastify.close().then(() => (this.isListening = true));
+        await this.fastify.close().then(() => (this.isListening = false));
     }
     /**
      * Add a new route to the http server.

package/src/types/contexts/Context.d.ts

@@ -6,11 +6,24 @@
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
-import { Request } from '#src/context/Request';
-import { Response } from '#src/context/Response';
+import type { Request } from '#src/context/Request';
+import type { Response } from '#src/context/Response';
 export type Context = {
+    /**
+     * Retrieve any kind of data from your request by using the
+     * request object.
+     */
     request: Request;
+    /**
+     * Return a response from the request using the response
+     * object.
+     */
     response: Response;
+    /**
+     * Save any kind of data that will be shared in all of your
+     * request flow. The data defined here will be available in
+     * middlewares, route handlers, interceptors and terminators.
+     */
     data: any;
 };
 export type RequestHandler = (ctx: Context) => any | Promise<any>;

package/src/types/contexts/Context.js

@@ -6,5 +6,4 @@
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
-import { Request } from '#src/context/Request';
-import { Response } from '#src/context/Response';
+export {};