@mapwhit/tileserver 3.5.0

package/LICENSE.md

@@ -0,0 +1,26 @@
+Copyright (c) 2016, Klokan Technologies GmbH
+
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are
+met:
+
+1. Redistributions of source code must retain the above copyright
+   notice, this list of conditions and the following disclaimer.
+2. Redistributions in binary form must reproduce the above copyright
+   notice, this list of conditions and the following disclaimer in
+   the documentation and/or other materials provided with the
+   distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
+IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
+THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
+CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

package/README.md

@@ -0,0 +1,71 @@
+[![NPM version][npm-image]][npm-url]
+[![Build Status][build-image]][build-url]
+[![Dependency Status][deps-image]][deps-url]
+
+# @mapwhit/tileserver
+
+This is a slimmed down clone of the [tileserver-gl] package.
+It's intended to be used as a standalone server for tiles in [mbtiles] format.
+
+The following features of the original are not supported:
+
+- server side rasterization
+- font server - if needed use [map-glyph-server]
+- CORS support - if needed use behind NGINX or alternative
+
+## Installation
+
+```sh
+npm install -g @mapwhit/tileserver-gl-tiny
+```
+
+
+You will also need [mbtiles]
+
+## Usage
+
+```sh
+tileserver-gl-tiny --config path/to/config/file
+```
+
+Config file can be in `.json` or `yaml`. If config file name is not specified
+`tilesrc` config file is located according to the rules describe in the [rc] project.
+
+Config file example:
+
+```ini
+port = 5080
+max-age = 10d
+
+[options.paths]
+
+; this is where .mbtiles files are located
+root = /var/lib/tiles
+
+[data.v3]
+
+mbtiles = planet.mbtiles
+
+; add more [data.xxx] section to serve additional .mbtiles
+```
+
+## Documentation
+
+Most of the [tileserver-gl documentation] is relevant - specifically parts related to conig format.
+
+
+[mbtiles]: https://wiki.openstreetmap.org/wiki/MBTiles
+[tileserver-gl]: https://www.npmjs.com/package/tileserver-gl
+[rc]: https://www.npmjs.com/package/rc
+[tileserver-gl documentation]: http://tileserver.readthedocs.io
+[map-glyph-server]: https://github.com/furkot/map-glyph-server
+
+[npm-image]: https://img.shields.io/npm/v/@mapwhit/tileserver
+[npm-url]: https://npmjs.org/package/@mapwhit/tileserver
+
+[build-image]: https://img.shields.io/github/actions/workflow/status/mapwhit/tileserver/check.yaml?branch=main
+[build-url]: https://github.com/mapwhit/tileserver/actions/workflows/check.yaml
+
+[deps-image]: https://img.shields.io/librariesio/release/npm/@mapwhit/tileserver
+[deps-url]: https://libraries.io/npm/@mapwhit%2Ftileserver
+

package/bin/tileserver

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+
+require('..');

package/index.js

@@ -0,0 +1,28 @@
+const ms = require('ms');
+const config = require('rc')('tiles', {
+  port: process.env.PORT || 5080,
+  bind: process.env.BIND
+  // max-age: // 'max-age for Cache-Control header: "5d", "3h", "1y" etc.'
+});
+
+const { name, version } = require('./package.json');
+const makeServer = require('./lib/server');
+
+function startServer() {
+  config.cacheControl = cacheControl(config['max-age']);
+
+  console.log(`Starting ${name} v${version}`);
+  console.log(`Port ${config.port} on ${config.bind}`);
+
+  return makeServer(config);
+}
+
+function cacheControl(maxAgeMillis) {
+  if (!maxAgeMillis) {
+    return false;
+  }
+  const maxAge = Math.floor(ms(maxAgeMillis) / 1000);
+  return `public, max-age=${maxAge}`;
+}
+
+startServer();

package/lib/server.js

@@ -0,0 +1,84 @@
+process.env.UV_THREADPOOL_SIZE = Math.ceil(
+  Math.max(4, require('node:os').cpus().length * 1.5)
+);
+
+const fs = require('node:fs');
+const path = require('node:path');
+const connect = require('@pirxpilot/connect');
+const Router = require('@pirxpilot/router');
+const timings = require('server-timings');
+
+const tiles = require('./tiles');
+
+module.exports = makeServer;
+
+function makeServer(config, callback = () => {}) {
+  const { options = {}, data = {}, cacheControl } = config;
+
+  options.paths = checkPath(options.paths);
+
+  const app = connect();
+  app.use((req, res, next) => {
+    res.locals ??= Object.create(null);
+    timings(req, res, next);
+  });
+  if (cacheControl) {
+    app.use(function (req, res, next) {
+      res.setHeader('Cache-Control', cacheControl);
+      next();
+    });
+  }
+
+  const serving = Object.entries(data)
+    .map(([id, item]) => {
+      if (!item.mbtiles || item.mbtiles.length === 0) {
+        console.error(`Missing "mbtiles" property for ${id}`);
+        return;
+      }
+      const mountPath = `/data/${id}`;
+      const { router, createTileJSON } = tiles(mountPath, options, item);
+      app.use(mountPath, router);
+      return createTileJSON;
+    })
+    .filter(Boolean);
+
+  const router = new Router();
+  router.get(['/index.json', '/data.json'], sendTileJSONs);
+  app.use(router);
+
+  const server = app.listen(config.port, config.bind, function () {
+    const { address, port } = this.address();
+    console.log('Listening on http://[%s]:%d/', address, port);
+    return callback();
+  });
+
+  process.on('SIGINT', function () {
+    process.exit();
+  });
+
+  return {
+    app,
+    server
+  };
+
+  function sendTileJSONs(req, res) {
+    res.setHeader('Content-Type', 'application/json');
+    const result = serving.map(fn => fn(req));
+    res.end(JSON.stringify(result));
+  }
+}
+
+function checkPath(paths = {}, type = 'mbtiles') {
+  const resolved = path.resolve(paths.root || '', paths[type] || '');
+  if (!fs.existsSync(resolved)) {
+    console.error(
+      'The specified path for "%s" does not exist (%s).',
+      type,
+      resolved
+    );
+    process.exit(1);
+  }
+  console.log('%s located in %s', type, paths);
+  paths[type] = resolved;
+  return paths;
+}

package/lib/tiles.js

@@ -0,0 +1,110 @@
+const fs = require('node:fs');
+const path = require('node:path');
+const zlib = require('node:zlib');
+
+const Router = require('@pirxpilot/router');
+const mbtiles = require('@mapwhit/mbtiles');
+
+const { fixTileJSONCenter, getTileUrls } = require('./utils');
+
+module.exports = serveData;
+
+function serveData(mountPath, options, item) {
+  const domains = item.domains || options.domains;
+  const format = 'pbf';
+  const suffix = options.pbfAlias ?? format;
+  const tileJSON = {
+    tilejson: '2.0.0',
+    format
+  };
+
+  const filename = resolveFilename(options.paths.mbtiles, item.mbtiles);
+  const source = new mbtiles(filename);
+  const { filesize, mtime, scheme, tilejson, ...info } = source.getInfo();
+  Object.assign(tileJSON, info, item.tilejson);
+  fixTileJSONCenter(tileJSON);
+
+  const zoomRanges = initZoomRanges(tileJSON.minzoom, tileJSON.maxzoom);
+
+  const router = new Router();
+  router.get(`/:z/:x/:y.${suffix}`, checkParams, sendTile);
+  router.get('/{.json}', sendData);
+  return { router, createTileJSON };
+
+  function checkParams(req, res, next) {
+    const z = req.params.z | 0;
+    const x = req.params.x | 0;
+    const y = req.params.y | 0;
+
+    if (z < tileJSON.minzoom || z > tileJSON.maxzoom) {
+      return next(404);
+    }
+
+    const max = zoomRanges[z];
+
+    if (x < 0 || x >= max || y < 0 || y >= max) {
+      return next(404);
+    }
+
+    req.params.z = z;
+    req.params.x = x;
+    req.params.y = y;
+
+    next();
+  }
+
+  function sendTile(req, res, next) {
+    const { z, x, y } = req.params;
+    const { tile, headers, error } = source.getTile(z, x, y);
+    if (error) {
+      const { message } = error;
+      const status = /does not exist/.test(message) ? 404 : 500;
+      return res.writeHead(status, message).end();
+    }
+    if (tile == null) {
+      return next(404);
+    }
+    if (options.removeETag) {
+      delete headers['ETag']; // do not trust the tile ETag -- regenerate
+    }
+    headers['Content-Type'] ??= 'application/x-protobuf';
+    res.setHeaders(new Headers(headers));
+    res.end(tile);
+  }
+
+  function sendData(req, res) {
+    res.setHeader('Content-Type', 'application/json');
+    const info = createTileJSON(req);
+    return res.end(JSON.stringify(info));
+  }
+
+  function createTileJSON(req) {
+    return {
+      ...tileJSON,
+      tiles: getTileUrls(req, domains, mountPath, suffix)
+    };
+  }
+}
+
+function resolveFilename(dir, name) {
+  const filename = path.resolve(dir, name);
+  const stats = fs.statSync(filename);
+  if (!stats.isFile() || stats.size === 0) {
+    throw Error(`Not valid MBTiles file: ${filename}`);
+  }
+  return filename;
+}
+
+function isGzipped(data) {
+  return data[0] === 0x1f && data[1] === 0x8b;
+}
+
+function initZoomRanges(min, max) {
+  const ranges = [];
+  let value = 2 ** min;
+  for (let i = min; i <= max; i++) {
+    ranges[i] = value;
+    value *= 2;
+  }
+  return ranges;
+}

package/lib/utils.js

@@ -0,0 +1,37 @@
+module.exports = {
+  getTileUrls,
+  fixTileJSONCenter
+};
+
+function getTileUrls(req, domains, path, format) {
+  if (domains && typeof domains === 'string') {
+    domains = domains.split(/\s*,\s*/);
+  }
+
+  if (!domains || domains.length === 0) {
+    domains = [req.headers.host];
+  }
+
+  const protocol = req.headers['x-forwarded-proto']?.startsWith('https')
+    ? 'https'
+    : 'http';
+
+  return domains.map(
+    domain => `${protocol}://${domain}${path}/{z}/{x}/{y}.${format}`
+  );
+}
+
+function fixTileJSONCenter(tileJSON) {
+  if (tileJSON.bounds && !tileJSON.center) {
+    const fitWidth = 1024;
+    const tiles = fitWidth / 256;
+    tileJSON.center = [
+      (tileJSON.bounds[0] + tileJSON.bounds[2]) / 2,
+      (tileJSON.bounds[1] + tileJSON.bounds[3]) / 2,
+      Math.round(
+        -Math.log((tileJSON.bounds[2] - tileJSON.bounds[0]) / 360 / tiles) /
+          Math.LN2
+      )
+    ];
+  }
+}

package/package.json

@@ -0,0 +1,36 @@
+{
+  "name": "@mapwhit/tileserver",
+  "version": "3.5.0",
+  "description": "Map tile server for JSON GL styles - serving vector tiles",
+  "bin": {
+    "tileserver-gl-tiny": "bin/tileserver"
+  },
+  "authors": [
+    "Petr Sloup <petr.sloup@klokantech.com>",
+    "Damian Krzeminski <pirxpilot@furkot.com>"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/mapwhit/tileserver.git"
+  },
+  "license": "BSD-2-Clause",
+  "scripts": {
+    "test": "make check"
+  },
+  "dependencies": {
+    "@mapwhit/mbtiles": "^1.0.1",
+    "@pirxpilot/connect": "~4",
+    "@pirxpilot/router": "~1",
+    "ms": "~2",
+    "rc": "~1",
+    "server-timings": "~2"
+  },
+  "devDependencies": {
+    "@biomejs/biome": "^1.9.4",
+    "supertest": "~7"
+  },
+  "files": [
+    "index.js",
+    "lib"
+  ]
+}