fix internal Serverless custom resources S3 path addressing (#209)

bentsku · web-flow · commit 23570e1b7e9f · 2023-02-13T19:39:20.000+01:00
diff --git a/README.md b/README.md
@@ -205,6 +205,7 @@ custom:
 
 ## Change Log
 
+* v1.0.3: Set S3 Path addressing for internal Serverless Custom Resources - allow configuring S3 Events Notification for functions
 * v1.0.2: Add check to prevent IPv6 connection issue with `localhost` on MacOS
 * v1.0.1: Add support for Serverless projects with esbuild source config; enable config via environment variables
 * v1.0.0: Allow specifying path for mountCode, to point to a relative Lambda mount path
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "serverless-localstack",
-  "version": "1.0.2",
+  "version": "1.0.3",
   "description": "Connect Serverless to LocalStack!",
   "main": "src/index.js",
   "scripts": {
@@ -25,14 +25,16 @@
     "Waldemar Hummer (whummer)",
     "Justin McCormick <me@justinmccormick.com>",
     "djKooks",
-    "yohei1126"
+    "yohei1126",
+    "bentsku"
   ],
   "license": "MIT",
   "bugs": {
     "url": "https://github.com/localstack/serverless-localstack/issues"
   },
   "homepage": "https://github.com/localstack/serverless-localstack",
   "dependencies": {
+    "adm-zip": "^0.5.10",
     "aws-sdk": "^2.402.0",
     "es6-promisify": "^6.0.1"
   },
diff --git a/src/index.js b/src/index.js
@@ -1,4 +1,5 @@
 'use strict';
+const AdmZip = require("adm-zip");
 const AWS = require('aws-sdk');
 const fs = require('fs');
 const path = require('path');
@@ -49,6 +50,11 @@ class LocalstackPlugin {
     // Add a hook to fix TypeError when accessing undefined state attribute
     this.addHookInFirstPosition('before:aws:deploy:deploy:checkForChanges', this.beforeDeployCheckForChanges);
 
+    const compileEventsHooks = this.serverless.pluginManager.hooks['package:compileEvents'] || [];
+    compileEventsHooks.push({
+      pluginName: 'LocalstackPlugin', hook: this.patchCustomResourceLambdaS3ForcePathStyle.bind(this)
+    });
+
     this.awsServices = [
       'acm',
       'amplify',
@@ -731,7 +737,63 @@ class LocalstackPlugin {
       plugin.display = newDisplay;
     }
   }
+  patchCustomResourceLambdaS3ForcePathStyle () {
+    const awsProvider = this.awsProvider;
+    const patchMarker = path.join(
+      awsProvider.serverless.serviceDir,
+      '.serverless',
+      '.internal-custom-resources-patched'
+    );
+    const zipFilePath = path.join(
+      awsProvider.serverless.serviceDir,
+      '.serverless',
+      awsProvider.naming.getCustomResourcesArtifactName()
+    );
+
+    function fileExists (filePath) {
+      try {
+        const stats = fs.statSync(filePath);
+        return stats.isFile();
+      } catch (e) {
+        return false;
+      }
+    }
+
+    function createPatchMarker () {
+      try {
+        fs.open(patchMarker, 'a').close()
+      } catch (err) {
+        return;
+      }
+    }
+
+    if (fileExists(patchMarker)) {
+      this.debug("serverless-localstack: Serverless internal CustomResources already patched")
+      return;
+    }
+
+    const customResourceZipExists = fileExists(zipFilePath)
 
+    if (!customResourceZipExists) {
+      return;
+    }
+
+    const customResources = new AdmZip(zipFilePath);
+    const utilFile = customResources.getEntry('utils.js')
+    if (utilFile == null) return;
+    const data = utilFile.getData().toString()
+    const patch = "AWS.config.s3ForcePathStyle = true;"
+    if (data.includes(patch)) {
+      createPatchMarker()
+      return;
+    }
+    const indexPatch = data.indexOf('AWS.config.logger = console;')
+    const newData = data.slice(0, indexPatch) + patch + '\n' + data.slice(indexPatch)
+    utilFile.setData(newData)
+    customResources.writeZip()
+    createPatchMarker()
+    this.debug('serverless-localstack: Serverless internal CustomResources patched')
+  }
 }
 
 module.exports = LocalstackPlugin;
