@adaptivestone/framework 2.15.4 → 3.0.1

package/package.json

@@ -1,12 +1,13 @@
 {
   "name": "@adaptivestone/framework",
-  "version": "2.15.4",
+  "version": "3.0.1",
   "description": "Adaptive stone node js framework",
   "main": "index.js",
   "repository": {
     "type": "git",
     "url": "https://gitlab.com/adaptivestone/framework"
   },
+  "homepage": "https://framework.adaptivestone.com/",
   "scripts": {
     "dev": "nodemon ./index.js",
     "prod": "nodemon ./cluster.js",
@@ -25,18 +26,17 @@
   "license": "MIT",
   "dependencies": {
     "bcrypt": "^5.0.1",
-    "body-parser": "^1.19.0",
     "cors": "^2.8.5",
     "deepmerge": "^4.2.2",
     "dotenv": "^10.0.0",
     "email-templates": "^8.0.7",
     "express": "^4.17.1",
-    "i18next": "^20.3.5",
+    "i18next": "^21.2.4",
     "i18next-chained-backend": "^3.0.2",
     "i18next-fs-backend": "^1.1.1",
     "i18next-http-middleware": "^3.1.4",
     "minimist": "^1.2.5",
-    "mongoose": "^5.13.3",
+    "mongoose": "^6.0.0",
     "nodemailer": "^6.6.3",
     "nodemailer-sendmail-transport": "^1.0.2",
     "nodemailer-stub-transport": "^1.1.0",
@@ -44,21 +44,20 @@
     "pug": "^3.0.2",
     "rate-limiter-flexible": "^2.2.4",
     "redis": "^3.1.2",
-    "validator": "^13.6.0",
     "winston": "^3.3.3",
-    "winston-transport-sentry-node": "^1.0.2",
+    "winston-transport-sentry-node": "^2.0.0",
     "yup": "^0.32.9"
   },
   "devDependencies": {
-    "eslint": "^7.31.0",
-    "eslint-config-airbnb-base": "^14.2.1",
+    "eslint": "^8.0.0",
+    "eslint-config-airbnb-base": "^15.0.0",
     "eslint-config-prettier": "^8.3.0",
     "eslint-plugin-import": "^2.23.4",
-    "eslint-plugin-jest": "^24.4.0",
+    "eslint-plugin-jest": "^25.0.0",
     "husky": "^7.0.0",
     "jest": "^27.0.6",
-    "lint-staged": "^11.1.1",
-    "mongodb-memory-server": "^7.3.4",
+    "lint-staged": "^12.0.0",
+    "mongodb-memory-server": "^8.0.2",
     "nodemon": "^2.0.12",
     "supertest": "^6.1.4"
   },
@@ -66,10 +65,5 @@
     "**/*.{js,jsx,ts,tsx,json,css,scss,md}": [
       "prettier --write"
     ]
-  },
-  "config": {
-    "mongodbMemoryServer": {
-      "version": "4.4.6"
-    }
   }
 }

package/server.d.ts

@@ -0,0 +1,75 @@
+import TFolderConfig from './types/TFoldersConfig';
+import { ExpandDeep } from './types/Expand';
+
+import EventEmitter from 'events';
+
+import { Model as MongooseModel, Schema } from 'mongoose';
+
+import BaseCli from './modules/BaseCli';
+import Cache from './services/cache/Cache';
+
+type ServerConfig = {
+  folders: ExpandDeep<TFolderConfig>;
+};
+
+declare class Server {
+  config: ServerConfig;
+  app: {
+    getConfig: Server['getConfig'];
+    getModel: Server['getModel'];
+    runCliCommand: Server['runCliCommand'];
+    updateConfig: Server['updateConfig'];
+    foldersConfig: Server['config'];
+    events: EventEmitter;
+    get cache(): Server['cacheService'];
+    httpServer: null;
+    controllerManager: null;
+  };
+  cacheService: Cache;
+
+  cache: {
+    configs: Map<string, {}>;
+    models: Map<string, MongooseModel<any>>;
+  };
+  cli: boolean;
+
+  /**
+   *  Construct new server
+   */
+  constructor(config: ExpandDeep<ServerConfig>);
+
+  /**
+   * Start server (http + websocket + init all http and websocet ralated functions)
+   */
+  startServer(callbackBefore404?: Promise<null>): Promise<null>;
+
+  /**
+   * Return config from {configName} (file name) on config folder.
+   * Support cache and updating confing into cache
+   * Also will update config based on NODE_ENV. If config.js and config.production.js
+   * and NODE_ENV is production then we will load base config (config.js) and the load
+   * environment config (config.production.js) and overwrite base config options
+   * @see updateConfig
+   * @TODO generate that based on real data
+   */
+  getConfig(configName: string): {};
+
+  /**
+   * Primary designed for tests when we need to update some configs before start testing
+   * Should be called before any initialization was done
+   */
+  updateConfig(configName: string, config: {}): {};
+
+  /**
+   * Return model from {modelName} (file name) on model folder.
+   * Support cache
+   */
+  getModel(modelName: string): MongooseModel<any>;
+
+  /**
+   * Run cli command into framework (http, ws, etc)
+   */
+  runCliCommand(commandName: string, args: {}): Promise<BaseCli['run']>;
+}
+
+export = Server;

package/server.js

@@ -32,6 +32,8 @@ class Server {
       get cache() {
         return that.getCache();
       },
+      httpServer: null,
+      controllerManager: null,
     };
 
     this.cache = {
@@ -122,7 +124,7 @@ class Server {
   updateConfig(configName, config) {
     // const confName = configName.charAt(0).toUpperCase() + configName.slice(1);
     const conf = this.getConfig(configName);
-    const newConf = Object.assign(conf, config);
+    const newConf = Object.assign(conf, config); // TODO deep clone
     this.cache.configs.set(configName, newConf);
     return newConf;
   }
@@ -134,6 +136,11 @@ class Server {
    * @returns {import('mongoose').Model}
    */
   getModel(modelName) {
+    if (modelName.endsWith('s')) {
+      console.warn(
+        `Probably your model name '${modelName}' in plural from. Try to avoid plural form`,
+      );
+    }
     if (!this.cache.models.has(modelName)) {
       const Model = this.getFileWithExtendingInhirence('models', modelName);
       if (!Model) {

package/services/cache/Cache.d.ts

@@ -0,0 +1,22 @@
+import Base from '../../modules/Base';
+import Server from '../../server';
+
+declare class Cache extends Base {
+  app: Server['app'];
+
+  constructor(app: Server['app']);
+
+  /**
+   * Get value from cache. Set and get if not eists
+   * @param key key to check
+   * @param onNotFound callback that will be executed if value not found on cahce
+   * @param storeTime how long we should store value on cache
+   */
+  getSetValue(
+    key: String,
+    onNotFound: () => Promise<any>,
+    storeTime: number,
+  ): Promise<any>;
+}
+
+export = Cache;

package/services/cache/Cache.js

@@ -57,6 +57,10 @@ class Cache extends Base {
     this.promiseMapping.delete(key);
     return result;
   }
+
+  static get loggerGroup() {
+    return 'Cache_';
+  }
 }
 
 module.exports = Cache;

package/services/http/HttpServer.js

@@ -1,13 +1,13 @@
 const express = require('express');
 const http = require('http');
 const path = require('path');
-const bodyParser = require('body-parser');
 const cors = require('cors');
 
 const i18next = require('i18next');
 const i18nextMiddleware = require('i18next-http-middleware');
 const BackendFS = require('i18next-fs-backend');
 const Backend = require('i18next-chained-backend');
+const PrepareAppInfoMiddleware = require('./middleware/PrepareAppInfo');
 
 const Base = require('../../modules/Base');
 
@@ -41,11 +41,13 @@ class HttpServer extends Base {
         origin: httpConfig.corsDomains,
       }),
     ); // todo whitelist
-    this.express.use(bodyParser.urlencoded({ limit: '50mb', extended: true }));
-    this.express.use(bodyParser.json({ limit: '50mb' }));
+    this.express.use(express.urlencoded({ limit: '50mb', extended: true }));
+    this.express.use(express.json({ limit: '50mb' }));
     this.express.use(express.static(folderConfig.folders.public));
     this.express.use(express.static('./public'));
 
+    this.express.use(new PrepareAppInfoMiddleware(this.app).getMiddleware());
+
     // As exprress will check numbersof arguments
     // eslint-disable-next-line no-unused-vars
     this.express.use((err, req, res, next) => {

package/services/http/middleware/AbstractMiddleware.js

@@ -1,6 +1,20 @@
 const Base = require('../../../modules/Base');
 
 class AbstractMiddleware extends Base {
+  constructor(app, params) {
+    super(app);
+    this.params = params;
+  }
+
+  static get description() {
+    return ' Middleware description. Please provide own';
+  }
+
+  async middleware(req, res, next) {
+    this.logger.warn('Middleware is not implemented');
+    next();
+  }
+
   getMiddleware() {
     return this.middleware.bind(this);
   }

package/services/http/middleware/Auth.js

@@ -1,6 +1,10 @@
 const AbstractMiddleware = require('./AbstractMiddleware');
 
 class AuthMiddleware extends AbstractMiddleware {
+  static get description() {
+    return 'Allow to pass only if the user provided. Please use any middleware that provide user instance before';
+  }
+
   async middleware(req, res, next) {
     if (!req.appInfo.user) {
       this.logger.info('User try to access resource without credentials');

package/services/http/middleware/GetUserByToken.js

@@ -1,8 +1,17 @@
 const AbstractMiddleware = require('./AbstractMiddleware');
 
 class GetUserByToken extends AbstractMiddleware {
+  static get description() {
+    return 'Grab a token and try to parse the user from it. It user exist will add req.appInfo.user variable';
+  }
+
   async middleware(req, res, next) {
     let { token } = req.body;
+    this.logger.verbose(
+      `GetUserByToken token in BODY ${token}. Token if Authorization header ${req.get(
+        'Authorization',
+      )}`,
+    );
     if (!token) {
       token = req.get('Authorization');
       if (!token || token === 'null') {

package/services/http/middleware/PrepareAppInfo.js

@@ -1,6 +1,10 @@
 const AbstractMiddleware = require('./AbstractMiddleware');
 
 class PrepareAppInfo extends AbstractMiddleware {
+  static get description() {
+    return 'Basic middleware that creates "req.appInfo" object';
+  }
+
   async middleware(req, res, next) {
     if (!req.appInfo) {
       req.appInfo = {

package/services/http/middleware/RateLimiter.js

@@ -10,8 +10,12 @@ const mongoose = require('mongoose');
 const AbstractMiddleware = require('./AbstractMiddleware');
 
 class RateLimiter extends AbstractMiddleware {
+  static get description() {
+    return 'Rate limiter middleware. Limit amount of request. Please refer to documentation';
+  }
+
   constructor(app, params) {
-    super(app);
+    super(app, params);
     const limiterOptions = this.app.getConfig('rateLimiter');
     this.finalOptions = merge(limiterOptions, params);
 

package/services/http/middleware/Role.js

@@ -0,0 +1,29 @@
+const AbstractMiddleware = require('./AbstractMiddleware');
+
+class RoleMiddleware extends AbstractMiddleware {
+  static get description() {
+    return 'Check user role (user.roles property). If the user has no role then stop request and return error. OR logic (any role will pass user)';
+  }
+
+  async middleware(req, res, next) {
+    const { user } = req.appInfo;
+
+    if (!user) {
+      return res.status(401).send();
+    }
+
+    let hasRole = false;
+    user.roles.forEach((role) => {
+      if (this.params.roles.includes(role)) {
+        hasRole = true;
+      }
+    });
+
+    if (!hasRole) {
+      return res.status(403).json({ message: 'You do not have access' });
+    }
+    return next();
+  }
+}
+
+module.exports = RoleMiddleware;

package/tests/setup.js

@@ -9,7 +9,7 @@ const Server = require('../server');
 jest.setTimeout(1000000);
 beforeAll(async () => {
   mongoMemoryServerInstance = await MongoMemoryReplSet.create({
-    binary: { version: '4.4.6' },
+    // binary: { version: '4.4.6' },
     replSet: { storageEngine: 'wiredTiger' },
   });
   await mongoMemoryServerInstance.waitUntilRunning();

package/types/Expand.d.ts

@@ -0,0 +1,11 @@
+export type Expand<T> = T extends object
+  ? T extends infer O
+    ? { [K in keyof O]: O[K] }
+    : never
+  : T;
+
+export type ExpandDeep<T> = T extends object
+  ? T extends infer O
+    ? { [K in keyof O]: ExpandDeep<O[K]> }
+    : never
+  : T;

package/types/TFoldersConfig.d.ts

@@ -0,0 +1,19 @@
+/**
+ * @param config path to folder with config files
+ * @param models path to folder with moidels files
+ * @param controllers path to folder with controllers files
+ * @param views path to folder with view files
+ * @param public path to folder with public files
+ * @param locales path to folder with locales files
+ * @param emails path to folder with emails files
+ */
+type FolderConfig = {
+  config: string;
+  models: string;
+  controllers: string;
+  views: string;
+  public: string;
+  emails: string;
+};
+
+export default FolderConfig;