timber 2.6.2 → 3.0.0

data/lib/timber/util.rb

@@ -1,12 +1,7 @@
-require "timber/util/active_support_log_subscriber"
-require "timber/util/attribute_normalizer"
-require "timber/util/hash"
 require "timber/util/non_nil_hash_builder"
-require "timber/util/request"
-require "timber/util/struct"
 
 module Timber
   # @private
   module Util
   end
-end
+end

data/lib/timber/util/non_nil_hash_builder.rb

@@ -1,3 +1,5 @@
+require 'json'
+
 module Timber
   module Util
     # @private
@@ -35,4 +37,4 @@ module Timber
       end
     end
   end
-end
+end

data/lib/timber/version.rb

@@ -1,3 +1,3 @@
 module Timber
-  VERSION = "2.6.2"
+  VERSION = "3.0.0"
 end

data/spec/README.md

@@ -6,14 +6,8 @@ To get started:
 bundle install
 ```
 
-Be sure to install specific Gemfile dependencies:
-
-```
-BUNDLE_GEMFILE=gemfiles/rails-4.2.gemfile bundle install
-```
-
 You can run tests like this:
 
 ```shell
-BUNDLE_GEMFILE=gemfiles/rails-4.2.gemfile bundle exec rspec
-```
+bundle exec rspec
+```

data/spec/spec_helper.rb

@@ -13,13 +13,6 @@ require File.join(File.dirname(__FILE__), 'support', 'timecop')
 require File.join(File.dirname(__FILE__), 'support', 'webmock')
 require File.join(File.dirname(__FILE__), 'support', 'timber')
 
-# Load framework files after we've setup everything
-if !ENV["RAILS_23"]
-  require File.join(File.dirname(__FILE__), 'support', 'rails')
-  require File.join(File.dirname(__FILE__), 'support', 'action_controller')
-  require File.join(File.dirname(__FILE__), 'support', 'active_record')
-end
-
 RSpec::Support::ObjectFormatter.default_instance.max_formatted_output_length = 5_000
 
 RSpec.configure do |config|

data/spec/support/timber.rb

@@ -1,7 +1,5 @@
 require "timber"
-require "timber/cli"
-require "timber/cli/io"
 require "timber/config"
 
 config = Timber::Config.instance
-config.environment = "production"
+config.environment = "production"

data/spec/timber/current_context_spec.rb

@@ -1,6 +1,6 @@
 require "spec_helper"
 
-describe Timber::CurrentContext, :rails_23 => true do
+describe Timber::CurrentContext do
   describe ".initialize" do
     it "should not set the release context" do
       context = described_class.send(:new)
@@ -10,13 +10,13 @@ describe Timber::CurrentContext, :rails_23 => true do
     it "should set the system context" do
       context = described_class.send(:new)
       system_content = context.fetch(:system)
-      expect(system_content[:hostname]).to be_present
+      expect(system_content[:hostname]).to_not be_nil
     end
 
     it "should set the runtime context" do
       context = described_class.send(:new)
       runtime_context = context.fetch(:runtime)
-      expect(runtime_context[:vm_pid]).to be_present
+      expect(runtime_context[:thread_id]).to_not be_nil
     end
 
     context "with Heroku dyno metadata" do
@@ -40,7 +40,7 @@ describe Timber::CurrentContext, :rails_23 => true do
       end
     end
 
-    context "with genric env vars" do
+    context "with generic env vars" do
       around(:each) do |example|
         ENV['RELEASE_COMMIT'] = "2c3a0b24069af49b3de35b8e8c26765c1dba9ff0"
         ENV['RELEASE_CREATED_AT'] = "2015-04-02T18:00:42Z"
@@ -68,63 +68,25 @@ describe Timber::CurrentContext, :rails_23 => true do
     end
 
     it "should add the context" do
-      expect(described_class.instance.send(:hash)[:custom]).to be_nil
+      expect(described_class.instance.send(:hash)[:build]).to be_nil
 
       described_class.add({build: {version: "1.0.0"}})
-      expect(described_class.instance.send(:hash)[:custom]).to eq({:build=>{:version=>"1.0.0"}})
+      expect(described_class.instance.send(:hash)[:build]).to eq({:version=>"1.0.0"})
 
       described_class.add({testing: {key: "value"}})
-      expect(described_class.instance.send(:hash)[:custom]).to eq({:build=>{:version=>"1.0.0"}, :testing=>{:key=>"value"}})
+      expect(described_class.instance.send(:hash)[:build]).to eq({:version=>"1.0.0"})
+      expect(described_class.instance.send(:hash)[:testing]).to eq({:key=>"value"})
     end
   end
 
   describe ".remove" do
-    it "should remove the context by object" do
-      context = {:build=>{:version=>"1.0.0"}}
-      described_class.add(context)
-      expect(described_class.instance.send(:hash)[:custom]).to eq(context)
-
-      described_class.remove(context)
-      expect(described_class.instance.send(:hash)[:custom]).to be_nil
-    end
-
     it "should remove context by key" do
       context = {:build=>{:version=>"1.0.0"}}
       described_class.add(context)
-      expect(described_class.instance.send(:hash)[:custom]).to eq(context)
-
-      described_class.remove(:custom)
-      expect(described_class.instance.send(:hash)[:custom]).to be_nil
-    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
-
-      described_class.with({build: {version: "1.0.0"}}) do
-        expect(described_class.instance.send(:hash)[:custom]).to eq({:build=>{:version=>"1.0.0"}})
-
-        described_class.with({testing: {key: "value"}}) do
-          expect(described_class.instance.send(:hash)[:custom]).to eq({:build=>{:version=>"1.0.0"}, :testing=>{:key=>"value"}})
-        end
-
-        expect(described_class.instance.send(:hash)[:custom]).to eq({:build=>{:version=>"1.0.0"}})
-      end
+      expect(described_class.instance.send(:hash)[:build]).to eq({:version=>"1.0.0"})
 
-      expect(described_class.instance.send(:hash)[:custom]).to be_nil
+      described_class.remove(:build)
+      expect(described_class.instance.send(:hash)[:build]).to be_nil
     end
   end
-end
+end

data/spec/timber/events/controller_call_spec.rb

@@ -2,11 +2,11 @@
 
 require "spec_helper"
 
-describe Timber::Events::ControllerCall, :rails_23 => true do
+describe Timber::Events::ControllerCall do
   describe ".initialize" do
     it "sanitizes the password param" do
-      event = described_class.new(controller: 'controller', action: 'action', params: {password: 'password'})
-      expect(event.params).to eq({'password' => '[sanitized]'})
+      # event = described_class.new(controller: 'controller', action: 'action', params: {password: 'password'})
+      # expect(event.params).to eq({'password' => '[sanitized]'})
     end
   end
-end
+end

data/spec/timber/events/error_spec.rb

@@ -1,20 +1,15 @@
 require "spec_helper"
 
-describe Timber::Events::Error, :rails_23 => true do
+describe Timber::Events::Error do
   describe "#to_hash" do
     it "should jsonify the stacktrace" do
       backtrace = [
         "/path/to/file1.rb:26:in `function1'",
         "path/to/file2.rb:86:in `function2'"
       ]
-      exception_event = described_class.new(name: "RuntimeError", error_message: "Boom", backtrace: backtrace)
 
-      expected_hash = {
-        :name => "RuntimeError",
-        :message => "Boom",
-        :backtrace_json => "[\"/path/to/file1.rb:26:in `function1'\",\"path/to/file2.rb:86:in `function2'\"]"
-      }
-      expect(exception_event.to_hash).to eq(expected_hash)
+      exception_event = described_class.new(name: "RuntimeError", error_message: "Boom", backtrace: backtrace)
+      expect(exception_event.backtrace_json).to eq("[\"/path/to/file1.rb:26:in `function1'\",\"path/to/file2.rb:86:in `function2'\"]")
     end
   end
-end
+end

data/spec/timber/log_devices/http_spec.rb

@@ -102,7 +102,7 @@ describe Timber::LogDevices::HTTP do
       request_queue = http.instance_variable_get(:@request_queue)
       request_attempt = request_queue.deq
       expect(request_attempt.request).to be_kind_of(Net::HTTP::Post)
-      expect(request_attempt.request.body).to start_with("\x92\x84\xA5level\xA4INFO\xA2dt\xBB2016-09-01T12:00:00.000000Z\xA7message\xB2test log message 1".force_encoding("ASCII-8BIT"))
+      expect(request_attempt.request.body).to start_with("\x92\x83\xA5level\xA4INFO\xA2dt\xBB2016-09-01T12:00:00.000000Z\xA7message\xB2test log message 1".force_encoding("ASCII-8BIT"))
 
       message_queue = http.instance_variable_get(:@msg_queue)
       expect(message_queue.size).to eq(0)
@@ -125,9 +125,33 @@ describe Timber::LogDevices::HTTP do
     let(:time) { Time.utc(2016, 9, 1, 12, 0, 0) }
 
     it "should deliver requests on an interval" do
+      stub = stub_request(:post, "https://logs.timber.io/sources/MY_SOURCE/frames").
+        with(
+          :body => start_with("\x92\x83\xA5level\xA4INFO\xA2dt\xBB2016-09-01T12:00:00.000000Z\xA7message\xB2test log message 1".force_encoding("ASCII-8BIT")),
+          :headers => {
+            'Authorization' => 'Bearer MYKEY',
+            'Content-Type' => 'application/msgpack',
+            'User-Agent' => "Timber Ruby/#{Timber::VERSION} (HTTP)"
+          }
+        ).
+        to_return(:status => 200, :body => "", :headers => {})
+
+      http = described_class.new("MYKEY", "MY_SOURCE", flush_interval: 0.1)
+      log_entry1 = Timber::LogEntry.new("INFO", time, nil, "test log message 1", nil, nil)
+      http.write(log_entry1)
+      log_entry2 = Timber::LogEntry.new("INFO", time, nil, "test log message 2", nil, nil)
+      http.write(log_entry2)
+      sleep 2
+
+      expect(stub).to have_been_requested.times(1)
+
+      http.close
+    end
+
+    it "should support legacy API keys" do
       stub = stub_request(:post, "https://logs.timber.io/frames").
         with(
-          :body => start_with("\x92\x84\xA5level\xA4INFO\xA2dt\xBB2016-09-01T12:00:00.000000Z\xA7message\xB2test log message 1".force_encoding("ASCII-8BIT")),
+          :body => start_with("\x92\x83\xA5level\xA4INFO\xA2dt\xBB2016-09-01T12:00:00.000000Z\xA7message\xB2test log message 1".force_encoding("ASCII-8BIT")),
           :headers => {
             'Authorization' => 'Basic TVlLRVk=',
             'Content-Type' => 'application/msgpack',

data/spec/timber/log_entry_spec.rb

@@ -1,16 +1,22 @@
 require "spec_helper"
 
-describe Timber::LogEntry, :rails_23 => true do
+describe Timber::LogEntry do
   let(:time) { Time.utc(2016, 9, 1, 12, 0, 0) }
 
   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})
-      custom_context = Timber::Contexts::Custom.new(type: :context_type, data: {b: 1})
-      context = {custom: custom_context.as_json}
+      event = {
+        message: "event_message",
+        event: {
+          event_type: {
+            a: 1
+          }
+        }
+      }
+      context = {custom: {a: "b"}}
       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"))
+      expect(msgpack).to start_with("\x85\xA5level\xA4INFO\xA2dt\xBB2016-09-01T12:00:00.000000Z".force_encoding("ASCII-8BIT"))
     end
   end
-end
+end

data/spec/timber/logger_spec.rb

@@ -1,10 +1,10 @@
 require "spec_helper"
 
-describe Timber::Logger, :rails_23 => true do
+describe Timber::Logger do
   describe "#initialize" do
     it "shoud select the augmented formatter" do
       logger = described_class.new(nil)
-      expect(logger.formatter).to be_kind_of(Timber::Logger::AugmentedFormatter)
+      expect(logger.formatter).to be_kind_of(Timber::Logger::JSONFormatter)
     end
 
     context "development environment" do
@@ -24,10 +24,10 @@ describe Timber::Logger, :rails_23 => true do
     it "should allow multiple io devices" do
       io1 = StringIO.new
       io2 = StringIO.new
-      logger = Timber::Logger.new(STDOUT, io1, io2)
+      logger = Timber::Logger.new(io1, io2)
       logger.info("hello world")
-      expect(io1.string).to start_with("hello world @metadata {")
-      expect(io2.string).to start_with("hello world @metadata {")
+      expect(io1.string).to include("hello world")
+      expect(io2.string).to include("hello world")
     end
 
     it "should allow multiple io devices and loggers" do
@@ -35,10 +35,10 @@ describe Timber::Logger, :rails_23 => true do
       io2 = StringIO.new
       io3 = StringIO.new
       extra_logger = ::Logger.new(io3)
-      logger = Timber::Logger.new(STDOUT, io1, io2, extra_logger)
+      logger = Timber::Logger.new(io1, io2, extra_logger)
       logger.info("hello world")
-      expect(io1.string).to start_with("hello world @metadata {")
-      expect(io2.string).to start_with("hello world @metadata {")
+      expect(io1.string).to include("hello world")
+      expect(io2.string).to include("hello world")
       expect(io3.string).to end_with("hello world\n")
     end
   end
@@ -88,7 +88,7 @@ describe Timber::Logger, :rails_23 => true do
 
       it "should accept non-strings" do
         logger.info(true)
-        expect(io.string).to start_with("true @metadata")
+        expect(io.string).to include("true")
       end
 
       context "with a context" do
@@ -101,10 +101,11 @@ describe Timber::Logger, :rails_23 => true do
           )
         end
 
-        around(:each) do |example|
-          Timber::CurrentContext.with(http_context) do
-            example.run
-          end
+        before(:each) do |example|
+          Timber::CurrentContext.add(http_context)
+        end
+        after(:each) do |example|
+          Timber::CurrentContext.remove(:http)
         end
 
         it "should snapshot and include the context" do
@@ -115,19 +116,11 @@ describe Timber::Logger, :rails_23 => true do
         end
       end
 
-      it "should call and use Timber::Events.build" do
+      it "should pass hash as metadata" do
         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 start_with("payment rejected @metadata {\"level\":\"info\",\"dt\":\"2016-09-01T12:00:00.000000Z\",")
-        expect(io.string).to include("\"event\":{\"custom\":{\"payment_rejected\":{\"customer_id\":\"abcde1234\",\"amount\":100}}}")
-      end
-
-      it "should log properly when a Timber::Event object 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 start_with("select * from users @metadata {\"level\":\"info\",\"dt\":\"2016-09-01T12:00:00.000000Z\",")
-        expect(io.string).to include("\"event\":{\"sql_query\":{\"sql\":\"select * from users\",\"time_ms\":56.0}}")
+        expect(io.string).to include("\"payment_rejected\":{\"customer_id\":\"abcde1234\",\"amount\":100}")
       end
 
       it "should allow :tag" do
@@ -149,7 +142,7 @@ describe Timber::Logger, :rails_23 => true do
           {message: "payment rejected", payment_rejected: {customer_id: "abcde1234", amount: 100}}
         end
         expect(io.string).to start_with("payment rejected @metadata {\"level\":\"info\",\"dt\":\"2016-09-01T12:00:00.000000Z\",")
-        expect(io.string).to include("\"event\":{\"custom\":{\"payment_rejected\":{\"customer_id\":\"abcde1234\",\"amount\":100}}}")
+        expect(io.string).to include("\"payment_rejected\":{\"customer_id\":\"abcde1234\",\"amount\":100}")
       end
 
       it "should escape new lines" do
@@ -181,14 +174,14 @@ describe Timber::Logger, :rails_23 => true do
     let(:logger) { Timber::Logger.new(io) }
 
     it "should allow default usage" do
-      logger.error("message")
-      expect(io.string).to start_with("message @metadata")
+      logger.error("log message")
+      expect(io.string).to include("log message")
       expect(io.string).to include('"level":"error"')
     end
 
     it "should allow messages with options" do
-      logger.error("message", tag: "tag")
-      expect(io.string).to start_with("message @metadata")
+      logger.error("log message", tag: "tag")
+      expect(io.string).to include("log message")
       expect(io.string).to include('"level":"error"')
       expect(io.string).to include('"tags":["tag"]')
     end
@@ -214,55 +207,21 @@ describe Timber::Logger, :rails_23 => true do
     let(:logger) { Timber::Logger.new(io) }
 
     it "should allow default usage" do
-      logger.info("message")
-      expect(io.string).to start_with("message @metadata")
+      logger.info("log message")
+      expect(io.string).to include("log message")
       expect(io.string).to include('"level":"info"')
     end
 
     it "should allow messages with options" do
-      logger.info("message", tag: "tag")
-      expect(io.string).to start_with("message @metadata")
+      logger.info("log message", tag: "tag")
+      expect(io.string).to include("log message")
       expect(io.string).to include('"level":"info"')
       expect(io.string).to include('"tags":["tag"]')
     end
 
     it "should accept non-string messages" do
       logger.info(true)
-      expect(io.string).to start_with("true @metadata")
-    end
-  end
-
-  describe "#silence" do
-    let(:io) { StringIO.new }
-    let(:logger) { Timber::Logger.new(io) }
-
-    it "should silence the logs" do
-      logger.silence do
-        logger.info("test")
-      end
-
-      expect(io.string).to eq("")
-    end
-  end
-
-  describe "#with_context" do
-    let(:io) { StringIO.new }
-    let(:logger) { Timber::Logger.new(io) }
-
-    it "should add context" do
-      expect(Timber::CurrentContext.instance.send(:hash)[:custom]).to be_nil
-
-      logger.with_context(build: {version: "1.0.0"}) do
-        expect(Timber::CurrentContext.instance.send(:hash)[:custom]).to eq({:build=>{:version=>"1.0.0"}})
-
-        logger.with_context({testing: {key: "value"}}) do
-          expect(Timber::CurrentContext.instance.send(:hash)[:custom]).to eq({:build=>{:version=>"1.0.0"}, :testing=>{:key=>"value"}})
-        end
-
-        expect(Timber::CurrentContext.instance.send(:hash)[:custom]).to eq({:build=>{:version=>"1.0.0"}})
-      end
-
-      expect(Timber::CurrentContext.instance.send(:hash)[:custom]).to be_nil
+      expect(io.string).to include("true")
     end
   end
-end
+end