Merge pull request #1959 from serverless-heaven/feat/serverless-v4

Add support for Serverless v4

Author: j0k3r

.github/dependabot.yml

@@ -17,6 +17,10 @@ updates:
       - dependency-name: glob
         versions:
           - '>= 9.0.0'
+      # because tests aren't compatible
+      - dependency-name: serverless
+        versions:
+          - '>= 4.0.0'
   - package-ecosystem: github-actions
     directory: '/'
     schedule:

.github/workflows/tests.yml

@@ -132,3 +132,39 @@ jobs:
 
       - name: 'Run tests'
         run: 'npm run test'
+
+  serverless-v4:
+    runs-on: ${{ matrix.os }}
+    name: Node.js ${{ matrix.node }} on ${{ matrix.os }} with Serverless v4
+
+    strategy:
+      matrix:
+        os:
+          - ubuntu-20.04
+        node:
+          - '20'
+
+    steps:
+      - name: 'Checkout'
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 2
+
+      - name: 'Install Node.js'
+        uses: actions/setup-node@v4
+        with:
+          node-version: '${{ matrix.node }}'
+
+      - name: 'Install dependencies'
+        run: npm ci
+
+      - name: 'Install Serverless v4'
+        run: npm install serverless@4
+
+      - name: 'Run tests'
+        run: npm run test tests/e2e/e2e.test.js
+        env:
+          AWS_DEFAULT_REGION: eu-west-1
+          AWS_ACCESS_KEY_ID: ${{secrets.AWS_ACCESS_KEY_ID}}
+          AWS_SECRET_ACCESS_KEY: ${{secrets.AWS_SECRET_ACCESS_KEY}}
+          SERVERLESS_ACCESS_KEY: ${{secrets.SERVERLESS_ACCESS_KEY}}

README.md

@@ -49,6 +49,15 @@ plugins:
   - serverless-webpack
 ```
 
+## Serverless v4 requirement
+
+If you are using Serverless v4 you must disable the default builtin ESBuild support in your `serverless.yml` (because it conflicts with `serverless-webpack`):
+
+```yml
+build:
+  esbuild: false
+```
+
 ## Configure
 
 The configuration of the plugin is done by defining a `custom: webpack` object in your `serverless.yml` with your specific configuration. All settings are optional and will be set to reasonable defaults if missing.
@@ -184,8 +193,8 @@ module.exports = {
 
 `serverless-webpack` generates Webpack entries from the `handler` value by default.
 
-If your handler is different from the webpack entry, e.g. provided by a layer, 
-you may override the generated entry at function level via the `entrypoint` 
+If your handler is different from the webpack entry, e.g. provided by a layer,
+you may override the generated entry at function level via the `entrypoint`
 option in `serverless.yml`.
 
 ```yaml

examples/include-external-npm-packages-lock-file/_setup.js

@@ -1,5 +1,7 @@
 'use strict';
 
+// That file is only used by the e2e tests
+
 const path = require('path');
 
 module.exports = async (originalFixturePath, fixturePath, utils) => {

examples/include-external-npm-packages-with-yarn-workspaces/_setup.js

@@ -1,5 +1,7 @@
 'use strict';
 
+// That file is only used by the e2e tests
+
 const path = require('path');
 
 module.exports = async (originalFixturePath, fixturePath, utils) => {

examples/include-external-npm-packages/_setup.js

@@ -1,5 +1,7 @@
 'use strict';
 
+// That file is only used by the e2e tests
+
 const path = require('path');
 
 module.exports = async (originalFixturePath, fixturePath, utils) => {
@@ -18,5 +20,6 @@ module.exports = async (originalFixturePath, fixturePath, utils) => {
   ]);
 
   const command = /^win/.test(process.platform) ? 'yarn.cmd' : 'yarn';
+
   return utils.spawnProcess(command, ['install'], { cwd: __dirname });
 };

examples/serverless-v4/.babelrc

@@ -0,0 +1,12 @@
+{
+  "presets": [
+    [
+      "@babel/preset-env",
+      {
+        "targets": {
+          "node": "20"
+        }
+      }
+    ]
+  ]
+}

examples/serverless-v4/.gitignore

@@ -0,0 +1,3 @@
+node_modules
+.webpack
+.webpackCache

examples/serverless-v4/README.md

@@ -0,0 +1,5 @@
+You can try to invoke the function locally (be sure to `yarn install` before):
+
+```
+yarn serverless invoke local --function=hello --path=./event.json
+```

examples/serverless-v4/_setup.js

@@ -0,0 +1,25 @@
+'use strict';
+
+// That file is only used by the e2e tests
+
+const path = require('path');
+
+module.exports = async (originalFixturePath, fixturePath, utils) => {
+  const pluginPath = path.resolve(originalFixturePath, '..', '..');
+
+  const SLS_CONFIG_PATH = path.join(fixturePath, 'serverless.yml');
+  const WEBPACK_CONFIG_PATH = path.join(fixturePath, 'webpack.config.js');
+  const PACKAGE_JSON_PATH = path.join(fixturePath, 'package.json');
+  const LOCK_PATH = path.join(fixturePath, 'yarn.lock');
+
+  await Promise.all([
+    utils.replaceInFile(SLS_CONFIG_PATH, '- serverless-webpack', `- ${pluginPath}`),
+    utils.replaceInFile(WEBPACK_CONFIG_PATH, "'serverless-webpack'", `'${pluginPath}'`),
+    utils.replaceInFile(PACKAGE_JSON_PATH, 'file:../..', `file:${pluginPath}`),
+    utils.replaceInFile(LOCK_PATH, 'file:../..', `file:${pluginPath}`)
+  ]);
+
+  const command = /^win/.test(process.platform) ? 'yarn.cmd' : 'yarn';
+
+  return utils.spawnProcess(command, ['install'], { cwd: __dirname });
+};