Merge pull request #6309 from mamhoff/customer-return-dependent

Add foreign key and handling for stock location deletion to customer returns

Author: tvdeyen

core/app/models/spree/customer_return.rb

@@ -4,7 +4,7 @@ module Spree
   class CustomerReturn < Spree::Base
     include Metadata
 
-    belongs_to :stock_location, optional: true
+    belongs_to :stock_location
 
     has_many :return_items, inverse_of: :customer_return
     has_many :return_authorizations, through: :return_items
@@ -14,7 +14,6 @@ class CustomerReturn < Spree::Base
     before_create :generate_number
 
     validates :return_items, presence: true
-    validates :stock_location, presence: true
     validate :return_items_belong_to_same_order
 
     accepts_nested_attributes_for :return_items

core/app/models/spree/stock_location.rb

@@ -15,6 +15,7 @@ class InvalidMovementError < StandardError; end
     has_many :stock_movements, through: :stock_items
     has_many :user_stock_locations, dependent: :delete_all
     has_many :users, through: :user_stock_locations
+    has_many :customer_returns, inverse_of: :stock_location, dependent: :restrict_with_error
 
     belongs_to :state, class_name: 'Spree::State', optional: true
     belongs_to :country, class_name: 'Spree::Country', optional: true

core/db/migrate/20250726220709_add_fk_to_customer_return.rb

@@ -0,0 +1,30 @@
+# frozent_string_literal: true
+#
+class AddFkToCustomerReturn < ActiveRecord::Migration[7.0]
+  FOREIGN_KEY_VIOLATION_ERRORS = %w[PG::ForeignKeyViolation Mysql2::Error SQLite3::ConstraintException]
+
+  def up
+    # Uncomment the following code to remove orphaned records if this migration fails
+    #
+    # say_with_time "Removing invalid adjustment reason IDs from adjustments table" do
+    #   Spree::CustomerReturn.where.not(stock_location_id: nil).left_joins(:stock_location).where(spree_stock_locations: { id: nil }).delete_all
+    # end
+
+    add_foreign_key :spree_customer_returns, :spree_stock_locations, column: :stock_location_id, null: false, on_delete: :restrict
+  rescue ActiveRecord::StatementInvalid => e
+    if e.cause.class.name.in?(FOREIGN_KEY_VIOLATION_ERRORS)
+      say <<~MSG
+        ⚠️ Foreign key constraint failed when adding :spree_customer_returns => :spree_stock_locations.
+        To fix this:
+          1. Uncomment the code that removes invalid adjustment reason IDs from the spree_customer_returns table.
+          2. Rerun the migration.
+        Offending error: #{e.cause.class} - #{e.cause.message}
+      MSG
+    end
+    raise
+  end
+
+  def down
+    remove_foreign_key :spree_customer_returns, :spree_stock_locations, column: :stock_location_id, null: false, on_delete: :restrict
+  end
+end

core/spec/models/spree/stock_location_spec.rb

@@ -4,14 +4,22 @@
 
 module Spree
   RSpec.describe StockLocation, type: :model do
-    subject { create(:stock_location_with_items, backorderable_default: true) }
+    subject(:stock_location) { create(:stock_location_with_items, backorderable_default: true) }
     let(:stock_item) { subject.stock_items.order(:id).first }
     let(:variant) { stock_item.variant }
 
     it 'creates stock_items for all variants' do
       expect(subject.stock_items.count).to eq Variant.count
     end
 
+    describe "#customer_returns" do
+      let(:customer_return) { create(:customer_return, stock_location: stock_location) }
+
+      it "works" do
+        expect(stock_location.customer_returns).to include(customer_return)
+      end
+    end
+
     context "handling stock items" do
       let!(:variant) { create(:variant) }