jxp 2.12.4 → 2.13.1

package/docs/caching.md

@@ -0,0 +1,13 @@
+# Caching
+
+Enable caching to speed up your queries. Caching is disabled by default. Enable caching through the config:
+
+```JSON
+{
+    "cache": {
+        "enabled": true,
+        "debug": false,
+        "ttl": 3600
+    }
+}
+```

package/libs/cache.js

@@ -0,0 +1,76 @@
+const NodeCache = require('node-cache');
+const config = require('config');
+const cache = new NodeCache({ stdTTL: config.cache?.ttl || 5 * 60 });
+
+const generateKey = (req) => {
+    let key = `${req.modelname}/`;
+    if (req.params.item_id) {
+        key += `${req.params.item_id}`
+    }
+    if (req.query) {
+        key += `?${JSON.stringify(req.query)}`
+    }
+    return key;
+}
+
+const set = async (req, res) => {
+    if (!config.cache?.enabled) return;
+    const key = generateKey(req)
+    cache.set(key, res.result)
+    if (config.cache?.debug) {
+        console.log('cache set', key)
+    }
+}
+
+const get = async (req, res) => {
+    if (!config.cache?.enabled) return;
+    const key = generateKey(req)
+    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')
+}
+
+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()
+}
+
+const stats = async (req, res) => {
+    if (!config.cache?.enabled) return {};
+    res.result = cache.getStats()
+}
+
+module.exports = {
+    set,
+    get,
+    clear,
+    clearAll,
+    stats,
+}

package/libs/jxp.js

@@ -15,6 +15,7 @@ const modeldir = require("./modeldir");
 const query_manipulation = require("./query_manipulation");
 const corsMiddleware = require('restify-cors-middleware2');
 const json2csv = require('json2csv').parse;
+const cache = require("./cache");
 global.JXPSchema = require("./schema");
 
 var models = {};
@@ -53,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());
@@ -202,7 +202,7 @@ const actionGetOne = async (req, res) => {
 	console.time(opname);
 	try {
 		const data = await getOne(req.Model, req.params.item_id, req.query, { user: res.user });
-		res.send({ data });
+		res.result = { data };
 		if (debug) console.timeEnd(opname);
 	} catch(err) {
 		console.error(new Date(), err);
@@ -908,7 +908,9 @@ const JXP = function(options) {
 		security.login,
 		security.auth,
 		config.pre_hooks.get,
+		cache.get,
 		actionGet,
+		cache.set,
 		outputJSON
 	);
 	server.get(
@@ -917,7 +919,10 @@ const JXP = function(options) {
 		security.login,
 		security.auth,
 		config.pre_hooks.getOne,
-		actionGetOne
+		cache.get,
+		actionGetOne,
+		cache.set,
+		outputJSON
 	);
 	server.post(
 		"/api/:modelname",
@@ -927,6 +932,7 @@ const JXP = function(options) {
 		middlewarePasswords,
 		config.pre_hooks.post,
 		actionPost,
+		cache.clear,
 		(req, res, next) => {
 			next();
 		},
@@ -940,6 +946,10 @@ const JXP = function(options) {
 		middlewareCheckAdmin,
 		config.pre_hooks.put,
 		actionPut,
+		cache.clear,
+		(req, res, next) => {
+			next();
+		},
 	);
 	server.del(
 		"/api/:modelname/:item_id",
@@ -948,6 +958,7 @@ const JXP = function(options) {
 		security.auth,
 		config.pre_hooks.delete,
 		actionDelete,
+		cache.clear,
 	);
 
 	// Count
@@ -957,7 +968,9 @@ const JXP = function(options) {
 		security.login,
 		security.auth,
 		config.pre_hooks.get,
+		// cache.get,
 		actionCount,
+		// cache.set,
 		outputJSON
 	);
 
@@ -1009,6 +1022,7 @@ const JXP = function(options) {
 		middlewareCheckAdmin,
 		config.pre_hooks.update,
 		actionUpdate,
+		cache.clear,
 	);
 
 	/* Batch routes - ROLLED BACK FOR NOW */
@@ -1020,21 +1034,24 @@ const JXP = function(options) {
 		middlewareModel,
 		security.login,
 		security.auth,
-		actionCall
+		actionCall,
+		cache.clear,
 	);
 	server.post(
 		"/call/:modelname/:method_name",
 		middlewareModel,
 		security.login,
 		security.auth,
-		actionCall
+		actionCall,
+		cache.clear,
 	);
 	server.get(
 		"/call/:modelname/:item_id/:method_name",
 		middlewareModel,
 		security.login,
 		security.auth,
-		actionCallItem
+		actionCallItem,
+		cache.clear,
 	);
 
 	/* Login and authentication */
@@ -1081,6 +1098,11 @@ const JXP = function(options) {
 
 	/* Websocket */
 	server.on("upgrade", ws.upgrade)
+
+	/* Cache */
+	server.get("/cache/stats", cache.stats, outputJSON);
+	server.get("/cache/clear", cache.clear, 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.12.4",
+  "version": "2.13.1",
   "private": false,
   "main": "libs/jxp.js",
   "scripts": {
@@ -45,6 +45,7 @@
     "mongoose": "6.8.4",
     "mongoose-friendly": "^0.1.4",
     "morgan": "^1.10.0",
+    "node-cache": "^5.1.2",
     "nodemailer": "^6.9.0",
     "nodemailer-smtp-transport": "^2.7.4",
     "path": "^0.12.7",

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

@@ -127,7 +127,6 @@ describe('Test', () => {
 				.get("/api/user")
 				.auth(init.email, init.password)
 				.end((err, res) => {
-					// console.log(res.body);
 					res.should.have.status(200);
 					res.body.data.should.be.an('array');
 					done();
@@ -166,7 +165,6 @@ describe('Test', () => {
 			chai.request(server)
 				.get(`/api/user`)
 				.end((err, res) => {
-					// console.log(res.body);
 					res.should.have.status(403);
 					done();
 				});
@@ -374,7 +372,6 @@ describe('Test', () => {
 			.get(`/api/test/${post_id}?populate=link`)
 			.auth(init.email, init.password)
 			.end((err, res) => {
-				// console.log(res.body);
 				res.should.have.status(200);
 				res.body.should.have.property("data");
 				res.body.data.should.have.property("link");
@@ -391,7 +388,6 @@ describe('Test', () => {
 				.get(`/api/test/${post_id}?populate=other_link`)
 				.auth(init.email, init.password)
 				.end((err, res) => {
-					// console.log(res.body);
 					res.should.have.status(200);
 					res.body.should.have.property("data");
 					res.body.data.should.have.property("other_link")
@@ -408,7 +404,6 @@ describe('Test', () => {
 			.get(`/api/test?autopopulate=true`)
 			.auth(init.email, init.password)
 			.end((err, res) => {
-				// console.log(res.body);
 				res.should.have.status(200);
 				res.body.data[0].should.have.property("link")
 				res.body.data[0].link.should.be.an('object');
@@ -426,7 +421,6 @@ describe('Test', () => {
 				.get(`/api/test/${post_id}?autopopulate=true`)
 				.auth(init.email, init.password)
 				.end((err, res) => {
-					// console.log(res.body);
 					res.should.have.status(200);
 					res.body.data.should.have.property("link")
 					res.body.data.link.should.be.an('object');
@@ -444,7 +438,6 @@ describe('Test', () => {
 			.get(`/api/test/${post_id}?populate=link`)
 			.auth(init.email, init.password)
 			.end((err, res) => {
-				console.log(res.body);
 				res.should.have.status(200);
 				res.body.should.have.property("data");
 				res.body.data.should.have.property("link")
@@ -573,7 +566,6 @@ describe('Test', () => {
 				.get(`/api/test?populate=array_link`)
 				.auth(init.email, init.password)
 				.end((err, res) => {
-					// console.log(res.body);
 					res.should.have.status(200);
 					res.body.data[0].should.have.property("array_link");
 					res.body.data[0].array_link.should.be.an("array");
@@ -727,7 +719,6 @@ describe('Test', () => {
 				.send({ query })
 				.end((err, res) => {
 					res.should.have.status(200);
-					// console.log(res.body);
 					res.body.data.should.be.an('array');
 					res.body.data[0].should.have.property("_id");
 					res.body.data[0].should.have.property("count");
@@ -876,7 +867,6 @@ describe('Test', () => {
 				.del(`/api/test/${post_id}`)
 				.auth(init.email, init.password)
 				.end((err, res) => {
-					// console.log(res.body);
 					res.should.have.status(200);
 					res.body.status.should.equal('ok');
 					done();
@@ -887,7 +877,6 @@ describe('Test', () => {
 				.get(`/api/test/${post_id}`)
 				.auth(init.email, init.password)
 				.end((err, res) => {
-					// console.log(res.body);
 					res.should.have.status(404);
 					res.body.message.should.equal(`Document ${post_id} is deleted on Test`);
 					res.body.code.should.equal('NotFound');
@@ -992,7 +981,6 @@ describe('Test', () => {
 				.auth(init.email, init.password)
 				.end((err, res) => {
 					res.should.have.status(409);
-					// console.log(res.body.message);
 					res.body.message.should.equal(`Parent link item exists in test/link_id`);
 					done();
 				});
@@ -1002,7 +990,6 @@ describe('Test', () => {
 				.del(`/api/link/${link_id}?_cascade=1`)
 				.auth(init.email, init.password)
 				.end((err, res) => {
-					// console.log(res.body, res.status);
 					res.should.have.status(200);
 					res.body.status.should.equal('ok');
 					done();
@@ -1133,12 +1120,65 @@ describe('Test', () => {
 				bar: "Throw an error"
 			})
 			.end((err, res) => {
-				// console.log(res.body);
-				console.log(res.headers);
 				res.should.have.status(418);
 				res.body.message.should.equal(`I'm a teapot`);
 				done();
 			});
 		})
 	});
+
+	describe("Caching", () => {
+		it ("should give us cache stats", (done) => {
+			chai.request(server)
+			.get("/cache/stats")
+			.end((err, res) => {
+				// console.log(res.body);
+				res.should.have.status(200);
+				res.body.should.have.property("hits");
+				done();
+			});
+		})
+		it ("should clear the cache stats", (done) => {
+			chai.request(server)
+			.get("/cache/clear")
+			.end((err, res) => {
+				console.log(res.body);
+				res.should.have.status(200);
+				done();
+			});
+		});
+		it ("should get an uncached request", (done) => {
+			chai.request(server)
+			.get("/api/test")
+			.auth(init.email, init.password)
+			.end((err, res) => {
+				res.should.have.status(200);
+				res.headers.should.have.property("jxp-cache");
+				res.headers["jxp-cache"].should.equal("miss");
+				done();
+			});
+		});
+		it ("should get an cached request", (done) => {
+			chai.request(server)
+			.get("/api/test")
+			.auth(init.email, init.password)
+			.end((err, res) => {
+				res.should.have.status(200);
+				res.headers.should.have.property("jxp-cache");
+				res.headers["jxp-cache"].should.equal("hit");
+				done();
+			});
+		});
+		it ("should give us cache stats", (done) => {
+			chai.request(server)
+			.get("/cache/stats")
+			.end((err, res) => {
+				res.should.have.status(200);
+				res.body.should.have.property("hits");
+				res.body.hits.should.be.greaterThan(0);
+				res.body.misses.should.be.greaterThan(0);
+				done();
+			});
+		})
+	});
 });