@e22m4u/js-trie-router 0.2.0 → 0.3.0

package/src/parsers/request-parser.d.ts

@@ -1,7 +1,7 @@
 import {IncomingMessage} from 'http';
 import {ValueOrPromise} from '../types.js';
 import {ParsedQuery} from './query-parser.js';
-import {ParsedCookie} from '../utils/index.js';
+import {ParsedCookies} from '../utils/index.js';
 import {DebuggableService} from '../debuggable-service.js';
 
 /**
@@ -16,7 +16,7 @@ export type ParsedHeaders = {
  */
 type ParsedRequestData = {
   query: ParsedQuery;
-  cookie: ParsedCookie;
+  cookies: ParsedCookies;
   body: unknown;
   headers: ParsedHeaders;
 };

package/src/parsers/request-parser.js

@@ -3,7 +3,7 @@ import {Errorf} from '@e22m4u/js-format';
 import {isPromise} from '../utils/index.js';
 import {BodyParser} from './body-parser.js';
 import {QueryParser} from './query-parser.js';
-import {CookieParser} from './cookie-parser.js';
+import {CookiesParser} from './cookies-parser.js';
 import {DebuggableService} from '../debuggable-service.js';
 
 /**
@@ -20,7 +20,7 @@ export class RequestParser extends DebuggableService {
     if (!(req instanceof IncomingMessage))
       throw new Errorf(
         'The first argument of RequestParser.parse should be ' +
-          'an instance of IncomingMessage, but %v given.',
+          'an instance of IncomingMessage, but %v was given.',
         req,
       );
     const data = {};
@@ -39,11 +39,11 @@ export class RequestParser extends DebuggableService {
     // данные заголовка "cookie" с проверкой
     // значения на Promise, и разрываем
     // "eventLoop" при необходимости
-    const parsedCookie = this.getService(CookieParser).parse(req);
-    if (isPromise(parsedCookie)) {
-      promises.push(parsedCookie.then(v => (data.cookie = v)));
+    const parsedCookies = this.getService(CookiesParser).parse(req);
+    if (isPromise(parsedCookies)) {
+      promises.push(parsedCookies.then(v => (data.cookies = v)));
     } else {
-      data.cookie = parsedCookie;
+      data.cookies = parsedCookies;
     }
     // аналогично предыдущей операции, разбираем
     // тело запроса с проверкой результата
@@ -56,7 +56,7 @@ export class RequestParser extends DebuggableService {
     }
     // что бы предотвратить модификацию
     // заголовков, возвращаем их копию
-    data.headers = JSON.parse(JSON.stringify(req.headers));
+    data.headers = Object.assign({}, req.headers);
     // если имеются асинхронные операции, то результат
     // будет обернут в Promise, в противном случае
     // данные возвращаются сразу

package/src/parsers/request-parser.spec.js

@@ -12,7 +12,7 @@ describe('RequestParser', function () {
       const error = v =>
         format(
           'The first argument of RequestParser.parse should be ' +
-            'an instance of IncomingMessage, but %s given.',
+            'an instance of IncomingMessage, but %s was given.',
           v,
         );
       expect(throwable('str')).to.throw(error('"str"'));
@@ -29,13 +29,13 @@ describe('RequestParser', function () {
       throwable(createRequestMock())();
     });
 
-    it('returns the result object if no request body to parse', function () {
+    it('returns the result object if no request body', function () {
       const s = new RequestParser();
       const req = createRequestMock();
       const res = s.parse(req);
       expect(res).to.be.eql({
         query: {},
-        cookie: {},
+        cookies: {},
         body: undefined,
         headers: {host: 'localhost'},
       });
@@ -54,7 +54,7 @@ describe('RequestParser', function () {
       const res = await promise;
       expect(res).to.be.eql({
         query: {},
-        cookie: {},
+        cookies: {},
         body,
         headers: {
           host: 'localhost',
@@ -64,25 +64,25 @@ describe('RequestParser', function () {
       });
     });
 
-    it('returns the parsed query in the result object', function () {
+    it('returns the result object with the parsed query', function () {
       const s = new RequestParser();
       const req = createRequestMock({path: '/path?p1=foo&p2=bar'});
       const res = s.parse(req);
       expect(res).to.be.eql({
         query: {p1: 'foo', p2: 'bar'},
-        cookie: {},
+        cookies: {},
         body: undefined,
         headers: {host: 'localhost'},
       });
     });
 
-    it('returns the parsed cookie in the result object', function () {
+    it('returns the result object with the parsed cookies', function () {
       const s = new RequestParser();
       const req = createRequestMock({headers: {cookie: 'p1=foo; p2=bar;'}});
       const res = s.parse(req);
       expect(res).to.be.eql({
         query: {},
-        cookie: {p1: 'foo', p2: 'bar'},
+        cookies: {p1: 'foo', p2: 'bar'},
         body: undefined,
         headers: {
           host: 'localhost',
@@ -91,7 +91,7 @@ describe('RequestParser', function () {
       });
     });
 
-    it('returns the parsed body of the media type "text/plain" in the result object', async function () {
+    it('returns the result object with the parsed body of the media type "text/plain"', async function () {
       const s = new RequestParser();
       const body = 'Lorem Ipsum is simply dummy text.';
       const req = createRequestMock({
@@ -102,7 +102,7 @@ describe('RequestParser', function () {
       const res = await s.parse(req);
       expect(res).to.be.eql({
         query: {},
-        cookie: {},
+        cookies: {},
         body,
         headers: {
           host: 'localhost',
@@ -112,7 +112,7 @@ describe('RequestParser', function () {
       });
     });
 
-    it('returns the parsed body of the media type "application/json" in the result object', async function () {
+    it('returns the result object with the parsed body of the media type "application/json"', async function () {
       const s = new RequestParser();
       const body = {foo: 'bar', baz: 'qux'};
       const json = JSON.stringify(body);
@@ -124,7 +124,7 @@ describe('RequestParser', function () {
       const res = await s.parse(req);
       expect(res).to.be.eql({
         query: {},
-        cookie: {},
+        cookies: {},
         body,
         headers: {
           host: 'localhost',

package/src/request-context.d.ts

@@ -1,7 +1,7 @@
 import {ServerResponse} from 'http';
 import {IncomingMessage} from 'http';
-import {ParsedCookie} from './utils/index.js';
 import {ParsedQuery} from './parsers/index.js';
+import {ParsedCookies} from './utils/index.js';
 import {ParsedHeaders} from './parsers/index.js';
 import {ServiceContainer} from '@e22m4u/js-service';
 
@@ -47,9 +47,9 @@ export declare class RequestContext {
   headers: ParsedHeaders;
 
   /**
-   * Cookie.
+   * Cookies.
    */
-  cookie: ParsedCookie;
+  cookies: ParsedCookies;
 
   /**
    * Body.

package/src/request-context.js

@@ -52,11 +52,11 @@ export class RequestContext {
   headers = {};
 
   /**
-   * Parsed cookie.
+   * Parsed cookies.
    *
    * @type {object}
    */
-  cookie = {};
+  cookies = {};
 
   /**
    * Parsed body.
@@ -113,7 +113,7 @@ export class RequestContext {
     if (!isServiceContainer(container))
       throw new Errorf(
         'The parameter "container" of RequestContext.constructor ' +
-          'should be an instance of ServiceContainer, but %v given.',
+          'should be an instance of ServiceContainer, but %v was given.',
         container,
       );
     this.container = container;
@@ -125,7 +125,7 @@ export class RequestContext {
     ) {
       throw new Errorf(
         'The parameter "request" of RequestContext.constructor ' +
-          'should be an instance of IncomingMessage, but %v given.',
+          'should be an instance of IncomingMessage, but %v was given.',
         request,
       );
     }
@@ -138,7 +138,7 @@ export class RequestContext {
     ) {
       throw new Errorf(
         'The parameter "response" of RequestContext.constructor ' +
-          'should be an instance of ServerResponse, but %v given.',
+          'should be an instance of ServerResponse, but %v was given.',
         response,
       );
     }

package/src/request-context.spec.js

@@ -14,7 +14,7 @@ describe('RequestContext', function () {
       const error = v =>
         format(
           'The parameter "container" of RequestContext.constructor ' +
-            'should be an instance of ServiceContainer, but %s given.',
+            'should be an instance of ServiceContainer, but %s was given.',
           v,
         );
       expect(throwable('str')).to.throw(error('"str"'));
@@ -37,7 +37,7 @@ describe('RequestContext', function () {
       const error = v =>
         format(
           'The parameter "request" of RequestContext.constructor ' +
-            'should be an instance of IncomingMessage, but %s given.',
+            'should be an instance of IncomingMessage, but %s was given.',
           v,
         );
       expect(throwable('str')).to.throw(error('"str"'));
@@ -60,7 +60,7 @@ describe('RequestContext', function () {
       const error = v =>
         format(
           'The parameter "response" of RequestContext.constructor ' +
-            'should be an instance of ServerResponse, but %s given.',
+            'should be an instance of ServerResponse, but %s was given.',
           v,
         );
       expect(throwable('str')).to.throw(error('"str"'));

package/src/route-registry.js

@@ -32,16 +32,17 @@ export class RouteRegistry extends DebuggableService {
    * @returns {Route}
    */
   defineRoute(routeDef) {
+    const debug = this.getDebuggerFor(this.defineRoute);
     if (!routeDef || typeof routeDef !== 'object' || Array.isArray(routeDef))
       throw new Errorf(
-        'The route definition should be an Object, but %v given.',
+        'The route definition should be an Object, but %v was given.',
         routeDef,
       );
     const route = new Route(routeDef);
     const triePath = `${route.method}/${route.path}`;
     this._trie.add(triePath, route);
-    this.debug(
-      'The route %s %v is registered.',
+    debug(
+      'The route %s %v was registered.',
       route.method.toUpperCase(),
       route.path,
     );
@@ -55,9 +56,10 @@ export class RouteRegistry extends DebuggableService {
    * @returns {ResolvedRoute|undefined}
    */
   matchRouteByRequest(req) {
+    const debug = this.getDebuggerFor(this.matchRouteByRequest);
     const requestPath = (req.url || '/').replace(/\?.*$/, '');
-    this.debug(
-      'Matching %s %v with registered routes.',
+    debug(
+      'Matching routes with the request %s %v.',
       req.method.toUpperCase(),
       requestPath,
     );
@@ -65,28 +67,26 @@ export class RouteRegistry extends DebuggableService {
     const resolved = this._trie.match(triePath);
     if (resolved) {
       const route = resolved.value;
-      this.debug(
-        'The request %s %v was matched to the route %s %v.',
-        req.method.toUpperCase(),
-        requestPath,
+      debug(
+        'The route %s %v was matched.',
         route.method.toUpperCase(),
         route.path,
       );
       const paramNames = Object.keys(resolved.params);
-      if (paramNames) {
+      if (paramNames.length) {
         paramNames.forEach(name => {
-          this.debug(
-            'The path parameter %v has the value %v.',
+          debug(
+            'The path parameter %v had the value %v.',
             name,
             resolved.params[name],
           );
         });
       } else {
-        this.debug('No path parameters found.');
+        debug('No path parameters found.');
       }
       return {route, params: resolved.params};
     }
-    this.debug(
+    debug(
       'No matched route for the request %s %v.',
       req.method.toUpperCase(),
       requestPath,

package/src/route-registry.spec.js

@@ -11,7 +11,10 @@ describe('RouteRegistry', function () {
       const s = new RouteRegistry();
       const throwable = v => () => s.defineRoute(v);
       const error = v =>
-        format('The route definition should be an Object, but %s given.', v);
+        format(
+          'The route definition should be an Object, but %s was given.',
+          v,
+        );
       expect(throwable('str')).to.throw(error('"str"'));
       expect(throwable('')).to.throw(error('""'));
       expect(throwable(10)).to.throw(error('10'));

package/src/route.d.ts

@@ -5,13 +5,18 @@ import {RequestContext} from './request-context.js';
 /**
  * Http method.
  */
-export enum HttpMethod {
-  GET = 'get',
-  POST = 'post',
-  PUT = 'put',
-  PATCH = 'patch',
-  DELETE = 'delete',
-}
+export declare const HttpMethod: {
+  GET: 'GET';
+  POST: 'POST';
+  PUT: 'PUT';
+  PATCH: 'PATCH';
+  DELETE: 'DELETE';
+};
+
+/**
+ * Type of HttpMethod.
+ */
+export type HttpMethod = (typeof HttpMethod)[keyof typeof HttpMethod];
 
 /**
  * Route handler.

package/src/route.js

@@ -1,8 +1,9 @@
 import {Errorf} from '@e22m4u/js-format';
 import {HookType} from './hooks/index.js';
+import {Debuggable} from '@e22m4u/js-debug';
 import {HookRegistry} from './hooks/index.js';
-import {createDebugger} from './utils/index.js';
 import {getRequestPathname} from './utils/index.js';
+import {MODULE_DEBUG_NAMESPACE} from './debuggable-service.js';
 
 /**
  * @typedef {import('./request-context.js').RequestContext} RequestContext
@@ -37,17 +38,10 @@ export const HttpMethod = {
   DELETE: 'DELETE',
 };
 
-/**
- * Debugger.
- *
- * @type {Function}
- */
-const debug = createDebugger('route');
-
 /**
  * Route.
  */
-export class Route {
+export class Route extends Debuggable {
   /**
    * Method.
    *
@@ -122,29 +116,35 @@ export class Route {
    * @param {RouteDefinition} routeDef
    */
   constructor(routeDef) {
+    super({
+      namespace: MODULE_DEBUG_NAMESPACE,
+      noEnvironmentNamespace: true,
+      noInstantiationMessage: true,
+    });
     if (!routeDef || typeof routeDef !== 'object' || Array.isArray(routeDef))
       throw new Errorf(
-        'The first parameter of Route.controller ' +
-          'should be an Object, but %v given.',
+        'The first parameter of Route.constructor ' +
+          'should be an Object, but %v was given.',
         routeDef,
       );
     if (!routeDef.method || typeof routeDef.method !== 'string')
       throw new Errorf(
         'The option "method" of the Route should be ' +
-          'a non-empty String, but %v given.',
+          'a non-empty String, but %v was given.',
         routeDef.method,
       );
     this._method = routeDef.method.toUpperCase();
     if (typeof routeDef.path !== 'string')
       throw new Errorf(
-        'The option "path" of the Route should be ' + 'a String, but %v given.',
+        'The option "path" of the Route should be ' +
+          'a String, but %v was given.',
         routeDef.path,
       );
     this._path = routeDef.path;
     if (typeof routeDef.handler !== 'function')
       throw new Errorf(
         'The option "handler" of the Route should be ' +
-          'a Function, but %v given.',
+          'a Function, but %v was given.',
         routeDef.handler,
       );
     this._handler = routeDef.handler;
@@ -164,6 +164,7 @@ export class Route {
         this._hookRegistry.addHook(HookType.POST_HANDLER, hook);
       });
     }
+    this.ctorDebug('A new route %s %v was created.', this._method, this._path);
   }
 
   /**
@@ -173,6 +174,7 @@ export class Route {
    * @returns {*}
    */
   handle(context) {
+    const debug = this.getDebuggerFor(this.handle);
     const requestPath = getRequestPathname(context.req);
     debug(
       'Invoking the Route handler for the request %s %v.',

package/src/route.spec.js

@@ -14,8 +14,8 @@ describe('Route', function () {
       const throwable = v => () => new Route(v);
       const error = v =>
         format(
-          'The first parameter of Route.controller ' +
-            'should be an Object, but %s given.',
+          'The first parameter of Route.constructor ' +
+            'should be an Object, but %s was given.',
           v,
         );
       expect(throwable('str')).to.throw(error('"str"'));
@@ -45,7 +45,7 @@ describe('Route', function () {
       const error = v =>
         format(
           'The option "method" of the Route should be ' +
-            'a non-empty String, but %s given.',
+            'a non-empty String, but %s was given.',
           v,
         );
       expect(throwable('')).to.throw(error('""'));
@@ -71,7 +71,7 @@ describe('Route', function () {
       const error = v =>
         format(
           'The option "path" of the Route should be ' +
-            'a String, but %s given.',
+            'a String, but %s was given.',
           v,
         );
       expect(throwable(10)).to.throw(error('10'));
@@ -97,7 +97,7 @@ describe('Route', function () {
       const error = v =>
         format(
           'The option "handler" of the Route should be ' +
-            'a Function, but %s given.',
+            'a Function, but %s was given.',
           v,
         );
       expect(throwable('str')).to.throw(error('"str"'));
@@ -122,7 +122,10 @@ describe('Route', function () {
           handler: () => undefined,
         });
       const error = v =>
-        format('The hook "preHandler" should be a Function, but %s given.', v);
+        format(
+          'The hook "preHandler" should be a Function, but %s was given.',
+          v,
+        );
       expect(throwable1('str')).to.throw(error('"str"'));
       expect(throwable1('')).to.throw(error('""'));
       expect(throwable1(10)).to.throw(error('10'));
@@ -163,7 +166,10 @@ describe('Route', function () {
           postHandler: v,
         });
       const error = v =>
-        format('The hook "postHandler" should be a Function, but %s given.', v);
+        format(
+          'The hook "postHandler" should be a Function, but %s was given.',
+          v,
+        );
       expect(throwable1('str')).to.throw(error('"str"'));
       expect(throwable1('')).to.throw(error('""'));
       expect(throwable1(10)).to.throw(error('10'));

package/src/router-options.js

@@ -32,7 +32,7 @@ export class RouterOptions extends DebuggableService {
     if (typeof input !== 'number' || input < 0)
       throw new Errorf(
         'The option "requestBodyBytesLimit" must be ' +
-          'a positive Number or 0, but %v given.',
+          'a positive Number or 0, but %v was given.',
         input,
       );
     this._requestBodyBytesLimit = input;

package/src/router-options.spec.js

@@ -25,7 +25,7 @@ describe('RouterOptions', function () {
       const error = v =>
         format(
           'The option "requestBodyBytesLimit" must be ' +
-            'a positive Number or 0, but %s given.',
+            'a positive Number or 0, but %s was given.',
           v,
         );
       expect(throwable('str')).to.throw(error('"str"'));

package/src/senders/data-sender.js

@@ -14,14 +14,15 @@ export class DataSender extends DebuggableService {
    * @returns {undefined}
    */
   send(res, data) {
+    const debug = this.getDebuggerFor(this.send);
     // если ответ контроллера является объектом
     // ServerResponse, или имеются отправленные
     // заголовки, то считаем, что контроллер
     // уже отправил ответ самостоятельно
     if (data === res || res.headersSent) {
-      this.debug(
+      debug(
         'Response sending was skipped because ' +
-          'its headers where sent already .',
+          'its headers where sent already.',
       );
       return;
     }
@@ -30,7 +31,7 @@ export class DataSender extends DebuggableService {
     if (data == null) {
       res.statusCode = 204;
       res.end();
-      this.debug('The empty response was sent.');
+      debug('The empty response was sent.');
       return;
     }
     // если ответ контроллера является стримом,
@@ -38,7 +39,7 @@ export class DataSender extends DebuggableService {
     if (isReadableStream(data)) {
       res.setHeader('Content-Type', 'application/octet-stream');
       data.pipe(res);
-      this.debug('The stream response was sent.');
+      debug('The stream response was sent.');
       return;
     }
     // подготовка данных перед отправкой, и установка
@@ -67,6 +68,6 @@ export class DataSender extends DebuggableService {
     }
     // отправка подготовленных данных
     res.end(data);
-    this.debug(debugMsg);
+    debug(debugMsg);
   }
 }

package/src/senders/error-sender.js

@@ -23,6 +23,7 @@ export class ErrorSender extends DebuggableService {
    * @returns {undefined}
    */
   send(req, res, error) {
+    const debug = this.getDebuggerFor(this.send);
     let safeError = {};
     if (error) {
       if (typeof error === 'object') {
@@ -54,11 +55,16 @@ export class ErrorSender extends DebuggableService {
     };
     console.warn(inspect(requestData, inspectOptions));
     console.warn(inspect(body, inspectOptions));
+    if (error.stack) {
+      console.log(error.stack);
+    } else {
+      console.error(error);
+    }
     res.statusCode = statusCode;
     res.setHeader('content-type', 'application/json; charset=utf-8');
     res.end(JSON.stringify(body, null, 2), 'utf-8');
-    this.debug(
-      'The %s error is sent for the request %s %v.',
+    debug(
+      'The %s error was sent for the request %s %v.',
       statusCode,
       req.method,
       getRequestPathname(req),
@@ -73,11 +79,12 @@ export class ErrorSender extends DebuggableService {
    * @returns {undefined}
    */
   send404(req, res) {
+    const debug = this.getDebuggerFor(this.send404);
     res.statusCode = 404;
     res.setHeader('content-type', 'text/plain; charset=utf-8');
     res.end('404 Not Found', 'utf-8');
-    this.debug(
-      'The 404 error is sent for the request %s %v.',
+    debug(
+      'The 404 error was sent for the request %s %v.',
       req.method,
       getRequestPathname(req),
     );