fix: [P4PU-364] added custom exception to assistance flow (#62)

openapi/pagopa-arc-be.openapi.yaml

@@ -299,6 +299,8 @@ paths:
         - arc zendesk assistance
       summary: "Retrieve jwt token for the zendesk assistance"
       operationId: getZendeskAssistanceToken
+      security:
+        - bearerAuth: [ ]
       parameters:
         - name: userEmail
           in: query
@@ -711,6 +713,7 @@ components:
             - receipt_not_found_error
             - invalid_amount
             - invalid_date
+            - invalid_email
             - invalid_request
             - auth_user_unauthorized
         error_description:

src/main/java/it/gov/pagopa/arc/config/OAuth2LoginConfig.java

@@ -39,10 +39,11 @@ public SecurityFilterChain securityFilterChain(HttpSecurity http) throws Excepti
         .addFilterBefore(jwtAuthenticationFilter, UsernamePasswordAuthenticationFilter.class)
         .authorizeHttpRequests(authorize -> authorize
 
-            // Auth endpoint must be protected
+            // endpoint must be protected
             .requestMatchers(
                 "/auth",
-                "/auth/*"
+                    "/auth/*",
+                    "/assistance"
             ).authenticated()
 
             // Should be changed

src/main/java/it/gov/pagopa/arc/exception/ArcExceptionHandler.java

@@ -58,6 +58,11 @@ public ResponseEntity<ErrorDTO> handlePullInvalidTokenException(RuntimeException
         return handleArcErrorException(ex, request, HttpStatus.UNAUTHORIZED, ErrorDTO.ErrorEnum.AUTH_USER_UNAUTHORIZED);
     }
 
+    @ExceptionHandler(ZendeskAssistanceInvalidUserEmailException.class)
+    public ResponseEntity<ErrorDTO> handleZendeskAssistanceInvalidUserEmailException(RuntimeException ex, HttpServletRequest request){
+        return handleArcErrorException(ex, request, HttpStatus.BAD_REQUEST, ErrorDTO.ErrorEnum.INVALID_EMAIL);
+    }
+
     private static ResponseEntity<ErrorDTO> handleArcErrorException(RuntimeException ex, HttpServletRequest request, HttpStatus httpStatus, ErrorDTO.ErrorEnum errorEnum) {
         String message = ex.getMessage();
         log.info("A {} occurred handling request {}: HttpStatus {} - {}",

src/main/java/it/gov/pagopa/arc/exception/custom/ZendeskAssistanceInvalidUserEmailException.java

@@ -0,0 +1,11 @@
+package it.gov.pagopa.arc.exception.custom;
+
+import lombok.Getter;
+
+@Getter
+public class ZendeskAssistanceInvalidUserEmailException extends RuntimeException{
+
+    public ZendeskAssistanceInvalidUserEmailException(String message) {
+        super(message);
+    }
+}

src/main/java/it/gov/pagopa/arc/service/ZendeskAssistanceTokenServiceImpl.java

@@ -4,9 +4,11 @@
 import it.gov.pagopa.arc.dto.mapper.zendeskassistancetoken.ZendeskAssistanceTokenResponseMapper;
 import it.gov.pagopa.arc.model.generated.ZendeskAssistanceTokenResponse;
 import jakarta.validation.constraints.NotNull;
+import lombok.extern.slf4j.Slf4j;
 import org.springframework.stereotype.Service;
 
 @Service
+@Slf4j
 public class ZendeskAssistanceTokenServiceImpl implements ZendeskAssistanceTokenService{
     private final ZendeskAssistanceTokenBuilder zendeskAssistanceTokenBuilder;
     private final ZendeskAssistanceTokenConfig zendeskAssistanceTokenConfig;
@@ -20,6 +22,7 @@ public ZendeskAssistanceTokenServiceImpl(ZendeskAssistanceTokenBuilder zendeskAs
 
     @Override
     public ZendeskAssistanceTokenResponse retrieveZendeskAssistanceTokenResponse(@NotNull String userEmail) {
+        log.info("[GET_ZENDESK_ASSISTANCE_TOKEN_RESPONSE] the creation of the jwt token was requested to request assistance on zendesk");
         String zendeskAssistanceToken = zendeskAssistanceTokenBuilder.buildZendeskAssistanceToken(userEmail);
         String returnTo = this.zendeskAssistanceTokenConfig.getReturnTo();
 

src/main/java/it/gov/pagopa/arc/utils/SecurityUtils.java

@@ -13,8 +13,7 @@ public static IamUserInfoDTO getPrincipal() {
     try{
       return (IamUserInfoDTO) principal;
     }catch (ClassCastException e){
-      //Replace this exception with custom exception
-      throw new RuntimeException("Invalid principal type: expected IamUserInfoDTO but got " + principal.getClass().getName());
+      throw new IllegalStateException("Invalid principal type: expected IamUserInfoDTO but got " + principal.getClass().getName());
     }
 
   }

src/main/java/it/gov/pagopa/arc/utils/Utilities.java

@@ -3,6 +3,7 @@
 
 import it.gov.pagopa.arc.exception.custom.BizEventsInvalidAmountException;
 import it.gov.pagopa.arc.exception.custom.BizEventsInvalidDateException;
+import it.gov.pagopa.arc.exception.custom.ZendeskAssistanceInvalidUserEmailException;
 import lombok.extern.slf4j.Slf4j;
 import org.apache.commons.lang3.StringUtils;
 
@@ -63,8 +64,7 @@ public static String extractNameFromEmailAssistanceToken(String userMail){
             int index = userMail.indexOf("@");
             nameExtracted = userMail.substring(0, index);
         }else {
-            //Replace this exception with custom exception
-            throw new RuntimeException("Invalid user email");
+            throw new ZendeskAssistanceInvalidUserEmailException("Invalid user email [%s]".formatted(userMail));
         }
         return  nameExtracted;
     }

src/test/java/it/gov/pagopa/arc/exception/ArcExceptionHandlerTest.java

@@ -195,4 +195,20 @@ void givenInvalidTokenThenHandleInvalidTokenException() throws Exception {
         Assertions.assertTrue(memoryAppender.getLoggedEvents().get(0).getFormattedMessage().contains("A class it.gov.pagopa.arc.exception.custom.InvalidTokenException occurred handling request GET /test: HttpStatus 401 - Error"));
     }
 
+    @Test
+    void givenInvalidEmailWhenExtractNameFromEmailAssistanceTokenThenHandleZendeskAssistanceInvalidUserEmailException() throws Exception {
+        doThrow(new ZendeskAssistanceInvalidUserEmailException("Error")).when(testControllerSpy).testEndpoint();
+
+        mockMvc.perform(MockMvcRequestBuilders.get("/test")
+                        .param(DATA, DATA)
+                        .header(HEADER,HEADER)
+                        .contentType(MediaType.APPLICATION_JSON)
+                        .accept(MediaType.APPLICATION_JSON))
+                .andExpect(MockMvcResultMatchers.status().isBadRequest())
+                .andExpect(MockMvcResultMatchers.jsonPath("$.error").value("invalid_email"))
+                .andExpect(MockMvcResultMatchers.jsonPath("$.error_description").value("Error"));
+
+        Assertions.assertTrue(memoryAppender.getLoggedEvents().get(0).getFormattedMessage().contains("A class it.gov.pagopa.arc.exception.custom.ZendeskAssistanceInvalidUserEmailException occurred handling request GET /test: HttpStatus 400 - Error"));
+    }
+
 }

src/test/java/it/gov/pagopa/arc/utils/SecurityUtilsTest.java

@@ -35,7 +35,7 @@ void givenWrongConfiguredSecurityContextThenThrowException(){
     authentication.setDetails(new WebAuthenticationDetails(new MockHttpServletRequest()));
     SecurityContextHolder.getContext().setAuthentication(authentication);
 
-    RuntimeException ex = Assertions.assertThrows(RuntimeException.class, SecurityUtils::getPrincipal);
+    IllegalStateException ex = Assertions.assertThrows(IllegalStateException.class, SecurityUtils::getPrincipal);
     Assertions.assertEquals("Invalid principal type: expected IamUserInfoDTO but got java.lang.Object", ex.getMessage());
   }
 

src/test/java/it/gov/pagopa/arc/utils/UtilitiesTest.java

@@ -2,6 +2,7 @@
 
 import it.gov.pagopa.arc.exception.custom.BizEventsInvalidAmountException;
 import it.gov.pagopa.arc.exception.custom.BizEventsInvalidDateException;
+import it.gov.pagopa.arc.exception.custom.ZendeskAssistanceInvalidUserEmailException;
 import org.junit.jupiter.api.Assertions;
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.api.extension.ExtendWith;
@@ -90,9 +91,9 @@ void givenEmptyEmailStringWhenExtractNameFromEmailAssistanceTokenThenReturnExcep
         String wrongEmail = "";
         //when
         //then
-        RuntimeException exception = assertThrows(RuntimeException.class,
+        ZendeskAssistanceInvalidUserEmailException  exception = assertThrows(ZendeskAssistanceInvalidUserEmailException .class,
                 () -> Utilities.extractNameFromEmailAssistanceToken(wrongEmail));
-        Assertions.assertEquals("Invalid user email",exception.getMessage());
+        Assertions.assertEquals("Invalid user email []",exception.getMessage());
 
     }
 
@@ -102,9 +103,9 @@ void givenWrongEmailStringWhenExtractNameFromEmailAssistanceTokenThenReturnExcep
         String wrongEmail = "email";
         //when
         //then
-        RuntimeException exception = assertThrows(RuntimeException.class,
+        ZendeskAssistanceInvalidUserEmailException exception = assertThrows(ZendeskAssistanceInvalidUserEmailException .class,
                 () -> Utilities.extractNameFromEmailAssistanceToken(wrongEmail));
-        Assertions.assertEquals("Invalid user email",exception.getMessage());
+        Assertions.assertEquals("Invalid user email [email]",exception.getMessage());
 
     }