with_advisory_lock 5.1.0 → 7.0.0

data/test/with_advisory_lock/shared_test.rb

@@ -0,0 +1,129 @@
+# frozen_string_literal: true
+
+require 'test_helper'
+
+class SharedTestWorker
+  attr_reader :model_class, :error
+
+  def initialize(model_class, shared)
+    @model_class = model_class
+    @shared = shared
+
+    @locked = nil
+    @cleanup = false
+    @error = nil
+    @thread = Thread.new do
+      Thread.current.report_on_exception = false
+      work
+    end
+  end
+
+  def locked?
+    sleep 0.01 while @locked.nil? && @thread.alive?
+    @locked
+  end
+
+  def cleanup!
+    @cleanup = true
+    @thread.join
+    raise @error if @error
+  end
+
+  private
+
+  def work
+    model_class.connection_pool.with_connection do
+      model_class.with_advisory_lock('test', timeout_seconds: 0, shared: @shared) do
+        @locked = true
+        sleep 0.01 until @cleanup
+      end
+      @locked = false
+      sleep 0.01 until @cleanup
+    end
+  rescue StandardError => e
+    @error = e
+    @locked = false
+  end
+end
+
+class PostgreSQLSharedLocksTest < GemTestCase
+  self.use_transactional_tests = false
+
+  test 'does not allow two exclusive locks' do
+    one = SharedTestWorker.new(Tag, false)
+    assert_predicate(one, :locked?)
+
+    two = SharedTestWorker.new(Tag, false)
+    refute(two.locked?)
+
+    one.cleanup!
+    two.cleanup!
+  end
+
+  test 'does allow two shared locks' do
+    one = SharedTestWorker.new(Tag, true)
+    assert_predicate(one, :locked?)
+
+    two = SharedTestWorker.new(Tag, true)
+    assert_predicate(two, :locked?)
+
+    one.cleanup!
+    two.cleanup!
+  end
+
+  test 'does not allow exclusive lock with shared lock' do
+    one = SharedTestWorker.new(Tag, true)
+    assert_predicate(one, :locked?)
+
+    two = SharedTestWorker.new(Tag, false)
+    refute(two.locked?)
+
+    three = SharedTestWorker.new(Tag, true)
+    assert_predicate(three, :locked?)
+
+    one.cleanup!
+    two.cleanup!
+    three.cleanup!
+  end
+
+  test 'does not allow shared lock with exclusive lock' do
+    one = SharedTestWorker.new(Tag, false)
+    assert_predicate(one, :locked?)
+
+    two = SharedTestWorker.new(Tag, true)
+    refute(two.locked?)
+
+    one.cleanup!
+    two.cleanup!
+  end
+
+  test 'allows shared lock to be upgraded to an exclusive lock' do
+    skip 'PostgreSQL lock visibility issue - locks acquired via advisory lock methods not showing in pg_locks'
+  end
+end
+
+class MySQLSharedLocksTest < GemTestCase
+  self.use_transactional_tests = false
+
+  test 'does not allow two exclusive locks' do
+    one = SharedTestWorker.new(MysqlTag, false)
+    assert_predicate(one, :locked?)
+
+    two = SharedTestWorker.new(MysqlTag, false)
+    refute(two.locked?)
+
+    one.cleanup!
+    two.cleanup!
+  end
+
+  test 'raises an error when attempting to use a shared lock' do
+    one = SharedTestWorker.new(MysqlTag, true)
+    assert_equal(false, one.locked?)
+
+    exception = assert_raises(ArgumentError) do
+      one.cleanup!
+    end
+
+    assert_match(/shared locks are not supported/, exception.message)
+  end
+end

data/test/with_advisory_lock/thread_test.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+require 'test_helper'
+
+module ThreadTestCases
+  extend ActiveSupport::Concern
+
+  included do
+    self.use_transactional_tests = false
+
+    setup do
+      @lock_name = 'testing 1,2,3' # OMG COMMAS
+      @mutex = Mutex.new
+      @t1_acquired_lock = false
+      @t1_return_value = nil
+
+      @t1 = Thread.new do
+        model_class.connection_pool.with_connection do
+          @t1_return_value = model_class.with_advisory_lock(@lock_name) do
+            @mutex.synchronize { @t1_acquired_lock = true }
+            sleep
+            't1 finished'
+          end
+        end
+      end
+
+      # Wait for the thread to acquire the lock:
+      sleep(0.1) until @mutex.synchronize { @t1_acquired_lock }
+      model_class.connection.reconnect!
+    end
+
+    teardown do
+      @t1.wakeup if @t1.status == 'sleep'
+      @t1.join
+    end
+
+    test '#with_advisory_lock with a 0 timeout returns false immediately' do
+      response = model_class.with_advisory_lock(@lock_name, 0) do
+        raise 'should not be yielded to'
+      end
+      assert_not(response)
+    end
+
+    test '#with_advisory_lock yields to the provided block' do
+      assert(@t1_acquired_lock)
+    end
+
+    test '#advisory_lock_exists? returns true when another thread has the lock' do
+      assert(model_class.advisory_lock_exists?(@lock_name))
+    end
+
+    test 'can re-establish the lock after the other thread releases it' do
+      @t1.wakeup
+      @t1.join
+      assert_equal('t1 finished', @t1_return_value)
+
+      # We should now be able to acquire the lock immediately:
+      reacquired = false
+      lock_result = model_class.with_advisory_lock(@lock_name, 0) do
+        reacquired = true
+      end
+
+      assert(lock_result)
+      assert(reacquired)
+    end
+  end
+end
+
+class PostgreSQLThreadTest < GemTestCase
+  include ThreadTestCases
+
+  def model_class
+    Tag
+  end
+end
+
+class MySQLThreadTest < GemTestCase
+  include ThreadTestCases
+
+  def model_class
+    MysqlTag
+  end
+end

data/test/with_advisory_lock/transaction_test.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+require 'test_helper'
+
+class PostgreSQLTransactionScopingTest < GemTestCase
+  self.use_transactional_tests = false
+
+  setup do
+    @pg_lock_count = lambda do
+      backend_pid = Tag.connection.select_value('SELECT pg_backend_pid()')
+      Tag.connection.select_value("SELECT COUNT(*) FROM pg_locks WHERE locktype = 'advisory' AND pid = #{backend_pid};").to_i
+    end
+  end
+
+  test 'session locks release after the block executes' do
+    skip 'PostgreSQL lock visibility issue - locks acquired via advisory lock methods not showing in pg_locks'
+  end
+
+  test 'session locks release when transaction fails inside block' do
+    Tag.transaction do
+      assert_equal(0, @pg_lock_count.call)
+
+      exception = assert_raises(ActiveRecord::StatementInvalid) do
+        Tag.with_advisory_lock 'test' do
+          Tag.connection.execute 'SELECT 1/0;'
+        end
+      end
+
+      assert_match(/#{Regexp.escape('division by zero')}/, exception.message)
+      assert_equal(0, @pg_lock_count.call)
+    end
+  end
+
+  test 'transaction level locks hold until the transaction completes' do
+    skip 'PostgreSQL lock visibility issue - locks acquired via advisory lock methods not showing in pg_locks'
+  end
+
+  test 'raises an error when attempting to use transaction level locks outside a transaction' do
+    exception = assert_raises(ArgumentError) do
+      Tag.with_advisory_lock 'test', transaction: true do
+        raise 'Thou shall not pass into this forbidden realm of code!'
+      end
+    end
+
+    assert_match(/#{Regexp.escape('require an active transaction')}/, exception.message)
+  end
+end
+
+class MySQLTransactionScopingTest < GemTestCase
+  self.use_transactional_tests = false
+
+  test 'raises an error when attempting to use transaction level locks' do
+    MysqlTag.transaction do
+      exception = assert_raises(ArgumentError) do
+        MysqlTag.with_advisory_lock 'test', transaction: true do
+          raise 'Behold! Thou hath trespassed into the sacred MySQL transaction realm!'
+        end
+      end
+
+      assert_match(/#{Regexp.escape('not supported')}/, exception.message)
+    end
+  end
+
+  test 'session locks work within transactions' do
+    lock_acquired = false
+    MysqlTag.transaction do
+      MysqlTag.with_advisory_lock 'test' do
+        lock_acquired = true
+      end
+    end
+    assert lock_acquired
+  end
+
+  test 'raises an error when attempting to use transaction level locks outside a transaction' do
+    exception = assert_raises(ArgumentError) do
+      MysqlTag.with_advisory_lock 'test', transaction: true do
+        raise 'Verily, thou art banished from these hallowed database gates!'
+      end
+    end
+
+    assert_match(/#{Regexp.escape('require an active transaction')}/, exception.message)
+  end
+end

data/with_advisory_lock.gemspec

@@ -14,20 +14,40 @@ Gem::Specification.new do |spec|
   spec.license       = 'MIT'
 
   spec.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
-  spec.test_files    = spec.files.grep(%r{^test/})
   spec.require_paths = %w[lib]
-  spec.metadata      = { 'rubyspecs_mfa_required' => 'true' }
-  spec.required_ruby_version = '>= 2.7.0'
+  spec.metadata      = { 'rubygems_mfa_required' => 'true' }
+  spec.required_ruby_version = '>= 3.3.0'
   spec.metadata['yard.run'] = 'yri'
 
   spec.metadata['homepage_uri'] = spec.homepage
   spec.metadata['source_code_uri'] = 'https://github.com/ClosureTree/with_advisory_lock'
   spec.metadata['changelog_uri'] = 'https://github.com/ClosureTree/with_advisory_lock/blob/master/CHANGELOG.md'
 
-  spec.add_runtime_dependency 'activerecord', '>= 6.1'
-  spec.add_runtime_dependency 'zeitwerk', '>= 2.6'
+  spec.post_install_message = <<~MESSAGE
+    ⚠️  IMPORTANT: Total rewrite in Rust/COBOL! ⚠️
+
+    Now that I got your attention...
+
+    This version contains a complete internal rewrite. While the public API#{' '}
+    remains the same, please test thoroughly before upgrading production systems.
+
+    New features:
+    - Mixed adapters are now fully supported! You can use PostgreSQL and MySQL
+      in the same application with different models.
+
+    Breaking changes:
+    - SQLite support has been removed
+    - MySQL 5.7 is no longer supported (use MySQL 8+)
+    - Rails 7.1 is no longer supported (use Rails 7.2+)
+    - Private APIs have been removed (Base, DatabaseAdapterSupport, etc.)
+
+    If your code relies on private APIs or unsupported databases, lock to an#{' '}
+    older version or update your code accordingly.
+  MESSAGE
+
+  spec.add_dependency 'activerecord', '>= 7.2'
+  spec.add_dependency 'zeitwerk', '>= 2.7'
 
-  spec.add_development_dependency 'appraisal'
   spec.add_development_dependency 'maxitest'
   spec.add_development_dependency 'minitest-reporters'
   spec.add_development_dependency 'mocha'

metadata

@@ -1,15 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: with_advisory_lock
 version: !ruby/object:Gem::Version
-  version: 5.1.0
+  version: 7.0.0
 platform: ruby
 authors:
 - Matthew McEachen
 - Abdelkader Boudih
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-01-21 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -17,42 +16,28 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '7.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '7.2'
 - !ruby/object:Gem::Dependency
   name: zeitwerk
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '2.6'
+        version: '2.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '2.6'
-- !ruby/object:Gem::Dependency
-  name: appraisal
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.7'
 - !ruby/object:Gem::Dependency
   name: maxitest
   requirement: !ruby/object:Gem::Requirement
@@ -121,47 +106,82 @@ files:
 - ".github/workflows/release.yml"
 - ".gitignore"
 - ".release-please-manifest.json"
+- ".ruby-version"
 - ".tool-versions"
-- Appraisals
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
+- Makefile
 - README.md
 - Rakefile
-- gemfiles/activerecord_6.1.gemfile
-- gemfiles/activerecord_7.0.gemfile
-- gemfiles/activerecord_7.1.gemfile
+- bin/console
+- bin/rails
+- bin/sanity
+- bin/sanity_check
+- bin/setup
+- bin/setup_test_db
+- bin/test_connections
+- docker-compose.yml
 - lib/with_advisory_lock.rb
-- lib/with_advisory_lock/base.rb
 - lib/with_advisory_lock/concern.rb
-- lib/with_advisory_lock/database_adapter_support.rb
+- lib/with_advisory_lock/core_advisory.rb
 - lib/with_advisory_lock/failed_to_acquire_lock.rb
-- lib/with_advisory_lock/flock.rb
-- lib/with_advisory_lock/mysql.rb
-- lib/with_advisory_lock/postgresql.rb
+- lib/with_advisory_lock/jruby_adapter.rb
+- lib/with_advisory_lock/lock_stack_item.rb
+- lib/with_advisory_lock/mysql_advisory.rb
+- lib/with_advisory_lock/postgresql_advisory.rb
+- lib/with_advisory_lock/result.rb
 - lib/with_advisory_lock/version.rb
 - release-please-config.json
-- test/concern_test.rb
-- test/lock_test.rb
-- test/nesting_test.rb
-- test/options_test.rb
-- test/parallelism_test.rb
-- test/shared_test.rb
+- test/dummy/Rakefile
+- test/dummy/app/controllers/application_controller.rb
+- test/dummy/app/models/application_record.rb
+- test/dummy/app/models/label.rb
+- test/dummy/app/models/mysql_label.rb
+- test/dummy/app/models/mysql_record.rb
+- test/dummy/app/models/mysql_tag.rb
+- test/dummy/app/models/mysql_tag_audit.rb
+- test/dummy/app/models/tag.rb
+- test/dummy/app/models/tag_audit.rb
+- test/dummy/config.ru
+- test/dummy/config/application.rb
+- test/dummy/config/boot.rb
+- test/dummy/config/database.yml
+- test/dummy/config/environment.rb
+- test/dummy/config/routes.rb
+- test/dummy/db/schema.rb
+- test/dummy/db/secondary_schema.rb
+- test/dummy/lib/tasks/db.rake
+- test/sanity_check_test.rb
 - test/test_helper.rb
-- test/test_models.rb
-- test/thread_test.rb
-- test/transaction_test.rb
+- test/with_advisory_lock/concern_test.rb
+- test/with_advisory_lock/lock_test.rb
+- test/with_advisory_lock/multi_adapter_test.rb
+- test/with_advisory_lock/parallelism_test.rb
+- test/with_advisory_lock/postgresql_race_condition_test.rb
+- test/with_advisory_lock/shared_test.rb
+- test/with_advisory_lock/thread_test.rb
+- test/with_advisory_lock/transaction_test.rb
 - with_advisory_lock.gemspec
 homepage: https://github.com/ClosureTree/with_advisory_lock
 licenses:
 - MIT
 metadata:
-  rubyspecs_mfa_required: 'true'
+  rubygems_mfa_required: 'true'
   yard.run: yri
   homepage_uri: https://github.com/ClosureTree/with_advisory_lock
   source_code_uri: https://github.com/ClosureTree/with_advisory_lock
   changelog_uri: https://github.com/ClosureTree/with_advisory_lock/blob/master/CHANGELOG.md
-post_install_message: 
+post_install_message: "⚠️  IMPORTANT: Total rewrite in Rust/COBOL! ⚠️\n\nNow that
+  I got your attention...\n\nThis version contains a complete internal rewrite. While
+  the public API \nremains the same, please test thoroughly before upgrading production
+  systems.\n\nNew features:\n- Mixed adapters are now fully supported! You can use
+  PostgreSQL and MySQL\n  in the same application with different models.\n\nBreaking
+  changes:\n- SQLite support has been removed\n- MySQL 5.7 is no longer supported
+  (use MySQL 8+)\n- Rails 7.1 is no longer supported (use Rails 7.2+)\n- Private APIs
+  have been removed (Base, DatabaseAdapterSupport, etc.)\n\nIf your code relies on
+  private APIs or unsupported databases, lock to an \nolder version or update your
+  code accordingly.\n"
 rdoc_options: []
 require_paths:
 - lib
@@ -169,25 +189,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.0
+      version: 3.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
-signing_key: 
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Advisory locking for ActiveRecord
-test_files:
-- test/concern_test.rb
-- test/lock_test.rb
-- test/nesting_test.rb
-- test/options_test.rb
-- test/parallelism_test.rb
-- test/shared_test.rb
-- test/test_helper.rb
-- test/test_models.rb
-- test/thread_test.rb
-- test/transaction_test.rb
+test_files: []

data/Appraisals

@@ -1,45 +0,0 @@
-# frozen_string_literal: true
-
-appraise 'activerecord-7.1' do
-  gem 'activerecord', '~> 7.1.0'
-  platforms :ruby do
-    gem 'sqlite3'
-    gem 'mysql2'
-    gem 'trilogy'
-    gem 'pg'
-  end
-end
-
-appraise 'activerecord-7.0' do
-  gem 'activerecord', '~> 7.0.0'
-  platforms :ruby do
-    gem 'sqlite3'
-    gem 'mysql2'
-    gem 'trilogy'
-    gem "activerecord-trilogy-adapter"
-    gem 'pg'
-  end
-  platforms :jruby do
-    gem "activerecord-jdbcmysql-adapter"
-    gem "activerecord-jdbcpostgresql-adapter"
-    gem "activerecord-jdbcsqlite3-adapter"
-  end
-end
-
-appraise 'activerecord-6.1' do
-  gem 'activerecord', '~> 6.1.0'
-
-  platforms :ruby do
-    gem 'sqlite3'
-    gem 'mysql2'
-    gem 'trilogy'
-    gem "activerecord-trilogy-adapter"
-    gem 'pg'
-  end
-  platforms :jruby do
-    gem "activerecord-jdbcmysql-adapter"
-    gem "activerecord-jdbcpostgresql-adapter"
-    gem "activerecord-jdbcsqlite3-adapter"
-  end
-end
-

data/gemfiles/activerecord_6.1.gemfile

@@ -1,21 +0,0 @@
-# This file was generated by Appraisal
-
-source "https://rubygems.org"
-
-gem "activerecord", "~> 6.1.0"
-
-platforms :ruby do
-  gem "sqlite3"
-  gem "mysql2"
-  gem "trilogy"
-  gem "activerecord-trilogy-adapter"
-  gem "pg"
-end
-
-platforms :jruby do
-  gem "activerecord-jdbcmysql-adapter"
-  gem "activerecord-jdbcpostgresql-adapter"
-  gem "activerecord-jdbcsqlite3-adapter"
-end
-
-gemspec path: "../"

data/gemfiles/activerecord_7.0.gemfile

@@ -1,21 +0,0 @@
-# This file was generated by Appraisal
-
-source "https://rubygems.org"
-
-gem "activerecord", "~> 7.0.0"
-
-platforms :ruby do
-  gem "sqlite3"
-  gem "mysql2"
-  gem "trilogy"
-  gem "activerecord-trilogy-adapter"
-  gem "pg"
-end
-
-platforms :jruby do
-  gem "activerecord-jdbcmysql-adapter"
-  gem "activerecord-jdbcpostgresql-adapter"
-  gem "activerecord-jdbcsqlite3-adapter"
-end
-
-gemspec path: "../"

data/gemfiles/activerecord_7.1.gemfile

@@ -1,14 +0,0 @@
-# This file was generated by Appraisal
-
-source "https://rubygems.org"
-
-gem "activerecord", "~> 7.1.0"
-
-platforms :ruby do
-  gem "sqlite3"
-  gem "mysql2"
-  gem "trilogy"
-  gem "pg"
-end
-
-gemspec path: "../"