Merge pull request linkerd#115 from liamstewart/ls/thrift_compact_protocol

olix0r · olix0r · commit 4177245f3e5a · 2016-02-22T09:37:44.000-08:00
Protocol configuration for thrift client/server.
diff --git a/CHANGES.md b/CHANGES.md
@@ -1,5 +1,8 @@
 ## 0.1.1
 
+* New `thriftProtocol` config option to the thrift protocol to be
+  specified.
+
 ## 0.1.0
 
 * Introduce Marathon-backed service discovery, for routing traffic in Mesos.
diff --git a/docs/config.md b/docs/config.md
@@ -246,6 +246,10 @@ Thrift servers define additional parameters:
 * *thriftFramed* -- if `true`, a framed thrift transport is used for incoming
   requests; otherwise, a buffered transport is used. Typically this setting
   matches the router's `thriftFramed` param. (default: true)
+* *thriftProtocol* -- allows the thrift protocol to be chosen;
+   currently supports 'binary' for `TBinaryProtocol` (default) and
+   'compact' for `TCompactProtocol`. Typically this setting matches
+   the router's client `thriftProtocol` param.
 
 The default server _port_ is 4114.
 
@@ -254,9 +258,13 @@ Thrift also supports additional *client* parameters:
 * *thriftFramed* -- if `true`, a framed thrift transport is used for outgoing
   requests; otherwise, a buffered transport is used. Typically this setting
   matches the router's servers' `thriftFramed` param. (default: true)
+* *thriftProtocol* -- allows the thrift protocol to be chosen;
+   currently supports `binary` for `TBinaryProtocol` (default) and
+   `compact` for `TCompactProtocol`. Typically this setting matches
+   the router's servers' `thriftProtocol` param.
 
 As an example: Here's a thrift router configuration that routes thrift--via
-buffered transport--from port 4004 to port 5005
+buffered transport using the TCompactProtocol --from port 4004 to port 5005
 
 ```yaml
 routers:
@@ -268,8 +276,10 @@ routers:
   - port: 4004
     ip: 0.0.0.0
     thriftFramed: false
+    thriftProtocol: compact
   client:
     thriftFramed: false
+    thriftProtocol: compact
 ```
 
 <a name="protocol-mux"></a>
diff --git a/linkerd/protocol/thrift/src/main/scala/io/buoyant/linkerd/protocol/ThriftInitializer.scala b/linkerd/protocol/thrift/src/main/scala/io/buoyant/linkerd/protocol/ThriftInitializer.scala
@@ -3,7 +3,9 @@ package protocol
 
 import com.twitter.finagle.Path
 import com.twitter.finagle.Thrift.param
+import com.twitter.finagle.thrift.Protocols
 import io.buoyant.router.{Thrift, RoutingFactory}
+import org.apache.thrift.protocol.TCompactProtocol
 
 class ThriftInitializer extends ProtocolInitializer {
   val name = "thrift"
@@ -28,7 +30,16 @@ class ThriftInitializer extends ProtocolInitializer {
     Thrift.param.MethodInDst(methodInDst)
   }
 
+  val Protocol = Parsing.Param.Text("thriftProtocol") { protocol =>
+    val factory = protocol match {
+      case "binary" => Protocols.binaryFactory()
+      case "compact" => new TCompactProtocol.Factory()
+      case _ => throw new IllegalArgumentException(s"unsupported thrift protocol $protocol")
+    }
+    param.ProtocolFactory(factory)
+  }
+
   override val routerParamsParser = MethodInDst
-  override val serverParamsParser = Framed
-  override val clientParamsParser = Framed
+  override val serverParamsParser = Framed.andThen(Protocol)
+  override val clientParamsParser = Framed.andThen(Protocol)
 }
