Modify all serve_* modules to return a Promise (preparation for #140)

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) {
+  var source;
-    source.getInfo(function(err, info) {
+  var sourceInfoPromise = new Promise(function(resolve, reject) {
-      tileJSON['name'] = id;
+    source = new mbtiles(mbtilesFile, function(err) {
-      tileJSON['format'] = 'pbf';
+      source.getInfo(function(err, info) {
+        tileJSON['name'] = id;
+        tileJSON['format'] = 'pbf';
 
-      Object.assign(tileJSON, info);
+        Object.assign(tileJSON, info);
 
-      tileJSON['tilejson'] = '2.0.0';
+        tileJSON['tilejson'] = '2.0.0';
-      delete tileJSON['filesize'];
+        delete tileJSON['filesize'];
-      delete tileJSON['mtime'];
+        delete tileJSON['mtime'];
-      delete tileJSON['scheme'];
+        delete tileJSON['scheme'];
 
-      Object.assign(tileJSON, params.tilejson || {});
+        Object.assign(tileJSON, params.tilejson || {});
-      utils.fixTileJSONCenter(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) {
+  var fontListingPromise = new Promise(function(resolve, reject) {
-    files.forEach(function(file) {
+    fs.readdir(options.paths.fonts, function(err, files) {
-      fs.stat(path.join(fontPath, file), function(err, stats) {
+      files.forEach(function(file) {
-        if (!err) {
+        fs.stat(path.join(fontPath, file), function(err, stats) {
-          if (stats.isDirectory() &&
+          if (!err) {
-              fs.existsSync(path.join(fontPath, file, '0-255.pbf'))) {
+            if (stats.isDirectory() &&
-            existingFonts[path.basename(file)] = true;
+                fs.existsSync(path.join(fontPath, file, '0-255.pbf'))) {
+              existingFonts[path.basename(file)] = true;
+            }
           }
-        }
+        });
       });
+      resolve();
     });
   });
 
@@ -55,5 +58,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'),
+var advancedPool = require('advanced-pool'),
-    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) {
+  var fontListingPromise = new Promise(function(resolve, reject) {
-    files.forEach(function(file) {
+    fs.readdir(options.paths.fonts, function(err, files) {
-      fs.stat(path.join(options.paths.fonts, file), function(err, stats) {
+      files.forEach(function(file) {
-        if (!err) {
+        fs.stat(path.join(options.paths.fonts, file), function(err, stats) {
-          if (stats.isDirectory()) {
+          if (!err) {
-            existingFonts[path.basename(file)] = true;
+            if (stats.isDirectory()) {
+              existingFonts[path.basename(file)] = true;
+            }
           }
-        }
+        });
       });
+      resolve();
     });
   });
 
@@ -223,7 +225,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 +281,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;
@@ -692,5 +694,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,7 @@ module.exports = function(options, repo, params, id, reportTiles, reportFont) {
     });
   });
 
-  return app;
+  return new Promise(function(resolve, reject) {
+    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 + '/',
+        startupPromises.push(
-                serve_rendered(options, serving.rendered, item, id,
+          serve_rendered(options, serving.rendered, item, id,
-        function(mbtiles) {
+            function(mbtiles) {
-          var mbtilesFile;
+              var mbtilesFile;
-          Object.keys(data).forEach(function(id) {
+              Object.keys(data).forEach(function(id) {
-            if (id == mbtiles) {
+                if (id == mbtiles) {
-              mbtilesFile = data[id].mbtiles;
+                  mbtilesFile = data[id].mbtiles;
+                }
+              });
+              return mbtilesFile;
             }
-          });
+          ).then(function(sub) {
-          return mbtilesFile;
+            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) {
+    startupPromises.push(new Promise(function(resolve, reject) {
-      if (err) {
+      fs.readFile(templateFile, function(err, content) {
-        console.error('Template not found:', err);
+        if (err) {
-      }
+          console.error('Template not found:', err);
-      var compiled = handlebars.compile(content.toString());
+          reject(err);
-
-      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;
+        var compiled = handlebars.compile(content.toString());
-        data['is_light'] = isLight;
+
-        data['key_query_part'] =
+        app.use(urlPath, function(req, res, next) {
-            req.query.key ? 'key=' + req.query.key + '&' : '';
+          var data = {};
-        data['key_query'] = req.query.key ? '?key=' + req.query.key : '';
+          if (dataGetter) {
-        return res.status(200).send(compiled(data));
+            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,10 @@ function start(opts) {
     return data;
   });
 
+  var startupPromise = Promise.all(startupPromises).then(function() {
+    console.log('Startup complete');
+  });
+
   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 +392,8 @@ function start(opts) {
 
   return {
     app: app,
-    server: server
+    server: server,
+    startupPromise: startupPromise
   };
 }
 

test/setup.js

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