Update the version of libthrift to 0.14.1 (#772). (#774)

This change updates the version of the dependency libthrift to 0.14.1. The primary impact of this is the requirement to handle a new checked exception, TTransportException, and a new base class TEndpointTransport which is used instead of TTransport and provides a useful implementation of some additional methods that were added to the TTransport base class.

Signed-off-by: Robert Greig <[email protected]>

Co-authored-by: Yuri Shkuro <[email protected]>

Author: rgreig

build.gradle

@@ -19,7 +19,7 @@ plugins {
 
 ext.opentracingVersion = getProperty('opentracingVersion','0.33.0')
 ext.guavaVersion = getProperty('guavaVersion','18.0')
-ext.apacheThriftVersion = getProperty('apacheThriftVersion','0.13.0')
+ext.apacheThriftVersion = getProperty('apacheThriftVersion','0.14.1')
 ext.jerseyVersion = getProperty('jerseyVersion','2.22.2')
 ext.slf4jVersion = getProperty('slf4jVersion','1.7.28')
 ext.gsonVersion = getProperty('gsonVersion','2.8.6')

jaeger-crossdock/src/main/java/io/jaegertracing/crossdock/JerseyServer.java

@@ -40,6 +40,7 @@
 import javax.ws.rs.client.Client;
 import javax.ws.rs.client.ClientBuilder;
 import org.apache.log4j.BasicConfigurator;
+import org.apache.thrift.transport.TTransportException;
 import org.glassfish.grizzly.GrizzlyFuture;
 import org.glassfish.grizzly.http.server.HttpServer;
 import org.glassfish.grizzly.http.server.NetworkListener;
@@ -141,7 +142,7 @@ private static String getEvn(String envName, String defaultValue) {
     return env;
   }
 
-  private static Sender senderFromEnv(String collectorHostPort, String agentHost) {
+  private static Sender senderFromEnv(String collectorHostPort, String agentHost) throws TTransportException {
     String senderEnvVar = System.getenv(Constants.ENV_PROP_SENDER_TYPE);
     if ("http".equalsIgnoreCase(senderEnvVar)) {
       return new HttpSender.Builder(String.format("http://%s/api/traces", collectorHostPort))

jaeger-thrift/src/main/java/io/jaegertracing/thrift/internal/reporters/protocols/ThriftUdpTransport.java

@@ -23,14 +23,16 @@
 import java.net.UnknownHostException;
 import java.nio.ByteBuffer;
 import lombok.ToString;
+import org.apache.thrift.TConfiguration;
+import org.apache.thrift.transport.TEndpointTransport;
 import org.apache.thrift.transport.TTransport;
 import org.apache.thrift.transport.TTransportException;
 
 /*
  * A thrift transport for sending sending/receiving spans.
  */
 @ToString
-public class ThriftUdpTransport extends TTransport implements Closeable {
+public class ThriftUdpTransport extends TEndpointTransport implements Closeable {
   public static final int MAX_PACKET_SIZE = 65000;
 
   public int receiveOffSet = -1;
@@ -41,7 +43,7 @@ public class ThriftUdpTransport extends TTransport implements Closeable {
   @ToString.Exclude public ByteBuffer writeBuffer;
 
   // Create a UDP client for sending data to specific host and port
-  public static ThriftUdpTransport newThriftUdpClient(String host, int port) {
+  public static ThriftUdpTransport newThriftUdpClient(String host, int port) throws TTransportException {
     ThriftUdpTransport t;
     try {
       t = new ThriftUdpTransport();
@@ -54,13 +56,14 @@ public static ThriftUdpTransport newThriftUdpClient(String host, int port) {
 
   // Create a UDP server for receiving data on specific host and port
   public static ThriftUdpTransport newThriftUdpServer(String host, int port)
-      throws SocketException, UnknownHostException {
+      throws SocketException, TTransportException, UnknownHostException {
     ThriftUdpTransport t = new ThriftUdpTransport();
     t.socket.bind(new InetSocketAddress(host, port));
     return t;
   }
 
-  private ThriftUdpTransport() throws SocketException {
+  private ThriftUdpTransport() throws TTransportException, SocketException {
+    super(new TConfiguration());
     this.socket = new DatagramSocket(null);
   }
 

jaeger-thrift/src/main/java/io/jaegertracing/thrift/internal/senders/HttpSender.java

@@ -29,6 +29,7 @@
 import okhttp3.Request;
 import okhttp3.RequestBody;
 import okhttp3.Response;
+import org.apache.thrift.transport.TTransportException;
 
 @ToString
 public class HttpSender extends ThriftSender {
@@ -39,7 +40,7 @@ public class HttpSender extends ThriftSender {
   @ToString.Exclude private final OkHttpClient httpClient;
   @ToString.Exclude private final Request.Builder requestBuilder;
 
-  protected HttpSender(Builder builder) {
+  protected HttpSender(Builder builder) throws TTransportException {
     super(ProtocolType.Binary, builder.maxPacketSize);
     HttpUrl collectorUrl = HttpUrl
         .parse(String.format("%s?%s", builder.endpoint, HTTP_COLLECTOR_JAEGER_THRIFT_FORMAT_PARAM));
@@ -119,7 +120,7 @@ public Builder withAuth(String authToken) {
       return this;
     }
 
-    public HttpSender build() {
+    public HttpSender build() throws TTransportException {
       if (authInterceptor != null) {
         clientBuilder.addInterceptor(authInterceptor);
       }

jaeger-thrift/src/main/java/io/jaegertracing/thrift/internal/senders/ThriftSender.java

@@ -23,6 +23,7 @@
 import java.util.ArrayList;
 import java.util.List;
 import lombok.ToString;
+import org.apache.thrift.transport.TTransportException;
 
 @ToString
 public abstract class ThriftSender extends ThriftSenderBase implements Sender {
@@ -37,7 +38,7 @@ public abstract class ThriftSender extends ThriftSenderBase implements Sender {
    * @param protocolType protocol type (compact or binary)
    * @param maxPacketSize if 0 it will use default value {@value ThriftUdpTransport#MAX_PACKET_SIZE}
    */
-  public ThriftSender(ProtocolType protocolType, int maxPacketSize) {
+  public ThriftSender(ProtocolType protocolType, int maxPacketSize) throws TTransportException {
     super(protocolType, maxPacketSize);
 
     spanBuffer = new ArrayList<io.jaegertracing.thriftjava.Span>();

jaeger-thrift/src/main/java/io/jaegertracing/thrift/internal/senders/ThriftSenderBase.java

@@ -18,11 +18,13 @@
 import lombok.ToString;
 import lombok.extern.slf4j.Slf4j;
 import org.apache.thrift.TBase;
+import org.apache.thrift.TConfiguration;
 import org.apache.thrift.TSerializer;
 import org.apache.thrift.protocol.TBinaryProtocol;
 import org.apache.thrift.protocol.TCompactProtocol;
 import org.apache.thrift.protocol.TProtocolFactory;
 import org.apache.thrift.transport.AutoExpandingBufferWriteTransport;
+import org.apache.thrift.transport.TTransportException;
 
 @ToString
 @Slf4j
@@ -45,7 +47,7 @@ public enum ProtocolType {
    * @param protocolType protocol type (compact or binary)
    * @param maxPacketSize if 0 it will use default value {@value ThriftUdpTransport#MAX_PACKET_SIZE}
    */
-  public ThriftSenderBase(ProtocolType protocolType, int maxPacketSize) {
+  public ThriftSenderBase(ProtocolType protocolType, int maxPacketSize) throws TTransportException {
     switch (protocolType) {
       case Binary:
         this.protocolFactory = new TBinaryProtocol.Factory();
@@ -64,7 +66,7 @@ public ThriftSenderBase(ProtocolType protocolType, int maxPacketSize) {
     }
 
     maxBatchBytes = maxPacketSize - EMIT_BATCH_OVERHEAD;
-    memoryTransport = new AutoExpandingBufferWriteTransport(maxPacketSize, 2);
+    memoryTransport = new AutoExpandingBufferWriteTransport(new TConfiguration(), maxPacketSize, 2);
     serializer = new TSerializer(protocolFactory);
   }
 

jaeger-thrift/src/main/java/io/jaegertracing/thrift/internal/senders/ThriftSenderFactory.java

@@ -5,6 +5,7 @@
 import io.jaegertracing.spi.SenderFactory;
 import lombok.ToString;
 import lombok.extern.slf4j.Slf4j;
+import org.apache.thrift.transport.TTransportException;
 
 /**
  * Factory for {@link Sender} instances backed by Thrift. The actual sender implementation can be either
@@ -27,14 +28,24 @@ public Sender getSender(Configuration.SenderConfiguration conf) {
       }
 
       log.debug("Using the HTTP Sender to send spans directly to the endpoint.");
-      return httpSenderBuilder.build();
+      try {
+        return httpSenderBuilder.build();
+      }
+      catch (TTransportException e) {
+        throw new RuntimeException("Failed to build http sender: " + e, e);
+      }
     }
 
     log.debug("Using the UDP Sender to send spans to the agent.");
-    return new UdpSender(
-        stringOrDefault(conf.getAgentHost(), UdpSender.DEFAULT_AGENT_UDP_HOST),
-        numberOrDefault(conf.getAgentPort(), UdpSender.DEFAULT_AGENT_UDP_COMPACT_PORT).intValue(),
-        0 /* max packet size */);
+    try {
+      return new UdpSender(
+              stringOrDefault(conf.getAgentHost(), UdpSender.DEFAULT_AGENT_UDP_HOST),
+              numberOrDefault(conf.getAgentPort(), UdpSender.DEFAULT_AGENT_UDP_COMPACT_PORT).intValue(),
+              0 /* max packet size */);
+    }
+    catch (TTransportException e) {
+      throw new RuntimeException("Unable to create UDPSender: " + e, e);
+    }
   }
 
   @Override

jaeger-thrift/src/main/java/io/jaegertracing/thrift/internal/senders/UdpSender.java

@@ -21,6 +21,7 @@
 import io.jaegertracing.thriftjava.Process;
 import java.util.List;
 import lombok.ToString;
+import org.apache.thrift.transport.TTransportException;
 
 @ToString
 public class UdpSender extends ThriftSender {
@@ -37,7 +38,7 @@ public class UdpSender extends ThriftSender {
    * This constructor expects Jaeger running running on {@value #DEFAULT_AGENT_UDP_HOST}
    * and port {@value #DEFAULT_AGENT_UDP_COMPACT_PORT}
    */
-  public UdpSender() {
+  public UdpSender() throws TTransportException {
     this(DEFAULT_AGENT_UDP_HOST, DEFAULT_AGENT_UDP_COMPACT_PORT, 0);
   }
 
@@ -46,7 +47,7 @@ public UdpSender() {
    * @param port port e.g. {@value DEFAULT_AGENT_UDP_COMPACT_PORT}
    * @param maxPacketSize if 0 it will use {@value ThriftUdpTransport#MAX_PACKET_SIZE}
    */
-  public UdpSender(String host, int port, int maxPacketSize) {
+  public UdpSender(String host, int port, int maxPacketSize) throws TTransportException {
     super(ProtocolType.Compact, maxPacketSize);
 
     if (host == null || host.length() == 0) {
@@ -61,7 +62,7 @@ public UdpSender(String host, int port, int maxPacketSize) {
     this.port = port;
   }
 
-  private Agent.Client getAgentClient() {
+  private Agent.Client getAgentClient() throws TTransportException {
     Agent.Client localRef = this.agentClient;
     if (localRef == null) {
       synchronized (this) {

jaeger-thrift/src/test/java/io/jaegertracing/thrift/internal/reporters/protocols/TestTServer.java

@@ -22,13 +22,14 @@
 import org.apache.thrift.protocol.TCompactProtocol;
 import org.apache.thrift.server.TServer;
 import org.apache.thrift.server.TSimpleServer;
+import org.apache.thrift.transport.TTransportException;
 
 public class TestTServer implements Runnable {
   TServer server;
   InMemorySpanServerHandler handler;
   ThriftUdpServerTransport transport;
 
-  public TestTServer(int port) throws SocketException, UnknownHostException {
+  public TestTServer(int port) throws SocketException, UnknownHostException, TTransportException {
     handler = new InMemorySpanServerHandler();
     transport = new ThriftUdpServerTransport(port);
     server =
@@ -62,7 +63,7 @@ public Batch getBatch(int expectedSpans, int timeout) throws Exception {
         batch.setProcess(receivedBatch.getProcess());
       }
 
-      if (batch.spans.size() >= expectedSpans) {
+      if (batch.getSpans().size() >= expectedSpans) {
         return batch;
       }
 

jaeger-thrift/src/test/java/io/jaegertracing/thrift/internal/reporters/protocols/ThriftSenderBaseTest.java

@@ -22,6 +22,8 @@
 import io.jaegertracing.thriftjava.Span;
 import java.util.ArrayList;
 import java.util.List;
+
+import org.apache.thrift.TConfiguration;
 import org.apache.thrift.protocol.TCompactProtocol;
 import org.apache.thrift.transport.AutoExpandingBufferWriteTransport;
 import org.junit.Test;
@@ -44,7 +46,7 @@ public void testEmitBatchOverhead() throws Exception {
 
   private int calculateBatchOverheadDifference(int numberOfSpans) throws Exception {
     AutoExpandingBufferWriteTransport memoryTransport =
-        new AutoExpandingBufferWriteTransport(maxPacketSize, 2);
+        new AutoExpandingBufferWriteTransport(new TConfiguration(), maxPacketSize, 2);
     Agent.Client memoryClient = new Agent.Client(new TCompactProtocol((memoryTransport)));
     Span span = new Span();
     span.setOperationName("raza");