@e22m4u/js-trie-router 0.2.0 → 0.3.0

package/src/trie-router.js

@@ -1,5 +1,5 @@
 import {HookType} from './hooks/index.js';
-import {isPromise} from './utils/index.js';
+import {isPromise, isResponseSent} from './utils/index.js';
 import {HookInvoker} from './hooks/index.js';
 import {DataSender} from './senders/index.js';
 import {HookRegistry} from './hooks/index.js';
@@ -31,11 +31,11 @@ export class TrieRouter extends DebuggableService {
    * ```
    * const router = new TrieRouter();
    * router.defineRoute({
-   *   method: HttpMethod.POST,       // Request method.
+   *   method: HttpMethod.POST,        // Request method.
    *   path: '/users/:id',             // The path template may have parameters.
-   *   preHandler(ctx) { ... },        // The "preHandler" is executed before a route handler.
+   *   preHandler(ctx) { ... },        // The "preHandler" executes 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" executes after a route handler.
    * });
    * ```
    *
@@ -75,11 +75,16 @@ export class TrieRouter extends DebuggableService {
    * @private
    */
   async _handleRequest(req, res) {
+    const debug = this.getDebuggerFor(this._handleRequest);
     const requestPath = (req.url || '/').replace(/\?.*$/, '');
-    this.debug('Preparing to handle %s %v.', req.method, requestPath);
+    debug(
+      'Preparing to handle an incoming request %s %v.',
+      req.method,
+      requestPath,
+    );
     const resolved = this.getService(RouteRegistry).matchRouteByRequest(req);
     if (!resolved) {
-      this.debug('No route for the request %s %v.', req.method, requestPath);
+      debug('No route for the request %s %v.', req.method, requestPath);
       this.getService(ErrorSender).send404(req, res);
     } else {
       const {route, params} = resolved;
@@ -95,27 +100,28 @@ export class TrieRouter extends DebuggableService {
       // так как они были определены в момент
       // поиска подходящего роута
       context.params = params;
-      // разбор тела, заголовков и других данных
-      // запроса выполняется отдельным сервисом,
-      // после чего результат записывается
-      // в контекст передаваемый обработчику
-      const reqDataOrPromise = this.getService(RequestParser).parse(req);
-      // результат разбора может являться асинхронным,
-      // и вместо того, что бы разрывать поток выполнения,
-      // стоит проверить, действительно ли необходимо
-      // использование оператора "await"
-      if (isPromise(reqDataOrPromise)) {
-        const reqData = await reqDataOrPromise;
-        Object.assign(context, reqData);
-      } else {
-        Object.assign(context, reqDataOrPromise);
-      }
-      // получение данных от обработчика, который
-      // находится в найденном роуте, и отправка
-      // результата в качестве ответа сервера
-      let data, error;
-      const hookInvoker = this.getService(HookInvoker);
+      // при разборе входящих данных и выполнении обработчиков
+      // запроса, требуется перехватывать возможные ошибки
+      // для корректной отправки сервисом ErrorSender
+      let data;
       try {
+        // разбор тела, заголовков и других данных запроса
+        // выполняется отдельным сервисом, после чего результат
+        // записывается в контекст передаваемый обработчику
+        const reqDataOrPromise = this.getService(RequestParser).parse(req);
+        // результат разбора может являться асинхронным, и вместо
+        // того, что бы разрывать поток выполнения, стоит проверить,
+        // действительно ли необходимо использование оператора "await"
+        if (isPromise(reqDataOrPromise)) {
+          const reqData = await reqDataOrPromise;
+          Object.assign(context, reqData);
+        } else {
+          Object.assign(context, reqDataOrPromise);
+        }
+        // получение данных от обработчика, который находится
+        // в найденном маршруте, и отправка результата в качестве
+        // ответа сервера
+        const hookInvoker = this.getService(HookInvoker);
         // если результатом вызова хуков "preHandler" является
         // значение (или Promise) отличное от "undefined" и "null",
         // то такое значение используется в качестве ответа
@@ -126,15 +132,15 @@ export class TrieRouter extends DebuggableService {
           context,
         );
         if (isPromise(data)) data = await data;
-        // если ответ не определен хуками "preHandler",
-        // то вызывается обработчик роута, результат
-        // которого передается в хуки "postHandler"
-        if (data == null) {
+        // если ответ не бы отправлен внутри "preHandler" хуков,
+        // и сами "preHandler" хуки не вернули значения, то вызывается
+        // основной обработчик маршрута, результат которого передается
+        // в хуки "postHandler"
+        if (!isResponseSent(res) && data == null) {
           data = route.handle(context);
           if (isPromise(data)) data = await data;
-          // вызываются хуки "postHandler", результат
-          // которых также может быть использован
-          // в качестве ответа
+          // вызываются хуки "postHandler", результат которых
+          // также может быть использован в качестве ответа
           let postHandlerData = hookInvoker.invokeAndContinueUntilValueReceived(
             route,
             HookType.POST_HANDLER,
@@ -146,12 +152,14 @@ export class TrieRouter extends DebuggableService {
             postHandlerData = await postHandlerData;
           if (postHandlerData != null) data = postHandlerData;
         }
-      } catch (err) {
-        error = err;
-      }
-      if (error) {
+      } catch (error) {
         this.getService(ErrorSender).send(req, res, error);
-      } else {
+        return;
+      }
+      // если ответ не был отправлен во время выполнения
+      // хуков и основного обработчика запроса,
+      // то результат передается в DataSender
+      if (!isResponseSent(res)) {
         this.getService(DataSender).send(res, data);
       }
     }

package/src/trie-router.spec.js

@@ -75,13 +75,13 @@ describe('TrieRouter', function () {
       router.requestListener(req, res);
     });
 
-    it('passes parsed cookie to the request context', function (done) {
+    it('passes parsed cookies to the request context', function (done) {
       const router = new TrieRouter();
       router.defineRoute({
         method: HttpMethod.GET,
         path: '/',
-        handler: ({cookie}) => {
-          expect(cookie).to.be.eql({p1: 'foo', p2: 'bar'});
+        handler: ({cookies}) => {
+          expect(cookies).to.be.eql({p1: 'foo', p2: 'bar'});
           done();
         },
       });
@@ -472,6 +472,57 @@ describe('TrieRouter', function () {
       const res = createResponseMock();
       router.requestListener(req, res);
     });
+
+    it('should send parsing error response instead of throwing error', async function () {
+      const router = new TrieRouter();
+      router.defineRoute({
+        method: HttpMethod.POST,
+        path: '/',
+        handler() {},
+      });
+      const req = createRequestMock({
+        method: HttpMethod.POST,
+        headers: {'content-type': 'application/json'},
+        body: 'invalid',
+      });
+      const res = createResponseMock();
+      router.requestListener(req, res);
+      const body = await res.getBody();
+      expect(res.statusCode).to.be.eq(400);
+      expect(JSON.parse(body)).to.be.eql({
+        error: {
+          message: `Unexpected token 'i', "invalid" is not valid JSON`,
+        },
+      });
+    });
+
+    it('should not invoke the main handler if a preHandler sends the response asynchronously', async function () {
+      let handlerCalled = false;
+      const router = new TrieRouter();
+      router.defineRoute({
+        method: 'GET',
+        path: '/',
+        preHandler(ctx) {
+          return new Promise(resolve => {
+            setTimeout(() => {
+              ctx.res.setHeader('Content-Type', 'text/plain');
+              ctx.res.end('Response from preHandler');
+              resolve(undefined);
+            }, 10);
+          });
+        },
+        handler() {
+          handlerCalled = true;
+          return 'Response from main handler';
+        },
+      });
+      const req = createRequestMock({method: 'GET', path: '/'});
+      const res = createResponseMock();
+      await router._handleRequest(req, res);
+      const responseBody = await res.getBody();
+      expect(responseBody).to.equal('Response from preHandler');
+      expect(handlerCalled).to.be.false;
+    });
   });
 
   describe('addHook', function () {

package/src/utils/create-cookies-string.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Create cookies string.
+ *
+ * @param data
+ */
+export declare function createCookiesString(data: object): string;

package/src/utils/{create-cookie-string.js → create-cookies-string.js}

@@ -1,16 +1,16 @@
 import {Errorf} from '@e22m4u/js-format';
 
 /**
- * Create cookie string.
+ * Create cookies string.
  *
  * @param {object} data
  * @returns {string}
  */
-export function createCookieString(data) {
+export function createCookiesString(data) {
   if (!data || typeof data !== 'object' || Array.isArray(data))
     throw new Errorf(
-      'The first parameter of "createCookieString" should be ' +
-        'an Object, but %v given.',
+      'The first parameter of "createCookiesString" should be ' +
+        'an Object, but %v was given.',
       data,
     );
   let cookies = '';

package/src/utils/{create-cookie-string.spec.js → create-cookies-string.spec.js}

@@ -1,14 +1,14 @@
 import {expect} from '../chai.js';
 import {format} from '@e22m4u/js-format';
-import {createCookieString} from './create-cookie-string.js';
+import {createCookiesString} from './create-cookies-string.js';
 
-describe('createCookieString', function () {
+describe('createCookiesString', function () {
   it('requires the first argument to be an object', function () {
-    const throwable = v => () => createCookieString(v);
+    const throwable = v => () => createCookiesString(v);
     const error = v =>
       format(
-        'The first parameter of "createCookieString" should be ' +
-          'an Object, but %s given.',
+        'The first parameter of "createCookiesString" should be ' +
+          'an Object, but %s was given.',
         v,
       );
     expect(throwable('str')).to.throw(error('"str"'));
@@ -25,12 +25,12 @@ describe('createCookieString', function () {
   });
 
   it('returns an empty string if no keys', function () {
-    expect(createCookieString({})).to.be.eq('');
+    expect(createCookiesString({})).to.be.eq('');
   });
 
   it('returns a cookies string from a given object', function () {
     const data = {foo: 'bar', baz: 'quz'};
-    const result = createCookieString(data);
+    const result = createCookiesString(data);
     expect(result).to.be.eq('foo=bar; baz=quz;');
   });
 });

package/src/utils/create-debugger.js

@@ -11,7 +11,7 @@ export function createDebugger(name) {
   if (typeof name !== 'string')
     throw new Errorf(
       'The first argument of "createDebugger" should be ' +
-        'a String, but %v given.',
+        'a String, but %v was given.',
       name,
     );
   const debug = DebugFactory(`jsTrieRouter:${name}`);

package/src/utils/create-debugger.spec.js

@@ -8,7 +8,7 @@ describe('createDebugger', function () {
     const error = v =>
       format(
         'The first argument of "createDebugger" should be ' +
-          'a String, but %s given.',
+          'a String, but %s was given.',
         v,
       );
     expect(throwable(10)).to.throw(error('10'));

package/src/utils/create-error.js

@@ -13,13 +13,13 @@ export function createError(errorCtor, message, ...args) {
   if (typeof errorCtor !== 'function')
     throw new Errorf(
       'The first argument of "createError" should be ' +
-        'a constructor, but %v given.',
+        'a constructor, but %v was given.',
       errorCtor,
     );
   if (message != null && typeof message !== 'string')
     throw new Errorf(
       'The second argument of "createError" should be ' +
-        'a String, but %v given.',
+        'a String, but %v was given.',
       message,
     );
   if (message == null) return new errorCtor();

package/src/utils/create-error.spec.js

@@ -8,7 +8,7 @@ describe('createError', function () {
     const error = v =>
       format(
         'The first argument of "createError" should be ' +
-          'a constructor, but %s given.',
+          'a constructor, but %s was given.',
         v,
       );
     expect(throwable('str')).to.throw(error('"str"'));
@@ -29,7 +29,7 @@ describe('createError', function () {
     const error = v =>
       format(
         'The second argument of "createError" should be ' +
-          'a String, but %s given.',
+          'a String, but %s was given.',
         v,
       );
     expect(throwable(10)).to.throw(error('10'));

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

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

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

@@ -4,8 +4,8 @@ import {IncomingMessage} from 'http';
 import queryString from 'querystring';
 import {Errorf} from '@e22m4u/js-format';
 import {isReadableStream} from './is-readable-stream.js';
-import {createCookieString} from './create-cookie-string.js';
-import {BUFFER_ENCODING_LIST} from './fetch-request-body.js';
+import {createCookiesString} from './create-cookies-string.js';
+import {CHARACTER_ENCODING_LIST} from './fetch-request-body.js';
 
 /**
  * @typedef {{
@@ -14,7 +14,7 @@ import {BUFFER_ENCODING_LIST} from './fetch-request-body.js';
  *   secure?: boolean;
  *   path?: string;
  *   query?: object;
- *   cookie?: object;
+ *   cookies?: object;
  *   headers?: object;
  *   body?: string;
  *   stream?: import('stream').Readable;
@@ -32,7 +32,7 @@ export function createRequestMock(patch) {
   if ((patch != null && typeof patch !== 'object') || Array.isArray(patch)) {
     throw new Errorf(
       'The first parameter of "createRequestMock" ' +
-        'should be an Object, but %v given.',
+        'should be an Object, but %v was given.',
       patch,
     );
   }
@@ -40,25 +40,25 @@ export function createRequestMock(patch) {
   if (patch.host != null && typeof patch.host !== 'string')
     throw new Errorf(
       'The parameter "host" of "createRequestMock" ' +
-        'should be a String, but %v given.',
+        'should be a String, but %v was given.',
       patch.host,
     );
   if (patch.method != null && typeof patch.method !== 'string')
     throw new Errorf(
       'The parameter "method" of "createRequestMock" ' +
-        'should be a String, but %v given.',
+        'should be a String, but %v was given.',
       patch.method,
     );
   if (patch.secure != null && typeof patch.secure !== 'boolean')
     throw new Errorf(
       'The parameter "secure" of "createRequestMock" ' +
-        'should be a Boolean, but %v given.',
+        'should be a Boolean, but %v was given.',
       patch.secure,
     );
   if (patch.path != null && typeof patch.path !== 'string')
     throw new Errorf(
       'The parameter "path" of "createRequestMock" ' +
-        'should be a String, but %v given.',
+        'should be a String, but %v was given.',
       patch.path,
     );
   if (
@@ -69,20 +69,20 @@ export function createRequestMock(patch) {
   ) {
     throw new Errorf(
       'The parameter "query" of "createRequestMock" ' +
-        'should be a String or Object, but %v given.',
+        'should be a String or Object, but %v was given.',
       patch.query,
     );
   }
   if (
-    (patch.cookie != null &&
-      typeof patch.cookie !== 'string' &&
-      typeof patch.cookie !== 'object') ||
-    Array.isArray(patch.cookie)
+    (patch.cookies != null &&
+      typeof patch.cookies !== 'string' &&
+      typeof patch.cookies !== 'object') ||
+    Array.isArray(patch.cookies)
   ) {
     throw new Errorf(
-      'The parameter "cookie" of "createRequestMock" ' +
-        'should be a String or Object, but %v given.',
-      patch.cookie,
+      'The parameter "cookies" of "createRequestMock" ' +
+        'should be a String or Object, but %v was given.',
+      patch.cookies,
     );
   }
   if (
@@ -91,25 +91,28 @@ export function createRequestMock(patch) {
   ) {
     throw new Errorf(
       'The parameter "headers" of "createRequestMock" ' +
-        'should be an Object, but %v given.',
+        'should be an Object, but %v was given.',
       patch.headers,
     );
   }
   if (patch.stream != null && !isReadableStream(patch.stream))
     throw new Errorf(
       'The parameter "stream" of "createRequestMock" ' +
-        'should be a Stream, but %v given.',
+        'should be a Stream, but %v was given.',
       patch.stream,
     );
   if (patch.encoding != null) {
     if (typeof patch.encoding !== 'string')
       throw new Errorf(
         'The parameter "encoding" of "createRequestMock" ' +
-          'should be a String, but %v given.',
+          'should be a String, but %v was given.',
+        patch.encoding,
+      );
+    if (!CHARACTER_ENCODING_LIST.includes(patch.encoding))
+      throw new Errorf(
+        'Character encoding %v is not supported.',
         patch.encoding,
       );
-    if (!BUFFER_ENCODING_LIST.includes(patch.encoding))
-      throw new Errorf('Buffer encoding %v is not supported.', patch.encoding);
   }
   // если передан поток, выполняется
   // проверка на несовместимые опции
@@ -141,7 +144,7 @@ export function createRequestMock(patch) {
     patch.host,
     patch.secure,
     patch.body,
-    patch.cookie,
+    patch.cookies,
     patch.encoding,
     patch.headers,
   );
@@ -161,7 +164,7 @@ function createRequestStream(secure, body, encoding) {
   if (encoding != null && typeof encoding !== 'string')
     throw new Errorf(
       'The parameter "encoding" of "createRequestStream" ' +
-        'should be a String, but %v given.',
+        'should be a String, but %v was given.',
       encoding,
     );
   encoding = encoding || 'utf-8';
@@ -198,7 +201,7 @@ function createRequestUrl(path, query) {
   if (typeof path !== 'string')
     throw new Errorf(
       'The parameter "path" of "createRequestUrl" ' +
-        'should be a String, but %v given.',
+        'should be a String, but %v was given.',
       path,
     );
   if (
@@ -207,7 +210,7 @@ function createRequestUrl(path, query) {
   ) {
     throw new Errorf(
       'The parameter "query" of "createRequestUrl" ' +
-        'should be a String or Object, but %v given.',
+        'should be a String or Object, but %v was given.',
       query,
     );
   }
@@ -227,36 +230,36 @@ function createRequestUrl(path, query) {
  * @param {string|null|undefined} host
  * @param {boolean|null|undefined} secure
  * @param {*} body
- * @param {string|object|null|undefined} cookie
+ * @param {string|object|null|undefined} cookies
  * @param {import('buffer').BufferEncoding|null|undefined} encoding
  * @param {object|null|undefined} headers
  * @returns {object}
  */
-function createRequestHeaders(host, secure, body, cookie, encoding, headers) {
+function createRequestHeaders(host, secure, body, cookies, encoding, headers) {
   if (host != null && typeof host !== 'string')
     throw new Errorf(
       'The parameter "host" of "createRequestHeaders" ' +
-        'a non-empty String, but %v given.',
+        'a non-empty String, but %v was given.',
       host,
     );
   host = host || 'localhost';
   if (secure != null && typeof secure !== 'boolean')
     throw new Errorf(
       'The parameter "secure" of "createRequestHeaders" ' +
-        'should be a String, but %v given.',
+        'should be a String, but %v was given.',
       secure,
     );
   secure = Boolean(secure);
   if (
-    (cookie != null &&
-      typeof cookie !== 'object' &&
-      typeof cookie !== 'string') ||
-    Array.isArray(cookie)
+    (cookies != null &&
+      typeof cookies !== 'object' &&
+      typeof cookies !== 'string') ||
+    Array.isArray(cookies)
   ) {
     throw new Errorf(
-      'The parameter "cookie" of "createRequestHeaders" ' +
-        'should be a String or Object, but %v given.',
-      cookie,
+      'The parameter "cookies" of "createRequestHeaders" ' +
+        'should be a String or Object, but %v was given.',
+      cookies,
     );
   }
   if (
@@ -265,7 +268,7 @@ function createRequestHeaders(host, secure, body, cookie, encoding, headers) {
   ) {
     throw new Errorf(
       'The parameter "headers" of "createRequestHeaders" ' +
-        'should be an Object, but %v given.',
+        'should be an Object, but %v was given.',
       headers,
     );
   }
@@ -273,7 +276,7 @@ function createRequestHeaders(host, secure, body, cookie, encoding, headers) {
   if (encoding != null && typeof encoding !== 'string')
     throw new Errorf(
       'The parameter "encoding" of "createRequestHeaders" ' +
-        'should be a String, but %v given.',
+        'should be a String, but %v was given.',
       encoding,
     );
   encoding = encoding || 'utf-8';
@@ -282,13 +285,14 @@ function createRequestHeaders(host, secure, body, cookie, encoding, headers) {
   if (secure) obj['x-forwarded-proto'] = 'https';
   // формирование заголовка Cookie
   // из строки или объекта
-  if (cookie != null) {
-    if (typeof cookie === 'string') {
+  if (cookies != null) {
+    if (typeof cookies === 'string') {
       obj['cookie'] = obj['cookie'] ? obj['cookie'] : '';
-      obj['cookie'] += cookie;
-    } else if (typeof cookie === 'object') {
+      obj['cookie'] += obj['cookie'] ? `; ${cookies}` : cookies;
+    } else if (typeof cookies === 'object') {
       obj['cookie'] = obj['cookie'] ? obj['cookie'] : '';
-      obj['cookie'] += createCookieString(cookie);
+      const newCookies = createCookiesString(cookies);
+      obj['cookie'] += obj['cookie'] ? `; ${newCookies}` : newCookies;
     }
   }
   // установка заголовка "content-type"