jxp 2.13.1 → 2.13.3

package/libs/cache.js

@@ -1,8 +1,21 @@
 const NodeCache = require('node-cache');
-const config = require('config');
-const cache = new NodeCache({ stdTTL: config.cache?.ttl || 5 * 60 });
+let cache;
 
-const generateKey = (req) => {
+const init = (config) => {
+    if (!config.cache || !config.cache.enabled) return;
+    cache = new NodeCache({ stdTTL: config.cache.ttl || 5 * 60 });
+    if (config.cache.debug) {
+        cache.on('expired', (key) => {
+            console.log('cache expired', key)
+        })
+        cache.on('flush', () => {
+            console.log('cache flush')
+        })
+    }
+}
+
+const generateKey = (req, res) => {
+    if (res.jxp_cache_key) return res.jxp_cache_key;
     let key = `${req.modelname}/`;
     if (req.params.item_id) {
         key += `${req.params.item_id}`
@@ -10,43 +23,46 @@ const generateKey = (req) => {
     if (req.query) {
         key += `?${JSON.stringify(req.query)}`
     }
+    res.jxp_cache_key = key;
     return key;
 }
 
 const set = async (req, res) => {
-    if (!config.cache?.enabled) return;
-    const key = generateKey(req)
+    if (!req.config || !req.config.cache.enabled) return;
+    const key = generateKey(req, res)
     cache.set(key, res.result)
-    if (config.cache?.debug) {
+    if (!req.config.cache.debug) {
         console.log('cache set', key)
     }
 }
 
-const get = async (req, res) => {
-    if (!config.cache?.enabled) return;
-    const key = generateKey(req)
+const get = (req, res, next) => {
+    if (!req.config || !req.config.cache.enabled) return next();
+    const key = generateKey(req, res)
     res.header('jxp-cache-key', key);
     const cached = cache.get(key)
     if (cached) {
-        if (config.cache?.debug) {
+        if (!req.config.cache.debug) {
             console.log('cache hit', key)
         }
         res.header('jxp-cache', 'hit')
         res.result = cached
-        return res.send(res.result)
+        res.send(res.result);
+        return;
     }
-    if (config.cache?.debug) {
+    if (!req.config.cache.debug) {
         console.log('cache miss', key)
     }
     res.header('jxp-cache', 'miss')
+    next()
 }
 
-const clear = async (req, res) => {
-    if (!config.cache?.enabled) return;
+const clear = async (req) => {
+    if (!req.config || !req.config.cache.enabled) return;
     const keys = cache.keys()
     keys.forEach(key => {
         if (key.startsWith(`${req.modelname}/`)) {
-            if (config.cache?.debug) {
+            if (!req.config.cache.debug) {
                 console.log('cache del', key)
             }
             cache.del(key)
@@ -55,19 +71,19 @@ const clear = async (req, res) => {
 }
 
 const clearAll = async () => {
-    if (!config.cache?.enabled) return;
-    if (config.cache?.debug) {
-        console.log('cache flushAll')
-    }
     cache.flushAll()
 }
 
 const stats = async (req, res) => {
-    if (!config.cache?.enabled) return {};
+    if (!req.config || !req.config.cache.enabled) {
+        res.result = { cache_enabled: false }
+        return;
+    }
     res.result = cache.getStats()
 }
 
 module.exports = {
+    init,
     set,
     get,
     clear,

package/libs/jxp.js

@@ -857,6 +857,7 @@ const JXP = function(options) {
 	login.init(config);
 	groups.init(config);
 	ws.init({models});
+	cache.init(config);
 	const docs = new Docs({config, models});
 
 	// Set up our API server
@@ -932,7 +933,7 @@ const JXP = function(options) {
 		middlewarePasswords,
 		config.pre_hooks.post,
 		actionPost,
-		cache.clear,
+		cache.clearAll,
 		(req, res, next) => {
 			next();
 		},
@@ -946,7 +947,7 @@ const JXP = function(options) {
 		middlewareCheckAdmin,
 		config.pre_hooks.put,
 		actionPut,
-		cache.clear,
+		cache.clearAll,
 		(req, res, next) => {
 			next();
 		},
@@ -958,7 +959,7 @@ const JXP = function(options) {
 		security.auth,
 		config.pre_hooks.delete,
 		actionDelete,
-		cache.clear,
+		cache.clearAll,
 	);
 
 	// Count
@@ -1022,7 +1023,7 @@ const JXP = function(options) {
 		middlewareCheckAdmin,
 		config.pre_hooks.update,
 		actionUpdate,
-		cache.clear,
+		cache.clearAll,
 	);
 
 	/* Batch routes - ROLLED BACK FOR NOW */
@@ -1035,7 +1036,7 @@ const JXP = function(options) {
 		security.login,
 		security.auth,
 		actionCall,
-		cache.clear,
+		cache.clearAll,
 	);
 	server.post(
 		"/call/:modelname/:method_name",
@@ -1043,7 +1044,7 @@ const JXP = function(options) {
 		security.login,
 		security.auth,
 		actionCall,
-		cache.clear,
+		cache.clearAll,
 	);
 	server.get(
 		"/call/:modelname/:item_id/:method_name",
@@ -1051,7 +1052,7 @@ const JXP = function(options) {
 		security.login,
 		security.auth,
 		actionCallItem,
-		cache.clear,
+		cache.clearAll,
 	);
 
 	/* Login and authentication */
@@ -1101,7 +1102,7 @@ const JXP = function(options) {
 
 	/* Cache */
 	server.get("/cache/stats", cache.stats, outputJSON);
-	server.get("/cache/clear", cache.clear, outputJSON);
+	server.get("/cache/clear", cache.clearAll, outputJSON);
 
 	return server;
 };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "jxp",
   "description:": "An opinionated RESTful API library based on Mongoose and Restify. Make an API by just writing Mongoose models.",
-  "version": "2.13.1",
+  "version": "2.13.3",
   "private": false,
   "main": "libs/jxp.js",
   "scripts": {

package/test/test.js

@@ -1142,7 +1142,7 @@ describe('Test', () => {
 			chai.request(server)
 			.get("/cache/clear")
 			.end((err, res) => {
-				console.log(res.body);
+				// console.log(res.body);
 				res.should.have.status(200);
 				done();
 			});
@@ -1181,4 +1181,116 @@ describe('Test', () => {
 			});
 		})
 	});
+	describe("Cache invalidating", () => {
+		let test_id;
+		it("should get a test record", done => {
+			chai.request(server)
+				.get(`/api/test?populate=link&limit=1`)
+				.auth(init.email, init.password)
+				.end((err, res) => {
+					// console.log(res.headers)
+					res.should.have.status(200);
+					res.body.data[0].should.have.property("_id");
+					test_id = res.body.data[0]._id;
+					res.body.data[0].should.have.property("link");
+					should.equal(res.body.data[0].link, null);
+					res.headers["jxp-cache"].should.equal("miss");
+					done();
+				});
+		});
+		it("should get a cached test record", done => {
+			chai.request(server)
+				.get(`/api/test?populate=link&limit=1`)
+				.auth(init.email, init.password)
+				.end((err, res) => {
+					// console.log(res.headers)
+					res.should.have.status(200);
+					res.body.data[0].should.have.property("_id");
+					res.headers["jxp-cache"].should.equal("hit");
+					should.equal(res.body.data[0].link, null);
+					done();
+				});
+			});
+		let link_id;
+		it("should add a link record", done => {
+			chai.request(server)
+				.post(`/api/link`)
+				.auth(init.email, init.password)
+				.send({
+					name: "cache_test",
+					val: "YoYoYo"
+				})
+				.end((err, res) => {
+					// console.log(res.body)
+					res.should.have.status(200);
+					res.body.data.should.have.property("_id");
+					link_id = res.body.data._id;
+					done();
+				});
+		});
+		it("should put link_id into test record", done => {
+			chai.request(server)
+				.put(`/api/test/${test_id}`)
+				.auth(init.admin_email, init.admin_password)
+				.send({
+					link_id
+				})
+				.end((err, res) => {
+					// console.log(res.body)
+					res.should.have.status(200);
+					res.body.data.should.have.property("_id");
+					res.body.data.link_id.should.equal(link_id);
+					done();
+				});
+		});
+		it("should get a test record with link", done => {
+			chai.request(server)
+				.get(`/api/test?populate=link&limit=1`)
+				.auth(init.email, init.password)
+				.end((err, res) => {
+					// console.log(res.body)
+					res.should.have.status(200);
+					res.body.data[0].should.have.property("_id");
+					res.body.data[0].should.have.property("link");
+					res.body.data[0].link.should.not.equal(null);
+					res.body.data[0].link._id.should.equal(link_id);
+					res.body.data[0].link.name.should.equal("cache_test");
+					res.body.data[0].link.val.should.equal("YoYoYo");
+					res.headers["jxp-cache"].should.equal("miss");
+					done();
+				});
+		});
+		it("should update link record", done => {
+			chai.request(server)
+				.put(`/api/link/${link_id}`)
+				.auth(init.admin_email, init.admin_password)
+				.send({
+					val: "YoYoYo2"
+				})
+				.end((err, res) => {
+					// console.log(res.body)
+					res.should.have.status(200);
+					res.body.data.should.have.property("_id");
+					res.body.data.val.should.equal("YoYoYo2");
+					done();
+				});
+		});
+		it("should get a test record with updated link", done => {
+			chai.request(server)
+				.get(`/api/test?populate=link&limit=1`)
+				.auth(init.email, init.password)
+				.end((err, res) => {
+					// console.log(res.body.data[0].link)
+					res.should.have.status(200);
+					res.body.data[0].should.have.property("_id");
+					res.body.data[0].should.have.property("link");
+					res.body.data[0].link.should.not.equal(null);
+					res.body.data[0].link._id.should.equal(link_id);
+					res.body.data[0].link.name.should.equal("cache_test");
+					res.body.data[0].link.val.should.equal("YoYoYo2");
+					res.headers["jxp-cache"].should.equal("miss");
+					done();
+				});
+		});
+	})
 });