@adaptivestone/framework 4.4.0 → 4.5.0

package/CHANGELOG.md

@@ -1,3 +1,9 @@
+### 4.5.0
+
+[NEW] Now getSuper() available as a method on monsgoose models
+[UPDATE] Update rate-limiter-flexible to v3
+[UPDATE] Update test runner to suport ESM. In case problem with test please copy babel.config.js from framework to your project directory
+
 ### 4.4.0
 
 [NEW] New method to grab url of server it testing enviroument global.server.testingGetUrl("/some/endpoint")

package/babel.config.js

@@ -0,0 +1,3 @@
+module.exports = {
+  presets: [['@babel/preset-env', { targets: { node: 'current' } }]],
+};

package/controllers/index.js

@@ -28,26 +28,29 @@ class ControllerManager extends Base {
       }
       return 0;
     });
-    // const controllers = [];
+    const controllers = [];
     for (const controller of controllersToLoad) {
       // TODO wait until https://github.com/nodejs/node/issues/35889
-      // controllers.push(
-      // import(controller.path).then(({ default: ControllerModule }) => {
-      // eslint-disable-next-line import/no-dynamic-require, global-require
-      const ControllerModule = require(controller.path);
-      const contollerName = ControllerModule.name.toLowerCase();
-      let prefix = path.dirname(controller.file);
-      if (prefix === '.') {
-        prefix = '';
-      }
-      const controllePath = prefix
-        ? `${prefix}/${contollerName}`
-        : contollerName;
-      this.controllers[controllePath] = new ControllerModule(this.app, prefix);
-      // }),
-      // );
+      controllers.push(
+        import(controller.path).then(({ default: ControllerModule }) => {
+          // eslint-disable-next-line import/no-dynamic-require, global-require
+          // const ControllerModule = require(controller.path);
+          const contollerName = ControllerModule.name.toLowerCase();
+          let prefix = path.dirname(controller.file);
+          if (prefix === '.') {
+            prefix = '';
+          }
+          const controllePath = prefix
+            ? `${prefix}/${contollerName}`
+            : contollerName;
+          this.controllers[controllePath] = new ControllerModule(
+            this.app,
+            prefix,
+          );
+        }),
+      );
     }
-    // await Promise.all(controllers);
+    await Promise.all(controllers);
   }
 
   static get loggerGroup() {

package/models/User.js

@@ -88,8 +88,8 @@ class User extends AbstractModel {
     const scryptAsync = promisify(scrypt);
     const data = await scryptAsync(
       this.email + Date.now(),
-      this.constructor.getSuper().saltSecret,
-      this.constructor.getSuper().hashRounds,
+      this.getSuper().saltSecret,
+      this.getSuper().hashRounds,
     );
     const token = data.toString('base64url');
     this.sessionTokens.push({ token, valid: timestamp });
@@ -138,8 +138,8 @@ class User extends AbstractModel {
     const scryptAsync = promisify(scrypt);
     const data = await scryptAsync(
       userMongoose.email + Date.now(),
-      userMongoose.constructor.getSuper().saltSecret,
-      userMongoose.constructor.getSuper().hashRounds,
+      userMongoose.getSuper().saltSecret,
+      userMongoose.getSuper().hashRounds,
     );
     const token = data.toString('base64url');
     //       if (err) {
@@ -177,7 +177,7 @@ class User extends AbstractModel {
     const passwordRecoveryToken =
       await User.generateUserPasswordRecoveryToken(this);
     const mail = new Mailer(
-      this.constructor.getSuper().app,
+      this.getSuper().app,
       'recovery',
       {
         link: `${i18n.language}/auth/recovery?password_recovery_token=${passwordRecoveryToken.token}`,
@@ -194,8 +194,8 @@ class User extends AbstractModel {
     const scryptAsync = promisify(scrypt);
     const data = await scryptAsync(
       userMongoose.email + Date.now(),
-      userMongoose.constructor.getSuper().saltSecret,
-      userMongoose.constructor.getSuper().hashRounds,
+      userMongoose.getSuper().saltSecret,
+      userMongoose.getSuper().hashRounds,
     );
     const token = data.toString('base64url');
     // if (err) {
@@ -243,7 +243,7 @@ class User extends AbstractModel {
   async sendVerificationEmail(i18n) {
     const verificationToken = await User.generateUserVerificationToken(this);
     const mail = new Mailer(
-      this.constructor.getSuper().app,
+      this.getSuper().app,
       'verification',
       {
         link: `${i18n.language}/auth/login?verification_token=${verificationToken.token}`,

package/modules/AbstractModel.js

@@ -14,6 +14,7 @@ class AbstractModel extends Base {
     this.mongooseSchema.set('minimize', false);
     this.mongooseSchema.loadClass(this.constructor);
     this.mongooseSchema.statics.getSuper = () => this;
+    this.mongooseSchema.methods.getSuper = () => this;
     this.initHooks();
     this.mongooseModel = mongoose.model(
       this.constructor.name,

package/modules/BaseCli.js

@@ -48,10 +48,10 @@ class Cli extends Base {
       return false;
     }
     // TODO wait until https://github.com/nodejs/node/issues/35889
-    // const { default: Command } = await import(this.commands[command]);
+    const { default: Command } = await import(this.commands[command]);
 
     // eslint-disable-next-line import/no-dynamic-require, global-require
-    const Command = require(this.commands[command]);
+    // const Command = require(this.commands[command]);
 
     const c = new Command(this.app, this.commands, args);
     let result = false;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adaptivestone/framework",
-  "version": "4.4.0",
+  "version": "4.5.0",
   "description": "Adaptive stone node js framework",
   "main": "index.js",
   "engines": {
@@ -56,13 +56,14 @@
     "nodemailer-sendmail-transport": "^1.0.2",
     "nodemailer-stub-transport": "^1.1.0",
     "pug": "^3.0.2",
-    "rate-limiter-flexible": "^2.2.4",
+    "rate-limiter-flexible": "^3.0.0",
     "redis": "^4.3.1",
     "winston": "^3.3.3",
     "winston-transport-sentry-node": "^2.0.0",
     "yup": "^1.0.0"
   },
   "devDependencies": {
+    "@babel/preset-env": "^7.22.15",
     "eslint": "^8.0.0",
     "eslint-config-airbnb-base": "^15.0.0",
     "eslint-config-prettier": "^9.0.0",

package/server.js

@@ -52,17 +52,17 @@ class Server {
    */
   async startServer(callbackBefore404 = async () => Promise.resolve()) {
     // eslint-disable-next-line global-require
-    const HttpServer = require('./services/http/HttpServer');
+    // const HttpServer = require('./services/http/HttpServer');
     // eslint-disable-next-line global-require
-    const ControllerManager = require('./controllers/index');
+    // const ControllerManager = require('./controllers/index');
     // TODO wait until https://github.com/nodejs/node/issues/35889
-    // const [{ default: HttpServer }, { default: ControllerManager }] =
-    //   await Promise.all([
-    //     // eslint-disable-next-line import/extensions
-    //     import('./services/http/HttpServer.js'), // Speed optimisation
-    //     // eslint-disable-next-line import/extensions
-    //     import('./controllers/index.js'), // Speed optimisation
-    //   ]);
+    const [{ default: HttpServer }, { default: ControllerManager }] =
+      await Promise.all([
+        // eslint-disable-next-line import/extensions
+        import('./services/http/HttpServer.js'), // Speed optimisation
+        // eslint-disable-next-line import/extensions
+        import('./controllers/index.js'), // Speed optimisation
+      ]);
 
     this.addErrorHandling();
 

package/services/http/middleware/RateLimiter.js

@@ -16,10 +16,9 @@ class RateLimiter extends AbstractMiddleware {
 
   constructor(app, params) {
     super(app, params);
-    const routeParams = params;
     const limiterOptions = this.app.getConfig('rateLimiter');
 
-    this.finalOptions = merge(limiterOptions, routeParams);
+    this.finalOptions = merge(limiterOptions, params);
     this.limiter = null;
 
     switch (this.finalOptions.driver) {
@@ -32,7 +31,7 @@ class RateLimiter extends AbstractMiddleware {
         break;
 
       case 'mongo':
-        this.limiter = RateLimiterMongo({
+        this.limiter = new RateLimiterMongo({
           storeClient: mongoose.connection,
           ...this.finalOptions.limiterOptions,
         });
@@ -50,7 +49,6 @@ class RateLimiter extends AbstractMiddleware {
     const redisConfig = this.app.getConfig('redis');
     const redisClient = redis.createClient({
       url: redisConfig.url,
-      legacyMode: true,
     });
 
     // TODO: change it
@@ -71,6 +69,7 @@ class RateLimiter extends AbstractMiddleware {
 
     return new RateLimiterRedis({
       storeClient: redisClient,
+      useRedisPackage: true,
       ...this.finalOptions.limiterOptions,
     });
   }
@@ -91,7 +90,7 @@ class RateLimiter extends AbstractMiddleware {
 
     if (request && request.length) {
       request.forEach((val) => {
-        if (req.body[val]) {
+        if (req.body && req.body[val]) {
           key.push(req.body[val]);
         }
         // if (req.appInfo.request && req.appInfo.request[val]) {
@@ -108,6 +107,7 @@ class RateLimiter extends AbstractMiddleware {
       this.logger.info(
         `RateLimmiter not inited correclty! Please check init logs `,
       );
+      return res.status(500).send('');
     }
 
     const { namespace } = this.app.getConfig('redis');
@@ -119,7 +119,6 @@ class RateLimiter extends AbstractMiddleware {
       .catch(() => {
         this.logger.warn(`Too many requests. Consume key: ${consumeKey}`);
       });
-
     if (consumeResult) {
       return next();
     }

package/services/http/middleware/RateLimiter.test.js

@@ -1,6 +1,22 @@
+const { setTimeout } = require('node:timers/promises');
 const RateLimiter = require('./RateLimiter');
 
+let mongoRateLimiter;
+
 describe('rate limiter methods', () => {
+  beforeAll(() => {
+    mongoRateLimiter = new RateLimiter(global.server.app, {
+      driver: 'mongo',
+      limiterOptions: {
+        keyPrefix: `mongo_${Date.now()}`,
+      },
+    });
+  });
+
+  afterAll(async () => {
+    // we need to wait because redis mongo ask mongo to create indexes
+    await setTimeout(200);
+  });
   it('have description fields', async () => {
     expect.assertions(1);
     const middleware = new RateLimiter(global.server.app, {
@@ -47,4 +63,167 @@ describe('rate limiter methods', () => {
 
     expect(res).toBe('192.168.0.0__someId');
   });
+
+  it('generateConsumeKey with request works correctly', async () => {
+    expect.assertions(1);
+
+    const redisRateLimiter = new RateLimiter(global.server.app, {
+      driver: 'redis',
+      consumeKeyComponents: {
+        request: ['email'],
+      },
+    });
+
+    const res = await redisRateLimiter.gerenateConsumeKey({
+      ip: '192.168.0.0',
+      body: {
+        email: 'foo@example.com',
+      },
+    });
+
+    expect(res).toBe('192.168.0.0__foo@example.com');
+  });
+
+  it('middleware without driver should fail', async () => {
+    expect.assertions(2);
+    const rateLimiter = new RateLimiter(global.server.app, {
+      driver: 'unknown',
+    });
+    const nextFunction = jest.fn(() => {});
+    const req = {
+      appInfo: {},
+    };
+    let status;
+    let isSend;
+    await rateLimiter.middleware(
+      req,
+      {
+        status(statusCode) {
+          status = statusCode;
+          return this;
+        },
+        send() {
+          isSend = true;
+        },
+      },
+      nextFunction,
+    );
+    expect(status).toBe(500);
+    expect(isSend).toBe(true);
+  });
+
+  const makeOneRequest = async ({ rateLimiter, driver, request }) => {
+    let realRateLimiter = rateLimiter;
+    if (!realRateLimiter) {
+      realRateLimiter = new RateLimiter(global.server.app, {
+        driver,
+      });
+    }
+    const req = {
+      appInfo: {},
+      ...request,
+    };
+    let status;
+    let isSend = false;
+    let isNextCalled = false;
+    await realRateLimiter.middleware(
+      req,
+      {
+        status(statusCode) {
+          status = statusCode;
+          return this;
+        },
+        send() {
+          isSend = true;
+        },
+      },
+      () => {
+        isNextCalled = true;
+      },
+    );
+    return { status, isSend, isNextCalled };
+  };
+
+  it('middleware should works with a mongo drivers', async () => {
+    expect.assertions(1);
+    const { isNextCalled } = await makeOneRequest({
+      rateLimiter: mongoRateLimiter,
+      request: { ip: '10.10.0.1' },
+    });
+    expect(isNextCalled).toBe(true);
+  });
+
+  it('middleware should works with a memory drivers', async () => {
+    expect.assertions(1);
+    const { isNextCalled } = await makeOneRequest({
+      driver: 'memory',
+      request: { ip: '10.10.0.1' },
+    });
+    expect(isNextCalled).toBe(true);
+  });
+
+  it('middleware should works with a redis drivers', async () => {
+    expect.assertions(1);
+    const { isNextCalled } = await makeOneRequest({
+      driver: 'redis',
+      request: { ip: '10.10.0.1' },
+    });
+    expect(isNextCalled).toBe(true);
+  });
+
+  it('middleware should rate limits for us. mongo driver', async () => {
+    expect.assertions(2);
+
+    const middlewares = Array.from({ length: 20 }, () =>
+      makeOneRequest({ rateLimiter: mongoRateLimiter }),
+    );
+
+    const data = await Promise.all(middlewares);
+
+    const status = data.find((obj) => obj.status === 429);
+    const isSend = data.find((obj) => obj.isSend);
+
+    expect(status.status).toBe(429);
+    expect(isSend.isSend).toBe(true);
+  });
+
+  it('middleware should rate limits for us. memory driver', async () => {
+    expect.assertions(2);
+
+    const rateLimiter = new RateLimiter(global.server.app, {
+      driver: 'memory',
+    });
+
+    const middlewares = Array.from({ length: 20 }, () =>
+      makeOneRequest({ rateLimiter }),
+    );
+
+    const data = await Promise.all(middlewares);
+
+    const status = data.find((obj) => obj.status === 429);
+    const isSend = data.find((obj) => obj.isSend);
+
+    expect(status.status).toBe(429);
+    expect(isSend.isSend).toBe(true);
+  });
+
+  it('middleware should rate limits for us. redis driver', async () => {
+    expect.assertions(2);
+
+    const rateLimiter = new RateLimiter(global.server.app, {
+      driver: 'redis',
+    });
+
+    const middlewares = Array.from({ length: 20 }, () =>
+      makeOneRequest({ rateLimiter }),
+    );
+
+    const data = await Promise.all(middlewares);
+
+    const status = data.find((obj) => obj.status === 429);
+    const isSend = data.find((obj) => obj.isSend);
+
+    expect(status.status).toBe(429);
+    expect(isSend.isSend).toBe(true);
+  });
 });

package/tests/setup.js

@@ -14,7 +14,7 @@ jest.setTimeout(1000000);
 beforeAll(async () => {
   mongoMemoryServerInstance = await MongoMemoryReplSet.create({
     // binary: { version: '4.4.6' },
-    replSet: { storageEngine: 'wiredTiger' },
+    replSet: { count: 1, storageEngine: 'wiredTiger' },
   });
   await mongoMemoryServerInstance.waitUntilRunning();
   process.env.LOGGER_CONSOLE_LEVEL = 'error';