Merge pull request #47 from sckv/change-default-timer

fix(request-time): make request time header optional

Author: sckv

src/__tests__/request.test.ts

@@ -33,7 +33,7 @@ test('Adds logging listener if set up', () => {
 
   const listeners = out.listenerCount('close');
 
-  new BareRequest(inc, out, true);
+  new BareRequest(inc, out, { logging: true });
 
   expect(out.listenerCount('close')).toBe(listeners + 1);
 });
@@ -49,7 +49,7 @@ test('Gets response header', () => {
 test('Adds basic headers to the request upon instantiation', () => {
   const { request } = createRequest();
 
-  expect(request.getHeader('Content-Type')).toBe('text/plain');
+  expect(request.getHeader('Content-Type')).toBe('text/plain; charset=utf-8');
   expect(request.getHeader('X-Request-Id')).toEqual(expect.any(String));
 });
 

src/__tests__/server.integration.test.ts

@@ -116,7 +116,7 @@ test('Sets x-processing-time to milliseconds', async () => {
 });
 
 test('Base x-processing-time is in seconds', async () => {
-  const app = new BareHttp();
+  const app = new BareHttp({ requestTimeFormat: 's' });
 
   app.get({
     route: '/test',

src/bench/baretest.ts

@@ -4,7 +4,9 @@ const brt = new BareHttp({ statisticsReport: true });
 
 brt.get({
   route: '/myroute',
-  handler: () => 'just response',
+  handler: (flow) => {
+    flow._send('just response');
+  },
 });
 
 brt.start(() => console.log('server started'));

src/request.ts

@@ -52,10 +52,10 @@ export class BareRequest {
   sent = false;
 
   private cache = true;
-  private startTime: [seconds: number, nanoseconds: number];
+  private startTime?: [seconds: number, nanoseconds: number];
   private startDate = new Date();
   private remoteClient = '';
-  private countTimeFormat: 'ms' | 's' = 's';
+  private requestTimeFormat?: 'ms' | 's';
   private headers: { [header: string]: string | string[] } = {};
   private cookies: { [cooke: string]: string } = {};
   private contentType?: keyof typeof ContentType;
@@ -64,20 +64,27 @@ export class BareRequest {
   constructor(
     public _originalRequest: IncomingMessage,
     public _originalResponse: ServerResponse,
-    logging?: boolean,
+    options?: { logging?: boolean; requestTimeFormat?: 'ms' | 's' },
   ) {
     this.ID = { code: (_originalRequest.headers['x-request-id'] as string) || generateId() };
     this.remoteIp = _originalRequest.socket.remoteAddress;
     this.contentType = this._originalRequest.headers['content-type'] as any;
     this.requestHeaders = this._originalRequest.headers;
 
-    _originalRequest['flow'] = this; // to receive an id later on in the route handler
+    _originalRequest['flow'] = this; // to receive flow object later on in the route handler
 
-    this.setHeaders({ 'Content-Type': 'text/plain', 'X-Request-Id': this.ID.code });
-    this.startTime = process.hrtime();
+    this.setHeaders({
+      'Content-Type': 'text/plain; charset=utf-8',
+      'X-Request-Id': this.ID.code,
+    });
+
+    if (options?.requestTimeFormat) {
+      this.startTime = process.hrtime();
+      this.requestTimeFormat = options.requestTimeFormat;
+    }
 
     // call logging section
-    if (logging === true) {
+    if (options?.logging === true) {
       _originalResponse.on('close', () =>
         logHttp(
           this.headers,
@@ -140,22 +147,20 @@ export class BareRequest {
   }
 
   private setRequestTime() {
+    if (!this.requestTimeFormat) return;
+
     const diff = process.hrtime(this.startTime);
 
     const time =
-      diff[0] * (this.countTimeFormat === 's' ? 1 : 1e3) +
-      diff[1] * (this.countTimeFormat === 's' ? 1e-9 : 1e-6);
+      diff[0] * (this.requestTimeFormat === 's' ? 1 : 1e3) +
+      diff[1] * (this.requestTimeFormat === 's' ? 1e-9 : 1e-6);
 
     this.setHeaders({
       'X-Processing-Time': time,
-      'X-Processing-Time-Mode': this.countTimeFormat === 's' ? 'seconds' : 'milliseconds',
+      'X-Processing-Time-Mode': this.requestTimeFormat === 's' ? 'seconds' : 'milliseconds',
     });
   }
 
-  private setTimeFormat(format: 's' | 'ms') {
-    this.countTimeFormat = format;
-  }
-
   private cleanHeader(header: string) {
     delete this.headers[header];
   }
@@ -245,7 +250,8 @@ export class BareRequest {
       logMe.error("Tying to send into closed client's stream");
       return;
     }
-    if (this._originalResponse.headersSent) {
+
+    if (this._originalResponse.headersSent || this.sent) {
       logMe.error('Trying to send with the headers already sent');
       return;
     }

src/server.ts

@@ -53,7 +53,7 @@ type BareOptions<A extends IP> = {
   errorHandlerMiddleware?: ErrorHandler;
   /**
    * Request time format in `seconds` or `milliseconds`
-   * Default 's' - seconds
+   * Default - disabled
    */
   requestTimeFormat?: 's' | 'ms';
   /**
@@ -138,16 +138,14 @@ export class BareServer<A extends IP> {
   #listener = (request: IncomingMessage, response: ServerResponse) => {
     const { requestTimeFormat, logging } = this.bareOptions;
 
-    const flow = new BareRequest(request, response, logging);
+    const flow = new BareRequest(request, response, { logging, requestTimeFormat });
 
     // init and attach request uuid to the context
     if (this.bareOptions.context) {
       newContext('request');
       context.current?.store.set('id', flow.ID.code);
     }
 
-    if (requestTimeFormat) flow['setTimeFormat'](requestTimeFormat);
-
     // attach a flow to the flow memory storage
     this.applyMiddlewares(flow).catch((e) => this.#errorHandler(e, flow, 400));
   };