tileserver-gl-light 5.5.0-pre.4 → 5.5.0-pre.6

package/src/serve_rendered.js

@@ -531,30 +531,43 @@ async function respondImage(
     pool = item.map.renderersStatic[scale];
   }
 
+  if (!pool) {
+    console.error(`Pool not found for scale ${scale}, mode ${mode}`);
+    return res.status(500).send('Renderer pool not configured');
+  }
+
   pool.acquire(async (err, renderer) => {
     // Check if pool.acquire failed or returned null/invalid renderer
     if (err) {
       console.error('Failed to acquire renderer from pool:', err);
-      return res.status(503).send('Renderer pool error');
+      if (!res.headersSent) {
+        return res.status(503).send('Renderer pool error');
+      }
+      return;
     }
 
     if (!renderer) {
       console.error(
         'Renderer is null - likely crashed or failed to initialize',
       );
-      return res.status(503).send('Renderer unavailable');
+      if (!res.headersSent) {
+        return res.status(503).send('Renderer unavailable');
+      }
+      return;
     }
 
     // Validate renderer has required methods (basic health check)
     if (typeof renderer.render !== 'function') {
       console.error('Renderer is invalid - missing render method');
-      // Destroy the bad renderer and remove from pool
       try {
-        pool.destroy(renderer);
+        pool.removeBadObject(renderer);
       } catch (e) {
-        console.error('Error destroying invalid renderer:', e);
+        console.error('Error removing bad renderer:', e);
+      }
+      if (!res.headersSent) {
+        return res.status(503).send('Renderer invalid');
       }
-      return res.status(503).send('Renderer invalid');
+      return;
     }
 
     // For 512px tiles, use the actual maplibre-native zoom. For 256px tiles, use zoom - 1
@@ -588,13 +601,14 @@ async function respondImage(
 
     // Set a timeout for the render operation to detect hung renderers
     const renderTimeout = setTimeout(() => {
-      console.error('Renderer timeout - destroying potentially hung renderer');
+      console.error('Renderer timeout - destroying hung renderer');
+
       try {
-        // Don't release back to pool, destroy it
-        pool.destroy(renderer);
+        pool.removeBadObject(renderer);
       } catch (e) {
-        console.error('Error destroying timed-out renderer:', e);
+        console.error('Error removing timed-out renderer:', e);
       }
+
       if (!res.headersSent) {
         res.status(503).send('Renderer timeout');
       }
@@ -604,13 +618,17 @@ async function respondImage(
       renderer.render(params, (err, data) => {
         clearTimeout(renderTimeout);
 
+        if (res.headersSent) {
+          // Timeout already fired and sent response, don't process
+          return;
+        }
+
         if (err) {
           console.error('Render error:', err);
-          // Destroy renderer instead of releasing it back to pool since it may be corrupted
           try {
-            pool.destroy(renderer);
+            pool.removeBadObject(renderer);
           } catch (e) {
-            console.error('Error destroying failed renderer:', e);
+            console.error('Error removing failed renderer:', e);
           }
           if (!res.headersSent) {
             return res
@@ -646,12 +664,11 @@ async function respondImage(
             height: height * scale,
           });
         }
-        // HACK(Part 2) 256px tiles are a zoom level lower than maplibre-native default tiles. this hack allows tileserver-gl to support zoom 0 256px tiles, which would actually be zoom -1 in maplibre-native. Since zoom -1 isn't supported, a double sized zoom 0 tile is requested and resized here.
 
+        // HACK(Part 2) 256px tiles are a zoom level lower than maplibre-native default tiles. this hack allows tileserver-gl to support zoom 0 256px tiles, which would actually be zoom -1 in maplibre-native. Since zoom -1 isn't supported, a double sized zoom 0 tile is requested and resized here.
         if (z === 0 && width === 256) {
           image.resize(width * scale, height * scale);
         }
-        // END HACK(Part 2)
 
         const composites = [];
         if (overlay) {
@@ -659,7 +676,6 @@ async function respondImage(
         }
         if (item.watermark) {
           const canvas = renderWatermark(width, height, scale, item.watermark);
-
           composites.push({ input: canvas.toBuffer() });
         }
 
@@ -670,7 +686,6 @@ async function respondImage(
             scale,
             item.staticAttributionText,
           );
-
           composites.push({ input: canvas.toBuffer() });
         }
 
@@ -687,7 +702,6 @@ async function respondImage(
         }
         // eslint-disable-next-line security/detect-object-injection -- format is validated above
         const formatQuality = formatQualities[format];
-
         // eslint-disable-next-line security/detect-object-injection -- format is validated above
         const formatOptions = (options.formatOptions || {})[format] || {};
 
@@ -710,25 +724,32 @@ async function respondImage(
         } else if (format === 'webp') {
           image.webp({ quality: formatOptions.quality || formatQuality || 90 });
         }
+
         image.toBuffer((err, buffer, info) => {
-          if (!buffer) {
-            return res.status(404).send('Not found');
+          if (err || !buffer) {
+            console.error('Sharp error:', err);
+            if (!res.headersSent) {
+              return res.status(500).send('Image processing failed');
+            }
+            return;
           }
 
-          res.set({
-            'Last-Modified': item.lastModified,
-            'Content-Type': `image/${format}`,
-          });
-          return res.status(200).send(buffer);
+          if (!res.headersSent) {
+            res.set({
+              'Last-Modified': item.lastModified,
+              'Content-Type': `image/${format}`,
+            });
+            return res.status(200).send(buffer);
+          }
         });
       });
     } catch (error) {
       clearTimeout(renderTimeout);
       console.error('Unexpected error during render:', error);
       try {
-        pool.destroy(renderer);
+        pool.removeBadObject(renderer);
       } catch (e) {
-        console.error('Error destroying renderer after error:', e);
+        console.error('Error removing renderer after error:', e);
       }
       if (!res.headersSent) {
         return res.status(500).send('Render failed');
@@ -1073,7 +1094,7 @@ export const serve_rendered = {
             (!p1 && p2 === 'static') || (p1 === 'static' && p2 === 'raw')
               ? 'static'
               : 'tile';
-          if (verbose) {
+          if (verbose >= 3) {
             console.log(
               `Handling rendered %s request for: /styles/%s%s/%s/%s/%s%s.%s`,
               requestType,
@@ -1133,7 +1154,7 @@ export const serve_rendered = {
         return res.sendStatus(404);
       }
       const tileSize = parseInt(req.params.tileSize, 10) || undefined;
-      if (verbose) {
+      if (verbose >= 3) {
         console.log(
           `Handling rendered tilejson request for: /styles/%s%s.json`,
           req.params.tileSize
@@ -1184,11 +1205,16 @@ export const serve_rendered = {
       renderersStatic: [],
       sources: {},
       sourceTypes: {},
+      sparseFlags: {},
     };
 
-    const { publicUrl, verbose } = programOpts;
+    const { publicUrl, verbose, fetchTimeout } = programOpts;
 
     const styleJSON = clone(style);
+
+    // Global sparse flag for HTTP/remote sources (from config options)
+    const globalSparse = options.sparse ?? true;
+
     /**
      * Creates a pool of renderers.
      * @param {number} ratio Pixel ratio
@@ -1210,7 +1236,7 @@ export const serve_rendered = {
           ratio,
           request: async (req, callback) => {
             const protocol = req.url.split(':')[0];
-            if (verbose && verbose >= 3) {
+            if (verbose >= 3) {
               console.log('Handling request:', req);
             }
             if (protocol === 'sprites') {
@@ -1266,22 +1292,18 @@ export const serve_rendered = {
                 x,
                 y,
               );
-              if (fetchTile == null && sourceInfo.sparse == true) {
-                if (verbose) {
-                  console.log(
-                    'fetchTile warning on %s, sparse response',
-                    req.url,
-                  );
+              if (fetchTile == null) {
+                if (verbose >= 2) {
+                  console.log('fetchTile null on %s', req.url);
                 }
-                callback();
-                return;
-              } else if (fetchTile == null) {
-                if (verbose) {
-                  console.log(
-                    'fetchTile error on %s, serving empty response',
-                    req.url,
-                  );
+                // eslint-disable-next-line security/detect-object-injection -- sourceId from internal style source names
+                const sparse = map.sparseFlags[sourceId] ?? true;
+                // sparse=true (default) -> return empty callback so MapLibre can overzoom
+                if (sparse) {
+                  callback();
+                  return;
                 }
+                // sparse=false -> 204 (empty tile, no overzoom) - create blank response
                 createEmptyResponse(
                   sourceInfo.format,
                   sourceInfo.color,
@@ -1320,40 +1342,58 @@ export const serve_rendered = {
 
               callback(null, response);
             } else if (protocol === 'http' || protocol === 'https') {
-              try {
-                // Add timeout to prevent hanging on unreachable hosts
-                const controller = new AbortController();
-                const timeoutId = setTimeout(() => controller.abort(), 10000); // 10 second timeout
+              const controller = new AbortController();
+              const timeoutMs = (fetchTimeout && Number(fetchTimeout)) || 15000;
+              let timeoutId;
 
+              try {
+                timeoutId = setTimeout(() => controller.abort(), timeoutMs);
                 const response = await fetch(req.url, {
                   signal: controller.signal,
                 });
-
                 clearTimeout(timeoutId);
 
-                // Handle 410 Gone as sparse response
-                if (response.status === 410) {
-                  if (verbose) {
+                // HTTP 204 No Content means "empty tile" - generate a blank tile
+                if (response.status === 204) {
+                  const parts = url.parse(req.url);
+                  const extension = path.extname(parts.pathname).toLowerCase();
+                  // eslint-disable-next-line security/detect-object-injection -- extension is from path.extname, limited set
+                  const format = extensionToFormat[extension] || '';
+                  createEmptyResponse(format, '', callback);
+                  return;
+                }
+
+                if (!response.ok) {
+                  if (verbose >= 2) {
                     console.log(
-                      'fetchTile warning on %s, sparse response due to 410 Gone',
+                      'fetchTile HTTP %d on %s, %s',
+                      response.status,
                       req.url,
+                      globalSparse
+                        ? 'allowing overzoom'
+                        : 'creating empty tile',
                     );
                   }
-                  callback();
-                  return;
-                }
 
-                // Check for other non-ok responses
-                if (!response.ok) {
-                  throw new Error(
-                    `HTTP ${response.status}: ${response.statusText}`,
-                  );
+                  if (globalSparse) {
+                    // sparse=true -> allow overzoom
+                    callback();
+                    return;
+                  }
+
+                  // sparse=false (default) -> create empty tile
+                  const parts = url.parse(req.url);
+                  const extension = path.extname(parts.pathname).toLowerCase();
+                  // eslint-disable-next-line security/detect-object-injection -- extension is from path.extname, limited set
+                  const format = extensionToFormat[extension] || '';
+                  createEmptyResponse(format, '', callback);
+                  return;
                 }
 
                 const responseHeaders = response.headers;
                 const responseData = await response.arrayBuffer();
-
                 const parsedResponse = {};
+
                 if (responseHeaders.get('last-modified')) {
                   parsedResponse.modified = new Date(
                     responseHeaders.get('last-modified'),
@@ -1371,8 +1411,7 @@ export const serve_rendered = {
                 parsedResponse.data = Buffer.from(responseData);
                 callback(null, parsedResponse);
               } catch (error) {
-                // Log DNS failures more prominently as they often indicate config issues
-                // Native fetch wraps DNS errors in error.cause
+                // Log DNS failures
                 if (error.cause?.code === 'ENOTFOUND') {
                   console.error(
                     `DNS RESOLUTION FAILED for ${req.url}. ` +
@@ -1381,20 +1420,27 @@ export const serve_rendered = {
                   );
                 }
 
-                // Handle AbortController timeout
+                // Log timeout
                 if (error.name === 'AbortError') {
                   console.error(
                     `FETCH TIMEOUT for ${req.url}. ` +
-                      `The request took longer than 10 seconds to complete.`,
+                      `The request took longer than ${timeoutMs} ms to complete.`,
                   );
                 }
 
-                // For all other errors (e.g., network errors, 404, 500, etc.) return empty content.
+                // Log all other errors
                 console.error(
                   `Error fetching remote URL ${req.url}:`,
                   error.message || error,
                 );
 
+                if (globalSparse) {
+                  // sparse=true -> allow overzoom
+                  callback();
+                  return;
+                }
+
+                // sparse=false (default) -> create empty tile
                 const parts = url.parse(req.url);
                 const extension = path.extname(parts.pathname).toLowerCase();
                 // eslint-disable-next-line security/detect-object-injection -- extension is from path.extname, limited set
@@ -1476,7 +1522,7 @@ export const serve_rendered = {
 
         // Remove (flatten) 3D buildings
         if (layer.paint['fill-extrusion-height']) {
-          if (verbose) {
+          if (verbose >= 1) {
             console.warn(
               `Warning: Layer '${layerIdForWarning}' in style '${id}' has property 'fill-extrusion-height'. ` +
                 `3D extrusion may appear distorted or misleading when rendered as a static image due to camera angle limitations. ` +
@@ -1487,7 +1533,7 @@ export const serve_rendered = {
           layer.paint['fill-extrusion-height'] = 0;
         }
         if (layer.paint['fill-extrusion-base']) {
-          if (verbose) {
+          if (verbose >= 1) {
             console.warn(
               `Warning: Layer '${layerIdForWarning}' in style '${id}' has property 'fill-extrusion-base'. ` +
                 `3D extrusion may appear distorted or misleading when rendered as a static image due to camera angle limitations. ` +
@@ -1507,7 +1553,7 @@ export const serve_rendered = {
 
         for (const prop of hillshadePropertiesToRemove) {
           if (prop in layer.paint) {
-            if (verbose) {
+            if (verbose >= 1) {
               console.warn(
                 `Warning: Layer '${layerIdForWarning}' in style '${id}' has property '${prop}'. ` +
                   `This property is not supported by MapLibre Native. ` +
@@ -1522,7 +1568,7 @@ export const serve_rendered = {
 
         // --- Remove 'hillshade-shadow-color' if it is an array. It can only be a string in MapLibre Native ---
         if (Array.isArray(layer.paint['hillshade-shadow-color'])) {
-          if (verbose) {
+          if (verbose >= 1) {
             console.warn(
               `Warning: Layer '${layerIdForWarning}' in style '${id}' has property 'hillshade-shadow-color'. ` +
                 `An array value is not supported by MapLibre Native for this property (expected string/color). ` +
@@ -1568,7 +1614,6 @@ export const serve_rendered = {
 
     for (const name of Object.keys(styleJSON.sources)) {
       let sourceType;
-      let sparse;
       // eslint-disable-next-line security/detect-object-injection -- name is from style sources object keys
       let source = styleJSON.sources[name];
       let url = source.url;
@@ -1599,7 +1644,6 @@ export const serve_rendered = {
         if (dataInfo.inputFile) {
           inputFile = dataInfo.inputFile;
           sourceType = dataInfo.fileType;
-          sparse = dataInfo.sparse;
           s3Profile = dataInfo.s3Profile;
           requestPayer = dataInfo.requestPayer;
           s3Region = dataInfo.s3Region;
@@ -1643,7 +1687,6 @@ export const serve_rendered = {
           const type = source.type;
           Object.assign(source, metadata);
           source.type = type;
-          source.sparse = sparse;
           source.tiles = [
             // meta url which will be detected when requested
             `pmtiles://${name}/{z}/{x}/{y}.${metadata.format || 'pbf'}`,
@@ -1662,6 +1705,13 @@ export const serve_rendered = {
               tileJSON.attribution += source.attribution;
             }
           }
+
+          // Set sparse flag: user config overrides format-based default
+          // Vector tiles (pbf) default to false (204), raster tiles default to true (404)
+          const isVector = metadata.format === 'pbf';
+          // eslint-disable-next-line security/detect-object-injection -- name is from style sources object keys
+          map.sparseFlags[name] =
+            dataInfo.sparse ?? options.sparse ?? !isVector;
         } else {
           // MBTiles does not support remote URLs
 
@@ -1687,7 +1737,6 @@ export const serve_rendered = {
           const type = source.type;
           Object.assign(source, info);
           source.type = type;
-          source.sparse = sparse;
           source.tiles = [
             // meta url which will be detected when requested
             `mbtiles://${name}/{z}/{x}/{y}.${info.format || 'pbf'}`,
@@ -1710,6 +1759,13 @@ export const serve_rendered = {
               tileJSON.attribution += source.attribution;
             }
           }
+
+          // Set sparse flag: user config overrides format-based default
+          // Vector tiles (pbf) default to false (204), raster tiles default to true (404)
+          const isVector = info.format === 'pbf';
+          // eslint-disable-next-line security/detect-object-injection -- name is from style sources object keys
+          map.sparseFlags[name] =
+            dataInfo.sparse ?? options.sparse ?? !isVector;
         }
       }
     }

package/src/serve_style.js

@@ -35,7 +35,7 @@ export const serve_style = {
      */
     app.get('/:id/style.json', (req, res, next) => {
       const { id } = req.params;
-      if (verbose) {
+      if (verbose >= 1) {
         console.log(
           'Handling style request for: /styles/%s/style.json',
           String(id).replace(/\n|\r/g, ''),
@@ -95,7 +95,7 @@ export const serve_style = {
         const sanitizedFormat = format
           ? '.' + String(format).replace(/\n|\r/g, '')
           : '';
-        if (verbose) {
+        if (verbose >= 1) {
           console.log(
             `Handling sprite request for: /styles/%s/sprite/%s%s%s`,
             sanitizedId,
@@ -108,7 +108,7 @@ export const serve_style = {
         const item = repo[id];
         const validatedFormat = allowedSpriteFormats(format);
         if (!item || !validatedFormat) {
-          if (verbose)
+          if (verbose >= 1)
             console.error(
               `Sprite item or format not found for: /styles/%s/sprite/%s%s%s`,
               sanitizedId,
@@ -123,7 +123,7 @@ export const serve_style = {
         );
         const spriteScale = allowedSpriteScales(scale);
         if (!sprite || spriteScale === null) {
-          if (verbose)
+          if (verbose >= 1)
             console.error(
               `Bad Sprite ID or Scale for: /styles/%s/sprite/%s%s%s`,
               sanitizedId,
@@ -147,7 +147,7 @@ export const serve_style = {
 
         const sanitizedSpritePath = sprite.path.replace(/^(\.\.\/)+/, '');
         const filename = `${sanitizedSpritePath}${spriteScale}.${validatedFormat}`;
-        if (verbose) console.log(`Loading sprite from: %s`, filename);
+        if (verbose >= 1) console.log(`Loading sprite from: %s`, filename);
         try {
           const data = await readFile(filename);
 
@@ -156,7 +156,7 @@ export const serve_style = {
           } else if (validatedFormat === 'png') {
             res.header('Content-type', 'image/png');
           }
-          if (verbose)
+          if (verbose >= 1)
             console.log(
               `Responding with sprite data for /styles/%s/sprite/%s%s%s`,
               sanitizedId,
@@ -167,7 +167,7 @@ export const serve_style = {
           res.set({ 'Last-Modified': item.lastModified });
           return res.send(data);
         } catch (err) {
-          if (verbose) {
+          if (verbose >= 1) {
             console.error(
               'Sprite load error: %s, Error: %s',
               filename,
@@ -217,7 +217,28 @@ export const serve_style = {
     const styleFile = path.resolve(options.paths.styles, params.style);
     const styleJSON = clone(style);
 
-    const validationErrors = validateStyleMin(styleJSON);
+    // Sanitize style for validation: remove non-spec properties (e.g., 'sparse')
+    // so that validateStyleMin doesn't reject valid styles containing our custom flags.
+    const styleForValidation = clone(styleJSON);
+    if (styleForValidation.sources) {
+      for (const name of Object.keys(styleForValidation.sources)) {
+        if (
+          // eslint-disable-next-line security/detect-object-injection -- name is from Object.keys of styleForValidation.sources
+          styleForValidation.sources[name] &&
+          // eslint-disable-next-line security/detect-object-injection -- name is from Object.keys of styleForValidation.sources
+          'sparse' in styleForValidation.sources[name]
+        ) {
+          try {
+            // eslint-disable-next-line security/detect-object-injection -- name is from Object.keys of styleForValidation.sources
+            delete styleForValidation.sources[name].sparse;
+          } catch (_err) {
+            // ignore any deletion errors and continue validation
+          }
+        }
+      }
+    }
+
+    const validationErrors = validateStyleMin(styleForValidation);
     if (validationErrors.length > 0) {
       console.log(`The file "${params.style}" is not a valid style file:`);
       for (const err of validationErrors) {