Migrating to express 5 (#6690)

* pMigrating to express 5

* Fixed export.

* chore: bumped deps

* chore: added express

* chore: added express

* chore: fixed admin ui

Author: SamTV12345

CHANGELOG.md

@@ -1,3 +1,8 @@
+# 2.5.0
+
+### Notable enhancements and fixes
+- Updated to express 5.0.0. This is a major update to express that brings a lot of improvements and fixes.
+
 # 2.4.2
 
 ### Notable enhancements and fixes

pnpm-lock.yaml

@@ -96,12 +96,6 @@
         "socketio": "ep_etherpad-lite/node/handler/PadMessageHandler"
       }
     },
-    {
-      "name": "tests",
-      "hooks": {
-        "expressPreSession": "ep_etherpad-lite/node/hooks/express/tests"
-      }
-    },
     {
       "name": "admin",
       "hooks": {

src/ep.json

@@ -22,7 +22,7 @@ exports.expressCreateServer = (hookName: string, args: ArgsExpressType, cb: Func
     console.error('admin template not found, skipping admin interface. You need to rebuild it in /admin with pnpm run build-copy')
     return cb();
   }
-  args.app.get('/admin/*', (req: any, res: any) => {
+  args.app.get('/admin/{*filename}', (req: any, res: any) => {
     // extract URL path
     let pathname = path.join(ADMIN_PATH, req.url);
     pathname = path.normalize(pathname)

src/node/hooks/express/admin.ts

@@ -25,8 +25,8 @@ exports.expressCreateServer = (hookName:string, args:ArgsExpressType, cb:Functio
   });
 
   // handle export requests
-  args.app.use('/p/:pad/:rev?/export/:type', limiter);
-  args.app.get('/p/:pad/:rev?/export/:type', (req:any, res:any, next:Function) => {
+  args.app.use('/p/:pad{/:rev}/export/:type', limiter);
+  args.app.get('/p/:pad{/:rev}/export/:type', (req:any, res:any, next:Function) => {
     (async () => {
       const types = ['pdf', 'doc', 'txt', 'html', 'odt', 'etherpad'];
       // send a 404 if we don't support this filetype

src/node/hooks/express/importexport.ts

@@ -6,6 +6,7 @@ import {PartType} from "../../types/PartType";
 const fs = require('fs').promises;
 import {minify} from '../../utils/Minify';
 import path from 'node:path';
+import {ArgsExpressType} from "../../types/ArgsExpressType";
 const plugins = require('../../../static/js/pluginfw/plugin_defs');
 const settings = require('../../utils/Settings');
 
@@ -30,16 +31,16 @@ const getTar = async () => {
   return tar;
 };
 
-exports.expressPreSession = async (hookName:string, {app}:any) => {
+exports.expressPreSession = async (hookName:string, {app}:ArgsExpressType) => {
 
   // Minify will serve static files compressed (minify enabled). It also has
   // file-specific hacks for ace/require-kernel/etc.
-  app.all('/static/:filename(*)', minify);
+  app.all('/static/*filename', minify);
 
   // serve plugin definitions
   // not very static, but served here so that client can do
   // require("pluginfw/static/js/plugin-definitions.js");
-  app.get('/pluginfw/plugin-definitions.json', (req: any, res:any, next:Function) => {
+  app.get('/pluginfw/plugin-definitions.json', (_req, res) => {
     const clientParts = plugins.parts.filter((part: PartType) => part.client_hooks != null);
     const clientPlugins:MapArrayType<string> = {};
     for (const name of new Set(clientParts.map((part: PartType) => part.plugin))) {

src/node/hooks/express/static.ts

@@ -146,7 +146,7 @@ const compatPaths = {
  * @param res the Express response
  */
 const _minify = async (req:any, res:any) => {
-  let filename = req.params.filename;
+  let filename = req.params.filename.join('/');
   try {
     filename = sanitizePathname(filename);
   } catch (err) {

src/node/hooks/express/tests.ts

@@ -37,8 +37,8 @@
     "cross-spawn": "^7.0.6",
     "ejs": "^3.1.10",
     "esbuild": "^0.25.8",
-    "express": "4.21.2",
-    "express-rate-limit": "^8.0.0",
+    "express": "^5.1.0",
+    "express-rate-limit": "^8.0.1",
     "express-session": "^1.18.2",
     "fast-deep-equal": "^3.1.3",
     "find-root": "1.1.0",
@@ -85,8 +85,8 @@
   "devDependencies": {
     "@playwright/test": "^1.54.1",
     "@types/async": "^3.2.24",
+    "@types/express": "^5.0.0",
     "@types/cookie-parser": "^1.4.9",
-    "@types/express": "^4.17.21",
     "@types/express-session": "^1.18.2",
     "@types/formidable": "^3.4.5",
     "@types/http-errors": "^2.0.5",