grape-idempotency 1.1.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 115100d8cd1141c7c801a1501ede2db9eff3419a5b2974de93c4b79e7c812fd2
-  data.tar.gz: 567472c4ab8ad2aae2561d7af0e808c803a025caae34f75492c2b889b6468d7e
+  metadata.gz: be4536a211550d89d0c48cd4c83c7704cb5242bedd7028fe10037e1ceac11f76
+  data.tar.gz: 5fed5897f5416f70e99771aa7a773433420829acb60c9682fec55d943ac5080c
 SHA512:
-  metadata.gz: fde07abe226552ba88086f20fcece9778ef13ee04c17c27376aea2d13386955944caea65ae28ff1d2abdda72bc501600a9afb107229e6da47b4dd02a56b2e5f5
-  data.tar.gz: 3a9a9fcd8f30d5f1deab9da2c719c54c1a0cbecafb5ce3b1196301bc60983bd3271153f4b02fed795d49d4188255507e0a8445d1fdd37cad1bbe0a0851b32e48
+  metadata.gz: 797f3ba565676d3eb97c5b0d38af871ec0c017b3f1a0705b08cd80c7f8b6fa30d32d3c921bb46aa2910827e06bb21500d3bf83e63c017177feb33e13bb5a0ab3
+  data.tar.gz: 071c4135447ceb9389cd2c5d8c2bb92477465318c523efc25eca43967e0c4533366a5d576cac3c52ee097c59ccd1164628124d73a5aea1072f6bfed7da3ae78b

data/CHANGELOG.md

@@ -4,20 +4,31 @@ All changes to `grape-idempotency` will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [1.1.0] - (Next)
+## [1.1.1] - 2026-10-15
 
 ### Fix
 
-* Your contribution here.
+* Catch errors thrown with `error!` inside `rescue_from` handlers, which raised `UncaughtThrowError` with Grape >= 2.1 - [@jcagarcia](https://github.com/jcagarcia).
+* Return Grape's `500 Invalid response` when a `rescue_from` handler does not return a valid response, instead of raising `NoMethodError: undefined method 'default_rescue_handler'` with Grape >= 2.1 - [@jcagarcia](https://github.com/jcagarcia).
+* Store that `500 Invalid response` for the idempotency key, so retrying the request replays it instead of returning `409 Conflict` until the key expires - [@jcagarcia](https://github.com/jcagarcia).
+* Support `rescue_from ..., with: :helper_method` with Grape >= 3.0, which resolves symbol handlers on the endpoint - [@jcagarcia](https://github.com/jcagarcia).
+* Only treat a Hash returned by a `rescue_from` handler as an error response when it contains `:message`, `:status` and `:headers`, matching Grape - [@jcagarcia](https://github.com/jcagarcia).
+* Handle `Grape::Exceptions::ErrorResponse` thrown by `error!` with Grape >= 3.3, both inside `idempotent` blocks and inside `rescue_from` handlers - [@jcagarcia](https://github.com/jcagarcia).
+* [#22](https://github.com/jcagarcia/grape-idempotency/pull/22): Do not turn `rescue_from` responses into 500 errors when a stored error request expires or is invalid while being looked up. - [@salrepe](https://github.com/salrepe).
+* [#22](https://github.com/jcagarcia/grape-idempotency/pull/22): Only access the storage from the error middleware for requests that stored an error inside `idempotent`, reading that exact key instead of scanning all error keys. - [@salrepe](https://github.com/salrepe).
+* [#22](https://github.com/jcagarcia/grape-idempotency/pull/22): Do not store error requests when no idempotency key was provided. - [@salrepe](https://github.com/salrepe).
 
 ### Changed
 
-* Your contribution here.
+* [#24](https://github.com/jcagarcia/grape-idempotency/issues/24): Test Ruby (2.6 - 4.0) and Grape (1.5 - 4.0) in CI: the combinations where behaviour changes on every push and pull request, and every supported combination plus the latest Grape release weekly or on demand - [@jcagarcia](https://github.com/jcagarcia).
+* Document Ruby and Grape compatibility in the README - [@jcagarcia](https://github.com/jcagarcia).
+
+
+## [1.1.0] - 2023-12-12
 
 ### Feature
 
-* [#20](https://github.com/jcagarcia/grape-idempotency/pull/20): Manage `Redis` exceptions by default and allow the gem's consumer to manage them by itself - [@jcagarcia](https://github.com/jcagarcia).
-* Your contribution here.
+* [#20](https://github.com/jcagarcia/grape-idempotency/pull/20): Allow consumers to configure the gem for handling `Redis` exceptions - [@jcagarcia](https://github.com/jcagarcia).
 
 ## [1.0.0] - 2023-11-23
 

data/README.md

@@ -10,6 +10,7 @@ Implementation based on the Active Internet-Draft [draft-ietf-httpapi-idempotenc
 Topics covered in this README:
 
 - [Installation](#installation-)
+- [Compatibility](#compatibility-)
 - [Basic Usage](#basic-usage-)
 - [How it works](#how-it-works-)
   - [Making idempotency key header mandatory](#making-idempotency-key-header-mandatory-)
@@ -30,6 +31,20 @@ Ruby 2.6 or newer is required.
 gem install grape-idempotency
 ```
 
+## Compatibility 🤝
+
+- Ruby 2.6 or newer.
+- Grape 1.x and 2.x or newer are supported from a single codebase.
+- Grape 1.0 - 1.4 are allowed by the gemspec but are not tested.
+- Grape 1.x does not work with Rack 3, so if you are using Grape 1.x add `gem 'rack', '< 3'` to your `Gemfile`.
+- Grape 1.5 does not load with ActiveSupport 7.1.x (7.0 and 7.2+ work). On Ruby 2.7 / 3.0, where 7.1 is the newest installable ActiveSupport, add `gem 'activesupport', '< 7.1'` to your `Gemfile`.
+
+The tested Ruby and Grape combinations live in the [CI workflow](.github/workflows/ruby.yml): pushes and pull requests run the combinations where Ruby or Grape behaviour changes, and a weekly (or manually triggered) run tests every Grape minor line from 1.5 onwards against every Ruby version it supports, plus the latest Grape release on the newest Ruby. To run the specs against a specific Grape line locally, set `GRAPE_VERSION` (this rewrites your local `Gemfile.lock`, do not commit it):
+
+```shell
+GRAPE_VERSION="~> 1.8.0" bundle update grape && bundle exec rspec
+```
+
 ## Basic Usage 📖
 
 Configure the `Grape::Idempotency` class with a `Redis` instance.
@@ -368,4 +383,5 @@ Open issues on the GitHub issue tracker with clear information.
 ### Contributors
 
 * Juan Carlos García - Creator - https://github.com/jcagarcia
-* Carlos Cabanero - Contributor - https://github.com/Flip120
+* Carlos Cabanero - Contributor - https://github.com/Flip120
+* Salvador Revert Pedron - Contributor - https://github.com/salrepe

data/lib/grape/idempotency/middleware/error.rb

@@ -5,36 +5,56 @@ module Grape
     class Error < Base
       def run_rescue_handler(handler, error, endpoint=nil)
         if handler.instance_of?(Symbol)
-          raise NoMethodError, "undefined method '#{handler}'" unless respond_to?(handler)
+          # grape >= 3.0 resolves symbol handlers (`rescue_from ..., with: :helper`) on the endpoint
+          handler_owner = respond_to?(handler) || endpoint.nil? ? self : endpoint
+          raise NoMethodError, "undefined method '#{handler}'" unless handler_owner.respond_to?(handler)
 
-          handler = public_method(handler)
+          handler = handler_owner.public_method(handler)
         end
 
-        if endpoint
-          response = handler.arity.zero? ? endpoint.instance_exec(&handler) : endpoint.instance_exec(error, &handler)
-        else
-          response = handler.arity.zero? ? instance_exec(&handler) : instance_exec(error, &handler)
+        response = catch(:error) do
+          if endpoint
+            handler.arity.zero? ? endpoint.instance_exec(&handler) : endpoint.instance_exec(error, &handler)
+          else
+            handler.arity.zero? ? instance_exec(&handler) : instance_exec(error, &handler)
+          end
         end
 
+        response = error_response(response) if thrown_error?(response)
+
         if response.is_a?(Rack::Response)
           update_idempotency_error_with(error, response)
           response
         else
-          run_rescue_handler(:default_rescue_handler, Grape::Exceptions::InvalidResponse.new)
+          # default_rescue_handler is private since grape 2.1
+          response = run_rescue_handler(method(:default_rescue_handler), Grape::Exceptions::InvalidResponse.new, endpoint)
+          # Store it under the original error, the one the pending idempotent request was registered with
+          update_idempotency_error_with(error, response)
+          response
         end
       end
 
       private
 
+      def thrown_error?(response)
+        # grape >= 3.3 throws Grape::Exceptions::ErrorResponse instead of a Hash
+        return true if defined?(Grape::Exceptions::ErrorResponse) && response.is_a?(Grape::Exceptions::ErrorResponse)
+
+        response.is_a?(Hash) && response.key?(:message) && response.key?(:status) && response.key?(:headers)
+      end
+
       def update_idempotency_error_with(error, response)
+        stored_error_key = env && env[Grape::Idempotency::ERROR_KEY_ENV]
+        return unless stored_error_key
+
         begin
           body = JSON.parse(response.body.join)
         rescue JSON::ParserError
           body = response.body.join
         end
 
-        Grape::Idempotency.update_error_with_rescue_from_result(error, response.status, body)
+        Grape::Idempotency.update_error_with_rescue_from_result(error, response.status, body, error_key: stored_error_key)
       end
     end
   end
-end
+end

data/lib/grape/idempotency/version.rb

@@ -2,6 +2,6 @@
 
 module Grape
   module Idempotency
-    VERSION = '1.1.0'
+    VERSION = '1.1.1'
   end
 end

data/lib/grape/idempotency.rb

@@ -10,6 +10,8 @@ module Grape
     autoload :Helpers, 'grape/idempotency/helpers'
     Grape::Endpoint.send :include, Grape::Idempotency::Helpers
 
+    ERROR_KEY_ENV = "grape.idempotency.error_key".freeze
+
     class << self
       ORIGINAL_REQUEST_HEADER = "Original-Request".freeze
 
@@ -72,7 +74,7 @@ module Grape
 
         if is_an_error?(response)
           log(:debug, "An error response was returned by the performed block. => #{response}")
-          response = response[:message]
+          response = response.is_a?(Hash) ? response[:message] : response.message
         end
 
         grape.header(ORIGINAL_REQUEST_HEADER, original_request_id)
@@ -81,13 +83,14 @@ module Grape
         raise
       rescue => e
         log(:debug, "An unexpected error was raised when performing the block.")
-        if !stored_request && !response
+        if idempotency_key && !stored_request && !response
           validate_config!
           log(:debug, "Storing error response.")
           original_request_id = get_request_id(grape.request.headers)
           stored_key = store_error_request(idempotency_key, grape.request.path, grape.request.params, grape.status, original_request_id, e)
           if stored_key
             log(:debug, "Error response stored.")
+            grape.env[ERROR_KEY_ENV] = error_key(stored_key)
             grape.header(ORIGINAL_REQUEST_HEADER, original_request_id)
             grape.header(configuration.idempotency_key_header, stored_key)
           end
@@ -106,10 +109,10 @@ module Grape
         end
       end
 
-      def update_error_with_rescue_from_result(error, status, response)
+      def update_error_with_rescue_from_result(error, status, response, error_key: nil)
         validate_config!
 
-        stored_error = get_error_request_for(error)
+        stored_error = error_key ? get_error_request_by_key(error_key) : get_error_request_for(error)
         return unless stored_error
 
         request_with_unmanaged_error = stored_error[:request]
@@ -216,29 +219,49 @@ module Grape
         idempotency_key
       end
 
+      def get_error_request_by_key(error_key)
+        raw_request_with_error = storage.get(error_key)
+        return unless raw_request_with_error
+
+        {
+          error_key: error_key,
+          request: JSON.parse(raw_request_with_error),
+          idempotency_key: error_key.delete_prefix(error_key_prefix)
+        }
+      rescue Redis::BaseError, JSON::ParserError, TypeError => e
+        log(:error, "Error retrieving stored error request => #{e.message} - #{e}")
+        nil
+      end
+
       def get_error_request_for(error)
         error_keys = storage.keys("#{error_key_prefix}*")
         return if error_keys.empty?
 
         error_keys.map do |key|
-          request_with_error = JSON.parse(storage.get(key))
+          raw_request_with_error = storage.get(key)
+          next unless raw_request_with_error
+
+          request_with_error = JSON.parse(raw_request_with_error)
           error_class_name = request_with_error["error"]["class_name"]
           error_message = request_with_error["error"]["message"]
-          
+
           if error_class_name == error.class.to_s && error_message == error.message
             {
               error_key: key,
               request: request_with_error,
-              idempotency_key: key.gsub(error_key_prefix, '')
+              idempotency_key: key.delete_prefix(error_key_prefix)
             }
           end
-        end.first
-      rescue Redis::BaseError => e
-        log(:error, "Storage error => #{e.message} - #{e}")
+        end.compact.first
+      rescue Redis::BaseError, JSON::ParserError, TypeError => e
+        log(:error, "Error retrieving stored error request => #{e.message} - #{e}")
         nil
       end
 
       def is_an_error?(response)
+        # grape >= 3.3 throws Grape::Exceptions::ErrorResponse instead of a Hash
+        return true if defined?(Grape::Exceptions::ErrorResponse) && response.is_a?(Grape::Exceptions::ErrorResponse)
+
         response.is_a?(Hash) && response.has_key?(:message) && response.has_key?(:headers) && response.has_key?(:status)
       end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grape-idempotency
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.1
 platform: ruby
 authors:
 - Juan Carlos García
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-12-12 00:00:00.000000000 Z
+date: 2026-10-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: grape
@@ -118,7 +118,7 @@ homepage: https://github.com/jcagarcia/grape-idempotency
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -134,7 +134,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.4.10
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Gem for supporting idempotency in your Grape APIs
 test_files: []