idempo 1.1.0 → 1.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9bfbbd03a37973e1309f1c9d3a0aa1032cbfdfaae73f78f275a7fd9800e5e9ed
-  data.tar.gz: 54e1bb92e23d7003e7d4205e0964e94ab7288d342f2032fd4f7f2a280a2341f1
+  metadata.gz: 70c151d3823c956aac177dbf39ee4e5f216b9464a739b134c8a47822a01aa765
+  data.tar.gz: 4306e629c9d0f1bd59ad74bc6e61623e441e4713b88bccb8f69c08e8553dc251
 SHA512:
-  metadata.gz: 9be3229d0844358a342b5fcc65a885e96f0ae7ae73ebcfe91b74046ed7ddc3e90d836d2fbe047f22434f9bd15beda36d5f0d0eb5bf4f8f597996fa7006a00101
-  data.tar.gz: a9933869e79cd56229907bafe38b8c135357eb1e3b9ff8954e51f74f4a171b33dee8e5322a9178782c95e4686d96104d9ff4fbc4d801b5ff12066591cd68cd7b
+  metadata.gz: 5e80a42f84a311e633697123f7213af21b0f79d501937d5963e4dd918eb5cabd5d01174d781b0528d4f51923fc9eb038af20afeb164c8cdd51d2cc1983ea1111
+  data.tar.gz: 4d2ee3d361d009aacc23c42ec38323c9b9373d874c9abbd70596882dbd48d6ed4edcf9eb5c32f44e366aa091e178dfcd71c919b45d6bc1b8c17804094b23629f

data/.github/workflows/ci.yml

@@ -15,7 +15,7 @@ jobs:
     strategy:
       matrix:
         ruby:
-          - '2.7'
+          - "2.7"
     steps:
       - name: Checkout
         uses: actions/checkout@v4
@@ -37,11 +37,16 @@ jobs:
     name: Specs
     runs-on: ubuntu-22.04
     if: github.event_name == 'push' || github.event.pull_request.head.repo.full_name != github.repository
+    env:
+      IDEMPO_RACK_VERSION: ${{ matrix.rack }}
     strategy:
       matrix:
         ruby:
-          - '2.7'
-          - '3.2'
+          - "2.7"
+          - "3.2"
+        rack:
+          - "2.0"
+          - "3.0"
     services:
       mysql:
         image: mysql:5.7
@@ -65,6 +70,7 @@ jobs:
     steps:
       - name: Checkout
         uses: actions/checkout@v4
+
       - name: Setup Ruby
         uses: ruby/setup-ruby@v1
         with:

data/CHANGELOG.md

@@ -1,4 +1,17 @@
-## [1.1.0] - 2024-02-22
+## 1.2.2
+
+- Support `#to_ary` on Rack response bodies on newer Rails/Rack versions
+
+## 1.2.1
+
+- Use autoloading for internal modules. A user using Redis does not have to load the ActiveRecord storage backend, for example
+- Ensure that the original Rack response body receives a `close` when reading out for caching
+
+## 1.2.0
+
+- Use memory locking in addition to DB locking in `ActiveRecordBackend`
+
+## 1.1.0
 
 - Use modern ActiveRecord migration options for better Rails 7.x compatibility
 - Ensure Github actions CI can run and uses Postgres appropriately
@@ -6,16 +19,16 @@
 - Implement `#prune!` on storage backends
 - Reformat all code using [standard](https://github.com/standardrb/standard) instead of wetransfer_style as it is both more relaxed and more modern
 
-## [1.0.0] - 2023-10-27
+## 1.0.0
 
 - Release 1.0 as the API can be considered stable and the gem has been in production for years
 
-## [0.2.0] - 2022-04-08
+## 0.2.0
 
 - Allow setting the global default TTL for the cached responses
 - Allow customisation of the request key computation (so that the client can decide whether to include/exclude `Authorization` and the like)
 - Extract the error response generating apps into separate modules, to make them easier to override
 
-## [0.1.0] - 2021-10-14
+## 0.1.0
 
 - Initial release

data/README.md

@@ -10,7 +10,8 @@ instead of calling your application.
 Idempo supports a number of backends, we recommend using Redis if you have multiple application servers / dynos and MemoryBackend if you are only using one single Puma worker. To initialize with Redis as backend pass the `backend:` parameter when adding the middleware:
 
 ```ruby
-use Idempo, backend: Idempo::RedisBackend.new(Rails.application.config.redis_connection_pool)
+be = Idempo::RedisBackend.new(Rails.application.config.redis_connection_pool)
+use Idempo, backend: be
 ```
 
 and to initialize with a memory store as backend:
@@ -65,7 +66,8 @@ end
 Then configure Idempo to use the backend (in your `application.rb`):
 
 ```ruby
-config.middleware.insert Idempo, backend: Idempo::ActiveRecordBackend.new
+be = Idempo::ActiveRecordBackend.new
+config.middleware.insert Idempo, backend: be
 ```
 
 In your regular tasks (cron or Rake) you will want to add a call to delete old Idempo responses (there is an index on `expire_at`):
@@ -87,7 +89,8 @@ use Idempo, backend: Idempo::RedisBackend.new
 If you have a configured Redis connection pool (and you should) - pass it to the initializer:
 
 ```ruby
-config.middleware.insert Idempo, backend: Idempo::RedisBackend.new(config.redis_connection_pool)
+be = Idempo::RedisBackend.new(config.redis_connection_pool)
+config.middleware.insert Idempo, backend: be
 ```
 
 All data stored in Redis will have TTLs and will expire automatically. Redis scripts ensure that updates to the stored idempotent responses and locking happen atomically.

data/idempo.gemspec

@@ -35,11 +35,10 @@ Gem::Specification.new do |spec|
   spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  # Uncomment to register a new dependency of your gem
-  spec.add_dependency "rack"
   spec.add_dependency "msgpack"
   spec.add_dependency "measurometer", "~> 1.3"
 
+  spec.add_development_dependency "rack", "~> 3"
   spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "redis", "~> 4"

data/lib/idempo/active_record_backend.rb

@@ -60,6 +60,7 @@ class Idempo::ActiveRecordBackend
 
   def initialize
     require "active_record"
+    @memory_lock = Idempo::MemoryLock.new
   end
 
   # Allows the model to be defined lazily without having to require active_record when this module gets loaded
@@ -70,15 +71,25 @@ class Idempo::ActiveRecordBackend
   end
 
   def with_idempotency_key(request_key)
-    db_safe_key = Digest::SHA1.base64digest(request_key)
-    lock = lock_implementation_for_connection(model.connection)
-
-    raise Idempo::ConcurrentRequest unless lock.acquire(model.connection, request_key)
-
-    begin
-      yield(Store.new(db_safe_key, model))
-    ensure
-      lock.release(model.connection, request_key)
+    # We need to use an in-memory lock because database advisory locks are
+    # reentrant. Both Postgres and MySQL allow multiple acquisitions of the
+    # same advisory lock within the same connection - in most Rails/Rack apps
+    # this translates to "within the same thread". This means that if one
+    # elects to use a non-threading webserver (like Falcon), or tests Idempo
+    # within the same thread (like we do), they won't get advisory locking
+    # for concurrent requests. Therefore a staged lock is required. First we apply
+    # the memory lock (for same thread on this process/multiple threads on this
+    # process) and then once we have that - the DB lock.
+    @memory_lock.with(request_key) do
+      db_safe_key = Digest::SHA1.base64digest(request_key)
+      database_lock = lock_implementation_for_connection(model.connection)
+      raise Idempo::ConcurrentRequest unless database_lock.acquire(model.connection, request_key)
+
+      begin
+        yield(Store.new(db_safe_key, model))
+      ensure
+        database_lock.release(model.connection, request_key)
+      end
     end
   end
 

data/lib/idempo/concurrent_request_error_app.rb

@@ -1,5 +1,3 @@
-require "json"
-
 class Idempo::ConcurrentRequestErrorApp
   RETRY_AFTER_SECONDS = 2.to_s
 

data/lib/idempo/malformed_key_error_app.rb

@@ -1,5 +1,3 @@
-require "json"
-
 class Idempo::MalformedKeyErrorApp
   def self.call(env)
     res = {

data/lib/idempo/memory_backend.rb

@@ -1,12 +1,9 @@
 class Idempo::MemoryBackend
   def initialize
-    require "set"
     require_relative "response_store"
-
-    @requests_in_flight_mutex = Mutex.new
-    @in_progress = Set.new
-    @store_mutex = Mutex.new
+    @lock = Idempo::MemoryLock.new
     @response_store = Idempo::ResponseStore.new
+    @store_mutex = Mutex.new
   end
 
   class Store < Struct.new(:store_mutex, :response_store, :key, keyword_init: true)
@@ -24,22 +21,9 @@ class Idempo::MemoryBackend
   end
 
   def with_idempotency_key(request_key)
-    did_insert = @requests_in_flight_mutex.synchronize do
-      if @in_progress.include?(request_key)
-        false
-      else
-        @in_progress << request_key
-        true
-      end
-    end
-
-    raise Idempo::ConcurrentRequest unless did_insert
-
-    store = Store.new(store_mutex: @store_mutex, response_store: @response_store, key: request_key)
-    begin
+    @lock.with(request_key) do
+      store = Store.new(store_mutex: @store_mutex, response_store: @response_store, key: request_key)
       yield(store)
-    ensure
-      @requests_in_flight_mutex.synchronize { @in_progress.delete(request_key) }
     end
   end
 

data/lib/idempo/memory_lock.rb

@@ -0,0 +1,21 @@
+# A memory lock prevents multiple requests with the same request
+# fingerprint from running concurrently
+class Idempo::MemoryLock
+  def initialize
+    @requests_in_flight_mutex = Mutex.new
+    @in_progress = Set.new
+  end
+
+  def with(request_key)
+    @requests_in_flight_mutex.synchronize do
+      if @in_progress.include?(request_key)
+        raise Idempo::ConcurrentRequest
+      else
+        @in_progress << request_key
+      end
+    end
+    yield
+  ensure
+    @requests_in_flight_mutex.synchronize { @in_progress.delete(request_key) }
+  end
+end

data/lib/idempo/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class Idempo
-  VERSION = "1.1.0"
+  VERSION = "1.2.2"
 end

data/lib/idempo.rb

@@ -6,16 +6,20 @@ require "json"
 require "measurometer"
 require "msgpack"
 require "zlib"
+require "set"
+require "rack"
 
-require_relative "idempo/active_record_backend"
-require_relative "idempo/concurrent_request_error_app"
-require_relative "idempo/malformed_key_error_app"
-require_relative "idempo/memory_backend"
-require_relative "idempo/redis_backend"
-require_relative "idempo/request_fingerprint"
-require_relative "idempo/version"
+require "idempo/version"
 
 class Idempo
+  autoload :ConcurrentRequestErrorApp, "idempo/concurrent_request_error_app"
+  autoload :MalformedKeyErrorApp, "idempo/malformed_key_error_app"
+  autoload :MemoryBackend, "idempo/memory_backend"
+  autoload :RedisBackend, "idempo/redis_backend"
+  autoload :ActiveRecordBackend, "idempo/active_record_backend"
+  autoload :RequestFingerprint, "idempo/request_fingerprint"
+  autoload :MemoryLock, "idempo/memory_lock"
+
   DEFAULT_TTL_SECONDS = 30
   SAVED_RESPONSE_BODY_SIZE_LIMIT = 4 * 1024 * 1024
 
@@ -54,6 +58,12 @@ class Idempo
       status, headers, body = @app.call(env)
 
       expires_in_seconds = (headers.delete("X-Idempo-Persist-For-Seconds") || @persist_for_seconds).to_i
+
+      # In some cases `body` could respond to to_ary. In this case, we don't need to call .close on body afterwards.
+      #
+      # @see https://github.com/rack/rack/blob/main/SPEC.rdoc#the-body-
+      body = body.to_ary if rack_v3? && body.respond_to?(:to_ary)
+
       if response_may_be_persisted?(status, headers, body)
         # Body is replaced with a cached version since a Rack response body is not rewindable
         marshaled_response, body = serialize_response(status, headers, body)
@@ -73,6 +83,10 @@ class Idempo
 
   private
 
+  def rack_v3?
+    Gem::Version.new(Rack.release) >= Gem::Version.new("3.0")
+  end
+
   def from_persisted_response(marshaled_response)
     if marshaled_response[-2..] != ":1"
       raise Error, "Unknown serialization of the marshaled response"
@@ -85,7 +99,6 @@ class Idempo
     # Buffer the Rack response body, we can only do that once (it is non-rewindable)
     body_chunks = []
     rack_response_body.each { |chunk| body_chunks << chunk.dup }
-    rack_response_body.close if rack_response_body.respond_to?(:close)
 
     # Only keep headers which are strings
     stringified_headers = headers.each_with_object({}) do |(header, value), filtered|
@@ -101,6 +114,9 @@ class Idempo
     # (when we unserialize our response again) does a realloc, while slicing at the start
     # does not
     [deflated_message_packed_str, body_chunks]
+  ensure
+    # This will not be applied to response bodies of Array type.
+    rack_response_body.close if rack_response_body.respond_to?(:close)
   end
 
   def response_may_be_persisted?(status, headers, body)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: idempo
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.2
 platform: ruby
 authors:
 - Julik Tarkhanov
@@ -9,10 +9,10 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-02-22 00:00:00.000000000 Z
+date: 2024-09-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rack
+  name: msgpack
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -26,33 +26,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: msgpack
+  name: measurometer
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.3'
 - !ruby/object:Gem::Dependency
-  name: measurometer
+  name: rack
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
-  type: :runtime
+        version: '3'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -192,6 +192,7 @@ files:
 - lib/idempo/concurrent_request_error_app.rb
 - lib/idempo/malformed_key_error_app.rb
 - lib/idempo/memory_backend.rb
+- lib/idempo/memory_lock.rb
 - lib/idempo/redis_backend.rb
 - lib/idempo/request_fingerprint.rb
 - lib/idempo/response_store.rb
@@ -219,7 +220,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: Idempotency keys for all.