Improved performance of HEAD requests

FraunhoferIOSB · Nov 8, 2024 · 714b036 · 714b036
1 parent 4406612
commit 714b036
Show file tree

Hide file tree

Showing 4 changed files with 31 additions and 4 deletions.
diff --git a/FROST-Server.Core/src/main/java/de/fraunhofer/iosb/ilt/frostserver/service/Service.java b/FROST-Server.Core/src/main/java/de/fraunhofer/iosb/ilt/frostserver/service/Service.java
@@ -382,6 +382,14 @@ private ServiceResponse handleGet(PersistenceManager pm, ServiceRequest request,
             return errorResponse(response, version.getCannedResponse(Version.CannedResponseType.NOTHING_FOUND));
         }
         try {
+            if (request.isHead()) {
+                // Execute the query to check if it works. Doesn't actually fetch data.
+                query.setTop(0);
+                pm.get(path, query);
+                response.setMessage("");
+                response.setCode(200);
+                return response;
+            }
             Object object = pm.get(path, query);
             if (object == null) {
                 if (path.isValue() || path.isEntityProperty()) {

diff --git a/...-Server.Core/src/main/java/de/fraunhofer/iosb/ilt/frostserver/service/ServiceRequest.java b/...-Server.Core/src/main/java/de/fraunhofer/iosb/ilt/frostserver/service/ServiceRequest.java
@@ -48,6 +48,7 @@ public class ServiceRequest {
     private static final ThreadLocal<ServiceRequest> LOCAL_REQUEST = new ThreadLocal<>();
 
     private String requestType;
+    private boolean head;
     private String urlPath;
     private String urlQuery;
     private String contentString;
@@ -97,6 +98,21 @@ public ServiceRequest setRequestType(String requestType) {
         return this;
     }
 
+    /**
+     * Indicates the read request is a HEAD request and does not expect data in
+     * the response.
+     *
+     * @return true if it is a HEAD request.
+     */
+    public boolean isHead() {
+        return head;
+    }
+
+    public ServiceRequest setHead(boolean head) {
+        this.head = head;
+        return this;
+    }
+
     /**
      * Get the content as a String.
      *

diff --git a/...mmon/src/main/java/de/fraunhofer/iosb/ilt/frostserver/http/common/HttpRequestDecoder.java b/...mmon/src/main/java/de/fraunhofer/iosb/ilt/frostserver/http/common/HttpRequestDecoder.java
@@ -32,6 +32,7 @@
 import de.fraunhofer.iosb.ilt.frostserver.settings.CoreSettings;
 import de.fraunhofer.iosb.ilt.frostserver.settings.annotation.DefaultValue;
 import de.fraunhofer.iosb.ilt.frostserver.settings.annotation.DefaultValueBoolean;
+import de.fraunhofer.iosb.ilt.frostserver.util.HttpMethod;
 import de.fraunhofer.iosb.ilt.frostserver.util.StringHelper;
 import de.fraunhofer.iosb.ilt.frostserver.util.user.PrincipalExtended;
 import jakarta.servlet.http.HttpServletRequest;
@@ -137,8 +138,9 @@ public ServiceRequest serviceRequestFromHttpRequest(HttpServletRequest request)
             return null;
         }
 
-        final String method = request.getMethod();
-        String requestType = PluginManager.decodeRequestType(plugin, version, path, method, request.getContentType());
+        final HttpMethod method = HttpMethod.fromString(request.getMethod());
+        final String requestType = PluginManager.decodeRequestType(plugin, version, path, method, request.getContentType());
+        final boolean head = method == HttpMethod.HEAD;
 
         final Map<String, List<String>> parameterMap = UrlHelper.splitQuery(request.getQueryString());
         decodeAccepHeader(request, parameterMap);
@@ -149,6 +151,7 @@ public ServiceRequest serviceRequestFromHttpRequest(HttpServletRequest request)
                 .setQueryDefaults(queryDefaults)
                 .setVersion(version)
                 .setRequestType(requestType)
+                .setHead(head)
                 .setUrlPath(path)
                 .setUrlQuery(request.getQueryString() != null
                         ? StringHelper.urlDecode(request.getQueryString())

diff --git a/FROST-Server.Tests/src/test/java/de/fraunhofer/iosb/ilt/statests/util/EntityUtils.java b/FROST-Server.Tests/src/test/java/de/fraunhofer/iosb/ilt/statests/util/EntityUtils.java
@@ -549,8 +549,8 @@ public static void testHeadRequest(SensorThingsService service, String url, fina
         try {
             headResponse = HTTPMethods.doHead(service, url);
             if (headResponse.code != getStatusCode) {
-                LOGGER.error("Different status code for GET ({}) and HEAD ({})", getStatusCode, headResponse.code);
-                fail("Different status code for GET (" + getStatusCode + ") and HEAD (" + headResponse.code + ")");
+                LOGGER.error("Different status code for GET ({}) and HEAD ({}) on {}", getStatusCode, headResponse.code, url);
+                fail("Different status code for GET (" + getStatusCode + ") and HEAD (" + headResponse.code + ") on " + url);
             }
         } catch (IOException ex) {
             LOGGER.error("Exception:", ex);