fix(agent): algolia agent as query param (#391)

Author: aallam

client/src/commonMain/kotlin/com/algolia/search/configuration/internal/extension/AlgoliaAgent.kt

@@ -0,0 +1,37 @@
+package com.algolia.search.configuration.internal.extension
+
+import com.algolia.search.configuration.AlgoliaSearchClient
+import com.algolia.search.configuration.clientUserAgent
+import com.algolia.search.serialize.internal.Key
+import io.ktor.client.HttpClient
+import io.ktor.client.plugins.HttpClientPlugin
+import io.ktor.client.request.HttpRequestPipeline
+import io.ktor.util.AttributeKey
+
+/**
+ * A plugin that adds Algolia agent to all requests.
+ *
+ * @property agent `X-Algolia-Agent` header value.
+ */
+internal class AlgoliaAgent private constructor(val agent: String) {
+
+    class Config(var agent: String = clientUserAgent(AlgoliaSearchClient.version))
+
+    companion object Plugin : HttpClientPlugin<Config, AlgoliaAgent> {
+
+        override val key: AttributeKey<AlgoliaAgent> = AttributeKey("AlgoliaAgent")
+        override fun prepare(block: Config.() -> Unit): AlgoliaAgent = AlgoliaAgent(Config().apply(block).agent)
+
+        override fun install(plugin: AlgoliaAgent, scope: HttpClient) {
+            scope.requestPipeline.intercept(HttpRequestPipeline.State) {
+                context.url.parameters.apply {
+                    val parameter = Key.AlgoliaAgent
+                    val current = getAll(parameter) ?: listOf()
+                    val updated = listOf(plugin.agent) + current
+                    remove(parameter)
+                    append(parameter, updated.joinToString("; "))
+                }
+            }
+        }
+    }
+}

client/src/commonMain/kotlin/com/algolia/search/configuration/internal/extension/HttpClient.kt

@@ -1,16 +1,13 @@
 package com.algolia.search.configuration.internal.extension
 
-import com.algolia.search.configuration.AlgoliaSearchClient
 import com.algolia.search.configuration.Configuration
-import com.algolia.search.configuration.clientUserAgent
 import com.algolia.search.logging.LogLevel
 import com.algolia.search.logging.Logger
 import com.algolia.search.logging.internal.toKtorLogger
 import com.algolia.search.serialize.internal.JsonNonStrict
 import io.ktor.client.HttpClient
 import io.ktor.client.HttpClientConfig
 import io.ktor.client.plugins.HttpTimeout
-import io.ktor.client.plugins.UserAgent
 import io.ktor.client.plugins.contentnegotiation.ContentNegotiation
 import io.ktor.client.plugins.defaultRequest
 import io.ktor.client.plugins.logging.Logging
@@ -31,10 +28,8 @@ internal fun HttpClientConfig<*>.configure(configuration: Configuration) {
     // Logging
     installLogging(configuration.logLevel, configuration.logger)
 
-    // User agent
-    install(UserAgent) {
-        agent = clientUserAgent(AlgoliaSearchClient.version)
-    }
+    // Algolia user agent
+    install(AlgoliaAgent)
 
     // Timeout
     install(HttpTimeout)

client/src/commonMain/kotlin/com/algolia/search/endpoint/internal/EndpointInsights.kt

@@ -18,7 +18,7 @@ internal class EndpointInsightsImpl(
 ) : EndpointInsights {
 
     override suspend fun sendEvent(event: InsightsEvent, requestOptions: RequestOptions?): HttpResponse {
-        return sendEvents(listOf(event))
+        return sendEvents(listOf(event), requestOptions)
     }
 
     override suspend fun sendEvents(events: List<InsightsEvent>, requestOptions: RequestOptions?): HttpResponse {

client/src/commonMain/kotlin/com/algolia/search/serialize/internal/Key.kt

@@ -433,4 +433,5 @@ internal object Key {
     const val MaxRecommendations: String = "maxRecommendations"
     const val FallbackParameters: String = "fallbackParameters"
     const val Default: String = "default"
+    const val AlgoliaAgent = "X-Algolia-Agent"
 }

client/src/commonTest/kotlin/configuration/TestUserAgent.kt

@@ -4,12 +4,12 @@ import com.algolia.search.client.ClientSearch
 import com.algolia.search.configuration.AlgoliaSearchClient
 import com.algolia.search.configuration.ConfigurationSearch
 import com.algolia.search.configuration.clientUserAgent
-import com.algolia.search.internal.BuildConfig
+import com.algolia.search.configuration.internal.extension.AlgoliaAgent
 import com.algolia.search.model.APIKey
 import com.algolia.search.model.ApplicationID
+import com.algolia.search.serialize.internal.Key
 import io.ktor.client.engine.mock.MockEngine
 import io.ktor.client.engine.mock.respondOk
-import io.ktor.client.plugins.UserAgent
 import io.ktor.client.request.HttpRequestBuilder
 import io.ktor.client.request.request
 import kotlinx.coroutines.test.runTest
@@ -21,7 +21,6 @@ internal class TestUserAgent {
 
     private val applicationID = ApplicationID("applicationID")
     private val apiKey = APIKey("apiKey")
-    private val userAgentKey = "User-Agent"
 
     @Test
     fun testUserAgent() {
@@ -33,22 +32,23 @@ internal class TestUserAgent {
     @Test
     fun overridingUserAgentInConfigurationShouldBeIgnored() {
         runTest {
+            val testAgent = "Test"
             val configuration = ConfigurationSearch(
                 applicationID = applicationID,
                 engine = MockEngine { respondOk() },
                 apiKey = apiKey,
                 httpClientConfig = {
-                    install(UserAgent) {
-                        agent = "Test"
+                    install(AlgoliaAgent) {
+                        agent = testAgent
                     }
                 }
             )
             val client = ClientSearch(configuration)
             val request = client.httpClient.request(HttpRequestBuilder())
-            val headers = request.call.request.headers
+            val urlParameters = request.call.request.url.parameters
 
-            headers.contains(userAgentKey).shouldBeTrue()
-            headers[userAgentKey] shouldEqual clientUserAgent(BuildConfig.version)
+            urlParameters.contains(Key.AlgoliaAgent).shouldBeTrue()
+            urlParameters[Key.AlgoliaAgent] shouldEqual testAgent
         }
     }
 }