Set header indicating product origin (#197) (#198)

* Set header indicating product origin

This commit updates the elasticsearch client to set a header indicating which
product component is using the API.

Implementation note: The implementation follows the pattern set with setting the
elastic API version header. The use of static factory methods for that make the
test setup fairly convoluted. I think (with the help of copilot) i've figured
out a way to mock everything, but it feels fairly complex.

* Release prep for version 0.1.17

Author: donoghuc

CHANGELOG.md

@@ -1,3 +1,6 @@
+## 0.1.17
+    - Add `x-elastic-product-origin` header to Elasticsearch requests [#197](https://github.com/elastic/logstash-filter-elastic_integration/pull/197)
+
 ## 0.1.16
   - Reflects the Elasticsearch GeoIP changes into the plugin and syncs with Elasticsearch 8.16 branch [#170](https://github.com/elastic/logstash-filter-elastic_integration/pull/170)
 

VERSION

@@ -1 +1 @@
-0.1.16
+0.1.17

build.gradle

@@ -51,6 +51,8 @@ configurations {
 
     geolite2 { canBeConsumed = false }
 
+    mockitoAgent { canBeConsumed = false }
+
     implementation.extendsFrom(logstashCore, elasticsearchMinimalCore, elasticsearchClient)
 }
 
@@ -93,6 +95,9 @@ dependencies {
         from requiredLogstashCoreJar("guava", "jre")
     })
 
+    mockitoAgent('org.mockito:mockito-core:5.14.1') {
+        transitive = false
+    }
     testImplementation 'org.junit.jupiter:junit-jupiter-api:5.1.0'
     testRuntimeOnly 'org.junit.jupiter:junit-jupiter-engine:5.1.0'
     testImplementation 'org.mockito:mockito-junit-jupiter:5.14.1'
@@ -440,7 +445,11 @@ tasks.withType(Test) {
             "--add-opens=java.base/sun.nio.ch=ALL-UNNAMED",
             "--add-opens=java.base/java.io=ALL-UNNAMED",
             "--add-opens=java.base/java.lang=ALL-UNNAMED",
-            "--add-opens=java.base/java.util=ALL-UNNAMED"
+            "--add-opens=java.base/java.util=ALL-UNNAMED",
+            "-Djdk.attach.allowAttachSelf=true",
+            "-Dmockito.mock.maker=inline",
+            "-javaagent:${configurations.mockitoAgent.asPath}",
+            "-XX:+EnableDynamicAgentLoading"
     ]
 }
 

src/main/java/co/elastic/logstash/filters/elasticintegration/ElasticsearchRestClientBuilder.java

@@ -461,6 +461,10 @@ public void configureHttpClient(final HttpAsyncClientBuilder httpClientBuilder)
                 final HttpRequestInterceptor interceptor = new EAVHttpRequestInterceptor(elasticApiVersionHeader);
                 HttpClientConfigurator.forAddInterceptorFirst(interceptor).configure(httpClientBuilder);
             }
+            // Set header indicating internal use
+            final BasicHeader productOriginHeader = new BasicHeader("x-elastic-product-origin", "logstash-filter-elastic_integration");
+            final HttpRequestInterceptor productOriginHeaderInterceptor = new EAVHttpRequestInterceptor(productOriginHeader);
+            HttpClientConfigurator.forAddInterceptorFirst(productOriginHeaderInterceptor).configure(httpClientBuilder);
         }
     }
 }

src/test/java/co/elastic/logstash/filters/elasticintegration/ElasticsearchRestClientBuilderTest.java

@@ -6,7 +6,13 @@
  */
 package co.elastic.logstash.filters.elasticintegration;
 
+import org.apache.http.HttpException;
 import org.apache.http.HttpHost;
+import org.apache.http.HttpRequest;
+import org.apache.http.HttpRequestInterceptor;
+import org.apache.http.message.BasicHeader;
+import org.apache.http.message.BasicHttpRequest;
+import org.apache.http.impl.nio.client.HttpAsyncClientBuilder;
 import org.elasticsearch.client.RestClient;
 import org.elasticsearch.client.RestClientBuilder;
 import org.hamcrest.Matchers;
@@ -18,11 +24,20 @@
 import java.util.Collection;
 import java.util.Collections;
 import java.util.List;
+import java.util.Objects;
+
+import co.elastic.logstash.filters.elasticintegration.ElasticsearchRestClientBuilder.ElasticApiConfig;
+
+import org.mockito.MockedStatic;
+import org.mockito.ArgumentCaptor;
 
 import static org.hamcrest.MatcherAssert.assertThat;
 import static org.hamcrest.Matchers.containsString;
+import static org.hamcrest.Matchers.equalTo;
+import static org.hamcrest.Matchers.is;
 import static org.hamcrest.Matchers.stringContainsInOrder;
 import static org.junit.jupiter.api.Assertions.assertThrows;
+import static org.mockito.ArgumentCaptor.forClass;
 import static org.mockito.Mockito.*;
 
 class ElasticsearchRestClientBuilderTest {
@@ -111,6 +126,41 @@ public void testForHostsFactoryURLsWithoutPort() {
         assertThat(illegalStateException.getMessage(), containsString("URLS must include port specification"));
     }
 
+    @Test
+    public void testElasticApiConfigAddsHeaders() throws HttpException, IOException {
+        ElasticApiConfig config = new ElasticApiConfig();
+        config.setApiVersion("2023-10-31");
+
+        ElasticsearchRestClientBuilder.HttpClientConfigurator mockConfigurator =
+            mock(ElasticsearchRestClientBuilder.HttpClientConfigurator.class);
+
+        try (MockedStatic<ElasticsearchRestClientBuilder.HttpClientConfigurator> mockedStatic =
+                mockStatic(ElasticsearchRestClientBuilder.HttpClientConfigurator.class)) {
+            mockedStatic.when(() ->
+                ElasticsearchRestClientBuilder.HttpClientConfigurator.forAddInterceptorFirst(
+                    any(HttpRequestInterceptor.class)))
+                .thenReturn(mockConfigurator);
+
+            HttpAsyncClientBuilder builder = HttpAsyncClientBuilder.create();
+            config.configureHttpClient(builder);
+
+            ArgumentCaptor<HttpRequestInterceptor> interceptorCaptor = forClass(HttpRequestInterceptor.class);
+            mockedStatic.verify(() ->
+                ElasticsearchRestClientBuilder.HttpClientConfigurator.forAddInterceptorFirst(
+                    interceptorCaptor.capture()), times(2));
+            verify(mockConfigurator, times(2)).configure(builder);
+
+            // Process interceptors and look for product origin header
+            List<HttpRequestInterceptor> interceptors = interceptorCaptor.getAllValues();
+            HttpRequest request = new BasicHttpRequest("GET", "/");
+            for (HttpRequestInterceptor interceptor : interceptors) {
+                interceptor.process(request, null);
+            }
+            assertThat(request.getFirstHeader("x-elastic-product-origin").getValue(),
+                    is("logstash-filter-elastic_integration"));
+        }
+    }
+
     private <T> void validateTranslationToClientBuilderFactory(final Collection<URL> inputUrls, final HttpHost[] expectedInputReceivedByBuilderFactory) {
         final ElasticsearchRestClientBuilder.HostsArrayRestClientBuilderFactory hostsArrayRestClientBuilderFactory = spy(HOSTS_ARRAY_REST_CLIENT_BUILDER_FACTORY);
         try (RestClient restClient = ElasticsearchRestClientBuilder.forURLs(inputUrls, hostsArrayRestClientBuilderFactory).build()) {