lambda-forest

A set of tools to ease REST AWS Lambda Functions

About Lambda Forest

Lambda Forest is a microframework that provides a set of tools to make it easier to develop rest api's using the aws lambda function and api gateway. Lambda Forest attempts to make the develpment faster by easing common tasks, such as:

Exception handling
Request body deserialization
Response body serialization
Request validation

Before you begin

In order to use Lambda Forest the AWS API Gateway needs to be configured to use Proxy Integration.

A detailed documentation can be found here.

Getting Started

The recommended way to use Lambda Forest is to consume it from Maven. To add the lastest version of Lambda Forest in your project declare the following dependency in your pom.xml file:

<dependency>
    <groupId>br.com.tdsis</groupId>
    <artifactId>lambda-forest</artifactId>
    <version>1.0.0</version>
</dependency>

Handling Requests

The Lambda Forest framework provides an abstract base class called AbstratRequestHandler that handles a Lambda execution call and perform some operations such as request body deserialization, request validation, response body serialization and exception handling.

POST / PUT / PATCH

public class PostHandler extends AbstractRequestHandler<UserRequest, UserResponse> {

    @Override
    public void before(Context context) throws HttpException {
        addResponseHeader("Access-Control-Allow-Origin", "*");
    }
    
    @Override
    public UserResponse execute(UserRequest input, Context context) throws HttpException {
        UserResponse response = new UserResponse();
        response.setId(UUID.randomUUID().toString());
        response.setName(input.getName());
        response.setAddress(input.getAddress());
        
        return response;
    }
}

GET

public class GetHandler extends AbstractRequestHandler<Void, UserResponse> {

    @Override
    public void before(Context context) throws HttpException {
        addResponseHeader("Access-Control-Allow-Origin", "*");
    }
    
    @Override
    public UserResponse execute(Void input, Context context) throws HttpException {
        Optional<String> optional = getQueryStringParameter("name");
        String name = optional.orElseThrow(() -> new UnprocessableEntityException());
    
        UserResponse response = new UserResponse();
        response.setId(UUID.randomUUID().toString());
        response.setName(name);
        
        return response;
    }
}

You can also specify a pojo as an input of a GET request to be deserialized based on the query string parameters:

curl http://my-aws-api-gateway-resource/users?name=myname&address=myaddress

public class GetRequest {
    
    private String name;
    private String address;
    
    ...getters and setters
}

public class GetHandler extends AbstractRequestHandler<GetRequest, UserResponse> {

    @Override
    public void before(Context context) throws HttpException {
        addResponseHeader("Access-Control-Allow-Origin", "*");
    }
    
    @Override
    public UserResponse execute(GetRequest input, Context context) throws HttpException {	
        UserResponse response = new UserResponse();
        response.setId(UUID.randomUUID().toString());
        response.setName(input.getName());
        response.setName(input.getAddress());
        
        return response;
    }
}

DELETE

public class DeleteHandler extends AbstractRequestHandler<Void, UserResponse> {

    @Override
    public void before(Context context) throws HttpException {
        addResponseHeader("Access-Control-Allow-Origin", "*");
    }
    
    @Override
    public UserResponse execute(Void input, Context context) throws HttpException { 
        Optional<String> optional = getPathParameter("id");
        String id = optional.get();
        
        // some delete operation...
    
        UserResponse response = new UserResponse();        
        return response;
    }
}

The Request / Response Attributes

The AbstractRequestHandler class provides methods to access all the request / response attributes and the Lambda environment context as well:

Attribute	Method
Request Headers	getHeader("headerName")
Response Headers	addResponseHeader("headerName")
Raw Request Body	getRawRequestBody()
Http Method	getHttpMethod()
Resource Path	getPath()
Stage Variables	getStageVariable("stageVariableName")
Path Parameters	getPathParameter("parameterName")
Query String Parameters	getQueryStringParameter("parameterName")

Request Validation

Lambda Forest uses the Hibernate bean validation implementation to validate requests. To validate the incoming request the input parameter of the execute method must be annotated with @Valid

Eg.:

public class UserRequest {
    
    @Size(min=1, max=50, message="Invalid name message")
    private String name;
    
    @NotBlank(message="Invalid address message")
    private String address;

    ... getters and setters
}

public class LambdaHandler extends AbstractRequestHandler<UserRequest, UserResponse> {

    @Override
    public void before(Context context) throws HttpException {
        addResponseHeader("Access-Control-Allow-Origin", "*");
    }
    
    @Override
    public UserResponse execute(@Valid UserRequest input, Context context) throws HttpException {
        UserResponse response = new UserResponse();
        response.setId(UUID.randomUUID().toString());
        response.setName(input.getName());
        response.setAddress(input.getAddress());
        
        return response;
    }
}

If any constraint violation occurs an UnprocessableEntityException will be thrown and the http response will be serialized with the error details.

Eg.:

curl -X POST http://my-api-gateway-resource/users -d '{"name": "my name", "address": ""}'

I this particular example the server will respond the above request with a http status code 422 and the following response body:

{
    "message": "Unprocessable entity",
    "errors": [
        {
            "attribute": "address",
            "message": "Invalid address message"
        }
    ]
}

A detailed documentation of the Hibernate validation can be found here.

If you want to provide your own bean validation mechanism, the method resolveRequestValidator should be overridden:

@Override
protected RequestValidator resolveRequestValidator() {
    return new MyCustomRequestValidator();
}

Serialization and Deserialization

Lambda Forest uses Jackson to serialize and deserialize the request and response body.

The deserialization and serialization strategies are based on two http headers:

Content-Type for deserialization
Accept for serialization

If you want to provide your own request body deserializer, the method resolveDeserializerStrategy should be overridden:

@Override
protected RequestBodyDeserializerStrategy resolveDeserializerStrategy(String contentType) {
    return new MyCustomRequestBodyDeserializer();
}

If you want to provide your own response body serializer, the method resolveSerializerStrategy should be overridden:

@Override
protected ResponseBodySerializerStrategy resolveSerializerStrategy(String accept) {
    return new MyCustomResponseBodySerializer();
}

API Gateway Custom Authorizer

Lambda Forest offers a simple way to create a custom API Gateway Authorizer:

Allowing a Request

public class CustomAPIGatewayAuthorizer extends AbstractAPIGatewayAuthorizer {

  @Override
  public AuthPolicy authorize(AuthRequest request, Context context) throws HttpException {
    
    // your custom authorization logic here
    PolicyStatement policyStatement = new PolicyStatement(
      PolicyAction.INVOKE, 
      PolicyEffect.ALLOW, 
      request.getMethodArn());

    return new AuthPolicyBuilder()
      .withPrincipalId("principal-id")			
      .addPolicyStatement(policyStatement)
      .addToContext("myCustomKey", "myCustomValue")
      .build();
      
  }

}

Denying access to all API Gateway Resources

public class CustomAPIGatewayAuthorizer extends AbstractAPIGatewayAuthorizer {

  @Override
  public AuthPolicy authorize(AuthRequest request, Context context) throws HttpException {
    
    // your custom authorization logic here
    return new AuthPolicyBuilder("principal-id")
	    .denyAll()
	    .build();
	    
  }

}

Denying access with a HTTP Exception

public class CustomAPIGatewayAuthorizer extends AbstractAPIGatewayAuthorizer {
  
  @Override
  public AuthPolicy authorize(AuthRequest request, Context context) throws HttpException {
    // your custom authorization logic here
    throw new UnauthorizedException();
  }

}

Running locally

The Lambda Forest framework provides a class that simulates a Lambda execution call.

To simulate a Lambda execution call it is necessary to define an execution specification in your project resource folder.

Eg.:

project
└───src
│   └───main
│      └───resources
│            lambda-spec.json

{
    "context": {
        "awsRequestId": "",
        "logGroupName": "",
        "logStreamName": "",
        "functionName": "",
        "functionVersion": "",
        "invokedFunctionArn": "",
        "identity": null,
        "clientContext": {
            "client": {
                "installationId": "",
                "appTitle": "",
                "appVersionName": "",
                "appVersionCode": "",
                "appPackageName": ""
            },
            "custom": {
                
            },
            "environment": {
                
            }
        },
        "remainingTimeInMillis": 30,
        "memoryLimitInMB": 128,
        "logger": null
    },
    "request":{
            "path": "/users",
            "pathParameters": {
                
            },
            "queryStringParameters": {
                
            },
            "resource": "users",
            "stageVariables": {
            
            },
            "method":"POST",
            "headers": {
                
            },
            "body": {               
                "name": "my name",
                "message": "This is my message"
            }
      }
}

public class LambdaHandler extends AbstractRequestHandler<UserRequest, UserResponse> {

    @Override
    public void before(Context context) throws HttpException {
        addResponseHeader("Access-Control-Allow-Origin", "*");
    }
    
    @Override
    public UserResponse execute(@Valid UserRequest input, Context context) throws HttpException {
        UserResponse response = new UserResponse();
        response.setId(UUID.randomUUID().toString());
        response.setName(input.getName());
        response.setAddress(input.getAddress());
        
        return response;
    }
    
    public static void main(String [] args) {
        LambdaRunner.run("lambda-spec.json", LambdaHandler.class, args)
            .print()
            .printBody()
            .printHeaders()
            .printStatusCode();
    }
}

License

The Lambda Forest framework is open-source software licensed under the MIT license .

tdsis/lambda-forest

lambda-forest

About Lambda Forest

Before you begin

Getting Started

Handling Requests

POST / PUT / PATCH

GET

DELETE

The Request / Response Attributes

Request Validation

Serialization and Deserialization

API Gateway Custom Authorizer

Allowing a Request

Denying access to all API Gateway Resources

Denying access with a HTTP Exception

Running locally

License