-
Notifications
You must be signed in to change notification settings - Fork 18
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Improve Claim Evidence API Error Logging (#23304)
* Add CE API Error Handler Class * Add Error Handling Update the VBMSService and SensitivityChecker clases to use the new ClaimEvidenceApiErrorHandler service. * Add Specs * Fix Lint Errors and Spec Failures
- Loading branch information
1 parent
c4b62b1
commit 65ba2ae
Showing
7 changed files
with
416 additions
and
28 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
31 changes: 31 additions & 0 deletions
31
app/services/error_handlers/claim_evidence_api_error_handler.rb
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,31 @@ | ||
# frozen_string_literal: true | ||
|
||
class ErrorHandlers::ClaimEvidenceApiErrorHandler | ||
def handle_error(error:, error_details:) | ||
report_error_to_sentry(error: error, error_details: error_details) | ||
end | ||
|
||
private | ||
|
||
def report_error_to_sentry(error:, error_details:) | ||
Raven.capture_exception( | ||
error, | ||
tags: { feature: "claim_evidence_api" }, | ||
extra: { | ||
feature_toggle_enabled_use_ce_api: use_ce_api?, | ||
feature_toggle_enabled_send_current_user_cred_to_ce_api: send_current_user_cred_to_ce_api?, | ||
user_css_id: error_details[:user_css_id], | ||
user_sensitivity_level: error_details[:user_sensitivity_level], | ||
error_uuid: error_details[:error_uuid] | ||
} | ||
) | ||
end | ||
|
||
def send_current_user_cred_to_ce_api? | ||
FeatureToggle.enabled?(:send_current_user_cred_to_ce_api) | ||
end | ||
|
||
def use_ce_api? | ||
FeatureToggle.enabled?(:use_ce_api) | ||
end | ||
end |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
46 changes: 46 additions & 0 deletions
46
spec/services/error_handlers/claim_evidence_api_error_handler_spec.rb
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,46 @@ | ||
# frozen_string_literal: true | ||
|
||
require "rails_helper" | ||
|
||
describe ErrorHandlers::ClaimEvidenceApiErrorHandler do | ||
subject(:described) { described_class.new } | ||
|
||
describe "#handle_error" do | ||
let(:mock_sentry_client) { class_double(Raven) } | ||
|
||
before do | ||
FeatureToggle.enable!(:use_ce_api) | ||
FeatureToggle.enable!(:send_current_user_cred_to_ce_api) | ||
end | ||
|
||
after do | ||
FeatureToggle.disable!(:use_ce_api) | ||
FeatureToggle.disable!(:send_current_user_cred_to_ce_api) | ||
end | ||
|
||
it "sends the error to its registered clients" do | ||
error = StandardError.new("Example CE API failure") | ||
|
||
expect(Raven).to receive(:capture_exception) | ||
.with( | ||
error, | ||
tags: { feature: "claim_evidence_api" }, | ||
extra: { | ||
feature_toggle_enabled_use_ce_api: true, | ||
feature_toggle_enabled_send_current_user_cred_to_ce_api: true, | ||
user_css_id: "USER_12345", | ||
user_sensitivity_level: 4, | ||
error_uuid: "1234-1234-1234" | ||
} | ||
) | ||
|
||
error_details = { | ||
user_css_id: "USER_12345", | ||
user_sensitivity_level: 4, | ||
error_uuid: "1234-1234-1234" | ||
} | ||
|
||
described.handle_error(error: error, error_details: error_details) | ||
end | ||
end | ||
end |
Oops, something went wrong.