@azteam/express 1.2.149 → 1.2.152

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@azteam/express",
-    "version": "1.2.149",
+    "version": "1.2.152",
     "description": "",
     "main": "src/index.js",
     "repository": {
@@ -27,7 +27,7 @@
         "@azteam/error": "latest",
         "@azteam/http-client": "latest",
         "@azteam/rabbitmq-async": "latest",
-        "@azteam/redis-async": "latest",
+        "@azteam/redis-async": "1.0.48",
         "@grpc/grpc-js": "1.6.7",
         "@grpc/proto-loader": "0.6.12",
         "body-parser": "1.19.0",
@@ -41,6 +41,7 @@
         "fastest-validator": "1.8.0",
         "helmet": "3.21.2",
         "jsonwebtoken": "8.2.1",
+        "lodash": "4.17.21",
         "method-override": "3.0.0",
         "morgan": "1.10.0",
         "socket.io": "4.4.1",

package/src/Server.js

@@ -10,7 +10,7 @@ import morgan from 'morgan';
 import cors from 'cors';
 import _ from 'lodash';
 import 'express-async-errors';
-import { errorCatch, ErrorException, NOT_FOUND, UNKNOWN } from '@azteam/error';
+import {errorCatch, ErrorException, NOT_FOUND, UNKNOWN} from '@azteam/error';
 
 
 const RES_TYPE = {
@@ -40,6 +40,9 @@ function omitItem(item, guard, allows) {
 
 class Server {
     constructor(currentDir = '', options = {}) {
+        this.redis = null;
+        this.messageQueue = null;
+
         this.options = options;
 
         this.cookieOptions = {
@@ -62,10 +65,12 @@ class Server {
 
     setMessageQueue(messageQueue) {
         this.messageQueue = messageQueue;
+        return this;
     }
 
     setRedis(redis) {
         this.redis = redis;
+        return this;
     }
 
     setCookieOptions(cookieOptions) {
@@ -125,6 +130,7 @@ class Server {
 
 
     startAPI(port) {
+
         if (!_.isEmpty(this.controllers)) {
 
             const WHITE_LIST = this.whiteList;
@@ -137,8 +143,8 @@ class Server {
             }));
 
             app.use(methodOverride());
-            app.use(bodyParser.urlencoded({ limit: '5mb', extended: true }));
-            app.use(bodyParser.json({ limit: '5mb' }));
+            app.use(bodyParser.urlencoded({limit: '5mb', extended: true}));
+            app.use(bodyParser.json({limit: '5mb'}));
 
             app.set('trust proxy', 1);
 
@@ -168,92 +174,108 @@ class Server {
             });
             app.get('/favicon.ico', (req, res) => res.status(204).json({}));
 
-            app.use(async function(req, res, next) {
-                req.trackDevice = {
-                    ip: req.ip,
-                    device: req.get('X-DEVICE') || req.get('User-Agent'),
-                    device_id: req.get('X-DEVICE-ID') || 'web',
-                    os: req.get('X-OS') || 'web'
-                };
 
+            const {redis} = this;
+
+            if (redis) {
+                app.request.redis = redis;
+                app.response.redis = redis;
+            }
 
-                res.error = function(code, errors = []) {
-                    throw new ErrorException(code, errors);
-                };
 
-                res.success = function(data = {}, guard = [], allows = []) {
-                    let guardData = data;
-                    if (data) {
-                        let resType = null;
-                        if (_.isArray(data)) {
-                            resType = RES_TYPE.ARRAY;
-                        } else if (_.isObject(data)) {
-                            resType = RES_TYPE.OBJECT;
-                            if (data.docs) {
-                                resType = RES_TYPE.DOCS;
-                            }
+            app.response.error = function(code, errors = []) {
+                throw new ErrorException(code, errors);
+            };
+
+            app.response.success = function(data = {}, guard = [], allows = []) {
+
+                let guardData = data;
+                if (data) {
+                    let resType = null;
+                    if (_.isArray(data)) {
+                        resType = RES_TYPE.ARRAY;
+                    } else if (_.isObject(data)) {
+                        resType = RES_TYPE.OBJECT;
+                        if (data.docs) {
+                            resType = RES_TYPE.DOCS;
                         }
+                    }
 
-                        if (_.isArray(guard)) {
+                    if (_.isArray(guard)) {
+                        guard = [
+                            ...guard,
+                            '__v',
+                            '_id',
+                            'deleted_at',
+                            'updated_at',
+                            'created_id',
+                            'modified_id'
+                        ];
+                        if (resType === RES_TYPE.ARRAY || resType === RES_TYPE.DOCS) {
                             guard = [
                                 ...guard,
-                                '__v',
-                                '_id',
-                                'deleted_at',
-                                'updated_at',
-                                'created_id',
-                                'modified_id'
+                                'metadata_disable',
+                                'metadata_keywords',
+                                'metadata_description',
+                                'metadata_image_url'
                             ];
-                            if (resType === RES_TYPE.ARRAY || resType === RES_TYPE.DOCS) {
-                                guard = [
-                                    ...guard,
-                                    'metadata_disable',
-                                    'metadata_keywords',
-                                    'metadata_description',
-                                    'metadata_image_url'
-                                ];
-                            }
                         }
-                        if (resType === RES_TYPE.DOCS) {
-                            guardData.docs = _.map(data.docs, item => {
-                                return omitItem(item, guard, allows);
-                            });
-                        } else if (resType === RES_TYPE.ARRAY) {
-                            guardData = _.map(data, item => {
-                                return omitItem(item, guard, allows);
-                            });
-                        } else if (resType === RES_TYPE.OBJECT) {
-                            guardData = omitItem(data, guard, allows);
-                        }
-
-
                     }
+                    if (resType === RES_TYPE.DOCS) {
+                        guardData.docs = _.map(data.docs, item => {
+                            return omitItem(item, guard, allows);
+                        });
+                    } else if (resType === RES_TYPE.ARRAY) {
+                        guardData = _.map(data, item => {
+                            return omitItem(item, guard, allows);
+                        });
+                    } else if (resType === RES_TYPE.OBJECT) {
+                        guardData = omitItem(data, guard, allows);
+                    }
+                }
 
-                    return res.json({
-                        success: true,
-                        data: guardData,
-                        options: req.resOptions
-                    });
+                const resData = {
+                    success: true,
+                    data: guardData,
+                    options: this.resOptions
                 };
 
-                res.cleanCookie = function(data) {
-                    _.map(data, (name) => {
-                        res.clearCookie(name, {
-                            domain: COOKIE_OPTIONS.domain
-                        });
-                    });
-                };
+                if (this.redis && this.cache) {
+                    this.redis.set(this.cache.key, resData, this.cache.ttl);
+                }
 
-                res.addCookie = function(data) {
-                    _.map(data, (value, key) => {
-                        const maxAge = 86400000 * 365; // 1 year
-                        res.cookie(key, value, {
-                            ...COOKIE_OPTIONS,
-                            maxAge,
-                            expires: new Date(Date.now() + maxAge)
-                        });
+                return this.json(resData);
+            };
+
+            app.response.cleanCookie = function(data) {
+                _.map(data, (name) => {
+                    this.clearCookie(name, {
+                        domain: COOKIE_OPTIONS.domain
+                    });
+                });
+            };
+
+            app.response.addCookie = function(data) {
+                _.map(data, (value, key) => {
+                    const maxAge = 86400000 * 365; // 1 year
+                    this.cookie(key, value, {
+                        ...COOKIE_OPTIONS,
+                        maxAge,
+                        expires: new Date(Date.now() + maxAge)
                     });
+                });
+            };
+
+            app.use(async function(req, res, next) {
+                delete res.cache;
+
+                req.trackDevice = {
+                    ip: req.ip,
+                    device: req.get('X-DEVICE') || req.get('User-Agent'),
+                    device_id: req.get('X-DEVICE-ID') || 'web',
+                    os: req.get('X-OS') || 'web'
                 };
+
                 next();
             });
 
@@ -270,7 +292,7 @@ class Server {
                 const listPublicRouter = controller.publicRouter();
 
                 _.map(listPublicRouter, (method) => {
-                    const { name, type } = method;
+                    const {name, type} = method;
 
                     const router = controller[name]();
 
@@ -311,7 +333,7 @@ class Server {
                     this.callbackError(error);
                 }
 
-                return res.status(error.status).json({ success: false, errors: error.errors });
+                return res.status(error.status).json({success: false, errors: error.errors});
             });
 
             const server = http.Server(app);
@@ -376,4 +398,4 @@ class Server {
     }
 }
 
-export default Server;
+export default Server;

package/src/middleware/cacheMiddleware.js

@@ -0,0 +1,35 @@
+import _ from 'lodash';
+
+export default function(key, options = {}) {
+    options = {
+        ttl: 5,
+        limitPage: 5,
+        ...options
+    };
+    return async function(req, res, next) {
+        const {redis} = req;
+        if (redis) {
+            if (options.query) {
+                key += _.get(req, options.query);
+            }
+            if (req.paginate) ;
+            {
+                if (req.paginate.page <= options.limitPage) {
+                    key += `page${req.paginate.page}`;
+                } else {
+                    return next();
+                }
+            }
+            const cacheData = await redis.get(key);
+            if (cacheData) {
+                return res.json(cacheData);
+            } else {
+                res.cache = {
+                    key,
+                    ttl: options.ttl
+                };
+            }
+        }
+        return next();
+    };
+}

package/src/middleware/etagMiddleware.js

@@ -1,7 +1,5 @@
 import etag from 'etag';
 
-
-
 function floorToMinute(time, minutes) {
     const roundSecond = minutes * 60;
     time = time - (time % (Math.floor(time / roundSecond) * roundSecond));

package/src/middleware/index.js

@@ -5,4 +5,5 @@ export {default as roleMiddleware} from './roleMiddleware';
 export {default as paginateMiddleware} from './paginateMiddleware';
 export {default as validateMiddleware} from './validateMiddleware';
 export {default as limitRequestMiddleware} from './limitRequestMiddleware';
+export {default as cacheMiddleware} from './cacheMiddleware';
 

package/src/middleware/paginateMiddleware.js

@@ -36,7 +36,7 @@ export default function(options = {}) {
     return async function(req, res, next) {
         req.query = omitData(req.query);
 
-        req.resOptions = options;
+        res.resOptions = options;
         req.paginate = {
             limit: options.limit
         };
@@ -71,14 +71,14 @@ export default function(options = {}) {
                     req.query[newKey] = {
                         ...req.query[newKey],
                         $gte: value
-                    }
+                    };
                 } else if (key.endsWith('_end')) {
                     const newKey = key.replace('_end', '');
 
                     req.query[newKey] = {
                         ...req.query[newKey],
                         $lt: value
-                    }
+                    };
                 }
 
 
@@ -102,5 +102,5 @@ export default function(options = {}) {
         }
 
         return next();
-    }
-}
+    };
+}