idempotency_lock 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2433a11192a9d10ad05520f94d7b60854531c2c23ee0e2c674318c34aa77739c
-  data.tar.gz: 6b7e54105e42bee7122d20670a9bfc18192b4d0846e58b131939cf46274fa98f
+  metadata.gz: 88b6cc80e37f3db005c446a96005520945b141ef45f1ff4d90863975de52ed45
+  data.tar.gz: 43adf42af7496edc68cf46590fc2d09d585214c44dcd57487d0c290161f4af72
 SHA512:
-  metadata.gz: 102949944e74ef10b4f9ba6d3d62221abb307aaf79da156b6e25277eea4fd11032a435a1ea726044e228635c30e00511d7df46a10fe5f66621bf24dac901721b
-  data.tar.gz: 110b05bb0e03d952e5a44051dc4dfbb51c728e06f63e58aa46d2379482ab34ee261a39410fed5d90db4c0abe800948cfb509b4f4a17ec03d0a2ffb8b5e2513e0
+  metadata.gz: 989d09faf1a493cf14ee9426c4ffa67275a761e5784072164a0b3e24f9f3202a0424308f9621cace94e2245707ae25d936b96349a8798dfd5bb2b38656529b7c
+  data.tar.gz: '084463272e767a8579dde4848d1a386645119404d65c608ee5d2960940963e877dbeaa3ed4c481679e6d5e14811cdeabeee2427a906571e2db9ea1366baf7344'

data/CHANGELOG.md

@@ -1,5 +1,27 @@
 ## [Unreleased]
 
+## [0.1.2] - 2025-12-06
+
+### Fixed
+
+- Migration now works with MySQL (uses regular index instead of partial index,
+  which MySQL doesn't support)
+
+### Added
+
+- `Result#inspect` for easier debugging
+
+## [0.1.1] - 2025-12-06
+
+### Fixed
+
+- Use optimistic locking when claiming expired locks to prevent race conditions
+  where two processes with clock skew could both claim the same lock
+
+### Changed
+
+- `now` parameter is now injectable in `Lock.acquire`, `expired?`, and `valid_lock?` for testing
+
 ## [0.1.0] - 2025-12-06
 
 ### Added

data/README.md

@@ -186,7 +186,7 @@ The gem creates an `idempotency_locks` table with:
 
 Indexes:
 - Unique index on `name` (provides atomicity)
-- Partial index on `expires_at` where not null (for efficient TTL queries)
+- Index on `expires_at` (partial index on PostgreSQL/SQLite, regular index on MySQL)
 
 **Note on name length:** Lock names are limited to 255 characters to ensure compatibility with database unique index limits. MySQL users with `utf8mb4` encoding may need to reduce this to 191 characters by modifying the migration before running it.
 

data/lib/generators/idempotency_lock/templates/create_idempotency_locks.rb.erb

@@ -13,7 +13,14 @@ class CreateIdempotencyLocks < ActiveRecord::Migration<%= migration_version %>
     end
 
     add_index :idempotency_locks, :name, unique: true
-    add_index :idempotency_locks, :expires_at, where: "expires_at IS NOT NULL"
+
+    # Partial indexes are more efficient but not supported by MySQL.
+    # Use a regular index for MySQL, partial index for PostgreSQL/SQLite.
+    if ActiveRecord::Base.connection.adapter_name.downcase.include?("mysql")
+      add_index :idempotency_locks, :expires_at
+    else
+      add_index :idempotency_locks, :expires_at, where: "expires_at IS NOT NULL"
+    end
   end
 end
 

data/lib/idempotency_lock/lock.rb

@@ -24,14 +24,14 @@ module IdempotencyLock
 
     # Check if this lock has expired
     # @return [Boolean]
-    def expired?
-      expires_at.present? && expires_at < Time.current
+    def expired?(now: Time.current)
+      expires_at.present? && expires_at < now
     end
 
     # Check if this lock is still valid (not expired)
     # @return [Boolean]
-    def valid_lock?
-      expires_at.nil? || expires_at >= Time.current
+    def valid_lock?(now: Time.current)
+      expires_at.nil? || expires_at >= now
     end
 
     class << self
@@ -40,7 +40,7 @@ module IdempotencyLock
       #
       # @param name [String] unique identifier for the operation
       # @param expires_at [Time, nil] when the lock should expire (nil = never)
-      # @param now [Time] current time reference
+      # @param now [Time] current time reference (injectable for testing)
       # @return [Boolean] true if lock was acquired
       def acquire(name, expires_at: nil, now: Time.current)
         # Try to insert first (most common case for new keys)
@@ -51,10 +51,17 @@ module IdempotencyLock
           # Lock exists, check if it's expired
         end
 
-        # Atomic update: claim the lock only if it's expired
-        # Returns number of rows updated (0 or 1)
-        updated = where(name: name)
-                  .where("expires_at IS NOT NULL AND expires_at < ?", now)
+        # Check if an existing lock is expired and can be claimed
+        existing = find_by(name: name)
+        return false if existing.nil?
+        return false unless existing.expired?(now: now)
+
+        # Optimistic locking: use the observed expires_at in the WHERE clause.
+        # This prevents a race where two processes both see an expired lock and
+        # both try to claim it. Only one UPDATE will match; the other returns 0.
+        # This is safer than `WHERE expires_at < now` which could allow a second
+        # process to steal a lock if the first used a short TTL.
+        updated = where(name: name, expires_at: existing.expires_at)
                   .update_all(expires_at: expires_at, executed_at: now, updated_at: now)
 
         updated.positive?

data/lib/idempotency_lock/result.rb

@@ -40,5 +40,14 @@ module IdempotencyLock
     def success?
       @executed && !error?
     end
+
+    # @return [String] human-readable representation for debugging
+    def inspect
+      parts = ["executed=#{@executed}"]
+      parts << "skipped=#{@skipped}" if @skipped
+      parts << "value=#{@value.inspect}" if @value
+      parts << "error=#{@error.class}" if @error
+      "#<IdempotencyLock::Result #{parts.join(" ")}>"
+    end
   end
 end

data/lib/idempotency_lock/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module IdempotencyLock
-  VERSION = "0.1.0"
+  VERSION = "0.1.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: idempotency_lock
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - John Nagro