[ZOOKEEPER-1681] ZooKeeper 3.4.x can optionally use netty for nio but the pom does not declare the dep as optional

• Type: Improvement
• Status: Patch Available
• Priority: Major
• Resolution: Unresolved
• Affects Version/s: 3.4.0, 3.4.1, 3.4.2, 3.4.4, 3.4.5
• Assignee: Stevo Slavić
• Reporter: John Sirois
• Created: 02/Apr/13 13:05
• Updated: 15/Jun/23 21:09

Description

For example in 3.4.5 we see:

$ curl -sS http://search.maven.org/remotecontent?filepath=org/apache/zookeeper/zookeeper/3.4.5/zookeeper-3.4.5.pom | grep -B1 -A4 org.jboss.netty
    <dependency>
      <groupId>org.jboss.netty</groupId>
      <artifactId>netty</artifactId>
      <version>3.2.2.Final</version>
      <scope>compile</scope>
    </dependency>

As a consumer I can depend on zookeeper with an exclude for org.jboss.netty#netty or I can let my transitive dep resolver pick a winner. This might be fine, except for those who might be using a more modern netty published under the newish io.netty groupId. With this twist you get both org.jboss.netty#netty;foo and io.netty#netty;bar on your classpath and runtime errors ensue from incompatibilities. unless you add an exclude against zookeeper (and clearly don't enable the zk netty nio handling.)

I propose that this is a pom bug although this is debatable. Clearly as currently packaged zookeeper needs netty to compile, but I'd argue since it does not need netty to run, either the scope should be provided or optional or a zookeeper-netty lib should be broken out as an optional dependency and this new dep published by zookeeper can have a proper compile dependency on netty.

Issue Links

• is related to: ZOOKEEPER-1763 Upgrade the netty version
• is related to: ZOOKEEPER-1715 Upgrade netty version
• relates to: ZOOKEEPER-823 update ZooKeeper java client to optionally use Netty for connections