serverless-plugin-go 0.0.1 → 0.0.3

package/.cz.toml

@@ -1,7 +1,7 @@
 [tool]
 [tool.commitizen]
 name = "cz_customize"
-version = "0.0.1"
+version = "0.0.3"
 tag_format = "v$version"
 bump_message = "bump: release $current_version → $new_version [skip-ci]"
 update_changelog_on_bump = true

package/CHANGELOG.md

@@ -1,3 +1,13 @@
+## v0.0.3 (2024-08-19)
+
+
+- deps: resolve vulnerabilities (#7)
+
+## v0.0.2 (2023-11-16)
+
+
+- fix: concurrency overhead (#6)
+
 ## v0.0.1 (2023-10-26)
 
 

package/README.md

@@ -42,11 +42,24 @@ Default values:
 ```yaml
 custom:
   go:
-    baseDir: '.' # folder where go.mod file lives, if set `handler` property should be set relatively to that folder
-    binDir: '.bin' # target folder for binary files
-    cmd: 'go build -ldflags="-s -w"' # compile command
-    monorepo: false # if enabled, builds function every directory (useful for monorepo where go.mod is managed by each function
-    env: # environment variables used to compile binaries
+    # folder where go.mod file lives, if set `handler` property should be set relatively to that folder
+    baseDir: '.'
+
+    # Final target destination of the binary outputs
+    binDir: '.bin'
+
+    # Compile command that should be used to build binaries
+    cmd: 'go build -ldflags="-s -w"'
+
+    # If enabled, builds function every directory (useful for monorepo where go.mod is managed by each function
+    monorepo: false
+
+    # Number of concurrent process used to compile functions, you can fine tune this number to your needs.
+    # Alternatively you can use the env var `SP_GO_CONCURRENCY` to override this configuration
+    concurrency: 5
+
+    # Environment variables used to compile binaries
+    env:
       GOOS: 'linux' # Default compile OS
       CGO_ENABLED: '0' # By default CGO is disabled
 ```

package/index.js

@@ -3,6 +3,7 @@ import cp from "child_process";
 import prettyHrtime from "pretty-hrtime";
 import chalk from "chalk";
 import path from "path";
+import plimit from "p-limit";
 import AdmZip from "adm-zip";
 import { readFileSync } from "fs";
 
@@ -29,8 +30,11 @@ export default class Go {
       },
       cmd: 'go build -ldflags="-s -w"',
       monorepo: false,
+      concurrency: 5,
     };
 
+    this.config = this.getConfig();
+
     this.hooks = {
       "before:deploy:function:packageFunction": this.compileFunction.bind(this),
       "before:package:createDeploymentArtifacts":
@@ -81,12 +85,14 @@ export default class Go {
 
     const timeStart = process.hrtime();
 
-    let compiles = [];
+    this.logDebug(`using concurrency limit ${this.config.concurrency}...`);
+
+    const limit = plimit(this.config.concurrency);
 
-    for (let funcName of names) {
+    let compiles = names.map((funcName) => {
       const func = this.serverless.service.functions[funcName];
-      compiles.push(this.compile(funcName, func));
-    }
+      return limit(() => this.compile(funcName, func));
+    });
 
     await Promise.all(compiles);
 
@@ -122,7 +128,7 @@ export default class Go {
    * @throws {Error} if compilation command fails
    */
   async compile(name, func, artifact = true) {
-    const config = this.getConfig();
+    const config = this.config;
     const arch = this.getFunctionArch(name);
     const runtime = this.getFunctionRuntime(name);
 
@@ -240,6 +246,9 @@ export default class Go {
       config.env[env] = `${config.env[env]}`;
     }
 
+    config.concurrency =
+      parseInt(process.env.SP_GO_CONCURRENCY) || config.concurrency;
+
     return config;
   }
 

package/index.test.js

@@ -324,7 +324,7 @@ describe("Go Plugin", () => {
     );
   });
 
-  it("compiles Go functions", async () => {
+  it("Compiles Go functions", async () => {
     config.service.setFunctions({
       testFunc1: {
         name: "testFunc1",
@@ -346,4 +346,58 @@ describe("Go Plugin", () => {
       `.bin/testFunc1`,
     );
   });
+
+  it("Should get concurrency config", async () => {
+    config.service.setFunctions({
+      testFunc1: {
+        name: "testFunc1",
+        runtime: "provided.al2",
+        handler: "functions/func2/main.go",
+      },
+    });
+
+    const plugin = new Go(config);
+
+    expect(plugin.config.concurrency).to.be.equal(
+      plugin.defaultConfig.concurrency,
+    );
+  });
+
+  it("Should get concurrency from env vars", async () => {
+    config.service.setFunctions({
+      testFunc1: {
+        name: "testFunc1",
+        runtime: "provided.al2",
+        handler: "functions/func2/main.go",
+      },
+    });
+
+    process.env["SP_GO_CONCURRENCY"] = "10";
+
+    const plugin = new Go(config);
+
+    expect(plugin.config.concurrency).to.be.equal(10);
+
+    delete process.env["SP_GO_CONCURRENCY"];
+  });
+
+  it("Should get default concurrency if env var can't be parsed", async () => {
+    config.service.setFunctions({
+      testFunc1: {
+        name: "testFunc1",
+        runtime: "provided.al2",
+        handler: "functions/func2/main.go",
+      },
+    });
+
+    process.env["SP_GO_CONCURRENCY"] = "something";
+
+    const plugin = new Go(config);
+
+    expect(plugin.config.concurrency).to.be.equal(
+      plugin.defaultConfig.concurrency,
+    );
+
+    delete process.env["SP_GO_CONCURRENCY"];
+  });
 });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "serverless-plugin-go",
-  "version": "0.0.1",
+  "version": "0.0.3",
   "type": "module",
   "description": "Serverless Framework plugin that compiles Go functions on the fly",
   "main": "index.js",
@@ -41,6 +41,7 @@
   "dependencies": {
     "adm-zip": "^0.5.10",
     "chalk": "^5.3.0",
+    "p-limit": "^5.0.0",
     "pretty-hrtime": "^1.0.3",
     "util": "^0.12.5"
   },