From e52cfc91700e57c2dd4835ed9dd286268eab59fb Mon Sep 17 00:00:00 2001 From: Trim21 Date: Tue, 12 Dec 2023 03:08:43 +0800 Subject: [PATCH] refactor(server): migrate to fastify (#707) --- package-lock.json | 233 +++++++++++++++++++++++++++++-- package.json | 3 +- server/middleware/eventStream.ts | 1 - server/models/ServerEvent.ts | 1 - server/routes/index.ts | 31 ++-- 5 files changed, 235 insertions(+), 34 deletions(-) diff --git a/package-lock.json b/package-lock.json index d9aad535..623b492a 100644 --- a/package-lock.json +++ b/package-lock.json @@ -32,6 +32,7 @@ "@emotion/babel-plugin": "^11.11.0", "@emotion/css": "^11.11.0", "@emotion/react": "^11.11.1", + "@fastify/compress": "^6.5.0", "@fastify/express": "^2.3.0", "@fastify/static": "^6.10.2", "@lingui/loader": "^3.17.2", @@ -40,7 +41,6 @@ "@seald-io/nedb": "^3.1.0", "@types/bencode": "^2.0.1", "@types/body-parser": "^1.19.2", - "@types/compression": "^1.7.2", "@types/content-disposition": "^0.5.5", "@types/cookie-parser": "^1.4.3", "@types/create-torrent": "^5.0.0", @@ -77,7 +77,6 @@ "case-sensitive-paths-webpack-plugin": "2.4.0", "chalk": "^4.1.2", "classnames": "^2.3.2", - "compression": "^1.7.4", "content-disposition": "^0.5.4", "cookie-parser": "^1.4.6", "create-torrent": "^5.0.9", @@ -3047,6 +3046,22 @@ "integrity": "sha512-NM8/P9n3XjXhIZn1lLhkFaACTOURQXjWhV4BA/RnOv8xvgqtqpAX9IO4mRQxSx1Rlo4tqzeqb0sOlruaOy3dug==", "dev": true }, + "node_modules/@fastify/compress": { + "version": "6.5.0", + "resolved": "https://registry.npmjs.org/@fastify/compress/-/compress-6.5.0.tgz", + "integrity": "sha512-AqUOK714jY7qkzbQbS4zyI4yNFgnRoOJ3eH/oV1T9f5fFdPDRdrFxm5de1ya5n+as4bvitjwU9EY7zvtT9pI2A==", + "dev": true, + "dependencies": { + "@fastify/accept-negotiator": "^1.1.0", + "fastify-plugin": "^4.5.0", + "into-stream": "^6.0.0", + "mime-db": "^1.52.0", + "minipass": "^7.0.2", + "peek-stream": "^1.1.3", + "pump": "^3.0.0", + "pumpify": "^2.0.1" + } + }, "node_modules/@fastify/deepmerge": { "version": "1.3.0", "resolved": "https://registry.npmjs.org/@fastify/deepmerge/-/deepmerge-1.3.0.tgz", @@ -4219,15 +4234,6 @@ "@types/node": "*" } }, - "node_modules/@types/compression": { - "version": "1.7.2", - "resolved": "https://registry.npmjs.org/@types/compression/-/compression-1.7.2.tgz", - "integrity": "sha512-lwEL4M/uAGWngWFLSG87ZDr2kLrbuR8p7X+QZB1OQlT+qkHsCPDVFnHPyXf4Vyl4yDDorNY+mAhosxkCvppatg==", - "dev": true, - "dependencies": { - "@types/express": "*" - } - }, "node_modules/@types/connect": { "version": "3.4.35", "resolved": "https://registry.npmjs.org/@types/connect/-/connect-3.4.35.tgz", @@ -8037,6 +8043,48 @@ "integrity": "sha512-jtD6YG370ZCIi/9GTaJKQxWTZD045+4R4hTk/x1UyoqadyJ9x9CgSi1RlVDQF8U2sxLLSnFkCaMihqljHIWgMg==", "dev": true }, + "node_modules/duplexify": { + "version": "3.7.1", + "resolved": "https://registry.npmjs.org/duplexify/-/duplexify-3.7.1.tgz", + "integrity": "sha512-07z8uv2wMyS51kKhD1KsdXJg5WQ6t93RneqRxUHnskXVtlYYkLqM0gqStQZ3pj073g687jPCHrqNfCzawLYh5g==", + "dev": true, + "dependencies": { + "end-of-stream": "^1.0.0", + "inherits": "^2.0.1", + "readable-stream": "^2.0.0", + "stream-shift": "^1.0.0" + } + }, + "node_modules/duplexify/node_modules/isarray": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/isarray/-/isarray-1.0.0.tgz", + "integrity": "sha512-VLghIWNM6ELQzo7zwmcg0NmTVyWKYjvIeM83yjp0wRDTmUnrM678fQbcKBo6n2CJEF0szoG//ytg+TKla89ALQ==", + "dev": true + }, + "node_modules/duplexify/node_modules/readable-stream": { + "version": "2.3.8", + "resolved": "https://registry.npmjs.org/readable-stream/-/readable-stream-2.3.8.tgz", + "integrity": "sha512-8p0AUk4XODgIewSi0l8Epjs+EVnWiK7NoDIEGU0HhE7+ZyY8D1IMY7odu5lRrFXGg71L15KG8QrPmum45RTtdA==", + "dev": true, + "dependencies": { + "core-util-is": "~1.0.0", + "inherits": "~2.0.3", + "isarray": "~1.0.0", + "process-nextick-args": "~2.0.0", + "safe-buffer": "~5.1.1", + "string_decoder": "~1.1.1", + "util-deprecate": "~1.0.1" + } + }, + "node_modules/duplexify/node_modules/string_decoder": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/string_decoder/-/string_decoder-1.1.1.tgz", + "integrity": "sha512-n/ShnvDi6FHbbVfviro+WojiFzv+s8MPMHBczVePfUpDJLwoLT0ht1l4YwBCbi8pJAveEEdnkHyPyTP/mzRfwg==", + "dev": true, + "dependencies": { + "safe-buffer": "~5.1.0" + } + }, "node_modules/ecdsa-sig-formatter": { "version": "1.0.11", "resolved": "https://registry.npmjs.org/ecdsa-sig-formatter/-/ecdsa-sig-formatter-1.0.11.tgz", @@ -10374,6 +10422,46 @@ "node": ">= 0.6" } }, + "node_modules/from2": { + "version": "2.3.0", + "resolved": "https://registry.npmjs.org/from2/-/from2-2.3.0.tgz", + "integrity": "sha512-OMcX/4IC/uqEPVgGeyfN22LJk6AZrMkRZHxcHBMBvHScDGgwTm2GT2Wkgtocyd3JfZffjj2kYUDXXII0Fk9W0g==", + "dev": true, + "dependencies": { + "inherits": "^2.0.1", + "readable-stream": "^2.0.0" + } + }, + "node_modules/from2/node_modules/isarray": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/isarray/-/isarray-1.0.0.tgz", + "integrity": "sha512-VLghIWNM6ELQzo7zwmcg0NmTVyWKYjvIeM83yjp0wRDTmUnrM678fQbcKBo6n2CJEF0szoG//ytg+TKla89ALQ==", + "dev": true + }, + "node_modules/from2/node_modules/readable-stream": { + "version": "2.3.8", + "resolved": "https://registry.npmjs.org/readable-stream/-/readable-stream-2.3.8.tgz", + "integrity": "sha512-8p0AUk4XODgIewSi0l8Epjs+EVnWiK7NoDIEGU0HhE7+ZyY8D1IMY7odu5lRrFXGg71L15KG8QrPmum45RTtdA==", + "dev": true, + "dependencies": { + "core-util-is": "~1.0.0", + "inherits": "~2.0.3", + "isarray": "~1.0.0", + "process-nextick-args": "~2.0.0", + "safe-buffer": "~5.1.1", + "string_decoder": "~1.1.1", + "util-deprecate": "~1.0.1" + } + }, + "node_modules/from2/node_modules/string_decoder": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/string_decoder/-/string_decoder-1.1.1.tgz", + "integrity": "sha512-n/ShnvDi6FHbbVfviro+WojiFzv+s8MPMHBczVePfUpDJLwoLT0ht1l4YwBCbi8pJAveEEdnkHyPyTP/mzRfwg==", + "dev": true, + "dependencies": { + "safe-buffer": "~5.1.0" + } + }, "node_modules/front-matter": { "version": "4.0.2", "resolved": "https://registry.npmjs.org/front-matter/-/front-matter-4.0.2.tgz", @@ -11378,6 +11466,22 @@ "node": ">= 0.10" } }, + "node_modules/into-stream": { + "version": "6.0.0", + "resolved": "https://registry.npmjs.org/into-stream/-/into-stream-6.0.0.tgz", + "integrity": "sha512-XHbaOAvP+uFKUFsOgoNPRjLkwB+I22JFPFe5OjTkQ0nwgj6+pSjb4NmB6VMxaPshLiOf+zcpOCBQuLwC1KHhZA==", + "dev": true, + "dependencies": { + "from2": "^2.3.0", + "p-is-promise": "^3.0.0" + }, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, "node_modules/ip-address": { "version": "6.4.0", "resolved": "https://registry.npmjs.org/ip-address/-/ip-address-6.4.0.tgz", @@ -13727,6 +13831,15 @@ "url": "https://github.com/sponsors/ljharb" } }, + "node_modules/minipass": { + "version": "7.0.4", + "resolved": "https://registry.npmjs.org/minipass/-/minipass-7.0.4.tgz", + "integrity": "sha512-jYofLM5Dam9279rdkWzqHozUo4ybjdZmCsDHePy5V/PbBcVMiSZR97gmAy45aqi8CK1lG2ECd356FU86avfwUQ==", + "dev": true, + "engines": { + "node": ">=16 || 14 >=14.17" + } + }, "node_modules/mkdirp": { "version": "1.0.4", "resolved": "https://registry.npmjs.org/mkdirp/-/mkdirp-1.0.4.tgz", @@ -14305,6 +14418,15 @@ "react": ">=16.8.0" } }, + "node_modules/p-is-promise": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/p-is-promise/-/p-is-promise-3.0.0.tgz", + "integrity": "sha512-Wo8VsW4IRQSKVXsJCn7TomUaVtyfjVDn3nUP7kE967BQk0CwFpdbZs0X0uk5sW9mkBa9eNM7hCMaG93WUAwxYQ==", + "dev": true, + "engines": { + "node": ">=8" + } + }, "node_modules/p-limit": { "version": "3.1.0", "resolved": "https://registry.npmjs.org/p-limit/-/p-limit-3.1.0.tgz", @@ -14573,6 +14695,17 @@ "integrity": "sha512-KG8UEiEVkR3wGEb4m5yZkVCzigAD+cVEJck2CzYZO37ZGJfctvVptVO192MwrtPhzONn6go8ylnOdMhKqi4nfg==", "dev": true }, + "node_modules/peek-stream": { + "version": "1.1.3", + "resolved": "https://registry.npmjs.org/peek-stream/-/peek-stream-1.1.3.tgz", + "integrity": "sha512-FhJ+YbOSBb9/rIl2ZeE/QHEsWn7PqNYt8ARAY3kIgNGOk13g9FGyIY6JIl/xB/3TFRVoTv5as0l11weORrTekA==", + "dev": true, + "dependencies": { + "buffer-from": "^1.0.0", + "duplexify": "^3.5.0", + "through2": "^2.0.3" + } + }, "node_modules/pend": { "version": "1.2.0", "resolved": "https://registry.npmjs.org/pend/-/pend-1.2.0.tgz", @@ -15570,6 +15703,29 @@ "once": "^1.3.1" } }, + "node_modules/pumpify": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/pumpify/-/pumpify-2.0.1.tgz", + "integrity": "sha512-m7KOje7jZxrmutanlkS1daj1dS6z6BgslzOXmcSEpIlCxM3VJH7lG5QLeck/6hgF6F4crFf01UtQmNsJfweTAw==", + "dev": true, + "dependencies": { + "duplexify": "^4.1.1", + "inherits": "^2.0.3", + "pump": "^3.0.0" + } + }, + "node_modules/pumpify/node_modules/duplexify": { + "version": "4.1.2", + "resolved": "https://registry.npmjs.org/duplexify/-/duplexify-4.1.2.tgz", + "integrity": "sha512-fz3OjcNCHmRP12MJoZMPglx8m4rrFP8rovnk4vT8Fs+aonZoCwGg10dSsQsfP/E62eZcPTMSMP6686fu9Qlqtw==", + "dev": true, + "dependencies": { + "end-of-stream": "^1.4.1", + "inherits": "^2.0.3", + "readable-stream": "^3.1.1", + "stream-shift": "^1.0.0" + } + }, "node_modules/punycode": { "version": "2.3.0", "resolved": "https://registry.npmjs.org/punycode/-/punycode-2.3.0.tgz", @@ -16989,6 +17145,12 @@ "node": ">= 0.4" } }, + "node_modules/stream-shift": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/stream-shift/-/stream-shift-1.0.1.tgz", + "integrity": "sha512-AiisoFqQ0vbGcZgQPY1cdP2I76glaVA/RauYR4G4thNFgkTqr90yXTo4LYX60Jl+sIlPNHHdGSwo01AvbKUSVQ==", + "dev": true + }, "node_modules/string_decoder": { "version": "1.3.0", "resolved": "https://registry.npmjs.org/string_decoder/-/string_decoder-1.3.0.tgz", @@ -17559,6 +17721,46 @@ "integrity": "sha512-w89qg7PI8wAdvX60bMDP+bFoD5Dvhm9oLheFp5O4a2QF0cSBGsBX4qZmadPMvVqlLJBBci+WqGGOAPvcDeNSVg==", "dev": true }, + "node_modules/through2": { + "version": "2.0.5", + "resolved": "https://registry.npmjs.org/through2/-/through2-2.0.5.tgz", + "integrity": "sha512-/mrRod8xqpA+IHSLyGCQ2s8SPHiCDEeQJSep1jqLYeEUClOFG2Qsh+4FU6G9VeqpZnGW/Su8LQGc4YKni5rYSQ==", + "dev": true, + "dependencies": { + "readable-stream": "~2.3.6", + "xtend": "~4.0.1" + } + }, + "node_modules/through2/node_modules/isarray": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/isarray/-/isarray-1.0.0.tgz", + "integrity": "sha512-VLghIWNM6ELQzo7zwmcg0NmTVyWKYjvIeM83yjp0wRDTmUnrM678fQbcKBo6n2CJEF0szoG//ytg+TKla89ALQ==", + "dev": true + }, + "node_modules/through2/node_modules/readable-stream": { + "version": "2.3.8", + "resolved": "https://registry.npmjs.org/readable-stream/-/readable-stream-2.3.8.tgz", + "integrity": "sha512-8p0AUk4XODgIewSi0l8Epjs+EVnWiK7NoDIEGU0HhE7+ZyY8D1IMY7odu5lRrFXGg71L15KG8QrPmum45RTtdA==", + "dev": true, + "dependencies": { + "core-util-is": "~1.0.0", + "inherits": "~2.0.3", + "isarray": "~1.0.0", + "process-nextick-args": "~2.0.0", + "safe-buffer": "~5.1.1", + "string_decoder": "~1.1.1", + "util-deprecate": "~1.0.1" + } + }, + "node_modules/through2/node_modules/string_decoder": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/string_decoder/-/string_decoder-1.1.1.tgz", + "integrity": "sha512-n/ShnvDi6FHbbVfviro+WojiFzv+s8MPMHBczVePfUpDJLwoLT0ht1l4YwBCbi8pJAveEEdnkHyPyTP/mzRfwg==", + "dev": true, + "dependencies": { + "safe-buffer": "~5.1.0" + } + }, "node_modules/thunky": { "version": "1.1.0", "resolved": "https://registry.npmjs.org/thunky/-/thunky-1.1.0.tgz", @@ -19131,6 +19333,15 @@ } } }, + "node_modules/xtend": { + "version": "4.0.2", + "resolved": "https://registry.npmjs.org/xtend/-/xtend-4.0.2.tgz", + "integrity": "sha512-LKYU1iAXJXUgAXn9URjiu+MWhyUXHsvfp7mcuYm9dSUKK0/CjtrUwFAxD82/mCWbtLsGjFIad0wIsod4zrTAEQ==", + "dev": true, + "engines": { + "node": ">=0.4" + } + }, "node_modules/y18n": { "version": "5.0.8", "resolved": "https://registry.npmjs.org/y18n/-/y18n-5.0.8.tgz", diff --git a/package.json b/package.json index dce42d3c..279c1526 100644 --- a/package.json +++ b/package.json @@ -83,6 +83,7 @@ "@emotion/babel-plugin": "^11.11.0", "@emotion/css": "^11.11.0", "@emotion/react": "^11.11.1", + "@fastify/compress": "^6.5.0", "@fastify/express": "^2.3.0", "@fastify/static": "^6.10.2", "@lingui/loader": "^3.17.2", @@ -91,7 +92,6 @@ "@seald-io/nedb": "^3.1.0", "@types/bencode": "^2.0.1", "@types/body-parser": "^1.19.2", - "@types/compression": "^1.7.2", "@types/content-disposition": "^0.5.5", "@types/cookie-parser": "^1.4.3", "@types/create-torrent": "^5.0.0", @@ -128,7 +128,6 @@ "case-sensitive-paths-webpack-plugin": "2.4.0", "chalk": "^4.1.2", "classnames": "^2.3.2", - "compression": "^1.7.4", "content-disposition": "^0.5.4", "cookie-parser": "^1.4.6", "create-torrent": "^5.0.9", diff --git a/server/middleware/eventStream.ts b/server/middleware/eventStream.ts index 6fabb718..1410ed3e 100644 --- a/server/middleware/eventStream.ts +++ b/server/middleware/eventStream.ts @@ -17,7 +17,6 @@ export default (req: Request, res: Response, next: NextFunction) => { // Keep the connection open by sending a message every so often. const keepAliveTimeout = setInterval(() => { res.write(':keep-alive\n\n'); - res.flush(); }, 500); // cleanup on close diff --git a/server/models/ServerEvent.ts b/server/models/ServerEvent.ts index 9a8efafc..e0f4cc2b 100644 --- a/server/models/ServerEvent.ts +++ b/server/models/ServerEvent.ts @@ -13,7 +13,6 @@ class ServerEvent { this.res.write(`id:${id}\n`); this.res.write(`event:${eventType}\n`); this.res.write(`data:${JSON.stringify(data)}\n\n`); - this.res.flush(); } } diff --git a/server/routes/index.ts b/server/routes/index.ts index 97418947..469ecffc 100644 --- a/server/routes/index.ts +++ b/server/routes/index.ts @@ -12,11 +12,12 @@ import Users from '../models/Users'; import {authTokenSchema, UserInDatabase} from '@shared/schema/Auth'; import express from 'express'; import morgan from 'morgan'; -import compression from 'compression'; import passport from 'passport'; import bodyParser from 'body-parser'; import cookieParser from 'cookie-parser'; import {fastifyExpress} from '@fastify/express'; +import fastifyCompress from '@fastify/compress'; +import fastifyStatic from '@fastify/static'; declare global { // eslint-disable-next-line @typescript-eslint/no-namespace @@ -48,11 +49,9 @@ const constructRoutes = async (fastify: FastifyInstance) => { // Disable ETag app.set('etag', false); - // Enable compression - app.use(compression()); - // Static assets - app.use(servedPath, express.static(paths.appDist)); + // app.use(servedPath, express.static(paths.appDist)); + fastify.register(fastifyStatic, {root: paths.appDist, prefix: servedPath}); // Client app routes, serve index.html and client js will figure it out const html = fs.readFileSync(path.join(paths.appDist, 'index.html'), { @@ -65,30 +64,23 @@ const constructRoutes = async (fastify: FastifyInstance) => { 'Cache-Control': 'no-cache, no-store, must-revalidate', Pragma: 'no-cache', Expires: '0', + 'content-type': 'html', }; - app.get(`${servedPath}login`, (_req, res) => { - res.set(headers); + fastify.get(`${servedPath}login`, (_req, res) => { + res.headers(headers); res.send(html); }); - app.get(`${servedPath}register`, (_req, res) => { - res.set(headers); + fastify.get(`${servedPath}register`, (_req, res) => { + res.headers(headers); res.send(html); }); - app.get(`${servedPath}overview`, (_req, res) => { - res.set(headers); + fastify.get(`${servedPath}overview`, (_req, res) => { + res.headers(headers); res.send(html); }); - } else { - // no-op res.flush() as compression is not handled by Express - app.use((_req, res, next) => { - res.flush = () => { - // do nothing. - }; - next(); - }); } app.use(passport.initialize()); @@ -128,6 +120,7 @@ const constructRoutes = async (fastify: FastifyInstance) => { app.use(`${servedPath}api`, apiRoutes); + await fastify.register(fastifyCompress); await fastify.register(fastifyExpress); fastify.use(app);