feat: enforce zisi when target is not serverless (#22)

* feat: add bundler checks

* feat: add tests

Author: ascorbic

src/helpers/config.js

@@ -124,3 +124,26 @@ exports.setIncludedFiles = ({ netlifyConfig, publish }) => {
     )
   })
 }
+
+exports.setBundler = ({ netlifyConfig, target }) => {
+  if (target === 'serverless') {
+    // Any bundler works with serverless
+    return
+  }
+
+  // Not quite such a simple a check, as we need to check both the default bundler
+  // and whether any of the individual functions are using the esbuild bundler.
+  const handlers = [HANDLER_FUNCTION_NAME, ODB_FUNCTION_NAME]
+  const defaultIsEsbuild = Boolean(netlifyConfig.functions['*']?.node_bundler === 'esbuild')
+  const handlerBundlers = handlers.map((func) => netlifyConfig.functions[func]?.node_bundler)
+  if (
+    (defaultIsEsbuild && !handlerBundlers.every((bundler) => bundler === 'zisi')) ||
+    handlerBundlers.includes('esbuild')
+  ) {
+    console.warn(`esbuild is not supported for target=${target}. Setting to "zisi"`)
+  }
+  handlers.forEach((func) => {
+    netlifyConfig.functions[func] ||= {}
+    netlifyConfig.functions[func].node_bundler = 'zisi'
+  })
+}

src/index.js

@@ -6,7 +6,7 @@ const { copy } = require('fs-extra')
 
 const { ODB_FUNCTION_NAME, HANDLER_FUNCTION_NAME } = require('./constants')
 const { restoreCache, saveCache } = require('./helpers/cache')
-const { getNextConfig, setIncludedFiles, generateRedirects } = require('./helpers/config')
+const { getNextConfig, setIncludedFiles, generateRedirects, setBundler } = require('./helpers/config')
 const { generateFunctions, setupImageFunction } = require('./helpers/functions')
 const {
   verifyNetlifyBuildVersion,
@@ -44,6 +44,8 @@ module.exports = {
 
     const { images, target, appDir } = await getNextConfig({ publish, failBuild })
 
+    setBundler({ netlifyConfig, target })
+
     verifyBuildTarget(target)
 
     setIncludedFiles({ netlifyConfig, publish })

test/index.js

@@ -8,6 +8,7 @@ const { dir: getTmpDir } = require('tmp-promise')
 const plugin = require('../src')
 
 const { HANDLER_FUNCTION_NAME, ODB_FUNCTION_NAME } = require('../src/constants')
+const { setBundler } = require('../src/helpers/config')
 
 const FIXTURES_DIR = `${__dirname}/fixtures`
 const SAMPLE_PROJECT_DIR = `${__dirname}/../demo`
@@ -191,3 +192,84 @@ describe('onPostBuild', () => {
     })
   })
 })
+
+describe('target checking', () => {
+  const warn = jest.spyOn(global.console, 'warn')
+  beforeEach(() => {
+    warn.mockReset()
+  })
+  test('changes nothing if target is serverless', () => {
+    const netlifyConfig = {
+      functions: {
+        [HANDLER_FUNCTION_NAME]: {
+          node_bundler: 'esbuild',
+        },
+      },
+    }
+    setBundler({ target: 'serverless', netlifyConfig })
+    expect(netlifyConfig.functions[HANDLER_FUNCTION_NAME].node_bundler).toBe('esbuild')
+  })
+
+  test('changes both bundlers if target is server and default is esbuild', () => {
+    const netlifyConfig = {
+      functions: {
+        '*': {
+          node_bundler: 'esbuild',
+        },
+      },
+    }
+    setBundler({ target: 'server', netlifyConfig })
+    expect(warn).toHaveBeenCalledWith(`esbuild is not supported for target=server. Setting to "zisi"`)
+    expect(netlifyConfig.functions[HANDLER_FUNCTION_NAME].node_bundler).toBe('zisi')
+    expect(netlifyConfig.functions[ODB_FUNCTION_NAME].node_bundler).toBe('zisi')
+  })
+
+  test('does not warn if default bundler is zisi and target is server', () => {
+    const netlifyConfig = {
+      functions: {
+        '*': {
+          node_bundler: 'zisi',
+        },
+      },
+    }
+    setBundler({ target: 'server', netlifyConfig })
+    expect(warn).not.toHaveBeenCalled()
+  })
+
+  test('changes both bundlers if default is undefined and both are esbuild', () => {
+    const netlifyConfig = {
+      functions: {
+        '*': {},
+        [HANDLER_FUNCTION_NAME]: {
+          node_bundler: 'esbuild',
+        },
+        [ODB_FUNCTION_NAME]: {
+          node_bundler: 'esbuild',
+        },
+      },
+    }
+    setBundler({ target: 'server', netlifyConfig })
+    expect(warn).toHaveBeenCalledWith(`esbuild is not supported for target=server. Setting to "zisi"`)
+
+    expect(netlifyConfig.functions[HANDLER_FUNCTION_NAME].node_bundler).toBe('zisi')
+    expect(netlifyConfig.functions[ODB_FUNCTION_NAME].node_bundler).toBe('zisi')
+  })
+
+  test('does not warn if default is esbuild but others are both zisi', () => {
+    const netlifyConfig = {
+      functions: {
+        '*': {
+          node_bundler: 'esbuild',
+        },
+        [HANDLER_FUNCTION_NAME]: {
+          node_bundler: 'zisi',
+        },
+        [ODB_FUNCTION_NAME]: {
+          node_bundler: 'zisi',
+        },
+      },
+    }
+    setBundler({ target: 'server', netlifyConfig })
+    expect(warn).not.toHaveBeenCalled()
+  })
+})