Skip to content

Commit

Permalink
feat: implement watching mbtiles and hot-reloading
Browse files Browse the repository at this point in the history
this will watch for changes in the mbtiles and hot-reload it.
To keep the implementation simple, the whole renderer is restartet.
This will create a small downtime.

It is very important to replace files atomically
  • Loading branch information
candux committed Dec 31, 2023
1 parent a088080 commit 7e6c6f3
Show file tree
Hide file tree
Showing 2 changed files with 71 additions and 0 deletions.
8 changes: 8 additions & 0 deletions docs/config.rst
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ Example:
"pbfAlias": "pbf",
"serveAllFonts": false,
"serveAllStyles": false,
"watchMbtiles": false,
"serveStaticMaps": true,
"allowRemoteMarkerIcons": true,
"allowInlineMarkerImages": true,
Expand Down Expand Up @@ -152,6 +153,13 @@ If this option is enabled, all the styles from the ``paths.styles`` will be serv
The process will also watch for changes in this directory and remove/add more styles dynamically.
It is recommended to also use the ``serveAllFonts`` option when using this option.

``watchMbtiles``
------------------------

If this option is enabled, all the opened Mbtiles are watched for changes and automatically reloaded.
The new data is then severed immediately. There is a small downtime for rendered endpoints.
Mbtiles have to be replaced atomically. i.e. moving the file from the same filesystem. Modifying an existing file will crash the server.

``serveStaticMaps``
------------------------

Expand Down
63 changes: 63 additions & 0 deletions src/server.js
Original file line number Diff line number Diff line change
Expand Up @@ -292,6 +292,69 @@ function start(opts) {
startupPromises.push(
serve_data.add(options, serving.data, item, id, opts.publicUrl),
);

if (options.watchMbtiles) {
console.log(`Watching Mbtile "${item.mbtiles}" for changes...`);

const watcher = chokidar.watch(
path.join(options.paths.mbtiles, item.mbtiles),
{
ignoreInitial: true,
// wait 10 seconds after the last change before updating. Otherwise, cases where a file is constantly replaced
// will create race conditions and can crash the server
awaitWriteFinish: { stabilityThreshold: 10000 },
},
);

watcher.on('all', (eventType, filename) => {
if (filename) {
if (eventType === 'add' || eventType === 'change') {
console.log(`MBTiles "${filename}" changed, updating...`);

serve_data.remove(serving.data, id);
let newItem = {
mbtiles: filename,
};
serve_data.add(options, serving.data, newItem, id, opts.publicUrl);

if (!isLight) {
Object.entries(serving.rendered).forEach(
([serving_key, serving_value]) => {
// check if source is used in serving
Object.values(serving_value.map.sources).forEach(
(source_value) => {
const newFileInode = fs.statSync(filename).ino;
// we check if the filename is the same and the inode has changed
// the inode check is necessary because it could be that multiple mbtiles
// were changed and we already changed to the new file. This can lead to race-conditions
if (
source_value.filename === filename &&
source_value._stat.ino !== newFileInode
) {
// remove from serving and add back
serve_style.remove(serving.styles, serving_key);
serve_rendered.remove(serving.rendered, serving_key);

const item = {
style: serving_value.map.styleFile,
};
addStyle(serving_key, item, false, false);
}
},
);
},
);
}
}
// we intentionally don't handle the 'unlink' event here. If the file is deleted, the file descriptor is still valid,
// everything will continue to work
}
});

watcher.on('error', (error) => {
console.error(`Failed to watch file: ${error}`);
});
}
}

if (options.serveAllStyles) {
Expand Down

0 comments on commit 7e6c6f3

Please sign in to comment.