specwrk-store-redis_adapter 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2774f66f6a6356247c90f8dae3cc57452a0389ed502d4713ddd5d3ccc5c3f9cb
+  data.tar.gz: 2ff23a77e09dab33ae4518e2fffa96af8d1893349278615542074073859d8ed2
+SHA512:
+  metadata.gz: 785340c5eaf3af5540b4eb0ed60d95ff79ed98574bdc1734822cce33091327b99b9f27579ea233c3d9682bc471257906d6da2e9127c2f1267daf607871e75085
+  data.tar.gz: 156a21fb6424a180af03989bcbb3973e5825b32664ab9e1fc77c511124643c58b03f8bb8636ef00153721a458302e9b7a2fbaa09e87fe4919492b3409a343c4c

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.standard.yml

@@ -0,0 +1,3 @@
+# For available configuration options, see:
+#   https://github.com/standardrb/standard
+ruby_version: 3.1

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2025-08-24
+
+- Initial release

data/LICENSE

@@ -0,0 +1,5 @@
+Copyright (c) Daniel Westendorf
+
+specwrk-store-redis_adapter is an Open Source project licensed under the terms of
+the LGPLv3 license.  Please see <http://www.gnu.org/licenses/lgpl-3.0.html>
+for license text.

data/README.md

@@ -0,0 +1,3 @@
+# Redis Store Adapter for Specwrk
+
+TODO!

data/Rakefile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "standard/rake"
+
+task default: %i[spec standard]

data/docker-compose.yml

@@ -0,0 +1,6 @@
+version: '3'
+services:
+  redis:
+    image: redis:4.0
+    ports:
+      - "0.0.0.0:6379:6379"

data/lib/specwrk/store/redis_adapter.rb

@@ -0,0 +1,166 @@
+# frozen_string_literal: true
+
+require "json"
+
+require "specwrk/store/base_adapter"
+require "redis-client"
+require "redlock"
+
+module Specwrk
+  class Store
+    class RedisAdapter < Specwrk::Store::BaseAdapter
+      VERSION = "0.1.0"
+
+      REDIS_KEY_DELIMITER = "||||"
+
+      @connection_pools = {}
+      @mutex = Mutex.new
+
+      class << self
+        def with_lock(uri, key)
+          connection_pool_for(uri).with do |connection|
+            client = Redlock::Client.new(
+              [connection],
+              retry_count: lock_retry_count,
+              retry_delay: lock_retry_delay,
+              retry_jitter: lock_retry_jitter
+            )
+
+            until (lock = client.lock("specwrk-lock-#{key}", lock_ttl))
+              sleep(rand(0.001..0.09))
+            end
+
+            yield
+
+            client.unlock(lock)
+          end
+        end
+
+        def connection_pool_for(uri)
+          return @connection_pools[uri] if @connection_pools.key? uri
+
+          @mutex.synchronize do
+            @connection_pools[uri] ||= RedisClient.config(url: uri).new_pool(
+              size: ENV.fetch("SPECWRK_THREAD_COUNT", "4").to_i
+            )
+          end
+        end
+
+        def reset_connections!
+          @connection_pools.clear
+        end
+
+        private
+
+        # In ms
+        def lock_ttl
+          ENV.fetch("SPECWRK_REDIS_ADAPTER_LOCK_TTL", "5000").to_i
+        end
+
+        # See https://www.rubydoc.info/gems/redlock/Redlock/Client#initialize-instance_method
+        def lock_retry_count
+          ENV.fetch("SPECWRK_REDIS_ADAPTER_LOCK_RETRY_COUNT", "3").to_i
+        end
+
+        def lock_retry_delay
+          ENV.fetch("SPECWRK_REDIS_ADAPTER_LOCK_RETRY_DELAY", "100").to_i
+        end
+
+        def lock_retry_jitter
+          ENV.fetch("SPECWRK_REDIS_ADAPTER_LOCK_RETRY_JITTER", "10").to_i
+        end
+      end
+
+      def [](key)
+        with_connection do |redis|
+          value = redis.call("GET", encode_key(key))
+          JSON.parse(value, symbolize_names: true) if value
+        end
+      end
+
+      def []=(key, value)
+        with_connection do |redis|
+          redis.call("SET", encode_key(key), JSON.generate(value))
+        end
+      end
+
+      def keys
+        [].tap do |collected|
+          scan_for("#{scope}#{REDIS_KEY_DELIMITER}*") { |k| collected << decode_key(k) }
+        end
+      end
+
+      def clear
+        delete(*keys)
+      end
+
+      def delete(*keys)
+        return if keys.length.zero?
+
+        with_connection do |redis|
+          redis.call("DEL", *keys.map { |key| encode_key key })
+        end
+      end
+
+      def merge!(h2)
+        multi_write(h2)
+      end
+
+      def multi_read(*read_keys)
+        return {} if read_keys.length.zero?
+
+        values = with_connection do |redis|
+          redis.call("MGET", *read_keys.map { |key| encode_key(key) })
+        end
+
+        result = {}
+
+        read_keys.zip(values).each do |key, value|
+          next if value.nil?
+          result[key] = JSON.parse(value, symbolize_names: true)
+        end
+
+        result
+      end
+
+      def multi_write(hash)
+        return if hash.nil? || hash.length.zero?
+
+        with_connection do |redis|
+          redis.call("MSET", *hash.flat_map { |key, value| [encode_key(key), JSON.generate(value)] })
+        end
+      end
+
+      def empty?
+        keys.length.zero?
+      end
+
+      private
+
+      def with_connection
+        self.class.connection_pool_for(uri).with do |connection|
+          yield connection
+        end
+      end
+
+      def encode_key(key)
+        [scope, REDIS_KEY_DELIMITER, key].join
+      end
+
+      def decode_key(key)
+        key.split(REDIS_KEY_DELIMITER).last
+      end
+
+      def scan_for(match)
+        with_connection do |redis|
+          cursor = "0"
+          loop do
+            cursor, batch = redis.call("SCAN", cursor, "MATCH", match, "COUNT", 5_000)
+            batch.each { |k| yield k }
+            break if cursor == "0"
+          end
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: specwrk-store-redis_adapter
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Daniel Westendorf
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: specwrk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: redis-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: redlock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: standard
+  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'
+email:
+- daniel@prowestech.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".standard.yml"
+- CHANGELOG.md
+- LICENSE
+- README.md
+- Rakefile
+- docker-compose.yml
+- lib/specwrk/store/redis_adapter.rb
+homepage: https://github.com/danielwestendorf/specwrk-store-redis_adapter
+licenses:
+- GPL-3.0-or-later
+metadata:
+  homepage_uri: https://github.com/danielwestendorf/specwrk-store-redis_adapter
+  source_code_uri: https://github.com/danielwestendorf/specwrk-store-redis_adapter
+  changelog_uri: https://github.com/danielwestendorf/specwrk-store-redis_adapter/blob/main/CHANGELOG.md
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: Redis adapater for Specwrk, a parallel RSpec test runner
+test_files: []