Only log state changes when persisting new state

On the classic order updater, we were persisting updates to shipment and
payment states in the respective recalculate methods. We are no longer
persisting changes in those methods; now we only save changes in
`#persist_totals`, so this is where we should be logging.

Co-authored-by: Senem Soy <senem@super.gd>
Co-authored-by: Adam Mueller <adam@super.gd>
Co-authored-by: Kendra Riga <kendra@super.gd>

Author: 3 people

core/app/models/spree/in_memory_order_updater.rb

@@ -74,10 +74,7 @@ def recalculate(persist: true)
     def recalculate_shipment_state
       shipments.each(&:recalculate_state)
 
-      log_state_change('shipment') do
-        order.shipment_state = determine_shipment_state
-      end
-
+      order.shipment_state = determine_shipment_state
       order.shipment_state
     end
     alias_method :update_shipment_state, :recalculate_shipment_state
@@ -93,10 +90,7 @@ def recalculate_shipment_state
     #
     # The +payment_state+ value helps with reporting, etc. since it provides a quick and easy way to locate Orders needing attention.
     def recalculate_payment_state
-      log_state_change('payment') do
-        order.payment_state = determine_payment_state
-      end
-
+      order.payment_state = determine_payment_state
       order.payment_state
     end
     alias_method :update_payment_state, :recalculate_payment_state
@@ -244,20 +238,23 @@ def recalculate_item_total
     def persist_totals
       shipments.each(&:persist_amounts)
       persist_item_totals
+      log_state_change("payment")
+      log_state_change("shipment")
       order.save!
     end
 
     def log_state_change(name)
       state = "#{name}_state"
-      old_state = order.public_send(state)
-      yield
-      new_state = order.public_send(state)
-      if old_state != new_state
-        order.state_changes.new(
-          previous_state: old_state,
-          next_state:     new_state,
-          user_id:        order.user_id,
-          name:
+      previous_state, current_state = order.changes[state]
+
+      if previous_state != current_state
+        # Enqueue the job to track this state change
+        StateChangeTrackingJob.perform_later(
+          order,
+          previous_state,
+          current_state,
+          Time.current,
+          name
         )
       end
     end

core/spec/models/spree/in_memory_order_updater_spec.rb

@@ -111,6 +111,28 @@ module Spree
             expect(Rails.logger).not_to have_received(:warn)
           end
         end
+
+        context "when the payment state changes" do
+          let(:order) { create(:completed_order_with_pending_payment) }
+
+          it "logs a state change for the payment" do
+            expect { order.payments.first.update(state: "completed") }
+              .to enqueue_job(Spree::StateChangeTrackingJob)
+              .with(order, "balance_due", "paid", a_kind_of(Time), "payment")
+              .once
+          end
+        end
+
+        context "when the shipment state changes" do
+          let(:order) { create(:order_ready_to_ship) }
+
+          it "logs a state change for the shipment" do
+            expect { order.shipments.first.ship! }
+              .to enqueue_job(Spree::StateChangeTrackingJob)
+              .with(order, "ready", "shipped", a_kind_of(Time), "shipment")
+              .once
+          end
+        end
       end
     end