Rename features to match AWS documentation.

Use the names present in the API GW documentation to differentiate the APIs.

Signed-off-by: David Calavera <[email protected]>

Author: calavera

README.md

@@ -374,27 +374,27 @@ fn main() -> Result<(), Box<Error>> {
 
 ## Feature flags in lambda_http
 
-`lambda_http` is a wrapper for HTTP events coming from two different services, Amazon Load Balancer (ALB), and AWS Api Gateway (APIGW). AWS Api Gateway can also send events from three different endpoints, Proxy V1, Proxy V2, and WebSockets. `lambda_http` transforms events from all these sources into native `http::Request` objects, so you can incorporate Rust http semantics into your Lambda functions.
+`lambda_http` is a wrapper for HTTP events coming from two different services, Amazon Load Balancer (ALB), and Amazon Api Gateway (APIGW). Amazon Api Gateway can also send events from three different endpoints, Proxy V1, Proxy V2, and WebSockets. `lambda_http` transforms events from all these sources into native `http::Request` objects, so you can incorporate Rust HTTP semantics into your Lambda functions.
 
-By default, `lambda_http` compiles your function to support any of those services, this increases the compile time of your function because we have to generate code for all the sources. In reality, you'll usually put a Lambda function only behind of those sources. You can choose which source to generate code for with feature flags.
+By default, `lambda_http` compiles your function to support any of those services. This increases the compile time of your function because we have to generate code for all the sources. In reality, you'll usually put a Lambda function only behind one of those sources. You can choose which source to generate code for with feature flags.
 
 The available features flags for `lambda_http` are the following:
 
-- `alb`: for events coming from Amazon Load Balancer.
-- `apigw_v1`: for events coming from API Gateway Proxy V1.
-- `apigw_v2`: for events coming from API Gateway Proxy V2.
-- `apigw_websockets`: for events coming from API Gateway WebSockets.
+- `alb`: for events coming from [Amazon Elastic Load Balancer](https://aws.amazon.com/elasticloadbalancing/).
+- `apigw_rest`: for events coming from [Amazon API Gateway Rest APIs](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-rest-api.html).
+- `apigw_http`: for events coming from [Amazon API Gateway HTTP APIs](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api.html).
+- `apigw_websockets`: for events coming from [Amazon API Gateway WebSockets](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api.html).
 
-If you only want to support one of these sources, you can disable the default features, and enable only the source that you care about in your package's Cargo.toml file. Substitute the dependency line for `lambda_http` for the snippet below, changing the feature that you want to enable:
+If you only want to support one of these sources, you can disable the default features, and enable only the source that you care about in your package's `Cargo.toml` file. Substitute the dependency line for `lambda_http` for the snippet below, changing the feature that you want to enable:
 
 ```toml
 [dependencies.lambda_http]
 version = "0.5.3"
 default-features = false
-features = ["apigw_v1"]
+features = ["apigw_rest"]
 ```
 
-This will make your function to compile much faster.
+This will make your function compile much faster.
 
 ## Supported Rust Versions (MSRV)
 

lambda-http/Cargo.toml

@@ -13,9 +13,9 @@ categories = ["web-programming::http-server"]
 readme = "../README.md"
 
 [features]
-default = ["apigw_v1", "apigw_v2", "apigw_websockets", "alb"]
-apigw_v1 = []
-apigw_v2 = []
+default = ["apigw_rest", "apigw_http", "apigw_websockets", "alb"]
+apigw_rest = []
+apigw_http = []
 apigw_websockets = []
 alb = []
 

lambda-http/src/request.rs

@@ -6,9 +6,9 @@
 use crate::ext::{PathParameters, QueryStringParameters, RawHttpPath, StageVariables};
 #[cfg(feature = "alb")]
 use aws_lambda_events::alb::{AlbTargetGroupRequest, AlbTargetGroupRequestContext};
-#[cfg(feature = "apigw_v1")]
+#[cfg(feature = "apigw_rest")]
 use aws_lambda_events::apigw::{ApiGatewayProxyRequest, ApiGatewayProxyRequestContext};
-#[cfg(feature = "apigw_v2")]
+#[cfg(feature = "apigw_http")]
 use aws_lambda_events::apigw::{ApiGatewayV2httpRequest, ApiGatewayV2httpRequestContext};
 #[cfg(feature = "apigw_websockets")]
 use aws_lambda_events::apigw::{ApiGatewayWebsocketProxyRequest, ApiGatewayWebsocketProxyRequestContext};
@@ -28,9 +28,9 @@ use std::{io::Read, mem};
 #[derive(Deserialize, Debug)]
 #[serde(untagged)]
 pub enum LambdaRequest {
-    #[cfg(feature = "apigw_v1")]
+    #[cfg(feature = "apigw_rest")]
     ApiGatewayV1(ApiGatewayProxyRequest),
-    #[cfg(feature = "apigw_v2")]
+    #[cfg(feature = "apigw_http")]
     ApiGatewayV2(ApiGatewayV2httpRequest),
     #[cfg(feature = "alb")]
     Alb(AlbTargetGroupRequest),
@@ -44,9 +44,9 @@ impl LambdaRequest {
     /// type of response the request origin expects.
     pub fn request_origin(&self) -> RequestOrigin {
         match self {
-            #[cfg(feature = "apigw_v1")]
+            #[cfg(feature = "apigw_rest")]
             LambdaRequest::ApiGatewayV1 { .. } => RequestOrigin::ApiGatewayV1,
-            #[cfg(feature = "apigw_v2")]
+            #[cfg(feature = "apigw_http")]
             LambdaRequest::ApiGatewayV2 { .. } => RequestOrigin::ApiGatewayV2,
             #[cfg(feature = "alb")]
             LambdaRequest::Alb { .. } => RequestOrigin::Alb,
@@ -61,10 +61,10 @@ impl LambdaRequest {
 #[derive(Debug)]
 pub enum RequestOrigin {
     /// API Gateway request origin
-    #[cfg(feature = "apigw_v1")]
+    #[cfg(feature = "apigw_rest")]
     ApiGatewayV1,
     /// API Gateway v2 request origin
-    #[cfg(feature = "apigw_v2")]
+    #[cfg(feature = "apigw_http")]
     ApiGatewayV2,
     /// ALB request origin
     #[cfg(feature = "alb")]
@@ -74,7 +74,7 @@ pub enum RequestOrigin {
     WebSocket,
 }
 
-#[cfg(feature = "apigw_v2")]
+#[cfg(feature = "apigw_http")]
 fn into_api_gateway_v2_request(ag: ApiGatewayV2httpRequest) -> http::Request<Body> {
     let http_method = ag.request_context.http.method.clone();
     let raw_path = ag.raw_path.unwrap_or_default();
@@ -146,7 +146,7 @@ fn into_api_gateway_v2_request(ag: ApiGatewayV2httpRequest) -> http::Request<Bod
     req
 }
 
-#[cfg(feature = "apigw_v1")]
+#[cfg(feature = "apigw_rest")]
 fn into_proxy_request(ag: ApiGatewayProxyRequest) -> http::Request<Body> {
     let http_method = ag.http_method;
     let raw_path = ag.path.unwrap_or_default();
@@ -357,10 +357,10 @@ fn apigw_path_with_stage(stage: &Option<String>, path: &str) -> String {
 #[serde(untagged)]
 pub enum RequestContext {
     /// API Gateway proxy request context
-    #[cfg(feature = "apigw_v1")]
+    #[cfg(feature = "apigw_rest")]
     ApiGatewayV1(ApiGatewayProxyRequestContext),
     /// API Gateway v2 request context
-    #[cfg(feature = "apigw_v2")]
+    #[cfg(feature = "apigw_http")]
     ApiGatewayV2(ApiGatewayV2httpRequestContext),
     /// ALB request context
     #[cfg(feature = "alb")]
@@ -374,9 +374,9 @@ pub enum RequestContext {
 impl<'a> From<LambdaRequest> for http::Request<Body> {
     fn from(value: LambdaRequest) -> Self {
         match value {
-            #[cfg(feature = "apigw_v1")]
+            #[cfg(feature = "apigw_rest")]
             LambdaRequest::ApiGatewayV1(ag) => into_proxy_request(ag),
-            #[cfg(feature = "apigw_v2")]
+            #[cfg(feature = "apigw_http")]
             LambdaRequest::ApiGatewayV2(ag) => into_api_gateway_v2_request(ag),
             #[cfg(feature = "alb")]
             LambdaRequest::Alb(alb) => into_alb_request(alb),
@@ -449,10 +449,10 @@ mod tests {
     }
 
     #[test]
-    fn deserializes_minimal_apigw_v2_request_events() {
+    fn deserializes_minimal_apigw_http_request_events() {
         // from the docs
         // https://docs.aws.amazon.com/lambda/latest/dg/eventsources.html#eventsources-api-gateway-request
-        let input = include_str!("../tests/data/apigw_v2_proxy_request_minimal.json");
+        let input = include_str!("../tests/data/apigw_http_proxy_request_minimal.json");
         let result = from_str(input);
         assert!(
             result.is_ok(),
@@ -477,10 +477,10 @@ mod tests {
     }
 
     #[test]
-    fn deserializes_apigw_v2_request_events() {
+    fn deserializes_apigw_http_request_events() {
         // from the docs
         // https://docs.aws.amazon.com/lambda/latest/dg/eventsources.html#eventsources-api-gateway-request
-        let input = include_str!("../tests/data/apigw_v2_proxy_request.json");
+        let input = include_str!("../tests/data/apigw_http_proxy_request.json");
         let result = from_str(input);
         assert!(
             result.is_ok(),
@@ -620,7 +620,7 @@ mod tests {
     }
 
     #[test]
-    fn deserialize_apigw_v2_sam_local() {
+    fn deserialize_apigw_http_sam_local() {
         // manually generated from AWS SAM CLI
         // Steps to recreate:
         // * sam init
@@ -629,7 +629,7 @@ mod tests {
         // * Change the function code to return the Lambda event serialized
         // * sam local start-api
         // * Invoke the API
-        let input = include_str!("../tests/data/apigw_v2_sam_local.json");
+        let input = include_str!("../tests/data/apigw_http_sam_local.json");
         let result = from_str(input);
         assert!(
             result.is_ok(),

lambda-http/src/response.rs

@@ -4,9 +4,9 @@ use crate::request::RequestOrigin;
 use aws_lambda_events::encodings::Body;
 #[cfg(feature = "alb")]
 use aws_lambda_events::event::alb::AlbTargetGroupResponse;
-#[cfg(any(feature = "apigw_v1", feature = "apigw_websockets"))]
+#[cfg(any(feature = "apigw_rest", feature = "apigw_websockets"))]
 use aws_lambda_events::event::apigw::ApiGatewayProxyResponse;
-#[cfg(feature = "apigw_v2")]
+#[cfg(feature = "apigw_http")]
 use aws_lambda_events::event::apigw::ApiGatewayV2httpResponse;
 use http::{
     header::{CONTENT_TYPE, SET_COOKIE},
@@ -19,9 +19,9 @@ use serde::Serialize;
 #[derive(Serialize, Debug)]
 #[serde(untagged)]
 pub enum LambdaResponse {
-    #[cfg(any(feature = "apigw_v1", feature = "apigw_websockets"))]
+    #[cfg(any(feature = "apigw_rest", feature = "apigw_websockets"))]
     ApiGatewayV1(ApiGatewayProxyResponse),
-    #[cfg(feature = "apigw_v2")]
+    #[cfg(feature = "apigw_http")]
     ApiGatewayV2(ApiGatewayV2httpResponse),
     #[cfg(feature = "alb")]
     Alb(AlbTargetGroupResponse),
@@ -44,15 +44,15 @@ impl LambdaResponse {
         let status_code = parts.status.as_u16();
 
         match request_origin {
-            #[cfg(feature = "apigw_v1")]
+            #[cfg(feature = "apigw_rest")]
             RequestOrigin::ApiGatewayV1 => LambdaResponse::ApiGatewayV1(ApiGatewayProxyResponse {
                 body,
                 status_code: status_code as i64,
                 is_base64_encoded: Some(is_base64_encoded),
                 headers: headers.clone(),
                 multi_value_headers: headers,
             }),
-            #[cfg(feature = "apigw_v2")]
+            #[cfg(feature = "apigw_http")]
             RequestOrigin::ApiGatewayV2 => {
                 // ApiGatewayV2 expects the set-cookies headers to be in the "cookies" attribute,
                 // so remove them from the headers.