fix(logging) : Prevent endPointResponse showing 200 for failed request (502)

(cherry picked from commit df8c37a)

Author: arpzilla-dev

gravitee-apim-gateway/gravitee-apim-gateway-handlers/gravitee-apim-gateway-handlers-api/src/main/java/io/gravitee/gateway/reactive/handlers/api/v4/analytics/logging/LoggingHook.java

@@ -77,7 +77,12 @@ public Completable post(String id, HttpExecutionContext ctx, @Nullable Execution
             }
 
             if (log != null && loggingContext != null && loggingContext.endpointResponse()) {
-                ((LogEndpointResponse) log.getEndpointResponse()).capture();
+                final ExecutionFailure executionFailure = ctx.getInternalAttribute(
+                    InternalContextAttributes.ATTR_INTERNAL_EXECUTION_FAILURE
+                );
+                if (executionFailure == null) {
+                    ((LogEndpointResponse) log.getEndpointResponse()).capture();
+                }
 
                 final HttpResponseInternal response = ((HttpExecutionContextInternal) ctx).response();
                 response.setHeaders(((LogHeadersCaptor) response.headers()).getDelegate());

gravitee-apim-gateway/gravitee-apim-gateway-handlers/gravitee-apim-gateway-handlers-api/src/test/java/io/gravitee/gateway/reactive/handlers/api/v4/analytics/logging/LoggingHookTest.java

@@ -363,4 +363,57 @@ void shouldNotWrapHeadersInPreWhenNeitherEndpointRequestHeadersNorResponseEnable
         obs.assertComplete();
         verify(response, never()).setHeaders(any());
     }
+
+    @Test
+    void shouldCaptureEndpointResponseWhenExecutionFailureIsNull() {
+        Log log = Log.builder().timestamp(System.currentTimeMillis()).build();
+        LogEndpointResponse logEndpointResponse = mock(LogEndpointResponse.class);
+        log.setEndpointResponse(logEndpointResponse);
+
+        when(metrics.getLog()).thenReturn(log);
+        when(loggingContext.endpointResponse()).thenReturn(true);
+        when(response.headers()).thenReturn(new LogHeadersCaptor(HttpHeaders.create()));
+        when(ctx.getInternalAttribute(InternalContextAttributes.ATTR_INTERNAL_EXECUTION_FAILURE)).thenReturn(null);
+
+        TestObserver<Void> obs = cut.post("test", ctx, ExecutionPhase.RESPONSE).test();
+
+        obs.assertComplete();
+        verify(logEndpointResponse).capture();
+    }
+
+    @Test
+    void shouldNotCaptureEndpointResponseWhenExecutionFailureIsNotNull() {
+        Log log = Log.builder().timestamp(System.currentTimeMillis()).build();
+        LogEndpointResponse logEndpointResponse = mock(LogEndpointResponse.class);
+        log.setEndpointResponse(logEndpointResponse);
+        ExecutionFailure executionFailure = new ExecutionFailure(500);
+
+        when(metrics.getLog()).thenReturn(log);
+        when(loggingContext.endpointResponse()).thenReturn(true);
+        when(response.headers()).thenReturn(new LogHeadersCaptor(HttpHeaders.create()));
+        when(ctx.getInternalAttribute(InternalContextAttributes.ATTR_INTERNAL_EXECUTION_FAILURE)).thenReturn(executionFailure);
+
+        TestObserver<Void> obs = cut.post("test", ctx, ExecutionPhase.RESPONSE).test();
+
+        obs.assertComplete();
+        verify(logEndpointResponse, never()).capture();
+    }
+
+    @Test
+    void shouldNotCaptureEndpointResponseWhenExecutionFailureIsPresent() {
+        Log log = Log.builder().timestamp(System.currentTimeMillis()).build();
+        LogEndpointResponse logEndpointResponse = mock(LogEndpointResponse.class);
+        log.setEndpointResponse(logEndpointResponse);
+        ExecutionFailure executionFailure = new ExecutionFailure(502);
+
+        when(metrics.getLog()).thenReturn(log);
+        when(loggingContext.endpointResponse()).thenReturn(true);
+        when(response.headers()).thenReturn(new LogHeadersCaptor(HttpHeaders.create()));
+        when(ctx.getInternalAttribute(InternalContextAttributes.ATTR_INTERNAL_EXECUTION_FAILURE)).thenReturn(executionFailure);
+
+        TestObserver<Void> obs = cut.post("test", ctx, ExecutionPhase.RESPONSE).test();
+
+        obs.assertComplete();
+        verify(logEndpointResponse, never()).capture();
+    }
 }