fbe 0.23.2 → 0.23.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ee5e623e0dd6b64525eb62f7dcad447a595c3c963c747acec37dda308cabcf98
-  data.tar.gz: c422fd60aba87180dc2ab7265abe5458928b7df765b86e7c3eaea9f8b3884c34
+  metadata.gz: ebe33dc4f8380eeabe72495993dea6fe88842c8d062d7f41ce43111e664ba825
+  data.tar.gz: 2763f2c522defeb27a03bda9b15ec07d690721a663cb5bda91c2b07ea69b0b49
 SHA512:
-  metadata.gz: 0fcd4bf85f7ae73caab3b4b2a834b1978c2fb4aee2c58a83fcb53098d25d6208f25f99ded13ac5efbd441d6f7eeb24f22d5c74249f802353568781d38e9e0d93
-  data.tar.gz: 3b4aab5363b741fb8f9054a32a84e008a9ad5487d8f668580cbe6d6fdbe0b447511f6c999bcad9b4d906cbd017566e50bfb31ac881c2271c793fe0ce111700b9
+  metadata.gz: de77042cef4d5d7110fb13584e0b9765537dc156da8150c355a97f6d2b0b3212f8b46e8d20b24f96eacf3e1b93a30728e31514b731ca4fb6e92955046cc3f4b9
+  data.tar.gz: 5693137ce96120cad70e867b3e85655e29a4bc7d00e30435203f5c7b871e4b1248cd277190bb123dbcbe536beccbe99b72a4257da399a10f221ed0e4048e45b3

data/Gemfile.lock

@@ -13,6 +13,7 @@ PATH
       faraday-retry (~> 2.3)
       filesize (~> 0.2)
       graphql-client (~> 0.26)
+      intercepted (~> 0.2)
       judges (~> 0.46)
       liquid (~> 5.5)
       loog (~> 0.6)
@@ -115,6 +116,7 @@ GEM
     hashdiff (1.2.0)
     i18n (1.14.7)
       concurrent-ruby (~> 1.0)
+    intercepted (0.2.0)
     iri (0.11.2)
     json (2.12.2)
     judges (0.50.5)

data/fbe.gemspec

@@ -33,6 +33,7 @@ Gem::Specification.new do |s|
   s.add_dependency 'faraday-retry', '~>2.3'
   s.add_dependency 'filesize', '~>0.2'
   s.add_dependency 'graphql-client', '~>0.26'
+  s.add_dependency 'intercepted', '~>0.2'
   s.add_dependency 'judges', '~>0.46'
   s.add_dependency 'liquid', '~>5.5'
   s.add_dependency 'loog', '~>0.6'

data/lib/fbe/middleware/trace.rb

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

data/lib/fbe/octo.rb

@@ -8,11 +8,13 @@ require 'ellipsized'
 require 'faraday/http_cache'
 require 'faraday/retry'
 require 'filesize'
+require 'intercepted'
 require 'json'
 require 'loog'
 require 'obk'
 require 'octokit'
 require 'others'
+require 'tago'
 require 'uri'
 require 'verbose'
 require_relative '../fbe'
@@ -85,7 +87,7 @@ def Fbe.octo(options: $options, global: $global, loog: $loog)
             )
             if options.sqlite_cache
               maxsize = Filesize.from(options.sqlite_cache_maxsize || '10M').to_i
-              maxvsize = Filesize.from(options.sqlite_cache_maxxsize || '10K').to_i
+              maxvsize = Filesize.from(options.sqlite_cache_maxvsize || '10K').to_i
               store = Fbe::Middleware::SqliteStore.new(options.sqlite_cache, Fbe::VERSION, loog:, maxsize:, maxvsize:)
               loog.info(
                 "Using HTTP cache in SQLite file: #{store.path} (" \
@@ -105,7 +107,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, all: false)
+            builder.use(Fbe::Middleware::Trace, trace)
             builder.adapter(Faraday.default_adapter)
           end
         o.middleware = stack
@@ -122,12 +124,12 @@ def Fbe.octo(options: $options, global: $global, loog: $loog)
       end
       o =
         decoor(o, loog:, trace:) do
-          def print_trace!
+          def print_trace!(all: false, max: 5)
             if @trace.empty?
               @loog.debug('GitHub API trace is empty')
             else
               grouped =
-                @trace.group_by do |entry|
+                @trace.select { |e| e[:duration] > 0.05 || all }.group_by do |entry|
                   uri = URI.parse(entry[:url])
                   query = uri.query
                   query = "?#{query.ellipsized(40)}" if query
@@ -135,18 +137,27 @@ def Fbe.octo(options: $options, global: $global, loog: $loog)
                 end
               message = grouped
                 .sort_by { |_path, entries| -entries.count }
-                .map { |path, entries| "  #{path.gsub(%r{^https://api.github.com/}, '/')}: #{entries.count}" }
+                .map do |path, entries|
+                  [
+                    '  ',
+                    path.gsub(%r{^https://api.github.com/}, '/'),
+                    ': ',
+                    entries.count,
+                    " (#{entries.sum { |e| e[:duration] }.seconds})"
+                  ].join
+                end
+                .take(max)
                 .join("\n")
               @loog.info(
                 "GitHub API trace (#{grouped.count} URLs vs #{@trace.count} requests, " \
-                "#{@origin.rate_limit.remaining} quota left):\n#{message}"
+                "#{@origin.rate_limit!.remaining} quota left):\n#{message}"
               )
               @trace.clear
             end
           end
 
           def off_quota?(threshold: 50)
-            left = @origin.rate_limit.remaining
+            left = @origin.rate_limit!.remaining
             if left < threshold
               @loog.info("Too much GitHub API quota consumed already (#{left} < #{threshold}), stopping")
               true
@@ -183,11 +194,10 @@ def Fbe.octo(options: $options, global: $global, loog: $loog)
           end
         end
       o =
-        others(o:) do |*args|
-          if args.first != :off_quota? && args.first != :print_trace! && @o.off_quota?
-            raise "We are off-quota (remaining: #{@o.rate_limit.remaining})"
+        intercepted(o) do |e, m, _args, _r|
+          if e == :before && m != :off_quota? && m != :print_trace! && m != :rate_limit && o.off_quota?
+            raise "We are off-quota (remaining: #{o.rate_limit.remaining}), can't do #{name}()"
           end
-          @o.__send__(*args)
         end
       o
     end
@@ -248,6 +258,7 @@ class Fbe::FakeOctokit
     end
     o
   end
+  alias rate_limit! rate_limit
 
   # Lists repositories for a user or organization.
   #

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

data/test/fbe/test_conclude.rb

@@ -79,8 +79,12 @@ class TestConclude < Fbe::Test
       }
     )
     stub_request(:get, 'https://api.github.com/rate_limit').to_return(
-      body: 'hm...', headers: { 'X-RateLimit-Remaining' => '777' }
-    ).times(1)
+      { body: 'hm...', headers: { 'X-RateLimit-Remaining' => '777' } },
+      { body: 'hm...', headers: { 'X-RateLimit-Remaining' => '777' } },
+      { body: 'hm...', headers: { 'X-RateLimit-Remaining' => '777' } },
+      { body: 'hm...', headers: { 'X-RateLimit-Remaining' => '999' } },
+      { body: 'hm...', headers: { 'X-RateLimit-Remaining' => '9' } }
+    )
     global = {}
     o = Fbe.octo(loog: Loog::NULL, options:, global:)
     Fbe.conclude(fb:, judge: 'boom', loog: Loog::NULL, options:, global:) do

data/test/fbe/test_octo.rb

@@ -133,7 +133,9 @@ class TestOcto < Fbe::Test
   def test_off_quota?
     WebMock.disable_net_connect!
     stub_request(:get, 'https://api.github.com/rate_limit').to_return(
-      body: '{}', headers: { 'X-RateLimit-Remaining' => '333' }
+      { body: '{}', headers: { 'X-RateLimit-Remaining' => '333' } },
+      { body: '{}', headers: { 'X-RateLimit-Remaining' => '333' } },
+      { body: '{}', headers: { 'X-RateLimit-Remaining' => '3' } }
     )
     stub_request(:get, 'https://api.github.com/user/42').to_return(
       body: '', headers: { 'X-RateLimit-Remaining' => '3' }
@@ -147,7 +149,11 @@ class TestOcto < Fbe::Test
   def test_off_quota_twice
     WebMock.disable_net_connect!
     stub_request(:get, 'https://api.github.com/rate_limit').to_return(
-      body: '{}', headers: { 'X-RateLimit-Remaining' => '333' }
+      { body: '{}', headers: { 'X-RateLimit-Remaining' => '333' } },
+      { body: '{}', headers: { 'X-RateLimit-Remaining' => '333' } },
+      { body: '{}', headers: { 'X-RateLimit-Remaining' => '333' } },
+      { body: '{}', headers: { 'X-RateLimit-Remaining' => '5555' } },
+      { body: '{}', headers: { 'X-RateLimit-Remaining' => '5' } }
     )
     stub_request(:get, 'https://api.github.com/user/42').to_return(
       { body: '', headers: { 'X-RateLimit-Remaining' => '5555' } },
@@ -239,7 +245,9 @@ class TestOcto < Fbe::Test
   def test_pauses_when_quota_is_exceeded
     WebMock.disable_net_connect!
     stub_request(:get, 'https://api.github.com/rate_limit').to_return(
-      { body: '{}', headers: { 'X-RateLimit-Remaining' => '222' } }
+      { body: '{}', headers: { 'X-RateLimit-Remaining' => '222' } },
+      { body: '{}', headers: { 'X-RateLimit-Remaining' => '1' } },
+      { body: '{}', headers: { 'X-RateLimit-Remaining' => '10000' } }
     )
     o = Fbe.octo(loog: Loog::NULL, global: {}, options: Judges::Options.new({ 'github_api_pause' => 0.01 }))
     stub_request(:get, 'https://api.github.com/users/foo')
@@ -364,10 +372,11 @@ class TestOcto < Fbe::Test
     loog = Loog::Buffer.new
     WebMock.disable_net_connect!
     stub_request(:get, 'https://api.github.com/rate_limit').to_return(
+      { body: '{}', headers: { 'X-RateLimit-Remaining' => '222' } },
+      { body: '{}', headers: { 'X-RateLimit-Remaining' => '222' } },
       { body: '{}', 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"}',
@@ -375,7 +384,6 @@ class TestOcto < Fbe::Test
       }
     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"}',
@@ -386,10 +394,11 @@ class TestOcto < Fbe::Test
     octo.user(123)
     octo.repository('foo/bar')
     octo.repository('foo/bar')
-    octo.print_trace!
+    octo.print_trace!(all: true, max: 9_999)
     output = loog.to_s
-    assert_includes output, '2 URLs vs 3 requests'
+    assert_includes output, '3 URLs vs 6 requests'
     assert_includes output, '222 quota left'
+    assert_includes output, '/rate_limit: 3'
     assert_includes output, '/user/123: 1'
     assert_includes output, '/repos/foo/bar: 2'
     repo_index = output.index('/repos/foo/bar: 2')
@@ -526,4 +535,23 @@ class TestOcto < Fbe::Test
       end
     end
   end
+
+  def test_fetch_rate_limit_by_making_new_request
+    WebMock.disable_net_connect!
+    stub_request(:get, 'https://api.github.com/rate_limit').to_return(
+      { body: '{}', headers: { 'X-RateLimit-Remaining' => '321' } }
+    ).to_return(
+      { body: '{}', headers: { 'X-RateLimit-Remaining' => '123' } }
+    ).to_return(
+      { body: '{}', headers: { 'X-RateLimit-Remaining' => '1' } }
+    ).to_raise(StandardError.new('no more requests to https://api.github.com/rate_limit'))
+    loog = Loog::Buffer.new
+    o = Fbe.octo(loog:, global: {}, options: Judges::Options.new)
+    refute_predicate(o, :off_quota?)
+    assert_match(/321 GitHub API quota left/, loog.to_s)
+    o.print_trace!(all: true)
+    assert_match(/123 quota left/, loog.to_s)
+    assert_predicate(o, :off_quota?)
+    assert_match(/1 GitHub API quota left/, loog.to_s)
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fbe
 version: !ruby/object:Gem::Version
-  version: 0.23.2
+  version: 0.23.4
 platform: ruby
 authors:
 - Yegor Bugayenko
@@ -163,6 +163,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.26'
+- !ruby/object:Gem::Dependency
+  name: intercepted
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
 - !ruby/object:Gem::Dependency
   name: judges
   requirement: !ruby/object:Gem::Requirement