with_transactional_lock 2.3.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5e23e87e0f583421cd8059c2357cb938189754803f981411f6dac9111ba128df
-  data.tar.gz: 7294f251168099acfad4122609c6a0d5b2debb17edb6a66ebc65e5ea87f1efdb
+  metadata.gz: 5a37a429d4501cab5013a8adda04f58543f9dfa1ce272669fb3e77b50ba41ba1
+  data.tar.gz: 21c127ebf79c22c6e6b658b0bd3084553af9f0f0a414171438912d6f3f32b63a
 SHA512:
-  metadata.gz: 1e4984a3ea1ceda7c6a163b99eff34f6364ab37038da8a26e15ed01d5527a8775ac70b33db4c6dcbb8a8385528a62bdadb39a2983e05036a269f630a94b72338
-  data.tar.gz: 7f1a85d1c4372eaee6406cb95a8c3c7b45bd35b8ac3248d321c212e06b37f033a4628a4d29ce358d6fcef200e90a671405c9537b3bcf791f0f56f3d787aa5a0b
+  metadata.gz: 6f177f997f70e2b22c426ca79281a537ef4a058e6baaf31bbe34730700b451c06fc5c2e81b3f809d5c525feab6c3e5427cc6650051f08ff5ca63c26d9242d5b4
+  data.tar.gz: fef780d0e0805babed56e1e6f2f64642c13afcc27ac1ada1b71a2e4b9ed9b24aa523ca571f02b5c711d6ac47159569240a853fa8aedbac4d0eb06507c6690dbd

data/README.md

@@ -1,14 +1,14 @@
 # with_transactional_lock
 
 A simple extension to ActiveRecord for performing advisory locking on
-MySQL and PostgreSQL.
+PostgreSQL.
 
 An advisory lock is a database-level mutex that can be used to prevent
 concurrent access to a shared resource or to prevent two workers from
 performing the same process concurrently.
 
 This gem is different from other advisory locking gems because it
-uses advisory transaction locks instead of advisory session locks. 
+uses advisory transaction locks instead of advisory session locks.
 
 ## Why transactional?
 
@@ -31,7 +31,7 @@ preventing leaks.
 Additionally, application developers tend to think about discrete units
 of database work in terms of transactions. By leveraging the transaction
 boundary, we ensure the advisory lock is released at the earliest
-possible moment that it can be and no sooner. 
+possible moment that it can be and no sooner.
 
 ## Lock acquisition efficiency & fairness
 
@@ -60,25 +60,16 @@ waiting on I/O (possibly allowing another thread to use the CPU).
 
 Add this line to your application's Gemfile:
 
-``` ruby
+```ruby
 gem 'with_transactional_lock'
 ```
 
 And then bundle install:
 
 ```
-$ bundle install
-```
-
-And then if you're using MySQL, you will need to run the installer:
-
-```
-$ rails g with_transactional_lock:install
+bundle install
 ```
 
-This will create a migration that will add an
-`transactional_advisory_locks` table to your database.
-
 ## Usage
 
 Because transactional locks are meaningless outside of the context of a
@@ -92,12 +83,12 @@ ActiveRecord::Base.with_transactional_lock('name_of_a_resource') do
 end
 ```
 
-This call will attempt to acquire an exclusive lock using the provided 
+This call will attempt to acquire an exclusive lock using the provided
 lock name. It will wait indefinitely for that lock -- or at least as
 long as your database connection timeout is willing to allow. Once the
 lock is acquired you will have exclusive ownership of the advisory lock
 with the name that you provided. Your block is free to execute its
-critical work. Upon completion of your transaction, the lock will be 
+critical work. Upon completion of your transaction, the lock will be
 released.
 
 ## Supported databases
@@ -109,15 +100,6 @@ PostgreSQL has first-class support for transactional advisory locks via
 duration of a given transaction and automatically released upon
 transaction commit.
 
-### MySQL
-
-MySQL does not have built-in support for transactional advisory locks.
-So, MySQL gets a special treatment. We emulate the behavior of PostgreSQL
-using a special `transactional_advisory_locks` table with a unique index 
-on the `lock_id` column. This allows us to provide the same transactional 
-and mutual exclusivity guarantees as PostgreSQL. The trade-off is that 
-you need to add another table to your database.
-
 ## License
 
 Any contributions made to this project are covered under the MIT License, found [here](LICENSE)

data/lib/with_transactional_lock/mixin.rb

@@ -23,8 +23,6 @@ module WithTransactionalLock
       def self.locate(connection)
         adapter = connection.adapter_name.downcase.to_sym
         case adapter
-        when :mysql, :mysql2
-          MySqlAdvisoryLock
         when :postgresql
           PostgresAdvisoryLock
         else
@@ -55,20 +53,11 @@ module WithTransactionalLock
       end
     end
 
-    class MySqlAdvisoryLock < AdvisoryLockBase
-      private
-
-      def acquire_lock
-        connection.execute("insert into transactional_advisory_locks values (#{connection.quote(db_lock_name)}) \
-        on duplicate key update lock_id = lock_id")
-      end
-    end
-
     class PostgresAdvisoryLock < AdvisoryLockBase
       private
 
       def acquire_lock
-        connection.execute("select pg_advisory_xact_lock(#{connection.quote(db_lock_name)})")
+        connection.execute("/* lock:#{lock_name} */ SELECT pg_advisory_xact_lock(#{connection.quote(db_lock_name)})")
       end
     end
   end

data/lib/with_transactional_lock/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module WithTransactionalLock
-  VERSION = "2.3.0"
+  VERSION = "3.0.0"
 end

data/lib/with_transactional_lock.rb

@@ -5,7 +5,6 @@ require "with_transactional_lock/engine"
 module WithTransactionalLock
   extend ActiveSupport::Autoload
   autoload :Mixin
-  autoload :MySqlHelper
 end
 
 ActiveSupport.on_load(:active_record) { include WithTransactionalLock::Mixin }

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: with_transactional_lock
 version: !ruby/object:Gem::Version
-  version: 2.3.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Sam Moore
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-11-22 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -19,7 +18,7 @@ dependencies:
         version: '7.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '7.2'
+        version: '8.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +28,7 @@ dependencies:
         version: '7.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '7.2'
+        version: '8.1'
 - !ruby/object:Gem::Dependency
   name: railties
   requirement: !ruby/object:Gem::Requirement
@@ -39,7 +38,7 @@ dependencies:
         version: '7.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '7.2'
+        version: '8.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -49,23 +48,9 @@ dependencies:
         version: '7.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '7.2'
+        version: '8.1'
 - !ruby/object:Gem::Dependency
   name: appraisal
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 2.2.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 2.2.0
-- !ruby/object:Gem::Dependency
-  name: betterlint
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -79,7 +64,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: database_cleaner
+  name: betterlint
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -93,7 +78,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: mysql2
+  name: database_cleaner
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -148,7 +133,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Advisory locking support for MySQL and Postgresql done right.
+description: Advisory locking support for Postgresql done right.
 email:
 - sam@betterment.com
 executables: []
@@ -158,13 +143,9 @@ files:
 - LICENSE
 - README.md
 - Rakefile
-- lib/generators/with_transactional_lock/install/install_generator.rb
-- lib/generators/with_transactional_lock/install/templates/README
-- lib/generators/with_transactional_lock/install/templates/db/migrate/create_transactional_advisory_locks.rb
 - lib/with_transactional_lock.rb
 - lib/with_transactional_lock/engine.rb
 - lib/with_transactional_lock/mixin.rb
-- lib/with_transactional_lock/my_sql_helper.rb
 - lib/with_transactional_lock/version.rb
 homepage: https://github.com/Betterment/with_transactional_lock
 licenses:
@@ -172,7 +153,6 @@ licenses:
 metadata:
   allowed_push_host: https://rubygems.org
   rubygems_mfa_required: 'true'
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -187,8 +167,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.23
-signing_key:
+rubygems_version: 3.7.0
 specification_version: 4
 summary: Transactional advisory locks for ActiveRecord
 test_files: []

data/lib/generators/with_transactional_lock/install/install_generator.rb

@@ -1,36 +0,0 @@
-# frozen_string_literal: true
-
-require 'rails/generators/base'
-require 'rails/generators/active_record'
-
-module WithTransactionalLock
-  module Generators
-    class InstallGenerator < Rails::Generators::Base
-      include Rails::Generators::Migration
-      source_root File.expand_path('templates', __dir__)
-
-      def show_readme
-        readme 'README'
-      end
-
-      def create_with_transactional_lock_migration
-        if mysql?
-          migration_template(
-            'db/migrate/create_transactional_advisory_locks.rb',
-            'db/migrate/create_transactional_advisory_locks.rb',
-          )
-        end
-      end
-
-      def self.next_migration_number(dir)
-        ActiveRecord::Generators::Base.next_migration_number(dir)
-      end
-
-      private
-
-      def mysql?
-        ActiveRecord::Base.connection.adapter_name.downcase.include?('mysql')
-      end
-    end
-  end
-end

data/lib/generators/with_transactional_lock/install/templates/README

@@ -1,8 +0,0 @@
-*******************************************************************************
-
-If you're using MySql, then run `rake db:migrate` to setup the `transactional_advisory_locks`
-table.
-
-If you're using Postgresql, then you're all set!
-
-*******************************************************************************

data/lib/generators/with_transactional_lock/install/templates/db/migrate/create_transactional_advisory_locks.rb

@@ -1,10 +0,0 @@
-# frozen_string_literal: true
-
-class CreateTransactionalAdvisoryLocks < ActiveRecord::Migration
-  def change
-    create_table :transactional_advisory_locks, id: false do |t|
-      t.integer :lock_id, null: false, limit: 8
-    end
-    add_index(:transactional_advisory_locks, :lock_id, unique: true, name: 'index_transactional_advisory_locks_on_lock_id')
-  end
-end

data/lib/with_transactional_lock/my_sql_helper.rb

@@ -1,13 +0,0 @@
-# frozen_string_literal: true
-
-module WithTransactionalLock
-  class MySqlHelper
-    def self.cleanup(klass = ActiveRecord::Base)
-      klass.connection_pool.with_connection do |conn|
-        target_count = conn.select_value('select count(1) from transactional_advisory_locks')
-        count = 0
-        count += conn.delete('delete from transactional_advisory_locks limit 1000') until count >= target_count
-      end
-    end
-  end
-end