@e22m4u/js-trie-router 0.6.5 → 0.6.6

package/README.md

@@ -190,39 +190,38 @@ router.defineRoute({
 
 **При получении входящего HTTP-запроса**
 
-1. [Глобальные хуки `onRequest`](#onrequest)  
-  \- Вызываются до поиска маршрута и создания контекста. Подходит для ранней
-  блокировки запроса или установки базовых заголовков.
+1. [Глобальные хуки `onRequest`](#onrequest).  
+  \- Вызываются до поиска маршрута и разбора входящих данных.
 
-2. Поиск маршрута  
-  \- Маршрутизатор ищет совпадение пути. Если маршрут не найден,
-  отправляется ответ `404`, а дальнейшая обработка прекращается.
+2. Поиск маршрута.  
+  \- Если маршрут не найден, отправляется ответ `404`, а дальнейшая обработка
+  прерывается.
 
-3. Создание `RequestContext` и парсинг  
+3. Создание `RequestContext` и парсинг.  
   \- Создается экземпляр контекста, разбирается строка запроса, заголовки
   и извлекается тело запроса.
 
-4. [Глобальные хуки `preHandler`](#prehandler-глобальный)  
-  \- Вызываются последовательно. Если хук возвращает значение
-  или отправляет ответ, цикл прерывается.
+4. [Глобальные хуки `preHandler`](#prehandler-глобальный).  
+  \- Вызываются последовательно. Если хук возвращает значение или отправляет
+  ответ, цикл прерывается.
 
-5. [Хуки маршрута `preHandler`](#prehandler-для-маршрута)   
-  \- Вызываются последовательно для конкретного маршрута. Правила
-  прерывания такие же, как у одноименных глобальных хуков.
+5. [Хуки маршрута `preHandler`](#prehandler-для-маршрута).   
+  \- Вызываются для конкретного маршрута. Правила прерывания такие же,
+  как у глобальных хуков.
 
-6. Основной обработчик (функция `handler`)  
-  \- Вызывается для формирования ответа сервера.
+6. Основной обработчик (функция `handler`).  
+  \- Обработчик запроса вызывается для формирования ответа сервера.
 
-7. [Хуки маршрута `postHandler`](#posthandler-для-маршрута)  
-  \- Вызываются последовательно. Получают результат работы обработчика
-  (или из `preHandler`) и могут трансформировать его перед отправкой.
+7. [Хуки маршрута `postHandler`](#posthandler-для-маршрута).  
+  \- Получают результат обработчика и могут трансформировать его перед
+  отправкой.
 
-8. [Глобальные хуки `postHandler`](#posthandler-глобальный)  
+8. [Глобальные хуки `postHandler`](#posthandler-глобальный).  
   \- Завершают цепочку трансформации ответа.
 
 9. Отправка ответа.  
-  \- Маршрутизатор автоматически форматирует и отправляет итоговые данные
-  клиенту (если ответ не был отправлен ранее вручную).
+  \- Маршрутизатор сериализует итоговые данные, устанавливает заголовки
+  и отправляет клиенту.
 
 Процесс обработки запроса обернут в глобальный `try/catch` блок. Любая ошибка,
 выброшенная на любом этапе (в хуках, при разборе тела или в самом обработчике),

package/dist/cjs/index.cjs

@@ -38,7 +38,6 @@ __export(index_exports, {
   EXPOSED_ERROR_PROPERTIES: () => EXPOSED_ERROR_PROPERTIES,
   ErrorSender: () => ErrorSender,
   HttpMethod: () => HttpMethod,
-  METHODS_WITH_BODY: () => METHODS_WITH_BODY,
   QueryParser: () => QueryParser,
   ROOT_PATH: () => ROOT_PATH,
   ROUTER_HOOK_TYPES: () => ROUTER_HOOK_TYPES,
@@ -51,7 +50,6 @@ __export(index_exports, {
   RouterHookType: () => RouterHookType,
   RouterOptions: () => RouterOptions,
   TrieRouter: () => TrieRouter,
-  UNPARSABLE_MEDIA_TYPES: () => UNPARSABLE_MEDIA_TYPES,
   cloneDeep: () => cloneDeep,
   createCookieString: () => createCookieString,
   createError: () => createError,
@@ -60,6 +58,7 @@ __export(index_exports, {
   createRouteMock: () => createRouteMock,
   fetchRequestBody: () => fetchRequestBody,
   getRequestPathname: () => getRequestPathname,
+  hasRequestBody: () => hasRequestBody,
   isPromise: () => isPromise,
   isReadableStream: () => isReadableStream,
   isResponseSent: () => isResponseSent,
@@ -219,6 +218,18 @@ function isResponseSent(response) {
 }
 __name(isResponseSent, "isResponseSent");
 
+// src/utils/has-request-body.js
+function hasRequestBody(request) {
+  if (request.headers["transfer-encoding"] !== void 0) {
+    return true;
+  }
+  if (!isNaN(request.headers["content-length"]) && request.headers["content-length"] !== "0") {
+    return true;
+  }
+  return false;
+}
+__name(hasRequestBody, "hasRequestBody");
+
 // src/utils/create-route-mock.js
 function createRouteMock(options = {}) {
   return new Route({
@@ -641,7 +652,7 @@ function createRequestHeaders(host, secure, body, cookies, encoding, headers) {
       obj["content-type"] = "application/json";
     }
   }
-  if (body != null && obj["content-length"] == null) {
+  if (body != null && obj["transfer-encoding"] == null && obj["content-length"] == null) {
     if (typeof body === "string") {
       const length = Buffer.byteLength(body, encoding);
       obj["content-length"] = String(length);
@@ -1558,8 +1569,6 @@ var RouterOptions = _RouterOptions;
 
 // src/parsers/body-parser.js
 var import_js_format15 = require("@e22m4u/js-format");
-var METHODS_WITH_BODY = ["POST", "PUT", "PATCH", "DELETE"];
-var UNPARSABLE_MEDIA_TYPES = ["multipart/form-data"];
 var _BodyParser = class _BodyParser extends DebuggableService {
   /**
    * Parsers.
@@ -1590,7 +1599,7 @@ var _BodyParser = class _BodyParser extends DebuggableService {
         parser
       );
     }
-    this._parsers[mediaType] = parser;
+    this._parsers[mediaType.toLowerCase()] = parser;
     return this;
   }
   /**
@@ -1606,7 +1615,7 @@ var _BodyParser = class _BodyParser extends DebuggableService {
         mediaType
       );
     }
-    return Boolean(this._parsers[mediaType]);
+    return Boolean(this._parsers[mediaType.toLowerCase()]);
   }
   /**
    * Get parser.
@@ -1621,7 +1630,7 @@ var _BodyParser = class _BodyParser extends DebuggableService {
         mediaType
       );
     }
-    const parser = this._parsers[mediaType];
+    const parser = this._parsers[mediaType.toLowerCase()];
     if (!parser) {
       throw new import_js_format15.InvalidArgumentError(
         "Media type %v does not have a parser.",
@@ -1643,7 +1652,7 @@ var _BodyParser = class _BodyParser extends DebuggableService {
         mediaType
       );
     }
-    delete this._parsers[mediaType];
+    delete this._parsers[mediaType.toLowerCase()];
     return this;
   }
   /**
@@ -1659,17 +1668,11 @@ var _BodyParser = class _BodyParser extends DebuggableService {
       request.method.toUpperCase(),
       getRequestPathname(request)
     );
-    if (!METHODS_WITH_BODY.includes(request.method.toUpperCase())) {
-      debug(
-        "Skipping body parsing for the %s method.",
-        request.method.toUpperCase()
-      );
+    if (!hasRequestBody(request)) {
+      debug("Skipping body parsing because no body is provided.");
       return;
     }
-    const contentType = (request.headers["content-type"] || "").replace(
-      /^([^;]+);.*$/,
-      "$1"
-    );
+    const contentType = request.headers["content-type"];
     if (!contentType) {
       debug("Skipping body parsing because no content type is provided.");
       return;
@@ -1681,17 +1684,10 @@ var _BodyParser = class _BodyParser extends DebuggableService {
         'Unable to parse the "content-type" header.'
       );
     }
-    const parser = this._parsers[mediaType];
+    const parser = this._parsers[mediaType.toLowerCase()];
     if (!parser) {
-      if (UNPARSABLE_MEDIA_TYPES.includes(mediaType)) {
-        debug("Skipping body parsing for the media type %v.", mediaType);
-        return;
-      }
-      throw createError(
-        import_http_errors2.default.UnsupportedMediaType,
-        "Media type %v is not supported.",
-        mediaType
-      );
+      debug("No body parser for the media type %v.", mediaType);
+      return;
     }
     const bodyBytesLimit = this.getService(RouterOptions).requestBodyBytesLimit;
     debug("Fetching a request body.");
@@ -1715,7 +1711,7 @@ function parseJsonBody(input) {
   try {
     return JSON.parse(input);
   } catch (error) {
-    throw createError(import_http_errors2.default.BadRequest, error.message);
+    throw new import_http_errors2.default.BadRequest(error.message);
   }
 }
 __name(parseJsonBody, "parseJsonBody");
@@ -2565,7 +2561,6 @@ var TrieRouter = _TrieRouter;
   EXPOSED_ERROR_PROPERTIES,
   ErrorSender,
   HttpMethod,
-  METHODS_WITH_BODY,
   QueryParser,
   ROOT_PATH,
   ROUTER_HOOK_TYPES,
@@ -2578,7 +2573,6 @@ var TrieRouter = _TrieRouter;
   RouterHookType,
   RouterOptions,
   TrieRouter,
-  UNPARSABLE_MEDIA_TYPES,
   cloneDeep,
   createCookieString,
   createError,
@@ -2587,6 +2581,7 @@ var TrieRouter = _TrieRouter;
   createRouteMock,
   fetchRequestBody,
   getRequestPathname,
+  hasRequestBody,
   isPromise,
   isReadableStream,
   isResponseSent,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@e22m4u/js-trie-router",
-  "version": "0.6.5",
+  "version": "0.6.6",
   "description": "HTTP маршрутизатор для Node.js на основе префиксного дерева",
   "author": "Mikhail Evstropov <e22m4u@yandex.ru>",
   "license": "MIT",

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

@@ -2,16 +2,6 @@ import {IncomingMessage} from 'http';
 import {ValueOrPromise} from '../types.js';
 import {DebuggableService} from '../debuggable-service.js';
 
-/**
- * Method names to be parsed.
- */
-export declare const METHODS_WITH_BODY: string[];
-
-/**
- * Unparsable media types.
- */
-export declare const UNPARSABLE_MEDIA_TYPES: string[];
-
 /**
  * Body parser function.
  */

package/src/parsers/body-parser.js

@@ -5,25 +5,12 @@ import {DebuggableService} from '../debuggable-service.js';
 
 import {
   createError,
+  hasRequestBody,
   parseContentType,
   fetchRequestBody,
   getRequestPathname,
 } from '../utils/index.js';
 
-/**
- * Method names to be parsed.
- *
- * @type {string[]}
- */
-export const METHODS_WITH_BODY = ['POST', 'PUT', 'PATCH', 'DELETE'];
-
-/**
- * Unparsable media types.
- *
- * @type {string[]}
- */
-export const UNPARSABLE_MEDIA_TYPES = ['multipart/form-data'];
-
 /**
  * Body parser.
  */
@@ -59,7 +46,7 @@ export class BodyParser extends DebuggableService {
         parser,
       );
     }
-    this._parsers[mediaType] = parser;
+    this._parsers[mediaType.toLowerCase()] = parser;
     return this;
   }
 
@@ -77,7 +64,7 @@ export class BodyParser extends DebuggableService {
         mediaType,
       );
     }
-    return Boolean(this._parsers[mediaType]);
+    return Boolean(this._parsers[mediaType.toLowerCase()]);
   }
 
   /**
@@ -94,7 +81,7 @@ export class BodyParser extends DebuggableService {
         mediaType,
       );
     }
-    const parser = this._parsers[mediaType];
+    const parser = this._parsers[mediaType.toLowerCase()];
     if (!parser) {
       throw new InvalidArgumentError(
         'Media type %v does not have a parser.',
@@ -118,7 +105,7 @@ export class BodyParser extends DebuggableService {
         mediaType,
       );
     }
-    delete this._parsers[mediaType];
+    delete this._parsers[mediaType.toLowerCase()];
     return this;
   }
 
@@ -135,17 +122,11 @@ export class BodyParser extends DebuggableService {
       request.method.toUpperCase(),
       getRequestPathname(request),
     );
-    if (!METHODS_WITH_BODY.includes(request.method.toUpperCase())) {
-      debug(
-        'Skipping body parsing for the %s method.',
-        request.method.toUpperCase(),
-      );
+    if (!hasRequestBody(request)) {
+      debug('Skipping body parsing because no body is provided.');
       return;
     }
-    const contentType = (request.headers['content-type'] || '').replace(
-      /^([^;]+);.*$/,
-      '$1',
-    );
+    const contentType = request.headers['content-type'];
     if (!contentType) {
       debug('Skipping body parsing because no content type is provided.');
       return;
@@ -157,17 +138,10 @@ export class BodyParser extends DebuggableService {
         'Unable to parse the "content-type" header.',
       );
     }
-    const parser = this._parsers[mediaType];
+    const parser = this._parsers[mediaType.toLowerCase()];
     if (!parser) {
-      if (UNPARSABLE_MEDIA_TYPES.includes(mediaType)) {
-        debug('Skipping body parsing for the media type %v.', mediaType);
-        return;
-      }
-      throw createError(
-        HttpErrors.UnsupportedMediaType,
-        'Media type %v is not supported.',
-        mediaType,
-      );
+      debug('No body parser for the media type %v.', mediaType);
+      return;
     }
     const bodyBytesLimit = this.getService(RouterOptions).requestBodyBytesLimit;
     debug('Fetching a request body.');
@@ -196,6 +170,6 @@ export function parseJsonBody(input) {
   try {
     return JSON.parse(input);
   } catch (error) {
-    throw createError(HttpErrors.BadRequest, error.message);
+    throw new HttpErrors.BadRequest(error.message);
   }
 }

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

@@ -1,16 +1,11 @@
 import {expect} from 'chai';
 import HttpErrors from 'http-errors';
 import {format} from '@e22m4u/js-format';
+import {BodyParser} from './body-parser.js';
 import {HttpMethod} from '../route/index.js';
 import {RouterOptions} from '../router-options.js';
 import {createRequestMock} from '../utils/index.js';
 
-import {
-  BodyParser,
-  METHODS_WITH_BODY,
-  UNPARSABLE_MEDIA_TYPES,
-} from './body-parser.js';
-
 describe('BodyParser', function () {
   describe('defineParser', function () {
     it('should require the parameter "mediaType" to be a non-empty String', function () {
@@ -106,6 +101,13 @@ describe('BodyParser', function () {
       S.defineParser(mediaType, parser);
       expect(S.hasParser(mediaType)).to.be.true;
     });
+
+    it('should be case-insensitive when looking up the parser', function () {
+      const S = new BodyParser();
+      const parser = v => v;
+      S.defineParser('MeDiA/TyPe', parser);
+      expect(S.hasParser('mEdIa/tYpE')).to.be.true;
+    });
   });
 
   describe('getParser', function () {
@@ -147,6 +149,13 @@ describe('BodyParser', function () {
       S.defineParser(mediaType, parser);
       expect(S.getParser(mediaType)).to.be.eq(parser);
     });
+
+    it('should be case-insensitive when looking up the parser', function () {
+      const S = new BodyParser();
+      const parser = v => v;
+      S.defineParser('MeDiA/TyPe', parser);
+      expect(S.getParser('mEdIa/tYpE')).to.be.eq(parser);
+    });
   });
 
   describe('removeParser', function () {
@@ -188,71 +197,77 @@ describe('BodyParser', function () {
       S.removeParser(mediaType);
       expect(S.hasParser(mediaType)).to.be.false;
     });
-  });
 
-  describe('parse', function () {
-    it('should return undefined when the request method is not supported', async function () {
+    it('should be case-insensitive when removing the parser', function () {
       const S = new BodyParser();
-      const req = createRequestMock({
-        method: 'unsupported',
-        body: 'Lorem Ipsum is simply dummy text.',
-      });
-      const result = await S.parse(req);
-      expect(result).to.be.undefined;
-    });
-
-    it('should return undefined when the request method is not supported even if the "content-type" header is specified', async function () {
-      const S = new BodyParser();
-      const req = createRequestMock({
-        method: 'unsupported',
-        headers: {'content-type': 'text/plain'},
-        body: 'Lorem Ipsum is simply dummy text.',
-      });
-      const result = await S.parse(req);
-      expect(result).to.be.undefined;
+      const parser = v => v;
+      const mediaType = 'MeDiA/TyPe';
+      S.defineParser(mediaType, parser);
+      expect(S.hasParser(mediaType)).to.be.true;
+      S.removeParser('mEdIa/tYpE');
+      expect(S.hasParser(mediaType)).to.be.false;
     });
+  });
 
-    it('should return undefined when no "content-type" header is specified', async function () {
+  describe('parse', function () {
+    it('should parse the request body when the "content-type" and "content-length" headers are provided', async function () {
       const S = new BodyParser();
-      const req = createRequestMock({method: HttpMethod.POST});
-      const result = await S.parse(req);
-      expect(result).to.be.undefined;
+      const body = 'Lorem Ipsum is simply dummy text.';
+      const headers = {
+        'content-type': 'text/plain',
+        'content-length': Buffer.byteLength(body, 'utf-8'),
+      };
+      for await (const method of Object.values(HttpMethod)) {
+        const req = createRequestMock({method, body, headers});
+        const result = await S.parse(req);
+        expect(result).to.be.eq(body);
+      }
     });
 
-    it('should return undefined when the media type is excluded', async function () {
+    it('should parse the request body when the "content-type" and "transfer-encoding" headers are provided', async function () {
       const S = new BodyParser();
-      for await (const mediaType of UNPARSABLE_MEDIA_TYPES) {
-        const req = createRequestMock({
-          method: HttpMethod.POST,
-          headers: {'content-type': mediaType},
-          body: 'Lorem Ipsum is simply dummy text.',
-        });
+      const body = 'Lorem Ipsum is simply dummy text.';
+      const headers = {
+        'content-type': 'text/plain',
+        'transfer-encoding': 'chunked',
+      };
+      for await (const method of Object.values(HttpMethod)) {
+        const req = createRequestMock({method, body, headers});
         const result = await S.parse(req);
-        expect(result).to.be.undefined;
+        expect(result).to.be.eq(body);
       }
     });
 
-    it('should parse the request body for available methods', async function () {
+    it('should skip parsing when the header "content-length" has an invalid value', async function () {
       const S = new BodyParser();
       const body = 'Lorem Ipsum is simply dummy text.';
-      const headers = {'content-type': 'text/plain'};
-      for await (const method of Object.values(METHODS_WITH_BODY)) {
+      const headers = {
+        'content-type': 'text/plain',
+        'content-length': 'invalid',
+      };
+      for await (const method of Object.values(HttpMethod)) {
         const req = createRequestMock({method, body, headers});
         const result = await S.parse(req);
-        expect(result).to.be.eq(body);
+        expect(result).to.be.undefined;
       }
     });
 
-    it('should throw an error when the media type is not supported', function () {
+    it('should return undefined when no "content-type" header is provided', async function () {
+      const S = new BodyParser();
+      const req = createRequestMock({method: HttpMethod.POST});
+      const result = await S.parse(req);
+      expect(result).to.be.undefined;
+    });
+
+    it('should return undefined when the media type does not have a registered parser', async function () {
       const S = new BodyParser();
       const req = createRequestMock({
         method: HttpMethod.POST,
-        headers: {'content-type': 'media/unknown'},
+        headers: {'content-type': 'type/unknown'},
+        body: 'Lorem Ipsum is simply dummy text.',
       });
-      const throwable = () => S.parse(req);
-      expect(throwable).to.throw(
-        'Media type "media/unknown" is not supported.',
-      );
+      const result = await S.parse(req);
+      expect(result).to.be.undefined;
     });
 
     it('should use the option "bodyBytesLimit" from the RouterOptions', async function () {