feat: add version check for gatsby-netlify-plugin

Author: orinokai

plugin/package-lock.json

@@ -54,13 +54,15 @@
     "node-stream-zip": "^1.15.0",
     "pathe": "^0.2.0",
     "pretty-bytes": "^5.6.0",
+    "semver": "^7.3.5",
     "tempy": "^1.0.0"
   },
   "devDependencies": {
     "@gatsbyjs/reach-router": "^1.3.6",
     "@netlify/build": "^26.5.1",
     "@types/fs-extra": "^9.0.12",
     "@types/multer": "^1.4.7",
+    "@types/semver": "^7.3.9",
     "gatsby": "^4.9.0",
     "npm-run-all": "^4.1.5",
     "rimraf": "^3.0.2",

plugin/package.json

@@ -6,6 +6,8 @@ import { stripIndent } from 'common-tags'
 import fs, { existsSync } from 'fs-extra'
 import type { GatsbyConfig, PluginRef } from 'gatsby'
 
+import { checkPackageVersion } from './files'
+
 export async function spliceConfig({
   startMarker,
   endMarker,
@@ -38,11 +40,9 @@ export async function spliceConfig({
   return fs.writeFile(fileName, out)
 }
 
-function loadGatsbyConfig({ utils, publish }): GatsbyConfig | never {
-  const gatsbyConfigFile = path.resolve(
-    getGatsbyRoot(publish),
-    'gatsby-config.js',
-  )
+function loadGatsbyConfig({ gatsbyRoot, utils }): GatsbyConfig | never {
+  const gatsbyConfigFile = path.resolve(gatsbyRoot, 'gatsby-config.js')
+
   if (!existsSync(gatsbyConfigFile)) {
     return {}
   }
@@ -65,14 +65,25 @@ function hasPlugin(plugins: PluginRef[], pluginName: string): boolean {
   )
 }
 
-export function checkGatsbyConfig({ utils, netlifyConfig }): void {
+export async function checkConfig({ utils, netlifyConfig }): Promise<void> {
+  const gatsbyRoot = getGatsbyRoot(netlifyConfig.build.publish)
+
   // warn if gatsby-plugin-netlify is missing
   const gatsbyConfig = loadGatsbyConfig({
     utils,
-    publish: netlifyConfig.build.publish,
+    gatsbyRoot,
   })
 
-  if (!hasPlugin(gatsbyConfig.plugins, 'gatsby-plugin-netlify')) {
+  if (hasPlugin(gatsbyConfig.plugins, 'gatsby-plugin-netlify')) {
+    if (
+      // prettier-ignore
+      !(await checkPackageVersion(gatsbyRoot, 'gatsby-plugin-netlify', '>=4.2.0',))
+    ) {
+      console.error(
+        'The plugin `gatsby-plugin-netlify` does not support DSG, please update to >=4.2.0',
+      )
+    }
+  } else {
     console.error(
       'Please install `gatsby-plugin-netlify` and enable it in your gatsby-config.js. https://www.gatsbyjs.com/plugins/gatsby-plugin-netlify/',
     )

plugin/src/helpers/config.ts

@@ -1,8 +1,16 @@
 import os from 'os'
 import process from 'process'
 
-import { copyFile, ensureDir, existsSync, readFile, writeFile } from 'fs-extra'
+import {
+  copyFile,
+  ensureDir,
+  existsSync,
+  readFile,
+  writeFile,
+  readJson,
+} from 'fs-extra'
 import { dirname, join, resolve } from 'pathe'
+import semver from 'semver'
 
 const DEFAULT_LAMBDA_PLATFORM = 'linux'
 const DEFAULT_LAMBDA_ABI = '83'
@@ -70,6 +78,26 @@ export const findModuleFromBase = ({ paths, candidates }): string | null => {
   return null
 }
 
+export async function checkPackageVersion(
+  root: string,
+  name: string,
+  version: string,
+): Promise<boolean> {
+  const packagePath = findModuleFromBase({
+    paths: [root],
+    candidates: [name],
+  })
+
+  let packageObj: { version: string }
+  try {
+    packageObj = await readJson(`${packagePath}/package.json`)
+  } catch {
+    return false
+  }
+
+  return semver.satisfies(packageObj.version, version)
+}
+
 /**
  * When Gatsby runs a build, it copies binary dependencies to the "query-engine" folder. These are auto-detected, based
  * on the environment in which the build is running. This can cause problems if these don't match the lambda environment.

plugin/src/helpers/files.ts

@@ -7,7 +7,7 @@ import { existsSync } from 'fs-extra'
 
 import { normalizedCacheDir, restoreCache, saveCache } from './helpers/cache'
 import {
-  checkGatsbyConfig,
+  checkConfig,
   mutateConfig,
   shouldSkipFunctions,
   spliceConfig,
@@ -32,7 +32,7 @@ export async function onPreBuild({
   }
   await restoreCache({ utils, publish: PUBLISH_DIR })
 
-  checkGatsbyConfig({ utils, netlifyConfig })
+  await checkConfig({ utils, netlifyConfig })
 }
 
 export async function onBuild({