Files
wehub-resource-sync c56bef871b
Sync docs with Docusaurus / sync (push) Waiting to run
Tests / Check if changed (push) Waiting to run
Tests / format (push) Blocked by required conditions
Tests / check-imports (push) Blocked by required conditions
Tests / Unit / macos-latest (push) Blocked by required conditions
Tests / Unit / ubuntu-latest (push) Blocked by required conditions
Tests / Unit / windows-latest (push) Blocked by required conditions
Tests / mypy (push) Blocked by required conditions
Tests / Integration / ubuntu-latest (push) Blocked by required conditions
Tests / Integration / macos-latest (push) Blocked by required conditions
Tests / Integration / windows-latest (push) Blocked by required conditions
Tests / notify-slack-on-failure (push) Blocked by required conditions
Tests / Mark tests as completed (push) Blocked by required conditions
Docker image release / Build base image (push) Waiting to run
CodeQL / Analyze (python) (push) Has been cancelled
Update Platform Components Table / update (push) Has been cancelled
chore: import upstream snapshot with attribution
2026-07-13 13:22:28 +08:00

2555 lines
113 KiB
Python

# SPDX-FileCopyrightText: 2022-present deepset GmbH <info@deepset.ai>
#
# SPDX-License-Identifier: Apache-2.0
import logging
from typing import Any
from unittest.mock import patch
import pytest
from pandas import DataFrame
from haystack import Document
from haystack.core.component import component
from haystack.core.component.types import GreedyVariadic, InputSocket, OutputSocket, Variadic, _empty
from haystack.core.errors import (
DeserializationError,
PipelineConnectError,
PipelineDrawingError,
PipelineError,
PipelineMaxComponentRuns,
PipelineRuntimeError,
)
from haystack.core.pipeline import Pipeline
from haystack.core.pipeline.base import _NO_OUTPUT_PRODUCED, ComponentPriority, PipelineBase
from haystack.core.pipeline.utils import FIFOPriorityQueue
from haystack.core.serialization import DeserializationCallbacks
from haystack.core.type_utils import ConversionStrategy
from haystack.dataclasses import ChatMessage
from haystack.testing.factory import component_class
from haystack.testing.sample_components import AddFixedValue, Double, Greet
logging.basicConfig(level=logging.DEBUG)
@component
class FakeComponent:
def __init__(self, an_init_param: str | None = None):
pass
@component.output_types(value=str)
def run(self, input_: str) -> dict[str, str]:
return {"value": input_}
@component
class FakeComponentSquared:
def __init__(self, an_init_param: str | None = None):
self.an_init_param = an_init_param
self.inner = FakeComponent()
@component.output_types(value=str)
def run(self, input_: str) -> dict[str, str]:
return {"value": input_}
@component
class FakeRouter:
@component.output_types(route1=str, route2=str)
def run(self, inp: str) -> dict[str, str]:
if inp == "route1":
return {"route1": "output from route 1"}
return {"route2": "output from route 2"}
@component
class StringProducer:
@component.output_types(text=str)
def run(self) -> dict[str, str]:
return {"text": "Hello"}
@component
class ChatMessageProducer:
@component.output_types(message=ChatMessage)
def run(self) -> dict[str, ChatMessage]:
return {"message": ChatMessage.from_user("Hello")}
@component
class ListStrProducer:
@component.output_types(texts=list[str])
def run(self) -> dict[str, list[str]]:
return {"texts": ["Hello", "Hi"]}
@component
class ListChatMessageProducer:
@component.output_types(messages=list[ChatMessage])
def run(self) -> dict[str, list[ChatMessage]]:
return {"messages": [ChatMessage.from_user("Hello")]}
@component
class ListStrAcceptor:
@component.output_types(result=list[str])
def run(self, texts: list[str]) -> dict[str, list[str]]:
return {"result": texts}
@component
class ListChatMessageAcceptor:
@component.output_types(result=list[ChatMessage])
def run(self, messages: list[ChatMessage]) -> dict[str, list[ChatMessage]]:
return {"result": messages}
@pytest.fixture
def regular_output_socket():
"""Output socket for a regular (non-variadic) connection with receivers"""
return OutputSocket("output1", int, receivers=["receiver1", "receiver2"])
@pytest.fixture
def regular_input_socket():
"""Regular (non-variadic) input socket with a single sender"""
return InputSocket("input1", int, senders=["sender1"])
@pytest.fixture
def lazy_variadic_input_socket():
"""Lazy variadic input socket with multiple senders"""
return InputSocket("variadic_input", Variadic[int], senders=["sender1", "sender2"])
class TestPipelineBase:
"""
This class contains only unit tests for the PipelineBase class.
It doesn't test Pipeline.run(), that is done separately in a different way.
"""
def test_pipeline_dumps(self, test_files_path):
pipeline = PipelineBase(max_runs_per_component=99)
pipeline.add_component("Comp1", FakeComponent("Foo"))
pipeline.add_component("Comp2", FakeComponent())
pipeline.connect("Comp1.value", "Comp2.input_")
result = pipeline.dumps()
with open(f"{test_files_path}/yaml/test_pipeline.yaml") as f:
assert f.read() == result
def test_pipeline_loads_invalid_data(self):
invalid_yaml = """components:
Comp1:
init_parameters:
an_init_param: null
type: test.core.pipeline.test_pipeline_base.FakeComponent
Comp2*
init_parameters:
an_init_param: null
type: test.core.pipeline.test_pipeline_base.FakeComponent
connections:
* receiver: Comp2.input_
sender: Comp1.value
metadata:
"""
with pytest.raises(DeserializationError, match="unmarshalling serialized"):
_ = PipelineBase.loads(invalid_yaml)
invalid_init_parameter_yaml = """components:
Comp1:
init_parameters:
unknown: null
type: test.core.pipeline.test_pipeline_base.FakeComponent
Comp2:
init_parameters:
an_init_param: null
type: test.core.pipeline.test_pipeline_base.FakeComponent
connections:
- receiver: Comp2.input_
sender: Comp1.value
metadata: {}
"""
with pytest.raises(DeserializationError, match="Couldn't deserialize component 'Comp1'"):
_ = PipelineBase.loads(invalid_init_parameter_yaml)
def test_pipeline_dump(self, test_files_path, tmp_path):
pipeline = PipelineBase(max_runs_per_component=99)
pipeline.add_component("Comp1", FakeComponent("Foo"))
pipeline.add_component("Comp2", FakeComponent())
pipeline.connect("Comp1.value", "Comp2.input_")
with open(tmp_path / "out.yaml", "w") as f:
pipeline.dump(f)
# re-open and ensure it's the same data as the test file
with open(f"{test_files_path}/yaml/test_pipeline.yaml") as test_f, open(tmp_path / "out.yaml") as f:
assert f.read() == test_f.read()
def test_pipeline_load(self, test_files_path):
with open(f"{test_files_path}/yaml/test_pipeline.yaml") as f:
pipeline = PipelineBase.load(f)
assert pipeline._max_runs_per_component == 99
assert isinstance(pipeline.get_component("Comp1"), FakeComponent)
assert isinstance(pipeline.get_component("Comp2"), FakeComponent)
@patch("haystack.core.pipeline.base._to_mermaid_image")
@patch("haystack.core.pipeline.base.is_in_jupyter")
@patch("IPython.display.Image")
@patch("IPython.display.display")
def test_show_in_notebook(
self, mock_ipython_display, mock_ipython_image, mock_is_in_jupyter, mock_to_mermaid_image
):
pipe = PipelineBase()
mock_to_mermaid_image.return_value = b"some_image_data"
mock_is_in_jupyter.return_value = True
pipe.show()
mock_ipython_image.assert_called_once_with(b"some_image_data")
mock_ipython_display.assert_called_once()
@patch("haystack.core.pipeline.base.is_in_jupyter")
def test_show_not_in_notebook(self, mock_is_in_jupyter):
pipe = PipelineBase()
mock_is_in_jupyter.return_value = False
with pytest.raises(PipelineDrawingError):
pipe.show()
@patch("haystack.core.pipeline.base._to_mermaid_image")
def test_draw(self, mock_to_mermaid_image, tmp_path):
pipe = PipelineBase()
mock_to_mermaid_image.return_value = b"some_image_data"
image_path = tmp_path / "test.png"
pipe.draw(path=image_path)
assert image_path.read_bytes() == mock_to_mermaid_image.return_value
def test_add_invalid_component_name(self):
pipe = PipelineBase()
with pytest.raises(ValueError):
pipe.add_component("this.is.not.a.valida.name", FakeComponent)
with pytest.raises(ValueError):
pipe.add_component("_debug", FakeComponent)
def test_add_component_to_different_pipelines(self):
first_pipe = PipelineBase()
second_pipe = PipelineBase()
some_component = component_class("Some")()
assert some_component.__haystack_added_to_pipeline__ is None # type: ignore[attr-defined]
first_pipe.add_component("some", some_component)
assert some_component.__haystack_added_to_pipeline__ is first_pipe # type: ignore[attr-defined]
with pytest.raises(PipelineError):
second_pipe.add_component("some", some_component)
def test_remove_component_raises_if_invalid_component_name(self):
pipe = PipelineBase()
comp = component_class("Some")()
pipe.add_component("1", comp)
with pytest.raises(ValueError):
pipe.remove_component("2")
def test_remove_component_removes_component_and_its_edges(self):
pipe = PipelineBase()
component_1 = component_class("Type1")()
component_2 = component_class("Type2")()
component_3 = component_class("Type3")()
component_4 = component_class("Type4")()
pipe.add_component("1", component_1)
pipe.add_component("2", component_2)
pipe.add_component("3", component_3)
pipe.add_component("4", component_4)
pipe.connect("1", "2")
pipe.connect("2", "3")
pipe.connect("3", "4")
pipe.remove_component("2")
assert sorted(pipe.graph.nodes) == ["1", "3", "4"]
assert sorted([(u, v) for (u, v) in pipe.graph.edges()]) == [("3", "4")]
def test_remove_component_allows_you_to_reuse_the_component(self):
pipe = PipelineBase()
Some = component_class("Some", input_types={"in": int}, output_types={"out": int})
pipe.add_component("component_1", Some())
pipe.add_component("component_2", Some())
pipe.add_component("component_3", Some())
pipe.connect("component_1", "component_2")
pipe.connect("component_2", "component_3")
component_2 = pipe.remove_component("component_2")
assert component_2.__haystack_added_to_pipeline__ is None # type: ignore[attr-defined]
assert component_2.__haystack_input__._sockets_dict == { # type: ignore[attr-defined]
"in": InputSocket(name="in", type=int, senders=[])
}
assert component_2.__haystack_output__._sockets_dict == { # type: ignore[attr-defined]
"out": OutputSocket(name="out", type=int, receivers=[])
}
pipe2 = PipelineBase()
pipe2.add_component("component_4", Some())
pipe2.add_component("component_2", component_2)
pipe2.add_component("component_5", Some())
pipe2.connect("component_4", "component_2")
pipe2.connect("component_2", "component_5")
assert component_2.__haystack_added_to_pipeline__ is pipe2 # type: ignore[attr-defined]
assert component_2.__haystack_input__._sockets_dict == {
"in": InputSocket(name="in", type=int, senders=["component_4"])
}
assert component_2.__haystack_output__._sockets_dict == {
"out": OutputSocket(name="out", type=int, receivers=["component_5"])
}
def test_get_component_name(self):
pipe = PipelineBase()
some_component = component_class("Some")()
pipe.add_component("some", some_component)
assert pipe.get_component_name(some_component) == "some"
def test_get_component_name_not_added_to_pipeline(self):
pipe = PipelineBase()
some_component = component_class("Some")()
assert pipe.get_component_name(some_component) == ""
def test_repr(self):
pipe = PipelineBase(metadata={"test": "test"})
pipe.add_component("add_two", AddFixedValue(add=2))
pipe.add_component("add_default", AddFixedValue())
pipe.add_component("double", Double())
pipe.connect("add_two", "double")
pipe.connect("double", "add_default")
expected_repr = (
f"{object.__repr__(pipe)}\n"
"🧱 Metadata\n"
" - test: test\n"
"🚅 Components\n"
" - add_two: AddFixedValue\n"
" - add_default: AddFixedValue\n"
" - double: Double\n"
"🛤️ Connections\n"
" - add_two.result -> double.value (int)\n"
" - double.value -> add_default.value (int)\n"
)
assert repr(pipe) == expected_repr
def test_to_dict(self):
pipe = PipelineBase(metadata={"test": "test"}, max_runs_per_component=42)
pipe.add_component("add_two", AddFixedValue(add=2))
pipe.add_component("add_default", AddFixedValue())
pipe.add_component("double", Double())
pipe.connect("add_two", "double")
pipe.connect("double", "add_default")
res = pipe.to_dict()
expected = {
"metadata": {"test": "test"},
"max_runs_per_component": 42,
"connection_type_validation": True,
"components": {
"add_two": {
"type": "haystack.testing.sample_components.add_value.AddFixedValue",
"init_parameters": {"add": 2},
},
"add_default": {
"type": "haystack.testing.sample_components.add_value.AddFixedValue",
"init_parameters": {"add": 1},
},
"double": {"type": "haystack.testing.sample_components.double.Double", "init_parameters": {}},
},
"connections": [
{"sender": "add_two.result", "receiver": "double.value"},
{"sender": "double.value", "receiver": "add_default.value"},
],
}
assert res == expected
def test_describe_input_only_no_inputs_components(self):
A = component_class("A", input_types={}, output={"x": 0})
B = component_class("B", input_types={}, output={"y": 0})
C = component_class("C", input_types={"x": int, "y": int}, output={"z": 0})
p = PipelineBase()
p.add_component("a", A())
p.add_component("b", B())
p.add_component("c", C())
p.connect("a.x", "c.x")
p.connect("b.y", "c.y")
assert p.inputs() == {}
assert p.inputs(include_components_with_connected_inputs=True) == {
"c": {"x": {"type": int, "is_mandatory": False}, "y": {"type": int, "is_mandatory": False}}
}
def test_describe_input_some_components_with_no_inputs(self):
A = component_class("A", input_types={}, output={"x": 0})
B = component_class("B", input_types={"y": int}, output={"y": 0})
C = component_class("C", input_types={"x": int, "y": int}, output={"z": 0})
p = PipelineBase()
p.add_component("a", A())
p.add_component("b", B())
p.add_component("c", C())
p.connect("a.x", "c.x")
p.connect("b.y", "c.y")
assert p.inputs() == {"b": {"y": {"type": int, "is_mandatory": True}}}
assert p.inputs(include_components_with_connected_inputs=True) == {
"b": {"y": {"type": int, "is_mandatory": True}},
"c": {"x": {"type": int, "is_mandatory": False}, "y": {"type": int, "is_mandatory": False}},
}
def test_describe_input_all_components_have_inputs(self):
A = component_class("A", input_types={"x": int | None}, output={"x": 0})
B = component_class("B", input_types={"y": int}, output={"y": 0})
C = component_class("C", input_types={"x": int, "y": int}, output={"z": 0})
p = PipelineBase()
p.add_component("a", A())
p.add_component("b", B())
p.add_component("c", C())
p.connect("a.x", "c.x")
p.connect("b.y", "c.y")
assert p.inputs() == {
"a": {"x": {"type": int | None, "is_mandatory": True}},
"b": {"y": {"type": int, "is_mandatory": True}},
}
assert p.inputs(include_components_with_connected_inputs=True) == {
"a": {"x": {"type": int | None, "is_mandatory": True}},
"b": {"y": {"type": int, "is_mandatory": True}},
"c": {"x": {"type": int, "is_mandatory": False}, "y": {"type": int, "is_mandatory": False}},
}
def test_describe_output_multiple_possible(self):
"""
This pipeline has two outputs: {"b": {"output_b": {"type": str}}, "a": {"output_a": {"type": str}}}
"""
A = component_class("A", input_types={"input_a": str}, output={"output_a": "str", "output_b": "str"})
B = component_class("B", input_types={"input_b": str}, output={"output_b": "str"})
pipe = PipelineBase()
pipe.add_component("a", A())
pipe.add_component("b", B())
pipe.connect("a.output_b", "b.input_b")
assert pipe.outputs() == {"b": {"output_b": {"type": str}}, "a": {"output_a": {"type": str}}}
assert pipe.outputs(include_components_with_connected_outputs=True) == {
"a": {"output_a": {"type": str}, "output_b": {"type": str}},
"b": {"output_b": {"type": str}},
}
def test_describe_output_single(self):
"""
This pipeline has one output: {"c": {"z": {"type": int}}}
"""
A = component_class("A", input_types={"x": int | None}, output={"x": 0})
B = component_class("B", input_types={"y": int}, output={"y": 0})
C = component_class("C", input_types={"x": int, "y": int}, output={"z": 0})
p = PipelineBase()
p.add_component("a", A())
p.add_component("b", B())
p.add_component("c", C())
p.connect("a.x", "c.x")
p.connect("b.y", "c.y")
assert p.outputs() == {"c": {"z": {"type": int}}}
assert p.outputs(include_components_with_connected_outputs=True) == {
"a": {"x": {"type": int}},
"b": {"y": {"type": int}},
"c": {"z": {"type": int}},
}
def test_describe_no_outputs(self):
"""
Test for PipelineBase.outputs() method.
This pipeline sets up elaborate connections between three components but in fact it has no outputs:
Check that p.outputs() == {}
"""
A = component_class("A", input_types={"x": int | None}, output={"x": 0})
B = component_class("B", input_types={"y": int}, output={"y": 0})
C = component_class("C", input_types={"x": int, "y": int}, output={})
p = PipelineBase()
p.add_component("a", A())
p.add_component("b", B())
p.add_component("c", C())
p.connect("a.x", "c.x")
p.connect("b.y", "c.y")
assert p.outputs() == {}
assert p.outputs(include_components_with_connected_outputs=True) == {
"a": {"x": {"type": int}},
"b": {"y": {"type": int}},
}
def test_walk_pipeline_with_no_cycles(self):
"""
Test for PipelineBase.walk() method.
This pipeline has two source nodes, source1 and source2, one hello3 node in between, and one sink node, joiner.
pipeline.walk() should return each component exactly once. The order is not guaranteed.
"""
@component
class Hello:
@component.output_types(output=str)
def run(self, word: str) -> dict[str, str]:
return {"output": f"Hello, {word}!"}
@component
class Joiner:
@component.output_types(output=str)
def run(self, word1: str, word2: str) -> dict[str, str]:
return {"output": f"Hello, {word1} and {word2}!"}
pipeline = PipelineBase()
source1 = Hello()
source2 = Hello()
hello3 = Hello()
joiner = Joiner()
pipeline.add_component("source1", source1)
pipeline.add_component("source2", source2)
pipeline.add_component("hello3", hello3)
pipeline.add_component("joiner", joiner)
pipeline.connect("source1", "joiner.word1")
pipeline.connect("source2", "hello3")
pipeline.connect("hello3", "joiner.word2")
expected_components = [("source1", source1), ("source2", source2), ("joiner", joiner), ("hello3", hello3)]
assert sorted(expected_components) == sorted(pipeline.walk())
def test_walk_pipeline_with_cycles(self):
"""
This pipeline consists of two components, which would run three times in a loop.
pipeline.walk() should return these components exactly once. The order is not guaranteed.
"""
@component
class Hello:
def __init__(self):
self.iteration_counter = 0
@component.output_types(intermediate=str, final=str)
def run(self, word: str, intermediate: str | None = None) -> dict[str, str]:
if self.iteration_counter < 3:
self.iteration_counter += 1
return {"intermediate": f"Hello, {intermediate or word}!"}
return {"final": f"Hello, {intermediate or word}!"}
pipeline = PipelineBase()
hello = Hello()
hello_again = Hello()
pipeline.add_component("hello", hello)
pipeline.add_component("hello_again", hello_again)
pipeline.connect("hello.intermediate", "hello_again.intermediate")
pipeline.connect("hello_again.intermediate", "hello.intermediate")
assert {("hello", hello), ("hello_again", hello_again)} == set(pipeline.walk())
def test__prepare_component_input_data(self):
MockComponent = component_class("MockComponent", input_types={"x": list[str], "y": str})
pipe = PipelineBase()
pipe.add_component("first_mock", MockComponent())
pipe.add_component("second_mock", MockComponent())
res = pipe._prepare_component_input_data({"x": ["some data"], "y": "some other data"})
assert res == {
"first_mock": {"x": ["some data"], "y": "some other data"},
"second_mock": {"x": ["some data"], "y": "some other data"},
}
assert id(res["first_mock"]["x"]) != id(res["second_mock"]["x"])
def test__prepare_component_input_data_with_connected_inputs(self):
MockComponent = component_class(
"MockComponent", input_types={"x": list[str], "y": str}, output_types={"z": str}
)
pipe = PipelineBase()
pipe.add_component("first_mock", MockComponent())
pipe.add_component("second_mock", MockComponent())
pipe.connect("first_mock.z", "second_mock.y")
res = pipe._prepare_component_input_data({"x": ["some data"], "y": "some other data"})
assert res == {"first_mock": {"x": ["some data"], "y": "some other data"}, "second_mock": {"x": ["some data"]}}
assert id(res["first_mock"]["x"]) != id(res["second_mock"]["x"])
def test__prepare_component_input_data_with_non_existing_input(self, caplog):
pipe = PipelineBase()
res = pipe._prepare_component_input_data({"input_name": 1})
assert res == {}
assert (
"Inputs ['input_name'] were not matched to any component inputs, "
"please check your run parameters." in caplog.text
)
@pytest.mark.parametrize(
"component_inputs,sockets,expected_inputs",
[
({"mandatory": 1}, {"mandatory": InputSocket("mandatory", int)}, {"mandatory": 1}),
({}, {"optional": InputSocket("optional", str, default_value="test")}, {"optional": "test"}),
(
{"mandatory": 1},
{
"mandatory": InputSocket("mandatory", int),
"optional": InputSocket("optional", str, default_value="test"),
},
{"mandatory": 1, "optional": "test"},
),
(
{},
{"optional_variadic": InputSocket("optional_variadic", Variadic[str], default_value="test")},
{"optional_variadic": ["test"]},
),
(
{},
{
"optional_1": InputSocket("optional_1", int, default_value=1),
"optional_2": InputSocket("optional_2", int, default_value=2),
},
{"optional_1": 1, "optional_2": 2},
),
],
ids=["no-defaults", "only-default", "mixed-default", "variadic-default", "multiple_defaults"],
)
def test__add_missing_defaults(self, component_inputs, sockets, expected_inputs):
filled_inputs = PipelineBase._add_missing_input_defaults(component_inputs, sockets)
assert filled_inputs == expected_inputs
def test__find_receivers_from(self):
sentence_builder = component_class(
"SentenceBuilder", input_types={"words": list[str]}, output_types={"text": str}
)()
document_builder = component_class(
"DocumentBuilder", input_types={"text": str}, output_types={"doc": Document}
)()
conditional_document_builder = component_class(
"ConditionalDocumentBuilder", output_types={"doc": Document, "noop": None}
)()
document_joiner = component_class("DocumentJoiner", input_types={"docs": Variadic[Document]})()
pipe = PipelineBase()
pipe.add_component("sentence_builder", sentence_builder)
pipe.add_component("document_builder", document_builder)
pipe.add_component("document_joiner", document_joiner)
pipe.add_component("conditional_document_builder", conditional_document_builder)
pipe.connect("sentence_builder.text", "document_builder.text")
pipe.connect("document_builder.doc", "document_joiner.docs")
pipe.connect("conditional_document_builder.doc", "document_joiner.docs")
res = pipe._find_receivers_from("sentence_builder")
assert res == [
(
"document_builder",
OutputSocket(name="text", type=str, receivers=["document_builder"]),
InputSocket(name="text", type=str, default_value=_empty, senders=["sentence_builder"]),
None,
)
]
res = pipe._find_receivers_from("document_builder")
assert res == [
(
"document_joiner",
OutputSocket(name="doc", type=Document, receivers=["document_joiner"]),
InputSocket(
name="docs",
type=Variadic[Document],
default_value=_empty,
senders=["document_builder", "conditional_document_builder"],
),
None,
)
]
res = pipe._find_receivers_from("document_joiner")
assert res == []
res = pipe._find_receivers_from("conditional_document_builder")
assert res == [
(
"document_joiner",
OutputSocket(name="doc", type=Document, receivers=["document_joiner"]),
InputSocket(
name="docs",
type=Variadic[Document],
default_value=_empty,
senders=["document_builder", "conditional_document_builder"],
),
None,
)
]
@pytest.mark.parametrize(
"component, inputs, expected_priority, test_description",
[
# Test case 1: BLOCKED - Missing mandatory input
(
{
"instance": "mock_instance",
"visits": 0,
"input_sockets": {
"mandatory_input": InputSocket("mandatory_input", int),
"optional_input": InputSocket(
"optional_input", str, default_value="default", senders=["previous_component"]
),
},
},
{"optional_input": [{"sender": "previous_component", "value": "test"}]},
ComponentPriority.BLOCKED,
"Component should be BLOCKED when mandatory input is missing",
),
# Test case 2: BLOCKED - No trigger after first visit
(
{
"instance": "mock_instance",
"visits": 1, # Already visited
"input_sockets": {
"mandatory_input": InputSocket("mandatory_input", int),
"optional_input": InputSocket("optional_input", str, default_value="default"),
},
},
{"mandatory_input": [{"sender": None, "value": 42}]},
ComponentPriority.BLOCKED,
"Component should be BLOCKED when there's no new trigger after first visit",
),
# Test case 3: HIGHEST - Greedy socket ready
(
{
"instance": "mock_instance",
"visits": 0,
"input_sockets": {
"greedy_input": InputSocket("greedy_input", GreedyVariadic[int], senders=["component1"]),
"normal_input": InputSocket("normal_input", str, senders=["component2"]),
},
},
{
"greedy_input": [{"sender": "component1", "value": 42}],
"normal_input": [{"sender": "component2", "value": "test"}],
},
ComponentPriority.HIGHEST,
"Component should have HIGHEST priority when greedy socket has valid input",
),
# Test case 4: DEFER - Greedy socket ready but optional missing
(
{
"instance": "mock_instance",
"visits": 0,
"input_sockets": {
"greedy_input": InputSocket("greedy_input", GreedyVariadic[int], senders=["component1"]),
"optional_input": InputSocket(
"optional_input", str, senders=["component2"], default_value="test"
),
},
},
{"greedy_input": [{"sender": "component1", "value": 42}]},
ComponentPriority.DEFER,
"Component should DEFER when greedy socket has valid input but expected optional input is missing",
),
# Test case 4: READY - All predecessors executed
(
{
"instance": "mock_instance",
"visits": 0,
"input_sockets": {
"mandatory_input": InputSocket("mandatory_input", int, senders=["previous_component"]),
"optional_input": InputSocket(
"optional_input", str, senders=["another_component"], default_value="default"
),
},
},
{
"mandatory_input": [{"sender": "previous_component", "value": 42}],
"optional_input": [{"sender": "another_component", "value": "test"}],
},
ComponentPriority.READY,
"Component should be READY when all predecessors have executed",
),
# Test case 5: DEFER - Lazy variadic sockets resolved and optional missing.
(
{
"instance": "mock_instance",
"visits": 0,
"input_sockets": {
"variadic_input": InputSocket(
"variadic_input", Variadic[int], senders=["component1", "component2"]
),
"normal_input": InputSocket("normal_input", str, senders=["component3"]),
"optional_input": InputSocket(
"optional_input", str, default_value="default", senders=["component4"]
),
},
},
{
"variadic_input": [
{"sender": "component1", "value": "test"},
{"sender": "component2", "value": _NO_OUTPUT_PRODUCED},
],
"normal_input": [{"sender": "component3", "value": "test"}],
},
ComponentPriority.DEFER,
"Component should DEFER when all lazy variadic sockets are resolved",
),
# Test case 6: DEFER - Incomplete variadic inputs
(
{
"instance": "mock_instance",
"visits": 0,
"input_sockets": {
"variadic_input": InputSocket(
"variadic_input", Variadic[int], senders=["component1", "component2"]
),
"normal_input": InputSocket("normal_input", str),
},
},
{
"variadic_input": [{"sender": "component1", "value": 42}], # Missing component2
"normal_input": [{"sender": "component3", "value": "test"}],
},
ComponentPriority.DEFER,
"Component should be DEFER when not all variadic senders have produced output",
),
# Test case 7: READY - No input sockets, first visit
(
{
"instance": "mock_instance",
"visits": 0,
"input_sockets": {"optional_input": InputSocket("optional_input", str, default_value="default")},
},
{}, # no inputs
ComponentPriority.READY,
"Component should be READY on first visit when it has no input sockets",
),
# Test case 8: BLOCKED - No connected input sockets, subsequent visit
(
{
"instance": "mock_instance",
"visits": 1,
"input_sockets": {"optional_input": InputSocket("optional_input", str, default_value="default")},
},
{}, # no inputs
ComponentPriority.BLOCKED,
"Component should be BLOCKED on subsequent visits when it has no input sockets",
),
],
ids=lambda p: p.name if isinstance(p, ComponentPriority) else str(p),
)
def test__calculate_priority(self, component, inputs, expected_priority, test_description):
"""Test priority calculation for various component and input combinations."""
# For variadic inputs, set up senders if needed
for socket in component["input_sockets"].values():
if socket.is_variadic and not hasattr(socket, "senders"):
socket.senders = ["component1", "component2"]
assert PipelineBase._calculate_priority(component, inputs) == expected_priority
@pytest.mark.parametrize(
"pipeline_inputs,expected_output",
[
# Test case 1: Empty input
({}, {}),
# Test case 2: Single component, multiple inputs
(
{"component1": {"input1": 42, "input2": "test", "input3": True}},
{
"component1": {
"input1": [{"sender": None, "value": 42}],
"input2": [{"sender": None, "value": "test"}],
"input3": [{"sender": None, "value": True}],
}
},
),
# Test case 3: Multiple components
(
{
"component1": {"input1": 42, "input2": "test"},
"component2": {"input3": [1, 2, 3], "input4": {"key": "value"}},
},
{
"component1": {
"input1": [{"sender": None, "value": 42}],
"input2": [{"sender": None, "value": "test"}],
},
"component2": {
"input3": [{"sender": None, "value": [1, 2, 3]}],
"input4": [{"sender": None, "value": {"key": "value"}}],
},
},
),
],
ids=["empty_input", "single_component_multiple_inputs", "multiple_components"],
)
def test__convert_to_internal_format(self, pipeline_inputs, expected_output):
"""Test conversion of legacy pipeline inputs to internal format."""
result = PipelineBase._convert_to_internal_format(pipeline_inputs)
assert result == expected_output
@pytest.mark.parametrize(
"socket_type,existing_inputs,expected_count",
[
("regular", None, 1), # Regular socket should overwrite
("regular", [{"sender": "other", "value": 24}], 1), # Should still overwrite
("lazy_variadic", None, 1), # First input to lazy variadic
("lazy_variadic", [{"sender": "other", "value": 24}], 2), # Should append
],
ids=["regular-new", "regular-existing", "variadic-new", "variadic-existing"],
)
def test__write_component_outputs_different_sockets(
self,
socket_type,
existing_inputs,
expected_count,
regular_output_socket,
regular_input_socket,
lazy_variadic_input_socket,
):
"""Test writing to different socket types with various existing input states"""
receiver_socket = lazy_variadic_input_socket if socket_type == "lazy_variadic" else regular_input_socket
socket_name = receiver_socket.name
receivers = [("receiver1", regular_output_socket, receiver_socket, None)]
inputs = {}
if existing_inputs:
inputs = {"receiver1": {socket_name: existing_inputs}}
component_outputs = {"output1": 42}
PipelineBase()._write_component_outputs(
component_name="sender1",
component_outputs=component_outputs,
inputs=inputs,
receivers=receivers,
include_outputs_from=set(),
)
assert len(inputs["receiver1"][socket_name]) == expected_count
assert {"sender": "sender1", "value": 42} in inputs["receiver1"][socket_name]
@pytest.mark.parametrize(
"component_outputs,include_outputs,expected_pruned",
[
({"output1": 42, "output2": 24}, set(), {"output2": 24}), # Prune consumed outputs only
({"output1": 42, "output2": 24}, {"sender1"}, {"output1": 42, "output2": 24}), # Keep all outputs
({}, set(), {}), # No outputs case
],
ids=["prune-consumed", "keep-all", "no-outputs"],
)
def test__write_component_outputs_output_pruning(
self, component_outputs, include_outputs, expected_pruned, regular_output_socket, regular_input_socket
):
"""Test output pruning behavior under different scenarios"""
receivers = [("receiver1", regular_output_socket, regular_input_socket, None)]
pruned_outputs = PipelineBase()._write_component_outputs(
component_name="sender1",
component_outputs=component_outputs,
inputs={},
receivers=receivers,
include_outputs_from=include_outputs,
)
assert pruned_outputs == expected_pruned
@pytest.mark.parametrize(
"output_value",
[42, None, _NO_OUTPUT_PRODUCED, "string_value", 3.14],
ids=["int", "none", "no-output", "string", "float"],
)
def test__write_component_outputs_different_output_values(
self, output_value, regular_output_socket, regular_input_socket
):
"""Test handling of different output values"""
receivers = [("receiver1", regular_output_socket, regular_input_socket, None)]
component_outputs = {"output1": output_value}
inputs: dict[str, Any] = {}
PipelineBase()._write_component_outputs(
component_name="sender1",
component_outputs=component_outputs,
inputs=inputs,
receivers=receivers,
include_outputs_from=set(),
)
assert inputs["receiver1"]["input1"] == [{"sender": "sender1", "value": output_value}]
def test__write_component_outputs_dont_overwrite_with_no_output(self, regular_output_socket, regular_input_socket):
"""Test that existing inputs are not overwritten with _NO_OUTPUT_PRODUCED"""
receivers = [("receiver1", regular_output_socket, regular_input_socket, None)]
component_outputs = {"output1": _NO_OUTPUT_PRODUCED}
inputs = {"receiver1": {"input1": [{"sender": "sender1", "value": "keep"}]}}
PipelineBase()._write_component_outputs(
component_name="sender1",
component_outputs=component_outputs,
inputs=inputs,
receivers=receivers,
include_outputs_from=set(),
)
assert inputs["receiver1"]["input1"] == [{"sender": "sender1", "value": "keep"}]
@pytest.mark.parametrize("receivers_count", [1, 2, 3], ids=["single-receiver", "two-receivers", "three-receivers"])
def test__write_component_outputs_multiple_receivers(
self, receivers_count, regular_output_socket, regular_input_socket
):
"""Test writing to multiple receivers"""
receivers = [
(f"receiver{i}", regular_output_socket, regular_input_socket, None) for i in range(receivers_count)
]
component_outputs = {"output1": 42}
inputs: dict[str, Any] = {}
PipelineBase()._write_component_outputs(
component_name="sender1",
component_outputs=component_outputs,
inputs=inputs,
receivers=receivers,
include_outputs_from=set(),
)
for i in range(receivers_count):
receiver_name = f"receiver{i}"
assert receiver_name in inputs
assert inputs[receiver_name]["input1"] == [{"sender": "sender1", "value": 42}]
def test__write_component_outputs_conversion_chat_message(self):
# ChatMessage to str
out = OutputSocket("output1", ChatMessage, receivers=["receiver1"])
inp = InputSocket("input1", str, senders=["sender1"])
receivers = [("receiver1", out, inp, ConversionStrategy.CHAT_MESSAGE_TO_STR)]
component_outputs: dict = {"output1": ChatMessage.from_user("Hello")}
inputs: dict = {}
PipelineBase()._write_component_outputs(
component_name="sender1",
component_outputs=component_outputs,
inputs=inputs,
receivers=receivers,
include_outputs_from=set(),
)
assert inputs["receiver1"]["input1"] == [{"sender": "sender1", "value": "Hello"}]
# str to ChatMessage
out = OutputSocket("output1", str, receivers=["receiver1"])
inp = InputSocket("input1", ChatMessage, senders=["sender1"])
receivers = [("receiver1", out, inp, ConversionStrategy.STR_TO_CHAT_MESSAGE)]
component_outputs = {"output1": "Hello"}
inputs = {}
PipelineBase()._write_component_outputs(
component_name="sender1",
component_outputs=component_outputs,
inputs=inputs,
receivers=receivers,
include_outputs_from=set(),
)
assert inputs["receiver1"]["input1"] == [{"sender": "sender1", "value": ChatMessage.from_user("Hello")}]
def test__write_component_outputs_conversion_chat_message_no_text(self):
@component
class ChatMessageOutputter:
@component.output_types(message=ChatMessage)
def run(self):
return {"message": ChatMessage.from_assistant()}
@component
class StringReceiver:
@component.output_types(text=str)
def run(self, text: str) -> dict[str, str]:
return {"text": text}
pipe = Pipeline()
pipe.add_component("sender", ChatMessageOutputter())
pipe.add_component("receiver", StringReceiver())
pipe.connect("sender.message", "receiver.text")
with pytest.raises(PipelineRuntimeError, match="Failed to perform conversion between components:"):
pipe.run({})
def test__get_next_runnable_component_empty(self):
"""Test with empty queue returns None"""
queue = FIFOPriorityQueue()
pipeline = PipelineBase()
result = pipeline._get_next_runnable_component(queue, component_visits={})
assert result is None
@patch("haystack.core.pipeline.base.PipelineBase._get_component_with_graph_metadata_and_visits")
def test__get_next_runnable_component_max_visits(self, mock_get_component_with_graph_metadata_and_visits):
"""Test component reaching max visits raises exception"""
pipeline = PipelineBase(max_runs_per_component=2)
queue = FIFOPriorityQueue()
queue.push("ready_component", ComponentPriority.READY)
mock_get_component_with_graph_metadata_and_visits.return_value = {"instance": "test", "visits": 2}
with pytest.raises(PipelineMaxComponentRuns) as exc_info:
pipeline._get_next_runnable_component(queue, component_visits={"ready_component": 2})
assert "Maximum run count 2 reached for component 'ready_component'" in str(exc_info.value)
@patch("haystack.core.pipeline.base.PipelineBase._get_component_with_graph_metadata_and_visits")
def test__get_next_runnable_component_max_visits_blocked(self, mock_get_component_with_graph_metadata_and_visits):
"""Test a BLOCKED component that has reached max visits does NOT raise, since it cannot run anyway."""
pipeline = PipelineBase(max_runs_per_component=2)
queue = FIFOPriorityQueue()
queue.push("blocked_component", ComponentPriority.BLOCKED)
mock_get_component_with_graph_metadata_and_visits.return_value = {"instance": "test", "visits": 2}
result = pipeline._get_next_runnable_component(queue, component_visits={"blocked_component": 2})
assert result is not None
priority, component_name, comp = result
assert priority == ComponentPriority.BLOCKED
assert component_name == "blocked_component"
@patch("haystack.core.pipeline.base.PipelineBase._get_component_with_graph_metadata_and_visits")
def test__get_next_runnable_component_ready(self, mock_get_component_with_graph_metadata_and_visits):
"""Test component that is READY"""
pipeline = PipelineBase()
queue = FIFOPriorityQueue()
queue.push("ready_component", ComponentPriority.READY)
mock_get_component_with_graph_metadata_and_visits.return_value = {"instance": "test", "visits": 1}
result = pipeline._get_next_runnable_component(queue, component_visits={"ready_component": 1})
assert result is not None
priority, component_name, comp = result
assert priority == ComponentPriority.READY
assert component_name == "ready_component"
assert comp == {"instance": "test", "visits": 1}
@pytest.mark.parametrize(
"queue_setup,expected_stale",
[
# Empty queue case
(None, True),
# READY priority case
((ComponentPriority.READY, "component1"), False),
# DEFER priority case
((ComponentPriority.DEFER, "component1"), True),
],
ids=["empty-queue", "ready-component", "deferred-component"],
)
def test__is_queue_stale(self, queue_setup, expected_stale):
queue = FIFOPriorityQueue()
if queue_setup:
priority, component_name = queue_setup
queue.push(component_name, priority)
result = PipelineBase._is_queue_stale(queue)
assert result == expected_stale
@patch("haystack.core.pipeline.base.PipelineBase._calculate_priority")
@patch("haystack.core.pipeline.base.PipelineBase._get_component_with_graph_metadata_and_visits")
def test_fill_queue(self, mock_get_metadata, mock_calc_priority):
pipeline = PipelineBase()
component_names = ["comp1", "comp2"]
inputs = {
"comp1": {"input1": [{"sender": None, "value": "value1"}]},
"comp2": {"input2": [{"sender": None, "value": "value2"}]},
}
mock_get_metadata.side_effect = lambda name, _: {"component": f"mock_{name}"}
mock_calc_priority.side_effect = [1, 2] # Different priorities for testing
queue = pipeline._fill_queue(component_names, inputs, component_visits={"comp1": 1, "comp2": 1})
assert mock_get_metadata.call_count == 2
assert mock_calc_priority.call_count == 2
# Verify correct calls for first component
mock_get_metadata.assert_any_call("comp1", 1)
mock_calc_priority.assert_any_call(
{"component": "mock_comp1"}, {"input1": [{"sender": None, "value": "value1"}]}
)
# Verify correct calls for second component
mock_get_metadata.assert_any_call("comp2", 1)
mock_calc_priority.assert_any_call(
{"component": "mock_comp2"}, {"input2": [{"sender": None, "value": "value2"}]}
)
assert queue.pop() == (1, "comp1")
assert queue.pop() == (2, "comp2")
@pytest.mark.parametrize(
"input_sockets,component_inputs,expected_consumed,expected_remaining",
[
# Regular socket test
(
{"input1": InputSocket("input1", int)},
{"input1": [{"sender": "comp1", "value": 42}, {"sender": "comp2", "value": 24}]},
{"input1": 42}, # Should take first valid input
{}, # All pipeline inputs should be removed
),
# Regular socket with user input
(
{"input1": InputSocket("input1", int)},
{
"input1": [
{"sender": "comp1", "value": 42},
{"sender": None, "value": 24}, # User input
]
},
{"input1": 42},
{"input1": [{"sender": None, "value": 24}]}, # User input should remain
),
# Greedy variadic socket
(
{"greedy": InputSocket("greedy", GreedyVariadic[int])},
{
"greedy": [
{"sender": "comp1", "value": 42},
{"sender": None, "value": 24}, # User input
{"sender": "comp2", "value": 33},
]
},
{"greedy": [42]}, # Takes first valid input
{}, # All inputs removed for greedy sockets
),
# Lazy variadic socket
(
{"lazy": InputSocket("lazy", Variadic[int])},
{
"lazy": [
{"sender": "comp1", "value": 42},
{"sender": "comp2", "value": 24},
{"sender": None, "value": 33}, # User input
]
},
{"lazy": [42, 24, 33]}, # Takes all valid inputs
{"lazy": [{"sender": None, "value": 33}]}, # User input remains
),
# Mixed socket types
(
{
"regular": InputSocket("regular", int),
"greedy": InputSocket("greedy", GreedyVariadic[int]),
"lazy": InputSocket("lazy", Variadic[int]),
},
{
"regular": [{"sender": "comp1", "value": 42}, {"sender": None, "value": 24}],
"greedy": [{"sender": "comp2", "value": 33}, {"sender": None, "value": 15}],
"lazy": [{"sender": "comp3", "value": 55}, {"sender": "comp4", "value": 66}],
},
{"regular": 42, "greedy": [33], "lazy": [55, 66]},
{"regular": [{"sender": None, "value": 24}]}, # Only non-greedy user input remains
),
# Filtering _NO_OUTPUT_PRODUCED
(
{"input1": InputSocket("input1", int)},
{
"input1": [
{"sender": "comp1", "value": _NO_OUTPUT_PRODUCED},
{"sender": "comp2", "value": 42},
{"sender": "comp2", "value": _NO_OUTPUT_PRODUCED},
]
},
{"input1": 42}, # Should skip _NO_OUTPUT_PRODUCED values
{}, # All inputs consumed
),
],
ids=[
"regular-socket",
"regular-with-user-input",
"greedy-variadic",
"lazy-variadic",
"mixed-sockets",
"no-output-filtering",
],
)
def test__consume_component_inputs(self, input_sockets, component_inputs, expected_consumed, expected_remaining):
comp = {"input_sockets": input_sockets}
inputs = {"test_component": component_inputs}
consumed = PipelineBase._consume_component_inputs("test_component", comp, inputs)
assert consumed == expected_consumed
assert inputs["test_component"] == expected_remaining
def test__consume_component_inputs_with_df(self, regular_input_socket):
comp = {"input_sockets": {"input1": regular_input_socket}}
inputs = {"test_component": {"input1": [{"sender": "sender1", "value": DataFrame({"a": [1, 2], "b": [1, 2]})}]}}
consumed = PipelineBase._consume_component_inputs("test_component", comp, inputs)
assert consumed["input1"].equals(DataFrame({"a": [1, 2], "b": [1, 2]}))
@pytest.mark.integration
def test_find_super_components(self, in_memory_doc_store):
"""
Test that the pipeline can find super components in it's pipeline.
"""
from haystack import Pipeline
from haystack.components.converters import MultiFileConverter
from haystack.components.preprocessors import DocumentPreprocessor
from haystack.components.writers import DocumentWriter
multi_file_converter = MultiFileConverter()
doc_processor = DocumentPreprocessor()
pipeline = Pipeline()
pipeline.add_component("converter", multi_file_converter)
pipeline.add_component("preprocessor", doc_processor)
pipeline.add_component("writer", DocumentWriter(document_store=in_memory_doc_store))
pipeline.connect("converter", "preprocessor")
pipeline.connect("preprocessor", "writer")
result = pipeline._find_super_components()
assert len(result) == 2
assert [("converter", multi_file_converter), ("preprocessor", doc_processor)] == result
@pytest.mark.integration
def test_merge_super_component_pipelines(self, in_memory_doc_store):
from haystack import Pipeline
from haystack.components.converters import MultiFileConverter
from haystack.components.preprocessors import DocumentPreprocessor
from haystack.components.writers import DocumentWriter
multi_file_converter = MultiFileConverter()
doc_processor = DocumentPreprocessor()
pipeline = Pipeline()
pipeline.add_component("converter", multi_file_converter)
pipeline.add_component("preprocessor", doc_processor)
pipeline.add_component("writer", DocumentWriter(document_store=in_memory_doc_store))
pipeline.connect("converter", "preprocessor")
pipeline.connect("preprocessor", "writer")
merged_graph, super_component_components = pipeline._merge_super_component_pipelines()
assert super_component_components == {
"router": "converter",
"docx": "converter",
"html": "converter",
"json": "converter",
"md": "converter",
"text": "converter",
"pdf": "converter",
"pptx": "converter",
"xlsx": "converter",
"joiner": "converter",
"csv": "converter",
"splitter": "preprocessor",
"cleaner": "preprocessor",
}
expected_nodes = [
"cleaner",
"csv",
"docx",
"html",
"joiner",
"json",
"md",
"pdf",
"pptx",
"router",
"splitter",
"text",
"writer",
"xlsx",
]
assert sorted(merged_graph.nodes) == expected_nodes
expected_edges = [
("cleaner", "writer"),
("csv", "joiner"),
("docx", "joiner"),
("html", "joiner"),
("joiner", "splitter"),
("json", "joiner"),
("md", "joiner"),
("pdf", "joiner"),
("pptx", "joiner"),
("router", "csv"),
("router", "docx"),
("router", "html"),
("router", "json"),
("router", "md"),
("router", "pdf"),
("router", "pptx"),
("router", "text"),
("router", "xlsx"),
("splitter", "cleaner"),
("text", "joiner"),
("xlsx", "joiner"),
]
actual_edges = [(u, v) for u, v, _ in merged_graph.edges]
assert sorted(actual_edges) == expected_edges
def test_is_pipeline_possibly_blocked_has_expected_outputs(self):
pipe = PipelineBase()
pipe.add_component("comp1", FakeComponent("out"))
assert pipe._is_pipeline_possibly_blocked(current_pipeline_outputs={"comp1": {"value": "out"}}) is False
def test_is_pipeline_possibly_blocked_missing_expected_outputs(self):
pipe = PipelineBase()
pipe.add_component("comp1", FakeComponent("out"))
assert pipe._is_pipeline_possibly_blocked(current_pipeline_outputs={}) is True
def test_is_pipeline_possibly_blocked_no_expected_outputs(self):
pipe = PipelineBase()
assert pipe._is_pipeline_possibly_blocked(current_pipeline_outputs={}) is False
def test_tiebreak_defer_components(self):
pipe = PipelineBase()
pipe.add_component("comp1", FakeComponent())
pipe.add_component("comp2", FakeComponent())
# Since comp2 is downstream of comp1, it should have a higher topological order, and thus be prioritized in
# the tie-break
pipe.connect("comp1", "comp2")
priority_queue = FIFOPriorityQueue()
priority_queue.push("comp1", ComponentPriority.DEFER)
priority_queue.push("comp2", ComponentPriority.DEFER)
component_name, topological_sort = pipe._tiebreak_waiting_components(
component_name="comp1",
priority=ComponentPriority.DEFER,
priority_queue=priority_queue,
topological_sort=None,
)
assert component_name == "comp1"
assert topological_sort == {"comp1": 0, "comp2": 1}
def test_tiebreak_defer_components_in_a_loop(self):
from haystack.components.joiners import BranchJoiner
pipe = PipelineBase()
pipe.add_component("comp1", FakeComponent())
# We need to use branch joiner to create a cycle in the graph
pipe.add_component("branch_joiner", BranchJoiner(type_=str))
pipe.add_component("comp3", FakeComponent())
# Create a cycle between comp2 and comp3. Entry point is comp1 -> comp2
pipe.connect("comp1", "branch_joiner")
pipe.connect("branch_joiner", "comp3")
pipe.connect("comp3", "branch_joiner")
priority_queue = FIFOPriorityQueue()
priority_queue.push("branch_joiner", ComponentPriority.DEFER)
priority_queue.push("comp3", ComponentPriority.DEFER)
component_name, topological_sort = pipe._tiebreak_waiting_components(
component_name="branch_joiner",
priority=ComponentPriority.DEFER,
priority_queue=priority_queue,
topological_sort=None,
)
# In a cycle, the original order should be preserved
assert component_name == "branch_joiner"
# Since branch_joiner and comp3 are in a cycle, their topological sort values are the same
assert topological_sort == {"branch_joiner": 1, "comp3": 1, "comp1": 0}
class TestPipelineBaseFromDict:
"""Unit tests for ``PipelineBase.from_dict`` and its deserialization safety checks."""
def test_from_dict(self):
data = {
"metadata": {"test": "test"},
"max_runs_per_component": 101,
"components": {
"add_two": {
"type": "haystack.testing.sample_components.add_value.AddFixedValue",
"init_parameters": {"add": 2},
},
"add_default": {
"type": "haystack.testing.sample_components.add_value.AddFixedValue",
"init_parameters": {"add": 1},
},
"double": {"type": "haystack.testing.sample_components.double.Double", "init_parameters": {}},
},
"connections": [
{"sender": "add_two.result", "receiver": "double.value"},
{"sender": "double.value", "receiver": "add_default.value"},
],
}
pipe = PipelineBase.from_dict(data)
assert pipe.metadata == {"test": "test"}
assert pipe._max_runs_per_component == 101
# Components
assert len(pipe.graph.nodes) == 3
## add_two
add_two = pipe.graph.nodes["add_two"]
assert add_two["instance"].add == 2
assert add_two["input_sockets"] == {
"value": InputSocket(name="value", type=int),
"add": InputSocket(name="add", type=int | None, default_value=None),
}
assert add_two["output_sockets"] == {"result": OutputSocket(name="result", type=int, receivers=["double"])}
assert add_two["visits"] == 0
## add_default
add_default = pipe.graph.nodes["add_default"]
assert add_default["instance"].add == 1
assert add_default["input_sockets"] == {
"value": InputSocket(name="value", type=int, senders=["double"]),
"add": InputSocket(name="add", type=int | None, default_value=None),
}
assert add_default["output_sockets"] == {"result": OutputSocket(name="result", type=int)}
assert add_default["visits"] == 0
## double
double = pipe.graph.nodes["double"]
assert double["instance"]
assert double["input_sockets"] == {"value": InputSocket(name="value", type=int, senders=["add_two"])}
assert double["output_sockets"] == {"value": OutputSocket(name="value", type=int, receivers=["add_default"])}
assert double["visits"] == 0
# Connections
connections = list(pipe.graph.edges(data=True))
assert len(connections) == 2
assert connections[0] == (
"add_two",
"double",
{
"conn_type": "int",
"conversion_strategy": None,
"from_socket": OutputSocket(name="result", type=int, receivers=["double"]),
"to_socket": InputSocket(name="value", type=int, senders=["add_two"]),
"mandatory": True,
},
)
assert connections[1] == (
"double",
"add_default",
{
"conn_type": "int",
"conversion_strategy": None,
"from_socket": OutputSocket(name="value", type=int, receivers=["add_default"]),
"to_socket": InputSocket(name="value", type=int, senders=["double"]),
"mandatory": True,
},
)
# TODO: Remove this, this should be a component test.
# The pipeline can't handle this in any case nor way.
def test_from_dict_with_callbacks(self):
data = {
"metadata": {"test": "test"},
"components": {
"add_two": {
"type": "haystack.testing.sample_components.add_value.AddFixedValue",
"init_parameters": {"add": 2},
},
"add_default": {
"type": "haystack.testing.sample_components.add_value.AddFixedValue",
"init_parameters": {"add": 1},
},
"double": {"type": "haystack.testing.sample_components.double.Double", "init_parameters": {}},
"greet": {
"type": "haystack.testing.sample_components.greet.Greet",
"init_parameters": {"message": "test"},
},
},
"connections": [
{"sender": "add_two.result", "receiver": "double.value"},
{"sender": "double.value", "receiver": "add_default.value"},
],
}
components_seen_in_callback = []
def component_pre_init_callback(name, component_cls, init_params):
assert name in ["add_two", "add_default", "double", "greet"]
assert component_cls in [AddFixedValue, Double, Greet]
if name == "add_two":
assert init_params == {"add": 2}
elif name == "add_default":
assert init_params == {"add": 1}
elif name == "greet":
assert init_params == {"message": "test"}
components_seen_in_callback.append(name)
pipe = PipelineBase.from_dict(
data, callbacks=DeserializationCallbacks(component_pre_init=component_pre_init_callback)
)
assert components_seen_in_callback == ["add_two", "add_default", "double", "greet"]
add_two = pipe.graph.nodes["add_two"]["instance"]
assert add_two.add == 2
add_default = pipe.graph.nodes["add_default"]["instance"]
assert add_default.add == 1
greet = pipe.graph.nodes["greet"]["instance"]
assert greet.message == "test"
assert greet.log_level == "INFO"
def component_pre_init_callback_modify(name, component_cls, init_params):
assert name in ["add_two", "add_default", "double", "greet"]
assert component_cls in [AddFixedValue, Double, Greet]
if name == "add_two":
init_params["add"] = 3
elif name == "add_default":
init_params["add"] = 0
elif name == "greet":
init_params["message"] = "modified test"
init_params["log_level"] = "DEBUG"
pipe = PipelineBase.from_dict(
data, callbacks=DeserializationCallbacks(component_pre_init=component_pre_init_callback_modify)
)
add_two = pipe.graph.nodes["add_two"]["instance"]
assert add_two.add == 3
add_default = pipe.graph.nodes["add_default"]["instance"]
assert add_default.add == 0
greet = pipe.graph.nodes["greet"]["instance"]
assert greet.message == "modified test"
assert greet.log_level == "DEBUG"
# Test with a component that internally instantiates another component
def component_pre_init_callback_check_class(name, component_cls, init_params):
assert name == "fake_component_squared"
assert component_cls == FakeComponentSquared
pipe = PipelineBase()
pipe.add_component("fake_component_squared", FakeComponentSquared())
pipe = PipelineBase.from_dict(
pipe.to_dict(),
callbacks=DeserializationCallbacks(component_pre_init=component_pre_init_callback_check_class),
)
assert type(pipe.graph.nodes["fake_component_squared"]["instance"].inner) == FakeComponent
def test_from_dict_with_empty_dict(self):
assert PipelineBase() == PipelineBase.from_dict({})
def test_from_dict_with_components_instances(self):
add_two = AddFixedValue(add=2)
add_default = AddFixedValue()
components = {"add_two": add_two, "add_default": add_default}
data = {
"metadata": {"test": "test"},
"components": {
"add_two": {},
"add_default": {},
"double": {"type": "haystack.testing.sample_components.double.Double", "init_parameters": {}},
},
"connections": [
{"sender": "add_two.result", "receiver": "double.value"},
{"sender": "double.value", "receiver": "add_default.value"},
],
}
pipe = PipelineBase.from_dict(data, components=components)
assert pipe.metadata == {"test": "test"}
# Components
assert len(pipe.graph.nodes) == 3
## add_two
add_two_data = pipe.graph.nodes["add_two"]
assert add_two_data["instance"] is add_two
assert add_two_data["instance"].add == 2
assert add_two_data["input_sockets"] == {
"value": InputSocket(name="value", type=int),
"add": InputSocket(name="add", type=int | None, default_value=None),
}
assert add_two_data["output_sockets"] == {"result": OutputSocket(name="result", type=int, receivers=["double"])}
assert add_two_data["visits"] == 0
## add_default
add_default_data = pipe.graph.nodes["add_default"]
assert add_default_data["instance"] is add_default
assert add_default_data["instance"].add == 1
assert add_default_data["input_sockets"] == {
"value": InputSocket(name="value", type=int, senders=["double"]),
"add": InputSocket(name="add", type=int | None, default_value=None),
}
assert add_default_data["output_sockets"] == {"result": OutputSocket(name="result", type=int, receivers=[])}
assert add_default_data["visits"] == 0
## double
double = pipe.graph.nodes["double"]
assert double["instance"]
assert double["input_sockets"] == {"value": InputSocket(name="value", type=int, senders=["add_two"])}
assert double["output_sockets"] == {"value": OutputSocket(name="value", type=int, receivers=["add_default"])}
assert double["visits"] == 0
# Connections
connections = list(pipe.graph.edges(data=True))
assert len(connections) == 2
assert connections[0] == (
"add_two",
"double",
{
"conn_type": "int",
"conversion_strategy": None,
"from_socket": OutputSocket(name="result", type=int, receivers=["double"]),
"to_socket": InputSocket(name="value", type=int, senders=["add_two"]),
"mandatory": True,
},
)
assert connections[1] == (
"double",
"add_default",
{
"conn_type": "int",
"conversion_strategy": None,
"from_socket": OutputSocket(name="value", type=int, receivers=["add_default"]),
"to_socket": InputSocket(name="value", type=int, senders=["double"]),
"mandatory": True,
},
)
def test_from_dict_without_component_type(self):
data = {
"metadata": {"test": "test"},
"components": {"add_two": {"init_parameters": {"add": 2}}},
"connections": [],
}
with pytest.raises(PipelineError) as err:
PipelineBase.from_dict(data)
err.match("Missing 'type' in component 'add_two'")
def test_from_dict_without_registered_component_type(self):
# A component type whose module passes the allowlist but cannot be imported should
# surface as a `PipelineError` ("not imported").
data = {
"metadata": {"test": "test"},
"components": {"add_two": {"type": "haystack.does.not.exist.Component", "init_parameters": {"add": 2}}},
"connections": [],
}
with pytest.raises(PipelineError) as err:
PipelineBase.from_dict(data)
err.match(r"Component .+ not imported.")
def test_from_dict_rejects_untrusted_component_module(self):
data = {
"metadata": {"test": "test"},
"components": {"add_two": {"type": "foo.bar.baz", "init_parameters": {"add": 2}}},
"connections": [],
}
with pytest.raises(DeserializationError, match="not on the trusted-module allowlist"):
PipelineBase.from_dict(data)
def test_from_dict_with_unsafe_bypasses_allowlist(self):
# `unsafe=True` bypasses the allowlist but the import itself still fails because the module
# is nonexistent — proving that the allowlist check (not the import) is what changes.
data = {
"metadata": {"test": "test"},
"components": {"add_two": {"type": "foo.bar.baz", "init_parameters": {"add": 2}}},
"connections": [],
}
# Sanity check: without ``unsafe=True`` we'd get the allowlist rejection.
with pytest.raises(DeserializationError):
PipelineBase.from_dict(data)
# With ``unsafe=True`` the allowlist is bypassed; we fall through to a normal import error.
with pytest.raises(PipelineError, match="not imported"):
PipelineBase.from_dict(data, unsafe=True)
def test_from_dict_with_allowed_modules_kwarg(self):
# Passing the third-party module via `allowed_modules` should make the allowlist check pass.
data = {
"metadata": {"test": "test"},
"components": {"add_two": {"type": "foo.bar.baz", "init_parameters": {"add": 2}}},
"connections": [],
}
# Without an extension, the allowlist rejects the module.
with pytest.raises(DeserializationError):
PipelineBase.from_dict(data)
# Passing the matching pattern lets us hit the actual import failure instead.
with pytest.raises(PipelineError, match="not imported"):
PipelineBase.from_dict(data, allowed_modules=["foo.*"])
def test_from_dict_with_invalid_type(self):
data = {
"metadata": {"test": "test"},
"components": {"add_two": {"type": "", "init_parameters": {"add": 2}}},
"connections": [],
}
with pytest.raises(PipelineError) as err:
PipelineBase.from_dict(data)
err.match(
r"Component '' \(name: 'add_two'\) not imported. Please check that the package is installed and the "
r"component path is correct."
)
def test_from_dict_with_correct_import_but_invalid_type(self):
# Test case: Module imports but component not found in registry.
data_registry_error = {
"metadata": {"test": "test"},
"components": {"add_two": {"type": "haystack.testing.NonExistentComponent", "init_parameters": {"add": 2}}},
"connections": [],
}
# Patch thread_safe_import so it doesn't raise an ImportError.
with patch("haystack.utils.type_serialization.thread_safe_import") as mock_import:
mock_import.return_value = None
with pytest.raises(PipelineError) as err_info:
PipelineBase.from_dict(data_registry_error)
outer_message = str(err_info.value)
inner_message = str(err_info.value.__cause__)
assert "Component 'haystack.testing.NonExistentComponent' (name: 'add_two') not imported." in outer_message
assert "Successfully imported module 'haystack.testing' but couldn't find" in inner_message
assert "in the component registry." in inner_message
assert "registered under a different path." in inner_message
def test_from_dict_without_connection_sender(self):
data = {"metadata": {"test": "test"}, "components": {}, "connections": [{"receiver": "some.receiver"}]}
with pytest.raises(PipelineError) as err:
PipelineBase.from_dict(data)
err.match("Missing sender in connection: {'receiver': 'some.receiver'}")
def test_from_dict_without_connection_receiver(self):
data = {"metadata": {"test": "test"}, "components": {}, "connections": [{"sender": "some.sender"}]}
with pytest.raises(PipelineError) as err:
PipelineBase.from_dict(data)
err.match("Missing receiver in connection: {'sender': 'some.sender'}")
class TestPipelineConnect:
def test_connect(self):
comp1 = component_class("Comp1", output_types={"value": int})()
comp2 = component_class("Comp2", input_types={"value": int})()
pipe = PipelineBase()
pipe.add_component("comp1", comp1)
pipe.add_component("comp2", comp2)
assert pipe.connect("comp1.value", "comp2.value") is pipe
assert comp1.__haystack_output__.value.receivers == ["comp2"] # type: ignore[attr-defined]
assert comp2.__haystack_input__.value.senders == ["comp1"] # type: ignore[attr-defined]
assert list(pipe.graph.edges) == [("comp1", "comp2", "value/value")]
def test_connect_already_connected(self):
comp1 = component_class("Comp1", output_types={"value": int})()
comp2 = component_class("Comp2", input_types={"value": int})()
pipe = PipelineBase()
pipe.add_component("comp1", comp1)
pipe.add_component("comp2", comp2)
pipe.connect("comp1.value", "comp2.value")
pipe.connect("comp1.value", "comp2.value")
assert comp1.__haystack_output__.value.receivers == ["comp2"] # type: ignore[attr-defined]
assert comp2.__haystack_input__.value.senders == ["comp1"] # type: ignore[attr-defined]
assert list(pipe.graph.edges) == [("comp1", "comp2", "value/value")]
def test_connect_with_sender_component_name(self):
comp1 = component_class("Comp1", output_types={"value": int})()
comp2 = component_class("Comp2", input_types={"value": int})()
pipe = PipelineBase()
pipe.add_component("comp1", comp1)
pipe.add_component("comp2", comp2)
pipe.connect("comp1", "comp2.value")
assert comp1.__haystack_output__.value.receivers == ["comp2"] # type: ignore[attr-defined]
assert comp2.__haystack_input__.value.senders == ["comp1"] # type: ignore[attr-defined]
assert list(pipe.graph.edges) == [("comp1", "comp2", "value/value")]
def test_connect_with_receiver_component_name(self):
comp1 = component_class("Comp1", output_types={"value": int})()
comp2 = component_class("Comp2", input_types={"value": int})()
pipe = PipelineBase()
pipe.add_component("comp1", comp1)
pipe.add_component("comp2", comp2)
pipe.connect("comp1.value", "comp2")
assert comp1.__haystack_output__.value.receivers == ["comp2"] # type: ignore[attr-defined]
assert comp2.__haystack_input__.value.senders == ["comp1"] # type: ignore[attr-defined]
assert list(pipe.graph.edges) == [("comp1", "comp2", "value/value")]
def test_connect_with_sender_and_receiver_component_name(self):
comp1 = component_class("Comp1", output_types={"value": int})()
comp2 = component_class("Comp2", input_types={"value": int})()
pipe = PipelineBase()
pipe.add_component("comp1", comp1)
pipe.add_component("comp2", comp2)
pipe.connect("comp1", "comp2")
assert comp1.__haystack_output__.value.receivers == ["comp2"] # type: ignore[attr-defined]
assert comp2.__haystack_input__.value.senders == ["comp1"] # type: ignore[attr-defined]
assert list(pipe.graph.edges) == [("comp1", "comp2", "value/value")]
def test_connect_with_sender_not_in_pipeline(self):
comp2 = component_class("Comp2", input_types={"value": int})()
pipe = PipelineBase()
pipe.add_component("comp2", comp2)
with pytest.raises(ValueError):
pipe.connect("comp1.value", "comp2.value")
def test_connect_with_receiver_not_in_pipeline(self):
comp1 = component_class("Comp1", output_types={"value": int})()
pipe = PipelineBase()
pipe.add_component("comp1", comp1)
with pytest.raises(ValueError):
pipe.connect("comp1.value", "comp2.value")
def test_connect_with_sender_socket_name_not_in_pipeline(self):
comp1 = component_class("Comp1", output_types={"value": int})()
comp2 = component_class("Comp2", input_types={"value": int})()
pipe = PipelineBase()
pipe.add_component("comp1", comp1)
pipe.add_component("comp2", comp2)
with pytest.raises(PipelineConnectError):
pipe.connect("comp1.non_existing", "comp2.value")
def test_connect_with_receiver_socket_name_not_in_pipeline(self):
comp1 = component_class("Comp1", output_types={"value": int})()
comp2 = component_class("Comp2", input_types={"value": int})()
pipe = PipelineBase()
pipe.add_component("comp1", comp1)
pipe.add_component("comp2", comp2)
with pytest.raises(PipelineConnectError):
pipe.connect("comp1.value", "comp2.non_existing")
def test_connect_with_no_matching_types_and_same_names(self):
comp1 = component_class("Comp1", output_types={"value": int})()
comp2 = component_class("Comp2", input_types={"value": str})()
pipe = PipelineBase()
pipe.add_component("comp1", comp1)
pipe.add_component("comp2", comp2)
with pytest.raises(PipelineConnectError):
pipe.connect("comp1", "comp2")
def test_connect_with_multiple_sender_connections_with_same_type_and_differing_name(self):
comp1 = component_class("Comp1", output_types={"val1": int, "val2": int})()
comp2 = component_class("Comp2", input_types={"value": int})()
pipe = PipelineBase()
pipe.add_component("comp1", comp1)
pipe.add_component("comp2", comp2)
with pytest.raises(PipelineConnectError):
pipe.connect("comp1", "comp2")
def test_connect_with_multiple_receiver_connections_with_same_type_and_differing_name(self):
comp1 = component_class("Comp1", output_types={"value": int})()
comp2 = component_class("Comp2", input_types={"val1": int, "val2": int})()
pipe = PipelineBase()
pipe.add_component("comp1", comp1)
pipe.add_component("comp2", comp2)
with pytest.raises(PipelineConnectError):
pipe.connect("comp1", "comp2")
def test_connect_with_multiple_sender_connections_with_same_type_and_same_name(self):
comp1 = component_class("Comp1", output_types={"value": int, "other": int})()
comp2 = component_class("Comp2", input_types={"value": int})()
pipe = PipelineBase()
pipe.add_component("comp1", comp1)
pipe.add_component("comp2", comp2)
pipe.connect("comp1", "comp2")
assert comp1.__haystack_output__.value.receivers == ["comp2"] # type: ignore[attr-defined]
assert comp2.__haystack_input__.value.senders == ["comp1"] # type: ignore[attr-defined]
assert list(pipe.graph.edges) == [("comp1", "comp2", "value/value")]
def test_connect_with_multiple_receiver_connections_with_same_type_and_same_name(self):
comp1 = component_class("Comp1", output_types={"value": int})()
comp2 = component_class("Comp2", input_types={"value": int, "other": int})()
pipe = PipelineBase()
pipe.add_component("comp1", comp1)
pipe.add_component("comp2", comp2)
pipe.connect("comp1", "comp2")
assert comp1.__haystack_output__.value.receivers == ["comp2"] # type: ignore[attr-defined]
assert comp2.__haystack_input__.value.senders == ["comp1"] # type: ignore[attr-defined]
assert list(pipe.graph.edges) == [("comp1", "comp2", "value/value")]
def test_connect_multiple_outputs_to_non_variadic_input(self):
comp1 = component_class("Comp1", output_types={"value": int})()
comp2 = component_class("Comp2", output_types={"value": int})()
comp3 = component_class("Comp3", input_types={"value": int})()
pipe = PipelineBase()
pipe.add_component("comp1", comp1)
pipe.add_component("comp2", comp2)
pipe.add_component("comp3", comp3)
pipe.connect("comp1.value", "comp3.value")
with pytest.raises(PipelineConnectError):
pipe.connect("comp2.value", "comp3.value")
def test_connect_multiple_outputs_to_variadic_input(self):
comp1 = component_class("Comp1", output_types={"value": int})()
comp2 = component_class("Comp2", output_types={"value": int})()
comp3 = component_class("Comp3", input_types={"value": Variadic[int]})()
pipe = PipelineBase()
pipe.add_component("comp1", comp1)
pipe.add_component("comp2", comp2)
pipe.add_component("comp3", comp3)
pipe.connect("comp1.value", "comp3.value")
pipe.connect("comp2.value", "comp3.value")
assert comp1.__haystack_output__.value.receivers == ["comp3"] # type: ignore[attr-defined]
assert comp2.__haystack_output__.value.receivers == ["comp3"] # type: ignore[attr-defined]
assert comp3.__haystack_input__.value.senders == ["comp1", "comp2"] # type: ignore[attr-defined]
assert list(pipe.graph.edges) == [("comp1", "comp3", "value/value"), ("comp2", "comp3", "value/value")]
def test_connect_same_component_as_sender_and_receiver(self):
"""
This pipeline consists of one component, which would be connected to itself.
Connecting a component to itself is raises PipelineConnectError.
"""
pipe = PipelineBase()
single_component = FakeComponent()
pipe.add_component("single_component", single_component)
with pytest.raises(PipelineConnectError):
pipe.connect("single_component.out", "single_component.in")
def test_connect_with_nonexistent_output_socket_name(self):
"""Test connecting using a non-existent output socket name."""
comp1 = component_class("Comp1", output_types={"output": int})()
comp2 = component_class("Comp2", input_types={"value": int})()
pipe = PipelineBase()
pipe.add_component("comp1", comp1)
pipe.add_component("comp2", comp2)
with pytest.raises(PipelineConnectError) as excinfo:
pipe.connect("comp1.value", "comp2.value")
assert "'comp1.value' does not exist" in str(excinfo.value)
assert "Output connections of comp1 are: output (type int)" in str(excinfo.value)
def test_connect_with_no_output_sockets(self):
"""Test connecting from a component that has no output sockets at all."""
@component
class NoOutputComponent:
def run(self):
pass
comp1 = NoOutputComponent()
comp2 = component_class("Comp2", input_types={"value": int})()
pipe = PipelineBase()
pipe.add_component("comp1", comp1)
pipe.add_component("comp2", comp2)
with pytest.raises(PipelineConnectError) as excinfo:
pipe.connect("comp1.value", "comp2.value")
assert "'comp1' does not have any output connections" in str(excinfo.value)
assert "@component.output_types" in str(excinfo.value)
def test_connect_pep_604_union_type(self):
"""
Test connecting a PEP 604 union type as input and output.
"""
# Producer: outputs a plain list of strings
@component
class StringProducer:
@component.output_types(words=list[str])
def run(self) -> dict[str, list[str]]:
return {"words": ["apple", "banana", "cherry"]}
@component
class StringConsumerOptional:
@component.output_types(count=int)
def run(self, words: list[str] | None = None) -> dict[str, int]:
return {"count": len(words or [])}
comp1 = StringProducer()
comp2 = StringConsumerOptional()
pipeline = PipelineBase()
pipeline.add_component("producer", comp1)
pipeline.add_component("consumer_opt", comp2)
# This should succeed:
pipeline.connect("producer.words", "consumer_opt.words")
assert comp1.__haystack_output__.words.receivers == ["consumer_opt"] # type: ignore[attr-defined]
assert comp2.__haystack_input__.words.senders == ["producer"] # type: ignore[attr-defined]
assert list(pipeline.graph.edges) == [("producer", "consumer_opt", "words/words")]
def test_connect_auto_variadic(self):
@component
class ListAcceptor:
@component.output_types(result=list[int])
def run(self, numbers: list[int]) -> dict[str, list[int]]:
return {"result": numbers}
pipeline = PipelineBase()
receiver = ListAcceptor()
pipeline.add_component("sender1", ListAcceptor())
pipeline.add_component("sender2", ListAcceptor())
pipeline.add_component("receiver", receiver)
pipeline.connect("sender1.result", "receiver.numbers")
pipeline.connect("sender2.result", "receiver.numbers")
# Check that the receiver's input socket is correctly set to lazy variadic with wrap_input_in_list=False
inp_socket = InputSocket(name="numbers", type=list[int], senders=["sender1", "sender2"])
inp_socket.is_lazy_variadic = True
inp_socket.wrap_input_in_list = False
assert receiver.__haystack_input__._sockets_dict == {"numbers": inp_socket} # type: ignore[attr-defined]
assert receiver.__haystack_input__._sockets_dict["numbers"].senders == ["sender1", "sender2"] # type: ignore[attr-defined]
def test_connect_auto_variadic_optional_list(self):
@component
class ListAcceptor:
@component.output_types(result=list[int])
def run(self, numbers: list[int] | None = None) -> dict[str, list[int]]:
return {"result": numbers or []}
pipeline = PipelineBase()
receiver = ListAcceptor()
pipeline.add_component("sender1", ListAcceptor())
pipeline.add_component("sender2", ListAcceptor())
pipeline.add_component("receiver", receiver)
pipeline.connect("sender1.result", "receiver.numbers")
pipeline.connect("sender2.result", "receiver.numbers")
# Check that the receiver's input socket is correctly set to lazy variadic with wrap_input_in_list=False
inp_socket = InputSocket(
name="numbers", type=list[int] | None, senders=["sender1", "sender2"], default_value=None
)
inp_socket.is_lazy_variadic = True
inp_socket.wrap_input_in_list = False
assert receiver.__haystack_input__._sockets_dict == {"numbers": inp_socket} # type: ignore[attr-defined]
assert receiver.__haystack_input__._sockets_dict["numbers"].senders == ["sender1", "sender2"] # type: ignore[attr-defined]
def test_connect_auto_variadic_with_conversion_str_to_list_str(self):
pipeline = PipelineBase()
receiver = ListStrAcceptor()
pipeline.add_component("producer1", StringProducer())
pipeline.add_component("producer2", StringProducer())
pipeline.add_component("receiver", receiver)
pipeline.connect("producer1.text", "receiver.texts")
pipeline.connect("producer2.text", "receiver.texts")
inp_socket = InputSocket(name="texts", type=list[str], senders=["producer1", "producer2"])
inp_socket.is_lazy_variadic = True
inp_socket.wrap_input_in_list = False
assert receiver.__haystack_input__._sockets_dict == {"texts": inp_socket} # type: ignore[attr-defined]
assert receiver.__haystack_input__._sockets_dict["texts"].senders == ["producer1", "producer2"] # type: ignore[attr-defined]
assert pipeline.graph["producer1"]["receiver"]["text/texts"]["conversion_strategy"] == ConversionStrategy.WRAP
assert pipeline.graph["producer2"]["receiver"]["text/texts"]["conversion_strategy"] == ConversionStrategy.WRAP
def test_connect_auto_variadic_with_conversion_str_and_list_str_to_list_str(self):
pipeline = PipelineBase()
receiver = ListStrAcceptor()
pipeline.add_component("producer1", StringProducer())
pipeline.add_component("producer2", ListStrProducer())
pipeline.add_component("receiver", receiver)
pipeline.connect("producer1.text", "receiver.texts")
pipeline.connect("producer2.texts", "receiver.texts")
inp_socket = InputSocket(name="texts", type=list[str], senders=["producer1", "producer2"])
inp_socket.is_lazy_variadic = True
inp_socket.wrap_input_in_list = False
assert receiver.__haystack_input__._sockets_dict == {"texts": inp_socket} # type: ignore[attr-defined]
assert receiver.__haystack_input__._sockets_dict["texts"].senders == ["producer1", "producer2"] # type: ignore[attr-defined]
assert pipeline.graph["producer1"]["receiver"]["text/texts"]["conversion_strategy"] == ConversionStrategy.WRAP
assert pipeline.graph["producer2"]["receiver"]["texts/texts"]["conversion_strategy"] is None
def test_connect_auto_variadic_chat_message_to_list_str(self):
pipeline = PipelineBase()
receiver = ListStrAcceptor()
pipeline.add_component("producer1", ChatMessageProducer())
pipeline.add_component("producer2", ChatMessageProducer())
pipeline.add_component("receiver", receiver)
pipeline.connect("producer1.message", "receiver.texts")
pipeline.connect("producer2.message", "receiver.texts")
inp_socket = InputSocket(name="texts", type=list[str], senders=["producer1", "producer2"])
inp_socket.is_lazy_variadic = True
inp_socket.wrap_input_in_list = False
assert receiver.__haystack_input__._sockets_dict == {"texts": inp_socket} # type: ignore[attr-defined]
assert receiver.__haystack_input__._sockets_dict["texts"].senders == ["producer1", "producer2"] # type: ignore[attr-defined]
assert (
pipeline.graph["producer1"]["receiver"]["message/texts"]["conversion_strategy"]
== ConversionStrategy.WRAP_CHAT_MESSAGE_TO_STR
)
assert (
pipeline.graph["producer2"]["receiver"]["message/texts"]["conversion_strategy"]
== ConversionStrategy.WRAP_CHAT_MESSAGE_TO_STR
)
def test_connect_auto_variadic_str_and_chat_message_to_list_str(self):
pipeline = PipelineBase()
receiver = ListStrAcceptor()
pipeline.add_component("str_producer", StringProducer())
pipeline.add_component("chat_producer", ChatMessageProducer())
pipeline.add_component("receiver", receiver)
pipeline.connect("str_producer.text", "receiver.texts")
pipeline.connect("chat_producer.message", "receiver.texts")
inp_socket = InputSocket(name="texts", type=list[str], senders=["str_producer", "chat_producer"])
inp_socket.is_lazy_variadic = True
inp_socket.wrap_input_in_list = False
assert receiver.__haystack_input__._sockets_dict == {"texts": inp_socket} # type: ignore[attr-defined]
assert receiver.__haystack_input__._sockets_dict["texts"].senders == ["str_producer", "chat_producer"] # type: ignore[attr-defined]
assert (
pipeline.graph["str_producer"]["receiver"]["text/texts"]["conversion_strategy"] == ConversionStrategy.WRAP
)
assert (
pipeline.graph["chat_producer"]["receiver"]["message/texts"]["conversion_strategy"]
== ConversionStrategy.WRAP_CHAT_MESSAGE_TO_STR
)
def test_connect_auto_variadic_chat_message_to_list_chat_message(self):
pipeline = PipelineBase()
receiver = ListChatMessageAcceptor()
pipeline.add_component("producer1", ChatMessageProducer())
pipeline.add_component("producer2", ChatMessageProducer())
pipeline.add_component("receiver", receiver)
pipeline.connect("producer1.message", "receiver.messages")
pipeline.connect("producer2.message", "receiver.messages")
inp_socket = InputSocket(name="messages", type=list[ChatMessage], senders=["producer1", "producer2"])
inp_socket.is_lazy_variadic = True
inp_socket.wrap_input_in_list = False
assert receiver.__haystack_input__._sockets_dict == {"messages": inp_socket} # type: ignore[attr-defined]
assert receiver.__haystack_input__._sockets_dict["messages"].senders == ["producer1", "producer2"] # type: ignore[attr-defined]
assert (
pipeline.graph["producer1"]["receiver"]["message/messages"]["conversion_strategy"]
== ConversionStrategy.WRAP
)
assert (
pipeline.graph["producer2"]["receiver"]["message/messages"]["conversion_strategy"]
== ConversionStrategy.WRAP
)
def test_connect_auto_variadic_str_to_list_chat_message(self):
pipeline = PipelineBase()
receiver = ListChatMessageAcceptor()
pipeline.add_component("producer1", StringProducer())
pipeline.add_component("producer2", StringProducer())
pipeline.add_component("receiver", receiver)
pipeline.connect("producer1.text", "receiver.messages")
pipeline.connect("producer2.text", "receiver.messages")
inp_socket = InputSocket(name="messages", type=list[ChatMessage], senders=["producer1", "producer2"])
inp_socket.is_lazy_variadic = True
inp_socket.wrap_input_in_list = False
assert receiver.__haystack_input__._sockets_dict == {"messages": inp_socket} # type: ignore[attr-defined]
assert receiver.__haystack_input__._sockets_dict["messages"].senders == ["producer1", "producer2"] # type: ignore[attr-defined]
assert (
pipeline.graph["producer1"]["receiver"]["text/messages"]["conversion_strategy"]
== ConversionStrategy.WRAP_STR_TO_CHAT_MESSAGE
)
assert (
pipeline.graph["producer2"]["receiver"]["text/messages"]["conversion_strategy"]
== ConversionStrategy.WRAP_STR_TO_CHAT_MESSAGE
)
def test_connect_auto_variadic_str_and_chat_message_to_list_chat_message(self):
pipeline = PipelineBase()
receiver = ListChatMessageAcceptor()
pipeline.add_component("str_producer", StringProducer())
pipeline.add_component("chat_producer", ChatMessageProducer())
pipeline.add_component("receiver", receiver)
pipeline.connect("str_producer.text", "receiver.messages")
pipeline.connect("chat_producer.message", "receiver.messages")
inp_socket = InputSocket(name="messages", type=list[ChatMessage], senders=["str_producer", "chat_producer"])
inp_socket.is_lazy_variadic = True
inp_socket.wrap_input_in_list = False
assert receiver.__haystack_input__._sockets_dict == {"messages": inp_socket} # type: ignore[attr-defined]
assert receiver.__haystack_input__._sockets_dict["messages"].senders == ["str_producer", "chat_producer"] # type: ignore[attr-defined]
assert (
pipeline.graph["str_producer"]["receiver"]["text/messages"]["conversion_strategy"]
== ConversionStrategy.WRAP_STR_TO_CHAT_MESSAGE
)
assert (
pipeline.graph["chat_producer"]["receiver"]["message/messages"]["conversion_strategy"]
== ConversionStrategy.WRAP
)
def test_connect_auto_variadic_chat_message_and_list_chat_message_to_list_chat_message(self):
pipeline = PipelineBase()
receiver = ListChatMessageAcceptor()
pipeline.add_component("chat_producer", ChatMessageProducer())
pipeline.add_component("list_producer", ListChatMessageProducer())
pipeline.add_component("receiver", receiver)
pipeline.connect("chat_producer.message", "receiver.messages")
pipeline.connect("list_producer.messages", "receiver.messages")
inp_socket = InputSocket(name="messages", type=list[ChatMessage], senders=["chat_producer", "list_producer"])
inp_socket.is_lazy_variadic = True
inp_socket.wrap_input_in_list = False
assert receiver.__haystack_input__._sockets_dict == {"messages": inp_socket} # type: ignore[attr-defined]
assert receiver.__haystack_input__._sockets_dict["messages"].senders == ["chat_producer", "list_producer"] # type: ignore[attr-defined]
assert (
pipeline.graph["chat_producer"]["receiver"]["message/messages"]["conversion_strategy"]
== ConversionStrategy.WRAP
)
assert pipeline.graph["list_producer"]["receiver"]["messages/messages"]["conversion_strategy"] is None
def test_connect_with_conversion_chat_message_to_str(self):
@component
class ChatMessageOutput:
@component.output_types(message=ChatMessage)
def run(self) -> dict[str, ChatMessage]:
return {"message": ChatMessage.from_assistant("Hello")}
@component
class StringInput:
@component.output_types(text=str)
def run(self, text: str) -> dict[str, str]:
return {"text": text}
chat_message_output = ChatMessageOutput()
string_input = StringInput()
pipe = PipelineBase()
pipe.add_component("chat_message_output", chat_message_output)
pipe.add_component("string_input", string_input)
pipe.connect("chat_message_output.message", "string_input.text")
assert chat_message_output.__haystack_output__.message.receivers == ["string_input"] # type: ignore[attr-defined]
assert string_input.__haystack_input__.text.senders == ["chat_message_output"] # type: ignore[attr-defined]
assert list(pipe.graph.edges) == [("chat_message_output", "string_input", "message/text")]
def test_connect_with_conversion_list_unwrap(self):
@component
class ListOutput:
@component.output_types(list=list[ChatMessage])
def run(self) -> dict[str, list[ChatMessage]]:
return {"list": [ChatMessage.from_user("Hello")]}
@component
class StringInput:
@component.output_types(text=str)
def run(self, text: str) -> dict[str, str]:
return {"text": text}
list_output = ListOutput()
string_input = StringInput()
pipe = PipelineBase()
pipe.add_component("list_output", list_output)
pipe.add_component("string_input", string_input)
pipe.connect("list_output.list", "string_input.text")
assert list_output.__haystack_output__.list.receivers == ["string_input"] # type: ignore[attr-defined]
assert string_input.__haystack_input__.text.senders == ["list_output"] # type: ignore[attr-defined]
assert list(pipe.graph.edges) == [("list_output", "string_input", "list/text")]
def test_connect_with_conversion_wrap(self):
@component
class StringOutput:
@component.output_types(string=str)
def run(self) -> dict[str, str]:
return {"string": "Hello"}
@component
class ListChatMessageInput:
@component.output_types(messages=list[ChatMessage])
def run(self, messages: list[ChatMessage]) -> dict[str, list[ChatMessage]]:
return {"messages": messages}
string_output = StringOutput()
list_chat_message_input = ListChatMessageInput()
pipe = PipelineBase()
pipe.add_component("string_output", string_output)
pipe.add_component("list_chat_message_input", list_chat_message_input)
pipe.connect("string_output.string", "list_chat_message_input.messages")
assert string_output.__haystack_output__.string.receivers == ["list_chat_message_input"] # type: ignore[attr-defined]
assert list_chat_message_input.__haystack_input__.messages.senders == ["string_output"] # type: ignore[attr-defined]
assert list(pipe.graph.edges) == [("string_output", "list_chat_message_input", "string/messages")]
def test_connect_prioritizes_strict_connections(self):
"""
Test that when connecting a component with multiple convertible output sockets to another component
the strict connection is prioritized over the convertible one.
"""
@component
class MultiOutputComponent:
@component.output_types(message=ChatMessage, string=str)
def run(self) -> dict[str, ChatMessage | str]:
return {"message": ChatMessage.from_assistant("Hello"), "string": "Hello"}
@component
class ComponentStrInput:
@component.output_types(string=str)
def run(self, string: str) -> dict[str, str]:
return {"string": string}
multi_output_component = MultiOutputComponent()
component_str_input = ComponentStrInput()
pipe = PipelineBase()
pipe.add_component("multi_output_component", multi_output_component)
pipe.add_component("component_str_input", component_str_input)
pipe.connect("multi_output_component", "component_str_input")
connections = list(pipe.graph.edges(data=True))
assert len(connections) == 1
assert connections[0] == (
"multi_output_component",
"component_str_input",
{
"conn_type": "str",
"conversion_strategy": None,
"from_socket": OutputSocket(name="string", type=str, receivers=["component_str_input"]),
"to_socket": InputSocket(name="string", type=str, senders=["multi_output_component"]),
"mandatory": True,
},
)
class TestMakeSocketAutoVariadic:
@pytest.mark.parametrize(
"receiver_type,current_sender_type,new_sender_type",
[
# All lists
(list[int], list[int], list[int]),
# List unions
(list[str] | list[ChatMessage], list[str], list[str]),
(list[str] | list[ChatMessage], list[ChatMessage], list[ChatMessage]),
# Optional list
(list[int] | None, list[int], list[int]),
],
)
def test_successful(self, receiver_type, current_sender_type, new_sender_type):
pipe = PipelineBase()
inp_socket = pipe._make_socket_auto_variadic(
component_name="comp",
receiver_socket=InputSocket(name="input_to_comp3", type=receiver_type, senders=["comp1"]),
error_type=PipelineConnectError,
)
assert inp_socket.is_variadic is True
assert inp_socket.is_lazy_variadic is True
assert inp_socket.wrap_input_in_list is False
def test_raises_error_all_int(self):
with pytest.raises(PipelineConnectError):
pipe = PipelineBase()
_ = pipe._make_socket_auto_variadic(
component_name="comp",
receiver_socket=InputSocket(name="input_to_comp3", type=int, senders=["comp1"]),
error_type=PipelineConnectError,
)
class TestValidateInput:
def test_validate_input_wrong_comp_name(self):
pipe = PipelineBase()
pipe.add_component("comp", FakeComponent())
with pytest.raises(ValueError, match="Component named 'wrong_comp_name' not found in the pipeline."):
pipe.validate_input(data={"wrong_comp_name": {"input_": "test"}})
def test_validate_missing_mandatory_input(self):
pipe = PipelineBase()
pipe.add_component("comp", FakeComponent())
with pytest.raises(ValueError, match="Missing mandatory input 'input_' for component 'comp'."):
pipe.validate_input(data={"comp": {}})
def test_validate_wrong_input_name(self):
pipe = PipelineBase()
pipe.add_component("comp", FakeComponent())
with pytest.raises(ValueError, match="Input 'wrong_input' not found in component 'comp'."):
pipe.validate_input(data={"comp": {"wrong_input": "test", "input_": "test"}})
def test_validate_multiple_connections_to_non_variadic_input(self):
pipe = PipelineBase()
pipe.add_component("comp1", FakeComponent())
pipe.add_component("comp2", FakeComponent())
pipe.connect("comp1.value", "comp2.input_")
with pytest.raises(
ValueError,
match="Component 'comp2' cannot accept multiple inputs to 'input_'. "
"It is already connected to component 'comp1', and it can only accept inputs from multiple "
r"senders if its type is list, Optional\[list\], or union of list types.",
):
pipe.validate_input(data={"comp1": {"input_": "test"}, "comp2": {"input_": "extra_input"}})
def test_validate_multiple_connections_to_auto_variadic_input(self):
@component
class ListAcceptor:
@component.output_types(result=list[int])
def run(self, numbers: list[int]) -> dict[str, list[int]]:
return {"result": numbers}
comp2 = ListAcceptor()
pipe = PipelineBase()
pipe.add_component("comp1", ListAcceptor())
pipe.add_component("comp2", comp2)
pipe.connect("comp1.result", "comp2.numbers")
pipe.validate_input(data={"comp1": {"numbers": [1]}, "comp2": {"numbers": [2]}})
inp_socket = InputSocket(name="numbers", type=list[int], senders=["comp1"])
inp_socket.is_lazy_variadic = True
inp_socket.wrap_input_in_list = False
assert comp2.__haystack_input__._sockets_dict == {"numbers": inp_socket} # type: ignore[attr-defined]
assert comp2.__haystack_input__._sockets_dict["numbers"].senders == ["comp1"] # type: ignore[attr-defined]
class TestFindComponentsBlockingPipeline:
def test_missing_input(self):
pipe = PipelineBase()
pipe.add_component("comp1", FakeComponent())
pipe.add_component("comp2", FakeComponent())
pipe.connect("comp1.value", "comp2.input_")
priority_queue = FIFOPriorityQueue()
priority_queue.push("comp1", ComponentPriority.BLOCKED)
priority_queue.push("comp2", ComponentPriority.BLOCKED)
blocking_comps, blocking_comp_types = pipe._find_components_blocking_pipeline(
priority_queue=priority_queue,
component_visits={"comp1": 1, "comp2": 0},
inputs={
"comp1": {"input_": [{"sender": None, "value": "some user input"}]},
# We are mimicking the state where the output of comp1 was misnamed (e.g. output_types doesn't match
# the actually returned output dict). This results in an _empty input to comp2.
"comp2": {"input_": [{"sender": "comp1", "value": _empty}]},
},
)
assert blocking_comps == ["comp2"]
assert blocking_comp_types == ["FakeComponent"]
def test_blocked_components_linear(self):
"""Tests that we only return the component directly blocked by missing input, and not downstream components"""
pipe = PipelineBase()
pipe.add_component("comp1", FakeComponent())
pipe.add_component("comp2", FakeComponent())
pipe.add_component("comp3", FakeComponent())
pipe.connect("comp1.value", "comp2.input_")
pipe.connect("comp2.value", "comp3.input_")
priority_queue = FIFOPriorityQueue()
priority_queue.push("comp1", ComponentPriority.BLOCKED)
priority_queue.push("comp2", ComponentPriority.BLOCKED)
priority_queue.push("comp3", ComponentPriority.BLOCKED)
blocking_comps, blocking_comp_types = pipe._find_components_blocking_pipeline(
priority_queue=priority_queue,
component_visits={"comp1": 1, "comp2": 0, "comp3": 0},
inputs={
"comp1": {"input_": [{"sender": None, "value": "some user input"}]},
# We are mimicking the state where the output of comp1 was misnamed (e.g. output_types doesn't match
# the actually returned output dict). This results in an _empty input to comp2.
"comp2": {"input_": [{"sender": "comp1", "value": _empty}]},
},
)
assert blocking_comps == ["comp2"]
assert blocking_comp_types == ["FakeComponent"]
def test_blocking_components_from_two_branches(self):
"""Tests that we can correctly identify both potentially blocking components"""
pipe = PipelineBase()
pipe.add_component("comp1", FakeComponent())
pipe.add_component("router", FakeRouter())
pipe.add_component("comp2", FakeComponent())
pipe.add_component("blocking_comp", FakeComponent())
pipe.add_component("a_comp3", FakeComponent())
pipe.connect("comp1.value", "router.inp")
pipe.connect("router.route1", "comp2.input_")
pipe.connect("comp2.value", "blocking_comp.input_")
pipe.connect("router.route2", "a_comp3.input_")
priority_queue = FIFOPriorityQueue()
priority_queue.push("comp1", ComponentPriority.BLOCKED)
priority_queue.push("router", ComponentPriority.BLOCKED)
priority_queue.push("comp2", ComponentPriority.BLOCKED)
priority_queue.push("blocking_comp", ComponentPriority.BLOCKED)
priority_queue.push("a_comp3", ComponentPriority.BLOCKED)
blocking_comps, blocking_comp_types = pipe._find_components_blocking_pipeline(
priority_queue=priority_queue,
component_visits={"comp1": 1, "router": 1, "comp2": 1, "a_comp3": 0, "blocking_comp": 0},
inputs={
# Mimicking the user providing "route1" as input to the pipeline.run
"comp1": {"input_": [{"sender": None, "value": "route1"}]},
# For educational purposes I've left what the inputs would have looked like while running the pipeline.
# These aren't actually present when trying to execute "blocking_comp" since we consume (i.e. remove)
# inputs passed between components.
# "router": {"value": [{"sender": "comp1", "value": "route1"}]},
# "comp2": {"input_": [{"sender": "router", "value": "output from route 1"}]},
# We are mimicking the state where the output of comp2 was misnamed (e.g. output_types doesn't match
# the actually returned output dict). This results in an _empty input to blocking_comp.
"blocking_comp": {"input_": [{"sender": "comp2", "value": _empty}]},
# The input to a_comp3 should be present and the value should be _empty since route 2 wasn't activated
"a_comp3": {"input_": [{"sender": "router", "value": _empty}]},
},
)
# We correctly label as both potentially blocking since it's unclear from the input state which component is
# actually blocking.
assert blocking_comps == ["a_comp3", "blocking_comp"]
assert blocking_comp_types == ["FakeComponent", "FakeComponent"]