timber 2.0.24 → 2.1.0.rc1

data/spec/timber/events/custom_spec.rb

@@ -3,9 +3,20 @@ require "spec_helper"
 describe Timber::Events::Custom, :rails_23 => true do
   describe ".to_hash" do
     it "should coerce type into an atom" do
-      custom_context = described_class.new(:type => "my type", :message => "hello", :data => {:key => "value"})
-      hash = custom_context.to_hash()
+      custom_event = described_class.new(:type => "my type", :message => "hello", :data => {:key => "value"})
+      hash = custom_event.to_hash()
       expect(hash.keys.first).to eq(:"my type")
     end
+
+    it "should coerce a Time into a float representing fractional milliseconds" do
+      timer = Timber::Timer.start
+      sleep(0.25)
+      custom_event = described_class.new(:type => :my_event, :message => "hello", :data => {:time_ms => timer})
+      expect(custom_event.message).to include("in ")
+      expect(custom_event.message).to end_with("ms")
+      data = custom_event.data
+      expect(data[:time_ms]).to be_kind_of(Float)
+      expect(data[:time_ms]).to be > 0.0
+    end
   end
 end

data/spec/timber/events/exception_spec.rb

@@ -0,0 +1,15 @@
+require "spec_helper"
+
+describe Timber::Events::Exception, :rails_23 => true do
+  describe ".initialize" do
+    it "should clean the backtrace" do
+      backtrace = [
+        "/path/to/file1.rb:26:in `function1'",
+        "path/to/file2.rb:86:in `function2'"
+      ]
+
+      exception_event = described_class.new(name: "RuntimeError", exception_message: "Boom", backtrace: backtrace)
+      expect(exception_event.backtrace).to eq([{:file=>"/path/to/file1.rb", :line=>26, :function=>"function1"}, {:file=>"path/to/file2.rb", :line=>86, :function=>"function2"}])
+    end
+  end
+end

data/spec/timber/events/http_server_request_spec.rb

@@ -6,10 +6,10 @@ describe Timber::Events::HTTPServerRequest, :rails_23 => true do
   describe ".initialize" do
     context "with a header filters" do
       around(:each) do |example|
-        old_header_filters = Timber::Config.instance.header_filters
-        Timber::Config.instance.header_filters += ['api-key']
+        old_http_header_filters = Timber::Config.instance.http_header_filters
+        Timber::Config.instance.http_header_filters += ['api-key']
         example.run
-        Timber::Config.instance.header_filters = old_header_filters
+        Timber::Config.instance.http_header_filters = old_http_header_filters
       end
 
       it "should sanitize headers when a config option is set" do

data/spec/timber/integrations/rack/http_events_spec.rb

@@ -0,0 +1,101 @@
+require "spec_helper"
+
+if defined?(::Rack)
+  describe Timber::Integrations::Rack::HTTPEvents do
+    let(:time) { Time.utc(2016, 9, 1, 12, 0, 0) }
+    let(:io) { StringIO.new }
+    let(:logger) do
+      logger = Timber::Logger.new(io)
+      logger.level = ::Logger::INFO
+      logger
+    end
+
+    around(:each) do |example|
+      class RackHttpController < ActionController::Base
+        layout nil
+
+        def index
+          Thread.current[:_timber_context_snapshot] = Timber::CurrentContext.instance.snapshot
+          render json: {}
+        end
+
+        def method_for_action(action_name)
+          action_name
+        end
+      end
+
+      ::RailsApp.routes.draw do
+        get '/rack_http' => 'rack_http#index'
+      end
+
+      with_rails_logger(logger) do
+        Timecop.freeze(time) { example.run }
+      end
+
+      Object.send(:remove_const, :RackHttpController)
+    end
+
+    describe "#process" do
+      it "should log the events" do
+        allow(Benchmark).to receive(:ms).and_return(1).and_yield
+
+        dispatch_rails_request("/rack_http")
+
+        lines = clean_lines(io.string.split("\n"))
+        expect(lines.length).to eq(3)
+
+        expect(lines[0]).to start_with("Started GET \"/rack_http\" @metadata ")
+        expect(lines[1]).to start_with("Processing by RackHttpController#index as HTML @metadata ")
+        expect(lines[2]).to start_with("Completed 200 OK in 0.0ms @metadata ")
+      end
+
+      context "with the route silenced" do
+        around(:each) do |example|
+          described_class.silence_request = lambda do |rack_env, rack_request|
+            rack_request.path == "/rack_http"
+          end
+
+          example.run
+
+          described_class.silence_request = nil
+        end
+
+        it "should silence the logs" do
+          allow(Benchmark).to receive(:ms).and_return(1).and_yield
+
+          dispatch_rails_request("/rack_http")
+
+          lines = clean_lines(io.string.split("\n"))
+          expect(lines.length).to eq(0)
+        end
+      end
+
+      context "collapsed into a single event" do
+        around(:each) do |example|
+          described_class.collapse_into_single_event = true
+
+          example.run
+
+          described_class.collapse_into_single_event = nil
+        end
+
+        it "should silence the logs" do
+          allow(Benchmark).to receive(:ms).and_return(1).and_yield
+
+          dispatch_rails_request("/rack_http")
+
+          lines = clean_lines(io.string.split("\n"))
+          expect(lines.length).to eq(2)
+
+          expect(lines[0]).to start_with("Processing by RackHttpController#index as HTML @metadata ")
+          expect(lines[1]).to start_with("GET /rack_http sent 200 OK in 0.0ms @metadata ")
+        end
+      end
+    end
+
+    # Remove blank lines since Rails does this to space out requests in the logs
+    def clean_lines(lines)
+      lines.select { |line| !line.start_with?(" @metadat") }
+    end
+  end
+end

data/spec/timber/log_devices/http_spec.rb

@@ -42,7 +42,7 @@ describe Timber::LogDevices::HTTP do
 
       it "should attempt a delivery when the limit is exceeded" do
         http.write("test")
-        expect(http).to receive(:flush).exactly(1).times
+        expect(http).to receive(:flush_async).exactly(1).times
         http.write("my log message")
         expect(http).to receive(:flush).exactly(1).times
         http.close
@@ -76,13 +76,29 @@ describe Timber::LogDevices::HTTP do
   describe "#flush" do
     let(:time) { Time.utc(2016, 9, 1, 12, 0, 0) }
 
-    it "should add a request to the queue" do
+    it "should deliver the request" do
       http = described_class.new("MYKEY", flush_continuously: false)
       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)
       http.write(log_entry)
+      expect(http).to receive(:flush_async).exactly(2).times
       http.send(:flush)
+      http.close
+    end
+  end
+
+  # Testing a private method because it helps break down our tests
+  describe "#flush_async" do
+    let(:time) { Time.utc(2016, 9, 1, 12, 0, 0) }
+
+    it "should add a request to the queue" do
+      http = described_class.new("MYKEY", flush_continuously: false)
+      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)
+      http.write(log_entry)
+      http.send(:flush_async)
       request_queue = http.instance_variable_get(:@request_queue)
       request = request_queue.deq
       expect(request).to be_kind_of(Net::HTTP::Post)
@@ -98,8 +114,8 @@ describe Timber::LogDevices::HTTP do
     it "should start a intervaled flush thread and flush on an interval" do
       http = described_class.new("MYKEY", flush_interval: 0.1)
       http.send(:ensure_flush_threads_are_started)
-      expect(http).to receive(:flush).exactly(2).times
-      sleep 0.15 # too fast!
+      expect(http).to receive(:flush_async).at_least(3).times
+      sleep 1.1 # iterations check every 0.5 seconds
       http.close
     end
   end

data/spec/timber/log_entry_spec.rb

@@ -6,7 +6,8 @@ describe Timber::LogEntry, :rails_23 => true do
   describe "#to_msgpack" do
     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})}
+      custom_context = Timber::Contexts::Custom.new(type: :context_type, data: {b: 1})
+      context = {custom: custom_context.as_json}
       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"))

data/spec/timber/logger_spec.rb

@@ -10,8 +10,8 @@ describe Timber::Logger, :rails_23 => true do
       Timecop.freeze(time) { example.run }
     end
 
-    context "with the StringFormatter" do
-      before(:each) { logger.formatter = Timber::Logger::StringFormatter.new }
+    context "with the AugmentedFormatter" do
+      before(:each) { logger.formatter = Timber::Logger::AugmentedFormatter.new }
 
       it "should accept strings" do
         logger.info("this is a test")
@@ -91,7 +91,7 @@ describe Timber::Logger, :rails_23 => true do
       end
     end
 
-    context "with the :json format" do
+    context "with the JSONFormatter" do
       before(:each) { logger.formatter = Timber::Logger::JSONFormatter.new }
 
       it "should log in the correct format" do
@@ -129,19 +129,19 @@ describe Timber::Logger, :rails_23 => true do
     let(:logger) { Timber::Logger.new(io) }
 
     it "should add context" do
-      expect(Timber::CurrentContext.hash).to eq({})
+      expect(Timber::CurrentContext.instance.send(:hash)).to eq({})
 
       logger.with_context(build: {version: "1.0.0"}) do
-        expect(Timber::CurrentContext.hash).to eq({:custom=>{:build=>{:version=>"1.0.0"}}})
+        expect(Timber::CurrentContext.instance.send(:hash)).to eq({:custom=>{:build=>{:version=>"1.0.0"}}})
 
         logger.with_context({testing: {key: "value"}}) do
-          expect(Timber::CurrentContext.hash).to eq({:custom=>{:build=>{:version=>"1.0.0"}, :testing=>{:key=>"value"}}})
+          expect(Timber::CurrentContext.instance.send(:hash)).to eq({:custom=>{:build=>{:version=>"1.0.0"}, :testing=>{:key=>"value"}}})
         end
 
-        expect(Timber::CurrentContext.hash).to eq({:custom=>{:build=>{:version=>"1.0.0"}}})
+        expect(Timber::CurrentContext.instance.send(:hash)).to eq({:custom=>{:build=>{:version=>"1.0.0"}}})
       end
 
-      expect(Timber::CurrentContext.hash).to eq({})
+      expect(Timber::CurrentContext.instance.send(:hash)).to eq({})
     end
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: timber
 version: !ruby/object:Gem::Version
-  version: 2.0.24
+  version: 2.1.0.rc1
 platform: ruby
 authors:
 - Timber Technologies, Inc.
@@ -134,10 +134,10 @@ files:
 - ".rspec"
 - ".travis.yml"
 - ".yardopts"
+- CHANGELOG
 - Gemfile
 - LICENSE.md
 - README.md
-- benchmarks/rails.rb
 - bin/timber
 - gemfiles/rails-3.0.gemfile
 - gemfiles/rails-3.1.gemfile
@@ -151,16 +151,27 @@ files:
 - lib/timber.rb
 - lib/timber/cli.rb
 - lib/timber/cli/api.rb
-- lib/timber/cli/application.rb
-- lib/timber/cli/install.rb
-- lib/timber/cli/io_helper.rb
-- lib/timber/cli/messages.rb
+- lib/timber/cli/api/application.rb
+- lib/timber/cli/config_file.rb
+- lib/timber/cli/file_helper.rb
+- lib/timber/cli/installer.rb
+- lib/timber/cli/installers.rb
+- lib/timber/cli/installers/other.rb
+- lib/timber/cli/installers/rails.rb
+- lib/timber/cli/installers/root.rb
+- lib/timber/cli/io.rb
+- lib/timber/cli/io/ansi.rb
+- lib/timber/cli/io/messages.rb
+- lib/timber/cli/os_helper.rb
 - lib/timber/config.rb
+- lib/timber/config/integrations.rb
+- lib/timber/config/integrations/rack.rb
 - lib/timber/context.rb
 - lib/timber/contexts.rb
 - lib/timber/contexts/custom.rb
 - lib/timber/contexts/http.rb
 - lib/timber/contexts/organization.rb
+- lib/timber/contexts/release.rb
 - lib/timber/contexts/runtime.rb
 - lib/timber/contexts/session.rb
 - lib/timber/contexts/system.rb
@@ -179,31 +190,41 @@ files:
 - lib/timber/events/template_render.rb
 - lib/timber/frameworks.rb
 - lib/timber/frameworks/rails.rb
+- lib/timber/integration.rb
 - lib/timber/integrations.rb
+- lib/timber/integrations/action_controller.rb
 - lib/timber/integrations/action_controller/log_subscriber.rb
 - lib/timber/integrations/action_controller/log_subscriber/timber_log_subscriber.rb
+- lib/timber/integrations/action_dispatch.rb
 - lib/timber/integrations/action_dispatch/debug_exceptions.rb
+- lib/timber/integrations/action_view.rb
 - lib/timber/integrations/action_view/log_subscriber.rb
 - lib/timber/integrations/action_view/log_subscriber/timber_log_subscriber.rb
+- lib/timber/integrations/active_record.rb
 - lib/timber/integrations/active_record/log_subscriber.rb
 - lib/timber/integrations/active_record/log_subscriber/timber_log_subscriber.rb
-- lib/timber/integrations/active_support/tagged_logging.rb
 - lib/timber/integrations/rack.rb
 - lib/timber/integrations/rack/exception_event.rb
 - lib/timber/integrations/rack/http_context.rb
 - lib/timber/integrations/rack/http_events.rb
+- lib/timber/integrations/rack/middleware.rb
 - lib/timber/integrations/rack/session_context.rb
 - lib/timber/integrations/rack/user_context.rb
+- lib/timber/integrations/rails.rb
 - lib/timber/integrations/rails/rack_logger.rb
 - lib/timber/integrator.rb
 - lib/timber/log_devices.rb
 - lib/timber/log_devices/http.rb
+- lib/timber/log_devices/http/dropping_sized_queue.rb
+- lib/timber/log_devices/http/flushable_sized_queue.rb
 - lib/timber/log_entry.rb
 - lib/timber/logger.rb
 - lib/timber/overrides.rb
+- lib/timber/overrides/active_support_3_tagged_logging.rb
 - lib/timber/overrides/active_support_tagged_logging.rb
 - lib/timber/overrides/lograge.rb
 - lib/timber/overrides/rails_stdout_logging.rb
+- lib/timber/timer.rb
 - lib/timber/util.rb
 - lib/timber/util/active_support_log_subscriber.rb
 - lib/timber/util/hash.rb
@@ -225,6 +246,9 @@ files:
 - spec/support/timber.rb
 - spec/support/timecop.rb
 - spec/support/webmock.rb
+- spec/timber/cli/installers/rails_spec.rb
+- spec/timber/cli/installers/root_spec.rb
+- spec/timber/config_spec.rb
 - spec/timber/contexts/custom_spec.rb
 - spec/timber/contexts/organization_spec.rb
 - spec/timber/contexts/system_spec.rb
@@ -234,6 +258,7 @@ files:
 - spec/timber/event_spec.rb
 - spec/timber/events/controller_call_spec.rb
 - spec/timber/events/custom_spec.rb
+- spec/timber/events/exception_spec.rb
 - spec/timber/events/http_server_request_spec.rb
 - spec/timber/events_spec.rb
 - spec/timber/integrations/action_controller/log_subscriber_spec.rb
@@ -241,6 +266,7 @@ files:
 - spec/timber/integrations/action_view/log_subscriber_spec.rb
 - spec/timber/integrations/active_record/log_subscriber_spec.rb
 - spec/timber/integrations/rack/http_context_spec.rb
+- spec/timber/integrations/rack/http_events_spec.rb
 - spec/timber/integrations/rails/rack_logger_spec.rb
 - spec/timber/log_devices/http_spec.rb
 - spec/timber/log_entry_spec.rb
@@ -262,9 +288,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 1.9.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.4.5.2
@@ -284,6 +310,9 @@ test_files:
 - spec/support/timber.rb
 - spec/support/timecop.rb
 - spec/support/webmock.rb
+- spec/timber/cli/installers/rails_spec.rb
+- spec/timber/cli/installers/root_spec.rb
+- spec/timber/config_spec.rb
 - spec/timber/contexts/custom_spec.rb
 - spec/timber/contexts/organization_spec.rb
 - spec/timber/contexts/system_spec.rb
@@ -293,6 +322,7 @@ test_files:
 - spec/timber/event_spec.rb
 - spec/timber/events/controller_call_spec.rb
 - spec/timber/events/custom_spec.rb
+- spec/timber/events/exception_spec.rb
 - spec/timber/events/http_server_request_spec.rb
 - spec/timber/events_spec.rb
 - spec/timber/integrations/action_controller/log_subscriber_spec.rb
@@ -300,6 +330,7 @@ test_files:
 - spec/timber/integrations/action_view/log_subscriber_spec.rb
 - spec/timber/integrations/active_record/log_subscriber_spec.rb
 - spec/timber/integrations/rack/http_context_spec.rb
+- spec/timber/integrations/rack/http_events_spec.rb
 - spec/timber/integrations/rails/rack_logger_spec.rb
 - spec/timber/log_devices/http_spec.rb
 - spec/timber/log_entry_spec.rb

data/benchmarks/rails.rb

@@ -1,122 +0,0 @@
-require 'benchmark'
-require 'benchmark-memory'
-require 'bundler/setup'
-require 'rails'
-require 'action_controller'
-
-io = StringIO.new # ensure we are logging to something
-logger = Logger.new(io)
-logger.level = Logger::DEBUG
-Rails.logger = logger
-
-#
-# Setup
-#
-
-# Setup the rails app to test
-class RailsApp < Rails::Application
-  if ::Rails.version =~ /^3\./
-    config.secret_token = '1e05af2b349457936a41427e63450937'
-  else
-    config.secret_key_base = '1e05af2b349457936a41427e63450937'
-  end
-
-  # This ensures our tests fail, otherwise exceptions get swallowed by ActionDispatch::DebugExceptions
-  config.action_dispatch.show_exceptions = false
-  config.active_support.deprecation = :stderr
-  config.eager_load = false
-end
-
-# Create a controller to test against
-class HomeController < ActionController::Base
-  layout nil
-
-  def index
-    render json: {}
-  end
-
-  def method_for_action(action_name)
-    action_name
-  end
-end
-
-# Define the routes
-::RailsApp.routes.draw do
-  get '/' => 'home#index'
-end
-
-# Initialize the app
-RailsApp.initialize!
-
-# Helper function to issue requests.
-def dispatch_rails_request(path, additional_env_options = {})
-  application = ::Rails.application
-  env = application.respond_to?(:env_config) ? application.env_config.clone : application.env_defaults.clone
-  env["rack.request.cookie_hash"] = {}.with_indifferent_access
-  env["REMOTE_ADDR"] = "123.456.789.10"
-  env["HTTP_X_REQUEST_ID"] = "unique-request-id-1234"
-  env["action_dispatch.request_id"] = env["HTTP_X_REQUEST_ID"]
-  env = env.merge(additional_env_options)
-  ::Rack::MockRequest.new(application).get(path, env)
-end
-
-# How many iterations to perform
-iterations = 1_000
-
-puts "############################################################"
-puts ""
-puts "Testing Without Timber (#{iterations} iterations)"
-puts ""
-puts "############################################################"
-puts
-
-# Use bmbm to mimimize initial GC differences.
-puts "Timing via benchmark:"
-puts ""
-
-Benchmark.bmbm do |x|
-  x.report("Without Timber") { iterations.times { dispatch_rails_request("/") } }
-end
-
-puts "\n"
-puts "Memory profiling via benchmark-memory:"
-puts
-
-Benchmark.memory do |x|
-  x.report("Without Timber") { iterations.times { dispatch_rails_request("/") } }
-end
-
-puts "\n\n\n\n"
-puts "############################################################"
-puts ""
-puts "Testing With Timber (#{iterations} iterations)"
-puts ""
-puts "############################################################"
-puts ""
-
-# Integrate Timber (this is handled in our Railtie, but we cna't use that here since we already
-# initialized the app.)
-require 'timber'
-io = StringIO.new # ensure we are logging to something
-logger = Timber::Logger.new(io)
-logger.level = Logger::DEBUG
-Timber::Frameworks::Rails.set_logger(logger)
-Timber::Frameworks::Rails.configure_middlewares(Rails.application.config.app_middleware)
-Timber::Integrations.integrate!
-Timber::Config.instance.append_metadata = false
-
-
-puts "Timing via benchmark:"
-puts ""
-
-Benchmark.bmbm do |x|
-  x.report("With Timber")  { iterations.times { dispatch_rails_request("/") } }
-end
-
-puts "\n"
-puts "Memory profiling via benchmark-memory:"
-puts ""
-
-Benchmark.memory do |x|
-  x.report("With Timber") { iterations.times { dispatch_rails_request("/") } }
-end