barehttp 0.4.0 → 0.5.0

package/README.md

@@ -51,23 +51,23 @@ import { BareHttp, logMe } from 'barehttp';
 
 const app = new BareHttp();
 
-app.get({
+app.route.get({
   route: '/route',
   handler: function routeGet(flow) {
-    flow.json({ everythings: 'OK' });
+    flow.json({ everything: 'OK' });
   })
 });
 
 
 // you can chain the routes
-app
+app.route
   .post({
     route: '/route',
     handler: async function routePost(flow) {
       return 'RESPONSE POST';
     },
   })
-  .patch({
+  .route.patch({
     route: '/route',
     handler: async function routePatch(flow) {
       return 'RESPONSE PATCH';
@@ -90,7 +90,7 @@ import { BareHttp, logMe } from 'barehttp';
 
 const app = new BareHttp({ logging: true });
 
-app.get({
+ app.route.get({
   route:'/route',
   handler: async function routeV1() {
     return { promised: 'data' };
@@ -195,7 +195,7 @@ The order of the middlewares is followed by code declarations order.
 
 ---
 
-## `BareServer.get | post | patch | put | delete | options | head | declare` (Function)
+## `BareServer.route.get | post | patch | put | delete | options | head | declare` (Function)
 
 To set a route for `get | post | patch | put | delete | options | head` with following parameters:
 
@@ -206,7 +206,7 @@ To set a route for `get | post | patch | put | delete | options | head` with fol
   Example
 
 ```ts
-app.get({
+app.route.get({
   route: '/route',
   options: { timeout: 2000 },
   handler: async (flow) => {
@@ -214,7 +214,7 @@ app.get({
   },
 });
 
-app.declare({
+app.route.declare({
   route: '/declared_route',
   handler: () => {
     return 'My declared route response';
@@ -345,13 +345,21 @@ Imperatively disables cache, does the same as `disableCache: true` in `RouteOpti
 
 Imperatively sets the cache, does the same as `cache: CacheOptions` in `RouteOptions`
 
+### `addHeader` (Function)
+
+Adds a header outgoing header string as a (key, value) `addHeader(header, value)`. Can **not** overwrite.
+
+### `addHeaders` (Function)
+
+Adds outgoing headers in a "batch", merges provided headers object `{ [header: string]: value }` to already existing headers. Can **not** overwrite.
+
 ### `setHeader` (Function)
 
-Set outgoing header as a (key, value) arguments `setHeader(header, value)`. Can overwrite
+Does the same as `addHeader` but overrides the value.
 
 ### `setHeaders` (Function)
 
-Set outgoing headers in a "batch", merges provided headers object `{ [header: string]: value }` to already existing headers. Can overwrite
+Does the same as `addHeaders` but overrides the value.
 
 ### `status` (Function)
 
@@ -391,17 +399,42 @@ Some of the features are in progress.
 - [x] Request execution cancellation by timeout
 - [x] Bulk/chaining routes declaration
 - [x] Runtime routes hot swapping
+- [x] runtime validation schema generation per route response types (on project compile/on launch)
 - [ ] middlewares per route
 - [ ] swagger OpenAPI 3.0 on `/docs` endpoint
 - [ ] swagger OpenAPI 3.0 scheme on `/docs_raw` endpoint
 - [ ] optional export of generated schema to a location (yaml, json)
 - [ ] streaming/receiving of chunked multipart
-- [ ] runtime validation schema generation per route response types (on project compile/on launch)
 - [ ] runtime route params or query validation upon declared types (on project compile/on launch)
 
+## Runtime schema validation on response (EXPERIMENTAL)
+
+This feature enables a runtime check for the returned value for a route,
+for now it only works for `return` statements of the routes declared in handlers.
+
+Please write your `return` statements with plain response objects within the `handler` or `controller` function.
+
+To enable this feature you need to set up the following:
+
+- On `BareHttp` settings set: `enableSchemaValidation: true`
+- On `BareHttp` settings set: `declaredRoutesPaths: [...array of paths to routes]`,
+- On `route.<method>` declaration set: `options: { builtInRuntime: { output: true } }`
+
 ## Benchmarks
 
-(coming soon)
+Done on MacBook Pro with M1 Pro processor. No logs enabled. `NODE_ENV=production` is set. All settings set to default.
+
+### BareHttp
+
+![BareHttp](./docs/barehttp.png)
+
+### Express
+
+![Express](./docs/express.png)
+
+### Fastify
+
+![Fastify](./docs/fastify.png)
 
 ## Support
 

package/lib/context/execution.js

@@ -5,7 +5,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Execution = void 0;
 const hyperid_1 = __importDefault(require("hyperid"));
-const generateId = hyperid_1.default();
+const generateId = (0, hyperid_1.default)();
 class Execution {
     id;
     type;

package/lib/logger/index.js

@@ -1,7 +1,11 @@
 "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]; } });
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
 }) : (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];
@@ -23,45 +27,27 @@ exports.logMe = exports.logHttp = void 0;
 const pino_1 = __importStar(require("pino"));
 const serializers_1 = require("./serializers");
 const env_1 = require("../env");
-const asyncDest = env_1.envs.isProd ? [pino_1.destination({ sync: false })] : [];
+const asyncDest = env_1.envs.isProd ? [(0, pino_1.destination)({ sync: false })] : [];
 const pinoCommonOptions = {
     timestamp: () => `,"time":"${new Date()[env_1.envs.isProd ? 'toISOString' : 'toLocaleTimeString']()}"`,
     formatters: {
         level: (label) => ({ level: label }),
     },
     messageKey: 'message',
-    prettyPrint: !env_1.envs.isProd,
+    transport: env_1.envs.isProd ? undefined : { target: 'pino-pretty', options: { colorize: true } },
 };
-const logger = pino_1.default(pinoCommonOptions, asyncDest[0]);
-if (env_1.envs.isProd) {
-    setInterval(function () {
-        logger.flush();
-    }, 10000).unref();
-    const handler = pino_1.default.final(logger, (err, finalLogger, evt) => {
-        finalLogger.info(`${evt} caught`);
-        if (err)
-            finalLogger.error(err, 'error caused exit');
-        process.exit(err ? 1 : 0);
-    });
-    // catch all the ways node might exit
-    process.on('beforeExit', () => handler(null, 'beforeExit'));
-    process.on('exit', () => handler(null, 'exit'));
-    process.on('uncaughtException', (err) => handler(err, 'uncaughtException'));
-    process.on('SIGINT', () => handler(null, 'SIGINT'));
-    process.on('SIGQUIT', () => handler(null, 'SIGQUIT'));
-    process.on('SIGTERM', () => handler(null, 'SIGTERM'));
-}
+const logger = (0, pino_1.default)(pinoCommonOptions, asyncDest[0]);
 const logHttp = (...params) => {
-    const { level, logObject } = serializers_1.serializeHttp(...params);
+    const { level, logObject } = (0, serializers_1.serializeHttp)(...params);
     logger[level](logObject);
 };
 exports.logHttp = logHttp;
 // TODO: remove the test condition
 exports.logMe = {
-    debug: (...args) => !env_1.envs.isTest && logger.debug(serializers_1.serializeLog(...args)),
-    info: (...args) => !env_1.envs.isTest && logger.info(serializers_1.serializeLog(...args)),
-    warn: (...args) => !env_1.envs.isTest && logger.warn(serializers_1.serializeLog(...args)),
-    error: (...args) => !env_1.envs.isTest && logger.error(serializers_1.serializeLog(...args)),
-    fatal: (...args) => !env_1.envs.isTest && logger.fatal(serializers_1.serializeLog(...args)),
-    trace: (...args) => !env_1.envs.isTest && logger.trace(serializers_1.serializeLog(...args)),
+    debug: (...args) => !env_1.envs.isTest && logger.debug((0, serializers_1.serializeLog)(...args)),
+    info: (...args) => !env_1.envs.isTest && logger.info((0, serializers_1.serializeLog)(...args)),
+    warn: (...args) => !env_1.envs.isTest && logger.warn((0, serializers_1.serializeLog)(...args)),
+    error: (...args) => !env_1.envs.isTest && logger.error((0, serializers_1.serializeLog)(...args)),
+    fatal: (...args) => !env_1.envs.isTest && logger.fatal((0, serializers_1.serializeLog)(...args)),
+    trace: (...args) => !env_1.envs.isTest && logger.trace((0, serializers_1.serializeLog)(...args)),
 };

package/lib/logger/serializers.js

@@ -26,7 +26,7 @@ const parseArgs = (argSlice) => argSlice.map((arg) => {
     return arg;
 });
 function serializeLog(...args) {
-    const site = callsites_1.default()[2];
+    const site = (0, callsites_1.default)()[2];
     const meta = {
         timestamp: Date.now(),
         location: `${site.getFileName()}:${site.getLineNumber()}:${site.getColumnNumber()}`,

package/lib/middlewares/cookies/cookie-manager.js

@@ -16,7 +16,7 @@ class CookiesManager {
         this.flow = flow;
         const secret = this.options.secret || '';
         const enableRotation = Array.isArray(secret);
-        this.signer = typeof secret === 'string' || enableRotation ? signer_1.secretsOperator(secret) : null;
+        this.signer = typeof secret === 'string' || enableRotation ? (0, signer_1.secretsOperator)(secret) : null;
     }
     setCookie(name, value, options, signer) {
         const localSigner = signer || this.signer;

package/lib/request.d.ts

@@ -38,6 +38,7 @@ export declare class BareRequest {
     private startTime?;
     private startDate;
     private remoteClient;
+    private logging;
     private requestTimeFormat?;
     private headers;
     private cookies;
@@ -63,15 +64,20 @@ export declare class BareRequest {
     };
     disableCache(): void;
     setCache(cacheOpts: CacheOpts): void;
+    addHeader(header: string, value: string | number | string[] | number[]): void;
     setHeader(header: string, value: string | number | string[] | number[]): void;
     setHeaders(headers: {
         [header: string]: string | number | string[] | number[];
     }): void;
+    addHeaders(headers: {
+        [header: string]: string | number | string[] | number[];
+    }): void;
     status(status: StatusCodesUnion): this;
     sendStatus(status: StatusCodesUnion): void;
     stream<T extends NodeJS.WritableStream>(stream: T): void;
     json(data: any): void;
     _send(chunk?: string | ArrayBuffer | NodeJS.ArrayBufferView | SharedArrayBuffer): void;
+    sendStringifiedJson(data: string): void;
     send(anything?: any): void;
 }
 export {};

package/lib/request.js

@@ -12,7 +12,7 @@ const cookie_manager_1 = require("./middlewares/cookies/cookie-manager");
 const util_1 = require("util");
 const stream_1 = require("stream");
 const url_1 = __importDefault(require("url"));
-const generateId = hyperid_1.default();
+const generateId = (0, hyperid_1.default)();
 const statusTuples = Object.entries(utils_1.StatusCodes).reduce((acc, [name, status]) => {
     acc[status] = utils_1.StatusPhrases[name];
     return acc;
@@ -33,6 +33,7 @@ class BareRequest {
     startTime;
     startDate = new Date();
     remoteClient = '';
+    logging = false;
     requestTimeFormat;
     headers = {};
     cookies = {};
@@ -45,11 +46,12 @@ class BareRequest {
         this.remoteIp = _originalRequest.socket.remoteAddress;
         this.contentType = this._originalRequest.headers['content-type'];
         this.requestHeaders = this._originalRequest.headers;
+        this.logging = options?.logging ?? false;
         // this is a placeholder URL base that we need to make class working
         new url_1.default.URL(`http://localhost/${this._originalRequest.url}`).searchParams.forEach((value, name) => (this.query[name] = value));
         // parsed;
         _originalRequest['flow'] = this; // to receive flow object later on in the route handler
-        this.setHeaders({
+        this.addHeaders({
             'Content-Type': 'text/plain; charset=utf-8',
             'X-Request-Id': this.ID.code,
         });
@@ -57,26 +59,28 @@ class BareRequest {
             this.startTime = process.hrtime();
             this.requestTimeFormat = options.requestTimeFormat;
         }
-        // call logging section
-        if (options?.logging === true) {
-            _originalResponse.on('close', () => logger_1.logHttp(this.headers, this.startDate, this.remoteClient, _originalRequest, _originalResponse));
-        }
     }
     readBody() {
-        if (['POST', 'PATCH', 'PUT'].includes(this._originalRequest.method))
-            return new Promise((resolve, reject) => {
-                const temp = [];
-                this._originalRequest
-                    .on('data', (chunk) => temp.push(chunk))
-                    .on('end', () => {
-                    const parsed = this.classifyRequestBody(temp);
-                    if (util_1.types.isNativeError(parsed))
-                        reject(parsed);
-                    this.requestBody = parsed;
-                    resolve();
-                })
-                    .on('error', reject);
-            });
+        switch (this._originalRequest.method) {
+            case 'POST':
+            case 'PATCH':
+            case 'PUT':
+                return new Promise((resolve, reject) => {
+                    const temp = [];
+                    this._originalRequest
+                        .on('data', (chunk) => temp.push(chunk))
+                        .on('end', () => {
+                        const parsed = this.classifyRequestBody(temp);
+                        if (util_1.types.isNativeError(parsed))
+                            return reject(parsed);
+                        this.requestBody = parsed;
+                        resolve(parsed);
+                    })
+                        .on('error', reject);
+                });
+            default:
+                return;
+        }
     }
     attachCookieManager(opts) {
         this.cm = new cookie_manager_1.CookiesManager(opts, this);
@@ -90,7 +94,7 @@ class BareRequest {
             case 'text/plain':
                 return wholeChunk.toString();
             case 'application/json':
-                return safe_json_1.JSONParse(wholeChunk.toString());
+                return (0, safe_json_1.JSONParse)(wholeChunk.toString());
             case 'application/x-www-form-urlencoded':
                 const store = {};
                 for (const curr of wholeChunk.toString().split('&')) {
@@ -108,8 +112,6 @@ class BareRequest {
         this.remoteClient = remoteClient;
     }
     setRequestTime() {
-        if (!this.requestTimeFormat)
-            return;
         const diff = process.hrtime(this.startTime);
         const time = diff[0] * (this.requestTimeFormat === 's' ? 1 : 1e3) +
             diff[1] * (this.requestTimeFormat === 's' ? 1e-9 : 1e-6);
@@ -158,7 +160,7 @@ class BareRequest {
         if (cacheHeader.length > 0)
             this.setHeader(directive, cacheHeader);
     }
-    setHeader(header, value) {
+    addHeader(header, value) {
         const old = this.headers[header];
         const parsedVal = Array.isArray(value) ? value.join(', ') : '' + value;
         if (old) {
@@ -168,11 +170,20 @@ class BareRequest {
             this.headers[header] = parsedVal;
         }
     }
+    setHeader(header, value) {
+        const parsedVal = Array.isArray(value) ? value.join(', ') : '' + value;
+        this.headers[header] = parsedVal;
+    }
     setHeaders(headers) {
         for (const [header, value] of Object.entries(headers)) {
             this.setHeader(header, value);
         }
     }
+    addHeaders(headers) {
+        for (const [header, value] of Object.entries(headers)) {
+            this.addHeader(header, value);
+        }
+    }
     status(status) {
         this.statusToSend = status;
         return this;
@@ -185,7 +196,7 @@ class BareRequest {
     }
     json(data) {
         // to generate with fast-json-stringify schema issue #1
-        const jsoned = safe_json_1.JSONStringify(data);
+        const jsoned = (0, safe_json_1.JSONStringify)(data);
         this.setHeader('Content-Type', 'application/json');
         this._send(jsoned ? jsoned : undefined);
     }
@@ -198,14 +209,6 @@ class BareRequest {
             logger_1.logMe.error('Trying to send with the headers already sent');
             return;
         }
-        this.sent = true;
-        let toSend = chunk;
-        switch (chunk?.constructor) {
-            case Uint16Array:
-            case Uint8Array:
-            case Uint32Array:
-                toSend = Buffer.from(chunk.buffer);
-        }
         // work basic headers
         if (typeof chunk !== 'undefined' && chunk !== null)
             this.setHeader('Content-Length', Buffer.byteLength(chunk, 'utf-8'));
@@ -213,10 +216,20 @@ class BareRequest {
             this.setHeaders({ 'Cache-Control': 'no-store', Expire: 0, Pragma: 'no-cache' });
         if (this.statusToSend >= 400 && this.statusToSend !== 404 && this.statusToSend !== 410)
             this.cleanHeader('Cache-Control');
-        this.setRequestTime();
+        if (this.requestTimeFormat)
+            this.setRequestTime();
         // perform sending
-        this._originalResponse.writeHead(this.statusToSend, statusTuples[this.statusToSend], this.headers);
-        this._originalResponse.end(toSend);
+        this._originalResponse.writeHead(this.statusToSend, '', this.headers);
+        this._originalResponse.end(chunk || statusTuples[this.statusToSend]);
+        this.sent = true;
+        // call logging section
+        if (this.logging === true) {
+            (0, logger_1.logHttp)(this.headers, this.startDate, this.remoteClient, this._originalRequest, this._originalResponse);
+        }
+    }
+    sendStringifiedJson(data) {
+        this.setHeader('Content-Type', 'application/json');
+        this._send(data);
     }
     send(anything) {
         if (this.sent)
@@ -227,6 +240,8 @@ class BareRequest {
             case Uint8Array:
             case Uint16Array:
             case Uint32Array:
+                this._send(Buffer.from(anything.buffer));
+                break;
             case Buffer:
             case String:
                 this._send(anything);
@@ -234,10 +249,12 @@ class BareRequest {
             case Boolean:
             case Number:
                 this._send('' + anything);
+                break;
             case stream_1.Writable:
                 this.stream(anything);
                 break;
             case Object:
+            case Array:
                 this.json(anything);
                 break;
             default:

package/lib/schemas/custom-schema.d.ts

@@ -0,0 +1,32 @@
+import { ts, Type } from 'ts-morph';
+export declare type StringSchemaType = {
+    type: 'string';
+    nullable: boolean;
+};
+export declare type NumberSchemaType = {
+    type: 'number';
+    nullable: boolean;
+};
+export declare type BooleanSchemaType = {
+    type: 'boolean';
+    nullable: boolean;
+};
+export declare type ArraySchemaType = {
+    type: 'array';
+    items: StringSchemaType | NumberSchemaType | BooleanSchemaType | ArraySchemaType | ObjectSchemaType;
+    nullable: boolean;
+};
+export declare type ObjectSchemaType = {
+    type: 'object';
+    properties: {
+        [key: string]: StringSchemaType | NumberSchemaType | BooleanSchemaType | ArraySchemaType | ObjectSchemaType;
+    };
+    nullable: boolean;
+};
+export declare type UnionSchemaType = {
+    type: 'union';
+    anyOf: CustomSchema[];
+    nullable: boolean;
+};
+export declare type CustomSchema = StringSchemaType | NumberSchemaType | BooleanSchemaType | ArraySchemaType | ObjectSchemaType | UnionSchemaType;
+export declare const generateCustomSchema: (t: Type<ts.Type>) => CustomSchema;

package/lib/schemas/custom-schema.js

@@ -0,0 +1,69 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.generateCustomSchema = void 0;
+const find_1 = __importDefault(require("lodash/find"));
+const helpers_1 = require("./helpers");
+const generateCustomSchema = (t) => {
+    if ((0, helpers_1.isFinalType)(t)) {
+        return { type: (0, helpers_1.getTypeGenericText)(t), nullable: false };
+    }
+    if (t.isUnion()) {
+        const nulled = t.getUnionTypes().some((nt) => (0, helpers_1.isNullType)(nt));
+        const cleanTypes = helpers_1.helpers.cleanNullableTypes(t.getUnionTypes());
+        let returning = {
+            nullable: false,
+            type: 'union',
+        };
+        const transformed = cleanTypes.reduce((acc, ut) => {
+            const regenerated = (0, exports.generateCustomSchema)(ut);
+            if ((0, find_1.default)(acc, regenerated))
+                return acc;
+            return acc.concat(regenerated);
+        }, []);
+        if (transformed.length > 1) {
+            returning.anyOf = transformed;
+        }
+        else {
+            returning = transformed[0];
+        }
+        if (nulled) {
+            returning.nullable = true;
+        }
+        return returning;
+    }
+    if (t.isIntersection()) {
+        return t.getIntersectionTypes().reduce((acc, it) => {
+            const generatedSchema = (0, exports.generateCustomSchema)(it);
+            if (Object.keys(acc).length === 0) {
+                acc = generatedSchema;
+                return acc;
+            }
+            if (generatedSchema.type === acc.type && acc.type === 'object') {
+                acc.properties = { ...acc.properties, ...generatedSchema.properties };
+            }
+            return acc;
+        }, {});
+    }
+    if (t.isArray()) {
+        return {
+            type: 'array',
+            items: (0, exports.generateCustomSchema)(t.getArrayElementType()),
+        };
+    }
+    if (t.isInterface() || t.isObject()) {
+        const result = t.getProperties().reduce((acc, ci) => {
+            const val = ci.getValueDeclaration();
+            acc.properties = { ...acc.properties, [ci.getName()]: (0, exports.generateCustomSchema)(val.getType()) };
+            return acc;
+        }, { type: 'object', properties: {} });
+        return result;
+    }
+    return {
+        type: (0, helpers_1.getApparentTypeName)(t),
+        nullable: false,
+    };
+};
+exports.generateCustomSchema = generateCustomSchema;

package/lib/schemas/dirty-tsm.d.ts

@@ -0,0 +1 @@
+export {};