uniform_notifier 1.14.2 → 1.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1920cf91de7d2884a04afe7b4bb3f47b5aaf05fffb71e014631fbc1a1eb7c1bd
-  data.tar.gz: 8798d5ba9cb5ddc6bed1a05895ec4bd85c03aa690df1aa9dba5eb1abb45b7619
+  metadata.gz: 8cbfb1cbe32444a41960c0a9671bac48a43d96722312c1717c0c4e7a2a804433
+  data.tar.gz: 6c82f5aa72805717af977bc454464eaaf6cf2222e96cf6b97581265eb52ec678
 SHA512:
-  metadata.gz: 0d6382aff6ad0043e90d3f82853367f480c46c84780df5928d073b8acd64055e5dfbc6c58e468f4115325adf980c907c10d0d1b87f4c5db7deeda9fe37fceb8e
-  data.tar.gz: b3de13ddb6ca896814f325d14deff64c7353af2117a32441c604235ae1abac1855bb42826d64188fa8ee71c0179a6313332df7dd85b6682f9d19473c8b11f651
+  metadata.gz: 6870a31994f2d3592c30f145c76efedb4cb773053231732d4a2e369ced6ff013f37c673df7279d90bd4067dfd6029073b55fc24b957936519033abae809aef94
+  data.tar.gz: '09a5bb04b7966baf30a5af2b207dd7e33c2450e8058ebf16efe23ce7f024f3330e49ceaf07b3c1571fb0b316e1fffa1ce62673431f2145ac2762fe2b55e19b16'

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Next Release
 
+# 1.15.0 (03/21/2022)
+
+* Fix bugsnag notifications
+* Improve appsignal message
+
 # 1.14.2 (03/24/2021)
 
 * Fix `capture_exception` signature
@@ -11,7 +16,7 @@
 # 1.14.0 (02/26/2021)
 
 * Add AppSignal integration
-* Fix UniformNotifier::Raise.active? when .rails= receives a false value
+* Fix `UniformNotifier::Raise.active?` when `.rails=` receives a false value
 
 ## 1.13.0 (10/05/2019)
 

data/lib/uniform_notifier/appsignal.rb

@@ -12,13 +12,16 @@ class UniformNotifier
       def _out_of_channel_notify(data)
         opt = UniformNotifier.appsignal.is_a?(Hash) ? UniformNotifier.appsignal : {}
 
-        exception = Exception.new(data[:title])
+        exception = Exception.new("#{data[:title]}\n#{data[:body]}")
         exception.set_backtrace(data[:backtrace]) if data[:backtrace]
 
         tags = opt.fetch(:tags, {}).merge(data.fetch(:tags, {}))
         namespace = data[:namespace] || opt[:namespace]
 
-        Appsignal.send_error(*[exception, tags, namespace].compact)
+        Appsignal.send_error(exception) do |transaction|
+          transaction.set_tags(tags)
+          transaction.set_namespace(namespace)
+        end
       end
     end
   end

data/lib/uniform_notifier/bugsnag.rb

@@ -10,12 +10,20 @@ class UniformNotifier
       protected
 
       def _out_of_channel_notify(data)
-        opt = {}
-        opt = UniformNotifier.bugsnag if UniformNotifier.bugsnag.is_a?(Hash)
-
         exception = Exception.new(data[:title])
         exception.set_backtrace(data[:backtrace]) if data[:backtrace]
-        Bugsnag.notify(exception, opt.merge(grouping_hash: data[:body] || data[:title], notification: data))
+
+        return nil if data.empty?
+
+        Bugsnag.notify(exception) do |report|
+          report.severity = "warning"
+          report.add_tab(:bullet, data)
+          report.grouping_hash = data[:body] || data[:title]
+
+          if UniformNotifier.bugsnag.is_a?(Proc)
+            UniformNotifier.bugsnag.call(report)
+          end
+        end
       end
     end
   end

data/lib/uniform_notifier/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class UniformNotifier
-  VERSION = '1.14.2'
+  VERSION = '1.15.0'
 end

data/spec/uniform_notifier/appsignal_spec.rb

@@ -12,39 +12,50 @@ RSpec.describe UniformNotifier::AppsignalNotifier do
   end
 
   it 'should notify appsignal with keyword title' do
-    expect(Appsignal).to receive(:send_error).with(UniformNotifier::Exception.new('notify appsignal'), {})
+    expect(Appsignal).to receive(:send_error).with(UniformNotifier::Exception.new("notify appsignal\n"))
 
     UniformNotifier.appsignal = true
     expect(UniformNotifier::AppsignalNotifier.out_of_channel_notify(title: 'notify appsignal'))
   end
 
   it 'should notify appsignal with first argument title' do
-    expect(Appsignal).to receive(:send_error).with(UniformNotifier::Exception.new('notify appsignal'), {})
+    expect(Appsignal).to receive(:send_error).with(
+      UniformNotifier::Exception.new("notify appsignal\n")
+    )
 
     UniformNotifier.appsignal = true
     UniformNotifier::AppsignalNotifier.out_of_channel_notify('notify appsignal')
   end
 
   it 'should notify appsignal with tags' do
-    expect(Appsignal).to receive(:send_error).with(UniformNotifier::Exception.new('notify appsignal'), { foo: :bar })
+    transaction = double('Appsignal::Transaction', set_namespace: nil)
+    expect(transaction).to receive(:set_tags).with({ foo: :bar })
+    expect(Appsignal).to receive(:send_error).with(
+      UniformNotifier::Exception.new("notify appsignal\n")
+    ).and_yield(transaction)
 
     UniformNotifier.appsignal = true
     UniformNotifier::AppsignalNotifier.out_of_channel_notify(title: 'notify appsignal', tags: { foo: :bar })
   end
 
   it 'should notify appsignal with default namespace' do
-    expect(Appsignal).to receive(:send_error).with(UniformNotifier::Exception.new('notify appsignal'), {}, 'web')
+    transaction = double('Appsignal::Transaction', set_tags: nil)
+    expect(transaction).to receive(:set_namespace).with('web')
+    expect(Appsignal).to receive(:send_error).with(
+      UniformNotifier::Exception.new("notify appsignal\n")
+    ).and_yield(transaction)
 
     UniformNotifier.appsignal = { namespace: 'web' }
     UniformNotifier::AppsignalNotifier.out_of_channel_notify('notify appsignal')
   end
 
   it 'should notify appsignal with overridden namespace' do
+    transaction = double('Appsignal::Transaction')
+    expect(transaction).to receive(:set_tags).with({ foo: :bar })
+    expect(transaction).to receive(:set_namespace).with('background')
     expect(Appsignal).to receive(:send_error).with(
-      UniformNotifier::Exception.new('notify appsignal'),
-      { foo: :bar },
-      'background'
-    )
+      UniformNotifier::Exception.new("notify appsignal\nbody")
+    ).and_yield(transaction)
 
     UniformNotifier.appsignal = { namespace: 'web' }
     UniformNotifier::AppsignalNotifier.out_of_channel_notify(
@@ -52,16 +63,18 @@ RSpec.describe UniformNotifier::AppsignalNotifier do
       tags: {
         foo: :bar
       },
-      namespace: 'background'
+      namespace: 'background',
+      body: 'body',
     )
   end
 
   it 'should notify appsignal with merged tags' do
+    transaction = double('Appsignal::Transaction')
+    expect(transaction).to receive(:set_tags).with({ user: 'Bob', hostname: 'frontend2', site: 'first' })
+    expect(transaction).to receive(:set_namespace).with('background')
     expect(Appsignal).to receive(:send_error).with(
-      UniformNotifier::Exception.new('notify appsignal'),
-      { user: 'Bob', hostname: 'frontend2', site: 'first' },
-      'background'
-    )
+      UniformNotifier::Exception.new("notify appsignal\nbody")
+    ).and_yield(transaction)
 
     UniformNotifier.appsignal = { namespace: 'web', tags: { hostname: 'frontend1', user: 'Bob' } }
     UniformNotifier::AppsignalNotifier.out_of_channel_notify(
@@ -70,6 +83,7 @@ RSpec.describe UniformNotifier::AppsignalNotifier do
         hostname: 'frontend2',
         site: 'first'
       },
+      body: 'body',
       namespace: 'background'
     )
   end

data/spec/uniform_notifier/bugsnag_spec.rb

@@ -8,47 +8,51 @@ end
 
 RSpec.describe UniformNotifier::BugsnagNotifier do
   let(:notification_data) { {} }
+  let(:report) { double('Bugsnag::Report') }
+  before do
+    allow(report).to receive(:severity=)
+    allow(report).to receive(:add_tab)
+    allow(report).to receive(:grouping_hash=)
+  end
   it 'should not notify bugsnag' do
     expect(Bugsnag).not_to receive(:notify)
     UniformNotifier::BugsnagNotifier.out_of_channel_notify(notification_data)
   end
   context 'with string notification' do
-    let(:notification_data) { { user: 'user', title: 'notify bugsnag', url: 'URL', body: 'something' } }
+    let(:notification_data) { 'notify bugsnag' }
 
     it 'should notify bugsnag' do
       expect(Bugsnag).to receive(:notify).with(
-        UniformNotifier::Exception.new(notification_data[:title]),
-        grouping_hash: notification_data[:body],
-        notification: notification_data
-      )
+        UniformNotifier::Exception.new(notification_data)
+      ).and_yield(report)
+      expect(report).to receive(:severity=).with('warning')
+      expect(report).to receive(:add_tab).with(:bullet, title: notification_data)
+      expect(report).to receive(:grouping_hash=).with(notification_data)
 
       UniformNotifier.bugsnag = true
       UniformNotifier::BugsnagNotifier.out_of_channel_notify(notification_data)
     end
 
-    it 'should notify bugsnag with option' do
+    it 'should notify bugsnag with additional report configuration' do
       expect(Bugsnag).to receive(:notify).with(
-        UniformNotifier::Exception.new(notification_data[:title]),
-        foo: :bar,
-        grouping_hash: notification_data[:body],
-        notification: notification_data
-      )
+        UniformNotifier::Exception.new(notification_data)
+      ).and_yield(report)
+      expect(report).to receive(:meta_data=).with(foo: :bar)
 
-      UniformNotifier.bugsnag = { foo: :bar }
+      UniformNotifier.bugsnag = ->(report) { report.meta_data = { foo: :bar } }
       UniformNotifier::BugsnagNotifier.out_of_channel_notify(notification_data)
     end
   end
   context 'with hash notification' do
-    let(:notification_data) { 'notify bugsnag' }
+    let(:notification_data) { { user: 'user', title: 'notify bugsnag', url: 'URL', body: 'something' } }
 
     it 'should notify bugsnag' do
       expect(Bugsnag).to receive(:notify).with(
-        UniformNotifier::Exception.new('notify bugsnag'),
-        grouping_hash: 'notify bugsnag',
-        notification: {
-          title: 'notify bugsnag'
-        }
-      )
+        UniformNotifier::Exception.new(notification_data[:title])
+      ).and_yield(report)
+      expect(report).to receive(:severity=).with('warning')
+      expect(report).to receive(:add_tab).with(:bullet, notification_data)
+      expect(report).to receive(:grouping_hash=).with(notification_data[:body])
 
       UniformNotifier.bugsnag = true
       UniformNotifier::BugsnagNotifier.out_of_channel_notify(notification_data)
@@ -56,15 +60,11 @@ RSpec.describe UniformNotifier::BugsnagNotifier do
 
     it 'should notify bugsnag with option' do
       expect(Bugsnag).to receive(:notify).with(
-        UniformNotifier::Exception.new('notify bugsnag'),
-        foo: :bar,
-        grouping_hash: 'notify bugsnag',
-        notification: {
-          title: 'notify bugsnag'
-        }
-      )
+        UniformNotifier::Exception.new(notification_data[:title])
+      ).and_yield(report)
+      expect(report).to receive(:meta_data=).with(foo: :bar)
 
-      UniformNotifier.bugsnag = { foo: :bar }
+      UniformNotifier.bugsnag = ->(report) { report.meta_data = { foo: :bar } }
       UniformNotifier::BugsnagNotifier.out_of_channel_notify(notification_data)
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: uniform_notifier
 version: !ruby/object:Gem::Version
-  version: 1.14.2
+  version: 1.15.0
 platform: ruby
 authors:
 - Richard Huang
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-03-23 00:00:00.000000000 Z
+date: 2022-03-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -154,7 +154,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: uniform notifier for rails logger, customized logger, javascript alert, javascript