Merge pull request #18 from netlify/feat/v4

feat!: version 4 beta

Author: ascorbic

.gitignore

@@ -2,3 +2,4 @@
 !.*.js
 !index.js
 node_modules
+yarn-error.log

package.json

@@ -1,7 +1,7 @@
 {
   "name": "gatsby-plugin-netlify",
   "description": "A Gatsby plugin which generates a _headers file for netlify",
-  "version": "3.14.0",
+  "version": "4.0.0-next.0",
   "author": "Kyle Mathews <[email protected]>",
   "bugs": {
     "url": "https://github.com/netlify/gatsby-plugin-netlify/issues"
@@ -15,6 +15,7 @@
   "dependencies": {
     "@babel/runtime": "^7.14.8",
     "fs-extra": "^10.0.0",
+    "gatsby-core-utils": "^3.0.0-zz-next.1",
     "kebab-hash": "^0.1.2",
     "lodash": "^4.17.21",
     "webpack-assets-manifest": "^5.0.6"
@@ -26,7 +27,7 @@
     "@babel/eslint-plugin": "^7.14.0",
     "@typescript-eslint/eslint-plugin": "^4.28.1",
     "@typescript-eslint/parser": "^4.28.1",
-    "babel-preset-gatsby-package": "^1.13.0",
+    "babel-preset-gatsby-package": "^2.0.0-zz-next.1",
     "cross-env": "^7.0.3",
     "eslint": "^7.32.0",
     "eslint-config-google": "^0.14.0",
@@ -36,8 +37,8 @@
     "eslint-plugin-jsx-a11y": "^6.4.1",
     "eslint-plugin-prettier": "^4.0.0",
     "eslint-plugin-react": "^7.24.0",
-    "gatsby": "^3.13.0",
-    "gatsby-plugin-utils": "^1.13.0",
+    "gatsby": "^4.0.0-zz-next.1",
+    "gatsby-plugin-utils": "^2.0.0-zz-next.1",
     "jest": "^27.0.6",
     "prettier": "^2.3.2",
     "typescript": "^4.3.5"
@@ -52,7 +53,7 @@
   "license": "MIT",
   "main": "index.js",
   "peerDependencies": {
-    "gatsby": "^3.0.0"
+    "gatsby": "^4.0.0-next.0"
   },
   "repository": {
     "type": "git",
@@ -61,6 +62,7 @@
   "scripts": {
     "build": "babel src --out-dir . --ignore \"**/__tests__\"",
     "prepare": "cross-env NODE_ENV=production npm run build",
+    "prepublishOnly": "npm run prepare",
     "format": "npm run format:code && npm run format:other",
     "format:code": "npm run lint -- --fix",
     "format:other": "npm run prettier -- --write",

src/constants.js

@@ -40,3 +40,5 @@ export const COMMON_BUNDLES = [`commons`, `app`]
 export const HEADER_COMMENT = `## Created with gatsby-plugin-netlify`
 
 export const PAGE_DATA_DIR = `page-data/`
+
+export const PAGE_COUNT_WARN = 1000

src/create-redirects.js

@@ -1,5 +1,5 @@
 import { HEADER_COMMENT } from "./constants"
-import { exists, readFile, writeFile } from "fs-extra"
+import { existsSync, readFile, writeFile } from "fs-extra"
 
 export default async function writeRedirectsFile(
   pluginData,
@@ -71,7 +71,7 @@ export default async function writeRedirectsFile(
   // Websites may also have statically defined redirects
   // In that case we should append to them (not overwrite)
   // Make sure we aren't just looking at previous build results though
-  const fileExists = await exists(FILE_PATH)
+  const fileExists = existsSync(FILE_PATH)
   let fileContents = ``
   if (fileExists) {
     fileContents = await readFile(FILE_PATH, `utf8`)

src/gatsby-node.js

@@ -1,11 +1,16 @@
 // https://www.netlify.com/docs/headers-and-basic-auth/
 
 import WebpackAssetsManifest from "webpack-assets-manifest"
-
+import { generatePageDataPath } from "gatsby-core-utils"
 import makePluginData from "./plugin-data"
 import buildHeadersProgram from "./build-headers-program"
 import createRedirects from "./create-redirects"
-import { DEFAULT_OPTIONS, BUILD_HTML_STAGE, BUILD_CSS_STAGE } from "./constants"
+import {
+  DEFAULT_OPTIONS,
+  BUILD_HTML_STAGE,
+  BUILD_CSS_STAGE,
+  PAGE_COUNT_WARN,
+} from "./constants"
 
 const assetsManifest = {}
 
@@ -14,7 +19,6 @@ exports.onCreateWebpackConfig = ({ actions, stage }) => {
   if (stage !== BUILD_HTML_STAGE && stage !== BUILD_CSS_STAGE) {
     return
   }
-
   actions.setWebpackConfig({
     plugins: [
       new WebpackAssetsManifest({
@@ -32,20 +36,48 @@ exports.onPostBuild = async (
   const pluginData = makePluginData(store, assetsManifest, pathPrefix)
   const pluginOptions = { ...DEFAULT_OPTIONS, ...userPluginOptions }
 
-  const { redirects } = store.getState()
-
-  let rewrites = []
-  if (pluginOptions.generateMatchPathRewrites) {
-    const { pages } = store.getState()
-    rewrites = Array.from(pages.values())
-      .filter(page => page.matchPath && page.matchPath !== page.path)
-      .map(page => {
-        return {
-          fromPath: page.matchPath,
-          toPath: page.path,
+  const { redirects, pages } = store.getState()
+  if (
+    pages.size > PAGE_COUNT_WARN &&
+    (pluginOptions.mergeCachingHeaders || pluginOptions.mergeLinkHeaders)
+  ) {
+    reporter.warn(
+      `[gatsby-plugin-netlify] Your site has ${pages.size} pages, which means that the generated headers file could become very large. Consider disabling "mergeCachingHeaders" and "mergeLinkHeaders" in your plugin config`
+    )
+  }
+  reporter.info(`[gatsby-plugin-netlify] Creating SSR redirects...`)
+  let count = 0
+  const rewrites = []
+  Array.from(pages.values()).forEach(page => {
+    const { mode, matchPath, path } = page
+    if (mode === `SSR`) {
+      count++
+      rewrites.push(
+        {
+          fromPath: matchPath ?? path,
+          toPath: `/.netlify/functions/__ssr`,
+        },
+        {
+          fromPath: generatePageDataPath(`/`, matchPath ?? path),
+          toPath: `/.netlify/functions/__ssr`,
         }
+      )
+    }
+    if (
+      pluginOptions.generateMatchPathRewrites &&
+      page.matchPath !== page.path
+    ) {
+      rewrites.push({
+        fromPath: page.matchPath,
+        toPath: page.path,
       })
-  }
+    }
+  })
+  reporter.info(
+    `[gatsby-plugin-netlify] Created ${count} SSR redirect${
+      count === 1 ? `` : `s`
+    }...`
+  )
 
   await Promise.all([
     buildHeadersProgram(pluginData, pluginOptions, reporter),
@@ -66,21 +98,21 @@ const pluginOptionsSchema = function ({ Joi }) {
       .items(Joi.string())
       .description(`Add more headers to all the pages`),
     mergeSecurityHeaders: Joi.boolean().description(
-      `When set to true, turns off the default security headers`
+      `When set to false, turns off the default security headers`
     ),
     mergeLinkHeaders: Joi.boolean().description(
-      `When set to true, turns off the default gatsby js headers`
+      `When set to false, turns off the default gatsby js headers`
     ),
     mergeCachingHeaders: Joi.boolean().description(
-      `When set to true, turns off the default caching headers`
+      `When set to false, turns off the default caching headers`
     ),
     transformHeaders: Joi.function()
       .maxArity(2)
       .description(
         `Transform function for manipulating headers under each path (e.g.sorting), etc. This should return an object of type: { key: Array<string> }`
       ),
     generateMatchPathRewrites: Joi.boolean().description(
-      `When set to true, turns off automatic creation of redirect rules for client only paths`
+      `When set to false, turns off automatic creation of redirect rules for client only paths`
     ),
   })
 }