request_id 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: a15cb25ed02ec17242c57798948853b77d0b097c
-  data.tar.gz: eed296879d558c00b33e507aa195482f29203dc8
+!binary "U0hBMQ==":
+  metadata.gz: 9011e2b94dae6364b5af80b30e652d960a89132f
+  data.tar.gz: 86957882e9a04e2b1318b54bf7f0739244930767
 SHA512:
-  metadata.gz: fe2d085fbe00596365443abcb878130ebcef0c7d367f3207e2e178ea32be493d3a339f217587fb3d08dd7eb9eabac7eade5ebc7d7261244743de58052202f610
-  data.tar.gz: 7f3543a463295b69d9767ac3b10b6f4a9573f843663a1ca68b0edf8276d21a8ac261871e328550747c81ec53f1565ee1536c6326e26e2a225744c8483e364d9d
+  metadata.gz: bc0867cb3c43d4760c8f79b9232e232113f73ff3b85c7f19159c447326f56515e321d530540f51a6362db82cb1778c4009a8e89f84f2d6142f587c8f8df30587
+  data.tar.gz: 16adfdda7b0c62c0888e0b39d00f4210c74510f86dc09bce3ff6329f5f6fa238a248dae46ddfae853bd2d79e7f18b759a08d089b5fa8c95d449796a0acbecbfb

data/README.md

@@ -3,11 +3,12 @@
 This is a gem with a collection of middleware for easily cascading [Heroku request id's](https://devcenter.heroku.com/articles/http-request-id)
 Throughout the system. It includes:
 
-* Rack middleware, which adds the request\_id to `Thread.current[:request\_id]`
+* Rack middleware, which adds the request\_id to `Thread.current[:request_id]`.
 * Sidekiq Client middleware, which adds the request\_id to the message
   payload.
 * Sidekiq Server middleware, which adds the request\_id to
   `Thread.current[:request_id]` from the request\_id in the message payload.
+* Faraday middleware, which adds the request\_id as a response header `X-Request-Id`.
 
 ## Installation
 
@@ -46,12 +47,53 @@ Sidekiq.configure_server do |config|
   end
 
   config.server_middleware do |chain|
-    chain.remove Sidekiq::Middleware::Server::Logging
     chain.add Sidekiq::Middleware::Client::RequestId
   end
 end
 ```
 
+### If you're using Faraday
+
+Add the middleware.
+
+```ruby
+  builder.use Faraday::RequestId
+
+```
+
+### Customization
+
+You can customize each middleware to store the value of any header you like in the same fashion. For instance,
+if you wanted to track a `X-Request-Id` header as well as a `X-Session-Id` header, you could do so like this:
+
+```ruby
+# Rack
+use Rack::RequestId
+use Rack::RequestId, key: :request_id, value: -> (env) { env['HTTP_X_SESSION_ID'], response_header: 'X-Session-Id' }
+
+# Sidekiq
+Sidekiq.configure_client do |config|
+  config.client_middleware do |chain|
+    chain.add Sidekiq::Middleware::Client::RequestId
+    chain.add Sidekiq::Middleware::Client::RequestId, key: :session_id, value: -> { ::RequestId.get(:session_id) }
+  end
+end
+
+Sidekiq.configure_server do |config|
+  config.client_middleware do |chain|
+    chain.add Sidekiq::Middleware::Client::RequestId
+    chain.add Sidekiq::Middleware::Client::RequestId, key: :session_id, value: -> { ::RequestId.get(:session_id) }
+  end
+
+  config.server_middleware do |chain|
+    chain.add Sidekiq::Middleware::Client::RequestId, key: :session_id, value: lambda { |item| item['session_id'] }
+  end
+end
+
+# Faraday
+builder.use Faraday::RequestId, key: :session_id, header: 'X-Session-Id'
+```
+
 ## Contributing
 
 1. Fork it

data/lib/faraday/request_id.rb

@@ -5,6 +5,11 @@ module Faraday
   class RequestId < Faraday::Middleware
     HEADER = 'X-Request-Id'.freeze
 
+    def initialize(app, options = nil)
+      super(app)
+      @options = options || default_options
+    end
+
     def call(env)
       set_header(env) if needs_header?(env)
       @app.call(env)
@@ -13,15 +18,15 @@ module Faraday
   private
 
     def needs_header?(env)
-      request_id && !env[:request_headers][HEADER]
+      ::RequestId.get(@options[:key]) && !env[:request_headers][@options[:header]]
     end
 
     def set_header(env)
-      env[:request_headers][HEADER] = request_id
+      env[:request_headers][@options[:header]] = ::RequestId.get(@options[:key])
     end
 
-    def request_id
-      ::RequestId.request_id
+    def default_options
+      { key: :request_id, header: HEADER }
     end
   end
 end

data/lib/rack/request_id.rb

@@ -2,7 +2,7 @@ require 'securerandom'
 
 module Rack
 
-  # Public: Rack middleware that stores the Heroku-Request-Id header in a
+  # Public: Rack middleware that stores the X-Request-Id header in a
   # thread local variable.
   #
   # Heroku has a labs feature called request_id, which can be used to tracking
@@ -12,39 +12,35 @@ module Rack
   #
   # Examples
   #
-  #   use Rack::LogRequestId
+  #   use Rack::RequestId, key: :request_id, value: -> (env) { env['HTTP_X_REQUEST_ID'] }, response_header: 'X-Request-Id'
   #
-  #   logger.info "request_id=#{Thread.current[:request_id]} Hello world"
+  #   logger.info "request_id=#{RequestId.request_id} Hello world"
   #   # => request_id=a08a6712229fb991c0e5026c246862c7 Hello world
   class RequestId
     REQUEST_HEADER  = 'HTTP_X_REQUEST_ID'.freeze
     RESPONSE_HEADER = 'X-Request-Id'.freeze
 
-    def initialize(app, options = {})
+    def initialize(app, options = nil)
       @app = app
+      @options = options || default_options
     end
 
     def call(env)
-      ::RequestId.with_request_id(request_id(env)) do
+      ::RequestId.with(@options[:key], @options[:value].call(env)) do
         status, headers, body = @app.call(env)
-        headers[RESPONSE_HEADER] ||= ::RequestId.request_id
+
+        if @options[:response_header]
+          headers[@options[:response_header]] ||= ::RequestId.get(@options[:key])
+        end
+
         [status, headers, body]
       end
     end
 
   private
 
-    def request_id(env)
-      env[REQUEST_HEADER] || generate
-    end
-
-    def generate
-      generate? && SecureRandom.hex(16)
+    def default_options
+      { key: :request_id, value: lambda { |env| env[REQUEST_HEADER] }, response_header: RESPONSE_HEADER }
     end
-
-    def generate?
-      ::RequestId.configuration.generate
-    end
-
   end
 end

data/lib/request_id.rb

@@ -20,7 +20,7 @@ module RequestId
     #
     # Returns the String request id.
     def request_id
-      Thread.current[:request_id]
+      get(:request_id)
     end
 
     # Internal: Set the current request_id.
@@ -32,7 +32,7 @@ module RequestId
     #
     # Returns the new String request id.
     def request_id=(request_id)
-      Thread.current[:request_id] = request_id
+      set(:request_id, request_id)
     end
 
     # Public: Runs the block with the given request id set.
@@ -49,12 +49,28 @@ module RequestId
     #
     #   RequestId.request_id
     #   # => "9fee77ec37b483983839fe7a753b64d9"
-    def with_request_id(request_id)
-      last_request_id = RequestId.request_id
-      RequestId.request_id = request_id
+    def with_request_id(request_id, &block)
+      with(:request_id, request_id, &block)
+    end
+
+    # Public: Runs the block with the given id key and value set.
+    def with(id_key, id_value)
+      last_id = RequestId.get(id_key)
+      RequestId.set(id_key, id_value)
       yield
     ensure
-      RequestId.request_id = last_request_id
+      RequestId.set(id_key, last_id)
+    end
+
+    # Public: Retrieve the given id, which is generally set by the
+    # Rack or Sidekiq middleware.
+    def get(id_key)
+      Thread.current[id_key]
+    end
+
+    # Public: Set the given id to the given value
+    def set(id_key, id_value)
+      Thread.current[id_key] = id_value
     end
 
     def configuration

data/lib/request_id/version.rb

@@ -1,3 +1,3 @@
 module RequestId
-  VERSION = '0.3.0'
+  VERSION = '0.4.0'
 end

data/lib/sidekiq/middleware/client/request_id.rb

@@ -2,15 +2,27 @@ module Sidekiq
   module Middleware
     module Client
       class RequestId
+        def initialize(options = nil)
+          @options = options || default_options
+        end
+
         def call(worker, item, queue)
-          item['request_id'] = request_id if request_id
+          item[id_key] = id_value if id_value
           yield
         end
 
       private
 
-        def request_id
-          ::RequestId.request_id
+        def id_key
+          @options[:key].to_s
+        end
+
+        def id_value
+          @options[:value].call()
+        end
+
+        def default_options
+          { key: :request_id, value: lambda { ::RequestId.request_id } }
         end
       end
     end

data/lib/sidekiq/middleware/server/request_id.rb

@@ -12,12 +12,22 @@ module Sidekiq
           attr_accessor :no_reset
         end
 
+        def initialize(options = nil)
+          @options = options || default_options
+        end
+
         def call(worker, item, queue)
-          ::RequestId.request_id = item['request_id']
+          ::RequestId.set(@options[:key], @options[:value].call(item))
           yield
         ensure
-          ::RequestId.request_id = nil unless self.class.no_reset
+          ::RequestId.set(@options[:key], nil) unless self.class.no_reset
         end
+
+        private
+
+          def default_options
+            { key: :request_id, value: lambda { |item| item['request_id'] } }
+          end
       end
     end
   end

data/spec/faraday/request_id_spec.rb

@@ -8,7 +8,7 @@ describe Faraday::RequestId do
   describe '.call' do
     context 'when a request_id is set' do
       before do
-        RequestId.stub(request_id: SecureRandom.hex)
+        RequestId.stub(get: SecureRandom.hex)
       end
 
       it 'adds the X-Request-Id header' do
@@ -20,7 +20,7 @@ describe Faraday::RequestId do
 
     context 'when no request_id is set' do
       before do
-        RequestId.stub(request_id: nil)
+        RequestId.stub(get: nil)
       end
 
       it 'does not add the X-Request-Id header' do

data/spec/rack/request_id_spec.rb

@@ -3,7 +3,8 @@ require 'securerandom'
 
 describe Rack::RequestId do
   let(:app) { double('app', call: [200, {}, ['Body']]) }
-  let(:middleware) { described_class.new app }
+  let(:config) { { key: :request_id, value: lambda { |env| env['HTTP_X_REQUEST_ID'] }, response_header: 'X-Request-Id' } }
+  let(:middleware) { described_class.new app, config }
 
   describe '.call' do
     let(:request_id) { SecureRandom.hex }
@@ -29,4 +30,31 @@ describe Rack::RequestId do
       end
     end
   end
+
+  describe 'custom middleware configuration' do
+    let(:config) { { key: :session_id, value: lambda { |env| env['HTTP_X_SESSION_ID'] }, response_header: 'X-Session-Id' } }
+    let(:session_id) { SecureRandom.hex }
+
+    it 'stores the custom id in a thread local' do
+      Thread.current.should_receive(:[]=).with(:session_id, session_id)
+      app.should_receive(:call)
+      Thread.current.should_receive(:[]=).with(:session_id, nil)
+      middleware.call('HTTP_X_SESSION_ID' => session_id)
+    end
+
+    it 'sets the X-Session-Id header in the response' do
+      status, headers, body = middleware.call('HTTP_X_SESSION_ID' => session_id)
+      expect(headers['X-Session-Id']).to eq session_id
+    end
+
+    context 'when an exception is raised' do
+      it 'still sets the session_id back to nil' do
+        Thread.current.should_receive(:[]=).with(:session_id, session_id)
+        app.should_receive(:call).and_raise
+        Thread.current.should_receive(:[]=).with(:session_id, nil)
+        expect { middleware.call('HTTP_X_SESSION_ID' => session_id) }.to raise_error
+      end
+    end
+
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: request_id
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Eric J. Holmes
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-12 00:00:00.000000000 Z
+date: 2014-11-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -28,42 +28,42 @@ dependencies:
   name: rake
   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'
 - !ruby/object:Gem::Dependency
   name: rspec
   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'
 - !ruby/object:Gem::Dependency
   name: faraday
   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: Classes for tracking request id
@@ -107,17 +107,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.14
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Classes for tracking request id