appsignal 2.11.6-java → 2.11.7-java

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 98537d0865014abcba17744b865f00ce320f9049e9a4397f5c688547595779a5
-  data.tar.gz: cd0dc3ea721e2f52445b9097bc09c31245729519a970d14c7a105ee455c67524
+  metadata.gz: b97d29242854a8a2f45cc111ce7ca9ebd4367bc966a103a528a0873e3411ddee
+  data.tar.gz: ca75043dbd897e34817fd24879be0c95fda398c06d1b8a73863da86847eb1f22
 SHA512:
-  metadata.gz: 679d1d72f5eeb7cf00fbabb334ae85471808541a74c96c70de8964ea4d630690c3f9a851a78bf7879782b53e0753862e866bb337b2553e3ed989599778a6666d
-  data.tar.gz: 5d0bb9342599fbbea0e2e1f2f9f4347dcdaa91929a33b4cf85a39533fa34d6c820c3081f6118607081161e8ef65d48696cfa00b7a9f5147e98948b63ab034109
+  metadata.gz: f2045ed2f107a293039ad933d1e4f584a1063ff3cd763d728aa230ecc182f8f105d71f90faeef034e0aba6b2740d8805600ec8052389c7c6e67b2fb411e8c9b7
+  data.tar.gz: 88fb1e14b251c8188b45dd4594f65c849bbaa25333434b55353749c424b9d387dfd83c358947a46cdde1ace806c6da0117e99567a601111c4b8d77468826c4f5

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+# 2.11.7
+- Fix ActionCable integration in test environment using `stub_connection`.
+  PR #705
+
 # 2.11.6
 - Prepend Sidekiq middleware to wrap all Sidekiq middleware. Catches more
   errors and provide more complete performance measurements. PR #698

data/lib/appsignal/hooks/action_cable.rb

@@ -56,7 +56,11 @@ module Appsignal
       def install_callbacks
         ActionCable::Channel::Base.set_callback :subscribe, :around, :prepend => true do |channel, inner|
           # The request is only the original websocket request
-          env = channel.connection.env
+          connection = channel.connection
+          # #env is not available on the Rails ConnectionStub class used in the
+          # Rails app test suite. If we call `#env` it causes an error to occur
+          # in apps' test suites.
+          env = connection.respond_to?(:env) ? connection.env : {}
           request = ActionDispatch::Request.new(env)
           env[Appsignal::Hooks::ActionCableHook::REQUEST_ID] ||=
             request.request_id || SecureRandom.uuid
@@ -84,7 +88,11 @@ module Appsignal
 
         ActionCable::Channel::Base.set_callback :unsubscribe, :around, :prepend => true do |channel, inner|
           # The request is only the original websocket request
-          env = channel.connection.env
+          connection = channel.connection
+          # #env is not available on the Rails ConnectionStub class used in the
+          # Rails app test suite. If we call `#env` it causes an error to occur
+          # in apps' test suites.
+          env = connection.respond_to?(:env) ? connection.env : {}
           request = ActionDispatch::Request.new(env)
           env[Appsignal::Hooks::ActionCableHook::REQUEST_ID] ||=
             request.request_id || SecureRandom.uuid

data/lib/appsignal/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Appsignal
-  VERSION = "2.11.6".freeze
+  VERSION = "2.11.7".freeze
 end

data/spec/lib/appsignal/hooks/action_cable_spec.rb

@@ -2,6 +2,8 @@ describe Appsignal::Hooks::ActionCableHook do
   if DependencyHelper.action_cable_present?
     context "with ActionCable" do
       require "action_cable/engine"
+      # Require test helper to test with ConnectionStub
+      require "action_cable/channel/test_case" if DependencyHelper.rails6_present?
 
       describe ".dependencies_present?" do
         subject { described_class.new.dependencies_present? }
@@ -262,6 +264,49 @@ describe Appsignal::Hooks::ActionCableHook do
               )
             end
           end
+
+          if DependencyHelper.rails6_present?
+            context "with ConnectionStub" do
+              let(:connection) { ActionCable::Channel::ConnectionStub.new }
+              let(:transaction_id) { "Stubbed transaction id" }
+              before do
+                # Stub future (private AppSignal) transaction id generated by the hook.
+                expect(SecureRandom).to receive(:uuid).and_return(transaction_id)
+              end
+
+              it "does not fail on missing `#env` method on `ConnectionStub`" do
+                instance.subscribe_to_channel
+
+                expect(subject).to include(
+                  "action" => "MyChannel#subscribed",
+                  "error" => nil,
+                  "id" => transaction_id,
+                  "namespace" => Appsignal::Transaction::ACTION_CABLE,
+                  "metadata" => {
+                    "method" => "websocket",
+                    "path" => "" # No path as the ConnectionStub doesn't have the real request env
+                  }
+                )
+                expect(subject["events"].first).to include(
+                  "allocation_count" => kind_of(Integer),
+                  "body" => "",
+                  "body_format" => Appsignal::EventFormatter::DEFAULT,
+                  "child_allocation_count" => kind_of(Integer),
+                  "child_duration" => kind_of(Float),
+                  "child_gc_duration" => kind_of(Float),
+                  "count" => 1,
+                  "gc_duration" => kind_of(Float),
+                  "start" => kind_of(Float),
+                  "duration" => kind_of(Float),
+                  "name" => "subscribed.action_cable",
+                  "title" => ""
+                )
+                expect(subject["sample_data"]).to include(
+                  "params" => { "internal" => "true" }
+                )
+              end
+            end
+          end
         end
 
         describe "unsubscribe callback" do
@@ -349,6 +394,49 @@ describe Appsignal::Hooks::ActionCableHook do
               )
             end
           end
+
+          if DependencyHelper.rails6_present?
+            context "with ConnectionStub" do
+              let(:connection) { ActionCable::Channel::ConnectionStub.new }
+              let(:transaction_id) { "Stubbed transaction id" }
+              before do
+                # Stub future (private AppSignal) transaction id generated by the hook.
+                expect(SecureRandom).to receive(:uuid).and_return(transaction_id)
+              end
+
+              it "does not fail on missing `#env` method on `ConnectionStub`" do
+                instance.unsubscribe_from_channel
+
+                expect(subject).to include(
+                  "action" => "MyChannel#unsubscribed",
+                  "error" => nil,
+                  "id" => transaction_id,
+                  "namespace" => Appsignal::Transaction::ACTION_CABLE,
+                  "metadata" => {
+                    "method" => "websocket",
+                    "path" => "" # No path as the ConnectionStub doesn't have the real request env
+                  }
+                )
+                expect(subject["events"].first).to include(
+                  "allocation_count" => kind_of(Integer),
+                  "body" => "",
+                  "body_format" => Appsignal::EventFormatter::DEFAULT,
+                  "child_allocation_count" => kind_of(Integer),
+                  "child_duration" => kind_of(Float),
+                  "child_gc_duration" => kind_of(Float),
+                  "count" => 1,
+                  "gc_duration" => kind_of(Float),
+                  "start" => kind_of(Float),
+                  "duration" => kind_of(Float),
+                  "name" => "unsubscribed.action_cable",
+                  "title" => ""
+                )
+                expect(subject["sample_data"]).to include(
+                  "params" => { "internal" => "true" }
+                )
+              end
+            end
+          end
         end
       end
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: appsignal
 version: !ruby/object:Gem::Version
-  version: 2.11.6
+  version: 2.11.7
 platform: java
 authors:
 - Robert Beekman
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-02-08 00:00:00.000000000 Z
+date: 2021-02-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -432,7 +432,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.6
+rubygems_version: 3.2.8
 signing_key:
 specification_version: 4
 summary: Logs performance and exception data from your app to appsignal.com