Avoid mutating self.routes in ConditionalRouter to_dict method (#8936)

* Avoid mutating self.routes in ConditionalRouter to_dict method

* Add release note

* Update releasenotes/notes/fix-conditional-router-to-dict-5af887da50effe11.yaml

Co-authored-by: David S. Batista <[email protected]>

* Make test_router_to_dict_does_not_mutate_routes more robut (add another roundtrip)

---------

Co-authored-by: David S. Batista <[email protected]>

Author: mpangrazzi

haystack/components/routers/conditional_router.py

@@ -241,13 +241,14 @@ def to_dict(self) -> Dict[str, Any]:
         :returns:
             Dictionary with serialized data.
         """
+        serialized_routes = []
         for route in self.routes:
             # output_type needs to be serialized to a string
-            route["output_type"] = serialize_type(route["output_type"])
+            serialized_routes.append({**route, "output_type": serialize_type(route["output_type"])})
         se_filters = {name: serialize_callable(filter_func) for name, filter_func in self.custom_filters.items()}
         return default_to_dict(
             self,
-            routes=self.routes,
+            routes=serialized_routes,
             custom_filters=se_filters,
             unsafe=self._unsafe,
             validate_output_type=self._validate_output_type,

releasenotes/notes/fix-conditional-router-to-dict-5af887da50effe11.yaml

@@ -0,0 +1,5 @@
+---
+fixes:
+  - |
+    Fix a bug where the `output_type` of a `ConditionalRouter` was not being serialized correctly.
+    This would cause the router to work incorrectly after being serialized and deserialized.

test/components/routers/test_conditional_router.py

@@ -542,3 +542,35 @@ def test_warns_on_unused_optional_variables(self):
         # Verify router still works normally
         result = router.run(question="What?", mode="chat")
         assert result == {"chat": "What?"}
+
+    def test_router_to_dict_does_not_mutate_routes(self):
+        routes = [
+            {"condition": "{{streams|length < 2}}", "output": "{{query}}", "output_type": str, "output_name": "query"}
+        ]
+
+        router = ConditionalRouter(routes)
+
+        # Store the original output_type before serializing
+        original_output_type = router.routes[0]["output_type"]
+        assert original_output_type is str
+
+        router_dict = router.to_dict()
+
+        # Verify that the original routes are not mutated
+        assert router.routes[0]["output_type"] is str
+        assert router.routes[0]["output_type"] is original_output_type
+
+        # Verify that the serialized output_type is a string
+        assert isinstance(router_dict["init_parameters"]["routes"][0]["output_type"], str), (
+            "Serialized output_type should be a string"
+        )
+
+        # Verify that the router still works correctly after to_dict()
+        result = router.run(streams=[1], query="test")
+        assert result == {"query": "test"}, "Router should still work correctly after to_dict()"
+
+        # Double check on another ConditionalRouter instance
+        new_router = ConditionalRouter.from_dict(router_dict)
+        assert new_router.routes == router.routes
+        assert new_router.routes[0]["output_type"] is str
+        assert new_router.routes[0]["output_type"] is original_output_type