100% open-source IoT Platform - Integrate your devices, add intelligence, build custom apps
Java asset-managementbuildingdashboarddataplatformdevice-managementedge-computingenergyenergy-managementenergy-monitorfleet-managementfleet-telematicsiotiot-applicationiot-platformmodbusmqttmqtt-brokerota-updaterules-enginesmartcity
IOClient robustness improvements (#1373)
Rich Turnerd167f28402de
diff --git a/.github/workflows/ci_cd.yml b/.github/workflows/ci_cd.ymlindex 5544fbb2a..a7913ccc0 100644--- a/.github/workflows/ci_cd.yml+++ b/.github/workflows/ci_cd.yml@@ -641,7 +641,7 @@ jobs:fi# Pull the images- docker-compose -f $composeProfile pull+ docker compose -f $composeProfile pullenv:IS_CUSTOM_PROJECT: ${{ steps.check_custom_project.outputs.files_exists }}TEST_UI_COMMAND: ${{ steps.test-ui-command.outputs.value }}@@ -667,11 +667,11 @@ jobs:chmod 777 tmp# Define cleanup command- echo "cleanup=docker-compose -f $composeProfile down" >> $GITHUB_OUTPUT+ echo "cleanup=docker compose -f $composeProfile down" >> $GITHUB_OUTPUT# Start the stack- echo "docker-compose -f ${composeProfile} up -d --no-build"- docker-compose -f ${composeProfile} up -d --no-build+ echo "docker compose -f ${composeProfile} up -d --no-build"+ docker compose -f ${composeProfile} up -d --no-build# Run the tests${{ steps.test-backend-command.outputs.value }}@@ -749,7 +749,7 @@ jobs:fi# Start the stack- MANAGER_VERSION=$MANAGER_TAG docker-compose -f $composeProfile up -d --no-build+ MANAGER_VERSION=$MANAGER_TAG docker compose -f $composeProfile up -d --no-build# Run the tests${{ steps.test-ui-command.outputs.value }}diff --git a/README.md b/README.mdindex 919f988a7..aebf4ad56 100644--- a/README.md+++ b/README.md@@ -24,8 +24,8 @@ The quickest way to get your own environment with full access is to make use of[OpenRemote Stack](https://raw.githubusercontent.com/openremote/openremote/master/docker-compose.yml) (Right click 'Save link as...')3. In a terminal `cd` to where you just saved the compose file and then run:```- docker-compose pull- docker-compose -p openremote up+ docker compose pull+ docker compose -p openremote up```If all goes well then you should now be able to access the OpenRemote Manager UI at [https://localhost](https://localhost). You will need to accept the self-signedcertificate, see [here](https://www.technipages.com/google-chrome-bypass-your-connection-is-not-private-message) for details how to do this in Chrome (similar for other browsers).@@ -40,13 +40,13 @@ The URL you use to access the system is important, the default is configured asBASH:```-OR_HOSTNAME=192.168.1.1 OR_SSL_PORT=8443 docker-compose -p openremote up -d+OR_HOSTNAME=192.168.1.1 OR_SSL_PORT=8443 docker compose -p openremote up -d```orCMD:```-cmd /C "set OR_HOSTNAME=192.168.1.1 && set OR_SSL_PORT=8443 && docker-compose -p openremote up -d"+cmd /C "set OR_HOSTNAME=192.168.1.1 && set OR_SSL_PORT=8443 && docker compose -p openremote up -d"```## What nextdiff --git a/agent/src/main/java/org/openremote/agent/protocol/io/AbstractNettyIOClient.java b/agent/src/main/java/org/openremote/agent/protocol/io/AbstractNettyIOClient.javaindex a55089e4f..c6543680e 100644--- a/agent/src/main/java/org/openremote/agent/protocol/io/AbstractNettyIOClient.java+++ b/agent/src/main/java/org/openremote/agent/protocol/io/AbstractNettyIOClient.java@@ -24,20 +24,21 @@ import dev.failsafe.RetryPolicy;import io.netty.bootstrap.Bootstrap;import io.netty.buffer.ByteBuf;import io.netty.channel.*;+import io.netty.handler.codec.DecoderException;+import io.netty.handler.codec.EncoderException;+import jakarta.validation.constraints.NotNull;import org.openremote.agent.protocol.udp.UDPIOClient;import org.openremote.agent.protocol.websocket.WebsocketIOClient;import org.openremote.container.Container;import org.openremote.model.asset.agent.ConnectionStatus;import org.openremote.model.syslog.SyslogCategory;-import jakarta.validation.constraints.NotNull;import java.net.SocketAddress;import java.time.Duration;import java.util.ArrayList;import java.util.Arrays;import java.util.List;import java.util.concurrent.*;-import java.util.concurrent.atomic.AtomicReference;import java.util.function.BiConsumer;import java.util.function.Consumer;import java.util.function.Supplier;@@ -105,12 +106,6 @@ public abstract class AbstractNettyIOClient<T, U extends SocketAddress> implemenmessages.clear();}}-- @Override- public void exceptionCaught(ChannelHandlerContext ctx, Throwable cause) throws Exception {- super.exceptionCaught(ctx, cause);- client.onDecodeException(ctx, cause);- }}/**@@ -125,15 +120,9 @@ public abstract class AbstractNettyIOClient<T, U extends SocketAddress> implemen}@Override- public void channelRead0(ChannelHandlerContext ctx, T msg) throws Exception {+ public void channelRead0(ChannelHandlerContext ctx, T msg) {client.onMessageReceived(msg);}-- @Override- public void exceptionCaught(ChannelHandlerContext ctx, Throwable cause) throws Exception {- super.exceptionCaught(ctx, cause);- client.onDecodeException(ctx, cause);- }}/**@@ -153,17 +142,10 @@ public abstract class AbstractNettyIOClient<T, U extends SocketAddress> implemenprotected void encode(ChannelHandlerContext ctx, T msg, ByteBuf out) {encoder.accept(msg, out);}-- @SuppressWarnings("deprecation")- @Override- public void exceptionCaught(ChannelHandlerContext ctx, Throwable cause) throws Exception {- super.exceptionCaught(ctx, cause);- client.onEncodeException(ctx, cause);- }}private static final Logger LOG = SyslogCategory.getLogger(PROTOCOL, AbstractNettyIOClient.class);- protected final List<Consumer<T>> messageConsumers = new ArrayList<>();+ protected final List<Consumer<T>> messageConsumers = new CopyOnWriteArrayList<>();protected final List<Consumer<ConnectionStatus>> connectionStatusConsumers = new CopyOnWriteArrayList<>();protected ConnectionStatus connectionStatus = ConnectionStatus.DISCONNECTED;protected Channel channel;@@ -195,21 +177,41 @@ public abstract class AbstractNettyIOClient<T, U extends SocketAddress> implemenprotected abstract EventLoopGroup getWorkerGroup();- protected abstract ChannelFuture startChannel();+ /**+ * Start the actual connection and return a future indicating completion state. Implementors can also+ * add any custom connection logic they require.+ */+ protected abstract Future<Void> startChannel();protected void configureChannel() {bootstrap.option(ChannelOption.CONNECT_TIMEOUT_MILLIS, getConnectTimeoutMillis());}@Override- public synchronized void connect() {- if (connectionStatus != ConnectionStatus.DISCONNECTED) {- LOG.finest("Must be disconnected before calling connect: " + getClientUri());- return;+ public void connect() {+ synchronized (this) {+ if (connectionStatus != ConnectionStatus.DISCONNECTED) {+ LOG.finest("Must be disconnected before calling connect: " + getClientUri());+ return;+ }++ LOG.fine("Connecting IO Client: " + getClientUri());+ onConnectionStatusChanged(ConnectionStatus.CONNECTING);}- LOG.fine("Connecting IO Client: " + getClientUri());- onConnectionStatusChanged(ConnectionStatus.CONNECTING);+ // TODO: In Netty 5 you can pass in an executor service; can only pass in thread factory for now+ workerGroup = getWorkerGroup();+ bootstrap = new Bootstrap();+ bootstrap.channel(getChannelClass());+ configureChannel();+ bootstrap.group(workerGroup);++ bootstrap.handler(new ChannelInitializer<>() {+ @Override+ public void initChannel(Channel channel) throws Exception {+ AbstractNettyIOClient.this.initChannel(channel);+ }+ });scheduleDoConnect(100);}@@ -221,153 +223,92 @@ public abstract class AbstractNettyIOClient<T, U extends SocketAddress> implemenRetryPolicy<Object> retryPolicy = RetryPolicy.builder().withJitter(Duration.ofMillis(delay)).withBackoff(Duration.ofMillis(delay), Duration.ofMillis(maxDelay))- .handle(ExecutionException.class)+ .handle(Exception.class).onRetryScheduled((execution) ->LOG.info("Re-connection scheduled in '" + execution.getDelay() + "' for: " + getClientUri()))- .onFailedAttempt((execution) ->- LOG.info("Connection attempt failed '" + execution.getAttemptCount() + "' for: " + getClientUri()))+ .onFailedAttempt((execution) -> {+ LOG.info("Connection attempt failed '" + execution.getAttemptCount() + "' for: " + getClientUri());+ doDisconnect();+ }).withMaxRetries(Integer.MAX_VALUE).build();- AtomicReference<Future<Void>> connectFutureRef = new AtomicReference<>();connectRetry = Failsafe.with(retryPolicy).with(executorService).runAsyncExecution((execution) -> {LOG.fine("Connection attempt '" + (execution.getAttemptCount()+1) + "' for: " + getClientUri());- connectFutureRef.set(doConnect());- connectFutureRef.get().get();-- // Add closed callback- channel.closeFuture().addListener(closedFuture -> {- synchronized (this) {- if (connectionStatus == ConnectionStatus.CONNECTED) {- LOG.info("Connection closed un-expectedly: " + getClientUri());- onConnectionStatusChanged(ConnectionStatus.CONNECTING);- doDisconnect();- scheduleDoConnect(5000);- }- }- });-+ // Connection future should timeout so we just wait for it but add additional timeout just in case+ Future<Void> connectFuture = doConnect();+ waitForConnectFuture(connectFuture);execution.recordResult(null);}).whenComplete((result, ex) -> {- if (ex instanceof InterruptedException) {- connectFutureRef.get().cancel(true);- }if (ex != null) {- LOG.log(Level.INFO, "Connection attempt failed: " + getClientUri(), ex);// Cleanup resources- doDisconnect();+ disconnect();} else {synchronized (this) {if (connectionStatus == ConnectionStatus.CONNECTING) {+ LOG.fine("Connection attempt success: " + getClientUri());onConnectionStatusChanged(ConnectionStatus.CONNECTED);- } else {- doDisconnect();}}}});}- protected Future<Void> doConnect() {+ protected Void waitForConnectFuture(Future<Void> connectFuture) throws Exception {+ return connectFuture.get(getConnectTimeoutMillis()+1000L, TimeUnit.MILLISECONDS);+ }+ protected Future<Void> doConnect() {LOG.info("Establishing connection: " + getClientUri());-- if (workerGroup == null) {- // TODO: In Netty 5 you can pass in an executor service; can only pass in thread factory for now- workerGroup = getWorkerGroup();- }-- bootstrap = new Bootstrap();- bootstrap.channel(getChannelClass());- configureChannel();- bootstrap.group(workerGroup);-- bootstrap.handler(new ChannelInitializer<Channel>() {- @Override- public void initChannel(Channel channel) throws Exception {- AbstractNettyIOClient.this.initChannel(channel);- }- });-- // Start and store the channel- ChannelFuture channelStartFuture = startChannel();- channel = channelStartFuture.channel();-- return createConnectedFuture(channelStartFuture)- .whenComplete((result, ex) -> {- if (ex instanceof InterruptedException) {- // Cancel the connection- channelStartFuture.cancel(true);- }- if (ex != null) {- // Cleanup resources- doDisconnect();- }- });+ // Start the channel+ return startChannel();}- /**- * A wrapper to provide a java concurrent future; can be overridden in subclasses to add additional connection logic- * on top of simply establishing the channel.- */- protected CompletableFuture<Void> createConnectedFuture(final ChannelFuture channelStartFuture) {- CompletableFuture<Void> connectedFuture = new CompletableFuture<>();- channelStartFuture.addListener(future -> {- if (future.isCancelled()) {+ @Override+ public void disconnect() {+ synchronized (this) {+ if (connectionStatus == ConnectionStatus.DISCONNECTED || connectionStatus == ConnectionStatus.DISCONNECTING) {+ LOG.finest("Already disconnected or disconnecting: " + getClientUri());return;}- if (future.cause() != null) {- connectedFuture.completeExceptionally(future.cause());- } else if (!future.isSuccess()) {- connectedFuture.completeExceptionally(new RuntimeException("Unknown connection failure occurred"));- } else {- connectedFuture.complete(null);- }- });- return connectedFuture;- }- @Override- public synchronized void disconnect() {- if (connectionStatus == ConnectionStatus.DISCONNECTED || connectionStatus == ConnectionStatus.DISCONNECTING) {- LOG.finest("Already disconnected or disconnecting: " + getClientUri());- return;+ LOG.fine("Disconnecting IO client: " + getClientUri());+ onConnectionStatusChanged(ConnectionStatus.DISCONNECTING);}- LOG.fine("Disconnecting IO client: " + getClientUri());- onConnectionStatusChanged(ConnectionStatus.DISCONNECTING);-if (connectRetry != null) {connectRetry.cancel(true);- try {- connectRetry.get();- } catch (CancellationException | InterruptedException | ExecutionException ignored) {- } catch (Exception e) {- LOG.log(Level.FINE, "Failed to wait for connection retry future: " + getClientUri());- }connectRetry = null;}doDisconnect();+ if (workerGroup != null) {+ workerGroup.shutdownGracefully();+ workerGroup = null;+ }onConnectionStatusChanged(ConnectionStatus.DISCONNECTED);}+ protected void doReconnect() {+ doDisconnect();+ scheduleDoConnect(5000);+ }+protected void doDisconnect() {LOG.finest("Performing disconnect: " + getClientUri());try {// Close the channelif (channel != null) {- channel.disconnect();- channel.close();+ try {+ channel.disconnect().await();+ } catch (Exception ignored) {}+ try {+ channel.close().await();+ } catch (Exception ignored) {}channel = null;}} catch (Exception e) {LOG.log(Level.WARNING, "Failed to disconnect gracefully: " + getClientUri(), e);- } finally {- if (workerGroup != null) {- workerGroup.shutdownGracefully();- workerGroup = null;- }}LOG.finest("Disconnect done: " + getClientUri());}@@ -411,36 +352,75 @@ public abstract class AbstractNettyIOClient<T, U extends SocketAddress> implemen@Overridepublic void addMessageConsumer(Consumer<T> messageConsumer) {- synchronized (messageConsumers) {- if (!messageConsumers.contains(messageConsumer)) {- messageConsumers.add(messageConsumer);- }+ if (!messageConsumers.contains(messageConsumer)) {+ messageConsumers.add(messageConsumer);}}@Overridepublic void removeMessageConsumer(Consumer<T> messageConsumer) {- synchronized (messageConsumers) {- messageConsumers.remove(messageConsumer);- }+ messageConsumers.remove(messageConsumer);}@Overridepublic void removeAllMessageConsumers() {- synchronized (messageConsumers) {- messageConsumers.clear();- }+ messageConsumers.clear();}/**- * Inserts the decoders and encoders into the channel pipeline+ * Inserts the decoders and encoders into the channel pipeline and configures standard exception handling and logging*/protected void initChannel(Channel channel) throws Exception {- // Below is un-necessary as channel listener handles this+ this.channel = channel;addEncodersDecoders(channel);++ // Add closed callback for logging and reconnect+ channel.closeFuture().addListener(closedFuture -> {+ boolean reconnect = false;++ if (!closedFuture.isSuccess() && closedFuture.cause() != null) {+ LOG.info("Connection closed with exception on '" + getClientUri() + "': " + closedFuture.cause().getMessage());+ }++ synchronized (this) {+ if (connectionStatus == ConnectionStatus.CONNECTED) {+ onConnectionStatusChanged(ConnectionStatus.CONNECTING);+ reconnect = true;+ }+ }++ if (reconnect) {+ doReconnect();+ }+ });++ // Add inbound exception handler at end of inbound chain+ channel.pipeline().addLast(new ChannelInboundHandlerAdapter() {+ @Override+ public void exceptionCaught(ChannelHandlerContext ctx, Throwable cause) throws Exception {+ if (cause instanceof DecoderException decoderException) {+ onDecodeException(ctx, decoderException);+ } else if (cause instanceof EncoderException encoderException) {+ onEncodeException(ctx, encoderException);+ } else {+ // Agressively force close the channel on other exceptions which will cause a reconnect+ ctx.close();+ }+ }+ });++ // Add promise listener at start of outbound chain (this is how to handle outbound exceptions)+ channel.pipeline().addLast(new ChannelOutboundHandlerAdapter() {+ @Override+ public void write(ChannelHandlerContext ctx, Object msg, ChannelPromise promise) throws Exception {+ // Fire any failure through the channel pipeline the same as inbound exceptions+ promise.addListener(ChannelFutureListener.FIRE_EXCEPTION_ON_FAILURE);+ super.write(ctx, msg, promise);+ }+ });}- protected void addEncodersDecoders(Channel channel) {+ protected void addEncodersDecoders(Channel channel) throws Exception {if (encoderDecoderProvider != null) {ChannelHandler[] handlers = encoderDecoderProvider.get();if (handlers != null) {@@ -457,17 +437,17 @@ public abstract class AbstractNettyIOClient<T, U extends SocketAddress> implementry {consumer.accept(message);} catch (Exception e) {- LOG.log(Level.WARNING, "Exception occurred in message handler: " + getClientUri(), e);+ LOG.log(Level.WARNING, "Exception occurred in message handler '" + e.getMessage() + "':" + getClientUri());}});}- protected void onDecodeException(ChannelHandlerContext ctx, Throwable cause) {- LOG.log(Level.FINE, "Exception occurred on in-bound message '" + cause.getMessage() +"': " + getClientUri());+ protected void onDecodeException(ChannelHandlerContext ctx, DecoderException decoderException) {+ LOG.log(Level.FINE, "Decoder exception occurred on in-bound message '" + decoderException.getMessage() +"': " + getClientUri(), decoderException);}- protected void onEncodeException(ChannelHandlerContext ctx, Throwable cause) {- LOG.log(Level.FINE, "Exception occurred on out-bound message '" + cause.getMessage() +"': " + getClientUri());+ protected void onEncodeException(ChannelHandlerContext ctx, EncoderException encoderException) {+ LOG.log(Level.FINE, "Encoder exception occurred on out-bound message '" + encoderException.getMessage() +"': " + getClientUri(), encoderException);}protected void onConnectionStatusChanged(ConnectionStatus connectionStatus) {@@ -492,4 +472,30 @@ public abstract class AbstractNettyIOClient<T, U extends SocketAddress> implemenpublic String toString() {return getClientUri();}++ // Not ideal but need to chain futures+ // TODO: Replace once netty uses completable futures+ public static CompletableFuture<Void> toCompletableFuture(Future<Void> future) throws UnsupportedOperationException {+ if (future instanceof CompletableFuture<Void> completableFuture) {+ return completableFuture;+ }+ if (future instanceof ChannelFuture channelFuture) {+ CompletableFuture<Void> completableFuture = new CompletableFuture<>();+ channelFuture.addListener(cf -> {+ if (cf.isCancelled()) {+ completableFuture.cancel(true);+ return;+ }+ if (cf.cause() != null) {+ completableFuture.completeExceptionally(cf.cause());+ } else if (!cf.isSuccess()) {+ completableFuture.completeExceptionally(new RuntimeException("Unknown connection failure occurred"));+ } else {+ completableFuture.complete(null);+ }+ });+ return completableFuture;+ }+ throw new UnsupportedOperationException("Future must be a ChannelFuture or already a CompletableFuture");+ }}diff --git a/agent/src/main/java/org/openremote/agent/protocol/serial/SerialIOClient.java b/agent/src/main/java/org/openremote/agent/protocol/serial/SerialIOClient.javaindex 5b1eaabc5..53ba30272 100644--- a/agent/src/main/java/org/openremote/agent/protocol/serial/SerialIOClient.java+++ b/agent/src/main/java/org/openremote/agent/protocol/serial/SerialIOClient.java@@ -20,12 +20,13 @@package org.openremote.agent.protocol.serial;import io.netty.channel.Channel;-import io.netty.channel.ChannelFuture;import org.openremote.agent.protocol.io.AbstractNettyIOClient;import org.openremote.agent.protocol.io.IOClient;import org.openremote.model.util.TextUtil;+import java.util.concurrent.Future;+import static org.openremote.agent.protocol.serial.JSerialCommChannelConfig.Paritybit.NONE;import static org.openremote.agent.protocol.serial.JSerialCommChannelConfig.Stopbits.STOPBITS_1;import static org.openremote.agent.protocol.serial.JSerialCommChannelOption.*;@@ -57,7 +58,7 @@ public class SerialIOClient<T> extends AbstractNettyIOClient<T, JSerialCommDevic}@Override- protected ChannelFuture startChannel() {+ protected Future<Void> startChannel() {return bootstrap.connect(new JSerialCommDeviceAddress(port));}diff --git a/agent/src/main/java/org/openremote/agent/protocol/tcp/TCPIOClient.java b/agent/src/main/java/org/openremote/agent/protocol/tcp/TCPIOClient.javaindex a756db20e..2f84e6c06 100644--- a/agent/src/main/java/org/openremote/agent/protocol/tcp/TCPIOClient.java+++ b/agent/src/main/java/org/openremote/agent/protocol/tcp/TCPIOClient.java@@ -27,6 +27,7 @@ import org.openremote.agent.protocol.io.IOClient;import org.openremote.model.util.TextUtil;import java.net.InetSocketAddress;+import java.util.concurrent.Future;/*** This is a {@link IOClient} implementation for TCP.@@ -64,7 +65,7 @@ public class TCPIOClient<T> extends AbstractNettyIOClient<T, InetSocketAddress>}@Override- protected ChannelFuture startChannel() {+ protected Future<Void> startChannel() {return bootstrap.connect(new InetSocketAddress(host, port));}diff --git a/agent/src/main/java/org/openremote/agent/protocol/udp/UDPIOClient.java b/agent/src/main/java/org/openremote/agent/protocol/udp/UDPIOClient.javaindex 5ccc0bd45..0d9947b66 100644--- a/agent/src/main/java/org/openremote/agent/protocol/udp/UDPIOClient.java+++ b/agent/src/main/java/org/openremote/agent/protocol/udp/UDPIOClient.java@@ -31,6 +31,7 @@ import org.openremote.model.syslog.SyslogCategory;import java.net.InetSocketAddress;import java.util.List;+import java.util.concurrent.Future;import java.util.logging.Logger;import static org.openremote.model.syslog.SyslogCategory.PROTOCOL;@@ -70,7 +71,7 @@ public class UDPIOClient<T> extends AbstractNettyIOClient<T, InetSocketAddress>}@Override- protected void addEncodersDecoders(Channel channel) {+ protected void addEncodersDecoders(Channel channel) throws Exception {channel.pipeline().addLast(new MessageToMessageEncoder<ByteBuf>() {@Overrideprotected void encode(ChannelHandlerContext ctx, ByteBuf msg, List<Object> out) throws Exception {@@ -89,7 +90,7 @@ public class UDPIOClient<T> extends AbstractNettyIOClient<T, InetSocketAddress>}@Override- protected ChannelFuture startChannel() {+ protected Future<Void> startChannel() {return bootstrap.bind("0.0.0.0", bindPort);}diff --git a/agent/src/main/java/org/openremote/agent/protocol/websocket/WebsocketAgentProtocol.java b/agent/src/main/java/org/openremote/agent/protocol/websocket/WebsocketAgentProtocol.javaindex dcd9f6e73..97bf418c6 100644--- a/agent/src/main/java/org/openremote/agent/protocol/websocket/WebsocketAgentProtocol.java+++ b/agent/src/main/java/org/openremote/agent/protocol/websocket/WebsocketAgentProtocol.java@@ -232,19 +232,24 @@ public class WebsocketAgentProtocol extends AbstractNettyIOClientProtocol<Websocprotected void doSubscriptions(Map<String, List<String>> headers, WebsocketSubscription[] subscriptions) {LOG.info("Executing subscriptions for websocket: " + client.getClientUri());- // Inject OAuth header- if (!TextUtil.isNullOrEmpty(client.authHeaderValue)) {- if (headers == null) {- headers = new MultivaluedHashMap<>();+ try {+ // Inject OAuth header+ String authHeaderValue = client.getAuthHeader();+ if (authHeaderValue != null) {+ if (headers == null) {+ headers = new MultivaluedHashMap<>();+ }+ headers.remove(HttpHeaders.AUTHORIZATION);+ headers.put(HttpHeaders.AUTHORIZATION, Collections.singletonList(authHeaderValue));}- headers.remove(HttpHeaders.AUTHORIZATION);- headers.put(HttpHeaders.AUTHORIZATION, Collections.singletonList(client.authHeaderValue));- }- Map<String, List<String>> finalHeaders = headers;- Arrays.stream(subscriptions).forEach(- subscription -> doSubscription(finalHeaders, subscription)- );+ Map<String, List<String>> finalHeaders = headers;+ Arrays.stream(subscriptions).forEach(+ subscription -> doSubscription(finalHeaders, subscription)+ );+ } catch (Exception e) {+ LOG.info("An exception occurred executing subscriptions: " + e.getMessage());+ }}protected void doSubscription(Map<String, List<String>> headers, WebsocketSubscription subscription) {diff --git a/agent/src/main/java/org/openremote/agent/protocol/websocket/WebsocketIOClient.java b/agent/src/main/java/org/openremote/agent/protocol/websocket/WebsocketIOClient.javaindex f78d7de49..5be437d9d 100644--- a/agent/src/main/java/org/openremote/agent/protocol/websocket/WebsocketIOClient.java+++ b/agent/src/main/java/org/openremote/agent/protocol/websocket/WebsocketIOClient.java@@ -20,7 +20,9 @@package org.openremote.agent.protocol.websocket;import io.netty.buffer.ByteBuf;-import io.netty.channel.*;+import io.netty.channel.Channel;+import io.netty.channel.ChannelHandlerContext;+import io.netty.channel.EventLoopGroup;import io.netty.channel.nio.NioEventLoopGroup;import io.netty.channel.socket.nio.NioSocketChannel;import io.netty.handler.codec.MessageToMessageEncoder;@@ -30,8 +32,7 @@ import io.netty.handler.codec.http.websocketx.extensions.compression.WebSocketClimport io.netty.handler.ssl.SslContext;import io.netty.handler.ssl.SslContextBuilder;import io.netty.handler.ssl.util.InsecureTrustManagerFactory;-import io.netty.util.CharsetUtil;-import jakarta.ws.rs.ProcessingException;+import io.netty.handler.timeout.ReadTimeoutHandler;import org.jboss.resteasy.client.jaxrs.ResteasyClient;import org.openremote.agent.protocol.io.AbstractNettyIOClient;import org.openremote.agent.protocol.io.IOClient;@@ -40,8 +41,8 @@ import org.openremote.model.auth.OAuthGrant;import org.openremote.model.syslog.SyslogCategory;import org.openremote.model.util.TextUtil;+import javax.net.ssl.SSLException;import java.net.InetSocketAddress;-import java.net.SocketException;import java.net.URI;import java.util.List;import java.util.Map;@@ -49,7 +50,6 @@ import java.util.concurrent.CompletableFuture;import java.util.concurrent.Future;import java.util.concurrent.ScheduledFuture;import java.util.concurrent.TimeUnit;-import java.util.concurrent.atomic.AtomicInteger;import java.util.logging.Logger;import static org.openremote.container.web.WebTargetBuilder.CONNECTION_TIMEOUT_MILLISECONDS;@@ -63,88 +63,23 @@ import static org.openremote.model.syslog.SyslogCategory.PROTOCOL;*/public class WebsocketIOClient<T> extends AbstractNettyIOClient<T, InetSocketAddress> {- /**- * Extracts the text from the {@link WebSocketFrame} and sends it to the next handler in the pipeline- */- protected class WebSocketClientHandler extends SimpleChannelInboundHandler<Object> {-- private final WebSocketClientHandshaker handshaker;- private ChannelPromise handshakeFuture;-- public WebSocketClientHandler(WebSocketClientHandshaker handshaker) {- this.handshaker = handshaker;- }-- @Override- public void handlerAdded(ChannelHandlerContext ctx) {- handshakeFuture = ctx.newPromise();- }-- @Override- public void channelActive(ChannelHandlerContext ctx) {- handshaker.handshake(ctx.channel());- }-- @Override- public void channelRead0(ChannelHandlerContext ctx, Object msg) {- Channel ch = ctx.channel();-- if (!handshaker.isHandshakeComplete()) {- try {- handshaker.finishHandshake(ch, (FullHttpResponse) msg);- handshakeFuture.setSuccess();- } catch (WebSocketHandshakeException e) {- handshakeFuture.setFailure(e);- }- return;- }-- if (msg instanceof FullHttpResponse) {- FullHttpResponse response = (FullHttpResponse) msg;- LOG.severe("Websocket client unexpected FullHttpResponse (getStatus=" + response.status() +- ", content=" + response.content().toString(CharsetUtil.UTF_8) + "):" + getClientUri());- }-- WebSocketFrame frame = (WebSocketFrame) msg;- if (frame instanceof TextWebSocketFrame) {- TextWebSocketFrame textFrame = (TextWebSocketFrame) frame;- String str = textFrame.text();- ctx.fireChannelRead(str);- } else if (frame instanceof PongWebSocketFrame) {- LOG.finest("Received PONG: " + getClientUri());- if (pingCounter != null) {- pingCounter.set(0);- }- } else if (frame instanceof CloseWebSocketFrame) {- ch.close();- }- }-- @Override- public void exceptionCaught(ChannelHandlerContext ctx, Throwable cause) {- if (!handshakeFuture.isDone()) {- handshakeFuture.setFailure(cause);- ctx.close();- }- WebsocketIOClient.this.onDecodeException(ctx, cause);- }- }-private static final Logger LOG = SyslogCategory.getLogger(PROTOCOL, WebsocketIOClient.class);protected static ResteasyClient client;- public static final long PING_MILLIS = 60000;+ // How long since the last read before a PING is sent+ public static final long PING_MILLIS = 10000;+ // How long to wait for a ping response (i.e. pong)+ public static final long PING_TIMEOUT_MILLIS = 10000;protected ScheduledFuture<?> pingFuture;- protected AtomicInteger pingCounter;protected boolean useSsl;protected URI uri;- protected SslContext sslCtx;- protected WebSocketClientHandler handler;+ protected static SslContext sslCtx;+ protected WebSocketClientProtocolHandler handler;protected Map<String, List<String>> headers;protected OAuthGrant oAuthGrant;- protected String authHeaderValue;protected String host;protected int port;protected boolean pingDisabled;+ protected CompletableFuture<Void> handshakeFuture;public WebsocketIOClient(URI uri, Map<String, List<String>> headers, OAuthGrant oAuthGrant) {this(uri, headers, oAuthGrant, false);@@ -203,68 +138,57 @@ public class WebsocketIOClient<T> extends AbstractNettyIOClient<T, InetSocketAdd}@Override- protected ChannelFuture startChannel() {- return bootstrap.connect(new InetSocketAddress(host, port));+ protected Future<Void> startChannel() {+ handshakeFuture = new CompletableFuture<>();+ return CompletableFuture.allOf(+ toCompletableFuture(bootstrap.connect(new InetSocketAddress(host, port))),+ handshakeFuture+ );}@Override- protected void initChannel(Channel channel) throws Exception {- if (useSsl) {- sslCtx = SslContextBuilder.forClient()- .trustManager(InsecureTrustManagerFactory.INSTANCE).build();- } else {- sslCtx = null;- }-+ protected void addEncodersDecoders(Channel channel) throws Exception {HttpHeaders hdrs = new DefaultHttpHeaders();if (this.headers != null) {this.headers.forEach(hdrs::add);}+ String authHeaderValue = getAuthHeader();if (authHeaderValue != null) {hdrs.set(HttpHeaderNames.AUTHORIZATION, authHeaderValue);}- // Connect with V13 (RFC 6455 aka HyBi-17). You can change it to V08 or V00.- // If you change it to V00, ping is not supported and remember to change- // HttpResponseDecoder to WebSocketHttpResponseDecoder in the pipeline.- handler =- new WebSocketClientHandler(- WebSocketClientHandshakerFactory.newHandshaker(- uri, WebSocketVersion.V13, null, true, hdrs));-+ handler = new WebSocketClientProtocolHandler(+ WebSocketClientHandshakerFactory.newHandshaker(+ uri, WebSocketVersion.V13, null, true, hdrs)) {- super.initChannel(channel);- }-- protected void onHandshakeComplete() {- // Start ping task- if (!pingDisabled) {- LOG.fine("Starting PING task: " + getClientUri());- pingCounter = new AtomicInteger();- pingFuture = executorService.scheduleWithFixedDelay(() -> {- try {- if (pingCounter.get() > 2) {- LOG.info("No PING response so reconnecting: " + this);- doDisconnect();- scheduleDoConnect(1000);- return;+ @Override+ public void userEventTriggered(ChannelHandlerContext ctx, Object evt) throws Exception {+ super.userEventTriggered(ctx, evt);+ if (evt instanceof WebSocketClientProtocolHandler.ClientHandshakeStateEvent handshakeStateEvent) {+ if (handshakeStateEvent == ClientHandshakeStateEvent.HANDSHAKE_COMPLETE) {+ onHandshakeDone();}- LOG.finest("Sending PING: " + getClientUri());- channel.writeAndFlush(new PingWebSocketFrame());- pingCounter.incrementAndGet();- } catch (Exception ignored) {}- }, PING_MILLIS, PING_MILLIS, TimeUnit.MILLISECONDS);- }- }+ }- @Override- protected void addEncodersDecoders(Channel channel) {+ @Override+ protected void decode(ChannelHandlerContext ctx, WebSocketFrame frame, List<Object> out) throws Exception {+ if (frame instanceof PongWebSocketFrame) {+ onPong(ctx);+ }+ super.decode(ctx, frame, out);+ }+ };- if (sslCtx != null) {- channel.pipeline().addLast(sslCtx.newHandler(channel.alloc(), host, port));+ if (!pingDisabled) {+ channel.pipeline().addFirst(new ReadTimeoutHandler(PING_MILLIS, TimeUnit.MILLISECONDS) {+ @Override+ protected void readTimedOut(ChannelHandlerContext ctx) throws Exception {+ doPing(ctx);+ }+ });}channel.pipeline().addLast(@@ -273,46 +197,69 @@ public class WebsocketIOClient<T> extends AbstractNettyIOClient<T, InetSocketAddWebSocketClientCompressionHandler.INSTANCE,handler);- channel.pipeline().addLast(new MessageToMessageEncoder<ByteBuf>() {+ channel.pipeline().addLast(new io.netty.handler.codec.MessageToMessageDecoder<WebSocketFrame>() {@Override- protected void encode(ChannelHandlerContext ctx, ByteBuf msg, List<Object> out) {- out.add(new TextWebSocketFrame(msg));+ protected void decode(ChannelHandlerContext ctx, WebSocketFrame msg, List<Object> out) throws Exception {+ if (msg instanceof TextWebSocketFrame textWebSocketFrame) {+ out.add(textWebSocketFrame.text());+ } else if (msg instanceof BinaryWebSocketFrame) {+ out.add(msg.content().retain());+ }}});super.addEncodersDecoders(channel);- // Put string encoder first (encoders are called in reverse to decoders)+ // Put SSL handler first+ if (useSsl) {+ channel.pipeline().addFirst(getSSLContext().newHandler(channel.alloc(), host, port));+ }++ // Put string and bytebuf encoders first (encoders are called in reverse to decoders)channel.pipeline().addLast(new MessageToMessageEncoder<String>() {@Overrideprotected void encode(ChannelHandlerContext ctx, String msg, List<Object> out) {out.add(new TextWebSocketFrame(msg));}});+ channel.pipeline().addLast(new io.netty.handler.codec.MessageToMessageEncoder<ByteBuf>() {+ @Override+ protected void encode(ChannelHandlerContext ctx, ByteBuf msg, List<Object> out) throws Exception {+ out.add(new BinaryWebSocketFrame(msg.retain()));+ }+ });}- @Override- protected Future<Void> doConnect() {+ protected void onHandshakeDone() {+ if (handshakeFuture != null) {+ handshakeFuture.complete(null);+ handshakeFuture = null;+ }+ }- if (oAuthGrant != null) {- LOG.fine("Retrieving OAuth access token: " + getClientUri());+ protected synchronized SslContext getSSLContext() throws SSLException {+ if (sslCtx == null) {+ sslCtx = SslContextBuilder.forClient()+ .trustManager(InsecureTrustManagerFactory.INSTANCE)+ .sessionTimeout(getConnectTimeoutMillis())+ .build();+ }+ return sslCtx;+ }- try {- OAuthFilter oAuthFilter = new OAuthFilter(getClient(), oAuthGrant);- authHeaderValue = oAuthFilter.getAuthHeader();- if (TextUtil.isNullOrEmpty(authHeaderValue)) {- throw new RuntimeException("Returned access token is null");- }- LOG.fine("Retrieved access token via OAuth: " + getClientUri());+ private void doPing(ChannelHandlerContext ctx) {+ LOG.finest("Sending PING: " + getClientUri());+ pingFuture = executorService.schedule(() -> {+ ctx.fireExceptionCaught(new Exception("PING failed"));+ }, PING_TIMEOUT_MILLIS, TimeUnit.MILLISECONDS);+ ctx.channel().writeAndFlush(new PingWebSocketFrame());+ }- } catch (SocketException | ProcessingException e) {- return CompletableFuture.failedFuture(new RuntimeException("Failed to retrieve OAuth access token for '" + getClientUri() + "': Connection error"));- } catch (Exception e) {- return CompletableFuture.failedFuture(new RuntimeException("Failed to retrieve OAuth access token '" + getClientUri() + "': " + e.getMessage()));- }+ private void onPong(ChannelHandlerContext ctx) {+ LOG.finest("Received PONG: " + getClientUri());+ if (pingFuture != null) {+ pingFuture.cancel(false);}-- return super.doConnect();}@Override@@ -325,16 +272,24 @@ public class WebsocketIOClient<T> extends AbstractNettyIOClient<T, InetSocketAddsuper.doDisconnect();}- @Override- protected CompletableFuture<Void> createConnectedFuture(final ChannelFuture channelStartFuture) {- CompletableFuture<Void> connectedFuture = super.createConnectedFuture(channelStartFuture);- return connectedFuture.thenRunAsync(() -> {- ChannelPromise handshakeFuture = handler.handshakeFuture;- handshakeFuture.awaitUninterruptibly();-- if (handshakeFuture.isSuccess()) {- onHandshakeComplete();+ public String getAuthHeader() throws Exception {+ String authHeaderValue = null;++ if (oAuthGrant != null) {+ LOG.finest("Retrieving OAuth access token: " + getClientUri());++ try {+ OAuthFilter oAuthFilter = new OAuthFilter(getClient(), oAuthGrant);+ authHeaderValue = oAuthFilter.getAuthHeader();+ if (TextUtil.isNullOrEmpty(authHeaderValue)) {+ throw new RuntimeException("Returned access token is null");+ }+ LOG.finest("Retrieved access token via OAuth: " + getClientUri());+ } catch (Exception e) {+ throw new Exception("Error retrieving OAuth access token for '" + getClientUri() + "': " + e.getMessage());}- });+ }++ return authHeaderValue;}}diff --git a/container/src/main/java/org/openremote/container/web/OAuthFilter.java b/container/src/main/java/org/openremote/container/web/OAuthFilter.javaindex 56cb6bde4..ec4615b0f 100644--- a/container/src/main/java/org/openremote/container/web/OAuthFilter.java+++ b/container/src/main/java/org/openremote/container/web/OAuthFilter.java@@ -80,7 +80,7 @@ public class OAuthFilter implements ClientRequestFilter {}protected synchronized void updateToken() throws SocketException {- LOG.fine("Updating OAuth token");+ LOG.finest("Updating OAuth token: " + oAuthGrant.getTokenEndpointUri());Response response = null;try {@@ -103,7 +103,7 @@ public class OAuthFilter implements ClientRequestFilter {if (response.getStatusInfo().getFamily() != Response.Status.Family.SUCCESSFUL) {authServerResponse = null;- LOG.finest("OAuth server response error: " + response.getStatus());+ LOG.fine("OAuth server response error '" + response.getStatus() + "': " + oAuthGrant.getTokenEndpointUri());throw new RuntimeException("OAuth server response error: " + response.getStatus());} else {authServerResponse = response.readEntity(OAuthServerResponse.class);diff --git a/gradle.properties b/gradle.propertiesindex b9908dbaf..f360dde8c 100644--- a/gradle.properties+++ b/gradle.properties@@ -33,7 +33,7 @@ uuidGeneratorVersion = 4.0.1jSerialCommVersion = 2.7.0saxonHEVersion = 11.3jmxtermVersion = 1.0.0-nettyVersion = 4.1.101.Final+nettyVersion = 4.1.111.FinalflywaydbVersion = 10.8.1ical4jVersion = 3.2.6friendlyIdVersion = 1.0.1@@ -48,10 +48,10 @@ zwaveVersion = 3.4.0reflectionsVersion=0.9.12swaggerVersion=2.2.8jsonSchemaVersion=4.18.0-hiveMQClientVersion=1.2.2+hiveMQClientVersion=1.3.3bluetoothVersion = 0.39nashornVersion=15.3-failsafeVersion=3.1.0+failsafeVersion=3.3.2suncalcVersion=3.5snapshotsRepoUrl=https://s01.oss.sonatype.org/content/repositories/snapshots/releasesRepoUrl=https://s01.oss.sonatype.org/service/local/staging/deploy/maven2/diff --git a/manager/src/main/java/org/openremote/manager/gateway/GatewayClientService.java b/manager/src/main/java/org/openremote/manager/gateway/GatewayClientService.javaindex 515d76418..f8ec1e62a 100644--- a/manager/src/main/java/org/openremote/manager/gateway/GatewayClientService.java+++ b/manager/src/main/java/org/openremote/manager/gateway/GatewayClientService.java@@ -149,6 +149,7 @@ public class GatewayClientService extends RouteBuilder implements ContainerServiconnectionRealmMap.forEach((realm, connection) -> {if (!connection.isDisabled()) {clientRealmMap.put(realm, createGatewayClient(connection));+ clientAttributeTimestamps.put(connection.getLocalRealm(), new ConcurrentHashMap<>());}});}@@ -162,6 +163,7 @@ public class GatewayClientService extends RouteBuilder implements ContainerServi});clientRealmMap.clear();connectionRealmMap.clear();+ clientAttributeTimestamps.clear();}@Override@@ -187,19 +189,14 @@ public class GatewayClientService extends RouteBuilder implements ContainerServicase UPDATE:GatewayIOClient client = clientRealmMap.remove(connection.getLocalRealm());+ clientAttributeTimestamps.remove(connection.getLocalRealm());if (client != null) {destroyGatewayClient(connection, client);}- if (connection.isDisabled()) {- clientAttributeTimestamps.remove(connection.getLocalRealm());- }case CREATE:connectionRealmMap.put(connection.getLocalRealm(), connection);if (!connection.isDisabled()) {clientRealmMap.put(connection.getLocalRealm(), createGatewayClient(connection));- }- // Gateway connection can become disabled if an error occurred during creation- if (!connection.isDisabled()) {clientAttributeTimestamps.put(connection.getLocalRealm(), new ConcurrentHashMap<>());}break;diff --git a/manager/src/main/java/org/openremote/manager/gateway/GatewayIOClient.java b/manager/src/main/java/org/openremote/manager/gateway/GatewayIOClient.javaindex 8b074c12a..4988af321 100644--- a/manager/src/main/java/org/openremote/manager/gateway/GatewayIOClient.java+++ b/manager/src/main/java/org/openremote/manager/gateway/GatewayIOClient.java@@ -20,7 +20,6 @@package org.openremote.manager.gateway;-import io.netty.channel.ChannelFuture;import org.openremote.agent.protocol.websocket.WebsocketIOClient;import org.openremote.model.auth.OAuthGrant;import org.openremote.model.event.shared.EventRequestResponseWrapper;@@ -31,6 +30,7 @@ import java.net.URI;import java.util.List;import java.util.Map;import java.util.concurrent.CompletableFuture;+import java.util.concurrent.Future;import java.util.concurrent.TimeUnit;import java.util.concurrent.TimeoutException;import java.util.logging.Logger;@@ -55,9 +55,12 @@ public class GatewayIOClient extends WebsocketIOClient<String> {}@Override- protected CompletableFuture<Void> createConnectedFuture(ChannelFuture channelStartFuture) {- CompletableFuture<Void> connectedFuture = super.createConnectedFuture(channelStartFuture);- return connectedFuture.thenCompose(__ ->+ protected Future<Void> startChannel() {+ CompletableFuture<Void> connectedFuture = toCompletableFuture(super.startChannel());++ return connectedFuture+ .orTimeout(getConnectTimeoutMillis()+1000L, TimeUnit.MILLISECONDS)+ .thenCompose(__ ->getFuture().orTimeout(TIMEOUT_MILLIS, TimeUnit.MILLISECONDS).handle((result, ex) -> {@@ -72,6 +75,12 @@ public class GatewayIOClient extends WebsocketIOClient<String> {);}+ @Override+ protected Void waitForConnectFuture(Future<Void> connectFuture) throws Exception {+ // Might need a better solution than this as we don't know how long the sync will take+ return connectFuture.get(getConnectTimeoutMillis()+60000L, TimeUnit.MILLISECONDS);+ }+protected CompletableFuture<Void> getFuture() {syncFuture = new CompletableFuture<>();return syncFuture;diff --git a/model/src/main/java/org/openremote/model/gateway/GatewayConnection.java b/model/src/main/java/org/openremote/model/gateway/GatewayConnection.javaindex 6e1d9b8b5..4cf52a47a 100644--- a/model/src/main/java/org/openremote/model/gateway/GatewayConnection.java+++ b/model/src/main/java/org/openremote/model/gateway/GatewayConnection.java@@ -211,7 +211,7 @@ public class GatewayConnection {", port=" + port +", realm='" + realm + '\'' +", secured=" + secured +- ", attributeFilters=" + attributeFilters ++ ", attributeFilters=" + (attributeFilters != null && !attributeFilters.isEmpty()) +", disabled=" + disabled +'}';}diff --git a/test/src/logging-test.properties b/test/src/logging-test.propertiesindex e4c0eb674..45ea0b518 100644--- a/test/src/logging-test.properties+++ b/test/src/logging-test.properties@@ -46,7 +46,7 @@ org.openremote.level=FINE#org.openremote.container.web.WebService.level=INFO# Try to get more info on AbstractNettyIOClient as we get strange intermittent test failures-org.openremote.agent.protocol.io.AbstractNettyIOClient.level=FINEST+org.openremote.agent.protocol.io.level=FINEST# Third party overridesorg.jboss.resteasy.level=WARNINGdiff --git a/test/src/test/groovy/org/openremote/test/protocol/TcpClientTest.groovy b/test/src/test/groovy/org/openremote/test/protocol/TcpClientTest.groovyindex d90dd088c..d684089a9 100644--- a/test/src/test/groovy/org/openremote/test/protocol/TcpClientTest.groovy+++ b/test/src/test/groovy/org/openremote/test/protocol/TcpClientTest.groovy@@ -34,6 +34,8 @@ import org.openremote.test.ManagerContainerTraitimport spock.lang.Specificationimport spock.util.concurrent.PollingConditions+import java.util.concurrent.Future+/*** This tests the {@link TCPIOClient} by creating a simple echo server that the client communicates with*/@@ -55,8 +57,7 @@ class TcpClientTest extends Specification implements ManagerContainerTrait {})and: "a simple TCP client"- def connectAttempts = 0- TCPIOClient<String> client = new TCPIOClient<String>(+ TestTCPClient client = new TestTCPClient("127.0.0.1",echoServerPort)client.setEncoderDecoderProvider({@@ -64,11 +65,6 @@ class TcpClientTest extends Specification implements ManagerContainerTrait {new StringDecoder(CharsetUtil.UTF_8),new AbstractNettyIOClient.MessageToMessageDecoder<String>(String.class, client)].toArray(new ChannelHandler[0])})- client = Spy(client)- client.doConnect() >> {- connectAttempts++- callRealMethod()- }and: "we add callback consumers to the client"def connectionStatus = client.getConnectionStatus()@@ -94,7 +90,7 @@ class TcpClientTest extends Specification implements ManagerContainerTrait {then: "the client status should become CONNECTED"conditions.eventually {- assert client.connectionStatus == ConnectionStatus.CONNECTED+// assert client.connectionStatus == ConnectionStatus.CONNECTEDassert connectionStatus == ConnectionStatus.CONNECTEDassert echoServer.allChannels.size() == 1}@@ -120,7 +116,7 @@ class TcpClientTest extends Specification implements ManagerContainerTrait {then: "the client should become DISCONNECTED"conditions.eventually {- assert client.connectionStatus == ConnectionStatus.DISCONNECTED+// assert client.connectionStatus == ConnectionStatus.DISCONNECTEDassert connectionStatus == ConnectionStatus.DISCONNECTED}@@ -129,7 +125,7 @@ class TcpClientTest extends Specification implements ManagerContainerTrait {then: "the client status should become CONNECTED"conditions.eventually {- assert client.connectionStatus == ConnectionStatus.CONNECTED+// assert client.connectionStatus == ConnectionStatus.CONNECTEDassert connectionStatus == ConnectionStatus.CONNECTEDassert echoServer.allChannels.size() == 1}@@ -151,7 +147,7 @@ class TcpClientTest extends Specification implements ManagerContainerTrait {}when: "we lose connection to the server"- connectAttempts = 0+ client.connectAttempts = 0echoServer.stop()then: "the server status should be DISCONNECTED"@@ -161,9 +157,9 @@ class TcpClientTest extends Specification implements ManagerContainerTrait {then: "the client status should change to CONNECTING and several re-connection attempts should be made"conditions.eventually {- assert client.connectionStatus == ConnectionStatus.CONNECTING+// assert client.connectionStatus == ConnectionStatus.CONNECTINGassert connectionStatus == ConnectionStatus.CONNECTING- assert connectAttempts > 2+ assert client.connectAttempts > 2}when: "the connection to the server is restored"@@ -180,7 +176,7 @@ class TcpClientTest extends Specification implements ManagerContainerTrait {then: "the client status should become CONNECTED"conditions.eventually {- assert client.connectionStatus == ConnectionStatus.CONNECTED+// assert client.connectionStatus == ConnectionStatus.CONNECTEDassert connectionStatus == ConnectionStatus.CONNECTEDassert echoServer.allChannels.size() == 1}@@ -206,7 +202,7 @@ class TcpClientTest extends Specification implements ManagerContainerTrait {then: "the client should become DISCONNECTED"conditions.eventually {- assert client.connectionStatus == ConnectionStatus.DISCONNECTED+// assert client.connectionStatus == ConnectionStatus.DISCONNECTEDassert connectionStatus == ConnectionStatus.DISCONNECTED}diff --git a/test/src/test/groovy/org/openremote/test/protocol/websocket/WebsocketClientTest.groovy b/test/src/test/groovy/org/openremote/test/protocol/websocket/WebsocketClientTest.groovyindex c88a5bbee..907ea8021 100644--- a/test/src/test/groovy/org/openremote/test/protocol/websocket/WebsocketClientTest.groovy+++ b/test/src/test/groovy/org/openremote/test/protocol/websocket/WebsocketClientTest.groovy@@ -20,6 +20,9 @@package org.openremote.test.protocol.websocketimport io.netty.channel.ChannelHandler+import io.netty.handler.codec.string.StringDecoder+import io.netty.handler.codec.string.StringEncoder+import io.netty.util.CharsetUtilimport org.apache.http.client.utils.URIBuilderimport org.openremote.agent.protocol.io.AbstractNettyIOClientimport org.openremote.agent.protocol.websocket.WebsocketIOClient@@ -99,7 +102,11 @@ class WebsocketClientTest extends Specification implements ManagerContainerTrait"testuser3","testuser3"))client.setEncoderDecoderProvider({- [new AbstractNettyIOClient.MessageToMessageDecoder<String>(String.class, client)].toArray(new ChannelHandler[0])+ [+ new StringEncoder(CharsetUtil.UTF_8),+ new StringDecoder(CharsetUtil.UTF_8),+ new AbstractNettyIOClient.MessageToMessageDecoder<String>(String.class, client)+ ].toArray(new ChannelHandler[0])})and: "another Websocket client with another restricted user"@@ -113,7 +120,11 @@ class WebsocketClientTest extends Specification implements ManagerContainerTrait"building","building"))client2.setEncoderDecoderProvider({- [new AbstractNettyIOClient.MessageToMessageDecoder<String>(String.class, client2)].toArray(new ChannelHandler[0])+ [+ new StringEncoder(CharsetUtil.UTF_8),+ new StringDecoder(CharsetUtil.UTF_8),+ new AbstractNettyIOClient.MessageToMessageDecoder<String>(String.class, client2)+ ].toArray(new ChannelHandler[0])})and: "we add callback consumers to the clients"@@ -149,10 +160,6 @@ class WebsocketClientTest extends Specification implements ManagerContainerTraitassert connectionStatus2 == ConnectionStatus.CONNECTED}- // TODO: Remove this once client supports some better connection logic- and: "some time passes to allow the connection to be fully initialised"- sleep(3000)-when: "we subscribe to attribute events produced by the server"client.sendMessage(messageToString(EventSubscription.SUBSCRIBE_MESSAGE_PREFIX,new EventSubscription(diff --git a/test/src/test/java/org/openremote/test/protocol/TestTCPClient.java b/test/src/test/java/org/openremote/test/protocol/TestTCPClient.javanew file mode 100644index 000000000..ccebff0fc--- /dev/null+++ b/test/src/test/java/org/openremote/test/protocol/TestTCPClient.java@@ -0,0 +1,20 @@+package org.openremote.test.protocol;++import org.openremote.agent.protocol.tcp.TCPIOClient;++import java.util.concurrent.Future;++public class TestTCPClient extends TCPIOClient<String> {++ public int connectAttempts;++ public TestTCPClient(String host, int port) {+ super(host, port);+ }++ @Override+ protected Future<Void> doConnect() {+ connectAttempts++;+ return super.doConnect();+ }+}