faraday: Add logging formatter signatures (#1037)

Author: rossta

gems/faraday/2.5/_test/test_logging_formatter.rb

@@ -0,0 +1,22 @@
+class MyFormatter < Faraday::Logging::Formatter
+  def request(env)
+    # Build a custom message using `env`
+    info('Request') { 'Sending Request' }
+  end
+
+  def response(env)
+    # Build a custom message using `env`
+    info('Response') { 'Response Received' }
+  end
+
+  def exception(exc)
+    # Build a custom message using `exc`
+    info('Error') { 'Error Raised' }
+  end
+end
+
+conn = Faraday.new(url: 'http:///example.com') do |faraday|
+  faraday.response :logger, nil, formatter: MyFormatter
+end
+
+conn.get('/abc')

gems/faraday/2.5/_test/test_logging_formatter.rbs

@@ -0,0 +1,5 @@
+class MyFormatter < Faraday::Logging::Formatter
+  def request: (Faraday::Env env) -> void
+  def response: (Faraday::Env env) -> void
+  def exception: (untyped exc) -> void
+end

gems/faraday/2.5/faraday.rbs

@@ -225,6 +225,12 @@ module Faraday
   end
 
   class Response
+    class Logger < Middleware
+      def initialize: (untyped app, ?untyped logger, ?::Hash[Symbol, untyped] options) ?{ (Logging::Formatter formatter) -> void } -> void
+      def call: (Env env) -> untyped
+      def on_complete: (Env env) -> void
+    end
+
     def status: () -> Integer
     def headers: () -> untyped
     def body: () -> String
@@ -264,6 +270,42 @@ module Faraday
     def close: () -> void
   end
 
+  module Logging
+    class Formatter
+      extend Forwardable
+
+      DEFAULT_OPTIONS: ::Hash[Symbol, untyped]
+
+      @logger: untyped
+      @options: ::Hash[Symbol, untyped]
+      @filter: ::Array[[untyped, untyped]]
+
+      def initialize: (logger: untyped, options: ::Hash[Symbol, untyped]) -> void
+
+      def debug: (?untyped progname) ?{ () -> untyped } -> untyped
+      def info: (?untyped progname) ?{ () -> untyped } -> untyped
+      def warn: (?untyped progname) ?{ () -> untyped } -> untyped
+      def error: (?untyped progname) ?{ () -> untyped } -> untyped
+      def fatal: (?untyped progname) ?{ () -> untyped } -> untyped
+
+      def request: (Env env) -> void
+      def response: (Env env) -> void
+      def filter: (untyped filter_word, untyped filter_replacement) -> void
+
+      private
+
+      def dump_headers: (untyped headers) -> String
+      def dump_body: (untyped body) -> String
+      def pretty_inspect: (untyped body) -> String
+      def log_headers?: (String | Symbol type) -> boolish
+      def log_body?: (String | Symbol type) -> boolish
+      def apply_filters: (untyped output) -> String
+      def log_level: () -> Symbol
+      def log_headers: (String type, untyped headers) -> untyped
+      def log_body: (String type, untyped body) -> untyped
+    end
+  end
+
   module MiddlewareRegistry
     def registered_middleware: () -> Hash[Symbol, untyped]
     def register_middleware: (**untyped mappings) -> void
@@ -329,5 +371,8 @@ module Faraday
     attr_accessor response_body: untyped
 
     alias body request_body
+
+    def []: (untyped key) -> untyped
+    def []=: (untyped key, untyped value) -> untyped
   end
 end

gems/faraday/2.7/_test/test_logging_formatter.rb

@@ -0,0 +1,22 @@
+class MyFormatter < Faraday::Logging::Formatter
+  def exception(exc)
+    # Build a custom message using `exc`
+    info('Error') { 'Error Raised' }
+  end
+
+  def dump_nil_headers
+    dump_headers(nil)
+  end
+end
+
+conn = Faraday.new(url: 'http:///example.com') do |faraday|
+  faraday.response :logger, nil, formatter: MyFormatter, errors: true
+end
+
+conn.get('/abc')
+
+formatter = MyFormatter.new(logger: Object.new, options: {})
+formatter.dump_nil_headers
+
+logger = Faraday::Response::Logger.new(Object.new)
+logger.on_error(StandardError.new('boom'))

gems/faraday/2.7/_test/test_logging_formatter.rbs

@@ -0,0 +1,4 @@
+class MyFormatter < Faraday::Logging::Formatter
+  def exception: (untyped exc) -> void
+  def dump_nil_headers: () -> nil
+end

gems/faraday/2.7/faraday-2.7.rbs

@@ -1,4 +1,22 @@
 module Faraday
   class TooManyRequestsError < ClientError
   end
+
+  class Response
+    class Logger
+      def on_error: (untyped exc) -> void
+    end
+  end
+
+  module Logging
+    class Formatter
+      def exception: (untyped exc) -> void
+
+      private
+
+      def dump_headers: (nil headers) -> nil
+                      | ...
+      def log_errors?: () -> boolish
+    end
+  end
 end