jxp 2.13.0 → 2.13.2

package/docs/caching.md

@@ -6,6 +6,7 @@ Enable caching to speed up your queries. Caching is disabled by default. Enable
 {
     "cache": {
         "enabled": true,
+        "debug": false,
         "ttl": 3600
     }
 }

package/libs/cache.js

@@ -2,46 +2,81 @@ const NodeCache = require('node-cache');
 const config = require('config');
 const cache = new NodeCache({ stdTTL: config.cache?.ttl || 5 * 60 });
 
-const generateKey = (req) => {
-    const url = req.url
-    return url
+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}`
+    }
+    if (req.query) {
+        key += `?${JSON.stringify(req.query)}`
+    }
+    res.jxp_cache_key = key;
+    return key;
 }
 
-const set = (req, res, next) => {
-    if (!config.cache?.enabled) return next();
-    const key = generateKey(req)
+const set = async (req, res) => {
+    if (!config.cache?.enabled) return;
+    const key = generateKey(req, res)
     cache.set(key, res.result)
-    next()
+    if (config.cache?.debug) {
+        console.log('cache set', key)
+    }
 }
 
 const get = (req, res, next) => {
-    if (!config.cache?.enabled) return next();
-    const key = generateKey(req)
+    if (!config.cache?.enabled) return;
+    const key = generateKey(req, res)
+    res.header('jxp-cache-key', key);
     const cached = cache.get(key)
     if (cached) {
+        if (config.cache?.debug) {
+            console.log('cache hit', key)
+        }
         res.header('jxp-cache', 'hit')
         res.result = cached
         return res.send(res.result)
     }
+    if (config.cache?.debug) {
+        console.log('cache miss', key)
+    }
     res.header('jxp-cache', 'miss')
     next()
 }
 
-const clear = (req, res, next) => {
-    if (!config.cache?.enabled) return next();
+const clear = async (req, res) => {
+    if (!config.cache?.enabled) return;
+    const keys = cache.keys()
+    keys.forEach(key => {
+        if (key.startsWith(`${req.modelname}/`)) {
+            if (config.cache?.debug) {
+                console.log('cache del', key)
+            }
+            cache.del(key)
+        }
+    })
+}
+
+const clearAll = async () => {
+    if (!config.cache?.enabled) return;
+    if (config.cache?.debug) {
+        console.log('cache flushAll')
+    }
     cache.flushAll()
-    next()
 }
 
-const stats = (req, res, next) => {
-    if (!config.cache?.enabled) return {};
+const stats = async (req, res) => {
+    if (!config.cache?.enabled) {
+        res.result = { cache_enabled: false }
+        return;
+    }
     res.result = cache.getStats()
-    next()
 }
 
 module.exports = {
     set,
     get,
     clear,
-    stats
+    clearAll,
+    stats,
 }

package/libs/jxp.js

@@ -54,10 +54,9 @@ const middlewareCheckAdmin = (req, res, next) => {
 };
 
 // Outputs whatever is in res.result as JSON
-const outputJSON = (req, res, next) => {
+const outputJSON = async (req, res) => {
 	try {
 		res.send(res.result);
-		next();
 	} catch (err) {
 		console.error(new Date(), err);
 		throw new errors.InternalServerError(err.toString());
@@ -919,7 +918,6 @@ const JXP = function(options) {
 		middlewareModel,
 		security.login,
 		security.auth,
-		cache.get,
 		config.pre_hooks.getOne,
 		cache.get,
 		actionGetOne,
@@ -934,7 +932,7 @@ const JXP = function(options) {
 		middlewarePasswords,
 		config.pre_hooks.post,
 		actionPost,
-		cache.clear,
+		cache.clearAll,
 		(req, res, next) => {
 			next();
 		},
@@ -948,7 +946,10 @@ const JXP = function(options) {
 		middlewareCheckAdmin,
 		config.pre_hooks.put,
 		actionPut,
-		cache.clear,
+		cache.clearAll,
+		(req, res, next) => {
+			next();
+		},
 	);
 	server.del(
 		"/api/:modelname/:item_id",
@@ -957,7 +958,7 @@ const JXP = function(options) {
 		security.auth,
 		config.pre_hooks.delete,
 		actionDelete,
-		cache.clear,
+		cache.clearAll,
 	);
 
 	// Count
@@ -967,9 +968,9 @@ const JXP = function(options) {
 		security.login,
 		security.auth,
 		config.pre_hooks.get,
-		cache.get,
+		// cache.get,
 		actionCount,
-		cache.set,
+		// cache.set,
 		outputJSON
 	);
 
@@ -1021,7 +1022,7 @@ const JXP = function(options) {
 		middlewareCheckAdmin,
 		config.pre_hooks.update,
 		actionUpdate,
-		cache.clear,
+		cache.clearAll,
 	);
 
 	/* Batch routes - ROLLED BACK FOR NOW */
@@ -1034,7 +1035,7 @@ const JXP = function(options) {
 		security.login,
 		security.auth,
 		actionCall,
-		cache.clear,
+		cache.clearAll,
 	);
 	server.post(
 		"/call/:modelname/:method_name",
@@ -1042,7 +1043,7 @@ const JXP = function(options) {
 		security.login,
 		security.auth,
 		actionCall,
-		cache.clear,
+		cache.clearAll,
 	);
 	server.get(
 		"/call/:modelname/:item_id/:method_name",
@@ -1050,7 +1051,7 @@ const JXP = function(options) {
 		security.login,
 		security.auth,
 		actionCallItem,
-		cache.clear,
+		cache.clearAll,
 	);
 
 	/* Login and authentication */
@@ -1100,7 +1101,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/mkdocs.yml

@@ -11,6 +11,7 @@ nav:
   - Aggregations: aggregations.md
   - Bulk Writes: bulk_writes.md
   - Queries: queries.md
+  - Caching: caching.md
   - Websocket: websocket.md
   - Special Features: special.md
   - Changelog: changelog.md

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.0",
+  "version": "2.13.2",
   "private": false,
   "main": "libs/jxp.js",
   "scripts": {

package/test/init.js

@@ -8,6 +8,7 @@ global.JXPSchema = require("../libs/schema");
 const User = require(path.join(model_dir, "user_model"));
 const Apikey = require(path.join(model_dir, "apikey_model"));
 const Test = require(path.join(model_dir, "test_model"));
+const cache = require("../libs/cache");
 
 const security = require("../libs/security");
 
@@ -38,6 +39,7 @@ const admin_password = "SecretPassword";
 
 const init = async () => {
 	try {
+		await cache.clearAll();
 		await empty_user_collections();
 		await post(User, { name: "Admin User", email: admin_email, password: security.encPassword(admin_password), urlid: "admin-user", admin: true });
 		await post(User, { name: "Test User", email, password: security.encPassword(password), urlid: "test-user" });

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();
 			});
@@ -1173,13 +1173,124 @@ describe('Test', () => {
 			chai.request(server)
 			.get("/cache/stats")
 			.end((err, res) => {
-				// console.log(res.body);
 				res.should.have.status(200);
 				res.body.should.have.property("hits");
-				res.body.hits.should.equal(1);
-				res.body.misses.should.equal(1);
+				res.body.hits.should.be.greaterThan(0);
+				res.body.misses.should.be.greaterThan(0);
 				done();
 			});
 		})
 	});
+	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();
+				});
+		});
+	})
 });