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
Handle immutable addresses correctly (#14300)
Kacper Mękarski2216b7db6e49
diff --git a/spree/admin/app/controllers/spree/admin/addresses_controller.rb b/spree/admin/app/controllers/spree/admin/addresses_controller.rbindex 7362d7c7fa..4b32127a63 100644--- a/spree/admin/app/controllers/spree/admin/addresses_controller.rb+++ b/spree/admin/app/controllers/spree/admin/addresses_controller.rb@@ -20,12 +20,9 @@ module Spreeenddef update- order = address_user_current_order-result = update_service.call(address: @address,address_params: permitted_resource_params,- order: order,address_changes_except: address_update_address_changes_except)@@ -53,15 +50,6 @@ module Spree[]end- def address_user_current_order- incomplete_orders = @address.user.orders.incomplete- incomplete_orders.where(ship_address: @address).or(incomplete_orders.where(bill_address: @address)).first- end-- def location_after_save- spree.admin_user_url(@address.user)- end-def collection_urlif @address.user.present?spree.admin_user_url(@address.user)diff --git a/spree/admin/spec/controllers/spree/admin/addresses_controller_spec.rb b/spree/admin/spec/controllers/spree/admin/addresses_controller_spec.rbindex d477149317..77cf0b1d54 100644--- a/spree/admin/spec/controllers/spree/admin/addresses_controller_spec.rb+++ b/spree/admin/spec/controllers/spree/admin/addresses_controller_spec.rb@@ -130,4 +130,33 @@ RSpec.describe Spree::Admin::AddressesController, type: :controller doendendend++ describe 'DELETE #destroy' do+ context 'when the address is not referenced by an order' do+ let!(:address) { create(:address, user: user) }++ it 'hard-deletes the address' do+ expect { delete :destroy, params: { id: address.to_param } }.to change(Spree::Address, :count).by(-1)+ end+ end++ context 'when the address is referenced by a completed order' do+ let!(:address) { create(:address, user: user) }+ let!(:order) { create(:completed_order_with_totals, user: user, ship_address: address, bill_address: address) }++ it 'soft-deletes the address, keeping the row for the order' do+ expect { delete :destroy, params: { id: address.to_param } }.not_to change(Spree::Address, :count)++ expect(address.reload.deleted_at).to be_present+ end+ end++ context 'when the address has no user' do+ let!(:address) { create(:address, user: nil) }++ it 'hard-deletes the address' do+ expect { delete :destroy, params: { id: address.to_param } }.to change(Spree::Address, :count).by(-1)+ end+ end+ endenddiff --git a/spree/api/app/controllers/spree/api/v3/admin/customers/addresses_controller.rb b/spree/api/app/controllers/spree/api/v3/admin/customers/addresses_controller.rbindex caf1b2fac7..51871d8d5b 100644--- a/spree/api/app/controllers/spree/api/v3/admin/customers/addresses_controller.rb+++ b/spree/api/app/controllers/spree/api/v3/admin/customers/addresses_controller.rb@@ -7,17 +7,19 @@ module Spree# POST /api/v3/admin/customers/:customer_id/addressesdef create- @resource = @parent.addresses.new(address_attrs)- authorize_resource!(@resource, :create)+ authorize_resource!(Spree::Address.new(user_id: @parent.id), :create)- ApplicationRecord.transaction do- if @resource.save- apply_default_flags(@resource)- render json: serialize_resource(@resource.reload), status: :created- else- render_validation_error(@resource.errors)- raise ActiveRecord::Rollback- end+ result = Spree.address_create_service.call(+ address_params: address_attrs,+ user: @parent,+ default_billing: default_billing_flag,+ default_shipping: default_shipping_flag+ )++ if result.success?+ render json: serialize_resource(result.value), status: :created+ else+ render_validation_error(result.value.errors)endend@@ -25,14 +27,17 @@ module Spreedef updateauthorize_resource!(@resource)- ApplicationRecord.transaction do- if @resource.update(address_attrs)- apply_default_flags(@resource)- render json: serialize_resource(@resource.reload)- else- render_validation_error(@resource.errors)- raise ActiveRecord::Rollback- end+ result = Spree.address_update_service.call(+ address: @resource,+ address_params: address_attrs,+ default_billing: default_billing_flag,+ default_shipping: default_shipping_flag+ )++ if result.success?+ render json: serialize_resource(result.value)+ else+ render_validation_error(result.value.errors)endend@@ -69,11 +74,12 @@ module Spree)end- def apply_default_flags(address)- updates = {}- updates[:bill_address_id] = address.id if ActiveModel::Type::Boolean.new.cast(params[:is_default_billing])- updates[:ship_address_id] = address.id if ActiveModel::Type::Boolean.new.cast(params[:is_default_shipping])- @parent.update!(updates) if updates.any?+ def default_billing_flag+ ActiveModel::Type::Boolean.new.cast(params[:is_default_billing])+ end++ def default_shipping_flag+ ActiveModel::Type::Boolean.new.cast(params[:is_default_shipping])endendenddiff --git a/spree/api/app/controllers/spree/api/v3/store/customer/addresses_controller.rb b/spree/api/app/controllers/spree/api/v3/store/customer/addresses_controller.rbindex 85a153c1cd..5df93cb9eb 100644--- a/spree/api/app/controllers/spree/api/v3/store/customer/addresses_controller.rb+++ b/spree/api/app/controllers/spree/api/v3/store/customer/addresses_controller.rb@@ -35,6 +35,14 @@ module Spreeendend+ # DELETE /api/v3/store/customers/me/addresses/:id+ def destroy+ @resource.destroy!+ head :no_content+ rescue ActiveRecord::RecordNotDestroyed => e+ render_validation_error(e.record.errors.presence || e.message)+ end+protecteddef set_parentdiff --git a/spree/api/spec/controllers/spree/api/v3/admin/customers/addresses_controller_spec.rb b/spree/api/spec/controllers/spree/api/v3/admin/customers/addresses_controller_spec.rbindex a1bf1d6a43..bc27cfef59 100644--- a/spree/api/spec/controllers/spree/api/v3/admin/customers/addresses_controller_spec.rb+++ b/spree/api/spec/controllers/spree/api/v3/admin/customers/addresses_controller_spec.rb@@ -105,6 +105,40 @@ RSpec.describe Spree::Api::V3::Admin::Customers::AddressesController, type: :conexpect(response).to have_http_status(:ok)expect(customer.reload.bill_address_id).to eq(target_id)end++ context 'when the address is referenced by a completed order' do+ let!(:order) { create(:completed_order_with_totals, user: customer, ship_address: address) }++ it 'edits a copy instead of mutating the historical order address in place' do+ original_id = address.id+ original_city = address.city++ patch :update, params: {+ customer_id: customer.prefixed_id,+ id: address.prefixed_id,+ firstname: address.firstname,+ lastname: address.lastname,+ address1: address.address1,+ city: 'NewCity',+ zipcode: address.zipcode,+ phone: address.phone,+ country_id: address.country_id,+ state_id: address.state_id+ }, as: :json++ expect(response).to have_http_status(:ok)+ expect(json_response['city']).to eq('NewCity')++ # a new address backs the edit; the original is soft-deleted but unchanged+ expect(Spree::Address.find_by_prefix_id(json_response['id']).id).not_to eq(original_id)+ expect(address.reload.city).to eq(original_city)+ expect(address.deleted_at).to be_present++ # the completed order still points at the original, historical address+ expect(order.reload.ship_address_id).to eq(original_id)+ expect(order.ship_address.city).to eq(original_city)+ end+ endenddescribe 'DELETE #destroy' do@@ -114,5 +148,45 @@ RSpec.describe Spree::Api::V3::Admin::Customers::AddressesController, type: :conexpect(response).to have_http_status(:no_content)expect(Spree::Address.where(id: address.id)).to be_emptyend++ context 'when the address is referenced by a shipment' do+ let!(:shipment) { create(:shipment, address: address) }++ it 'soft-deletes the address, keeping the shipment association intact' do+ expect {+ delete :destroy, params: { customer_id: customer.prefixed_id, id: address.prefixed_id }, as: :json+ }.to change { customer.addresses.count }.by(-1)++ expect(response).to have_http_status(:no_content)+ expect(address.reload.deleted_at).to be_present+ expect(shipment.reload.address).to eq(address)+ end+ end++ context 'when the address is referenced by a completed order' do+ shared_examples 'soft-deletes the referenced address' do |association|+ it 'soft-deletes the address, keeping the order association intact' do+ expect {+ delete :destroy, params: { customer_id: customer.prefixed_id, id: address.prefixed_id }, as: :json+ }.to change { customer.addresses.count }.by(-1)++ expect(response).to have_http_status(:no_content)+ expect(address.reload.deleted_at).to be_present+ expect(order.reload.public_send(association)).to eq(address)+ end+ end++ context 'as the ship address' do+ let!(:order) { create(:completed_order_with_totals, user: customer, ship_address: address) }++ it_behaves_like 'soft-deletes the referenced address', :ship_address+ end++ context 'as the bill address' do+ let!(:order) { create(:completed_order_with_totals, user: customer, bill_address: address) }++ it_behaves_like 'soft-deletes the referenced address', :bill_address+ end+ endendenddiff --git a/spree/api/spec/controllers/spree/api/v3/store/customer/addresses_controller_spec.rb b/spree/api/spec/controllers/spree/api/v3/store/customer/addresses_controller_spec.rbindex d9bd4e7386..ac2565d97a 100644--- a/spree/api/spec/controllers/spree/api/v3/store/customer/addresses_controller_spec.rb+++ b/spree/api/spec/controllers/spree/api/v3/store/customer/addresses_controller_spec.rb@@ -289,6 +289,46 @@ RSpec.describe Spree::Api::V3::Store::Customer::AddressesController, type: :contexpect(response).to have_http_status(:no_content)end+ context 'when the address is referenced by a shipment' do+ let!(:shipment) { create(:shipment, address: address) }++ it 'soft-deletes the address, keeping the shipment association intact' do+ expect {+ delete :destroy, params: { id: address.prefixed_id }+ }.to change { user.addresses.count }.by(-1)++ expect(response).to have_http_status(:no_content)+ expect(address.reload.deleted_at).to be_present+ expect(shipment.reload.address).to eq(address)+ end+ end++ context 'when the address is referenced by a completed order' do+ shared_examples 'soft-deletes the referenced address' do |association|+ it 'soft-deletes the address, keeping the order association intact' do+ expect {+ delete :destroy, params: { id: address.prefixed_id }+ }.to change { user.addresses.count }.by(-1)++ expect(response).to have_http_status(:no_content)+ expect(address.reload.deleted_at).to be_present+ expect(order.reload.public_send(association)).to eq(address)+ end+ end++ context 'as the ship address' do+ let!(:order) { create(:completed_order_with_totals, user: user, ship_address: address) }++ it_behaves_like 'soft-deletes the referenced address', :ship_address+ end++ context 'as the bill address' do+ let!(:order) { create(:completed_order_with_totals, user: user, bill_address: address) }++ it_behaves_like 'soft-deletes the referenced address', :bill_address+ end+ end+context 'when address belongs to another user' dolet!(:other_user) { create(:user) }let!(:other_address) { create(:address, user: other_user) }diff --git a/spree/core/app/models/spree/address.rb b/spree/core/app/models/spree/address.rbindex f9423dddf4..dfc37a6036 100644--- a/spree/core/app/models/spree/address.rb+++ b/spree/core/app/models/spree/address.rb@@ -233,6 +233,7 @@ module Spreeassign_new_default_address_to_userif can_be_deleted?+ unassign_from_incomplete_orderssuperelseupdate_column :deleted_at, Time.current@@ -364,5 +365,11 @@ module Spreedef assign_new_default_address_to_user_scopeuser.addresses.not_quick_checkout.reorder(created_at: :desc)end++ def unassign_from_incomplete_orders+ orders = Spree::Order.incomplete.where(user_id: user_id)+ orders.where(ship_address_id: id).update_all(ship_address_id: nil, state: 'address', updated_at: Time.current)+ orders.where(bill_address_id: id).update_all(bill_address_id: nil, state: 'address', updated_at: Time.current)+ endendenddiff --git a/spree/core/app/services/spree/addresses/update.rb b/spree/core/app/services/spree/addresses/update.rbindex 59ce679182..298ef39275 100644--- a/spree/core/app/services/spree/addresses/update.rb+++ b/spree/core/app/services/spree/addresses/update.rb@@ -7,7 +7,16 @@ module Spreeattr_accessor :countrydef call(address:, address_params:, **opts)- order = opts[:order]+ ApplicationRecord.transaction do+ perform(address: address, address_params: address_params, **opts)+ end+ rescue ActiveRecord::RecordInvalid, ActiveRecord::RecordNotDestroyed => e+ failure(e.record)+ end++ private++ def perform(address:, address_params:, **opts)default_billing = address_params.key?(:is_default_billing) ? address_params.delete(:is_default_billing) : opts.fetch(:default_billing, false)default_shipping = address_params.key?(:is_default_shipping) ? address_params.delete(:is_default_shipping) : opts.fetch(:default_shipping, false)address_changes_except = opts.fetch(:address_changes_except, [])@@ -35,24 +44,23 @@ module Spreereturn success(address) unless address_changedif address.editable?- if address.update(address_params)- if address.user.present?- assign_to_user_as_default(- user: address.user,- address_id: address.id,- default_billing: default_billing,- default_shipping: default_shipping- )- end-- order.update(state: 'address') if order.present?-- success(address)- else- failure(address)+ address.update!(address_params)++ if address.user.present?+ assign_to_user_as_default(+ user: address.user,+ address_id: address.id,+ default_billing: default_billing,+ default_shipping: default_shipping+ )end++ reassign_incomplete_orders(address.id, address)++ success(address)elsif new_address(address_params).valid?- address.destroy+ old_address_id = address.id+ address.destroy!if new_address.user.present?default_billing = address.user_default_billing? || default_billing@@ -66,12 +74,7 @@ module Spree)end- if order.present?- order.ship_address = new_address if order.ship_address_id == address.id- order.bill_address = new_address if order.bill_address_id == address.id- order.state = 'address'- order.save- end+ reassign_incomplete_orders(old_address_id, new_address)success(new_address)else@@ -79,8 +82,6 @@ module Spreeendend- private-def prepare_address_params!(address, address_params)address_params[:user_id] = address&.user_idaddress_params[:country_id] ||= address.country_id@@ -88,6 +89,12 @@ module Spreeaddress_params.transform_values!(&:presence)end+ def reassign_incomplete_orders(old_address_id, new_address)+ orders = Spree::Order.incomplete.where(user_id: new_address.user_id)+ orders.where(ship_address_id: old_address_id).update_all(ship_address_id: new_address.id, state: 'address', updated_at: Time.current)+ orders.where(bill_address_id: old_address_id).update_all(bill_address_id: new_address.id, state: 'address', updated_at: Time.current)+ end+def defaults_changed?(address, default_billing, default_shipping)user = address.userdiff --git a/spree/core/spec/models/spree/address_spec.rb b/spree/core/spec/models/spree/address_spec.rbindex adb3aef3a6..463a9ec203 100644--- a/spree/core/spec/models/spree/address_spec.rb+++ b/spree/core/spec/models/spree/address_spec.rb@@ -564,6 +564,51 @@ describe Spree::Address, type: :model doexpect(Spree::Address.not_deleted.where(['id = (?)', address2.id])).to be_emptyend+ context 'when an incomplete order references the address' do+ let!(:incomplete_order) do+ create(:order, user: user, bill_address: address, ship_address: address, state: 'delivery')+ end++ it 'detaches the address from the order and resets it to the address step' do+ address.destroy++ incomplete_order.reload+ expect(incomplete_order.bill_address_id).to be_nil+ expect(incomplete_order.ship_address_id).to be_nil+ expect(incomplete_order.state).to eq('address')+ end++ it 'still hard-deletes the address' do+ address.destroy+ expect(Spree::Address.where(id: address.id)).to be_empty+ end++ it "leaves another user's order referencing the same address untouched" do+ other_order = create(:order, user: create(:user), bill_address: address, ship_address: address, state: 'delivery')++ address.destroy++ expect(other_order.reload.ship_address_id).to eq(address.id)+ expect(other_order.bill_address_id).to eq(address.id)+ expect(other_order.state).to eq('delivery')+ end++ context 'when the address is also used by a completed order' do+ let!(:completed_order) do+ create(:completed_order_with_totals, bill_address: address, ship_address: address)+ end++ it 'soft-deletes the address and keeps it associated to all orders' do+ address.destroy++ expect(address.reload.deleted_at).to be_present+ expect(incomplete_order.reload.bill_address_id).to eq(address.id)+ expect(incomplete_order.ship_address_id).to eq(address.id)+ expect(completed_order.reload.bill_address_id).to eq(address.id)+ end+ end+ end+context 'when saving user raises error' dobefore douser.update(ship_address: address2, bill_address: address2)diff --git a/spree/core/spec/services/spree/addresses/update_spec.rb b/spree/core/spec/services/spree/addresses/update_spec.rbindex 759ccca68c..5d2804fd40 100644--- a/spree/core/spec/services/spree/addresses/update_spec.rb+++ b/spree/core/spec/services/spree/addresses/update_spec.rb@@ -241,8 +241,73 @@ RSpec.describe Spree::Addresses::Update doendend+ context 'when a separate incomplete order shares the address' do+ let!(:incomplete_order) { create(:order, user: user, ship_address: address, bill_address: address) }++ it 'repoints the incomplete order to the new address and moves it to the address step' do+ result++ expect(incomplete_order.reload.ship_address_id).to eq(value.id)+ expect(incomplete_order.bill_address_id).to eq(value.id)+ expect(incomplete_order.state).to eq('address')+ end++ it 'keeps the completed order on the original, soft-deleted address' do+ result++ expect(completed_order.reload.ship_address_id).to eq(address.id)+ expect(completed_order.bill_address_id).to eq(address.id)+ expect(address.reload.deleted_at).to be_present+ end++ it "does not repoint another user's order sharing the address" do+ other_order = create(:order, user: create(:user), ship_address: address, bill_address: address, state: 'delivery')++ result++ expect(other_order.reload.ship_address_id).to eq(address.id)+ expect(other_order.bill_address_id).to eq(address.id)+ expect(other_order.state).to eq('delivery')+ end+ end++ context 'when soft-deleting the previous address fails' do+ before do+ allow(address).to receive(:destroy!).and_raise(ActiveRecord::RecordNotDestroyed.new('failed', address))+ end++ it 'rolls back the address replacement and returns a failure' do+ expect { result }.not_to change(Spree::Address.unscoped, :count)+ expect(result).to be_failure+ expect(result.value).to eq(address)+ end+ end+it_behaves_like 'updating with same params'end++ context 'when a guest cart shares an immutable address' do+ let(:address) { create(:address) }+ let!(:completed_guest_order) do+ create(:order, user: nil, email: '[email protected]', completed_at: Time.current,+ ship_address: address, bill_address: address)+ end+ let!(:guest_cart) do+ create(:order, user: nil, email: '[email protected]', ship_address: address, bill_address: address)+ end++ it 'repoints the guest cart to the copy and keeps the completed order on the original' do+ expect(result).to be_success+ expect(value.id).not_to eq(address.id)+ expect(address.reload.deleted_at).to be_present++ expect(guest_cart.reload.ship_address_id).to eq(value.id)+ expect(guest_cart.bill_address_id).to eq(value.id)+ expect(guest_cart.state).to eq('address')++ expect(completed_guest_order.reload.ship_address_id).to eq(address.id)+ end+ endendcontext 'with invalid params' do@@ -260,6 +325,16 @@ RSpec.describe Spree::Addresses::Update domessages = result.error.value.messagesexpect(messages).to eq( zipcode: ["can't be blank"])end++ context 'when the address is uneditable' do+ let!(:completed_order) { create(:completed_order_with_totals, user: user, ship_address: address, bill_address: address) }++ it 'returns a failure and leaves the original address intact' do+ expect { result }.not_to change(Spree::Address, :count)+ expect(result).to be_failure+ expect(address.reload.deleted_at).to be_nil+ end+ endendendend