Haystack commons refactor (#101)

doctorXWrites · ashishagg · commit a15d6a91a307 · 2019-04-10T17:18:51.000+05:30
* use haystack idl instead of entire commons library

* creating a separate remote clients module

* bumping up the haystack client java release version

* updating the parent version for pom
diff --git a/core/pom.xml b/core/pom.xml
@@ -5,7 +5,7 @@
   <parent>
     <groupId>com.expedia.www</groupId>
     <artifactId>haystack-client-java-parent</artifactId>
-    <version>0.2.6-SNAPSHOT</version>
+    <version>0.2.7-SNAPSHOT</version>
   </parent>
 
   <artifactId>haystack-client-core</artifactId>
@@ -20,6 +20,12 @@
       <version>${project.version}</version>
     </dependency>
 
+    <dependency>
+      <groupId>com.expedia.www</groupId>
+      <artifactId>haystack-remote-clients</artifactId>
+      <version>${project.version}</version>
+    </dependency>
+
     <dependency>
       <groupId>com.expedia.www</groupId>
       <artifactId>haystack-idl-java</artifactId>
diff --git a/core/src/main/java/com/expedia/www/haystack/client/dispatchers/RemoteDispatcher.java b/core/src/main/java/com/expedia/www/haystack/client/dispatchers/RemoteDispatcher.java
@@ -17,10 +17,10 @@
 package com.expedia.www.haystack.client.dispatchers;
 
 import com.expedia.www.haystack.client.Span;
-import com.expedia.www.haystack.client.dispatchers.clients.Client;
-import com.expedia.www.haystack.client.dispatchers.clients.ClientException;
 import com.expedia.www.haystack.client.metrics.*;
 import com.expedia.www.haystack.client.metrics.Timer.Sample;
+import com.expedia.www.haystack.remote.clients.Client;
+import com.expedia.www.haystack.remote.clients.ClientException;
 import org.apache.commons.lang3.builder.ReflectionToStringBuilder;
 import org.apache.commons.lang3.builder.ToStringStyle;
 import org.slf4j.Logger;
diff --git a/core/src/main/java/com/expedia/www/haystack/client/dispatchers/clients/GRPCAgentClient.java b/core/src/main/java/com/expedia/www/haystack/client/dispatchers/clients/GRPCAgentClient.java
@@ -25,6 +25,8 @@
 import com.expedia.www.haystack.client.metrics.Metrics;
 import com.expedia.www.haystack.client.metrics.MetricsRegistry;
 import com.expedia.www.haystack.client.metrics.Timer.Sample;
+import com.expedia.www.haystack.remote.clients.BaseGrpcClient;
+import com.expedia.www.haystack.remote.clients.ClientException;
 import io.grpc.ManagedChannel;
 import io.grpc.stub.StreamObserver;
 
diff --git a/core/src/main/java/com/expedia/www/haystack/client/dispatchers/clients/HttpCollectorClient.java b/core/src/main/java/com/expedia/www/haystack/client/dispatchers/clients/HttpCollectorClient.java
@@ -19,6 +19,9 @@
 import com.expedia.www.haystack.client.Span;
 import com.expedia.www.haystack.client.dispatchers.formats.Format;
 import com.expedia.www.haystack.client.dispatchers.formats.ProtoBufFormat;
+import com.expedia.www.haystack.remote.clients.BaseHttpClient;
+import com.expedia.www.haystack.remote.clients.Client;
+import com.expedia.www.haystack.remote.clients.ClientException;
 import org.apache.http.impl.client.CloseableHttpClient;
 
 import java.util.Collections;
diff --git a/core/src/main/java/com/expedia/www/haystack/client/dispatchers/clients/InMemoryClient.java b/core/src/main/java/com/expedia/www/haystack/client/dispatchers/clients/InMemoryClient.java
@@ -23,6 +23,7 @@
 import java.util.List;
 import java.util.concurrent.Semaphore;
 
+import com.expedia.www.haystack.remote.clients.Client;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
diff --git a/core/src/main/java/com/expedia/www/haystack/client/dispatchers/clients/LoggerClient.java b/core/src/main/java/com/expedia/www/haystack/client/dispatchers/clients/LoggerClient.java
@@ -18,6 +18,7 @@
 
 import java.util.Arrays;
 
+import com.expedia.www.haystack.remote.clients.Client;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
diff --git a/core/src/main/java/com/expedia/www/haystack/client/dispatchers/clients/NoopClient.java b/core/src/main/java/com/expedia/www/haystack/client/dispatchers/clients/NoopClient.java
@@ -17,6 +17,7 @@
 package com.expedia.www.haystack.client.dispatchers.clients;
 
 import com.expedia.www.haystack.client.Span;
+import com.expedia.www.haystack.remote.clients.Client;
 
 public class NoopClient implements Client<Span> {
 
diff --git a/core/src/test/java/com/expedia/www/haystack/client/dispatchers/clients/HttpCollectorClientTest.java b/core/src/test/java/com/expedia/www/haystack/client/dispatchers/clients/HttpCollectorClientTest.java
@@ -22,6 +22,7 @@
 import com.expedia.www.haystack.client.Tracer;
 import com.expedia.www.haystack.client.dispatchers.InMemoryDispatcher;
 import com.expedia.www.haystack.client.metrics.NoopMetricsRegistry;
+import com.expedia.www.haystack.remote.clients.ClientException;
 import org.apache.http.ProtocolVersion;
 import org.apache.http.client.methods.CloseableHttpResponse;
 import org.apache.http.client.methods.HttpPost;
diff --git a/haystack-remote-clients/pom.xml b/haystack-remote-clients/pom.xml
@@ -0,0 +1,83 @@
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
+
+    <modelVersion>4.0.0</modelVersion>
+
+    <parent>
+        <groupId>com.expedia.www</groupId>
+        <artifactId>haystack-client-java-parent</artifactId>
+        <version>0.2.7-SNAPSHOT</version>
+    </parent>
+
+    <artifactId>haystack-remote-clients</artifactId>
+    <packaging>jar</packaging>
+    <name>haystack-remote-clients</name>
+
+    <dependencies>
+        <dependency>
+            <groupId>com.expedia.www</groupId>
+            <artifactId>haystack-idl-java</artifactId>
+        </dependency>
+
+        <dependency>
+            <groupId>com.expedia.www</groupId>
+            <artifactId>haystack-client-metrics-api</artifactId>
+            <version>${project.version}</version>
+        </dependency>
+
+        <dependency>
+            <groupId>io.grpc</groupId>
+            <artifactId>grpc-netty-shaded</artifactId>
+        </dependency>
+
+        <dependency>
+            <groupId>io.grpc</groupId>
+            <artifactId>grpc-protobuf</artifactId>
+        </dependency>
+
+        <dependency>
+            <groupId>io.grpc</groupId>
+            <artifactId>grpc-stub</artifactId>
+        </dependency>
+
+        <dependency>
+            <groupId>org.apache.commons</groupId>
+            <artifactId>commons-lang3</artifactId>
+        </dependency>
+
+        <dependency>
+            <groupId>org.slf4j</groupId>
+            <artifactId>slf4j-api</artifactId>
+        </dependency>
+
+        <dependency>
+            <groupId>org.apache.httpcomponents</groupId>
+            <artifactId>httpclient</artifactId>
+        </dependency>
+
+        <!-- Test dependencies -->
+        <dependency>
+            <groupId>junit</groupId>
+            <artifactId>junit</artifactId>
+            <scope>test</scope>
+        </dependency>
+
+        <dependency>
+            <groupId>org.mockito</groupId>
+            <artifactId>mockito-core</artifactId>
+            <scope>test</scope>
+        </dependency>
+
+        <dependency>
+            <groupId>io.grpc</groupId>
+            <artifactId>grpc-testing</artifactId>
+            <scope>test</scope>
+        </dependency>
+
+        <dependency>
+            <groupId>org.awaitility</groupId>
+            <artifactId>awaitility</artifactId>
+            <scope>test</scope>
+        </dependency>
+    </dependencies>
+
+</project>
diff --git a/haystack-remote-clients/src/main/java/com/expedia/www/haystack/remote/clients/BaseGrpcClient.java b/haystack-remote-clients/src/main/java/com/expedia/www/haystack/remote/clients/BaseGrpcClient.java
@@ -15,7 +15,7 @@
  *
  */
 
-package com.expedia.www.haystack.client.dispatchers.clients;
+package com.expedia.www.haystack.remote.clients;
 
 import com.expedia.open.tracing.agent.api.DispatchResult;
 import com.expedia.open.tracing.agent.api.SpanAgentGrpc;
diff --git a/haystack-remote-clients/src/main/java/com/expedia/www/haystack/remote/clients/BaseHttpClient.java b/haystack-remote-clients/src/main/java/com/expedia/www/haystack/remote/clients/BaseHttpClient.java
@@ -15,7 +15,7 @@
  *
  */
 
-package com.expedia.www.haystack.client.dispatchers.clients;
+package com.expedia.www.haystack.remote.clients;
 
 import org.apache.commons.lang3.Validate;
 import org.apache.http.Header;
@@ -32,7 +32,7 @@
 import java.util.Map;
 import java.util.stream.Collectors;
 
-abstract class BaseHttpClient {
+public abstract class BaseHttpClient {
     private final String endpoint;
     private final BasicHeader[] headers;
     private final CloseableHttpClient httpClient;
diff --git a/haystack-remote-clients/src/main/java/com/expedia/www/haystack/remote/clients/Client.java b/haystack-remote-clients/src/main/java/com/expedia/www/haystack/remote/clients/Client.java
@@ -14,7 +14,7 @@
  *       limitations under the License.
  *
  */
-package com.expedia.www.haystack.client.dispatchers.clients;
+package com.expedia.www.haystack.remote.clients;
 
 import java.io.Closeable;
 import java.io.Flushable;
diff --git a/haystack-remote-clients/src/main/java/com/expedia/www/haystack/remote/clients/ClientException.java b/haystack-remote-clients/src/main/java/com/expedia/www/haystack/remote/clients/ClientException.java
@@ -14,7 +14,7 @@
  *       limitations under the License.
  *
  */
-package com.expedia.www.haystack.client.dispatchers.clients;
+package com.expedia.www.haystack.remote.clients;
 
 /**
  * An Exception to indicate a client failure
diff --git a/haystack-remote-clients/src/main/java/com/expedia/www/haystack/remote/clients/GRPCAgentProtoClient.java b/haystack-remote-clients/src/main/java/com/expedia/www/haystack/remote/clients/GRPCAgentProtoClient.java
@@ -0,0 +1,76 @@
+/*
+ * Copyright 2018 Expedia, Inc.
+ *
+ *       Licensed 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 com.expedia.www.haystack.remote.clients;
+
+
+import com.expedia.open.tracing.Span;
+import com.expedia.open.tracing.agent.api.DispatchResult;
+import com.expedia.open.tracing.agent.api.SpanAgentGrpc;
+import com.expedia.open.tracing.agent.api.SpanAgentGrpc.SpanAgentStub;
+import com.expedia.www.haystack.client.metrics.Metrics;
+import com.expedia.www.haystack.client.metrics.MetricsRegistry;
+import com.expedia.www.haystack.client.metrics.Timer.Sample;
+import io.grpc.ManagedChannel;
+import io.grpc.stub.StreamObserver;
+
+public class GRPCAgentProtoClient extends BaseGrpcClient<Span> {
+    public GRPCAgentProtoClient(Metrics metrics,
+                                ManagedChannel channel,
+                                SpanAgentStub stub,
+                                StreamObserver<DispatchResult> observer,
+                                long shutdownTimeoutMS) {
+        super(metrics, channel, stub, observer, shutdownTimeoutMS);
+    }
+
+    @Override
+    public boolean send(Span span) throws ClientException {
+        try (Sample timer = sendTimer.start()) {
+            stub.dispatch(span, observer);
+        } catch (Exception e) {
+            sendExceptionCounter.increment();
+            throw new ClientException(e.getMessage(), e);
+        }
+        // always true
+        return true;
+    }
+
+    public static final class Builder extends BaseGrpcClient.Builder {
+        public Builder(MetricsRegistry metrics, ManagedChannel channel) {
+            super(metrics, channel);
+        }
+
+        public Builder(Metrics metrics, String host, int port) {
+            super(metrics, host, port);
+        }
+
+        public Builder(MetricsRegistry metrics, String host, int port) {
+            super(metrics, host, port);
+        }
+
+        public GRPCAgentProtoClient build() {
+            ManagedChannel managedChannel = this.channel;
+
+            if (managedChannel == null) {
+                managedChannel = buildManagedChannel();
+            }
+
+            SpanAgentStub stub = SpanAgentGrpc.newStub(managedChannel);
+            return new GRPCAgentProtoClient(metrics, managedChannel, stub, observer, shutdownTimeoutMS);
+        }
+    }
+}
diff --git a/haystack-remote-clients/src/main/java/com/expedia/www/haystack/remote/clients/HttpCollectorProtoClient.java b/haystack-remote-clients/src/main/java/com/expedia/www/haystack/remote/clients/HttpCollectorProtoClient.java
@@ -0,0 +1,42 @@
+/*
+ * Copyright 2018 Expedia, Inc.
+ *
+ *       Licensed 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 com.expedia.www.haystack.remote.clients;
+
+import com.expedia.open.tracing.Span;
+import org.apache.http.impl.client.CloseableHttpClient;
+
+import java.util.Map;
+
+public class HttpCollectorProtoClient extends BaseHttpClient implements Client<Span> {
+    public HttpCollectorProtoClient(String endpoint, Map<String, String> headers) {
+        super(endpoint, headers);
+    }
+
+    public HttpCollectorProtoClient(String endpoint) {
+        super(endpoint);
+    }
+
+    public HttpCollectorProtoClient(String endpoint, Map<String, String> headers, CloseableHttpClient httpClient) {
+        super(endpoint, headers, httpClient);
+    }
+
+    @Override
+    public boolean send(Span span) throws ClientException {
+        return super.send(span.toByteArray());
+    }
+}
diff --git a/metrics/api/pom.xml b/metrics/api/pom.xml
@@ -5,7 +5,7 @@
     <parent>
         <artifactId>haystack-client-metrics</artifactId>
         <groupId>com.expedia.www</groupId>
-        <version>0.2.6-SNAPSHOT</version>
+        <version>0.2.7-SNAPSHOT</version>
     </parent>
     <modelVersion>4.0.0</modelVersion>
 
diff --git a/metrics/dropwizard-metrics/pom.xml b/metrics/dropwizard-metrics/pom.xml
@@ -6,7 +6,7 @@
     <parent>
         <groupId>com.expedia.www</groupId>
         <artifactId>haystack-client-metrics</artifactId>
-        <version>0.2.6-SNAPSHOT</version>
+        <version>0.2.7-SNAPSHOT</version>
     </parent>
 
     <artifactId>haystack-client-metrics-dropwizard</artifactId>
diff --git a/metrics/micrometer/pom.xml b/metrics/micrometer/pom.xml
@@ -6,7 +6,7 @@
     <parent>
         <groupId>com.expedia.www</groupId>
         <artifactId>haystack-client-metrics</artifactId>
-        <version>0.2.6-SNAPSHOT</version>
+        <version>0.2.7-SNAPSHOT</version>
     </parent>
 
     <artifactId>haystack-client-micrometer</artifactId>
diff --git a/metrics/pom.xml b/metrics/pom.xml
@@ -10,7 +10,7 @@
     <parent>
         <groupId>com.expedia.www</groupId>
         <artifactId>haystack-client-java-parent</artifactId>
-        <version>0.2.6-SNAPSHOT</version>
+        <version>0.2.7-SNAPSHOT</version>
     </parent>
 
     <artifactId>haystack-client-metrics</artifactId>
diff --git a/pom.xml b/pom.xml
@@ -4,7 +4,7 @@
 
   <groupId>com.expedia.www</groupId>
   <artifactId>haystack-client-java-parent</artifactId>
-  <version>0.2.6-SNAPSHOT</version>
+  <version>0.2.7-SNAPSHOT</version>
   <packaging>pom</packaging>
   <name>Haystack Java Client Parent POM</name>
   <description>Haystack Java Client Parent POM</description>
@@ -35,6 +35,7 @@
 
   <modules>
     <module>metrics</module>
+    <module>haystack-remote-clients</module>
     <module>core</module>
   </modules>
 

Original file line number	Diff line number	Diff line change
`@@ -15,7 +15,7 @@`
`15`	`15`	`*`
`16`	`16`	`*/`
`17`	`17`
`18`		`-package com.expedia.www.haystack.client.dispatchers.clients;`
	`18`	`+package com.expedia.www.haystack.remote.clients;`
`19`	`19`
`20`	`20`	`import com.expedia.open.tracing.agent.api.DispatchResult;`
`21`	`21`	`import com.expedia.open.tracing.agent.api.SpanAgentGrpc;`