specwrk-store-redis_adapter 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7dfd5dfaecffd662d5eac13f71983a4f1bbafc4b05ef20140a7606d9204d6fd1
-  data.tar.gz: 76623ce696c958f0be9661a7eb2c5455eb384f9c62a1bad4fb24d4182c58bbdf
+  metadata.gz: d6da1ca92a3507c6251032708246c2c75490b189e24427d4541fcba13c9f1931
+  data.tar.gz: b16e5dec0899ac70e6469289a1313ab390127e0bf488cbb53a2e42afcde863d7
 SHA512:
-  metadata.gz: f061f52007d34735b291a5df219412f3a735506b07d0196087dd7218d909d717f409ddefd79fe612fb6c0fa92f0687854912d136360a2803b17c224ab0528420
-  data.tar.gz: 0b6155b3ee87e11d591352b57fe3cc4d6d7d41358bfb14a6f3bc4dcecbed341a59067f5b1acd5d14e6a7398defcc98fa03b175c2bab76380333b9ab894fa457c
+  metadata.gz: c576a494cc6f2828973fe8c494dc880519bc70f8d0189aa0a25e3e0967b4eb86b9b808a2d8ee7acbfcfdd8ff7667aaa130c7d4cc9f3ae7c0586d28e7ac6fe510
+  data.tar.gz: f9ab432763045f76f9d5fbc887eacb5e42b8e141b82362a6a31b981aa9b75f7ea96430953aba893b4604cdc748a15f3c4bcf0685649fcbdc123f08b04f6df458

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 ## [Unreleased]
 
+## [0.2.0] - 2026-08-23
+
+- Replace the Redis queue lock with atomic, token-owned Lua lock and unlock scripts cached and versioned by content SHA.
+- Raise `Specwrk::Store::LockUnavailableError` immediately when a Redis lock cannot be acquired.
+- Document the release process and manage versions with `gem-release`.
+
 ## [0.1.0] - 2025-08-24
 
 - Initial release

data/RELEASING.md

@@ -0,0 +1,95 @@
+# Releasing the Specwrk Redis Store Adapter
+
+Releases are cut from `main` in two stages:
+
+1. `gem bump` updates the version for the release.
+2. Bundler's `rake release` task tags the commit, pushes Git, and publishes the gem.
+
+## One-time setup
+
+Install `gem-release`, which provides the `gem bump` command. It is intentionally
+not a development dependency because it is only needed by maintainers cutting a
+release.
+
+```sh
+gem install gem-release
+```
+
+Configure credentials for RubyGems:
+
+```sh
+gem signin
+```
+
+Pushing this gem to RubyGems requires multi-factor authentication. Run the
+release from an interactive terminal and have your authenticator available.
+RubyGems will prompt for an OTP code or WebAuthn verification when `rake release`
+pushes the gem. Signing in stores an API key, but does not bypass the MFA check
+required for each push.
+
+## Cut a release
+
+Start from an up-to-date, clean `main` branch. This is important because
+`rake release` pushes the current branch.
+
+```sh
+git switch main
+git pull --ff-only origin main
+git status --short
+```
+
+Bump the version without committing. Use `patch`, `minor`, `major`, or an
+explicit version number:
+
+```sh
+gem bump --version patch --no-commit
+```
+
+This updates `lib/specwrk/store/redis_adapter/version.rb` while leaving the
+release changes uncommitted. Update `CHANGELOG.md` using the new version:
+
+1. Add a dated section for the new version.
+2. Move the Unreleased entries into that section.
+3. Leave an empty Unreleased section for subsequent changes.
+
+Stage the version, changelog, and any release documentation, then create the
+version commit:
+
+```sh
+git add lib/specwrk/store/redis_adapter/version.rb CHANGELOG.md RELEASING.md
+git commit -m "Bump specwrk-store-redis_adapter to VERSION"
+```
+
+Replace `VERSION` with the new version, for example `0.1.1`. Confirm that the
+commit contains the version and changelog updates:
+
+```sh
+git show --stat --oneline HEAD
+git status --short
+```
+
+Run the full checks:
+
+```sh
+bundle exec rake
+```
+
+Publish the release:
+
+```sh
+bundle exec rake release
+```
+
+The release task requires a clean tracked worktree and then:
+
+1. Builds `pkg/specwrk-store-redis_adapter-VERSION.gem`.
+2. Creates the annotated `vVERSION` tag.
+3. Pushes `main` and the tag to `origin`.
+4. Pushes the gem to RubyGems.org and prompts for MFA verification.
+
+Use `gem bump` only to update the version; use `bundle exec rake release`, not
+`gem release`, to publish this project.
+
+If the RubyGems push fails after the tag was pushed, fix the authentication or
+network problem and rerun `bundle exec rake release`. The task recognizes the
+existing tag and retries the gem publication.

data/lib/specwrk/store/redis_adapter/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Specwrk
+  class Store
+    REDIS_ADAPTER_VERSION = "0.2.0"
+  end
+end

data/lib/specwrk/store/redis_adapter.rb

@@ -2,14 +2,35 @@
 
 require "json"
 require "securerandom"
+require "digest/sha1"
 
 require "specwrk/store/base_adapter"
 require "specwrk/store/serializer"
+require "specwrk/store/redis_adapter/version"
 require "redis-client"
 
 module Specwrk
   class Store
     class RedisAdapter < Specwrk::Store::BaseAdapter
+      VERSION = REDIS_ADAPTER_VERSION
+      LOCK_TTL_MILLISECONDS = 10_000
+      LOCK_SCRIPT = <<~LUA
+        if redis.call("SET", KEYS[1], ARGV[1], "NX", "PX", ARGV[2]) then
+          return 1
+        end
+
+        return 0
+      LUA
+      UNLOCK_SCRIPT = <<~LUA
+        if redis.call("GET", KEYS[1]) == ARGV[1] then
+          return redis.call("DEL", KEYS[1])
+        end
+
+        return 0
+      LUA
+      LOCK_SCRIPT_SHA = Digest::SHA1.hexdigest(LOCK_SCRIPT)
+      UNLOCK_SCRIPT_SHA = Digest::SHA1.hexdigest(UNLOCK_SCRIPT)
+
       @connection_pools = {}
       @mutex = Mutex.new
 
@@ -19,23 +40,19 @@ module Specwrk
             Thread.current[:connection] = connection
 
             id = SecureRandom.uuid
-            queue = "specwrk-lock-#{key}"
-            connection.pipelined do |pipeline|
-              pipeline.call("RPUSH", queue, id)
-              pipeline.call("EXPIRE", queue, 10) # only set if no expireat already
-            end
+            lock_key = "specwrk-lock-#{key}"
+            locked = false
 
-            # wait for our id to be first in line or the queue to expire
-            sleep(0.01 * rand) until [id, nil].include? connection.call("LINDEX", queue, 0)
+            locked = obtain_lock(connection, lock_key, id)
+            raise Specwrk::Store::LockUnavailableError unless locked
 
             yield
           ensure
-            connection.pipelined do |pipeline|
-              pipeline.call("LPOP", queue)
-              pipeline.call("EXPIRE", queue, 10) # keeps the queue fresh when things are moving
+            begin
+              release_lock(connection, lock_key, id) if locked
+            ensure
+              Thread.current[:connection] = nil
             end
-
-            Thread.current[:connection] = nil
           end
         end
 
@@ -52,6 +69,23 @@ module Specwrk
         def reset_connections!
           @connection_pools.clear
         end
+
+        private
+
+        def obtain_lock(connection, key, id)
+          eval_script(connection, LOCK_SCRIPT, LOCK_SCRIPT_SHA, key, id, LOCK_TTL_MILLISECONDS) == 1
+        end
+
+        def release_lock(connection, key, id)
+          eval_script(connection, UNLOCK_SCRIPT, UNLOCK_SCRIPT_SHA, key, id)
+        end
+
+        def eval_script(connection, script, sha, key, *arguments)
+          connection.call("EVALSHA", sha, 1, key, *arguments)
+        rescue RedisClient::NoScriptError
+          connection.call("SCRIPT", "LOAD", script)
+          retry
+        end
       end
 
       def [](key)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: specwrk-store-redis_adapter
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Daniel Westendorf
@@ -15,14 +15,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.19.1
+        version: 0.19.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.19.1
+        version: 0.19.4
 - !ruby/object:Gem::Dependency
   name: redis-client
   requirement: !ruby/object:Gem::Requirement
@@ -76,9 +76,11 @@ files:
 - CHANGELOG.md
 - LICENSE
 - README.md
+- RELEASING.md
 - Rakefile
 - docker-compose.yml
 - lib/specwrk/store/redis_adapter.rb
+- lib/specwrk/store/redis_adapter/version.rb
 homepage: https://github.com/danielwestendorf/specwrk-store-redis_adapter
 licenses:
 - GPL-3.0-or-later
@@ -100,7 +102,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 4.0.10
 specification_version: 4
 summary: Redis adapater for Specwrk, a parallel RSpec test runner
 test_files: []