idempo 1.2.1 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 79351972a8246031e7301fcadb2d3721fa99300edffc00a3cb1a2e5fa828c68b
-  data.tar.gz: 27bb14ea7cfe6a10de6367cd725a549a0e26ccec289ca6bdc192752df39c60db
+  metadata.gz: 3db7fbb3c612bae5675890f118986c3d026e49c73f3c74c24f15fea51e6a67c7
+  data.tar.gz: 65a193261af6e424fe8f7e3437d28e02c20ddb4c9ae199c9556f39676474b8ac
 SHA512:
-  metadata.gz: e7cab37f569d2688a83b0d2c25c8f73b720c3fbc294ab6f2cd70686167f8c8dfb1864c738a33ffa28fec152f346e409cc0088be2d9a907974ac8c5370a9469fb
-  data.tar.gz: f2ad3d16e636499ce989c9093ad0c7144fb9d22fe89d63939045fbe9df593595ce349d4e9ae25cb70898020bc1e66ea0307889cd7b1eb3060e758675219e5add
+  metadata.gz: bd32562481a479070ed2806ef3201d370417fd9acfbbb8499d1aefb2f1000f278ee3dff47ccb0ac640f33001be8c41cccba7c498980d07c893dee519e53f539b
+  data.tar.gz: df3b05f901ac7e49bb82bfde9a522e2a179b96953db10751b7814858597a5a0af0aa82ff0fd6824e3a11cae6bdf4ebc84004a35b09cfae7a39958114a307eef8

data/.github/workflows/ci.yml

@@ -15,7 +15,7 @@ jobs:
     strategy:
       matrix:
         ruby:
-          - '2.7'
+          - "2.7"
     steps:
       - name: Checkout
         uses: actions/checkout@v4
@@ -34,14 +34,13 @@ jobs:
       - name: Standard (Lint)
         run: bundle exec rake standard
   test:
-    name: Specs
+    name: "Specs (Rack 2 and 3)"
     runs-on: ubuntu-22.04
     if: github.event_name == 'push' || github.event.pull_request.head.repo.full_name != github.repository
     strategy:
       matrix:
         ruby:
-          - '2.7'
-          - '3.2'
+          - "2.7"
     services:
       mysql:
         image: mysql:5.7
@@ -65,13 +64,14 @@ jobs:
     steps:
       - name: Checkout
         uses: actions/checkout@v4
+
       - name: Setup Ruby
         uses: ruby/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby }}
           bundler-cache: true
-      - name: RSpec
-        run: bundle exec rspec
+      - name: RSpec via Appraisal
+        run: "bundle exec appraisal install && bundle exec appraisal rspec"
         env:
           MYSQL_HOST: 127.0.0.1
           MYSQL_PORT: 3306

data/Appraisals

@@ -0,0 +1,9 @@
+appraise "rack-3" do
+  gem "rack", ">= 3.0"
+  gem "activerecord", "~> 7.0", "< 9.0"
+end
+
+appraise "rack-2" do
+  gem "rack", ">= 2.0", "< 3.0"
+  gem "activerecord", "~> 6", "< 7.0"
+end

data/CHANGELOG.md

@@ -1,13 +1,21 @@
-## [1.2.1] - 2024-02-22
+## 1.3.0
+
+- Streamline integration with both Rack 2 and 3, add tests for request fingerprinting.
+
+## 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] - 2024-02-22
+## 1.2.0
 
 - Use memory locking in addition to DB locking in `ActiveRecordBackend`
 
-## [1.1.0] - 2024-02-22
+## 1.1.0
 
 - Use modern ActiveRecord migration options for better Rails 7.x compatibility
 - Ensure Github actions CI can run and uses Postgres appropriately
@@ -15,16 +23,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/Rakefile

@@ -3,7 +3,11 @@
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
 require "standard/rake"
+require "appraisal"
 
 RSpec::Core::RakeTask.new(:spec)
-
 task default: :spec
+
+if !ENV["APPRAISAL_INITIALIZED"]
+  task default: :appraisal
+end

data/idempo.gemspec

@@ -29,16 +29,15 @@ Gem::Specification.new do |spec|
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
   spec.files = Dir.chdir(File.expand_path(__dir__)) do
-    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features|gemfiles)/}) }
   end
   spec.bindir = "exe"
   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_dependency "rack", "< 4"
 
   spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "rspec", "~> 3.0"
@@ -48,6 +47,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "mysql2"
   spec.add_development_dependency "pg"
   spec.add_development_dependency "standard"
+  spec.add_development_dependency "appraisal"
 
   # For more information and examples about making a new gem, checkout our
   # guide at: https://bundler.io/guides/creating_gem.html

data/lib/idempo/concurrent_request_error_app.rb

@@ -8,6 +8,6 @@ class Idempo::ConcurrentRequestErrorApp
         message: "Another request with this idempotency key is still in progress, please try again later"
       }
     }
-    [429, {"Retry-After" => RETRY_AFTER_SECONDS, "Content-Type" => "application/json"}, [JSON.pretty_generate(res)]]
+    [429, {"retry-after" => RETRY_AFTER_SECONDS, "content-type" => "application/json"}, [JSON.pretty_generate(res)]]
   end
 end

data/lib/idempo/malformed_key_error_app.rb

@@ -6,6 +6,6 @@ class Idempo::MalformedKeyErrorApp
         message: "The Idempotency-Key header provided was empty or malformed"
       }
     }
-    [400, {"Content-Type" => "application/json"}, [JSON.pretty_generate(res)]]
+    [400, {"content-type" => "application/json"}, [JSON.pretty_generate(res)]]
   end
 end

data/lib/idempo/request_fingerprint.rb

@@ -5,11 +5,24 @@ module Idempo::RequestFingerprint
     d << rack_request.url << "\n"
     d << rack_request.request_method << "\n"
     d << rack_request.get_header("HTTP_AUTHORIZATION").to_s << "\n"
-    while (chunk = rack_request.env["rack.input"].read(1024 * 65))
-      d << chunk
+
+    # Under Rack 3.0 the rack.input may or may not be rewindable (this is done to support
+    # streaming HTTP request bodies). If we know a request body is rewindable we can read it
+    # out in full and add it to the request fingerprint. If the request body cannot be
+    # rewound, we can't really rely on it as it can be fairly large (and we want the
+    # downstream app to read the request body, not us).
+    if rack_request.env["rack.input"].respond_to?(:rewind)
+      read_and_rewind(rack_request.env["rack.input"], d)
     end
+
     Base64.strict_encode64(d.digest)
+  end
+
+  def self.read_and_rewind(source_io, to_destination_io)
+    while (chunk = source_io.read(1024 * 65))
+      to_destination_io << chunk
+    end
   ensure
-    rack_request.env["rack.input"].rewind
+    source_io.rewind
   end
 end

data/lib/idempo/version.rb

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

data/lib/idempo.rb

@@ -7,6 +7,7 @@ require "measurometer"
 require "msgpack"
 require "zlib"
 require "set"
+require "rack"
 
 require "idempo/version"
 
@@ -54,9 +55,17 @@ class Idempo
         return from_persisted_response(stored_response)
       end
 
-      status, headers, body = @app.call(env)
+      status, raw_headers, body = @app.call(env)
+      headers = downcase_keys(raw_headers)
+
+      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 the body afterwards, as it is supposed to self-close as per Rack 3.0 SPEC
+      #
+      # @see https://github.com/rack/rack/blob/main/SPEC.rdoc#the-body-
+      body = body.to_ary if body.respond_to?(:to_ary)
 
-      expires_in_seconds = (headers.delete("X-Idempo-Persist-For-Seconds") || @persist_for_seconds).to_i
       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)
@@ -76,6 +85,12 @@ class Idempo
 
   private
 
+  def downcase_keys(raw_headers)
+    raw_headers.each_with_object({}) do |(name, value), hh|
+      hh[name.to_s.downcase] = value
+    end
+  end
+
   def from_persisted_response(marshaled_response)
     if marshaled_response[-2..] != ":1"
       raise Error, "Unknown serialization of the marshaled response"
@@ -104,21 +119,23 @@ class Idempo
     # 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)
-    return false if headers.delete("X-Idempo-Policy") == "no-store"
+    return false if headers.delete("x-idempo-policy") == "no-store"
     return false unless status_may_be_persisted?(status)
     return false unless body_size_within_limit?(headers, body)
     true
   end
 
   def body_size_within_limit?(response_headers, body)
-    return response_headers["Content-Length"].to_i <= SAVED_RESPONSE_BODY_SIZE_LIMIT if response_headers["Content-Length"]
+    if response_headers["content-length"]
+      return response_headers["content-length"].to_i <= SAVED_RESPONSE_BODY_SIZE_LIMIT
+    end
 
     return false unless body.is_a?(Array) # Arbitrary iterable of unknown size
-
     sum_of_string_bytesizes(body) <= SAVED_RESPONSE_BODY_SIZE_LIMIT
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: idempo
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.3.0
 platform: ruby
 authors:
 - Julik Tarkhanov
@@ -9,10 +9,10 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-02-27 00:00:00.000000000 Z
+date: 2024-11-29 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'
+        version: '4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '4'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -165,6 +165,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !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'
 description: Provides idempotency keys for Rack applications.
 email:
 - me@julik.nl
@@ -177,6 +191,7 @@ files:
 - ".gitignore"
 - ".rubocop.yml"
 - ".standard.yml"
+- Appraisals
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt