tileserver-gl-light 5.1.3 → 5.2.0-pre.1

package/.github/workflows/automerger.yml

@@ -14,3 +14,4 @@ jobs:
       - uses: fastify/github-action-merge-dependabot@v3
         with:
           github-token: ${{ secrets.GITHUB_TOKEN }}
+          target: minor

package/.github/workflows/ci.yml

@@ -21,6 +21,11 @@ jobs:
         with:
           ref: ${{ github.event.pull_request.head.sha }}
 
+      - name: Install dependencies (Ubuntu) 🚀
+        run: >-
+          sudo apt-get install -qq libcairo2-dev libjpeg8-dev libpango1.0-dev
+          libgif-dev build-essential
+
       - name: Setup node env 📦
         uses: actions/setup-node@v4
         with:

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # tileserver-gl changelog
 
+## 5.2.0-pre.1
+* Use npm packages for public/resources (https://github.com/maptiler/tileserver-gl/pull/1427) by @okimiko
+* use ttf files of googlefonts/opensans (https://github.com/maptiler/tileserver-gl/pull/1447) by @okimiko
+* Limit Elevation Lat/Long Output Length (https://github.com/maptiler/tileserver-gl/pull/1457) by @okimiko
+* Fetch style from url (https://github.com/maptiler/tileserver-gl/pull/1462) by @YoelRidgway
+* fix: memory leak on SIGHUP (https://github.com/maptiler/tileserver-gl/pull/1455) by @okimiko
+* fix: resolves Unimplemented type: 3 error for geojson format #1465
+
 ## 5.1.3
 * Fix SIGHUP (broken since 5.1.x) (https://github.com/maptiler/tileserver-gl/pull/1452) by @okimiko
 

package/Dockerfile

@@ -5,49 +5,46 @@ ENV \
     CHOKIDAR_USEPOLLING=1 \
     CHOKIDAR_INTERVAL=500
 
-RUN set -ex; \
-    export DEBIAN_FRONTEND=noninteractive; \
-    groupadd -r node; \
-    useradd -r -g node node; \
-    apt-get -qq update; \
-    apt-get -y --no-install-recommends install \
+SHELL ["/bin/bash", "-o", "pipefail", "-c"]
+
+RUN export DEBIAN_FRONTEND=noninteractive && \
+    groupadd -r node && \
+    useradd -r -g node node && \
+    apt-get -qq update && \
+    apt-get install -y --no-install-recommends --no-install-suggests \
       ca-certificates \
       curl \
-      gnupg; \
-    mkdir -p /etc/apt/keyrings; \
-    curl -fsSL https://deb.nodesource.com/gpgkey/nodesource-repo.gpg.key | gpg --dearmor -o /etc/apt/keyrings/nodesource.gpg; \
-    echo "deb [signed-by=/etc/apt/keyrings/nodesource.gpg] https://deb.nodesource.com/node_22.x nodistro main" | tee /etc/apt/sources.list.d/nodesource.list; \
-    apt-get -qq update; \
-    apt-get install -y nodejs; \
-    npm i -g npm@latest; \
-    apt-get -y remove curl gnupg; \
-    apt-get -y --purge autoremove; \
-    apt-get clean; \
-    rm -rf /var/lib/apt/lists/*;
-
-EXPOSE 8080
-
-RUN mkdir -p /data; \
-    chown node:node /data; \
-    mkdir -p /usr/src/app;
-
+      gnupg && \
+    mkdir -p /etc/apt/keyrings && \
+    curl -fsSL https://deb.nodesource.com/gpgkey/nodesource-repo.gpg.key | gpg --dearmor -o /etc/apt/keyrings/nodesource.gpg && \
+    echo "deb [signed-by=/etc/apt/keyrings/nodesource.gpg] https://deb.nodesource.com/node_22.x nodistro main" | tee /etc/apt/sources.list.d/nodesource.list && \
+    apt-get -qq update && \
+    apt-get install -y --no-install-recommends --no-install-suggests nodejs && \
+    npm i -g npm@latest && \
+    apt-get -y remove curl gnupg && \
+    apt-get -y --purge autoremove && \
+    apt-get clean && \
+    rm -rf /var/lib/apt/lists/*
+
+WORKDIR /usr/src/app
+COPY . .
+
+RUN npm config set maxsockets 1 && \
+    npm config set fetch-retries 5 && \
+    npm config set fetch-retry-mintimeout 100000 && \
+    npm config set fetch-retry-maxtimeout 600000 && \
+    npm install --omit=dev && \
+    chown -R root:root . && \
+    chmod +x ./docker-entrypoint.sh
+
+RUN mkdir -p /data && chown node:node /data
 VOLUME /data
-
 WORKDIR /data
 
-COPY / /usr/src/app
-
-RUN cd /usr/src/app; \
-    npm config set maxsockets 1; \
-    npm config set fetch-retries 5; \
-    npm config set fetch-retry-mintimeout 100000; \
-    npm config set fetch-retry-maxtimeout 600000; \
-    npm install --omit=dev; \
-    chown -R root:root /usr/src/app; \
-    chmod +x /usr/src/app/docker-entrypoint.sh;
+EXPOSE 8080
 
 USER node:node
 
 ENTRYPOINT ["/usr/src/app/docker-entrypoint.sh"]
 
-HEALTHCHECK CMD node /usr/src/app/src/healthcheck.js
+HEALTHCHECK CMD node /usr/src/app/src/healthcheck.js

package/Dockerfile_build

@@ -0,0 +1,38 @@
+FROM ubuntu:jammy AS builder
+
+ENV NODE_ENV="devel"
+
+RUN export DEBIAN_FRONTEND=noninteractive && \
+    apt-get update && \
+    apt-get install -y --no-install-recommends --no-install-suggests \
+      build-essential \
+      ca-certificates \
+      curl \
+      gnupg \
+      pkg-config \
+      xvfb \
+      libglfw3-dev \
+      libuv1-dev \
+      libjpeg-turbo8 \
+      libicu70 \
+      libcairo2-dev \
+      libpango1.0-dev \
+      libjpeg-dev \
+      libgif-dev \
+      librsvg2-dev \
+      gir1.2-rsvg-2.0 \
+      librsvg2-2 \
+      librsvg2-common \
+      libcurl4-openssl-dev \
+      libpixman-1-dev \
+      libpixman-1-0 && \
+    mkdir -p /etc/apt/keyrings && \
+    curl -fsSL https://deb.nodesource.com/gpgkey/nodesource-repo.gpg.key | gpg --dearmor -o /etc/apt/keyrings/nodesource.gpg && \
+    echo "deb [signed-by=/etc/apt/keyrings/nodesource.gpg] https://deb.nodesource.com/node_22.x nodistro main" | tee /etc/apt/sources.list.d/nodesource.list && \
+    apt-get -qq update && \
+    apt-get install -y --no-install-recommends --no-install-suggests nodejs && \
+    npm i -g npm@latest && \
+    apt-get -y remove curl gnupg && \
+    apt-get -y --purge autoremove && \
+    apt-get clean && \
+    rm -rf /var/lib/apt/lists/*

package/changelog_for_version.md

@@ -1,2 +1,7 @@
-* Fix SIGHUP (broken since 5.1.x) (https://github.com/maptiler/tileserver-gl/pull/1452) by @okimiko
+* Use npm packages for public/resources (https://github.com/maptiler/tileserver-gl/pull/1427) by @okimiko
+* use ttf files of googlefonts/opensans (https://github.com/maptiler/tileserver-gl/pull/1447) by @okimiko
+* Limit Elevation Lat/Long Output Length (https://github.com/maptiler/tileserver-gl/pull/1457) by @okimiko
+* Fetch style from url (https://github.com/maptiler/tileserver-gl/pull/1462) by @YoelRidgway
+* fix: memory leak on SIGHUP (https://github.com/maptiler/tileserver-gl/pull/1455) by @okimiko
+* fix: resolves Unimplemented type: 3 error for geojson format #1465
 

package/docs/config.rst

@@ -57,6 +57,9 @@ Example:
         "tilejson": {
           "format": "webp"
         }
+      },
+      "remote": {
+        "style": "https://demotiles.maplibre.org/style.json"
       }
     },
     "data": {
@@ -209,7 +212,7 @@ Not used by default.
 
 Each item in this object defines one style (map). It can have the following options:
 
-* ``style`` -- name of the style json file [required]
+* ``style`` -- name of the style json file or url of a remote hosted style [required]
 * ``serve_rendered`` -- whether to render the raster tiles for this style or not
 * ``serve_data`` -- whether to allow access to the original tiles, sprites and required glyphs
 * ``tilejson`` -- properties to add to the TileJSON created for the raster data

package/package.json

@@ -1,11 +1,16 @@
 {
   "name": "tileserver-gl-light",
-  "version": "5.1.3",
+  "version": "5.2.0-pre.1",
   "description": "Map tile server for JSON GL styles - serving vector tiles",
   "main": "src/main.js",
   "bin": "src/main.js",
   "type": "module",
   "scripts": {
+    "copy:maplibre": "copyfiles -EVf node_modules/maplibre-gl/dist/maplibre-gl.js node_modules/maplibre-gl/dist/maplibre-gl.js.map node_modules/maplibre-gl/dist/maplibre-gl.css public/resources/",
+    "copy:maplibre-inspect": "copyfiles -EVf node_modules/@maplibre/maplibre-gl-inspect/dist/maplibre-gl-inspect.js node_modules/@maplibre/maplibre-gl-inspect/dist/maplibre-gl-inspect.js.map node_modules/@maplibre/maplibre-gl-inspect/dist/maplibre-gl-inspect.css  public/resources/",
+    "copy:mapbox-rtl-text": "copyfiles -EVf node_modules/@mapbox/mapbox-gl-rtl-text/dist/mapbox-gl-rtl-text.js public/resources/",
+    "copy:leaflet": "copyfiles -EVf node_modules/leaflet/dist/leaflet.js node_modules/leaflet/dist/leaflet.js.map node_modules/leaflet/dist/leaflet.css node_modules/leaflet/dist/leaflet-hash.js public/resources/",
+    "copy:leaflet-hash": "copyfiles -EVf node_modules/leaflet-hash/leaflet-hash.js public/resources/",
     "test": "mocha test/**.js --timeout 10000 --exit",
     "test-docker": "xvfb-run npm test",
     "lint:yml": "yamllint --schema=CORE_SCHEMA *.{yml,yaml}",
@@ -19,14 +24,16 @@
   },
   "dependencies": {
     "@jsse/pbfont": "^0.2.2",
+    "@mapbox/mapbox-gl-rtl-text": "0.3.0",
     "@mapbox/mbtiles": "0.12.1",
     "@mapbox/polyline": "^1.2.1",
     "@mapbox/sphericalmercator": "1.2.0",
     "@mapbox/vector-tile": "2.0.3",
+    "@maplibre/maplibre-gl-inspect": "1.7.0",
     "@maplibre/maplibre-gl-style-spec": "20.3.1",
     "@sindresorhus/fnv1a": "3.1.0",
     "advanced-pool": "0.3.3",
-    "axios": "^1.7.7",
+    "axios": "^1.8.2",
     "chokidar": "3.6.0",
     "clone": "2.1.2",
     "color": "4.2.3",
@@ -35,6 +42,9 @@
     "express": "5.0.1",
     "handlebars": "4.7.8",
     "http-shutdown": "1.2.2",
+    "leaflet": "1.9.4",
+    "leaflet-hash": "0.2.1",
+    "maplibre-gl": "4.7.1",
     "morgan": "1.10.0",
     "pbf": "4.0.1",
     "pmtiles": "3.0.7",

package/public/resources/elevation-control.js

@@ -18,7 +18,7 @@ class ElevationInfoControl {
 
       map.on('click', (e) => {
         var url = this.url;
-        var coord = {"z": Math.floor(map.getZoom()), "x": e.lngLat["lng"], "y": e.lngLat["lat"]};
+        var coord = {"z": Math.floor(map.getZoom()), "x": e.lngLat["lng"].toFixed(7), "y": e.lngLat["lat"].toFixed(7)};
         for(var key in coord) {
           url = url.replace(new RegExp('{'+ key +'}','g'), coord[key]);
         }

package/src/serve_data.js

@@ -21,6 +21,7 @@ import { openMbTilesWrapper } from './mbtiles_wrapper.js';
 
 import fs from 'node:fs';
 import { fileURLToPath } from 'url';
+
 const packageJson = JSON.parse(
   fs.readFileSync(
     path.dirname(fileURLToPath(import.meta.url)) + '/../package.json',
@@ -113,12 +114,13 @@ export const serve_data = {
       let headers = fetchTile.headers;
       let isGzipped = data.slice(0, 2).indexOf(Buffer.from([0x1f, 0x8b])) === 0;
 
+      if (isGzipped) {
+        data = await gunzipP(data);
+        isGzipped = false;
+      }
+
       if (tileJSONFormat === 'pbf') {
         if (options.dataDecoratorFunc) {
-          if (isGzipped) {
-            data = await gunzipP(data);
-            isGzipped = false;
-          }
           data = options.dataDecoratorFunc(
             req.params.id,
             'data',
@@ -259,8 +261,8 @@ export const serve_data = {
 
         let data = fetchTile.data;
         var param = {
-          long: bbox[0],
-          lat: bbox[1],
+          long: bbox[0].toFixed(7),
+          lat: bbox[1].toFixed(7),
           encoding,
           format,
           tile_size: TILE_SIZE,

package/src/serve_light.js

@@ -6,6 +6,7 @@ export const serve_rendered = {
   init: (options, repo, programOpts) => {},
   add: (options, repo, params, id, programOpts, dataResolver) => {},
   remove: (repo, id) => {},
+  clear: (repo) => {},
   getTerrainElevation: (data, param) => {
     param['elevation'] = 'not supported in light';
     return param;

package/src/serve_rendered.js

@@ -15,7 +15,6 @@ import '@maplibre/maplibre-gl-native';
 import advancedPool from 'advanced-pool';
 import path from 'path';
 import url from 'url';
-import util from 'util';
 import sharp from 'sharp';
 import clone from 'clone';
 import Color from 'color';
@@ -1028,10 +1027,19 @@ export const serve_rendered = {
    * @param {object} params Parameters object.
    * @param {string} id ID of the item.
    * @param {object} programOpts - An object containing the program options
+   * @param {object} style pre-fetched/read StyleJSON object.
    * @param {Function} dataResolver Function to resolve data.
    * @returns {Promise<void>}
    */
-  add: async function (options, repo, params, id, programOpts, dataResolver) {
+  add: async function (
+    options,
+    repo,
+    params,
+    id,
+    programOpts,
+    style,
+    dataResolver,
+  ) {
     const map = {
       renderers: [],
       renderersStatic: [],
@@ -1041,7 +1049,7 @@ export const serve_rendered = {
 
     const { publicUrl, verbose } = programOpts;
 
-    let styleJSON;
+    const styleJSON = clone(style);
     /**
      * Creates a pool of renderers.
      * @param {number} ratio Pixel ratio
@@ -1230,12 +1238,6 @@ export const serve_rendered = {
 
     const styleFile = params.style;
     const styleJSONPath = path.resolve(options.paths.styles, styleFile);
-    try {
-      styleJSON = JSON.parse(await fsp.readFile(styleJSONPath));
-    } catch (e) {
-      console.log('Error parsing style file');
-      return false;
-    }
 
     if (styleJSON.sprite) {
       if (!Array.isArray(styleJSON.sprite)) {
@@ -1458,7 +1460,25 @@ export const serve_rendered = {
     }
     delete repo[id];
   },
-
+  /**
+   * Removes all items from the repository.
+   * @param {object} repo Repository object.
+   * @returns {void}
+   */
+  clear: function (repo) {
+    Object.keys(repo).forEach((id) => {
+      const item = repo[id];
+      if (item) {
+        item.map.renderers.forEach((pool) => {
+          pool.close();
+        });
+        item.map.renderersStatic.forEach((pool) => {
+          pool.close();
+        });
+      }
+      delete repo[id];
+    });
+  },
   /**
    * Get the elevation of terrain tile data by rendering it to a canvas image
    * @param {object} data The background color (or empty string for transparent).

package/src/serve_style.js

@@ -196,9 +196,10 @@ export const serve_style = {
    * @param {object} params Parameters object containing style path
    * @param {string} id ID of the style.
    * @param {object} programOpts - An object containing the program options
+   * @param {object} style pre-fetched/read StyleJSON object.
    * @param {Function} reportTiles Function for reporting tile sources.
    * @param {Function} reportFont Function for reporting font usage
-   * @returns {boolean} true if add is succesful
+   * @returns {boolean} true if add is successful
    */
   add: function (
     options,
@@ -206,21 +207,14 @@ export const serve_style = {
     params,
     id,
     programOpts,
+    style,
     reportTiles,
     reportFont,
   ) {
     const { publicUrl } = programOpts;
     const styleFile = path.resolve(options.paths.styles, params.style);
+    const styleJSON = clone(style);
 
-    let styleFileData;
-    try {
-      styleFileData = fs.readFileSync(styleFile); // TODO: could be made async if this function was
-    } catch (e) {
-      console.log(`Error reading style file "${params.style}"`);
-      return false;
-    }
-
-    const styleJSON = JSON.parse(styleFileData);
     const validationErrors = validateStyleMin(styleJSON);
     if (validationErrors.length > 0) {
       console.log(`The file "${params.style}" is not a valid style file:`);

package/src/server.js

@@ -178,10 +178,29 @@ async function start(opts) {
    * @param {object} item - The style configuration object.
    * @param {boolean} allowMoreData - Whether to allow adding more data sources.
    * @param {boolean} reportFonts - Whether to report fonts.
-   * @returns {void}
+   * @returns {Promise<void>}
    */
-  function addStyle(id, item, allowMoreData, reportFonts) {
+  async function addStyle(id, item, allowMoreData, reportFonts) {
     let success = true;
+
+    let styleJSON;
+    try {
+      if (isValidHttpUrl(item.style)) {
+        const res = await fetch(item.style);
+        if (!res.ok) {
+          throw new Error(`fetch error ${res.status}`);
+        }
+        styleJSON = await res.json();
+      } else {
+        const styleFile = path.resolve(options.paths.styles, item.style);
+        const styleFileData = await fs.promises.readFile(styleFile);
+        styleJSON = JSON.parse(styleFileData);
+      }
+    } catch (e) {
+      console.log(`Error getting style file "${item.style}"`);
+      return false;
+    }
+
     if (item.serve_data !== false) {
       success = serve_style.add(
         options,
@@ -189,6 +208,7 @@ async function start(opts) {
         item,
         id,
         opts,
+        styleJSON,
         (styleSourceId, protocol) => {
           let dataItemId;
           for (const id of Object.keys(data)) {
@@ -246,6 +266,7 @@ async function start(opts) {
             item,
             id,
             opts,
+            styleJSON,
             function dataResolver(styleSourceId) {
               let fileType;
               let inputFile;
@@ -271,6 +292,7 @@ async function start(opts) {
         item.serve_rendered = false;
       }
     }
+    return success;
   }
 
   for (const id of Object.keys(config.styles || {})) {
@@ -279,8 +301,7 @@ async function start(opts) {
       console.log(`Missing "style" property for ${id}`);
       continue;
     }
-
-    addStyle(id, item, true, true);
+    startupPromises.push(addStyle(id, item, true, true));
   }
   startupPromises.push(
     serve_font(options, serving.fonts, opts).then((sub) => {
@@ -743,6 +764,7 @@ async function start(opts) {
     app,
     server,
     startupPromise,
+    serving,
   };
 }
 /**
@@ -777,8 +799,13 @@ export async function server(opts) {
 
     running.server.shutdown(async () => {
       const restarted = await start(opts);
+      if (!isLight) {
+        serve_rendered.clear(running.serving.rendered);
+      }
       running.server = restarted.server;
       running.app = restarted.app;
+      running.startupPromise = restarted.startupPromise;
+      running.serving = restarted.serving;
     });
   });
   return running;

package/public/resources/leaflet-hash.js

@@ -1,162 +0,0 @@
-(function(window) {
-	var HAS_HASHCHANGE = (function() {
-		var doc_mode = window.documentMode;
-		return ('onhashchange' in window) &&
-			(doc_mode === undefined || doc_mode > 7);
-	})();
-
-	L.Hash = function(map) {
-		this.onHashChange = L.Util.bind(this.onHashChange, this);
-
-		if (map) {
-			this.init(map);
-		}
-	};
-
-	L.Hash.parseHash = function(hash) {
-		if(hash.indexOf('#') === 0) {
-			hash = hash.substr(1);
-		}
-		var args = hash.split("/");
-		if (args.length == 3) {
-			var zoom = parseInt(args[0], 10),
-			lat = parseFloat(args[1]),
-			lon = parseFloat(args[2]);
-			if (isNaN(zoom) || isNaN(lat) || isNaN(lon)) {
-				return false;
-			} else {
-				return {
-					center: new L.LatLng(lat, lon),
-					zoom: zoom
-				};
-			}
-		} else {
-			return false;
-		}
-	};
-
-	L.Hash.formatHash = function(map) {
-		var center = map.getCenter(),
-		    zoom = map.getZoom(),
-		    precision = Math.max(0, Math.ceil(Math.log(zoom) / Math.LN2));
-
-		return "#" + [zoom,
-			center.lat.toFixed(precision),
-			center.lng.toFixed(precision)
-		].join("/");
-	},
-
-	L.Hash.prototype = {
-		map: null,
-		lastHash: null,
-
-		parseHash: L.Hash.parseHash,
-		formatHash: L.Hash.formatHash,
-
-		init: function(map) {
-			this.map = map;
-
-			// reset the hash
-			this.lastHash = null;
-			this.onHashChange();
-
-			if (!this.isListening) {
-				this.startListening();
-			}
-		},
-
-		removeFrom: function(map) {
-			if (this.changeTimeout) {
-				clearTimeout(this.changeTimeout);
-			}
-
-			if (this.isListening) {
-				this.stopListening();
-			}
-
-			this.map = null;
-		},
-
-		onMapMove: function() {
-			// bail if we're moving the map (updating from a hash),
-			// or if the map is not yet loaded
-
-			if (this.movingMap || !this.map._loaded) {
-				return false;
-			}
-
-			var hash = this.formatHash(this.map);
-			if (this.lastHash != hash) {
-				location.replace(hash);
-				this.lastHash = hash;
-			}
-		},
-
-		movingMap: false,
-		update: function() {
-			var hash = location.hash;
-			if (hash === this.lastHash) {
-				return;
-			}
-			var parsed = this.parseHash(hash);
-			if (parsed) {
-				this.movingMap = true;
-
-				this.map.setView(parsed.center, parsed.zoom);
-
-				this.movingMap = false;
-			} else {
-				this.onMapMove(this.map);
-			}
-		},
-
-		// defer hash change updates every 100ms
-		changeDefer: 100,
-		changeTimeout: null,
-		onHashChange: function() {
-			// throttle calls to update() so that they only happen every
-			// `changeDefer` ms
-			if (!this.changeTimeout) {
-				var that = this;
-				this.changeTimeout = setTimeout(function() {
-					that.update();
-					that.changeTimeout = null;
-				}, this.changeDefer);
-			}
-		},
-
-		isListening: false,
-		hashChangeInterval: null,
-		startListening: function() {
-			this.map.on("moveend", this.onMapMove, this);
-
-			if (HAS_HASHCHANGE) {
-				L.DomEvent.addListener(window, "hashchange", this.onHashChange);
-			} else {
-				clearInterval(this.hashChangeInterval);
-				this.hashChangeInterval = setInterval(this.onHashChange, 50);
-			}
-			this.isListening = true;
-		},
-
-		stopListening: function() {
-			this.map.off("moveend", this.onMapMove, this);
-
-			if (HAS_HASHCHANGE) {
-				L.DomEvent.removeListener(window, "hashchange", this.onHashChange);
-			} else {
-				clearInterval(this.hashChangeInterval);
-			}
-			this.isListening = false;
-		}
-	};
-	L.hash = function(map) {
-		return new L.Hash(map);
-	};
-	L.Map.prototype.addHash = function() {
-		this._hash = L.hash(this);
-	};
-	L.Map.prototype.removeHash = function() {
-		this._hash.removeFrom();
-	};
-})(window);