Changes to servlet context to address #84. Created a singleton ObjectMapper to speed up initialization and address #91. Added unit tests to make sure #90 is resolved and stays resolved.

Author: sapessi

aws-serverless-java-container-core/src/main/java/com/amazonaws/serverless/proxy/AwsProxyExceptionHandler.java

@@ -13,11 +13,14 @@
 package com.amazonaws.serverless.proxy;
 
 import com.amazonaws.serverless.exceptions.InvalidRequestEventException;
+import com.amazonaws.serverless.proxy.internal.LambdaContainerHandler;
 import com.amazonaws.serverless.proxy.model.AwsProxyResponse;
 import com.amazonaws.serverless.proxy.model.ErrorModel;
 
 import com.fasterxml.jackson.core.JsonProcessingException;
 import com.fasterxml.jackson.databind.ObjectMapper;
+import com.fasterxml.jackson.databind.jsonFormatVisitors.JsonValueFormat;
+import com.fasterxml.jackson.databind.ser.std.JsonValueSerializer;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
@@ -55,8 +58,6 @@ public class AwsProxyExceptionHandler
     //-------------------------------------------------------------
 
     private static Map<String, String> headers = new HashMap<>();
-    private static ObjectMapper objectMapper = new ObjectMapper();
-
 
     //-------------------------------------------------------------
     // Constructors
@@ -87,7 +88,7 @@ public AwsProxyResponse handle(Throwable ex) {
     public void handle(Throwable ex, OutputStream stream) throws IOException {
         AwsProxyResponse response = handle(ex);
 
-        objectMapper.writeValue(stream, response);
+        LambdaContainerHandler.getObjectMapper().writeValue(stream, response);
     }
 
 
@@ -96,8 +97,9 @@ public void handle(Throwable ex, OutputStream stream) throws IOException {
     //-------------------------------------------------------------
 
     String getErrorJson(String message) {
+
         try {
-            return objectMapper.writeValueAsString(new ErrorModel(message));
+            return LambdaContainerHandler.getObjectMapper().writeValueAsString(new ErrorModel(message));
         } catch (JsonProcessingException e) {
             log.error("Could not produce error JSON", e);
             return "{ \"message\": \"" + message + "\" }";

aws-serverless-java-container-core/src/main/java/com/amazonaws/serverless/proxy/internal/LambdaContainerHandler.java

@@ -20,6 +20,7 @@
 import com.amazonaws.serverless.proxy.SecurityContextWriter;
 import com.amazonaws.services.lambda.runtime.Context;
 
+import com.fasterxml.jackson.databind.ObjectMapper;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
@@ -64,6 +65,8 @@ public abstract class LambdaContainerHandler<RequestType, ResponseType, Containe
     //-------------------------------------------------------------
 
     private static ContainerConfig config = ContainerConfig.defaultConfig();
+    private static ObjectMapper objectMapper;
+
 
 
     //-------------------------------------------------------------
@@ -97,6 +100,13 @@ protected abstract void handleRequest(ContainerRequestType containerRequest, Con
     // Methods - Public
     //-------------------------------------------------------------
 
+    public static ObjectMapper getObjectMapper() {
+        if (objectMapper == null) {
+            objectMapper = new ObjectMapper();
+        }
+        return objectMapper;
+    }
+
     /**
      * Configures the library to strip a base path from incoming requests before passing them on to the wrapped
      * framework. This was added in response to issue #34 (https://github.com/awslabs/aws-serverless-java-container/issues/34).

aws-serverless-java-container-core/src/main/java/com/amazonaws/serverless/proxy/internal/servlet/AwsProxyHttpServletRequest.java

@@ -15,6 +15,7 @@
 
 import com.amazonaws.serverless.proxy.internal.LambdaContainerHandler;
 import com.amazonaws.serverless.proxy.model.AwsProxyRequest;
+import com.amazonaws.serverless.proxy.model.ContainerConfig;
 import com.amazonaws.services.lambda.runtime.Context;
 
 import org.apache.commons.fileupload.FileItem;
@@ -79,6 +80,7 @@ public class AwsProxyHttpServletRequest extends AwsHttpServletRequest {
     private Map<String, List<String>> urlEncodedFormParameters;
     private Map<String, Part> multipartFormParameters;
     private Logger log = LoggerFactory.getLogger(AwsProxyHttpServletRequest.class);
+    private ContainerConfig config;
 
 
     //-------------------------------------------------------------
@@ -89,6 +91,17 @@ public AwsProxyHttpServletRequest(AwsProxyRequest awsProxyRequest, Context lambd
         super(lambdaContext);
         this.request = awsProxyRequest;
         this.securityContext = awsSecurityContext;
+        this.config = ContainerConfig.defaultConfig();
+
+        this.urlEncodedFormParameters = getFormUrlEncodedParametersMap();
+        this.multipartFormParameters = getMultipartFormParametersMap();
+    }
+
+    public AwsProxyHttpServletRequest(AwsProxyRequest awsProxyRequest, Context lambdaContext, SecurityContext awsSecurityContext, ContainerConfig config) {
+        super(lambdaContext);
+        this.request = awsProxyRequest;
+        this.securityContext = awsSecurityContext;
+        this.config = config;
 
         this.urlEncodedFormParameters = getFormUrlEncodedParametersMap();
         this.multipartFormParameters = getMultipartFormParametersMap();
@@ -181,10 +194,7 @@ public String getMethod() {
 
     @Override
     public String getPathInfo() {
-        String pathInfo = getServletPath().replace(getContextPath(), "");
-        if (!pathInfo.startsWith("/")) {
-            pathInfo = "/" + pathInfo;
-        }
+        String pathInfo = cleanUri(request.getPath()); //getServletPath().replace(getContextPath(), "");
         return decodeRequestPath(pathInfo, LambdaContainerHandler.getContainerConfig());
     }
 
@@ -196,13 +206,18 @@ public String getPathTranslated() {
     }
 
 
-    /**
-     * In AWS API Gateway, stage is never given as part of the path.
-     * @return
-     */
     @Override
     public String getContextPath() {
-        return "";
+        if (config.isUseStageAsServletContext()) {
+            String contextPath = cleanUri(request.getRequestContext().getStage());
+            if (config.getServiceBasePath() != null) {
+                contextPath += cleanUri(config.getServiceBasePath());
+            }
+
+            return contextPath;
+        } else {
+            return "" + (config.getServiceBasePath() != null ? cleanUri(config.getServiceBasePath()) : "");
+        }
     }
 
 
@@ -232,28 +247,25 @@ public Principal getUserPrincipal() {
 
     @Override
     public String getRequestURI() {
-        return (getContextPath().isEmpty() ? "" : "/" + getContextPath()) + request.getPath();
+        return cleanUri(getContextPath()) + cleanUri(request.getPath());
     }
 
 
     @Override
     public StringBuffer getRequestURL() {
         String url = "";
         url += getServerName();
-        url += "/";
-        url += getContextPath();
-        url += "/";
-        url += request.getPath();
-
-        url = url.replaceAll("/+", "/");
+        url += cleanUri(getContextPath());
+        url += cleanUri(request.getPath());
 
         return new StringBuffer(getScheme() + "://" + url);
     }
 
 
     @Override
     public String getServletPath() {
-        return decodeRequestPath(request.getPath(), LambdaContainerHandler.getContainerConfig());
+        // we always work on the root path
+        return "";
     }
 
     @Override
@@ -653,15 +665,15 @@ private String getQueryStringParameterCaseInsensitive(String key) {
 
 
     private String[] getFormBodyParameterCaseInsensitive(String key) {
-            List<String> values = urlEncodedFormParameters.get(key);
-            if (values != null) {
-                String[] valuesArray = new String[values.size()];
-                valuesArray = values.toArray(valuesArray);
-                return valuesArray;
-            } else {
-                return null;
-            }
+        List<String> values = urlEncodedFormParameters.get(key);
+        if (values != null) {
+            String[] valuesArray = new String[values.size()];
+            valuesArray = values.toArray(valuesArray);
+            return valuesArray;
+        } else {
+            return null;
         }
+    }
 
 
     private Map<String, Part> getMultipartFormParametersMap() {
@@ -698,6 +710,22 @@ private Map<String, Part> getMultipartFormParametersMap() {
         return output;
     }
 
+    private String cleanUri(String uri) {
+        String finalUri = uri;
+
+        if (!finalUri.startsWith("/")) {
+            finalUri = "/" + finalUri;
+        }
+
+        if (finalUri.endsWith(("/"))) {
+            finalUri = finalUri.substring(0, finalUri.length() - 1);
+        }
+
+        finalUri = finalUri.replaceAll("/+", "/");
+
+        return finalUri;
+    }
+
 
     private Map<String, List<String>> getFormUrlEncodedParametersMap() {
         String contentType = getContentType();

aws-serverless-java-container-core/src/main/java/com/amazonaws/serverless/proxy/internal/servlet/AwsProxyHttpServletRequestReader.java

@@ -34,7 +34,7 @@ public class AwsProxyHttpServletRequestReader extends RequestReader<AwsProxyRequ
     public AwsProxyHttpServletRequest readRequest(AwsProxyRequest request, SecurityContext securityContext, Context lambdaContext, ContainerConfig config)
             throws InvalidRequestEventException {
         request.setPath(stripBasePath(request.getPath(), config));
-        AwsProxyHttpServletRequest servletRequest = new AwsProxyHttpServletRequest(request, lambdaContext, securityContext);
+        AwsProxyHttpServletRequest servletRequest = new AwsProxyHttpServletRequest(request, lambdaContext, securityContext, config);
         servletRequest.setAttribute(API_GATEWAY_CONTEXT_PROPERTY, request.getRequestContext());
         servletRequest.setAttribute(API_GATEWAY_STAGE_VARS_PROPERTY, request.getStageVariables());
         servletRequest.setAttribute(LAMBDA_CONTEXT_PROPERTY, lambdaContext);

aws-serverless-java-container-core/src/main/java/com/amazonaws/serverless/proxy/internal/servlet/AwsServletContext.java

@@ -104,7 +104,7 @@ public static void clearServletContextCache() {
     @Override
     public String getContextPath() {
         // servlets are always at the root.
-        return "/";
+        return "";
     }
 
 

aws-serverless-java-container-core/src/main/java/com/amazonaws/serverless/proxy/internal/servlet/FilterChainManager.java

@@ -93,7 +93,7 @@ public abstract class FilterChainManager<ServletContextType extends ServletConte
      * @return A <code>FilterChainHolder</code> object that can be used to apply the filters to the request
      */
     FilterChainHolder getFilterChain(final HttpServletRequest request, Servlet servlet) {
-        String targetPath = request.getServletPath();
+        String targetPath = request.getRequestURI();
         DispatcherType type = request.getDispatcherType();
 
         // only return the cached result if the filter list hasn't changed in the meanwhile

aws-serverless-java-container-core/src/main/java/com/amazonaws/serverless/proxy/internal/testutils/AwsProxyRequestBuilder.java

@@ -12,6 +12,7 @@
  */
 package com.amazonaws.serverless.proxy.internal.testutils;
 
+import com.amazonaws.serverless.proxy.internal.LambdaContainerHandler;
 import com.amazonaws.serverless.proxy.model.ApiGatewayAuthorizerContext;
 import com.amazonaws.serverless.proxy.model.ApiGatewayRequestContext;
 import com.amazonaws.serverless.proxy.model.ApiGatewayRequestIdentity;
@@ -41,8 +42,6 @@ public class AwsProxyRequestBuilder {
     //-------------------------------------------------------------
 
     private AwsProxyRequest request;
-    private ObjectMapper mapper;
-
 
     //-------------------------------------------------------------
     // Constructors
@@ -59,7 +58,6 @@ public AwsProxyRequestBuilder(String path) {
 
 
     public AwsProxyRequestBuilder(String path, String httpMethod) {
-        this.mapper = new ObjectMapper();
 
         this.request = new AwsProxyRequest();
         this.request.setHeaders(new HashMap<>()); // avoid NPE
@@ -144,7 +142,7 @@ public AwsProxyRequestBuilder body(String body) {
     public AwsProxyRequestBuilder body(Object body) {
         if (request.getHeaders() != null && request.getHeaders().get(HttpHeaders.CONTENT_TYPE).equals(MediaType.APPLICATION_JSON)) {
             try {
-                return body(mapper.writeValueAsString(body));
+                return body(LambdaContainerHandler.getObjectMapper().writeValueAsString(body));
             } catch (JsonProcessingException e) {
                 throw new UnsupportedOperationException("Could not serialize object: " + e.getMessage());
             }
@@ -239,13 +237,13 @@ public AwsProxyRequestBuilder serverName(String serverName) {
 
     public AwsProxyRequestBuilder fromJsonString(String jsonContent)
             throws IOException {
-        request = mapper.readValue(jsonContent, AwsProxyRequest.class);
+        request = LambdaContainerHandler.getObjectMapper().readValue(jsonContent, AwsProxyRequest.class);
         return this;
     }
 
     public AwsProxyRequestBuilder fromJsonPath(String filePath)
             throws IOException {
-        request = mapper.readValue(new File(filePath), AwsProxyRequest.class);
+        request = LambdaContainerHandler.getObjectMapper().readValue(new File(filePath), AwsProxyRequest.class);
         return this;
     }
 

aws-serverless-java-container-core/src/main/java/com/amazonaws/serverless/proxy/model/ContainerConfig.java

@@ -1,6 +1,9 @@
 package com.amazonaws.serverless.proxy.model;
 
 
+import com.amazonaws.serverless.proxy.internal.servlet.AwsProxyHttpServletRequest;
+
+
 /**
  * Configuration parameters for the framework
  */
@@ -12,6 +15,7 @@ public static ContainerConfig defaultConfig() {
         configuration.setStripBasePath(false);
         configuration.setUriEncoding(DEFAULT_URI_ENCODING);
         configuration.setConsolidateSetCookieHeaders(true);
+        configuration.setUseStageAsServletContext(false);
 
         return configuration;
     }
@@ -24,19 +28,29 @@ public static ContainerConfig defaultConfig() {
     private boolean stripBasePath;
     private String uriEncoding;
     private boolean consolidateSetCookieHeaders;
+    private boolean useStageAsServletContext;
 
 
     //-------------------------------------------------------------
     // Methods - Getter/Setter
     //-------------------------------------------------------------
 
+
+    /**
+     * Returns the base path configured in the container. This configuration variable is used in conjuction with {@link #setStripBasePath(boolean)} to route
+     * the request. When requesting the context path from an HttpServletRequest: {@link AwsProxyHttpServletRequest#getContextPath()} this base path is added
+     * to the context even though it was initially stripped for the purpose of routing the request. We decided to add it to the context to address GitHub issue
+     * #84 and allow framework's link builders to it.
+     *
+     * @return The base path configured for the container
+     */
     public String getServiceBasePath() {
         return serviceBasePath;
     }
 
 
     /**
-     * Configures a base path  that can be strippped from the request path before passing it to the frameowkr-specific implementation. This can be used to
+     * Configures a base path  that can be stripped from the request path before passing it to the framework-specific implementation. This can be used to
      * remove API Gateway's base path mappings from the request.
      * @param serviceBasePath The base path mapping to be removed.
      */
@@ -99,4 +113,22 @@ public boolean isConsolidateSetCookieHeaders() {
     public void setConsolidateSetCookieHeaders(boolean consolidateSetCookieHeaders) {
         this.consolidateSetCookieHeaders = consolidateSetCookieHeaders;
     }
+
+
+    /**
+     * Tells whether the stage name passed in the request should be added to the context path: {@link AwsProxyHttpServletRequest#getContextPath()}.
+     * @return true if the stage will be included in the context path, false otherwise.
+     */
+    public boolean isUseStageAsServletContext() {
+        return useStageAsServletContext;
+    }
+
+
+    /**
+     * Sets whether the API Gateway stage name should be included in the servlet context path.
+     * @param useStageAsServletContext true if you want the stage to appear as the root of the context path, false otherwise.
+     */
+    public void setUseStageAsServletContext(boolean useStageAsServletContext) {
+        this.useStageAsServletContext = useStageAsServletContext;
+    }
 }