grape-idempotency 0.1.1 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3141f3c611358f6110a6176beea8857d316b4f2ba859b630385f3287ba68811f
-  data.tar.gz: c367aa96495a47ac03243a31c79b0de163ccd2411cdcc7a673663b310083bfe5
+  metadata.gz: 7f9a4d3d3a6e885bfa07afd8f0d51dfbfe930853d3919934016e9173f9d418a0
+  data.tar.gz: 81e8817b09d72d35bb71746a3451e66aed12af38888b169abc0297bb2c3f7481
 SHA512:
-  metadata.gz: c42121192159af6be351e82e2da316b549d1a7be17203ec146af5809dcc10df4ca058728b78de916913aaa02d8689317a69f3c365fa67ddd83cc06ebab5c7f29
-  data.tar.gz: 305b32f988ecac6a209019fffd42a95b34be5f938d9eff4c749e74acc48c95ad51c8c1439b26d80fd0938d7b6854f82fe53e29d43f283b40f29d83d8c41e51ff
+  metadata.gz: 20a9654e3b1086a7dfa77379129f7bc46d18df4eadfa85ee13e7027dd91ffc6f68b83843f0d41212695287b472ebcb6e7c9b68ac322bb46f8ddadbdb9294a6ad
+  data.tar.gz: 60fc291bbc9558e19b2816614f0584812e08b6846b17b68af7395d15665439cad756034ff4f64d59592f56626d4fa0d5381f8dbcfc91b91294e5d223c8d4a8da

data/CHANGELOG.md

@@ -4,6 +4,19 @@ 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).
 
+## [0.1.3] - 2023-01-07
+
+### Fix
+
+- Second calls were returning `null` when the first response was generated inside a `rescue_from`.
+- Conflict response had invalid format.
+
+## [0.1.2] - 2023-01-06
+
+### Fix
+
+- Return correct original response when the endpoint returns a hash in the body
+
 ## [0.1.1] - 2023-01-06
 
 ### Fix

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

@@ -0,0 +1,36 @@
+require 'grape/middleware/base'
+
+module Grape
+  module Middleware
+    class Error < Base
+      def run_rescue_handler(handler, error)
+        if handler.instance_of?(Symbol)
+          raise NoMethodError, "undefined method '#{handler}'" unless respond_to?(handler)
+
+          handler = public_method(handler)
+        end
+
+        response = handler.arity.zero? ? instance_exec(&handler) : instance_exec(error, &handler)
+
+        if response.is_a?(Rack::Response)
+          update_idempotency_error_with(error, response)
+          response
+        else
+          run_rescue_handler(:default_rescue_handler, Grape::Exceptions::InvalidResponse.new)
+        end
+      end
+
+      private
+
+      def update_idempotency_error_with(error, response)
+        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)
+      end
+    end
+  end
+end

data/lib/grape/idempotency/version.rb

@@ -2,6 +2,6 @@
 
 module Grape
   module Idempotency
-    VERSION = '0.1.1'
+    VERSION = '0.1.3'
   end
 end

data/lib/grape/idempotency.rb

@@ -1,6 +1,7 @@
 require 'grape'
 require 'securerandom'
 require 'grape/idempotency/version'
+require 'grape/idempotency/middleware/error'
 
 module Grape
   module Idempotency
@@ -29,7 +30,7 @@ module Grape
         cached_request = get_from_cache(idempotency_key)
         if cached_request && (cached_request["params"] != grape.request.params || cached_request["path"] != grape.request.path)
           grape.status 409
-          return configuration.conflict_error_response.to_json
+          return configuration.conflict_error_response
         elsif cached_request
           grape.status cached_request["status"]
           grape.header(ORIGINAL_REQUEST_HEADER, cached_request["original_request"])
@@ -41,21 +42,44 @@ module Grape
           block.call
         end
 
-        if response.is_a?(Hash)
-          response = response[:message].to_json
-        end
+        response = response[:message] if is_an_error?(response)
 
         original_request_id = get_request_id(grape.request.headers)
         grape.header(ORIGINAL_REQUEST_HEADER, original_request_id)
-        response
+        grape.body response
+      rescue => e
+        if !cached_request && !response
+          validate_config!
+          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)
+          grape.header(ORIGINAL_REQUEST_HEADER, original_request_id)
+          grape.header(configuration.idempotency_key_header, stored_key)
+        end
+        raise
       ensure
-        validate_config!
-        unless cached_request
-          stored_key = store_in_cache(idempotency_key, grape.request.path, grape.request.params, grape.status, original_request_id, response)
+        if !cached_request && response
+          validate_config!
+          stored_key = store_request(idempotency_key, grape.request.path, grape.request.params, grape.status, original_request_id, response)
           grape.header(configuration.idempotency_key_header, stored_key)
         end
       end
 
+      def update_error_with_rescue_from_result(error, status, response)
+        validate_config!
+
+        stored_error = get_error_request_for(error)
+        return unless stored_error
+
+        request_with_unmanaged_error = stored_error[:request]
+        idempotency_key = stored_error[:idempotency_key]
+        path = request_with_unmanaged_error["path"]
+        params = request_with_unmanaged_error["params"]
+        original_request_id = request_with_unmanaged_error["original_request"]
+
+        store_request(idempotency_key, path, params, status, original_request_id, response)
+        storage.del(stored_error[:error_key])
+      end
+
       private
 
       def validate_config!
@@ -89,7 +113,7 @@ module Grape
         JSON.parse(value)
       end
 
-      def store_in_cache(idempotency_key, path, params, status, request_id, response)
+      def store_request(idempotency_key, path, params, status, request_id, response)
         body = {
           path: path,
           params: params,
@@ -101,14 +125,70 @@ module Grape
         result = storage.set(key(idempotency_key), body, ex: configuration.expires_in, nx: true)
 
         if !result
-          return store_in_cache(random_idempotency_key, path, params, status, request_id, response)
+          return store_request(random_idempotency_key, path, params, status, request_id, response)
+        else
+          return idempotency_key
+        end
+      end
+
+      def store_error_request(idempotency_key, path, params, status, request_id, error)
+        body = {
+          path: path,
+          params: params,
+          status: status,
+          original_request: request_id,
+          error: {
+            class_name: error.class.to_s,
+            message: error.message
+          }
+        }.to_json
+
+        result = storage.set(error_key(idempotency_key), body, ex: 30, nx: true)
+
+        if !result
+          return store_error_request(random_idempotency_key, path, params, status, request_id, error)
         else
           return idempotency_key
         end
       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))
+          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, '')
+            }
+          end
+        end.first
+      end
+
+      def is_an_error?(response)
+        response.is_a?(Hash) && response.has_key?(:message) && response.has_key?(:headers) && response.has_key?(:status)
+      end
+
       def key(idempotency_key)
-        "grape:idempotency:#{idempotency_key}"
+        "#{gem_prefix}#{idempotency_key}"
+      end
+
+      def error_key(idempotency_key)
+        "#{error_key_prefix}#{idempotency_key}"
+      end
+
+      def error_key_prefix
+        "#{gem_prefix}error:"
+      end
+
+      def gem_prefix
+        "grape:idempotency:"
       end
 
       def random_idempotency_key

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grape-idempotency
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.3
 platform: ruby
 authors:
 - Juan Carlos García
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-11-06 00:00:00.000000000 Z
+date: 2023-11-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: grape
@@ -98,6 +98,7 @@ files:
 - lib/grape-idempotency.rb
 - lib/grape/idempotency.rb
 - lib/grape/idempotency/helpers.rb
+- lib/grape/idempotency/middleware/error.rb
 - lib/grape/idempotency/version.rb
 homepage: https://github.com/jcagarcia/grape-idempotency
 licenses: