add v4 migration

Author: sid88in

e2e/README.md

@@ -21,9 +21,15 @@ runs `serverless package` to produce a CloudFormation template, and
 asserts on the generated resources.
 
 Critically, **these tests do not deploy anything to AWS** — they only
-exercise the synthesis path. That makes them fast (~3s per fixture),
-fork-safe (no AWS credentials required), and suitable to run on every
-PR.
+exercise the synthesis path. That makes them fast (~3s per fixture)
+and suitable to run on every PR. No AWS credentials are required.
+
+> **Serverless Framework v4 requires authentication.** As of v4, every
+> CLI invocation (including the `serverless package` these tests run)
+> must be authenticated, even though nothing is deployed. You need a
+> Serverless **Access Key** or **License Key** — free for individual
+> developers and organizations under the revenue threshold. See
+> [Authentication](#authentication-serverless-v4) below.
 
 ## Running locally
 
@@ -38,6 +44,24 @@ npm run test:all
 npx jest --config jest.e2e.config.ts basic-api-key
 ```
 
+### Authentication (Serverless v4)
+
+Set a Serverless Access Key (or License Key) before running, otherwise
+the spawned `serverless package` will fail / prompt for login:
+
+```bash
+# One-time interactive login (writes a key to your machine)
+npx serverless login
+
+# …or set an explicit key for this shell / CI
+export SERVERLESS_ACCESS_KEY=...   # from Dashboard > Settings > Access Keys
+# or
+export SERVERLESS_LICENSE_KEY=...
+```
+
+The harness passes the current environment through to the CLI, so any
+of the above is sufficient.
+
 ## Adding a new test
 
 1. Create a new example under `examples/<feature>/`:
@@ -90,3 +114,7 @@ A dedicated `e2e` job in `.github/workflows/ci.yml` runs the full
 synthesis test suite on every PR and push to `master` or `alpha`. It
 runs after the unit-test matrix completes successfully (no point
 running E2E if unit tests already failed).
+
+The job reads `SERVERLESS_ACCESS_KEY` from repository secrets to
+authenticate the Serverless v4 CLI. Add it under
+**Settings > Secrets and variables > Actions** before this job can pass.

e2e/helpers/synthesize.ts

@@ -93,14 +93,33 @@ export function synthesize(exampleDir: string): SynthesizeResult {
     );
   }
 
-  const templatePath = path.join(
+  // Serverless writes the synthesized template as
+  // `cloudformation-template-update-stack.json`. We look it up defensively
+  // (preferring the canonical name, then falling back to any
+  // `cloudformation-template-*-stack.json`) so the harness is resilient to
+  // any path/name nuance across Serverless Framework major versions.
+  const canonical = path.join(
     packageDir,
     'cloudformation-template-update-stack.json',
   );
+  let templatePath = canonical;
+  if (!fs.existsSync(templatePath)) {
+    const fallback = fs
+      .readdirSync(packageDir)
+      .find(
+        (f) =>
+          /^cloudformation-template-.*-stack\.json$/.test(f) &&
+          f.endsWith('.json'),
+      );
+    if (fallback) {
+      templatePath = path.join(packageDir, fallback);
+    }
+  }
   if (!fs.existsSync(templatePath)) {
     fs.rmSync(packageDir, { recursive: true, force: true });
     throw new Error(
-      `CloudFormation template was not produced at ${templatePath}.`,
+      `CloudFormation template was not produced in ${packageDir} ` +
+        `(expected ${canonical} or a cloudformation-template-*-stack.json).`,
     );
   }
 

package.json

@@ -14,7 +14,8 @@
     "test:watch": "jest src/__tests__/.*\\.test\\.ts --watch",
     "test:e2e": "npm run build && jest --config jest.e2e.config.ts",
     "test:all": "npm run test && npm run test:e2e",
-    "build": "tsc",
+    "build": "tsc && npm run verify:imports",
+    "verify:imports": "node scripts/check-no-serverless-deep-imports.js",
     "lint": "eslint . && tsc --noEmit",
     "lint:fix": "eslint . --fix",
     "prepare": "husky && rm -rf lib & npm run build"
@@ -40,7 +41,7 @@
     "lint-staged": "^16.2.3",
     "prettier": "^2.8.0",
     "semantic-release": "^25.0.3",
-    "serverless": "^3.25.1",
+    "serverless": "^4.0.0",
     "ts-jest": "^29.4.11",
     "ts-node": "^10.9.1",
     "typescript": "~4.9.5"
@@ -71,7 +72,7 @@
     "terminal-link": "^2.1.1"
   },
   "peerDependencies": {
-    "serverless": ">=3.0.0"
+    "serverless": "^4.0.0"
   },
   "lint-staged": {
     "*.{ts,js}": [

scripts/check-no-serverless-deep-imports.js

@@ -0,0 +1,59 @@
+#!/usr/bin/env node
+/**
+ * Guard against regressing issue #632.
+ *
+ * Serverless Framework v4's `serverless` npm package is a thin installer with
+ * no `lib/` directory, so any runtime `require('serverless/lib/...')` in our
+ * compiled output throws `Cannot find module 'serverless/lib/...'` on v4.
+ *
+ * We intentionally only reference Serverless internals via `import type`
+ * (erased at compile time) or via the injected `serverless`/`utils` objects.
+ * This script fails the build if a deep runtime require ever sneaks into the
+ * emitted `lib/` output.
+ */
+'use strict';
+/* eslint-disable @typescript-eslint/no-var-requires -- Node CJS tooling script */
+
+const fs = require('fs');
+const path = require('path');
+
+const LIB_DIR = path.resolve(__dirname, '..', 'lib');
+// Matches `require('serverless/lib/...')` / `require("serverless/lib/...")`.
+const FORBIDDEN = /require\(\s*['"]serverless\/lib\//;
+
+/** @param {string} dir @returns {string[]} */
+function collectJsFiles(dir) {
+  /** @type {string[]} */
+  const out = [];
+  for (const entry of fs.readdirSync(dir, { withFileTypes: true })) {
+    const full = path.join(dir, entry.name);
+    if (entry.isDirectory()) out.push(...collectJsFiles(full));
+    else if (entry.isFile() && full.endsWith('.js')) out.push(full);
+  }
+  return out;
+}
+
+if (!fs.existsSync(LIB_DIR)) {
+  console.error(
+    `[check-no-serverless-deep-imports] lib/ not found at ${LIB_DIR}. Run \`npm run build\` first.`,
+  );
+  process.exit(1);
+}
+
+const offenders = collectJsFiles(LIB_DIR).filter((file) =>
+  FORBIDDEN.test(fs.readFileSync(file, 'utf8')),
+);
+
+if (offenders.length > 0) {
+  console.error(
+    '[check-no-serverless-deep-imports] Forbidden runtime require of ' +
+      "'serverless/lib/...' found in compiled output (this reintroduces #632 " +
+      'on Serverless v4). Use `import type` instead:\n' +
+      offenders.map((f) => `  - ${path.relative(LIB_DIR, f)}`).join('\n'),
+  );
+  process.exit(1);
+}
+
+console.log(
+  '[check-no-serverless-deep-imports] OK — no deep serverless/lib requires in lib/.',
+);

src/index.ts

@@ -1,5 +1,11 @@
-import Serverless from 'serverless/lib/Serverless';
-import Provider from 'serverless/lib/plugins/aws/provider.js';
+// NOTE: these MUST stay `import type`. They reference internal Serverless
+// paths that exist in v3 but NOT in the Serverless v4 npm package (v4 ships a
+// thin installer with no `lib/` tree). `import type` is fully erased at
+// compile time, so it never becomes a runtime `require('serverless/lib/...')`.
+// A plain `import` here is what caused issue #632
+// (`Cannot find module 'serverless/lib/serverless-error'`) on v4.
+import type Serverless from 'serverless/lib/Serverless';
+import type Provider from 'serverless/lib/plugins/aws/provider.js';
 import { forEach, last, merge } from 'lodash';
 import { getAppSyncConfig } from './getAppSyncConfig';
 import { GraphQLError } from 'graphql';
@@ -31,7 +37,7 @@ import {
   ListApiKeysRequest,
   ListApiKeysResponse,
 } from 'aws-sdk/clients/appsync';
-import {
+import type {
   CommandsDefinition,
   Hook,
   VariablesSourcesDefinition,