fbe 0.16.1 → 0.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 011c5a07ab2d1b15194cd2950da1cd466698d37a9aa0bbd07225ce7bca335881
-  data.tar.gz: 1fa420cebbdc70897a4779601a5cc8e4596a9542a223e64e020086ff0ec10826
+  metadata.gz: 7f70d456f08cfacd13990d45fd62834c1856260dd096583909fe4aa2b113f080
+  data.tar.gz: edd2a32689116bf7ae2940458f2e77cf6d33027097e3a01985af685d78f666b4
 SHA512:
-  metadata.gz: 1790fa88d1d97b8509d61c85592c36ca5147e97e982015991fc15128315a210190505310cf1d53b618507b354e1b77b065bbc1cbfff4b8ffc771f50bea5778fa
-  data.tar.gz: 4bf95961acba3192c824e48054c8a36d7aa72184645305c8fcc6ef9e5926cd08c7f661353bc6244b8e789b1fb5ea2e4dcf8a089969267bc55b80fdf9b641b775
+  metadata.gz: 5a5371878121330954776a6fc2d7cc32ef4207afd7c6e73b8ac4399c6af222abbfda3afd7d2636eadb7bf3f305984ed547d755666e02d38d3a54c0479c289e15
+  data.tar.gz: 76cf0627e9c1bd78b9ad1e348ff5c6fce2f0c9e8374d2a0b09ae93c1b4faa27b240446f30abb1fb7821bcf5c18b5bd118b7f54d3615843773ebe3b1edcbca4c8

data/.gitignore

@@ -8,3 +8,4 @@ doc/
 node_modules/
 rdoc/
 vendor/
+.claude/

data/.rubocop.yml

@@ -14,6 +14,8 @@ plugins:
   - rubocop-minitest
   - rubocop-performance
   - rubocop-rake
+Minitest/MultipleAssertions:
+  Max: 10
 Minitest/EmptyLineBeforeAssertionMethods:
   Enabled: false
 Style/GlobalVars:
@@ -54,4 +56,3 @@ Metrics/ParameterLists:
   Enabled: false
 Layout/MultilineAssignmentLayout:
   Enabled: true
-require: []

data/Rakefile

@@ -16,7 +16,7 @@ def version
   Gem::Specification.load(Dir['*.gemspec'].first).version
 end
 
-task default: %i[clean test picks rubocop yard]
+task default: %i[clean test rubocop picks yard]
 
 require 'rake/testtask'
 desc 'Run all unit tests'

data/lib/fbe/middleware/trace.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+# SPDX-FileCopyrightText: Copyright (c) 2024-2025 Zerocracy
+# SPDX-License-Identifier: MIT
+
+require 'faraday'
+require_relative '../../fbe'
+require_relative '../../fbe/middleware'
+
+# Faraday middleware that traces all API calls.
+#
+# This middleware records all HTTP requests and responses in a trace array,
+# capturing method, URL, status, and timing information for debugging and
+# monitoring purposes.
+#
+# @example Usage in Faraday middleware stack
+#   trace = []
+#   connection = Faraday.new do |f|
+#     f.use Fbe::Middleware::Trace, trace
+#   end
+#   connection.get('/api/endpoint')
+#   trace.first[:method] #=> :get
+#   trace.first[:url] #=> 'https://example.com/api/endpoint'
+#   trace.first[:status] #=> 200
+#
+# Author:: Yegor Bugayenko (yegor256@gmail.com)
+# Copyright:: Copyright (c) 2024-2025 Zerocracy
+# License:: MIT
+class Fbe::Middleware::Trace < Faraday::Middleware
+  # Initializes the trace middleware.
+  #
+  # @param [Object] app The next middleware in the stack
+  # @param [Array] trace The array to store trace entries
+  def initialize(app, trace)
+    super(app)
+    @trace = trace
+  end
+
+  # Processes the HTTP request and records trace information.
+  #
+  # @param [Faraday::Env] env The request environment
+  # @return [Faraday::Response] The response from the next middleware
+  def call(env)
+    started = Time.now
+    entry = {
+      method: env.method,
+      url: env.url.to_s,
+      started_at: started
+    }
+    @app.call(env).on_complete do |response_env|
+      finished = Time.now
+      entry[:status] = response_env.status
+      entry[:finished_at] = finished
+      entry[:duration] = finished - started
+      @trace << entry
+    end
+  end
+end

data/lib/fbe/octo.rb

@@ -9,10 +9,12 @@ require 'faraday/retry'
 require 'loog'
 require 'obk'
 require 'octokit'
+require 'uri'
 require 'verbose'
 require_relative '../fbe'
 require_relative 'middleware'
 require_relative 'middleware/formatter'
+require_relative 'middleware/trace'
 
 # Makes a call to the GitHub API.
 #
@@ -30,6 +32,7 @@ def Fbe.octo(options: $options, global: $global, loog: $loog)
   raise 'The $loog is not set' if loog.nil?
   global[:octo] ||=
     begin
+      trace = []
       if options.testing.nil?
         o = Octokit::Client.new
         token = options.github_token
@@ -50,8 +53,10 @@ def Fbe.octo(options: $options, global: $global, loog: $loog)
           loog.warn('The GitHub API token is an empty string, won\'t use it')
         else
           o = Octokit::Client.new(access_token: token)
-          loog.info("Accessing GitHub API with a token (#{token.length} chars, ending by #{token[-4..].inspect}, " \
-                    "#{Octokit::Client.new(access_token: token).rate_limit.remaining} quota remaining)")
+          loog.info(
+            "Accessing GitHub API with a token (#{token.length} chars, ending by #{token[-4..].inspect}, " \
+            "#{Octokit::Client.new(access_token: token).rate_limit.remaining} quota remaining)"
+          )
         end
         o.auto_paginate = true
         o.per_page = 100
@@ -76,6 +81,7 @@ def Fbe.octo(options: $options, global: $global, loog: $loog)
             builder.use(Faraday::HttpCache, serializer: Marshal, shared_cache: false, logger: Loog::NULL)
             builder.use(Octokit::Response::RaiseError)
             builder.use(Faraday::Response::Logger, loog, formatter: Fbe::Middleware::Formatter)
+            builder.use(Fbe::Middleware::Trace, trace)
             builder.adapter(Faraday.default_adapter)
           end
         o.middleware = stack
@@ -84,7 +90,25 @@ def Fbe.octo(options: $options, global: $global, loog: $loog)
         loog.debug('The connection to GitHub API is mocked')
         o = Fbe::FakeOctokit.new
       end
-      decoor(o, loog:) do
+      decoor(o, loog:, trace:) do
+        def print_trace!
+          if @trace.empty?
+            @loog.debug('GitHub API trace is empty')
+          else
+            grouped =
+              @trace.group_by do |entry|
+                uri = URI.parse(entry[:url])
+                "#{uri.scheme}://#{uri.host}#{uri.path}"
+              end
+            message = grouped
+              .sort_by { |_path, entries| -entries.count }
+              .map { |path, entries| "  #{path}: #{entries.count}" }
+              .join("\n")
+            @loog.info("GitHub API trace (#{grouped.count} URLs vs #{@trace.count} requests):\n#{message}")
+            @trace.clear
+          end
+        end
+
         def off_quota(threshold: 50)
           left = @origin.rate_limit.remaining
           if left < threshold

data/lib/fbe.rb

@@ -10,5 +10,5 @@
 # License:: MIT
 module Fbe
   # Current version of the gem (changed by +.rultor.yml+ on every release)
-  VERSION = '0.16.1' unless const_defined?(:VERSION)
+  VERSION = '0.17.0' unless const_defined?(:VERSION)
 end

data/test/fbe/middleware/test_trace.rb

@@ -0,0 +1,106 @@
+# frozen_string_literal: true
+
+# SPDX-FileCopyrightText: Copyright (c) 2024-2025 Zerocracy
+# SPDX-License-Identifier: MIT
+
+require 'faraday'
+require 'webmock'
+require_relative '../../test__helper'
+require_relative '../../../lib/fbe'
+require_relative '../../../lib/fbe/middleware'
+require_relative '../../../lib/fbe/middleware/trace'
+
+# Test.
+# Author:: Yegor Bugayenko (yegor256@gmail.com)
+# Copyright:: Copyright (c) 2024-2025 Zerocracy
+# License:: MIT
+class TraceTest < Fbe::Test
+  def test_traces_successful_request
+    trace = []
+    stub_request(:get, 'http://example.com/test')
+      .to_return(status: 200, body: 'success')
+    conn =
+      Faraday.new do |f|
+        f.use Fbe::Middleware::Trace, trace
+        f.adapter :net_http
+      end
+    conn.get('http://example.com/test')
+    assert_equal 1, trace.size
+    entry = trace.first
+    assert_equal :get, entry[:method]
+    assert_equal 'http://example.com/test', entry[:url]
+    assert_equal 200, entry[:status]
+    assert_instance_of Time, entry[:started_at]
+    assert_instance_of Time, entry[:finished_at]
+    assert_instance_of Float, entry[:duration]
+    assert_operator entry[:duration], :>=, 0
+    assert_operator entry[:finished_at], :>=, entry[:started_at]
+  end
+
+  def test_traces_multiple_requests
+    trace = []
+    stub_request(:get, 'http://example.com/endpoint1').to_return(status: 200)
+    stub_request(:post, 'http://example.com/endpoint2').to_return(status: 201)
+    stub_request(:delete, 'http://example.com/endpoint3').to_return(status: 404)
+    conn =
+      Faraday.new do |f|
+        f.use Fbe::Middleware::Trace, trace
+        f.adapter :net_http
+      end
+    conn.get('http://example.com/endpoint1')
+    conn.post('http://example.com/endpoint2')
+    conn.delete('http://example.com/endpoint3')
+    assert_equal 3, trace.size
+    assert_equal :get, trace[0][:method]
+    assert_equal 200, trace[0][:status]
+    assert_equal :post, trace[1][:method]
+    assert_equal 201, trace[1][:status]
+    assert_equal :delete, trace[2][:method]
+    assert_equal 404, trace[2][:status]
+  end
+
+  def test_traces_error_responses
+    trace = []
+    stub_request(:get, 'http://example.com/error').to_return(status: 500, body: 'error')
+    conn =
+      Faraday.new do |f|
+        f.use Fbe::Middleware::Trace, trace
+        f.adapter :net_http
+      end
+    conn.get('http://example.com/error')
+    assert_equal 1, trace.size
+    entry = trace.first
+    assert_equal 500, entry[:status]
+    assert_equal 'http://example.com/error', entry[:url]
+  end
+
+  def test_handles_connection_errors
+    trace = []
+    stub_request(:get, 'http://example.com/timeout').to_timeout
+    conn =
+      Faraday.new do |f|
+        f.use Fbe::Middleware::Trace, trace
+        f.adapter :net_http
+      end
+    assert_raises(Faraday::ConnectionFailed) do
+      conn.get('http://example.com/timeout')
+    end
+    assert_equal 0, trace.size
+  end
+
+  def test_preserves_request_with_query_params
+    trace = []
+    stub_request(:get, 'http://example.com/search').with(query: { 'q' => 'test', 'page' => '2' }).to_return(status: 200)
+    conn =
+      Faraday.new do |f|
+        f.use Fbe::Middleware::Trace, trace
+        f.adapter :net_http
+      end
+    conn.get('http://example.com/search?q=test&page=2')
+    assert_equal 1, trace.size
+    url = trace.first[:url]
+    assert url.start_with?('http://example.com/search?')
+    assert_includes url, 'q=test'
+    assert_includes url, 'page=2'
+  end
+end

data/test/fbe/test_octo.rb

@@ -322,4 +322,48 @@ class TestOcto < Fbe::Test
       }
     end
   end
+
+  def test_print_trace
+    loog = Loog::Buffer.new
+    WebMock.disable_net_connect!
+    stub_request(:get, 'https://api.github.com/user/123').to_return(
+      status: 200,
+      body: '{"id":123,"login":"test"}'
+    )
+    stub_request(:get, 'https://api.github.com/repos/foo/bar').to_return(
+      status: 200,
+      body: '{"id":456,"full_name":"foo/bar"}'
+    )
+    octo = Fbe.octo(loog:, global: {}, options: Judges::Options.new)
+    octo.user(123)
+    octo.repository('foo/bar')
+    octo.repository('foo/bar')
+    octo.print_trace!
+    output = loog.to_s
+    assert_includes output, 'GitHub API trace (2 URLs vs 3 requests)'
+    assert_includes output, 'https://api.github.com/user/123: 1'
+    assert_includes output, 'https://api.github.com/repos/foo/bar: 2'
+    repo_index = output.index('https://api.github.com/repos/foo/bar: 2')
+    user_index = output.index('https://api.github.com/user/123: 1')
+    assert_operator repo_index, :<, user_index, 'URLs should be sorted by request count (highest first)'
+  end
+
+  def test_trace_gets_cleared_after_print
+    WebMock.disable_net_connect!
+    stub_request(:get, 'https://api.github.com/user/456').to_return(
+      status: 200,
+      body: '{"id":456,"login":"testuser"}'
+    )
+    first_loog = Loog::Buffer.new
+    octo = Fbe.octo(loog: first_loog, global: {}, options: Judges::Options.new)
+    octo.user(456)
+    octo.print_trace!
+    first_output = first_loog.to_s
+    assert_includes first_output, 'GitHub API trace'
+    second_loog = Loog::Buffer.new
+    octo.instance_variable_set(:@loog, second_loog)
+    octo.print_trace!
+    second_output = second_loog.to_s
+    assert_includes second_output, 'GitHub API trace is empty'
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fbe
 version: !ruby/object:Gem::Version
-  version: 0.16.1
+  version: 0.17.0
 platform: ruby
 authors:
 - Yegor Bugayenko
@@ -307,6 +307,7 @@ files:
 - lib/fbe/just_one.rb
 - lib/fbe/middleware.rb
 - lib/fbe/middleware/formatter.rb
+- lib/fbe/middleware/trace.rb
 - lib/fbe/octo.rb
 - lib/fbe/overwrite.rb
 - lib/fbe/pmp.rb
@@ -318,6 +319,7 @@ files:
 - renovate.json
 - rules/basic.fe
 - test/fbe/middleware/test_formatter.rb
+- test/fbe/middleware/test_trace.rb
 - test/fbe/test_award.rb
 - test/fbe/test_bylaws.rb
 - test/fbe/test_conclude.rb