tileblaster 1.0.5 → 1.0.7

package/builtins/check.js

@@ -2,13 +2,27 @@
 
 const cache = {};
 
-module.exports = function({ req, res, opts, data }, next){
+module.exports = function({ req, res, opts, data }, next, skip){
 
 	// fill cache for map
 	if (!cache.hasOwnProperty(data.map)) {
 
 		cache[data.map] = {};
 
+		// skip function
+		cache[data.map].abort = function(err){
+			if (res.used) return;
+			res.statusCode = cache[data.map].status;
+			if (cache[data.map].hints && err) res.setHeader("x-tileblaster-hint", err.message || err.toString());
+			res.end();
+			res.used = true; // mark connection as used
+			return skip(); // skip rest of jobs
+		};
+
+		cache[data.map].status = (opts.status && Number.isInteger(opts.status)) ? opts.status : 204;
+
+		cache[data.map].hints = !!opts.hints;
+
 		// assume reasonable default if no zoom level was specified
 		cache[data.map].zoom = (!opts.zoom || opts.zoom.length === 0) ? [ 0, 24 ] : opts.zoom;
 
@@ -86,28 +100,28 @@ module.exports = function({ req, res, opts, data }, next){
 	opts = cache[data.map];
 
 	// check for NaNs
-	if (isNaN(data.req.params.z) || isNaN(data.req.params.x) || isNaN(data.req.params.y)) return next(new Error("illegal zxy."));
+	if (isNaN(data.req.params.z) || isNaN(data.req.params.x) || isNaN(data.req.params.y)) return cache[data.map].abort(new Error("illegal zxy."));
 
 	// check zoom
-	if (data.req.params.z < opts.minZoom || data.req.params.z > opts.maxZoom) return next(new Error("illegal zoom."));
+	if (data.req.params.z < opts.minZoom || data.req.params.z > opts.maxZoom) return cache[data.map].abort(new Error("illegal zoom."));
 
 	// check bounds
 	if (opts.bounds) {
 		if (opts.bounds[data.req.params.z][0] < opts.bounds[data.req.params.z][2]) { // check for bounds spanning antimeridian
 			// bounds don't span antimeridian
-			if (data.req.params.x < opts.bounds[data.req.params.z][0] || data.req.params.x > opts.bounds[data.req.params.z][2]) return next(new Error("x is out of bounds."));
+			if (data.req.params.x < opts.bounds[data.req.params.z][0] || data.req.params.x > opts.bounds[data.req.params.z][2]) return cache[data.map].abort(new Error("x is out of bounds."));
 		} else {
 			// bounds span antimeridian
-			if (data.req.params.x > opts.bounds[data.req.params.z][0] && data.req.params.x < opts.bounds[data.req.params.z][2]) return next(new Error("x is out of bounds, bounds span antimeridian"));
+			if (data.req.params.x > opts.bounds[data.req.params.z][0] && data.req.params.x < opts.bounds[data.req.params.z][2]) return cache[data.map].abort(new Error("x is out of bounds, bounds span antimeridian"));
 		}
-		if (data.req.params.y < opts.bounds[data.req.params.z][1] || data.req.params.y > opts.bounds[data.req.params.z][3]) return next(new Error("y is out of bounds."));
+		if (data.req.params.y < opts.bounds[data.req.params.z][1] || data.req.params.y > opts.bounds[data.req.params.z][3]) return cache[data.map].abort(new Error("y is out of bounds."));
 	}
 
 	// check extension
-	if (opts.extensions.length > 0 && !opts.extensions.includes(data.req.params.e) && !opts.extensions.includes(data.req.params.f)) return next(new Error("illegal extension."));
+	if (opts.extensions.length > 0 && !opts.extensions.includes(data.req.params.e) && !opts.extensions.includes(data.req.params.f)) return cache[data.map].abort(new Error("illegal extension."));
 
 	// check density
-	if (opts.density && !opts.density.includes(data.req.params.d) && !opts.density.includes(data.req.params.f)) return next(new Error("illegal density marker."));
+	if (opts.density && !opts.density.includes(data.req.params.d) && !opts.density.includes(data.req.params.f)) return cache[data.map].abort(new Error("illegal density marker."));
 
 	// all passed
 	next();

package/builtins/compress.js

@@ -39,7 +39,7 @@ module.exports = function({ req, res, opts, data }, next){
 		if (opts.brotli) promises.push(new Promise(function(resolve, reject) {
 			brotli(tile.buffer, opts.brotli).then(function(compressed){
 				if (compressed.length > tile.buffer.length) {
-					debug.warn("Discarding useless Brotli compression for %s: +%db", data.path.magenta, compressed.length-tile.buffer.length);
+					debug.warn("Discarding useless Brotli compression for %s: +%db", tile.path.magenta, compressed.length-tile.buffer.length);
 					return resolve();
 				};
 				data.tiles.push({
@@ -52,7 +52,7 @@ module.exports = function({ req, res, opts, data }, next){
 				});
 				resolve();
 			}).catch(function(err){
-				debug.error("Brotli failed for %s: %s", data.path.magenta, err);
+				debug.error("Brotli failed for %s: %s", tile.path.magenta, err);
 				reject(err);
 			});
 		}));
@@ -60,7 +60,7 @@ module.exports = function({ req, res, opts, data }, next){
 		if (opts.gzip) promises.push(new Promise(function(resolve, reject) {
 			gzip(tile.buffer, opts.gzip).then(function(compressed){
 				if (compressed.length > tile.buffer.length) {
-					debug.warn("Discarding useless Gzip compression for %s: +%db", data.path.magenta, compressed.length-tile.buffer.length);
+					debug.warn("Discarding useless Gzip compression for %s: +%db", tile.path.magenta, compressed.length-tile.buffer.length);
 					return resolve();
 				}
 				data.tiles.push({
@@ -73,7 +73,7 @@ module.exports = function({ req, res, opts, data }, next){
 				});
 				resolve();
 			}).catch(function(err){
-				debug.error("Gzip failed for %s: %s", data.path.magenta, err);
+				debug.error("Gzip failed for %s: %s", tile.path.magenta, err);
 				reject(err);
 			});
 		}));

package/builtins/cors.js

@@ -1,6 +1,6 @@
 // send cors headers.
 
-module.exports = function({ req, res, opts, data }, next){
+module.exports = function({ req, res, opts, data }, next, skip){
 
 	// only if origin header is set
 	if (!req.headers.hasOwnProperty("origin") || !req.headers.origin) return next();
@@ -15,6 +15,7 @@ module.exports = function({ req, res, opts, data }, next){
 	if (!opts.origins.includes("*") && opts.origins.includes(req.headers.origin)) return next();
 
 	// send common headers
+	res.setHeader("Vary", "Origin"); // important for caching
 	res.setHeader("Access-Control-Allow-Origin", req.headers.origin||"*");
 	res.setHeader("Access-Control-Allow-Methods", "GET, OPTIONS");
 	res.setHeader("Access-Control-Allow-Headers", "DNT,If-None-Match,If-Modified-Since,Cache-Control,Content-Type,Range,Accept-Encoding");
@@ -27,6 +28,8 @@ module.exports = function({ req, res, opts, data }, next){
 		res.setHeader("Content-Length", 0);
 		res.statusCode = 204;
 		res.end();
+		res.used = true;
+		return skip();
 	};
 
 	next();

package/builtins/deliver.js

@@ -10,6 +10,7 @@ module.exports = function({ res, opts, data }, next){
 	if (data.tile.buffer.length === 0) {
 		res.statusCode = 204;
 		res.end();
+		res.used = true;
 		return next();
 	}
 

package/builtins/dump.js

@@ -12,7 +12,6 @@ module.exports = function({ res, data }, next, skip){
 	res.statusCode = 200;
 	res.setHeader("content-type", "text/plain");
 	res.end(dump);
-
 	res.used = true;
 	skip();
 

package/builtins/edit.js

@@ -19,7 +19,7 @@ module.exports = function({ req, res, opts, data }, next){
 		return tile.type === "pbf";
 	}).forEach(function(tile){
 		try {
-			tile.buffer = vtt.pack(opts.edit(vtt.unpack(tile.buffer)));
+			tile.buffer = Buffer.from(vtt.pack(opts.edit(vtt.unpack(tile.buffer))));
 		} catch (err) {
 			debug.error("Editing vector tile failed:", err);
 		}

package/builtins/versatiles.js

@@ -4,7 +4,7 @@ const versatiles = load("versatiles");
 const cache = {};
 
 // versatiles backend
-module.exports = function({ req, res, opts, data }, next){
+module.exports = function({ req, res, opts, data }, next, skip){
 	const mime = this.lib.mime;
 	const debug = this.lib.debug;
 
@@ -16,12 +16,23 @@ module.exports = function({ req, res, opts, data }, next){
 			tms: (!!opts.tms),
 			headers: ((opts.hasOwnProperty("headers")) ? opts.headers : {}),
 		});
+
+		// skip function
+		cache[data.map].abort = function(err){
+			if (res.used) return;
+			res.statusCode = 204; // no content
+			res.setHeader("x-tileblaster-hint", err.message || err.toString());
+			res.end();
+			res.used = true; // mark connection as used
+			return skip(); // skip rest of jobs
+		};
+
 	};
 	const vt = cache[data.map];
 
 	debug.info("Fetching %s/%s/%s", data.req.params.z, data.req.params.x, data.req.params.y);
 	vt.getTile(data.req.params.z, data.req.params.x, data.req.params.y, function(err, buf){
-		if (err) return next(err);
+		if (err) return cache[data.map].abort(err); // fail gracefully
 
 		// if precompressed, keep in tile stack
 		/* TODO evaluate side effects
@@ -40,7 +51,7 @@ module.exports = function({ req, res, opts, data }, next){
 
 		// decompress tile
 		vt.decompress(vt.header.tile_precompression, buf, function(err, buf){
-			if (err) return next(err);
+			if (err) return cache[data.map].abort(err); // fail gracefully
 
 			const tile = {
 				buffer: buf,

package/config.dist.js

@@ -68,7 +68,9 @@ const config = module.exports = {
 			density: [ "", "@2x", "@3x" ], // allowed density markeers
 			check: function(params, fn) { // override check function, params from parse
 				fn(new Error("Check failed")); // deliver error if check failed
-			}
+			},
+			status: 204,
+			hints: true,
 		},{ // get from cache, skip to `skipto` if successful
 			builtin: "cache",
 			skipto: "deliver",

package/docs/config.md

@@ -151,7 +151,9 @@ within a bounding box, to specific extensions and densities, or use your own che
 	density: [ "", "@2x", "@3x" ], // allowed density markeers
 	check: function(params, fn) { // override check function, params from parse
 		fn(new Error("Check failed")); // deliver error if check failed
-	}
+	},
+	status: 204, // http status code delivered on fail; default: 204
+	hints: false, // send `x-tileblaster-hint` header with error message
 }
 ```
 

package/docs/todo.md

@@ -70,9 +70,9 @@
 * [ ] Map Web Interface, Configurable
 * [ ] Configurable Index Page
 * [ ] Support for Glyphs and Styles, tile.json proxy
-* [ ] Better Error Handling
-	* [ ] Error wrapper (to pass along http status etc)?
-	* [ ] 404 for nonexistant tiles
+* [x] Better Error Handling
+	* [x] Error wrapper (to pass along http status etc)?
+	* [x] Skip for nonexistant tiles
 * [ ] Render Vector Tiles with MapLibreGL-Native
 * [ ] Improve Debug Consistency
 * [ ] Documentation: How to write a plugin

package/lib/purge.js

@@ -87,7 +87,7 @@ if (worker.isMainThread) {
 				let deletable = [];
 
 				klaw(cache.dir).on("data", function(file){
-					if (file.stats.mtimeMs < cache.expires) deletable.push(file.path);
+					if (file.stats.mtimeMs > cache.expires) deletable.push(file.path);
 				}).on("end", function(){
 					Promise.allSettled(deletable.map(function(file){
 						return new Promise(function(resolve,reject){

package/lib/router.js

@@ -14,7 +14,7 @@ const router = module.exports = function router({ mountpoint }) {
 
 	// default default route, very bare bones
 	self.routes[""] = function(req, res){
-		res.statusCode = 404, res.end();
+		res.statusCode = 404, res.end(), res.used = true;
 	};
 
 	return self;

package/lib/store.js

@@ -80,7 +80,7 @@ store.prototype.put = function(tile, fn){
 	const self = this;
 
 	const destfile = path.join(self.root, tile.path);
-	const tmpfile = destfile+self.ext;
+	const tmpfile = destfile+"."+Date.now()+self.ext;
 
 	// check if exists and still valid?
 	self.check(destfile, function(err, isValid){

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "tileblaster",
-  "version": "1.0.5",
+  "version": "1.0.7",
   "description": "a quick and versatile map tile caching proxy",
   "main": "tileblaster.js",
   "bin": {