improving UX when a http exception is encountered

docs/code-howtos/tools.md

@@ -37,7 +37,7 @@ See also: [https://help.github.com/articles/syncing-a-fork/](https://help.github
 (As Administrator - one time)
 
 1. Install [chocolatey](https://chocolatey.org)
-2. `choco install git.install -y --params "/GitAndUnixToolsOnPath /WindowsTerminal"`
+2. `choco install git.install -y --params "/GitAndUnixToolsOnPath /WindowsTerminal`
 3. `choco install notepadplusplus`
 4. If you want to have your JDK also managed via chocolatey: `choco install temurin`
 

src/main/java/org/jabref/gui/importer/fetcher/WebSearchPaneViewModel.java

@@ -2,6 +2,7 @@
 
 import java.util.concurrent.Callable;
 
+import javafx.application.Platform;
 import javafx.beans.property.ListProperty;
 import javafx.beans.property.ObjectProperty;
 import javafx.beans.property.SimpleListProperty;
@@ -14,11 +15,9 @@
 import org.jabref.gui.DialogService;
 import org.jabref.gui.StateManager;
 import org.jabref.gui.importer.ImportEntriesDialog;
+import org.jabref.gui.linkedfile.DownloadLinkedFileAction;
 import org.jabref.gui.util.BackgroundTask;
-import org.jabref.logic.importer.CompositeIdFetcher;
-import org.jabref.logic.importer.ParserResult;
-import org.jabref.logic.importer.SearchBasedFetcher;
-import org.jabref.logic.importer.WebFetchers;
+import org.jabref.logic.importer.*;
 import org.jabref.logic.l10n.Localization;
 import org.jabref.model.strings.StringUtil;
 import org.jabref.model.util.OptionalUtil;
@@ -144,7 +143,20 @@ public void search() {
         }
 
         SearchBasedFetcher activeFetcher = getSelectedFetcher();
-        Callable<ParserResult> parserResultCallable = () -> new ParserResult(activeFetcher.performSearch(query));
+
+        ParserResult parserResult;
+        try{
+            parserResult = new ParserResult(activeFetcher.performSearch(query));
+        } catch (FetcherException e) {
+            if(e.getCause()!=null && e.getCause().getCause() instanceof FetcherClientException clientException)    {
+                    dialogService.showErrorDialogAndWait(e.getMessage(),clientException.getHttpResponse().responseBody(),clientException);
+            } else{
+                dialogService.showErrorDialogAndWait(e.getMessage(),e);
+            }
+            return;
+        }
+
+        Callable<ParserResult> parserResultCallable = () -> parserResult;
         String fetcherName = activeFetcher.getName();
 
         if (CompositeIdFetcher.containsValidId(query)) {

src/main/java/org/jabref/gui/linkedfile/DownloadLinkedFileAction.java

@@ -203,7 +203,7 @@ private void onFailure(URLDownload urlDownload, Exception ex) {
         String failedTitle = Localization.lang("Failed to download from URL");
         int statusCode;
         if (ex instanceof FetcherClientException clientException) {
-            statusCode = clientException.getStatusCode();
+            statusCode = clientException.getHttpResponse().statusCode();
             if (statusCode == 401) {
                 dialogService.showInformationDialogAndWait(failedTitle, Localization.lang("401 Unauthorized: Access Denied. You are not authorized to access this resource. Please check your credentials and try again. If you believe you should have access, please contact the administrator for assistance.\nURL: %0 \n %1", urlDownload.getSource(), fetcherExceptionMessage));
             } else if (statusCode == 403) {

src/main/java/org/jabref/http/dto/SimpleHttpResponse.java

@@ -0,0 +1,62 @@
+package org.jabref.http.dto;
+
+import java.io.BufferedReader;
+import java.io.IOException;
+import java.io.InputStreamReader;
+import java.net.HttpURLConnection;
+import java.nio.charset.StandardCharsets;
+
+public record SimpleHttpResponse(int statusCode, String responseBody , String responseMessage) {
+
+    public SimpleHttpResponse(int statusCode,String responseBody,String responseMessage) {
+        this.statusCode=statusCode;
+        this.responseBody=truncateResponseBody(responseBody);
+        this.responseMessage=responseMessage;
+    }
+
+    public SimpleHttpResponse(HttpURLConnection connection) throws IOException {
+        this(
+                connection.getResponseCode(),
+                getResponseBody(connection),
+                connection.getResponseMessage()
+        );
+    }
+
+    /**
+     * Truncates the response body to 1 KB if it exceeds that size.
+     * Appends "... (truncated)" to indicate truncation.
+     *
+     * @param responseBody  the original response body
+     * @return  the truncated response body
+     */
+    private static String truncateResponseBody(String responseBody) {
+        byte[] bytes = responseBody.getBytes(StandardCharsets.UTF_8);
+        int maxLength = 1024; // 1 KB
+        if (bytes.length > maxLength) {
+            // Truncate the response body to 1 KB and append "... (truncated)"
+            return new String(bytes, 0, maxLength, StandardCharsets.UTF_8) + "... (truncated)";
+        }
+        // Return the original response body if it's within the 1 KB limit
+        return responseBody;
+    }
+
+    /**
+     * Reads the response body from the HttpURLConnection and returns it as a string.
+     * This method is used to retrieve the response body from the connection,
+     * which may contain error messages or other information from the server.
+     *
+     * @param connection the HttpURLConnection to read the response body from
+     * @return the response body as a string
+     * @throws IOException if an I/O error occurs while reading the response body
+     */
+    private static String getResponseBody(HttpURLConnection connection) throws IOException {
+        try (BufferedReader in = new BufferedReader(new InputStreamReader(connection.getErrorStream()))) {
+            String inputLine;
+            StringBuilder content = new StringBuilder();
+            while ((inputLine = in.readLine()) != null) {
+                content.append(inputLine);
+            }
+            return truncateResponseBody(content.toString());
+        }
+    }
+}

src/main/java/org/jabref/logic/importer/FetcherClientException.java

@@ -1,18 +1,20 @@
 package org.jabref.logic.importer;
 
+import org.jabref.http.dto.SimpleHttpResponse;
+
 /**
  * Should be thrown when you encounter an HTTP status code error >= 400 and < 500.
  */
 public class FetcherClientException extends FetcherException {
-    private int statusCode;
+    private SimpleHttpResponse httpResponse;
 
     public FetcherClientException(String errorMessage, Throwable cause) {
         super(errorMessage, cause);
     }
 
-    public FetcherClientException(String errorMessage, Throwable cause, int statusCode) {
+    public FetcherClientException(String errorMessage, Throwable cause, SimpleHttpResponse httpResponse) {
         super(errorMessage, cause);
-        this.statusCode = statusCode;
+        this.httpResponse = httpResponse;
     }
 
     public FetcherClientException(String errorMessage) {
@@ -23,7 +25,13 @@ public FetcherClientException(String errorMessage, String localizedMessage, Thro
         super(errorMessage, localizedMessage, cause);
     }
 
-    public int getStatusCode() {
-        return statusCode;
+    public FetcherClientException(String errorMessage,SimpleHttpResponse httpResponse) {
+        super(errorMessage);
+        this.httpResponse=httpResponse;
     }
+
+    public SimpleHttpResponse getHttpResponse() {
+        return httpResponse;
+    }
+
 }

src/main/java/org/jabref/logic/importer/SearchBasedParserFetcher.java

@@ -59,9 +59,13 @@ private List<BibEntry> getBibEntries(URL urlForQuery) throws FetcherException {
             fetchedEntries.forEach(this::doPostCleanup);
             return fetchedEntries;
         } catch (IOException e) {
-            throw new FetcherException("A network error occurred while fetching from " + urlForQuery, e);
+            throw new FetcherException(("A network error occurred while fetching from " + urlForQuery).replaceAll
+//                   // Regular expression to redact API keys from the error message
+                    ("(?i)(api[_-]?key)=.*","[REDACTED]"), e);
         } catch (ParseException e) {
-            throw new FetcherException("An internal parser error occurred while fetching from " + urlForQuery, e);
+            throw new FetcherException(("An internal parser error occurred while fetching from " + urlForQuery).replaceAll
+                    // Regular expression to redact API keys from the error message
+                    ("(?i)(api[_-]?key)=.*","[REDACTED]"), e);
         }
     }
 

src/main/java/org/jabref/logic/net/URLDownload.java

@@ -40,6 +40,7 @@
 import javax.net.ssl.TrustManager;
 import javax.net.ssl.X509TrustManager;
 
+import org.jabref.http.dto.SimpleHttpResponse;
 import org.jabref.logic.importer.FetcherClientException;
 import org.jabref.logic.importer.FetcherServerException;
 import org.jabref.logic.util.io.FileUtil;
@@ -395,8 +396,9 @@ public URLConnection openConnection() throws IOException {
                 connection = new URLDownload(newUrl).openConnection();
             }
             if ((status >= 400) && (status < 500)) {
+                SimpleHttpResponse httpResponse = new SimpleHttpResponse(lConnection);
                 LOGGER.info("HTTP {}, details: {}, {}", status, lConnection.getResponseMessage(), lConnection.getContentLength() > 0 ? lConnection.getContent() : "");
-                throw new IOException(new FetcherClientException("Encountered HTTP %s %s".formatted(status, lConnection.getResponseMessage())));
+                throw new IOException(new FetcherClientException("Encountered HTTP %s %s".formatted(status, lConnection.getResponseMessage()),httpResponse));
             }
             if (status >= 500) {
                 LOGGER.info("HTTP {}, details: {}, {}", status, lConnection.getResponseMessage(), lConnection.getContentLength() > 0 ? lConnection.getContent() : "");