Update package version to 1.7.0

docs/endpoints.rst

@@ -64,3 +64,10 @@ Array of all TileJSONs is at ``/index.json`` (``/rendered.json``; ``/data.json``
 List of available fonts
 =======================
 Array of names of the available fonts is at ``/fonts.json``
+
+Health check
+============
+Endpoint reporting health status is at ``/health`` and currently returns:
+
+  * ``503`` Starting - for a short period before everything is initialized
+  * ``200`` OK - when the server is running

package.json

@@ -1,6 +1,6 @@
 {
   "name": "tileserver-gl",
-  "version": "1.6.0",
+  "version": "1.7.0",
   "description": "Map tile server for JSON GL styles - vector and server side generated raster tiles",
   "main": "src/main.js",
   "bin": "src/main.js",
@@ -22,7 +22,6 @@
     "@mapbox/mapbox-gl-native": "3.4.4",
     "@mapbox/sphericalmercator": "1.0.5",
     "advanced-pool": "0.3.2",
-    "async": "2.4.0",
     "base64url": "2.0.0",
     "canvas": "1.6.5",
     "clone": "2.1.1",

src/serve_data.js

@@ -34,20 +34,24 @@ module.exports = function(options, repo, params, id, styles) {
   if (!mbtilesFileStats.isFile() || mbtilesFileStats.size == 0) {
     throw Error('Not valid MBTiles file: ' + mbtilesFile);
   }
-  var source = new mbtiles(mbtilesFile, function(err) {
-    source.getInfo(function(err, info) {
-      tileJSON['name'] = id;
-      tileJSON['format'] = 'pbf';
+  var source;
+  var sourceInfoPromise = new Promise(function(resolve, reject) {
+    source = new mbtiles(mbtilesFile, function(err) {
+      source.getInfo(function(err, info) {
+        tileJSON['name'] = id;
+        tileJSON['format'] = 'pbf';
 
-      Object.assign(tileJSON, info);
+        Object.assign(tileJSON, info);
 
-      tileJSON['tilejson'] = '2.0.0';
-      delete tileJSON['filesize'];
-      delete tileJSON['mtime'];
-      delete tileJSON['scheme'];
+        tileJSON['tilejson'] = '2.0.0';
+        delete tileJSON['filesize'];
+        delete tileJSON['mtime'];
+        delete tileJSON['scheme'];
 
-      Object.assign(tileJSON, params.tilejson || {});
-      utils.fixTileJSONCenter(tileJSON);
+        Object.assign(tileJSON, params.tilejson || {});
+        utils.fixTileJSONCenter(tileJSON);
+        resolve();
+      });
     });
   });
 
@@ -161,5 +165,9 @@ module.exports = function(options, repo, params, id, styles) {
     return res.send(info);
   });
 
-  return app;
+  return new Promise(function(resolve, reject) {
+    sourceInfoPromise.then(function() {
+      resolve(app);
+    });
+  });
 };

src/serve_font.js

@@ -15,16 +15,19 @@ module.exports = function(options, allowedFonts) {
   var fontPath = options.paths.fonts;
 
   var existingFonts = {};
-  fs.readdir(options.paths.fonts, function(err, files) {
-    files.forEach(function(file) {
-      fs.stat(path.join(fontPath, file), function(err, stats) {
-        if (!err) {
-          if (stats.isDirectory() &&
-              fs.existsSync(path.join(fontPath, file, '0-255.pbf'))) {
-            existingFonts[path.basename(file)] = true;
+  var fontListingPromise = new Promise(function(resolve, reject) {
+    fs.readdir(options.paths.fonts, function(err, files) {
+      files.forEach(function(file) {
+        fs.stat(path.join(fontPath, file), function(err, stats) {
+          if (!err) {
+            if (stats.isDirectory() &&
+                fs.existsSync(path.join(fontPath, file, '0-255.pbf'))) {
+              existingFonts[path.basename(file)] = true;
+            }
           }
-        }
+        });
       });
+      resolve();
     });
   });
 
@@ -33,19 +36,15 @@ module.exports = function(options, allowedFonts) {
     var fontstack = decodeURI(req.params.fontstack);
     var range = req.params.range;
 
-    return utils.getFontsPbf(options.serveAllFonts ? null : allowedFonts,
-      fontPath, fontstack, range, existingFonts,
-        function(err, concated) {
-      if (err || concated.length === 0) {
-        console.log(err);
-        console.log(concated.length);
-        return res.status(400).send('');
-      } else {
+    utils.getFontsPbf(options.serveAllFonts ? null : allowedFonts,
+      fontPath, fontstack, range, existingFonts).then(function(concated) {
         res.header('Content-type', 'application/x-protobuf');
         res.header('Last-Modified', lastModified);
         return res.send(concated);
+      }, function(err) {
+        return res.status(400).send(err);
       }
-    });
+    );
   });
 
   app.get('/fonts.json', function(req, res, next) {
@@ -55,5 +54,9 @@ module.exports = function(options, allowedFonts) {
     );
   });
 
-  return app;
+  return new Promise(function(resolve, reject) {
+    fontListingPromise.then(function() {
+      resolve(app);
+    });
+  });
 };

src/serve_rendered.js

@@ -1,7 +1,6 @@
 'use strict';
 
-var async = require('async'),
-    advancedPool = require('advanced-pool'),
+var advancedPool = require('advanced-pool'),
     fs = require('fs'),
     path = require('path'),
     util = require('util'),
@@ -59,15 +58,18 @@ module.exports = function(options, repo, params, id, dataResolver) {
   };
 
   var existingFonts = {};
-  fs.readdir(options.paths.fonts, function(err, files) {
-    files.forEach(function(file) {
-      fs.stat(path.join(options.paths.fonts, file), function(err, stats) {
-        if (!err) {
-          if (stats.isDirectory()) {
-            existingFonts[path.basename(file)] = true;
+  var fontListingPromise = new Promise(function(resolve, reject) {
+    fs.readdir(options.paths.fonts, function(err, files) {
+      files.forEach(function(file) {
+        fs.stat(path.join(options.paths.fonts, file), function(err, stats) {
+          if (!err) {
+            if (stats.isDirectory()) {
+              existingFonts[path.basename(file)] = true;
+            }
           }
-        }
+        });
       });
+      resolve();
     });
   });
 
@@ -89,9 +91,12 @@ module.exports = function(options, repo, params, id, dataResolver) {
             var parts = req.url.split('/');
             var fontstack = unescape(parts[2]);
             var range = parts[3].split('.')[0];
-            utils.getFontsPbf(null, options.paths[protocol], fontstack, range, existingFonts,
-                function(err, concated) {
-              callback(err, {data: concated});
+            utils.getFontsPbf(
+              null, options.paths[protocol], fontstack, range, existingFonts
+            ).then(function(concated) {
+              callback(null, {data: concated});
+            }, function(err) {
+              callback(err, {data: null});
             });
           } else if (protocol == 'mbtiles') {
             var parts = req.url.split('/');
@@ -223,7 +228,7 @@ module.exports = function(options, repo, params, id, dataResolver) {
         }
       }
 
-      queue.push(function(callback) {
+      queue.push(new Promise(function(resolve, reject) {
         mbtilesFile = path.resolve(options.paths.mbtiles, mbtilesFile);
         var mbtilesFileStats = fs.statSync(mbtilesFile);
         if (!mbtilesFileStats.isFile() || mbtilesFileStats.size == 0) {
@@ -279,14 +284,14 @@ module.exports = function(options, repo, params, id, dataResolver) {
               }
               tileJSON.attribution += source.attribution;
             }
-            callback(null);
+            resolve();
           });
         });
-      });
+      }));
     }
   });
 
-  async.parallel(queue, function(err, results) {
+  var renderersReadyPromise = Promise.all(queue).then(function() {
     // TODO: make pool sizes configurable
     for (var s = 1; s <= maxScaleFactor; s++) {
       var minPoolSize = 2;
@@ -310,11 +315,13 @@ module.exports = function(options, repo, params, id, dataResolver) {
   var respondImage = function(z, lon, lat, bearing, pitch,
                               width, height, scale, format, res, next,
                               opt_overlay) {
-    if (Math.abs(lon) > 180 || Math.abs(lat) > 85.06) {
+    if (Math.abs(lon) > 180 || Math.abs(lat) > 85.06 ||
+        lon != lon || lat != lat) {
       return res.status(400).send('Invalid center');
     }
     if (Math.min(width, height) <= 0 ||
-        Math.max(width, height) * scale > (options.maxSize || 2048)) {
+        Math.max(width, height) * scale > (options.maxSize || 2048) ||
+        width != width || height != height) {
       return res.status(400).send('Invalid size');
     }
     if (format == 'png' || format == 'webp') {
@@ -466,9 +473,19 @@ module.exports = function(options, repo, params, id, dataResolver) {
       return [px[0] * scale, px[1] * scale];
     };
 
+    var center = precisePx([x, y], z);
+
+    var mapHeight = 512 * (1 << z);
+    var maxEdge = center[1] + h / 2;
+    var minEdge = center[1] - h / 2;
+    if (maxEdge > mapHeight) {
+      center[1] -= (maxEdge - mapHeight);
+    } else if (minEdge < 0) {
+      center[1] -= minEdge;
+    }
+
     var canvas = new Canvas(scale * w, scale * h);
     var ctx = canvas.getContext('2d');
-    var center = precisePx([x, y], z);
     ctx.scale(scale, scale);
     if (bearing) {
       ctx.translate(w / 2, h / 2);
@@ -656,9 +673,14 @@ module.exports = function(options, repo, params, id, dataResolver) {
         bbox[3] = Math.max(bbox[3], pair[1]);
       });
 
+      var bbox_ = mercator.convert(bbox, '900913');
+      var center = mercator.inverse(
+        [(bbox_[0] + bbox_[2]) / 2, (bbox_[1] + bbox_[3]) / 2]
+      );
+
       var z = calcZForBBox(bbox, w, h, req.query),
-          x = (bbox[0] + bbox[2]) / 2,
-          y = (bbox[1] + bbox[3]) / 2;
+          x = center[0],
+          y = center[1];
 
       var overlay = renderOverlay(z, x, y, bearing, pitch, w, h, scale,
                                   path, req.query);
@@ -675,5 +697,9 @@ module.exports = function(options, repo, params, id, dataResolver) {
     return res.send(info);
   });
 
-  return app;
+  return new Promise(function(resolve, reject) {
+    Promise.all([fontListingPromise, renderersReadyPromise]).then(function() {
+      resolve(app);
+    });
+  });
 };

src/serve_style.js

@@ -117,5 +117,5 @@ module.exports = function(options, repo, params, id, reportTiles, reportFont) {
     });
   });
 
-  return app;
+  return Promise.resolve(app);
 };

src/server.js

@@ -76,6 +76,8 @@ function start(opts) {
   paths.sprites = path.resolve(paths.root, paths.sprites || '');
   paths.mbtiles = path.resolve(paths.root, paths.mbtiles || '');
 
+  var startupPromises = [];
+
   var checkPath = function(type) {
     if (!fs.existsSync(paths[type])) {
       console.error('The specified path for "' + type + '" does not exist (' + paths[type] + ').');
@@ -101,7 +103,7 @@ function start(opts) {
     }
 
     if (item.serve_data !== false) {
-      app.use('/styles/', serve_style(options, serving.styles, item, id,
+      startupPromises.push(serve_style(options, serving.styles, item, id,
         function(mbtiles, fromData) {
           var dataItemId;
           Object.keys(data).forEach(function(id) {
@@ -130,28 +132,38 @@ function start(opts) {
           }
         }, function(font) {
           serving.fonts[font] = true;
+        }).then(function(sub) {
+          app.use('/styles/', sub);
         }));
     }
     if (item.serve_rendered !== false) {
       if (serve_rendered) {
-        app.use('/styles/' + id + '/',
-                serve_rendered(options, serving.rendered, item, id,
-        function(mbtiles) {
-          var mbtilesFile;
-          Object.keys(data).forEach(function(id) {
-            if (id == mbtiles) {
-              mbtilesFile = data[id].mbtiles;
+        startupPromises.push(
+          serve_rendered(options, serving.rendered, item, id,
+            function(mbtiles) {
+              var mbtilesFile;
+              Object.keys(data).forEach(function(id) {
+                if (id == mbtiles) {
+                  mbtilesFile = data[id].mbtiles;
+                }
+              });
+              return mbtilesFile;
             }
-          });
-          return mbtilesFile;
-        }));
+          ).then(function(sub) {
+            app.use('/styles/' + id + '/', sub);
+          })
+        );
       } else {
         item.serve_rendered = false;
       }
     }
   });
 
-  app.use('/', serve_font(options, serving.fonts));
+  startupPromises.push(
+    serve_font(options, serving.fonts).then(function(sub) {
+      app.use('/', sub);
+    })
+  );
 
   Object.keys(data).forEach(function(id) {
     var item = data[id];
@@ -160,7 +172,11 @@ function start(opts) {
       return;
     }
 
-    app.use('/data/', serve_data(options, serving.data, item, id, serving.styles));
+    startupPromises.push(
+      serve_data(options, serving.data, item, id, serving.styles).then(function(sub) {
+        app.use('/data/', sub);
+      })
+    );
   });
 
   app.get('/styles.json', function(req, res, next) {
@@ -221,28 +237,32 @@ function start(opts) {
         templateFile = path.resolve(paths.root, options.frontPage);
       }
     }
-    fs.readFile(templateFile, function(err, content) {
-      if (err) {
-        console.error('Template not found:', err);
-      }
-      var compiled = handlebars.compile(content.toString());
-
-      app.use(urlPath, function(req, res, next) {
-        var data = {};
-        if (dataGetter) {
-          data = dataGetter(req);
-          if (!data) {
-            return res.status(404).send('Not found');
-          }
+    startupPromises.push(new Promise(function(resolve, reject) {
+      fs.readFile(templateFile, function(err, content) {
+        if (err) {
+          console.error('Template not found:', err);
+          reject(err);
         }
-        data['server_version'] = packageJson.name + ' v' + packageJson.version;
-        data['is_light'] = isLight;
-        data['key_query_part'] =
-            req.query.key ? 'key=' + req.query.key + '&' : '';
-        data['key_query'] = req.query.key ? '?key=' + req.query.key : '';
-        return res.status(200).send(compiled(data));
+        var compiled = handlebars.compile(content.toString());
+
+        app.use(urlPath, function(req, res, next) {
+          var data = {};
+          if (dataGetter) {
+            data = dataGetter(req);
+            if (!data) {
+              return res.status(404).send('Not found');
+            }
+          }
+          data['server_version'] = packageJson.name + ' v' + packageJson.version;
+          data['is_light'] = isLight;
+          data['key_query_part'] =
+              req.query.key ? 'key=' + req.query.key + '&' : '';
+          data['key_query'] = req.query.key ? '?key=' + req.query.key : '';
+          return res.status(200).send(compiled(data));
+        });
+        resolve();
       });
-    });
+    }));
   };
 
   serveTemplate('/$', 'index', function(req) {
@@ -355,6 +375,19 @@ function start(opts) {
     return data;
   });
 
+  var startupComplete = false;
+  var startupPromise = Promise.all(startupPromises).then(function() {
+    console.log('Startup complete');
+    startupComplete = true;
+  });
+  app.get('/health', function(req, res, next) {
+    if (startupComplete) {
+      return res.status(200).send('OK');
+    } else {
+      return res.status(503).send('Starting');
+    }
+  });
+
   var server = app.listen(process.env.PORT || opts.port, process.env.BIND || opts.bind, function() {
     var address = this.address().address;
     if (address.indexOf('::') === 0) {
@@ -368,7 +401,8 @@ function start(opts) {
 
   return {
     app: app,
-    server: server
+    server: server,
+    startupPromise: startupPromise
   };
 }
 

src/utils.js

@@ -1,7 +1,6 @@
 'use strict';
 
-var async = require('async'),
-    path = require('path'),
+var path = require('path'),
     fs = require('fs');
 
 var clone = require('clone'),
@@ -73,47 +72,47 @@ module.exports.fixTileJSONCenter = function(tileJSON) {
   }
 };
 
-module.exports.getFontsPbf = function(allowedFonts, fontPath, names, range, fallbacks, callback) {
-  var getFontPbf = function(allowedFonts, name, range, callback, fallbacks) {
+var getFontPbf = function(allowedFonts, fontPath, name, range, fallbacks) {
+  return new Promise(function(resolve, reject) {
     if (!allowedFonts || (allowedFonts[name] && fallbacks)) {
       var filename = path.join(fontPath, name, range + '.pbf');
       if (!fallbacks) {
         fallbacks = clone(allowedFonts || {});
       }
       delete fallbacks[name];
-      return fs.readFile(filename, function(err, data) {
+      fs.readFile(filename, function(err, data) {
         if (err) {
           console.error('ERROR: Font not found:', name);
           if (fallbacks && Object.keys(fallbacks).length) {
             var fallbackName = Object.keys(fallbacks)[0];
             console.error('ERROR: Trying to use', fallbackName, 'as a fallback');
             delete fallbacks[fallbackName];
-            return getFontPbf(null, fallbackName, range, callback, fallbacks);
+            getFontPbf(null, fontPath, fallbackName, range, fallbacks).then(resolve, reject);
           } else {
-            return callback(new Error('Font load error: ' + name));
+            reject('Font load error: ' + name);
           }
         } else {
-          return callback(null, data);
+          resolve(data);
         }
       });
     } else {
-      return callback(new Error('Font not allowed: ' + name));
-    }
-  };
-
-  var fonts = names.split(',');
-  var queue = [];
-  fonts.forEach(function(font) {
-    queue.push(function(callback) {
-      getFontPbf(allowedFonts, font, range, callback, clone(allowedFonts || fallbacks));
-    });
-  });
-
-  return async.parallel(queue, function(err, results) {
-    if (err) {
-      callback(err, new Buffer([]));
-    } else {
-      callback(err, glyphCompose.combine(results));
+      reject('Font not allowed: ' + name);
     }
   });
 };
+
+module.exports.getFontsPbf = function(allowedFonts, fontPath, names, range, fallbacks) {
+  var fonts = names.split(',');
+  var queue = [];
+  fonts.forEach(function(font) {
+    queue.push(
+      getFontPbf(allowedFonts, fontPath, font, range, clone(allowedFonts || fallbacks))
+    );
+  });
+
+  return new Promise(function(resolve, reject) {
+    Promise.all(queue).then(function(values) {
+      return resolve(glyphCompose.combine(values));
+    }, reject);
+  });
+};

test/metadata.js

@@ -38,6 +38,14 @@ var testTileJSON = function(url) {
 };
 
 describe('Metadata', function() {
+  describe('/health', function() {
+    it('returns 200', function(done) {
+      supertest(app)
+        .get('/health')
+        .expect(200, done);
+    });
+  });
+
   testTileJSONArray('/index.json');
   testTileJSONArray('/rendered.json');
   testTileJSONArray('/data.json');

test/setup.js

@@ -12,6 +12,7 @@ before(function() {
   });
   global.app = running.app;
   global.server = running.server;
+  return running.startupPromise;
 });
 
 after(function() {