rf_logger 0.3.4 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 48bfb144bdbf72a511aadac75f6dbb3156603034
-  data.tar.gz: 38384d7a71e1d011894674282eab6b67af905fd2
+  metadata.gz: 81caf0a521defb598ff45606fa41b4a3716b6cca
+  data.tar.gz: 380ede66b6abbd83af7e7f8bf8ad0023992e96af
 SHA512:
-  metadata.gz: 8de9535830368540b4ff1caf1b57c57ff21487e4fe161eff869d225eda6ea05e67159cbdd76126291b0283dd8819a2f98f2fd355790397cbb48fd92820c311de
-  data.tar.gz: 73dc68be426f72760a446b415fe9b6e7ddb4b9df9872230e7bfb3dacfdea92f37b9a0231bbafb76e207926e20f75ab86ef0d5c825c648d411cefd23e9aad1654
+  metadata.gz: 94eacd45bc0183dcded21c6cab446b0a3025fb98111ef76f505b244e076ecd9cce3995670b7ffc7360c38992825d56e1eb3d2b57682d6343cfbc7662092db156
+  data.tar.gz: 526e62a0c64f1bc1a4801c533d56840547e7f6acecebfbc7d57e23e7d02555a14a183c79c339ef99da2d730d03baafbc1b354c78e738385e263f88f98d24a3f0

data/lib/rf_logger/request/request_middleware.rb

@@ -2,11 +2,17 @@ require "thread/inheritable_attributes"
 
 module RfLogger
   class RequestMiddleware
+    REQUEST_ID_ENV = [
+      /\.request_id/, # matches action_dispatch.request_id & rory.request_id
+      "X-Request-Id", # If framework middleware has not been set fallback to default.
+      "HTTP_X_REQUEST_ID"
+    ].freeze
+
     # @param [Hash] options
-    # @option opts [Hash{:label => "header_name"}] :tagged The subject
+    # @option opts [Hash{:label => ["header_name", /or regex/]}] :tagged match on rack request env keys. First value found has priority.
     def initialize(app, options={})
-      @app                = app
-      @tagged             = options.fetch(:tagged, { request_id: "X-Request-Id" })
+      @app    = app
+      @tagged = options.fetch(:tagged, { request_id: REQUEST_ID_ENV })
     end
 
     def call(env)
@@ -16,13 +22,26 @@ module RfLogger
     end
 
     def tagged
-      @tagged.each_with_object({}) do |(key, value), hash|
-        hash[key] = @env[value]
+      @tagged.each_with_object({}) do |(label, matches), tags|
+        [*matches].each do |match|
+          break if (val = find_by(match)) && (tags[label] = val)
+        end
       end
     end
 
     private
 
+    def find_by(match)
+      case match
+      when String
+        @env[match]
+      when Regexp
+        (@env.find { |k, _| match =~ k }|| []).last
+      else
+        raise "Unknown tagged match type: #{match}"
+      end
+    end
+
     def set_tagged_thread_var
       Thread.current.set_inheritable_attribute(:rf_logger_request_tags, tagged)
     end

data/lib/rf_logger/version.rb

@@ -1,3 +1,3 @@
 module RfLogger
-  VERSION = "0.3.4"
+  VERSION = "0.4.0"
 end

data/spec/lib/rf_logger/request/request_middleware_spec.rb

@@ -1,35 +1,66 @@
 require "rf_logger/request/request_middleware"
+require "thread/inheritable_attributes"
 
 RSpec.describe RfLogger::RequestMiddleware do
   subject { RfLogger::RequestMiddleware.new(*init_arguments).call(env) }
   let(:env) { {} }
   let(:init_arguments) { [->(_) {}] }
-  after { Thread.current[:rf_logger_request_id] = nil }
+  let(:rf_logger_request_tags) { Thread.current.get_inheritable_attribute(:rf_logger_request_tags) || :tags_not_present }
 
-  context "when tagged is missing" do
-    let(:env) { { "X-Request-Id" => "uuid-from_env" } }
-    it "defaults to getting the request_id" do
-      subject
-      expect(Thread.current[:inheritable_attributes][:rf_logger_request_tags]).to eq({ :request_id => "uuid-from_env" })
-    end
+  before do
+    Thread.current.set_inheritable_attribute(:rf_logger_request_tags, nil)
   end
 
-  context "when tagged option is given that exists" do
-    let(:env) { { "X-OtherHeader" => "other_request_id" } }
-    let(:init_arguments) { [->(_) {}, tagged: { custom_env_key: "X-OtherHeader" }] }
+  context "when tagged: keyword arg is not given it loads defaults" do
+    before { subject }
+    context "when env[/request_id/] is present" do
+      let(:env) { { "some_other_env"     => "other_value",
+                    "sinatra.request_id" => "framework_request_id_value",
+                    "X-Request-Id"       => "http_request_id_value" } }
+      it { expect(rf_logger_request_tags).to eq({ :request_id => "framework_request_id_value" }) }
+    end
+
+    context "when env['X-Request-Id'] is the only value" do
+      let(:env) { { "X-Request-Id" => "http_request_id_value", "some_other_env" => "other_value" } }
+      it { expect(rf_logger_request_tags).to eq({ :request_id => "http_request_id_value" }) }
+    end
+
+    context "when env[/request_id/] os env['X-Request-Id'] NOT is present" do
+      let(:env) { {} }
 
-    it "sets current Thread variable" do
-      subject
-      expect(Thread.current[:inheritable_attributes][:rf_logger_request_tags]).to eq({ :custom_env_key => "other_request_id" })
+      it "is not set in the tags" do
+        expect(rf_logger_request_tags).to eq({})
+      end
     end
   end
 
-  context "when tagged option is given that does not exists" do
-    let(:init_arguments) { [->(_) {}, tagged: { custom_env_key: "X-WontFindMe" }] }
+  context "when tagged: keyword arg is given" do
+    context "when the env exists" do
+      before { subject }
+      let(:env) { { "some_other_env" => "other_value", "X-OtherHeader" => "other_request_id" } }
+      let(:init_arguments) { [->(_) {}, tagged: { custom_env_key: "X-OtherHeader" }] }
+      it "sets current Thread variable" do
+        expect(rf_logger_request_tags).to eq({ :custom_env_key => "other_request_id" })
+      end
+    end
+
+    context "when a tagged match type is unknown" do
+      let(:env) { { "X-OtherHeader" => "other_request_id", "some_other_env" => "other_value" } }
+      let(:init_arguments) { [->(_) {}, tagged: { custom_env_key: [1] }] }
+
+      it "sets current Thread variable" do
+        expect { subject }.to raise_error("Unknown tagged match type: 1")
+        expect(rf_logger_request_tags).to eq(:tags_not_present)
+      end
+    end
+
+    context "when the env does not exists" do
+      before { subject }
+      let(:init_arguments) { [->(_) {}, tagged: { custom_env_key: "X-WontFindMe" }] }
 
-    it "sets current Thread variable" do
-      subject
-      expect(Thread.current[:inheritable_attributes][:rf_logger_request_tags]).to eq({:custom_env_key=>nil})
+      it "is not set in the tags" do
+        expect(rf_logger_request_tags).to eq({})
+      end
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rf_logger
 version: !ruby/object:Gem::Version
-  version: 0.3.4
+  version: 0.4.0
 platform: ruby
 authors:
 - Dustin Zeisler
@@ -199,3 +199,4 @@ test_files:
 - spec/lib/rf_logger_spec.rb
 - spec/spec_helper.rb
 - spec/support/request_id_shared_examples.rb
+has_rdoc: