fbe 0.19.1 → 0.19.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4f97f9d210de0a591fd2649095d07a8e6415a13b74d7abce02322d84cdcb29fd
-  data.tar.gz: 864239e8b577903cb9c3c1cad53e2d267f31de6839df37ecca8123d1a1340d84
+  metadata.gz: df9755e6d4d7bf5ae3a716031216786929ddfcdf328a3f026b308e9bbfc93f92
+  data.tar.gz: ed1cfe9f9877a3e3e1b77f30f4b9c8ca525885306d100058d5397019ca1005e6
 SHA512:
-  metadata.gz: ac1618f1d123e8ef210f33fe73e23d3b324bea096d3bfc18f97f9671100f0a75312524ea8fbb9eead93cb9e1c22635def15365e99f35e2000abbd89b209d3f51
-  data.tar.gz: f69b7743409715b8fb42b44641414e235cc6c259316ea8427fa19295c23a50cb9d40750721a9a18d1873ca511f3434a37042fee3857fb117c0975e00c2fa031d
+  metadata.gz: 3bfc015d2f0c47035fae903627404da6fafcd823c14abdcdc8a37694fea73bbb4edd1f1467497379fff51e62388b741a205b28bcd0ee8a4b5c28aceaf0f6c22c
+  data.tar.gz: dc92c946e0d1bd14deb3d29a73b36f9317d7e06597ac2ec4fc05030ed9afea415830a71f101eb54ddd2793a02a3c6b480d2a2b95482f3deb0d62903230b1432e

data/lib/fbe/middleware/sqlite_store.rb

@@ -21,9 +21,6 @@ class Fbe::Middleware::SqliteStore
     dir = File.dirname(path)
     raise ArgumentError, "Directory #{dir} does not exist" unless File.directory?(dir)
     @path = File.absolute_path(path)
-    open
-    prepare
-    at_exit { close }
   end
 
   def read(key)
@@ -37,9 +34,13 @@ class Fbe::Middleware::SqliteStore
   end
 
   def write(key, value)
+    return if value.is_a?(Array) && value.any? do |vv|
+      req = JSON.parse(vv[0])
+      req['url'].include?('?') || req['method'] != 'get'
+    end
     value = JSON.dump(value)
-    perform do |tdb|
-      tdb.execute(<<~SQL, [key, value])
+    perform do |t|
+      t.execute(<<~SQL, [key, value])
         INSERT INTO cache(key, value) VALUES(?1, ?2)
         ON CONFLICT(key) DO UPDATE SET value = ?2
       SQL
@@ -47,32 +48,10 @@ class Fbe::Middleware::SqliteStore
     nil
   end
 
-  def open
-    return if @db
-    @db = SQLite3::Database.new(@path)
-  end
-
-  def prepare
-    perform do |tdb|
-      tdb.execute 'CREATE TABLE IF NOT EXISTS cache(key TEXT UNIQUE NOT NULL, value TEXT);'
-      tdb.execute 'CREATE INDEX IF NOT EXISTS key_idx ON cache(key);'
-    end
-  end
-
-  def close
-    return if !@db || @db.closed?
-    @db.close
-    @db = nil
-  end
-
   def clear
     perform { _1.execute 'DELETE FROM cache;' }
   end
 
-  def drop
-    perform { _1.execute 'DROP TABLE IF EXISTS cache;' }
-  end
-
   def all
     perform { _1.execute('SELECT key, value FROM cache') }
   end
@@ -80,6 +59,14 @@ class Fbe::Middleware::SqliteStore
   private
 
   def perform(&)
+    @db ||=
+      SQLite3::Database.new(@path).tap do |d|
+        d.transaction do |t|
+          t.execute 'CREATE TABLE IF NOT EXISTS cache(key TEXT UNIQUE NOT NULL, value TEXT);'
+          t.execute 'CREATE INDEX IF NOT EXISTS key_idx ON cache(key);'
+        end
+        at_exit { @db&.close }
+      end
     @db.transaction(&)
   end
 end

data/lib/fbe/octo.rb

@@ -47,7 +47,7 @@ def Fbe.octo(options: $options, global: $global, loog: $loog)
             loog.debug("The 'GITHUB_TOKEN' environment was provided")
           end
         else
-          loog.debug("The 'github_token' option was provided")
+          loog.debug("The 'github_token' option was provided (#{token.length} chars)")
         end
         if token.nil?
           loog.warn('Accessing GitHub API without a token!')
@@ -55,10 +55,6 @@ def Fbe.octo(options: $options, global: $global, loog: $loog)
           loog.warn('The GitHub API token is an empty string, won\'t use it')
         else
           o = Octokit::Client.new(access_token: token)
-          loog.info(
-            "Accessing GitHub API with a token (#{token.length} chars, ending by #{token[-4..].inspect}, " \
-            "#{Octokit::Client.new(access_token: token).rate_limit.remaining} quota remaining)"
-          )
         end
         o.auto_paginate = true
         o.per_page = 100
@@ -80,16 +76,24 @@ def Fbe.octo(options: $options, global: $global, loog: $loog)
               methods: [:get],
               backoff_factor: 2
             )
-            serializer = Marshal
             if options.sqlite_cache
               store = Fbe::Middleware::SqliteStore.new(options.sqlite_cache)
-              serializer = JSON
-              loog.info("Using HTTP cache in SQLite file: #{store.path}")
+              loog.info(
+                "Using HTTP cache in SQLite file: #{store.path} (" \
+                "#{File.exist?(store.path) ? "#{File.size(store.path)} bytes" : 'file is absent'}" \
+                ')'
+              )
+              builder.use(
+                Faraday::HttpCache,
+                store:, serializer: JSON, shared_cache: false, logger: Loog::NULL
+              )
+            else
+              loog.info("No HTTP cache in SQLite file, because 'sqlite_cache' option is not provided")
+              builder.use(
+                Faraday::HttpCache,
+                serializer: Marshal, shared_cache: false, logger: Loog::NULL
+              )
             end
-            builder.use(
-              Faraday::HttpCache,
-              store: store, serializer: serializer, shared_cache: false, logger: Loog::NULL
-            )
             builder.use(Octokit::Response::RaiseError)
             builder.use(Faraday::Response::Logger, loog, formatter: Fbe::Middleware::Formatter)
             builder.use(Fbe::Middleware::Trace, trace)
@@ -97,6 +101,12 @@ def Fbe.octo(options: $options, global: $global, loog: $loog)
           end
         o.middleware = stack
         o = Verbose.new(o, log: loog)
+        unless token.nil? || token.empty?
+          loog.info(
+            "Accessing GitHub API with a token (#{token.length} chars, ending by #{token[-4..].inspect}, " \
+            "#{o.rate_limit.remaining} quota remaining)"
+          )
+        end
       else
         loog.debug('The connection to GitHub API is mocked')
         o = Fbe::FakeOctokit.new

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

data/test/fbe/middleware/test_sqlite_store.rb

@@ -3,6 +3,7 @@
 # SPDX-FileCopyrightText: Copyright (c) 2024-2025 Zerocracy
 # SPDX-License-Identifier: MIT
 
+require 'qbash'
 require_relative '../../test__helper'
 require_relative '../../../lib/fbe/middleware'
 require_relative '../../../lib/fbe/middleware/sqlite_store'
@@ -12,24 +13,107 @@ require_relative '../../../lib/fbe/middleware/sqlite_store'
 # Copyright:: Copyright (c) 2024-2025 Zerocracy
 # License:: MIT
 class SqliteStoreTest < Fbe::Test
-  def test_sqlite_store
-    Dir.mktmpdir do |dir|
-      store = Fbe::Middleware::SqliteStore.new(File.expand_path('test.db', dir))
-      assert_nil(store.read('my_key'))
-      assert_nil(store.delete('my_key'))
-      assert_nil(store.write('my_key', 'some value'))
-      assert_equal('some value', store.read('my_key'))
-      assert_nil(store.write('my_key', 'some value 2'))
-      assert_equal('some value 2', store.read('my_key'))
-      assert_nil(store.delete('my_key'))
-      assert_nil(store.read('my_key'))
+  def test_simple_caching_algorithm
+    with_tmpfile('x.db') do |f|
+      store = Fbe::Middleware::SqliteStore.new(f)
+      k = 'some-key'
+      assert_nil(store.read(k))
+      assert_nil(store.delete(k))
+      v1 = 'first value to save'
+      assert_nil(store.write(k, v1))
+      assert_equal(v1, store.read(k))
+      v2 = 'another value to save'
+      assert_nil(store.write(k, v2))
+      assert_equal(v2, store.read(k))
+      assert_nil(store.delete(k))
+      assert_nil(store.read(k))
+      assert_path_exists(f)
     end
   end
 
-  def test_sqlite_store_empty_all
-    Dir.mktmpdir do |dir|
-      store = Fbe::Middleware::SqliteStore.new(File.expand_path('test.db', dir))
+  def test_returns_empty_list
+    with_tmpfile('b.db') do |f|
+      store = Fbe::Middleware::SqliteStore.new(f)
+      assert_empty(store.all)
+    end
+  end
+
+  def test_clear_all_keys
+    with_tmpfile('a.db') do |f|
+      store = Fbe::Middleware::SqliteStore.new(f)
+      k = 'a key'
+      store.write(k, 'some value')
+      store.clear
+      assert_empty(store.all)
+    end
+  end
+
+  def test_empty_all_if_not_written
+    with_tmpfile do |f|
+      store = Fbe::Middleware::SqliteStore.new(f)
       assert_empty(store.all)
     end
   end
+
+  def test_wrong_db_path
+    assert_raises(ArgumentError) do
+      Fbe::Middleware::SqliteStore.new(nil).read('my_key')
+    end
+    assert_raises(ArgumentError) do
+      Fbe::Middleware::SqliteStore.new('').read('my_key')
+    end
+    assert_raises(ArgumentError) do
+      Fbe::Middleware::SqliteStore.new('/fakepath/fakefolder/test.db').read('my_key')
+    end
+  end
+
+  def test_not_db_file
+    with_tmpfile do |f|
+      File.binwrite(f, Array.new(20) { rand(0..255) }.pack('C*'))
+      ex =
+        assert_raises(SQLite3::NotADatabaseException) do
+          Fbe::Middleware::SqliteStore.new(f).read('my_key')
+        end
+      assert_match('file is not a database', ex.message)
+    end
+  end
+
+  def test_defer_db_close_callback
+    txt = <<~RUBY
+      require 'tempfile'
+      require 'sqlite3'
+      require 'fbe/middleware/sqlite_store'
+
+      SQLite3::Database.class_eval do
+        prepend(Module.new do
+          def close
+            super
+            puts 'closed sqlite after process exit'
+          end
+        end)
+      end
+
+      Tempfile.open('test.db') do |f|
+        Fbe::Middleware::SqliteStore.new(f.path).then do |s|
+          s.write('my_key', 'my_value')
+          s.read('my_key')
+        end
+      end
+    RUBY
+    out =
+      qbash(
+        'bundle exec ruby ' \
+        "-I#{Shellwords.escape(File.expand_path('../../../lib', __dir__))} " \
+        "-e #{Shellwords.escape(txt)} 2>&1"
+      )
+    assert_match('closed sqlite after process exit', out)
+  end
+
+  private
+
+  def with_tmpfile(name = 'test.db', &)
+    Dir.mktmpdir do |dir|
+      yield File.expand_path(name, dir)
+    end
+  end
 end

data/test/fbe/test_octo.rb

@@ -138,10 +138,8 @@ class TestOcto < Fbe::Test
       body: '{}', headers: { 'X-RateLimit-Remaining' => '1234' }
     )
     buf = Loog::Buffer.new
-    o = Fbe.octo(loog: buf, global: {}, options: Judges::Options.new({ 'github_token' => 'secret_github_token' }))
+    Fbe.octo(loog: buf, global: {}, options: Judges::Options.new({ 'github_token' => 'secret_github_token' }))
     assert_match(/Accessing GitHub API with a token \(19 chars, ending by "oken", 1234 quota remaining\)/, buf.to_s)
-    assert_nil(o.last_response, 'Not to be requests until initialize main Octokit client, ' \
-                                'because middleware cached after first request and not apply after')
   end
 
   def test_retrying
@@ -258,7 +256,10 @@ class TestOcto < Fbe::Test
   end
 
   def test_reads_quota
-    WebMock.enable_net_connect!
+    WebMock.disable_net_connect!
+    stub_request(:get, 'https://api.github.com/rate_limit').to_return(
+      { body: '{}', headers: { 'X-RateLimit-Remaining' => '222' } }
+    )
     o = Fbe.octo(loog: Loog::VERBOSE, global: {}, options: Judges::Options.new({ 'github_api_pause' => 0.01 }))
     refute_nil(o.off_quota?)
   end
@@ -367,7 +368,7 @@ class TestOcto < Fbe::Test
     assert_includes second_output, 'GitHub API trace is empty'
   end
 
-  def test_sqlite_store
+  def test_works_via_sqlite_store
     WebMock.disable_net_connect!
     Dir.mktmpdir do |dir|
       global = {}
@@ -390,4 +391,18 @@ class TestOcto < Fbe::Test
       assert_equal('user1', o.user_name_by_id(42))
     end
   end
+
+  def test_through_sqlite_store_when_broken_token
+    WebMock.disable_net_connect!
+    Dir.mktmpdir do |dir|
+      global = {}
+      file = File.expand_path('test.db', dir)
+      stub_request(:get, 'https://api.github.com/user/4242').to_return(status: 401)
+      o = Fbe.octo(loog: Loog::NULL, global:, options: Judges::Options.new({ 'sqlite_cache' => file }))
+      assert_raises(StandardError) do
+        assert_equal('user1', o.user_name_by_id(4242))
+      end
+      assert_path_exists(file)
+    end
+  end
 end

metadata

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