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.
Ruby b2b-commercee-commerceecommerceecommerce-apiecommerce-frameworkecommerce-platformheadlessheadless-commerceheadless-ecommercemarketplacemulti-tenantmulti-vendormulti-vendor-ecommerceopen-sourcespree-commerce
Add Spree::Api::ErrorHandler (#10783)
Damian Legawiecea8b1a3da476
diff --git a/api/app/controllers/spree/api/v2/base_controller.rb b/api/app/controllers/spree/api/v2/base_controller.rbindex 8ef5d83d6f..b0806b33e9 100644--- a/api/app/controllers/spree/api/v2/base_controller.rb+++ b/api/app/controllers/spree/api/v2/base_controller.rb@@ -10,6 +10,8 @@ module Spreerescue_from ActiveRecord::RecordNotFound, with: :record_not_foundrescue_from CanCan::AccessDenied, with: :access_deniedrescue_from Spree::Core::GatewayError, with: :gateway_error+ rescue_from ActionController::ParameterMissing, with: :error_during_processing+ rescue_from ArgumentError, with: :error_during_processingdef content_typeSpree::Api::Config[:api_v2_content_type]@@ -43,8 +45,6 @@ module Spreedef render_serialized_payload(status = 200)render json: yield, status: status, content_type: content_type- rescue ArgumentError => exception- render_error_payload(exception.message, 400)enddef render_error_payload(error, status = 422)@@ -125,6 +125,16 @@ module Spreedef gateway_error(exception)render_error_payload(exception.message)end++ def error_during_processing(exception)+ result = error_handler.call(exception: exception, opts: { user: spree_current_user })++ render_error_payload(result.value[:message], 400)+ end++ def error_handler+ Spree::Api::Dependencies.error_handler.constantize+ endendendenddiff --git a/api/app/models/spree/api_dependencies.rb b/api/app/models/spree/api_dependencies.rbindex 799511429e..e8d3c220e0 100644--- a/api/app/models/spree/api_dependencies.rb+++ b/api/app/models/spree/api_dependencies.rb@@ -16,7 +16,7 @@ module Spree:storefront_cart_update_service, :storefront_cart_estimate_shipping_rates_service, :storefront_estimated_shipment_serializer,:storefront_store_serializer, :storefront_address_serializer, :storefront_order_serializer,:storefront_account_create_address_service, :storefront_account_update_address_service, :storefront_address_finder,- :storefront_collection_sorter+ :storefront_collection_sorter, :error_handler].freezeattr_accessor *INJECTION_POINTS@@ -86,6 +86,8 @@ module Spree@storefront_find_by_variant_finder = Spree::Dependencies.line_item_by_variant_finder@storefront_products_finder = Spree::Dependencies.products_finder@storefront_taxon_finder = Spree::Dependencies.taxon_finder++ @error_handler = 'Spree::Api::ErrorHandler'endendenddiff --git a/api/app/services/spree/api/error_handler.rb b/api/app/services/spree/api/error_handler.rbnew file mode 100644index 0000000000..51ee559153--- /dev/null+++ b/api/app/services/spree/api/error_handler.rb@@ -0,0 +1,40 @@+module Spree+ module Api+ class ErrorHandler+ prepend ::Spree::ServiceModule::Base++ 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")++ 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++ success(exception: exception, message: message)+ end+ end+ end+enddiff --git a/api/spec/controllers/spree/api/v2/base_controller_spec.rb b/api/spec/controllers/spree/api/v2/base_controller_spec.rbindex f2f8853c7d..9849cb4fba 100644--- a/api/spec/controllers/spree/api/v2/base_controller_spec.rb+++ b/api/spec/controllers/spree/api/v2/base_controller_spec.rb@@ -88,4 +88,37 @@ describe Spree::Api::V2::BaseController, type: :controller doendendend++ describe '#error_during_processing' do++ controller(described_class) do+ def index+ render plain: { 'products' => [] }.to_json+ end+ end++ before do+ @routes = ActionDispatch::Routing::RouteSet.new.tap do |r|+ r.draw { get 'index', to: 'spree/api/v2/base#index' }+ end+ end++ let!(:user) { create :user }+ let(:exception) { ArgumentError.new('foo') }+ let(:result_class) { Struct.new(:value) }+ let(:result) { result_class.new({message: 'foo'}) }++ it 'handles ArgumentError exceptions' do+ expect(subject).to receive(:index).and_raise(exception)+ expect(subject).to receive(:spree_current_user).and_return(user)+ expect_next_instance_of(::Spree::Api::ErrorHandler) do |instance|+ expect(instance).to receive(:call).with(+ exception: exception,+ opts: { user: user }+ ).and_return(result)+ end+ get :index, params: { token: 'exception-message' }+ expect(json_response).to eql('error' => 'foo')+ end+ endenddiff --git a/api/spec/services/spree/api/error_handler_spec.rb b/api/spec/services/spree/api/error_handler_spec.rbnew file mode 100644index 0000000000..7f788cf13b--- /dev/null+++ b/api/spec/services/spree/api/error_handler_spec.rb@@ -0,0 +1,26 @@+require 'spec_helper'++module Spree+ describe Api::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+ end+enddiff --git a/api/spec/spec_helper.rb b/api/spec/spec_helper.rbindex 2a2f6703af..fdd081f680 100644--- a/api/spec/spec_helper.rb+++ b/api/spec/spec_helper.rb@@ -35,6 +35,7 @@ Dir[File.dirname(__FILE__) + '/support/**/*.rb'].each { |f| require f }require 'spree/testing_support/factories'require 'spree/testing_support/preferences'require 'spree/testing_support/image_helpers'+require 'spree/testing_support/next_instance_of'require 'spree/api/testing_support/caching'require 'spree/api/testing_support/helpers'@@ -42,6 +43,7 @@ require 'spree/api/testing_support/setup'require 'spree/api/testing_support/v2/base'require 'spree/api/testing_support/v2/current_order'+RSpec.configure do |config|config.backtrace_exclusion_patterns = [/gems\/activesupport/, /gems\/actionpack/, /gems\/rspec/]config.color = truediff --git a/core/app/models/spree/app_dependencies.rb b/core/app/models/spree/app_dependencies.rbindex 54ab158ed0..9db4ef3d6f 100644--- a/core/app/models/spree/app_dependencies.rb+++ b/core/app/models/spree/app_dependencies.rb@@ -13,7 +13,7 @@ module Spree:completed_order_finder, :order_sorter, :cart_compare_line_items_service, :collection_paginator, :products_sorter,:products_finder, :taxon_finder, :line_item_by_variant_finder, :cart_estimate_shipping_rates_service,:account_create_address_service, :account_update_address_service, :address_finder,- :collection_sorter+ :collection_sorter, :error_handler].freezeattr_accessor *INJECTION_POINTS@@ -66,6 +66,8 @@ module Spree# account@account_create_address_service = 'Spree::Account::Addresses::Create'@account_update_address_service = 'Spree::Account::Addresses::Update'++ @error_handler = 'Spree::ErrorReporter'enddef set_default_findersdiff --git a/core/lib/spree/testing_support/next_instance_of.rb b/core/lib/spree/testing_support/next_instance_of.rbnew file mode 100644index 0000000000..92fd436604--- /dev/null+++ b/core/lib/spree/testing_support/next_instance_of.rb@@ -0,0 +1,38 @@+# Helper services with prepended ServiceModule+# https://gitlab.com/gitlab-org/gitlab-foss/-/issues/33587+#+# ex:+# expect_next_instance_of(service_class) do |instance|+# expect(instance).to receive(:call)+# end++module NextInstanceOf+ def expect_next_instance_of(klass, *new_args)+ stub_new(expect(klass), *new_args) do |expectation|+ yield(expectation)+ end+ end++ def allow_next_instance_of(klass, *new_args)+ stub_new(allow(klass), *new_args) do |allowance|+ yield(allowance)+ end+ end++ private++ def stub_new(target, *new_args)+ receive_new = receive(:new)+ receive_new.with(*new_args) if new_args.any?++ target.to receive_new.and_wrap_original do |method, *original_args|+ method.call(*original_args).tap do |instance|+ yield(instance)+ end+ end+ end+end++RSpec.configure do |config|+ config.include NextInstanceOf+end