Merge branch 'master' of github.com:softprops/serverless-rust into bin-target

Author: softprops

.travis.yml

@@ -2,6 +2,13 @@ language: node_js
 node_js:
   - "node"
 
+# only build pushes to master
+# prs are build separately
+# https://docs.travis-ci.com/user/pull-requests/#how-pull-requests-are-built
+branches:
+  only:
+  - master
+
 services:
   # start docker to enable lambda ci compatible build env
   - docker

CHANGELOG.md

@@ -1,37 +1,48 @@
+# ⚡ 0.2.2
+
+- bump [lambda-rust](https://hub.docker.com/r/softprops/lambda-rust/) docker version to 0.2.1-rust-1.32.0, fixing a bug where cargo binaries named `bootstrap` weren't getting packaged. Reminder: this plugin renames binaries to `bootstrap` for the lambda runtime for you. You don't have do to this manually in your Cargo configuration. This also introduces an effiency in the way binaries are identified for packaging that may help some windows users.
+- bump serverless version to [`1.37.1`](https://github.com/serverless/serverless/releases/tag/v1.37.1)
+
+
+# ⚡ 0.2.1
+
+- bump [lambda-rust](https://hub.docker.com/r/softprops/lambda-rust/) docker version to 0.2.0-rust-1.32.0, to make the new default Rust 1.32.0 (the latest release of Rust at this time)
+- bump serverless version to [`1.36.3`](https://github.com/serverless/serverless/releases/tag/v1.36.3)
+
 # ⚡ 0.2.0
 
-* Switch from supporting the Lambda `python3.6` runtime to a new ✨ `rust` runtime ✨ ( which runs on the `provided` runtime under the covers )
-* you can now deploy independent functions with `npx serverless deploy function -f func-name`
-* you no longer have to be explicit about function binary to include, this plugin generates and configures the artifact (zip) file for you
-* you no longer have to set default exclusion rules
-* you can deploy a `rust` runtime function side by side with other serverless runtime functions
-within the same service, to facilitate experimentation and learning.
+- Switch from supporting the Lambda `python3.6` runtime to a new ✨ `rust` runtime ✨ ( which runs on the `provided` runtime under the covers )
+- you can now deploy independent functions with `npx serverless deploy function -f func-name`
+- you no longer have to be explicit about function binary to include, this plugin generates and configures the artifact (zip) file for you
+- you no longer have to set default exclusion rules
+- you can deploy a `rust` runtime function side by side with other serverless runtime functions
+  within the same service, to facilitate experimentation and learning.
 
 # ⚡ 0.1.7
 
-* bump [lambda-rust](https://hub.docker.com/r/softprops/lambda-rust/) docker version to 0.1.0-rust-1.30.1, to make the new default Rust 1.30.1 (the latest release of Rust at this time)
-* bumb serverless version to [1.33.2](https://github.com/serverless/serverless/blob/master/CHANGELOG.md#1332-18112018) ( the latest serverless release at this time)
+- bump [lambda-rust](https://hub.docker.com/r/softprops/lambda-rust/) docker version to 0.1.0-rust-1.30.1, to make the new default Rust 1.30.1 (the latest release of Rust at this time)
+- bump serverless version to [1.33.2](https://github.com/serverless/serverless/blob/master/CHANGELOG.md#1332-18112018) ( the latest serverless release at this time)
 
 # ⚡ 0.1.6
 
-* bump [lambda-rust](https://hub.docker.com/r/softprops/lambda-rust/) docker version to 0.1.0-rust-1.28.0, to make the new default Rust 1.28.0 (the latest release of Rust at this time)
+- bump [lambda-rust](https://hub.docker.com/r/softprops/lambda-rust/) docker version to 0.1.0-rust-1.28.0, to make the new default Rust 1.28.0 (the latest release of Rust at this time)
 
 # ⚡ 0.1.5
 
-* ensure only a unique set of artifacts are collected for cleanup
-* Allocate a docker pseudo-tty so that process signals are forwarded (Keyboard interrupts stop docker process)
+- ensure only a unique set of artifacts are collected for cleanup
+- Allocate a docker pseudo-tty so that process signals are forwarded (Keyboard interrupts stop docker process)
 
 # ⚡ 0.1.4
 
-* bump [lambda-rust](https://hub.docker.com/r/softprops/lambda-rust/) docker version to 0.1.0-rust-1.27.2, to make the new default Rust 1.27.2 (the latest release of Rust at this time)
-* speed up deployments by ~3.2 seconds by disabling excludeDevDependencies. it's on by default but it's not useful for for Rust focused services
-* the `custom.rust` config object can be overrided at the function level
+- bump [lambda-rust](https://hub.docker.com/r/softprops/lambda-rust/) docker version to 0.1.0-rust-1.27.2, to make the new default Rust 1.27.2 (the latest release of Rust at this time)
+- speed up deployments by ~3.2 seconds by disabling excludeDevDependencies. it's on by default but it's not useful for for Rust focused services
+- the `custom.rust` config object can be overrided at the function level
 
 ```yaml
 functions:
   hello:
     rust:
-      cargoFlags: '--features ...'
+      cargoFlags: "--features ..."
     handler: liblambda.handler
     package:
       include:
@@ -42,17 +53,17 @@ functions:
 
 # ⚡ 0.1.3
 
-* bump lambda rust docker version to 0.1.0-rust-1.27.0
+- bump lambda rust docker version to 0.1.0-rust-1.27.0
 
 # ⚡ 0.1.2
 
-* bump lambda rust docker version to 0.1.0-rust-1.26.2
-* use a polyfill for fs.copyFileSync to accomidate older versions of node on travis ci
+- bump lambda rust docker version to 0.1.0-rust-1.26.2
+- use a polyfill for fs.copyFileSync to accomidate older versions of node on travis ci
 
 # ⚡ 0.1.1
 
-* fix exporting plugin
+- fix exporting plugin
 
 # ⚡ 0.1.0
 
-* initial release
+- initial release

README.md

@@ -39,6 +39,7 @@ functions:
           method: GET
 ```
 
+> 💡 The Rust Lambda runtime requires a binary named `bootstrap`. This plugin renames the binary cargo builds to `bootstrap` for you before packaging. You do not need to do this manually in your Cargo configuration.
 
 ## 🖍️ customize
 

index.js

@@ -1,34 +1,34 @@
-'use strict';
+"use strict";
 
 // https://serverless.com/blog/writing-serverless-plugins/
 // https://serverless.com/framework/docs/providers/aws/guide/plugins/
 // https://github.com/softprops/lambda-rust/
 
-const { spawnSync } = require('child_process');
-const path = require('path');
+const { spawnSync } = require("child_process");
+const path = require("path");
 
-const DEFAULT_DOCKER_TAG = '0.2.0-rust-1.31.0';
-const RUST_RUNTIME = 'rust';
-const BASE_RUNTIME = 'provided';
-const NO_OUTPUT_CAPTURE = { stdio: ['ignore', process.stdout, process.stderr] };
+const DEFAULT_DOCKER_TAG = "0.2.1-rust-1.32.0";
+const RUST_RUNTIME = "rust";
+const BASE_RUNTIME = "provided";
+const NO_OUTPUT_CAPTURE = { stdio: ["ignore", process.stdout, process.stderr] };
 
 /** assumes docker is on the host's execution path */
 class RustPlugin {
   constructor(serverless, options) {
-
     this.serverless = serverless;
     this.options = options;
-    this.servicePath = this.serverless.config.servicePath || '';
+    this.servicePath = this.serverless.config.servicePath || "";
     this.hooks = {
-      'before:package:createDeploymentArtifacts': this.build.bind(this),
-      'before:deploy:function:packageFunction': this.build.bind(this),
+      "before:package:createDeploymentArtifacts": this.build.bind(this),
+      "before:deploy:function:packageFunction": this.build.bind(this)
     };
     this.custom = Object.assign(
       {
         cargoFlags: "",
         dockerTag: DEFAULT_DOCKER_TAG
       },
-      this.serverless.service.custom && this.serverless.service.custom.rust || {}
+      (this.serverless.service.custom && this.serverless.service.custom.rust) ||
+        {}
     );
 
     // By default, Serverless examines node_modules to figure out which
@@ -53,41 +53,37 @@ class RustPlugin {
     let cargoFlags = (funcArgs || {}).cargoFlags || this.custom.cargoFlags;
     if (cargoPackage != undefined) {
       if (cargoFlags) {
-        cargoFlags = `${cargoFlags} -p ${cargoPackage}`
+        cargoFlags = `${cargoFlags} -p ${cargoPackage}`;
       } else {
         cargoFlags = ` -p ${cargoPackage}`;
       }
     }
     if (cargoFlags) {
       // --features awesome-feature, ect
-      customArgs.push('-e', `CARGO_FLAGS=${cargoFlags}`);
-    };
+      customArgs.push("-e", `CARGO_FLAGS=${cargoFlags}`);
+    }
     const dockerTag = (funcArgs || {}).dockerTag || this.custom.dockerTag;
     return spawnSync(
-      'docker',
-      [
-        ...defaultArgs,
-        ...customArgs,
-        `softprops/lambda-rust:${dockerTag}`
-      ],
+      "docker",
+      [...defaultArgs, ...customArgs, `softprops/lambda-rust:${dockerTag}`],
       NO_OUTPUT_CAPTURE
     );
   }
 
   functions() {
     if (this.options.function) {
-        return [this.options.function];
+      return [this.options.function];
     } else {
-        return this.serverless.service.getAllFunctions();
+      return this.serverless.service.getAllFunctions();
     }
   }
 
   build() {
     const service = this.serverless.service;
-    if (service.provider.name != 'aws') {
+    if (service.provider.name != "aws") {
       return;
     }
-    let rustFunctionsFound = false
+    let rustFunctionsFound = false;
     this.functions().forEach(funcName => {
       const func = service.getFunction(funcName);
       const runtime = func.runtime || service.provider.runtime;
@@ -96,14 +92,18 @@ class RustPlugin {
         return;
       }
       rustFunctionsFound = true;
-      let [cargoPackage, binary] = func.handler.split('.');
+      let [cargoPackage, binary] = func.handler.split(".");
       if (binary == undefined) {
         binary = cargoPackage;
       }
       this.serverless.cli.log(`Building native Rust ${func.handler} func...`);
       const res = this.runDocker(func.rust, cargoPackage, binary);
       if (res.error || res.status > 0) {
-        this.serverless.cli.log(`Dockerized Rust build encountered an error: ${res.error} ${res.status}.`);
+        this.serverless.cli.log(
+          `Dockerized Rust build encountered an error: ${res.error} ${
+            res.status
+          }.`
+        );
         throw new Error(res.error);
       }
       // If all went well, we should now have find a packaged compiled binary under `target/lambda/release`.
@@ -115,26 +115,26 @@ class RustPlugin {
       // we leverage the ability to declare a package artifact directly
       // see https://serverless.com/framework/docs/providers/aws/guide/packaging/
       // for more information
-      const artifactPath =  path.join('target/lambda/release', binary + ".zip")
+      const artifactPath = path.join("target/lambda/release", binary + ".zip");
       func.package = func.package || {};
       func.package.artifact = artifactPath;
 
       // Ensure the runtime is set to a sane value for other plugins
       if (func.runtime == RUST_RUNTIME) {
-        func.runtime = BASE_RUNTIME
+        func.runtime = BASE_RUNTIME;
       }
-    })
+    });
     if (service.provider.runtime === RUST_RUNTIME) {
       service.provider.runtime = BASE_RUNTIME;
     }
     if (!rustFunctionsFound) {
       throw new Error(
         `Error: no Rust functions found. ` +
-        `Use 'runtime: ${RUST_RUNTIME}' in global or ` +
-        `function configuration to use this plugin.`
+          `Use 'runtime: ${RUST_RUNTIME}' in global or ` +
+          `function configuration to use this plugin.`
       );
     }
   }
 }
 
-module.exports = RustPlugin;
+module.exports = RustPlugin;