feat(deps): Upgrade to Fastify v5 (#109)

Huge shoutout to @ladderschool who originally created this PR over at
the RedwoodGQL repo: redwoodjs/graphql#12046

V4 of Fastify is approaching end of life by 6/30/25. This PR seeks to
upgrade the relevant packages.
Fastify V5 also requires node >=20 now.

Migration docs:
https://fastify.dev/docs/latest/Guides/Migration-Guide-V5/

Luckily many changes were already deprecated from V3->V4 and I have
found no issues running V5 in my production app. The only breaking
change is how Fastify handles the logger, which this PR addresses,
specifically in the
[createServerHelpers.ts](https://github.com/redwoodjs/graphql/compare/main...ladderschool:redwood:main?expand=1#diff-2f9b7c2c7a03d2b1aca7d841ce3365a524a92b7bee07c5177272f1dbf1395d84)
file.

```js
// v5
const loggerInstance = require('pino')()
const fastify = require('fastify')({
  loggerInstance
})
```

There's a test repository that @ladderschool used to confirm these
updates in this PR from:
https://github.com/ladderschool/fastify-v5-test

Local build succeeded: https://cloud.nx.app/runs/saVKz8Qhgn
Local tests succeeded: https://cloud.nx.app/runs/5SujFvDgYM

---------

Co-authored-by: ladderschool <[email protected]>

Author: Tobbe

.changesets/109.md

@@ -0,0 +1,14 @@
+- feat(deps): Upgrade (#109) by @Tobbe
+
+This PR is a breaking change. It upgrades Fastify from v4 to v5, so if you're
+running CedarJS in a serverful environment you should look through your Fastify
+specific code.
+
+Note: For v5 Fastify changed how you pass in a custom logger. CedarJS already
+had that code somewhat customized, so for this PR we kept the unified `logger`
+option we already had, so there should be no change for you in that regards,
+but we will probably break this appart in the future to match what Fastify is
+doing
+
+See [the Fastify v5 migration docs](https://fastify.dev/docs/latest/Guides/Migration-Guide-V5/)
+for all the details.

packages/adapters/fastify/web/package.json

@@ -22,14 +22,14 @@
   },
   "dependencies": {
     "@cedarjs/project-config": "workspace:*",
-    "@fastify/http-proxy": "9.5.0",
-    "@fastify/static": "6.12.0",
-    "@fastify/url-data": "5.4.0",
+    "@fastify/http-proxy": "11.1.2",
+    "@fastify/static": "8.2.0",
+    "@fastify/url-data": "6.0.3",
     "fast-glob": "3.3.2"
   },
   "devDependencies": {
     "@cedarjs/framework-tools": "workspace:*",
-    "fastify": "4.28.1",
+    "fastify": "5.3.3",
     "tsx": "4.19.3",
     "typescript": "5.6.2",
     "vitest": "2.1.9"

packages/adapters/fastify/web/src/web.test.ts

@@ -51,7 +51,7 @@ describe('redwoodFastifyWeb', () => {
       })
 
       expect(res.statusCode).toBe(200)
-      expect(res.headers['content-type']).toBe('text/html; charset=UTF-8')
+      expect(res.headers['content-type']).toBe('text/html; charset=utf-8')
       expect(res.body).toBe(
         fs.readFileSync(path.join(getPaths().web.dist, `${url}.html`), 'utf-8'),
       )
@@ -66,7 +66,7 @@ describe('redwoodFastifyWeb', () => {
       })
 
       expect(res.statusCode).toBe(200)
-      expect(res.headers['content-type']).toBe('text/html; charset=UTF-8')
+      expect(res.headers['content-type']).toBe('text/html; charset=utf-8')
       expect(res.body).toBe(
         fs.readFileSync(path.join(getPaths().web.dist, `${url}.html`), 'utf-8'),
       )
@@ -83,7 +83,7 @@ describe('redwoodFastifyWeb', () => {
       })
 
       expect(res.statusCode).toBe(200)
-      expect(res.headers['content-type']).toBe('text/html; charset=UTF-8')
+      expect(res.headers['content-type']).toBe('text/html; charset=utf-8')
       expect(res.body).toBe(
         fs.readFileSync(path.join(getPaths().web.dist, `${url}.html`), 'utf-8'),
       )
@@ -122,7 +122,7 @@ describe('redwoodFastifyWeb', () => {
       })
 
       expect(res.statusCode).toBe(200)
-      expect(res.headers['content-type']).toBe('text/html; charset=UTF-8')
+      expect(res.headers['content-type']).toBe('text/html; charset=utf-8')
       expect(res.body).toBe(
         fs.readFileSync(path.join(getPaths().web.dist, url), 'utf-8'),
       )
@@ -135,7 +135,7 @@ describe('redwoodFastifyWeb', () => {
       })
 
       expect(res.statusCode).toBe(200)
-      expect(res.headers['content-type']).toBe('text/html; charset=UTF-8')
+      expect(res.headers['content-type']).toBe('text/html; charset=utf-8')
       expect(res.body).toBe(
         fs.readFileSync(path.join(getPaths().web.dist, '200.html'), 'utf-8'),
       )
@@ -153,7 +153,7 @@ describe('redwoodFastifyWeb', () => {
 
       expect(res.statusCode).toBe(200)
       expect(res.headers['content-type']).toBe(
-        'application/javascript; charset=UTF-8',
+        'application/javascript; charset=utf-8',
       )
       expect(res.body).toBe(
         fs.readFileSync(
@@ -172,7 +172,7 @@ describe('redwoodFastifyWeb', () => {
       })
 
       expect(res.statusCode).toBe(200)
-      expect(res.headers['content-type']).toBe('text/css; charset=UTF-8')
+      expect(res.headers['content-type']).toBe('text/css; charset=utf-8')
       expect(res.body).toBe(
         fs.readFileSync(
           path.join(getPaths().web.dist, relativeFilePath),
@@ -191,7 +191,7 @@ describe('redwoodFastifyWeb', () => {
 
       expect(res.statusCode).toBe(200)
       expect(res.headers['content-type']).toBe(
-        'application/json; charset=UTF-8',
+        'application/json; charset=utf-8',
       )
       expect(res.body).toBe(
         fs.readFileSync(
@@ -220,7 +220,7 @@ describe('redwoodFastifyWeb', () => {
       })
 
       expect(res.statusCode).toBe(200)
-      expect(res.headers['content-type']).toBe('text/markdown; charset=UTF-8')
+      expect(res.headers['content-type']).toBe('text/markdown; charset=utf-8')
       expect(res.body).toBe(
         fs.readFileSync(
           path.join(getPaths().web.dist, relativeFilePath),
@@ -238,7 +238,7 @@ describe('redwoodFastifyWeb', () => {
       })
 
       expect(res.statusCode).toBe(200)
-      expect(res.headers['content-type']).toBe('text/plain; charset=UTF-8')
+      expect(res.headers['content-type']).toBe('text/plain; charset=utf-8')
       expect(res.body).toBe(
         fs.readFileSync(
           path.join(getPaths().web.dist, relativeFilePath),

packages/adapters/fastify/web/src/webFallback.test.ts

@@ -37,7 +37,7 @@ describe('webFallback', () => {
     })
 
     expect(res.statusCode).toBe(200)
-    expect(res.headers['content-type']).toBe('text/html; charset=UTF-8')
+    expect(res.headers['content-type']).toBe('text/html; charset=utf-8')
     expect(res.body).toBe(
       fs.readFileSync(path.join(getPaths().web.dist, url), 'utf-8'),
     )

packages/api-server/package.json

@@ -34,15 +34,15 @@
     "@cedarjs/internal": "workspace:*",
     "@cedarjs/project-config": "workspace:*",
     "@cedarjs/web-server": "workspace:*",
-    "@fastify/multipart": "8.3.1",
-    "@fastify/url-data": "5.4.0",
+    "@fastify/multipart": "9.0.3",
+    "@fastify/url-data": "6.0.3",
     "chalk": "4.1.2",
     "chokidar": "3.6.0",
     "dotenv-defaults": "5.0.2",
     "fast-glob": "3.3.2",
     "fast-json-parse": "1.0.3",
-    "fastify": "4.28.1",
-    "fastify-raw-body": "4.3.0",
+    "fastify": "5.3.3",
+    "fastify-raw-body": "5.0.0",
     "lodash": "4.17.21",
     "pretty-bytes": "5.6.0",
     "pretty-ms": "7.0.1",
@@ -57,6 +57,7 @@
     "@types/qs": "6.9.16",
     "@types/split2": "4.2.3",
     "@types/yargs": "17.0.33",
+    "memfs": "4.17.2",
     "pino-abstract-transport": "1.2.0",
     "tsx": "4.19.3",
     "typescript": "5.6.2",

packages/api-server/src/__tests__/createServer.test.ts

@@ -160,7 +160,6 @@ describe('createServer', () => {
       level: 30,
       msg: 'incoming request',
       req: {
-        hostname: 'localhost:80',
         method: 'GET',
         remoteAddress: '127.0.0.1',
         url: '/hello',

packages/api-server/src/createServerHelpers.ts

@@ -20,8 +20,11 @@ export interface CreateServerOptions {
   /** The prefix for all routes. Defaults to `/` */
   apiRootPath?: string
 
+  // TODO: This should probably be split, to match Fastify's way of doing things
   /** Logger instance or options */
-  logger?: FastifyServerOptions['logger']
+  logger?:
+    | FastifyServerOptions['logger']
+    | FastifyServerOptions['loggerInstance']
 
   /**
    * Options for the fastify server instance.
@@ -74,23 +77,29 @@ type ResolvedOptions = Required<
   }
 >
 
+function isCustomLoggerInstance(
+  logger:
+    | FastifyServerOptions['logger']
+    | FastifyServerOptions['loggerInstance'],
+): logger is FastifyServerOptions['loggerInstance'] {
+  return !!logger && typeof logger === 'object' && 'info' in logger
+}
+
 export function resolveOptions(
   options: CreateServerOptions = {},
   args?: string[],
 ) {
   options.parseArgs ??= true
 
   const defaults = getDefaultCreateServerOptions()
-
-  options.logger ??= defaults.logger
+  const logger = options.logger ?? defaults.logger
 
   // Set defaults.
   const resolvedOptions: ResolvedOptions = {
     apiRootPath: options.apiRootPath ?? defaults.apiRootPath,
 
     fastifyServerOptions: options.fastifyServerOptions ?? {
       requestTimeout: defaults.fastifyServerOptions.requestTimeout,
-      logger: options.logger ?? defaults.logger,
       bodyLimit: defaults.fastifyServerOptions.bodyLimit,
     },
     configureApiServer:
@@ -100,9 +109,15 @@ export function resolveOptions(
   }
 
   // Merge fastifyServerOptions.
+
   resolvedOptions.fastifyServerOptions.requestTimeout ??=
     defaults.fastifyServerOptions.requestTimeout
-  resolvedOptions.fastifyServerOptions.logger = options.logger
+
+  if (isCustomLoggerInstance(logger)) {
+    resolvedOptions.fastifyServerOptions.loggerInstance = logger
+  } else {
+    resolvedOptions.fastifyServerOptions.logger = logger
+  }
 
   if (options.parseArgs) {
     const { values } = parseArgs({

packages/web-server/package.json

@@ -29,7 +29,7 @@
     "@cedarjs/project-config": "workspace:*",
     "chalk": "4.1.2",
     "dotenv-defaults": "5.0.2",
-    "fastify": "4.28.1",
+    "fastify": "5.3.3",
     "fs-extra": "11.2.0",
     "yargs": "17.7.2"
   },