[th2-5092] Puts unique th2-request-id property to metadata of reque… (#28)

Co-authored-by: Denis Plotnikov <denis.plotnikov@exactprosystems.com>
Co-authored-by: Oleg Smirnov <oleg.smirnov@exactprosystems.com>

Author: 3 people

.github/workflows/build.yml

@@ -0,0 +1,23 @@
+name: Build and publish Docker distributions to Github Container Registry ghcr.io
+
+on:
+  push:
+    branches:
+      - master
+      - version-*
+    paths:
+      - gradle.properties
+#    - package_info.json  
+
+jobs:
+  build-job:
+    uses: th2-net/.github/.github/workflows/compound-java.yml@main
+    with:
+      build-target: 'Docker,Sonatype'
+      docker-username: ${{ github.actor }}
+    secrets:
+      docker-password: ${{ secrets.GITHUB_TOKEN }}
+      sonatypeUsername: ${{ secrets.SONATYPE_NEXUS_USERNAME }}
+      sonatypePassword: ${{ secrets.SONATYPE_NEXUS_PASSWORD }}
+      sonatypeSigningKey: ${{ secrets.SONATYPE_GPG_ARMORED_KEY }}
+      sonatypeSigningPassword: ${{ secrets.SONATYPE_SIGNING_PASSWORD }}

.github/workflows/dev-build.yml

@@ -0,0 +1,23 @@
+name: Dev build and publish Docker distributions to Github Container Registry ghcr.io
+
+on:
+  push:
+    branches-ignore:
+      - master
+      - version-*
+      - dependabot**
+    paths-ignore:
+      - README.md
+
+jobs:
+  build-job:
+    uses: th2-net/.github/.github/workflows/compound-java-dev.yml@main
+    with:
+      build-target: 'Docker,Sonatype'
+      docker-username: ${{ github.actor }}
+    secrets:
+      docker-password: ${{ secrets.GITHUB_TOKEN }}
+      sonatypeUsername: ${{ secrets.SONATYPE_NEXUS_USERNAME }}
+      sonatypePassword: ${{ secrets.SONATYPE_NEXUS_PASSWORD }}
+      sonatypeSigningKey: ${{ secrets.SONATYPE_GPG_ARMORED_KEY }}
+      sonatypeSigningPassword: ${{ secrets.SONATYPE_SIGNING_PASSWORD }}

README.md

@@ -1,4 +1,4 @@
-# HTTP Client v2.1.0
+# HTTP Client v2.2.0
 
 This microservice allows performing HTTP requests and receive HTTP responses. It also can perform basic authentication
 
@@ -131,7 +131,7 @@ metadata:
   name: http-client
 spec:
   image-name: ghcr.io/th2-net/th2-conn-http-client
-  image-version: 0.7.2
+  image-version: 2.2.0-dev
   custom-config:
     https: false
     host: 127.0.0.1
@@ -177,6 +177,11 @@ spec:
 
 ## Changelog
 
+### v2.2.0
+
+* Puts unique `th2-request-id` property to metadata of request/response messages 
+* Merged `v0.8.1`
+
 ### v2.1.0
 
 * Supports th2 transport protocol
@@ -193,8 +198,13 @@ spec:
 * th2-common upgrade to `5.2.0`
 * th2-bom upgrade to `4.2.0`
 
-### v0.8.0
+### v0.8.1
 
+#### Fixed:
+
++ Fix problem with exceeding the limit for sockets to acquire when and exception is thrown during that process.
+
+### v0.8.0
 * Vulnerability check pipeline step
 * th2-common upgrade to `3.44.0`
 * th2-bom upgrade to `4.1.0`

gradle.properties

@@ -1,5 +1,5 @@
 kotlin.code.style=official
-release_version=2.1.0
+release_version=2.2.0
 description='HTTP Client'
 vcs_url=https://github.com/th2-net/th2-conn-http-client
 app_main_class=com.exactpro.th2.http.client.Main

gradle/wrapper/gradle-wrapper.properties

@@ -1,5 +1,5 @@
 #Mon May 25 11:22:24 MSK 2020
-distributionUrl=https\://services.gradle.org/distributions/gradle-7.6-all.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-7.6-bin.zip
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
 zipStorePath=wrapper/dists

src/main/kotlin/com/exactpro/th2/http/client/ClientOptions.kt

@@ -114,25 +114,30 @@ internal class ClientOptions(
 
         fun acquire(): Socket {
             semaphore.acquire()
-
-            var socket = sockets.poll().let { socket ->
-                when {
-                    socket == null || socket.isClosed || !socket.isConnected -> factory(host, port)
-                    else -> socket
+            try {
+                var socket = sockets.poll().let { socket ->
+                    when {
+                        socket == null || socket.isClosed || !socket.isConnected -> factory(host, port)
+                        else -> socket
+                    }
                 }
-            }
 
-            val currentTime = System.currentTimeMillis()
-            val expirationTime = expirationTimes.getOrPut(socket) { currentTime + keepAliveTimeout }
+                val currentTime = System.currentTimeMillis()
+                val expirationTime = expirationTimes.getOrPut(socket) { currentTime + keepAliveTimeout }
 
-            if (expirationTime < currentTime) {
-                expirationTimes -= socket
-                socket = factory(host, port)
-            }
+                if (expirationTime < currentTime) {
+                    expirationTimes -= socket
+                    socket = factory(host, port)
+                }
 
 
-            return socket.apply {
-                expirationTimes[socket] = currentTime + keepAliveTimeout
+                return socket.apply {
+                    expirationTimes[socket] = currentTime + keepAliveTimeout
+                }
+            } catch (ex: Exception) {
+                // release semaphore because the socket was not created
+                semaphore.release()
+                throw ex
             }
         }
 

src/main/kotlin/com/exactpro/th2/http/client/api/decorators/Th2RequestDecorator.kt

@@ -16,6 +16,7 @@
 
 package com.exactpro.th2.http.client.api.decorators
 
+import com.exactpro.th2.common.event.EventUtils.generateUUID
 import com.exactpro.th2.common.grpc.EventID
 import rawhttp.core.EagerHttpRequest
 import rawhttp.core.RawHttpHeaders
@@ -24,16 +25,22 @@ import rawhttp.core.RequestLine
 import rawhttp.core.body.BodyReader
 import rawhttp.core.body.HttpMessageBody
 import java.net.InetAddress
+import java.time.Instant
+import java.util.concurrent.TimeUnit.SECONDS
+import java.util.concurrent.atomic.AtomicLong
 
 class Th2RawHttpRequest(
     requestLine: RequestLine,
     headers: RawHttpHeaders,
     bodyReader: BodyReader?,
     senderAddress: InetAddress?,
     val parentEventId: EventID?,
-    val metadataProperties: Map<String, String>
+    val metadataProperties: Map<String, String>,
+    val th2RequestId: String = nextRequestId(),
 ) : RawHttpRequest(requestLine, headers, bodyReader, senderAddress) {
 
+
+
     override fun withBody(body: HttpMessageBody?, adjustHeaders: Boolean): Th2RawHttpRequest =
         withBody(body, adjustHeaders) { headers: RawHttpHeaders, bodyReader: BodyReader? ->
             Th2RawHttpRequest(
@@ -42,7 +49,8 @@ class Th2RawHttpRequest(
                 bodyReader,
                 senderAddress.orElse(null),
                 parentEventId,
-                metadataProperties
+                metadataProperties,
+                th2RequestId,
             )
         }
 
@@ -61,7 +69,8 @@ class Th2RawHttpRequest(
             body.orElse(null),
             senderAddress.orElse(null),
             parentEventId,
-            metadataProperties
+            metadataProperties,
+            th2RequestId,
         )
     }
 
@@ -73,13 +82,22 @@ class Th2RawHttpRequest(
         body.orElse(null),
         senderAddress.orElse(null),
         parentEventId,
-        metadataProperties
+        metadataProperties,
+        th2RequestId,
     )
 
     override fun eagerly(): EagerHttpRequest {
         throw UnsupportedOperationException("Unsupported eagerly call of request. It's client side, no need to eager request")
     }
 
+    companion object {
+        private val BASE_REQUEST_ID = generateUUID()
+        private val REQUEST_ID_COUNTER = Instant.now().run {
+            AtomicLong(epochSecond * SECONDS.toNanos(1) + nano)
+        }
+
+        private fun nextRequestId() = "$BASE_REQUEST_ID-${REQUEST_ID_COUNTER.incrementAndGet()}"
+    }
 }
 
 

src/main/kotlin/com/exactpro/th2/http/client/util/MessageUtil.kt

@@ -66,6 +66,7 @@ private const val HEADER_NAME_FIELD = "name"
 private const val HEADER_VALUE_FIELD = "value"
 private const val HEADER_PREFIX = "header-"
 
+internal const val TH2_REQUEST_ID_PROPERTY = "th2-request-id"
 private const val METHOD_PROPERTY = METHOD_FIELD
 private const val URI_PROPERTY = URI_FIELD
 private const val CONTENT_TYPE_PROPERTY = "contentType"
@@ -305,7 +306,7 @@ private fun HttpMessage.toByteArrayOutputStream(): ByteArrayOutputStream {
 }
 
 private fun RawHttpRequest.toProperties(): Map<String, String> = when (this) {
-    is Th2RawHttpRequest -> metadataProperties.toMutableMap()
+    is Th2RawHttpRequest -> metadataProperties.toMutableMap().apply { put(TH2_REQUEST_ID_PROPERTY, th2RequestId) }
     else -> hashMapOf()
 }.apply {
     put(METHOD_PROPERTY, method)

src/test/kotlin/com/exactpro/th2/http/client/CommonTests.kt

@@ -20,12 +20,14 @@ import com.exactpro.th2.common.grpc.ConnectionID
 import com.exactpro.th2.common.grpc.EventID
 import com.exactpro.th2.http.client.api.decorators.Th2RawHttpRequest
 import com.exactpro.th2.http.client.util.toProtoMessage
-import org.junit.jupiter.api.Assertions
+import org.junit.jupiter.api.Assertions.assertEquals
+import org.junit.jupiter.api.Assertions.assertFalse
 import org.junit.jupiter.api.Test
 import rawhttp.core.HttpVersion
 import rawhttp.core.RawHttpHeaders
 import rawhttp.core.RequestLine
 import java.net.URI
+import kotlin.test.assertContains
 
 class CommonTests {
 
@@ -39,11 +41,16 @@ class CommonTests {
 
         val rawMessage = request.toProtoMessage(ConnectionID.getDefaultInstance(), 12345L)
         val newMetadata = rawMessage.metadata.propertiesMap
-        Assertions.assertEquals(metadata.values.size + 2 /* method and uri */, newMetadata.values.size)
-        metadata.forEach {
-            Assertions.assertTrue(newMetadata.containsKey(it.key))
-            Assertions.assertEquals(it.value, newMetadata[it.key])
+        assertEquals(metadata.values.size + 2 /* method and uri */ + 1 /* th2-request-id */, newMetadata.values.size)
+        assertFalse(newMetadata[PROPERTY].isNullOrBlank(), "The $PROPERTY message property is null or blank")
+        metadata.forEach { (name, value) ->
+            assertContains(newMetadata, name)
+            assertEquals(value, newMetadata[name])
         }
-        Assertions.assertEquals(parentEventID, rawMessage.parentEventId)
+        assertEquals(parentEventID, rawMessage.parentEventId)
+    }
+
+    companion object {
+        private const val PROPERTY = "th2-request-id"
     }
 }