9b64093c42
* style: fix lint issues in code 🕺
Signed-off-by: Vinayak Kulkarni <19776877+vinayakkulkarni@users.noreply.github.com>
* style: lint fix all files
Signed-off-by: Vinayak Kulkarni <19776877+vinayakkulkarni@users.noreply.github.com>
* chore: add `keywords` for better reach
Signed-off-by: Vinayak Kulkarni <19776877+vinayakkulkarni@users.noreply.github.com>
* feat: add `husky` & `commitlint`
Signed-off-by: Vinayak Kulkarni <19776877+vinayakkulkarni@users.noreply.github.com>
* chore: ignore `public` directory
Signed-off-by: Vinayak Kulkarni <19776877+vinayakkulkarni@users.noreply.github.com>
* revert: do not lint `public` directory
Signed-off-by: Vinayak Kulkarni <19776877+vinayakkulkarni@users.noreply.github.com>
* style: fix issues with lint
Signed-off-by: Vinayak Kulkarni <19776877+vinayakkulkarni@users.noreply.github.com>
* feat: add eslint config
Signed-off-by: Vinayak Kulkarni <19776877+vinayakkulkarni@users.noreply.github.com>
* feat: add lint-staged
Signed-off-by: Vinayak Kulkarni <19776877+vinayakkulkarni@users.noreply.github.com>
* style: lint fix all file(s)
Signed-off-by: Vinayak Kulkarni <19776877+vinayakkulkarni@users.noreply.github.com>
* fix: ignore rules for light version
Signed-off-by: Vinayak Kulkarni <19776877+vinayakkulkarni@users.noreply.github.com>
* fix: remove unnecessary space
Signed-off-by: Vinayak Kulkarni <19776877+vinayakkulkarni@users.noreply.github.com>
* chore(deps): update lockfile
Signed-off-by: Vinayak Kulkarni <19776877+vinayakkulkarni@users.noreply.github.com>
* style: autofix linting issue(s)
Signed-off-by: Vinayak Kulkarni <19776877+vinayakkulkarni@users.noreply.github.com>
Signed-off-by: Vinayak Kulkarni <19776877+vinayakkulkarni@users.noreply.github.com>
620 lines
17 KiB
JavaScript
620 lines
17 KiB
JavaScript
#!/usr/bin/env node
|
|
'use strict';
|
|
|
|
import os from 'os';
|
|
process.env.UV_THREADPOOL_SIZE = Math.ceil(Math.max(4, os.cpus().length * 1.5));
|
|
|
|
import fs from 'node:fs';
|
|
import path from 'path';
|
|
|
|
import chokidar from 'chokidar';
|
|
import clone from 'clone';
|
|
import cors from 'cors';
|
|
import enableShutdown from 'http-shutdown';
|
|
import express from 'express';
|
|
import handlebars from 'handlebars';
|
|
import SphericalMercator from '@mapbox/sphericalmercator';
|
|
const mercator = new SphericalMercator();
|
|
import morgan from 'morgan';
|
|
import { serve_data } from './serve_data.js';
|
|
import { serve_style } from './serve_style.js';
|
|
import { serve_font } from './serve_font.js';
|
|
import { getTileUrls, getPublicUrl } from './utils.js';
|
|
|
|
import { fileURLToPath } from 'url';
|
|
const __filename = fileURLToPath(import.meta.url);
|
|
const __dirname = path.dirname(__filename);
|
|
const packageJson = JSON.parse(
|
|
fs.readFileSync(__dirname + '/../package.json', 'utf8'),
|
|
);
|
|
|
|
const isLight = packageJson.name.slice(-6) === '-light';
|
|
const serve_rendered = (
|
|
await import(`${!isLight ? `./serve_rendered.js` : `./serve_light.js`}`)
|
|
).serve_rendered;
|
|
|
|
/**
|
|
*
|
|
* @param opts
|
|
*/
|
|
function start(opts) {
|
|
console.log('Starting server');
|
|
|
|
const app = express().disable('x-powered-by');
|
|
const serving = {
|
|
styles: {},
|
|
rendered: {},
|
|
data: {},
|
|
fonts: {},
|
|
};
|
|
|
|
app.enable('trust proxy');
|
|
|
|
if (process.env.NODE_ENV !== 'test') {
|
|
const defaultLogFormat =
|
|
process.env.NODE_ENV === 'production' ? 'tiny' : 'dev';
|
|
const logFormat = opts.logFormat || defaultLogFormat;
|
|
app.use(
|
|
morgan(logFormat, {
|
|
stream: opts.logFile
|
|
? fs.createWriteStream(opts.logFile, { flags: 'a' })
|
|
: process.stdout,
|
|
skip: (req, res) =>
|
|
opts.silent && (res.statusCode === 200 || res.statusCode === 304),
|
|
}),
|
|
);
|
|
}
|
|
|
|
let config = opts.config || null;
|
|
let configPath = null;
|
|
if (opts.configPath) {
|
|
configPath = path.resolve(opts.configPath);
|
|
try {
|
|
config = JSON.parse(fs.readFileSync(configPath, 'utf8'));
|
|
} catch (e) {
|
|
console.log('ERROR: Config file not found or invalid!');
|
|
console.log(' See README.md for instructions and sample data.');
|
|
process.exit(1);
|
|
}
|
|
}
|
|
if (!config) {
|
|
console.log('ERROR: No config file not specified!');
|
|
process.exit(1);
|
|
}
|
|
|
|
const options = config.options || {};
|
|
const paths = options.paths || {};
|
|
options.paths = paths;
|
|
paths.root = path.resolve(
|
|
configPath ? path.dirname(configPath) : process.cwd(),
|
|
paths.root || '',
|
|
);
|
|
paths.styles = path.resolve(paths.root, paths.styles || '');
|
|
paths.fonts = path.resolve(paths.root, paths.fonts || '');
|
|
paths.sprites = path.resolve(paths.root, paths.sprites || '');
|
|
paths.mbtiles = path.resolve(paths.root, paths.mbtiles || '');
|
|
paths.icons = path.resolve(paths.root, paths.icons || '');
|
|
|
|
const startupPromises = [];
|
|
|
|
const checkPath = (type) => {
|
|
if (!fs.existsSync(paths[type])) {
|
|
console.error(
|
|
`The specified path for "${type}" does not exist (${paths[type]}).`,
|
|
);
|
|
process.exit(1);
|
|
}
|
|
};
|
|
checkPath('styles');
|
|
checkPath('fonts');
|
|
checkPath('sprites');
|
|
checkPath('mbtiles');
|
|
checkPath('icons');
|
|
|
|
/**
|
|
* Recursively get all files within a directory.
|
|
* Inspired by https://stackoverflow.com/a/45130990/10133863
|
|
*
|
|
* @param {string} directory Absolute path to a directory to get files from.
|
|
*/
|
|
const getFiles = async (directory) => {
|
|
// Fetch all entries of the directory and attach type information
|
|
const dirEntries = await fs.promises.readdir(directory, {
|
|
withFileTypes: true,
|
|
});
|
|
|
|
// Iterate through entries and return the relative file-path to the icon directory if it is not a directory
|
|
// otherwise initiate a recursive call
|
|
const files = await Promise.all(
|
|
dirEntries.map((dirEntry) => {
|
|
const entryPath = path.resolve(directory, dirEntry.name);
|
|
return dirEntry.isDirectory()
|
|
? getFiles(entryPath)
|
|
: entryPath.replace(paths.icons + path.sep, '');
|
|
}),
|
|
);
|
|
|
|
// Flatten the list of files to a single array
|
|
return files.flat();
|
|
};
|
|
|
|
// Load all available icons into a settings object
|
|
startupPromises.push(
|
|
new Promise((resolve) => {
|
|
getFiles(paths.icons).then((files) => {
|
|
paths.availableIcons = files;
|
|
resolve();
|
|
});
|
|
}),
|
|
);
|
|
|
|
if (options.dataDecorator) {
|
|
try {
|
|
options.dataDecoratorFunc = require(path.resolve(
|
|
paths.root,
|
|
options.dataDecorator,
|
|
));
|
|
} catch (e) {}
|
|
}
|
|
|
|
const data = clone(config.data || {});
|
|
|
|
if (opts.cors) {
|
|
app.use(cors());
|
|
}
|
|
|
|
app.use('/data/', serve_data.init(options, serving.data));
|
|
app.use('/styles/', serve_style.init(options, serving.styles));
|
|
if (!isLight) {
|
|
startupPromises.push(
|
|
serve_rendered.init(options, serving.rendered).then((sub) => {
|
|
app.use('/styles/', sub);
|
|
}),
|
|
);
|
|
}
|
|
|
|
const addStyle = (id, item, allowMoreData, reportFonts) => {
|
|
let success = true;
|
|
if (item.serve_data !== false) {
|
|
success = serve_style.add(
|
|
options,
|
|
serving.styles,
|
|
item,
|
|
id,
|
|
opts.publicUrl,
|
|
(mbtiles, fromData) => {
|
|
let dataItemId;
|
|
for (const id of Object.keys(data)) {
|
|
if (fromData) {
|
|
if (id === mbtiles) {
|
|
dataItemId = id;
|
|
}
|
|
} else {
|
|
if (data[id].mbtiles === mbtiles) {
|
|
dataItemId = id;
|
|
}
|
|
}
|
|
}
|
|
if (dataItemId) {
|
|
// mbtiles exist in the data config
|
|
return dataItemId;
|
|
} else {
|
|
if (fromData || !allowMoreData) {
|
|
console.log(
|
|
`ERROR: style "${item.style}" using unknown mbtiles "${mbtiles}"! Skipping...`,
|
|
);
|
|
return undefined;
|
|
} else {
|
|
let id = mbtiles.substr(0, mbtiles.lastIndexOf('.')) || mbtiles;
|
|
while (data[id]) id += '_';
|
|
data[id] = {
|
|
mbtiles: mbtiles,
|
|
};
|
|
return id;
|
|
}
|
|
}
|
|
},
|
|
(font) => {
|
|
if (reportFonts) {
|
|
serving.fonts[font] = true;
|
|
}
|
|
},
|
|
);
|
|
}
|
|
if (success && item.serve_rendered !== false) {
|
|
if (!isLight) {
|
|
startupPromises.push(
|
|
serve_rendered.add(
|
|
options,
|
|
serving.rendered,
|
|
item,
|
|
id,
|
|
opts.publicUrl,
|
|
(mbtiles) => {
|
|
let mbtilesFile;
|
|
for (const id of Object.keys(data)) {
|
|
if (id === mbtiles) {
|
|
mbtilesFile = data[id].mbtiles;
|
|
}
|
|
}
|
|
return mbtilesFile;
|
|
},
|
|
),
|
|
);
|
|
} else {
|
|
item.serve_rendered = false;
|
|
}
|
|
}
|
|
};
|
|
|
|
for (const id of Object.keys(config.styles || {})) {
|
|
const item = config.styles[id];
|
|
if (!item.style || item.style.length === 0) {
|
|
console.log(`Missing "style" property for ${id}`);
|
|
continue;
|
|
}
|
|
|
|
addStyle(id, item, true, true);
|
|
}
|
|
|
|
startupPromises.push(
|
|
serve_font(options, serving.fonts).then((sub) => {
|
|
app.use('/', sub);
|
|
}),
|
|
);
|
|
|
|
for (const id of Object.keys(data)) {
|
|
const item = data[id];
|
|
if (!item.mbtiles || item.mbtiles.length === 0) {
|
|
console.log(`Missing "mbtiles" property for ${id}`);
|
|
continue;
|
|
}
|
|
|
|
startupPromises.push(
|
|
serve_data.add(options, serving.data, item, id, opts.publicUrl),
|
|
);
|
|
}
|
|
|
|
if (options.serveAllStyles) {
|
|
fs.readdir(options.paths.styles, { withFileTypes: true }, (err, files) => {
|
|
if (err) {
|
|
return;
|
|
}
|
|
for (const file of files) {
|
|
if (file.isFile() && path.extname(file.name).toLowerCase() == '.json') {
|
|
const id = path.basename(file.name, '.json');
|
|
const item = {
|
|
style: file.name,
|
|
};
|
|
addStyle(id, item, false, false);
|
|
}
|
|
}
|
|
});
|
|
|
|
const watcher = chokidar.watch(
|
|
path.join(options.paths.styles, '*.json'),
|
|
{},
|
|
);
|
|
watcher.on('all', (eventType, filename) => {
|
|
if (filename) {
|
|
const id = path.basename(filename, '.json');
|
|
console.log(`Style "${id}" changed, updating...`);
|
|
|
|
serve_style.remove(serving.styles, id);
|
|
if (!isLight) {
|
|
serve_rendered.remove(serving.rendered, id);
|
|
}
|
|
|
|
if (eventType == 'add' || eventType == 'change') {
|
|
const item = {
|
|
style: filename,
|
|
};
|
|
addStyle(id, item, false, false);
|
|
}
|
|
}
|
|
});
|
|
}
|
|
|
|
app.get('/styles.json', (req, res, next) => {
|
|
const result = [];
|
|
const query = req.query.key
|
|
? `?key=${encodeURIComponent(req.query.key)}`
|
|
: '';
|
|
for (const id of Object.keys(serving.styles)) {
|
|
const styleJSON = serving.styles[id].styleJSON;
|
|
result.push({
|
|
version: styleJSON.version,
|
|
name: styleJSON.name,
|
|
id: id,
|
|
url: `${getPublicUrl(
|
|
opts.publicUrl,
|
|
req,
|
|
)}styles/${id}/style.json${query}`,
|
|
});
|
|
}
|
|
res.send(result);
|
|
});
|
|
|
|
const addTileJSONs = (arr, req, type) => {
|
|
for (const id of Object.keys(serving[type])) {
|
|
const info = clone(serving[type][id].tileJSON);
|
|
let path = '';
|
|
if (type === 'rendered') {
|
|
path = `styles/${id}`;
|
|
} else {
|
|
path = `${type}/${id}`;
|
|
}
|
|
info.tiles = getTileUrls(
|
|
req,
|
|
info.tiles,
|
|
path,
|
|
info.format,
|
|
opts.publicUrl,
|
|
{
|
|
pbf: options.pbfAlias,
|
|
},
|
|
);
|
|
arr.push(info);
|
|
}
|
|
return arr;
|
|
};
|
|
|
|
app.get('/rendered.json', (req, res, next) => {
|
|
res.send(addTileJSONs([], req, 'rendered'));
|
|
});
|
|
app.get('/data.json', (req, res, next) => {
|
|
res.send(addTileJSONs([], req, 'data'));
|
|
});
|
|
app.get('/index.json', (req, res, next) => {
|
|
res.send(addTileJSONs(addTileJSONs([], req, 'rendered'), req, 'data'));
|
|
});
|
|
|
|
// ------------------------------------
|
|
// serve web presentations
|
|
app.use('/', express.static(path.join(__dirname, '../public/resources')));
|
|
|
|
const templates = path.join(__dirname, '../public/templates');
|
|
const serveTemplate = (urlPath, template, dataGetter) => {
|
|
let templateFile = `${templates}/${template}.tmpl`;
|
|
if (template === 'index') {
|
|
if (options.frontPage === false) {
|
|
return;
|
|
} else if (
|
|
options.frontPage &&
|
|
options.frontPage.constructor === String
|
|
) {
|
|
templateFile = path.resolve(paths.root, options.frontPage);
|
|
}
|
|
}
|
|
startupPromises.push(
|
|
new Promise((resolve, reject) => {
|
|
fs.readFile(templateFile, (err, content) => {
|
|
if (err) {
|
|
err = new Error(`Template not found: ${err.message}`);
|
|
reject(err);
|
|
return;
|
|
}
|
|
const compiled = handlebars.compile(content.toString());
|
|
|
|
app.use(urlPath, (req, res, next) => {
|
|
let data = {};
|
|
if (dataGetter) {
|
|
data = dataGetter(req);
|
|
if (!data) {
|
|
return res.status(404).send('Not found');
|
|
}
|
|
}
|
|
data[
|
|
'server_version'
|
|
] = `${packageJson.name} v${packageJson.version}`;
|
|
data['public_url'] = opts.publicUrl || '/';
|
|
data['is_light'] = isLight;
|
|
data['key_query_part'] = req.query.key
|
|
? `key=${encodeURIComponent(req.query.key)}&`
|
|
: '';
|
|
data['key_query'] = req.query.key
|
|
? `?key=${encodeURIComponent(req.query.key)}`
|
|
: '';
|
|
if (template === 'wmts') res.set('Content-Type', 'text/xml');
|
|
return res.status(200).send(compiled(data));
|
|
});
|
|
resolve();
|
|
});
|
|
}),
|
|
);
|
|
};
|
|
|
|
serveTemplate('/$', 'index', (req) => {
|
|
const styles = clone(serving.styles || {});
|
|
for (const id of Object.keys(styles)) {
|
|
const style = styles[id];
|
|
style.name = (serving.styles[id] || serving.rendered[id] || {}).name;
|
|
style.serving_data = serving.styles[id];
|
|
style.serving_rendered = serving.rendered[id];
|
|
if (style.serving_rendered) {
|
|
const center = style.serving_rendered.tileJSON.center;
|
|
if (center) {
|
|
style.viewer_hash = `#${center[2]}/${center[1].toFixed(
|
|
5,
|
|
)}/${center[0].toFixed(5)}`;
|
|
|
|
const centerPx = mercator.px([center[0], center[1]], center[2]);
|
|
style.thumbnail = `${center[2]}/${Math.floor(
|
|
centerPx[0] / 256,
|
|
)}/${Math.floor(centerPx[1] / 256)}.png`;
|
|
}
|
|
|
|
style.xyz_link = getTileUrls(
|
|
req,
|
|
style.serving_rendered.tileJSON.tiles,
|
|
`styles/${id}`,
|
|
style.serving_rendered.tileJSON.format,
|
|
opts.publicUrl,
|
|
)[0];
|
|
}
|
|
}
|
|
const data = clone(serving.data || {});
|
|
for (const id of Object.keys(data)) {
|
|
const data_ = data[id];
|
|
const tilejson = data[id].tileJSON;
|
|
const center = tilejson.center;
|
|
if (center) {
|
|
data_.viewer_hash = `#${center[2]}/${center[1].toFixed(
|
|
5,
|
|
)}/${center[0].toFixed(5)}`;
|
|
}
|
|
data_.is_vector = tilejson.format === 'pbf';
|
|
if (!data_.is_vector) {
|
|
if (center) {
|
|
const centerPx = mercator.px([center[0], center[1]], center[2]);
|
|
data_.thumbnail = `${center[2]}/${Math.floor(
|
|
centerPx[0] / 256,
|
|
)}/${Math.floor(centerPx[1] / 256)}.${data_.tileJSON.format}`;
|
|
}
|
|
|
|
data_.xyz_link = getTileUrls(
|
|
req,
|
|
tilejson.tiles,
|
|
`data/${id}`,
|
|
tilejson.format,
|
|
opts.publicUrl,
|
|
{
|
|
pbf: options.pbfAlias,
|
|
},
|
|
)[0];
|
|
}
|
|
if (data_.filesize) {
|
|
let suffix = 'kB';
|
|
let size = parseInt(data_.filesize, 10) / 1024;
|
|
if (size > 1024) {
|
|
suffix = 'MB';
|
|
size /= 1024;
|
|
}
|
|
if (size > 1024) {
|
|
suffix = 'GB';
|
|
size /= 1024;
|
|
}
|
|
data_.formatted_filesize = `${size.toFixed(2)} ${suffix}`;
|
|
}
|
|
}
|
|
return {
|
|
styles: Object.keys(styles).length ? styles : null,
|
|
data: Object.keys(data).length ? data : null,
|
|
};
|
|
});
|
|
|
|
serveTemplate('/styles/:id/$', 'viewer', (req) => {
|
|
const id = req.params.id;
|
|
const style = clone(((serving.styles || {})[id] || {}).styleJSON);
|
|
if (!style) {
|
|
return null;
|
|
}
|
|
style.id = id;
|
|
style.name = (serving.styles[id] || serving.rendered[id]).name;
|
|
style.serving_data = serving.styles[id];
|
|
style.serving_rendered = serving.rendered[id];
|
|
return style;
|
|
});
|
|
|
|
/*
|
|
app.use('/rendered/:id/$', function(req, res, next) {
|
|
return res.redirect(301, '/styles/' + req.params.id + '/');
|
|
});
|
|
*/
|
|
serveTemplate('/styles/:id/wmts.xml', 'wmts', (req) => {
|
|
const id = req.params.id;
|
|
const wmts = clone((serving.styles || {})[id]);
|
|
if (!wmts) {
|
|
return null;
|
|
}
|
|
if (wmts.hasOwnProperty('serve_rendered') && !wmts.serve_rendered) {
|
|
return null;
|
|
}
|
|
wmts.id = id;
|
|
wmts.name = (serving.styles[id] || serving.rendered[id]).name;
|
|
if (opts.publicUrl) {
|
|
wmts.baseUrl = opts.publicUrl;
|
|
} else {
|
|
wmts.baseUrl = `${
|
|
req.get('X-Forwarded-Protocol')
|
|
? req.get('X-Forwarded-Protocol')
|
|
: req.protocol
|
|
}://${req.get('host')}/`;
|
|
}
|
|
return wmts;
|
|
});
|
|
|
|
serveTemplate('/data/:id/$', 'data', (req) => {
|
|
const id = req.params.id;
|
|
const data = clone(serving.data[id]);
|
|
if (!data) {
|
|
return null;
|
|
}
|
|
data.id = id;
|
|
data.is_vector = data.tileJSON.format === 'pbf';
|
|
return data;
|
|
});
|
|
|
|
let startupComplete = false;
|
|
const startupPromise = Promise.all(startupPromises).then(() => {
|
|
console.log('Startup complete');
|
|
startupComplete = true;
|
|
});
|
|
app.get('/health', (req, res, next) => {
|
|
if (startupComplete) {
|
|
return res.status(200).send('OK');
|
|
} else {
|
|
return res.status(503).send('Starting');
|
|
}
|
|
});
|
|
|
|
const server = app.listen(
|
|
process.env.PORT || opts.port,
|
|
process.env.BIND || opts.bind,
|
|
function () {
|
|
let address = this.address().address;
|
|
if (address.indexOf('::') === 0) {
|
|
address = `[${address}]`; // literal IPv6 address
|
|
}
|
|
console.log(`Listening at http://${address}:${this.address().port}/`);
|
|
},
|
|
);
|
|
|
|
// add server.shutdown() to gracefully stop serving
|
|
enableShutdown(server);
|
|
|
|
return {
|
|
app: app,
|
|
server: server,
|
|
startupPromise: startupPromise,
|
|
};
|
|
}
|
|
|
|
/**
|
|
*
|
|
* @param opts
|
|
*/
|
|
export function server(opts) {
|
|
const running = start(opts);
|
|
|
|
running.startupPromise.catch((err) => {
|
|
console.error(err.message);
|
|
process.exit(1);
|
|
});
|
|
|
|
process.on('SIGINT', () => {
|
|
process.exit();
|
|
});
|
|
|
|
process.on('SIGHUP', () => {
|
|
console.log('Stopping server and reloading config');
|
|
|
|
running.server.shutdown(() => {
|
|
const restarted = start(opts);
|
|
running.server = restarted.server;
|
|
running.app = restarted.app;
|
|
});
|
|
});
|
|
|
|
return running;
|
|
}
|