From b9aa8ac5a46b8b0aa4fe8a36510e2b1876fc5d66 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Ren=C3=A9=20Pfeuffer?= <rene.pfeuffer@cloudogu.com>
Date: Tue, 1 Sep 2020 12:04:34 +0200
Subject: [PATCH] Map WebApplicationExceptions from JaxRS to appropriate
 response

---
 CHANGELOG.md                                  |  1 +
 .../api/WebApplicationExceptionMapper.java    | 63 +++++++++++++++++++
 .../main/resources/locales/de/plugins.json    |  4 ++
 .../main/resources/locales/en/plugins.json    |  4 ++
 4 files changed, 72 insertions(+)
 create mode 100644 scm-webapp/src/main/java/sonia/scm/api/WebApplicationExceptionMapper.java

diff --git a/CHANGELOG.md b/CHANGELOG.md
index 794efe3b8d..a64adee8f0 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -12,6 +12,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Fix text-overflow in danger zone ([#1298](https://github.com/scm-manager/scm-manager/pull/1298))
 - Fix plugin installation error if previously a plugin was installed with the same dependency which is still pending. ([#1300](https://github.com/scm-manager/scm-manager/pull/1300))
 - Remove obsolete revision encoding on sources ([#1315](https://github.com/scm-manager/scm-manager/pull/1315))
+- Map generic JaxRS 'web application exceptions' to appropriate response instead of "internal server error" ([#1318](https://github.com/scm-manager/scm-manager/pull/1312))
 
 ## [2.4.0] - 2020-08-14
 ### Added
diff --git a/scm-webapp/src/main/java/sonia/scm/api/WebApplicationExceptionMapper.java b/scm-webapp/src/main/java/sonia/scm/api/WebApplicationExceptionMapper.java
new file mode 100644
index 0000000000..41ec6787ef
--- /dev/null
+++ b/scm-webapp/src/main/java/sonia/scm/api/WebApplicationExceptionMapper.java
@@ -0,0 +1,63 @@
+/*
+ * MIT License
+ *
+ * Copyright (c) 2020-present Cloudogu GmbH and Contributors
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+package sonia.scm.api;
+
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import org.slf4j.MDC;
+import sonia.scm.api.v2.resources.ErrorDto;
+import sonia.scm.web.VndMediaType;
+
+import javax.ws.rs.WebApplicationException;
+import javax.ws.rs.core.Response;
+import javax.ws.rs.ext.ExceptionMapper;
+import javax.ws.rs.ext.Provider;
+import java.util.Collections;
+
+@Provider
+public class WebApplicationExceptionMapper implements ExceptionMapper<WebApplicationException> {
+
+  private static final Logger LOG = LoggerFactory.getLogger(WebApplicationExceptionMapper.class);
+
+  private static final String ERROR_CODE = "FVS9JY1T21";
+
+  @Override
+  public Response toResponse(WebApplicationException exception) {
+    LOG.trace("caught web application exception", exception);
+
+    ErrorDto errorDto = new ErrorDto();
+    errorDto.setMessage(exception.getMessage());
+    errorDto.setContext(Collections.emptyList());
+    errorDto.setErrorCode(ERROR_CODE);
+    errorDto.setTransactionId(MDC.get("transaction_id"));
+
+    Response originalResponse = exception.getResponse();
+
+    return Response.fromResponse(originalResponse)
+      .entity(errorDto)
+      .type(VndMediaType.ERROR_TYPE)
+      .build();
+  }
+}
diff --git a/scm-webapp/src/main/resources/locales/de/plugins.json b/scm-webapp/src/main/resources/locales/de/plugins.json
index 169c38cd85..c5ab04d950 100644
--- a/scm-webapp/src/main/resources/locales/de/plugins.json
+++ b/scm-webapp/src/main/resources/locales/de/plugins.json
@@ -268,6 +268,10 @@
     "BxS5wX2v71": {
       "displayName": "Inkorrekter Schlüssel",
       "description": "Der bereitgestellte Schlüssel ist kein korrekt formartierter öffentlicher Schlüssel."
+    },
+    "FVS9JY1T21": {
+      "displayName": "Fehler bei der Anfrage",
+      "description": "Bei der Anfrage trat ein Fehler auf. Prüfen Sie bitte den Status der HTTP Antwort und die konkrete Meldung."
     }
   },
   "namespaceStrategies": {
diff --git a/scm-webapp/src/main/resources/locales/en/plugins.json b/scm-webapp/src/main/resources/locales/en/plugins.json
index c65c506386..7338d53267 100644
--- a/scm-webapp/src/main/resources/locales/en/plugins.json
+++ b/scm-webapp/src/main/resources/locales/en/plugins.json
@@ -268,6 +268,10 @@
     "BxS5wX2v71": {
       "displayName": "Invalid key",
       "description": "The provided key is not a valid public key."
+    },
+    "FVS9JY1T21": {
+      "displayName": "Error in the request",
+      "description": "While processing the request there was an error. Please check the http return status and the concrete error message."
     }
   },
   "namespaceStrategies": {