fbe 0.24.4 → 0.25.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 92baa5e54a0df9b2e57f2d6619cfad4d4ee1b4a4150b1e30b82780062dd9bd34
-  data.tar.gz: ac08a108536716ff130271018211616e02b58a55dcef303bed0c0d01808387eb
+  metadata.gz: c7615e3d4257252fcc987acca6caeb717c328a79edfd563eb67e704be741cef2
+  data.tar.gz: 3a256df746d860b44a2d6f3d44cad34690dce87ca9743227b1e114edfcdff5bd
 SHA512:
-  metadata.gz: 4b87c1fefa9477f19588b01eeb7a7d593ca38f1eed068fe7d27a84a66b4cc35214f83b8f6128a169a007df962063f4ae5373442a17c61d12f1c7e876c1099ef6
-  data.tar.gz: ae01c566bca05de64432b34b6f27bbf82497d5d72817c5bbb0ef9f80e0f62f742681f1ae820d30bc081d891b31f926369ee1f0efe42e4b778a0223b4be26959e
+  metadata.gz: 3bf3c8e87ea0f0bc52a51d7f89c60bc1dc5e67b78eccac3ce9de0ac80f73406b4b8fec508d7c83c10b42a07fbe594505d3a5cddc80fd8a35e00c292a80eaf911
+  data.tar.gz: 2b4b12a737a6f810d304727f649faa7dceaf224c317c7d79d01705af5442a9510ede60d9f63f9afc433b6b3ce3a4bd49a7c30934d2ee9b6c90d26aebbb1a9d84

data/Gemfile

@@ -17,7 +17,7 @@ gem 'rubocop-minitest', '~>0.38', require: false
 gem 'rubocop-performance', '~>1.25', require: false
 gem 'rubocop-rake', '~>0.7', require: false
 gem 'simplecov', '~>0.22', require: false
-gem 'simplecov-cobertura', '~>2.1', require: false
+gem 'simplecov-cobertura', '~>3.0', require: false
 gem 'veils', '~>0.4', require: false
 gem 'webmock', '~>3.25', require: false
 gem 'yard', '~>0.9', require: false

data/Gemfile.lock

@@ -223,7 +223,7 @@ GEM
       docile (~> 1.1)
       simplecov-html (~> 0.11)
       simplecov_json_formatter (~> 0.1)
-    simplecov-cobertura (2.1.0)
+    simplecov-cobertura (3.0.0)
       rexml
       simplecov (~> 0.19)
     simplecov-html (0.13.1)
@@ -277,7 +277,7 @@ DEPENDENCIES
   rubocop-performance (~> 1.25)
   rubocop-rake (~> 0.7)
   simplecov (~> 0.22)
-  simplecov-cobertura (~> 2.1)
+  simplecov-cobertura (~> 3.0)
   veils (~> 0.4)
   webmock (~> 3.25)
   yard (~> 0.9)

data/lib/fbe/middleware/sqlite_store.rb

@@ -54,9 +54,10 @@ class Fbe::Middleware::SqliteStore
   # @param maxsize [Integer] Maximum database size in bytes (optional, defaults to 10MB)
   # @param maxvsize [Integer] Maximum size in bytes of a single value (optional, defaults to 10Kb)
   # @param ttl [Integer, nil] lifetime of keys in hours
+  # @param cache_min_age [Integer, nil] age which will could be overwritten in cache-control header
   # @raise [ArgumentError] If path is nil/empty, directory doesn't exist, version is nil/empty,
   # or ttl is not nil or not Integer or not positive
-  def initialize(path, version, loog: Loog::NULL, maxsize: '10Mb', maxvsize: '10Kb', ttl: nil)
+  def initialize(path, version, loog: Loog::NULL, maxsize: '10Mb', maxvsize: '10Kb', ttl: nil, cache_min_age: nil)
     raise ArgumentError, 'Database path cannot be nil or empty' if path.nil? || path.empty?
     dir = File.dirname(path)
     raise ArgumentError, "Directory #{dir} does not exist" unless File.directory?(dir)
@@ -68,6 +69,10 @@ class Fbe::Middleware::SqliteStore
     @maxvsize = Filesize.from(maxvsize.to_s).to_i
     raise ArgumentError, 'TTL can be nil or Integer > 0' if !ttl.nil? && !(ttl.is_a?(Integer) && ttl.positive?)
     @ttl = ttl
+    if !cache_min_age.nil? && !(cache_min_age.is_a?(Integer) && cache_min_age.positive?)
+      raise ArgumentError, 'Cache min age can be nil or Integer > 0'
+    end
+    @cache_min_age = cache_min_age
   end
 
   # Read a value from the cache.
@@ -106,6 +111,26 @@ class Fbe::Middleware::SqliteStore
       req = JSON.parse(vv[0])
       req['method'] != 'get'
     end
+    if @cache_min_age && value.is_a?(Array) && value[0].is_a?(Array) && value[0].size > 1
+      begin
+        resp = JSON.parse(value[0][1])
+      rescue TypeError, JSON::ParserError => e
+        @loog.info("Failed to parse response to rewrite the cache age: #{e.message}")
+        resp = nil
+      end
+      cache_control = resp.dig('response_headers', 'cache-control') if resp.is_a?(Hash)
+      if cache_control && !cache_control.empty?
+        %w[max-age s-maxage].each do |key|
+          age = cache_control.scan(/#{key}=(\d+)/i).first&.first&.to_i
+          if age
+            age = [age, @cache_min_age].max
+            cache_control = cache_control.sub(/#{key}=(\d+)/, "#{key}=#{age}")
+          end
+        end
+        resp['response_headers']['cache-control'] = cache_control
+        value[0][1] = JSON.dump(resp)
+      end
+    end
     value = Zlib::Deflate.deflate(JSON.dump(value))
     return if value.bytesize > @maxvsize
     perform do |t|

data/lib/fbe/octo.rb

@@ -93,8 +93,9 @@ def Fbe.octo(options: $options, global: $global, loog: $loog)
             if options.sqlite_cache
               maxsize = Filesize.from(options.sqlite_cache_maxsize || '100M').to_i
               maxvsize = Filesize.from(options.sqlite_cache_maxvsize || '100K').to_i
+              cache_min_age = options.sqlite_cache_min_age&.to_i
               store = Fbe::Middleware::SqliteStore.new(
-                options.sqlite_cache, Fbe::VERSION, loog:, maxsize:, maxvsize:, ttl: 24
+                options.sqlite_cache, Fbe::VERSION, loog:, maxsize:, maxvsize:, ttl: 24, cache_min_age:
               )
               loog.info(
                 "Using HTTP cache in SQLite file: #{store.path} (" \

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

data/test/fbe/middleware/test_sqlite_store.rb

@@ -330,6 +330,94 @@ class SqliteStoreTest < Fbe::Test
     end
   end
 
+  def test_set_correct_cache_min_age
+    with_tmpfile('c.db') do |f|
+      s = Fbe::Middleware::SqliteStore.new(f, '0.0.1', loog: fake_loog, cache_min_age: nil)
+      refute_nil(s)
+      s = Fbe::Middleware::SqliteStore.new(f, '0.0.1', loog: fake_loog, cache_min_age: 600)
+      refute_nil(s)
+    end
+  end
+
+  def test_set_incorrect_cache_min_age
+    with_tmpfile('c.db') do |f|
+      msg = 'Cache min age can be nil or Integer > 0'
+      [0, -50, 120.0, '120', Object.new].each do |cache_min_age|
+        ex =
+          assert_raises(ArgumentError) do
+            Fbe::Middleware::SqliteStore.new(f, '0.0.1', loog: fake_loog, cache_min_age:)
+          end
+        assert_equal(msg, ex.message)
+      end
+    end
+  end
+
+  def test_not_overwrite_cache_control
+    with_tmpfile('t.db') do |f|
+      Fbe::Middleware::SqliteStore.new(f, '0.0.1', loog: fake_loog, cache_min_age: 30).then do |store|
+        store.write(
+          'test1',
+          faraday_value(resp: { 'response_headers' => { 'cache-control' => 'public, max-age=60, s-maxage=60' } })
+        )
+        store.write(
+          'test2',
+          faraday_value(resp: { 'response_headers' => { 'cache-control' => 'public, max-age=30, s-maxage=30' } })
+        )
+        store.write(
+          'test3',
+          faraday_value(resp: { 'response_headers' => { 'content-type' => 'application/json; charset=utf-8' } })
+        )
+        store.write('test4', faraday_value(resp: { 'status' => 200, 'body' => '{"some":"value"}' }))
+        store.write('test5', faraday_value(resp: {}))
+        store.write('test6', [[JSON.dump({ 'method' => 'get' }), 1]])
+        store.write('test7', faraday_value(resp: 'some string'))
+        store.write('test8', faraday_value(resp: nil))
+      end
+      Fbe::Middleware::SqliteStore.new(f, '0.0.1', loog: fake_loog).then do |store|
+        assert_equal(
+          'public, max-age=60, s-maxage=60',
+          JSON.parse(store.read('test1')[0][1]).dig('response_headers', 'cache-control')
+        )
+        assert_equal(
+          'public, max-age=30, s-maxage=30',
+          JSON.parse(store.read('test2')[0][1]).dig('response_headers', 'cache-control')
+        )
+        assert_nil(JSON.parse(store.read('test3')[0][1]).dig('response_headers', 'cache-control'))
+        assert_nil(JSON.parse(store.read('test4')[0][1]).dig('response_headers', 'cache-control'))
+        assert_nil(JSON.parse(store.read('test5')[0][1]).dig('response_headers', 'cache-control'))
+        assert_equal(1, store.read('test6')[0][1])
+        assert_equal(JSON.dump('some string'), store.read('test7')[0][1])
+        assert_nil(store.read('test8')[0][1])
+      end
+    end
+  end
+
+  def test_overwrite_cache_control
+    with_tmpfile('t.db') do |f|
+      Fbe::Middleware::SqliteStore.new(f, '0.0.1', loog: fake_loog, cache_min_age: 300).then do |store|
+        store.write(
+          'test1',
+          faraday_value(resp: { 'response_headers' => { 'cache-control' => 'public, max-age=60, s-maxage=60' } })
+        )
+      end
+      Fbe::Middleware::SqliteStore.new(f, '0.0.1', loog: fake_loog, cache_min_age: 1555).then do |store|
+        store.write(
+          'test2',
+          faraday_value(resp: { 'response_headers' => { 'cache-control' => 'public, max-age=60, s-maxage=60' } })
+        )
+      end
+      store = Fbe::Middleware::SqliteStore.new(f, '0.0.1', loog: fake_loog)
+      assert_equal(
+        'public, max-age=300, s-maxage=300',
+        JSON.parse(store.read('test1')[0][1]).dig('response_headers', 'cache-control')
+      )
+      assert_equal(
+        'public, max-age=1555, s-maxage=1555',
+        JSON.parse(store.read('test2')[0][1]).dig('response_headers', 'cache-control')
+      )
+    end
+  end
+
   private
 
   def with_tmpfile(name = 'test.db', &)
@@ -337,4 +425,22 @@ class SqliteStoreTest < Fbe::Test
       yield File.expand_path(name, dir)
     end
   end
+
+  def faraday_value(
+    req: {
+      'method' => 'get',
+      'url' => 'https://example.com/test',
+      'headers' => { 'Content-Type' => 'application/json' }
+    },
+    resp: {
+      'status' => 200,
+      'body' => '{"some":"value"}',
+      'response_headers' => { 'content-type' => 'application/json; charset=utf-8' }
+    }
+  )
+    value = []
+    value << JSON.dump(req) if req
+    value << JSON.dump(resp) if resp
+    [value]
+  end
 end

data/test/fbe/test_octo.rb

@@ -709,4 +709,53 @@ class TestOcto < Fbe::Test
       end
     end
   end
+
+  def test_octo_with_set_sqlite_cache_min_age
+    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
+      )
+    Dir.mktmpdir do |dir|
+      sqlite_cache = File.expand_path('t.db', dir)
+      options = Judges::Options.new({ 'sqlite_cache' => sqlite_cache, 'sqlite_cache_min_age' => 120 })
+      o = Fbe.octo(loog: fake_loog, global: {}, options:)
+      stub_request(:get, 'https://api.github.com/repositories/798641472').to_return(
+        status: 200,
+        body: { id: 798_641_472, name: 'factbase' }.to_json,
+        headers: {
+          'Date' => now.httpdate,
+          'Content-Type' => 'application/json; charset=utf-8',
+          'Cache-Control' => 'public, max-age=60, s-maxage=60',
+          'Etag' => 'W/"f5f1ea995fd7266816f681aca5a81f539420c469070a47568bebdaa3055487bc"',
+          'Last-Modified' => 'Fri, 04 Jul 2025 13:39:42 GMT'
+        }
+      ).times(1).then.to_raise('no more request to /repositories/798641472')
+      Time.stub(:now, now) do
+        assert_equal('factbase', o.repo(798_641_472)['name'])
+      end
+      Time.stub(:now, now + 50) do
+        assert_equal('factbase', o.repo(798_641_472)['name'])
+      end
+      Time.stub(:now, now + 100) do
+        assert_equal('factbase', o.repo(798_641_472)['name'])
+      end
+      stub_request(:get, 'https://api.github.com/repositories/798641472').to_return(
+        status: 200,
+        body: { id: 798_641_472, name: 'factbase_changed' }.to_json,
+        headers: {
+          'Date' => (now + 120).httpdate,
+          'Content-Type' => 'application/json; charset=utf-8',
+          'Cache-Control' => 'public, max-age=60, s-maxage=60',
+          'Etag' => 'W/"f5f1ea995fd7266816f681aca5a81f539420c469070a47568bebdaa3055487bc"',
+          'Last-Modified' => 'Fri, 04 Jul 2025 13:39:42 GMT'
+        }
+      )
+      Time.stub(:now, now + 120) do
+        assert_equal('factbase_changed', o.repo(798_641_472)['name'])
+      end
+    end
+  end
 end

metadata

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