appsignal 2.2.0 → 2.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 21ea8fda4d2d6bea2c6a3a5225bcf2f31635eb8e
-  data.tar.gz: a2191345607fbff0eae62ff4c74536e85dc16c90
+  metadata.gz: 705384b1874c28d97c9686459bcbfc6a99fb2314
+  data.tar.gz: d191875adb5dadac78d8148828a346e9165964a4
 SHA512:
-  metadata.gz: 8e9b7f50c4e8c4b8736b5d570288522aee4cfd0a75e1fab24ab6c9701b3e01593b8eacea36d86d1e0b8efe4ebd3fb3228beb740d40988a80aa9df2b3d861f282
-  data.tar.gz: 031661f930c29f14f7f5653b24bc5ffcf749313f16fda86e69e034defabb0fa958b454f0522bd888586b2365e8b1cc2e20a2f17570958104e6f24f8fa449799e
+  metadata.gz: fd0dc31ae1795897907da34b6ce862777829e81b6e98013830caa4818bf17f77f683e4a6beb176d6664213f5e64bd602df410aedab8ac798b58432dc0417daa5
+  data.tar.gz: 7a448280ea51c4426e6a9322f8a264fe99f94c25312dd663cdd489d8d9f9ac58d81e5f21e154fb309a9fcc035fc23fbcfc7ea98394597305ae49ad021356f167

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+# 2.2.1
+* Fix support for Rails 5.1. PR #286
+* Fix instrumentation that would report a duration of `0ms` for all DataMapper
+  queries. PR #290
+* Finish events when `Appsignal.instrument` encounters a `raise` or a `throw`.
+  PR #292
+
 # 2.2.0
 * Support Ruby 2.4 better. PR #234
 * Initial setup for documenting the Ruby gem's code. PR #243

data/ext/agent.yml

@@ -1,18 +1,18 @@
 ---
-version: f16607c
+version: d54a76a
 triples:
   x86_64-linux:
-    checksum: '0479e8b0aeba95360e9fd8cfd7e7f7f4c1a8dfc555f6149c0c35d27593a05193'
-    download_url: https://appsignal-agent-releases.global.ssl.fastly.net/f16607c/appsignal-x86_64-linux-all-static.tar.gz
+    checksum: 281d91b060365e05fc2df94eb88b0b8d7f6fde06c439829bdd170f202f5aa5b1
+    download_url: https://appsignal-agent-releases.global.ssl.fastly.net/d54a76a/appsignal-x86_64-linux-all-static.tar.gz
   i686-linux:
-    checksum: 3c3c63f26bec0304649cad4fb69410dd6b13313a178f3db7cdeba72b24834715
-    download_url: https://appsignal-agent-releases.global.ssl.fastly.net/f16607c/appsignal-i686-linux-all-static.tar.gz
+    checksum: 91e9d317a45d0a5e1a03b5a12480c221182b8f460638532181b58b362941d3d5
+    download_url: https://appsignal-agent-releases.global.ssl.fastly.net/d54a76a/appsignal-i686-linux-all-static.tar.gz
   x86-linux:
-    checksum: 3c3c63f26bec0304649cad4fb69410dd6b13313a178f3db7cdeba72b24834715
-    download_url: https://appsignal-agent-releases.global.ssl.fastly.net/f16607c/appsignal-i686-linux-all-static.tar.gz
+    checksum: 91e9d317a45d0a5e1a03b5a12480c221182b8f460638532181b58b362941d3d5
+    download_url: https://appsignal-agent-releases.global.ssl.fastly.net/d54a76a/appsignal-i686-linux-all-static.tar.gz
   x86_64-darwin:
-    checksum: 853398d93cda5f16edd2a931346f97fedea4c16f729bb987564cfbc29e73ef33
-    download_url: https://appsignal-agent-releases.global.ssl.fastly.net/f16607c/appsignal-x86_64-darwin-all-static.tar.gz
+    checksum: f9732af3f4913341d0ec70474d893472fd1bf9720c5cea098a24be92379872aa
+    download_url: https://appsignal-agent-releases.global.ssl.fastly.net/d54a76a/appsignal-x86_64-darwin-all-static.tar.gz
   universal-darwin:
-    checksum: 853398d93cda5f16edd2a931346f97fedea4c16f729bb987564cfbc29e73ef33
-    download_url: https://appsignal-agent-releases.global.ssl.fastly.net/f16607c/appsignal-x86_64-darwin-all-static.tar.gz
+    checksum: f9732af3f4913341d0ec70474d893472fd1bf9720c5cea098a24be92379872aa
+    download_url: https://appsignal-agent-releases.global.ssl.fastly.net/d54a76a/appsignal-x86_64-darwin-all-static.tar.gz

data/ext/appsignal_extension.c

@@ -119,7 +119,7 @@ static VALUE finish_event(VALUE self, VALUE name, VALUE title, VALUE body, VALUE
   return Qnil;
 }
 
-static VALUE record_event(VALUE self, VALUE name, VALUE title, VALUE body, VALUE duration, VALUE body_format, VALUE gc_duration_ms) {
+static VALUE record_event(VALUE self, VALUE name, VALUE title, VALUE body, VALUE body_format, VALUE duration, VALUE gc_duration_ms) {
   appsignal_transaction_t* transaction;
   appsignal_data_t* body_data;
   int body_type;

data/lib/appsignal.rb

@@ -461,10 +461,12 @@ module Appsignal
     #   instrumented. Accepted values are {EventFormatter::DEFAULT} and
     #   {EventFormatter::SQL_BODY_FORMAT}, but we recommend you use
     #   {.instrument_sql} instead of {EventFormatter::SQL_BODY_FORMAT}.
-    # @yield yields the given block of code instrumented in an AppSignal event.
+    # @yield yields the given block of code instrumented in an AppSignal
+    #   event.
     # @return [Object] Returns the blocks return value.
     #
-    # @see .instrument_sql Specific helper for SQL queries.
+    # @see Appsignal::Transaction#instrument
+    # @see .instrument_sql
     # @see http://docs.appsignal.com/ruby/instrumentation/instrumentation.html
     #   AppSignal custom instrumentation guide
     # @see http://docs.appsignal.com/api/event-names.html
@@ -472,9 +474,9 @@ module Appsignal
     # @since 1.3.0
     def instrument(name, title = nil, body = nil, body_format = Appsignal::EventFormatter::DEFAULT)
       Appsignal::Transaction.current.start_event
-      return_value = yield if block_given?
+      yield if block_given?
+    ensure
       Appsignal::Transaction.current.finish_event(name, title, body, body_format)
-      return_value
     end
 
     # Instrumentation helper for SQL queries.

data/lib/appsignal/integrations/railtie.rb

@@ -22,8 +22,8 @@ module Appsignal
         # Start logger
         Appsignal.start_logger
 
-        app.middleware.insert_before(
-          ActionDispatch::RemoteIp,
+        app.middleware.insert_after(
+          ActionDispatch::DebugExceptions,
           Appsignal::Rack::RailsInstrumentation
         )
 

data/lib/appsignal/transaction.rb

@@ -278,17 +278,17 @@ module Appsignal
         name,
         title || BLANK,
         body || BLANK,
-        duration,
         body_format || Appsignal::EventFormatter::DEFAULT,
+        duration,
         self.class.garbage_collection_profiler.total_time
       )
     end
 
     def instrument(name, title = nil, body = nil, body_format = Appsignal::EventFormatter::DEFAULT)
       start_event
-      r = yield
+      yield if block_given?
+    ensure
       finish_event(name, title, body, body_format)
-      r
     end
 
     class GenericRequest

data/lib/appsignal/version.rb

@@ -1,5 +1,5 @@
 require "yaml"
 
 module Appsignal
-  VERSION = "2.2.0".freeze
+  VERSION = "2.2.1".freeze
 end

data/spec/lib/appsignal/extension_spec.rb

@@ -48,7 +48,7 @@ describe "extension loading and operation" do
         end
 
         it "should have a record_event method" do
-          subject.record_event("name", "title", "body", 1000, 0, 1000)
+          subject.record_event("name", "title", "body", 0, 1000, 1000)
         end
 
         it "should have a set_error method" do

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

@@ -57,6 +57,7 @@ if DependencyHelper.padrino_present?
       let(:base)     { double }
       let(:router)   { PadrinoClassWithRouter.new }
       let(:env)      { {} }
+      # TODO: use an instance double
       let(:settings) { double(:name => "TestApp") }
 
       describe "routes" do
@@ -107,6 +108,7 @@ if DependencyHelper.padrino_present?
             Appsignal::Transaction::HTTP_REQUEST,
             request_kind
           ).and_return(transaction)
+
           expect(Appsignal).to receive(:instrument)
             .at_least(:once)
             .with("process_action.padrino")

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

@@ -11,7 +11,10 @@ if DependencyHelper.rails_present?
 
     describe "#initialize_appsignal" do
       let(:app) { MyApp::Application }
-      before { allow(app.middleware).to receive(:insert_before).and_return(true) }
+      before do
+        allow(app.middleware).to receive(:insert_before)
+        allow(app.middleware).to receive(:insert_after)
+      end
 
       describe ".logger" do
         before  { Appsignal::Integrations::Railtie.initialize_appsignal(app) }
@@ -68,8 +71,8 @@ if DependencyHelper.rails_present?
 
       describe "Rails listener middleware" do
         it "adds the Rails listener middleware" do
-          expect(app.middleware).to receive(:insert_before).with(
-            ActionDispatch::RemoteIp,
+          expect(app.middleware).to receive(:insert_after).with(
+            ActionDispatch::DebugExceptions,
             Appsignal::Rack::RailsInstrumentation
           )
         end
@@ -93,8 +96,8 @@ if DependencyHelper.rails_present?
           let(:enable_frontend_error_catching) { true }
 
           it "adds the Rails and JSExceptionCatcher middleware" do
-            expect(app.middleware).to receive(:insert_before).with(
-              ActionDispatch::RemoteIp,
+            expect(app.middleware).to receive(:insert_after).with(
+              ActionDispatch::DebugExceptions,
               Appsignal::Rack::RailsInstrumentation
             )
 
@@ -109,8 +112,8 @@ if DependencyHelper.rails_present?
           let(:enable_frontend_error_catching) { false }
 
           it "adds the Rails middleware, but not the JSExceptionCatcher middleware" do
-            expect(app.middleware).to receive(:insert_before).with(
-              ActionDispatch::RemoteIp,
+            expect(app.middleware).to receive(:insert_after).with(
+              ActionDispatch::DebugExceptions,
               Appsignal::Rack::RailsInstrumentation
             )
 

data/spec/lib/appsignal/transaction_spec.rb

@@ -568,8 +568,8 @@ describe Appsignal::Transaction do
           "name",
           "title",
           "body",
-          1000,
           1,
+          1000,
           fake_gc_time
         ).and_call_original
 
@@ -587,8 +587,8 @@ describe Appsignal::Transaction do
           "name",
           "",
           "",
-          1000,
           0,
+          1000,
           fake_gc_time
         ).and_call_original
 
@@ -603,22 +603,8 @@ describe Appsignal::Transaction do
     end
 
     describe "#instrument" do
-      it "should start and finish an event around the given block" do
-        stub = double
-        expect(stub).to receive(:method_call).and_return("return value")
-
-        expect(transaction).to receive(:start_event)
-        expect(transaction).to receive(:finish_event).with(
-          "name",
-          "title",
-          "body",
-          0
-        )
-
-        return_value = transaction.instrument "name", "title", "body" do
-          stub.method_call
-        end
-        expect(return_value).to eq "return value"
+      it_behaves_like "instrument helper" do
+        let(:instrumenter) { transaction }
       end
     end
 

data/spec/lib/appsignal_spec.rb

@@ -298,18 +298,6 @@ describe Appsignal do
         end.to_not raise_error
       end
     end
-
-    describe ".instrument" do
-      it "should not instrument, but still call the block" do
-        stub = double
-        expect(stub).to receive(:method_call).and_return("return value")
-
-        return_value = Appsignal.instrument "name" do
-          stub.method_call
-        end
-        expect(return_value).to eq "return value"
-      end
-    end
   end
 
   context "with config and started" do
@@ -848,28 +836,11 @@ describe Appsignal do
     end
 
     describe ".instrument" do
-      before do
-        expect(Appsignal::Transaction).to receive(:current).at_least(:once).and_return(transaction)
-      end
-
-      it "should instrument through the transaction" do
-        expect(transaction).to receive(:start_event)
-        expect(transaction).to receive(:finish_event)
-          .with("name", "title", "body", Appsignal::EventFormatter::DEFAULT)
-
-        result = Appsignal.instrument "name", "title", "body" do
-          "return value"
+      it_behaves_like "instrument helper" do
+        let(:instrumenter) { Appsignal }
+        before do
+          expect(Appsignal::Transaction).to receive(:current).at_least(:once).and_return(transaction)
         end
-        expect(result).to eq "return value"
-      end
-
-      it "should instrument without a block given" do
-        expect(transaction).to receive(:start_event)
-        expect(transaction).to receive(:finish_event)
-          .with("name", "title", "body", Appsignal::EventFormatter::DEFAULT)
-
-        result = Appsignal.instrument "name", "title", "body"
-        expect(result).to be_nil
       end
     end
 
@@ -878,7 +849,7 @@ describe Appsignal do
         expect(Appsignal::Transaction).to receive(:current).at_least(:once).and_return(transaction)
       end
 
-      it "should instrument sql through the transaction" do
+      it "creates an SQL event on the transaction" do
         expect(transaction).to receive(:start_event)
         expect(transaction).to receive(:finish_event)
           .with("name", "title", "body", Appsignal::EventFormatter::SQL_BODY_FORMAT)

data/spec/spec_helper.rb

@@ -19,6 +19,9 @@ end
 Dir[File.join(APPSIGNAL_SPEC_DIR, "support/mocks", "*.rb")].each do |f|
   require f
 end
+Dir[File.join(APPSIGNAL_SPEC_DIR, "support/shared_examples", "*.rb")].each do |f|
+  require f
+end
 if DependencyHelper.rails_present?
   Dir[File.join(DirectoryHelper.support_dir, "rails", "*.rb")].each do |f|
     require f

data/spec/support/shared_examples/instrument.rb

@@ -0,0 +1,43 @@
+RSpec.shared_examples "instrument helper" do
+  let(:stub) { double }
+  before do
+    expect(stub).to receive(:method_call).and_return("return value")
+
+    expect(transaction).to receive(:start_event)
+    expect(transaction).to receive(:finish_event).with(
+      "name",
+      "title",
+      "body",
+      0
+    )
+  end
+
+  it "records an event around the given block" do
+    return_value = instrumenter.instrument "name", "title", "body" do
+      stub.method_call
+    end
+    expect(return_value).to eq "return value"
+  end
+
+  context "with an error raised in the passed block" do
+    it "records an event around the given block" do
+      expect do
+        instrumenter.instrument "name", "title", "body" do
+          stub.method_call
+          raise "foo"
+        end
+      end.to raise_error(StandardError, "foo")
+    end
+  end
+
+  context "with an error raise in the passed block" do
+    it "records an event around the given block" do
+      expect do
+        instrumenter.instrument "name", "title", "body" do
+          stub.method_call
+          throw :foo
+        end
+      end.to throw_symbol(:foo)
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: appsignal
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.2.1
 platform: ruby
 authors:
 - Robert Beekman
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-03 00:00:00.000000000 Z
+date: 2017-05-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -339,6 +339,7 @@ files:
 - spec/support/project_fixture/config/environments/test.rb
 - spec/support/project_fixture/log/.gitkeep
 - spec/support/rails/my_app.rb
+- spec/support/shared_examples/instrument.rb
 - spec/support/stubs/delayed_job.rb
 homepage: https://github.com/appsignal/appsignal
 licenses:
@@ -361,7 +362,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.10
+rubygems_version: 2.6.12
 signing_key: 
 specification_version: 4
 summary: Logs performance and exception data from your app to appsignal.com
@@ -457,4 +458,5 @@ test_files:
 - spec/support/project_fixture/config/environments/test.rb
 - spec/support/project_fixture/log/.gitkeep
 - spec/support/rails/my_app.rb
+- spec/support/shared_examples/instrument.rb
 - spec/support/stubs/delayed_job.rb