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 ability to delete admin user (#13117)
Damian Legawiecf8844b10d9d0
diff --git a/admin/app/controllers/spree/admin/admin_users_controller.rb b/admin/app/controllers/spree/admin/admin_users_controller.rbindex 27c34b9918..45e5ef82fa 100644--- a/admin/app/controllers/spree/admin/admin_users_controller.rb+++ b/admin/app/controllers/spree/admin/admin_users_controller.rb@@ -7,7 +7,9 @@ module Spreebefore_action :load_parent, except: [:new, :create]before_action :load_roles, except: [:index]before_action :load_invitation, only: [:new, :create]- before_action :load_admin_user, only: [:show, :edit, :update]+ before_action :load_admin_user, only: [:show, :edit, :update, :destroy]++ helper_method :object_urllayout :choose_layout@@ -16,8 +18,8 @@ module Spreeparams[:q] ||= {}params[:q][:s] ||= 'created_at asc'@search = scope.includes(role_users: :role, avatar_attachment: :blob).- where(role_users: { resource: @parent }).- ransack(params[:q])+ where(role_users: { resource: @parent }).+ ransack(params[:q])@collection = @search.resultend@@ -71,6 +73,17 @@ module Spreeendend+ # DELETE /admin/admin_users/:id+ def destroy+ authorize! :destroy, @admin_user+ if @admin_user.destroy+ redirect_to spree.admin_admin_users_path, status: :see_other, notice: flash_message_for(@admin_user, :successfully_removed)+ else+ flash[:error] = @admin_user.errors.full_messages.to_sentence+ redirect_to spree.admin_admin_users_path, status: :see_other+ end+ end+privatedef permitted_params@@ -107,6 +120,10 @@ module Spreedef model_classSpree.admin_user_classend++ def object_url+ spree.admin_admin_user_path(@admin_user)+ endendendenddiff --git a/admin/config/routes.rb b/admin/config/routes.rbindex b4bfacd795..dd22a4a40c 100644--- a/admin/config/routes.rb+++ b/admin/config/routes.rb@@ -233,7 +233,7 @@ Spree::Core::Engine.add_routes doput :resendendend- resources :admin_users, except: [:destroy]+ resources :admin_users# Action Textnamespace :action_text dodiff --git a/admin/spec/controllers/spree/admin/admin_users_controller_spec.rb b/admin/spec/controllers/spree/admin/admin_users_controller_spec.rbindex 17fba28c85..58984fbfbb 100644--- a/admin/spec/controllers/spree/admin/admin_users_controller_spec.rb+++ b/admin/spec/controllers/spree/admin/admin_users_controller_spec.rb@@ -98,9 +98,9 @@ RSpec.describe Spree::Admin::AdminUsersController, type: :controller docontext 'with invalid token' doit 'raises RecordNotFound' do- expect {+ expect doget :new, params: { token: 'invalid' }- }.to raise_error(ActiveRecord::RecordNotFound)+ end.to raise_error(ActiveRecord::RecordNotFound)endendend@@ -122,17 +122,17 @@ RSpec.describe Spree::Admin::AdminUsersController, type: :controller docontext 'with invalid token' doit 'raises RecordNotFound' do- expect {+ expect dopost :create, params: { token: 'invalid' }- }.to raise_error(ActiveRecord::RecordNotFound)+ end.to raise_error(ActiveRecord::RecordNotFound)endendcontext 'with valid parameters' doit 'creates a new admin user' do- expect {+ expect dopost :create, params: valid_params- }.to change(Spree.admin_user_class, :count).by(1)+ end.to change(Spree.admin_user_class, :count).by(1)endit 'accepts the invitation' do@@ -167,9 +167,9 @@ RSpec.describe Spree::Admin::AdminUsersController, type: :controller doendit 'does not create a new admin user' do- expect {+ expect dopost :create, params: invalid_params- }.not_to change(Spree.admin_user_class, :count)+ end.not_to change(Spree.admin_user_class, :count)endit 'renders the new template' do@@ -262,4 +262,26 @@ RSpec.describe Spree::Admin::AdminUsersController, type: :controller doendendend++ describe 'DELETE #destroy' do+ stub_authorization!++ context 'can delete user' do+ let!(:other_admin) { create(:admin_user) }++ it 'deletes the admin user' do+ expect { delete :destroy, params: { id: admin_user.id } }.to change(Spree.admin_user_class, :count).by(-1)+ expect(response).to redirect_to(spree.admin_admin_users_path)+ end+ end++ context 'cannot delete user' do+ it 'does not delete the admin user' do+ delete :destroy, params: { id: admin_user.id }+ expect(response).to redirect_to(spree.admin_admin_users_path)+ expect(flash[:error]).to include ('Cannot delete the last admin user')+ expect(admin_user).not_to be_destroyed+ end+ end+ endenddiff --git a/api/spec/integration/api/v2/platform/users_spec.rb b/api/spec/integration/api/v2/platform/users_spec.rbindex 226a2697c9..8e90bb49fe 100644--- a/api/spec/integration/api/v2/platform/users_spec.rb+++ b/api/spec/integration/api/v2/platform/users_spec.rb@@ -3,6 +3,8 @@ require 'swagger_helper'describe 'Users API', swagger: true doinclude_context 'Platform API v2'+ let!(:another_admin_user) { create(:admin_user) }+resource_name = 'User'options = {include_example: 'ship_address,bill_address',diff --git a/core/app/models/concerns/spree/admin_user_methods.rb b/core/app/models/concerns/spree/admin_user_methods.rbnew file mode 100644index 0000000000..1aad07c978--- /dev/null+++ b/core/app/models/concerns/spree/admin_user_methods.rb@@ -0,0 +1,63 @@+module Spree+ module AdminUserMethods+ extend ActiveSupport::Concern++ included do+ # Associations+ has_many :canceled_orders, class_name: 'Spree::Order', foreign_key: :canceler_id+ has_many :created_orders, class_name: 'Spree::Order', foreign_key: :created_by_id+ has_many :approved_orders, class_name: 'Spree::Order', foreign_key: :approver_id+ has_many :created_gift_cards, class_name: 'Spree::GiftCard', foreign_key: :created_by_id+ has_many :created_gift_card_batches, class_name: 'Spree::GiftCardBatch', foreign_key: :created_by_id+ has_many :refunded_refunds, class_name: 'Spree::Refund', foreign_key: :refunder_id+ has_many :performed_reimbursements, class_name: 'Spree::Reimbursement', foreign_key: :performed_by_id+ has_many :authored_posts, class_name: 'Spree::Post', foreign_key: :author_id+ has_many :created_store_credits, class_name: 'Spree::StoreCredit', foreign_key: :created_by_id+ has_many :reports, class_name: 'Spree::Report', foreign_key: :user_id+ has_many :exports, class_name: 'Spree::Export', foreign_key: :user_id++ # Callbacks+ before_destroy :check_if_there_are_other_admin_users+ after_destroy :nullify_approver_id_in_approved_orders+ after_destroy :cleanup_admin_user_resources+ end++ private++ def nullify_approver_id_in_approved_orders+ return if self.class != Spree.admin_user_class++ approved_orders.update_all(approver_id: nil, updated_at: Time.current)+ end++ def cleanup_admin_user_resources+ return if self.class != Spree.admin_user_class++ # resources to nullify+ # TODO: we should change these associations to polymorphic and resolve this via standard rails association+ # declarations with dependent: :nullify+ canceled_orders.update_all(canceler_id: nil, updated_at: Time.current)+ created_orders.update_all(created_by_id: nil, updated_at: Time.current)+ created_gift_cards.update_all(created_by_id: nil, updated_at: Time.current)+ created_gift_card_batches.update_all(created_by_id: nil, updated_at: Time.current)+ refunded_refunds.update_all(refunder_id: nil, updated_at: Time.current)+ performed_reimbursements.update_all(performed_by_id: nil, updated_at: Time.current)+ authored_posts.update_all(author_id: nil, updated_at: Time.current)+ created_store_credits.update_all(created_by_id: nil, updated_at: Time.current)++ # resources to destroy+ reports.destroy_all+ exports.destroy_all+ end++ def check_if_there_are_other_admin_users+ return if self.class != Spree.admin_user_class+ return unless has_spree_role?(Spree::Role::ADMIN_ROLE)++ if Spree::Store.current.users.where.not(id: id).none?+ errors.add(:base, I18n.t('activerecord.errors.models.spree/admin_user.attributes.base.cannot_destroy_last_admin_user'))+ throw(:abort)+ end+ end+ end+enddiff --git a/core/app/models/concerns/spree/user_methods.rb b/core/app/models/concerns/spree/user_methods.rbindex 3263cc5797..db0b95149d 100644--- a/core/app/models/concerns/spree/user_methods.rb+++ b/core/app/models/concerns/spree/user_methods.rb@@ -5,6 +5,7 @@ module Spreeinclude Spree::UserPaymentSourceinclude Spree::UserReportinginclude Spree::UserRoles+ include Spree::AdminUserMethodsinclude Spree::RansackableAttributesinclude Spree::MultiSearchableincluded do@@ -12,7 +13,6 @@ module Spree# https://github.com/rails/rails/issues/3458before_validation :clone_billing_address, if: :use_billing?before_destroy :check_completed_orders- after_destroy :nullify_approver_id_in_approved_ordersattr_accessor :use_billing@@ -144,12 +144,6 @@ module Spreeraise Spree::Core::DestroyWithOrdersError if orders.complete.present?end- def nullify_approver_id_in_approved_orders- return unless Spree.admin_user_class != Spree.user_class-- Spree::Order.where(approver_id: id).update_all(approver_id: nil)- end-def clone_billing_addressif bill_address && ship_address.nil?self.ship_address = bill_address.clonediff --git a/core/app/models/concerns/spree/user_payment_source.rb b/core/app/models/concerns/spree/user_payment_source.rbindex f17df8f80f..fe30214db1 100644--- a/core/app/models/concerns/spree/user_payment_source.rb+++ b/core/app/models/concerns/spree/user_payment_source.rb@@ -3,7 +3,7 @@ module Spreeextend ActiveSupport::Concernincluded do- has_many :credit_cards, class_name: 'Spree::CreditCard', foreign_key: :user_id+ has_many :credit_cards, class_name: 'Spree::CreditCard', foreign_key: :user_id, dependent: :destroydef default_credit_cardcredit_cards.default.firstenddiff --git a/core/app/models/concerns/spree/user_roles.rb b/core/app/models/concerns/spree/user_roles.rbindex c2f6d5799b..998704e6b4 100644--- a/core/app/models/concerns/spree/user_roles.rb+++ b/core/app/models/concerns/spree/user_roles.rb@@ -3,10 +3,11 @@ module Spreeextend ActiveSupport::Concernincluded do- has_many :role_users, class_name: 'Spree::RoleUser', foreign_key: :user_id, as: :user, dependent: :destroy+ has_many :role_users, class_name: 'Spree::RoleUser', foreign_key: :user_id, as: :user, dependent: :destroy_async # async as we need to check if the user has admin role before destroyinghas_many :spree_roles, through: :role_users, class_name: 'Spree::Role', source: :rolehas_many :stores, through: :role_users, source: :resource, source_type: 'Spree::Store'- has_many :invitations, class_name: 'Spree::Invitation', foreign_key: :invitee_id, dependent: :destroy+ has_many :invitations, class_name: 'Spree::Invitation', as: :invitee, dependent: :destroy+ has_many :sent_invitations, class_name: 'Spree::Invitation', as: :inviter, dependent: :destroyscope :spree_admin, -> { joins(:spree_roles).where(Spree::Role.table_name => { name: Spree::Role::ADMIN_ROLE }) }diff --git a/core/app/models/spree/gift_card_batch.rb b/core/app/models/spree/gift_card_batch.rbindex ac7e8ed17a..6e9cf07b16 100644--- a/core/app/models/spree/gift_card_batch.rb+++ b/core/app/models/spree/gift_card_batch.rb@@ -10,7 +10,6 @@ module Spreebelongs_to :created_by, class_name: Spree.admin_user_class.to_s, optional: truehas_many :gift_cards, class_name: 'Spree::GiftCard', inverse_of: :batch, dependent: :destroy-## Validations#diff --git a/core/app/models/spree/post.rb b/core/app/models/spree/post.rbindex e39b9e1896..ee1ab74860 100644--- a/core/app/models/spree/post.rb+++ b/core/app/models/spree/post.rb@@ -37,7 +37,7 @@ module Spree## Associations#- belongs_to :author, class_name: Spree.admin_user_class.to_s+ belongs_to :author, class_name: Spree.admin_user_class.to_s, optional: truebelongs_to :store, class_name: 'Spree::Store'belongs_to :post_category, class_name: 'Spree::PostCategory', optional: truealias category post_category@@ -45,7 +45,7 @@ module Spree## Validations#- validates :title, :store, :author, presence: true+ validates :title, :store, presence: truevalidates :slug, presence: true, uniqueness: { scope: :store_id, conditions: -> { where(deleted_at: nil) } }validates :meta_title, length: { maximum: 160 }, allow_blank: truevalidates :meta_description, length: { maximum: 320 }, allow_blank: truediff --git a/core/app/models/spree/refund.rb b/core/app/models/spree/refund.rbindex c1d61e1ca1..7a965d0e5d 100644--- a/core/app/models/spree/refund.rb+++ b/core/app/models/spree/refund.rb@@ -13,7 +13,7 @@ module Spreebelongs_to :reimbursement, optional: trueendbelongs_to :reason, class_name: 'Spree::RefundReason', foreign_key: :refund_reason_id- belongs_to :refunder, class_name: "::#{Spree.admin_user_class}", optional: true+ belongs_to :refunder, class_name: Spree.admin_user_class.to_s, optional: truehas_many :log_entries, as: :sourcediff --git a/core/app/models/spree/store_credit.rb b/core/app/models/spree/store_credit.rbindex aede8269a8..489e72155a 100644--- a/core/app/models/spree/store_credit.rb+++ b/core/app/models/spree/store_credit.rb@@ -19,7 +19,7 @@ module Spreebelongs_to :store, class_name: 'Spree::Store'belongs_to :user, class_name: "::#{Spree.user_class}", foreign_key: 'user_id'belongs_to :category, class_name: 'Spree::StoreCreditCategory', optional: true- belongs_to :created_by, class_name: "::#{Spree.admin_user_class}", foreign_key: 'created_by_id', optional: true+ belongs_to :created_by, class_name: Spree.admin_user_class.to_s, foreign_key: 'created_by_id', optional: truebelongs_to :credit_type, class_name: 'Spree::StoreCreditType', foreign_key: 'type_id', optional: truebelongs_to :originator, polymorphic: true, optional: truediff --git a/core/config/locales/en.yml b/core/config/locales/en.ymlindex ca35a931d5..968200130c 100644--- a/core/config/locales/en.yml+++ b/core/config/locales/en.yml@@ -216,6 +216,10 @@ en:messages:blank: can't be blankmodels:+ spree/admin_user:+ attributes:+ base:+ cannot_destroy_last_admin_user: Cannot delete the last admin userspree/calculator/tiered_flat_rate:attributes:base:diff --git a/core/lib/spree/testing_support/factories/export_factory.rb b/core/lib/spree/testing_support/factories/export_factory.rbindex 2932410c05..e251f44518 100644--- a/core/lib/spree/testing_support/factories/export_factory.rb+++ b/core/lib/spree/testing_support/factories/export_factory.rb@@ -18,7 +18,7 @@ FactoryBot.define dofactory :export, class: 'Spree::Export' dostore { create(:store) }user { create(:admin_user) }- type { 'Spree::Export::Products' }+ type { 'Spree::Exports::Products' }format { 'csv' }factory :product_export, class: 'Spree::Exports::Products', parent: :export dodiff --git a/core/spec/models/spree/admin_user_spec.rb b/core/spec/models/spree/admin_user_spec.rbnew file mode 100644index 0000000000..860ab0eb37--- /dev/null+++ b/core/spec/models/spree/admin_user_spec.rb@@ -0,0 +1,41 @@+require 'spec_helper'++describe Spree::LegacyUser, type: :model do+ let(:admin_user) { create(:admin_user) }++ context 'Callbacks' do+ describe 'do not allow to delete last admin user' do+ it 'raises an error' do+ admin_user+ expect { admin_user.destroy! }.to raise_error(ActiveRecord::RecordNotDestroyed)+ end+ end++ describe 'cleans up admin user resources' do+ let!(:other_admin_user) { create(:admin_user) }+ let!(:cancelled_orders) { create_list(:order, 2, canceler: admin_user, state: 'canceled') }+ let!(:approved_orders) { create_list(:order, 2, approver: admin_user) }+ let!(:gift_card_batches) { create_list(:gift_card_batch, 2, created_by: admin_user, amount: 100, prefix: 'TEST') }+ let!(:gift_cards) { create_list(:gift_card, 2, created_by: admin_user) }+ let!(:refunds) { create_list(:refund, 2, refunder: admin_user, amount: 1) }+ let!(:reimbursements) { create_list(:reimbursement, 2, performed_by: admin_user) }+ let!(:posts) { create_list(:post, 2, author: admin_user) }+ let!(:reports) { create_list(:report, 2, user: admin_user) }+ let!(:store_credits) { create_list(:store_credit, 2, created_by: admin_user) }+ let!(:exports) { create_list(:export, 2, user: admin_user) }++ it 'nullifies admin user resources' do+ expect { admin_user.destroy }.to change(Spree.admin_user_class, :count).by(-1).and change(Spree::Export, :count).by(-2).and change(Spree::Report, :count).by(-2)++ expect(cancelled_orders.all? { |order| order.reload.canceler_id.nil? }).to be_truthy+ expect(approved_orders.all? { |order| order.reload.approver_id.nil? }).to be_truthy+ expect(gift_card_batches.all? { |batch| batch.reload.created_by_id.nil? }).to be_truthy+ expect(gift_cards.all? { |gift_card| gift_card.reload.created_by_id.nil? }).to be_truthy+ expect(refunds.all? { |refund| refund.reload.refunder_id.nil? }).to be_truthy+ expect(reimbursements.all? { |reimbursement| reimbursement.reload.performed_by_id.nil? }).to be_truthy+ expect(posts.all? { |post| post.reload.author_id.nil? }).to be_truthy+ expect(store_credits.all? { |store_credit| store_credit.reload.created_by_id.nil? }).to be_truthy+ end+ end+ end+enddiff --git a/core/spec/models/spree/concerns/user_methods_spec.rb b/core/spec/models/spree/concerns/user_methods_spec.rbindex 9f465e591c..0e9e1e358f 100644--- a/core/spec/models/spree/concerns/user_methods_spec.rb+++ b/core/spec/models/spree/concerns/user_methods_spec.rb@@ -2,6 +2,7 @@ require 'spec_helper'describe Spree::UserMethods dolet(:test_user) { create :user }+ let!(:another_user) { create(:user) }let(:current_store) { @default_store }describe '#last_incomplete_spree_order' do@@ -57,16 +58,6 @@ describe Spree::UserMethods doendendend-- context 'when user destroyed with approved orders' do- let(:order) { create(:order, approver_id: test_user.id, created_at: 1.day.ago) }-- it 'nullifies all approver ids' do- expect(test_user).to receive(:nullify_approver_id_in_approved_orders)- test_user.destroy- end- end-describe '#payment_sources' dosubject { test_user.payment_sources }diff --git a/core/spec/models/spree/post_spec.rb b/core/spec/models/spree/post_spec.rbindex f630910d9e..cf5ba0814c 100644--- a/core/spec/models/spree/post_spec.rb+++ b/core/spec/models/spree/post_spec.rb@@ -3,7 +3,7 @@ require 'spec_helper'RSpec.describe Spree::Post, type: :model dolet(:post) { create(:post) }- describe 'validations' do+ context 'Validations' dodescribe 'image' doit 'validates content type' dopost.image.attach(@@ -33,4 +33,20 @@ RSpec.describe Spree::Post, type: :model doendendend++ describe '#author_name' do+ it 'returns the author name' do+ expect(post.author_name).to eq(post.author.name)+ end++ context 'when author is deleted' do+ let!(:other_admin_user) { create(:admin_user) }++ it 'returns the author name' do+ post.author.destroy!+ post.reload+ expect(post.author_name).to be_nil+ end+ end+ endend