1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380
//! Lando provides building blocks for serverless HTTP Rust applications deployable on [AWS Lambda](https://aws.amazon.com/lambda/). //! //! Specifically, lando exposes [API Gateway](https://aws.amazon.com/api-gateway/) proxy events //! as standard Rust [http](https://crates.io/crates/http) types with API Gateway //! modeled [Bodies](enum.Body.html). For convenience, //! `lando` re-exports `http::Request` and `http::Response`. //! //! AWS Lambda is a ✨ **fully managed** ✨ compute service allowing you to run //! code without thinking about servers. AWS will provide [monitoring metrics](https://docs.aws.amazon.com/lambda/latest/dg/monitoring-functions.html) //! and [scaling](https://docs.aws.amazon.com/lambda/latest/dg/scaling.html) out of the box for you. //! //! Lando exports Rust functions as native CPython modules making it possible to embed //! handlers within AWS' [Python3.6 runtime](https://docs.aws.amazon.com/lambda/latest/dg/python-programming-model.html). //! //! # Usage //! //! Add `lando` to your `Cargo.toml` //! //! ```toml //! [dependencies] //! lando = "0.2" //! ``` //! //! Within your application's source, use lando's macros. //! //! ``` //! #[macro_use] //! extern crate lando; //! # fn main() { } //! ``` //! //! Write your function using the [gateway!](macro.gateway.html) macro. See //! it's documentation for more examples. //! //! ```rust //! # #[macro_use] extern crate lando; //! //! gateway!(|_request, context| { //! println!("👋 cloudwatch logs, this is {}", context.function_name()); //! // return a basic 200 response //! Ok(()) //! }); //! # fn main() { } //! ``` //! //! Alternatively, you can also just attribute a bare handler `fn` with `#[lando]` //! //! ```rust //! # #[macro_use] extern crate lando; //! use lando::{Request, LambdaContext, IntoResponse, Result}; //! //! #[lando] //! fn handler( //! _: Request, //! _: LambdaContext //! ) -> Result<impl IntoResponse> { //! Ok(()) //! } //! ``` //! //! # Packaging functions //! //! Lando targets AWS Lambda's Python3.6 runtime. The //! [gateway!](macro.gateway.html) macro does //! the all the integration for you, but cargo still needs //! to know what type of `lib` you are compiling. Cargo makes it easy to produce //! compatible binaries. //! //! Simply add the following setting to your crate's `Cargo.toml` file. //! //! ```toml //! [lib] //! crate-type = ["cdylib"] //! ``` //! //! 💡 `cdylib` produces dynamic library embeddable in other languages. This and other link formats are described [here](https://doc.rust-lang.org/reference/linkage.html) //! //! `cargo build` will then produce an AWS deploy-ready `liblambda.so` binary artifact on linux hosts. //! Package this file in a zip file and it's now deployable as an AWS Lambda function! //! Be sure to use the the Python 3.6 execution environment with the handler //! configured as `lib{your_crate_name}.handler`. //! //! Because you're building a dynamic library, other libraries that you're dynamically linking //! against need to also be in the Lambda execution environment. The easiest way to achive this is //! by building in an environment similar to Lambda's. [This Docker //! container](https://hub.docker.com/r/softprops/lambda-rust/) faithfully reproduces the AWS Lambda Python 3.6 runtime. //! #[cfg(test)] #[macro_use] extern crate pretty_assertions; extern crate base64; extern crate bytes; // in addition to cpython types we use its macros in our macro // py_module_initializer!, py_fn! // we export and pub use those so that consumers of this // need only have to declare one dependency #[doc(hidden)] pub extern crate cpython; #[doc(hidden)] pub use cpython::*; extern crate crowbar; extern crate failure; #[macro_use] extern crate failure_derive; // re-export for convenience pub extern crate http; extern crate paste; // re-export for use in gateway! macro #[doc(hidden)] pub use paste::item as paste_item; extern crate serde; #[macro_use] extern crate serde_derive; extern crate serde_json; extern crate serde_urlencoded; /// Export #[lando] proc macro pub extern crate lando_attr; pub use lando_attr::*; // Std use std::error::Error as StdError; use std::result::Result as StdResult; // Third Party use cpython::Python; #[doc(hidden)] pub use cpython::{PyObject, PyResult}; pub use crowbar::LambdaContext; // Ours mod body; mod ext; pub mod request; mod response; mod strmap; pub use body::Body; pub use ext::{PayloadError, RequestExt}; // for benches only! pub use request::GatewayRequest; pub use strmap::StrMap; /// A re-exported version of `http::Request` with a type /// parameter for body fixed to type [lando::Body](enum.Body.html) pub type Request = http::Request<Body>; /// A re-exported version of the `http::Response` type pub use http::Response; /// Result type for gateway functions pub type Result<T> = StdResult<T, Box<StdError>>; /// A conversion of self into a `Response` /// /// Implementations for `Response<B> where B: Into<Body>`, /// `B where B: Into<Body>` and `serde_json::Value` are provided /// /// # example /// /// ```rust /// use lando::{Body, IntoResponse, Response}; /// /// assert_eq!( /// "hello".into_response().body(), /// Response::new(Body::from("hello")).body() /// ); /// ``` pub trait IntoResponse { /// Return a translation of `self` into `Response<Body>` fn into_response(self) -> Response<Body>; } impl<B> IntoResponse for Response<B> where B: Into<Body>, { fn into_response(self) -> Response<Body> { let (parts, body) = self.into_parts(); Response::from_parts(parts, body.into()) } } impl<B> IntoResponse for B where B: Into<Body>, { fn into_response(self) -> Response<Body> { Response::new(self.into()) } } impl IntoResponse for serde_json::Value { fn into_response(self) -> Response<Body> { Response::builder() .header(http::header::CONTENT_TYPE, "application/json") .body( serde_json::to_string(&self) .expect("unable to serialize serde_json::Value") .into(), ) .expect("unable to build http::Response") } } // wrap crowbar handler in gateway handler // which works with http crate types lifting them into apigw types #[doc(hidden)] pub fn handler<F, R>( py: Python, func: F, py_event: PyObject, py_context: PyObject, ) -> PyResult<PyObject> where F: FnOnce(Request, LambdaContext) -> StdResult<R, Box<StdError>>, R: IntoResponse, { crowbar::handler( py, |event, ctx| { let apigw = serde_json::from_value::<request::GatewayRequest>(event)?; func(Request::from(apigw), ctx) .map(|into| response::GatewayResponse::from(into.into_response())) }, py_event, py_context, ) } /// A macro that exposes a Lambda function handler for AWS API gateway proxy event triggers. /// /// Lambda functions accept two arguments (the event, a [lando::Request](type.Request.html), and a context, a /// `LambdaContext`) and are expected to return a result containing [lando::Response](struct.Response.html). The function signature should look /// like: /// /// ``` /// # extern crate lando; /// # use lando::{Request, LambdaContext, Result, IntoResponse}; /// fn handler( /// request: Request, /// context: LambdaContext /// ) -> Result<impl IntoResponse> { /// // impl... /// # Ok("docs") /// } /// ``` /// /// To use this macro, you need the following `macro_use` declaration /// /// ``` /// #[macro_use] /// extern crate lando; /// # fn main() { } /// ``` /// /// # Examples /// /// You can export a lambda-ready function by wrapping a closure with `gateway!`: /// /// ```rust /// # #[macro_use] extern crate lando; /// # use lando::RequestExt; /// gateway!(|request, _| { /// Ok(lando::Response::new(format!( /// "hello {}", /// request /// .path_parameters() /// .get("name") /// .unwrap_or_else(|| "stranger") /// ))) /// }); /// # fn main() { } /// ``` /// /// You can also the provide `gateway!` macro with a function reference /// /// The `request` argument is just a regular `http::Request` type, /// extendable with API gateway features, like accessing path and query string parameters, and /// more by importing [lando::RequestExt`](trait.RequestExt.html) /// /// The context argument is [same type](struct.LambdaContext.html) defined within the crowbar crate. /// /// ```rust /// # #[macro_use] extern crate lando; /// /// use lando::{LambdaContext, Request, Result, IntoResponse}; /// /// fn handler( /// request: Request, /// context: LambdaContext /// ) -> Result<impl IntoResponse> { /// println!("{:?}", request); /// Ok("👍") /// } /// /// gateway!(handler); /// # fn main() { } /// ``` /// /// # Export multiple lambda functions in one library /// /// You can export multiple functions in the same module with a format similar to a `match` expression: /// /// ```rust /// # #[macro_use] extern crate lando; /// /// use lando::Response; /// /// gateway! { /// "one" => |request, context| { Ok(Response::new("1")) }, /// "two" => |request, context| { Ok(Response::new("2")) } /// } /// # fn main() { } /// ``` /// #[macro_export] macro_rules! gateway { (@module ($module:ident, $py2:ident, $py3:ident) @handlers ($($handler:expr => $target:expr),*)) => { py_module_initializer!($module, $py2, $py3, |py, m| { $( m.add(py, $handler, py_fn!( py, x( event: $crate::PyObject, context: $crate::PyObject ) -> $crate::PyResult<$crate::PyObject> { $crate::handler(py, $target, event, context) } ))?; )* Ok(()) }); }; (crate $module:tt { $($handler:expr => $target:expr),* }) => { gateway! { @module $module @handlers ($($handler => $target),*) } }; (crate $module:tt { $($handler:expr => $target:expr,)* }) => { gateway! { @module $module @handlers ($($handler => $target),*) } }; ($($handler:expr => $target:expr),*) => { // conventions required by cpython crate // https://dgrunwald.github.io/rust-cpython/doc/cpython/macro.py_module_initializer.html $crate::paste_item! { gateway! { @module ([<lib env!("CARGO_PKG_NAME")>],[<initlib env!("CARGO_PKG_NAME")>], [<PyInit_lib env!("CARGO_PKG_NAME")>]) @handlers ($($handler => $target),*) } } }; ($($handler:expr => $target:expr,)*) => { gateway! { $($handler => $target),* } }; ($f:expr) => { gateway! { "handler" => $f, } }; } #[cfg(test)] mod tests { use super::*; use serde_json::json; #[test] fn json_into_response() { let response = json!({ "hello": "lambda"}).into_response(); match response.body() { Body::Text(json) => assert_eq!(json, r#"{"hello":"lambda"}"#), _ => panic!("invalid body"), } assert_eq!( response .headers() .get(http::header::CONTENT_TYPE) .map(|h| h.to_str().expect("invalid header")), Some("application/json") ) } }