@e22m4u/js-trie-router 0.3.6 → 0.3.7

package/README.md

@@ -101,16 +101,17 @@ router.defineRoute({
   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.cookies);  // {foo: 'bar', baz: 'qux'}
-    console.log(ctx.method);   // "GET"
-    console.log(ctx.path);     // "/users/10?include=city"
-    console.log(ctx.pathname); // "/users/10"
-    console.log(ctx.meta);     // {prop: 'value'}
+    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.cookies);   // {foo: 'bar', baz: 'qux'}
+    console.log(ctx.method);    // "GET"
+    console.log(ctx.path);      // "/users/10?include=city"
+    console.log(ctx.pathname);  // "/users/10"
+    console.log(ctx.meta);      // {prop: 'value'}
+    console.log(ctx.container); // ServiceContainer
     // ...
   },
 });

package/dist/cjs/index.cjs

@@ -76,6 +76,25 @@ var import_js_debug = require("@e22m4u/js-debug");
 // src/hooks/hook-invoker.js
 var import_js_format13 = require("@e22m4u/js-format");
 
+// src/debuggable-service.js
+var import_js_service = require("@e22m4u/js-service");
+var MODULE_DEBUG_NAMESPACE = "jsTrieRouter";
+var _DebuggableService = class _DebuggableService extends import_js_service.DebuggableService {
+  /**
+   * Constructor.
+   *
+   * @param {ServiceContainer} container
+   */
+  constructor(container = void 0) {
+    super(container, {
+      namespace: MODULE_DEBUG_NAMESPACE,
+      noEnvironmentNamespace: true
+    });
+  }
+};
+__name(_DebuggableService, "DebuggableService");
+var DebuggableService = _DebuggableService;
+
 // src/utils/clone-deep.js
 function cloneDeep(value) {
   if (value == null || typeof value !== "object") {
@@ -739,25 +758,6 @@ var _HookRegistry = class _HookRegistry {
 __name(_HookRegistry, "HookRegistry");
 var HookRegistry = _HookRegistry;
 
-// src/debuggable-service.js
-var import_js_service = require("@e22m4u/js-service");
-var MODULE_DEBUG_NAMESPACE = "jsTrieRouter";
-var _DebuggableService = class _DebuggableService extends import_js_service.DebuggableService {
-  /**
-   * Constructor.
-   *
-   * @param {ServiceContainer} container
-   */
-  constructor(container = void 0) {
-    super(container, {
-      namespace: MODULE_DEBUG_NAMESPACE,
-      noEnvironmentNamespace: true
-    });
-  }
-};
-__name(_DebuggableService, "DebuggableService");
-var DebuggableService = _DebuggableService;
-
 // src/hooks/hook-invoker.js
 var _HookInvoker = class _HookInvoker extends DebuggableService {
   /**
@@ -788,31 +788,46 @@ var _HookInvoker = class _HookInvoker extends DebuggableService {
         response
       );
     }
+    if (isResponseSent(response)) {
+      return response;
+    }
     const hooks = [
       ...this.getService(HookRegistry).getHooks(hookType),
       ...route.hookRegistry.getHooks(hookType)
     ];
     let result = void 0;
-    for (const hook of hooks) {
+    for (let i = 0; i < hooks.length; i++) {
+      const hook = hooks[i];
+      result = hook(...args);
       if (isResponseSent(response)) {
-        result = response;
-        break;
+        return response;
       }
-      if (result == null) {
-        result = hook(...args);
-      } else if (isPromise(result)) {
-        result = result.then((prevVal) => {
-          if (isResponseSent(response)) {
+      if (result != null) {
+        if (isPromise(result)) {
+          return (async () => {
+            let asyncResult = await result;
+            if (isResponseSent(response)) {
+              return response;
+            }
+            if (asyncResult != null) {
+              return asyncResult;
+            }
+            for (let j = i + 1; j < hooks.length; j++) {
+              asyncResult = await hooks[j](...args);
+              if (isResponseSent(response)) {
+                return response;
+              }
+              if (asyncResult != null) {
+                return asyncResult;
+              }
+            }
             return;
-          }
-          if (prevVal != null) return prevVal;
-          return hook(...args);
-        });
-      } else {
-        break;
+          })();
+        }
+        return result;
       }
     }
-    return result;
+    return;
   }
 };
 __name(_HookInvoker, "HookInvoker");

package/package.json

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

package/src/hooks/hook-invoker.js

@@ -1,10 +1,8 @@
 import {Route} from '../route.js';
 import {Errorf} from '@e22m4u/js-format';
-import {isPromise} from '../utils/index.js';
-import {HookRegistry} from './hook-registry.js';
-import {isResponseSent} from '../utils/index.js';
-import {RouterHookType} from './hook-registry.js';
 import {DebuggableService} from '../debuggable-service.js';
+import {isPromise, isResponseSent} from '../utils/index.js';
+import {HookRegistry, RouterHookType} from './hook-registry.js';
 
 /**
  * Hook invoker.
@@ -49,6 +47,11 @@ export class HookInvoker extends DebuggableService {
         response,
       );
     }
+    // если ответ уже отправлен,
+    // то возвращается ServerResponse
+    if (isResponseSent(response)) {
+      return response;
+    }
     // так как хуки роута выполняются
     // после глобальных, то объединяем
     // их в данной последовательности
@@ -56,48 +59,72 @@ export class HookInvoker extends DebuggableService {
       ...this.getService(HookRegistry).getHooks(hookType),
       ...route.hookRegistry.getHooks(hookType),
     ];
-    // последовательный вызов хуков будет прерван,
-    // если один из них вернет значение (или Promise)
-    // отличное от "undefined" и "null"
     let result = undefined;
-    for (const hook of hooks) {
-      // если ответ уже был отправлен,
-      // то завершаем обход
+    // итерация по хукам выполняется по индексу,
+    // чтобы знать, с какого места продолжать
+    // в асинхронном режиме
+    for (let i = 0; i < hooks.length; i++) {
+      const hook = hooks[i];
+      // вызов хука выполняется
+      // в синхронном режиме
+      result = hook(...args);
+      // если ответ уже отправлен,
+      // то возвращается ServerResponse
       if (isResponseSent(response)) {
-        result = response;
-        break;
-      }
-      // если выполняется первый хук, или предыдущий
-      // хук вернул пустое значение, то выполняем
-      // следующий, записывая возвращаемое
-      // значение в результат
-      if (result == null) {
-        result = hook(...args);
+        return response;
       }
-      // если какой-то из предыдущих хуков вернул
-      // Promise, то последующие значения будут
-      // оборачиваться именно им
-      else if (isPromise(result)) {
-        result = result.then(prevVal => {
-          // если ответ уже был отправлен,
-          // то останавливаем выполнение
-          if (isResponseSent(response)) {
+      // если синхронный вызов хука вернул значение отличное
+      // от undefined и null, то требуется проверить данное
+      // значение для коррекции режима вызова оставшихся хуков
+      if (result != null) {
+        // если синхронный вызов хука вернул Promise, то дальнейшее
+        // выполнение переключается в асинхронный режим, начиная
+        // с индекса следующего хука
+        if (isPromise(result)) {
+          return (async () => {
+            // ожидание Promise, который был получен
+            // на предыдущем шаге (в синхронном режиме)
+            let asyncResult = await result;
+            // если ответ уже отправлен,
+            // то возвращается ServerResponse
+            if (isResponseSent(response)) {
+              return response;
+            }
+            // если Promise разрешился значением отличным
+            // от undefined и null, то данное значение
+            // возвращается в качестве результата
+            if (asyncResult != null) {
+              return asyncResult;
+            }
+            // продолжение вызова хуков начиная
+            // со следующего индекса (асинхронно)
+            for (let j = i + 1; j < hooks.length; j++) {
+              // с этого момента все синхронные
+              // хуки выполняются как асинхронные
+              asyncResult = await hooks[j](...args);
+              // если ответ уже отправлен,
+              // то возвращается ServerResponse
+              if (isResponseSent(response)) {
+                return response;
+              }
+              // если хук вернул значение отличное
+              // от undefined и null, то данное значение
+              // возвращается в качестве результата
+              if (asyncResult != null) {
+                return asyncResult;
+              }
+            }
             return;
-          }
-          // если предыдущий Promise вернул значение
-          // отличное от "undefined" и "null",
-          // то завершаем обход
-          if (prevVal != null) return prevVal;
-          return hook(...args);
-        });
-      }
-      // если предыдущий хук вернул значение
-      // отличное от "undefined" и "null",
-      // то завершаем обход
-      else {
-        break;
+          })();
+        }
+        // если синхронный хук вернул значение отличное
+        // от undefined и null, то данное значение
+        // возвращается в качестве результата
+        return result;
       }
     }
-    return result;
+    // все хуки были синхронными
+    // и не вернули значения
+    return;
   }
 }

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

@@ -234,7 +234,32 @@ describe('HookInvoker', function () {
       ]);
     });
 
-    it('stops global hooks invocation and returns the given response if it was sent', function () {
+    it('returns the given response and should not call hooks if the response is already sent', function () {
+      const s = new HookInvoker();
+      const res = createResponseMock();
+      res._headersSent = true;
+      s.getService(HookRegistry).addHook(RouterHookType.PRE_HANDLER, () => {
+        throw new Error('Should not be called');
+      });
+      const route = new Route({
+        method: HttpMethod.GET,
+        path: '/',
+        preHandler: [
+          () => {
+            throw new Error('Should not be called');
+          },
+        ],
+        handler: () => undefined,
+      });
+      const result = s.invokeAndContinueUntilValueReceived(
+        route,
+        RouterHookType.PRE_HANDLER,
+        res,
+      );
+      expect(result).to.be.eq(res);
+    });
+
+    it('stops global hooks invocation and returns the given response if it is already sent', function () {
       const s = new HookInvoker();
       const order = [];
       const res = createResponseMock();
@@ -270,7 +295,7 @@ describe('HookInvoker', function () {
       expect(order).to.be.eql(['globalHook1', 'globalHook2']);
     });
 
-    it('stops route hooks invocation and returns the given response if it was sent', function () {
+    it('stops route hooks invocation and returns the given response if it is already sent', function () {
       const s = new HookInvoker();
       const order = [];
       const res = createResponseMock();

package/src/route.d.ts

@@ -39,7 +39,9 @@ export type RoutePostHandler<T = unknown, U = unknown> = (
 /**
  * Route meta.
  */
-export type RouteMeta = Record<PropertyKey, any>;
+export type RouteMeta = {
+  [key: string]: unknown;
+};
 
 /**
  * Route definition.

package/src/route.spec.js

@@ -370,14 +370,13 @@ describe('Route', function () {
 
   describe('handle', function () {
     it('invokes the handler with the given RequestContext and return its result', function () {
-      const handler = ctx => {
-        expect(ctx).to.be.instanceof(RequestContext);
-        return 'OK';
-      };
       const route = new Route({
         method: HttpMethod.GET,
         path: '/',
-        handler,
+        handler(ctx) {
+          expect(ctx).to.be.instanceof(RequestContext);
+          return 'OK';
+        },
       });
       const req = createRequestMock();
       const res = createResponseMock();