request_id 0.1.0

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1 @@
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+script: bundle exec rake

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in requestid.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Eric J. Holmes
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,62 @@
+# RequestId
+
+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]`
+* 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.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'request_id', github: 'remind101/request_id'
+```
+
+## Usage
+
+Add the rack middleware:
+
+```ruby
+use Rack::RequestId
+```
+
+
+### If you're using Sidekiq
+
+Add the client middleware.
+
+```ruby
+Sidekiq.configure_client do |config|
+  config.client_middleware do |chain|
+    chain.add Sidekiq::Middleware::Client::RequestId
+  end
+end
+```
+
+Add the server middleware.
+
+```ruby
+Sidekiq.configure_server do |config|
+  config.client_middleware do |chain|
+    chain.add Sidekiq::Middleware::Client::RequestId
+  end
+
+  config.server_middleware do |chain|
+    chain.remove Sidekiq::Middleware::Server::Logging
+    chain.add Sidekiq::Middleware::Client::RequestId
+  end
+end
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,10 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+
+task :default => [:spec]
+
+require 'rspec/core/rake_task'
+desc "Run specs"
+RSpec::Core::RakeTask.new do |t|
+  t.pattern = 'spec/**/*_spec.rb'
+end

data/lib/rack/request_id.rb

@@ -0,0 +1,31 @@
+module Rack
+
+  # Public: Rack middleware that stores the Heroku-Request-Id header in a
+  # thread local variable.
+  #
+  # Heroku has a labs feature called request_id, which can be used to tracking
+  # a request through the system.
+  #
+  # app - The Rack app.
+  #
+  # Examples
+  #
+  #   use Rack::LogRequestId
+  #
+  #   logger.info "request_id=#{Thread.current[:request_id]} Hello world"
+  #   # => request_id=a08a6712229fb991c0e5026c246862c7 Hello world
+  class RequestId
+    REQUEST_ID_HEADER = 'HTTP_HEROKU_REQUEST_ID'.freeze
+
+    def initialize(app, options = {})
+      @app = app
+    end
+
+    def call(env)
+      ::RequestId.request_id = env[REQUEST_ID_HEADER]
+      @app.call(env)
+    ensure
+      ::RequestId.request_id = nil
+    end
+  end
+end

data/lib/request_id.rb

@@ -0,0 +1,48 @@
+require 'request_id/version'
+
+module RequestId
+  class << self
+
+    # Public: Retrieve the current request_id, which is generally set by the
+    # Rack or Sidekiq middleware.
+    #
+    # Examples
+    #
+    #   RequestId.request_id
+    #   # => "0b482498be0d6084d2b634cd6523418d"
+    #
+    # Returns the String request id.
+    def request_id
+      Thread.current[:request_id]
+    end
+
+    # Internal: Set the current request_id.
+    #
+    # Examples
+    #
+    #   RequestId.request_id = SecureRandom.hex
+    #   # => "2297456c027c536d0eb3eb86583fe5a9"
+    #
+    # Returns the new String request id.
+    def request_id=(request_id)
+      Thread.current[:request_id] = request_id
+    end
+
+  end
+end
+
+module Rack
+  autoload :RequestId, 'rack/request_id'
+end
+
+module Sidekiq
+  module Middleware
+    module Client
+      autoload :RequestId, 'sidekiq/middleware/client/request_id'
+    end
+
+    module Server
+      autoload :RequestId, 'sidekiq/middleware/server/request_id'
+    end
+  end
+end

data/lib/request_id/version.rb

@@ -0,0 +1,3 @@
+module RequestId
+  VERSION = '0.1.0'
+end

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

@@ -0,0 +1,34 @@
+module Sidekiq
+  module Middleware
+    module Client
+      class RequestId
+
+        def call(worker, item, queue)
+          item['request_id'] = request_id if request_id
+          log(request_id, worker, item['args'].inspect) if log_request_id?(worker)
+          yield
+        end
+
+      private
+
+        def log(request_id, worker, args)
+          logger.info "request_id=#{request_id} at=enqueue worker=#{worker.to_s} args=#{args}"
+        end
+
+        def log_request_id?(worker)
+          worker.respond_to?(:get_sidekiq_options) && worker.get_sidekiq_options['log_request_id']
+        end
+
+        def logger
+          Sidekiq.logger
+        end
+
+        def request_id
+          ::RequestId.request_id
+        end
+
+      end
+    end
+  end
+end
+

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

@@ -0,0 +1,26 @@
+module Sidekiq
+  module Middleware
+    module Server
+      class RequestId < Logging
+
+        def call(worker, item, queue)
+          request_id = ::RequestId.request_id = item['request_id']
+          Sidekiq::Logging.with_context("request_id=#{request_id} worker=#{worker.class.to_s} jid=#{item['jid']} args=#{item['args'].inspect}") do
+            begin
+              start = Time.now
+              logger.info { "at=start" }
+              yield
+              logger.info { "at=done duration=#{elapsed(start)}sec" }
+            rescue Exception
+              logger.info { "at=fail duration=#{elapsed(start)}sec" }
+              raise
+            end
+          end
+        ensure
+          ::RequestId.request_id = nil
+        end
+
+      end
+    end
+  end
+end

data/request_id.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'request_id/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'request_id'
+  spec.version       = RequestId::VERSION
+  spec.authors       = ['Eric J. Holmes']
+  spec.email         = ['eric@ejholmes.net']
+  spec.description   = %q{Classes for tracking request id}
+  spec.summary       = %q{Classes for tracking request id}
+  spec.homepage      = 'https://github.com/remind101/request_id'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+end

data/spec/rack/request_id_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+require 'securerandom'
+
+describe Rack::RequestId do
+  let(:app) { double('app', call: nil) }
+  let(:middleware) { described_class.new app }
+
+  describe '.call' do
+    let(:request_id) { SecureRandom.hex }
+
+    it 'stores the request_id in a thread local' do
+      Thread.current.should_receive(:[]=).with(:request_id, request_id)
+      app.should_receive(:call)
+      Thread.current.should_receive(:[]=).with(:request_id, nil)
+      middleware.call('HTTP_HEROKU_REQUEST_ID' => request_id)
+    end
+
+    context 'when an exception is raised' do
+      it 'still sets the request_id back to nil' do
+        Thread.current.should_receive(:[]=).with(:request_id, request_id)
+        app.should_receive(:call).and_raise
+        Thread.current.should_receive(:[]=).with(:request_id, nil)
+        expect { middleware.call('HTTP_HEROKU_REQUEST_ID' => request_id) }.to raise_error
+      end
+    end
+  end
+end

data/spec/sidekiq/middleware/client/request_id_spec.rb

@@ -0,0 +1,49 @@
+require 'spec_helper'
+require 'securerandom'
+
+describe Sidekiq::Middleware::Client::RequestId do
+  let(:middleware) { described_class.new }
+
+  describe '#call' do
+    context 'when the worker is an object that responds to `get_sidekiq_options`' do
+      let(:worker) { double('worker', to_s: 'Worker') }
+
+      context 'when the worker is configured to log request ids' do
+        let(:logger) { double('Logger', info: nil) }
+
+        before { worker.stub get_sidekiq_options: { 'log_request_id' => true } }
+        before { Sidekiq.stub logger: logger }
+
+        it 'adds the request id to the item' do
+          request_id = Thread.current[:request_id] = SecureRandom.hex
+          item = {}
+          expect { middleware.call(worker, item, nil) { } }.to change { item }.from({}).to('request_id' => request_id)
+        end
+
+        it 'logs the request id' do
+          request_id = Thread.current[:request_id] = SecureRandom.hex
+          logger.should_receive(:info).with(
+            "request_id=#{request_id} at=enqueue worker=Worker args=[\"foo\"]"
+          )
+          expect { |b| middleware.call(worker, { 'args' => ['foo'] }, nil, &b) }.to yield_control
+        end
+      end
+
+      context 'when the worker is not configured to log request ids' do
+        before { worker.stub get_sidekiq_options: {} }
+
+        it 'does not log the request' do
+          expect { |b| middleware.call(worker, {}, nil, &b) }.to yield_control
+        end
+      end
+    end
+
+    context 'when the worker is an object that does not respond to `get_sidekiq_options`' do
+      let(:worker) { 'Worker' }
+
+      it 'does not log the request' do
+        expect { |b| middleware.call(worker, {}, nil, &b) }.to yield_control
+      end
+    end
+  end
+end

data/spec/sidekiq/middleware/server/request_id_spec.rb

@@ -0,0 +1,47 @@
+require 'spec_helper'
+require 'securerandom'
+
+describe Sidekiq::Middleware::Server::RequestId do
+  let(:logger) { double('Logger', info: nil) }
+  let(:middleware) { described_class.new }
+
+  before { Sidekiq.stub logger: logger }
+
+  describe '#call' do
+    let(:worker) { double('worker') }
+
+    before { worker.stub_chain :class, to_s: 'Worker' }
+
+    context 'when the worker is configured to log request ids' do
+      let(:request_id) { SecureRandom.hex }
+      let(:job_id) { SecureRandom.hex }
+      let(:item) { { 'jid' => job_id, 'args' => ['foo'], 'log_request_id' => true, 'request_id' => request_id } }
+
+      it 'sets a thread local to the request id' do
+        Thread.current.should_receive(:[]=).with(:request_id, request_id)
+        Thread.current.should_receive(:[]=).with(:request_id, nil)
+        expect { |b| middleware.call(worker, item, nil, &b) }.to yield_control
+      end
+
+      it 'logs the request id' do
+        Sidekiq::Logging.should_receive(:with_context)
+          .with("request_id=#{request_id} worker=Worker jid=#{job_id} args=[\"foo\"]")
+          .and_yield
+        expect { |b| middleware.call(worker, item, nil, &b) }.to yield_control
+      end
+    end
+
+    context 'when the worker is not configured to log request ids' do
+      it 'does not log the request' do
+        expect { |b| middleware.call(worker, {}, nil, &b) }.to yield_control
+      end
+    end
+
+    context 'when an error is raised' do
+      it 'ensures that the thread local is set to nil, and raises the error' do
+        Thread.current.should_receive(:[]=).with(:request_id, nil).twice
+        expect { middleware.call(worker, {}, nil) { raise } }.to raise_error
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require 'bundler/setup'
+Bundler.require :default, :test
+
+# Requires supporting ruby files with custom matchers and macros, etc,
+# in spec/support/ and its subdirectories.
+Dir[File.join(File.dirname(__FILE__), "support/**/*.rb")].each {|f| require f}

data/spec/support/sidekiq.rb

@@ -0,0 +1,33 @@
+require 'logger'
+
+module Sidekiq
+  def self.logger
+    @logger ||= ::Logger.new(STDOUT)
+  end
+end
+
+# https://github.com/mperham/sidekiq/blob/602d5da96d0101f47d7e89602478b2246853733e/lib/sidekiq/middleware/server/logging.rb
+module Sidekiq
+  module Middleware
+    module Server
+      class Logging
+        def elapsed(start)
+          (Time.now - start).to_f.round(3)
+        end
+
+        def logger
+          Sidekiq.logger
+        end
+      end
+    end
+  end
+end
+
+# https://github.com/mperham/sidekiq/blob/602d5da96d0101f47d7e89602478b2246853733e/lib/sidekiq/logging.rb
+module Sidekiq
+  module Logging
+    def self.with_context(msg)
+      yield
+    end
+  end
+end

metadata

@@ -0,0 +1,123 @@
+--- !ruby/object:Gem::Specification
+name: request_id
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Eric J. Holmes
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-09-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Classes for tracking request id
+email:
+- eric@ejholmes.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rack/request_id.rb
+- lib/request_id.rb
+- lib/request_id/version.rb
+- lib/sidekiq/middleware/client/request_id.rb
+- lib/sidekiq/middleware/server/request_id.rb
+- request_id.gemspec
+- spec/rack/request_id_spec.rb
+- spec/sidekiq/middleware/client/request_id_spec.rb
+- spec/sidekiq/middleware/server/request_id_spec.rb
+- spec/spec_helper.rb
+- spec/support/sidekiq.rb
+homepage: https://github.com/remind101/request_id
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -2924657603052698808
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -2924657603052698808
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Classes for tracking request id
+test_files:
+- spec/rack/request_id_spec.rb
+- spec/sidekiq/middleware/client/request_id_spec.rb
+- spec/sidekiq/middleware/server/request_id_spec.rb
+- spec/spec_helper.rb
+- spec/support/sidekiq.rb