node-server-engine 1.3.2 → 1.3.3

package/.env.example

@@ -170,4 +170,17 @@ SMTP_USER=your-email@example.com
 SMTP_PASS=your-email-password
 
 
-FILE_STORAGE_FOLDER=./uploads
+FILE_STORAGE_FOLDER=./uploads
+
+
+################
+# User Service #
+################
+
+# URL where the user service is located
+USER_SERVICE_URL= 
+
+# Attributes of the users to fetch
+# Comma separated list of attributes to fetch from the user Service 
+# (ex: name,permissions,..) all -> for retrun everything
+USER_FETCHED_ATTRIBUTES=

package/dist/middleware/userResolver/userResolver.d.ts

@@ -1,3 +1,7 @@
 import { Request, Response, NextFunction } from 'express';
 /** Fetch the user previously identified by a JWT and adds his data to the request.user object */
 export declare function userResolver(request: Request, response: Response, next: NextFunction): Promise<void>;
+/**
+ * Call the GET /user/{id} endpoint using TLS
+ */
+export declare function getUserById(userId: number): Promise<unknown>;

package/dist/middleware/userResolver/userResolver.js

@@ -3,9 +3,11 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
+exports.getUserById = getUserById;
 exports.userResolver = userResolver;
 var _EngineError = require("../../entities/EngineError");
 var _utils = require("../../utils");
+var _tlsRequest = require("../../utils/tlsRequest");
 const namespace = 'engine:middleware:userResolver';
 
 /** Fetch the user previously identified by a JWT and adds his data to the request.user object */
@@ -14,10 +16,7 @@ async function userResolver(request, response, next) {
   if (!id) throw new _EngineError.EngineError({
     message: 'Could not resolve user as the request is missing his ID'
   });
-  const user = {
-    user: 'ram',
-    id
-  };
+  const user = await getUserById(id);
   if (!user) throw new _EngineError.EngineError({
     message: 'Could not resolve user as it could not be fetched',
     data: {
@@ -38,4 +37,19 @@ async function userResolver(request, response, next) {
   };
   next();
 }
+
+/**
+ * Call the GET /user/{id} endpoint using TLS
+ */
+async function getUserById(userId) {
+  const userServiceUrl = process.env.USER_SERVICE_URL;
+  if (!userServiceUrl) {
+    throw new Error('USER_SERVICE_URL is not defined in environment variables');
+  }
+  const response = await (0, _tlsRequest.tlsRequest)({
+    method: 'GET',
+    url: `${userServiceUrl}/${userId}`
+  });
+  return response.data;
+}
 //# sourceMappingURL=userResolver.js.map

package/dist/middleware/userResolver/userResolver.js.map

@@ -1 +1 @@
-{"version":3,"file":"userResolver.js","names":["_EngineError","require","_utils","namespace","userResolver","request","response","next","id","user","EngineError","message","data","reportDebug"],"sources":["../../../src/middleware/userResolver/userResolver.ts"],"sourcesContent":["import { Request, Response, NextFunction } from 'express';\nimport { EngineError } from 'entities/EngineError';\nimport { reportDebug } from 'utils';\n\nconst namespace = 'engine:middleware:userResolver';\n\n/** Fetch the user previously identified by a JWT and adds his data to the request.user object */\nexport async function userResolver(\n  request: Request,\n  response: Response,\n  next: NextFunction\n): Promise<void> {\n  const id = request.user?.id;\n  if (!id)\n    throw new EngineError({\n      message: 'Could not resolve user as the request is missing his ID'\n    });\n  const user = { user: 'ram', id };\n  if (!user)\n    throw new EngineError({\n      message: 'Could not resolve user as it could not be fetched',\n      data: { id }\n    });\n  reportDebug({\n    namespace,\n    message: 'Resolved user based on his token',\n    data: { user, request: request.user }\n  });\n  request.user = {\n    ...request?.user,\n    ...user\n  };\n\n  next();\n}\n"],"mappings":";;;;;;AACA,IAAAA,YAAA,GAAAC,OAAA;AACA,IAAAC,MAAA,GAAAD,OAAA;AAEA,MAAME,SAAS,GAAG,gCAAgC;;AAElD;AACO,eAAeC,YAAYA,CAChCC,OAAgB,EAChBC,QAAkB,EAClBC,IAAkB,EACH;EACf,MAAMC,EAAE,GAAGH,OAAO,CAACI,IAAI,EAAED,EAAE;EAC3B,IAAI,CAACA,EAAE,EACL,MAAM,IAAIE,wBAAW,CAAC;IACpBC,OAAO,EAAE;EACX,CAAC,CAAC;EACJ,MAAMF,IAAI,GAAG;IAAEA,IAAI,EAAE,KAAK;IAAED;EAAG,CAAC;EAChC,IAAI,CAACC,IAAI,EACP,MAAM,IAAIC,wBAAW,CAAC;IACpBC,OAAO,EAAE,mDAAmD;IAC5DC,IAAI,EAAE;MAAEJ;IAAG;EACb,CAAC,CAAC;EACJ,IAAAK,kBAAW,EAAC;IACVV,SAAS;IACTQ,OAAO,EAAE,kCAAkC;IAC3CC,IAAI,EAAE;MAAEH,IAAI;MAAEJ,OAAO,EAAEA,OAAO,CAACI;IAAK;EACtC,CAAC,CAAC;EACFJ,OAAO,CAACI,IAAI,GAAG;IACb,GAAGJ,OAAO,EAAEI,IAAI;IAChB,GAAGA;EACL,CAAC;EAEDF,IAAI,CAAC,CAAC;AACR","ignoreList":[]}
+{"version":3,"file":"userResolver.js","names":["_EngineError","require","_utils","_tlsRequest","namespace","userResolver","request","response","next","id","user","EngineError","message","getUserById","data","reportDebug","userId","userServiceUrl","process","env","USER_SERVICE_URL","Error","tlsRequest","method","url"],"sources":["../../../src/middleware/userResolver/userResolver.ts"],"sourcesContent":["import { Request, Response, NextFunction } from 'express';\nimport { EngineError } from 'entities/EngineError';\nimport { reportDebug } from 'utils';\nimport { tlsRequest } from 'utils/tlsRequest';\n\nconst namespace = 'engine:middleware:userResolver';\n\n/** Fetch the user previously identified by a JWT and adds his data to the request.user object */\nexport async function userResolver(\n  request: Request,\n  response: Response,\n  next: NextFunction\n): Promise<void> {\n  const id = request.user?.id;\n  if (!id)\n    throw new EngineError({\n      message: 'Could not resolve user as the request is missing his ID'\n    });\n  const user = await getUserById(id);\n  if (!user)\n    throw new EngineError({\n      message: 'Could not resolve user as it could not be fetched',\n      data: { id }\n    });\n  reportDebug({\n    namespace,\n    message: 'Resolved user based on his token',\n    data: { user, request: request.user }\n  });\n  request.user = {\n    ...request?.user,\n    ...user\n  };\n\n  next();\n}\n\n/**\n * Call the GET /user/{id} endpoint using TLS\n */\nexport async function getUserById(userId: number): Promise<unknown> {\n  const userServiceUrl = process.env.USER_SERVICE_URL;\n  if (!userServiceUrl) {\n    throw new Error('USER_SERVICE_URL is not defined in environment variables');\n  }\n\n  const response = await tlsRequest<unknown>({\n    method: 'GET',\n    url: `${userServiceUrl}/${userId}`\n  });\n\n  return response.data;\n}\n"],"mappings":";;;;;;;AACA,IAAAA,YAAA,GAAAC,OAAA;AACA,IAAAC,MAAA,GAAAD,OAAA;AACA,IAAAE,WAAA,GAAAF,OAAA;AAEA,MAAMG,SAAS,GAAG,gCAAgC;;AAElD;AACO,eAAeC,YAAYA,CAChCC,OAAgB,EAChBC,QAAkB,EAClBC,IAAkB,EACH;EACf,MAAMC,EAAE,GAAGH,OAAO,CAACI,IAAI,EAAED,EAAE;EAC3B,IAAI,CAACA,EAAE,EACL,MAAM,IAAIE,wBAAW,CAAC;IACpBC,OAAO,EAAE;EACX,CAAC,CAAC;EACJ,MAAMF,IAAI,GAAG,MAAMG,WAAW,CAACJ,EAAE,CAAC;EAClC,IAAI,CAACC,IAAI,EACP,MAAM,IAAIC,wBAAW,CAAC;IACpBC,OAAO,EAAE,mDAAmD;IAC5DE,IAAI,EAAE;MAAEL;IAAG;EACb,CAAC,CAAC;EACJ,IAAAM,kBAAW,EAAC;IACVX,SAAS;IACTQ,OAAO,EAAE,kCAAkC;IAC3CE,IAAI,EAAE;MAAEJ,IAAI;MAAEJ,OAAO,EAAEA,OAAO,CAACI;IAAK;EACtC,CAAC,CAAC;EACFJ,OAAO,CAACI,IAAI,GAAG;IACb,GAAGJ,OAAO,EAAEI,IAAI;IAChB,GAAGA;EACL,CAAC;EAEDF,IAAI,CAAC,CAAC;AACR;;AAEA;AACA;AACA;AACO,eAAeK,WAAWA,CAACG,MAAc,EAAoB;EAClE,MAAMC,cAAc,GAAGC,OAAO,CAACC,GAAG,CAACC,gBAAgB;EACnD,IAAI,CAACH,cAAc,EAAE;IACnB,MAAM,IAAII,KAAK,CAAC,0DAA0D,CAAC;EAC7E;EAEA,MAAMd,QAAQ,GAAG,MAAM,IAAAe,sBAAU,EAAU;IACzCC,MAAM,EAAE,KAAK;IACbC,GAAG,EAAE,GAAGP,cAAc,IAAID,MAAM;EAClC,CAAC,CAAC;EAEF,OAAOT,QAAQ,CAACO,IAAI;AACtB","ignoreList":[]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "node-server-engine",
-  "version": "1.3.2",
+  "version": "1.3.3",
   "description": "Framework used to develop backend services. This package ships with a lot of features to standardize the creation of services, letting you focus on the business logic.",
   "main": "dist/index.js",
   "scripts": {

package/src/middleware/userResolver/userResolver.ts

@@ -1,6 +1,7 @@
 import { Request, Response, NextFunction } from 'express';
 import { EngineError } from 'entities/EngineError';
 import { reportDebug } from 'utils';
+import { tlsRequest } from 'utils/tlsRequest';
 
 const namespace = 'engine:middleware:userResolver';
 
@@ -15,7 +16,7 @@ export async function userResolver(
     throw new EngineError({
       message: 'Could not resolve user as the request is missing his ID'
     });
-  const user = { user: 'ram', id };
+  const user = await getUserById(id);
   if (!user)
     throw new EngineError({
       message: 'Could not resolve user as it could not be fetched',
@@ -33,3 +34,20 @@ export async function userResolver(
 
   next();
 }
+
+/**
+ * Call the GET /user/{id} endpoint using TLS
+ */
+export async function getUserById(userId: number): Promise<unknown> {
+  const userServiceUrl = process.env.USER_SERVICE_URL;
+  if (!userServiceUrl) {
+    throw new Error('USER_SERVICE_URL is not defined in environment variables');
+  }
+
+  const response = await tlsRequest<unknown>({
+    method: 'GET',
+    url: `${userServiceUrl}/${userId}`
+  });
+
+  return response.data;
+}

package/src/middleware/userResolver/userResolver.test.ts

@@ -1,35 +0,0 @@
-import { factory } from 'backend-test-tools';
-import { expect } from 'chai';
-import { Request, Response } from 'express';
-import { stub, fake } from 'sinon';
-import { userResolver } from './userResolver';
-
-describe('Middleware - User Resolver', function () {
-  it('should expand the user object with its data using its userId', async function () {
-    const me = factory.build('user');
-    const next = fake();
-    const request: Partial<Request> = { user: { id: me.id } };
-
-    // Call the resolver with the mocked request
-    await userResolver(request as Request, undefined as unknown as Response, next);
-
-    expect(next).to.have.been.called;
-    // expect(request.user).to.deep.equal(me);
-  });
-
-  it('should throw an error if there is no userId', async function () {
-    const me = factory.build('user');
-    const next = fake();
-    const request = {} as Request;
-    await expect(userResolver(request, undefined as unknown as Response, next))
-      .to.eventually.be.rejected;
-  });
-
-  // it('should throw an error if there is no such user', async function () {
-  //   const { id } = factory.build('user');
-  //   const next = fake();
-  //   const request = { user: { id } } as Request;
-  //   await expect(userResolver(request, undefined as unknown as Response, next))
-  //     .to.eventually.be.rejected;
-  // });
-});