Fix errors in cayw endpoint (#13478)

* fix internal server issue upon request

* fix content type according to the response

* undo

* remove throws and add default return of Formatter

---------

Co-authored-by: iloveskittles <40355179+iloveskittles82@users.noreply.github.com>

Author: palukku

jabsrv/src/main/java/org/jabref/http/server/cayw/CAYWResource.java

@@ -19,6 +19,7 @@
 import javafx.application.Platform;
 
 import org.jabref.architecture.AllowedToUseAwt;
+import org.jabref.http.server.cayw.format.CAYWFormatter;
 import org.jabref.http.server.cayw.format.FormatterService;
 import org.jabref.http.server.cayw.gui.CAYWEntry;
 import org.jabref.http.server.cayw.gui.SearchDialog;
@@ -37,8 +38,6 @@
 import jakarta.ws.rs.BeanParam;
 import jakarta.ws.rs.GET;
 import jakarta.ws.rs.Path;
-import jakarta.ws.rs.Produces;
-import jakarta.ws.rs.core.MediaType;
 import jakarta.ws.rs.core.Response;
 import org.jspecify.annotations.Nullable;
 import org.slf4j.Logger;
@@ -64,14 +63,12 @@ public class CAYWResource {
     private ContextsToServe contextsToServe;
 
     @GET
-    @Produces(MediaType.TEXT_PLAIN)
     public Response getCitation(
             @BeanParam CAYWQueryParams queryParams
     ) throws IOException, ExecutionException, InterruptedException {
         if (queryParams.isProbe()) {
             return Response.ok("ready").build();
         }
-
         BibDatabaseContext databaseContext = getBibDatabaseContext(queryParams);
 
         /* unused until DatabaseSearcher is fixed
@@ -111,17 +108,18 @@ public Response getCitation(
         }
 
         // Format parameter handling
-        String response = formatterService.format(queryParams, searchResults);
+        CAYWFormatter formatter = formatterService.getFormatter(queryParams);
+        String formattedResponse = formatter.format(queryParams, searchResults);
 
         // Clipboard parameter handling
         if (queryParams.isClipboard()) {
             Toolkit toolkit = Toolkit.getDefaultToolkit();
             Clipboard systemClipboard = toolkit.getSystemClipboard();
-            StringSelection strSel = new StringSelection(response);
+            StringSelection strSel = new StringSelection(formattedResponse);
             systemClipboard.setContents(strSel, null);
         }
 
-        return Response.ok(response).build();
+        return Response.ok(formattedResponse).type(formatter.getMediaType()).build();
     }
 
     private BibDatabaseContext getBibDatabaseContext(CAYWQueryParams queryParams) throws IOException {
@@ -186,7 +184,7 @@ private BibDatabaseContext getDatabaseContextFromStream(InputStream inputStream)
     private synchronized void initializeGUI() {
         // TODO: Implement a better way to handle the window popup since this is a bit hacky.
         if (!initialized) {
-            if (!contextsToServe.getContextsToServe().isEmpty()) {
+            if (!contextsToServe.isEmpty()) {
                 LOGGER.debug("Running inside JabRef UI, no need to initialize JavaFX for CAYW resource.");
                 initialized = true;
                 return;

jabsrv/src/main/java/org/jabref/http/server/cayw/format/BibLatexFormatter.java

@@ -7,6 +7,7 @@
 import org.jabref.http.server.cayw.gui.CAYWEntry;
 import org.jabref.model.entry.BibEntry;
 
+import jakarta.ws.rs.core.MediaType;
 import org.jvnet.hk2.annotations.Service;
 
 @Service
@@ -17,6 +18,11 @@ public String getFormatName() {
         return "biblatex";
     }
 
+    @Override
+    public MediaType getMediaType() {
+        return MediaType.TEXT_PLAIN_TYPE;
+    }
+
     @Override
     public String format(CAYWQueryParams queryParams, List<CAYWEntry> caywEntries) {
         String command = queryParams.getCommand();

jabsrv/src/main/java/org/jabref/http/server/cayw/format/CAYWFormatter.java

@@ -5,9 +5,13 @@
 import org.jabref.http.server.cayw.CAYWQueryParams;
 import org.jabref.http.server.cayw.gui.CAYWEntry;
 
+import jakarta.ws.rs.core.MediaType;
+
 public interface CAYWFormatter {
 
     String getFormatName();
 
+    MediaType getMediaType();
+
     String format(CAYWQueryParams caywQueryParams, List<CAYWEntry> caywEntries);
 }

jabsrv/src/main/java/org/jabref/http/server/cayw/format/FormatterService.java

@@ -1,17 +1,16 @@
 package org.jabref.http.server.cayw.format;
 
 import java.util.HashMap;
-import java.util.List;
 import java.util.Map;
 
 import org.jabref.http.server.cayw.CAYWQueryParams;
-import org.jabref.http.server.cayw.gui.CAYWEntry;
 
 import org.jvnet.hk2.annotations.Service;
 
 @Service
 public class FormatterService {
 
+    private static final String DEFAULT_FORMATTER = "biblatex";
     private final Map<String, CAYWFormatter> formatters;
 
     public FormatterService() {
@@ -24,8 +23,7 @@ public void registerFormatter(CAYWFormatter formatter) {
         formatters.putIfAbsent(formatter.getFormatName(), formatter);
     }
 
-    public String format(CAYWQueryParams queryParams, List<CAYWEntry> caywEntries) throws IllegalArgumentException {
-        CAYWFormatter formatter = formatters.get(queryParams.getFormat().toLowerCase());
-        return formatter.format(queryParams, caywEntries);
+    public CAYWFormatter getFormatter(CAYWQueryParams queryParams) {
+        return formatters.getOrDefault(queryParams.getFormat().toLowerCase(), formatters.get(DEFAULT_FORMATTER));
     }
 }

jabsrv/src/main/java/org/jabref/http/server/cayw/format/SimpleJsonFormatter.java

@@ -8,6 +8,7 @@
 import org.jabref.http.server.cayw.gui.CAYWEntry;
 
 import com.google.gson.Gson;
+import jakarta.ws.rs.core.MediaType;
 import org.jvnet.hk2.annotations.Service;
 
 @Service
@@ -24,6 +25,11 @@ public String getFormatName() {
         return "simple-json";
     }
 
+    @Override
+    public MediaType getMediaType() {
+        return MediaType.APPLICATION_JSON_TYPE;
+    }
+
     @Override
     public String format(CAYWQueryParams queryParams, List<CAYWEntry> caywEntries) {
         List<SimpleJson> simpleJsons = caywEntries.stream()