no message

Author: Carlos R. L. Rodrigues

.gitignore

@@ -0,0 +1,62 @@
+.vscode
+dist/
+
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (http://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# Typescript v1 declaration files
+typings/
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variables file
+.env
+

README.md

@@ -0,0 +1,2 @@
+# node-cache-layer
+Cache layer for express framework

cache-config.json

@@ -0,0 +1,35 @@
+{
+	"prefix": "cache_",
+	"handler": "",
+	"status": [
+		200
+	],
+	"default_expire": 86400,
+	"rules": [
+		{
+			"name": "Home",
+			"group": "static",
+			"route": "/test",
+			"regex": "test/[0-9]+",
+			"ignore_case": false,
+			"expire": 10,
+			"methods": [ "OPTIONS", "GET", "HEAD", "POST", "PUT", "DELETE", "TRACE", "CONNECT" ],
+			"variables": {
+				"params": [ "product_id", "id" ],
+				"query": [
+					"get_var",
+					{
+						"value": "search",
+						"ignore_case": true
+					},
+					"abc"
+				],
+				"cookies": [ "cookie_name" ],
+				"body": [ "post_var", "username" ],
+				"session": [ "post_var", "username" ],
+				"header": [ "Authorization" ],
+				"subdomains": [ "static" ]
+			}
+		}
+	]
+}

index.ts

@@ -0,0 +1,85 @@
+import { config, updateConfig, loadHandler } from "./src/config"
+import { RouteCheck } from "./src/RouteCheck"
+
+export default (options: any = {}) => {
+	updateConfig(options);
+
+	const module = loadHandler(config);
+	const cacheControl = new module.Handler(config);
+
+	return (req, res, next) => {
+		const route = new RouteCheck(req);
+		if (!route.isCacheable)
+			return next();
+
+		const end = res.end;
+		const write = res.write;
+		const cache = [];
+		const key = route.key;
+		const expire = route.expire;
+
+		cacheControl.get(key, (error, reply) => {
+			if (error) {
+				return next();
+			}
+			else if (reply) {
+				// TESTTEEEEE
+				reply.header["x-cached"] = "1";
+				res.set(reply.header);
+
+				res.removeHeader("X-Powered-By");
+
+				return res.end(reply.content, reply.encoding);
+			}
+			else {
+				res.write = function (chunk, encoding) {
+					if(typeof chunk == "string") {
+						chunk = Buffer.from(chunk, encoding);
+					}
+
+					cache.push(chunk);
+					write.call(res, chunk, encoding);
+				}
+
+				res.end = function (chunk, encoding) {
+					if (chunk)
+						this.write(chunk, encoding);
+
+					if(!~config.status.indexOf(res.statusCode)){
+						end.call(res);
+						return;
+					}
+
+					// TESTEEEE
+					cache.push(Buffer.from("<hr /><b>cac<font color='red'>hed</font></b>", encoding));
+
+					const now = new Date();
+					let dateExpire = new Date();
+					dateExpire.setSeconds(now.getSeconds() + expire);
+
+					const rawUrl = req.originalUrl;
+					const buf = Buffer.concat(cache);
+
+					const headers = route.mergeHeaders(
+						res._headers,
+						{
+							"Content-Length": buf.length,
+							"Last-Modified": now.toUTCString(),
+							"Cache-Control": "max-age=" + (dateExpire.getTime() / 1000)
+						}
+					);
+					
+					cacheControl.set(
+						key,
+						buf,
+						headers,
+						rawUrl,
+						expire
+					);
+					end.call(res);
+				};
+				return next();
+			}
+		});
+	}
+}

package.json

@@ -0,0 +1,35 @@
+{
+	"name": "node-cache-layer",
+	"version": "0.0.1",
+	"description": "Extensible cache layer for express framework.",
+	"main": "dist/index",
+	"typings": "dist/index",
+	"scripts": {
+		"prepublishOnly": "npm run compile",
+		"compile": "tsc -p ."
+	},
+	"bugs": {
+		"url": "http://github.com/JSFromHell/node-cache-layer/issues"
+	},
+	"repository": {
+		"type": "git",
+		"url": "http://github.com/JSFromHell/node-cache-layer.git"
+	},
+	"keywords": [
+		"cache",
+		"cache layer",
+		"node cache layer",
+		"nosql cache",
+		"express cache",
+		"response cache"
+	],
+	"author": "Carlos R. L. Rodrigues",
+	"license": "MIT",
+	"devDependencies": {
+		"@types/node": "^8.0.0",
+		"typescript": "^2.6.1"
+	},
+	"files": [
+		"dist/*"
+	]
+}

src/RouteCheck.ts

@@ -0,0 +1,143 @@
+import { config } from "./config"
+import { hash } from "./hash"
+import * as url from "url"
+
+export class RouteCheck {
+	private _key: string;
+	private _expire: number;
+	private _url: string;
+	private _original: string;
+
+	private _isCacheable: boolean = false;
+	constructor(private req) {
+		this._original = url.parse(req.originalUrl).pathname;
+		if(config.ignore_case) {
+			this._original = this._original.toLocaleLowerCase();
+		}
+
+		const mayCache = this.matchesRule();
+		if (mayCache) {
+			if (typeof config.isCacheable == "function") {
+				this._isCacheable = config.isCacheable(this.req);
+			}
+			else {
+				this._isCacheable = true;
+			}
+		}
+	}
+
+	private getNormalizedKey(): string {
+		const vars = config.variables;
+
+		let baseUrl: string[] = [
+			this._original,
+			this.req.method
+		];
+		let param: string[] = [];
+
+		for (let o in vars) {
+			if (o in this.req) {
+				const values = this.req[o];
+				const type = vars[o];
+				for (let i = 0; i < type.length; i++) {
+					let n: string;
+					let v: string;
+					if (typeof type[i] == "object") {
+						[n, v] = [type[i].value, values[n]];
+
+						if (typeof v == "undefined") {
+							continue;
+						}
+
+						if (type[i].ignore_case) {
+							v = v.toLocaleLowerCase();
+						}
+					}
+					else {
+						[n, v] = [type[i], values[i]];
+
+						if (typeof v == "undefined") {
+							continue;
+						}
+					}
+					param.push(n + "=" + v);
+				}
+			}
+		}
+
+		if (param.length) {
+			baseUrl.push("?");
+		}
+		return baseUrl.join("_") + param.join("&");
+	}
+
+	private hasMethod(rule: any): boolean {
+		if (rule.methods && rule.methods != "*") {
+			if (!~rule.methods.indexOf(this.req.method)) {
+				return false;
+			}
+		}
+		return true;
+	}
+
+	private matchesRule(): boolean {
+		let url = this._original;
+		let has: boolean = false;
+
+		let rule;
+		for (rule of config.rules) {
+			if(!this.hasMethod(rule))
+				continue;
+			
+			if (rule.regex && rule.regex.test(url)) {
+				has = true;
+				break;
+			}
+			else if (rule.route) {
+				if (rule.route == url) {
+					has = true;
+					break;
+				}
+			}
+		}
+		if (has) {
+			this.useMatchedRule(rule);
+		}
+		return has;
+	}
+
+	private useMatchedRule(rule) {
+		let group = rule.group ? rule.group + "_" : "";
+		this._url = this.getNormalizedKey();
+		this._key = group + hash(this._url);
+		this._expire = rule.expire;
+	}
+
+	get isCacheable(): boolean {
+		return this._isCacheable;
+	}
+
+	get key(): string {
+		return this._key;
+	}
+
+	get expire(): number {
+		return this._expire;
+	}
+
+	get normalizedKey(): string {
+		return this._url;
+	}
+
+	mergeHeaders(original: any, newValues: any): any {
+		let head = Object.assign({}, original);
+
+		for (let o in head) {
+			let n = o.toLocaleLowerCase();
+			if (n in newValues)
+				delete head[o];
+		}
+
+		return Object.assign(head, newValues);
+	}
+}