Refactor: Split allNextJsPages.js into pages/ folder

The allNextJsPages.js file has become too long and difficult to read.
Instead, add a pages/ folder with seven subdirectories, one for each
page type of NextJS:

- api
- getInitialProps
- getServerSideProps
- getStaticProps
- getStaticPropsWithFallback
- getStaticPropsWithRevalidate
- withoutProps

Each folder contains a pages.js file that collects the relevant pages,
a setup.js file that sets up the Netlify function for the page or
copies the pre-rendered files to the correct locations, and a
redirects.js file that returns the list of redirects/rewrites to set up
for these pages.

We now have a lot more files than before, but it should be much easier
to understand than the prior allNextJsPages.js file.

Author: FinnWoelm

lib/allNextJsPages.js

@@ -0,0 +1,17 @@
+const { join } = require("path");
+const { readFileSync } = require("fs-extra");
+const { NEXT_DIST_DIR } = require("../config");
+const getFilePathForRoute = require("./getFilePathForRoute");
+
+// Get build ID that is used for data routes, e.g. /_next/data/BUILD_ID/...
+const fileContents = readFileSync(join(NEXT_DIST_DIR, "BUILD_ID"));
+const buildId = fileContents.toString();
+
+// Return the data route for the given route
+const getDataRouteForRoute = (route) => {
+  const filePath = getFilePathForRoute(route, "json");
+
+  return join("/_next", "data", buildId, filePath);
+};
+
+module.exports = getDataRouteForRoute;

lib/helpers/getDataRouteForRoute.js

@@ -0,0 +1,9 @@
+// Return the file for the given route
+const getFilePathForRoute = (route, extension) => {
+  // Replace / with /index
+  const path = route.replace(/^\/$/, "/index");
+
+  return `${path}.${extension}`;
+};
+
+module.exports = getFilePathForRoute;

lib/helpers/getFilePathForRoute.js

@@ -0,0 +1,40 @@
+// Adapted from @sls-next/lambda-at-edge (v1.2.0-alpha.3)
+// See: https://github.com/danielcondemarin/serverless-next.js/blob/57142970b08e6bc3faf0fc70749b3b0501ad7869/packages/lambda-at-edge/src/lib/expressifyDynamicRoute.ts#L4
+
+const CATCH_ALL_REGEX = /\/\[\.{3}(.*)\](.json)?$/;
+const OPTIONAL_CATCH_ALL_REGEX = /\/\[{2}\.{3}(.*)\]{2}(.json)?$/;
+const DYNAMIC_PARAMETER_REGEX = /\/\[(.*?)\]/g;
+
+// Convert dynamic NextJS routes into their Netlify-equivalent
+// Note that file endings (.json) must be removed for catch-all and optional
+// catch-all routes to work. That's why the regexes defined above include
+// the (.json)? option
+const getNetlifyRoutes = (nextRoute) => {
+  let netlifyRoutes = [nextRoute];
+
+  // If the route is an optional catch-all route, we need to add a second
+  // Netlify route for the base path (when no parameters are present).
+  // The file ending must be present!
+  if (nextRoute.match(OPTIONAL_CATCH_ALL_REGEX)) {
+    netlifyRoutes.push(nextRoute.replace(OPTIONAL_CATCH_ALL_REGEX, "$2"));
+  }
+
+  // Replace catch-all, e.g., [...slug]
+  netlifyRoutes = netlifyRoutes.map((route) =>
+    route.replace(CATCH_ALL_REGEX, "/:$1/*")
+  );
+
+  // Replace optional catch-all, e.g., [[...slug]]
+  netlifyRoutes = netlifyRoutes.map((route) =>
+    route.replace(OPTIONAL_CATCH_ALL_REGEX, "/*")
+  );
+
+  // Replace dynamic parameters, e.g., [id]
+  netlifyRoutes = netlifyRoutes.map((route) =>
+    route.replace(DYNAMIC_PARAMETER_REGEX, "/:$1")
+  );
+
+  return netlifyRoutes;
+};
+
+module.exports = getNetlifyRoutes;

lib/helpers/getNetlifyRoute.js

@@ -0,0 +1,9 @@
+const { join } = require("path");
+const { readJSONSync } = require("fs-extra");
+const { NEXT_DIST_DIR } = require("../config");
+
+const getPagesManifest = () => {
+  return readJSONSync(join(NEXT_DIST_DIR, "serverless", "pages-manifest.json"));
+};
+
+module.exports = getPagesManifest;

lib/helpers/getNetlifyRoutes.js

@@ -0,0 +1,9 @@
+const { join } = require("path");
+const { readJSONSync } = require("fs-extra");
+const { NEXT_DIST_DIR } = require("../config");
+
+const getPrerenderManifest = () => {
+  return readJSONSync(join(NEXT_DIST_DIR, "prerender-manifest.json"));
+};
+
+module.exports = getPrerenderManifest;

lib/helpers/getPagesManifest.js

@@ -0,0 +1,9 @@
+const { join } = require("path");
+const { readJSONSync } = require("fs-extra");
+const { NEXT_DIST_DIR } = require("../config");
+
+const getRoutesManifest = () => {
+  return readJSONSync(join(NEXT_DIST_DIR, "routes-manifest.json"));
+};
+
+module.exports = getRoutesManifest;

lib/helpers/getPrerenderManifest.js

@@ -0,0 +1,29 @@
+const {
+  getSortedRoutes: getSortedRoutesFromSlsNext,
+} = require("@sls-next/lambda-at-edge/dist/lib/sortedRoutes");
+
+// Remove the file extension form the route
+const removeFileExtension = (route) => route.replace(/\.[A-z]+$/, "");
+
+// Return an array of routes sorted in order of specificity, i.e., more generic
+// routes precede more specific ones
+const getSortedRoutes = (routes) => {
+  // The @sls-next getSortedRoutes does not correctly sort routes with file
+  // endings (e.g., json), so we remove them before sorting and add them back
+  // after sorting
+  const routesWithoutExtensions = routes.map((route) =>
+    removeFileExtension(route)
+  );
+
+  // Sort the "naked" routes
+  const sortedRoutes = getSortedRoutesFromSlsNext(routesWithoutExtensions);
+
+  // Return original routes in the sorted order
+  return routes.sort(
+    (routeA, routeB) =>
+      sortedRoutes.indexOf(removeFileExtension(routeA)) -
+      sortedRoutes.indexOf(removeFileExtension(routeB))
+  );
+};
+
+module.exports = getSortedRoutes;

lib/helpers/getRoutesManifest.js

@@ -0,0 +1,6 @@
+// Return true if the route is an API route
+const isApiRoute = (route) => {
+  return route.startsWith("/api/");
+};
+
+module.exports = isApiRoute;

lib/helpers/getSortedRoutes.js

@@ -0,0 +1,6 @@
+// Return true if the route uses dynamic routing (e.g., [id] or [...slug])
+const {
+  default: isDynamicRoute,
+} = require("@sls-next/lambda-at-edge/dist/lib/isDynamicRoute");
+
+module.exports = isDynamicRoute;

lib/helpers/isApiRoute.js

@@ -0,0 +1,7 @@
+// Return true if the route is one of the framework pages, such as _app or
+// _error
+const isFrameworkRoute = (route) => {
+  return ["/_app", "/_document", "/_error"].includes(route);
+};
+
+module.exports = isFrameworkRoute;

lib/helpers/isDynamicRoute.js

@@ -0,0 +1,6 @@
+// Return true if the file path is an HTML file
+const isHtmlFile = (filePath) => {
+  return filePath.endsWith(".html");
+};
+
+module.exports = isHtmlFile;

lib/helpers/isFrameworkRoute.js

@@ -0,0 +1,10 @@
+const getPrerenderManifest = require("./getPrerenderManifest");
+
+const { routes, dynamicRoutes } = getPrerenderManifest();
+
+// Return true if the route is defined in the prerender manifest
+const isRouteInPrerenderManifest = (route) => {
+  return route in routes || route in dynamicRoutes;
+};
+
+module.exports = isRouteInPrerenderManifest;

lib/helpers/isHtmlFile.js

@@ -0,0 +1,13 @@
+const getRoutesManifest = require("./getRoutesManifest");
+
+const { dataRoutes } = getRoutesManifest();
+
+// Return true if the route has a data route in the routes manifest
+const isRouteInPrerenderManifest = (route) => {
+  // If no data routes exist, return false
+  if (dataRoutes == null) return false;
+
+  return dataRoutes.find((dataRoute) => dataRoute.page === route);
+};
+
+module.exports = isRouteInPrerenderManifest;