Skip to content

armgit / spree

Public Imported from GitHub
0

Open Source Platform for DTC, B2B Commerce, Marketplaces & Omnichannel. REST APIs, TypeScript SDKs, and production-ready Next.js storefront. Self-host it. Own your data. No vendor lock-in. Zero platform fees.

Replace Spree's `ErrorHandler` with native Rails's error handler (#12573)

Damian Kaczmarczyk2fb41002bd8e
diff --git a/api/app/controllers/spree/api/v2/base_controller.rb b/api/app/controllers/spree/api/v2/base_controller.rb
index 0e31173c6c..a910eb6525 100644
--- a/api/app/controllers/spree/api/v2/base_controller.rb
+++ b/api/app/controllers/spree/api/v2/base_controller.rb
@@ -145,13 +145,13 @@ module Spree
end
def record_not_found(exception)
- result = error_handler.call(exception: exception, opts: { user: spree_current_user })
+ Rails.error.report(exception, context: { user_id: spree_current_user&.id }, source: 'spree.api')
render_error_payload(I18n.t(:resource_not_found, scope: 'spree.api'), 404)
end
def access_denied(exception)
- result = error_handler.call(exception: exception, opts: { user: spree_current_user })
+ Rails.error.report(exception, context: { user_id: spree_current_user&.id }, source: 'spree.api')
render_error_payload(exception.message, 403)
end
@@ -161,19 +161,17 @@ module Spree
end
def gateway_error(exception)
- result = error_handler.call(exception: exception, opts: { user: spree_current_user })
+ Rails.error.report(exception, context: { user_id: spree_current_user&.id }, source: 'spree.api')
render_error_payload(exception.message)
end
def error_during_processing(exception)
- result = error_handler.call(exception: exception, opts: { user: spree_current_user })
+ Rails.error.report(exception, context: { user_id: spree_current_user&.id }, source: 'spree.api')
- render_error_payload(result.value[:message], 400)
- end
+ message = exception.respond_to?(:original_message) ? exception.original_message : exception.message
- def error_handler
- Spree::Api::Dependencies.error_handler.constantize
+ render_error_payload(message, 400)
end
end
end
diff --git a/api/lib/spree/api/dependencies.rb b/api/lib/spree/api/dependencies.rb
index 7ce51ba47c..868da5b057 100644
--- a/api/lib/spree/api/dependencies.rb
+++ b/api/lib/spree/api/dependencies.rb
@@ -86,8 +86,6 @@ module Spree
storefront_taxon_finder: -> { Spree::Dependencies.taxon_finder },
storefront_variant_finder: -> { Spree::Dependencies.variant_finder },
- error_handler: 'Spree::ErrorHandler',
-
# serializers
platform_admin_user_serializer: 'Spree::Api::V2::Platform::AdminUserSerializer',
diff --git a/api/spec/controllers/spree/api/v2/base_controller_spec.rb b/api/spec/controllers/spree/api/v2/base_controller_spec.rb
index eaf6f19e09..850dd0d24a 100644
--- a/api/spec/controllers/spree/api/v2/base_controller_spec.rb
+++ b/api/spec/controllers/spree/api/v2/base_controller_spec.rb
@@ -110,12 +110,7 @@ describe Spree::Api::V2::BaseController, type: :controller do
it do
expect(subject).to receive(:index).and_raise(exception)
expect(subject).to receive(:spree_current_user).at_least(:once).and_return(user)
- expect_next_instance_of(::Spree::ErrorHandler) do |instance|
- expect(instance).to receive(:call).with(
- exception: exception,
- opts: { user: user }
- ).and_return(result)
- end
+ expect(Rails.error).to receive(:report).with(exception, context: { user_id: user.id }, source: 'spree.api')
get :index, params: { token: 'exception-message' }
expect(json_response).to eql('error' => 'foo')
end
diff --git a/api/spec/requests/spree/api/v2/errors_spec.rb b/api/spec/requests/spree/api/v2/errors_spec.rb
index f8bee3b198..4b2bab8825 100644
--- a/api/spec/requests/spree/api/v2/errors_spec.rb
+++ b/api/spec/requests/spree/api/v2/errors_spec.rb
@@ -28,12 +28,12 @@ describe 'API v2 Errors spec', type: :request do
end
it 'calls error handler' do
- expect_next_instance_of(::Spree::ErrorHandler) do |instance|
- expect(instance).to receive(:call).with(
- exception: instance_of(CanCan::AccessDenied),
- opts: { user: user }
- )
- end
+ expect(Rails.error).to receive(:report).with(
+ instance_of(CanCan::AccessDenied),
+ context: { user_id: user.id },
+ source: 'spree.api'
+ )
+
patch '/api/v2/storefront/cart/empty', headers: headers_bearer
end
end
diff --git a/core/app/jobs/spree/addresses/geocode_address_job.rb b/core/app/jobs/spree/addresses/geocode_address_job.rb
index ea1c9c7b0a..4a744a308e 100644
--- a/core/app/jobs/spree/addresses/geocode_address_job.rb
+++ b/core/app/jobs/spree/addresses/geocode_address_job.rb
@@ -18,9 +18,11 @@ module Spree
else
# Unfortunately there is no way to get the error message from Geocoder,
# but the request is fully displayed in the server logs
- Spree::Dependencies.error_handler.constantize.call(
- exception: GeocodeAddressError.new("Cannot geocode address ID: #{address.id}"),
- opts: { report_context: { address_id: address_id } }
+ Rails.error.report(
+ GeocodeAddressError.new("Cannot geocode address ID: #{address.id}"),
+ handled: false,
+ context: { address_id: address_id },
+ source: 'spree.core'
)
end
end
diff --git a/core/app/services/spree/error_handler.rb b/core/app/services/spree/error_handler.rb
deleted file mode 100644
index 1b7f0baad1..0000000000
--- a/core/app/services/spree/error_handler.rb
+++ /dev/null
@@ -1,53 +0,0 @@
-module Spree
- class ErrorHandler
- prepend ::Spree::ServiceModule::Base
-
- # Handles errors and logs them to the console.
- #
- # @param exception [Exception]
- # @param opts [Hash]
- # @option opts [Hash] :report_context
- # @option opts [User] :user
- def call(exception:, opts: {})
- run :format_message
- run :log_error
- run :report_error
- end
-
- protected
-
- def format_message(exception:, opts: {})
- message = if exception.respond_to?(:original_message)
- exception.original_message
- else
- exception.message
- end
-
- success(exception: exception, message: message, opts: opts)
- end
-
- def log_error(exception:, message:, opts: {})
- Rails.logger.error message
- Rails.logger.error "User ID: #{opts[:user]&.id}" if opts[:user]
- Rails.logger.error exception.backtrace.join("\n") if exception.backtrace.present?
-
- success(exception: exception, message: message, opts: opts)
- end
-
- def report_error(exception:, message:, opts: {})
- # overwrite this method in your application to support different error handlers
- # eg. Sentry, Rollbar, etc
- if defined?(Sentry)
- if opts[:report_context].present?
- Sentry.configure_scope do |scope|
- scope.set_context(:extra, opts[:report_context])
- end
- end
-
- Sentry.capture_exception(exception)
- end
-
- success(exception: exception, message: message)
- end
- end
-end
diff --git a/core/lib/spree/core/dependencies.rb b/core/lib/spree/core/dependencies.rb
index 82435ab416..73daa3a982 100644
--- a/core/lib/spree/core/dependencies.rb
+++ b/core/lib/spree/core/dependencies.rb
@@ -80,9 +80,6 @@ module Spree
payment_create_service: 'Spree::Payments::Create',
- # errors
- error_handler: 'Spree::ErrorHandler',
-
# data feeds
data_feeds_google_rss_service: 'Spree::DataFeeds::Google::Rss',
data_feeds_google_optional_attributes_service: 'Spree::DataFeeds::Google::OptionalAttributes',
diff --git a/core/spec/jobs/spree/addresses/geocode_address_job_spec.rb b/core/spec/jobs/spree/addresses/geocode_address_job_spec.rb
index 0c37601367..c43236dcbb 100644
--- a/core/spec/jobs/spree/addresses/geocode_address_job_spec.rb
+++ b/core/spec/jobs/spree/addresses/geocode_address_job_spec.rb
@@ -34,21 +34,16 @@ RSpec.describe Spree::Addresses::GeocodeAddressJob do
context 'when the address cannot be geocoded' do
let(:geocoder_coordinates) { nil }
- let(:error_handler) { instance_double(Spree::ErrorHandler, call: nil) }
-
- before do
- allow(Spree::ErrorHandler).to receive(:new).and_return(error_handler)
- allow(error_handler).to receive(:call)
- end
it 'handles the error' do
- geocode_address
+ expect(Rails.error).to receive(:report).with(
+ Spree::Addresses::GeocodeAddressError.new("Cannot geocode address ID: #{address.id}"),
+ handled: false,
+ context: { address_id: address.id },
+ source: 'spree.core'
+ )
- expect(error_handler).to have_received(:call).
- with(
- exception: Spree::Addresses::GeocodeAddressError.new("Cannot geocode address ID: #{address.id}"),
- opts: { report_context: { address_id: address.id } }
- )
+ geocode_address
expect(address.reload.latitude).to be_nil
expect(address.longitude).to be_nil
diff --git a/core/spec/services/spree/error_handler_spec.rb b/core/spec/services/spree/error_handler_spec.rb
deleted file mode 100644
index 9d8e121515..0000000000
--- a/core/spec/services/spree/error_handler_spec.rb
+++ /dev/null
@@ -1,33 +0,0 @@
-require 'spec_helper'
-
-RSpec.describe Spree::ErrorHandler do
- class CustomException < StandardError
- def backtrace
- ['a', 'b']
- end
- end
-
- let(:message) { 'error' }
- let(:exception) { CustomException.new(message) }
- let(:user) { create :user }
-
- subject { described_class.call(exception: exception, opts: { user: user }) }
- let(:result) { subject }
-
- it 'returns result with error' do
- expect(Rails.logger).to receive(:error).with(message)
- expect(Rails.logger).to receive(:error).with("User ID: #{user.id}")
- expect(Rails.logger).to receive(:error).with(exception.backtrace.join("\n"))
-
- expect(result.value).to eq({ exception: exception, message: message })
- end
-
- context 'without opts ' do
- subject { described_class.call(exception: exception) }
- let(:result) { subject }
-
- it 'returns result with error' do
- expect(result.value).to eq({ exception: exception, message: message })
- end
- end
-end
diff --git a/storefront/app/controllers/spree/checkout_controller.rb b/storefront/app/controllers/spree/checkout_controller.rb
index 97a7e033f3..700f1070b6 100644
--- a/storefront/app/controllers/spree/checkout_controller.rb
+++ b/storefront/app/controllers/spree/checkout_controller.rb
@@ -319,15 +319,10 @@ module Spree
end
def rescue_from_spree_gateway_error(exception)
- Spree::Dependencies.error_handler.constantize.call(
- exception: exception,
- opts: {
- report_context: {
- order_id: @order&.id,
- order_number: @order&.number,
- error_type: 'gateway_error'
- }
- }
+ Rails.error.report(
+ exception,
+ context: { order_id: @order&.id, order_number: @order&.number, error_type: 'gateway_error' },
+ source: 'spree.storefront'
)
flash.now[:error] = Spree.t(:spree_gateway_error_flash_for_checkout)
diff --git a/storefront/app/controllers/spree/contacts_controller.rb b/storefront/app/controllers/spree/contacts_controller.rb
index 46b3a06f25..2d8ed35742 100644
--- a/storefront/app/controllers/spree/contacts_controller.rb
+++ b/storefront/app/controllers/spree/contacts_controller.rb
@@ -27,13 +27,10 @@ module Spree
end
def message_not_sent(exception = nil)
- Spree::Dependencies.error_handler.constantize.call(
- exception: exception || StandardError.new('Contact Form Message not sent'),
- opts: {
- report_context: {
- contact: @contact&.id
- }
- }
+ Rails.error.report(
+ exception || StandardError.new('Contact Form Message not sent'),
+ context: { contact_id: @contact&.id },
+ source: 'spree.storefront'
)
flash[:error] = Spree.t('storefront.contacts.message_not_sent')
diff --git a/storefront/app/controllers/spree/store_controller.rb b/storefront/app/controllers/spree/store_controller.rb
index c7b9281119..a3e2d32d68 100644
--- a/storefront/app/controllers/spree/store_controller.rb
+++ b/storefront/app/controllers/spree/store_controller.rb
@@ -230,7 +230,11 @@ module Spree
end
def invalid_authenticity_token(exception)
- Spree::Dependencies.error_handler.constantize.call(exception: exception)
+ Rails.error.report(
+ exception,
+ context: { user_id: spree_current_user&.id },
+ source: 'spree.storefront'
+ )
flash[:error] = Spree.t(:something_went_wrong)
diff --git a/storefront/app/helpers/spree/analytics_helper.rb b/storefront/app/helpers/spree/analytics_helper.rb
index 1618c11ea3..793ba987db 100644
--- a/storefront/app/helpers/spree/analytics_helper.rb
+++ b/storefront/app/helpers/spree/analytics_helper.rb
@@ -14,9 +14,10 @@ module Spree
handler.handle_event(event_name, record)
end
rescue => e
- Spree::Dependencies.error_handler.constantize.call(
- exception: e,
- opts: { report_context: { event_name: event_name, record: record } }
+ Rails.error.report(
+ e,
+ context: { event_name: event_name, record_id: record&.id, record_type: record&.class&.name },
+ source: 'spree.storefront'
)
end
diff --git a/storefront/app/helpers/spree/page_helper.rb b/storefront/app/helpers/spree/page_helper.rb
index 9e2d718f22..10b90626ba 100644
--- a/storefront/app/helpers/spree/page_helper.rb
+++ b/storefront/app/helpers/spree/page_helper.rb
@@ -49,7 +49,8 @@ module Spree
rescue ActionView::MissingTemplate, ActionView::Template::Error => e
raise e unless Rails.env.production?
- Spree::Dependencies.error_handler.constantize.call(exception: e, extra: { section: section })
+ Rails.error.report(e, context: { section_id: section.id }, source: 'spree.storefront')
+
''
end
diff --git a/storefront/app/helpers/spree/theme_helper.rb b/storefront/app/helpers/spree/theme_helper.rb
index b2ec246462..abce5860c9 100644
--- a/storefront/app/helpers/spree/theme_helper.rb
+++ b/storefront/app/helpers/spree/theme_helper.rb
@@ -50,7 +50,8 @@ module Spree
rescue StandardError => e
raise e unless Rails.env.production?
- Spree::Dependencies.error_handler.constantize.call(exception: e)
+ Rails.error.report(e, context: { theme_id: current_theme_or_preview.id }, source: 'spree.storefront')
+
{}
end