add log method as a mixin

lib/httpx.rb

@@ -4,6 +4,7 @@ require "httpx/version"
 
 require "httpx/errors"
 require "httpx/callbacks"
+require "httpx/loggable"
 require "httpx/registry"
 require "httpx/transcoder"
 require "httpx/options"

lib/httpx/channel.rb

@@ -31,6 +31,8 @@ module HTTPX
   class Channel
     extend Forwardable
     include Registry
+    include Loggable
+
     require "httpx/channel/http2"
     require "httpx/channel/http1"
 
@@ -156,10 +158,5 @@ module HTTPX
         @parser
       end
     end
-    
-    def log(&msg)
-      return unless @options.debug 
-      @options.debug << (+"" << msg.call << "\n")
-    end
   end
 end

lib/httpx/channel/http1.rb

@@ -5,6 +5,7 @@ require "http_parser"
 module HTTPX
   class Channel::HTTP1
     include Callbacks
+    include Loggable
 
     CRLF = "\r\n"
 
@@ -164,12 +165,6 @@ module HTTPX
     def capitalized(field)
       field.to_s.split("-").map(&:capitalize).join("-")
     end
-
-    def log(level=@options.debug_level, &msg)
-      return unless @options.debug
-      return unless @options.debug_level >= level 
-      @options.debug << (+"" << msg.call << "\n")
-    end
   end
   Channel.register "http/1.1", Channel::HTTP1
 end

lib/httpx/channel/http2.rb

@@ -5,6 +5,7 @@ require "http/2"
 module HTTPX
   class Channel::HTTP2
     include Callbacks
+    include Loggable
 
     def initialize(buffer, options)
       @options = Options.new(options)
@@ -42,13 +43,14 @@ module HTTPX
           end
           response = request.response || ErrorResponse.new(error, retries)
           emit(:response, request, response)
-          log(stream.id, 2) { "closing stream" }
+          log(2, "#{stream.id}: ") { "closing stream" }
+
 
           @streams.delete(request)
           send(@pending.shift) unless @pending.empty?
         end
         stream.on(:half_close) do
-          log(stream.id, 2) { "waiting for response..." }
+          log(2, "#{stream.id}: ") { "waiting for response..." }
         end
         # stream.on(:altsvc)
         stream.on(:headers) do |h|
@@ -62,8 +64,8 @@ module HTTPX
           @streams[request] = stream 
         end
         stream.on(:data) do |data|
-          log(stream.id) { "<- DATA: #{data.bytesize} bytes..." }
-          log(stream.id, 2) { "<- #{data.inspect}" }
+          log(1, "#{stream.id}: ") { "<- DATA: #{data.bytesize} bytes..." }
+          log(2, "#{stream.id}: ") { "<- #{data.inspect}" }
           request.response << data
         end
         @streams[request] = stream
@@ -125,7 +127,7 @@ module HTTPX
       headers[":path"]      = headline_uri(request)
       headers[":authority"] = request.authority 
       headers = headers.merge(request.headers)
-      log(stream.id) do
+      log(1, "#{stream.id}: ") do
         headers.map { |k, v| "-> HEADER: #{k}: #{v}" }.join("\n")
       end
       stream.headers(headers, end_stream: request.empty?)
@@ -135,8 +137,8 @@ module HTTPX
       chunk = @drains.delete(request) || request.drain_body
       while chunk
         next_chunk = request.drain_body
-        log(stream.id) { "-> DATA: #{chunk.bytesize} bytes..." }
-        log(stream.id, 2) { "-> #{chunk.inspect}" }
+        log(1, "#{stream.id}: ") { "-> DATA: #{chunk.bytesize} bytes..." }
+        log(2, "#{stream.id}: ") { "-> #{chunk.inspect}" }
         stream.data(chunk, end_stream: !next_chunk)
         if next_chunk && @buffer.full?
           @drains[request] = next_chunk
@@ -165,8 +167,8 @@ module HTTPX
     end
 
     def on_frame_sent(frame)
-      log(frame[:stream], 2) { "frame was sent!" }
-      log(frame[:stream], 2) do
+      log(2, "#{frame[:stream]}: ") { "frame was sent!" }
+      log(2, "#{frame[:stream]}: ") do
         case frame[:type]
         when :data
           frame.merge(payload: frame[:payload].bytesize).inspect
@@ -179,8 +181,8 @@ module HTTPX
     end
 
     def on_frame_received(frame)
-      log(frame[:stream], 2) { "frame was received!" }
-      log(frame[:stream], 2) do
+      log(2, "#{frame[:stream]}: ") { "frame was received!" }
+      log(2, "#{frame[:stream]}: ") do
         case frame[:type]
         when :data
           frame.merge(payload: frame[:payload].bytesize).inspect
@@ -191,22 +193,15 @@ module HTTPX
     end
 
     def on_altsvc(frame)
-      log(frame[:stream], 2) { "altsvc frame was received" }
-      log(frame[:stream], 2) { frame.inspect }
+      log(2, "#{frame[:stream]}: ") { "altsvc frame was received" }
+      log(2, "#{frame[:stream]}: ") { frame.inspect }
     end
 
     def on_promise(stream)
-      log(stream.id, 2) { "refusing stream!" }
+      log(2, "#{stream.id}: ") { "refusing stream!" }
       stream.refuse
       # TODO: policy for handling promises
     end
-
-    def log(stream=nil, level = @options.debug_level, &msg)
-      return unless @options.debug
-      return unless @options.debug_level >= level 
-      prefix =  +"connection (HTTP/2, stream: #{stream || 0}):"
-      @options.debug << (prefix << msg.call << "\n")
-    end
   end
   Channel.register "h2", Channel::HTTP2
 end

lib/httpx/io.rb

@@ -6,7 +6,8 @@ require "ipaddr"
 
 module HTTPX
   class TCP
-    
+    include Loggable
+
     attr_reader :ip, :port
 
     def initialize(hostname, port, options)
@@ -132,14 +133,9 @@ module HTTPX
       when :closed
         return unless @state == :connected
       end
-      log { nextstate.to_s }
+      log(1, "#{inspect}: ") { nextstate.to_s }
       @state = nextstate
     end
-    
-    def log(&msg)
-      return unless @options.debug 
-      @options.debug << (+"#{inspect}: " << msg.call.to_s << "\n")
-    end
   end
 
   class SSL < TCP

lib/httpx/loggable.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Loggable
+  def log(level=@options.debug_level, label="", &msg)
+    return unless @options.debug
+    return unless @options.debug_level >= level 
+    @options.debug << (+label << msg.call << "\n")
+  end
+end

lib/httpx/plugins/proxy/socks4.rb

@@ -73,12 +73,6 @@ module HTTPX
           def <<(packet)
             emit(:packet, packet)
           end
-
-          def log(level=@options.debug_level, &msg)
-            return unless @options.debug
-            return unless @options.debug_level >= level 
-            @options.debug << (+"" << msg.call << "\n")
-          end
         end
 
         module Packet

lib/httpx/plugins/proxy/socks5.rb

@@ -101,12 +101,6 @@ module HTTPX
           def <<(packet)
             emit(:packet, packet)
           end
-
-          def log(level=@options.debug_level, &msg)
-            return unless @options.debug
-            return unless @options.debug_level >= level 
-            @options.debug << (+"" << msg.call << "\n")
-          end
         end
 
         module Packet