@e22m4u/js-trie-router 0.0.1 → 0.0.3

package/README.md

@@ -1,80 +1,99 @@
 ## @e22m4u/js-trie-router
 
-A pure ES-module of the Node.js HTTP router that uses the
-[Trie](https://en.wikipedia.org/wiki/Trie) for routing.
+ES-модуль HTTP роутера для Node.js, использующий
+[Trie](https://en.wikipedia.org/wiki/Trie)
+для разрешения маршрутов.
 
-- Uses [path-to-regexp](https://github.com/pillarjs/path-to-regexp) syntax.
-- Supports path parameters.
-- Parses JSON-body automatically.
-- Parses a query string and the Cookie header.
-- Supports `preHandler` and `postHandler` hooks.
-- Asynchronous request handler.
+- Поддержка [path-to-regexp](https://github.com/pillarjs/path-to-regexp) синтаксиса.
+- Автоматический парсинг JSON-тела запроса.
+- Парсинг строки запроса и заголовка `cookie`.
+- Поддержка `preHandler` и `postHandler` хуков.
+- Позволяет использовать асинхронные обработчики.
 
-## Installation
+## Установка
 
 ```bash
 npm install @e22m4u/js-trie-router
 ```
 
-## Overview
+Для загрузки ES-модуля требуется установить `"type": "module"` в файле
+`package.json`, или использовать `.mjs` расширение.
 
-A basic "Hello world." example.
+## Обзор
+
+Базовый пример создания экземпляра роутера, объявления маршрута
+и передачи слушателя запросов `http` серверу.
 
 ```js
 import http from 'http';
-import {TrieRouter} from '../src/index.js';
-import {HTTP_METHOD} from '../src/route.js';
+import {TrieRouter} from '@e22m4u/js-path-trie';
 
-const server = new http.Server(); // A Node.js HTTP server.
-const router = new TrieRouter();  // A TrieRouter instance.
+const server = new http.Server(); // создание экземпляра HTTP сервера
+const router = new TrieRouter();  // создание экземпляра роутера
 
 router.defineRoute({
-  method: HTTP_METHOD.GET,        // Request method.
-  path: '/',                      // Path template like "/user/:id".
-  handler(ctx) {                  // Request handler.
+  method: 'GET',                  // метод запроса "GET", "POST" и т.д.
+  path: '/',                      // шаблон пути, пример "/user/:id"
+  handler(ctx) {                  // обработчик маршрута
     return 'Hello world!';
   },
 });
 
-server.on('request', router.requestHandler);
-server.listen(3000, 'localhost');
+server.on('request', router.requestListener); // подключение роутера
+server.listen(3000, 'localhost');             // прослушивание запросов
 
 // Open in browser http://localhost:3000
 ```
 
-### RequestContext
+### Контекст запроса
 
-The first parameter of the `Router` handler is the `RequestContext` instance.
+Первый параметр обработчика маршрута принимает экземпляр класса
+`RequestContext` с набором свойств, содержащих разобранные
+данные входящего запроса.
 
-- `container: ServiceContainer`
-- `req: IncomingMessage`
-- `res: ServerResponse`
-- `query: ParsedQuery`
-- `headers: ParsedHeaders`
-- `cookie: ParsedCookie`
+- `container: ServiceContainer` экземпляр [сервис-контейнера](https://npmjs.com/package/@e22m4u/js-service)
+- `req: IncomingMessage` нативный поток запроса модуля `http`
+- `res: ServerResponse` нативный поток ответа модуля `http`
+- `params: ParsedParams` объект ключ-значение с параметрами пути
+- `query: ParsedQuery` объект ключ-значение с параметрами строки запроса
+- `headers: ParsedHeaders` объект ключ-значение с заголовками запроса 
+- `cookie: ParsedCookie` объект ключ-значение разобранного заголовка `cookie`
+- `method: string` метод запроса в верхнем регистре, например `GET`, `POST` и т.д.
+- `path: string` путь включающий строку запроса, например `/myPath?foo=bar`
+- `pathname: string` путь запроса, например `/myMath`
 
-The `RequestContext` can be destructured.
+Пример доступа к контексту из обработчика маршрута.
 
 ```js
 router.defineRoute({
-  // ...
-  handler({req, res, query, headers, cookie}) {
-    console.log(req);     // IncomingMessage
-    console.log(res);     // ServerResponse
-    console.log(query);   // {id: '10', ...}
-    console.log(headers); // {'cookie': 'foo=bar', ...}
-    console.log(cookie);  // {foo: 'bar', ...}
+  method: 'GET',
+  path: '/users/:id',
+  handler(ctx) {
+    // GET /users/10?include=city
+    // Cookie: foo=bar; baz=qux;
+    console.log(ctx.req);      // IncomingMessage
+    console.log(ctx.res);      // ServerResponse
+    console.log(ctx.params);   // {id: 10}
+    console.log(ctx.query);    // {include: 'city'}
+    console.log(ctx.headers);  // {cookie: 'foo=bar; baz=qux;'}
+    console.log(ctx.cookie);   // {foo: 'bar', baz: 'qux'}
+    console.log(ctx.method);   // "GET"
+    console.log(ctx.path);     // "/users/10?include=city"
+    console.log(ctx.pathname); // "/users/10"
     // ...
   },
 });
 ```
 
-### Sending response
+### Отправка ответа
 
-Return values of the `Route` handler will be sent as described below.
+Возвращаемое значение обработчика маршрута используется в качестве ответа
+сервера. Тип значения влияет на представление возвращаемых данных. Например,
+если результатом будет являться тип `object`, то такое значение автоматически
+сериализуется в JSON.
 
-| type    | content-type             |
-|---------|--------------------------|
+| value     | content-type             |
+|-----------|--------------------------|
 | `string`  | text/plain               |
 | `number`  | application/json         |
 | `boolean` | application/json         |
@@ -82,20 +101,19 @@ Return values of the `Route` handler will be sent as described below.
 | `Buffer`  | application/octet-stream |
 | `Stream`  | application/octet-stream |
 
-Here is an example of a JSON response.
+Пример возвращаемого значения обработчиком маршрута.
 
 ```js
-router.defineRoute({
+router.defineRoute({     // регистрация маршрута
   // ...
-  handler(ctx) {
-    // sends "application/json"
-    return {foo: 'bar'};
+  handler(ctx) {         // обработчик входящего запроса
+    return {foo: 'bar'}; // ответ будет представлен в виде JSON
   },
 });
 ```
 
-If the `ServerResponse` has been sent manually, then the return
-value will be ignored.
+Контекст запроса `ctx` содержит нативный экземпляр класса `ServerResponse`,
+который может быть использован для ручного управления ответом.
 
 ```js
 router.defineRoute({
@@ -108,20 +126,114 @@ router.defineRoute({
 });
 ```
 
-## Debug
+### Хуки маршрута
+
+Определение маршрута методом `defineRoute` позволяет задать хуки
+для отслеживания и перехвата входящего запроса и ответа
+конкретного маршрута.
+
+- `preHandler` выполняется перед вызовом обработчика
+- `postHandler` выполняется после вызова обработчика
+
+#### preHandler
+
+Перед вызовом обработчика маршрута может потребоваться выполнение
+таких операции как авторизация и проверка параметров запроса. Для
+этого можно использовать хук `preHandler`.
+
+```js
+router.defineRoute({ // регистрация маршрута
+  // ...
+  preHandler(ctx) {
+    // вызывается перед обработчиком
+    console.log(`Incoming request ${ctx.method} ${ctx.path}`);
+    // Incoming request GET /myPath
+  },
+  handler(ctx) {
+    return 'Hello world!';
+  },
+});
+```
+
+Если хук `preHandler` возвращает значение отличное от `undefined` и `null`,
+то такое значение будет использовано в качестве ответа сервера, а вызов
+обработчика маршрута будет пропущен.
+
+```js
+router.defineRoute({ // регистрация маршрута
+  // ...
+  preHandler(ctx) {
+    // возвращение ответа сервера
+    return 'Are you authorized?';
+  },
+  handler(ctx) {
+    // данный обработчик не вызывается, так как
+    // хук "preHandler" уже отправил ответ
+  },
+});
+```
+
+#### postHandler
+
+Возвращаемое значение обработчика маршрута передается вторым аргументом
+хука `postHandler`. По аналогии с `preHandler`, если возвращаемое
+значение отличается от `undefined` и `null`, то такое значение будет
+использовано в качестве ответа сервера. Это может быть полезно для
+модификации возвращаемого ответа.
+
+```js
+router.defineRoute({
+  // ...
+  handler(ctx) {
+    return 'Hello world!';
+  },
+  postHandler(ctx, data) {
+    // выполняется после обработчика маршрута
+    return data.toUpperCase(); // HELLO WORLD!
+  },
+});
+```
+
+### Глобальные хуки
+
+Экземпляр роутера `TrieRouter` позволяет задать глобальные хуки, которые
+имеют более высокий приоритет перед хуками маршрута, и вызываются
+в первую очередь.
+
+- `preHandler` выполняется перед вызовом обработчика
+- `postHandler` выполняется после вызова обработчика
+
+Добавить глобальные хуки можно методом `addHook` экземпляра роутера,
+где первым параметром передается название хука, а вторым его функция.
+
+```js
+router.addHook('preHandler', (ctx) => {
+  // вызов перед обработчиком маршрута
+});
+
+router.addHook('postHandler', (ctx, data) => {
+  // вызов после обработчика маршрута
+});
+```
+
+Аналогично хукам маршрута, если глобальный хук возвращает значение
+отличное от `undefined` и `null`, то такое значение будет использовано
+как ответ сервера.
+
+## Отладка
 
-Set environment variable `DEBUG=jsTrieRouter*` before start.
+Установка переменной `DEBUG` перед командой запуска включает вывод логов.
 
 ```bash
 DEBUG=jsPathTrie* npm run test
 ```
 
-## Testing
+## Тестирование
 
 ```bash
 npm run test
 ```
 
-## License
+## Лицензия
 
 MIT

package/examples/cookie-parsing-example.js

@@ -15,7 +15,7 @@ router.defineRoute({
 // создаем экземпляр HTTP сервера
 // и подключаем обработчик запросов
 const server = new http.Server();
-server.on('request', router.requestHandler);
+server.on('request', router.requestListener);
 
 // слушаем входящие запросы
 // на указанный адрес и порт

package/examples/params-parsing-example.js

@@ -15,7 +15,7 @@ router.defineRoute({
 // создаем экземпляр HTTP сервера
 // и подключаем обработчик запросов
 const server = new http.Server();
-server.on('request', router.requestHandler);
+server.on('request', router.requestListener);
 
 // слушаем входящие запросы
 // на указанный адрес и порт

package/examples/query-parsing-example.js

@@ -15,7 +15,7 @@ router.defineRoute({
 // создаем экземпляр HTTP сервера
 // и подключаем обработчик запросов
 const server = new http.Server();
-server.on('request', router.requestHandler);
+server.on('request', router.requestListener);
 
 // слушаем входящие запросы
 // на указанный адрес и порт

package/examples/uptime-example.js

@@ -27,7 +27,7 @@ router.defineRoute({
 // создаем экземпляр HTTP сервера
 // и подключаем обработчик запросов
 const server = new http.Server();
-server.on('request', router.requestHandler);
+server.on('request', router.requestListener);
 
 // слушаем входящие запросы
 // на указанный адрес и порт

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@e22m4u/js-trie-router",
-  "version": "0.0.1",
-  "description": "Trie-based router for Node.js",
+  "version": "0.0.3",
+  "description": "Trie-роутер для Node.js",
   "type": "module",
   "main": "src/index.js",
   "scripts": {

package/src/parsers/body-parser.js

@@ -11,7 +11,7 @@ import {parseContentType} from '../utils/parse-content-type.js';
  *
  * @type {string[]}
  */
-export const METHODS_WITH_BODY = ['post', 'put', 'patch', 'delete'];
+export const METHODS_WITH_BODY = ['POST', 'PUT', 'PATCH', 'DELETE'];
 
 /**
  * Unparsable media types.
@@ -100,7 +100,7 @@ export class BodyParser extends Service {
    * @returns {Promise<*>|undefined}
    */
   parse(req) {
-    if (!METHODS_WITH_BODY.includes(req.method.toLowerCase())) {
+    if (!METHODS_WITH_BODY.includes(req.method.toUpperCase())) {
       this.debug(
         'Body parsing was skipped for the %s request.',
         req.method.toUpperCase(),

package/src/parsers/cookie-parser.js

@@ -1,6 +1,6 @@
 import {Service} from '../service.js';
 import {parseCookie} from '../utils/index.js';
-import {getRequestPath} from '../utils/index.js';
+import {getRequestPathname} from '../utils/index.js';
 
 /**
  * Cookie parser.
@@ -24,7 +24,7 @@ export class CookieParser extends Service {
       this.debug(
         'The request %s %v has no cookie.',
         req.method,
-        getRequestPath(req),
+        getRequestPathname(req),
       );
     }
     return cookie;

package/src/parsers/query-parser.js

@@ -1,6 +1,6 @@
 import querystring from 'querystring';
 import {Service} from '../service.js';
-import {getRequestPath} from '../utils/index.js';
+import {getRequestPathname} from '../utils/index.js';
 
 /**
  * Query parser.
@@ -24,7 +24,7 @@ export class QueryParser extends Service {
       this.debug(
         'The request %s %v has no query.',
         req.method,
-        getRequestPath(req),
+        getRequestPathname(req),
       );
     }
     return query;

package/src/request-context.d.ts

@@ -39,6 +39,21 @@ export declare class RequestContext {
    */
   cookie: ParsedCookie;
 
+  /**
+   * Method.
+   */
+  get method(): string;
+
+  /**
+   * Path.
+   */
+  get path(): string;
+
+  /**
+   * Pathname.
+   */
+  get pathname(): string;
+
   /**
    * Constructor.
    *

package/src/request-context.js

@@ -2,6 +2,7 @@ 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';
 
 /**
  * Request context.
@@ -63,6 +64,43 @@ export class RequestContext {
    */
   cookie = {};
 
+  /**
+   * Method.
+   *
+   * @returns {string}
+   */
+  get method() {
+    return this.req.method.toUpperCase();
+  }
+
+  /**
+   * Path.
+   *
+   * @returns {string}
+   */
+  get path() {
+    return this.req.url;
+  }
+
+  /**
+   * Pathname.
+   *
+   * @type {string|undefined}
+   * @private
+   */
+  _pathname = undefined;
+
+  /**
+   * Pathname.
+   *
+   * @returns {string}
+   */
+  get pathname() {
+    if (this._pathname != null) return this._pathname;
+    this._pathname = getRequestPathname(this.req);
+    return this._pathname;
+  }
+
   /**
    * Constructor.
    *

package/src/request-context.spec.js

@@ -86,4 +86,48 @@ describe('RequestContext', function () {
       expect(ctx.res).to.be.eq(res);
     });
   });
+
+  describe('method', function () {
+    it('returns the method name in upper case', function () {
+      const req = createRequestMock({method: 'post'});
+      const res = createResponseMock();
+      const cnt = new ServiceContainer();
+      const ctx = new RequestContext(cnt, req, res);
+      expect(ctx.method).to.be.eq('POST');
+    });
+  });
+
+  describe('path', function () {
+    it('returns the request pathname with the query string', function () {
+      const req = createRequestMock({path: '/pathname?foo=bar'});
+      const res = createResponseMock();
+      const cnt = new ServiceContainer();
+      const ctx = new RequestContext(cnt, req, res);
+      expect(req.url).to.be.eq('/pathname?foo=bar');
+      expect(ctx.path).to.be.eq('/pathname?foo=bar');
+    });
+  });
+
+  describe('pathname', function () {
+    it('returns the request pathname without the query string', function () {
+      const req = createRequestMock({path: '/pathname?foo=bar'});
+      const res = createResponseMock();
+      const cnt = new ServiceContainer();
+      const ctx = new RequestContext(cnt, req, res);
+      expect(req.url).to.be.eq('/pathname?foo=bar');
+      expect(ctx.pathname).to.be.eq('/pathname');
+    });
+
+    it('sets the cache to the "_pathname" property and uses is for next accesses', function () {
+      const req = createRequestMock({path: '/pathname'});
+      const res = createResponseMock();
+      const cnt = new ServiceContainer();
+      const ctx = new RequestContext(cnt, req, res);
+      expect(ctx._pathname).to.be.undefined;
+      expect(ctx.pathname).to.be.eq('/pathname');
+      expect(ctx._pathname).to.be.eq('/pathname');
+      ctx._pathname = '/overridden';
+      expect(ctx.pathname).to.be.eq('/overridden');
+    });
+  });
 });

package/src/route-registry.js

@@ -61,7 +61,7 @@ export class RouteRegistry extends Service {
       req.method.toUpperCase(),
       requestPath,
     );
-    const triePath = `${req.method.toLowerCase()}/${requestPath}`;
+    const triePath = `${req.method.toUpperCase()}/${requestPath}`;
     const resolved = this._trie.match(triePath);
     if (resolved) {
       const route = resolved.value;

package/src/route.js

@@ -2,7 +2,7 @@ import {Errorf} from '@e22m4u/js-format';
 import {HOOK_NAME} from './hooks/index.js';
 import {HookRegistry} from './hooks/index.js';
 import {createDebugger} from './utils/index.js';
-import {getRequestPath} from './utils/index.js';
+import {getRequestPathname} from './utils/index.js';
 
 /**
  * @typedef {import('./request-context.js').RequestContext} RequestContext
@@ -22,19 +22,19 @@ import {getRequestPath} from './utils/index.js';
  * Http method.
  *
  * @type {{
- *   DELETE: 'delete',
- *   POST: 'post',
- *   GET: 'get',
- *   PUT: 'put',
- *   PATCH: 'patch',
+ *   GET: 'GET',
+ *   POST: 'POST',
+ *   PUT: 'PUT',
+ *   PATCH: 'PATCH',
+ *   DELETE: 'DELETE',
  * }}
  */
 export const HTTP_METHOD = {
-  GET: 'get',
-  POST: 'post',
-  PUT: 'put',
-  PATCH: 'patch',
-  DELETE: 'delete',
+  GET: 'GET',
+  POST: 'POST',
+  PUT: 'PUT',
+  PATCH: 'PATCH',
+  DELETE: 'DELETE',
 };
 
 /**
@@ -134,7 +134,7 @@ export class Route {
           'a non-empty String, but %v given.',
         routeDef.method,
       );
-    this._method = routeDef.method.toLowerCase();
+    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.',
@@ -173,7 +173,7 @@ export class Route {
    * @returns {*}
    */
   handle(context) {
-    const requestPath = getRequestPath(context.req);
+    const requestPath = getRequestPathname(context.req);
     debug(
       'Invoking the Route handler for the request %s %v.',
       this.method.toUpperCase(),

package/src/route.spec.js

@@ -195,13 +195,13 @@ describe('Route', function () {
       throwable2(() => undefined)();
     });
 
-    it('sets the option "method" in lowercase to the "method" property', function () {
+    it('sets the option "method" in upper case to the "method" property', function () {
       const route = new Route({
-        method: 'POST',
+        method: 'post',
         path: '/',
         handler: () => undefined,
       });
-      expect(route.method).to.be.eq('post');
+      expect(route.method).to.be.eq('POST');
     });
 
     it('sets the option "path" to the "path" property', function () {

package/src/senders/error-sender.js

@@ -1,7 +1,7 @@
 import {inspect} from 'util';
 import {Service} from '../service.js';
 import getStatusMessage from 'statuses';
-import {getRequestPath} from '../utils/index.js';
+import {getRequestPathname} from '../utils/index.js';
 
 /**
  * Exposed error properties.
@@ -61,7 +61,7 @@ export class ErrorSender extends Service {
       'The %s error is sent for the request %s %v.',
       statusCode,
       req.method,
-      getRequestPath(req),
+      getRequestPathname(req),
     );
   }
 
@@ -79,7 +79,7 @@ export class ErrorSender extends Service {
     this.debug(
       'The 404 error is sent for the request %s %v.',
       req.method,
-      getRequestPath(req),
+      getRequestPathname(req),
     );
   }
 }

package/src/trie-router.d.ts

@@ -39,7 +39,7 @@ export declare class TrieRouter extends Service {
   defineRoute(routeDef: RouteDefinition): Route;
 
   /**
-   * Request handler.
+   * Request listener.
    *
    * Example:
    * ```
@@ -48,13 +48,13 @@ export declare class TrieRouter extends Service {
    *
    * const router = new TrieRouter();
    * const server = new http.Server();
-   * server.on('request', router.requestHandler); // Sets the request handler.
-   * server.listen(3000);                         // Starts listening for connections.
+   * server.on('request', router.requestListener); // Sets the request listener.
+   * server.listen(3000);                          // Starts listening for connections.
    * ```
    *
    * @returns {Function}
    */
-  get requestHandler(): RequestListener;
+  get requestListener(): RequestListener;
 
   /**
    * Add hook.

package/src/trie-router.js

@@ -35,7 +35,7 @@ export class TrieRouter extends Service {
    *   path: '/users/:id',             // The path template may have parameters.
    *   preHandler(ctx) { ... },        // The "preHandler" is executed before a route handler.
    *   handler(ctx) { ... },           // Request handler function.
-   *   postHandler(ctx, data) { ... }, // The "postHandler" is executed after a route handler
+   *   postHandler(ctx, data) { ... }, // The "postHandler" is executed after a route handler.
    * });
    * ```
    *
@@ -47,7 +47,7 @@ export class TrieRouter extends Service {
   }
 
   /**
-   * Request handler.
+   * Request listener.
    *
    * Example:
    * ```
@@ -56,13 +56,13 @@ export class TrieRouter extends Service {
    *
    * const router = new TrieRouter();
    * const server = new http.Server();
-   * server.on('request', router.requestHandler); // Sets the request handler.
-   * server.listen(3000);                         // Starts listening for connections.
+   * server.on('request', router.requestListener); // Sets the request listener.
+   * server.listen(3000);                          // Starts listening for connections.
    * ```
    *
    * @returns {Function}
    */
-  get requestHandler() {
+  get requestListener() {
     return this._handleRequest.bind(this);
   }
 

package/src/trie-router.spec.js

@@ -25,10 +25,10 @@ describe('TrieRouter', function () {
     });
   });
 
-  describe('requestHandler', function () {
+  describe('requestListener', function () {
     it('to be a function', function () {
       const router = new TrieRouter();
-      expect(typeof router.requestHandler).to.be.eq('function');
+      expect(typeof router.requestListener).to.be.eq('function');
     });
 
     it('passes request context to the route handler', function (done) {
@@ -43,7 +43,7 @@ describe('TrieRouter', function () {
       });
       const req = createRequestMock({path: '/test'});
       const res = createResponseMock();
-      router.requestHandler(req, res);
+      router.requestListener(req, res);
     });
 
     it('passes path parameters to the request context', function (done) {
@@ -58,7 +58,7 @@ describe('TrieRouter', function () {
       });
       const req = createRequestMock({path: '/foo-bar'});
       const res = createResponseMock();
-      router.requestHandler(req, res);
+      router.requestListener(req, res);
     });
 
     it('passes query parameters to the request context', function (done) {
@@ -73,7 +73,7 @@ describe('TrieRouter', function () {
       });
       const req = createRequestMock({path: '?p1=foo&p2=bar'});
       const res = createResponseMock();
-      router.requestHandler(req, res);
+      router.requestListener(req, res);
     });
 
     it('passes parsed cookie to the request context', function (done) {
@@ -88,7 +88,7 @@ describe('TrieRouter', function () {
       });
       const req = createRequestMock({headers: {cookie: 'p1=foo; p2=bar;'}});
       const res = createResponseMock();
-      router.requestHandler(req, res);
+      router.requestListener(req, res);
     });
 
     it('passes plain text body to the request context', function (done) {
@@ -104,7 +104,7 @@ describe('TrieRouter', function () {
       });
       const req = createRequestMock({method: HTTP_METHOD.POST, body});
       const res = createResponseMock();
-      router.requestHandler(req, res);
+      router.requestListener(req, res);
     });
 
     it('passes parsed JSON body to the request context', function (done) {
@@ -120,7 +120,7 @@ describe('TrieRouter', function () {
       });
       const req = createRequestMock({method: HTTP_METHOD.POST, body: data});
       const res = createResponseMock();
-      router.requestHandler(req, res);
+      router.requestListener(req, res);
     });
 
     it('passes headers to the request context', function (done) {
@@ -138,7 +138,7 @@ describe('TrieRouter', function () {
       });
       const req = createRequestMock({headers: {foo: 'bar'}});
       const res = createResponseMock();
-      router.requestHandler(req, res);
+      router.requestListener(req, res);
     });
 
     it('uses DataSender to send the response', function (done) {
@@ -158,7 +158,7 @@ describe('TrieRouter', function () {
           done();
         },
       });
-      router.requestHandler(req, res);
+      router.requestListener(req, res);
     });
 
     it('uses ErrorSender to send the response', function (done) {
@@ -181,7 +181,7 @@ describe('TrieRouter', function () {
           done();
         },
       });
-      router.requestHandler(req, res);
+      router.requestListener(req, res);
     });
 
     describe('hooks', function () {
@@ -207,7 +207,7 @@ describe('TrieRouter', function () {
         });
         const req = createRequestMock();
         const res = createResponseMock();
-        router.requestHandler(req, res);
+        router.requestListener(req, res);
         const result = await res.getBody();
         expect(result).to.be.eq(body);
         expect(order).to.be.eql(['preHandler1', 'preHandler2', 'handler']);
@@ -235,7 +235,7 @@ describe('TrieRouter', function () {
         });
         const req = createRequestMock();
         const res = createResponseMock();
-        router.requestHandler(req, res);
+        router.requestListener(req, res);
         const result = await res.getBody();
         expect(result).to.be.eq(body);
         expect(order).to.be.eql(['handler', 'postHandler1', 'postHandler2']);
@@ -266,7 +266,7 @@ describe('TrieRouter', function () {
         });
         const req = createRequestMock();
         const res = createResponseMock();
-        router.requestHandler(req, res);
+        router.requestListener(req, res);
         const result = await res.getBody();
         expect(result).to.be.eq(body);
         expect(order).to.be.eql(['preHandler1', 'preHandler2', 'handler']);
@@ -301,7 +301,7 @@ describe('TrieRouter', function () {
         });
         const req = createRequestMock();
         const res = createResponseMock();
-        router.requestHandler(req, res);
+        router.requestListener(req, res);
         const result = await res.getBody();
         expect(result).to.be.eq(body);
         expect(order).to.be.eql(['handler', 'postHandler1', 'postHandler2']);
@@ -331,7 +331,7 @@ describe('TrieRouter', function () {
         });
         const req = createRequestMock();
         const res = createResponseMock();
-        router.requestHandler(req, res);
+        router.requestListener(req, res);
         const result = await res.getBody();
         expect(result).to.be.eq(body);
         expect(order).to.be.eql(['preHandler1', 'preHandler2', 'handler']);
@@ -361,7 +361,7 @@ describe('TrieRouter', function () {
         });
         const req = createRequestMock();
         const res = createResponseMock();
-        router.requestHandler(req, res);
+        router.requestListener(req, res);
         const result = await res.getBody();
         expect(result).to.be.eq(body);
         expect(order).to.be.eql(['handler', 'postHandler1', 'postHandler2']);
@@ -391,7 +391,7 @@ describe('TrieRouter', function () {
         });
         const req = createRequestMock();
         const res = createResponseMock();
-        router.requestHandler(req, res);
+        router.requestListener(req, res);
         const result = await res.getBody();
         expect(result).to.be.eq(preHandlerBody);
         expect(result).not.to.be.eq(handlerBody);
@@ -421,7 +421,7 @@ describe('TrieRouter', function () {
         });
         const req = createRequestMock();
         const res = createResponseMock();
-        router.requestHandler(req, res);
+        router.requestListener(req, res);
         const result = await res.getBody();
         expect(result).not.to.be.eq(handlerBody);
         expect(result).to.be.eq(postHandlerBody);
@@ -448,7 +448,7 @@ describe('TrieRouter', function () {
         });
         const req = createRequestMock();
         const res = createResponseMock();
-        router.requestHandler(req, res);
+        router.requestListener(req, res);
         const result = await res.getBody();
         expect(result).to.be.eq(body);
         expect(order).to.be.eql(['preHandler', 'handler', 'postHandler']);

package/src/utils/create-request-mock.d.ts

@@ -10,7 +10,6 @@ type RequestPatch = {
   secure?: boolean;
   path?: string;
   query?: object;
-  hash?: string;
   cookie?: object;
   headers?: object;
   body?: string;

package/src/utils/create-request-mock.js

@@ -14,7 +14,6 @@ import {BUFFER_ENCODING_LIST} from './fetch-request-body.js';
  *   secure?: boolean;
  *   path?: string;
  *   query?: object;
- *   hash?: string;
  *   cookie?: object;
  *   headers?: object;
  *   body?: string;
@@ -74,12 +73,6 @@ export function createRequestMock(patch) {
       patch.query,
     );
   }
-  if (patch.hash != null && typeof patch.hash !== 'string')
-    throw new Errorf(
-      'The parameter "hash" of "createRequestMock" ' +
-        'should be a String, but %v given.',
-      patch.hash,
-    );
   if (
     (patch.cookie != null &&
       typeof patch.cookie !== 'string' &&
@@ -143,7 +136,7 @@ export function createRequestMock(patch) {
   const req =
     patch.stream ||
     createRequestStream(patch.secure, patch.body, patch.encoding);
-  req.url = createRequestUrl(patch.path || '/', patch.query, patch.hash);
+  req.url = createRequestUrl(patch.path || '/', patch.query);
   req.headers = createRequestHeaders(
     patch.host,
     patch.secure,
@@ -199,10 +192,9 @@ function createRequestStream(secure, body, encoding) {
  *
  * @param {string} path
  * @param {string|object|null|undefined} query
- * @param {string|null|undefined} hash
  * @returns {string}
  */
-function createRequestUrl(path, query, hash) {
+function createRequestUrl(path, query) {
   if (typeof path !== 'string')
     throw new Errorf(
       'The parameter "path" of "createRequestUrl" ' +
@@ -219,12 +211,6 @@ function createRequestUrl(path, query, hash) {
       query,
     );
   }
-  if (hash != null && typeof hash !== 'string')
-    throw new Errorf(
-      'The parameter "hash" of "createRequestUrl" ' +
-        'should be a String, but %v given.',
-      path,
-    );
   let url = ('/' + path).replace('//', '/');
   if (typeof query === 'object') {
     const qs = queryString.stringify(query);
@@ -232,8 +218,6 @@ function createRequestUrl(path, query, hash) {
   } else if (typeof query === 'string') {
     url += `?${query.replace(/^\?/, '')}`;
   }
-  hash = (hash || '').replace('#', '');
-  if (hash) url += `#${hash}`;
   return url;
 }
 

package/src/utils/create-request-mock.spec.js

@@ -128,26 +128,6 @@ describe('createRequestMock', function () {
     throwable(null)();
   });
 
-  it('requires the parameter "hash" to be a String', function () {
-    const throwable = v => () => createRequestMock({hash: v});
-    const error = v =>
-      format(
-        'The parameter "hash" of "createRequestMock" ' +
-          'should be a String, but %s given.',
-        v,
-      );
-    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([])).to.throw(error('Array'));
-    expect(throwable({})).to.throw(error('Object'));
-    throwable('str')();
-    throwable('')();
-    throwable(undefined)();
-    throwable(null)();
-  });
-
   it('requires the parameter "cookie" to be a String or Object', function () {
     const throwable = v => () => createRequestMock({cookie: v});
     const error = v =>
@@ -289,7 +269,7 @@ describe('createRequestMock', function () {
     expect(req.socket).to.be.instanceof(Socket);
   });
 
-  it('uses the default path "/" without query and hash', function () {
+  it('uses the default path "/" without a query string', function () {
     const req = createRequestMock();
     expect(req.url).to.be.eq('/');
   });
@@ -377,29 +357,17 @@ describe('createRequestMock', function () {
     expect(req.url).to.be.eq('/?p1=foo&p2=bar');
   });
 
-  it('sets the hash value to the request url', async function () {
-    const req = createRequestMock({hash: 'myHash'});
-    expect(req.url).to.be.eq('/#myHash');
-  });
-
-  it('sets the hash value to the request url with the prefix "#"', async function () {
-    const req = createRequestMock({hash: '#myHash'});
-    expect(req.url).to.be.eq('/#myHash');
-  });
-
-  it('set parameters "path", "query" and "hash" to the request url', function () {
+  it('set parameters "path" and "query" to the request url', function () {
     const req1 = createRequestMock({
       path: 'test',
       query: 'p1=foo&p2=bar',
-      hash: 'myHash1',
     });
     const req2 = createRequestMock({
       path: '/test',
       query: {p1: 'baz', p2: 'qux'},
-      hash: '#myHash2',
     });
-    expect(req1.url).to.be.eq('/test?p1=foo&p2=bar#myHash1');
-    expect(req2.url).to.be.eq('/test?p1=baz&p2=qux#myHash2');
+    expect(req1.url).to.be.eq('/test?p1=foo&p2=bar');
+    expect(req2.url).to.be.eq('/test?p1=baz&p2=qux');
   });
 
   it('sets the parameter "method" in uppercase', async function () {

package/src/utils/get-request-pathname.d.ts

@@ -0,0 +1,8 @@
+import {IncomingMessage} from 'http';
+
+/**
+ * Get request pathname.
+ *
+ * @param req
+ */
+export declare function getRequestPathname(req: IncomingMessage): string;

package/src/utils/{get-request-path.js → get-request-pathname.js}

@@ -1,12 +1,12 @@
 import {Errorf} from '@e22m4u/js-format';
 
 /**
- * Get request path.
+ * Get request pathname.
  *
  * @param {import('http').IncomingMessage} req
  * @returns {string}
  */
-export function getRequestPath(req) {
+export function getRequestPathname(req) {
   if (
     !req ||
     typeof req !== 'object' ||
@@ -14,7 +14,7 @@ export function getRequestPath(req) {
     typeof req.url !== 'string'
   ) {
     throw new Errorf(
-      'The first argument of "getRequestPath" should be ' +
+      'The first argument of "getRequestPathname" should be ' +
         'an instance of IncomingMessage, but %v given.',
       req,
     );

package/src/utils/{get-request-path.spec.js → get-request-pathname.spec.js}

@@ -1,13 +1,13 @@
 import {expect} from '../chai.js';
 import {format} from '@e22m4u/js-format';
-import {getRequestPath} from './get-request-path.js';
+import {getRequestPathname} from './get-request-pathname.js';
 
-describe('getRequestPath', function () {
+describe('getRequestPathname', function () {
   it('requires the argument to be an Object with "url" property', function () {
-    const throwable = v => () => getRequestPath(v);
+    const throwable = v => () => getRequestPathname(v);
     const error = v =>
       format(
-        'The first argument of "getRequestPath" should be ' +
+        'The first argument of "getRequestPathname" should be ' +
           'an instance of IncomingMessage, but %s given.',
         v,
       );
@@ -24,8 +24,8 @@ describe('getRequestPath', function () {
     throwable({url: ''})();
   });
 
-  it('returns the request path without query parameters', function () {
-    const res = getRequestPath({url: '/test?foo=bar'});
-    expect(res).to.be.eq('/test');
+  it('returns the request path without the query string', function () {
+    const res = getRequestPathname({url: '/pathname?foo=bar'});
+    expect(res).to.be.eq('/pathname');
   });
 });

package/src/utils/index.d.ts

@@ -4,8 +4,8 @@ export * from './create-error.js';
 export * from './to-camel-case.js';
 export * from './create-debugger.js';
 export * from './is-response-sent.js';
-export * from './get-request-path.js';
 export * from './is-readable-stream.js';
 export * from './is-writable-stream.js';
 export * from './fetch-request-body.js';
 export * from './create-cookie-string.js';
+export * from './get-request-pathname.js';

package/src/utils/index.js

@@ -4,8 +4,8 @@ export * from './create-error.js';
 export * from './to-camel-case.js';
 export * from './create-debugger.js';
 export * from './is-response-sent.js';
-export * from './get-request-path.js';
 export * from './is-readable-stream.js';
 export * from './is-writable-stream.js';
 export * from './fetch-request-body.js';
 export * from './create-cookie-string.js';
+export * from './get-request-pathname.js';

package/src/utils/get-request-path.d.ts

@@ -1,8 +0,0 @@
-import {IncomingMessage} from 'http';
-
-/**
- * Get request path.
- *
- * @param req
- */
-export declare function getRequestPath(req: IncomingMessage): string;