with_advisory_lock 5.3.0 → 7.0.0

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: with_advisory_lock
 version: !ruby/object:Gem::Version
-  version: 5.3.0
+  version: 7.0.0
 platform: ruby
 authors:
 - Matthew McEachen
@@ -16,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
@@ -116,44 +102,63 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/workflows/ci-mysql5.yml"
-- ".github/workflows/ci-mysql8.yml"
-- ".github/workflows/ci-postgresql.yml"
-- ".github/workflows/ci-sqlite3.yml"
+- ".github/workflows/ci.yml"
 - ".github/workflows/release.yml"
 - ".gitignore"
 - ".release-please-manifest.json"
 - ".ruby-version"
 - ".tool-versions"
-- Appraisals
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - Makefile
 - README.md
 - Rakefile
+- bin/console
+- bin/rails
+- bin/sanity
+- bin/sanity_check
+- bin/setup
+- bin/setup_test_db
+- bin/test_connections
 - docker-compose.yml
-- gemfiles/activerecord_6.1.gemfile
-- gemfiles/activerecord_7.0.gemfile
-- gemfiles/activerecord_7.1.gemfile
 - 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/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/with_advisory_lock/base_test.rb
 - test/with_advisory_lock/concern_test.rb
 - test/with_advisory_lock/lock_test.rb
-- test/with_advisory_lock/nesting_test.rb
-- test/with_advisory_lock/options_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
@@ -167,6 +172,16 @@ metadata:
   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: "⚠️  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
@@ -174,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.6.7
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Advisory locking for ActiveRecord
-test_files:
-- test/test_helper.rb
-- test/test_models.rb
-- test/with_advisory_lock/base_test.rb
-- test/with_advisory_lock/concern_test.rb
-- test/with_advisory_lock/lock_test.rb
-- test/with_advisory_lock/nesting_test.rb
-- test/with_advisory_lock/options_test.rb
-- test/with_advisory_lock/parallelism_test.rb
-- test/with_advisory_lock/shared_test.rb
-- test/with_advisory_lock/thread_test.rb
-- test/with_advisory_lock/transaction_test.rb
+test_files: []

data/.github/workflows/ci-mysql5.yml

@@ -1,61 +0,0 @@
-name: CI Mysql 5.7
-on:
-  pull_request:
-    branches:
-      - master
-concurrency:
-  group: ci-mysql5-${{ github.head_ref }}
-  cancel-in-progress: true
-
-jobs:
-  minitest:
-    runs-on: ubuntu-latest
-    name: CI Mysql 5.7 Ruby ${{ matrix.ruby }} / Rails ${{ matrix.rails }} / Adapter ${{ matrix.adapter }}
-    services:
-      mysql:
-        image: mysql/mysql-server:5.7
-        ports:
-          - 3306
-        env:
-          MYSQL_USER: with_advisory
-          MYSQL_PASSWORD: with_advisory_pass
-          MYSQL_DATABASE: with_advisory_lock_test
-          MYSQL_ROOT_HOST: '%'
-    strategy:
-      fail-fast: false
-      matrix:
-        ruby:
-#          - '3.2'
-#          - '3.1'
-#          - '3.0'
-#          - '2.7'
-          - '3.3'
-          - 'truffleruby'
-        rails:
-          - 7.1
-          - "7.0"
-          - 6.1
-        adapter:
-          - mysql2
-          - trilogy
-        include:
-          - ruby: jruby
-            rails: 6.1
-            adapter: jdbcmysql
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v4
-      - name: Setup Ruby
-        uses: ruby/setup-ruby@v1
-        with:
-          ruby-version: ${{ matrix.ruby }}
-          bundler-cache: true
-          rubygems: latest
-        env:
-          BUNDLE_GEMFILE:  gemfiles/activerecord_${{ matrix.rails }}.gemfile
-      - name: Test
-        env:
-          BUNDLE_GEMFILE: gemfiles/activerecord_${{ matrix.rails }}.gemfile
-          DATABASE_URL: ${{ matrix.adapter }}://with_advisory:with_advisory_pass@0:${{ job.services.mysql.ports[3306] }}/with_advisory_lock_test
-          WITH_ADVISORY_LOCK_PREFIX: ${{ github.run_id }}
-        run: bundle exec rake

data/.github/workflows/ci-mysql8.yml

@@ -1,62 +0,0 @@
-name: CI Mysql 8.0
-on:
-  pull_request:
-    branches:
-      - master
-
-concurrency:
-  group: ci-mysql8-${{ github.head_ref }}
-  cancel-in-progress: true
-
-jobs:
-  minitest:
-    runs-on: ubuntu-latest
-    name: CI Mysql 8.0 Ruby ${{ matrix.ruby }} / Rails ${{ matrix.rails }} / Adapter ${{ matrix.adapter }}
-    services:
-      mysql:
-        image: mysql/mysql-server
-        ports:
-          - 3306
-        env:
-          MYSQL_USER: with_advisory
-          MYSQL_PASSWORD: with_advisory_pass
-          MYSQL_DATABASE: with_advisory_lock_test
-          MYSQL_ROOT_HOST: '%'
-    strategy:
-      fail-fast: false
-      matrix:
-        ruby:
-#          - '3.2'
-#          - '3.1'
-#          - '3.0'
-#          - '2.7'
-          - '3.3'
-          - 'truffleruby'
-        rails:
-          - 7.1
-          - "7.0"
-          - 6.1
-        adapter:
-          - mysql2
-#          - trilogy://with_advisory:with_advisory_pass@0/with_advisory_lock_test  Trilogy is not supported by mysql 8 with new encryption
-        include:
-          - ruby: jruby
-            rails: 6.1
-            adapter: jdbcmysql
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v4
-      - name: Setup Ruby
-        uses: ruby/setup-ruby@v1
-        with:
-          ruby-version: ${{ matrix.ruby }}
-          bundler-cache: true
-          rubygems: latest
-        env:
-          BUNDLE_GEMFILE:  gemfiles/activerecord_${{ matrix.rails }}.gemfile
-      - name: Test
-        env:
-          BUNDLE_GEMFILE: gemfiles/activerecord_${{ matrix.rails }}.gemfile
-          DATABASE_URL: ${{ matrix.adapter }}://with_advisory:with_advisory_pass@0:${{ job.services.mysql.ports[3306] }}/with_advisory_lock_test
-          WITH_ADVISORY_LOCK_PREFIX: ${{ github.run_id }}
-        run: bundle exec rake

data/.github/workflows/ci-postgresql.yml

@@ -1,64 +0,0 @@
-name: CI Postgresql
-on:
-  pull_request:
-    branches:
-      - master
-concurrency:
-    group: ci-postgresql-${{ github.head_ref }}
-    cancel-in-progress: true
-
-jobs:
-  minitest:
-    runs-on: ubuntu-latest
-    name: CI Postgresql Ruby ${{ matrix.ruby }} / Rails ${{ matrix.rails }} / Adapter ${{ matrix.adapter }}
-    services:
-      postgres:
-        image: 'postgres:16-alpine'
-        ports:
-         - '5432'
-        env:
-          POSTGRES_USER: with_advisory
-          POSTGRES_PASSWORD: with_advisory_pass
-          POSTGRES_DB: with_advisory_lock_test
-        options: >-
-          --health-cmd pg_isready
-          --health-interval 10s
-          --health-timeout 5s
-          --health-retries 5
-    strategy:
-      fail-fast: false
-      matrix:
-        ruby:
-#          - '3.2'
-#          - '3.1'
-#          - '3.0'
-#          - '2.7'
-          - '3.3'
-          - 'truffleruby'
-        rails:
-          - 7.1
-          - "7.0"
-          - 6.1
-        adapter:
-          - postgres
-        include:
-          - ruby: jruby
-            rails: 6.1
-            adapter: jdbcpostgresql
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v4
-      - name: Setup Ruby
-        uses: ruby/setup-ruby@v1
-        with:
-          ruby-version: ${{ matrix.ruby }}
-          bundler-cache: true
-          rubygems: latest
-        env:
-          BUNDLE_GEMFILE:  gemfiles/activerecord_${{ matrix.rails }}.gemfile
-      - name: Test
-        env:
-          BUNDLE_GEMFILE:  gemfiles/activerecord_${{ matrix.rails }}.gemfile
-          DATABASE_URL: ${{ matrix.adapter }}://with_advisory:with_advisory_pass@localhost:${{ job.services.postgres.ports[5432] }}/with_advisory_lock_test
-          WITH_ADVISORY_LOCK_PREFIX: ${{ github.run_id }}
-        run: bundle exec rake

data/.github/workflows/ci-sqlite3.yml

@@ -1,54 +0,0 @@
-name: CI Sqlite3
-
-on:
-  pull_request:
-    branches:
-      - master
-
-concurrency:
-  group: ci-sqlite3-${{ github.head_ref }}
-  cancel-in-progress: true
-
-jobs:
-  minitest:
-    runs-on: ubuntu-latest
-    name: CI Sqlite3 Ruby ${{ matrix.ruby }} / Rails ${{ matrix.rails }} / Adapter ${{ matrix.adapter }}
-    strategy:
-      fail-fast: false
-      matrix:
-        ruby:
-#          - '3.2'
-#          - '3.1'
-#          - '3.0'
-#          - '2.7'
-          - '3.3'
-          - 'truffleruby'
-        rails:
-          - 7.1
-          - "7.0"
-          - 6.1
-        adapter:
-          - sqlite3
-        include:
-          - ruby: jruby
-            rails: 6.1
-            adapter: jdbcsqlite3
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v4
-
-      - name: Setup Ruby
-        uses: ruby/setup-ruby@v1
-        with:
-          ruby-version: ${{ matrix.ruby }}
-          bundler-cache: true
-          rubygems: latest
-        env:
-          BUNDLE_GEMFILE: gemfiles/activerecord_${{ matrix.rails }}.gemfile
-
-      - name: Test
-        env:
-          BUNDLE_GEMFILE: gemfiles/activerecord_${{ matrix.rails }}.gemfile
-          DATABASE_URL: ${{ matrix.adapter }}:///tmp/test.sqlite3
-          WITH_ADVISORY_LOCK_PREFIX: ${{ github.run_id }}
-        run: bundle exec rake

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: "../"

data/lib/with_advisory_lock/base.rb

@@ -1,118 +0,0 @@
-# frozen_string_literal: true
-
-require 'zlib'
-
-module WithAdvisoryLock
-  class Result
-    attr_reader :result
-
-    def initialize(lock_was_acquired, result = false)
-      @lock_was_acquired = lock_was_acquired
-      @result = result
-    end
-
-    def lock_was_acquired?
-      @lock_was_acquired
-    end
-  end
-
-  FAILED_TO_LOCK = Result.new(false)
-
-  LockStackItem = Struct.new(:name, :shared)
-
-  class Base
-    attr_reader :connection, :lock_name, :timeout_seconds, :shared, :transaction, :disable_query_cache
-
-    def initialize(connection, lock_name, options)
-      options = { timeout_seconds: options } unless options.respond_to?(:fetch)
-      options.assert_valid_keys :timeout_seconds, :shared, :transaction, :disable_query_cache
-
-      @connection = connection
-      @lock_name = lock_name
-      @timeout_seconds = options.fetch(:timeout_seconds, nil)
-      @shared = options.fetch(:shared, false)
-      @transaction = options.fetch(:transaction, false)
-      @disable_query_cache = options.fetch(:disable_query_cache, false)
-    end
-
-    def lock_str
-      @lock_str ||= "#{ENV[LOCK_PREFIX_ENV]}#{lock_name}"
-    end
-
-    def lock_stack_item
-      @lock_stack_item ||= LockStackItem.new(lock_str, shared)
-    end
-
-    def self.lock_stack
-      # access doesn't need to be synchronized as it is only accessed by the current thread.
-      Thread.current[:with_advisory_lock_stack] ||= []
-    end
-    delegate :lock_stack, to: 'self.class'
-
-    def already_locked?
-      lock_stack.include? lock_stack_item
-    end
-
-    def with_advisory_lock_if_needed(&block)
-      if disable_query_cache
-        return lock_and_yield do
-          connection.uncached(&block)
-        end
-      end
-
-      lock_and_yield(&block)
-    end
-
-    def lock_and_yield(&block)
-      if already_locked?
-        Result.new(true, yield)
-      elsif timeout_seconds == 0
-        yield_with_lock(&block)
-      else
-        yield_with_lock_and_timeout(&block)
-      end
-    end
-
-    def stable_hashcode(input)
-      if input.is_a? Numeric
-        input.to_i
-      else
-        # Ruby MRI's String#hash is randomly seeded as of Ruby 1.9 so
-        # make sure we use a deterministic hash.
-        Zlib.crc32(input.to_s, 0)
-      end
-    end
-
-    def yield_with_lock_and_timeout(&block)
-      give_up_at = Time.now + @timeout_seconds if @timeout_seconds
-      while @timeout_seconds.nil? || Time.now < give_up_at
-        r = yield_with_lock(&block)
-        return r if r.lock_was_acquired?
-
-        # Randomizing sleep time may help reduce contention.
-        sleep(rand(0.05..0.15))
-      end
-      FAILED_TO_LOCK
-    end
-
-    def yield_with_lock
-      if try_lock
-        begin
-          lock_stack.push(lock_stack_item)
-          result = block_given? ? yield : nil
-          Result.new(true, result)
-        ensure
-          lock_stack.pop
-          release_lock
-        end
-      else
-        FAILED_TO_LOCK
-      end
-    end
-
-    # Prevent AR from caching results improperly
-    def unique_column_name
-      "t#{SecureRandom.hex}"
-    end
-  end
-end

data/lib/with_advisory_lock/database_adapter_support.rb

@@ -1,23 +0,0 @@
-# frozen_string_literal: true
-
-module WithAdvisoryLock
-  class DatabaseAdapterSupport
-    attr_reader :adapter_name
-    def initialize(connection)
-      @connection = connection
-      @adapter_name   = connection.adapter_name.downcase.to_sym
-    end
-
-    def mysql?
-      %i[mysql2 trilogy].include? adapter_name
-    end
-
-    def postgresql?
-      %i[postgresql empostgresql postgis].include? adapter_name
-    end
-
-    def sqlite?
-      [:sqlite3, :sqlite].include? adapter_name
-    end
-  end
-end