fix: support for serverless framework v2 (#95)

activescott · web-flow · commit b34054baa85c · 2021-07-28T01:53:32.000-07:00
* update plugin implementation work with serverless v2 by not registering an explicit deploy command (🤦‍♂️, fixes #92) * continues to work with serverless framework v1.x * update examples to use serverless framework v2 and to pull the latest version of the plugin * added end-to-end test to validate successful deploy
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -2,7 +2,7 @@ name: build
 
 on:
   push:
-    branches: [main]
+    branches: [main, beta, next]
   pull_request:
     branches: [main]
 
@@ -25,7 +25,7 @@ jobs:
         run: |
           npm run lint
 
-  build_and_test:
+  unit_tests:
     runs-on: ubuntu-20.04
     strategy:
       matrix:
@@ -37,6 +37,7 @@ jobs:
         uses: actions/setup-node@v2
         with:
           node-version: ${{ matrix.node }}
+          cache: "npm"
 
       - name: install dependencies
         run: |
@@ -55,8 +56,8 @@ jobs:
           flag-name: nodejs-${{ matrix.node }}
           parallel: true
 
-  finish_tests:
-    needs: build_and_test
+  update_code_coverage:
+    needs: unit_tests
     runs-on: ubuntu-20.04
     steps:
       - name: Coveralls Finished
@@ -65,8 +66,90 @@ jobs:
           github-token: ${{ secrets.GITHUB_TOKEN }}
           parallel-finished: true
 
+  e2e_tests:
+    needs: unit_tests
+    runs-on: ubuntu-20.04
+    steps:
+      - uses: actions/checkout@v1
+
+      - name: Use Node.js v12.x
+        uses: actions/setup-node@v1
+        with:
+          node-version: v12.x
+
+      #- name: debug deploy_package
+      #  uses: actions/bin/debug@master
+      - name: build plugin locally
+        run: |
+          cd "$GITHUB_WORKSPACE"
+          npm i
+          npm pack
+
+      - name: prepare to run end-to-end deploy test
+        env:
+          AWS_KEY_ID: ${{ secrets.AWS_KEY_ID }}
+          AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
+        run: |
+          cd "$GITHUB_WORKSPACE/examples/basic"
+          npm i
+          # now update to use the local plugin built above
+          npm install --save file://../../serverless-aws-static-file-handler-0.0.0.tgz
+          ./node_modules/.bin/serverless config credentials --provider aws --key $AWS_KEY_ID --secret $AWS_SECRET_ACCESS_KEY --profile serverless --overwrite
+
+      - name: run end-to-end deploy and test endpoints
+        run: |
+          cd "$GITHUB_WORKSPACE/examples/basic"
+          npm run deploy
+          # get the APIG endpoint URL:
+          APIG_URL=$(./node_modules/.bin/serverless info --aws-profile serverless | sed -nr 's#^.*(https://.+/dev)/png$#\1#p')
+
+          # CURL to some known good endpoints expecting 200:
+          function TEST_HTTP ()
+            {
+              URL_PATH=$1
+              if [[ -z "$URL_PATH" ]]; then
+                echo "path not specified"
+                return 1
+              fi
+              EXPECT_CODE=$2
+              if [[ -z "$EXPECT_CODE" ]]; then
+                EXPECT_CODE=200
+              fi
+
+              HTTP_CODE=$(curl -s -w '%{http_code}' --compressed --output /dev/null "$APIG_URL/$URL_PATH")
+              if [[ "$HTTP_CODE" = "$EXPECT_CODE" ]]; then
+                echo "/$URL_PATH succeeded (returned expected code $HTTP_CODE)"
+              else
+                echo "FAILURE: Expected /$URL_PATH to have code $EXPECT_CODE but it was $HTTP_CODE"
+                exit $HTTP_CODE
+              fi
+            }
+
+          # 200; these all should succeed
+          TEST_HTTP png
+          TEST_HTTP jpg
+          TEST_HTTP binary/glyphicons-halflings-regular.woff2
+          TEST_HTTP binary/subdir/png.png
+
+          # 403
+          TEST_HTTP "ff404.png" 403
+          TEST_HTTP "jpeg404.jpg" 403
+          TEST_HTTP "subdir404/ff.png" 403
+          TEST_HTTP "subdir/ff404.png" 403
+
+          # 404
+          TEST_HTTP "binary/404-glyphicons-halflings-regular.woff2" 404
+          TEST_HTTP "binary/subdir/404-png.png" 404
+
+      - name: destroy serverless stack
+        # Run this step even if the prior one failed (to clean up)
+        if: ${{ always() }}
+        run: |
+          cd "$GITHUB_WORKSPACE/examples/basic"
+          npm run destroy
+
   deploy_package:
-    needs: finish_tests
+    needs: e2e_tests
     runs-on: ubuntu-20.04
     steps:
       - uses: actions/checkout@v1
diff --git a/.gitignore b/.gitignore
@@ -65,4 +65,6 @@ examples/basic/.serverless
 /junk.js
 /todo.md
 
-.serverless/
+.serverless/
+
+.DS_Store
diff --git a/examples/basic/package.json b/examples/basic/package.json
@@ -11,9 +11,9 @@
     "reset": "rm -rfd ./node_modules/ && npm i && npm run deploy"
   },
   "devDependencies": {
-    "serverless": "^1.46.1"
+    "serverless": "^2.52.1"
   },
   "dependencies": {
-    "serverless-aws-static-file-handler": "=2.0.8"
+    "serverless-aws-static-file-handler": ">=3.0.2-beta.1"
   }
 }
diff --git a/examples/basic/serverless.yml b/examples/basic/serverless.yml
@@ -13,6 +13,7 @@ custom:
 provider:
   name: aws
   runtime: nodejs14.x
+  lambdaHashingVersion: 20201221
 
 functions:
   html:
diff --git a/examples/serverless-offline/package.json b/examples/serverless-offline/package.json
@@ -10,10 +10,10 @@
     "reset": "rm -rfd ./node_modules/ && npm i && npm run deploy"
   },
   "devDependencies": {
-    "serverless": "^1.46.1",
+    "serverless": "^2.52.1",
     "serverless-offline": "^7.0.0"
   },
   "dependencies": {
-    "serverless-aws-static-file-handler": "=2.0.8"
+    "serverless-aws-static-file-handler": ">=3.0.2-beta.1"
   }
 }
diff --git a/examples/serverless-offline/serverless.yml b/examples/serverless-offline/serverless.yml
@@ -14,6 +14,7 @@ custom:
 provider:
   name: aws
   runtime: nodejs14.x
+  lambdaHashingVersion: 20201221
 
 functions:
   html:
diff --git a/package.json b/package.json
@@ -41,6 +41,9 @@
     "serverless": "^2.46.0",
     "sinon": "^10.0.0"
   },
+  "peerDependencies": {
+    "serverless": "^2.46.0 || ^1.46.1"
+  },
   "engines": {
     "node": ">=10"
   },
diff --git a/src/plugins/BinaryMediaTypes.js b/src/plugins/BinaryMediaTypes.js
@@ -10,11 +10,6 @@ class BinaryMediaTypes {
     this.serverless = serverless
     this.options = options
     this.provider = this.serverless.getProvider("aws")
-    this.commands = {
-      deploy: {
-        lifecycleEvents: ["resources"],
-      },
-    }
     this.hooks = {
       "package:compileEvents": this.packageCompileEvents.bind(this),
     }
@@ -65,6 +60,7 @@ class BinaryMediaTypes {
   }
 
   packageCompileEvents() {
+    this.log("Preparing to add binary media types (package:compileEvents)...")
     const restApi = this.getRestApi()
     this.addBinaryMediaTypes(restApi)
   }
diff --git a/src/test/BinaryMediaTypes.js b/src/test/BinaryMediaTypes.js
@@ -78,9 +78,9 @@ describe("BinaryMediaTypes", function () {
       p.serverless.service.provider.compiledCloudFormationTemplate.Resources = []
       const hook = getHook(p)
       expect(hook).to.not.throw()
-      expect(logSpy.callCount).to.equal(1)
+      expect(logSpy.callCount).to.equal(2)
       expect(
-        logSpy.calledOnceWithExactly(
+        logSpy.calledWithExactly(
           sinon.match(
             /Amazon API Gateway RestApi resource not found. No BinaryMediaTypes will be added.$/
           )

Original file line number	Diff line number	Diff line change
`@@ -11,9 +11,9 @@`
`11`	`11`	`"reset": "rm -rfd ./node_modules/ && npm i && npm run deploy"`
`12`	`12`	`},`
`13`	`13`	`"devDependencies": {`
`14`		`- "serverless": "^1.46.1"`
	`14`	`+ "serverless": "^2.52.1"`
`15`	`15`	`},`
`16`	`16`	`"dependencies": {`
`17`		`- "serverless-aws-static-file-handler": "=2.0.8"`
	`17`	`+ "serverless-aws-static-file-handler": ">=3.0.2-beta.1"`
`18`	`18`	`}`
`19`	`19`	`}`
Original file line number	Diff line number	Diff line change
`@@ -10,10 +10,10 @@`
`10`	`10`	`"reset": "rm -rfd ./node_modules/ && npm i && npm run deploy"`
`11`	`11`	`},`
`12`	`12`	`"devDependencies": {`
`13`		`- "serverless": "^1.46.1",`
	`13`	`+ "serverless": "^2.52.1",`
`14`	`14`	`"serverless-offline": "^7.0.0"`
`15`	`15`	`},`
`16`	`16`	`"dependencies": {`
`17`		`- "serverless-aws-static-file-handler": "=2.0.8"`
	`17`	`+ "serverless-aws-static-file-handler": ">=3.0.2-beta.1"`
`18`	`18`	`}`
`19`	`19`	`}`
Original file line number	Diff line number	Diff line change
`@@ -10,11 +10,6 @@ class BinaryMediaTypes {`
`10`	`10`	`this.serverless = serverless`
`11`	`11`	`this.options = options`
`12`	`12`	`this.provider = this.serverless.getProvider("aws")`
`13`		`- this.commands = {`
`14`		`- deploy: {`
`15`		`- lifecycleEvents: ["resources"],`
`16`		`- },`
`17`		`- }`
`18`	`13`	`this.hooks = {`
`19`	`14`	`"package:compileEvents": this.packageCompileEvents.bind(this),`
`20`	`15`	`}`
`@@ -65,6 +60,7 @@ class BinaryMediaTypes {`
`65`	`60`	`}`
`66`	`61`
`67`	`62`	`packageCompileEvents() {`
	`63`	`+ this.log("Preparing to add binary media types (package:compileEvents)...")`
`68`	`64`	`const restApi = this.getRestApi()`
`69`	`65`	`this.addBinaryMediaTypes(restApi)`
`70`	`66`	`}`