fbe 0.23.6 → 0.23.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bed0dbc2fe40503e276fad9620585658b3781cc02ce1fd171136ec9cae18bb67
-  data.tar.gz: 7ff721a9a5550eb960e4f98be1148b68e67a0198f821ba7485683022b0af2d1c
+  metadata.gz: 36afd4e19f2a84e050e41ba6395a35cbc1bd404c8f6c1971affd64aa4c9c9e27
+  data.tar.gz: 904a216825c9bb411036db7c2486e492a6a58ca6b77f26b05f39c37cae377867
 SHA512:
-  metadata.gz: 6f9a87c2d309bd1806aff0184d1173f903b8e5612b6564de1e7b1a4fa9c932c88793f294e33a341255d810095a161d0bdb492492510ffd19c6ffae2c14724609
-  data.tar.gz: c91361e3272512623ca9f3c7f7b35c056bd55e37a3baf5635525974043fc62a1d80eac2dd533385bd124c91b0ccb54167319f2691e1e439be47c30c751ae3873
+  metadata.gz: a3de96beb257378efe098e4ba1406a06dab673c6717ef249fd92bd31b92483f983847af33e6b34d00b707c4bddf2271f8afee4a597802e9c9d80300cd343625c
+  data.tar.gz: ce3036d1e93ca6585bc188724c9e34552ce5bc658c8d15ffe5e74d0cf59682322475941cac47e33c76338da5e07d84a44d4f0b0b407084c7918e26f7421b1a54

data/.github/workflows/typos.yml

@@ -16,6 +16,6 @@ jobs:
     runs-on: ubuntu-24.04
     steps:
       - uses: actions/checkout@v4
-      - uses: crate-ci/typos@v1.33.1
+      - uses: crate-ci/typos@v1.34.0
         with:
           config: .github/.typos.toml

data/lib/fbe/middleware/trace.rb

@@ -31,9 +31,12 @@ 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 [Array<Symbol>] ignores The array of symbols (see Faraday::HttpCache::CACHE_STATUSES),
+  # which will be ignored
+  def initialize(app, trace, ignores: [])
     super(app)
     @trace = trace
+    @ignores = ignores
   end
 
   # Processes the HTTP request and records trace information.
@@ -47,6 +50,9 @@ class Fbe::Middleware::Trace < Faraday::Middleware
       started_at: Time.now
     }
     @app.call(env).on_complete do |response_env|
+      next if !@ignores.empty? &&
+              response_env[:http_cache_trace] &&
+              (response_env[:http_cache_trace] & @ignores).size.positive?
       finished = Time.now
       duration = finished - entry[:started_at]
       entry[:status] = response_env.status

data/lib/fbe/octo.rb

@@ -86,6 +86,10 @@ def Fbe.octo(options: $options, global: $global, loog: $loog)
               methods: [:get],
               backoff_factor: 2
             )
+            builder.use(Octokit::Response::RaiseError)
+            builder.use(Faraday::Response::Logger, loog, formatter: Fbe::Middleware::Formatter)
+            builder.use(Fbe::Middleware::RateLimit)
+            builder.use(Fbe::Middleware::Trace, trace, ignores: [:fresh])
             if options.sqlite_cache
               maxsize = Filesize.from(options.sqlite_cache_maxsize || '10M').to_i
               maxvsize = Filesize.from(options.sqlite_cache_maxvsize || '10K').to_i
@@ -106,10 +110,6 @@ def Fbe.octo(options: $options, global: $global, loog: $loog)
                 serializer: Marshal, shared_cache: false, logger: Loog::NULL
               )
             end
-            builder.use(Octokit::Response::RaiseError)
-            builder.use(Faraday::Response::Logger, loog, formatter: Fbe::Middleware::Formatter)
-            builder.use(Fbe::Middleware::RateLimit)
-            builder.use(Fbe::Middleware::Trace, trace)
             builder.adapter(Faraday.default_adapter)
           end
         o.middleware = stack

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

data/test/fbe/middleware/test_trace.rb

@@ -4,6 +4,7 @@
 # SPDX-License-Identifier: MIT
 
 require 'faraday'
+require 'faraday/http_cache'
 require 'webmock'
 require_relative '../../test__helper'
 require_relative '../../../lib/fbe'
@@ -103,4 +104,65 @@ class TraceTest < Fbe::Test
     assert_includes url, 'q=test'
     assert_includes url, 'page=2'
   end
+
+  def test_trace_and_cache_middlewares_together
+    WebMock.disable_net_connect!
+    now = Time.now
+    stub_request(:get, 'https://api.example.com/page')
+      .to_return(
+        status: 200,
+        headers: {
+          'date' => now.httpdate,
+          'cache-control' => 'public, max-age=60, s-maxage=60',
+          'last-modified' => (now - (6 * 60 * 60)).httpdate
+        },
+        body: 'some body 1'
+      )
+      .times(1)
+      .then
+      .to_return(
+        status: 200,
+        headers: {
+          'date' => (now + 70).httpdate,
+          'cache-control' => 'public, max-age=60, s-maxage=60',
+          'last-modified' => (now - (6 * 60 * 60)).httpdate,
+          'content-type' => 'application/json; charset=utf-8'
+        },
+        body: 'some body 2'
+      )
+      .times(1)
+      .then.to_raise('no more request to /page')
+    trace_real = []
+    trace_full = []
+    builder =
+      Faraday::RackBuilder.new do |f|
+        f.use Fbe::Middleware::Trace, trace_full
+        f.use(Faraday::HttpCache, serializer: Marshal, shared_cache: false, logger: Loog::NULL)
+        f.use Fbe::Middleware::Trace, trace_real
+        f.adapter :net_http
+      end
+    conn = Faraday::Connection.new(builder: builder)
+    5.times do
+      r = conn.get('https://api.example.com/page')
+      assert_equal('some body 1', r.body)
+    end
+    assert_equal(1, trace_real.size)
+    assert_equal(5, trace_full.size)
+    trace_real.clear
+    trace_full.clear
+    5.times do
+      r = conn.get('https://api.example.com/page')
+      assert_equal('some body 1', r.body)
+    end
+    assert_equal(0, trace_real.size)
+    assert_equal(5, trace_full.size)
+    Time.stub(:now, now + 70) do
+      5.times do
+        r = conn.get('https://api.example.com/page')
+        assert_equal('some body 2', r.body)
+      end
+    end
+    assert_equal(1, trace_real.size)
+    assert_equal(10, trace_full.size)
+  end
 end

data/test/fbe/test_octo.rb

@@ -421,14 +421,69 @@ class TestOcto < Fbe::Test
       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 }))
+      octo = Fbe.octo(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)
+      octo.print_trace!(all: true)
+      refute_match('/user/123: 1', loog.to_s)
     end
   end
 
+  def test_octo_not_trace_cached_requests
+    WebMock.disable_net_connect!
+    now = Time.now
+    stub_request(:get, 'https://api.github.com/rate_limit')
+      .to_return(
+        status: 200, headers: { 'Content-Type' => 'application/json', 'X-RateLimit-Remaining' => '5000' },
+        body: { 'rate' => { 'limit' => 5000, 'remaining' => 5000, 'reset' => 1_672_531_200 } }.to_json
+      )
+    stub_request(:get, 'https://api.github.com/repos/zerocracy/baza.rb')
+      .to_return(
+        status: 200,
+        headers: {
+          'date' => now.httpdate,
+          'cache-control' => 'public, max-age=60, s-maxage=60',
+          'last-modified' => (now - (6 * 60 * 60)).httpdate,
+          'content-type' => 'application/json; charset=utf-8'
+        },
+        body: { id: 840_215_648, name: 'baza.rb' }.to_json
+      )
+      .times(1)
+      .then
+      .to_return(
+        status: 200,
+        headers: {
+          'date' => (now + 70).httpdate,
+          'cache-control' => 'public, max-age=60, s-maxage=60',
+          'last-modified' => (now - (6 * 60 * 60)).httpdate,
+          'content-type' => 'application/json; charset=utf-8'
+        },
+        body: { id: 840_215_648, name: 'baza.rb' }.to_json
+      )
+      .times(1)
+      .then.to_raise('no more request to /repos/zerocracy/baza.rb')
+    loog = Loog::Buffer.new
+    o = Fbe.octo(loog:, global: {}, options: Judges::Options.new({}))
+    o.print_trace!(all: true)
+    Time.stub(:now, now) do
+      5.times do
+        o.repo('zerocracy/baza.rb')
+      end
+    end
+    o.print_trace!(all: true)
+    Time.stub(:now, now + 70) do
+      25.times do
+        o.repo('zerocracy/baza.rb')
+      end
+    end
+    o.print_trace!(all: true)
+    assert_requested :get, 'https://api.github.com/repos/zerocracy/baza.rb', times: 2
+    output = loog.to_s
+    assert_match('/repos/zerocracy/baza.rb: 1', output)
+    refute_match('/repos/zerocracy/baza.rb: 5', output)
+    refute_match('/repos/zerocracy/baza.rb: 25', output)
+  end
+
   def test_trace_gets_cleared_after_print
     WebMock.disable_net_connect!
     stub_request(:get, 'https://api.github.com/rate_limit').to_return(
@@ -542,4 +597,69 @@ class TestOcto < Fbe::Test
     o.print_trace!(all: true)
     assert_match(/321 quota left/, loog.to_s)
   end
+
+  def test_throttling_request_to_rate_limit
+    WebMock.disable_net_connect!
+    stub_request(:get, 'https://api.github.com/rate_limit')
+      .to_return(
+        status: 200, headers: { 'Content-Type' => 'application/json', 'X-RateLimit-Remaining' => '5000' },
+        body: { 'rate' => { 'limit' => 5000, 'remaining' => 5000, 'reset' => 1_672_531_200 } }.to_json
+      )
+      .then.to_return(
+        status: 200, headers: { 'Content-Type' => 'application/json', 'X-RateLimit-Remaining' => '4900' },
+        body: { 'rate' => { 'limit' => 5000, 'remaining' => 4900, 'reset' => 1_672_531_200 } }.to_json
+      )
+      .then.to_return(
+        status: 200, headers: { 'Content-Type' => 'application/json', 'X-RateLimit-Remaining' => '4800' },
+        body: { 'rate' => { 'limit' => 5000, 'remaining' => 4800, 'reset' => 1_672_531_200 } }.to_json
+      )
+      .then.to_raise('no more request to /rate_limit')
+    stub_request(:get, 'https://api.github.com/user/1')
+      .to_return(
+        status: 200, headers: { 'Content-Type' => 'application/json' },
+        body: { 'id' => 1, 'login' => 'user1' }.to_json
+      ).times(1)
+    stub_request(:get, 'https://api.github.com/user/111')
+      .to_return(
+        status: 200, headers: { 'Content-Type' => 'application/json' },
+        body: { 'id' => 111, 'login' => 'user111' }.to_json
+      )
+      .times(201)
+      .then.to_raise('no more request to /user/111')
+    loog = Loog::Buffer.new
+    o = Fbe.octo(loog:, global: {}, options: Judges::Options.new({}))
+    o.user(1)
+    o.print_trace!(all: true)
+    201.times do
+      o.user(111)
+      o.rate_limit!.remaining
+    end
+    o.print_trace!(all: true)
+    output = loog.to_s
+    assert_requested :get, 'https://api.github.com/user/1', times: 1
+    assert_requested :get, 'https://api.github.com/user/111', times: 201
+    assert_requested :get, 'https://api.github.com/rate_limit', times: 3
+    assert_match('2 URLs vs 2 requests', output)
+    assert_match('/user/1: 1', output)
+    assert_match('/rate_limit: 1', output)
+    assert_match('2 URLs vs 203 requests', output)
+    assert_match('/user/111: 201', output)
+    assert_match('/rate_limit: 2', output)
+  end
+
+  def test_octo_http_cache_middleware_located_in_end_of_chain
+    WebMock.disable_net_connect!
+    stub_request(:get, 'https://api.github.com/rate_limit')
+      .to_return(
+        status: 200, headers: { 'Content-Type' => 'application/json', 'X-RateLimit-Remaining' => '5000' },
+        body: { 'rate' => { 'limit' => 5000, 'remaining' => 5000, 'reset' => 1_672_531_200 } }.to_json
+      )
+    o = Fbe.octo(loog: fake_loog, global: {}, options: Judges::Options.new({}))
+    assert_equal('Faraday::HttpCache', o.middleware.handlers.last.name, <<~MSG.strip.gsub!(/\s+/, ' '))
+      Faraday::HttpCache middleware must be located in the end of chain middlewares,
+      because the Oktokit client change Faraday::HttpCache position to the last,
+      for more info, see: https://github.com/zerocracy/fbe/issues/230#issuecomment-3020551743 and
+      https://github.com/octokit/octokit.rb/blob/ea3413c3174571e87c83d358fc893cc7613091fa/lib/octokit/connection.rb#L109-L119
+    MSG
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fbe
 version: !ruby/object:Gem::Version
-  version: 0.23.6
+  version: 0.23.7
 platform: ruby
 authors:
 - Yegor Bugayenko