Correlation ID support implementation

docker-compose-postgresql.yml

@@ -94,7 +94,4 @@ services:
       - FINERACT_DEFAULT_TENANTDB_IDENTIFIER=default
       - FINERACT_DEFAULT_TENANTDB_NAME=fineract_default
       - FINERACT_DEFAULT_TENANTDB_DESCRIPTION=Default Demo Tenant
-      - FINERACT_LOGGING_HTTP_CORRELATION_ID_ENABLED=false
-      - FINERACT_LOGGING_HTTP_CORRELATION_ID_HEADER_NAME=X-Correlation-ID
-      - CONSOLE_LOG_PATTERN=%d{yyyy-MM-dd HH:mm:ss.SSS} %thread %replace([%X{correlationId}]){'\[\]', ''} [%-5level] %class{0} - %msg%n
       - JAVA_TOOL_OPTIONS="-Xmx1G"

docker-compose.yml

@@ -90,8 +90,4 @@ services:
       - FINERACT_DEFAULT_TENANTDB_IDENTIFIER=default
       - FINERACT_DEFAULT_TENANTDB_NAME=fineract_default
       - FINERACT_DEFAULT_TENANTDB_DESCRIPTION=Default Demo Tenant
-      - FINERACT_LOGGING_HTTP_CORRELATION_ID_ENABLED=false
-      - FINERACT_LOGGING_HTTP_CORRELATION_ID_HEADER_NAME=X-Correlation-ID
-      - CONSOLE_LOG_PATTERN=%d{yyyy-MM-dd HH:mm:ss.SSS} %thread %replace([%X{correlationId}]){'\[\]', ''} [%-5level] %class{0} - %msg%n
-      - FINERACT_LOGGING_LEVEL=warn
       - JAVA_TOOL_OPTIONS="-Xmx1G"

fineract-provider/src/main/java/org/apache/fineract/commands/provider/CommandHandlerProvider.java

@@ -81,7 +81,7 @@ public class CommandHandlerProvider implements ApplicationContextAware {
             final String[] commandHandlerBeans = this.applicationContext.getBeanNamesForAnnotation(CommandType.class);
             if (ArrayUtils.isNotEmpty(commandHandlerBeans)) {
                 for (final String commandHandlerName : commandHandlerBeans) {
-                    log.info("Register command handler '{}' ...", commandHandlerName);
+                    log.debug("Register command handler '{}' ...", commandHandlerName);
                     final CommandType commandType = this.applicationContext.findAnnotationOnBean(commandHandlerName, CommandType.class);
                     try {
                         this.registeredHandlers.put(commandType.entity() + "|" + commandType.action(), commandHandlerName);

fineract-provider/src/main/java/org/apache/fineract/infrastructure/core/config/CorrelationIdConfig.java

@@ -1,50 +0,0 @@
-/**
- * Licensed to the Apache Software Foundation (ASF) under one
- * or more contributor license agreements. See the NOTICE file
- * distributed with this work for additional information
- * regarding copyright ownership. The ASF licenses this file
- * to you 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 org.apache.fineract.infrastructure.core.config;
-
-import java.util.Arrays;
-import org.apache.fineract.infrastructure.core.filters.CorrelationHeaderFilter;
-import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
-import org.springframework.boot.web.servlet.FilterRegistrationBean;
-import org.springframework.context.EnvironmentAware;
-import org.springframework.context.annotation.Bean;
-import org.springframework.context.annotation.Configuration;
-import org.springframework.core.env.Environment;
-
-@Configuration
-@ConditionalOnProperty("fineract.logging.http.correlation-id.enabled")
-public class CorrelationIdConfig implements EnvironmentAware {
-
-    private Environment environment;
-
-    @Override
-    public void setEnvironment(Environment environment) {
-        this.environment = environment;
-    }
-
-    @Bean
-    public FilterRegistrationBean<CorrelationHeaderFilter> correlationHeaderFilter() {
-        FilterRegistrationBean<CorrelationHeaderFilter> filterRegBean = new FilterRegistrationBean<CorrelationHeaderFilter>();
-        filterRegBean.setFilter(new CorrelationHeaderFilter(environment));
-        filterRegBean.setUrlPatterns(Arrays.asList("/*"));
-        return filterRegBean;
-    }
-
-}

fineract-provider/src/main/java/org/apache/fineract/infrastructure/core/filters/CorrelationHeaderFilter.java

@@ -26,42 +26,49 @@ import javax.servlet.http.HttpServletRequest;
 import javax.servlet.http.HttpServletResponse;
 import lombok.RequiredArgsConstructor;
 import lombok.extern.slf4j.Slf4j;
+import org.apache.commons.lang3.StringUtils;
+import org.apache.fineract.infrastructure.core.config.FineractProperties;
+import org.apache.fineract.infrastructure.core.service.MDCWrapper;
 import org.apache.fineract.infrastructure.security.utils.LogParameterEscapeUtil;
-import org.slf4j.MDC;
-import org.springframework.beans.factory.annotation.Autowired;
-import org.springframework.core.env.Environment;
+import org.springframework.stereotype.Component;
 import org.springframework.web.filter.OncePerRequestFilter;
 
 @RequiredArgsConstructor
 @Slf4j
+@Component
 public class CorrelationHeaderFilter extends OncePerRequestFilter {
 
-    private String correlationIdHeader;
+    public static final String CORRELATION_ID_KEY = "correlationId";
 
-    public static final String correlationIdKey = "correlationId";
-
-    @Autowired
-    public CorrelationHeaderFilter(Environment env) {
-        correlationIdHeader = env.getRequiredProperty("fineract.logging.http.correlation-id.header-name");
-    }
+    private final FineractProperties fineractProperties;
+    private final MDCWrapper mdcWrapper;
 
     @Override
     protected void doFilterInternal(final HttpServletRequest request, final HttpServletResponse response, final FilterChain filterChain)
             throws IOException, ServletException {
-
-        try {
-            final HttpServletRequest httpServletRequest = (HttpServletRequest) request;
-            String currentCorrId = httpServletRequest.getHeader(correlationIdHeader);
-            log.debug("Found correlationId in Header : {}", LogParameterEscapeUtil.escapeLogMDCParameter(currentCorrId));
-            MDC.put(correlationIdKey, currentCorrId);
+        FineractProperties.FineractCorrelationProperties correlationProperties = fineractProperties.getCorrelation();
+        if (correlationProperties.isEnabled()) {
+            handleCorrelations(request, response, filterChain, correlationProperties);
+        } else {
             filterChain.doFilter(request, response);
-        } finally {
-            MDC.remove(correlationIdKey);
         }
+
     }
 
-    public static String getCurrentValue() {
-        return MDC.get(correlationIdKey);
+    private void handleCorrelations(HttpServletRequest request, HttpServletResponse response, FilterChain filterChain,
+            FineractProperties.FineractCorrelationProperties correlationProperties) throws IOException, ServletException {
+        try {
+            String correlationHeaderName = correlationProperties.getHeaderName();
+            String correlationId = request.getHeader(correlationHeaderName);
+            if (StringUtils.isNotBlank(correlationId)) {
+                String escapedCorrelationId = LogParameterEscapeUtil.escapeLogMDCParameter(correlationId);
+                log.debug("Found correlationId in header : {}", escapedCorrelationId);
+                mdcWrapper.put(CORRELATION_ID_KEY, escapedCorrelationId);
+            }
+            filterChain.doFilter(request, response);
+        } finally {
+            mdcWrapper.remove(CORRELATION_ID_KEY);
+        }
     }
 
     @Override

fineract-provider/src/main/java/org/apache/fineract/infrastructure/core/service/MDCWrapper.java

@@ -19,39 +19,17 @@
 
 package org.apache.fineract.infrastructure.core.service;
 
-import java.util.Map;
 import org.slf4j.MDC;
-import org.slf4j.spi.MDCAdapter;
+import org.springframework.stereotype.Component;
 
-public class MdcAdapter implements MDCAdapter {
+@Component
+public class MDCWrapper {
 
-    @Override
     public void put(String key, String val) {
         MDC.put(key, val);
     }
 
-    @Override
-    public String get(String key) {
-        return MDC.get(key);
-    }
-
-    @Override
     public void remove(String key) {
         MDC.remove(key);
     }
-
-    @Override
-    public void clear() {
-        MDC.clear();
-    }
-
-    @Override
-    public Map<String, String> getCopyOfContextMap() {
-        return MDC.getCopyOfContextMap();
-    }
-
-    @Override
-    public void setContextMap(Map<String, String> map) {
-        MDC.setContextMap(map);
-    }
 }

fineract-provider/src/main/java/org/apache/fineract/infrastructure/instancemode/filter/FineractInstanceModeApiFilter.java

@@ -29,7 +29,6 @@ import javax.servlet.ServletException;
 import javax.servlet.http.HttpServletRequest;
 import javax.servlet.http.HttpServletResponse;
 import javax.ws.rs.HttpMethod;
-import javax.ws.rs.ext.Provider;
 import lombok.Getter;
 import lombok.RequiredArgsConstructor;
 import org.apache.fineract.infrastructure.core.config.FineractProperties;
@@ -38,7 +37,6 @@ import org.apache.http.HttpStatus;
 import org.springframework.stereotype.Component;
 import org.springframework.web.filter.OncePerRequestFilter;
 
-@Provider
 @Component
 @RequiredArgsConstructor
 public class FineractInstanceModeApiFilter extends OncePerRequestFilter {

fineract-provider/src/main/resources/application.properties

@@ -40,11 +40,11 @@ fineract.mode.write-enabled=${FINERACT_MODE_WRITE_ENABLED:true}
 fineract.mode.batch-worker-enabled=${FINERACT_MODE_BATCH_WORKER_ENABLED:true}
 fineract.mode.batch-manager-enabled=${FINERACT_MODE_BATCH_MANAGER_ENABLED:true}
 
-fineract.logging.http.correlation-id.enabled=${FINERACT_LOGGING_HTTP_CORRELATION_ID_ENABLED:false}
-fineract.logging.http.correlation-id.header-name=${FINERACT_LOGGING_HTTP_CORRELATION_ID_HEADER_NAME:X-Correlation-ID}
+fineract.correlation.enabled=${FINERACT_LOGGING_HTTP_CORRELATION_ID_ENABLED:false}
+fineract.correlation.header-name=${FINERACT_LOGGING_HTTP_CORRELATION_ID_HEADER_NAME:X-Correlation-ID}
 
 # Logging pattern for the console
-logging.pattern.console=${CONSOLE_LOG_PATTERN:%d{yyyy-MM-dd HH\:mm\:ss.SSS} %thread %replace([%X{correlationId}]){'\\[\\]', ''} [%-5level] %class{0} - %msg%n}
+logging.pattern.console=${CONSOLE_LOG_PATTERN:%clr(%d{yyyy-MM-dd HH:mm:ss.SSS}){faint} %clr(${LOG_LEVEL_PATTERN:-%5p}) %clr(${PID:- }){magenta} %clr(%replace([%X{correlationId}]){'\\[\\]', ''}) %clr(---){faint} %clr([%15.15t]){faint} %clr(%-40.40logger{39}){cyan} %clr(:){faint} %m%n${LOG_EXCEPTION_CONVERSION_WORD:%wEx}}
 
 management.health.jms.enabled=false
 

fineract-provider/src/test/java/org/apache/fineract/infrastructure/core/filters/CorrelationHeaderFilterTest.java

@@ -0,0 +1,131 @@
+/**
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you 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 org.apache.fineract.infrastructure.core.filters;
+
+import static org.mockito.ArgumentMatchers.anyString;
+import static org.mockito.BDDMockito.given;
+import static org.mockito.Mockito.never;
+import static org.mockito.Mockito.verify;
+import static org.mockito.Mockito.verifyNoInteractions;
+
+import java.util.UUID;
+import javax.servlet.FilterChain;
+import javax.servlet.http.HttpServletRequest;
+import javax.servlet.http.HttpServletResponse;
+import org.apache.fineract.infrastructure.core.config.FineractProperties;
+import org.apache.fineract.infrastructure.core.service.MDCWrapper;
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.extension.ExtendWith;
+import org.mockito.Mock;
+import org.mockito.junit.jupiter.MockitoExtension;
+import org.mockito.junit.jupiter.MockitoSettings;
+import org.mockito.quality.Strictness;
+
+@ExtendWith(MockitoExtension.class)
+@MockitoSettings(strictness = Strictness.LENIENT)
+class CorrelationHeaderFilterTest {
+
+    private static final String CORRELATION_ID_HEADER_NAME = "X-CORR-ID";
+
+    @Mock
+    private HttpServletRequest request;
+
+    @Mock
+    private HttpServletResponse response;
+
+    @Mock
+    private FilterChain filterChain;
+
+    @Mock
+    private MDCWrapper mdcWrapper;
+
+    private FineractProperties fineractProperties;
+
+    private CorrelationHeaderFilter underTest;
+
+    @BeforeEach
+    void setUp() {
+        fineractProperties = new FineractProperties();
+        FineractProperties.FineractCorrelationProperties correlationProps = new FineractProperties.FineractCorrelationProperties();
+        correlationProps.setHeaderName(CORRELATION_ID_HEADER_NAME);
+        correlationProps.setEnabled(true);
+        fineractProperties.setCorrelation(correlationProps);
+        underTest = new CorrelationHeaderFilter(fineractProperties, mdcWrapper);
+    }
+
+    @Test
+    public void testDoFilterInternalShouldPutCorrelationIdIntoMDCIfHeaderIsPresentAndEnabled() throws Exception {
+        // given
+        String correlationId = UUID.randomUUID().toString();
+        given(request.getHeader(fineractProperties.getCorrelation().getHeaderName())).willReturn(correlationId);
+
+        // when
+        underTest.doFilterInternal(request, response, filterChain);
+
+        // then
+        verify(mdcWrapper).put(CorrelationHeaderFilter.CORRELATION_ID_KEY, correlationId);
+        verify(mdcWrapper).remove(CorrelationHeaderFilter.CORRELATION_ID_KEY);
+        verify(filterChain).doFilter(request, response);
+    }
+
+    @Test
+    public void testDoFilterInternalShouldNotPutCorrelationIdIntoMDCIfHeaderIsNotPresentAndEnabled() throws Exception {
+        // given
+        given(request.getHeader(fineractProperties.getCorrelation().getHeaderName())).willReturn(null);
+
+        // when
+        underTest.doFilterInternal(request, response, filterChain);
+
+        // then
+        verify(mdcWrapper, never()).put(anyString(), anyString());
+        verify(mdcWrapper).remove(CorrelationHeaderFilter.CORRELATION_ID_KEY);
+        verify(filterChain).doFilter(request, response);
+    }
+
+    @Test
+    public void testDoFilterInternalShouldNotPutCorrelationIdIntoMDCIfHeaderIsPresentButWhitespacesAndEnabled() throws Exception {
+        // given
+        given(request.getHeader(fineractProperties.getCorrelation().getHeaderName())).willReturn("    ");
+
+        // when
+        underTest.doFilterInternal(request, response, filterChain);
+
+        // then
+        verify(mdcWrapper, never()).put(anyString(), anyString());
+        verify(mdcWrapper).remove(CorrelationHeaderFilter.CORRELATION_ID_KEY);
+        verify(filterChain).doFilter(request, response);
+    }
+
+    @Test
+    public void testDoFilterInternalShouldNotPutCorrelationIdIntoMDCIfHeaderIsPresentAndDisabled() throws Exception {
+        // given
+        fineractProperties.getCorrelation().setEnabled(false);
+        String correlationId = UUID.randomUUID().toString();
+        given(request.getHeader(fineractProperties.getCorrelation().getHeaderName())).willReturn(correlationId);
+
+        // when
+        underTest.doFilterInternal(request, response, filterChain);
+
+        // then
+        verifyNoInteractions(mdcWrapper);
+        verify(filterChain).doFilter(request, response);
+    }
+}

fineract-provider/src/test/java/org/apache/fineract/infrastructure/core/filters/FineractCorrelationIdApiFilterTest.java

@@ -1,80 +0,0 @@
-/**
- * Licensed to the Apache Software Foundation (ASF) under one
- * or more contributor license agreements. See the NOTICE file
- * distributed with this work for additional information
- * regarding copyright ownership. The ASF licenses this file
- * to you 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 org.apache.fineract.infrastructure.core.filters;
-
-import static org.assertj.core.api.Assertions.assertThat;
-import static org.mockito.Mockito.verify;
-import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get;
-import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.header;
-import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;
-
-import java.util.UUID;
-import org.apache.fineract.infrastructure.core.service.MdcAdapter;
-import org.junit.Test;
-import org.junit.jupiter.api.extension.ExtendWith;
-import org.junit.jupiter.params.ParameterizedTest;
-import org.junit.jupiter.params.provider.ValueSource;
-import org.mockito.junit.jupiter.MockitoExtension;
-import org.mockito.junit.jupiter.MockitoSettings;
-import org.mockito.quality.Strictness;
-import org.slf4j.MDC;
-import org.springframework.beans.factory.annotation.Autowired;
-import org.springframework.boot.test.autoconfigure.web.servlet.WebMvcTest;
-import org.springframework.boot.test.mock.mockito.SpyBean;
-import org.springframework.context.annotation.Configuration;
-import org.springframework.test.context.ContextConfiguration;
-import org.springframework.test.web.servlet.MockMvc;
-
-@ExtendWith(MockitoExtension.class)
-@MockitoSettings(strictness = Strictness.LENIENT)
-@ContextConfiguration(classes = { Configuration.class })
-@WebMvcTest
-class FineractCorrelationIdApiFilterTest {
-
-    @SpyBean
-    private MdcAdapter mdc;
-
-    @Autowired
-    private MockMvc mockMvc;
-
-    @ParameterizedTest
-    @ValueSource(strings = { "/fineract-provider/api/v1/loans", "/fineract-provider/api/v1/loans" })
-    void shouldGet200IfXCorrelationIdHeaderIsPresentAndRequestIsForV1Path(String url) throws Exception {
-        String correlationId = UUID.randomUUID().toString();
-        mockMvc.perform(get(url).header(CorrelationHeaderFilter.correlationIdKey, correlationId)).andExpect(status().isOk())
-                .andExpect(header().string(CorrelationHeaderFilter.correlationIdKey, correlationId));
-
-        verify(mdc).remove(CorrelationHeaderFilter.correlationIdKey);
-    }
-
-    @ParameterizedTest
-    @ValueSource(strings = { "/fineract-provider/api/v1/loans", "/fineract-provider/api/v1/loans" })
-    void shouldGet400IfXCorrelationIdHeaderIsNotPresentAndRequestIsForV1Path(String url) throws Exception {
-        mockMvc.perform(get(url)).andExpect(status().isBadRequest())
-                .andExpect(header().doesNotExist(CorrelationHeaderFilter.correlationIdKey));
-    }
-
-    @Test
-    void shouldReturnCurrentCorrelationIdFromMDC() {
-        MDC.put(CorrelationHeaderFilter.correlationIdKey, "1");
-        assertThat(CorrelationHeaderFilter.getCurrentValue()).isEqualTo("1");
-    }
-
-}

fineract-provider/src/test/resources/application-test.properties

@@ -37,9 +37,6 @@ fineract.mode.read-enabled=true
 fineract.mode.write-enabled=true
 fineract.mode.batch-enabled=true
 
-fineract.logging.http.correlation-id.enabled=false
-fineract.logging.http.correlation-id.header-name=X-Correlation-ID
-
 management.health.jms.enabled=false
 
 # FINERACT 1296

fineract-war/setenv.sh

@@ -53,5 +53,3 @@ export FINERACT_DEFAULT_TENANTDB_TIMEZONE="Asia/Kolkata"
 export FINERACT_DEFAULT_TENANTDB_IDENTIFIER="default"
 export FINERACT_DEFAULT_TENANTDB_NAME="fineract_default"
 export FINERACT_DEFAULT_TENANTDB_DESCRIPTION="Default Demo Tenant"
-export FINERACT_LOGGING_HTTP_CORRELATION_ID_ENABLED="false"
-export FINERACT_LOGGING_HTTP_CORRELATION_ID_HEADER_NAME="X-Correlation-ID"