extralite 3.1.3 → 3.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 49e8816c10db2687c32a0339d55c3027c1e8c071692bd83de6dfa0be4972a3b8
-  data.tar.gz: 9910eaa68101d1099981f22476488b743b287008fc4d9b2c16d1e553c7fad684
+  metadata.gz: 5281aeb88afdc13d5ab8997ef3d268b5c2f23bba5c10121d82d93fa1b0c6683e
+  data.tar.gz: 98c7ebcc643f1c228e7dd154530363d2b590c32e8c6ec2048ab680e6ef8dff29
 SHA512:
-  metadata.gz: 5c26195a522ab6a4b356f70b230f17dd76e49635f44a22e0a40e18ac4ee380357c7b2879c45b2d7e9e96c3fac85831dfa1791b0d13939c16c2cb1c898c73e0b7
-  data.tar.gz: 8c9c0e088738ef416c56e9dd429a2b6597b7a75c74557a3b7f353ddc521a24c72b31ef2d7cfff787347260f2cadcbc9d1a38557883ebe495ab48a4bd2d0e0f21
+  metadata.gz: 500b76bae6913d602bfea5a611e0dab55a36563b665afc9ad48143c379cd6c7cfffa768a35dfaec966286197dbc1e1bdf02a4d7203bab6f3adf4b10c14ff92e3
+  data.tar.gz: d93b59540dfd75a7ddb1d0477e48cf064d49e1c8800f18b7953f7a04e58a756c48f6e3dac71e6d3d8df4463faa3a573aafb942bbf3e93170a630e5dcaf9dad12

data/.github/workflows/test-asan.yml

@@ -0,0 +1,37 @@
+name: Tests (AddressSanitizer)
+
+on: [push, pull_request]
+
+concurrency:
+  group: tests-${{ format('{0}-{1}', github.head_ref || github.run_number, github.job) }}
+  cancel-in-progress: true
+
+jobs:
+  asan:
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          # Ruby is not instrumented, rake test:asan preloads libasan
+          - { ruby: '3.4', os: ubuntu-latest, test_task: 'test:asan' }
+          - { ruby: '4.0', os: ubuntu-latest, test_task: 'test:asan' }
+          # Ruby built with ASan (latest stable release), only on ubuntu-24.04
+          - { ruby: 'asan-release', os: ubuntu-24.04, test_task: 'test' }
+
+    name: ASan, ${{matrix.ruby}}
+
+    if: github.event_name != 'pull_request' || github.event.pull_request.head.repo.full_name != github.event.pull_request.base.repo.full_name
+
+    runs-on: ${{matrix.os}}
+    steps:
+    - uses: actions/checkout@v4
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{matrix.ruby}}
+        bundler-cache: true
+    - name: Compile C-extension with ASan (bundled SQLite)
+      run: EXTRALITE_BUNDLE=1 EXTRALITE_ASAN=1 bundle exec rake compile
+    - name: Run tests
+      run: bundle exec rake ${{matrix.test_task}}
+    - name: Run tests with GC.stress
+      run: EXTRALITE_GC_STRESS=1 bundle exec rake ${{matrix.test_task}}

data/.gitignore

@@ -51,7 +51,7 @@ build-iPhoneSimulator/
 # for a library or gem, you might want to ignore these files since the code is
 # intended to run in multiple environments; otherwise, check them in:
 # Gemfile.lock
-# .ruby-version
+.ruby-version
 # .ruby-gemset
 
 # unless supporting rvm < 1.11.0 or doing something fancy, ignore this:

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+# 3.1.4 2026-11-07
+
+- Fix loading of extension on some systems running Ruby from distro packages (#96)
+
 # 3.1.3 2026-10-03
 
 - Fix database finalization of stmts (on free/close)

data/Rakefile

@@ -15,6 +15,38 @@ task :test do
   exec 'ruby test/run.rb'
 end
 
+namespace :test do
+  # Runs the tests against an extension built with AddressSanitizer:
+  #
+  #   bundle exec rake clean
+  #   EXTRALITE_BUNDLE=1 EXTRALITE_ASAN=1 bundle exec rake compile
+  #   bundle exec rake test:asan
+  #
+  # Set TEST_FILES (comma separated) to run only some test files.
+  #
+  # Ruby itself is not built with ASan, so libasan has to be preloaded.
+  # use_sigaltstack=0: Ruby installs its own signal stack for each thread,
+  # which makes ASan fail when it unmaps its own signal stack on thread exit.
+  # Leak detection is off because Ruby does not free everything on exit.
+  desc 'Run tests with an ASan build of the extension (Linux only)'
+  task :asan do
+    so = Dir['lib/extralite_ext.{so,bundle}'].first
+    libasan = so && `ldd #{so}`[/^\s*libasan\S*\s*=>\s*(\S+)/, 1]
+    abort 'The extension is not built with EXTRALITE_ASAN=1' unless libasan
+
+    env = {
+      'LD_PRELOAD' => libasan,
+      'ASAN_OPTIONS' => "detect_leaks=0:use_sigaltstack=0:abort_on_error=1:#{ENV['ASAN_OPTIONS']}"
+    }
+    files = ENV['TEST_FILES']&.split(',')
+    if files
+      exec env, 'ruby', '-Itest', '-e', files.map { "require './#{it}'" }.join(';')
+    else
+      exec env, 'ruby test/run.rb'
+    end
+  end
+end
+
 CLEAN.include 'lib/*.o', 'lib/*.so', 'lib/*.so.*', 'lib/*.a', 'lib/*.bundle', 'lib/*.jar', 'pkg', 'tmp'
 
 require 'yard'

data/ext/extralite/database.c

@@ -237,11 +237,12 @@ VALUE Database_initialize(int argc, VALUE *argv, VALUE self) {
   sqlite3_db_config(db->sqlite3_db ,SQLITE_DBCONFIG_ENABLE_LOAD_EXTENSION, 1, NULL);
 #endif
 
-  db->stmt_cache = rb_hash_new();
+  RB_OBJ_WRITE(self, &db->stmt_cache, rb_hash_new());
   db->trace_proc = Qnil;
   db->gvl_release_threshold = DEFAULT_GVL_RELEASE_THRESHOLD;
 
   db->progress_handler = global_progress_handler;
+  RB_OBJ_WRITTEN(self, Qundef, db->progress_handler.proc);
   db->progress_handler.tick_count = 0;
   db->progress_handler.call_count = 0;
   if (db->progress_handler.mode != PROGRESS_NONE) {
@@ -627,7 +628,7 @@ VALUE Database_batch_query(VALUE self, VALUE sql, VALUE parameters) {
   sqlite3_stmt *stmt;
 
   stmt_ctx stmt_ctx;
-  make_stmt_ctx(&stmt_ctx, db, &stmt, sql, RARRAY_LEN(parameters), NULL);
+  make_stmt_ctx(&stmt_ctx, db, &stmt, sql, (TYPE(parameters) == T_ARRAY) ? RARRAY_LEN(parameters) : 0, NULL);
   prep_single_stmt(&stmt_ctx);
   // prepare_xsingle_stmt(DB_GVL_MODE(db), db->stmt_cache, db->sqlite3_db, &stmt, sql, 0, NULL);
   query_ctx ctx = QUERY_CTX(
@@ -664,7 +665,7 @@ VALUE Database_batch_query_array(VALUE self, VALUE sql, VALUE parameters) {
   sqlite3_stmt *stmt;
 
   stmt_ctx stmt_ctx;
-  make_stmt_ctx(&stmt_ctx, db, &stmt, sql, RARRAY_LEN(parameters), NULL);
+  make_stmt_ctx(&stmt_ctx, db, &stmt, sql, (TYPE(parameters) == T_ARRAY) ? RARRAY_LEN(parameters) : 0, NULL);
   prep_single_stmt(&stmt_ctx);
   // prepare_xsingle_stmt(DB_GVL_MODE(db), db->stmt_cache, db->sqlite3_db, &stmt, sql, 0, NULL);
   query_ctx ctx = QUERY_CTX(
@@ -701,7 +702,7 @@ VALUE Database_batch_query_splat(VALUE self, VALUE sql, VALUE parameters) {
   sqlite3_stmt *stmt;
 
   stmt_ctx stmt_ctx;
-  make_stmt_ctx(&stmt_ctx, db, &stmt, sql, RARRAY_LEN(parameters), NULL);
+  make_stmt_ctx(&stmt_ctx, db, &stmt, sql, (TYPE(parameters) == T_ARRAY) ? RARRAY_LEN(parameters) : 0, NULL);
   prep_single_stmt(&stmt_ctx);
   // prepare_xsingle_stmt(DB_GVL_MODE(db), db->stmt_cache, db->sqlite3_db, &stmt, sql, 0, NULL);
   query_ctx ctx = QUERY_CTX(
@@ -1736,7 +1737,9 @@ void Init_ExtraliteDatabase(void) {
   rb_gc_register_mark_object(SYM_truncate);
   rb_gc_register_mark_object(SYM_wal);
 
-  rb_gc_register_mark_object(global_progress_handler.proc);
+  // the proc is replaced by Extralite.on_progress, so register the address,
+  // not the current value
+  rb_gc_register_address(&global_progress_handler.proc);
 
   UTF8_ENCODING = rb_utf8_encoding();
 }

data/ext/extralite/extconf-bundle.rb

@@ -6,6 +6,24 @@ $CFLAGS << ' -Wno-undef'
 $CFLAGS << ' -Wno-discarded-qualifiers'
 $CFLAGS << ' -Wno-unused-function'
 
+# Development only: build with AddressSanitizer (EXTRALITE_ASAN=1), then run
+# the tests with `bundle exec rake test:asan` (see Rakefile).
+#
+# -fgnu89-inline: several non-static functions in the C files are declared
+# `inline` without an extern definition, which only links when every call is
+# inlined (as with the default -O3).
+if ENV['EXTRALITE_ASAN']
+  $CFLAGS << ' -fsanitize=address -fno-omit-frame-pointer -O1 -g -fgnu89-inline'
+  $LDFLAGS << ' -fsanitize=address'
+  # No stack instrumentation: Ruby raises exceptions with longjmp, which
+  # leaves poisoned stack redzones behind and causes false reports later.
+  # It also keeps local VALUEs on the real stack, where the GC can see them.
+  $CFLAGS << (try_cflags('--param=asan-stack=0') ? ' --param=asan-stack=0' : ' -mllvm -asan-stack=0')
+  # SQLite serves small allocations (including statements) from its own
+  # lookaside pool, which hides use-after-free bugs from ASan.
+  $defs << '-DSQLITE_DEFAULT_LOOKASIDE=0,0'
+end
+
 # enable the session extension
 $defs << '-DSQLITE_ENABLE_SESSION'
 $defs << '-DSQLITE_ENABLE_PREUPDATE_HOOK'

data/ext/extralite/extconf.rb

@@ -48,6 +48,21 @@ else
     dir_config('sqlite3', cppflags, ldflags)
   end
 
+  # Development only: build with AddressSanitizer (EXTRALITE_ASAN=1), then run
+  # the tests with `bundle exec rake test:asan` (see Rakefile).
+  #
+  # -fgnu89-inline: several non-static functions in the C files are declared
+  # `inline` without an extern definition, which only links when every call is
+  # inlined (as with the default -O3).
+  if ENV['EXTRALITE_ASAN']
+    $CFLAGS << ' -fsanitize=address -fno-omit-frame-pointer -O1 -g -fgnu89-inline'
+    $LDFLAGS << ' -fsanitize=address'
+    # No stack instrumentation: Ruby raises exceptions with longjmp, which
+    # leaves poisoned stack redzones behind and causes false reports later.
+    # It also keeps local VALUEs on the real stack, where the GC can see them.
+    $CFLAGS << (try_cflags('--param=asan-stack=0') ? ' --param=asan-stack=0' : ' -mllvm -asan-stack=0')
+  end
+
   if RbConfig::CONFIG['host_os'] =~ /mswin/
     $CFLAGS << ' -W3'
   end

data/ext/extralite/iterator.c

@@ -54,7 +54,7 @@ static inline Iterator_t *self_to_iterator(VALUE obj) {
  */
 VALUE Iterator_initialize(VALUE self, VALUE query) {
   Iterator_t *iterator = self_to_iterator(self);
-  iterator->query = query;
+  RB_OBJ_WRITE(self, &iterator->query, query);
   return Qnil;
 }
 

data/ext/extralite/query.c

@@ -649,7 +649,7 @@ VALUE Query_transform_get(VALUE self) {
  */
 VALUE Query_transform_set(VALUE self, VALUE transform) {
   Query_t *query = self_to_query(self);
-  query->transform = transform;
+  RB_OBJ_WRITE(self, &query->transform, transform);
   query->transform_object = rb_obj_is_instance_of(transform, cTransform);
   return self;
 }

data/lib/extralite/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Extralite
-  VERSION = '3.1.3'
+  VERSION = '3.1.4'
 end

data/lib/extralite.rb

@@ -1,4 +1,4 @@
-require_relative './extralite_ext'
+require 'extralite_ext'
 
 # Extralite is a Ruby gem for working with SQLite databases
 module Extralite

data/test/helper.rb

@@ -3,6 +3,7 @@
 require 'bundler/setup'
 require 'extralite'
 require 'minitest/autorun'
+require 'tempfile'
 
 puts "sqlite3 version: #{Extralite.sqlite3_version}"
 
@@ -22,7 +23,43 @@ module TestExtensions
     @db = nil
     GC.start
     super
+  ensure
+    @tempfiles&.each(&:close!)
+  end
+
+  # Returns the path of a new temp file. The Tempfile is kept until teardown,
+  # otherwise GC may delete the file while a database is still using it.
+  def tempfile_path(name)
+    (@tempfiles ||= []) << (tmp = Tempfile.new(name))
+    tmp.path
   end
 end
 
 Minitest::Test.prepend(TestExtensions)
+
+# EXTRALITE_GC_STRESS=1 runs every test with GC.stress enabled, which makes GC
+# bugs in the C extension (objects freed too early, wrong free order) show up
+# reliably. It's slow, so you may want to run only some test files, e.g.:
+#
+#   EXTRALITE_GC_STRESS=1 ruby test/test_stmt_cache.rb
+if ENV['EXTRALITE_GC_STRESS']
+  module GCStressExtensions
+    def before_setup
+      super
+      GC.stress = true
+    end
+
+    def after_teardown
+      GC.stress = false
+      super
+    end
+  end
+
+  Minitest::Test.prepend(GCStressExtensions)
+end
+
+module Minitest::Assertions
+  def skip_with_gc_stress
+    skip 'timing-sensitive, too slow with GC.stress' if ENV['EXTRALITE_GC_STRESS']
+  end
+end

data/test/test_database.rb

@@ -347,7 +347,7 @@ class DatabaseTest < Minitest::Test
 
     assert_raises { @db.tables('foo') }
 
-    fn = Tempfile.new('extralite_test_tables_with_db_name').path
+    fn = tempfile_path('extralite_test_tables_with_db_name')
     @db.execute "attach database '#{fn}' as foo"
 
     assert_equal [], @db.tables('foo')
@@ -382,7 +382,7 @@ class DatabaseTest < Minitest::Test
   end
 
   def test_integrity_check_damaged
-    fn = Tempfile.new('extralite_test_integrity_check_damaged').path
+    fn = tempfile_path('extralite_test_integrity_check_damaged')
     db = Extralite::Database.new(fn)
 
     db.execute <<~SQL
@@ -422,7 +422,7 @@ class DatabaseTest < Minitest::Test
   end
 
   def test_quick_check_damaged
-    fn = Tempfile.new('extralite_test_quick_check_damaged').path
+    fn = tempfile_path('extralite_test_quick_check_damaged')
     db = Extralite::Database.new(fn)
 
     db.execute <<~SQL
@@ -882,7 +882,8 @@ class DatabaseTest < Minitest::Test
   end
 
   def test_database_busy_timeout
-    fn = Tempfile.new('extralite_test_database_busy_timeout').path
+    skip_with_gc_stress
+    fn = tempfile_path('extralite_test_database_busy_timeout')
     db1 = Extralite::Database.new(fn)
     db2 = Extralite::Database.new(fn)
 
@@ -978,13 +979,13 @@ class DatabaseTest < Minitest::Test
     db = Extralite::Database.new(':memory:', gvl_release_threshold: 23)
     assert_equal 23, db.gvl_release_threshold
 
-    fn = Tempfile.new('extralite_test_database_initialize_modern').path
+    fn = tempfile_path('extralite_test_database_initialize_modern')
     db = Extralite::Database.new(fn)
     assert_equal 'wal', db.pragma(:journal_mode)
     assert_equal 1, db.pragma(:synchronous)
     assert_equal 1, db.pragma(:foreign_keys)
 
-    fn = Tempfile.new('extralite_test_database_initialize_legacy').path
+    fn = tempfile_path('extralite_test_database_initialize_legacy')
     db = Extralite::Database.new(fn, legacy: true)
     assert_equal 'delete', db.pragma(:journal_mode)
     assert_equal 2, db.pragma(:synchronous)
@@ -1011,7 +1012,7 @@ class DatabaseTest < Minitest::Test
   end
 
   def test_database_transaction_commit
-    path = Tempfile.new('extralite_test_database_transaction_commit').path
+    path = tempfile_path('extralite_test_database_transaction_commit')
     db1 = Extralite::Database.new(path)
     db2 = Extralite::Database.new(path)
 
@@ -1165,7 +1166,7 @@ class DatabaseTest < Minitest::Test
   end
 
   def test_wal_checkpoint
-    fn = Tempfile.new('extralite_test_wal_checkpoint').path
+    fn = tempfile_path('extralite_test_wal_checkpoint')
 
     db = Extralite::Database.new(fn)
 
@@ -1258,7 +1259,7 @@ end
 
 class ScenarioTest < Minitest::Test
   def setup
-    @fn = Tempfile.new('extralite_scenario_test').path
+    @fn = tempfile_path('extralite_scenario_test')
     @db = Extralite::Database.new(@fn, legacy: true)
     @db.query('create table if not exists t (x,y,z)')
     @db.query('delete from t')
@@ -1411,7 +1412,7 @@ class BackupTest < Minitest::Test
   end
 
   def test_backup_with_fn
-    tmp_fn = Tempfile.new('extralite_test_backup_with_fn').path
+    tmp_fn = tempfile_path('extralite_test_backup_with_fn')
     @src.backup(tmp_fn)
 
     db = Extralite::Database.new(tmp_fn)
@@ -1438,6 +1439,7 @@ class ConcurrencyTest < Minitest::Test
   end
 
   def test_gvl_always_release
+    skip_with_gc_stress
     skip if !IS_LINUX
 
     delays = []
@@ -1522,6 +1524,7 @@ class ConcurrencyTest < Minitest::Test
   end
 
   def test_progress_handler_simple
+    skip_with_gc_stress
     db = Extralite::Database.new(':memory:')
 
     # SQLite's behaviour post 3.46.0 has changed, such that the first time the
@@ -1714,6 +1717,7 @@ class ConcurrencyTest < Minitest::Test
   SQL
 
   def test_progress_handler_timeout_interrupt
+    skip_with_gc_stress
     db = Extralite::Database.new(':memory:')
     t0 = Time.now
     db.on_progress do
@@ -1756,6 +1760,7 @@ class ConcurrencyTest < Minitest::Test
   end
 
   def test_progress_handler_timeout_raise
+    skip_with_gc_stress
     db = Extralite::Database.new(':memory:')
     t0 = Time.now
     db.on_progress do
@@ -1795,7 +1800,8 @@ class ConcurrencyTest < Minitest::Test
   end
 
   def test_progress_handler_busy_timeout
-    fn = Tempfile.new('extralite_test_progress_handler_busy_timeout').path
+    skip_with_gc_stress
+    fn = tempfile_path('extralite_test_progress_handler_busy_timeout')
     db1 = Extralite::Database.new(fn)
     db2 = Extralite::Database.new(fn)
 
@@ -1865,7 +1871,7 @@ class RactorTest < Minitest::Test
   def test_ractor_simple
     skip if SKIP_RACTOR_TESTS
 
-    fn = Tempfile.new('extralite_test_database_in_ractor').path
+    fn = tempfile_path('extralite_test_database_in_ractor')
 
     r = Ractor.new do
       path = receive
@@ -1917,7 +1923,7 @@ class RactorTest < Minitest::Test
   def test_ractor_stress
     skip if SKIP_RACTOR_TESTS
 
-    fn = Tempfile.new('extralite_test_ractor_stress').path
+    fn = tempfile_path('extralite_test_ractor_stress')
     random = Random.new.freeze
 
     ractors = (0..9).map do |ractor_number|
@@ -2307,7 +2313,7 @@ class StmtCacheText < Minitest::Test
   end
 
   def test_stmt_cache_close
-    fn = Tempfile.new('extralite_test_stmt_cache_close').path
+    fn = tempfile_path('extralite_test_stmt_cache_close')
 
     db = Extralite::Database.new(fn)
     db.query('create table t (x)')
@@ -2324,7 +2330,7 @@ class StmtCacheText < Minitest::Test
   end
 
   def test_stmt_cache_gc
-    fn = Tempfile.new('extralite_test_stmt_cache_gc').path
+    fn = tempfile_path('extralite_test_stmt_cache_gc')
 
     db = Extralite::Database.new(fn)
     db.query('create table t (x)')
@@ -2343,7 +2349,7 @@ class StmtCacheText < Minitest::Test
 
   def test_stmt_cache_concurrent_access
     # https://github.com/digital-fabric/extralite/issues/88
-    fn = Tempfile.new('extralite_test_stmt_cache_concurrent_access').path
+    fn = tempfile_path('extralite_test_stmt_cache_concurrent_access')
 
     a = Extralite::Database.new(fn)
     a.execute("pragma journal_mode=wal")
@@ -2360,7 +2366,7 @@ class StmtCacheText < Minitest::Test
 
   def test_stmt_cache_concurrent_transactions
     # https://github.com/digital-fabric/extralite/issues/89
-    fn = Tempfile.new('extralite_test_stmt_cache_concurrent_access').path
+    fn = tempfile_path('extralite_test_stmt_cache_concurrent_access')
 
     a = Extralite::Database.new(fn)
     a.execute('create table t (x)')

data/test/test_iterator.rb

@@ -118,7 +118,7 @@ class IteratorTest < Minitest::Test
   end
 
   def test_return_from_block_issue_26
-    fn = Tempfile.new('extralite_test_return_from_block_issue_26').path
+    fn = tempfile_path('extralite_test_return_from_block_issue_26')
     db = Extralite::Database.new(fn)
 
     λ = ->(sql) {

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: extralite
 version: !ruby/object:Gem::Version
-  version: 3.1.3
+  version: 3.1.4
 platform: ruby
 authors:
 - Sharon Rosner
@@ -88,6 +88,7 @@ extra_rdoc_files:
 files:
 - ".editorconfig"
 - ".github/FUNDING.yml"
+- ".github/workflows/test-asan.yml"
 - ".github/workflows/test-bundle.yml"
 - ".github/workflows/test.yml"
 - ".gitignore"
@@ -174,7 +175,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.6
+rubygems_version: 4.0.20
 specification_version: 4
 summary: Extra-lightweight SQLite3 wrapper for Ruby
 test_files: []