WIP: feat(gatsby-plugin-fastity): Gatsby v4 DSG & SSR Support

.changeset/good-plums-shop.md

@@ -0,0 +1,5 @@
+---
+"gatsby-plugin-fastify": minor
+---
+
+feat: much improved logging

.changeset/kind-starfishes-change.md

@@ -0,0 +1,5 @@
+---
+"gatsby-plugin-fastify": patch
+---
+
+Fix: SSR/DSG routes throwing non-fatal error when returning file.

.changeset/odd-days-march.md

@@ -0,0 +1,5 @@
+---
+"gatsby-plugin-fastify": minor
+---
+
+feat: add support for Gatsby 500 error if SSR/DSG throws an error.

.changeset/stale-rocks-pay.md

@@ -0,0 +1,5 @@
+---
+"gatsby-plugin-fastify": patch
+---
+
+fix: handle situations where dev doesn't provide 404 page by falling back to generic 404.

.changeset/strange-adults-fly.md

@@ -0,0 +1,5 @@
+---
+"gatsby-plugin-fastify": minor
+---
+
+Support for Gatsby v4's DSG and SSR routes.

.yarnrc.yml

@@ -5,5 +5,7 @@ nodeLinker: node-modules
 plugins:
   - path: .yarn/plugins/@yarnpkg/plugin-workspace-tools.cjs
     spec: "@yarnpkg/plugin-workspace-tools"
+  - path: .yarn/plugins/@yarnpkg/plugin-interactive-tools.cjs
+    spec: "@yarnpkg/plugin-interactive-tools"
 
 yarnPath: .yarn/releases/yarn-3.1.0.cjs

package.json

@@ -6,7 +6,7 @@
   "private": true,
   "workspaces": [
     "packages/*",
-    "packages/**/test-site"
+    "test-sites/*"
   ],
   "scripts": {
     "ac": "yarn all-contributors",

packages/gatsby-plugin-fastify/.vscode/launch.json

@@ -0,0 +1,22 @@
+{
+  // Use IntelliSense to learn about possible attributes.
+  // Hover to view descriptions of existing attributes.
+  // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "name": "Attach",
+      "port": 9229,
+      "request": "attach",
+      "skipFiles": ["<node_internals>/**"],
+      "type": "pwa-node"
+    },
+    {
+      "name": "Attach by Process ID",
+      "processId": "${command:PickProcess}",
+      "request": "attach",
+      "skipFiles": ["<node_internals>/**"],
+      "type": "pwa-node"
+    }
+  ]
+}

packages/gatsby-plugin-fastify/README.md

@@ -22,7 +22,9 @@
 
 - Serving Gatsby Functions
 - Serving static files
+- Serving DSG/SSR Routes
 - Gatsby 404 page
+- Gatsby 500 page
 - Gatsby redirects
 - Client-side paths
 - Serving the site with pathPrefix - set it up inside `gatsby-config.js`, the plugin will take care of it
@@ -33,7 +35,7 @@
 Install the plugin using npm or yarn
 
 ```sh
-npm install gatsby-plugin-fastify fastify fastify-static fastify-compress fastify-plugin
+npm install gatsby-plugin-fastify fastify fastify-static fastify-compress fastify-plugin fastify-accepts
 ```
 
 and add it to your `gatsby-config.js`
@@ -56,6 +58,8 @@ module.exports = {
 
 # Serving your site
 
+Node and Fastify are great for building application specific web servers but generally should not be used on the edge. Meaning, most folks will use a fully fledged web server (e.g. [Nginx](https://www.nginx.com/) or [Caddy](https://caddyserver.com/) that handles traffic before passing it back to node. This allows the Edge web server to handle security, TLS/SSL, load balencing, etc. Then the node server only worries about the application. A CDN (e.g. Fastly or CloudFlare ) is also often used for performance and scalability.
+
 ## Server CLI (expected)
 
 This plugin implements a server that's ready to go. To use this you can configure a `start`(or whatever you prefer) command in your `package.json`:
@@ -111,12 +115,13 @@ For an example on how to use thi reference the server implementation file from [
 Finally, each of the Gatsby features (functions, static files, redirects, client-only routes, and 404 handling) is implemented in it's own plugin. Those may be imported as well for use in a custom server implementation.
 
 ```js
-import { handle } from "gatsby-plugin-fastify/plugins/gatsby";
 import { handle404 } from "gatsby-plugin-fastify/plugins/404";
+import { handle500 } from "gatsby-plugin-fastify/plugins/500";
 import { handleClientOnlyPaths } from "gatsby-plugin-fastify/plugins/clientPaths";
 import { handleFunctions } from "gatsby-plugin-fastify/plugins/functions";
 import { handleRedirects } from "gatsby-plugin-fastify/plugins/redirects";
 import { handleStatic } from "gatsby-plugin-fastify/plugins/static";
+import { handleServerRoutes } from "gatsby-plugin-fastify/plugins/serverRoutes";
 ```
 
 For an example on how to use these you see the `serveGatsby` implementation file from [`src/plugins/gatsby.ts`](https://github.com/gatsby-uc/plugins/tree/main/packages/gatsby-plugin-fastify/src/plugins/gatsby.ts).

packages/gatsby-plugin-fastify/jest.config.js

@@ -20,6 +20,8 @@ module.exports = {
   ],
 
   modulePathIgnorePatterns: [`<rootDir>/test-site/`],
+  transformIgnorePatterns: ["/query-engine/", "/page-ssr/", "/test-sites/fastify/"],
+  coveragePathIgnorePatterns: ["/query-engine/", "/page-ssr/", "/test-sites/fastify/"],
   // The test environment that will be used for testing
   testEnvironment: `node`,
 };

packages/gatsby-plugin-fastify/package.json

@@ -25,7 +25,7 @@
   },
   "scripts": {
     "build": "babel src --out-dir . --ignore \"**/__tests__,**/*.d.ts\" --extensions \".ts,.js\"",
-    "pretest": "cd test-site && yarn run build",
+    "pretest": "cd ../../test-sites/fastify/ && yarn run build",
     "test": "jest --coverage",
     "test:watch": "jest --watch",
     "watch": "yarn build --watch"
@@ -48,21 +48,23 @@
     "babel-preset-gatsby-package": "^1.14.0",
     "cross-env": "^7.0.3",
     "fastify": "^3.22.0",
+    "fastify-accepts": "^2.0.1",
     "fastify-compress": "^3.6.0",
     "fastify-plugin": "^3.0.0",
     "fastify-static": "^4.4.0",
-    "gatsby": "^3.14.2",
-    "gatsby-plugin-utils": "^1.14.0",
-    "jest": "^27.2.5"
+    "gatsby": "^4.0.0",
+    "gatsby-plugin-utils": "^2.0.0",
+    "jest": "^27.3.1"
   },
   "peerDependencies": {
     "fastify": "^3.19.0",
+    "fastify-accepts": "^2.1.0",
     "fastify-compress": "^3.6.0",
     "fastify-plugin": "^3.0.0",
     "fastify-static": "^4.2.0",
-    "gatsby": "^3.7.0"
+    "gatsby": "^4.0.0"
   },
   "engines": {
-    "node": ">=12.13.0"
+    "node": ">=14.15.0"
   }
 }

packages/gatsby-plugin-fastify/src/__tests__/__snapshots__/gatsby-node.js.snap

@@ -52,5 +52,15 @@ Object {
       "toPath": "/posts/page-3",
     },
   ],
+  "serverSideRoutes": Array [
+    Object {
+      "mode": "SSR",
+      "path": "/ssr",
+    },
+    Object {
+      "mode": "DSG",
+      "path": "/my/dsg/path",
+    },
+  ],
 }
 `;

packages/gatsby-plugin-fastify/src/__tests__/__utils__/config.js

@@ -1,3 +1,6 @@
+import Fastify from "fastify";
+import { getConfig } from "../../utils/config";
+
 exports.createCliConfig = function createCliConfig({ host, port, logLevel, open }) {
   return {
     host,
@@ -10,3 +13,22 @@ exports.createCliConfig = function createCliConfig({ host, port, logLevel, open
     o: open,
   };
 };
+
+exports.createFastifyInstance = async function createFastifyInstance(plugin) {
+  const {
+    cli: { logLevel },
+  } = getConfig();
+  const fastify = Fastify({
+    ignoreTrailingSlash: true,
+    logger: { level: logLevel, prettyPrint: true },
+    disableRequestLogging: ["trace", "debug"].includes(logLevel) ? false : true,
+  });
+
+  const {
+    server: { prefix },
+  } = getConfig();
+  await fastify.register(plugin, { prefix });
+  await fastify.ready();
+
+  return fastify;
+};

packages/gatsby-plugin-fastify/src/__tests__/gatsby-node.js

@@ -1,7 +1,7 @@
 const { onPostBuild } = require("../gatsby-node");
 const fs = require("fs-extra");
 
-jest.mock("../../utils/constants", () => ({
+jest.mock("../utils/constants", () => ({
   ...jest.requireActual("../utils/constants"),
   PATH_TO_FUNCTIONS: "test-site/.cache/functions/",
   PATH_TO_PUBLIC: __dirname + "/__files__/public/",
@@ -63,6 +63,14 @@ const store = {
         matchPath: "/app/*",
         path: "/app/[...]/",
       },
+      {
+        path: "/ssr",
+        mode: "SSR",
+      },
+      {
+        path: "/my/dsg/path",
+        mode: "DSG",
+      },
     ],
     redirects: [
       {