mirror of https://github.com/chatwoot/chatwoot.git
chore: Upgrade Exception tracking (#4638)
- Upgrade Sentry Libraries - Enable provision for account and user info in error tracking - Add ChatwootExceptionTracker fixes: #4375pull/4659/head
Sojan Jose
2 years ago
committed by
GitHub
parent
360b438a55
commit
04dfb034cc
@ -0,0 +1,32 @@
|
||||
###############
|
||||
# One library to capture_exception and send to the specific service.
|
||||
# # e as exception, u for user and a for account (user and account are optional)
|
||||
# Usage: ChatwootExceptionTracker(e, user: u, account: a).capture_exception
|
||||
############
|
||||
|
||||
class ChatwootExceptionTracker
|
||||
def initialize(exception, user: nil, account: nil)
|
||||
@exception = exception
|
||||
@user = user
|
||||
@account = account
|
||||
end
|
||||
|
||||
def capture_exception
|
||||
capture_exception_with_sentry if ENV['SENTRY_DSN'].present?
|
||||
# Implement other providers like honeybadger, rollbar etc in future
|
||||
end
|
||||
|
||||
private
|
||||
|
||||
def capture_exception_with_sentry
|
||||
Sentry.with_scope do |scope|
|
||||
if @account.present?
|
||||
scope.set_context('account', { id: @account.id, name: @account.name })
|
||||
scope.set_tags(account_id: @account.id)
|
||||
end
|
||||
|
||||
scope.set_user(id: @user.id, email: @user.email) if @user.is_a?(User)
|
||||
Sentry.capture_exception(@exception)
|
||||
end
|
||||
end
|
||||
end
|
||||
@ -0,0 +1,23 @@
|
||||
require 'rails_helper'
|
||||
|
||||
describe ChatwootExceptionTracker do
|
||||
it 'returns nil if no tracker is configured' do
|
||||
expect(described_class.new('random').capture_exception).to eq(nil)
|
||||
end
|
||||
|
||||
context 'with sentry DSN' do
|
||||
before do
|
||||
# since sentry is not initated in test, we need to do it manually
|
||||
Sentry.init do |config|
|
||||
config.dsn = 'test'
|
||||
end
|
||||
end
|
||||
|
||||
it 'will call sentry capture exception' do
|
||||
with_modified_env SENTRY_DSN: 'random dsn' do
|
||||
expect(Sentry).to receive(:capture_exception).with('random')
|
||||
described_class.new('random').capture_exception
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
Loading…
Reference in new issue