@e22m4u/ts-rest-router 0.4.3 → 0.5.0

package/README.md

@@ -209,6 +209,7 @@ class UserController {
 - `@requestCookie` - определенный cookie запроса;
 - `@requestCookies` - все cookies запроса как объект;
 - `@requestContext` - доступ к контексту запроса;
+- `@requestContainer` - сервис-контейнер запроса;
 - `@requestData` - доступ к данным запроса;
 - `@httpRequest` - экземпляр `IncomingMessage`;
 - `@httpResponse` - экземпляр `ServerResponse`;

package/dist/cjs/index.cjs

@@ -51,6 +51,7 @@ __export(index_exports, {
   postAction: () => postAction,
   putAction: () => putAction,
   requestBody: () => requestBody,
+  requestContainer: () => requestContainer,
   requestContext: () => requestContext,
   requestCookie: () => requestCookie,
   requestCookies: () => requestCookies,
@@ -602,6 +603,10 @@ function httpResponse() {
   return requestContext("res");
 }
 __name(httpResponse, "httpResponse");
+function requestContainer() {
+  return requestContext("container");
+}
+__name(requestContainer, "requestContainer");
 
 // dist/esm/controller-registry.js
 var import_ts_data_schema4 = require("@e22m4u/ts-data-schema");
@@ -955,7 +960,9 @@ var _ControllerRegistry = class _ControllerRegistry extends DebuggableService {
           debug("No RequestDataMetadata specified for %v argument.", index);
         }
       });
-      const controller = this.getService(controllerCtor);
+      if (requestContext2.container.has(controllerCtor))
+        throw new import_js_format3.Errorf("The controller %v is already registered, which breaks controller isolation per request.", controllerCtor.name);
+      const controller = requestContext2.container.get(controllerCtor);
       return controller[actionName](...args);
     };
   }
@@ -1016,6 +1023,7 @@ var RestRouter = _RestRouter;
   postAction,
   putAction,
   requestBody,
+  requestContainer,
   requestContext,
   requestCookie,
   requestCookies,

package/dist/esm/controller-registry.js

@@ -417,7 +417,10 @@ export class ControllerRegistry extends DebuggableService {
                 }
             });
             // выполнение операции контроллера
-            const controller = this.getService(controllerCtor);
+            if (requestContext.container.has(controllerCtor))
+                throw new Errorf('The controller %v is already registered, which breaks ' +
+                    'controller isolation per request.', controllerCtor.name);
+            const controller = requestContext.container.get(controllerCtor);
             return controller[actionName](...args);
         };
     }

package/dist/esm/decorators/request-context/request-context-decorator.d.ts

@@ -14,3 +14,7 @@ export declare function httpRequest(): (target: Prototype<object>, propertyKey:
  * HttpResponse decorator.
  */
 export declare function httpResponse(): (target: Prototype<object>, propertyKey: string, indexOrDescriptor: number) => void;
+/**
+ * RequestContainer decorator.
+ */
+export declare function requestContainer(): (target: Prototype<object>, propertyKey: string, indexOrDescriptor: number) => void;

package/dist/esm/decorators/request-context/request-context-decorator.js

@@ -27,3 +27,9 @@ export function httpRequest() {
 export function httpResponse() {
     return requestContext('res');
 }
+/**
+ * RequestContainer decorator.
+ */
+export function requestContainer() {
+    return requestContext('container');
+}

package/dist/esm/decorators/request-context/request-context-decorator.spec.js

@@ -15,13 +15,10 @@ import { expect } from 'chai';
 import { httpRequest } from './request-context-decorator.js';
 import { httpResponse } from './request-context-decorator.js';
 import { requestContext } from './request-context-decorator.js';
+import { requestContainer } from './request-context-decorator.js';
 import { RequestContextReflector } from './request-context-reflector.js';
 describe('requestContext', function () {
-    it('has aliases', function () {
-        expect(httpRequest).to.be.instanceOf(Function);
-        expect(httpResponse).to.be.instanceOf(Function);
-    });
-    it('does not require options', function () {
+    it('should not require options', function () {
         class Target {
             method(prop) { }
         }
@@ -34,7 +31,7 @@ describe('requestContext', function () {
         const res = RequestContextReflector.getMetadata(Target, 'method');
         expect(res.get(0)).to.be.eql({ property: undefined });
     });
-    it('sets a given property to the target metadata', function () {
+    it('should set the given property to target metadata', function () {
         class Target {
             method(prop) { }
         }
@@ -47,4 +44,49 @@ describe('requestContext', function () {
         const res = RequestContextReflector.getMetadata(Target, 'method');
         expect(res.get(0)).to.be.eql({ property: 'res' });
     });
+    describe('httpRequest', function () {
+        it('should set the "req" property to target metadata', function () {
+            class Target {
+                method(prop) { }
+            }
+            __decorate([
+                __param(0, httpRequest()),
+                __metadata("design:type", Function),
+                __metadata("design:paramtypes", [Object]),
+                __metadata("design:returntype", void 0)
+            ], Target.prototype, "method", null);
+            const res = RequestContextReflector.getMetadata(Target, 'method');
+            expect(res.get(0)).to.be.eql({ property: 'req' });
+        });
+    });
+    describe('httpResponse', function () {
+        it('should set the "res" property to target metadata', function () {
+            class Target {
+                method(prop) { }
+            }
+            __decorate([
+                __param(0, httpResponse()),
+                __metadata("design:type", Function),
+                __metadata("design:paramtypes", [Object]),
+                __metadata("design:returntype", void 0)
+            ], Target.prototype, "method", null);
+            const res = RequestContextReflector.getMetadata(Target, 'method');
+            expect(res.get(0)).to.be.eql({ property: 'res' });
+        });
+    });
+    describe('requestContainer', function () {
+        it('should set the "container" property to target metadata', function () {
+            class Target {
+                method(prop) { }
+            }
+            __decorate([
+                __param(0, requestContainer()),
+                __metadata("design:type", Function),
+                __metadata("design:paramtypes", [Object]),
+                __metadata("design:returntype", void 0)
+            ], Target.prototype, "method", null);
+            const res = RequestContextReflector.getMetadata(Target, 'method');
+            expect(res.get(0)).to.be.eql({ property: 'container' });
+        });
+    });
 });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@e22m4u/ts-rest-router",
-  "version": "0.4.3",
+  "version": "0.5.0",
   "description": "REST маршрутизатор на основе контроллеров для TypeScript",
   "author": "Mikhail Evstropov <e22m4u@yandex.ru>",
   "license": "MIT",

package/src/controller-registry.spec.ts

@@ -13,6 +13,7 @@ import {
   RouteRegistry,
   TrieRouter,
 } from '@e22m4u/js-trie-router';
+
 import {
   afterAction,
   beforeAction,
@@ -34,6 +35,7 @@ import {
 import {expect} from 'chai';
 import {DataType} from '@e22m4u/ts-data-schema';
 import {ControllerRegistry} from './controller-registry.js';
+import {Service, ServiceContainer} from '@e22m4u/js-service';
 
 const PRE_HANDLER_1 = () => undefined;
 const PRE_HANDLER_2 = () => undefined;
@@ -969,5 +971,73 @@ describe('ControllerRegistry', function () {
       await handler(ctx);
       expect(invoked).to.be.true;
     });
+
+    it('should create a new controller instance for each request', async function () {
+      @restController()
+      class MyStatefulController {
+        public readonly instanceId: number;
+        constructor() {
+          this.instanceId = Math.random();
+        }
+        @getAction('/test')
+        myAction() {
+          return this;
+        }
+      }
+      const S = new ControllerRegistry();
+      S.addController(MyStatefulController);
+      // поиск обработчика
+      const router = S.getService(RouteRegistry);
+      const req = createRequestMock({method: HttpMethod.GET, path: '/test'});
+      const matching = router.matchRouteByRequest(req);
+      const handler = matching!.route.handler;
+      // симуляция первого запроса
+      const req1 = createRequestMock();
+      const res1 = createResponseMock();
+      const cont1 = new ServiceContainer(S.container);
+      const ctx1 = new RequestContext(cont1, req1, res1);
+      const controllerInstance1 = (await handler(ctx1)) as MyStatefulController;
+      // симуляция второго запроса
+      const req2 = createRequestMock();
+      const res2 = createResponseMock();
+      const cont2 = new ServiceContainer(S.container);
+      const ctx2 = new RequestContext(cont2, req2, res2);
+      const controllerInstance2 = (await handler(ctx2)) as MyStatefulController;
+      // проверка, что это два разных экземпляра
+      expect(controllerInstance1).to.be.instanceOf(MyStatefulController);
+      expect(controllerInstance2).to.be.instanceOf(MyStatefulController);
+      expect(controllerInstance1).to.not.equal(controllerInstance2);
+      expect(controllerInstance1.instanceId).to.not.equal(
+        controllerInstance2.instanceId,
+        'Controller instance IDs should be different',
+      );
+    });
+
+    it('should create controller using a request-scoped container parented by the application container', async function () {
+      let counter = 0;
+      const appContainer = new ServiceContainer();
+      @restController()
+      class MyStatefulController extends Service {
+        @getAction('/test')
+        myAction() {
+          expect(this.container).to.be.not.eq(appContainer);
+          expect(this.container.getParent()).to.be.eq(appContainer);
+          counter++;
+        }
+      }
+      const S = new ControllerRegistry(appContainer);
+      S.addController(MyStatefulController);
+      // поиск обработчика
+      const router = S.getService(RouteRegistry);
+      const req = createRequestMock({method: HttpMethod.GET, path: '/test'});
+      const matching = router.matchRouteByRequest(req);
+      const handler = matching!.route.handler;
+      // симуляция запроса
+      const res = createResponseMock();
+      const cont1 = new ServiceContainer(S.container);
+      const ctx1 = new RequestContext(cont1, req, res);
+      await handler(ctx1);
+      expect(counter).to.be.eq(1);
+    });
   });
 });

package/src/controller-registry.ts

@@ -501,7 +501,13 @@ export class ControllerRegistry extends DebuggableService {
           }
         });
       // выполнение операции контроллера
-      const controller = this.getService(controllerCtor);
+      if (requestContext.container.has(controllerCtor))
+        throw new Errorf(
+          'The controller %v is already registered, which breaks ' +
+            'controller isolation per request.',
+          controllerCtor.name,
+        );
+      const controller = requestContext.container.get(controllerCtor);
       return (controller as AnyObject)[actionName](...args);
     };
   }

package/src/decorators/request-context/request-context-decorator.spec.ts

@@ -3,15 +3,11 @@ import {expect} from 'chai';
 import {httpRequest} from './request-context-decorator.js';
 import {httpResponse} from './request-context-decorator.js';
 import {requestContext} from './request-context-decorator.js';
+import {requestContainer} from './request-context-decorator.js';
 import {RequestContextReflector} from './request-context-reflector.js';
 
 describe('requestContext', function () {
-  it('has aliases', function () {
-    expect(httpRequest).to.be.instanceOf(Function);
-    expect(httpResponse).to.be.instanceOf(Function);
-  });
-
-  it('does not require options', function () {
+  it('should not require options', function () {
     class Target {
       method(
         @requestContext()
@@ -22,7 +18,7 @@ describe('requestContext', function () {
     expect(res.get(0)).to.be.eql({property: undefined});
   });
 
-  it('sets a given property to the target metadata', function () {
+  it('should set the given property to target metadata', function () {
     class Target {
       method(
         @requestContext('res')
@@ -32,4 +28,43 @@ describe('requestContext', function () {
     const res = RequestContextReflector.getMetadata(Target, 'method');
     expect(res.get(0)).to.be.eql({property: 'res'});
   });
+
+  describe('httpRequest', function () {
+    it('should set the "req" property to target metadata', function () {
+      class Target {
+        method(
+          @httpRequest()
+          prop: unknown,
+        ) {}
+      }
+      const res = RequestContextReflector.getMetadata(Target, 'method');
+      expect(res.get(0)).to.be.eql({property: 'req'});
+    });
+  });
+
+  describe('httpResponse', function () {
+    it('should set the "res" property to target metadata', function () {
+      class Target {
+        method(
+          @httpResponse()
+          prop: unknown,
+        ) {}
+      }
+      const res = RequestContextReflector.getMetadata(Target, 'method');
+      expect(res.get(0)).to.be.eql({property: 'res'});
+    });
+  });
+
+  describe('requestContainer', function () {
+    it('should set the "container" property to target metadata', function () {
+      class Target {
+        method(
+          @requestContainer()
+          prop: unknown,
+        ) {}
+      }
+      const res = RequestContextReflector.getMetadata(Target, 'method');
+      expect(res.get(0)).to.be.eql({property: 'container'});
+    });
+  });
 });

package/src/decorators/request-context/request-context-decorator.ts

@@ -50,3 +50,10 @@ export function httpRequest() {
 export function httpResponse() {
   return requestContext('res');
 }
+
+/**
+ * RequestContainer decorator.
+ */
+export function requestContainer() {
+  return requestContext('container');
+}