tileserver-gl-light 5.5.0-pre.1 → 5.5.0-pre.2

package/src/server.js

@@ -31,9 +31,9 @@ const packageJson = JSON.parse(
 );
 const isLight = packageJson.name.slice(-6) === '-light';
 
-const serve_rendered = (
-  await import(`${!isLight ? `./serve_rendered.js` : `./serve_light.js`}`)
-).serve_rendered;
+const { serve_rendered } = await import(
+  `${!isLight ? `./serve_rendered.js` : `./serve_light.js`}`
+);
 
 /**
  *  Starts the server.
@@ -60,8 +60,7 @@ async function start(opts) {
     app.use(
       morgan(logFormat, {
         stream: opts.logFile
-          ? // eslint-disable-next-line security/detect-non-literal-fs-filename -- logFile is from CLI/config, admin-controlled
-            fs.createWriteStream(opts.logFile, { flags: 'a' })
+          ? fs.createWriteStream(opts.logFile, { flags: 'a' })
           : process.stdout,
         skip: (req, res) =>
           opts.silent && (res.statusCode === 200 || res.statusCode === 304),
@@ -74,9 +73,8 @@ async function start(opts) {
   if (opts.configPath) {
     configPath = path.resolve(opts.configPath);
     try {
-      // eslint-disable-next-line security/detect-non-literal-fs-filename -- configPath is from CLI argument, expected behavior
       config = JSON.parse(fs.readFileSync(configPath, 'utf8'));
-    } catch (e) {
+    } catch {
       console.log('ERROR: Config file not found or invalid!');
       console.log('   See README.md for instructions and sample data.');
       process.exit(1);
@@ -109,8 +107,7 @@ async function start(opts) {
   const startupPromises = [];
 
   for (const type of Object.keys(paths)) {
-    // eslint-disable-next-line security/detect-object-injection -- type is from Object.keys of paths config
-    // eslint-disable-next-line security/detect-non-literal-fs-filename, security/detect-object-injection -- paths[type] constructed from validated config paths
+    // eslint-disable-next-line security/detect-object-injection -- paths[type] constructed from validated config paths
     if (!fs.existsSync(paths[type])) {
       console.error(
         // eslint-disable-next-line security/detect-object-injection -- type is from Object.keys of paths config
@@ -128,7 +125,7 @@ async function start(opts) {
    */
   async function getFiles(directory) {
     // Fetch all entries of the directory and attach type information
-    // eslint-disable-next-line security/detect-non-literal-fs-filename -- directory is constructed from validated config paths
+
     const dirEntries = await fs.promises.readdir(directory, {
       withFileTypes: true,
     });
@@ -157,12 +154,13 @@ async function start(opts) {
 
   if (options.dataDecorator) {
     try {
-      // eslint-disable-next-line security/detect-non-literal-require -- dataDecorator path is from config file, admin-controlled
-      options.dataDecoratorFunc = require(
-        path.resolve(paths.root, options.dataDecorator),
-      );
+      const dataDecoratorPath = path.resolve(paths.root, options.dataDecorator);
+
+      const module = await import(dataDecoratorPath);
+      options.dataDecoratorFunc = module.default;
     } catch (e) {
-      // Silently fail if dataDecorator cannot be loaded
+      console.error(`Error loading data decorator: ${e}`);
+      // Intentionally don't set options.dataDecoratorFunc - let it remain undefined
     }
   }
 
@@ -204,11 +202,11 @@ async function start(opts) {
         styleJSON = await res.json();
       } else {
         const styleFile = path.resolve(options.paths.styles, item.style);
-        // eslint-disable-next-line security/detect-non-literal-fs-filename -- styleFile constructed from config base path and style name
+
         const styleFileData = await fs.promises.readFile(styleFile);
         styleJSON = JSON.parse(styleFileData);
       }
-    } catch (e) {
+    } catch {
       console.log(`Error getting style file "${item.style}"`);
       return false;
     }
@@ -224,7 +222,6 @@ async function start(opts) {
         (styleSourceId, protocol) => {
           let dataItemId;
           for (const id of Object.keys(data)) {
-            // eslint-disable-next-line security/detect-object-injection -- id is from Object.keys of data config
             if (id === styleSourceId) {
               // Style id was found in data ids, return that id
               dataItemId = id;
@@ -301,10 +298,10 @@ async function start(opts) {
                 let currentInputFileValue;
 
                 // Check for recognized file type keys
-                if (sourceData.hasOwnProperty('pmtiles')) {
+                if (Object.hasOwn(sourceData, 'pmtiles')) {
                   currentFileType = 'pmtiles';
                   currentInputFileValue = sourceData.pmtiles;
-                } else if (sourceData.hasOwnProperty('mbtiles')) {
+                } else if (Object.hasOwn(sourceData, 'mbtiles')) {
                   currentFileType = 'mbtiles';
                   currentInputFileValue = sourceData.mbtiles;
                 }
@@ -319,24 +316,24 @@ async function start(opts) {
                     resolvedInputFile = currentInputFileValue;
 
                     // Get sparse if present
-                    if (sourceData.hasOwnProperty('sparse')) {
+                    if (Object.hasOwn(sourceData, 'sparse')) {
                       resolvedSparse = !!sourceData.sparse;
                     } else {
                       resolvedSparse = false;
                     }
 
                     // Get s3Profile if present
-                    if (sourceData.hasOwnProperty('s3Profile')) {
+                    if (Object.hasOwn(sourceData, 's3Profile')) {
                       resolvedS3Profile = sourceData.s3Profile;
                     }
 
                     // Get requestPayer if present
-                    if (sourceData.hasOwnProperty('requestPayer')) {
+                    if (Object.hasOwn(sourceData, 'requestPayer')) {
                       resolvedRequestPayer = !!sourceData.requestPayer;
                     }
 
                     // Get s3Region if present
-                    if (sourceData.hasOwnProperty('s3Region')) {
+                    if (Object.hasOwn(sourceData, 's3Region')) {
                       resolvedS3Region = sourceData.s3Region;
                     }
 
@@ -427,7 +424,6 @@ async function start(opts) {
     startupPromises.push(serve_data.add(options, serving.data, item, id, opts));
   }
   if (options.serveAllStyles) {
-    // eslint-disable-next-line security/detect-non-literal-fs-filename -- options.paths.styles is from validated config
     fs.readdir(options.paths.styles, { withFileTypes: true }, (err, files) => {
       if (err) {
         return;
@@ -599,7 +595,6 @@ async function start(opts) {
       }
     }
     try {
-      // eslint-disable-next-line security/detect-non-literal-fs-filename -- templateFile is from internal templates or config-specified path
       const content = fs.readFileSync(templateFile, 'utf-8');
       const compiled = handlebars.compile(content.toString());
       app.get(urlPath, (req, res, next) => {
@@ -793,7 +788,7 @@ async function start(opts) {
       return null;
     }
 
-    if (wmts.hasOwnProperty('serve_rendered') && !wmts.serve_rendered) {
+    if (Object.hasOwn(wmts, 'serve_rendered') && !wmts.serve_rendered) {
       return null;
     }
 

package/src/utils.js

@@ -40,7 +40,6 @@ export function allowedScales(scale, maxScale = 9) {
     return 1;
   }
 
-  // eslint-disable-next-line security/detect-non-literal-regexp -- maxScale is a number parameter, not user input
   const regex = new RegExp(`^[2-${maxScale}]x$`);
   if (!regex.test(scale)) {
     return null;
@@ -161,8 +160,7 @@ export function getTileUrls(
     const hostParts = urlObject.host.split('.');
     const relativeSubdomainsUsable =
       hostParts.length > 1 &&
-      // eslint-disable-next-line security/detect-unsafe-regex -- Simple IPv4 validation, no nested quantifiers
-      !/^([0-9]{1,3}\.){3}[0-9]{1,3}(\:[0-9]+)?$/.test(urlObject.host);
+      !/^([0-9]{1,3}\.){3}[0-9]{1,3}(:[0-9]+)?$/.test(urlObject.host);
     const newDomains = [];
     for (const domain of domains) {
       if (domain.indexOf('*') !== -1) {
@@ -253,7 +251,7 @@ export function fixTileJSONCenter(tileJSON) {
 export function readFile(filename) {
   return new Promise((resolve, reject) => {
     const sanitizedFilename = path.normalize(filename); // Normalize path, remove ..
-    // eslint-disable-next-line security/detect-non-literal-fs-filename -- filename is normalized and validated by caller
+
     fs.readFile(String(sanitizedFilename), (err, data) => {
       if (err) {
         reject(err);
@@ -276,7 +274,7 @@ export function readFile(filename) {
 async function getFontPbf(allowedFonts, fontPath, name, range, fallbacks) {
   // eslint-disable-next-line security/detect-object-injection -- name is validated font name from sanitizedName check
   if (!allowedFonts || (allowedFonts[name] && fallbacks)) {
-    const fontMatch = name?.match(/^[\p{L}\p{N} \-\.~!*'()@&=+,#$\[\]]+$/u);
+    const fontMatch = name?.match(/^[\p{L}\p{N} \-.~!*'()@&=+,#$[\]]+$/u);
     const sanitizedName = fontMatch?.[0] || 'invalid';
     if (!name || typeof name !== 'string' || name.trim() === '' || !fontMatch) {
       console.error(
@@ -390,16 +388,13 @@ export async function getFontsPbf(
 export async function listFonts(fontPath) {
   const existingFonts = {};
 
-  // eslint-disable-next-line security/detect-non-literal-fs-filename -- fontPath is from validated config
   const files = await fsPromises.readdir(fontPath);
   for (const file of files) {
-    // eslint-disable-next-line security/detect-non-literal-fs-filename -- file is from readdir of validated fontPath
     const stats = await fsPromises.stat(path.join(fontPath, file));
     if (
       stats.isDirectory() &&
       (await existsP(path.join(fontPath, file, '0-255.pbf')))
     ) {
-      // eslint-disable-next-line security/detect-object-injection -- file is from readdir, used as font name key
       existingFonts[path.basename(file)] = true;
     }
   }
@@ -415,7 +410,7 @@ export async function listFonts(fontPath) {
 export function isValidHttpUrl(string) {
   try {
     return httpTester.test(string);
-  } catch (e) {
+  } catch {
     return false;
   }
 }
@@ -428,7 +423,7 @@ export function isValidHttpUrl(string) {
 export function isS3Url(string) {
   try {
     return s3Tester.test(string) || s3HttpTester.test(string);
-  } catch (e) {
+  } catch {
     return false;
   }
 }
@@ -445,7 +440,7 @@ export function isValidRemoteUrl(string) {
       s3Tester.test(string) ||
       s3HttpTester.test(string)
     );
-  } catch (e) {
+  } catch {
     return false;
   }
 }
@@ -458,7 +453,7 @@ export function isValidRemoteUrl(string) {
 export function isPMTilesProtocol(string) {
   try {
     return pmtilesTester.test(string);
-  } catch (e) {
+  } catch {
     return false;
   }
 }
@@ -471,7 +466,7 @@ export function isPMTilesProtocol(string) {
 export function isMBTilesProtocol(string) {
   try {
     return mbtilesTester.test(string);
-  } catch (e) {
+  } catch {
     return false;
   }
 }
@@ -487,15 +482,19 @@ export function isMBTilesProtocol(string) {
  */
 export async function fetchTileData(source, sourceType, z, x, y) {
   if (sourceType === 'pmtiles') {
-    return await new Promise(async (resolve) => {
+    try {
       const tileinfo = await getPMtilesTile(source, z, x, y);
-      if (!tileinfo?.data) return resolve(null);
-      resolve({ data: tileinfo.data, headers: tileinfo.header });
-    });
+      if (!tileinfo?.data) return null;
+      return { data: tileinfo.data, headers: tileinfo.header };
+    } catch (error) {
+      console.error('Error fetching PMTiles tile:', error);
+      return null;
+    }
   } else if (sourceType === 'mbtiles') {
-    return await new Promise((resolve) => {
+    return new Promise((resolve) => {
       source.getTile(z, x, y, (err, tileData, tileHeader) => {
         if (err) {
+          console.error('Error fetching MBTiles tile:', err);
           return resolve(null);
         }
         resolve({ data: tileData, headers: tileHeader });

package/test/static_images.js

@@ -0,0 +1,241 @@
+// test/static_images.js
+import { describe, it } from 'mocha';
+import { expect } from 'chai';
+import supertest from 'supertest';
+import fs from 'fs';
+import path from 'path';
+import sharp from 'sharp';
+import pixelmatch from 'pixelmatch';
+import { fileURLToPath } from 'url';
+
+const __dirname = path.dirname(fileURLToPath(import.meta.url));
+
+const FIXTURES_DIR = path.join(__dirname, 'fixtures', 'visual');
+const THRESHOLD = 0.1;
+const MAX_DIFF_PIXELS = 100;
+
+// Check for the environment variable to conditionally generate fixtures
+const shouldGenerateFixtures = process.env.GENERATE_FIXTURES === 'true';
+
+// --- Test Definitions ---
+const tests = [
+  {
+    name: 'static-lat-lng',
+    // Test default center format (lng,lat,zoom)
+    url: '/styles/test-style/static/8.5375,47.379,12/400x300.png',
+  },
+  {
+    name: 'static-bearing',
+    // Test map bearing (rotation) at 180 degrees
+    url: '/styles/test-style/static/8.5375,47.379,12@180/400x300.png',
+  },
+  {
+    name: 'static-bearing-pitch',
+    // Test map bearing and pitch (3D tilt)
+    url: '/styles/test-style/static/8.5375,47.379,12@15,80/400x300.png',
+  },
+  {
+    name: 'static-pixel-ratio-2x',
+    // Test high-DPI rendering using @2x scale
+    url: '/styles/test-style/static/8.5375,47.379,11/200x150@2x.png',
+  },
+  {
+    name: 'path-auto',
+    // Test path rendering with simple coordinates and auto-centering
+    url: '/styles/test-style/static/auto/400x300.png?fill=%23ff000080&path=8.53180,47.38713|8.53841,47.38248|8.53320,47.37457',
+  },
+  {
+    name: 'encoded-path-auto',
+    // Test path rendering using encoded polyline and auto-centering
+    url: '/styles/test-style/static/auto/400x300.png?stroke=red&width=5&path=enc:wwg`Hyu}r@fNgn@hKyh@rR{ZlP{YrJmM`PJhNbH`P`VjUbNfJ|LzM~TtLnKxQZ',
+  },
+  {
+    name: 'linecap-linejoin-round-round',
+    // Test custom line styling: round linejoin and round linecap
+    url: '/styles/test-style/static/8.5375,47.379,12/400x300.png?width=30&linejoin=round&linecap=round&path=enc:uhd`Hqk_s@kiA}nAnfAqpA',
+  },
+  {
+    name: 'linecap-linejoin-bevel-square',
+    // Test custom line styling: bevel linejoin and square linecap
+    url: '/styles/test-style/static/8.5375,47.379,12/400x300.png?width=30&linejoin=bevel&linecap=square&path=enc:uhd`Hqk_s@kiA}nAnfAqpA',
+  },
+  {
+    name: 'static-markers',
+    // Test multiple markers with scale and offset options
+    url: '/styles/test-style/static/8.5375,47.379,12/400x300.png?marker=8.531,47.38|marker-icon.png|scale:0.8&marker=8.545,47.375|marker-icon-2x.png|offset:5,-10',
+  },
+  {
+    name: 'static-bbox',
+    // Test area-based map rendering using a bounding box (bbox)
+    url: '/styles/test-style/static/8.5,47.35,8.6,47.4/400x300.png',
+  },
+  {
+    name: 'static-multiple-paths',
+    // Test rendering of multiple, individually styled path parameters
+    url: '/styles/test-style/static/8.5375,47.379,12/400x300.png?path=stroke:blue|width:8|fill:none|8.53,47.38|8.54,47.385&path=stroke:red|width:3|fill:yellow|8.53,47.37|8.54,47.375',
+  },
+  {
+    name: 'static-path-latlng',
+    // Test path rendering when the 'latlng' parameter reverses coordinate order
+    url: '/styles/test-style/static/auto/400x300.png?latlng=true&path=47.38,8.53|47.385,8.54&fill=rgba(0,0,255,0.5)',
+  },
+  {
+    name: 'static-path-border-stroke',
+    // Test path border/halo functionality (line stroke with border halo)
+    url: '/styles/test-style/static/8.5375,47.379,12/400x300.png?path=stroke:yellow|width:10|border:black|borderwidth:2|8.53,47.37|8.54,47.38|8.53,47.39',
+  },
+  {
+    name: 'static-path-border-isolated',
+    // Test path border/halo in isolation (only border, no stroke)
+    url: '/styles/test-style/static/8.5375,47.379,12/400x300.png?path=border:black|borderwidth:10|8.53,47.37|8.54,47.38|8.53,47.39',
+  },
+  {
+    name: 'static-border-global',
+    // Test border functionality using global query parameters (less common, but valid)
+    url: '/styles/test-style/static/8.5375,47.379,12/400x300.png?stroke=yellow&width=10&border=black&borderwidth=2&path=8.53,47.37|8.54,47.38|8.53,47.39',
+  },
+];
+
+/**
+ * Loads an image buffer and extracts its raw pixel data.
+ * @param {Buffer} buffer The raw image data buffer (e.g., from an HTTP response).
+ * @returns {Promise<{data: Buffer, width: number, height: number}>} An object containing the raw RGBA pixel data, width, and height.
+ */
+async function loadImageData(buffer) {
+  const image = sharp(buffer);
+  const { width, height } = await image.metadata();
+
+  // Get raw RGBA pixel data
+  const data = await image.ensureAlpha().raw().toBuffer();
+
+  return { data, width, height };
+}
+
+/**
+ * Fetches an image from the test server URL.
+ * @param {string} url The URL of the static image endpoint to fetch.
+ * @returns {Promise<Buffer>} A promise that resolves with the image buffer.
+ */
+async function fetchImage(url) {
+  return new Promise((resolve, reject) => {
+    supertest(global.app)
+      .get(url)
+      .expect(200)
+      .expect('Content-Type', /image\/png/)
+      .end((err, res) => {
+        if (err) {
+          reject(err);
+        } else {
+          resolve(res.body);
+        }
+      });
+  });
+}
+
+/**
+ * Compares two images (actual result vs. expected fixture) and counts the differing pixels.
+ * @param {Buffer} actualBuffer The buffer of the image rendered by the server.
+ * @param {string} expectedPath The file path to the expected fixture image.
+ * @returns {Promise<{numDiffPixels: number, diffBuffer: Buffer, width: number, height: number}>} Comparison results.
+ */
+async function compareImages(actualBuffer, expectedPath) {
+  const actual = await loadImageData(actualBuffer);
+  const expectedBuffer = fs.readFileSync(expectedPath);
+  const expected = await loadImageData(expectedBuffer);
+
+  if (actual.width !== expected.width || actual.height !== expected.height) {
+    throw new Error(
+      `Image dimensions don't match: ${actual.width}x${actual.height} vs ${expected.width}x${expected.height}`,
+    );
+  }
+
+  const diffBuffer = Buffer.alloc(actual.width * actual.height * 4);
+  const numDiffPixels = pixelmatch(
+    actual.data,
+    expected.data,
+    diffBuffer,
+    actual.width,
+    actual.height,
+    { threshold: THRESHOLD },
+  );
+
+  return {
+    numDiffPixels,
+    diffBuffer,
+    width: actual.width,
+    height: actual.height,
+  };
+}
+
+// Conditional definition: Only define this suite if the GENERATE_FIXTURES environment variable is true
+if (shouldGenerateFixtures) {
+  describe('GENERATE Visual Fixtures', function () {
+    this.timeout(10000);
+
+    it('should generate all fixture images', async function () {
+      fs.mkdirSync(FIXTURES_DIR, { recursive: true });
+      console.log(`\nGenerating fixtures to ${FIXTURES_DIR}\n`);
+
+      for (const { name, url } of tests) {
+        try {
+          const actualBuffer = await fetchImage(url);
+          const fixturePath = path.join(FIXTURES_DIR, `${name}.png`);
+          fs.writeFileSync(fixturePath, actualBuffer);
+          console.log(
+            `✓ Generated: ${name}.png (${actualBuffer.length} bytes)`,
+          );
+        } catch (error) {
+          console.error(`❌ Failed to generate ${name}:`, error.message);
+          throw error;
+        }
+      }
+
+      console.log(
+        `\n✓ Successfully generated ${tests.length} fixture images!\n`,
+      );
+    });
+  });
+}
+
+describe('Static Image Visual Regression Tests', function () {
+  this.timeout(10000);
+
+  tests.forEach(({ name, url }) => {
+    it(`should match expected output: ${name}`, async function () {
+      const expectedPath = path.join(FIXTURES_DIR, `${name}.png`);
+
+      if (!fs.existsSync(expectedPath)) {
+        this.skip();
+        return;
+      }
+
+      const actualBuffer = await fetchImage(url);
+      const { numDiffPixels, diffBuffer, width, height } = await compareImages(
+        actualBuffer,
+        expectedPath,
+      );
+
+      if (numDiffPixels > MAX_DIFF_PIXELS) {
+        const diffPath = path.join(FIXTURES_DIR, 'diffs', `${name}-diff.png`);
+        fs.mkdirSync(path.dirname(diffPath), { recursive: true });
+
+        await sharp(diffBuffer, {
+          raw: {
+            width,
+            height,
+            channels: 4,
+          },
+        })
+          .png()
+          .toFile(diffPath);
+
+        console.log(`Diff image saved to: ${diffPath}`);
+      }
+
+      expect(numDiffPixels).to.be.at.most(
+        MAX_DIFF_PIXELS,
+        `Expected at most ${MAX_DIFF_PIXELS} different pixels, but got ${numDiffPixels}`,
+      );
+    });
+  });
+});