From f947bb89392792a46a3bd6e86651eaf0bae7de20 Mon Sep 17 00:00:00 2001 From: Andrew Welker Date: Mon, 18 Oct 2021 12:04:51 -0600 Subject: [PATCH 1/4] refactor: Add logging of some messages to error log Also moves some error handling and status notifications into the catch blocks in the `Connectr()` method. --- .../Pepperdash Core/Comm/GenericSshClient.cs | 39 ++++++++++--------- 1 file changed, 20 insertions(+), 19 deletions(-) diff --git a/Pepperdash Core/Pepperdash Core/Comm/GenericSshClient.cs b/Pepperdash Core/Pepperdash Core/Comm/GenericSshClient.cs index 3bc7c21..8be7768 100644 --- a/Pepperdash Core/Pepperdash Core/Comm/GenericSshClient.cs +++ b/Pepperdash Core/Pepperdash Core/Comm/GenericSshClient.cs @@ -193,7 +193,7 @@ namespace PepperDash.Core { if (IsConnecting) { - Debug.Console(0, this, "Connection attempt in progress. Exiting Connect()"); + Debug.Console(0, this, Debug.ErrorLogLevel.Warning, "Connection attempt in progress. Exiting Connect()"); return; } @@ -216,7 +216,7 @@ namespace PepperDash.Core if (string.IsNullOrEmpty(Hostname) || Port < 1 || Port > 65535 || Username == null || Password == null) { - Debug.Console(1, this, "Connect failed. Check hostname, port, username and password are set or not null"); + Debug.Console(1, this, Debug.ErrorLogLevel.Error, "Connect failed. Check hostname, port, username and password are set or not null"); return; } @@ -248,7 +248,7 @@ namespace PepperDash.Core TheStream = Client.CreateShellStream("PDTShell", 100, 80, 100, 200, 65534); TheStream.DataReceived += Stream_DataReceived; //TheStream.ErrorOccurred += TheStream_ErrorOccurred; - Debug.Console(1, this, "Connected"); + Debug.Console(1, this, Debug.ErrorLogLevel.Notice, "Connected"); ClientStatus = SocketStatus.SOCKET_STATUS_CONNECTED; IsConnecting = false; return; // Success will not pass here @@ -257,26 +257,27 @@ namespace PepperDash.Core { var ie = e.InnerException; // The details are inside!! if (ie is SocketException) - Debug.Console(1, this, "'{0}' CONNECTION failure: Cannot reach host, ({1})", Key, ie.GetType()); + Debug.Console(1, this, Debug.ErrorLogLevel.Error, "'{0}' CONNECTION failure: Cannot reach host, ({1})", Key, ie.Message); else if (ie is System.Net.Sockets.SocketException) - Debug.Console(1, this, "'{0}' Connection failure: Cannot reach host '{1}' on port {2}, ({3})", + Debug.Console(1, this, Debug.ErrorLogLevel.Error, "'{0}' Connection failure: Cannot reach host '{1}' on port {2}, ({3})", Key, Hostname, Port, ie.GetType()); else if (ie is SshAuthenticationException) { - Debug.Console(1, this, "Authentication failure for username '{0}', ({1})", - Username, ie.GetType()); + Debug.Console(1, this, Debug.ErrorLogLevel.Error, "Authentication failure for username '{0}', ({1})", + Username, ie.Message); } else - Debug.Console(1, this, "Error on connect:\r({0})", e); + Debug.Console(1, this, Debug.ErrorLogLevel.Error, "Error on connect:\r({0})", e); + + ClientStatus = SocketStatus.SOCKET_STATUS_CONNECT_FAILED; + HandleConnectionFailure(); } catch (Exception e) { - Debug.Console(1, this, "Unhandled exception on connect:\r({0})", e); - } - - // Sucess will not make it this far - ClientStatus = SocketStatus.SOCKET_STATUS_CONNECT_FAILED; - HandleConnectionFailure(); + Debug.Console(1, this, Debug.ErrorLogLevel.Error, "Unhandled exception on connect:\r({0})", e); + ClientStatus = SocketStatus.SOCKET_STATUS_CONNECT_FAILED; + HandleConnectionFailure(); + } } @@ -335,7 +336,7 @@ namespace PepperDash.Core Connect(); ReconnectTimer = null; }, AutoReconnectIntervalMs); - Debug.Console(1, this, "Attempting connection in {0} seconds", + Debug.Console(1, this, Debug.ErrorLogLevel.Notice, "Attempting connection in {0} seconds", (float)(AutoReconnectIntervalMs / 1000)); } else @@ -402,9 +403,9 @@ namespace PepperDash.Core void Client_ErrorOccurred(object sender, Crestron.SimplSharp.Ssh.Common.ExceptionEventArgs e) { if (e.Exception is SshConnectionException || e.Exception is System.Net.Sockets.SocketException) - Debug.Console(1, this, "Disconnected by remote"); + Debug.Console(1, this, Debug.ErrorLogLevel.Error, "Disconnected by remote"); else - Debug.Console(1, this, "Unhandled SSH client error: {0}", e.Exception); + Debug.Console(1, this, Debug.ErrorLogLevel.Error, "Unhandled SSH client error: {0}", e.Exception); ClientStatus = SocketStatus.SOCKET_STATUS_BROKEN_REMOTELY; HandleConnectionFailure(); @@ -444,7 +445,7 @@ namespace PepperDash.Core Debug.Console(0, "Exception: {0}", ex.Message); Debug.Console(0, "Stack Trace: {0}", ex.StackTrace); - Debug.Console(1, this, "Stream write failed. Disconnected, closing"); + Debug.Console(1, this, Debug.ErrorLogLevel.Error, "Stream write failed. Disconnected, closing"); ClientStatus = SocketStatus.SOCKET_STATUS_BROKEN_REMOTELY; HandleConnectionFailure(); } @@ -469,7 +470,7 @@ namespace PepperDash.Core } catch { - Debug.Console(1, this, "Stream write failed. Disconnected, closing"); + Debug.Console(1, this, Debug.ErrorLogLevel.Error, "Stream write failed. Disconnected, closing"); ClientStatus = SocketStatus.SOCKET_STATUS_BROKEN_REMOTELY; HandleConnectionFailure(); } From e565144830312320c18119a9a486b953965070ca Mon Sep 17 00:00:00 2001 From: Andrew Welker Date: Mon, 18 Oct 2021 12:16:22 -0600 Subject: [PATCH 2/4] refactor: Move failure handling out of catch blocks just in case --- Pepperdash Core/Pepperdash Core/Comm/GenericSshClient.cs | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/Pepperdash Core/Pepperdash Core/Comm/GenericSshClient.cs b/Pepperdash Core/Pepperdash Core/Comm/GenericSshClient.cs index 8be7768..6d9a2e5 100644 --- a/Pepperdash Core/Pepperdash Core/Comm/GenericSshClient.cs +++ b/Pepperdash Core/Pepperdash Core/Comm/GenericSshClient.cs @@ -277,7 +277,10 @@ namespace PepperDash.Core Debug.Console(1, this, Debug.ErrorLogLevel.Error, "Unhandled exception on connect:\r({0})", e); ClientStatus = SocketStatus.SOCKET_STATUS_CONNECT_FAILED; HandleConnectionFailure(); - } + } + + ClientStatus = SocketStatus.SOCKET_STATUS_CONNECT_FAILED; + HandleConnectionFailure(); } From 41fdecefa05fa6ee4e24c2981bd4247dffa47784 Mon Sep 17 00:00:00 2001 From: Andrew Welker Date: Wed, 9 Feb 2022 09:29:43 -0700 Subject: [PATCH 3/4] ci: Fix runner image --- .github/workflows/docker.yml | 2 +- .github/workflows/main.yml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/docker.yml b/.github/workflows/docker.yml index 9e09430..30d108b 100644 --- a/.github/workflows/docker.yml +++ b/.github/workflows/docker.yml @@ -21,7 +21,7 @@ env: RELEASE_BRANCH: main jobs: Build_Project: - runs-on: windows-latest + runs-on: windows-2019 steps: # First we checkout the source repo - name: Checkout repo diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index 3c73887..47efe95 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -19,7 +19,7 @@ env: RELEASE_BRANCH: main jobs: Build_Project: - runs-on: windows-latest + runs-on: windows-2019 steps: # First we checkout the source repo - name: Checkout repo From bbbd6d2290453ea254aa4549bf284921f0affebd Mon Sep 17 00:00:00 2001 From: Andrew Welker Date: Wed, 9 Feb 2022 10:07:59 -0700 Subject: [PATCH 4/4] refactor: fix missing `}` --- .../Pepperdash Core/Comm/GenericSshClient.cs | 35 ++++++++++--------- 1 file changed, 18 insertions(+), 17 deletions(-) diff --git a/Pepperdash Core/Pepperdash Core/Comm/GenericSshClient.cs b/Pepperdash Core/Pepperdash Core/Comm/GenericSshClient.cs index 8ffe560..2990ae0 100644 --- a/Pepperdash Core/Pepperdash Core/Comm/GenericSshClient.cs +++ b/Pepperdash Core/Pepperdash Core/Comm/GenericSshClient.cs @@ -326,23 +326,24 @@ namespace PepperDash.Core KillClient(SocketStatus.SOCKET_STATUS_CONNECT_FAILED); Debug.Console(1, this, "Client nulled due to connection failure. AutoReconnect: {0}, ConnectEnabled: {1}", AutoReconnect, ConnectEnabled); - if (AutoReconnect && ConnectEnabled) - { - Debug.Console(1, this, "Checking autoreconnect: {0}, {1}ms", AutoReconnect, AutoReconnectIntervalMs); - if (ReconnectTimer == null) - { - ReconnectTimer = new CTimer(o => - { - Connect(); - }, AutoReconnectIntervalMs); - Debug.Console(1, this, Debug.ErrorLogLevel.Notice, "Attempting connection in {0} seconds", - (float)(AutoReconnectIntervalMs / 1000)); - } - else - { - Debug.Console(1, this, "{0} second reconnect cycle running", - (float)(AutoReconnectIntervalMs / 1000)); - } + if (AutoReconnect && ConnectEnabled) + { + Debug.Console(1, this, "Checking autoreconnect: {0}, {1}ms", AutoReconnect, AutoReconnectIntervalMs); + if (ReconnectTimer == null) + { + ReconnectTimer = new CTimer(o => + { + Connect(); + }, AutoReconnectIntervalMs); + Debug.Console(1, this, Debug.ErrorLogLevel.Notice, "Attempting connection in {0} seconds", + (float) (AutoReconnectIntervalMs/1000)); + } + else + { + Debug.Console(1, this, "{0} second reconnect cycle running", + (float) (AutoReconnectIntervalMs/1000)); + } + } } ///