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.

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.rb
index 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 Spree
authorize! action, record
end
+ 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 API
def generate_admin_api_key
diff --git a/backend/app/controllers/spree/admin/errors_controller.rb b/backend/app/controllers/spree/admin/errors_controller.rb
new file mode 100644
index 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
+end
diff --git a/backend/app/views/spree/admin/errors/forbidden.html.erb b/backend/app/views/spree/admin/errors/forbidden.html.erb
new file mode 100644
index 0000000000..e69de29bb2
diff --git a/backend/config/routes.rb b/backend/config/routes.rb
index eaf31288be..4fdf99db52 100644
--- a/backend/config/routes.rb
+++ b/backend/config/routes.rb
@@ -193,6 +193,8 @@ Spree::Core::Engine.add_routes do
end
end
end
+
+ get '/forbidden', to: 'admin/errors#forbidden', as: :forbidden
end
spree_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.rb
index 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 get
require 'spec_helper'
+class AdminFakesController < Spree::Admin::BaseController
+ def index
+ render plain: 'index'
+ end
+end
+
describe Spree::Admin::BaseController, type: :controller do
controller(Spree::Admin::BaseController) do
def index
@@ -11,18 +17,6 @@ describe Spree::Admin::BaseController, type: :controller do
end
end
- 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' do
let(:user) { mock_model(Spree.user_class, has_spree_role?: true) }
@@ -43,4 +37,47 @@ describe Spree::Admin::BaseController, type: :controller do
get :index
end
end
+
+ 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
+ end
end
diff --git a/backend/spec/controllers/spree/admin/orders_controller_spec.rb b/backend/spec/controllers/spree/admin/orders_controller_spec.rb
index 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 do
user.spree_roles.clear
user.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)
end
end
it 'denies access to users without an admin role' do
allow(user).to receive_messages has_spree_role?: false
post :index
- expect(response).to redirect_to(spree.forbidden_path)
+ expect(response).to redirect_to(spree.admin_forbidden_path)
end
it 'denies access to not signed in users' do
diff --git a/backend/spec/controllers/spree/admin/users_controller_spec.rb b/backend/spec/controllers/spree/admin/users_controller_spec.rb
index 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 do
it 'deny access to users without an admin role' do
allow(user).to receive_messages has_spree_role?: false
post :index
- expect(response).to redirect_to(spree.forbidden_path)
+ expect(response).to redirect_to(spree.admin_forbidden_path)
end
describe 'deny access to users with an bar role' do
@@ -57,14 +57,18 @@ describe Spree::Admin::UsersController, type: :controller do
Spree::Ability.register_ability(BarAbility)
end
+ after do
+ Spree::Ability.remove_ability(BarAbility)
+ end
+
it '#index' do
post :index
- expect(response).to redirect_to(spree.forbidden_path)
+ expect(response).to redirect_to(spree.admin_forbidden_path)
end
it '#update' do
post :update, params: { id: '9' }
- expect(response).to redirect_to(spree.forbidden_path)
+ expect(response).to redirect_to(spree.admin_forbidden_path)
end
end
end
diff --git a/core/lib/spree/core/controller_helpers/auth.rb b/core/lib/spree/core/controller_helpers/auth.rb
index 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
+ DEPRECATION
if try_spree_current_user
flash[:error] = Spree.t(:authorization_failure)
redirect_to spree.forbidden_path
diff --git a/core/spec/lib/spree/core/controller_helpers/auth_spec.rb b/core/spec/lib/spree/core/controller_helpers/auth_spec.rb
index 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 do
end
it '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')
end
end
diff --git a/frontend/app/controllers/spree/store_controller.rb b/frontend/app/controllers/spree/store_controller.rb
index 6ad44fefe1..b45c363ca2 100644
--- a/frontend/app/controllers/spree/store_controller.rb
+++ b/frontend/app/controllers/spree/store_controller.rb
@@ -60,5 +60,19 @@ module Spree
def store_last_modified
(current_store.updated_at || Time.current).utc
end
+
+ 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
+ end
end
end
diff --git a/frontend/spec/controllers/spree/store_controller_spec.rb b/frontend/spec/controllers/spree/store_controller_spec.rb
index 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 do
describe '#store_etag' do
let!(:store) { create(:store, default: true, default_locale: 'es', default_currency: 'EUR') }
@@ -53,4 +59,39 @@ describe Spree::StoreController, type: :controller do
end
end
end
+
+ 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
+ end
end