timber 2.6.0.pre.beta1 → 2.6.0.pre.beta2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 10838667c7f285fea9c51270f12594b2106299e1
-  data.tar.gz: f91eaaac75c0ed243686771c415a3f44d6c431b3
+  metadata.gz: 52dde0fadd6632da69428d41199325ddebf0e6a4
+  data.tar.gz: 4f313fdc346a21c1a5ad34ceb384068bab70a6d1
 SHA512:
-  metadata.gz: 8cc093229929a57566e15f4fe81a9f2fbf36c0259a85123e43cbe077e9a14828147620b60be1a7953560ac691923146dcccb2075adbe64fb331bae9a1e388206
-  data.tar.gz: 5478c747ded3aa62d3fcf0b877e5e09bccafb94c72e1b4812b2dea0cac2aa5fe2e86435532c66f16b35596178c64d2502a40687fe97437f13e6db641cbb296b8
+  metadata.gz: c851eb624acd150eb033bbcdc31685916112ba8d0e69816955d6b66b056cb0aadba55231519299ce409ca487c33e01f6fa0168a7c982734c95c1434830280a4c
+  data.tar.gz: 20143122643afb851984e7b44cf3f52a6cdf300b8a15e21df332c83f0e1dcd6bbd6881c2acb01dedf3e59dde85b604c2d03a6eb075a921aeccb7c269278baa0a

data/CHANGELOG.md

@@ -7,6 +7,12 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## [Unreleased]
 
+## [2.6.0-beta2] - 2017-11-16
+
+### Fixed
+
+  - Fixes an issue where a reference to the current custom context map was being capture during log line creation and then later self-modifying to make the context invalid.
+
 ## [2.6.0-beta1] - 2017-10-28
 
 ### Fixed
@@ -14,6 +20,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
   - Encoding and rewind issues for file upload parameters have been resolved. Timber
     improved attribute normalization across all contexts and events, ignoring binary
     values like this in general.
+  - Fixes `::ActionDispatch::ExceptionWrapper` version detection preventing the `undefined method clean for #<Hash:->` error when an exception is raised in a Rack request.
 
 ## [2.5.1] - 2017-10-27
 
@@ -111,7 +118,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
     instead of applying back pressure.
 
 
-[Unreleased]: https://github.com/timberio/timber-ruby/compare/v2.6.0-beta1...HEAD
+[Unreleased]: https://github.com/timberio/timber-ruby/compare/v2.6.0-beta2...HEAD
+[2.6.0-beta2]: https://github.com/timberio/timber-ruby/compare/v2.6.0-beta1...v2.6.0-beta2
 [2.6.0-beta1]: https://github.com/timberio/timber-ruby/compare/v2.5.1...v2.6.0-beta1
 [2.5.1]: https://github.com/timberio/timber-ruby/compare/v2.5.0...v2.5.1
 [2.5.0]: https://github.com/timberio/timber-ruby/compare/v2.4.0...v2.5.0

data/lib/timber/current_context.rb

@@ -120,7 +120,13 @@ module Timber
     # since the context can change as execution proceeds. Note that individual contexts
     # should be immutable, and we implement snapshot caching as a result of this assumption.
     def snapshot
-      @snapshot ||= hash.clone
+      @snapshot ||= begin
+        snapshot = hash.clone
+        if snapshot.key?(:custom)
+          snapshot[:custom] = hash[:custom].clone
+        end
+        snapshot
+      end
     end
 
     private

data/lib/timber/events/error.rb

@@ -16,7 +16,7 @@ module Timber
       def initialize(attributes)
         normalizer = Util::AttributeNormalizer.new(attributes)
         @name = normalizer.fetch!(:name, :string)
-        @error_message = normalizer.fetch!(:error_message, :string, :limit => MESSAGE_MAX_BYTES)
+        @error_message = normalizer.fetch(:error_message, :string, :limit => MESSAGE_MAX_BYTES)
         @backtrace = normalizer.fetch(:backtrace, :array)
       end
 
@@ -35,7 +35,13 @@ module Timber
       end
 
       def message
-        "#{name} (#{error_message})"
+        message = "#{name}"
+
+        if !error_message.nil?
+          message << " (#{error_message})"
+        end
+
+        message
       end
     end
   end

data/lib/timber/integrations/rack/error_event.rb

@@ -18,11 +18,8 @@ module Timber
       # {Timber::Events::Error}.
       class ErrorEvent < Middleware
         # We determine this when the app loads to avoid the overhead on a per request basis.
-        EXCEPTION_WRAPPER_TAKES_CLEANER = if Gem.loaded_specs["rails"]
-          Gem.loaded_specs["rails"].version >= Gem::Version.new('5.0.0')
-        else
-          false
-        end
+        EXCEPTION_WRAPPER_TAKES_CLEANER = defined?(::ActionDispatch::ExceptionWrapper) &&
+          !::ActionDispatch::ExceptionWrapper.instance_methods.include?(:env)
 
         def call(env)
           begin

data/lib/timber/log_devices/http.rb

@@ -147,6 +147,7 @@ module Timber
           req['Authorization'] = authorization_payload
           req['Content-Type'] = CONTENT_TYPE
           req['User-Agent'] = USER_AGENT
+
           req.body = msgs.to_msgpack
           req
         end

data/lib/timber/util/attribute_normalizer.rb

@@ -14,7 +14,6 @@ module Timber
       def fetch!(key, type, options = {})
         v = fetch(key, type, options)
         if v.nil?
-          raise @attributes.inspect
           raise ArgumentError.new("The #{key.inspect} attribute is required")
         end
         v

data/lib/timber/version.rb

@@ -1,3 +1,3 @@
 module Timber
-  VERSION = "2.6.0-beta1"
+  VERSION = "2.6.0-beta2"
 end

data/spec/timber/current_context_spec.rb

@@ -98,6 +98,18 @@ describe Timber::CurrentContext, :rails_23 => true do
     end
   end
 
+  describe ".snapshot" do
+    it "shoud properly snapshot custom contexts" do
+      snapshot = nil
+
+      described_class.with({build: {version: "1.0.0"}}) do
+        snapshot = described_class.instance.snapshot
+      end
+
+      expect(snapshot[:custom]).to eq({:build=>{:version=>"1.0.0"}})
+    end
+  end
+
   describe ".with" do
     it "should merge the context and cleanup on block exit" do
       expect(described_class.instance.send(:hash)[:custom]).to be_nil

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

@@ -0,0 +1,63 @@
+require "spec_helper"
+
+if defined?(::Rack)
+  describe Timber::Integrations::Rack::ErrorEvent 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 RackErrorController < ActionController::Base
+        layout nil
+
+        hook_name = respond_to?(:before_action) ? "before_action" : "before_filter"
+        send(hook_name) do
+          raise "Boom!"
+        end
+
+        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_error' => 'rack_error#index'
+      end
+
+      with_rails_logger(logger) do
+        Timecop.freeze(time) { example.run }
+      end
+
+      Object.send(:remove_const, :RackErrorController)
+    end
+
+    describe "#process" do
+      it "should log the exception" do
+        allow(Benchmark).to receive(:ms).and_return(1).and_yield
+
+        expect { dispatch_rails_request("/rack_error") }.to raise_error(RuntimeError)
+
+        lines = clean_lines(io.string.split("\n"))
+        expect(lines.length).to eq(3)
+
+        expect(lines[0]).to start_with("Started GET \"/rack_error\" @metadata ")
+        expect(lines[1]).to start_with("Processing by RackErrorController#index as HTML @metadata ")
+        expect(lines[2]).to start_with("RuntimeError (Boom!) @metadata")
+      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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: timber
 version: !ruby/object:Gem::Version
-  version: 2.6.0.pre.beta1
+  version: 2.6.0.pre.beta2
 platform: ruby
 authors:
 - Timber Technologies, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-28 00:00:00.000000000 Z
+date: 2017-11-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: msgpack
@@ -284,6 +284,7 @@ files:
 - spec/timber/integrations/action_dispatch/debug_exceptions_spec.rb
 - spec/timber/integrations/action_view/log_subscriber_spec.rb
 - spec/timber/integrations/active_record/log_subscriber_spec.rb
+- spec/timber/integrations/rack/error_event_spec.rb
 - spec/timber/integrations/rack/http_context_spec.rb
 - spec/timber/integrations/rack/http_events_spec.rb
 - spec/timber/integrations/rack/session_context_spec.rb
@@ -354,6 +355,7 @@ test_files:
 - spec/timber/integrations/action_dispatch/debug_exceptions_spec.rb
 - spec/timber/integrations/action_view/log_subscriber_spec.rb
 - spec/timber/integrations/active_record/log_subscriber_spec.rb
+- spec/timber/integrations/rack/error_event_spec.rb
 - spec/timber/integrations/rack/http_context_spec.rb
 - spec/timber/integrations/rack/http_events_spec.rb
 - spec/timber/integrations/rack/session_context_spec.rb