remotus 1.0.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 86bb2b7b3be25ec98b48372e32f75f6ae70471bdb72635a44a1f50b20c1f5421
-  data.tar.gz: a2f1b203c618ffb909bc55f7edd0718bd960d53b968ea5418f1a80c7ff05b9a6
+  metadata.gz: 66301e654fe9408264dbf7d7313fb93ff7cc3e5b8758cd5584f9d69aef477a4e
+  data.tar.gz: 5c8793e11d677261f6db58fb415030b23262b0c61559777282ea29413e0203ba
 SHA512:
-  metadata.gz: 28acc8709f9bcc670d175471973f309f76af530e4fb9cf1b566f58405ef4516fddc20dec63ca318c768c8f6247f6314d64838d2314fc5cf3f18a736f8fc24d38
-  data.tar.gz: e8d1a7cb11844225214b55fb59de52c0af958e8640db57c15eefac3e92dc3cae63a8186165108158ca93da134961a08f163fd7e2d7ec381f84524587a2881e98
+  metadata.gz: 2567a652c903e2538ceb352b01ec606e983b5aa6f64a64d707ac35302121462cd15373f6463920053831d169f1cb37c0287be206798f81b28afb5e0c30de357a
+  data.tar.gz: cacd8478695fbac5ea33d76356a5d553af541249615c3ff57b60adf497e99593784a16d8ae5d2fb61803565f49b40d7e6ab0ee7a4c7b019d0502d57cf5406c14

data/.gitignore

@@ -9,3 +9,5 @@
 
 # rspec failure tracking
 .rspec_status
+
+.vscode

data/.rubocop.yml

@@ -14,7 +14,7 @@ Layout/LineLength:
   Max: 150
 
 Metrics/ClassLength:
-  Max: 250
+  Max: 300
 
 Metrics/BlockLength:
   Exclude:
@@ -46,3 +46,6 @@ Metrics/ParameterLists:
 
 Gemspec/RequireMFA:
   Enabled: false
+
+Gemspec/DevelopmentDependencies:
+  EnforcedStyle: gemspec

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+## [1.1.1] - 2023-05-26
+* Handle close failures and improve logging around connection status.
+
+## [1.1.0] - 2023-05-25
+* Improve exponential backoff during SSH retries.
+* Force connection close on IOError (closed stream).
+
 ## [1.0.0] - 2023-04-25
 * Update SSH dependencies to handle `pkeys are immutable on OpenSSL 3.0` errors on newer Ruby versions
 * Remove Ruby 2.5 support

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    remotus (1.0.0)
+    remotus (1.1.1)
       connection_pool (~> 2.4)
       net-scp (~> 4.0)
       net-ssh (~> 7.1)
@@ -15,7 +15,7 @@ GEM
   specs:
     ast (2.4.2)
     builder (3.2.4)
-    connection_pool (2.4.0)
+    connection_pool (2.4.1)
     diff-lcs (1.5.0)
     erubi (1.12.0)
     ffi (1.15.5)
@@ -57,7 +57,7 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
     rspec-support (3.12.0)
-    rubocop (1.50.2)
+    rubocop (1.51.0)
       json (~> 2.3)
       parallel (~> 1.10)
       parser (>= 3.2.0.0)
@@ -67,15 +67,18 @@ GEM
       rubocop-ast (>= 1.28.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.28.0)
+    rubocop-ast (1.28.1)
       parser (>= 3.2.1.0)
     rubocop-capybara (2.18.0)
       rubocop (~> 1.41)
+    rubocop-factory_bot (2.23.1)
+      rubocop (~> 1.33)
     rubocop-rake (0.6.0)
       rubocop (~> 1.0)
-    rubocop-rspec (2.20.0)
+    rubocop-rspec (2.22.0)
       rubocop (~> 1.33)
       rubocop-capybara (~> 2.17)
+      rubocop-factory_bot (~> 2.22)
     ruby-progressbar (1.13.0)
     rubyntlm (0.6.3)
     rubyzip (2.3.2)

data/lib/remotus/ssh_connection.rb

@@ -20,7 +20,7 @@ module Remotus
     KEEPALIVE_INTERVAL = 300
 
     # Number of default retries
-    DEFAULT_RETRIES = 2
+    DEFAULT_RETRIES = 8
 
     # Base options for new SSH connections
     BASE_CONNECT_OPTIONS = { non_interactive: true, keepalive: true, keepalive_interval: KEEPALIVE_INTERVAL }.freeze
@@ -154,9 +154,21 @@ module Remotus
     # Closes the current SSH connection if it is active
     #
     def close
-      @connection&.close
+      Remotus.logger.debug { "Closing SSH connection." }
 
-      @gateway&.connection&.shutdown! if via_gateway?
+      begin
+        @connection&.close
+      rescue StandardError => e
+        Remotus.logger.warn { "Failed to close existing SSH connection with error #{e}" }
+      end
+
+      begin
+        @gateway&.connection&.shutdown! if via_gateway?
+      rescue StandardError => e
+        Remotus.logger.warn { "Failed to close existing SSH gateway connection with error #{e}" }
+      end
+
+      Remotus.logger.debug { "Setting @gateway and @connection to nil." }
 
       @gateway = nil
       @connection = nil
@@ -424,6 +436,8 @@ module Remotus
     # @param [Integer] retries number of retries
     #
     def with_retries(command, retries)
+      sleep_time = 1
+
       yield if block_given?
     rescue Remotus::AuthenticationError, Net::SSH::AuthenticationFailed => e
       # Re-raise exception if the retry count is exceeded
@@ -446,6 +460,12 @@ module Remotus
       retries -= 1
       raise if e.to_s != "closed stream" || retries.negative?
 
+      # Close the existing connection before retrying again
+      close
+
+      Remotus.logger.debug { "Sleeping for #{sleep_time} seconds before next retry..." }
+      sleep sleep_time
+      sleep_time *= 2 # Double delay for each retry
       retry
     end
 

data/lib/remotus/version.rb

@@ -2,5 +2,5 @@
 
 module Remotus
   # Remotus gem version
-  VERSION = "1.0.0"
+  VERSION = "1.1.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: remotus
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.1
 platform: ruby
 authors:
 - Matthew Newell
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-04-25 00:00:00.000000000 Z
+date: 2023-05-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: connection_pool