Merge remote-tracking branch 'upstream/main'

Author: s0l0ist

.github/actions/rust-build/action.yml

@@ -7,6 +7,10 @@ inputs:
   toolchain:
     required: true
     description: "the Rust toolchain to use"
+  run-tests:
+    required: true
+    default: true
+    description: "whether to run tests in addition to building"
 
 runs:
   using: "composite"
@@ -22,5 +26,6 @@ runs:
       run: cargo build --all-features --verbose --package ${{ inputs.package }}
 
     - name: Run tests
+      if: ${{ inputs.run-tests == 'true' }}
       shell: bash
       run: cargo test --all-features --verbose --package ${{ inputs.package }}

.github/workflows/build-events.yml

@@ -16,13 +16,12 @@ jobs:
     strategy:
       matrix:
         toolchain:
-          - "1.71.1" # Current MSRV
+          - "1.81.0" # Current MSRV
           - stable
     env:
       RUST_BACKTRACE: 1
     steps:
       - uses: actions/checkout@v3
-
       - name: Build events
         uses: ./.github/actions/rust-build
         with:
@@ -34,6 +33,23 @@ jobs:
       - uses: actions/checkout@v3
       - uses: dtolnay/rust-toolchain@stable
       - uses: Swatinem/rust-cache@v2
-
       - name: Test individual event features
         run: make check-event-features
+  semver:
+    name: semver
+    needs: [build, check-event-features]
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Check `aws_lambda_events` semver with only default features
+        uses: obi1kenobi/cargo-semver-checks-action@v2
+        with:
+          rust-toolchain: stable
+          package: aws_lambda_events
+          feature-group: default-features
+      - name: Check `aws_lambda_events` semver with all features
+        uses: obi1kenobi/cargo-semver-checks-action@v2
+        with:
+          rust-toolchain: stable
+          package: aws_lambda_events
+          feature-group: all-features

.github/workflows/build-extension.yml

@@ -1,4 +1,4 @@
-name: Check Lambda Runtime
+name: Check Lambda Extension
 
 on:
   push:
@@ -22,22 +22,37 @@ jobs:
     strategy:
       matrix:
         toolchain:
-          - "1.71.1" # Current MSRV
+          - "1.81.0" # Current MSRV
           - stable
     env:
       RUST_BACKTRACE: 1
     steps:
       - uses: actions/checkout@v3
-
       - name: Build Runtime API Client
         uses: ./.github/actions/rust-build
         with:
           package: lambda_runtime_api_client
           toolchain: ${{ matrix.toolchain}}
-
-
       - name: Build Extensions runtime
         uses: ./.github/actions/rust-build
         with:
           package: lambda-extension
           toolchain: ${{ matrix.toolchain}}
+  semver:
+    name: semver
+    needs: build-runtime
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Check `lambda-extension` semver with only default features
+        uses: obi1kenobi/cargo-semver-checks-action@v2
+        with:
+          rust-toolchain: stable
+          package: lambda-extension
+          feature-group: default-features
+      - name: Check `lambda-extension` semver with all features
+        uses: obi1kenobi/cargo-semver-checks-action@v2
+        with:
+          rust-toolchain: stable
+          package: lambda-extension
+          feature-group: all-features

.github/workflows/build-integration-test.yml

@@ -0,0 +1,40 @@
+name: Build integration tests
+
+on:
+  push:
+    paths:
+      - 'lambda-runtime-api-client/**'
+      - 'lambda-runtime/**'
+      - 'lambda-http/**'
+      - 'lambda-extension/**'
+      - 'Cargo.toml'
+
+  pull_request:
+    paths:
+      - 'lambda-runtime-api-client/**'
+      - 'lambda-runtime/**'
+      - 'lambda-http/**'
+      - 'lambda-extension/**'
+      - 'Cargo.toml'
+
+jobs:
+  build-runtime:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        toolchain:
+          - "1.81.0" # Current MSRV
+          - stable
+    env:
+      RUST_BACKTRACE: 1
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Build Integration tests
+        uses: ./.github/actions/rust-build
+        with:
+          package: lambda-integration-tests
+          toolchain: ${{ matrix.toolchain}}
+          # the tests will generally fail in ci since they make a network call to a real endpoint,
+          # this step is just designed to make sure they build successfully
+          run-tests: false

.github/workflows/build-runtime.yml

@@ -21,27 +21,42 @@ jobs:
     strategy:
       matrix:
         toolchain:
-          - "1.71.1" # Current MSRV
+          - "1.81.0" # Current MSRV
           - stable
     env:
       RUST_BACKTRACE: 1
     steps:
       - uses: actions/checkout@v3
-
       - name: Build Runtime API Client
         uses: ./.github/actions/rust-build
         with:
           package: lambda_runtime_api_client
           toolchain: ${{ matrix.toolchain}}
-
       - name: Build Functions runtime
         uses: ./.github/actions/rust-build
         with:
           package: lambda_runtime
           toolchain: ${{ matrix.toolchain}}
-
       - name: Build HTTP layer
         uses: ./.github/actions/rust-build
         with:
           package: lambda_http
           toolchain: ${{ matrix.toolchain}}
+  semver:
+    name: semver
+    needs: build-runtime
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Check `lambda_runtime_api_client`, `lambda_runtime`, lambda_http` semver with only default features
+        uses: obi1kenobi/cargo-semver-checks-action@v2
+        with:
+          rust-toolchain: stable
+          package: lambda_runtime_api_client, lambda_runtime, lambda_http
+          feature-group: default-features
+      - name: Check `lambda_runtime_api_client`, `lambda_runtime`, lambda_http` semver with all features
+        uses: obi1kenobi/cargo-semver-checks-action@v2
+        with:
+          rust-toolchain: stable
+          package: lambda_runtime_api_client, lambda_runtime, lambda_http
+          feature-group: all-features

.github/workflows/check-docs.yml

@@ -0,0 +1,39 @@
+name: Check rustdocs
+# this is its own workflow since we to to use unstable
+# to have the docs.rs display of feature flags
+
+on:
+  push:
+    paths:
+      - 'lambda-runtime/**'
+      - 'lambda-runtime-api-client/**'
+      - 'lambda-http/**'
+      - 'lambda-events/**'
+      - 'lambda-extension/**'
+      - 'Cargo.toml'
+
+  pull_request:
+    paths:
+      - 'lambda-runtime/**'
+      - 'lambda-runtime-api-client/**'
+      - 'lambda-http/**'
+      - 'lambda-events/**'
+      - 'lambda-extension/**'
+      - 'Cargo.toml'
+
+jobs:
+  build-runtime:
+    runs-on: ubuntu-latest
+
+    env:
+      RUST_BACKTRACE: 1
+    steps:
+      - uses: actions/checkout@v3
+      - uses: dtolnay/rust-toolchain@nightly
+
+      - name: Check documentation
+        shell: bash
+        env:
+            RUSTFLAGS: --cfg docsrs 
+            RUSTDOCFLAGS: --cfg docsrs -Dwarnings
+        run: cargo doc --no-deps --document-private-items --all-features

.github/workflows/run-integration-test.yml

@@ -18,10 +18,12 @@ jobs:
             repo: cargo-lambda/cargo-lambda
             platform: linux
             arch: x86_64
+            # TODO: unpin once https://github.com/awslabs/aws-lambda-rust-runtime/issues/1006 is fixed
+            tag: v1.8.1
         - name: install Zig toolchain
-          uses: korandoru/setup-zig@v1
+          uses: mlugg/setup-zig@v2
           with:
-            zig-version: 0.10.0
+            version: 0.10.0
         - name: install SAM
           uses: aws-actions/setup-sam@v2
           with:

README.md

@@ -1,6 +1,6 @@
 # Rust Runtime for AWS Lambda
 
-[![Build Status](https://github.com/awslabs/aws-lambda-rust-runtime/workflows/Rust/badge.svg)](https://github.com/awslabs/aws-lambda-rust-runtime/actions)
+[![Build Status](https://github.com/awslabs/aws-lambda-rust-runtime/actions/workflows/check-examples.yml/badge.svg)](https://github.com/awslabs/aws-lambda-rust-runtime/actions)
 
 This package makes it easy to run AWS Lambda Functions written in Rust. This workspace includes multiple crates:
 
@@ -82,7 +82,7 @@ when a function invocation fails, AWS Lambda expects you to return an object tha
 }
 ```
 
-The Rust Runtime for Lambda uses a struct called `Diagnostic` to represent function errors internally. The runtime implements the converstion of several general errors types, like `std::error::Error`, into `Diagnostic`. For these general implementations, the `error_type` is the name of the value type returned by your function. For example, if your function returns `lambda_runtime::Error`, the `error_type` will be something like `alloc::boxed::Box<dyn core::error::Error + core::marker::Send + core::marker::Sync>`, which is not very descriptive.
+The Rust Runtime for Lambda uses a struct called `Diagnostic` to represent function errors internally. The runtime implements the conversion of several general error types, like `std::error::Error`, into `Diagnostic`. For these general implementations, the `error_type` is the name of the value type returned by your function. For example, if your function returns `lambda_runtime::Error`, the `error_type` will be something like `alloc::boxed::Box<dyn core::error::Error + core::marker::Send + core::marker::Sync>`, which is not very descriptive.
 
 ### Implement your own Diagnostic
 
@@ -126,6 +126,52 @@ async fn handler(_event: LambdaEvent<Request>) -> Result<(), Diagnostic> {
 
 You can see more examples on how to use these error crates in our [example repository](https://github.com/awslabs/aws-lambda-rust-runtime/tree/main/examples/basic-error-error-crates-integration). 
 
+### Graceful shutdown
+
+`lambda_runtime` offers a helper to simplify configuring graceful shutdown signal handling, `spawn_graceful_shutdown_handler()`. This requires the `graceful-shutdown` feature flag and only supports Unix systems.
+
+You can use it by passing a `FnOnce` closure that returns an async block. That async block will be executed
+when the function receives a `SIGTERM` or `SIGKILL`.
+
+Note that this helper is opinionated in a number of ways. Most notably:
+1. It spawns a task to drive your signal handlers
+2. It registers a 'no-op' extension in order to enable graceful shutdown signals
+3. It panics on unrecoverable errors
+
+If you prefer to fine-tune the behavior, refer to the implementation of `spawn_graceful_shutdown_handler()` as a starting point for your own.
+
+For more information on graceful shutdown handling in AWS Lambda, see: [aws-samples/graceful-shutdown-with-aws-lambda](https://github.com/aws-samples/graceful-shutdown-with-aws-lambda).
+
+Complete example (cleaning up a non-blocking tracing writer):
+
+```rust,no_run
+use lambda_runtime::{service_fn, LambdaEvent, Error};
+use serde_json::{json, Value};
+
+#[tokio::main]
+async fn main() -> Result<(), Error> {
+    let func = service_fn(func);
+
+    let (writer, log_guard) = tracing_appender::non_blocking(std::io::stdout());
+    lambda_runtime::tracing::init_default_subscriber_with_writer(writer);
+
+    let shutdown_hook = || async move {
+      std::mem::drop(log_guard);
+    };
+    lambda_runtime::spawn_graceful_shutdown_handler(shutdown_hook).await;
+
+    lambda_runtime::run(func).await?;
+    Ok(())
+}
+
+async fn func(event: LambdaEvent<Value>) -> Result<Value, Error> {
+    let (event, _context) = event.into_parts();
+    let first_name = event["firstName"].as_str().unwrap_or("world");
+
+    Ok(json!({ "message": format!("Hello, {}!", first_name) }))
+}
+```
+
 ## Building and deploying your Lambda functions
 
 If you already have Cargo Lambda installed in your machine, run the next command to build your function:
@@ -409,7 +455,7 @@ fn main() -> Result<(), Box<Error>> {
 
 ## Supported Rust Versions (MSRV)
 
-The AWS Lambda Rust Runtime requires a minimum of Rust 1.71.1, and is not guaranteed to build on compiler versions earlier than that.
+The AWS Lambda Rust Runtime requires a minimum of Rust 1.81.0, and is not guaranteed to build on compiler versions earlier than that.
 
 ## Security