fbe 0.24.3 → 0.24.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ce758baa2b569c87b5c6318bd2a58df0a5041c578164bb07f337c197a83ef4a7
-  data.tar.gz: fa85c249bc4ea36ecf435e0412bccd9a1c8885ed222f0538be0c02ebd4f59ccc
+  metadata.gz: 92baa5e54a0df9b2e57f2d6619cfad4d4ee1b4a4150b1e30b82780062dd9bd34
+  data.tar.gz: ac08a108536716ff130271018211616e02b58a55dcef303bed0c0d01808387eb
 SHA512:
-  metadata.gz: 43e184c1ee6955ca80cd5a4ba01aa47cf5e59ce8ad1767c03e535c77c253a1bb9223d6603825ef99c6d094828d03e3ae7b6a68e3cc4b7766cfb108c3058fa714
-  data.tar.gz: f1399b8d6b1022a2460f6c1049bd2b58aa924933773c0bdbec3cc21ba65e28aeca6712d382fdd070e0ec5f44f8c5ac3608aacdb9d87857c11f00b45bc6efd728
+  metadata.gz: 4b87c1fefa9477f19588b01eeb7a7d593ca38f1eed068fe7d27a84a66b4cc35214f83b8f6128a169a007df962063f4ae5373442a17c61d12f1c7e876c1099ef6
+  data.tar.gz: ae01c566bca05de64432b34b6f27bbf82497d5d72817c5bbb0ef9f80e0f62f742681f1ae820d30bc081d891b31f926369ee1f0efe42e4b778a0223b4be26959e

data/.rubocop.yml

@@ -56,3 +56,5 @@ Metrics/ParameterLists:
   Enabled: false
 Layout/MultilineAssignmentLayout:
   Enabled: true
+Style/RequireOrder:
+  Enabled: true

data/Rakefile

@@ -4,9 +4,9 @@
 # SPDX-License-Identifier: MIT
 
 require 'qbash'
-require 'rubygems'
 require 'rake'
 require 'rake/clean'
+require 'rubygems'
 
 def name
   @name ||= File.basename(Dir['*.gemspec'].first, '.*')

data/lib/fbe/conclude.rb

@@ -6,8 +6,8 @@
 require 'tago'
 require_relative '../fbe'
 require_relative 'fb'
-require_relative 'octo'
 require_relative 'if_absent'
+require_relative 'octo'
 
 # Creates an instance of {Fbe::Conclude} and evals it with the block provided.
 #

data/lib/fbe/fb.rb

@@ -4,11 +4,11 @@
 # SPDX-License-Identifier: MIT
 
 require 'factbase'
+require 'factbase/cached/cached_factbase'
+require 'factbase/indexed/indexed_factbase'
 require 'factbase/logged'
 require 'factbase/pre'
 require 'factbase/rules'
-require 'factbase/cached/cached_factbase'
-require 'factbase/indexed/indexed_factbase'
 require 'factbase/sync/sync_factbase'
 require 'judges'
 require 'loog'

data/lib/fbe/just_one.rb

@@ -3,8 +3,8 @@
 # SPDX-FileCopyrightText: Copyright (c) 2024-2025 Zerocracy
 # SPDX-License-Identifier: MIT
 
-require 'time'
 require 'others'
+require 'time'
 require_relative '../fbe'
 require_relative 'fb'
 

data/lib/fbe/middleware/formatter.rb

@@ -3,6 +3,7 @@
 # SPDX-FileCopyrightText: Copyright (c) 2024-2025 Zerocracy
 # SPDX-License-Identifier: MIT
 
+require 'ellipsized'
 require 'faraday'
 require 'faraday/logging/formatter'
 require_relative '../../fbe'
@@ -66,6 +67,21 @@ class Fbe::Middleware::Formatter < Faraday::Logging::Formatter
       )
       return
     end
+    if http.status >= 500 && http.response_headers['content-type']&.start_with?('text')
+      error(
+        [
+          "#{@req.method.upcase} #{apply_filters(@req.url.to_s)} HTTP/1.1",
+          shifted(apply_filters(dump_headers(@req.request_headers))),
+          '',
+          shifted(apply_filters(@req.request_body)),
+          "HTTP/1.1 #{http.status}",
+          shifted(apply_filters(dump_headers(http.response_headers))),
+          '',
+          shifted(apply_filters(http.response_body&.ellipsized(100, :right)))
+        ].join("\n")
+      )
+      return
+    end
     error(
       [
         "#{@req.method.upcase} #{apply_filters(@req.url.to_s)} HTTP/1.1",

data/lib/fbe/middleware/sqlite_store.rb

@@ -3,12 +3,12 @@
 # SPDX-FileCopyrightText: Copyright (c) 2024-2025 Zerocracy
 # SPDX-License-Identifier: MIT
 
-require 'zlib'
 require 'filesize'
 require 'json'
 require 'loog'
 require 'sqlite3'
 require 'time'
+require 'zlib'
 require_relative '../../fbe'
 require_relative '../../fbe/middleware'
 
@@ -53,8 +53,10 @@ class Fbe::Middleware::SqliteStore
   # @param loog [Loog] Logger instance (optional, defaults to Loog::NULL)
   # @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)
-  # @raise [ArgumentError] If path is nil/empty, directory doesn't exist, or version is nil/empty
-  def initialize(path, version, loog: Loog::NULL, maxsize: '10Mb', maxvsize: '10Kb')
+  # @param ttl [Integer, nil] lifetime of keys in hours
+  # @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)
     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)
@@ -64,6 +66,8 @@ class Fbe::Middleware::SqliteStore
     @loog = loog
     @maxsize = Filesize.from(maxsize.to_s).to_i
     @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
   end
 
   # Read a value from the cache.
@@ -106,8 +110,8 @@ class Fbe::Middleware::SqliteStore
     return if value.bytesize > @maxvsize
     perform do |t|
       t.execute(<<~SQL, [key, value, Time.now.utc.iso8601])
-        INSERT INTO cache(key, value, touched_at) VALUES(?1, ?2, ?3)
-        ON CONFLICT(key) DO UPDATE SET value = ?2, touched_at = ?3
+        INSERT INTO cache(key, value, touched_at, created_at) VALUES(?1, ?2, ?3, ?3)
+        ON CONFLICT(key) DO UPDATE SET value = ?2, touched_at = ?3, created_at = ?3
       SQL
     end
     nil
@@ -153,10 +157,29 @@ class Fbe::Middleware::SqliteStore
             SQL
             t.execute 'INSERT INTO cache SELECT * FROM cache_old;'
             t.execute 'DROP TABLE cache_old;'
+            t.execute 'CREATE INDEX IF NOT EXISTS cache_key_idx ON cache(key);'
             t.execute 'CREATE INDEX IF NOT EXISTS cache_touched_at_idx ON cache(touched_at);'
           end
           d.execute 'VACUUM;'
         end
+        if d.execute("SELECT 1 FROM pragma_table_info('cache') WHERE name = 'created_at';").dig(0, 0) != 1
+          d.transaction do |t|
+            t.execute 'ALTER TABLE cache ADD COLUMN created_at TEXT;'
+            t.execute 'UPDATE cache set created_at = ?;', [Time.now.utc.iso8601]
+            t.execute 'ALTER TABLE cache RENAME TO cache_old;'
+            t.execute <<~SQL
+              CREATE TABLE IF NOT EXISTS cache(
+                key TEXT UNIQUE NOT NULL, value TEXT, touched_at TEXT NOT NULL, created_at TEXT NOT NULL
+              );
+            SQL
+            t.execute 'INSERT INTO cache SELECT * FROM cache_old;'
+            t.execute 'DROP TABLE cache_old;'
+            t.execute 'CREATE INDEX IF NOT EXISTS cache_key_idx ON cache(key);'
+            t.execute 'CREATE INDEX IF NOT EXISTS cache_touched_at_idx ON cache(touched_at);'
+            t.execute 'CREATE INDEX IF NOT EXISTS cache_created_at_idx ON cache(created_at);'
+          end
+          d.execute 'VACUUM;'
+        end
         found = d.execute("SELECT value FROM meta WHERE key = 'version' LIMIT 1;").dig(0, 0)
         if found != @version
           @loog.info("Version mismatch in SQLite cache: stored '#{found}' != current '#{@version}', cleaning up")
@@ -166,6 +189,15 @@ class Fbe::Middleware::SqliteStore
           end
           d.execute 'VACUUM;'
         end
+        unless @ttl.nil?
+          d.transaction do |t|
+            t.execute <<~SQL, [(Time.now.utc - (@ttl * 60 * 60)).iso8601]
+              DELETE FROM cache
+              WHERE key IN (SELECT key FROM cache WHERE (created_at < ?));
+            SQL
+          end
+          d.execute 'VACUUM;'
+        end
         if File.size(@path) > @maxsize
           @loog.info(
             "SQLite cache file size (#{Filesize.from(File.size(@path).to_s).pretty} bytes) exceeds " \

data/lib/fbe/octo.rb

@@ -93,7 +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
-              store = Fbe::Middleware::SqliteStore.new(options.sqlite_cache, Fbe::VERSION, loog:, maxsize:, maxvsize:)
+              store = Fbe::Middleware::SqliteStore.new(
+                options.sqlite_cache, Fbe::VERSION, loog:, maxsize:, maxvsize:, ttl: 24
+              )
               loog.info(
                 "Using HTTP cache in SQLite file: #{store.path} (" \
                 "#{File.exist?(store.path) ? Filesize.from(File.size(store.path).to_s).pretty : 'file is absent'}, " \

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

data/test/fbe/middleware/test_formatter.rb

@@ -5,10 +5,11 @@
 
 require 'faraday'
 require 'loog'
-require_relative '../../test__helper'
+require 'securerandom'
 require_relative '../../../lib/fbe'
 require_relative '../../../lib/fbe/middleware'
 require_relative '../../../lib/fbe/middleware/formatter'
+require_relative '../../test__helper'
 
 # Test.
 # Author:: Yegor Bugayenko (yegor256@gmail.com)
@@ -49,9 +50,38 @@ class LoggingFormatterTest < Fbe::Test
     end
   end
 
+  def test_truncate_body_for_error_text_response
+    body = SecureRandom.alphanumeric(120)
+    log_it(
+      status: 502,
+      response_body: body,
+      response_headers: {
+        'content-type' => 'text/html; charset=utf-8',
+        'x-github-api-version-selected' => '2022-11-28'
+      }
+    ) do |loog|
+      str = loog.to_s
+      refute_empty(str)
+      [
+        %r{http://example.com},
+        /Authorization:/,
+        /some request body/,
+        %r{HTTP/1.1 502},
+        /x-github-api-version-selected: "2022-11-28"/,
+        %r{content-type: "text/html; charset=utf-8"},
+        "#{body.slice(0, 97)}..."
+      ].each { |ptn| assert_match(ptn, str) }
+    end
+  end
+
   private
 
-  def log_it(status:, method: :get)
+  def log_it(
+    status:,
+    method: :get,
+    response_body: '{"message": "hello, world!"}',
+    response_headers: { 'content-type' => 'application/json', 'x-github-api-version-selected' => '2022-11-28' }
+  )
     loog = Loog::Buffer.new
     formatter = Fbe::Middleware::Formatter.new(logger: loog, options: {})
     formatter.request(
@@ -67,16 +97,7 @@ class LoggingFormatterTest < Fbe::Test
       )
     )
     formatter.response(
-      Faraday::Env.from(
-        {
-          status:,
-          response_body: '{"message": "hello, world!"}',
-          response_headers: {
-            'content-type' => 'application/json',
-            'x-github-api-version-selected' => '2022-11-28'
-          }
-        }
-      )
+      Faraday::Env.from({ status:, response_body:, response_headers: })
     )
     yield loog
   end

data/test/fbe/middleware/test_rate_limit.rb

@@ -5,10 +5,10 @@
 
 require 'faraday'
 require 'webmock'
-require_relative '../../test__helper'
 require_relative '../../../lib/fbe'
 require_relative '../../../lib/fbe/middleware'
 require_relative '../../../lib/fbe/middleware/rate_limit'
+require_relative '../../test__helper'
 
 # Test.
 # Author:: Yegor Bugayenko (yegor256@gmail.com)

data/test/fbe/middleware/test_sqlite_store.rb

@@ -3,11 +3,11 @@
 # SPDX-FileCopyrightText: Copyright (c) 2024-2025 Zerocracy
 # SPDX-License-Identifier: MIT
 
-require 'securerandom'
 require 'qbash'
-require_relative '../../test__helper'
+require 'securerandom'
 require_relative '../../../lib/fbe/middleware'
 require_relative '../../../lib/fbe/middleware/sqlite_store'
+require_relative '../../test__helper'
 
 # Test.
 # Author:: Yegor Bugayenko (yegor256@gmail.com)
@@ -237,6 +237,99 @@ class SqliteStoreTest < Fbe::Test
     end
   end
 
+  def test_upgrade_sqlite_schema_for_add_created_at_column
+    with_tmpfile('a.db') do |f|
+      SQLite3::Database.new(f).tap do |d|
+        d.execute 'CREATE TABLE IF NOT EXISTS cache(key TEXT UNIQUE NOT NULL, value TEXT, touched_at TEXT NOT NULL);'
+        [
+          ['key1', Zlib::Deflate.deflate(JSON.dump('value1')), Time.now.utc.iso8601],
+          ['key2', Zlib::Deflate.deflate(JSON.dump('value2')), Time.now.utc.iso8601]
+        ].each { d.execute 'INSERT INTO cache(key, value, touched_at) VALUES(?1, ?2, ?3);', _1 }
+        d.execute 'CREATE TABLE IF NOT EXISTS meta(key TEXT UNIQUE NOT NULL, value TEXT);'
+        d.execute "INSERT INTO meta(key, value) VALUES('version', ?);", ['0.0.1']
+      end
+      Fbe::Middleware::SqliteStore.new(f, '0.0.1', loog: fake_loog).then do |store|
+        assert_equal('value1', store.read('key1'))
+        assert_equal('value2', store.read('key2'))
+      rescue SQLite3::SQLException => e
+        assert_nil(e)
+      end
+    end
+  end
+
+  def test_set_correct_ttl
+    with_tmpfile('c.db') do |f|
+      s = Fbe::Middleware::SqliteStore.new(f, '0.0.1', loog: fake_loog, ttl: nil)
+      refute_nil(s)
+      s = Fbe::Middleware::SqliteStore.new(f, '0.0.1', loog: fake_loog, ttl: 24)
+      refute_nil(s)
+    end
+  end
+
+  def test_set_incorrect_ttl
+    with_tmpfile('c.db') do |f|
+      ex =
+        assert_raises(ArgumentError) do
+          Fbe::Middleware::SqliteStore.new(f, '0.0.1', loog: fake_loog, ttl: 0)
+        end
+      assert_equal('TTL can be nil or Integer > 0', ex.message)
+      ex =
+        assert_raises(ArgumentError) do
+          Fbe::Middleware::SqliteStore.new(f, '0.0.1', loog: fake_loog, ttl: -10)
+        end
+      assert_equal('TTL can be nil or Integer > 0', ex.message)
+      ex =
+        assert_raises(ArgumentError) do
+          Fbe::Middleware::SqliteStore.new(f, '0.0.1', loog: fake_loog, ttl: 10.0)
+        end
+      assert_equal('TTL can be nil or Integer > 0', ex.message)
+      ex =
+        assert_raises(ArgumentError) do
+          Fbe::Middleware::SqliteStore.new(f, '0.0.1', loog: fake_loog, ttl: '10')
+        end
+      assert_equal('TTL can be nil or Integer > 0', ex.message)
+      ex =
+        assert_raises(ArgumentError) do
+          Fbe::Middleware::SqliteStore.new(f, '0.0.1', loog: fake_loog, ttl: Object.new)
+        end
+      assert_equal('TTL can be nil or Integer > 0', ex.message)
+    end
+  end
+
+  def test_delete_keys_if_ttl_expired
+    with_tmpfile('c.db') do |f|
+      now = Time.now
+      Time.stub(:now, now) do
+        Fbe::Middleware::SqliteStore.new(f, '0.0.1', loog: fake_loog, ttl: 24).then do |s|
+          s.write('test1', 'value1')
+          s.write('test2', 'value2')
+        end
+      end
+      Time.stub(:now, now + (12 * 60 * 60)) do
+        Fbe::Middleware::SqliteStore.new(f, '0.0.1', loog: fake_loog, ttl: 24).then do |s|
+          s.write('test3', 'value3')
+          s.write('test4', 'value4')
+        end
+      end
+      Time.stub(:now, now + (24 * 60 * 60)) do
+        Fbe::Middleware::SqliteStore.new(f, '0.0.1', loog: fake_loog, ttl: 24).then do |s|
+          assert_equal('value1', s.read('test1'))
+          assert_equal('value2', s.read('test2'))
+          assert_equal('value3', s.read('test3'))
+          assert_equal('value4', s.read('test4'))
+        end
+      end
+      Time.stub(:now, now + (24 * 60 * 60) + 1) do
+        Fbe::Middleware::SqliteStore.new(f, '0.0.1', loog: fake_loog, ttl: 24).then do |s|
+          assert_nil(s.read('test1'))
+          assert_nil(s.read('test2'))
+          assert_equal('value3', s.read('test3'))
+          assert_equal('value4', s.read('test4'))
+        end
+      end
+    end
+  end
+
   private
 
   def with_tmpfile(name = 'test.db', &)

data/test/fbe/middleware/test_trace.rb

@@ -6,10 +6,10 @@
 require 'faraday'
 require 'faraday/http_cache'
 require 'webmock'
-require_relative '../../test__helper'
 require_relative '../../../lib/fbe'
 require_relative '../../../lib/fbe/middleware'
 require_relative '../../../lib/fbe/middleware/trace'
+require_relative '../../test__helper'
 
 # Test.
 # Author:: Yegor Bugayenko (yegor256@gmail.com)

data/test/fbe/test_github_graph.rb

@@ -4,10 +4,10 @@
 # SPDX-License-Identifier: MIT
 
 require 'judges/options'
-require 'webmock/minitest'
 require 'loog'
-require_relative '../test__helper'
+require 'webmock/minitest'
 require_relative '../../lib/fbe/github_graph'
+require_relative '../test__helper'
 
 # Test.
 # Author:: Yegor Bugayenko (yegor256@gmail.com)

data/test/fbe/test_if_absent.rb

@@ -3,11 +3,11 @@
 # SPDX-FileCopyrightText: Copyright (c) 2024-2025 Zerocracy
 # SPDX-License-Identifier: MIT
 
-require 'tmpdir'
 require 'factbase'
 require 'loog'
-require_relative '../test__helper'
+require 'tmpdir'
 require_relative '../../lib/fbe/if_absent'
+require_relative '../test__helper'
 
 # Test.
 # Author:: Yegor Bugayenko (yegor256@gmail.com)

data/test/fbe/test_just_one.rb

@@ -4,8 +4,8 @@
 # SPDX-License-Identifier: MIT
 
 require 'factbase'
-require_relative '../test__helper'
 require_relative '../../lib/fbe/just_one'
+require_relative '../test__helper'
 
 # Test.
 # Author:: Yegor Bugayenko (yegor256@gmail.com)

data/test/fbe/test_unmask_repos.rb

@@ -5,8 +5,8 @@
 
 require 'judges/options'
 require 'loog'
-require_relative '../test__helper'
 require_relative '../../lib/fbe/unmask_repos'
+require_relative '../test__helper'
 
 # Test.
 # Author:: Yegor Bugayenko (yegor256@gmail.com)

data/test/test__helper.rb

@@ -32,8 +32,8 @@ require 'minitest/reporters'
 Minitest::Reporters.use! [Minitest::Reporters::SpecReporter.new]
 
 require 'loog'
-require 'minitest/stub_const'
 require 'minitest/autorun'
+require 'minitest/stub_const'
 require 'webmock/minitest'
 require_relative '../lib/fbe'
 

data/test/test_fbe.rb

@@ -3,8 +3,8 @@
 # SPDX-FileCopyrightText: Copyright (c) 2024-2025 Zerocracy
 # SPDX-License-Identifier: MIT
 
-require_relative 'test__helper'
 require_relative '../lib/fbe'
+require_relative 'test__helper'
 
 # Main module test.
 # Author:: Yegor Bugayenko (yegor256@gmail.com)

metadata

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