@e22m4u/js-trie-router 0.4.0 → 0.4.2

package/mocha-setup.js

@@ -0,0 +1,4 @@
+import * as chai from 'chai';
+import chaiAsPromised from 'chai-as-promised';
+
+chai.use(chaiAsPromised);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@e22m4u/js-trie-router",
-  "version": "0.4.0",
+  "version": "0.4.2",
   "description": "HTTP маршрутизатор для Node.js на основе префиксного дерева",
   "author": "Mikhail Evstropov <e22m4u@yandex.ru>",
   "license": "MIT",
@@ -58,7 +58,7 @@
     "eslint": "~9.39.1",
     "eslint-config-prettier": "~10.1.8",
     "eslint-plugin-chai-expect": "~3.1.0",
-    "eslint-plugin-jsdoc": "~61.2.0",
+    "eslint-plugin-jsdoc": "~61.2.1",
     "eslint-plugin-mocha": "~11.2.0",
     "globals": "~16.5.0",
     "husky": "~9.1.7",

package/src/debuggable-service.spec.js

@@ -1,4 +1,4 @@
-import {expect} from './chai.js';
+import {expect} from 'chai';
 import {DebuggableService} from './debuggable-service.js';
 
 describe('DebuggableService', function () {

package/src/hooks/hook-invoker.spec.js

@@ -1,4 +1,4 @@
-import {expect} from '../chai.js';
+import {expect} from 'chai';
 import {Route} from '../route.js';
 import {HttpMethod} from '../route.js';
 import {format} from '@e22m4u/js-format';

package/src/hooks/hook-registry.spec.js

@@ -1,4 +1,4 @@
-import {expect} from '../chai.js';
+import {expect} from 'chai';
 import {format} from '@e22m4u/js-format';
 import {HookRegistry} from './hook-registry.js';
 import {RouterHookType} from './hook-registry.js';

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

@@ -46,7 +46,7 @@ export declare class BodyParser extends DebuggableService {
   /**
    * Parse.
    *
-   * @param req
+   * @param request
    */
-  parse<T = unknown>(req: IncomingMessage): ValueOrPromise<T>;
+  parse<T = unknown>(request: IncomingMessage): ValueOrPromise<T>;
 }

package/src/parsers/body-parser.js

@@ -96,19 +96,19 @@ export class BodyParser extends DebuggableService {
   /**
    * Parse.
    *
-   * @param {import('http').IncomingMessage} req
+   * @param {import('http').IncomingMessage} request
    * @returns {Promise<*>|undefined}
    */
-  parse(req) {
+  parse(request) {
     const debug = this.getDebuggerFor(this.parse);
-    if (!METHODS_WITH_BODY.includes(req.method.toUpperCase())) {
+    if (!METHODS_WITH_BODY.includes(request.method.toUpperCase())) {
       debug(
         'Body parsing was skipped for the %s request.',
-        req.method.toUpperCase(),
+        request.method.toUpperCase(),
       );
       return;
     }
-    const contentType = (req.headers['content-type'] || '').replace(
+    const contentType = (request.headers['content-type'] || '').replace(
       /^([^;]+);.*$/,
       '$1',
     );
@@ -137,7 +137,7 @@ export class BodyParser extends DebuggableService {
       );
     }
     const bodyBytesLimit = this.getService(RouterOptions).requestBodyBytesLimit;
-    return fetchRequestBody(req, bodyBytesLimit).then(rawBody => {
+    return fetchRequestBody(request, bodyBytesLimit).then(rawBody => {
       if (rawBody != null) return parser(rawBody);
       return rawBody;
     });

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

@@ -1,4 +1,4 @@
-import {expect} from '../chai.js';
+import {expect} from 'chai';
 import HttpErrors from 'http-errors';
 import {HttpMethod} from '../route.js';
 import {format} from '@e22m4u/js-format';
@@ -104,7 +104,7 @@ describe('BodyParser', function () {
     });
   });
 
-  describe('removesParser', function () {
+  describe('deleteParser', function () {
     it('requires the parameter "mediaType" to be a non-empty String', function () {
       const parser = new BodyParser();
       const throwable = v => () => parser.deleteParser(v);

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

@@ -9,7 +9,7 @@ export declare class CookiesParser extends DebuggableService {
   /**
    * Parse.
    *
-   * @param req
+   * @param request
    */
-  parse(req: IncomingMessage): ParsedCookies;
+  parse(request: IncomingMessage): ParsedCookies;
 }

package/src/parsers/cookies-parser.js

@@ -9,12 +9,12 @@ export class CookiesParser extends DebuggableService {
   /**
    * Parse
    *
-   * @param {import('http').IncomingMessage} req
+   * @param {import('http').IncomingMessage} request
    * @returns {object}
    */
-  parse(req) {
+  parse(request) {
     const debug = this.getDebuggerFor(this.parse);
-    const cookiesString = req.headers['cookie'] || '';
+    const cookiesString = request.headers['cookie'] || '';
     const cookies = parseCookies(cookiesString);
     const cookiesKeys = Object.keys(cookies);
     if (cookiesKeys.length) {
@@ -24,8 +24,8 @@ export class CookiesParser extends DebuggableService {
     } else {
       debug(
         'The request %s %v had no cookies.',
-        req.method,
-        getRequestPathname(req),
+        request.method,
+        getRequestPathname(request),
       );
     }
     return cookies;

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

@@ -1,4 +1,4 @@
-import {expect} from '../chai.js';
+import {expect} from 'chai';
 import {CookiesParser} from './cookies-parser.js';
 
 describe('CookiesParser', function () {

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

@@ -15,7 +15,7 @@ export declare class QueryParser extends DebuggableService {
   /**
    * Parse.
    *
-   * @param req
+   * @param request
    */
-  parse(req: IncomingMessage): ParsedQuery;
+  parse(request: IncomingMessage): ParsedQuery;
 }

package/src/parsers/query-parser.js

@@ -9,12 +9,12 @@ export class QueryParser extends DebuggableService {
   /**
    * Parse
    *
-   * @param {import('http').IncomingMessage} req
+   * @param {import('http').IncomingMessage} request
    * @returns {object}
    */
-  parse(req) {
+  parse(request) {
     const debug = this.getDebuggerFor(this.parse);
-    const queryStr = req.url.replace(/^[^?]*\??/, '');
+    const queryStr = request.url.replace(/^[^?]*\??/, '');
     const query = queryStr ? querystring.parse(queryStr) : {};
     const queryKeys = Object.keys(query);
     if (queryKeys.length) {
@@ -24,8 +24,8 @@ export class QueryParser extends DebuggableService {
     } else {
       debug(
         'The request %s %v had no query parameters.',
-        req.method,
-        getRequestPathname(req),
+        request.method,
+        getRequestPathname(request),
       );
     }
     return query;

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

@@ -1,4 +1,4 @@
-import {expect} from '../chai.js';
+import {expect} from 'chai';
 import {QueryParser} from './query-parser.js';
 
 describe('QueryParser', function () {

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

@@ -28,7 +28,7 @@ export declare class RequestParser extends DebuggableService {
   /**
    * Parse.
    *
-   * @param req
+   * @param request
    */
-  parse(req: IncomingMessage): ValueOrPromise<ParsedRequestData>;
+  parse(request: IncomingMessage): ValueOrPromise<ParsedRequestData>;
 }

package/src/parsers/request-parser.js

@@ -13,15 +13,15 @@ export class RequestParser extends DebuggableService {
   /**
    * Parse.
    *
-   * @param {IncomingMessage} req
+   * @param {IncomingMessage} request
    * @returns {Promise<object>|object}
    */
-  parse(req) {
-    if (!(req instanceof IncomingMessage))
+  parse(request) {
+    if (!(request instanceof IncomingMessage))
       throw new Errorf(
         'The first argument of RequestParser.parse should be ' +
           'an instance of IncomingMessage, but %v was given.',
-        req,
+        request,
       );
     const data = {};
     const promises = [];
@@ -29,7 +29,7 @@ export class RequestParser extends DebuggableService {
     // значения, так как парсер может вернуть
     // Promise, и тогда придется разрывать
     // "eventLoop" с помощью "await"
-    const parsedQuery = this.getService(QueryParser).parse(req);
+    const parsedQuery = this.getService(QueryParser).parse(request);
     if (isPromise(parsedQuery)) {
       promises.push(parsedQuery.then(v => (data.query = v)));
     } else {
@@ -39,7 +39,7 @@ export class RequestParser extends DebuggableService {
     // данные заголовка "cookie" с проверкой
     // значения на Promise, и разрываем
     // "eventLoop" при необходимости
-    const parsedCookies = this.getService(CookiesParser).parse(req);
+    const parsedCookies = this.getService(CookiesParser).parse(request);
     if (isPromise(parsedCookies)) {
       promises.push(parsedCookies.then(v => (data.cookies = v)));
     } else {
@@ -48,7 +48,7 @@ export class RequestParser extends DebuggableService {
     // аналогично предыдущей операции, разбираем
     // тело запроса с проверкой результата
     // на наличие Promise
-    const parsedBody = this.getService(BodyParser).parse(req);
+    const parsedBody = this.getService(BodyParser).parse(request);
     if (isPromise(parsedBody)) {
       promises.push(parsedBody.then(v => (data.body = v)));
     } else {
@@ -56,7 +56,7 @@ export class RequestParser extends DebuggableService {
     }
     // что бы предотвратить модификацию
     // заголовков, возвращаем их копию
-    data.headers = Object.assign({}, req.headers);
+    data.headers = Object.assign({}, request.headers);
     // если имеются асинхронные операции, то результат
     // будет обернут в Promise, в противном случае
     // данные возвращаются сразу

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

@@ -1,4 +1,4 @@
-import {expect} from '../chai.js';
+import {expect} from 'chai';
 import {HttpMethod} from '../route.js';
 import {format} from '@e22m4u/js-format';
 import {RequestParser} from './request-parser.js';

package/src/request-context.d.ts

@@ -1,10 +1,8 @@
-import {ServerResponse} from 'http';
-import {IncomingMessage} from 'http';
-import {RouteMeta} from './route.js';
-import {ParsedQuery} from './parsers/index.js';
+import {Route, RouteMeta} from './route.js';
 import {ParsedCookies} from './utils/index.js';
-import {ParsedHeaders} from './parsers/index.js';
 import {ServiceContainer} from '@e22m4u/js-service';
+import {IncomingMessage, ServerResponse} from 'http';
+import {ParsedQuery, ParsedHeaders} from './parsers/index.js';
 
 /**
  * Parsed params.
@@ -20,17 +18,22 @@ export declare class RequestContext {
   /**
    * Container.
    */
-  cont: ServiceContainer;
+  get container(): ServiceContainer;
 
   /**
    * Request.
    */
-  req: IncomingMessage;
+  get request(): IncomingMessage;
 
   /**
    * Response.
    */
-  res: ServerResponse;
+  get response(): ServerResponse;
+
+  /**
+   * Route.
+   */
+  get route(): Route;
 
   /**
    * Query.
@@ -60,7 +63,7 @@ export declare class RequestContext {
   /**
    * Route meta.
    */
-  meta: RouteMeta;
+  get meta(): RouteMeta;
 
   /**
    * Method.
@@ -88,5 +91,6 @@ export declare class RequestContext {
     container: ServiceContainer,
     request: IncomingMessage,
     response: ServerResponse,
+    route: Route,
   );
 }

package/src/request-context.js

@@ -1,9 +1,12 @@
+import {Route} from './route.js';
 import {Errorf} from '@e22m4u/js-format';
-import {isReadableStream} from './utils/index.js';
-import {isWritableStream} from './utils/index.js';
-import {ServiceContainer} from '@e22m4u/js-service';
-import {getRequestPathname} from './utils/index.js';
-import {isServiceContainer} from '@e22m4u/js-service';
+import {ServiceContainer, isServiceContainer} from '@e22m4u/js-service';
+
+import {
+  isReadableStream,
+  isWritableStream,
+  getRequestPathname,
+} from './utils/index.js';
 
 /**
  * Request context.
@@ -12,23 +15,66 @@ export class RequestContext {
   /**
    * Service container.
    *
-   * @type {import('@e22m4u/js-service').ServiceContainer}
+   * @type {ServiceContainer}
+   */
+  _container;
+
+  /**
+   * Getter of service container.
+   *
+   * @type {ServiceContainer}
    */
-  cont;
+  get container() {
+    return this._container;
+  }
 
   /**
    * Request.
    *
    * @type {import('http').IncomingMessage}
    */
-  req;
+  _request;
+
+  /**
+   * Getter of request.
+   *
+   * @type {import('http').IncomingMessage}
+   */
+  get request() {
+    return this._request;
+  }
 
   /**
    * Response.
    *
    * @type {import('http').ServerResponse}
    */
-  res;
+  _response;
+
+  /**
+   * Getter of response.
+   *
+   * @type {import('http').ServerResponse}
+   */
+  get response() {
+    return this._response;
+  }
+
+  /**
+   * Route
+   *
+   * @type {Route}
+   */
+  _route;
+
+  /**
+   * Getter of route.
+   *
+   * @type {Route}
+   */
+  get route() {
+    return this._route;
+  }
 
   /**
    * Query.
@@ -68,9 +114,11 @@ export class RequestContext {
   /**
    * Route meta.
    *
-   * @type {object}
+   * @type {import('./route.js').RouteMeta}
    */
-  meta = {};
+  get meta() {
+    return this.route.meta;
+  }
 
   /**
    * Method.
@@ -78,7 +126,7 @@ export class RequestContext {
    * @returns {string}
    */
   get method() {
-    return this.req.method.toUpperCase();
+    return this.request.method.toUpperCase();
   }
 
   /**
@@ -87,7 +135,7 @@ export class RequestContext {
    * @returns {string}
    */
   get path() {
-    return this.req.url;
+    return this.request.url;
   }
 
   /**
@@ -105,7 +153,7 @@ export class RequestContext {
    */
   get pathname() {
     if (this._pathname != null) return this._pathname;
-    this._pathname = getRequestPathname(this.req);
+    this._pathname = getRequestPathname(this.request);
     return this._pathname;
   }
 
@@ -115,15 +163,16 @@ export class RequestContext {
    * @param {ServiceContainer} container
    * @param {import('http').IncomingMessage} request
    * @param {import('http').ServerResponse} response
+   * @param {Route} route
    */
-  constructor(container, request, response) {
+  constructor(container, request, response, route) {
     if (!isServiceContainer(container))
       throw new Errorf(
         'The parameter "container" of RequestContext.constructor ' +
           'should be an instance of ServiceContainer, but %v was given.',
         container,
       );
-    this.cont = container;
+    this._container = container;
     if (
       !request ||
       typeof request !== 'object' ||
@@ -136,7 +185,7 @@ export class RequestContext {
         request,
       );
     }
-    this.req = request;
+    this._request = request;
     if (
       !response ||
       typeof response !== 'object' ||
@@ -149,6 +198,14 @@ export class RequestContext {
         response,
       );
     }
-    this.res = response;
+    this._response = response;
+    if (!(route instanceof Route)) {
+      throw new Errorf(
+        'The parameter "route" of RequestContext.constructor ' +
+          'should be an instance of Route, but %v was given.',
+        route,
+      );
+    }
+    this._route = route;
   }
 }

package/src/request-context.spec.js

@@ -1,16 +1,21 @@
-import {expect} from './chai.js';
+import {expect} from 'chai';
 import {format} from '@e22m4u/js-format';
-import {createRequestMock} from './utils/index.js';
 import {RequestContext} from './request-context.js';
 import {ServiceContainer} from '@e22m4u/js-service';
-import {createResponseMock} from './utils/index.js';
+
+import {
+  createRouteMock,
+  createRequestMock,
+  createResponseMock,
+} from './utils/index.js';
 
 describe('RequestContext', function () {
   describe('constructor', function () {
     it('requires the parameter "container" to be the ServiceContainer', function () {
       const req = createRequestMock();
       const res = createResponseMock();
-      const throwable = v => () => new RequestContext(v, req, res);
+      const route = createRouteMock();
+      const throwable = v => () => new RequestContext(v, req, res, route);
       const error = v =>
         format(
           'The parameter "container" of RequestContext.constructor ' +
@@ -32,8 +37,9 @@ describe('RequestContext', function () {
 
     it('requires the parameter "request" to be the ServiceContainer', function () {
       const res = createResponseMock();
+      const route = createRouteMock();
       const cont = new ServiceContainer();
-      const throwable = v => () => new RequestContext(cont, v, res);
+      const throwable = v => () => new RequestContext(cont, v, res, route);
       const error = v =>
         format(
           'The parameter "request" of RequestContext.constructor ' +
@@ -55,8 +61,9 @@ describe('RequestContext', function () {
 
     it('requires the parameter "response" to be the ServiceContainer', function () {
       const req = createRequestMock();
+      const route = createRouteMock();
       const cont = new ServiceContainer();
-      const throwable = v => () => new RequestContext(cont, req, v);
+      const throwable = v => () => new RequestContext(cont, req, v, route);
       const error = v =>
         format(
           'The parameter "response" of RequestContext.constructor ' +
@@ -76,22 +83,39 @@ describe('RequestContext', function () {
       throwable(createResponseMock())();
     });
 
-    it('sets properties from given arguments', function () {
+    it('requires the parameter "route" to be the Route', function () {
       const req = createRequestMock();
       const res = createResponseMock();
       const cont = new ServiceContainer();
-      const ctx = new RequestContext(cont, req, res);
-      expect(ctx.cont).to.be.eq(cont);
-      expect(ctx.req).to.be.eq(req);
-      expect(ctx.res).to.be.eq(res);
+      const throwable = v => () => new RequestContext(cont, req, res, v);
+      const error = v =>
+        format(
+          'The parameter "route" of RequestContext.constructor ' +
+            'should be an instance of Route, but %s was given.',
+          v,
+        );
+      expect(throwable('str')).to.throw(error('"str"'));
+      expect(throwable('')).to.throw(error('""'));
+      expect(throwable(10)).to.throw(error('10'));
+      expect(throwable(0)).to.throw(error('0'));
+      expect(throwable(true)).to.throw(error('true'));
+      expect(throwable(false)).to.throw(error('false'));
+      expect(throwable(null)).to.throw(error('null'));
+      expect(throwable({})).to.throw(error('Object'));
+      expect(throwable([])).to.throw(error('Array'));
+      expect(throwable(undefined)).to.throw(error('undefined'));
+      throwable(createRouteMock())();
     });
 
-    it('sets an empty object to the "meta" property', function () {
+    it('sets properties from given arguments', function () {
       const req = createRequestMock();
       const res = createResponseMock();
+      const route = createRouteMock();
       const cont = new ServiceContainer();
-      const ctx = new RequestContext(cont, req, res);
-      expect(ctx.meta).to.be.eql({});
+      const ctx = new RequestContext(cont, req, res, route);
+      expect(ctx.container).to.be.eq(cont);
+      expect(ctx.request).to.be.eq(req);
+      expect(ctx.response).to.be.eq(res);
     });
   });
 
@@ -99,8 +123,9 @@ describe('RequestContext', function () {
     it('returns the method name in upper case', function () {
       const req = createRequestMock({method: 'post'});
       const res = createResponseMock();
+      const route = createRouteMock();
       const cont = new ServiceContainer();
-      const ctx = new RequestContext(cont, req, res);
+      const ctx = new RequestContext(cont, req, res, route);
       expect(ctx.method).to.be.eq('POST');
     });
   });
@@ -109,8 +134,9 @@ describe('RequestContext', function () {
     it('returns the request pathname with the query string', function () {
       const req = createRequestMock({path: '/pathname?foo=bar'});
       const res = createResponseMock();
+      const route = createRouteMock();
       const cont = new ServiceContainer();
-      const ctx = new RequestContext(cont, req, res);
+      const ctx = new RequestContext(cont, req, res, route);
       expect(req.url).to.be.eq('/pathname?foo=bar');
       expect(ctx.path).to.be.eq('/pathname?foo=bar');
     });
@@ -120,8 +146,9 @@ describe('RequestContext', function () {
     it('returns the request pathname without the query string', function () {
       const req = createRequestMock({path: '/pathname?foo=bar'});
       const res = createResponseMock();
+      const route = createRouteMock();
       const cont = new ServiceContainer();
-      const ctx = new RequestContext(cont, req, res);
+      const ctx = new RequestContext(cont, req, res, route);
       expect(req.url).to.be.eq('/pathname?foo=bar');
       expect(ctx.pathname).to.be.eq('/pathname');
     });
@@ -129,8 +156,9 @@ describe('RequestContext', function () {
     it('sets the cache to the "_pathname" property and uses is for next accesses', function () {
       const req = createRequestMock({path: '/pathname'});
       const res = createResponseMock();
+      const route = createRouteMock();
       const cont = new ServiceContainer();
-      const ctx = new RequestContext(cont, req, res);
+      const ctx = new RequestContext(cont, req, res, route);
       expect(ctx._pathname).to.be.undefined;
       expect(ctx.pathname).to.be.eq('/pathname');
       expect(ctx._pathname).to.be.eq('/pathname');

package/src/route-registry.d.ts

@@ -33,7 +33,7 @@ export declare class RouteRegistry extends DebuggableService {
   /**
    * Match route by request.
    *
-   * @param req
+   * @param request
    */
-  matchRouteByRequest(req: IncomingMessage): ResolvedRoute | undefined;
+  matchRouteByRequest(request: IncomingMessage): ResolvedRoute | undefined;
 }