fbe 0.6.0 → 0.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 72f0ba759db6bd1370f62c85290d009b0253b1c2d0b67f6933a6b8e2b43817ef
-  data.tar.gz: c7b030938e82ec475316cd1e4ffcf3597fe26665020114c9e8f847741853b1b4
+  metadata.gz: e1ce252b4d0093ff1f94e319d2c65502e134dad520398ca018fad1820b9dac78
+  data.tar.gz: f0039a70dcd2533e2acd36f80b7ef3ac68441f1f68611b38ee07d9c67449ddf3
 SHA512:
-  metadata.gz: edf889e94309ab5ebd1e0760a2152bc546d44b0b8ba42df2e5b4394cbabbc3964819690d787434bf10570a55ba3ed97514516ab029fe200056996994077fe00a
-  data.tar.gz: 45ce296b829c75109fd3a4f92f7b5f1ace1d3e77062210b0aa0214b2a7939509b9bddc95f5363d8d05f2a288484b2ada461695326b2284fe0fab8d745138ee17
+  metadata.gz: 25191aefeccb723456f4de449c6f042ce628c895fc7f2e941f5e63e0685bfb2bccf550e04c288ff28e288acf8a4c0b57f3402b2826cae5ccb5da549c977f1ffe
+  data.tar.gz: 6362777ada12c805d463db462afbfbf5bab5d20b897565b798c2ede567d097f3250622d1a67656731e94f0ac8fc37fb604ace94c150e51e47c2a83ec14f4be60

data/Gemfile

@@ -17,5 +17,6 @@ gem 'rubocop-performance', '>0', require: false
 gem 'rubocop-rake', '>0', require: false
 gem 'simplecov', '~>0.22', require: false
 gem 'simplecov-cobertura', '~>2.1', require: false
+gem 'veils', '>0', require: false
 gem 'webmock', '~>3.25', require: false
 gem 'yard', '~>0.9', require: false

data/Gemfile.lock

@@ -70,7 +70,7 @@ GEM
       tago (> 0)
     ethon (0.16.0)
       ffi (>= 1.15.0)
-    factbase (0.9.10)
+    factbase (0.10.0)
       backtrace (~> 0.4)
       decoor (~> 0.0)
       json (~> 2.7)
@@ -92,14 +92,14 @@ GEM
       net-http (>= 0.5.0)
     faraday-retry (2.3.1)
       faraday (~> 2.0)
-    ffi (1.17.1-arm64-darwin)
-    ffi (1.17.1-x64-mingw-ucrt)
-    ffi (1.17.1-x86_64-darwin)
-    ffi (1.17.1-x86_64-linux-gnu)
-    fiber-storage (1.0.0)
+    ffi (1.17.2-arm64-darwin)
+    ffi (1.17.2-x64-mingw-ucrt)
+    ffi (1.17.2-x86_64-darwin)
+    ffi (1.17.2-x86_64-linux-gnu)
+    fiber-storage (1.0.1)
     gli (2.22.2)
       ostruct
-    graphql (2.5.2)
+    graphql (2.5.3)
       base64
       fiber-storage
       logger
@@ -158,7 +158,7 @@ GEM
     os (1.1.4)
     ostruct (0.6.1)
     others (0.0.3)
-    parallel (1.26.3)
+    parallel (1.27.0)
     parser (3.3.8.0)
       ast (~> 2.4.1)
       racc
@@ -225,6 +225,7 @@ GEM
       unicode-emoji (~> 4.0, >= 4.0.4)
     unicode-emoji (4.0.4)
     uri (1.0.3)
+    veils (0.4.0)
     verbose (0.0.2)
       loog (~> 0.2)
       tago (~> 0.0)
@@ -257,6 +258,7 @@ DEPENDENCIES
   rubocop-rake (> 0)
   simplecov (~> 0.22)
   simplecov-cobertura (~> 2.1)
+  veils (> 0)
   webmock (~> 3.25)
   yard (~> 0.9)
 

data/Rakefile

@@ -16,8 +16,6 @@ def version
   Gem::Specification.load(Dir['*.gemspec'].first).version
 end
 
-ENV['RACK_ENV'] = 'test'
-
 task default: %i[clean test picks rubocop yard]
 
 require 'rake/testtask'

data/lib/fbe/conclude.rb

@@ -160,21 +160,20 @@ class Fbe::Conclude
   def roll(&)
     passed = 0
     start = Time.now
-    catch :stop do
-      @fb.txn do |fbt|
-        fbt.query(@query).each do |a|
-          if @quota_aware && Fbe.octo(loog: @loog, options: @options, global: @global).off_quota
-            @loog.debug('We ran out of GitHub quota, must stop here')
-            throw :stop
-          end
-          if Time.now > start + @timeout
-            @loog.debug("We've spent more than #{start.ago}, must stop here")
-            throw :stop
-          end
-          n = yield fbt, a
-          @loog.info("#{n.what}: #{n.details}") unless n.nil?
-          passed += 1
+    oct = Fbe.octo(loog: @loog, options: @options, global: @global)
+    @fb.txn do |fbt|
+      fbt.query(@query).each do |a|
+        if @quota_aware && oct.off_quota
+          @loog.debug('We ran out of GitHub quota, must stop here')
+          throw :commit
         end
+        if Time.now > start + @timeout
+          @loog.debug("We've spent more than #{start.ago}, must stop here")
+          throw :commit
+        end
+        n = yield fbt, a
+        @loog.info("#{n.what}: #{n.details}") unless n.nil?
+        passed += 1
       end
     end
     @loog.debug("Found and processed #{passed} facts by: #{@query}")

data/lib/fbe/iterate.rb

@@ -107,11 +107,23 @@ class Fbe::Iterate
     raise 'Use "by" first' if @query.nil?
     seen = {}
     oct = Fbe.octo(loog: @loog, options: @options, global: @global)
+    if oct.off_quota
+      @loog.debug('We are off GitHub quota, cannot even start, sorry')
+      return
+    end
     repos = Fbe.unmask_repos(loog: @loog, options: @options, global: @global)
     restarted = []
     start = Time.now
     loop do
+      if oct.off_quota
+        @loog.info("We are off GitHub quota, time to stop after #{start.ago}")
+        break
+      end
       repos.each do |repo|
+        if oct.off_quota
+          @loog.debug("We are off GitHub quota, we must skip #{repo}")
+          break
+        end
         if Time.now - start > timeout
           $loog.info("We are doing this for #{start.ago} already, won't check #{repo}")
           next
@@ -152,14 +164,6 @@ class Fbe::Iterate
           end
         f.what = @label
         seen[repo] += 1
-        if oct.off_quota
-          @loog.debug('We are off GitHub quota, time to stop')
-          break
-        end
-      end
-      if oct.off_quota
-        @loog.info("We are off GitHub quota, time to stop after #{start.ago}")
-        break
       end
       unless seen.any? { |r, v| v < @repeats && !restarted.include?(r) }
         @loog.debug("No more repos to scan (out of #{repos.size}), quitting after #{start.ago}")

data/lib/fbe/octo.rb

@@ -13,7 +13,6 @@ require 'verbose'
 require_relative '../fbe'
 require_relative 'middleware'
 require_relative 'middleware/formatter'
-require_relative 'middleware/quota'
 
 # Makes a call to the GitHub API.
 #
@@ -71,7 +70,6 @@ def Fbe.octo(options: $options, global: $global, loog: $loog)
               methods: [:get],
               backoff_factor: 2
             )
-            builder.use(Fbe::Middleware::Quota, loog:, pause: options.github_api_pause || 60)
             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)
@@ -84,12 +82,13 @@ def Fbe.octo(options: $options, global: $global, loog: $loog)
         o = Fbe::FakeOctokit.new
       end
       decoor(o, loog:) do
-        def off_quota
+        def off_quota(threshold: 50)
           left = @origin.rate_limit.remaining
-          if left < 5
-            @loog.info("Too much GitHub API quota consumed already (remaining=#{left}), stopping")
+          if left < threshold
+            @loog.info("Too much GitHub API quota consumed already (#{left} < #{threshold}), stopping")
             true
           else
+            @loog.debug("Still #{left} GitHub API quota left (>#{threshold})")
             false
           end
         end
@@ -149,13 +148,14 @@ class Fbe::FakeOctokit
     true
   end
 
-  def user(name)
-    login = name
-    login = name == 526_301 ? 'yegor256' : 'torvalds' if login.is_a?(Integer)
+  # Get details of the user.
+  # @param [String|Integer] uid The login of the user or its ID
+  def user(uid)
+    login = (uid == 526_301 ? 'yegor256' : 'torvalds') if uid.is_a?(Integer)
     {
       id: 444,
       login:,
-      type: name == 29_139_614 ? 'Bot' : 'User'
+      type: uid == 29_139_614 ? 'Bot' : 'User'
     }
   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.6.0' unless const_defined?(:VERSION)
+  VERSION = '0.7.1' unless const_defined?(:VERSION)
 end

data/test/fbe/test_conclude.rb

@@ -61,6 +61,38 @@ class TestConclude < Fbe::Test
     assert_equal(42, f.bar)
   end
 
+  def test_considers_until_quota
+    WebMock.disable_net_connect!
+    fb = Factbase.new
+    5.times do
+      fb.insert.foo = 1
+    end
+    options = Judges::Options.new
+    stub_request(:get, %r{https://api.github.com/users/.*}).to_return(
+      {
+        body: { id: rand(100) }.to_json,
+        headers: { 'Content-Type' => 'application/json', 'X-RateLimit-Remaining' => '999' }
+      },
+      {
+        body: { id: rand(100) }.to_json,
+        headers: { 'Content-Type' => 'application/json', 'X-RateLimit-Remaining' => '9' }
+      }
+    )
+    stub_request(:get, 'https://api.github.com/rate_limit').to_return(
+      body: 'hm...', headers: { 'X-RateLimit-Remaining' => '777' }
+    ).times(1)
+    global = {}
+    o = Fbe.octo(loog: Loog::NULL, options:, global:)
+    Fbe.conclude(fb:, judge: 'boom', loog: Loog::NULL, options:, global:) do
+      quota_aware
+      on '(exists foo)'
+      consider do |f|
+        f.bar = o.user("user-#{rand(100)}")[:id]
+      end
+    end
+    assert_equal(2, fb.query('(exists bar)').each.to_a.size)
+  end
+
   def test_ignores_globals
     $fb = nil
     $loog = nil

data/test/fbe/test_octo.rb

@@ -56,7 +56,7 @@ class TestOcto < Fbe::Test
     global = {}
     o = Fbe.octo(loog: Loog::NULL, global:, options: Judges::Options.new)
     stub_request(:get, 'https://api.github.com/users/yegor256')
-      .to_return(status: 200, body: '{}', headers: { 'Cache-Control' => 'public, max-age=60', 'etag' => 'abc' })
+      .to_return(body: '{}', headers: { 'Cache-Control' => 'public, max-age=60', 'etag' => 'abc' })
       .times(1)
       .then
       .to_raise('second request should be cached, not passed to GitHub API!')
@@ -64,12 +64,50 @@ class TestOcto < Fbe::Test
     o.user('yegor256')
   end
 
+  def test_rate_limit_remaining
+    WebMock.disable_net_connect!
+    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/42').to_return(
+      body: '', headers: { 'X-RateLimit-Remaining' => '4' }
+    )
+    o = Octokit::Client.new
+    assert_equal(222, o.rate_limit.remaining)
+    o.user(42)
+    assert_equal(4, o.rate_limit.remaining)
+    assert_equal(4, o.rate_limit.remaining)
+  end
+
   def test_off_quota
     WebMock.disable_net_connect!
-    stub_request(:get, 'https://api.github.com/rate_limit')
-      .to_return(status: 200, body: '{}', headers: { 'X-RateLimit-Remaining' => '1000' })
+    stub_request(:get, 'https://api.github.com/rate_limit').to_return(
+      body: '{}', headers: { 'X-RateLimit-Remaining' => '333' }
+    )
+    stub_request(:get, 'https://api.github.com/user/42').to_return(
+      body: '', headers: { 'X-RateLimit-Remaining' => '3' }
+    )
     o = Fbe.octo(loog: Loog::NULL, global: {}, options: Judges::Options.new)
     refute(o.off_quota)
+    o.user(42)
+    assert(o.off_quota)
+  end
+
+  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' }
+    )
+    stub_request(:get, 'https://api.github.com/user/42').to_return(
+      { body: '', headers: { 'X-RateLimit-Remaining' => '5555' } },
+      { body: '', headers: { 'X-RateLimit-Remaining' => '5' } }
+    )
+    o = Fbe.octo(loog: Loog::VERBOSE, global: {}, options: Judges::Options.new)
+    refute(o.off_quota)
+    o.user(42)
+    refute(o.off_quota)
+    o.user(42)
+    assert(o.off_quota)
   end
 
   def test_retrying
@@ -80,7 +118,7 @@ class TestOcto < Fbe::Test
       .to_raise(Octokit::TooManyRequests.new)
       .times(1)
       .then
-      .to_return(status: 200, body: '{}')
+      .to_return(body: '{}')
     o.user('yegor256')
   end
 
@@ -92,7 +130,7 @@ class TestOcto < Fbe::Test
       .to_return(status: 503)
       .times(1)
       .then
-      .to_return(status: 200, body: '{}')
+      .to_return(body: '{}')
     o.user('yegor256')
   end
 
@@ -133,29 +171,20 @@ class TestOcto < Fbe::Test
 
   def test_pauses_when_quota_is_exceeded
     WebMock.disable_net_connect!
-    global = {}
-    pause = 0.1
-    o = Fbe.octo(loog: Loog::NULL, global:, options: Judges::Options.new({ 'github_api_pause' => pause }))
-    limit = 100
-    start_time = Time.now
-    105.times do |i|
-      n = i + 1
-      user = "test#{n}"
-      limit = 100 if n > 100
-      stub_request(:get, "https://api.github.com/users/#{user}")
-        .then
-        .to_return(
-          status: 200, body: '{}',
-          headers: {
-            'x-ratelimit-remaining' => limit.to_s
-          }
-        )
-        .times(1)
-      o.user(user)
-      refute(o.off_quota) if n > 100
-      limit -= 1
-    end
-    assert_in_delta(pause, Time.now - start_time, 5)
+    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')
+      .to_return(
+        body: '{}',
+        headers: { 'x-ratelimit-remaining' => '1' }
+      )
+      .to_return(
+        body: '{}',
+        headers: { 'x-ratelimit-remaining' => '10000' }
+      )
+    o.user('foo')
+    assert(o.off_quota)
+    o.user('foo')
+    refute(o.off_quota)
   end
 
   def test_fetches_fake_check_runs_for_ref
@@ -193,4 +222,10 @@ class TestOcto < Fbe::Test
     result = o.workflow_run_job('zerocracy/baza', 0)
     assert_equal(0, result[:id])
   end
+
+  def test_reads_quota
+    WebMock.enable_net_connect!
+    o = Fbe.octo(loog: Loog::VERBOSE, global: {}, options: Judges::Options.new({ 'github_api_pause' => 0.01 }))
+    refute_nil(o.off_quota)
+  end
 end

data/test/test__helper.rb

@@ -5,6 +5,8 @@
 
 $stdout.sync = true
 
+ENV['RACK_ENV'] = 'test'
+
 require 'simplecov'
 require 'simplecov-cobertura'
 unless SimpleCov.running || ARGV.include?('--no-cov')

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: fbe
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.1
 platform: ruby
 authors:
 - Yegor Bugayenko
 bindir: bin
 cert_chain: []
-date: 2025-04-14 00:00:00.000000000 Z
+date: 2025-04-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: backtrace
@@ -305,7 +305,6 @@ files:
 - lib/fbe/just_one.rb
 - lib/fbe/middleware.rb
 - lib/fbe/middleware/formatter.rb
-- lib/fbe/middleware/quota.rb
 - lib/fbe/octo.rb
 - lib/fbe/overwrite.rb
 - lib/fbe/pmp.rb
@@ -317,7 +316,6 @@ files:
 - renovate.json
 - rules/basic.fe
 - test/fbe/middleware/test_formatter.rb
-- test/fbe/middleware/test_quota.rb
 - test/fbe/test_award.rb
 - test/fbe/test_bylaws.rb
 - test/fbe/test_conclude.rb

data/lib/fbe/middleware/quota.rb

@@ -1,64 +0,0 @@
-# frozen_string_literal: true
-
-# SPDX-FileCopyrightText: Copyright (c) 2024-2025 Zerocracy
-# SPDX-License-Identifier: MIT
-
-require 'faraday'
-require_relative '../middleware'
-
-# Faraday Middleware that monitors GitHub API rate limits.
-#
-# Author:: Yegor Bugayenko (yegor256@gmail.com)
-# Copyright:: Copyright (c) 2024-2025 Zerocracy
-# License:: MIT
-class Fbe::Middleware::Quota < Faraday::Middleware
-  # Constructor.
-  #
-  # @param [Object] app The Faraday app
-  # @param [Loog] loog The logging facility
-  # @param [Integer] pause Seconds to pause when rate limit is reached
-  # @param [Integer] limit Maximum number of requests before checking rate limit
-  # @param [Integer] rate Minimum remaining requests threshold
-  def initialize(app, loog: Loog::NULL, pause: 60, limit: 100, rate: 5)
-    super(app)
-    @requests = 0
-    @app = app
-    raise 'The "loog" cannot be nil' if loog.nil?
-    @loog = loog
-    raise 'The "pause" cannot be nil' if pause.nil?
-    raise 'The "pause" must be a positive integer' unless pause.positive?
-    @pause = pause
-    raise 'The "limit" cannot be nil' if limit.nil?
-    raise 'The "limit" must be a positive integer' unless limit.positive?
-    @limit = limit
-    raise 'The "rate" cannot be nil' if rate.nil?
-    raise 'The "rate" must be a positive integer' unless rate.positive?
-    @rate = rate
-  end
-
-  # Process the request and handle rate limiting.
-  #
-  # @param [Faraday::Env] env The environment
-  # @return [Faraday::Response] The response
-  def call(env)
-    @requests += 1
-    response = @app.call(env)
-    if out_of_limit?(env)
-      @loog.info("Too much GitHub API quota consumed, pausing for #{@pause} seconds")
-      sleep(@pause)
-      @requests = 0
-    end
-    response
-  end
-
-  private
-
-  # Check if we're approaching the rate limit.
-  #
-  # @param [Faraday::Env] env The environment
-  # @return [Boolean] True if we should pause to avoid hitting rate limits
-  def out_of_limit?(env)
-    remaining = env.response_headers['x-ratelimit-remaining'].to_i
-    (@requests % @limit).zero? && remaining < @rate
-  end
-end

data/test/fbe/middleware/test_quota.rb

@@ -1,66 +0,0 @@
-# frozen_string_literal: true
-
-# SPDX-FileCopyrightText: Copyright (c) 2024-2025 Zerocracy
-# SPDX-License-Identifier: MIT
-
-require 'faraday'
-require 'logger'
-require 'loog'
-require 'judges'
-require 'judges/options'
-require_relative '../../../lib/fbe/middleware'
-require_relative '../../../lib/fbe/middleware/quota'
-require_relative '../../test__helper'
-
-class QuotaTest < Fbe::Test
-  class FakeApp
-    def initialize
-      @calls = 0
-    end
-
-    def call(env)
-      @calls += 1
-      response_headers = {
-        'x-ratelimit-remaining' => (100 - @calls).to_s
-      }
-      env[:response_headers] = response_headers
-      env
-    end
-  end
-
-  def test_quota_middleware_pauses_when_quota_low
-    loog = Loog::NULL
-    pause = 0.1
-    app = FakeApp.new
-    middleware = Fbe::Middleware::Quota.new(app, loog:, pause:)
-    start_time = Time.now
-    105.times do
-      env = Judges::Options.new(
-        'method' => :get,
-        'url' => 'http://example.com',
-        'request_headers' => {},
-        'response_headers' => {}
-      )
-      middleware.call(env)
-    end
-    assert_in_delta pause, Time.now - start_time, 0.4
-  end
-
-  def test_quota_middleware_logs_when_quota_low
-    pause = 0.1
-    log_output = StringIO.new
-    loog = Logger.new(log_output)
-    app = FakeApp.new
-    middleware = Fbe::Middleware::Quota.new(app, loog:, pause:)
-    105.times do
-      env = Judges::Options.new(
-        'method' => :get,
-        'url' => 'http://example.com',
-        'request_headers' => {},
-        'response_headers' => {}
-      )
-      middleware.call(env)
-    end
-    assert_match(/Too much GitHub API quota/, log_output.string)
-  end
-end