jxp 2.13.0 → 2.13.1

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

@@ -3,45 +3,74 @@ const config = require('config');
 const cache = new NodeCache({ stdTTL: config.cache?.ttl || 5 * 60 });
 
 const generateKey = (req) => {
-    const url = req.url
-    return url
+    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 = (req, res, next) => {
-    if (!config.cache?.enabled) return next();
+const set = async (req, res) => {
+    if (!config.cache?.enabled) return;
     const key = generateKey(req)
     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 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')
-    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) => {
+const stats = async (req, res) => {
     if (!config.cache?.enabled) 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,
@@ -949,6 +947,9 @@ const JXP = function(options) {
 		config.pre_hooks.put,
 		actionPut,
 		cache.clear,
+		(req, res, next) => {
+			next();
+		},
 	);
 	server.del(
 		"/api/:modelname/:item_id",
@@ -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
 	);
 

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.1",
   "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

@@ -1173,11 +1173,10 @@ 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();
 			});
 		})