first attempt to upgrade express to v5 #1429

acalcutt · 2024-12-29T06:34:59Z

Today I was researching how we could fix #1412 and get express upgraded.

The main issue is in newer versions of express the syntax for optional parameters and paths has changed due to their upgrade of https://github.com/pillarjs/path-to-regexp which no longer allows options items by surrounding them with ( and )? . It also doesn't seem to support checking the values/value types by putting the type inside ( and )

https://github.com/pillarjs/path-to-regexp?tab=readme-ov-file#errors

Unexpected ? or +
In past releases, ?, *, and + were used to denote optional or repeating parameters. As an alternative, try these:
For optional (?), use an empty segment in a group such as /:file{.:ext}.
For repeating (+), only wildcard matching is supported, such as /*path.
For optional repeating (*), use a group and a wildcard parameter such as /files{/*path}.
Unexpected (, ), [, ], etc.
Previous versions of Path-to-RegExp used these for RegExp features. This version no longer supports them so they've been reserved to avoid ambiguity. To use these characters literally, escape them with a backslash, e.g. "\\(".

Unfortunately we used a lot of these features to direct how tileserver replied to requests.... Things like optional paths for rile size or raw co-ordinates. or validating the data types before picking up the request.

I went through and I tried to remove all parenthesis that it did now like, but this caused a bit of trouble because now some of our paths are a bit to similar. to support the paths we have a had to do a few ugly workarounds to get around misrouting. They do allow {/:variable} for optional paths, so I was somewhat rework some things to use that.

This still needs a lot of work and if anyone has any suggestions (or would like open a new PR based on it and finish it) I can use all the help I can get with this.

Co-Authored-By: Andrew Calcutt <[email protected]>

src/serve_font.js

+      return res.send(concatenated);
+    } catch (err) {
+      console.error('Error serving font:', err);
+      return res.status(400).header('Content-Type', 'text/plain').send(err);


src/serve_rendered.js

src/serve_style.js

Co-Authored-By: Andrew Calcutt <[email protected]>

src/serve_style.js

Co-Authored-By: Andrew Calcutt <[email protected]>

src/serve_style.js

+ */
+function allowedSpriteScales(scale) {
+  if (!scale) return '';
+  const match = scale.match(/(\d+)x/); 


Co-Authored-By: Andrew Calcutt <[email protected]>

src/serve_rendered.js

-              y = ll[1];
-            }
+  const staticTypeMatch = staticType.match(staticTypeRegex);
+  console.log(staticTypeMatch);


src/serve_style.js

+      const spriteScale = allowedSpriteScales(scale);
+      const filename = `${sprite.path}${spriteScale}.${format}`;
+
+      fs.readFile(filename, (err, data) => {


src/serve_style.js

+
+      fs.readFile(filename, (err, data) => {
+        if (err) {
+          console.error('Sprite load error: %s, Error: %s', filename, err);


src/utils.js

    if (!allowedFonts || (allowedFonts[name] && fallbacks)) {
+      if (!name || typeof name !== 'string' || name.trim() === '') {
+        console.error('ERROR: Invalid font name: %s', name);


src/utils.js

+        return reject('Invalid font name');
+      }
+      if (!/^\d+-\d+$/.test(range)) {
+        console.error('ERROR: Invalid range: %s', range);


src/utils.js

      fs.readFile(filename, (err, data) => {
        if (err) {
-          console.error(`ERROR: Font not found: ${name}`);
+          console.error('ERROR: Font not found: %s, Error: %s', filename, err);


Co-Authored-By: Andrew Calcutt <[email protected]>

src/serve_style.js

+    app.get(`/:id/sprite{/:spriteID}{@:scale}{.:format}`, (req, res, next) => {
+      const { spriteID = 'default', id, format } = req.params;
+      const spriteScale = allowedSpriteScales(req.params.scale);
+
+      const item = repo[id];
+      if (!item || !allowedSpriteFormats(format)) {
+        return res.sendStatus(404);
+      }
+
+      const sprite = item.spritePaths.find((sprite) => sprite.id === spriteID);
+      if (!sprite) {
+        return res.status(400).send('Bad Sprite ID or Scale');
+      }
+
+      const filename = `${sprite.path}${spriteScale}.${format}`;
+
+      // eslint-disable-next-line security/detect-non-literal-fs-filename
+      fs.readFile(filename, (err, data) => {
+        if (err) {
+          console.error('Sprite load error: %s, Error: %s', filename, err);
+          return res.sendStatus(404);
        }
-      },
-    );
+
+        if (format === 'json') {
+          res.header('Content-type', 'application/json');
+        } else if (format === 'png') {
+          res.header('Content-type', 'image/png');
+        }
+        return res.send(data);
+      });
+    });


Co-Authored-By: Andrew Calcutt <[email protected]>

src/serve_rendered.js

+              if (format === 'pbf') {
+                if (isGzipped) {
+                  response.data = await gunzipP(response.data);
+                  isGzipped = false;


Co-Authored-By: Andrew Calcutt <[email protected]>

first attempt to upgrade express to v5

8dd927e

Co-Authored-By: Andrew Calcutt <[email protected]>

github-advanced-security bot found potential problems Dec 29, 2024

View reviewed changes

acalcutt added 6 commits December 29, 2024 01:56

try to fix maptiler#1411

b72f662

Co-Authored-By: Andrew Calcutt <[email protected]>

cleanup server.js

c7377e8

Co-Authored-By: Andrew Calcutt <[email protected]>

cleanup serve_font.js

2e74bc7

Co-Authored-By: Andrew Calcutt <[email protected]>

cleanup sever_rendered.js

61e81e0

Co-Authored-By: Andrew Calcutt <[email protected]>

cleanup server_data.js

a0fb368

Co-Authored-By: Andrew Calcutt <[email protected]>

cleanup serve_style

b638208

Co-Authored-By: Andrew Calcutt <[email protected]>

github-advanced-security bot found potential problems Dec 29, 2024

View reviewed changes

src/serve_style.js Fixed Show fixed Hide fixed

src/serve_style.js Fixed Show fixed Hide fixed

Update serve_style.js

d635d3c

Co-Authored-By: Andrew Calcutt <[email protected]>

github-advanced-security bot found potential problems Dec 29, 2024

View reviewed changes

acalcutt added 5 commits December 29, 2024 11:39

Move UV_THREADPOOL_SIZE to main thred

c72d6f5

Co-Authored-By: Andrew Calcutt <[email protected]>

cleanup utils.js

70d6986

Co-Authored-By: Andrew Calcutt <[email protected]>

Use common app.get for images and static images

e1460fb

Co-Authored-By: Andrew Calcutt <[email protected]>

add allowedTileSizes and option

8dc3809

Co-Authored-By: Andrew Calcutt <[email protected]>

cleanup error responses

ab20e81

Co-Authored-By: Andrew Calcutt <[email protected]>

github-advanced-security bot found potential problems Dec 30, 2024

View reviewed changes

acalcutt added 3 commits December 30, 2024 00:22

fix /style/id.json with next('route')

9f3a7ce

Co-Authored-By: Andrew Calcutt <[email protected]>

improve sprite path

1f0ee0d

Co-Authored-By: Andrew Calcutt <[email protected]>

add parseFloadts around zxy

d255cdc

Co-Authored-By: Andrew Calcutt <[email protected]>

github-advanced-security bot found potential problems Dec 30, 2024

View reviewed changes

acalcutt added 2 commits December 30, 2024 02:39

simplify server_data

c4adfa8

Co-Authored-By: Andrew Calcutt <[email protected]>

move tile fetch and add fix verbose logging

3aaab82

Co-Authored-By: Andrew Calcutt <[email protected]>

github-advanced-security bot found potential problems Dec 30, 2024

View reviewed changes

src/serve_rendered.js

if (format === 'pbf') {

if (isGzipped) {

response.data = await gunzipP(response.data);

isGzipped = false;

Check warning

Code scanning / CodeQL

Useless assignment to local variable Warning

The value assigned to isGzipped here is unused.

add Handling request to verbose logging

848f7c5

Co-Authored-By: Andrew Calcutt <[email protected]>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

first attempt to upgrade express to v5 #1429

first attempt to upgrade express to v5 #1429

acalcutt commented Dec 29, 2024 •

edited

Loading

first attempt to upgrade express to v5 #1429

Are you sure you want to change the base?

first attempt to upgrade express to v5 #1429

Conversation

acalcutt commented Dec 29, 2024 • edited Loading

acalcutt commented Dec 29, 2024 •

edited

Loading