express-ext 0.1.12 → 0.1.13

package/lib/index.js

@@ -1,2 +1 @@
-"use strict";function __export(m){for(var p in m)if(!exports.hasOwnProperty(p))exports[p]=m[p]}
-Object.defineProperty(exports,"__esModule",{value:!0});var GenericController_1=require("./GenericController");exports.GenericHandler=GenericController_1.GenericController;var GenericSearchController_1=require("./GenericSearchController");exports.GenericSearchHandler=GenericSearchController_1.GenericSearchController;var HealthController_1=require("./HealthController");exports.HealthHandler=HealthController_1.HealthController;var LoadController_1=require("./LoadController");exports.LoadHandler=LoadController_1.LoadController;exports.ViewHandler=LoadController_1.LoadController;exports.ViewController=LoadController_1.LoadController;var LoadSearchController_1=require("./LoadSearchController");exports.LoadSearchHandler=LoadSearchController_1.LoadSearchController;var LowCodeController_1=require("./LowCodeController");exports.LowCodeHandler=LowCodeController_1.LowCodeController;exports.Handler=LowCodeController_1.LowCodeController;exports.Controller=LowCodeController_1.LowCodeController;var SearchController_1=require("./SearchController");exports.SearchHandler=SearchController_1.SearchController;var LogController_1=require("./LogController");exports.LogHandler=LogController_1.LogController;__export(require("./health"));__export(require("./HealthController"));__export(require("./LogController"));__export(require("./http"));__export(require("./view"));__export(require("./LoadController"));__export(require("./search_func"));__export(require("./search"));__export(require("./SearchController"));__export(require("./LoadSearchController"));__export(require("./resources"));__export(require("./edit"));__export(require("./GenericController"));__export(require("./GenericSearchController"));__export(require("./LowCodeController"))
+"use strict";function __export(r){for(var e in r)exports.hasOwnProperty(e)||(exports[e]=r[e])}Object.defineProperty(exports,"__esModule",{value:!0});var GenericController_1=require("./GenericController");exports.GenericHandler=GenericController_1.GenericController;var GenericSearchController_1=require("./GenericSearchController");exports.GenericSearchHandler=GenericSearchController_1.GenericSearchController;var HealthController_1=require("./HealthController");exports.HealthHandler=HealthController_1.HealthController;var LoadController_1=require("./LoadController");exports.LoadHandler=LoadController_1.LoadController,exports.ViewHandler=LoadController_1.LoadController,exports.ViewController=LoadController_1.LoadController;var LoadSearchController_1=require("./LoadSearchController");exports.LoadSearchHandler=LoadSearchController_1.LoadSearchController;var LogController_1=require("./LogController");exports.LogHandler=LogController_1.LogController;var LowCodeController_1=require("./LowCodeController");exports.LowCodeHandler=LowCodeController_1.LowCodeController,exports.Handler=LowCodeController_1.LowCodeController,exports.Controller=LowCodeController_1.LowCodeController;var SearchController_1=require("./SearchController");exports.SearchHandler=SearchController_1.SearchController,__export(require("./health")),__export(require("./HealthController")),__export(require("./LogController")),__export(require("./log")),__export(require("./http")),__export(require("./view")),__export(require("./LoadController")),__export(require("./search_func")),__export(require("./search")),__export(require("./SearchController")),__export(require("./LoadSearchController")),__export(require("./resources")),__export(require("./edit")),__export(require("./GenericController")),__export(require("./GenericSearchController")),__export(require("./LowCodeController"));

package/lib/log.js

@@ -0,0 +1,143 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+var stream_1 = require("stream");
+function createConfig(c) {
+  if (!c) {
+    return { skips: [], duration: 'duration', request: '', response: '', status: '', size: '' };
+  }
+  var l = {
+    log: c.log,
+    separate: c.separate,
+    skips: c.skips ? c.skips.split(',') : [],
+    duration: c.duration ? c.duration : 'duration',
+    request: c.request ? c.request : '',
+    response: c.response ? c.response : '',
+    status: c.status ? c.status : '',
+    size: c.size ? c.size : ''
+  };
+  return l;
+}
+exports.createConfig = createConfig;
+function skip(skips, url) {
+  if (skips.length === 0) {
+    return false;
+  }
+  var u = removeUrlParams(url);
+  for (var _i = 0, skips_1 = skips; _i < skips_1.length; _i++) {
+    var s = skips_1[_i];
+    if (u.endsWith(s)) {
+      return true;
+    }
+  }
+  return false;
+}
+exports.skip = skip;
+function removeUrlParams(url) {
+  var startParams = url.indexOf('?');
+  return startParams !== -1 ? url.substring(0, startParams) : url;
+}
+exports.removeUrlParams = removeUrlParams;
+var Logger = (function () {
+  function Logger(write, conf, build) {
+    this.write = write;
+    this.build = build;
+    this.log = this.log.bind(this);
+    this.c = createConfig(conf);
+  }
+  Logger.prototype.log = function (req, res, next) {
+    var _this = this;
+    if (this.c.log && !skip(this.c.skips, req.originalUrl)) {
+      var start_1 = process.hrtime();
+      var m = req.method;
+      var x = this.c.request;
+      var r_1 = false;
+      if (m !== 'GET' && m !== 'DELETE') {
+        r_1 = true;
+      }
+      var msg_1 = m + " " + req.originalUrl;
+      if (this.c.separate && r_1) {
+        if (this.c.request.length > 0) {
+          var op = {};
+          op[x] = JSON.stringify(req.body);
+          if (this.build) {
+            var op2 = this.build(req, op);
+            this.write(msg_1, op2);
+          }
+          else {
+            this.write(msg_1, op);
+          }
+        }
+      }
+      var chunks_1 = [];
+      mapResponseBody(res, chunks_1);
+      res.on('finish', function () {
+        var duration = getDurationInMilliseconds(start_1);
+        var op = {};
+        op[_this.c.duration] = duration;
+        if (r_1 && !_this.c.separate && _this.c.request.length > 0) {
+          op[_this.c.request] = JSON.stringify(req.body);
+        }
+        if (_this.c.response.length > 0) {
+          var rsBody = Buffer.concat(chunks_1).toString();
+          op[_this.c.response] = rsBody;
+        }
+        if (_this.c.status.length > 0) {
+          op[_this.c.status] = res.statusCode;
+        }
+        if (_this.c.size.length > 0) {
+          if ('_contentLength' in res) {
+            op[_this.c.size] = res['_contentLength'];
+          }
+          else if (res.hasHeader('content-length')) {
+            var l = res.getHeader('content-length');
+            if (typeof l === 'number' || typeof l === 'string') {
+              op[_this.c.size] = l;
+            }
+          }
+        }
+        if (_this.build) {
+          var op2 = _this.build(req, op);
+          _this.write(msg_1, op2);
+        }
+        else {
+          _this.write(msg_1, op);
+        }
+      });
+      next();
+    }
+    else {
+      next();
+    }
+  };
+  return Logger;
+}());
+exports.Logger = Logger;
+var mapResponseBody = function (res, chunks) {
+  var defaultWrite = res.write.bind(res);
+  var defaultEnd = res.end.bind(res);
+  var ps = new stream_1.PassThrough();
+  ps.on('data', function (data) { return chunks.push(data); });
+  res.write = function () {
+    var _a;
+    var args = [];
+    for (var _i = 0; _i < arguments.length; _i++) {
+      args[_i] = arguments[_i];
+    }
+    (_a = ps).write.apply(_a, args);
+    defaultWrite.apply(void 0, args);
+  };
+  res.end = function () {
+    var args = [];
+    for (var _i = 0; _i < arguments.length; _i++) {
+      args[_i] = arguments[_i];
+    }
+    ps.end.apply(ps, args);
+    defaultEnd.apply(void 0, args);
+  };
+};
+var NS_PER_SEC = 1e9;
+var NS_TO_MS = 1e6;
+var getDurationInMilliseconds = function (start) {
+  var diff = process.hrtime(start);
+  return (diff[0] * NS_PER_SEC + diff[1]) / NS_TO_MS;
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "express-ext",
-  "version": "0.1.12",
+  "version": "0.1.13",
   "description": "express-ext",
   "main": "./lib/index.js",
   "types": "./src/index.ts",

package/src/GenericController.ts

@@ -1,6 +1,6 @@
 import {Request, Response} from 'express';
 import {checkId, create, initializeStatus, isTypeError, ResultInfo, StatusConfig, update} from './edit';
-import {handleError} from './http';
+import {handleError, Log} from './http';
 import {LoadController} from './LoadController';
 import {Attribute, Attributes, ErrorMessage} from './metadata';
 import {resources} from './resources';
@@ -17,7 +17,7 @@ export interface GenericService<T, ID, R> {
 export class GenericController<T, ID> extends LoadController<T, ID> {
   status: StatusConfig;
   metadata?: Attributes;
-  constructor(log: (msg: string) => void, public service: GenericService<T, ID, number|ResultInfo<T>>, status?: StatusConfig, public validate?: (obj: T, patch?: boolean) => Promise<ErrorMessage[]>) {
+  constructor(log: Log, public service: GenericService<T, ID, number|ResultInfo<T>>, status?: StatusConfig, public validate?: (obj: T, patch?: boolean) => Promise<ErrorMessage[]>) {
     super(log, service);
     this.status = initializeStatus(status);
     if (service.metadata) {
@@ -67,7 +67,7 @@ export class GenericController<T, ID> extends LoadController<T, ID> {
     }
   }
 }
-export function validateAndCreate<T>(req: Request, res: Response, status: StatusConfig, save: (obj: T, ctx?: any) => Promise<number|ResultInfo<T>>, log: (msg: string) => void, validate?: (obj: T, patch?: boolean) => Promise<ErrorMessage[]>): void {
+export function validateAndCreate<T>(req: Request, res: Response, status: StatusConfig, save: (obj: T, ctx?: any) => Promise<number|ResultInfo<T>>, log: Log, validate?: (obj: T, patch?: boolean) => Promise<ErrorMessage[]>): void {
   const obj = req.body;
   if (!obj || obj === '') {
     return res.status(400).end('The request body cannot be empty.');
@@ -85,7 +85,7 @@ export function validateAndCreate<T>(req: Request, res: Response, status: Status
     create(res, status, obj, save, log);
   }
 }
-export function validateAndUpdate<T>(res: Response, status: StatusConfig, obj: T, isPatch: boolean, save: (obj: T, ctx?: any) => Promise<number|ResultInfo<T>>, log: (msg: string) => void, validate?: (obj: T, patch?: boolean) => Promise<ErrorMessage[]>):  void {
+export function validateAndUpdate<T>(res: Response, status: StatusConfig, obj: T, isPatch: boolean, save: (obj: T, ctx?: any) => Promise<number|ResultInfo<T>>, log: Log, validate?: (obj: T, patch?: boolean) => Promise<ErrorMessage[]>):  void {
   if (validate) {
     validate(obj, isPatch).then(errors => {
       if (errors && errors.length > 0) {

package/src/GenericSearchController.ts

@@ -1,7 +1,7 @@
 import {Request, Response} from 'express';
 import {ResultInfo, StatusConfig} from './edit';
 import {GenericController, GenericService} from './GenericController';
-import {handleError} from './http';
+import {handleError, Log} from './http';
 import {ErrorMessage} from './metadata';
 import {Filter, format, fromRequest, getParameters, initializeConfig, jsonResult, SearchConfig, SearchResult} from './search';
 import {getMetadataFunc} from './search_func';
@@ -15,7 +15,7 @@ export class GenericSearchController<T, ID, S extends Filter> extends GenericCon
   numbers?: string[];
   fields?: string;
   excluding?: string;
-  constructor(log: (msg: string) => void, public find: (s: S, limit?: number, skip?: number|string, fields?: string[]) => Promise<SearchResult<T>>, service: GenericService<T, ID, number|ResultInfo<T>>, config?: Config, validate?: (obj: T, patch?: boolean) => Promise<ErrorMessage[]>, dates?: string[], numbers?: string[]) {
+  constructor(log: Log, public find: (s: S, limit?: number, skip?: number|string, fields?: string[]) => Promise<SearchResult<T>>, service: GenericService<T, ID, number|ResultInfo<T>>, config?: Config, validate?: (obj: T, patch?: boolean) => Promise<ErrorMessage[]>, dates?: string[], numbers?: string[]) {
     super(log, service, config, validate);
     this.search = this.search.bind(this);
     this.config = initializeConfig(config);

package/src/LoadController.ts

@@ -1,5 +1,5 @@
 import {Request, Response} from 'express';
-import {attrs, handleError, respondModel} from './http';
+import {attrs, handleError, Log, respondModel} from './http';
 import {Attribute, Attributes} from './metadata';
 import {buildAndCheckId, buildKeys} from './view';
 
@@ -39,7 +39,7 @@ function getKeysFunc<T, ID>(viewService: ViewService<T, ID> | ((id: ID, ctx?: an
 export class LoadController<T, ID> {
   protected keys?: Attribute[];
   protected view: (id: ID, ctx?: any) => Promise<T|null>;
-  constructor(protected log: (msg: string) => void, viewService: ViewService<T, ID> | ((id: ID, ctx?: any) => Promise<T|null>), keys?: Attributes|Attribute[]|string[]) {
+  constructor(protected log: Log, viewService: ViewService<T, ID> | ((id: ID, ctx?: any) => Promise<T|null>), keys?: Attributes|Attribute[]|string[]) {
     this.load = this.load.bind(this);
     this.view = getViewFunc(viewService);
     this.keys = getKeysFunc(viewService, keys);

package/src/LoadSearchController.ts

@@ -1,5 +1,5 @@
 import {Request, Response} from 'express';
-import {handleError} from './http';
+import {handleError, Log} from './http';
 import {LoadController, ViewService} from './LoadController';
 import {Attribute, Attributes} from './metadata';
 import {Filter, format, fromRequest, getParameters, initializeConfig, jsonResult, SearchConfig, SearchResult} from './search';
@@ -12,7 +12,7 @@ export class LoadSearchController<T, ID, S extends Filter> extends LoadControlle
   numbers?: string[];
   fields?: string;
   excluding?: string;
-  constructor(log: (msg: string) => void, public find: (s: S, limit?: number, skip?: number|string, fields?: string[]) => Promise<SearchResult<T>>, viewService: ViewService<T, ID> | ((id: ID, ctx?: any) => Promise<T>), keys?: Attributes|Attribute[]|string[], config?: SearchConfig|boolean, dates?: string[], numbers?: string[]) {
+  constructor(log: Log, public find: (s: S, limit?: number, skip?: number|string, fields?: string[]) => Promise<SearchResult<T>>, viewService: ViewService<T, ID> | ((id: ID, ctx?: any) => Promise<T>), keys?: Attributes|Attribute[]|string[], config?: SearchConfig|boolean, dates?: string[], numbers?: string[]) {
     super(log, viewService, keys);
     this.search = this.search.bind(this);
     if (config) {

package/src/LogController.ts

@@ -3,7 +3,7 @@ import {Request, Response} from 'express';
 export interface NumberMap {
   [key: string]: number;
 }
-export interface LogConfig {
+export interface LogConf {
   level?: string;
   map?: LogMapConfig;
 }
@@ -17,19 +17,19 @@ export interface LogMap {
   level: string;
   msg: string;
 }
-export interface Logger {
+export interface LoggerConf {
   level: number;
   map: LogMap;
 }
 
 export class LogController {
   map?: NumberMap;
-  constructor(public logger: Logger, mp?: NumberMap) {
+  constructor(public logger: LoggerConf, mp?: NumberMap) {
     this.map = mp;
     this.config = this.config.bind(this);
   }
   config(req: Request, res: Response) {
-    const obj: LogConfig = req.body;
+    const obj: LogConf = req.body;
     if (!obj || obj === '') {
       return res.status(400).end('The request body cannot be empty');
     }

package/src/LowCodeController.ts

@@ -1,7 +1,7 @@
 import {Request, Response} from 'express';
 import {ResultInfo, StatusConfig} from './edit';
 import {GenericController, GenericService} from './GenericController';
-import {handleError} from './http';
+import {handleError, Log} from './http';
 import {ErrorMessage} from './metadata';
 import {Filter, format, fromRequest, getParameters, initializeConfig, jsonResult, SearchConfig, SearchResult} from './search';
 import {getMetadataFunc} from './search_func';
@@ -18,7 +18,7 @@ export class LowCodeController<T, ID, S extends Filter> extends GenericControlle
   numbers?: string[];
   fields?: string;
   excluding?: string;
-  constructor(log: (msg: string) => void, public lowCodeService: Service<T, ID, number|ResultInfo<T>, S>, config?: LowCodeConfig, validate?: (obj: T, patch?: boolean) => Promise<ErrorMessage[]>, dates?: string[], numbers?: string[]) {
+  constructor(log: Log, public lowCodeService: Service<T, ID, number|ResultInfo<T>, S>, config?: LowCodeConfig, validate?: (obj: T, patch?: boolean) => Promise<ErrorMessage[]>, dates?: string[], numbers?: string[]) {
     super(log, lowCodeService, config, validate);
     this.search = this.search.bind(this);
     this.config = initializeConfig(config);

package/src/SearchController.ts

@@ -1,5 +1,5 @@
 import {Request, Response} from 'express';
-import {handleError} from './http';
+import {handleError, Log} from './http';
 import {Filter, format, fromRequest, getParameters, initializeConfig, jsonResult, SearchConfig, SearchResult} from './search';
 
 export class SearchController<T, S extends Filter> {
@@ -7,7 +7,7 @@ export class SearchController<T, S extends Filter> {
   csv?: boolean;
   fields?: string;
   excluding?: string;
-  constructor(protected log: (msg: string) => void, public find: (s: S, limit?: number, skip?: number|string, fields?: string[]) => Promise<SearchResult<T>>, config?: SearchConfig|boolean, public dates?: string[], public numbers?: string[]) {
+  constructor(protected log: Log, public find: (s: S, limit?: number, skip?: number|string, fields?: string[]) => Promise<SearchResult<T>>, config?: SearchConfig|boolean, public dates?: string[], public numbers?: string[]) {
     this.search = this.search.bind(this);
     if (config) {
       if (typeof config === 'boolean') {

package/src/http.ts

@@ -1,6 +1,8 @@
 import {Request, Response} from 'express';
 import {Attribute} from './metadata';
 
+export type Log = (msg: string) => void;
+export type LogFunc = Log;
 export function handleError(err: any, res: Response, log?: (msg: string) => void) {
   if (log) {
     log(toString(err));

package/src/index.ts

@@ -26,6 +26,7 @@ export {Service as LowCodeService};
 export * from './health';
 export * from './HealthController';
 export * from './LogController';
+export * from './log';
 export * from './http';
 export * from './metadata';
 export * from './view';

package/src/log.ts

@@ -0,0 +1,150 @@
+import { NextFunction } from 'express';
+import { ParamsDictionary, Request, Response } from 'express-serve-static-core';
+import { ParsedQs } from 'qs';
+import { PassThrough } from 'stream';
+
+export interface LogConfig {
+  log?: boolean;
+  separate?: boolean;
+  skips?: string;
+  request?: string;
+  response?: string;
+  duration?: string;
+  status?: string;
+  size?: string;
+}
+export interface MiddleLog {
+  log?: boolean;
+  separate?: boolean;
+  skips: string[];
+  duration: string;
+  request: string;
+  response: string;
+  status: string;
+  size: string;
+}
+interface SimpleMap {
+  [key: string]: string|number|boolean|Date;
+}
+export function createConfig(c?: LogConfig): MiddleLog {
+  if (!c) {
+    return {skips: [], duration: 'duration', request: '', response: '', status: '', size: ''};
+  }
+  const l: MiddleLog = {
+    log: c.log,
+    separate: c.separate,
+    skips: c.skips ? c.skips.split(',') : [],
+    duration: c.duration ? c.duration : 'duration',
+    request: c.request ? c.request : '',
+    response: c.response ? c.response : '',
+    status: c.status ? c.status : '',
+    size: c.size ? c.size : ''
+  };
+  return l;
+}
+export function skip(skips: string[], url: string): boolean {
+  if (skips.length === 0) {
+    return false;
+  }
+  const u = removeUrlParams(url);
+  for (const s of skips) {
+    if (u.endsWith(s)) {
+      return true;
+    }
+  }
+  return false;
+}
+export function removeUrlParams(url: string): string {
+  const startParams = url.indexOf('?');
+  return startParams !== -1 ? url.substring(0, startParams) : url;
+}
+export class Logger {
+  constructor(public write: (msg: string, m?: SimpleMap) => void, conf?: LogConfig, public build?: (req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>, m: SimpleMap) => SimpleMap) {
+    this.log = this.log.bind(this);
+    this.c = createConfig(conf);
+  }
+  c: MiddleLog;
+  log(req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>, res: Response<any, Record<string, any>, number>, next: NextFunction) {
+    if (this.c.log && !skip(this.c.skips, req.originalUrl)) {
+      const start = process.hrtime();
+      const m = req.method;
+      const x = this.c.request;
+      let r = false;
+      if (m !== 'GET' && m !== 'DELETE') {
+        r = true;
+      }
+      const msg = `${m} ${req.originalUrl}`;
+      if (this.c.separate && r) {
+        if (this.c.request.length > 0) {
+          const op: SimpleMap = {};
+          op[x] = JSON.stringify(req.body);
+          if (this.build) {
+            const op2 = this.build(req, op);
+            this.write(msg, op2);
+          } else {
+            this.write(msg, op);
+          }
+        }
+      }
+      const chunks: Uint8Array[] = [];
+      mapResponseBody(res, chunks);
+      res.on('finish', () => {
+          const duration = getDurationInMilliseconds(start);
+          const op: SimpleMap = {};
+          op[this.c.duration] = duration;
+          if (r && !this.c.separate && this.c.request.length > 0) {
+            op[this.c.request] = JSON.stringify(req.body);
+          }
+          if (this.c.response.length > 0) {
+            const rsBody = Buffer.concat(chunks).toString();
+            op[this.c.response] = rsBody;
+          }
+          if (this.c.status.length > 0) {
+            op[this.c.status] = res.statusCode;
+          }
+          if (this.c.size.length > 0) {
+            if ('_contentLength' in res) {
+              op[this.c.size] = (res as any)['_contentLength'];
+            } else if (res.hasHeader('content-length')) {
+              const l = res.getHeader('content-length');
+              if (typeof l === 'number' || typeof l === 'string') {
+                op[this.c.size] = l;
+              }
+            }
+          }
+          if (this.build) {
+            const op2 = this.build(req, op);
+            this.write(msg, op2);
+          } else {
+            this.write(msg, op);
+          }
+      });
+      next();
+    } else {
+      next();
+    }
+  }
+}
+const mapResponseBody = (res: Response<any, Record<string, any>, number>, chunks: Uint8Array[]) => {
+  const defaultWrite = res.write.bind(res);
+  const defaultEnd = res.end.bind(res);
+  const ps = new PassThrough();
+
+  ps.on('data', (data: any) => chunks.push(data));
+
+  (res as any).write = (...args: any) => {
+      (ps as any).write(...args);
+      (defaultWrite as any)(...args);
+  };
+
+  (res as any).end = (...args: any) => {
+      ps.end(...args);
+      defaultEnd(...args);
+  };
+};
+const NS_PER_SEC = 1e9;
+const NS_TO_MS = 1e6;
+const getDurationInMilliseconds = (start: [number, number] | undefined) => {
+  const diff = process.hrtime(start);
+  return (diff[0] * NS_PER_SEC + diff[1]) / NS_TO_MS;
+};