tileblaster 1.0.4 → 1.0.6

package/builtins/cache.js

@@ -14,7 +14,7 @@ module.exports = function({ opts, data, res }, next, skip){
 	if (!cache.hasOwnProperty(data.map)) {
 
 		// store instance
-		cache.store = this.lib.store({ root: config.paths.data, ext: config.id+".tmp" });
+		cache.store = this.lib.store({ root: config.paths.data, ext: "."+config.id+".tmp" });
 
 		// merge opts of all uses of the cache builtin in a map config
 		opts = config.maps[data.map].filter(function(use){

package/builtins/check.js

@@ -2,13 +2,26 @@
 
 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){
+			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 +99,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

@@ -44,6 +44,7 @@ module.exports = function({ req, res, opts, data }, next){
 				};
 				data.tiles.push({
 					...tile,
+					path: tile.path+".br",
 					buffer: compressed,
 					compression: "br",
 					headers: { ...(tile.headers||{}), "content-encoding": "br" },
@@ -64,6 +65,7 @@ module.exports = function({ req, res, opts, data }, next){
 				}
 				data.tiles.push({
 					...tile,
+					path: tile.path+".gz",
 					buffer: compressed,
 					compression: "gzip",
 					headers: { ...(tile.headers||{}), "content-encoding": "gzip" },

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/package.json

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