@e22m4u/js-trie-router 0.2.0 → 0.3.0

package/examples/{cookie-parsing-example.js → cookies-parsing-example.js}

@@ -4,25 +4,25 @@ import {HttpMethod} from '../src/route.js';
 
 const router = new TrieRouter();
 
-// регистрация роута для вывода
-// переданных Cookie
+// регистрация маршрута для разбора
+// передаваемого заголовка "Cookie"
 router.defineRoute({
   method: HttpMethod.GET,
-  path: '/showCookie',
-  handler: ({cookie}) => cookie,
+  path: '/parseCookies',
+  handler: ({cookies}) => cookies,
 });
 
-// создаем экземпляр HTTP сервера
-// и подключаем обработчик запросов
+// создание экземпляра HTTP сервера
+// и подключение обработчика запросов
 const server = new http.Server();
 server.on('request', router.requestListener);
 
-// слушаем входящие запросы
+// прослушивание входящих запросов
 // на указанный адрес и порт
 const port = 3000;
 const host = '0.0.0.0';
 server.listen(port, host, function () {
   const cyan = '\x1b[36m%s\x1b[0m';
   console.log(cyan, 'Server listening on port:', port);
-  console.log(cyan, 'Open in browser:', `http://${host}:${port}/showCookie`);
+  console.log(cyan, 'Open in browser:', `http://${host}:${port}/parseCookies`);
 });

package/examples/params-parsing-example.js

@@ -4,25 +4,29 @@ import {HttpMethod} from '../src/route.js';
 
 const router = new TrieRouter();
 
-// регистрация роута для вывода
-// переданных параметров пути
+// регистрация маршрута для разбора
+// передаваемых параметров пути
 router.defineRoute({
   method: HttpMethod.GET,
-  path: '/showParams/:p1/:p2',
+  path: '/parseParams/:p1/:p2',
   handler: ({params}) => params,
 });
 
-// создаем экземпляр HTTP сервера
-// и подключаем обработчик запросов
+// создание экземпляра HTTP сервера
+// и подключение обработчика запросов
 const server = new http.Server();
 server.on('request', router.requestListener);
 
-// слушаем входящие запросы
+// прослушивание входящих запросов
 // на указанный адрес и порт
 const port = 3000;
 const host = '0.0.0.0';
 server.listen(port, host, function () {
   const cyan = '\x1b[36m%s\x1b[0m';
   console.log(cyan, 'Server listening on port:', port);
-  console.log(cyan, 'Open in browser:', `http://${host}:${port}/showParams/foo/bar`);
+  console.log(
+    cyan,
+    'Open in browser:',
+    `http://${host}:${port}/parseParams/foo/bar`,
+  );
 });

package/examples/query-parsing-example.js

@@ -4,25 +4,29 @@ import {HttpMethod} from '../src/route.js';
 
 const router = new TrieRouter();
 
-// регистрация роута для вывода
-// переданных "query" параметров
+// регистрация маршрута для разбора
+// передаваемых параметров запроса
 router.defineRoute({
   method: HttpMethod.GET,
-  path: '/showQuery',
+  path: '/parseQuery',
   handler: ({query}) => query,
 });
 
-// создаем экземпляр HTTP сервера
-// и подключаем обработчик запросов
+// создание экземпляра HTTP сервера
+// и подключение обработчика запросов
 const server = new http.Server();
 server.on('request', router.requestListener);
 
-// слушаем входящие запросы
+// прослушивание входящих запросов
 // на указанный адрес и порт
 const port = 3000;
 const host = '0.0.0.0';
 server.listen(port, host, function () {
   const cyan = '\x1b[36m%s\x1b[0m';
   console.log(cyan, 'Server listening on port:', port);
-  console.log(cyan, 'Open in browser:', `http://${host}:${port}/showQuery?foo=bar&baz=qux`);
+  console.log(
+    cyan,
+    'Open in browser:',
+    `http://${host}:${port}/parseQuery?foo=bar&baz=qux`,
+  );
 });

package/examples/uptime-example.js

@@ -4,7 +4,7 @@ import {HttpMethod} from '../src/route.js';
 
 const router = new TrieRouter();
 
-// регистрация роута для вывода
+// регистрация маршрута для вывода
 // времени работы сервера
 router.defineRoute({
   method: HttpMethod.GET,
@@ -24,12 +24,12 @@ router.defineRoute({
   },
 })
 
-// создаем экземпляр HTTP сервера
-// и подключаем обработчик запросов
+// создание экземпляра HTTP сервера
+// и подключение обработчика запросов
 const server = new http.Server();
 server.on('request', router.requestListener);
 
-// слушаем входящие запросы
+// прослушивание входящих запросов
 // на указанный адрес и порт
 const port = 3000;
 const host = '0.0.0.0';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@e22m4u/js-trie-router",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "description": "HTTP маршрутизатор для Node.js на основе префиксного дерева",
   "author": "Mikhail Evstropov <e22m4u@yandex.ru>",
   "license": "MIT",
@@ -38,30 +38,31 @@
     "prepare": "husky"
   },
   "dependencies": {
+    "@e22m4u/js-debug": "~0.3.1",
     "@e22m4u/js-format": "~0.2.0",
-    "@e22m4u/js-path-trie": "~0.0.10",
-    "@e22m4u/js-service": "~0.3.8",
+    "@e22m4u/js-path-trie": "~0.0.11",
+    "@e22m4u/js-service": "~0.4.0",
     "debug": "~4.4.3",
     "http-errors": "~2.0.0",
     "statuses": "~2.0.2"
   },
   "devDependencies": {
-    "@commitlint/cli": "~19.8.1",
-    "@commitlint/config-conventional": "~19.8.1",
+    "@commitlint/cli": "~20.1.0",
+    "@commitlint/config-conventional": "~20.0.0",
     "@eslint/js": "~9.36.0",
     "@types/chai-as-promised": "~8.0.2",
     "c8": "~10.1.3",
-    "chai": "~6.0.1",
+    "chai": "~6.2.0",
     "chai-as-promised": "~8.0.2",
     "esbuild": "~0.25.10",
     "eslint": "~9.36.0",
     "eslint-config-prettier": "~10.1.8",
     "eslint-plugin-chai-expect": "~3.1.0",
-    "eslint-plugin-jsdoc": "~60.2.0",
+    "eslint-plugin-jsdoc": "~60.5.0",
     "eslint-plugin-mocha": "~11.1.0",
     "globals": "~16.4.0",
     "husky": "~9.1.7",
-    "mocha": "~11.7.2",
+    "mocha": "~11.7.3",
     "prettier": "~3.6.2",
     "rimraf": "~6.0.1",
     "typescript": "~5.9.2"

package/src/debuggable-service.d.ts

@@ -1,14 +1,6 @@
-import {Debugger} from './utils/index.js';
-import {Service} from '@e22m4u/js-service';
+import {DebuggableService as BaseDebuggableService} from '@e22m4u/js-service';
 
 /**
  * Debuggable service.
  */
-declare class DebuggableService extends Service {
-  /**
-   * Debug.
-   *
-   * @protected
-   */
-  protected debug: Debugger;
-}
+declare class DebuggableService extends BaseDebuggableService {}

package/src/debuggable-service.js

@@ -1,28 +1,27 @@
-import {Service} from '@e22m4u/js-service';
-import {toCamelCase} from './utils/index.js';
-import {createDebugger} from './utils/index.js';
-import {ServiceContainer} from '@e22m4u/js-service';
+import {DebuggableService as BaseDebuggableService} from '@e22m4u/js-service';
 
 /**
- * Debuggable service.
+ * @typedef {import('@e22m4u/js-service').ServiceContainer} ServiceContainer
  */
-export class DebuggableService extends Service {
-  /**
-   * Debug.
-   *
-   * @type {Function}
-   */
-  debug;
 
+/**
+ * Module debug namespace.
+ */
+export const MODULE_DEBUG_NAMESPACE = 'jsTrieRouter';
+
+/**
+ * Debuggable service.
+ */
+export class DebuggableService extends BaseDebuggableService {
   /**
    * Constructor.
    *
    * @param {ServiceContainer} container
    */
-  constructor(container) {
-    super(container);
-    const serviceName = toCamelCase(this.constructor.name);
-    this.debug = createDebugger(serviceName);
-    this.debug('The %v is created.', this.constructor);
+  constructor(container = undefined) {
+    super(container, {
+      namespace: MODULE_DEBUG_NAMESPACE,
+      noEnvironmentNamespace: true,
+    });
   }
 }

package/src/hooks/hook-invoker.js

@@ -24,14 +24,14 @@ export class HookInvoker extends DebuggableService {
       throw new Errorf(
         'The parameter "route" of ' +
           'the HookInvoker.invokeAndContinueUntilValueReceived ' +
-          'should be a Route instance, but %v given.',
+          'should be a Route instance, but %v was given.',
         route,
       );
     if (!hookType || typeof hookType !== 'string')
       throw new Errorf(
         'The parameter "hookType" of ' +
           'the HookInvoker.invokeAndContinueUntilValueReceived ' +
-          'should be a non-empty String, but %v given.',
+          'should be a non-empty String, but %v was given.',
         hookType,
       );
     if (!Object.values(HookType).includes(hookType))
@@ -45,7 +45,7 @@ export class HookInvoker extends DebuggableService {
       throw new Errorf(
         'The parameter "response" of ' +
           'the HookInvoker.invokeAndContinueUntilValueReceived ' +
-          'should be a ServerResponse instance, but %v given.',
+          'should be a ServerResponse instance, but %v was given.',
         response,
       );
     }
@@ -82,7 +82,6 @@ export class HookInvoker extends DebuggableService {
           // если ответ уже был отправлен,
           // то останавливаем выполнение
           if (isResponseSent(response)) {
-            result = response;
             return;
           }
           // если предыдущий Promise вернул значение

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

@@ -18,7 +18,7 @@ describe('HookInvoker', function () {
         format(
           'The parameter "route" of ' +
             'the HookInvoker.invokeAndContinueUntilValueReceived ' +
-            'should be a Route instance, but %s given.',
+            'should be a Route instance, but %s was given.',
           v,
         );
       expect(throwable('str')).to.throw(error('"str"'));
@@ -54,7 +54,7 @@ describe('HookInvoker', function () {
         format(
           'The parameter "hookType" of ' +
             'the HookInvoker.invokeAndContinueUntilValueReceived ' +
-            'should be a non-empty String, but %s given.',
+            'should be a non-empty String, but %s was given.',
           v,
         );
       expect(throwable('')).to.throw(error('""'));
@@ -98,7 +98,7 @@ describe('HookInvoker', function () {
         format(
           'The parameter "response" of ' +
             'the HookInvoker.invokeAndContinueUntilValueReceived ' +
-            'should be a ServerResponse instance, but %s given.',
+            'should be a ServerResponse instance, but %s was given.',
           v,
         );
       expect(throwable('str')).to.throw(error('"str"'));

package/src/hooks/hook-registry.d.ts

@@ -37,7 +37,7 @@ export declare class HookRegistry extends DebuggableService {
    * @param type
    * @param hook
    */
-  hasHook(type: HookType, hook: RouterHook): this;
+  hasHook(type: HookType, hook: RouterHook): boolean;
 
   /**
    * Get hooks.

package/src/hooks/hook-registry.js

@@ -1,5 +1,4 @@
 import {Errorf} from '@e22m4u/js-format';
-import {DebuggableService} from '../debuggable-service.js';
 
 /**
  * Hook type.
@@ -17,7 +16,7 @@ export const HookType = {
 /**
  * Hook registry.
  */
-export class HookRegistry extends DebuggableService {
+export class HookRegistry {
   /**
    * Hooks.
    *
@@ -35,12 +34,12 @@ export class HookRegistry extends DebuggableService {
    */
   addHook(type, hook) {
     if (!type || typeof type !== 'string')
-      throw new Errorf('The hook type is required, but %v given.', type);
+      throw new Errorf('The hook type is required, but %v was given.', type);
     if (!Object.values(HookType).includes(type))
       throw new Errorf('The hook type %v is not supported.', type);
     if (!hook || typeof hook !== 'function')
       throw new Errorf(
-        'The hook %v should be a Function, but %v given.',
+        'The hook %v should be a Function, but %v was given.',
         type,
         hook,
       );
@@ -59,12 +58,12 @@ export class HookRegistry extends DebuggableService {
    */
   hasHook(type, hook) {
     if (!type || typeof type !== 'string')
-      throw new Errorf('The hook type is required, but %v given.', type);
+      throw new Errorf('The hook type is required, but %v was given.', type);
     if (!Object.values(HookType).includes(type))
       throw new Errorf('The hook type %v is not supported.', type);
     if (!hook || typeof hook !== 'function')
       throw new Errorf(
-        'The hook %v should be a Function, but %v given.',
+        'The hook %v should be a Function, but %v was given.',
         type,
         hook,
       );
@@ -80,7 +79,7 @@ export class HookRegistry extends DebuggableService {
    */
   getHooks(type) {
     if (!type || typeof type !== 'string')
-      throw new Errorf('The hook type is required, but %v given.', type);
+      throw new Errorf('The hook type is required, but %v was given.', type);
     if (!Object.values(HookType).includes(type))
       throw new Errorf('The hook type %v is not supported.', type);
     return this._hooks.get(type) || [];

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

@@ -8,7 +8,8 @@ describe('HookRegistry', function () {
     it('requires the parameter "type" to be a non-empty String', function () {
       const s = new HookRegistry();
       const throwable = v => () => s.addHook(v, () => undefined);
-      const error = v => format('The hook type is required, but %s given.', v);
+      const error = v =>
+        format('The hook type is required, but %s was given.', v);
       expect(throwable('')).to.throw(error('""'));
       expect(throwable(10)).to.throw(error('10'));
       expect(throwable(0)).to.throw(error('0'));
@@ -26,7 +27,10 @@ describe('HookRegistry', function () {
       const s = new HookRegistry();
       const throwable = v => () => s.addHook(HookType.PRE_HANDLER, v);
       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(throwable('str')).to.throw(error('"str"'));
       expect(throwable('')).to.throw(error('""'));
       expect(throwable(10)).to.throw(error('10'));
@@ -69,7 +73,8 @@ describe('HookRegistry', function () {
     it('requires the parameter "type" to be a non-empty String', function () {
       const s = new HookRegistry();
       const throwable = v => () => s.hasHook(v, () => undefined);
-      const error = v => format('The hook type is required, but %s given.', v);
+      const error = v =>
+        format('The hook type is required, but %s was given.', v);
       expect(throwable('')).to.throw(error('""'));
       expect(throwable(10)).to.throw(error('10'));
       expect(throwable(0)).to.throw(error('0'));
@@ -87,7 +92,10 @@ describe('HookRegistry', function () {
       const s = new HookRegistry();
       const throwable = v => () => s.hasHook(HookType.PRE_HANDLER, v);
       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(throwable('str')).to.throw(error('"str"'));
       expect(throwable('')).to.throw(error('""'));
       expect(throwable(10)).to.throw(error('10'));
@@ -123,7 +131,8 @@ describe('HookRegistry', function () {
     it('requires the parameter "type" to be a non-empty String', function () {
       const s = new HookRegistry();
       const throwable = v => () => s.getHooks(v);
-      const error = v => format('The hook type is required, but %s given.', v);
+      const error = v =>
+        format('The hook type is required, but %s was given.', v);
       expect(throwable('')).to.throw(error('""'));
       expect(throwable(10)).to.throw(error('10'));
       expect(throwable(0)).to.throw(error('0'));

package/src/parsers/body-parser.js

@@ -45,13 +45,13 @@ export class BodyParser extends DebuggableService {
     if (!mediaType || typeof mediaType !== 'string')
       throw new Errorf(
         'The parameter "mediaType" of BodyParser.defineParser ' +
-          'should be a non-empty String, but %v given.',
+          'should be a non-empty String, but %v was given.',
         mediaType,
       );
     if (!parser || typeof parser !== 'function')
       throw new Errorf(
         'The parameter "parser" of BodyParser.defineParser ' +
-          'should be a Function, but %v given.',
+          'should be a Function, but %v was given.',
         parser,
       );
     this._parsers[mediaType] = parser;
@@ -68,7 +68,7 @@ export class BodyParser extends DebuggableService {
     if (!mediaType || typeof mediaType !== 'string')
       throw new Errorf(
         'The parameter "mediaType" of BodyParser.hasParser ' +
-          'should be a non-empty String, but %v given.',
+          'should be a non-empty String, but %v was given.',
         mediaType,
       );
     return Boolean(this._parsers[mediaType]);
@@ -84,7 +84,7 @@ export class BodyParser extends DebuggableService {
     if (!mediaType || typeof mediaType !== 'string')
       throw new Errorf(
         'The parameter "mediaType" of BodyParser.deleteParser ' +
-          'should be a non-empty String, but %v given.',
+          'should be a non-empty String, but %v was given.',
         mediaType,
       );
     const parser = this._parsers[mediaType];
@@ -100,8 +100,9 @@ export class BodyParser extends DebuggableService {
    * @returns {Promise<*>|undefined}
    */
   parse(req) {
+    const debug = this.getDebuggerFor(this.parse);
     if (!METHODS_WITH_BODY.includes(req.method.toUpperCase())) {
-      this.debug(
+      debug(
         'Body parsing was skipped for the %s request.',
         req.method.toUpperCase(),
       );
@@ -112,8 +113,8 @@ export class BodyParser extends DebuggableService {
       '$1',
     );
     if (!contentType) {
-      this.debug(
-        'Body parsing was skipped because the request has no content type.',
+      debug(
+        'Body parsing was skipped because the request had no content type.',
       );
       return;
     }
@@ -126,7 +127,7 @@ export class BodyParser extends DebuggableService {
     const parser = this._parsers[mediaType];
     if (!parser) {
       if (UNPARSABLE_MEDIA_TYPES.includes(mediaType)) {
-        this.debug('Body parsing was skipped for %v.', mediaType);
+        debug('Body parsing was skipped for %v.', mediaType);
         return;
       }
       throw createError(
@@ -154,8 +155,6 @@ export function parseJsonBody(input) {
   try {
     return JSON.parse(input);
   } catch (error) {
-    if (process.env['DEBUG'] || process.env['NODE_ENV'] === 'development')
-      console.warn(error);
-    throw createError(HttpErrors.BadRequest, 'Unable to parse request body.');
+    throw createError(HttpErrors.BadRequest, error.message);
   }
 }

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

@@ -16,7 +16,7 @@ describe('BodyParser', function () {
       const error = v =>
         format(
           'The parameter "mediaType" of BodyParser.defineParser ' +
-            'should be a non-empty String, but %s given.',
+            'should be a non-empty String, but %s was given.',
           v,
         );
       expect(throwable('')).to.throw(error('""'));
@@ -38,7 +38,7 @@ describe('BodyParser', function () {
       const error = v =>
         format(
           'The parameter "parser" of BodyParser.defineParser ' +
-            'should be a Function, but %s given.',
+            'should be a Function, but %s was given.',
           v,
         );
       expect(throwable('str')).to.throw(error('"str"'));
@@ -76,7 +76,7 @@ describe('BodyParser', function () {
       const error = v =>
         format(
           'The parameter "mediaType" of BodyParser.hasParser ' +
-            'should be a non-empty String, but %s given.',
+            'should be a non-empty String, but %s was given.',
           v,
         );
       expect(throwable('')).to.throw(error('""'));
@@ -111,7 +111,7 @@ describe('BodyParser', function () {
       const error = v =>
         format(
           'The parameter "mediaType" of BodyParser.deleteParser ' +
-            'should be a non-empty String, but %s given.',
+            'should be a non-empty String, but %s was given.',
           v,
         );
       expect(throwable('')).to.throw(error('""'));

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

@@ -0,0 +1,15 @@
+import {IncomingMessage} from 'http';
+import {ParsedCookies} from '../utils/index.js';
+import {DebuggableService} from '../debuggable-service.js';
+
+/**
+ * Cookies parser.
+ */
+export declare class CookiesParser extends DebuggableService {
+  /**
+   * Parse.
+   *
+   * @param req
+   */
+  parse(req: IncomingMessage): ParsedCookies;
+}

package/src/parsers/cookies-parser.js

@@ -0,0 +1,33 @@
+import {parseCookies} from '../utils/index.js';
+import {getRequestPathname} from '../utils/index.js';
+import {DebuggableService} from '../debuggable-service.js';
+
+/**
+ * Cookies parser.
+ */
+export class CookiesParser extends DebuggableService {
+  /**
+   * Parse
+   *
+   * @param {import('http').IncomingMessage} req
+   * @returns {object}
+   */
+  parse(req) {
+    const debug = this.getDebuggerFor(this.parse);
+    const cookiesString = req.headers['cookie'] || '';
+    const cookies = parseCookies(cookiesString);
+    const cookiesKeys = Object.keys(cookies);
+    if (cookiesKeys.length) {
+      cookiesKeys.forEach(key => {
+        debug('The cookie %v had the value %v.', key, cookies[key]);
+      });
+    } else {
+      debug(
+        'The request %s %v had no cookies.',
+        req.method,
+        getRequestPathname(req),
+      );
+    }
+    return cookies;
+  }
+}

package/src/parsers/{cookie-parser.spec.js → cookies-parser.spec.js}

@@ -1,10 +1,10 @@
 import {expect} from '../chai.js';
-import {CookieParser} from './cookie-parser.js';
+import {CookiesParser} from './cookies-parser.js';
 
-describe('CookieParser', function () {
+describe('CookiesParser', function () {
   describe('parse', function () {
-    it('returns cookie parameters', function () {
-      const parser = new CookieParser();
+    it('returns parsed cookies as a plain object', function () {
+      const parser = new CookiesParser();
       const value = 'pkg=math; equation=E%3Dmc%5E2';
       const result = parser.parse({url: '', headers: {cookie: value}});
       expect(result).to.have.property('pkg', 'math');
@@ -12,13 +12,13 @@ describe('CookieParser', function () {
     });
 
     it('returns an empty object if no cookies', function () {
-      const parser = new CookieParser();
+      const parser = new CookiesParser();
       const result = parser.parse({url: '', headers: {}});
       expect(result).to.be.eql({});
     });
 
     it('returns an empty object for an empty string', function () {
-      const parser = new CookieParser();
+      const parser = new CookiesParser();
       const result = parser.parse({url: '', headers: {cookie: ''}});
       expect(result).to.be.eql({});
     });

package/src/parsers/index.d.ts

@@ -1,4 +1,4 @@
 export * from './body-parser.js';
 export * from './query-parser.js';
-export * from './cookie-parser.js';
+export * from './cookies-parser.js';
 export * from './request-parser.js';

package/src/parsers/index.js

@@ -1,4 +1,4 @@
 export * from './body-parser.js';
 export * from './query-parser.js';
-export * from './cookie-parser.js';
+export * from './cookies-parser.js';
 export * from './request-parser.js';

package/src/parsers/query-parser.js

@@ -13,16 +13,17 @@ export class QueryParser extends DebuggableService {
    * @returns {object}
    */
   parse(req) {
+    const debug = this.getDebuggerFor(this.parse);
     const queryStr = req.url.replace(/^[^?]*\??/, '');
     const query = queryStr ? querystring.parse(queryStr) : {};
     const queryKeys = Object.keys(query);
     if (queryKeys.length) {
       queryKeys.forEach(key => {
-        this.debug('The query %v has the value %v.', key, query[key]);
+        debug('The query parameter %v had the value %v.', key, query[key]);
       });
     } else {
-      this.debug(
-        'The request %s %v has no query.',
+      debug(
+        'The request %s %v had no query parameters.',
         req.method,
         getRequestPathname(req),
       );