qs-request-tracker 0.0.1

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/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 1.9.2
+  - 2.0.0
+  - jruby-19mode
+  - rbx-19mode

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# 0.0.1 / 2013-08-12
+
+* Adds travis badge
+* Adds travis configuration
+* The beginning

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Thorben Schröder
+
+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,57 @@
+# Qs::Request::Tracker
+
+[![Build Status](https://travis-ci.org/quarter-spiral/qs-request-tracker.png)](https://travis-ci.org/quarter-spiral/qs-request-tracker)
+
+Manages a ``Request-Id`` for each HTTP request. Hooks transparently into [Faraday](https://github.com/lostisland/faraday) and [service-client](https://github.com/quarter-spiral/service-client) to pass request ids on to subsequent calls to other services. This way errors can be tracked through all layers and apps of your infrastructure easily.
+
+## Use as a Rack middleware
+
+The easiest way to add request ids to your system is to add the ``Qs::Request::Tracker::Middleware`` as a middleware to your app.
+
+```ruby
+require 'qs/request/tracker'
+
+Rack::Builder.new do
+  use Qs::Request::Tracker::Middleware
+  run YourApp.new
+end
+```
+
+This will add the request id to the response. If there is no ``Request-Id`` HTTP header set in the request it will also set that. Please note that all middlewares that are included before it will not have that header set!
+
+## Use the Faraday middleware
+
+If you are using [Faraday](https://github.com/lostisland/faraday) you transparently add the request id to all outgoing HTTP calls, too.
+
+```ruby
+require 'faraday'
+# make sure to require this middleware after faraday itself
+require 'qs/request/tracker/faraday_middleware'
+
+conn = Faraday.new(:url => 'http://example.com') do |faraday|
+  # it is important to have the request_id middleware inserted before any Faraday adapter
+  faraday.request :request_id
+end
+```
+
+All requests done by that connection will now have a ``Request-Id`` http header set that equal the one from the request that came into your system. If this is used not within a request context that header will just not get set.
+
+**Imporant:** This feature relies on [thread local variables](http://www.ruby-doc.org/core-2.0/Thread.html#label-Fiber-local+vs.+Thread-local) and will not work if you deal with more than one request per thread at a time!
+
+This approach is inspired by [Andy](https://github.com/adelcambre)'s [talk](http://www.youtube.com/watch?v=NpTT30wLL-w) on debugging large scale systems.
+
+## Use the service-client extension
+
+This extension will automatically use the Faraday middleware for [service-client](https://github.com/quarter-spiral/service-client) connections that use the ``Service::Client::Adapter::Faraday`` adapter.
+
+```ruby
+require 'service-client'
+# make sure to require this extension after service-client itself
+require 'qs/request/tracker/service_client_extension'
+
+client = Service::Client.new('http://example.com/')
+client.urls.add(:root, :get, "/")
+client.get(client.urls.root, oauth_token)
+```
+
+This will then heave the ``Request-Id`` http header set through the Faraday middleware.

data/Rakefile

@@ -0,0 +1,10 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.pattern = "spec/**/*_spec.rb"
+end
+
+task :default => :test

data/lib/qs/request/tracker/faraday_middleware.rb

@@ -0,0 +1,43 @@
+if defined? Faraday::Middleware
+  module Qs::Request::Tracker
+    class FaradayMiddleware < Faraday::Middleware
+      THREAD_LOCAL_MISMATCH_MESSAGES = "REQUEST TRACKING ERROR! Found an ID in the headers: %s but a different one in the thread locals: %s"
+
+      def initialize(app, options = {})
+        super(app)
+      end
+
+      def call(env)
+        annotate_env_with_request_id!(env) if thread_local_request_id
+        @app.call(env)
+      end
+
+      protected
+      def annotate_env_with_request_id!(env)
+        log_request_mismatch_error(env) unless request_ids_match?(env)
+        env[:request_headers][HTTP_HEADER_FIELD] = thread_local_request_id
+      end
+
+      def request_ids_match?(env)
+        return true unless headers_request_id(env)
+        (thread_local_request_id && thread_local_request_id == headers_request_id(env))
+      end
+
+      def thread_local_request_id
+        Qs::Request::Tracker.thread_request_id
+      end
+
+      def headers_request_id(env)
+        env[:request_headers][HTTP_HEADER_FIELD]
+      end
+
+      def log_request_mismatch_error(env)
+        STDERR.puts(THREAD_LOCAL_MISMATCH_MESSAGES % [thread_local_request_id.inspect, headers_request_id(env).inspect])
+      end
+    end
+  end
+
+  if Faraday.respond_to? :register_middleware
+    Faraday.register_middleware :request, :request_id => lambda { Qs::Request::Tracker::FaradayMiddleware }
+  end
+end

data/lib/qs/request/tracker/middleware.rb

@@ -0,0 +1,21 @@
+require 'uuid'
+
+module Qs
+  module Request
+    module Tracker
+      class Middleware
+        def initialize(app)
+          @app = app
+        end
+
+        def call(env)
+          env['HTTP_REQUEST_ID'] ||= UUID.new.generate
+          Qs::Request::Tracker.thread_request_id = env['HTTP_REQUEST_ID']
+          status, headers, body = @app.call(env)
+          headers[HTTP_HEADER_FIELD] ||= Qs::Request::Tracker.thread_request_id
+          [status, headers, body]
+        end
+      end
+    end
+  end
+end

data/lib/qs/request/tracker/service_client_extension.rb

@@ -0,0 +1,15 @@
+if defined? Service::Client::Adapter::Faraday
+  require 'qs/request/tracker/faraday_middleware'
+
+  class Service::Client::Adapter::Faraday
+    alias _before_qs_request_tracker_service_client_extension_initialize initialize
+    def initialize(*args)
+      _before_qs_request_tracker_service_client_extension_initialize(*args)
+      existing_builder = @builder
+      @builder = lambda do |faraday|
+        faraday.request :request_id
+        existing_builder ? existing_builder.call(faraday) : true
+      end
+    end
+  end
+end

data/lib/qs/request/tracker/version.rb

@@ -0,0 +1,7 @@
+module Qs
+  module Request
+    module Tracker
+      VERSION = "0.0.1"
+    end
+  end
+end

data/lib/qs/request/tracker.rb

@@ -0,0 +1,19 @@
+require "qs/request/tracker/version"
+require "qs/request/tracker/middleware"
+
+module Qs
+  module Request
+    module Tracker
+      THREAD_LOCAL_REQUEST_ID_KEY = :'_HTTP_REQUEST_ID'
+      HTTP_HEADER_FIELD = 'Request-Id'
+
+      def self.thread_request_id
+        Thread.current[THREAD_LOCAL_REQUEST_ID_KEY]
+      end
+
+      def self.thread_request_id=(new_id)
+        Thread.current[THREAD_LOCAL_REQUEST_ID_KEY] = new_id
+      end
+    end
+  end
+end

data/qs-request-tracker.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'qs/request/tracker/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "qs-request-tracker"
+  spec.version       = Qs::Request::Tracker::VERSION
+  spec.authors       = ["Thorben Schröder"]
+  spec.email         = ["stillepost@gmail.com"]
+  spec.description   = %q{Manages a Request-Id for each HTTP request}
+  spec.summary       = %q{Manages a Request-Id for each HTTP request}
+  spec.homepage      = ""
+  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 "faraday"
+  spec.add_development_dependency "service-client", ">= 0.0.14"
+  spec.add_development_dependency "sinatra"
+  spec.add_development_dependency "rack-client"
+  spec.add_development_dependency "rack-test"
+
+  spec.add_dependency 'uuid'
+end

data/spec/faraday_middleware_spec.rb

@@ -0,0 +1,59 @@
+require 'sinatra'
+disable :run
+require 'faraday'
+require 'rack/client'
+
+require_relative './spec_helper'
+
+require 'qs/request/tracker/faraday_middleware'
+
+ALL_REQUESTS = []
+
+class SampleAppFaraday < Sinatra::Base
+  helpers do
+    def request_with_faraday!
+      conn = Faraday.new(:url => 'http://example.com') do |faraday|
+        faraday.request :request_id
+        faraday.adapter :rack, SampleAppFaraday.new
+      end
+
+      conn.get '/by-client'
+
+      'done'
+    end
+  end
+
+  get "/by-client" do
+    ALL_REQUESTS << request
+    '{"done": true}'
+  end
+
+  get "/with-request-id-set" do
+    Qs::Request::Tracker.thread_request_id = '123'
+
+    request_with_faraday!
+  end
+
+  get "/without-request-id-set" do
+    request_with_faraday!
+  end
+end
+
+describe Qs::Request::Tracker do
+  before do
+    Qs::Request::Tracker.thread_request_id = nil
+    @client = Rack::Client.new do
+      run SampleAppFaraday.new
+    end
+  end
+
+  it "passes the request-id as a http header" do
+    @client.get('/with-request-id-set')
+    ALL_REQUESTS.last.env['HTTP_REQUEST_ID'].must_equal '123'
+  end
+
+  it "doesn't add a request-id if there is none present" do
+    @client.get('/without-request-id-set')
+    ALL_REQUESTS.last.env['HTTP_REQUEST_ID'].must_be_nil
+  end
+end

data/spec/middleware_spec.rb

@@ -0,0 +1,51 @@
+require_relative './spec_helper'
+
+require 'sinatra'
+disable :run
+
+require 'rack/client'
+
+require 'json'
+
+class SampleAppMiddleware < Sinatra::Base
+  use Qs::Request::Tracker::Middleware
+
+  get '/' do
+    JSON.dump('request_id' => request.env['HTTP_REQUEST_ID'])
+  end
+end
+
+def parse_request_id(response)
+  JSON.parse(response.body)['request_id']
+end
+
+describe Qs::Request::Tracker::Middleware do
+  before do
+    @client = Rack::Client.new do
+      run SampleAppMiddleware.new
+    end
+    Qs::Request::Tracker.thread_request_id = nil
+  end
+
+  it "adds a request id if none is provided via an HTTP request header" do
+    response = @client.get '/'
+    request_id = parse_request_id(response)
+    request_id.wont_be_nil
+  end
+
+  it "sets the thread local id" do
+    response = @client.get '/'
+    Qs::Request::Tracker.thread_request_id.wont_be_nil
+  end
+
+  it "sets the request id in the response headers" do
+    response = @client.get '/'
+    response.headers['Request-Id'].wont_be_nil
+  end
+
+  it "does not change the supplied request id" do
+    response = @client.get '/', {'Request-Id' => '12345'}
+    Qs::Request::Tracker.thread_request_id.must_equal '12345'
+    Qs::Request::Tracker.thread_request_id.must_equal '12345'
+  end
+end

data/spec/service_client_extension_spec.rb

@@ -0,0 +1,59 @@
+require 'sinatra'
+disable :run
+
+require 'service-client'
+require 'rack/client'
+
+require_relative './spec_helper'
+
+require 'qs/request/tracker/service_client_extension'
+
+ALL_REQUESTS = []
+
+class SampleAppServiceClient < Sinatra::Base
+  helpers do
+    def request_with_service_client!
+      client = Service::Client.new('http://example.com/')
+      client.urls.add(:test, :get, "/by-client")
+      client.raw.adapter = Service::Client::Adapter::Faraday.new(adapter: [:rack, SampleAppServiceClient.new])
+
+      client.get(client.urls.test, 'no-token')
+
+      'done'
+    end
+  end
+
+  get "/by-client" do
+    ALL_REQUESTS << request
+    '{"done": true}'
+  end
+
+  get "/with-request-id-set" do
+    Qs::Request::Tracker.thread_request_id = '123'
+
+    request_with_service_client!
+  end
+
+  get "/without-request-id-set" do
+    request_with_service_client!
+  end
+end
+
+describe Qs::Request::Tracker do
+  before do
+    Qs::Request::Tracker.thread_request_id = nil
+    @client = Rack::Client.new do
+      run SampleAppServiceClient.new
+    end
+  end
+
+  it "passes the request-id as a http header" do
+    @client.get('/with-request-id-set')
+    ALL_REQUESTS.last.env['HTTP_REQUEST_ID'].must_equal '123'
+  end
+
+  it "doesn't add a request-id if there is none present" do
+    @client.get('/without-request-id-set')
+    ALL_REQUESTS.last.env['HTTP_REQUEST_ID'].must_be_nil
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+ENV['RACK_ENV'] ||= 'test'
+
+Bundler.require
+
+require 'qs/request/tracker'
+
+require 'minitest/autorun'

metadata

@@ -0,0 +1,195 @@
+--- !ruby/object:Gem::Specification
+name: qs-request-tracker
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Thorben Schröder
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-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: faraday
+  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: service-client
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.0.14
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.0.14
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  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: rack-client
+  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: rack-test
+  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: uuid
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Manages a Request-Id for each HTTP request
+email:
+- stillepost@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/qs/request/tracker.rb
+- lib/qs/request/tracker/faraday_middleware.rb
+- lib/qs/request/tracker/middleware.rb
+- lib/qs/request/tracker/service_client_extension.rb
+- lib/qs/request/tracker/version.rb
+- qs-request-tracker.gemspec
+- spec/faraday_middleware_spec.rb
+- spec/middleware_spec.rb
+- spec/service_client_extension_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+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'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Manages a Request-Id for each HTTP request
+test_files:
+- spec/faraday_middleware_spec.rb
+- spec/middleware_spec.rb
+- spec/service_client_extension_spec.rb
+- spec/spec_helper.rb