EPMRPP-100452 || refactor exception handling

build.gradle

@@ -68,7 +68,7 @@ dependencies {
         implementation 'com.epam.reportportal:plugin-api'
     } else {
         println("Using snapshot dependencies")
-        implementation 'com.github.reportportal:commons:d76faf7'
+        implementation 'com.github.reportportal:commons:356c23c'
         implementation 'com.github.reportportal:commons-dao:1296d7c'
         implementation 'com.github.reportportal:plugin-api:21310d8'
     }

src/main/java/com/epam/ta/reportportal/core/configs/MvcConfig.java

@@ -16,11 +16,6 @@
 
 package com.epam.ta.reportportal.core.configs;
 
-import com.epam.reportportal.rules.commons.ExceptionMappings;
-import com.epam.reportportal.rules.commons.exception.forwarding.ClientResponseForwardingExceptionHandler;
-import com.epam.reportportal.rules.commons.exception.rest.DefaultErrorResolver;
-import com.epam.reportportal.rules.commons.exception.rest.ReportPortalExceptionResolver;
-import com.epam.reportportal.rules.commons.exception.rest.RestExceptionHandler;
 import com.epam.ta.reportportal.ws.resolver.ActiveUserWebArgumentResolver;
 import com.epam.ta.reportportal.ws.resolver.FilterCriteriaResolver;
 import com.epam.ta.reportportal.ws.resolver.JsonViewSupportFactoryBean;
@@ -35,15 +30,13 @@
 import org.springframework.boot.autoconfigure.http.HttpMessageConverters;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
-import org.springframework.core.Ordered;
 import org.springframework.http.MediaType;
 import org.springframework.http.converter.ByteArrayHttpMessageConverter;
 import org.springframework.http.converter.HttpMessageConverter;
 import org.springframework.http.converter.StringHttpMessageConverter;
 import org.springframework.http.converter.json.MappingJackson2HttpMessageConverter;
 import org.springframework.validation.beanvalidation.BeanValidationPostProcessor;
 import org.springframework.web.method.support.HandlerMethodArgumentResolver;
-import org.springframework.web.servlet.HandlerExceptionResolver;
 import org.springframework.web.servlet.config.annotation.ContentNegotiationConfigurer;
 import org.springframework.web.servlet.config.annotation.PathMatchConfigurer;
 import org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry;
@@ -114,24 +107,6 @@ public void configureMessageConverters(List<HttpMessageConverter<?>> converters)
     converters.add(stringConverter());
   }
 
-  @Override
-  public void configureHandlerExceptionResolvers(
-      List<HandlerExceptionResolver> exceptionResolvers) {
-    /* to propagate exceptions from downstream services */
-    ClientResponseForwardingExceptionHandler forwardingExceptionHandler =
-        new ClientResponseForwardingExceptionHandler();
-    forwardingExceptionHandler.setOrder(Ordered.HIGHEST_PRECEDENCE);
-    exceptionResolvers.add(forwardingExceptionHandler);
-
-    RestExceptionHandler handler = new RestExceptionHandler();
-    handler.setOrder(Ordered.HIGHEST_PRECEDENCE + 1);
-
-    DefaultErrorResolver defaultErrorResolver =
-        new DefaultErrorResolver(ExceptionMappings.DEFAULT_MAPPING);
-    handler.setErrorResolver(new ReportPortalExceptionResolver(defaultErrorResolver));
-    handler.setMessageConverters(Collections.singletonList(jsonConverter()));
-    exceptionResolvers.add(handler);
-  }
 
   @Override
   public void configureContentNegotiation(ContentNegotiationConfigurer configurer) {

src/main/java/com/epam/ta/reportportal/exception/ExceptionMappings.java

@@ -0,0 +1,64 @@
+/*
+ * Copyright 2019 EPAM Systems
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package com.epam.ta.reportportal.exception;
+
+import com.epam.reportportal.rules.exception.ErrorType;
+import com.epam.reportportal.rules.exception.ReportPortalException;
+import com.epam.ta.reportportal.exception.message.ArgumentNotValidMessageBuilder;
+import com.epam.ta.reportportal.exception.message.DefaultExceptionMessageBuilder;
+import com.epam.ta.reportportal.exception.message.ExceptionMessageBuilder;
+import com.epam.ta.reportportal.exception.rest.RestErrorDefinition;
+import com.google.common.collect.ImmutableMap;
+import java.util.Map;
+import org.springframework.context.support.ReloadableResourceBundleMessageSource;
+import org.springframework.http.converter.HttpMessageNotReadableException;
+import org.springframework.security.access.AccessDeniedException;
+import org.springframework.security.authentication.BadCredentialsException;
+import org.springframework.security.authentication.LockedException;
+import org.springframework.web.bind.MethodArgumentNotValidException;
+import org.springframework.web.bind.MissingServletRequestParameterException;
+import org.springframework.web.client.RestClientException;
+import org.springframework.web.multipart.support.MissingServletRequestPartException;
+
+/**
+ * Set of default exception mappings
+ *
+ * @author Andrei Varabyeu
+ */
+public final class ExceptionMappings {
+
+  private static final ReloadableResourceBundleMessageSource MESSAGE_SOURCE = new ReloadableResourceBundleMessageSource() {
+    {
+      setBasename("classpath:ValidationMessages");
+      setDefaultEncoding("UTF-8");
+    }
+  };
+
+  private static final ExceptionMessageBuilder<Exception> DEFAULT_MESSAGE_BUILDER = new DefaultExceptionMessageBuilder();
+
+  public static Map<Class<? extends Throwable>, RestErrorDefinition> DEFAULT_MAPPING = ImmutableMap
+      .<Class<? extends Throwable>, RestErrorDefinition>builder()
+      .put(MethodArgumentNotValidException.class, new RestErrorDefinition<>(400, ErrorType.INCORRECT_REQUEST, new ArgumentNotValidMessageBuilder(MESSAGE_SOURCE)))
+      .put(HttpMessageNotReadableException.class, new RestErrorDefinition<>(400, ErrorType.INCORRECT_REQUEST, DEFAULT_MESSAGE_BUILDER))
+      .put(MissingServletRequestPartException.class, new RestErrorDefinition<>(400, ErrorType.INCORRECT_REQUEST, DEFAULT_MESSAGE_BUILDER))
+      .put(MissingServletRequestParameterException.class, new RestErrorDefinition<>(400, ErrorType.INCORRECT_REQUEST, DEFAULT_MESSAGE_BUILDER))
+      .put(AccessDeniedException.class, new RestErrorDefinition<>(403, ErrorType.ACCESS_DENIED, DEFAULT_MESSAGE_BUILDER))
+      .put(BadCredentialsException.class, new RestErrorDefinition<>(401, ErrorType.ACCESS_DENIED, DEFAULT_MESSAGE_BUILDER))
+      .put(LockedException.class, new RestErrorDefinition<>(403, ErrorType.ADDRESS_LOCKED, DEFAULT_MESSAGE_BUILDER))
+      .put(RestClientException.class, new RestErrorDefinition<>(400, ErrorType.UNABLE_INTERACT_WITH_INTEGRATION, DEFAULT_MESSAGE_BUILDER))
+      .put(Throwable.class, new RestErrorDefinition<>(500, ErrorType.UNCLASSIFIED_ERROR, DEFAULT_MESSAGE_BUILDER))
+      .build();
+}

src/main/java/com/epam/ta/reportportal/exception/forwarding/ClientResponseForwardingExceptionHandler.java

@@ -0,0 +1,61 @@
+/*
+ * Copyright 2019 EPAM Systems
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package com.epam.ta.reportportal.exception.forwarding;
+
+import java.nio.charset.StandardCharsets;
+import java.util.Objects;
+import lombok.Setter;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import org.springframework.core.Ordered;
+import org.springframework.http.ResponseEntity;
+import org.springframework.stereotype.Service;
+import org.springframework.web.servlet.HandlerExceptionResolver;
+
+/**
+ * {@link HandlerExceptionResolver} Checks of exception contains response of downstream service and copies it to upstream response
+ *
+ * @author Andrei Varabyeu
+ */
+@Setter
+@Service
+public class ClientResponseForwardingExceptionHandler implements Ordered {
+
+  private static final Logger LOGGER = LoggerFactory.getLogger(ClientResponseForwardingExceptionHandler.class);
+
+  private int order;
+
+  public ResponseEntity<String> resolveException(Exception ex) {
+    try {
+      ResponseForwardingException forwardingException = (ResponseForwardingException) ex;
+      var body = new String(forwardingException.getBody(), StandardCharsets.UTF_8);
+      return ResponseEntity
+          .status(forwardingException.getStatus())
+          .contentType(Objects.requireNonNull(forwardingException.getHeaders().getContentType()))
+          .body(body);
+
+    } catch (Exception e) {
+      LOGGER.error("Cannot forward exception", e);
+      return null;
+    }
+  }
+
+  @Override
+  public int getOrder() {
+    return order;
+  }
+
+}

src/main/java/com/epam/ta/reportportal/exception/forwarding/ResponseForwardingException.java

@@ -0,0 +1,59 @@
+/*
+ * Copyright 2019 EPAM Systems
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+/*
+ * This file is part of Report Portal.
+ *
+ * Report Portal is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * Report Portal is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with Report Portal.  If not, see <http://www.gnu.org/licenses/>.
+ */
+package com.epam.ta.reportportal.exception.forwarding;
+
+import com.google.common.io.ByteStreams;
+import java.io.IOException;
+import lombok.Getter;
+import org.springframework.http.HttpHeaders;
+import org.springframework.http.HttpStatus;
+import org.springframework.http.client.ClientHttpResponse;
+
+/**
+ * Exception to be forwarded from downstream to upstream microservice
+ *
+ * @author Andrei Varabyeu
+ */
+@Getter
+public class ResponseForwardingException extends RuntimeException {
+
+  private final byte[] body;
+  private final HttpHeaders headers;
+  private final HttpStatus status;
+
+  public ResponseForwardingException(ClientHttpResponse response) throws IOException {
+    this.headers = response.getHeaders();
+    this.status = HttpStatus.valueOf(response.getStatusCode().value());
+    this.body = ByteStreams.toByteArray(response.getBody());
+  }
+
+}

src/main/java/com/epam/ta/reportportal/exception/message/ArgumentNotValidMessageBuilder.java

@@ -0,0 +1,45 @@
+/*
+ * Copyright 2019 EPAM Systems
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.epam.ta.reportportal.exception.message;
+
+import java.util.stream.Collectors;
+import org.springframework.context.i18n.LocaleContextHolder;
+import org.springframework.context.support.ReloadableResourceBundleMessageSource;
+import org.springframework.web.bind.MethodArgumentNotValidException;
+
+/**
+ * {@link MethodArgumentNotValidException} message builder
+ *
+ * @author Andrei Varabyeu
+ */
+public class ArgumentNotValidMessageBuilder implements ExceptionMessageBuilder<MethodArgumentNotValidException> {
+
+  private final ReloadableResourceBundleMessageSource messageSource;
+
+  public ArgumentNotValidMessageBuilder(ReloadableResourceBundleMessageSource messageSource) {
+    this.messageSource = messageSource;
+  }
+
+  @Override
+  public String buildMessage(MethodArgumentNotValidException e) {
+    return e.getBindingResult().getAllErrors().stream()
+        .map(err -> messageSource.getMessage(err, LocaleContextHolder.getLocale()))
+        .collect(Collectors.joining("", "[", "] "));
+  }
+
+
+}

src/main/java/com/epam/ta/reportportal/exception/message/DefaultExceptionMessageBuilder.java

@@ -0,0 +1,34 @@
+/*
+ * Copyright 2019 EPAM Systems
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.epam.ta.reportportal.exception.message;
+
+
+import org.apache.commons.lang3.StringUtils;
+
+/**
+ * Default exception builder. Just reads the exception message
+ *
+ * @author Andrei Varabyeu
+ */
+public class DefaultExceptionMessageBuilder implements ExceptionMessageBuilder<Exception> {
+
+  @Override
+  public String buildMessage(Exception e) {
+    return StringUtils.substringBefore(e.getMessage(), "\n");
+  }
+
+}

src/main/java/com/epam/ta/reportportal/exception/message/ExceptionMessageBuilder.java

@@ -0,0 +1,34 @@
+/*
+ * Copyright 2019 EPAM Systems
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.epam.ta.reportportal.exception.message;
+
+/**
+ * Builds custom exception strings from Exception. Lots of exceptions have custom data which should
+ * be shown to the clients in a custom way
+ *
+ * @author Andrei Varabyeu
+ */
+public interface ExceptionMessageBuilder<T extends Exception> {
+
+  /**
+   * Builds message string from provided exception
+   *
+   * @param e Exception message should be built from
+   * @return Built message
+   */
+  String buildMessage(T e);
+}