redis-cluster-activesupport 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6cac869b68eafe05a50192c4e9551bb0f9cfa2f5d12f914a0a96a150409f624f
-  data.tar.gz: 43e3d49d20105a2f93a1eecdad0c2a37b21df9780a882f8665f0b8d6faccb802
+  metadata.gz: add6d07c71703b7fb32e3500b0045464fb1934f80d3d25b70ea8722a94733775
+  data.tar.gz: 82624a0a5d4e631da5812ab4b547b95b92d00a34dcfa3f91cc2e7a2c1b69daad
 SHA512:
-  metadata.gz: 16d2b4b7c0db6c1beb26bbbfcef6f4c9d71b379c2dfa8f51f20bf8a3e5ef0c267f9f8f09dfb1758fff26289718b2cfba9511ec4196d227a658c41c7e4b0fe06c
-  data.tar.gz: e884694bb86da4e3494ffa5c823b184b45302fd5f9bc5ee4b441b46e4ceb6cd96d6628a03078e2370c05113980198f6a4417a54691d904f26f45b7dcb40dd8ce
+  metadata.gz: eeb5b301ef0666b2c511868c9e16e43a895240373aa014b5842bf70f04e02ed61ebb2a1addd4cca01baadf125184ede29fab0a1847f271297f22ba4d99fc49b2
+  data.tar.gz: 99ea8eb9e80bd102a5571eabfdbb3f3d0129bacfd97abe549df69c77dd3ad4cbcdce145dd463f282e2e00962acd80f373bfc4843bcd596111dfde85f790a1c85

data/.github/workflows/ci.yml

@@ -11,43 +11,69 @@ on:
   pull_request:
     branches: [ master ]
 jobs:
+  # Fast unit specs (fakeredis) across every supported Ruby x Rails combination.
+  # Supported Rubies: CRuby 3.1-3.4, JRuby 9.4 (Ruby 3.1) and 10.0 (Ruby 3.4).
+  # The gemfiles are generated from Appraisals at runtime (they are gitignored).
   test:
     runs-on: ubuntu-latest
     strategy:
+      fail-fast: false
       matrix:
-        ruby-version: [ '3.2', '3.1', '3.0', '2.7', '2.6', 'jruby-9.3', 'jruby-9.4' ]
-        gemfile: [ 'rails60', 'rails61', 'rails70', 'rails71', 'rails72' ]
+        ruby-version: [ '3.4', '3.3', '3.2', '3.1', 'jruby-9.4', 'jruby-10.0' ]
+        appraisal: [ 'rails60', 'rails61', 'rails70', 'rails71', 'rails72', 'rails80', 'rails81' ]
         exclude:
-          - ruby-version: '2.6'
-            gemfile: 'rails70'
-          - ruby-version: '2.6'
-            gemfile: 'rails71'
-          - ruby-version: '2.6'
-            gemfile: 'rails72'
-          - ruby-version: '2.7'
-            gemfile: 'rails72'
-          - ruby-version: '3.0'
-            gemfile: 'rails72'
-          - ruby-version: 'jruby-9.3'
-            gemfile: 'rails70'
-          - ruby-version: 'jruby-9.3'
-            gemfile: 'rails71'
-          - ruby-version: 'jruby-9.3'
-            gemfile: 'rails72'
-    env: # $BUNDLE_GEMFILE must be set at the job level, so it is set for all steps
-      BUNDLE_GEMFILE: ${{ github.workspace }}/gemfiles/${{ matrix.gemfile }}.gemfile
-      RAILS_ENV: test
+          # Rails 8.0/8.1 require Ruby 3.2+ (excludes 3.1 and JRuby 9.4 which is Ruby 3.1)
+          - { ruby-version: '3.1', appraisal: 'rails80' }
+          - { ruby-version: '3.1', appraisal: 'rails81' }
+          - { ruby-version: 'jruby-9.4', appraisal: 'rails80' }
+          - { ruby-version: 'jruby-9.4', appraisal: 'rails81' }
+          # Rails 6.0/6.1 don't load on Ruby 3.4 (base64/mutex_m dropped from
+          # default gems and undeclared by those Rails versions); JRuby 10.0 is Ruby 3.4.
+          - { ruby-version: '3.4', appraisal: 'rails60' }
+          - { ruby-version: '3.4', appraisal: 'rails61' }
+          - { ruby-version: 'jruby-10.0', appraisal: 'rails60' }
+          - { ruby-version: 'jruby-10.0', appraisal: 'rails61' }
     steps:
       - name: Checkout code
         uses: actions/checkout@v4
-      # Add or replace dependency steps here
       - name: Install Ruby and gems
         uses: ruby/setup-ruby@v1
         with:
           bundler-cache: true
           ruby-version: ${{ matrix.ruby-version }}
-      # Add or replace test runners here
-      - name: Run tests
-        run: bundle exec rspec
-        env:
-          BUNDLE_GEMFILE: ${{ github.workspace }}/gemfiles/${{ matrix.gemfile }}.gemfile
+      - name: Generate appraisal gemfiles
+        run: bundle exec appraisal generate
+      - name: Install gems for ${{ matrix.appraisal }}
+        run: bundle exec appraisal ${{ matrix.appraisal }} bundle install
+      - name: Run unit tests
+        run: bundle exec appraisal ${{ matrix.appraisal }} rspec
+
+  # Full integration specs against a real Redis Cluster (3 masters + 3 replicas).
+  integration:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        # 3.2 is the minimum Ruby for Rails 8; 3.4 is the newest supported.
+        ruby-version: [ '3.4', '3.2' ]
+        appraisal: [ 'rails70', 'rails71', 'rails72', 'rails80', 'rails81' ]
+    env:
+      REDIS_CLUSTER_NODES: "127.0.0.1:7000,127.0.0.1:7001,127.0.0.1:7002"
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+      - name: Install Redis (server + cli for cluster support)
+        run: sudo apt-get update && sudo apt-get install -y redis-server redis-tools
+      - name: Install Ruby and gems
+        uses: ruby/setup-ruby@v1
+        with:
+          bundler-cache: true
+          ruby-version: ${{ matrix.ruby-version }}
+      - name: Generate appraisal gemfiles
+        run: bundle exec appraisal generate
+      - name: Install gems for ${{ matrix.appraisal }}
+        run: bundle exec appraisal ${{ matrix.appraisal }} bundle install
+      - name: Boot Redis Cluster
+        run: ./bin/redis-cluster
+      - name: Run integration tests
+        run: bundle exec appraisal ${{ matrix.appraisal }} rake integration

data/.gitignore

@@ -10,4 +10,7 @@
 
 # rspec failure tracking
 .rspec_status
-gemfiles/*.lock
+
+# Gemfiles are generated from Appraisals by `bundle exec appraisal generate`
+gemfiles/*.gemfile
+gemfiles/*.gemfile.lock

data/.rspec

@@ -1,2 +1,3 @@
 --format documentation
 --color
+--exclude-pattern "integration/**/*_spec.rb"

data/Appraisals

@@ -0,0 +1,29 @@
+# Regenerate the gemfiles/ with `bundle exec appraisal generate`.
+# The generated gemfiles are gitignored; CI regenerates them on each run.
+appraise "rails60" do
+  gem "activesupport", "~> 6.0.0"
+end
+
+appraise "rails61" do
+  gem "activesupport", "~> 6.1.0"
+end
+
+appraise "rails70" do
+  gem "activesupport", "~> 7.0.0"
+end
+
+appraise "rails71" do
+  gem "activesupport", "~> 7.1.0"
+end
+
+appraise "rails72" do
+  gem "activesupport", "~> 7.2.0"
+end
+
+appraise "rails80" do
+  gem "activesupport", "~> 8.0.0"
+end
+
+appraise "rails81" do
+  gem "activesupport", "~> 8.1.0"
+end

data/README.md

@@ -1,4 +1,4 @@
-# Redis cluster stores for ActiveSupport [![Build Status](https://travis-ci.org/film42/redis-cluster-activesupport.svg?branch=master)](https://travis-ci.org/film42/redis-cluster-activesupport)
+# Redis cluster stores for ActiveSupport [![CI](https://github.com/film42/redis-cluster-activesupport/actions/workflows/ci.yml/badge.svg)](https://github.com/film42/redis-cluster-activesupport/actions/workflows/ci.yml)
 
 This gem was an extension to [redis-activesupport](https://github.com/redis-store/redis-activesupport) that adds support
 for a few features required to use `redis-store` with redis cluster. Right now there isn't an official redis cluster
@@ -23,6 +23,27 @@ end
 ```
 
 
+## Limitations
+
+Because keys in a redis cluster are partitioned across shards, operations that
+touch **multiple keys at once** can't be executed in a single command and are
+therefore not supported. These methods raise `NotImplementedError` instead of
+silently returning incorrect results:
+
+- `read_multi` (would use `MGET`)
+- `write_multi` (would use `MSET`)
+- `fetch_multi` (would use `MULTI`)
+- `delete_matched` (would use `KEYS`/`SCAN`)
+
+```ruby
+store.read_multi("a", "b")        # => raises NotImplementedError
+store.write_multi("a" => 1, "b" => 2)  # => raises NotImplementedError
+```
+
+Read and write a single key at a time instead. Single-key operations
+(`read`, `write`, `fetch`, `increment`, `decrement`, `delete`, `exist?`) work
+as usual.
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -39,6 +60,48 @@ Or install it yourself as:
 
     $ gem install redis-cluster-activesupport
 
+## Compatibility
+
+Requires Ruby 3.1+ (CRuby 3.1–3.4, JRuby 9.4–10.0) and is tested against
+ActiveSupport 6.0 through 8.1 (Rails 6.0–8.1). Note that Rails 6.0/6.1 only run
+on Ruby 3.1–3.3, and Rails 8.0/8.1 require Ruby 3.2+. See
+[`.github/workflows/ci.yml`](.github/workflows/ci.yml) for the full Ruby x Rails
+support matrix.
+
+## Development & Testing
+
+Fast unit specs run against [fakeredis](https://github.com/guilleiguaran/fakeredis):
+
+```sh
+bundle exec rspec        # unit specs only (integration specs are excluded)
+```
+
+Integration specs exercise the store against a **real Redis Cluster**. Spin one
+up locally (3 masters + 3 replicas) and run them with:
+
+```sh
+bin/redis-cluster        # boots a cluster on 127.0.0.1:7000-7005
+bundle exec rake integration
+bin/redis-cluster stop   # tear it down when finished
+```
+
+Point the specs at an existing cluster with `REDIS_CLUSTER_NODES`
+(comma-separated seed nodes, e.g. `127.0.0.1:7000,127.0.0.1:7001`). On macOS,
+port 7000 is often held by the AirPlay Receiver — use
+`REDIS_CLUSTER_BASE_PORT=7010 bin/redis-cluster` and set `REDIS_CLUSTER_NODES`
+accordingly.
+
+To test against a specific Rails version, use [appraisal](https://github.com/thoughtbot/appraisal).
+The supported versions are declared in [`Appraisals`](Appraisals) and the
+`gemfiles/` are generated from it (and gitignored):
+
+```sh
+bundle exec appraisal generate            # (re)generate gemfiles/ from Appraisals
+bundle exec appraisal install             # generate + bundle install every version
+bundle exec appraisal rails81 rspec       # run unit specs against a single version
+bundle exec appraisal rails81 rake integration   # integration specs (needs a cluster)
+```
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/film42/redis-cluster-activesupport.

data/Rakefile

@@ -1,6 +1,15 @@
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
 
+# Fast unit specs (fakeredis) — this is what runs by default and excludes the
+# integration suite via .rspec's --exclude-pattern.
 RSpec::Core::RakeTask.new(:spec)
 
+# Integration specs that run against a real Redis Cluster. Requires a running
+# cluster (see `bin/redis-cluster`) or REDIS_CLUSTER_NODES.
+RSpec::Core::RakeTask.new(:integration) do |t|
+  t.pattern = "spec/integration/**/*_spec.rb"
+  t.rspec_opts = "--exclude-pattern ''"
+end
+
 task :default => :spec

data/bin/redis-cluster

@@ -0,0 +1,84 @@
+#!/usr/bin/env bash
+#
+# Boots a local Redis Cluster (3 masters + 3 replicas) for the integration specs,
+# then creates the cluster. Used by developers locally and by CI.
+#
+#   bin/redis-cluster            # start + create the cluster
+#   bin/redis-cluster stop       # stop the cluster and clean up
+#
+# Configure with:
+#   REDIS_CLUSTER_BASE_PORT  first node port (default 7000; nodes use base..base+5)
+#   REDIS_CLUSTER_HOST       bind/announce host (default 127.0.0.1)
+#   REDIS_CLUSTER_DIR        working dir for node data (default ./tmp/redis-cluster)
+#
+# Note for macOS users: port 7000 is often taken by the AirPlay Receiver
+# (Control Center). Either disable it or run with REDIS_CLUSTER_BASE_PORT=7010.
+set -euo pipefail
+
+HOST="${REDIS_CLUSTER_HOST:-127.0.0.1}"
+BASE_PORT="${REDIS_CLUSTER_BASE_PORT:-7000}"
+DIR="${REDIS_CLUSTER_DIR:-$(pwd)/tmp/redis-cluster}"
+
+PORTS=()
+for i in 0 1 2 3 4 5; do PORTS+=("$((BASE_PORT + i))"); done
+
+stop_cluster() {
+  echo "Stopping Redis Cluster nodes on ports ${PORTS[*]}..."
+  for p in "${PORTS[@]}"; do
+    redis-cli -h "$HOST" -p "$p" shutdown nosave >/dev/null 2>&1 || true
+  done
+  rm -rf "$DIR"
+  echo "Done."
+}
+
+if [[ "${1:-start}" == "stop" ]]; then
+  stop_cluster
+  exit 0
+fi
+
+echo "Starting Redis Cluster: ${HOST} ports ${PORTS[*]}"
+rm -rf "$DIR"
+for p in "${PORTS[@]}"; do
+  mkdir -p "$DIR/$p"
+  redis-server \
+    --port "$p" \
+    --cluster-enabled yes \
+    --cluster-config-file nodes.conf \
+    --cluster-node-timeout 5000 \
+    --appendonly no \
+    --save "" \
+    --dir "$DIR/$p" \
+    --daemonize yes \
+    --logfile "$DIR/$p/server.log"
+done
+
+# Wait for every node to accept connections before forming the cluster.
+for p in "${PORTS[@]}"; do
+  for _ in $(seq 1 50); do
+    if redis-cli -h "$HOST" -p "$p" ping >/dev/null 2>&1; then break; fi
+    sleep 0.2
+  done
+done
+
+ADDRS=()
+for p in "${PORTS[@]}"; do ADDRS+=("$HOST:$p"); done
+
+redis-cli --cluster create "${ADDRS[@]}" --cluster-replicas 1 --cluster-yes
+
+# `--cluster create` returns once all slots are covered, but there is a brief
+# gossip window before every node reports `cluster_state:ok`. Commands issued
+# during that window can fail, so block until each node considers the cluster
+# ready before handing control back to the caller / test suite.
+echo "Waiting for cluster_state:ok on all nodes..."
+for p in "${PORTS[@]}"; do
+  for _ in $(seq 1 50); do
+    if redis-cli -h "$HOST" -p "$p" cluster info 2>/dev/null | grep -q "cluster_state:ok"; then
+      break
+    fi
+    sleep 0.2
+  done
+done
+
+echo
+echo "Redis Cluster ready. Seed nodes:"
+echo "  REDIS_CLUSTER_NODES=${HOST}:${PORTS[0]},${HOST}:${PORTS[1]},${HOST}:${PORTS[2]}"

data/lib/active_support/cache/redis_cluster_store.rb

@@ -7,6 +7,14 @@ module ActiveSupport
         fail ::NotImplementedError, "Deleting keys with a matcher is not supported with redis cluster"
       end
 
+      def read_multi(*names)
+        fail ::NotImplementedError, "Reading multiple keys with MGET is not supported with redis cluster because the keys may live on different shards"
+      end
+
+      def write_multi(hash, options = nil)
+        fail ::NotImplementedError, "Writing multiple keys with MSET is not supported with redis cluster because the keys may live on different shards"
+      end
+
       def fetch_multi(*names)
         fail ::NotImplementedError, "The default implementation uses MULTI which isn't supported. This can be changed to use MSET and work."
       end

data/redis-cluster-activesupport.gemspec

@@ -3,7 +3,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = "redis-cluster-activesupport"
-  spec.version       = "1.3.0"
+  spec.version       = "1.4.0"
   spec.authors       = ["Garrett Thornburg"]
   spec.email         = ["film42@gmail.com"]
 
@@ -19,7 +19,10 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "activesupport", ">= 6.0", "< 7.3"
+  spec.required_ruby_version = ">= 3.1"
+
+  spec.add_dependency "activesupport", ">= 6.0", "< 8.2"
+  spec.add_development_dependency "appraisal"
   spec.add_development_dependency "bundler"
   spec.add_development_dependency "fakeredis"
   spec.add_development_dependency "pry"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: redis-cluster-activesupport
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Garrett Thornburg
@@ -18,7 +18,7 @@ dependencies:
         version: '6.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '7.3'
+        version: '8.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -28,7 +28,21 @@ dependencies:
         version: '6.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '7.3'
+        version: '8.2'
+- !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'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -109,18 +123,14 @@ files:
 - ".github/workflows/ci.yml"
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
+- Appraisals
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - bin/console
+- bin/redis-cluster
 - bin/setup
-- gemfiles/rails60.gemfile
-- gemfiles/rails61.gemfile
-- gemfiles/rails70.gemfile
-- gemfiles/rails71.gemfile
-- gemfiles/rails72.gemfile
 - lib/active_support/cache/redis_cluster_store.rb
 - lib/redis/cluster/activesupport.rb
 - redis-cluster-activesupport.gemspec
@@ -135,14 +145,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 4.0.15
 specification_version: 4
 summary: Extension to redis-activesupport for working with redis cluster
 test_files: []

data/.travis.yml

@@ -1,18 +0,0 @@
-language: ruby
-rvm:
- - jruby-9.4
- - jruby-9.3
- - 3.2
- - 3.1
- - 3.0
- - 2.7
- - 2.6
-gemfile:
-  - gemfiles/rails60.gemfile
-  - gemfiles/rails61.gemfile
-sudo: false
-cache: bundler
-notifications:
-  email:
-    on_success: never
-    on_failure: always

data/gemfiles/rails60.gemfile

@@ -1,4 +0,0 @@
-source "https://rubygems.org"
-
-gem "activesupport", "~> 6.0.0"
-gemspec path: "../"

data/gemfiles/rails61.gemfile

@@ -1,4 +0,0 @@
-source "https://rubygems.org"
-
-gem "activesupport", "~> 6.1.0"
-gemspec path: "../"

data/gemfiles/rails70.gemfile

@@ -1,4 +0,0 @@
-source "https://rubygems.org"
-
-gem "activesupport", "~> 7.0.0"
-gemspec path: "../"

data/gemfiles/rails71.gemfile

@@ -1,4 +0,0 @@
-source "https://rubygems.org"
-
-gem "activesupport", "~> 7.1.0"
-gemspec path: "../"

data/gemfiles/rails72.gemfile

@@ -1,4 +0,0 @@
-source "https://rubygems.org"
-
-gem "activesupport", "~> 7.2.0"
-gemspec path: "../"