Merge pull request #894 from lonvia/port-to-javalin

Replace Spark web framework with Javalin

Spark hasn't been updated for a while and it is keeping us at an old version of jetty. This replaces Spark with Javalin, which seems to be the most light-weight of alternatives and is currently still actively maintained. I did consider using jetty directly but that requires quite a bit of manual setup code, which Javalin wraps quite nicely.

The PR contains some heavy refactoring of request handling to prepare for the switch. Request classes are now organised in a inheritance hierarchy, so that shared parameters are only implemented once. The request factories follow the same hierarchy, again meaning that shared parameter can share the parsing code. The handlers for the search endpoints were also essentially duplicates of each other. They have been merged into a generic handler that handles a certain request type.

The tests for the requests factories have been replaced with API integration tests. This made it easier to check that the API behaviour is the same with the new framework. It also means that we can finally get rid of mockito.

There are some minor behaviour changes with Javalin:

*  Cors handling is now done by Jetty and following the spec more strictly.
*  We are using Javalin's parameter check mechanism, which comes with some error reporting that is not the most user friendly and uses a different format than what Photon usually reports. As it is unlikely that there are many users out there that parse 400 responses, we'll leave those as is for now.
*  Boolean parameters now consistently take 'yes', '1' and 'true' for truthy values and everything else as falsy.
*  NaN values for doubles will now consistently throw an error.

Author: lonvia

app/es_embedded/src/main/java/de/komoot/photon/Server.java

@@ -1,10 +1,10 @@
 package de.komoot.photon;
 
-import de.komoot.photon.searcher.StructuredSearchHandler;
-import de.komoot.photon.searcher.ReverseHandler;
-import de.komoot.photon.searcher.SearchHandler;
-import de.komoot.photon.ConfigExtraTags;
 import de.komoot.photon.elasticsearch.*;
+import de.komoot.photon.query.ReverseRequest;
+import de.komoot.photon.query.SimpleSearchRequest;
+import de.komoot.photon.query.StructuredSearchRequest;
+import de.komoot.photon.searcher.SearchHandler;
 import org.elasticsearch.action.get.GetResponse;
 import org.elasticsearch.client.Client;
 import org.elasticsearch.client.transport.TransportClient;
@@ -290,15 +290,15 @@ public Updater createUpdater(DatabaseProperties dbProperties) {
         return new de.komoot.photon.elasticsearch.Updater(esClient, dbProperties);
     }
 
-    public SearchHandler createSearchHandler(String[] languages, int queryTimeoutSec) {
+    public SearchHandler<SimpleSearchRequest> createSearchHandler(String[] languages, int queryTimeoutSec) {
         return new ElasticsearchSearchHandler(esClient, languages, queryTimeoutSec);
     }
 
-    public StructuredSearchHandler createStructuredSearchHandler(String[] languages, int queryTimeoutSec) {
+    public SearchHandler<StructuredSearchRequest> createStructuredSearchHandler(String[] languages, int queryTimeoutSec) {
         throw new UnsupportedOperationException("Structured queries are not supported for elasticsearch-based Photon. Consider to use OpenSearch.");
     }
 
-    public ReverseHandler createReverseHandler(int queryTimeoutSec) {
+    public SearchHandler<ReverseRequest> createReverseHandler(int queryTimeoutSec) {
         return new ElasticsearchReverseHandler(esClient, queryTimeoutSec);
     }
 }

app/es_embedded/src/main/java/de/komoot/photon/elasticsearch/ElasticsearchReverseHandler.java

@@ -1,9 +1,9 @@
 package de.komoot.photon.elasticsearch;
 
+import de.komoot.photon.searcher.SearchHandler;
 import org.locationtech.jts.geom.Point;
 import de.komoot.photon.query.ReverseRequest;
 import de.komoot.photon.searcher.PhotonResult;
-import de.komoot.photon.searcher.ReverseHandler;
 import org.elasticsearch.action.search.SearchRequestBuilder;
 import org.elasticsearch.action.search.SearchResponse;
 import org.elasticsearch.action.search.SearchType;
@@ -21,7 +21,7 @@
 /**
  * Execute a reverse lookup on a Elasticsearch database.
  */
-public class ElasticsearchReverseHandler implements ReverseHandler {
+public class ElasticsearchReverseHandler implements SearchHandler<ReverseRequest> {
     private Client client;
     private TimeValue queryTimeout;
 
@@ -31,7 +31,7 @@ public ElasticsearchReverseHandler(Client client, int queryTimeoutSec) {
     }
 
     @Override
-    public List<PhotonResult> reverse(ReverseRequest photonRequest) {
+    public List<PhotonResult> search(ReverseRequest photonRequest) {
         ReverseQueryBuilder queryBuilder = buildQuery(photonRequest);
         SearchResponse results = search(queryBuilder.buildQuery(), photonRequest.getLimit(), photonRequest.getLocation(),
                 photonRequest.getLocationDistanceSort());

app/es_embedded/src/main/java/de/komoot/photon/elasticsearch/ElasticsearchSearchHandler.java

@@ -1,6 +1,6 @@
 package de.komoot.photon.elasticsearch;
 
-import de.komoot.photon.query.PhotonRequest;
+import de.komoot.photon.query.SimpleSearchRequest;
 import de.komoot.photon.searcher.PhotonResult;
 import de.komoot.photon.searcher.SearchHandler;
 import org.elasticsearch.action.search.SearchResponse;
@@ -16,7 +16,7 @@
 /**
  * Execute a forward lookup on a Elasticsearch database.
  */
-public class ElasticsearchSearchHandler implements SearchHandler {
+public class ElasticsearchSearchHandler implements SearchHandler<SimpleSearchRequest> {
     private final Client client;
     private final String[] supportedLanguages;
     private boolean lastLenient = false;
@@ -29,7 +29,7 @@ public ElasticsearchSearchHandler(Client client, String[] languages, int queryTi
     }
 
     @Override
-    public List<PhotonResult> search(PhotonRequest photonRequest) {
+    public List<PhotonResult> search(SimpleSearchRequest photonRequest) {
         PhotonQueryBuilder queryBuilder = buildQuery(photonRequest, false);
 
         // for the case of deduplication we need a bit more results, #300
@@ -50,11 +50,11 @@ public List<PhotonResult> search(PhotonRequest photonRequest) {
         return ret;
     }
 
-    public String dumpQuery(PhotonRequest photonRequest) {
+    public String dumpQuery(SimpleSearchRequest photonRequest) {
         return buildQuery(photonRequest, lastLenient).buildQuery().toString();
     }
 
-   public PhotonQueryBuilder buildQuery(PhotonRequest photonRequest, boolean lenient) {
+   public PhotonQueryBuilder buildQuery(SimpleSearchRequest photonRequest, boolean lenient) {
        lastLenient = lenient;
         return PhotonQueryBuilder.
                 builder(photonRequest.getQuery(), photonRequest.getLanguage(), supportedLanguages, lenient).

app/es_embedded/src/test/java/de/komoot/photon/elasticsearch/ElasticResultTest.java

@@ -4,9 +4,8 @@
 import de.komoot.photon.Importer;
 import org.locationtech.jts.geom.Coordinate;
 import org.locationtech.jts.geom.Point;
-import de.komoot.photon.query.PhotonRequest;
+import de.komoot.photon.query.SimpleSearchRequest;
 import de.komoot.photon.searcher.PhotonResult;
-import de.komoot.photon.searcher.SearchHandler;
 import org.junit.jupiter.api.AfterAll;
 import org.junit.jupiter.api.BeforeAll;
 import org.junit.jupiter.api.Test;
@@ -68,14 +67,16 @@ void setUp(@TempDir Path dataDirectory) throws Exception {
 
     @AfterAll
     @Override
-    public void tearDown() throws IOException {
-        super.tearDown();
+    public void tearDown() {
+        shutdownES();
     }
 
     private PhotonResult search(String query) {
-        SearchHandler handler = getServer().createSearchHandler(new String[]{"en", "de", "it"}, 1);
+        var handler = getServer().createSearchHandler(new String[]{"en", "de", "it"}, 1);
+        final var request = new SimpleSearchRequest();
+        request.setQuery(query);
 
-        return handler.search(new PhotonRequest(query, "default")).get(0);
+        return handler.search(request).get(0);
     }
 
 

app/opensearch/src/main/java/de/komoot/photon/Server.java

@@ -3,9 +3,10 @@
 import com.fasterxml.jackson.core.Version;
 import com.fasterxml.jackson.databind.module.SimpleModule;
 import de.komoot.photon.opensearch.*;
-import de.komoot.photon.searcher.ReverseHandler;
+import de.komoot.photon.query.ReverseRequest;
+import de.komoot.photon.query.SimpleSearchRequest;
+import de.komoot.photon.query.StructuredSearchRequest;
 import de.komoot.photon.searcher.SearchHandler;
-import de.komoot.photon.searcher.StructuredSearchHandler;
 import org.apache.hc.core5.http.HttpHost;
 import org.codelibs.opensearch.runner.OpenSearchRunner;
 import org.opensearch.client.json.jackson.JacksonJsonpMapper;
@@ -184,15 +185,15 @@ public Updater createUpdater(DatabaseProperties dbProperties) {
         return new de.komoot.photon.opensearch.Updater(client);
     }
 
-    public SearchHandler createSearchHandler(String[] languages, int queryTimeoutSec) {
+    public SearchHandler<SimpleSearchRequest> createSearchHandler(String[] languages, int queryTimeoutSec) {
         return new OpenSearchSearchHandler(client, languages, queryTimeoutSec);
     }
 
-    public StructuredSearchHandler createStructuredSearchHandler(String[] languages, int queryTimeoutSec) {
+    public SearchHandler<StructuredSearchRequest> createStructuredSearchHandler(String[] languages, int queryTimeoutSec) {
         return new OpenSearchStructuredSearchHandler(client, languages, queryTimeoutSec);
     }
 
-    public ReverseHandler createReverseHandler(int queryTimeoutSec) {
+    public SearchHandler<ReverseRequest> createReverseHandler(int queryTimeoutSec) {
         return new OpenSearchReverseHandler(client, queryTimeoutSec);
     }
 

app/opensearch/src/main/java/de/komoot/photon/opensearch/OpenSearchReverseHandler.java

@@ -2,7 +2,7 @@
 
 import de.komoot.photon.query.ReverseRequest;
 import de.komoot.photon.searcher.PhotonResult;
-import de.komoot.photon.searcher.ReverseHandler;
+import de.komoot.photon.searcher.SearchHandler;
 import org.locationtech.jts.geom.Point;
 import org.opensearch.client.opensearch.OpenSearchClient;
 import org.opensearch.client.opensearch._types.SearchType;
@@ -14,7 +14,7 @@
 import java.util.ArrayList;
 import java.util.List;
 
-public class OpenSearchReverseHandler implements ReverseHandler {
+public class OpenSearchReverseHandler implements SearchHandler<ReverseRequest> {
     private final OpenSearchClient client;
     private final String queryTimeout;
 
@@ -24,7 +24,7 @@ public OpenSearchReverseHandler(OpenSearchClient client, int queryTimeoutSec) {
     }
 
     @Override
-    public List<PhotonResult> reverse(ReverseRequest request) {
+    public List<PhotonResult> search(ReverseRequest request) {
         final var queryBuilder = new ReverseQueryBuilder(request.getLocation(), request.getRadius(), request.getQueryStringFilter(), request.getLayerFilters())
                 .withOsmTagFilters(request.getOsmTagFilters());
 

app/opensearch/src/main/java/de/komoot/photon/opensearch/OpenSearchSearchHandler.java

@@ -1,6 +1,6 @@
 package de.komoot.photon.opensearch;
 
-import de.komoot.photon.query.PhotonRequest;
+import de.komoot.photon.query.SimpleSearchRequest;
 import de.komoot.photon.searcher.PhotonResult;
 import de.komoot.photon.searcher.SearchHandler;
 import org.opensearch.client.opensearch.OpenSearchClient;
@@ -12,7 +12,7 @@
 import java.util.ArrayList;
 import java.util.List;
 
-public class OpenSearchSearchHandler implements SearchHandler {
+public class OpenSearchSearchHandler implements SearchHandler<SimpleSearchRequest> {
     private final OpenSearchClient client;
     private final String[] supportedLanguages;
     private final String queryTimeout;
@@ -24,7 +24,7 @@ public OpenSearchSearchHandler(OpenSearchClient client, String[] supportedLangua
     }
 
     @Override
-    public List<PhotonResult> search(PhotonRequest request) {
+    public List<PhotonResult> search(SimpleSearchRequest request) {
         final int limit = request.getLimit();
         final int extLimit = limit > 1 ? (int) Math.round(limit * 1.5) : 1;
 
@@ -43,11 +43,11 @@ public List<PhotonResult> search(PhotonRequest request) {
     }
 
     @Override
-    public String dumpQuery(PhotonRequest photonRequest) {
-        return null;
+    public String dumpQuery(SimpleSearchRequest simpleSearchRequest) {
+        return "{}";
     }
 
-    private SearchQueryBuilder buildQuery(PhotonRequest request, boolean lenient) {
+    private SearchQueryBuilder buildQuery(SimpleSearchRequest request, boolean lenient) {
         return new SearchQueryBuilder(request.getQuery(), request.getLanguage(), supportedLanguages, lenient).
                 withOsmTagFilters(request.getOsmTagFilters()).
                 withLayerFilters(request.getLayerFilters()).

app/opensearch/src/main/java/de/komoot/photon/opensearch/OpenSearchStructuredSearchHandler.java

@@ -1,8 +1,8 @@
 package de.komoot.photon.opensearch;
 
-import de.komoot.photon.searcher.StructuredSearchHandler;
 import de.komoot.photon.searcher.PhotonResult;
-import de.komoot.photon.query.StructuredPhotonRequest;
+import de.komoot.photon.query.StructuredSearchRequest;
+import de.komoot.photon.searcher.SearchHandler;
 import org.opensearch.client.opensearch.OpenSearchClient;
 import org.opensearch.client.opensearch._types.SearchType;
 import org.opensearch.client.opensearch._types.query_dsl.Query;
@@ -15,7 +15,7 @@
 /**
  * Execute a structured forward lookup on an Elasticsearch database.
  */
-public class OpenSearchStructuredSearchHandler implements StructuredSearchHandler {
+public class OpenSearchStructuredSearchHandler implements SearchHandler<StructuredSearchRequest> {
     private final OpenSearchClient client;
     private final String[] supportedLanguages;
     private final String queryTimeout;
@@ -27,7 +27,7 @@ public OpenSearchStructuredSearchHandler(OpenSearchClient client, String[] langu
     }
 
     @Override
-    public List<PhotonResult> search(StructuredPhotonRequest photonRequest) {
+    public List<PhotonResult> search(StructuredSearchRequest photonRequest) {
         var queryBuilder = buildQuery(photonRequest, false);
 
         // for the case of deduplication we need a bit more results, #300
@@ -58,7 +58,12 @@ public List<PhotonResult> search(StructuredPhotonRequest photonRequest) {
         return ret;
     }
 
-    public SearchQueryBuilder buildQuery(StructuredPhotonRequest photonRequest, boolean lenient) {
+    @Override
+    public String dumpQuery(StructuredSearchRequest searchRequest) {
+        return "{}";
+    }
+
+    public SearchQueryBuilder buildQuery(StructuredSearchRequest photonRequest, boolean lenient) {
         return new SearchQueryBuilder(photonRequest, photonRequest.getLanguage(), supportedLanguages, lenient).
                 withOsmTagFilters(photonRequest.getOsmTagFilters()).
                 withLayerFilters(photonRequest.getLayerFilters()).

app/opensearch/src/main/java/de/komoot/photon/opensearch/SearchQueryBuilder.java

@@ -1,7 +1,7 @@
 package de.komoot.photon.opensearch;
 
 import de.komoot.photon.searcher.TagFilter;
-import de.komoot.photon.query.StructuredPhotonRequest;
+import de.komoot.photon.query.StructuredSearchRequest;
 import de.komoot.photon.Constants;
 import org.locationtech.jts.geom.Envelope;
 import org.locationtech.jts.geom.Point;
@@ -142,7 +142,7 @@ public SearchQueryBuilder(String query, String language, String[] languages, boo
                         .field(String.format("name.%s.raw", language))));
     }
 
-    public SearchQueryBuilder(StructuredPhotonRequest request, String language, String[] languages, boolean lenient)
+    public SearchQueryBuilder(StructuredSearchRequest request, String language, String[] languages, boolean lenient)
     {
         var hasSubStateField = request.hasCounty() || request.hasCityOrPostCode() || request.hasDistrict() || request.hasStreet();
         var query4QueryBuilder = new AddressQueryBuilder(lenient, language, languages)