Merge pull request #306 from raynigon/feature/okhttp-interceptor

Add Interceptor for OkHttp3

ecs-logging-access/build.gradle

@@ -8,5 +8,4 @@ dependencies {
     testImplementation("org.springframework.boot:spring-boot-starter-test")
     testImplementation("org.springframework.boot:spring-boot-starter-web")
     testImplementation("org.springframework.boot:spring-boot-starter-webflux")
-
 }

ecs-logging-okhttp3/build.gradle

@@ -0,0 +1,11 @@
+dependencies {
+    implementation(project(':ecs-logging-base'))
+    implementation("org.slf4j:slf4j-api:2.0.11")
+    compileOnly("com.squareup.okhttp3:okhttp:4.12.0")
+    compileOnly("ch.qos.logback:logback-core")
+
+    testImplementation("ch.qos.logback:logback-core")
+    testImplementation("ch.qos.logback:logback-classic")
+    testImplementation("com.squareup.okhttp3:okhttp:4.12.0")
+    testImplementation("org.springframework.boot:spring-boot-starter-test")
+}

ecs-logging-okhttp3/src/main/java/com/raynigon/ecs/logging/okhttp3/EcsTransactionIdInterceptor.java

@@ -0,0 +1,33 @@
+package com.raynigon.ecs.logging.okhttp3;
+
+import okhttp3.Interceptor;
+import okhttp3.Request;
+import okhttp3.Response;
+import org.jetbrains.annotations.NotNull;
+import org.slf4j.MDC;
+
+import java.io.IOException;
+import java.util.UUID;
+
+import static com.raynigon.ecs.logging.LoggingConstants.TRANSACTION_ID_HEADER;
+import static com.raynigon.ecs.logging.LoggingConstants.TRANSACTION_ID_PROPERTY;
+
+class EcsTransactionIdInterceptor implements Interceptor {
+
+    @NotNull
+    @Override
+    public Response intercept(Interceptor.Chain chain) throws IOException {
+        Request original = chain.request();
+        String transactionId = MDC.get(TRANSACTION_ID_PROPERTY);
+        // If no transaction id exists, generate custom transaction id
+        if (transactionId == null) {
+            transactionId = UUID.randomUUID().toString();
+            MDC.put(TRANSACTION_ID_PROPERTY, transactionId);
+        }
+        // Update Request with transaction id header
+        Request updated = original.newBuilder()
+                .header(TRANSACTION_ID_HEADER, transactionId)
+                .build();
+        return chain.proceed(updated);
+    }
+}

ecs-logging-okhttp3/src/test/groovy/com/raynigon/ecs/logging/okhttp3/EcsTransactionIdInterceptorSpec.groovy

@@ -0,0 +1,67 @@
+package com.raynigon.ecs.logging.okhttp3
+
+import static com.raynigon.ecs.logging.LoggingConstants.TRANSACTION_ID_HEADER
+import static com.raynigon.ecs.logging.LoggingConstants.TRANSACTION_ID_PROPERTY
+
+import okhttp3.Protocol
+import okhttp3.Request
+import okhttp3.Response
+import org.slf4j.MDC
+import spock.lang.Specification
+import spock.lang.Subject
+import okhttp3.Interceptor
+
+class EcsTransactionIdInterceptorSpec extends Specification {
+
+    @Subject
+    EcsTransactionIdInterceptor interceptor = new EcsTransactionIdInterceptor()
+
+    def "transaction id header exists"() {
+        given:
+        Interceptor.Chain chain = Mock()
+        Request request = new Request.Builder().url("https://example.com").build()
+        Response response = new Response.Builder().request(request).code(200)
+                .protocol(Protocol.HTTP_1_1)
+                .message("dummy")
+                .build()
+
+        when:
+        def result = interceptor.intercept(chain)
+
+        then:
+        1 * chain.request() >> request
+        1 * chain.proceed({ Request r -> r.header(TRANSACTION_ID_HEADER) != null }) >> response
+
+        and:
+        result == response
+
+        cleanup:
+        MDC.clear()
+    }
+
+    def "transaction id header is set from MDC Tag"() {
+        given:
+        Interceptor.Chain chain = Mock()
+        Request request = new Request.Builder().url("https://example.com").build()
+        Response response = new Response.Builder().request(request).code(200)
+                .protocol(Protocol.HTTP_1_1)
+                .message("dummy")
+                .build()
+
+        and:
+        MDC.put(TRANSACTION_ID_PROPERTY, "my-value")
+
+        when:
+        def result = interceptor.intercept(chain)
+
+        then:
+        1 * chain.request() >> request
+        1 * chain.proceed({ Request r -> r.header(TRANSACTION_ID_HEADER) == "my-value" }) >> response
+
+        and:
+        result == response
+
+        cleanup:
+        MDC.clear()
+    }
+}

settings.gradle

@@ -6,4 +6,5 @@ include 'ecs-logging-access'
 include 'ecs-logging-async'
 include 'ecs-logging-audit'
 include 'ecs-logging-kafka'
+include 'ecs-logging-okhttp3'
 include 'gzip-request-filter-starter'