rack-request-tracker 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c26fe97fae42ee27e8ba04519475e0b2a6e6f7bde6e543dda4e29cf12b47da1e
+  data.tar.gz: eeb5d4d28721899334493c1de863e768f988bd4999bc33805bfae21e32dca5ff
+SHA512:
+  metadata.gz: 8c4f14fe1450d7f9c83c3caa534b55f46d8371d2f4143111c02d971557702b2cbbd848c2ab8e512828f0d3e716d5345999f46812d0e7b07210fa93f5f7d54661
+  data.tar.gz: 7e0d4e70a0418058852b33be972fd29879fbde385490e24d2c331e9b523146ccc63383db646fe5fdf0791cd88df9ca9836ef5dc084438f23f546bc8a31a1e67c

data/lib/rack/request_tracker.rb

@@ -0,0 +1,48 @@
+require 'request_store'
+require 'mumukit/core'
+
+module Rack::RequestTracker
+  LOG_TAGS = %i(request_id forwarded_for request_uid)
+
+  class << self
+    def transaction_headers
+      LOG_TAGS.map { |it| [to_header(it), send(it)] }.to_h.compact
+    end
+
+    LOG_TAGS.each do |it|
+      define_method(it) { RequestStore.store[it] }
+      define_method("#{it}=") { |value| RequestStore.store[it] = value }
+    end
+
+    def compute_tags
+      LOG_TAGS
+          .map { |it| send it }
+          .compact
+          .join(', ')
+    end
+
+    def with_transaction_headers(args)
+      is_safe_domain?(URI.parse(args[:url]).hostname) ? args.deep_merge(headers: transaction_headers) : args
+    end
+
+    private
+
+    def to_header(log_tag)
+      "X-#{log_tag.upcase}".gsub('_', '-')
+    end
+
+    def is_safe_domain?(hostname)
+      safe_domains.any? { |it| hostname.end_with? it }
+    end
+
+    def safe_domains
+      []
+    end
+  end
+end
+
+require_relative 'request_tracker/logger_formatter'
+require_relative 'request_tracker/rack_common_logger'
+require_relative 'request_tracker/rest_client'
+require_relative 'request_tracker/middleware'
+require_relative 'request_tracker/version'

data/lib/rack/request_tracker/logger_formatter.rb

@@ -0,0 +1,8 @@
+class Logger::Formatter
+  remove_const :Format
+  Format = "%s, [%s#%d] %5s -- %s: [%s] %s\n".freeze
+
+  def call(severity, time, progname, msg)
+    Format % [severity[0..0], format_datetime(time), $$, severity, progname, Rack::RequestTracker.compute_tags, msg2str(msg)]
+  end
+end

data/lib/rack/request_tracker/middleware.rb

@@ -0,0 +1,4 @@
+module Rack::RequestTracker::Middleware
+end
+
+require_relative 'middleware/store'

data/lib/rack/request_tracker/middleware/store.rb

@@ -0,0 +1,23 @@
+module Rack::RequestTracker::Middleware
+  class Store
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      request = ActionDispatch::Request.new(env)
+      Rack::RequestTracker.request_id    = request.request_id
+      Rack::RequestTracker.forwarded_for = first_forward(request.x_forwarded_for) || request.remote_ip
+      Rack::RequestTracker.request_uid   = request.headers['X-REQUEST-UID']
+
+      @app.call(env)
+    end
+
+    private
+
+    def first_forward(forwards)
+      return unless forwards
+      forwards.split(', ').first
+    end
+  end
+end

data/lib/rack/request_tracker/rack_common_logger.rb

@@ -0,0 +1,33 @@
+class Rack::CommonLogger
+  remove_const :FORMAT
+  FORMAT = %{%s - %s [%s] [%s] "%s %s%s %s" %d %s %0.4f\n}
+
+  private
+
+  def log(env, status, header, began_at)
+    now = Time.now
+    length = extract_content_length(header)
+
+    msg = FORMAT % [
+        env['HTTP_X_FORWARDED_FOR'] || env["REMOTE_ADDR"] || "-",
+        env["REMOTE_USER"] || "-",
+        now.strftime("%d/%b/%Y:%H:%M:%S %z"),
+        Rack::RequestTracker.compute_tags,
+        env[Rack::REQUEST_METHOD],
+        env[Rack::PATH_INFO],
+        env[Rack::QUERY_STRING].empty? ? "" : "?"+env[Rack::QUERY_STRING],
+        env["HTTP_VERSION"],
+        status.to_s[0..3],
+        length,
+        now - began_at ]
+
+    logger = @logger || env['rack.errors']
+    # Standard library logger doesn't support write but it supports << which actually
+    # calls to write on the log device without formatting
+    if logger.respond_to?(:write)
+      logger.write(msg)
+    else
+      logger << msg
+    end
+  end
+end

data/lib/rack/request_tracker/rest_client.rb

@@ -0,0 +1,7 @@
+module RestClient
+  class << Request
+    revamp :new do |_, _, args, hyper|
+      hyper.(Rack::RequestTracker.with_transaction_headers args)
+    end
+  end
+end if defined? RestClient::Request

data/lib/rack/request_tracker/version.rb

@@ -0,0 +1,5 @@
+module Rack
+  module RequestTracker
+    VERSION = '0.1.0'
+  end
+end

metadata

@@ -0,0 +1,136 @@
+--- !ruby/object:Gem::Specification
+name: rack-request-tracker
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Julián Berbel Alt
+- Franco Bulgarelli
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-07-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+- !ruby/object:Gem::Dependency
+  name: request_store
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: mumukit-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- julian@mumuki.org
+- franco@mumuki.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/rack/request_tracker.rb
+- lib/rack/request_tracker/logger_formatter.rb
+- lib/rack/request_tracker/middleware.rb
+- lib/rack/request_tracker/middleware/store.rb
+- lib/rack/request_tracker/rack_common_logger.rb
+- lib/rack/request_tracker/rest_client.rb
+- lib/rack/request_tracker/version.rb
+homepage: http://github.com/mumuki/rack-request-tracker
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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: []
+rubygems_version: 3.0.2
+signing_key: 
+specification_version: 4
+summary: Bunch of patches and rack middlewares to allow for transactional logs
+test_files: []