waithook 0.4.1 → 0.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5df3978af4bd4dc3330d86dd3a1948d082d1642882163066ec4e09d9b63245b2
-  data.tar.gz: af869d9efc1604f24b3fd1455767f06d5af75d62c5a225611b87b450e21f4bc1
+  metadata.gz: b1f0cc2d5d5ec7b85af2b2d46e1fb0d027e44f59280383144852cd977ef7476e
+  data.tar.gz: 3b91c47c92011bb8ffdf2d6178f4e3b6634a276e3bea95038f81938f787f1a5c
 SHA512:
-  metadata.gz: f2aa1c1079788668a57c3483708aa5158f3fb2b9abdfa8fafb227027ed83c085d970b97d65068a34373cfcb5edcae0ffc481351b1ebc53ee726f7f707eaaadec
-  data.tar.gz: 19c9797a9712c5df295515da8a5b299132ec2176364094d7b6d5f7ca96e502aa986e379a6be94fad05c5109114bc7b7423c9ce6550bf2e1d7d903b5209c7d5a5
+  metadata.gz: dd53a11900c20386e09d9eaf95f59e8ff787063844367d3d49b2bd374b760c1ab967e022d8d195e10d79c2e44381b1fbc7dbdf34417d49ca93b7cd8e6b74f542
+  data.tar.gz: 17249a6bdddb4e9d24a441ceb68273f81649f8a1cf00514bc51464cb284f5291ba1d4030b53542981ebb702e29bb2d2ffbd4f9fbc3300506758441e658cbd4ba

data/Gemfile

@@ -4,5 +4,6 @@ gem 'rake'
 gem 'minitest-reporters'
 gem 'excon'
 gem 'addressable'
+gem 'coderay'
 
 gemspec

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    waithook (0.4.0)
+    waithook (0.4.2)
       websocket (~> 1.2)
 
 GEM
@@ -11,6 +11,7 @@ GEM
       public_suffix (>= 2.0.2, < 7.0)
     ansi (1.5.0)
     builder (3.3.0)
+    coderay (1.1.3)
     excon (0.112.0)
     minitest (5.25.1)
     minitest-reporters (1.7.1)
@@ -28,6 +29,7 @@ PLATFORMS
 
 DEPENDENCIES
   addressable
+  coderay
   excon
   minitest-reporters
   rake

data/example/example.rb

@@ -1,7 +1,7 @@
 require 'looksee'
 require 'net/http'
 
-require './websocket-client'
+require_relative '../lib/waithook/websocket_client'
 
 HOST = 'localhost'
 PORT = 3012

data/example/real_server_test.rb

@@ -1,7 +1,7 @@
 require 'looksee'
 require 'excon'
 
-require './websocket-client'
+require_relative '../lib/waithook/websocket_client'
 
 #HOST = 'localhost'
 #PORT = 3012

data/example/waithook_example.rb

@@ -1,7 +1,7 @@
-require_relative './waithook'
+require_relative '../lib/waithook'
 require 'excon'
 
-waithook = Waithook.subscribe('my-super-test', host: 'localhost', port: 3012)
+waithook = Waithook.subscribe(path: 'my-super-test', host: 'localhost', port: 3012)
 
 Excon.post('http://localhost:3012/my-super-test', body: Time.now.to_s)
 

data/lib/waithook/version.rb

@@ -1,3 +1,3 @@
 class Waithook
-  VERSION = "0.4.1"
+  VERSION = "0.4.3"
 end

data/lib/waithook/websocket_client.rb

@@ -79,7 +79,7 @@ class Waithook
       end
     end
 
-    # Estabilish connection to server and send initial handshake
+    # Establish connection to server and send initial handshake
     def connect!
       logger.info "Connecting to #{@host} #{@port}"
 
@@ -118,7 +118,7 @@ class Waithook
     def _start_parser!
       @reader, @writter = IO.pipe
       @processing_thread = Thread.new do
-        Thread.current.abort_on_exception = true
+        # Thread.current.abort_on_exception = true
         begin
           logger.debug "Start reading in thread"
           handshake_response = _wait_handshake_response
@@ -129,8 +129,14 @@ class Waithook
           _handshake_recieved!
           _wait_frames!
         rescue Object => error
+          # if got error - close socket and end thread
+          # @last_connection_error will be detected in #wait_message and raised to caller thread,
+          # so caller can decide to reconnect or do something else
+          @last_connection_error = error
+          close!(send_close: false, kill_processing_thread: false) rescue nil
+          @messages.close
+
           logger.error "#{error.class}: #{error.message}\n#{error.backtrace.join("\n")}"
-          raise error
         end
       end
     end
@@ -150,7 +156,7 @@ class Waithook
       _send_frame(:text, payload)
     end
 
-    # Wait for new message (thread safe, all waiting threads will recieve a message)
+    # Wait for new message (thread safe, all waiting threads will receive a message)
     # Message format [type, data], e.g. <tt>[:text, "hello world"]</tt>
     def wait_new_message
       waiter = Waiter.new
@@ -158,14 +164,27 @@ class Waithook
       waiter.wait
     end
 
-    # Synchroniously waiting for new message. Not thread safe, only one thread will receive message
+    # Synchronously waiting for new message. Not thread safe, only one thread will receive message
     # Message format [type, data], e.g. <tt>[:text, "hello world"]</tt>
     def wait_message
-      @messages.pop
+      begin
+        message = @messages.pop
+        if (!message || message.first == nil) && @messages.closed? && @last_connection_error
+          raise @last_connection_error
+        end
+
+        return message
+      rescue => error
+        if @last_connection_error
+          raise @last_connection_error
+        else
+          raise error
+        end
+      end
     end
 
     # Wait until server handshake recieved.
-    # Once it's recieved - we can are listening for new messages
+    # Once it's received - we can are listening for new messages
     # and connection is ready for sending data
     def wait_handshake!
       return true if @handshake_received
@@ -240,16 +259,20 @@ class Waithook
       data.join("")
     end
 
+    def socket_open?
+      @socket && !@socket.closed?
+    end
+
     # Send <tt>:close</tt> message to socket and close socket connection
-    def close!(options = {send_close: true})
+    def close!(send_close: true, kill_processing_thread: true)
       unless @is_open
         logger.info "Already closed"
         return false
       end
 
       logger.info "Disconnecting from #{@host} #{@port}"
-      @processing_thread.kill
-      _send_frame(:close) if options[:send_close]
+      @processing_thread.kill if kill_processing_thread
+      _send_frame(:close) if send_close
       @socket.close
       @is_open = false
 

data/lib/waithook.rb

@@ -118,7 +118,11 @@ class Waithook
         client.ping_sender
         logger.debug("Exit ping sender thread")
       rescue => error
-        logger.warn("Error in ping sender thread: #{error.message} (#{error.class})\n#{error.backtrace.join("\n")}")
+        if error.message == "closed stream" && !@client.socket_open?
+          logger.debug("Connection closed, stopping ping sender thread")
+        else
+          logger.warn("Error in ping sender thread: #{error.message} (#{error.class})\n#{error.backtrace.join("\n")}")
+        end
       end
     end
   end
@@ -146,7 +150,11 @@ class Waithook
     Timeout.timeout(timeout) do
       while true
         _, data = @client.wait_message
-        webhook = Webhook.new(data, logger)
+        webhook = Webhook.new(
+          data,
+          logger: logger,
+          forward_options: (options[:forward_options] || {}).merge(@options[:forward_options] || {})
+        )
         if @filter && @filter.call(webhook) || !@filter
           @messages << webhook
           return webhook
@@ -180,7 +188,7 @@ class Waithook
     # Raw message from waithook server
     attr_reader :message
 
-    def initialize(payload, logger = nil)
+    def initialize(payload, logger: nil, forward_options: {})
       @message = payload
       data = JSON.parse(@message)
       @url = data['url']
@@ -188,9 +196,17 @@ class Waithook
       @body = data['body']
       @method = data['method']
       @logger = logger
+      @forward_options = forward_options
     end
 
-    def pretty_print
+    def pretty_print(pp_arg = nil, *args)
+      return super if pp_arg && defined?(super) # method from 'pp' library has same name
+
+      if !@body
+        @logger&.debug("Error: Waithook::Webhook has no @body")
+        return @message
+      end
+
       if @body.start_with?('{') && @body.end_with?('}') || @body.start_with?('[') && @body.end_with?(']')
         begin
           body_data = JSON.parse(body)
@@ -202,15 +218,15 @@ class Waithook
             require 'coderay'
             pretty_body = CodeRay.scan(pretty_body, :json).term
           rescue => error
-            logger&.debug("Error while trying to use CodeRay: #{error.message}")
+            @logger&.debug("Error while trying to use CodeRay: #{error.message}")
           end
           return "#{JSON.pretty_generate(data_without_body)}\nBody:\n#{pretty_body}"
         rescue JSON::ParserError => error
-          logger&.debug("Error while parsing json body: #{error.message}")
+          @logger&.debug("Error while parsing json body: #{error.message}")
         end
       end
 
-      return message
+      return @message
     end
 
     # Returns Hash.
@@ -232,7 +248,8 @@ class Waithook
       uri = URI.parse(url)
       response = nil
 
-      Net::HTTP.start(uri.host, uri.port, use_ssl: uri.scheme == 'https') do |http|
+      http_options = {use_ssl: uri.scheme == 'https'}.merge(@forward_options || {})
+      Net::HTTP.start(uri.host, uri.port, http_options) do |http|
         http_klass = case method
           when "GET"    then Net::HTTP::Get
           when "POST"   then Net::HTTP::Post
@@ -263,3 +280,4 @@ class Waithook
     end
   end
 end
+

data/tests/waithook_test.rb

@@ -55,6 +55,20 @@ describe "Waithook" do
     assert_equal("POST", webhook.method)
   end
 
+  it "should use forward_options in request" do
+    waithook = default_client(forward_options: {write_timeout: :aaa, local_host: "--11"})
+
+    message = {'my_data' => true}
+
+    Excon.post("http://#{HOST}:#{PORT}/my-super-test", body: JSON.generate(message))
+
+    forward_error = begin
+      waithook.forward_to("http://#{HOST}:#{PORT}/my-super-test2")
+    rescue => e; e end
+    assert_equal(forward_error.class, Socket::ResolutionError)
+    assert_includes(forward_error.message, "getaddrinfo: nodename nor servname provided, or not known")
+  end
+
   it "should have trace log level" do
     out, err = capture_io do
       default_client(logger_level: :trace, logger: true)
@@ -96,4 +110,20 @@ describe "Waithook" do
 
     assert_includes(out, "Timeout::Error: execution expired")
   end
+
+  it "should throw exception when got socket error" do
+    waithook = default_client(logger: true)
+    socket = waithook.client.instance_variable_get(:@socket)
+    socket.close
+
+    captured_error = nil
+    begin
+      waithook.wait_message(raise_on_timeout: false)
+    rescue => error
+      captured_error = error
+    end
+
+    assert_instance_of(IOError, captured_error)
+    assert_equal("stream closed in another thread", captured_error.message)
+  end
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: waithook
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.4.3
 platform: ruby
 authors:
 - Pavel Evstigneev
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-10-22 00:00:00.000000000 Z
+date: 2025-03-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: websocket
@@ -55,7 +54,6 @@ homepage: https://github.com/paxa/waithook-ruby
 licenses:
 - MIT
 metadata: {}
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -70,8 +68,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.11
-signing_key:
+rubygems_version: 3.6.5
 specification_version: 4
 summary: HTTP to WebSocket transmitting client
 test_files: []