pliny 0.16.3 → 0.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 548c79d9c73c40bd3d9564f62ac43fafe8258720
-  data.tar.gz: 163711ca7aa133303c6fd3c31d47444d7880b14a
+  metadata.gz: 9a23d5c9332e98aa75fbe6d56ec858314aeafe88
+  data.tar.gz: 832352cd2b15849d452783fa87638b4d8fc7fa68
 SHA512:
-  metadata.gz: a21bb401dceadc0331e47a3b0484609a69b890c3e3ea03ab671888fa5993f252c7dc9a4d186717b80c20caa1565b86b3599017037f2343acad9bff5ef7050187
-  data.tar.gz: 2e4571958fa398ac04e7db0ff797a90fe242756d816a0f107735446e1c2c37db2c9a74a4b78804c08c9309394c0b7ffee3210cb723b181df3ed43520e0299ff5
+  metadata.gz: caef1b86bf0355f08804ff6d771dc3fb93f8520fc77332a5dd1dd25aad319d70802356198772a12cc70191f0118a6bf1747c50f0dd0362f958b2ff674e828260
+  data.tar.gz: 4253d293b4fac10cdd17d4291ffb77e44fa11c7fd5e31ada8caa0ce15997a7825eb86ad2b779e8658d7ee7e195cb47c5693fc72859dde4f79c3daa8ee2019ea0

data/lib/pliny.rb

@@ -2,6 +2,7 @@ require "multi_json"
 require "sinatra/base"
 
 require_relative "pliny/version"
+require_relative "pliny/error_reporter"
 require_relative "pliny/errors"
 require_relative "pliny/helpers/encode"
 require_relative "pliny/helpers/params"

data/lib/pliny/error_reporter.rb

@@ -0,0 +1,42 @@
+require 'rollbar/exception_reporter'
+require 'rollbar/request_data_extractor'
+
+class Pliny::ErrorReporter
+  def self.notify(exception, context: {}, rack_env: {})
+    Pliny.log_exception(exception)
+
+    REPORTERS.each do |reporter|
+      begin
+        reporter.new.notify(exception, context: context, rack_env: rack_env)
+      rescue
+        Pliny.log_exception($!)
+      end
+    end
+  end
+
+  class RollbarReporter
+    include ::Rollbar::ExceptionReporter
+    include ::Rollbar::RequestDataExtractor
+
+    def notify(exception, context:, rack_env:)
+      Rollbar.reset_notifier!
+      scope = fetch_scope(context: context, rack_env: rack_env)
+      Rollbar.scoped(scope) do
+        report_exception_to_rollbar(rack_env, exception)
+      end
+    end
+
+    private
+
+    def fetch_scope(context:, rack_env:)
+      {
+        request: proc { extract_request_data_from_rack(rack_env) }
+      }
+    rescue Exception => e
+      report_exception_to_rollbar(rack_env, e)
+      raise
+    end
+  end
+
+  REPORTERS = [RollbarReporter]
+end

data/lib/pliny/log.rb

@@ -1,8 +1,34 @@
 module Pliny
   module Log
     def log(data, &block)
-      data = default_context.merge(log_context.merge(local_context.merge(data)))
-      log_to_stream(stdout || $stdout, data, &block)
+      log_to_stream(stdout || $stdout, merge_log_contexts(data), &block)
+    end
+
+    def log_exception(e, data = {})
+      exception_id = e.object_id
+
+      # Log backtrace in reverse order for easier digestion.
+      if e.backtrace
+        e.backtrace.reverse.each do |backtrace|
+          log_to_stream(stderr || $stderr, merge_log_contexts(
+            exception_id: exception_id,
+            backtrace:    backtrace
+          ))
+        end
+      end
+
+      # then log the exception message last so that it's as close to the end of
+      # a log trace as possible
+      data.merge!(
+        exception:    true,
+        class:        e.class.name,
+        message:      e.message,
+        exception_id: exception_id
+      )
+
+      data[:status] = e.status if e.respond_to?(:status)
+
+      log_to_stream(stderr || $stderr, merge_log_contexts(data))
     end
 
     def context(data, &block)
@@ -30,8 +56,20 @@ module Pliny
       @stdout
     end
 
+    def stderr=(stream)
+      @stderr = stream
+    end
+
+    def stderr
+      @stderr
+    end
+
     private
 
+    def merge_log_contexts(data)
+      default_context.merge(log_context.merge(local_context.merge(data)))
+    end
+
     def local_context
       RequestStore.store[:local_context] ||= {}
     end

data/lib/pliny/middleware/rescue_errors.rb

@@ -8,25 +8,12 @@ module Pliny::Middleware
     def call(env)
       @app.call(env)
     rescue Pliny::Errors::Error => e
-      # blank out this field so that the error is not picked up by Rollbar
-      env["sinatra.error"] = nil
-
       Pliny::Errors::Error.render(e)
-    rescue Exception => e
-      if @raise
-        raise
-      else
-        dump_error(e, env)
-        Pliny::Errors::Error.render(Pliny::Errors::InternalServerError.new)
-      end
-    end
-
-    private
+    rescue => e
+      raise if @raise
 
-    # pulled from Sinatra
-    def dump_error(e, env)
-      message = ["#{e.class} - #{e.message}:", *e.backtrace].join("\n\t")
-      env['rack.errors'].puts(message)
+      Pliny::ErrorReporter.notify(e, rack_env: env)
+      Pliny::Errors::Error.render(Pliny::Errors::InternalServerError.new)
     end
   end
 end

data/lib/pliny/version.rb

@@ -1,3 +1,3 @@
 module Pliny
-  VERSION = "0.16.3"
+  VERSION = "0.17.0"
 end

data/lib/template/.ruby-version

@@ -1 +1 @@
-2.3.0
+2.3.1

data/lib/template/Gemfile

@@ -1,17 +1,17 @@
 source "https://rubygems.org"
-ruby "2.3.0"
+ruby "2.3.1"
 
 gem "multi_json"
 gem "oj"
 gem "pg"
-gem "pliny", "~> 0.16"
+gem "pliny", "~> 0.17"
 gem "pry"
-gem "puma", "~> 2.15"
+gem "puma", "~> 2.16"
 gem "rack-ssl"
 gem "rack-timeout", "~> 0.4"
 gem "rake"
 gem "rollbar", require: "rollbar/middleware/sinatra"
-gem "sequel", "~> 4.30"
+gem "sequel", "~> 4.34"
 gem "sequel-paranoid"
 gem "sequel_pg", "~> 1.6", require: "sequel"
 gem "sinatra", "~> 1.4", require: "sinatra/base"

data/lib/template/config.ru

@@ -1,5 +1,6 @@
 require_relative 'lib/application'
 
 $stdout.sync = true
+$stderr.sync = true
 
 run Routes

data/lib/template/config/config.rb

@@ -14,23 +14,22 @@ module Config
 
   # Optional -- value is returned or `nil` if it wasn't present.
   optional :app_name,            string
-  optional :placeholder,         string
   optional :versioning_default,  string
   optional :versioning_app_name, string
 
   # Override -- value is returned or the set default.
-  override :database_timeout, 10,    int
-  override :db_pool,          5,    int
+  override :database_timeout, 10,           int
+  override :db_pool,          5,            int
   override :deployment,       'production', string
-  override :force_ssl,        true,  bool
-  override :pliny_env,        'development', string
-  override :port,             5000, int
-  override :pretty_json,      false, bool
-  override :puma_max_threads, 16,   int
-  override :puma_min_threads, 1,    int
-  override :puma_workers,     3,    int
-  override :raise_errors,     false,         bool
+  override :force_ssl,        true,         bool
+  override :pliny_env,        'production', string
+  override :port,             5000,         int
+  override :pretty_json,      false,        bool
+  override :puma_max_threads, 16,           int
+  override :puma_min_threads, 1,            int
+  override :puma_workers,     3,            int
+  override :raise_errors,     false,        bool
   override :root,             File.expand_path("../../", __FILE__), string
-  override :timeout,          10,    int
-  override :versioning,       false, bool
+  override :timeout,          10,           int
+  override :versioning,       false,        bool
 end

data/lib/template/config/initializers/rollbar.rb

@@ -1,5 +1,6 @@
 Rollbar.configure do |config|
   config.enabled = ENV.has_key?('ROLLBAR_ACCESS_TOKEN')
+  config.disable_rack_monkey_patch = true
   config.access_token = ENV["ROLLBAR_ACCESS_TOKEN"]
   config.environment = ENV['ROLLBAR_ENV']
   config.logger = Pliny::RollbarLogger.new

data/lib/template/lib/routes.rb

@@ -1,5 +1,4 @@
 Routes = Rack::Builder.new do
-  use Rollbar::Middleware::Sinatra
   use Pliny::Middleware::CORS
   use Pliny::Middleware::RequestID
   use Pliny::Middleware::Instruments

data/spec/error_reporter_spec.rb

@@ -0,0 +1,24 @@
+
+require "spec_helper"
+
+describe Pliny::ErrorReporter do
+  subject(:reporter) { described_class }
+
+  describe ".notify" do
+    let(:exception) { RuntimeError.new }
+    let(:context)   { { context: "foo" } }
+    let(:rack_env)  { { rack_env: "bar" } }
+
+    subject(:notify_reporter) do
+      reporter.notify(exception, context: context, rack_env: rack_env)
+    end
+
+    it "notifies rollbar" do
+      any_instance_of(Pliny::ErrorReporter::RollbarReporter) do |klass|
+        stub(klass).notify(exception, context: context, rack_env: rack_env)
+      end
+
+      notify_reporter
+    end
+  end
+end

data/spec/log_spec.rb

@@ -4,6 +4,7 @@ describe Pliny::Log do
   before do
     @io = StringIO.new
     Pliny.stdout = @io
+    Pliny.stderr = @io
     stub(@io).print
   end
 
@@ -73,4 +74,11 @@ describe Pliny::Log do
     end
     Pliny.log(foo: "bar")
   end
+
+  it "logs exceptions" do
+    Pliny::RequestStore.store[:log_context] = { app: "pliny" }
+    e = RuntimeError.new
+    mock(@io).print "app=pliny exception class=RuntimeError message=RuntimeError exception_id=#{e.object_id}\n"
+    Pliny.log_exception(e)
+  end
 end

data/spec/middleware/rescue_errors_spec.rb

@@ -28,6 +28,7 @@ describe Pliny::Middleware::RescueErrors do
 
   it "intercepts exceptions and renders" do
     @app = new_rack_app
+    mock(Pliny::ErrorReporter).notify.with_any_args
     get "/"
     assert_equal 500, last_response.status
     error_json = MultiJson.decode(last_response.body)

data/spec/spec_helper.rb

@@ -43,3 +43,4 @@ RSpec.configure do |config|
 end
 
 Pliny.stdout = StringIO.new
+Pliny.stderr = StringIO.new

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pliny
 version: !ruby/object:Gem::Version
-  version: 0.16.3
+  version: 0.17.0
 platform: ruby
 authors:
 - Brandur Leach
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-04 00:00:00.000000000 Z
+date: 2016-05-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -305,6 +305,26 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.17.1
+- !ruby/object:Gem::Dependency
+  name: rollbar
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.11'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.11.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.11'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.11.0
 - !ruby/object:Gem::Dependency
   name: sequel
   requirement: !ruby/object:Gem::Requirement
@@ -354,6 +374,7 @@ files:
 - lib/pliny/commands/updater.rb
 - lib/pliny/config_helpers.rb
 - lib/pliny/db_support.rb
+- lib/pliny/error_reporter.rb
 - lib/pliny/errors.rb
 - lib/pliny/helpers/encode.rb
 - lib/pliny/helpers/params.rb
@@ -438,6 +459,7 @@ files:
 - spec/commands/updater_spec.rb
 - spec/config_helpers_spec.rb
 - spec/db_support_spec.rb
+- spec/error_reporter_spec.rb
 - spec/errors_spec.rb
 - spec/helpers/encode_spec.rb
 - spec/helpers/serialize_spec.rb