Merge pull request #12 from cybercoder-naj/feat-10/request-timing

Feat-10/request-timing

Author: cybercoder-naj

CHANGELOG.md

@@ -1,4 +1,16 @@
 # CHANGELOG
+## [1.0.0-alpha.5] - 26-03-2024
+### Changed
+- Request duration returns time in microseconds.
+- `fancy` preset includes the duration on successful requests.
+
+<!-- ### Fixed
+- Incorrect status code when returning with `error` function ([#11](https://github.com/cybercoder-naj/logestic/issues/11)) -->
+
+## [1.0.0-alpha.4] - 26-03-2024
+### Added
+- Request duration as a logging feature ([#10](https://github.com/cybercoder-naj/logestic/issues/10))
+
 ## [1.0.0-alpha.3] - 25-03-2024
 ### Changed
 - README file and updated the Wiki page.

bun.lockb

@@ -1,6 +1,6 @@
 {
   "name": "logestic",
-  "version": "1.0.0-alpha.3",
+  "version": "1.0.0-alpha.5",
   "author": "Nishant Aanjaney Jalan <[email protected]>",
   "description": "An advanced and customisable logging library for ElysiaJS",
   "keywords": [
@@ -30,12 +30,12 @@
   },
   "peerDependencies": {
     "typescript": "^5.0.0",
-    "elysia": "^1.0.0"
+    "elysia": "^1.0.9"
   },
   "devDependencies": {
-    "@elysiajs/eden": "1.0.0",
+    "@elysiajs/eden": "1.0.7",
     "bun-types": "latest",
-    "elysia": "^1.0.7",
+    "elysia": "^1.0.9",
     "rimraf": "^5.0.5",
     "typescript": "^5.4.3"
   },

package.json

@@ -125,13 +125,20 @@ export class Logestic {
    */
   format(this: Logestic, formatAttr: FormatObj) {
     return this.build()
-      .onAfterHandle({ as: 'global' }, ctx => {
+      .state('logestic_timeStart', 0n)
+      .onRequest(({ store }) => {
+        store.logestic_timeStart = process.hrtime.bigint();
+      })
+      .onResponse({ as: 'global' }, ctx => {
         if (!this.httpLogging) {
           return;
         }
 
         // get attributes, format and log
-        let attrs = buildAttrs(ctx, this.requestedAttrs);
+        const {
+          store: { logestic_timeStart }
+        } = ctx;
+        let attrs = buildAttrs(ctx, this.requestedAttrs, logestic_timeStart);
         let msg = formatAttr.onSuccess(attrs);
         if (this.showLevel) {
           msg = `${colourLogType('http', this.logLevelColour)} ${msg}`;

src/index.ts

@@ -21,13 +21,13 @@ export default (options: LogesticOptions) =>
     ...defaultOptions,
     ...options
   })
-    .use(['time', 'method', 'path'])
+    .use(['time', 'method', 'path', 'duration'])
     .format({
-      onSuccess({ time, method, path }) {
+      onSuccess({ time, method, path, duration }) {
         const dateTime = chalk.gray(getDateTimeString(time!!));
         const methodPath = chalk.cyan(`${method} ${path}`);
 
-        return `${dateTime} ${methodPath}`;
+        return `${dateTime} ${methodPath} ${duration}μs`;
       },
       onFailure({ request, datetime }) {
         const dateTime = getDateTimeString(datetime!!);

src/presets/fancy.ts

@@ -18,6 +18,7 @@ export type Attribute = {
   status?: any;
   referer?: string;
   userAgent?: string;
+  duration?: bigint;
 };
 
 export type ErrorAttribute = {

src/types.ts

@@ -14,7 +14,11 @@ import chalk, { ChalkInstance } from 'chalk';
  * @param reqAttrs A map of attributes to be built
  * @returns The built attributes
  */
-export const buildAttrs = (ctx: Context, reqAttrs: AttributeMap): Attribute => {
+export const buildAttrs = (
+  ctx: Context,
+  reqAttrs: AttributeMap,
+  timeStart: bigint
+): Attribute => {
   const { request, path, body, query, set } = ctx;
 
   let attrs: Attribute = {};
@@ -60,6 +64,11 @@ export const buildAttrs = (ctx: Context, reqAttrs: AttributeMap): Attribute => {
       case 'userAgent':
         attrs.userAgent = request.headers.get('user-agent') || '<user-agent?>';
         break;
+
+      case 'duration':
+        const now = process.hrtime.bigint();
+        attrs.duration = (now - timeStart) / 1000n;
+        break;
     }
   }