appsignal 0.11.7 → 0.11.8.beta.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 667d1d2dfa406916da0c6249befc7528ff83c662
-  data.tar.gz: 5853d8a6387eba48425f5206bd1d1352e827b0d7
+  metadata.gz: 69c0fe4aba981d664f4b5a320c2cf47816ae4598
+  data.tar.gz: 546e20aa73e171ca1183c4cba04beed672ced563
 SHA512:
-  metadata.gz: 6185e5637b0724d92dcdaaf826474e110bc8959f24ad057a0ddc391c972b175ca8efa498ed9f953211864e726450b8e344983c558082162f6d93a5848c376f3b
-  data.tar.gz: 91b6b5e685022c0493347161fb28f5c3b040f297231b2ae7e89b70fe43f5671a9b540edc0deaf674fb482ad5f01d97591aa075f22a9cecc75fdaed072f8b0f0a
+  metadata.gz: dba3ef8508c2b43ef0456f926397ae29cd34a0b454de79cf3cf10e853386a2bfb90fb2d1e60ef21f9ffcf8e56c9425f6ede6669436430b35e2fb95936851be8c
+  data.tar.gz: 26d06743732e417cd38ddf55372f25f80be96f38d55ed5719c3740b746a32cc0579e5f399e75b1b9d31a62564a31d643778ca8a0ff8ddc02ba7142c582762cb8

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+# 0.11.8
+* Add frontend error catcher
+
 # 0.11.7
 * Add option to override Job name in Delayed Job
 

data/lib/appsignal.rb

@@ -195,6 +195,7 @@ require 'appsignal/marker'
 require 'appsignal/rack/listener'
 require 'appsignal/rack/instrumentation'
 require 'appsignal/rack/sinatra_instrumentation'
+require 'appsignal/rack/js_exception_catcher'
 require 'appsignal/params_sanitizer'
 require 'appsignal/transaction'
 require 'appsignal/transaction/formatter'
@@ -203,3 +204,4 @@ require 'appsignal/transmitter'
 require 'appsignal/ipc'
 require 'appsignal/version'
 require 'appsignal/integrations/rails'
+require 'appsignal/js_exception_transaction'

data/lib/appsignal/config.rb

@@ -7,22 +7,24 @@ module Appsignal
     include Appsignal::CarefulLogger
 
     DEFAULT_CONFIG = {
-      :ignore_exceptions      => [],
-      :ignore_actions         => [],
-      :send_params            => true,
-      :endpoint               => 'https://push.appsignal.com/1',
-      :slow_request_threshold => 200,
-      :instrument_net_http    => true,
-      :skip_session_data      => false
+      :ignore_exceptions              => [],
+      :ignore_actions                 => [],
+      :send_params                    => true,
+      :endpoint                       => 'https://push.appsignal.com/1',
+      :slow_request_threshold         => 200,
+      :instrument_net_http            => true,
+      :skip_session_data              => false,
+      :enable_frontend_error_catching => false,
+      :frontend_error_catching_path   => '/appsignal_error_catcher'
     }.freeze
 
     attr_reader :root_path, :env, :initial_config, :config_hash
 
     def initialize(root_path, env, initial_config={}, logger=Appsignal.logger)
-      @root_path = root_path
-      @env = env.to_s
+      @root_path      = root_path
+      @env            = env.to_s
       @initial_config = initial_config
-      @logger = logger
+      @logger         = logger
 
       if File.exists?(config_file)
         load_config_from_disk

data/lib/appsignal/integrations/rails.rb

@@ -7,6 +7,10 @@ if defined?(::Rails)
         initializer 'appsignal.configure_rails_initialization' do |app|
           app.middleware.insert_before(
             ActionDispatch::RemoteIp,
+            Appsignal::Rack::JSExceptionCatcher
+          )
+          app.middleware.insert_after(
+            Appsignal::Rack::JSExceptionCatcher,
             Appsignal::Rack::Listener
           )
         end

data/lib/appsignal/js_exception_transaction.rb

@@ -0,0 +1,46 @@
+module Appsignal
+  class JSExceptionTransaction
+
+    def initialize(data)
+      @data = data
+      @time = Time.now.to_i
+    end
+
+    def type
+      :exception
+    end
+
+    def action
+      @data['action']
+    end
+
+    def clear_events!; end
+    def convert_values_to_primitives!; end
+    def events; []; end
+
+    def to_hash
+      {
+        :request_id => SecureRandom.uuid,
+        :log_entry => {
+          :action      => action,
+          :path        => @data['path'],
+          :kind        => 'frontend',
+          :time        => @time,
+          :environment => @data['environment'],
+          :revision    => Appsignal.agent.revision
+        },
+        :exception => {
+          :exception => @data['name'],
+          :message   => @data['message'],
+          :backtrace => @data['backtrace']
+        },
+        :failed => true
+      }
+    end
+
+    def complete!
+      Appsignal.enqueue(self)
+    end
+
+  end
+end

data/lib/appsignal/rack/js_exception_catcher.rb

@@ -0,0 +1,25 @@
+module Appsignal
+  module Rack
+    class JSExceptionCatcher
+      def initialize(app, options = {})
+        Appsignal.logger.debug 'Initializing Appsignal::Rack::JSExceptionCatcher'
+        @app, @options = app, options
+      end
+
+      def call(env)
+        if env['PATH_INFO'] == Appsignal.config[:frontend_error_catching_path]
+          if Appsignal.config.active? &&
+             Appsignal.config[:enable_frontend_error_catching] == true
+
+            body        = JSON.parse(env['rack.input'].read)
+            transaction = JSExceptionTransaction.new(body)
+            transaction.complete!
+          end
+          return [ 200, {}, []]
+        else
+          @app.call(env)
+        end
+      end
+    end
+  end
+end

data/lib/appsignal/version.rb

@@ -1,3 +1,3 @@
 module Appsignal
-  VERSION = '0.11.7'
+  VERSION = '0.11.8.beta.0'
 end

data/spec/lib/appsignal/config_spec.rb

@@ -16,16 +16,18 @@ describe Appsignal::Config do
 
     it "should merge with the default config and fill the config hash" do
       subject.config_hash.should == {
-        :ignore_exceptions => [],
-        :ignore_actions => [],
-        :instrument_net_http => true,
-        :skip_session_data => false,
-        :send_params => true,
-        :endpoint => 'https://push.appsignal.com/1',
-        :slow_request_threshold => 200,
-        :push_api_key => 'abc',
-        :name => 'TestApp',
-        :active => true
+        :ignore_exceptions              => [],
+        :ignore_actions                 => [],
+        :instrument_net_http            => true,
+        :skip_session_data              => false,
+        :send_params                    => true,
+        :endpoint                       => 'https://push.appsignal.com/1',
+        :slow_request_threshold         => 200,
+        :push_api_key                   => 'abc',
+        :name                           => 'TestApp',
+        :active                         => true,
+        :enable_frontend_error_catching => false,
+        :frontend_error_catching_path   => '/appsignal_error_catcher'
       }
     end
 
@@ -127,15 +129,17 @@ describe Appsignal::Config do
         )
 
         subject.config_hash.should == {
-          :push_api_key => 'push_api_key',
-          :ignore_exceptions => [],
-          :ignore_actions => [],
-          :send_params => true,
-          :instrument_net_http => true,
-          :skip_session_data => false,
-          :endpoint => 'https://push.appsignal.com/1',
-          :slow_request_threshold => 200,
-          :active => true
+          :push_api_key                   => 'push_api_key',
+          :ignore_exceptions              => [],
+          :ignore_actions                 => [],
+          :send_params                    => true,
+          :instrument_net_http            => true,
+          :skip_session_data              => false,
+          :endpoint                       => 'https://push.appsignal.com/1',
+          :slow_request_threshold         => 200,
+          :active                         => true,
+          :enable_frontend_error_catching => false,
+          :frontend_error_catching_path   => '/appsignal_error_catcher'
         }
       end
 

data/spec/lib/appsignal/integrations/rails_spec.rb

@@ -40,6 +40,10 @@ if rails_present?
         MyApp::Application.middleware.to_a.should include Appsignal::Rack::Listener
       end
 
+      it "should have added the js exception catcher middleware" do
+        MyApp::Application.middleware.to_a.should include Appsignal::Rack::JSExceptionCatcher
+      end
+
       it "should not have added the instrumentation middleware" do
         MyApp::Application.middleware.to_a.should_not include Appsignal::Rack::Instrumentation
       end

data/spec/lib/appsignal/js_exception_transaction_spec.rb

@@ -0,0 +1,91 @@
+require 'spec_helper'
+
+describe Appsignal::JSExceptionTransaction do
+  let(:transaction) { Appsignal::JSExceptionTransaction.new(data) }
+  let(:data) do
+    {
+      'name'        => 'TypeError',
+      'message'     => 'foo is not a valid method',
+      'action'      => 'ExceptionIncidentComponent',
+      'path'        => 'foo.bar/moo',
+      'environment' => 'development',
+      'backtrace'   => [
+        'foo.bar/js:11:1',
+        'foo.bar/js:22:2',
+      ]
+    }
+  end
+
+  describe "#type" do
+    it "should return `:exception`" do
+      expect( transaction.type ).to eql :exception
+    end
+  end
+
+  describe "#action" do
+    it "should return the action" do
+      expect( transaction.action ).to eql 'ExceptionIncidentComponent'
+    end
+  end
+
+  describe "#clear_events" do
+    it "should respond to `clear_events!`" do
+      expect( transaction ).to respond_to :clear_events!
+    end
+  end
+
+  describe "#convert_values_to_primitives!" do
+    it "should respond to `convert_values_to_primitives!`" do
+      expect( transaction ).to respond_to :convert_values_to_primitives!
+    end
+  end
+
+  describe "#events" do
+    it "should respond to `events` with an empty array" do
+      expect( transaction.events ).to eql []
+    end
+  end
+
+  describe "#to_hash" do
+    around do |sample|
+      Timecop.freeze(Time.at(123)) { sample.run }
+    end
+
+    before do
+      SecureRandom.stub(:uuid => 'uuid')
+      Appsignal.stub(:agent => double(:revision => 'abcdef'))
+    end
+
+    it "should generate a hash based on the given data" do
+      expect( transaction.to_hash).to eql({
+        :request_id => 'uuid',
+        :log_entry => {
+          :action      => 'ExceptionIncidentComponent',
+          :path        => 'foo.bar/moo',
+          :kind        => 'frontend',
+          :time        => 123,
+          :environment => 'development',
+          :revision    => 'abcdef'
+        },
+        :exception => {
+          :exception => 'TypeError',
+          :message   => 'foo is not a valid method',
+          :backtrace => [
+            'foo.bar/js:11:1',
+            'foo.bar/js:22:2',
+          ]
+        },
+        :failed => true
+      })
+    end
+
+    describe "#complete!" do
+      it "should enqueue itself" do
+        expect( Appsignal ).to receive(:enqueue).with(transaction)
+
+        transaction.complete!
+      end
+    end
+
+  end
+end

data/spec/lib/appsignal/rack/js_exception_catcher_spec.rb

@@ -0,0 +1,89 @@
+require 'spec_helper'
+
+describe Appsignal::Rack::JSExceptionCatcher do
+  let(:app)            { double(:call => true) }
+  let(:options)        { double }
+  let(:active)         { true }
+  let(:config_options) { {:enable_frontend_error_catching => true} }
+  let(:config)         { project_fixture_config('production', config_options) }
+
+  before do
+    Appsignal.stub(:config => config)
+    config.stub(:active? => active)
+  end
+
+  describe "#initialize" do
+    it "should log to the logger" do
+      expect( Appsignal.logger ).to receive(:debug)
+        .with('Initializing Appsignal::Rack::JSExceptionCatcher')
+
+      Appsignal::Rack::JSExceptionCatcher.new(app, options)
+    end
+  end
+
+  describe "#call" do
+    let(:catcher) { Appsignal::Rack::JSExceptionCatcher.new(app, options) }
+
+    context "when path is not `/appsignal_error_catcher`" do
+      let(:env) { {'PATH_INFO' => '/foo'} }
+
+      it "should call the next middleware" do
+        expect( app ).to receive(:call).with(env)
+      end
+    end
+
+    context "when path is `/appsignal_error_catcher`" do
+      let(:transaction) { double(:complete! => true) }
+      let(:env) do
+        {
+          'PATH_INFO'  => '/appsignal_error_catcher',
+          'rack.input' => double(:read => '{"foo": "bar"}')
+        }
+      end
+
+      it "should create a JSExceptionTransaction" do
+        expect( Appsignal::JSExceptionTransaction ).to receive(:new)
+          .with({'foo' => 'bar'})
+          .and_return(transaction)
+
+        expect( transaction ).to receive(:complete!)
+      end
+
+      context "when appsignal is not active" do
+        let(:active)  { false }
+
+        it "should not create a transaction" do
+          expect( Appsignal::JSExceptionTransaction ).to_not receive(:new)
+        end
+      end
+
+      context "when `enable_frontend_error_catching` is disabled" do
+        let(:config_options) { {:enable_frontend_error_catching => false} }
+
+        it "should not create a transaction" do
+          expect( Appsignal::JSExceptionTransaction ).to_not receive(:new)
+        end
+      end
+
+      context "when `frontend_error_catching_path` is different" do
+        let(:config_options) do
+          {
+            :enable_frontend_error_catching => true,
+            :frontend_error_catching_path   => '/foo'
+          }
+        end
+
+        it "should not create a transaction" do
+          expect( Appsignal::JSExceptionTransaction ).to_not receive(:new)
+        end
+
+        it "should call the next middleware" do
+          expect( app ).to receive(:call).with(env)
+        end
+      end
+    end
+
+    after { catcher.call(env) }
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: appsignal
 version: !ruby/object:Gem::Version
-  version: 0.11.7
+  version: 0.11.8.beta.0
 platform: ruby
 authors:
 - Robert Beekman
@@ -12,7 +12,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-20 00:00:00.000000000 Z
+date: 2015-03-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -170,9 +170,11 @@ files:
 - lib/appsignal/integrations/sinatra.rb
 - lib/appsignal/integrations/unicorn.rb
 - lib/appsignal/ipc.rb
+- lib/appsignal/js_exception_transaction.rb
 - lib/appsignal/marker.rb
 - lib/appsignal/params_sanitizer.rb
 - lib/appsignal/rack/instrumentation.rb
+- lib/appsignal/rack/js_exception_catcher.rb
 - lib/appsignal/rack/listener.rb
 - lib/appsignal/rack/sinatra_instrumentation.rb
 - lib/appsignal/transaction.rb
@@ -213,9 +215,11 @@ files:
 - spec/lib/appsignal/integrations/sinatra_spec.rb
 - spec/lib/appsignal/integrations/unicorn_spec.rb
 - spec/lib/appsignal/ipc_spec.rb
+- spec/lib/appsignal/js_exception_transaction_spec.rb
 - spec/lib/appsignal/marker_spec.rb
 - spec/lib/appsignal/params_sanitizer_spec.rb
 - spec/lib/appsignal/rack/instrumentation_spec.rb
+- spec/lib/appsignal/rack/js_exception_catcher_spec.rb
 - spec/lib/appsignal/rack/listener_spec.rb
 - spec/lib/appsignal/rack/sinatra_instrumentation_spec.rb
 - spec/lib/appsignal/transaction/formatter_spec.rb
@@ -250,9 +254,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '1.9'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.2.2
@@ -284,9 +288,11 @@ test_files:
 - spec/lib/appsignal/integrations/sinatra_spec.rb
 - spec/lib/appsignal/integrations/unicorn_spec.rb
 - spec/lib/appsignal/ipc_spec.rb
+- spec/lib/appsignal/js_exception_transaction_spec.rb
 - spec/lib/appsignal/marker_spec.rb
 - spec/lib/appsignal/params_sanitizer_spec.rb
 - spec/lib/appsignal/rack/instrumentation_spec.rb
+- spec/lib/appsignal/rack/js_exception_catcher_spec.rb
 - spec/lib/appsignal/rack/listener_spec.rb
 - spec/lib/appsignal/rack/sinatra_instrumentation_spec.rb
 - spec/lib/appsignal/transaction/formatter_spec.rb