Merge pull request #233 from GenomicDataInfrastructure/add-language-tag

feat(api): implement Accept-Language header support for dataset queri…

Author: qplevier

src/main/java/io/github/genomicdatainfrastructure/discovery/api/DatasetQueryApiImpl.java

@@ -10,9 +10,16 @@
 import io.github.genomicdatainfrastructure.discovery.model.DatasetSearchQuery;
 import io.quarkus.oidc.runtime.OidcJwtCallerPrincipal;
 import io.quarkus.security.identity.SecurityIdentity;
+import io.smallrye.common.constraint.Nullable;
+import jakarta.ws.rs.core.HttpHeaders;
+import jakarta.ws.rs.core.Context;
 import jakarta.ws.rs.core.Response;
+import org.eclipse.microprofile.config.inject.ConfigProperty;
 import lombok.RequiredArgsConstructor;
 
+import java.util.List;
+import java.util.Locale;
+
 @RequiredArgsConstructor
 public class DatasetQueryApiImpl implements DatasetQueryApi {
 
@@ -21,15 +28,23 @@ public class DatasetQueryApiImpl implements DatasetQueryApi {
     private final RetrieveDatasetQuery retrieveDatasetQuery;
     private final SearchDatasetsQuery searchDatasetsQuery;
 
+    @Context
+    HttpHeaders headers;
+
+    @ConfigProperty(name = "app.accept-language.default", defaultValue = "en")
+    String defaultAcceptLanguage;
+
     @Override
-    public Response datasetSearch(DatasetSearchQuery datasetSearchQuery) {
-        var content = searchDatasetsQuery.execute(datasetSearchQuery, accessToken());
+    public Response datasetSearch(String acceptLanguage, DatasetSearchQuery datasetSearchQuery) {
+        var preferredLanguage = preferredLanguage();
+        var content = searchDatasetsQuery.execute(datasetSearchQuery, accessToken(),
+                preferredLanguage);
         return Response.ok(content).build();
     }
 
     @Override
-    public Response retrieveDataset(String id) {
-        var content = retrieveDatasetQuery.execute(id, accessToken());
+    public Response retrieveDataset(String id, String acceptLanguage) {
+        var content = retrieveDatasetQuery.execute(id, accessToken(), preferredLanguage());
         return Response.ok(content).build();
     }
 
@@ -60,4 +75,19 @@ private String accessToken() {
         var principal = (OidcJwtCallerPrincipal) identity.getPrincipal();
         return principal.getRawToken();
     }
+
+    private String preferredLanguage() {
+        return getString(headers, defaultAcceptLanguage);
+    }
+
+    @Nullable
+    public static String getString(HttpHeaders headers, String defaultAcceptLanguage) {
+        List<Locale> languages = headers.getAcceptableLanguages();
+        if (languages != null && !languages.isEmpty()) {
+            return languages.getFirst().toLanguageTag().toLowerCase(Locale.ROOT);
+        }
+        return (defaultAcceptLanguage == null || defaultAcceptLanguage.isBlank())
+                ? null
+                : defaultAcceptLanguage;
+    }
 }

src/main/java/io/github/genomicdatainfrastructure/discovery/datasets/application/ports/DatasetsRepository.java

@@ -17,9 +17,10 @@ List<SearchedDataset> search(
             String sort,
             Integer rows,
             Integer start,
-            String accessToken);
+            String accessToken,
+            String preferredLanguage);
 
-    RetrievedDataset findById(String id, String accessToken);
+    RetrievedDataset findById(String id, String accessToken, String preferredLanguage);
 
     String retrieveDatasetInFormat(String id, String format, String accessToken);
 }

src/main/java/io/github/genomicdatainfrastructure/discovery/datasets/application/usecases/RetrieveDatasetQuery.java

@@ -16,7 +16,8 @@ public class RetrieveDatasetQuery {
 
     private final DatasetsRepository repository;
 
-    public RetrievedDataset execute(String datasetId, String accessToken) {
-        return repository.findById(datasetId, accessToken);
+    public RetrievedDataset execute(String datasetId, String accessToken,
+            String preferredLanguage) {
+        return repository.findById(datasetId, accessToken, preferredLanguage);
     }
 }

src/main/java/io/github/genomicdatainfrastructure/discovery/datasets/application/usecases/SearchDatasetsQuery.java

@@ -28,7 +28,8 @@ public class SearchDatasetsQuery {
     private final DatasetsRepository repository;
     private final Instance<DatasetIdsCollector> collectors;
 
-    public DatasetsSearchResponse execute(DatasetSearchQuery query, String accessToken) {
+    public DatasetsSearchResponse execute(DatasetSearchQuery query, String accessToken,
+            String preferredLanguage) {
         var datasetIdsByRecordCount = collectors
                 .stream()
                 .map(collector -> collector.collect(query, accessToken))
@@ -40,7 +41,8 @@ public DatasetsSearchResponse execute(DatasetSearchQuery query, String accessTok
                 query.getSort(),
                 query.getRows(),
                 query.getStart(),
-                accessToken);
+                accessToken,
+                preferredLanguage);
 
         var enhancedDatasets = datasets
                 .stream()

src/main/java/io/github/genomicdatainfrastructure/discovery/datasets/infrastructure/ckan/persistence/CkanDatasetIdsCollector.java

@@ -43,6 +43,7 @@ public Map<String, Integer> collect(DatasetSearchQuery query, String accessToken
                 .build();
 
         var response = ckanQueryApi.packageSearch(
+                null,
                 request
         );
 

src/main/java/io/github/genomicdatainfrastructure/discovery/datasets/infrastructure/ckan/persistence/CkanDatasetsRepository.java

@@ -41,7 +41,8 @@ public List<SearchedDataset> search(
             String sort,
             Integer rows,
             Integer start,
-            String accessToken) {
+            String accessToken,
+            String preferredLanguage) {
 
         if (datasetIds == null || datasetIds.isEmpty()) {
             return List.of();
@@ -70,16 +71,17 @@ public List<SearchedDataset> search(
                 .build();
 
         var response = ckanQueryApi.packageSearch(
+                preferredLanguage,
                 request
         );
 
         return ckanDatasetsMapper.map(response.getResult());
     }
 
     @Override
-    public RetrievedDataset findById(String id, String accessToken) {
+    public RetrievedDataset findById(String id, String accessToken, String preferredLanguage) {
         try {
-            var ckanPackage = ckanQueryApi.packageShow(id);
+            var ckanPackage = ckanQueryApi.packageShow(id, preferredLanguage);
             return ckanDatasetsMapper.map(ckanPackage.getResult());
         } catch (WebApplicationException e) {
             if (e.getResponse().getStatus() == 404) {

src/main/java/io/github/genomicdatainfrastructure/discovery/filters/application/ports/FilterBuilder.java

@@ -10,5 +10,5 @@
 
 public interface FilterBuilder {
 
-    List<Filter> build(String accessToken);
+    List<Filter> build(String accessToken, String preferredLanguage);
 }

src/main/java/io/github/genomicdatainfrastructure/discovery/filters/application/ports/FiltersRepository.java

@@ -9,6 +9,6 @@
 
 public interface FiltersRepository {
 
-    List<ValueLabel> getValuesForFilter(String key);
+    List<ValueLabel> getValuesForFilter(String key, String preferredLanguage);
 
 }

src/main/java/io/github/genomicdatainfrastructure/discovery/filters/application/usecases/RetrieveFiltersQuery.java

@@ -27,10 +27,10 @@ public class RetrieveFiltersQuery {
     private final Instance<FilterBuilder> filterBuilders;
     private final DatasetsConfig datasetsConfig;
 
-    public List<Filter> execute(String accessToken) {
+    public List<Filter> execute(String accessToken, String preferredLanguage) {
         return filterBuilders
                 .stream()
-                .map(filterBuilder -> filterBuilder.build(accessToken))
+                .map(filterBuilder -> filterBuilder.build(accessToken, preferredLanguage))
                 .filter(Objects::nonNull)
                 .flatMap(Collection::stream)
                 .map(this::mapGroup)

src/main/java/io/github/genomicdatainfrastructure/discovery/filters/application/usecases/RetrieveFiltersValuesQuery.java

@@ -17,8 +17,8 @@ public class RetrieveFiltersValuesQuery {
 
     private final FiltersRepository filtersRepository;
 
-    public List<ValueLabel> execute(String key) {
-        return filtersRepository.getValuesForFilter(key);
+    public List<ValueLabel> execute(String key, String preferredLanguage) {
+        return filtersRepository.getValuesForFilter(key, preferredLanguage);
     }
 
 }