idempotent-request 0.1.1 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7d7a529e3aef3790df0207b93cc2568d0796c36d01193a8309f24f815eb78a43
-  data.tar.gz: 6a70bedce0b0a3bd2456ed504cd2c1a266776ca50a5d7da1e89c441a92bb3a75
+  metadata.gz: cee83a3ed2329dd90ca0e12a8720c46225e90e2334a0a1d614cd911dbcfe02b4
+  data.tar.gz: 4d48b2dc61f9c7561788676d0cb9c3ada34edd1ff244f80e86c796236be7c819
 SHA512:
-  metadata.gz: b29abb27b091e57f83bb8f2cf241d0083653c3e4ce93138f486fd19448e64723419d78923fb662aaa21dec938b06f46cd76c353d444b59a134aa6b2919ec977c
-  data.tar.gz: 08b45d6a1db58c78274fe099eec5bd5af8f1549c543598b539d3004f97802c87763d8abd54e1bd8b003a75669426be4c2bd96844543e97a985a9fa7a90ec9c3f
+  metadata.gz: d0d61d258911181604c231b43e8711c09be4d74be10d7ed7d278fc28a438a1ec9f89a4a6e65cfdd0a0ae404f126058159ed55874bfcb71251514c1c27293ee01
+  data.tar.gz: 55308b0cf3a655fdb9f0c0d192e87f248ebfd2a966447df893000de29f5e5b6531816890f3b90a47c6087a09ffad0df58cb5ba04e07c3ba8262b068ecadf85d3

data/.travis.yml

@@ -1,7 +1,10 @@
 sudo: false
 language: ruby
 rvm:
-  - 2.4.2
+  - 2.4.10
+  - 2.5.8
+  - 2.6.6
+  - 2.7.1
 deploy:
   skip_cleanup: true
   provider: rubygems

data/CHANGELOG.md

@@ -1,5 +1,23 @@
 # Idempotent Request Changelog #
 
+## v0.1.5 ##
+
+* use ActiveSupport::Notifications to instrument events
+* fix an issue when getting an exception inside application would not delete lock, so client could receive 429 after 500
+
+## v0.1.4 ##
+
+* Fix an issue, when http response from backend != 200..226 caused lock to be taken
+
+## v0.1.3 ##
+
+* Fix an issue, when concurrent requests sent to an endpoint won't be protected by idempotency until the 1st request is finished
+
+## v0.1.2 ##
+
+* Fix rack response
+* Disuse SETNX (@espadrine)
+
 ## v0.1.1 ##
 
-*   Add caching for successful responses (@gomayonqui)
+* Add caching for successful responses (@gomayonqui)

data/README.md

@@ -84,6 +84,23 @@ module IdempotentRequest
 end
 ```
 
+
+### Use ActiveSupport::Notifications to read events
+
+```ruby
+# config/initializers/idempotent_request.rb
+ActiveSupport::Notifications.subscribe('idempotent.request') do |name, start, finish, request_id, payload|
+  notification = payload[:request].env['idempotent.request']
+  if notification['read']
+    Rails.logger.info "IdempotentRequest: Hit cached response from key #{notification['key']}, response: #{notification['read']}"
+  elsif notification['write']
+    Rails.logger.info "IdempotentRequest: Write: key #{notification['key']}, status: #{notification['write'][0]}, headers: #{notification['write'][1]}, unlocked? #{notification['unlocked']}"
+  elsif notification['concurrent_request_response']
+    Rails.logger.warn "IdempotentRequest: Concurrent request detected with key #{notification['key']}"
+  end
+end
+```
+
 ## Custom options
 
 ```ruby
@@ -92,7 +109,8 @@ config.middleware.use IdempotentRequest::Middleware,
   header_key: 'X-Qonto-Idempotency-Key', # by default Idempotency-key
   policy: IdempotentRequest::Policy,
   callback: IdempotentRequest::RailsCallback,
-  storage: IdempotentRequest::RedisStorage.new(::Redis.current, expire_time: 1.day, namespace: 'idempotency_keys')
+  storage: IdempotentRequest::RedisStorage.new(::Redis.current, expire_time: 1.day, namespace: 'idempotency_keys'),
+  conflict_response_status: 409
 ```
 
 ### Policy
@@ -117,7 +135,7 @@ end
 
 ### Callback
 
-Get notified when the client sends a request with the same idempotency key:
+Get notified when a client sends a request with the same idempotency key:
 
 ```ruby
 class RailsCallback
@@ -133,6 +151,10 @@ class RailsCallback
 end
 ```
 
+### Conflict response status
+
+Define http status code that should be returned when a client sends concurrent requests with the same idempotency key.
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/idempotent-request. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.

data/idempotent-request.gemspec

@@ -23,9 +23,9 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'rack', '~> 2.0'
   spec.add_dependency 'oj', '~> 3.0'
 
-  spec.add_development_dependency 'bundler', '~> 1.15'
-  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake', '>= 12.3.3'
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'fakeredis', '~> 0.6'
-  spec.add_development_dependency 'pry', '~> 0.11'
+  spec.add_development_dependency 'byebug', '~> 10.0'
 end

data/lib/idempotent-request/middleware.rb

@@ -4,6 +4,8 @@ module IdempotentRequest
       @app = app
       @config = config
       @policy = config.fetch(:policy)
+      @notifier = ActiveSupport::Notifications if defined?(ActiveSupport::Notifications)
+      @conflict_response_status = config.fetch(:conflict_response_status, 429)
     end
 
     def call(env)
@@ -13,14 +15,45 @@ module IdempotentRequest
 
     def process(env)
       set_request(env)
+      request.env['idempotent.request'] = {}
       return app.call(request.env) unless process?
-      storage = RequestManager.new(request, config)
-      storage.read || storage.write(*app.call(request.env))
+      request.env['idempotent.request']['key'] = request.key
+      response = read_idempotent_request || write_idempotent_request || concurrent_request_response
+      instrument(request)
+      response
     end
 
     private
 
-    attr_reader :app, :env, :config, :request, :policy
+    def storage
+      @storage ||= RequestManager.new(request, config)
+    end
+
+    def read_idempotent_request
+      request.env['idempotent.request']['read'] = storage.read
+    end
+
+    def write_idempotent_request
+      return unless storage.lock
+      begin
+        result = app.call(request.env)
+        request.env['idempotent.request']['write'] = result
+        storage.write(*result)
+      ensure
+        request.env['idempotent.request']['unlocked'] = storage.unlock
+        result
+      end
+    end
+
+    def concurrent_request_response
+      status = @conflict_response_status
+      headers = { 'Content-Type' => 'application/json' }
+      body = [ Oj.dump('error' => 'Concurrent requests detected') ]
+      request.env['idempotent.request']['concurrent_request_response'] = true
+      Rack::Response.new(body, status, headers).finish
+    end
+
+    attr_reader :app, :env, :config, :request, :policy, :notifier
 
     def process?
       !request.key.to_s.empty? && should_be_idempotent?
@@ -31,6 +64,10 @@ module IdempotentRequest
       policy.new(request).should?
     end
 
+    def instrument(request)
+      notifier.instrument('idempotent.request', request: request) if notifier
+    end
+
     def set_request(env)
       @env = env
       @request ||= Request.new(env, config)

data/lib/idempotent-request/redis_storage.rb

@@ -8,19 +8,41 @@ module IdempotentRequest
       @expire_time = config[:expire_time]
     end
 
+    def lock(key)
+      setnx_with_expiration(lock_key(key), Time.now.to_f)
+    end
+
+    def unlock(key)
+      redis.del(lock_key(key))
+    end
+
     def read(key)
       redis.get(namespaced_key(key))
     end
 
     def write(key, payload)
-      redis.setnx(namespaced_key(key), payload)
-      redis.expire(namespaced_key(key), expire_time.to_i) if expire_time.to_i > 0
+      setnx_with_expiration(namespaced_key(key), payload)
     end
 
     private
 
-    def namespaced_key(idempotency_key)
-      [namespace, idempotency_key.strip]
+    def setnx_with_expiration(key, data)
+      redis.set(
+        key,
+        data,
+        {}.tap do |options|
+          options[:nx] = true
+          options[:ex] = expire_time.to_i if expire_time.to_i > 0
+        end
+      )
+    end
+
+    def lock_key(key)
+      namespaced_key("lock:#{key}")
+    end
+
+    def namespaced_key(key)
+      [namespace, key.strip]
         .compact
         .join(':')
         .downcase

data/lib/idempotent-request/request.rb

@@ -22,10 +22,9 @@ module IdempotentRequest
     private
 
     def header_name
-      key = @header_name
-        .to_s
-        .upcase
-        .gsub('-', '_')
+      key = @header_name.to_s
+                        .upcase
+                        .tr('-', '_')
 
       key.start_with?('HTTP_') ? key : "HTTP_#{key}"
     end

data/lib/idempotent-request/request_manager.rb

@@ -8,6 +8,14 @@ module IdempotentRequest
       @callback = config[:callback]
     end
 
+    def lock
+      storage.lock(key)
+    end
+
+    def unlock
+      storage.unlock(key)
+    end
+
     def read
       status, headers, response = parse_data(storage.read(key)).values
 
@@ -19,8 +27,11 @@ module IdempotentRequest
     def write(*data)
       status, headers, response = data
       response = response.body if response.respond_to?(:body)
-      return data unless (200..226).include?(status)
-      storage.write(key, payload(status, headers, response))
+
+      if (200..226).cover?(status)
+        storage.write(key, payload(status, headers, response))
+      end
+
       data
     end
 
@@ -33,17 +44,15 @@ module IdempotentRequest
     end
 
     def payload(status, headers, response)
-      Oj.dump({
-        status: status,
-        headers: headers.to_h,
-        response: response
-      })
+      Oj.dump(status: status,
+              headers: headers.to_h,
+              response: Array(response))
     end
 
-    def run_callback(action, args)
+    def run_callback(action, **args)
       return unless @callback
 
-      @callback.new(request).send(action, args)
+      @callback.new(request).send(action, **args)
     end
 
     def key

data/lib/version.rb

@@ -1,3 +1,3 @@
 module IdempotentRequest
-  VERSION = "0.1.1"
+  VERSION = "0.1.6"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: idempotent-request
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.6
 platform: ruby
 authors:
 - Dmytro Zakharov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-02-19 00:00:00.000000000 Z
+date: 2020-11-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -42,30 +42,30 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.15'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.15'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -95,19 +95,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0.6'
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.11'
+        version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.11'
+        version: '10.0'
 description: 
 email:
 - dmytro@qonto.eu
@@ -152,8 +152,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.8
 signing_key: 
 specification_version: 4
 summary: Rack middleware ensuring at most once requests for mutating endpoints.