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
Move redirect_unauthorized_access from Core::ControllerHelpers::Auth to frontend/backend
Damian Legawiec32d61a5881ff
diff --git a/backend/app/controllers/spree/admin/base_controller.rb b/backend/app/controllers/spree/admin/base_controller.rbindex 31ddc1a2f3..a14f13c618 100644--- a/backend/app/controllers/spree/admin/base_controller.rb+++ b/backend/app/controllers/spree/admin/base_controller.rb@@ -38,6 +38,24 @@ module Spreeauthorize! action, recordend+ def redirect_unauthorized_access+ if try_spree_current_user+ flash[:error] = Spree.t(:authorization_failure)+ redirect_to spree.admin_forbidden_path+ else+ store_location+ if defined?(spree.admin_login_path)+ redirect_to spree.admin_login_path+ elsif respond_to?(:spree_login_path)+ redirect_to spree_login_path+ elsif spree.respond_to?(:root_path)+ redirect_to spree.root_path+ else+ redirect_to main_app.respond_to?(:root_path) ? main_app.root_path : '/'+ end+ end+ end+# Need to generate an API key for a user due to some backend actions# requiring authentication to the Spree APIdef generate_admin_api_keydiff --git a/backend/app/controllers/spree/admin/errors_controller.rb b/backend/app/controllers/spree/admin/errors_controller.rbnew file mode 100644index 0000000000..8c28b755f4--- /dev/null+++ b/backend/app/controllers/spree/admin/errors_controller.rb@@ -0,0 +1,9 @@+module Spree+ module Admin+ class ErrorsController < BaseController+ def forbidden+ render status: 403+ end+ end+ end+enddiff --git a/backend/app/views/spree/admin/errors/forbidden.html.erb b/backend/app/views/spree/admin/errors/forbidden.html.erbnew file mode 100644index 0000000000..e69de29bb2diff --git a/backend/config/routes.rb b/backend/config/routes.rbindex eaf31288be..4fdf99db52 100644--- a/backend/config/routes.rb+++ b/backend/config/routes.rb@@ -193,6 +193,8 @@ Spree::Core::Engine.add_routes doendendend++ get '/forbidden', to: 'admin/errors#forbidden', as: :forbiddenendspree_path = Rails.application.routes.url_helpers.try(:spree_path, trailing_slash: true) || '/'diff --git a/backend/spec/controllers/spree/admin/base_controller_spec.rb b/backend/spec/controllers/spree/admin/base_controller_spec.rbindex cb86ed9fd1..879a8f0b6b 100644--- a/backend/spec/controllers/spree/admin/base_controller_spec.rb+++ b/backend/spec/controllers/spree/admin/base_controller_spec.rb@@ -3,6 +3,12 @@# we call process directly instead of getrequire 'spec_helper'+class AdminFakesController < Spree::Admin::BaseController+ def index+ render plain: 'index'+ end+end+describe Spree::Admin::BaseController, type: :controller docontroller(Spree::Admin::BaseController) dodef index@@ -11,18 +17,6 @@ describe Spree::Admin::BaseController, type: :controller doendend- context 'unauthorized request' do- before do- allow_any_instance_of(Spree::Admin::BaseController).to receive(:spree_current_user).and_return(nil)- end-- it 'redirects to root' do- allow(controller).to receive_message_chain(:spree, :root_path).and_return('/root')- get :index- expect(response).to redirect_to '/root'- end- end-context '#generate_api_key' dolet(:user) { mock_model(Spree.user_class, has_spree_role?: true) }@@ -43,4 +37,47 @@ describe Spree::Admin::BaseController, type: :controller doget :indexendend++ describe '#redirect_unauthorized_access' do+ controller(AdminFakesController) do+ def index+ redirect_unauthorized_access+ end+ end+ context 'when logged in' do+ before do+ allow(controller).to receive_messages(try_spree_current_user: double('User', id: 1, last_incomplete_spree_order: nil))+ end++ it 'redirects forbidden path' do+ get :index+ expect(response).to redirect_to('/admin/forbidden')+ end+ end++ context 'when guest user' do+ before do+ allow(controller).to receive_messages(try_spree_current_user: nil)+ end++ it 'redirects login path' do+ allow(controller).to receive_messages(spree_login_path: '/login')+ get :index+ expect(response).to redirect_to('/login')+ end++ context 'redirects to root' do+ it 'of spree' do+ allow(controller).to receive_message_chain(:spree, :root_path).and_return('/root')+ get :index+ expect(response).to redirect_to '/root'+ end++ it 'of main app' do+ get :index+ expect(response).to redirect_to '/'+ end+ end+ end+ endenddiff --git a/backend/spec/controllers/spree/admin/orders_controller_spec.rb b/backend/spec/controllers/spree/admin/orders_controller_spec.rbindex 57e46f0ac5..7a253d249a 100644--- a/backend/spec/controllers/spree/admin/orders_controller_spec.rb+++ b/backend/spec/controllers/spree/admin/orders_controller_spec.rb@@ -285,14 +285,14 @@ describe Spree::Admin::OrdersController, type: :controller douser.spree_roles.clearuser.spree_roles << Spree::Role.find_or_create_by(name: 'bar')put :update, params: { id: order.number }- expect(response).to redirect_to(spree.forbidden_path)+ expect(response).to redirect_to(spree.admin_forbidden_path)endendit 'denies access to users without an admin role' doallow(user).to receive_messages has_spree_role?: falsepost :index- expect(response).to redirect_to(spree.forbidden_path)+ expect(response).to redirect_to(spree.admin_forbidden_path)endit 'denies access to not signed in users' dodiff --git a/backend/spec/controllers/spree/admin/users_controller_spec.rb b/backend/spec/controllers/spree/admin/users_controller_spec.rbindex 8140c2f830..a731df0f84 100644--- a/backend/spec/controllers/spree/admin/users_controller_spec.rb+++ b/backend/spec/controllers/spree/admin/users_controller_spec.rb@@ -48,7 +48,7 @@ describe Spree::Admin::UsersController, type: :controller doit 'deny access to users without an admin role' doallow(user).to receive_messages has_spree_role?: falsepost :index- expect(response).to redirect_to(spree.forbidden_path)+ expect(response).to redirect_to(spree.admin_forbidden_path)enddescribe 'deny access to users with an bar role' do@@ -57,14 +57,18 @@ describe Spree::Admin::UsersController, type: :controller doSpree::Ability.register_ability(BarAbility)end+ after do+ Spree::Ability.remove_ability(BarAbility)+ end+it '#index' dopost :index- expect(response).to redirect_to(spree.forbidden_path)+ expect(response).to redirect_to(spree.admin_forbidden_path)endit '#update' dopost :update, params: { id: '9' }- expect(response).to redirect_to(spree.forbidden_path)+ expect(response).to redirect_to(spree.admin_forbidden_path)endendenddiff --git a/core/lib/spree/core/controller_helpers/auth.rb b/core/lib/spree/core/controller_helpers/auth.rbindex 12df3d074e..dff9683b2b 100644--- a/core/lib/spree/core/controller_helpers/auth.rb+++ b/core/lib/spree/core/controller_helpers/auth.rb@@ -71,6 +71,10 @@ module Spree# Override this method in your controllers if you want to have special behavior in case the user is not authorized# to access the requested action. For example, a popup window might simply close itself.def redirect_unauthorized_access+ ActiveSupport::Deprecation.warn(<<-DEPRECATION, caller)+ Core::ControllerHelpers#redirect_unauthorized_access is deprecated and will be removed in Spree 5.0.+ This method is implemented differently for Storefront and Admin+ DEPRECATIONif try_spree_current_userflash[:error] = Spree.t(:authorization_failure)redirect_to spree.forbidden_pathdiff --git a/core/spec/lib/spree/core/controller_helpers/auth_spec.rb b/core/spec/lib/spree/core/controller_helpers/auth_spec.rbindex 799dfa7db6..cdd64ca639 100644--- a/core/spec/lib/spree/core/controller_helpers/auth_spec.rb+++ b/core/spec/lib/spree/core/controller_helpers/auth_spec.rb@@ -91,8 +91,9 @@ describe Spree::Core::ControllerHelpers::Auth, type: :controller doendit 'redirects forbidden path' do+ allow(controller).to receive_message_chain(:spree, :forbidden_path).and_return('/forbidden')get :index- expect(response).to redirect_to(spree.forbidden_path)+ expect(response).to redirect_to('/forbidden')endenddiff --git a/frontend/app/controllers/spree/store_controller.rb b/frontend/app/controllers/spree/store_controller.rbindex 6ad44fefe1..b45c363ca2 100644--- a/frontend/app/controllers/spree/store_controller.rb+++ b/frontend/app/controllers/spree/store_controller.rb@@ -60,5 +60,19 @@ module Spreedef store_last_modified(current_store.updated_at || Time.current).utcend++ def redirect_unauthorized_access+ if try_spree_current_user+ flash[:error] = Spree.t(:authorization_failure)+ redirect_to spree.forbidden_path+ else+ store_location+ if respond_to?(:spree_login_path)+ redirect_to spree_login_path+ else+ redirect_to spree.root_path+ end+ end+ endendenddiff --git a/frontend/spec/controllers/spree/store_controller_spec.rb b/frontend/spec/controllers/spree/store_controller_spec.rbindex 5525a611f7..9cffa4fbcc 100644--- a/frontend/spec/controllers/spree/store_controller_spec.rb+++ b/frontend/spec/controllers/spree/store_controller_spec.rb@@ -1,5 +1,11 @@require 'spec_helper'+class StorefrontFakesController < Spree::StoreController+ def index+ render plain: 'index'+ end+end+describe Spree::StoreController, type: :controller dodescribe '#store_etag' dolet!(:store) { create(:store, default: true, default_locale: 'es', default_currency: 'EUR') }@@ -53,4 +59,39 @@ describe Spree::StoreController, type: :controller doendendend++ describe '#redirect_unauthorized_access' do+ controller(StorefrontFakesController) do+ def index+ redirect_unauthorized_access+ end+ end+ context 'when logged in' do+ before do+ allow(controller).to receive_messages(try_spree_current_user: double('User', id: 1, last_incomplete_spree_order: nil))+ end++ it 'redirects forbidden path' do+ get :index+ expect(response).to redirect_to('/forbidden')+ end+ end++ context 'when guest user' do+ before do+ allow(controller).to receive_messages(try_spree_current_user: nil)+ end++ it 'redirects login path' do+ allow(controller).to receive_messages(spree_login_path: '/login')+ get :index+ expect(response).to redirect_to('/login')+ end++ it 'redirects root path' do+ get :index+ expect(response).to redirect_to('/')+ end+ end+ endend