fbe 0.23.0 → 0.23.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7faea911e89cea0abccc6d5f664a1ef5dd1ab8b6853ee0b2b6b97077c604f64d
-  data.tar.gz: 88ddb605cd24f68b965aa8ff2200c75c6759d175d130fded4f66ebb02540b00d
+  metadata.gz: ee5e623e0dd6b64525eb62f7dcad447a595c3c963c747acec37dda308cabcf98
+  data.tar.gz: c422fd60aba87180dc2ab7265abe5458928b7df765b86e7c3eaea9f8b3884c34
 SHA512:
-  metadata.gz: 283110a6a7bd12876e0f383f9d243309b0ff0e9495f0987e1e2dc3a84ce5e76e2aa44e86bafe6bcc992f1ec7eae8f36da7206d8f3b18b57320f9339fb7c781d1
-  data.tar.gz: fd3ce178823ca8e9b830b32143b80babda13d0e5f28549728ecd8d8e7635febc177b8691bd189ef9549d01a2ecf036fc9306697ff31856827ec018268338eb60
+  metadata.gz: 0fcd4bf85f7ae73caab3b4b2a834b1978c2fb4aee2c58a83fcb53098d25d6208f25f99ded13ac5efbd441d6f7eeb24f22d5c74249f802353568781d38e9e0d93
+  data.tar.gz: 3b4aab5363b741fb8f9054a32a84e008a9ad5487d8f668580cbe6d6fdbe0b447511f6c999bcad9b4d906cbd017566e50bfb31ac881c2271c793fe0ce111700b9

data/Gemfile.lock

@@ -5,6 +5,7 @@ PATH
       backtrace (~> 0.4)
       baza.rb (~> 0.5)
       decoor (~> 0.0)
+      ellipsized (~> 0.3)
       factbase (~> 0.11)
       faraday (~> 2.0)
       faraday-http-cache (~> 2.5)

data/fbe.gemspec

@@ -25,6 +25,7 @@ Gem::Specification.new do |s|
   s.add_dependency 'backtrace', '~>0.4'
   s.add_dependency 'baza.rb', '~>0.5'
   s.add_dependency 'decoor', '~>0.0'
+  s.add_dependency 'ellipsized', '~>0.3'
   s.add_dependency 'factbase', '~>0.11'
   s.add_dependency 'faraday', '~>2.0'
   s.add_dependency 'faraday-http-cache', '~>2.5'

data/lib/fbe/middleware/sqlite_store.rb

@@ -31,7 +31,6 @@ require_relative '../../fbe/middleware'
 #     loog: logger,
 #     maxsize: '50Mb'
 #   )
-#
 #   # Use with Faraday
 #   Faraday.new do |builder|
 #     builder.use Faraday::HttpCache, store: store

data/lib/fbe/middleware/trace.rb

@@ -31,9 +31,11 @@ class Fbe::Middleware::Trace < Faraday::Middleware
   #
   # @param [Object] app The next middleware in the stack
   # @param [Array] trace The array to store trace entries
-  def initialize(app, trace)
+  # @param [Boolean] all Print ALL requests, even very fast?
+  def initialize(app, trace, all: true)
     super(app)
     @trace = trace
+    @all = all
   end
 
   # Processes the HTTP request and records trace information.
@@ -41,18 +43,20 @@ class Fbe::Middleware::Trace < Faraday::Middleware
   # @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
+      started_at: Time.now
     }
     @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
+      duration = finished - entry[:started_at]
+      if duration > 0.01 || @all
+        entry[:status] = response_env.status
+        entry[:finished_at] = finished
+        entry[:duration] = duration
+        @trace << entry
+      end
     end
   end
 end

data/lib/fbe/octo.rb

@@ -3,11 +3,12 @@
 # SPDX-FileCopyrightText: Copyright (c) 2024-2025 Zerocracy
 # SPDX-License-Identifier: MIT
 
-require 'json'
 require 'decoor'
+require 'ellipsized'
 require 'faraday/http_cache'
 require 'faraday/retry'
 require 'filesize'
+require 'json'
 require 'loog'
 require 'obk'
 require 'octokit'
@@ -17,8 +18,8 @@ require 'verbose'
 require_relative '../fbe'
 require_relative 'middleware'
 require_relative 'middleware/formatter'
-require_relative 'middleware/trace'
 require_relative 'middleware/sqlite_store'
+require_relative 'middleware/trace'
 
 # Makes a call to the GitHub API.
 #
@@ -104,7 +105,7 @@ def Fbe.octo(options: $options, global: $global, loog: $loog)
             end
             builder.use(Octokit::Response::RaiseError)
             builder.use(Faraday::Response::Logger, loog, formatter: Fbe::Middleware::Formatter)
-            builder.use(Fbe::Middleware::Trace, trace)
+            builder.use(Fbe::Middleware::Trace, trace, all: false)
             builder.adapter(Faraday.default_adapter)
           end
         o.middleware = stack
@@ -128,13 +129,18 @@ def Fbe.octo(options: $options, global: $global, loog: $loog)
               grouped =
                 @trace.group_by do |entry|
                   uri = URI.parse(entry[:url])
-                  "#{uri.scheme}://#{uri.host}#{uri.path}"
+                  query = uri.query
+                  query = "?#{query.ellipsized(40)}" if query
+                  "#{uri.scheme}://#{uri.host}#{uri.path}#{query}"
                 end
               message = grouped
                 .sort_by { |_path, entries| -entries.count }
-                .map { |path, entries| "  #{path}: #{entries.count}" }
+                .map { |path, entries| "  #{path.gsub(%r{^https://api.github.com/}, '/')}: #{entries.count}" }
                 .join("\n")
-              @loog.info("GitHub API trace (#{grouped.count} URLs vs #{@trace.count} requests):\n#{message}")
+              @loog.info(
+                "GitHub API trace (#{grouped.count} URLs vs #{@trace.count} requests, " \
+                "#{@origin.rate_limit.remaining} quota left):\n#{message}"
+              )
               @trace.clear
             end
           end
@@ -689,10 +695,14 @@ class Fbe::FakeOctokit
       repo: {
         full_name: repo
       },
+      user: { login: 'yegor256', id: 526_301, type: 'User' },
+      head: { ref: 'master', sha: '6dcb09b5b57875f334f61aebed695e2e4193db5e' },
       additions: 12,
       deletions: 5,
       changed_files: 3,
-      review_comments: 2
+      comments: 2,
+      review_comments: 2,
+      created_at: Time.parse('2024-09-20 19:00:00 UTC')
     }
   end
 

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.23.0' unless const_defined?(:VERSION)
+  VERSION = '0.23.2' unless const_defined?(:VERSION)
 end

data/test/fbe/test_octo.rb

@@ -366,30 +366,66 @@ class TestOcto < Fbe::Test
     stub_request(:get, 'https://api.github.com/rate_limit').to_return(
       { body: '{}', headers: { 'X-RateLimit-Remaining' => '222' } }
     )
-    stub_request(:get, 'https://api.github.com/user/123').to_return(
-      status: 200,
-      body: '{"id":123,"login":"test"}',
-      headers: { 'X-RateLimit-Remaining' => '222' }
-    )
-    stub_request(:get, 'https://api.github.com/repos/foo/bar').to_return(
-      status: 200,
-      body: '{"id":456,"full_name":"foo/bar"}',
-      headers: { 'X-RateLimit-Remaining' => '222' }
-    )
+    stub_request(:get, 'https://api.github.com/user/123').to_return do
+      sleep(0.02)
+      {
+        status: 200,
+        body: '{"id":123,"login":"test"}',
+        headers: { 'X-RateLimit-Remaining' => '222' }
+      }
+    end
+    stub_request(:get, 'https://api.github.com/repos/foo/bar').to_return do
+      sleep(0.02)
+      {
+        status: 200,
+        body: '{"id":456,"full_name":"foo/bar"}',
+        headers: { 'X-RateLimit-Remaining' => '222' }
+      }
+    end
     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 (3 URLs vs 4 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_includes output, '2 URLs vs 3 requests'
+    assert_includes output, '222 quota left'
+    assert_includes output, '/user/123: 1'
+    assert_includes output, '/repos/foo/bar: 2'
+    repo_index = output.index('/repos/foo/bar: 2')
+    user_index = output.index('/user/123: 1')
     assert_operator repo_index, :<, user_index, 'URLs should be sorted by request count (highest first)'
   end
 
+  def test_prints_only_real_requests
+    WebMock.disable_net_connect!
+    stub_request(:get, 'https://api.github.com/rate_limit').to_return(
+      { body: '{}', headers: { 'X-RateLimit-Remaining' => '222' } }
+    )
+    stub = stub_request(:get, 'https://api.github.com/user/123').to_return(
+      status: 200,
+      body: '{"id":123,"login":"test"}',
+      headers: {
+        'X-RateLimit-Remaining' => '222',
+        'Content-Type' => 'application/json',
+        'Cache-Control' => 'public, max-age=60, s-maxage=60',
+        'Etag' => 'W/"2ff9dd4c3153f006830b2b8b721f6a4bb400a1eb81a2e1fa0a3b846ad349b9ec"',
+        'Last-Modified' => 'Wed, 01 May 2025 20:00:00 GMT'
+      }
+    )
+    Dir.mktmpdir do |dir|
+      fcache = File.expand_path('test.db', dir)
+      octo = Fbe.octo(loog: Loog::NULL, global: {}, options: Judges::Options.new({ 'sqlite_cache' => fcache }))
+      octo.user(123)
+      loog = Loog::Buffer.new
+      octo = Fbe.octo(loog: fake_loog, global: {}, options: Judges::Options.new({ 'sqlite_cache' => fcache }))
+      WebMock.remove_request_stub(stub)
+      octo.user(123)
+      octo.print_trace!
+      assert_empty(loog.to_s)
+    end
+  end
+
   def test_trace_gets_cleared_after_print
     WebMock.disable_net_connect!
     stub_request(:get, 'https://api.github.com/rate_limit').to_return(
@@ -414,9 +450,8 @@ class TestOcto < Fbe::Test
       { body: '{}', headers: { 'X-RateLimit-Remaining' => '222' } }
     )
     Dir.mktmpdir do |dir|
-      global = {}
       sqlite_cache = File.expand_path('test.db', dir)
-      o = Fbe.octo(loog: Loog::NULL, global:, options: Judges::Options.new({ 'sqlite_cache' => sqlite_cache }))
+      o = Fbe.octo(loog: Loog::NULL, global: {}, options: Judges::Options.new({ 'sqlite_cache' => sqlite_cache }))
       stub = stub_request(:get, 'https://api.github.com/user/42').to_return(
         status: 200,
         body: { login: 'user1' }.to_json,
@@ -429,8 +464,7 @@ class TestOcto < Fbe::Test
       )
       assert_equal('user1', o.user_name_by_id(42))
       WebMock.remove_request_stub(stub)
-      global = {}
-      o = Fbe.octo(loog: Loog::NULL, global:, options: Judges::Options.new({ 'sqlite_cache' => sqlite_cache }))
+      o = Fbe.octo(loog: Loog::NULL, global: {}, options: Judges::Options.new({ 'sqlite_cache' => sqlite_cache }))
       assert_equal('user1', o.user_name_by_id(42))
     end
   end
@@ -441,10 +475,9 @@ class TestOcto < Fbe::Test
       { body: '{}', headers: { 'X-RateLimit-Remaining' => '222' } }
     )
     Dir.mktmpdir do |dir|
-      global = {}
       file = File.expand_path('test.db', dir)
       stub_request(:get, 'https://api.github.com/user/4242').to_return(status: 401)
-      o = Fbe.octo(loog: Loog::NULL, global:, options: Judges::Options.new({ 'sqlite_cache' => file }))
+      o = Fbe.octo(loog: Loog::NULL, global: {}, options: Judges::Options.new({ 'sqlite_cache' => file }))
       assert_raises(StandardError) do
         assert_equal('user1', o.user_name_by_id(4242))
       end
@@ -458,7 +491,6 @@ class TestOcto < Fbe::Test
       { body: '{}', headers: { 'X-RateLimit-Remaining' => '222' } }
     )
     Dir.mktmpdir do |dir|
-      global = {}
       stub =
         stub_request(:get, 'https://api.github.com/user/42')
           .to_return(
@@ -473,7 +505,7 @@ class TestOcto < Fbe::Test
           )
       sqlite_cache = File.expand_path('test.db', dir)
       Fbe.stub_const(:VERSION, '0.0.1') do
-        o = Fbe.octo(loog: Loog::NULL, global:, options: Judges::Options.new({ 'sqlite_cache' => sqlite_cache }))
+        o = Fbe.octo(loog: Loog::NULL, global: {}, options: Judges::Options.new({ 'sqlite_cache' => sqlite_cache }))
         assert_equal('user1', o.user_name_by_id(42))
       end
       WebMock.remove_request_stub(stub)
@@ -488,9 +520,8 @@ class TestOcto < Fbe::Test
             'Last-Modified' => 'Wed, 01 May 2025 20:00:00 GMT'
           }
         )
-      global = {}
       Fbe.stub_const(:VERSION, '0.0.2') do
-        o = Fbe.octo(loog: Loog::NULL, global:, options: Judges::Options.new({ 'sqlite_cache' => sqlite_cache }))
+        o = Fbe.octo(loog: Loog::NULL, global: {}, options: Judges::Options.new({ 'sqlite_cache' => sqlite_cache }))
         assert_equal('user2', o.user_name_by_id(42))
       end
     end

data/test/test__helper.rb

@@ -40,6 +40,6 @@ require_relative '../lib/fbe'
 # Parent class for all tests.
 class Fbe::Test < Minitest::Test
   def fake_loog
-    Loog::VERBOSE
+    Loog::NULL
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fbe
 version: !ruby/object:Gem::Version
-  version: 0.23.0
+  version: 0.23.2
 platform: ruby
 authors:
 - Yegor Bugayenko
@@ -51,6 +51,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.0'
+- !ruby/object:Gem::Dependency
+  name: ellipsized
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
 - !ruby/object:Gem::Dependency
   name: factbase
   requirement: !ruby/object:Gem::Requirement