timber 1.1.14 → 2.0.0

data/lib/timber/probes/rails_rack_logger.rb

@@ -1,77 +0,0 @@
-module Timber
-  module Probes
-    # Responsible for automatically tracking the http request events for applications
-    # that use `Rack`.
-    class RailsRackLogger < Probe
-      module InstanceMethods
-        def self.included(klass)
-          klass.class_eval do
-            protected
-              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
-              elsif klass.method_defined?(:before_dispatch)
-                def before_dispatch(env)
-                  request = ActionDispatch::Request.new(env)
-                  info do
-                    http_request_event(request)
-                  end
-                end
-              end
-
-              def http_request_event(request)
-                # No idea why rails 3.X returns a "/" :/
-                referrer = request.referer == "/" ? nil : request.referer
-                Events::HTTPServerRequest.new(
-                  content_type: request.content_type,
-                  host: request.host,
-                  method: request.request_method,
-                  path: request.filtered_path,
-                  port: request.port,
-                  query_string: request.query_string,
-                  remote_addr: request.ip,
-                  referrer: referrer,
-                  request_id: request_id(request.env),
-                  scheme: request.scheme,
-                  user_agent: request.user_agent
-                )
-              end
-
-              def request_id(env)
-                env["X-Request-ID"] ||
-                  env["X-Request-Id"] ||
-                  env["action_dispatch.request_id"]
-              end
-          end
-        end
-      end
-
-      module BeforeDispatchInstanceMethods
-        def self.included(klass)
-          klass.class_eval do
-            protected
-              def before_dispatch(env)
-                request = ActionDispatch::Request.new(env)
-                path = request.filtered_path
-
-                info "\n\nStarted #{request.request_method} \"#{path}\" " \
-                     "for #{request.ip} at #{Time.now.to_default_s}"
-              end
-          end
-        end
-      end
-
-      def initialize
-        require "rails/rack/logger"
-      rescue LoadError => e
-        raise RequirementNotMetError.new(e.message)
-      end
-
-      def insert!
-        return true if ::Rails::Rack::Logger.include?(InstanceMethods)
-        ::Rails::Rack::Logger.send(:include, InstanceMethods)
-      end
-    end
-  end
-end

data/lib/timber/rack_middlewares.rb

@@ -1,12 +0,0 @@
-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

@@ -1,30 +0,0 @@
-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/spec/support/action_view.rb

@@ -1,4 +0,0 @@
-require "action_view"
-
-# Needed for the ActionView::LogSubscriber. If a logger is not present, nothing will be logged.
-ActionView::Base.logger = Rails.logger if ActionView::Base.respond_to?(:logger=)

data/spec/support/coveralls.rb

@@ -1,2 +0,0 @@
-require 'coveralls'
-Coveralls.wear!

data/spec/support/simplecov.rb

@@ -1,9 +0,0 @@
-require 'simplecov'
-
-# save to CircleCI's artifacts directory if we're on CircleCI
-if ENV['CIRCLE_ARTIFACTS']
-  dir = File.join(ENV['CIRCLE_ARTIFACTS'], "coverage")
-  SimpleCov.coverage_dir(dir)
-end
-
-SimpleCov.start

data/spec/timber/overrides/logger_add_spec.rb

@@ -1,26 +0,0 @@
-require "spec_helper"
-
-describe Timber::Overrides::LoggerAdd, :rails_23 => true do
-  describe "#add" do
-    let(:io) { StringIO.new }
-    let(:logger) do
-      logger = ::Logger.new(io)
-      logger.formatter = proc do |severity, datetime, progname, msg|
-         "#{msg}\n"
-      end
-      logger
-    end
-
-    it "should display the message only when passed to a default logger" do
-      event = Timber::Events::Custom.new(message: "Build version 1.0.0", type: :build, data: {version: "1.0.0"})
-      logger.info(event)
-      expect(io.string).to eq("Build version 1.0.0\n")
-    end
-
-    it "should work with blocks" do
-      event = Timber::Events::Custom.new(message: "Build version 1.0.0", type: :build, data: {version: "1.0.0"})
-      logger.info { event }
-      expect(io.string).to eq("Build version 1.0.0\n")
-    end
-  end
-end

data/spec/timber/probes/action_controller_log_subscriber_spec.rb

@@ -1,65 +0,0 @@
-require "spec_helper"
-
-describe Timber::Probes::ActionControllerLogSubscriber 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::WARN
-    logger
-  end
-
-  describe "#insert!" do
-    around(:each) do |example|
-      class LogSubscriberController < ActionController::Base
-        layout nil
-
-        def index
-          render json: {}
-        end
-
-        def method_for_action(action_name)
-          action_name
-        end
-      end
-
-      ::RailsApp.routes.draw do
-        get 'log_subscriber' => 'log_subscriber#index'
-      end
-
-      old_logger = ::ActionController::Base.logger
-      ::ActionController::Base.logger = logger
-
-      Timecop.freeze(time) { example.run }
-
-      Object.send(:remove_const, :LogSubscriberController)
-      ::ActionController::Base.logger = old_logger
-    end
-
-    it "should not log if the level is not sufficient" do
-      dispatch_rails_request("/log_subscriber")
-      expect(io.string).to eq("")
-    end
-
-    context "with an info level" do
-      around(:each) do |example|
-        old_level = logger.level
-        logger.level = ::Logger::INFO
-        example.run
-        logger.level = old_level
-      end
-
-      it "should log the controller call event" 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")
-        lines = io.string.split("\n")
-        expect(lines.length).to eq(2)
-        expect(lines[0]).to start_with('Processing by LogSubscriberController#index as HTML @metadata {"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) @metadata {"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
-end

data/spec/timber/probes/action_controller_user_context_spec.rb

@@ -1,53 +0,0 @@
-require "spec_helper"
-
-describe Timber::Probes::ActionControllerUserContext 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::WARN
-    logger
-  end
-
-  describe "#insert!" do
-    around(:each) do |example|
-      class UserContextController < ActionController::Base
-        layout nil
-
-        def index
-          logger.error "test"
-          render json: {}
-        end
-
-        def method_for_action(action_name)
-          action_name
-        end
-
-        private
-          def current_user
-            @current_user ||= begin
-              user_struct = Struct.new(:id, :name, :email)
-              user_struct.new(1, "Ben Johnson", "hi@timber.io")
-            end
-          end
-      end
-
-      ::RailsApp.routes.draw do
-        get 'user_context' => 'user_context#index'
-      end
-
-      old_logger = ::ActionController::Base.logger
-      ::ActionController::Base.logger = logger
-
-      Timecop.freeze(time) { example.run }
-
-      Object.send(:remove_const, :UserContextController)
-      ::ActionController::Base.logger = old_logger
-    end
-
-    it "should capture the user context" do
-      dispatch_rails_request("/user_context")
-      expect(io.string).to include("\"user\":{\"id\":\"1\",\"name\":\"Ben Johnson\",\"email\":\"hi@timber.io\"}")
-    end
-  end
-end

data/spec/timber/probes/action_dispatch_debug_exceptions_spec.rb

@@ -1,48 +0,0 @@
-require "spec_helper"
-
-describe Timber::Probes::ActionDispatchDebugExceptions 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::DEBUG
-    logger
-  end
-
-  describe "#insert!" do
-    around(:each) do |example|
-      class ExceptionController < ActionController::Base
-        layout nil
-
-        def index
-          raise "boom"
-        end
-
-        def method_for_action(action_name)
-          action_name
-        end
-      end
-
-      ::RailsApp.routes.draw do
-        get 'exception' => 'exception#index'
-      end
-
-      Timecop.freeze(time) { example.run }
-
-      Object.send(:remove_const, :ExceptionController)
-    end
-
-    it "should set the context" do
-      mock_class
-      dispatch_rails_request("/exception")
-      # Because constantly updating the line numbers sucks :/
-      expect(io.string).to include("RuntimeError (boom) @metadata")
-      expect(io.string).to include("\"event\":{\"server_side_app\":{\"exception\":{\"name\":\"RuntimeError\",\"message\":\"boom\",\"backtrace\":[{\"file\":\"lib/timber/probes/action_controller_user_context.rb\",\"line\":33,\"function\":\"_timber_capture_user_context\"},")
-    end
-
-    def mock_class
-      klass = defined?(::ActionDispatch::DebugExceptions) ? ::ActionDispatch::DebugExceptions : ::ActionDispatch::ShowExceptions
-      allow_any_instance_of(klass).to receive(:logger).and_return(logger)
-    end
-  end
-end

data/spec/timber/probes/action_view_log_subscriber_spec.rb

@@ -1,107 +0,0 @@
-require "spec_helper"
-
-describe Timber::Probes::ActionViewLogSubscriber 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::WARN
-    logger
-  end
-
-  describe "insert!" do
-    around(:each) do |example|
-      class ActionViewLogSubscriberController < ActionController::Base
-        layout nil
-
-        def index
-          render template: "template"
-        end
-
-        def method_for_action(action_name)
-          action_name
-        end
-      end
-
-      ::RailsApp.routes.draw do
-        get 'action_view_log_subscriber' => 'action_view_log_subscriber#index'
-      end
-
-      Timecop.freeze(time) { example.run }
-
-      Object.send(:remove_const, :ActionViewLogSubscriberController)
-    end
-
-    describe "#render_template" do
-      it "should not log if the level is not sufficient" do
-        allow_any_instance_of(Timber::Probes::ActionViewLogSubscriber::LogSubscriber).to receive(:logger).and_return(logger)
-        dispatch_rails_request("/action_view_log_subscriber")
-        expect(io.string).to eq("")
-      end
-
-      context "with an info level" do
-        around(:each) do |example|
-          old_level = logger.level
-          logger.level = ::Logger::INFO
-          example.run
-          logger.level = old_level
-        end
-
-        it "should log the controller call event" do
-          allow_any_instance_of(Timber::Probes::ActionViewLogSubscriber::LogSubscriber).to receive(:logger).and_return(logger)
-          dispatch_rails_request("/action_view_log_subscriber")
-          expect(io.string).to start_with("  Rendered spec/support/rails/templates/template.html (0.0ms) @metadata {\"level\":\"info\"")
-          expect(io.string).to include("\"event\":{\"server_side_app\":{\"template_render\":{\"name\":\"spec/support/rails/templates/template.html\",\"time_ms\":0.0}}},")
-        end
-      end
-    end
-  end
-
-  if defined?(described_class::LogSubscriber)
-    describe described_class::LogSubscriber do
-      let(:event) do
-        event = Struct.new(:duration, :payload)
-        event.new(2, identifier: "path/to/template.html")
-      end
-
-      around(:each) do |example|
-        old_level = logger.level
-        logger.level = ::Logger::INFO
-        example.run
-        logger.level = old_level
-      end
-
-      describe "#render_template" do
-        it "should render the collection" do
-          log_subscriber = described_class.new
-          log_subscriber.stub(:logger) { logger }
-          log_subscriber.render_template(event)
-          expect(io.string).to start_with("  Rendered path/to/template.html (2.0ms) @metadata")
-        end
-      end
-
-      describe "#render_partial" do
-        it "should render the collection" do
-          log_subscriber = described_class.new
-          log_subscriber.stub(:logger) { logger }
-          log_subscriber.render_partial(event)
-          expect(io.string).to start_with("  Rendered path/to/template.html (2.0ms) @metadata")
-        end
-      end
-
-      describe "#render_collection" do
-        it "should render the collection" do
-          log_subscriber = described_class.new
-          log_subscriber.stub(:logger) { logger }
-          log_subscriber.render_collection(event)
-
-          if log_subscriber.respond_to?(:render_count, true)
-            expect(io.string).to start_with("  Rendered collection of path/to/template.html [ times] (2.0ms) @metadata ")
-          else
-            expect(io.string).to start_with("  Rendered path/to/template.html (2.0ms) @metadata")
-          end
-        end
-      end
-    end
-  end
-end