Merge pull request #277 from nats-io/2.6.6

2.6.6

Author: sasbury

CHANGELOG.md

@@ -1,6 +1,12 @@
 
 # Change Log
 
+## Version 2.6.6
+
+* [FIXED] - #274 - Added a check to prevent double event notification
+* [CHANGED] - #276 - Updated TLS certs to match go client
+* [FIXED] - #275 - Updated connect to randomize with the same code as reconnect
+
 ## Version 2.6.2, 2.6.3, 2.6.4 & 2.6.5
 
 * [FIXED] - problem with jars being built with jdk 11

README.md

@@ -52,9 +52,9 @@ The java-nats client is provided in a single jar file, with a single external de
 
 ### Downloading the Jar
 
-You can download the latest jar at [https://search.maven.org/remotecontent?filepath=io/nats/jnats/2.6.5/jnats-2.6.5.jar](https://search.maven.org/remotecontent?filepath=io/nats/jnats/2.6.5/jnats-2.6.5.jar).
+You can download the latest jar at [https://search.maven.org/remotecontent?filepath=io/nats/jnats/2.6.6/jnats-2.6.6.jar](https://search.maven.org/remotecontent?filepath=io/nats/jnats/2.6.6/jnats-2.6.6.jar).
 
-The examples are available at [https://search.maven.org/remotecontent?filepath=io/nats/jnats/2.6.5/jnats-2.6.5-examples.jar](https://search.maven.org/remotecontent?filepath=io/nats/jnats/2.6.5/jnats-2.6.5-examples.jar).
+The examples are available at [https://search.maven.org/remotecontent?filepath=io/nats/jnats/2.6.6/jnats-2.6.6-examples.jar](https://search.maven.org/remotecontent?filepath=io/nats/jnats/2.6.6/jnats-2.6.6-examples.jar).
 
 To use NKeys, you will need the ed25519 library, which can be downloaded at [https://repo1.maven.org/maven2/net/i2p/crypto/eddsa/0.3.0/eddsa-0.3.0.jar](https://repo1.maven.org/maven2/net/i2p/crypto/eddsa/0.3.0/eddsa-0.3.0.jar).
 
@@ -64,7 +64,7 @@ The NATS client is available in the Maven central repository, and can be importe
 
 ```groovy
 dependencies {
-    implementation 'io.nats:jnats:2.6.5'
+    implementation 'io.nats:jnats:2.6.6'
 }
 ```
 
@@ -90,7 +90,7 @@ The NATS client is available on the Maven central repository, and can be importe
 <dependency>
     <groupId>io.nats</groupId>
     <artifactId>jnats</artifactId>
-    <version>2.6.5</version>
+    <version>2.6.6</version>
 </dependency>
 ```
 
@@ -226,15 +226,15 @@ NATS supports TLS 1.2. The server can be configured to verify client certificate
 1. The Java library allows the use of the tls:// protocol in its urls. This setting expects a default SSLContext to be set. You can set this default context using System properties, or in code. For example, you could run the publish example using:
 
     ```bash
-    java -Djavax.net.ssl.keyStore=src/test/resources/keystore.jks -Djavax.net.ssl.keyStorePassword=password -Djavax.net.ssl.trustStore=src/test/resources/cacerts -Djavax.net.ssl.trustStorePassword=password io.nats.examples.NatsPub tls://localhost:4443 test "hello world"
+    java -Djavax.net.ssl.keyStore=src/test/resources/keystore.jks -Djavax.net.ssl.keyStorePassword=password -Djavax.net.ssl.trustStore=src/test/resources/truststore.jks -Djavax.net.ssl.trustStorePassword=password io.nats.examples.NatsPub tls://localhost:4443 test "hello world"
     ```
 
     where the following properties are being set:
 
     ```bash
     -Djavax.net.ssl.keyStore=src/test/resources/keystore.jks
     -Djavax.net.ssl.keyStorePassword=password
-    -Djavax.net.ssl.trustStore=src/test/resources/cacerts
+    -Djavax.net.ssl.trustStore=src/test/resources/truststore.jks
     -Djavax.net.ssl.trustStorePassword=password
     ```
 
@@ -401,6 +401,20 @@ which will create a folder called `build/reports/jacoco` containing the file `in
 
 Many of the tests run nats-server on a custom port. If nats-server is in your path they should just work, but in cases where it is not, or an IDE running tests has issues with the path you can specify the nats-server location with the environment variable `nats_-_server_path`.
 
+## TLS Certs
+
+The raw TLS test certs are in [src/test/resources/certs](src/test/resources/certs) and come from the [nats.go](https://github.com/nats-io/nats.go) repository. However, the java client also needs a keystore and truststore.jks files for creating a context. These can be created using:
+
+```bash
+> cd src/test/resources
+> keytool -keystore truststore.jks -alias CARoot -import -file certs/ca.pem -storepass password -noprompt -storetype pkcs12
+> cat certs/client-key.pem certs/client-cert.pem > combined.pem
+> openssl pkcs12 -export -in combined.pem -out cert.p12
+> keytool -importkeystore -srckeystore cert.p12 -srcstoretype pkcs12 -deststoretype pkcs12 -destkeystore keystore.jks
+> keytool -keystore keystore.jks -alias CARoot -import -file certs/ca.pem -storepass password -noprompt
+> rm cert.p12 combined.pem
+```
+
 ## License
 
 Unless otherwise noted, the NATS source files are distributed

build.gradle

@@ -16,9 +16,9 @@ plugins {
 // Be sure to update Nats.java with the latest version, the change log and the package-info.java
 def versionMajor = 2
 def versionMinor = 6
-def versionPatch = 5
+def versionPatch = 6
 def versionModifier = ""
-def jarVersion = "2.6.5"
+def jarVersion = "2.6.6"
 def branch = System.getenv("TRAVIS_BRANCH");
 def tag = System.getenv("TRAVIS_TAG");
 def useSigning = "master".equals(branch) || (!"".equals(tag) && tag.equals(branch)) // tag will be the branch on a tag event for travis

src/examples/java/io/nats/examples/autobench/NatsAutoBench.java

@@ -94,7 +94,7 @@ public static void main(String args[]) {
              * jar plus the flag. For example, to run after building locally and using the test cert files:
              * java -cp ./build/libs/jnats-2.5.1-SNAPSHOT-examples.jar:./build/libs/jnats-2.5.1-SNAPSHOT-fat.jar:<path to conscrypt.jar> \
              * -Djavax.net.ssl.keyStore=src/test/resources/keystore.jks -Djavax.net.ssl.keyStorePassword=password \
-             * -Djavax.net.ssl.trustStore=src/test/resources/cacerts -Djavax.net.ssl.trustStorePassword=password \
+             * -Djavax.net.ssl.trustStore=src/test/resources/truststore.jks -Djavax.net.ssl.trustStorePassword=password \
              * io.nats.examples.autobench.NatsAutoBench tls://localhost:4443 med conscrypt
              */
             if (conscrypt) {

src/examples/java/io/nats/examples/benchmark/NatsBench.java

@@ -135,7 +135,7 @@ public void slowConsumerDetected(Connection conn, Consumer consumer) {
          * ./build/libs/jnats-2.5.1-SNAPSHOT-examples.jar:./build/libs/jnats-2.5.1-SNAPSHOT-fat.jar:<path
          * to conscrypt.jar> \ -Djavax.net.ssl.keyStore=src/test/resources/keystore.jks
          * -Djavax.net.ssl.keyStorePassword=password \
-         * -Djavax.net.ssl.trustStore=src/test/resources/cacerts
+         * -Djavax.net.ssl.trustStore=src/test/resources/truststore.jks
          * -Djavax.net.ssl.trustStorePassword=password \
          * io.nats.examples.autobench.NatsAutoBench tls://localhost:4443 med conscrypt
          */

src/examples/java/io/nats/examples/examples.md

@@ -30,7 +30,7 @@ To see how queues split messages, run the `NatsQSub` in multiple windows and the
 A set of sample certificates are provided in the repo for testing. These use the highly secure password `password`. To run with the full client and trust default keystore you can use command line arguments to set System properties.
 
 ```bash
-java -Djavax.net.ssl.keyStore=src/test/resources/keystore.jks -Djavax.net.ssl.keyStorePassword=password -Djavax.net.ssl.trustStore=src/test/resources/cacerts -Djavax.net.ssl.trustStorePassword=password io.nats.examples.NatsPub tls://localhost:4443 test "hello world"
+java -Djavax.net.ssl.keyStore=src/test/resources/keystore.jks -Djavax.net.ssl.keyStorePassword=password -Djavax.net.ssl.trustStore=src/test/resources/truststore.jks -Djavax.net.ssl.trustStorePassword=password io.nats.examples.NatsPub tls://localhost:4443 test "hello world"
 ```
 
 To run with the completely unverified client:

src/main/java/io/nats/client/Nats.java

@@ -72,7 +72,7 @@ public class Nats {
     /**
      * Current version of the library - {@value #CLIENT_VERSION}
      */
-    public static final String CLIENT_VERSION = "2.6.5";
+    public static final String CLIENT_VERSION = "2.6.6";
 
     /**
      * Current language of the library - {@value #CLIENT_LANGUAGE}

src/main/java/io/nats/client/impl/NatsConnection.java

@@ -192,7 +192,8 @@ void connect(boolean reconnectOnConnect) throws InterruptedException, IOExceptio
 
         timeTrace(trace, "starting connect loop");
 
-        for (String serverURI : getServers()) {
+        Collection<String> serversToTry = buildServerList();
+        for (String serverURI : serversToTry) {
             if (isClosed()) {
                 break;
             }
@@ -262,7 +263,7 @@ void reconnect() throws InterruptedException {
         boolean doubleAuthError = false;
 
         while (!isConnected() && !isClosed() && !this.isClosing()) {
-            Collection<String> serversToTry = buildReconnectList();
+            Collection<String> serversToTry = buildServerList();
 
             for (String server : serversToTry) {
                 if (isClosed()) {
@@ -1509,7 +1510,7 @@ void updateStatus(Status newStatus) {
 
         statusLock.lock();
         try {
-            if (oldStatus == Status.CLOSED) {
+            if (oldStatus == Status.CLOSED || newStatus == oldStatus) {
                 return;
             }
             this.status = newStatus;
@@ -1623,7 +1624,7 @@ void waitForReconnectTimeout() {
         this.reconnectWaiter.complete(Boolean.TRUE);
     }
 
-    Collection<String> buildReconnectList() {
+    Collection<String> buildServerList() {
         ArrayList<String> reconnectList = new ArrayList<>();
 
         reconnectList.addAll(getServers());

src/test/java/io/nats/client/AuthTests.java

@@ -217,7 +217,7 @@ public void testUserPassInURLWithFallback() throws Exception {
                 NatsTestServer ts2 = new NatsTestServer(customArgs2, false)) {
             // See config file for user/pass
             Options options = new Options.Builder().server("nats://stephen:password@localhost:" + ts1.getPort())
-                    .server("nats://localhost:" + ts2.getPort())
+                    .server("nats://localhost:" + ts2.getPort()).noRandomize()
                     .userInfo("alberto".toCharArray(), "casadecampo".toCharArray()).maxReconnects(4).noRandomize()
                     .connectionListener(handler).pingInterval(Duration.ofMillis(100)).build();
             Connection nc = Nats.connect(options);
@@ -556,7 +556,7 @@ public void testReconnectWithAuth() throws Exception {
         try (NatsTestServer ts = new NatsTestServer("src/test/resources/operator.conf", false);
                 NatsTestServer ts2 = new NatsTestServer("src/test/resources/operator.conf", false)) {
             Options options = new Options.Builder().servers(new String[] { ts.getURI(), ts2.getURI() })
-                    .maxReconnects(-1).authHandler(Nats.credentials("src/test/resources/jwt_nkey/user.creds")).build();
+                    .noRandomize().maxReconnects(-1).authHandler(Nats.credentials("src/test/resources/jwt_nkey/user.creds")).build();
             Connection nc = Nats.connect(options);
             try {
                 assertTrue("Connected Status", Connection.Status.CONNECTED == nc.getStatus());
@@ -591,7 +591,7 @@ public void testCloseOnReconnectWithSameError() throws Exception {
         try (NatsTestServer ts = new NatsTestServer("src/test/resources/operator_noacct.conf", false);
                 NatsTestServer ts2 = new NatsTestServer("src/test/resources/operator.conf", false)) {
             Options options = new Options.Builder().servers(new String[] { ts.getURI(), ts2.getURI() })
-                    .maxReconnects(-1).connectionTimeout(Duration.ofSeconds(2))
+                    .maxReconnects(-1).connectionTimeout(Duration.ofSeconds(2)).noRandomize()
                     .authHandler(Nats.credentials("src/test/resources/jwt_nkey/user.creds")).build();
             Connection nc = Nats.connect(options);
             try {
@@ -625,7 +625,7 @@ public void testThatAuthErrorIsCleared() throws Exception {
         // Connect should fail on ts1
         try (NatsTestServer ts = new NatsTestServer("src/test/resources/operator_noacct.conf", false);
                 NatsTestServer ts2 = new NatsTestServer("src/test/resources/operator.conf", false)) {
-            Options options = new Options.Builder().servers(new String[] { ts.getURI(), ts2.getURI() })
+            Options options = new Options.Builder().servers(new String[] { ts.getURI(), ts2.getURI() }).noRandomize()
                     .maxReconnects(-1).connectionTimeout(Duration.ofSeconds(5)).reconnectWait(Duration.ofSeconds(1)) // wait a tad to allow restarts
                     .authHandler(Nats.credentials("src/test/resources/jwt_nkey/user.creds")).build();
             Connection nc = Nats.connect(options);
@@ -696,6 +696,7 @@ public void testReconnectAfterExpiration() throws Exception {
             Options options = new Options.Builder().
                         servers(new String[] {ts.getURI(), ts2.getURI()}).
                         maxReconnects(-1).
+                        noRandomize().
                         authHandler(Nats.credentials("src/test/resources/jwt_nkey/user.creds")).
                         build();
             Connection nc = Nats.connect(options);

src/test/java/io/nats/client/ConnectTests.java

@@ -204,6 +204,68 @@ public void testConnectWithCommas() throws IOException, InterruptedException {
         }
     }
 
+    @Test
+    public void testConnectRandomize() throws IOException, InterruptedException {
+        try (NatsTestServer ts1 = new NatsTestServer(false)) {
+            try (NatsTestServer ts2 = new NatsTestServer(false)) {
+                int one = 0;
+                int two = 0;
+
+                // should get at least 1 for each
+                for (int i=0; i < 10; i++) {
+                    Connection nc = Nats.connect(ts1.getURI() + "," + ts2.getURI());
+                    try {
+                        assertTrue("Connected Status", Connection.Status.CONNECTED == nc.getStatus());
+
+                        if (nc.getConnectedUrl().equals(ts1.getURI())) {
+                            one++;
+                        } else {
+                            two++;
+                        }
+                    } finally {
+                        nc.close();
+                        assertTrue("Closed Status", Connection.Status.CLOSED == nc.getStatus());
+                    }
+                }
+
+                assertTrue("randomly got one", one > 0);
+                assertTrue("randomly got two", two > 0);
+            }
+        }
+    }
+
+    @Test
+    public void testConnectNoRandomize() throws IOException, InterruptedException {
+        try (NatsTestServer ts1 = new NatsTestServer(false)) {
+            try (NatsTestServer ts2 = new NatsTestServer(false)) {
+                int one = 0;
+                int two = 0;
+
+                // should get at least 1 for each
+                for (int i=0; i < 10; i++) {
+                    String[] servers = {ts1.getURI(), ts2.getURI()};
+                    Options options = new Options.Builder().noRandomize().servers(servers).build();
+                    Connection nc = Nats.connect(options);
+                    try {
+                        assertTrue("Connected Status", Connection.Status.CONNECTED == nc.getStatus());
+
+                        if (nc.getConnectedUrl().equals(ts1.getURI())) {
+                            one++;
+                        } else {
+                            two++;
+                        }
+                    } finally {
+                        nc.close();
+                        assertTrue("Closed Status", Connection.Status.CLOSED == nc.getStatus());
+                    }
+                }
+
+                assertTrue("always got one", one == 10);
+                assertTrue("never got two", two == 0);
+            }
+        }
+    }
+
     @Test(expected=IOException.class)
     public void testFailWithMissingLineFeedAfterInfo() throws IOException, InterruptedException {
         Connection nc = null;