timber 1.0.13 → 1.1.0

data/lib/timber/logger.rb

@@ -13,12 +13,15 @@ module Timber
   # @example Basic example (the original ::Logger interface remains untouched):
   #   logger.info "Payment rejected for customer #{customer_id}"
   #
-  # @example Using a map
-  #   # The :message, :type, and :data keys are required
-  #   logger.info message: "Payment rejected", type: :payment_rejected, data: {customer_id: customer_id, amount: 100}
+  # @example Using a Hash
+  #   # The :message key is required, the other additional key is your event type and data
+  #   # :type is the namespace used in timber for the :data
+  #   logger.info message: "Payment rejected", payment_rejected: {customer_id: customer_id, amount: 100}
   #
   # @example Using a Struct (a simple, more structured way, to define events)
   #   PaymentRejectedEvent = Struct.new(:customer_id, :amount, :reason) do
+  #     # `#message` and `#type` are required, otherwise they will not be logged properly.
+  #     # `#type` is the namespace used in timber for the struct data
   #     def message; "Payment rejected for #{customer_id}"; end
   #     def type; :payment_rejected; end
   #   end
@@ -72,14 +75,25 @@ module Timber
       private
         def build_log_entry(severity, time, progname, msg)
           level = SEVERITY_MAP.fetch(severity)
-          context = CurrentContext.instance.snapshot
+          context_snapshot = CurrentContext.instance.snapshot
+          tags = extract_active_support_tagged_logging_tags
+          tags += [msg.delete(:tag)] if msg.is_a?(Hash) && msg.key?(:tag)
+          tags += msg.delete(:tags) if msg.is_a?(Hash) && msg.key?(:tags)
           event = Events.build(msg)
+
           if event
-            LogEntry.new(level, time, progname, event.message, context, event)
+            LogEntry.new(level, time, progname, event.message, context_snapshot, event, tags)
           else
-            LogEntry.new(level, time, progname, msg, context, nil)
+            LogEntry.new(level, time, progname, msg, context_snapshot, nil, tags)
           end
         end
+
+        # Because of all the crazy ways Rails has attempted this we need this crazy method.
+        def extract_active_support_tagged_logging_tags
+          Thread.current[:activesupport_tagged_logging_tags] ||
+            Thread.current["activesupport_tagged_logging_tags:#{object_id}"] ||
+            []
+        end
     end
 
     # Structures your log messages into Timber's hybrid format, which makes

data/lib/timber/probes.rb

@@ -3,20 +3,18 @@ require "timber/probes/action_dispatch_debug_exceptions"
 require "timber/probes/action_view_log_subscriber"
 require "timber/probes/active_record_log_subscriber"
 require "timber/probes/active_support_tagged_logging"
-require "timber/probes/rack_http_context"
 require "timber/probes/rails_rack_logger"
 
 module Timber
   # Namespace for all probes.
   # @private
   module Probes
-    def self.insert!(middleware, insert_before)
+    def self.insert!
       ActionControllerLogSubscriber.insert!
       ActionDispatchDebugExceptions.insert!
       ActionViewLogSubscriber.insert!
       ActiveRecordLogSubscriber.insert!
       ActiveSupportTaggedLogging.insert!
-      RackHTTPContext.insert!(middleware, insert_before)
       RailsRackLogger.insert!
     end
   end

data/lib/timber/probes/active_support_tagged_logging.rb

@@ -17,26 +17,6 @@ module Timber
                 super(severity, timestamp, progname, "#{tags_text}#{msg}")
               end
             end
-
-            def push_tags(*tags)
-              _timber_original_push_tags(*tags).tap do
-                if current_tags.size > 0
-                  context = Contexts::Tags.new(values: current_tags)
-                  CurrentContext.add(context)
-                end
-              end
-            end
-
-            def pop_tags(size = 1)
-              _timber_original_pop_tags(size).tap do
-                if current_tags.size == 0
-                  CurrentContext.remove(Contexts::Tags)
-                else
-                  context = Contexts::Tags.new(values: current_tags)
-                  CurrentContext.add(context)
-                end
-              end
-            end
           end
         end
       end
@@ -44,29 +24,6 @@ module Timber
       module LoggerMethods
         def self.included(klass)
           klass.class_eval do
-            alias_method :_timber_original_push_tags, :push_tags
-            alias_method :_timber_original_pop_tags, :pop_tags
-
-            def push_tags(*tags)
-              _timber_original_push_tags(*tags).tap do
-                if current_tags.size > 0
-                  context = Contexts::Tags.new(values: current_tags)
-                  CurrentContext.add(context)
-                end
-              end
-            end
-
-            def pop_tags(size = 1)
-              _timber_original_pop_tags(size).tap do
-                if current_tags.size == 0
-                  CurrentContext.remove(Contexts::Tags)
-                else
-                  context = Contexts::Tags.new(values: current_tags)
-                  CurrentContext.add(context)
-                end
-              end
-            end
-
             def add(severity, message = nil, progname = nil, &block)
               if message.nil?
                 if block_given?

data/lib/timber/probes/rails_rack_logger.rb

@@ -7,7 +7,7 @@ module Timber
         def self.included(klass)
           klass.class_eval do
             protected
-              if klass.method_defined?(:started_request_message)
+              if klass.private_instance_methods.include?(:started_request_message) || klass.method_defined?(:started_request_message)
                 def started_request_message(request)
                   http_request_event(request)
                 end

data/lib/timber/rack_middlewares.rb

@@ -0,0 +1,12 @@
+require "timber/rack_middlewares/http_context"
+
+module Timber
+  # Namespace for all Rack middlewares.
+  module RackMiddlewares
+    # A list containing *all* `Timber::RackMiddlewares::*` sub classes. This makes it easy to
+    # achieve forward compatibility as middlewares are modified.
+    def self.middlewares
+      @middlewares ||= [HTTPContext]
+    end
+  end
+end

data/lib/timber/rack_middlewares/http_context.rb

@@ -0,0 +1,30 @@
+module Timber
+  module RackMiddlewares
+    # Reponsible for adding the HTTP context for applications that use `Rack`.
+    class HTTPContext
+      def initialize(app)
+        @app = app
+      end
+
+      def call(env)
+        request = ::Rack::Request.new(env)
+        context = Contexts::HTTP.new(
+          method: request.request_method,
+          path: request.path,
+          remote_addr: request.ip,
+          request_id: request_id(env)
+        )
+        CurrentContext.with(context) do
+          @app.call(env)
+        end
+      end
+
+      private
+        def request_id(env)
+          env["X-Request-ID"] ||
+            env["X-Request-Id"] ||
+            env["action_dispatch.request_id"]
+        end
+    end
+  end
+end

data/lib/timber/util.rb

@@ -1,5 +1,6 @@
 require "timber/util/active_support_log_subscriber"
 require "timber/util/hash"
+require "timber/util/struct"
 
 module Timber
   # @private

data/lib/timber/util/struct.rb

@@ -0,0 +1,16 @@
+module Timber
+  module Util
+    # @private
+    module Struct
+      extend self
+
+      def to_hash(struct)
+        h = {}
+        struct.each_pair do |k ,v|
+          h[k] = v
+        end
+        h
+      end
+    end
+  end
+end

data/lib/timber/version.rb

@@ -1,3 +1,3 @@
 module Timber
-  VERSION = "1.0.13"
+  VERSION = "1.1.0"
 end

data/spec/README.md

@@ -0,0 +1,23 @@
+# Testing
+
+Testing Timber uses [`appraisal`](https://github.com/thoughtbot/appraisal). This allows us to
+test across multiple versions and combinations of libraries.
+
+To get started:
+
+```shell
+bundle install
+bundle exec appraisal install
+```
+
+To see all appraisal commands:
+
+```shell
+appraisal --help
+```
+
+You can run tests with:
+
+```shell
+appraisal rails-3.2.X rspec
+```

data/spec/support/timber.rb

@@ -1,4 +1,4 @@
 # Must require last in order to be mocked via webmock
 require 'timber'
 
-Timber::Config.instance.logger = ::Logger.new(nil)
+Timber::Config.instance.logger = ::Logger.new(STDOUT)

data/spec/timber/contexts_spec.rb

@@ -0,0 +1,49 @@
+require "spec_helper"
+
+describe Timber::Contexts, :rails_23 => true do
+  describe ".build" do
+    it "should build a Timber::Context" do
+      context = Timber::Contexts::Custom.new(
+        type: :build,
+        data: {version: "1.0.0"}
+      )
+      built_context = Timber::Contexts.build(context)
+      expect(built_context).to eq(context)
+    end
+
+    it "should use #to_timber_context" do
+      BuildContext = Struct.new(:version) do
+        def to_timber_context
+          Timber::Contexts::Custom.new(
+            type: :build,
+            data: respond_to?(:to_h) ? to_h : Timber::Util::Struct.to_hash(self)
+          )
+        end
+      end
+      built_context = Timber::Contexts.build(BuildContext.new("1.0.0"))
+      expect(built_context).to be_kind_of(Timber::Contexts::Custom)
+      expect(built_context.type).to eq(:build)
+      Object.send(:remove_const, :BuildContext)
+    end
+
+    it "should accept a properly structured hash" do
+      built_context = Timber::Contexts.build(build: {version: "1.0.0"})
+      expect(built_context).to be_kind_of(Timber::Contexts::Custom)
+      expect(built_context.type).to eq(:build)
+    end
+
+    it "should accept a struct" do
+      BuildContext = Struct.new(:version) do
+        def type; :build; end
+      end
+      built_context = Timber::Contexts.build(BuildContext.new("1.0.0"))
+      expect(built_context).to be_kind_of(Timber::Contexts::Custom)
+      expect(built_context.type).to eq(:build)
+      Object.send(:remove_const, :BuildContext)
+    end
+
+    it "should return nil for unsupported" do
+      expect(Timber::Contexts.build(1)).to be_nil
+    end
+  end
+end

data/spec/timber/events_spec.rb

@@ -30,7 +30,7 @@ describe Timber::Events, :rails_23 => true do
     end
 
     it "should accept a properly structured hash" do
-      built_event = Timber::Events.build({type: :payment_rejected, message: "Payment rejected", data: {customer_id: "abcd1234", amount: 100}})
+      built_event = Timber::Events.build({message: "Payment rejected", payment_rejected: {customer_id: "abcd1234", amount: 100}})
       expect(built_event).to be_kind_of(Timber::Events::Custom)
       expect(built_event.type).to eq(:payment_rejected)
       expect(built_event.message).to eq("Payment rejected")

data/spec/timber/log_devices/http_spec.rb

@@ -58,15 +58,15 @@ describe Timber::LogDevices::HTTP do
 
     it "should add a request to the queue" do
       http = described_class.new("MYKEY", threads: false)
-      log_entry = Timber::LogEntry.new("INFO", time, nil, "test log message 1", nil, nil)
+      log_entry = Timber::LogEntry.new("INFO", time, nil, "test log message 1", nil, nil, [])
       http.write(log_entry)
-      log_entry = Timber::LogEntry.new("INFO", time, nil, "test log message 2", nil, nil)
+      log_entry = Timber::LogEntry.new("INFO", time, nil, "test log message 2", nil, nil, [])
       http.write(log_entry)
       http.send(:flush)
       request_queue = http.instance_variable_get(:@request_queue)
       request = request_queue.deq
       expect(request).to be_kind_of(Net::HTTP::Post)
-      expect(request.body).to eq("\x92\x83\xA5level\xA4INFO\xA2dt\xBB2016-09-01T12:00:00.000000Z\xA7message\xB2test log message 1\x83\xA5level\xA4INFO\xA2dt\xBB2016-09-01T12:00:00.000000Z\xA7message\xB2test log message 2".force_encoding("ASCII-8BIT"))
+      expect(request.body).to start_with("\x92\x85\xA5level\xA4INFO\xA2dt\xBB2016-09-01T12:00:00.000000Z\xA7message\xB2test log message 1\xA7context\x81".force_encoding("ASCII-8BIT"))
 
       message_queue = http.instance_variable_get(:@msg_queue)
       expect(message_queue.size).to eq(0)
@@ -98,20 +98,20 @@ describe Timber::LogDevices::HTTP do
     it "should start a intervaled flush thread and flush on an interval" do
       stub = stub_request(:post, "https://logs.timber.io/frames").
         with(
-          :body => "\x92\x83\xA5level\xA4INFO\xA2dt\xBB2016-09-01T12:00:00.000000Z\xA7message\xB2test log message 1\x83\xA5level\xA4INFO\xA2dt\xBB2016-09-01T12:00:00.000000Z\xA7message\xB2test log message 2".force_encoding("ASCII-8BIT"),
+          :body => start_with("\x92\x85\xA5level\xA4INFO\xA2dt\xBB2016-09-01T12:00:00.000000Z\xA7message\xB2test log message 1\xA7context\x81\xA6system".force_encoding("ASCII-8BIT")),
           :headers => {
             'Accept' => 'application/json',
             'Authorization' => 'Basic TVlLRVk=',
             'Content-Type' => 'application/msgpack',
-            'User-Agent' => "Timber Ruby Gem/#{Timber::VERSION}"
+            'User-Agent' => "Timber Ruby/#{Timber::VERSION} (HTTP)"
           }
         ).
         to_return(:status => 200, :body => "", :headers => {})
 
       http = described_class.new("MYKEY", flush_interval: 0.1)
-      log_entry = Timber::LogEntry.new("INFO", time, nil, "test log message 1", nil, nil)
+      log_entry = Timber::LogEntry.new("INFO", time, nil, "test log message 1", nil, nil, [])
       http.write(log_entry)
-      log_entry = Timber::LogEntry.new("INFO", time, nil, "test log message 2", nil, nil)
+      log_entry = Timber::LogEntry.new("INFO", time, nil, "test log message 2", nil, nil, [])
       http.write(log_entry)
       sleep 0.3
 

data/spec/timber/log_entry_spec.rb

@@ -0,0 +1,15 @@
+require "spec_helper"
+
+describe Timber::LogEntry, :rails_23 => true do
+  describe "#to_msgpack" do
+    let(:time) { Time.utc(2016, 9, 1, 12, 0, 0) }
+
+    it "should encode properly with an event and context" do
+      event = Timber::Events::Custom.new(type: :event_type, message: "event_message", data: {a: 1})
+      context = {custom: Timber::Contexts::Custom.new(type: :context_type, data: {b: 1})}
+      log_entry = described_class.new("INFO", time, nil, "log message", context, event, [])
+      msgpack = log_entry.to_msgpack
+      expect(msgpack).to start_with("\x86\xA5level\xA4INFO\xA2dt\xBB2016-09-01T12:00:00.000000Z".force_encoding("ASCII-8BIT"))
+    end
+  end
+end

data/spec/timber/logger_spec.rb

@@ -15,7 +15,7 @@ describe Timber::Logger, :rails_23 => true do
 
       it "should accept strings" do
         logger.info("this is a test")
-        expect(io.string).to eq("this is a test @timber.io {\"level\":\"info\",\"dt\":\"2016-09-01T12:00:00.000000Z\"}\n")
+        expect(io.string).to start_with("this is a test @timber.io {\"level\":\"info\",\"dt\":\"2016-09-01T12:00:00.000000Z\"")
       end
 
       context "with a context" do
@@ -37,33 +37,37 @@ describe Timber::Logger, :rails_23 => true do
         it "should snapshot and include the context" do
           expect(Timber::CurrentContext.instance).to receive(:snapshot).and_call_original
           logger.info("this is a test")
-          expect(io.string).to eq("this is a test @timber.io {\"level\":\"info\",\"dt\":\"2016-09-01T12:00:00.000000Z\",\"context\":{\"http\":{\"method\":\"POST\",\"path\":\"/checkout\",\"remote_addr\":\"123.456.789.10\",\"request_id\":\"abcd1234\"}}}\n")
+          expect(io.string).to start_with("this is a test @timber.io {\"level\":\"info\",\"dt\":\"2016-09-01T12:00:00.000000Z\"")
+          expect(io.string).to include("\"http\":{\"method\":\"POST\",\"path\":\"/checkout\",\"remote_addr\":\"123.456.789.10\",\"request_id\":\"abcd1234\"}")
         end
       end
 
       it "should call and use Timber::Events.build" do
-        message = {message: "payment rejected", type: :payment_rejected, data: {customer_id: "abcde1234", amount: 100}}
+        message = {message: "payment rejected", payment_rejected: {customer_id: "abcde1234", amount: 100}}
         expect(Timber::Events).to receive(:build).with(message).and_call_original
         logger.info(message)
-        expect(io.string).to eq("payment rejected @timber.io {\"level\":\"info\",\"dt\":\"2016-09-01T12:00:00.000000Z\",\"event\":{\"custom\":{\"payment_rejected\":{\"customer_id\":\"abcde1234\",\"amount\":100}}}}\n")
+        expect(io.string).to start_with("payment rejected @timber.io {\"level\":\"info\",\"dt\":\"2016-09-01T12:00:00.000000Z\",")
+        expect(io.string).to include("\"event\":{\"server_side_app\":{\"custom\":{\"payment_rejected\":{\"customer_id\":\"abcde1234\",\"amount\":100}}}}")
       end
 
       it "should log properly when an event is passed" do
         message = Timber::Events::SQLQuery.new(sql: "select * from users", time_ms: 56, message: "select * from users")
         logger.info(message)
-        expect(io.string).to eq("select * from users @timber.io {\"level\":\"info\",\"dt\":\"2016-09-01T12:00:00.000000Z\",\"event\":{\"sql_query\":{\"sql\":\"select * from users\",\"time_ms\":56}}}\n")
+        expect(io.string).to start_with("select * from users @timber.io {\"level\":\"info\",\"dt\":\"2016-09-01T12:00:00.000000Z\",")
+        expect(io.string).to include("\"event\":{\"server_side_app\":{\"sql_query\":{\"sql\":\"select * from users\",\"time_ms\":56.0}}}")
       end
 
       it "should allow functions" do
         logger.info do
-          {message: "payment rejected", type: :payment_rejected, data: {customer_id: "abcde1234", amount: 100}}
+          {message: "payment rejected", payment_rejected: {customer_id: "abcde1234", amount: 100}}
         end
-        expect(io.string).to eq("payment rejected @timber.io {\"level\":\"info\",\"dt\":\"2016-09-01T12:00:00.000000Z\",\"event\":{\"custom\":{\"payment_rejected\":{\"customer_id\":\"abcde1234\",\"amount\":100}}}}\n")
+        expect(io.string).to start_with("payment rejected @timber.io {\"level\":\"info\",\"dt\":\"2016-09-01T12:00:00.000000Z\",")
+        expect(io.string).to include("\"event\":{\"server_side_app\":{\"custom\":{\"payment_rejected\":{\"customer_id\":\"abcde1234\",\"amount\":100}}}}")
       end
 
       it "should escape new lines" do
         logger.info "first\nsecond"
-        expect(io.string).to eq("first\\nsecond @timber.io {\"level\":\"info\",\"dt\":\"2016-09-01T12:00:00.000000Z\"}\n")
+        expect(io.string).to start_with("first\\nsecond @timber.io")
       end
     end
 
@@ -72,7 +76,7 @@ describe Timber::Logger, :rails_23 => true do
 
       it "should log in the correct format" do
         logger.info("this is a test")
-        expect(io.string).to eq("{\"level\":\"info\",\"dt\":\"2016-09-01T12:00:00.000000Z\",\"message\":\"this is a test\"}\n")
+        expect(io.string).to start_with("{\"level\":\"info\",\"dt\":\"2016-09-01T12:00:00.000000Z\",\"message\":\"this is a test\"")
       end
     end
 
@@ -85,7 +89,7 @@ describe Timber::Logger, :rails_23 => true do
           logger.tagged("tag") do
             logger.info(message)
           end
-          expect(io.string).to eq("select * from users @timber.io {\"level\":\"info\",\"dt\":\"2016-09-01T12:00:00.000000Z\",\"event\":{\"sql_query\":{\"sql\":\"select * from users\",\"time_ms\":56}},\"context\":{\"tags\":[\"tag\"]}}\n")
+          expect(io.string).to include("\"tags\":[\"tag\"]")
         end
       end
     end

data/spec/timber/probes/action_controller_log_subscriber_spec.rb

@@ -55,13 +55,12 @@ describe Timber::Probes::ActionControllerLogSubscriber do
             # Rails uses this to calculate the view runtime below
             allow(Benchmark).to receive(:ms).and_return(1).and_yield
             dispatch_rails_request("/log_subscriber")
-            message1 = <<-MSG
-              Processing by LogSubscriberController#index as HTML @timber.io {"level":"info","dt":"2016-09-01T12:00:00.000000Z","event":{"controller_call":{"controller":"LogSubscriberController","action":"index"}},"context":{"http":{"method":"GET","path":"/log_subscriber","remote_addr":"123.456.789.10","request_id":"unique-request-id-1234"}}}
-            MSG
-            message2 = <<-MSG
-              Completed 200 OK in 0.0ms (Views: 1.0ms) @timber.io {"level":"info","dt":"2016-09-01T12:00:00.000000Z","event":{"http_response":{"status":200,"time_ms":0.0}},"context":{"http":{"method":"GET","path":"/log_subscriber","remote_addr":"123.456.789.10","request_id":"unique-request-id-1234"}}}
-            MSG
-            expect(io.string).to eq(message1.strip + "\n" + message2.strip + "\n")
+            lines = io.string.split("\n")
+            expect(lines.length).to eq(2)
+            expect(lines[0]).to start_with('Processing by LogSubscriberController#index as HTML @timber.io {"level":"info","dt":"2016-09-01T12:00:00.000000Z"')
+            expect(lines[0]).to include('"event":{"server_side_app":{"controller_call":{"controller":"LogSubscriberController","action":"index"}}}')
+            expect(lines[1]).to start_with('Completed 200 OK in 0.0ms (Views: 1.0ms) @timber.io {"level":"info","dt":"2016-09-01T12:00:00.000000Z"')
+            expect(lines[1]).to include('"event":{"server_side_app":{"http_server_response":{"status":200,"time_ms":0.0}}}')
           end
         end
       end