From a5d070093a2561c4924a030338db9064cdff7a16 Mon Sep 17 00:00:00 2001
From: Teddy Wing
Date: Tue, 13 Mar 2018 18:45:28 +0100
Subject: RouteWayCostWorker: Add comment about recursive workers

Explain why we need to skip and un-skip the callback.

Refs #6095
---
 app/workers/route_way_cost_worker.rb | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/app/workers/route_way_cost_worker.rb b/app/workers/route_way_cost_worker.rb
index 2ec8cdff9..d6bfed592 100644
--- a/app/workers/route_way_cost_worker.rb
+++ b/app/workers/route_way_cost_worker.rb
@@ -5,6 +5,8 @@ class RouteWayCostWorker
     Referential.find(referential_id).switch
     route = Chouette::Route.find(route_id)
 
+    # Prevent recursive worker spawning since this call updates the
+    # `costs` field of the route.
     Chouette::Route.skip_callback(:save, :after, :calculate_costs!)
 
     RouteWayCostCalculator.new(route).calculate!
-- 
cgit v1.2.3