Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions haystack/components/agents/agent.py
Original file line number Diff line number Diff line change
Expand Up @@ -719,7 +719,11 @@ def from_dict(cls, data: dict[str, Any]) -> "Agent":
:param data: Dictionary to deserialize from.
:returns: Deserialized agent.
"""
init_params = data.get("init_parameters", {})
# Copy before deserializing: writing into the caller's mapping destroys the
# serialized handles, so the payload can no longer be JSON-serialized and a
# second from_dict() receives already-parsed objects. default_from_dict
# already copies (see its comment); this write happens before that copy.
init_params = dict(data.get("init_parameters", {}))

deserialize_component_inplace(init_params, key="chat_generator")

Expand All @@ -734,7 +738,7 @@ def from_dict(cls, data: dict[str, Any]) -> "Agent":
if init_params.get("hooks") is not None:
init_params["hooks"] = _deserialize_hooks_dictionary(init_params["hooks"])

return default_from_dict(cls, data)
return default_from_dict(cls, {**data, "init_parameters": init_params})

def _create_agent_span(self, tools: ToolsType) -> Any:
"""
Expand Down
8 changes: 6 additions & 2 deletions haystack/components/builders/chat_prompt_builder.py
Original file line number Diff line number Diff line change
Expand Up @@ -343,12 +343,16 @@ def from_dict(cls, data: dict[str, Any]) -> "ChatPromptBuilder":
:returns:
The deserialized component.
"""
init_parameters = data["init_parameters"]
# Copy before deserializing: writing into the caller's mapping destroys the
# serialized handles, so the payload can no longer be JSON-serialized and a
# second from_dict() receives already-parsed objects. default_from_dict
# already copies (see its comment); this write happens before that copy.
init_parameters = dict(data["init_parameters"])
template = init_parameters.get("template")
if template:
if isinstance(template, list):
init_parameters["template"] = [ChatMessage.from_dict(d) for d in template]
elif isinstance(template, str):
init_parameters["template"] = template

return default_from_dict(cls, data)
return default_from_dict(cls, {**data, "init_parameters": init_parameters})
8 changes: 6 additions & 2 deletions haystack/components/converters/output_adapter.py
Original file line number Diff line number Diff line change
Expand Up @@ -175,7 +175,11 @@ def from_dict(cls, data: dict[str, Any]) -> "OutputAdapter":
:returns:
The deserialized component.
"""
init_params = data.get("init_parameters", {})
# Copy before deserializing: writing into the caller's mapping destroys the
# serialized handles, so the payload can no longer be JSON-serialized and a
# second from_dict() receives already-parsed objects. default_from_dict
# already copies (see its comment); this write happens before that copy.
init_params = dict(data.get("init_parameters", {}))

# `unsafe=True` swaps the Jinja sandbox for a NativeEnvironment that executes arbitrary code.
# Honor it from serialized data only when the whole pipeline is being loaded in unsafe mode;
Expand All @@ -201,4 +205,4 @@ def from_dict(cls, data: dict[str, Any]) -> "OutputAdapter":
name: deserialize_callable(filter_func) if filter_func else None
for name, filter_func in custom_filters.items()
}
return default_from_dict(cls, data)
return default_from_dict(cls, {**data, "init_parameters": init_params})
8 changes: 6 additions & 2 deletions haystack/components/embedders/mock_document_embedder.py
Original file line number Diff line number Diff line change
Expand Up @@ -122,11 +122,15 @@ def to_dict(self) -> dict[str, Any]:
@classmethod
def from_dict(cls, data: dict[str, Any]) -> MockDocumentEmbedder:
"""Deserialize the component from a dictionary."""
init_params = data.get("init_parameters", {})
# Copy before deserializing: writing into the caller's mapping destroys the
# serialized handles, so the payload can no longer be JSON-serialized and a
# second from_dict() receives already-parsed objects. default_from_dict
# already copies (see its comment); this write happens before that copy.
init_params = dict(data.get("init_parameters", {}))
embedding_fn = init_params.get("embedding_fn")
if embedding_fn:
init_params["embedding_fn"] = deserialize_callable(embedding_fn)
return default_from_dict(cls, data)
return default_from_dict(cls, {**data, "init_parameters": init_params})

def warm_up(self) -> None:
"""No-op warm up, provided for interface compatibility with real Embedders."""
Expand Down
8 changes: 6 additions & 2 deletions haystack/components/embedders/mock_text_embedder.py
Original file line number Diff line number Diff line change
Expand Up @@ -105,11 +105,15 @@ def to_dict(self) -> dict[str, Any]:
@classmethod
def from_dict(cls, data: dict[str, Any]) -> MockTextEmbedder:
"""Deserialize the component from a dictionary."""
init_params = data.get("init_parameters", {})
# Copy before deserializing: writing into the caller's mapping destroys the
# serialized handles, so the payload can no longer be JSON-serialized and a
# second from_dict() receives already-parsed objects. default_from_dict
# already copies (see its comment); this write happens before that copy.
init_params = dict(data.get("init_parameters", {}))
embedding_fn = init_params.get("embedding_fn")
if embedding_fn:
init_params["embedding_fn"] = deserialize_callable(embedding_fn)
return default_from_dict(cls, data)
return default_from_dict(cls, {**data, "init_parameters": init_params})

def warm_up(self) -> None:
"""No-op warm up, provided for interface compatibility with real Embedders."""
Expand Down
8 changes: 6 additions & 2 deletions haystack/components/generators/chat/fallback.py
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,11 @@ def to_dict(self) -> dict[str, Any]:
def from_dict(cls, data: dict[str, Any]) -> FallbackChatGenerator:
"""Rebuild the component from a serialized representation, restoring nested chat generators."""
# Reconstruct nested chat generators from their serialized dicts
init_params = data.get("init_parameters", {})
# Copy before deserializing: writing into the caller's mapping destroys the
# serialized handles, so the payload can no longer be JSON-serialized and a
# second from_dict() receives already-parsed objects. default_from_dict
# already copies (see its comment); this write happens before that copy.
init_params = dict(data.get("init_parameters", {}))
serialized = init_params.get("chat_generators") or []
deserialized: list[Any] = []
for g in serialized:
Expand All @@ -84,7 +88,7 @@ def from_dict(cls, data: dict[str, Any]) -> FallbackChatGenerator:
deserialized.append(holder["component"])
init_params["chat_generators"] = deserialized
data["init_parameters"] = init_params
return default_from_dict(cls, data)
return default_from_dict(cls, {**data, "init_parameters": init_params})

def warm_up(self) -> None:
"""Warm up all underlying chat generators."""
Expand Down
8 changes: 6 additions & 2 deletions haystack/components/generators/chat/llm.py
Original file line number Diff line number Diff line change
Expand Up @@ -115,14 +115,18 @@ def from_dict(cls, data: dict[str, Any]) -> "LLM":
:param data: Dictionary to deserialize from.
:return: Deserialized LLM instance.
"""
init_params = data.get("init_parameters", {})
# Copy before deserializing: writing into the caller's mapping destroys the
# serialized handles, so the payload can no longer be JSON-serialized and a
# second from_dict() receives already-parsed objects. default_from_dict
# already copies (see its comment); this write happens before that copy.
init_params = dict(data.get("init_parameters", {}))

deserialize_component_inplace(init_params, key="chat_generator")

if init_params.get("streaming_callback") is not None:
init_params["streaming_callback"] = deserialize_callable(init_params["streaming_callback"])

return default_from_dict(cls, data)
return default_from_dict(cls, {**data, "init_parameters": init_params})

def run( # type: ignore[override] # `messages` is in **kwargs to allow dynamic required/optional status
self,
Expand Down
8 changes: 6 additions & 2 deletions haystack/components/preprocessors/document_splitter.py
Original file line number Diff line number Diff line change
Expand Up @@ -524,13 +524,17 @@ def from_dict(cls, data: dict[str, Any]) -> "DocumentSplitter":
"""
Deserializes the component from a dictionary.
"""
init_params = data.get("init_parameters", {})
# Copy before deserializing: writing into the caller's mapping destroys the
# serialized handles, so the payload can no longer be JSON-serialized and a
# second from_dict() receives already-parsed objects. default_from_dict
# already copies (see its comment); this write happens before that copy.
init_params = dict(data.get("init_parameters", {}))

splitting_function = init_params.get("splitting_function", None)
if splitting_function:
init_params["splitting_function"] = deserialize_callable(splitting_function)

return default_from_dict(cls, data)
return default_from_dict(cls, {**data, "init_parameters": init_params})

@staticmethod
def _concatenate_sentences_based_on_word_amount(
Expand Down
8 changes: 6 additions & 2 deletions haystack/components/retrievers/in_memory/bm25_retriever.py
Original file line number Diff line number Diff line change
Expand Up @@ -112,10 +112,14 @@ def from_dict(cls, data: dict[str, Any]) -> "InMemoryBM25Retriever":
:returns:
The deserialized component.
"""
init_params = data.get("init_parameters", {})
# Copy before deserializing: writing into the caller's mapping destroys the
# serialized handles, so the payload can no longer be JSON-serialized and a
# second from_dict() receives already-parsed objects. default_from_dict
# already copies (see its comment); this write happens before that copy.
init_params = dict(data.get("init_parameters", {}))
if "filter_policy" in init_params:
init_params["filter_policy"] = FilterPolicy.from_str(init_params["filter_policy"])
return default_from_dict(cls, data)
return default_from_dict(cls, {**data, "init_parameters": init_params})

@component.output_types(documents=list[Document])
def run(
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -128,10 +128,14 @@ def from_dict(cls, data: dict[str, Any]) -> "InMemoryEmbeddingRetriever":
:returns:
The deserialized component.
"""
init_params = data.get("init_parameters", {})
# Copy before deserializing: writing into the caller's mapping destroys the
# serialized handles, so the payload can no longer be JSON-serialized and a
# second from_dict() receives already-parsed objects. default_from_dict
# already copies (see its comment); this write happens before that copy.
init_params = dict(data.get("init_parameters", {}))
if "filter_policy" in init_params:
init_params["filter_policy"] = FilterPolicy.from_str(init_params["filter_policy"])
return default_from_dict(cls, data)
return default_from_dict(cls, {**data, "init_parameters": init_params})

@component.output_types(documents=list[Document])
def run(
Expand Down
8 changes: 6 additions & 2 deletions haystack/components/writers/document_writer.py
Original file line number Diff line number Diff line change
Expand Up @@ -72,10 +72,14 @@ def from_dict(cls, data: dict[str, Any]) -> "DocumentWriter":
:raises DeserializationError:
If the document store is not properly specified in the serialization data or its type cannot be imported.
"""
init_params = data.get("init_parameters", {})
# Copy before deserializing: writing into the caller's mapping destroys the
# serialized handles, so the payload can no longer be JSON-serialized and a
# second from_dict() receives already-parsed objects. default_from_dict
# already copies (see its comment); this write happens before that copy.
init_params = dict(data.get("init_parameters", {}))
if "policy" in init_params:
init_params["policy"] = DuplicatePolicy[init_params["policy"]]
return default_from_dict(cls, data)
return default_from_dict(cls, {**data, "init_parameters": init_params})

@component.output_types(documents_written=int)
def run(self, documents: list[Document], policy: DuplicatePolicy | None = None) -> dict[str, int]:
Expand Down
8 changes: 6 additions & 2 deletions haystack/hooks/from_function.py
Original file line number Diff line number Diff line change
Expand Up @@ -112,12 +112,16 @@ def from_dict(cls, data: dict[str, Any]) -> "FunctionHook":
:param data: The serialized hook dictionary produced by `to_dict`.
:returns: The reconstructed `FunctionHook`.
"""
init_params = data.get("init_parameters", {})
# Copy before deserializing: writing into the caller's mapping destroys the
# serialized handles, so the payload can no longer be JSON-serialized and a
# second from_dict() receives already-parsed objects. default_from_dict
# already copies (see its comment); this write happens before that copy.
init_params = dict(data.get("init_parameters", {}))
if init_params.get("function") is not None:
init_params["function"] = deserialize_callable(init_params["function"])
if init_params.get("async_function") is not None:
init_params["async_function"] = deserialize_callable(init_params["async_function"])
return default_from_dict(cls, data)
return default_from_dict(cls, {**data, "init_parameters": init_params})


def hook(function: Callable[[State], None | Awaitable[None]]) -> FunctionHook:
Expand Down
8 changes: 6 additions & 2 deletions haystack/hooks/human_in_the_loop/hooks.py
Original file line number Diff line number Diff line change
Expand Up @@ -133,9 +133,13 @@ def to_dict(self) -> dict[str, Any]:
@classmethod
def from_dict(cls, data: dict[str, Any]) -> "ConfirmationHook":
"""Deserialize the hook, reconstructing its confirmation strategies."""
init_params = data.get("init_parameters", {})
# Copy before deserializing: writing into the caller's mapping destroys the
# serialized handles, so the payload can no longer be JSON-serialized and a
# second from_dict() receives already-parsed objects. default_from_dict
# already copies (see its comment); this write happens before that copy.
init_params = dict(data.get("init_parameters", {}))
if init_params.get("confirmation_strategies") is not None:
init_params["confirmation_strategies"] = _deserialize_confirmation_strategies(
init_params["confirmation_strategies"]
)
return default_from_dict(cls, data)
return default_from_dict(cls, {**data, "init_parameters": init_params})
8 changes: 6 additions & 2 deletions haystack/hooks/tool_result_offloading/hooks.py
Original file line number Diff line number Diff line change
Expand Up @@ -294,9 +294,13 @@ def from_dict(cls, data: dict[str, Any]) -> "ToolResultOffloadHook":
:param data: A dictionary representation produced by `to_dict`.
:returns: The deserialized `ToolResultOffloadHook`.
"""
init_params = data.get("init_parameters", {})
# Copy before deserializing: writing into the caller's mapping destroys the
# serialized handles, so the payload can no longer be JSON-serialized and a
# second from_dict() receives already-parsed objects. default_from_dict
# already copies (see its comment); this write happens before that copy.
init_params = dict(data.get("init_parameters", {}))
if init_params.get("store") is not None:
deserialize_component_inplace(init_params, key="store")
if init_params.get("offload_strategies") is not None:
init_params["offload_strategies"] = _deserialize_offload_strategies(data=init_params["offload_strategies"])
return default_from_dict(cls, data)
return default_from_dict(cls, {**data, "init_parameters": init_params})
5 changes: 4 additions & 1 deletion haystack/tools/component_tool.py
Original file line number Diff line number Diff line change
Expand Up @@ -345,7 +345,10 @@ def from_dict(cls, data: dict[str, Any]) -> "ComponentTool":
"""
Deserializes the ComponentTool from a dictionary.
"""
inner_data = data["data"]
# Copy before deserializing: writing into the caller's mapping destroys the
# serialized handles, so the payload can no longer be JSON-serialized and a
# second from_dict() receives already-parsed objects.
inner_data = dict(data["data"])
deserialize_component_inplace(data=inner_data, key="component")

if "outputs_to_state" in inner_data and inner_data["outputs_to_state"]:
Expand Down
5 changes: 4 additions & 1 deletion haystack/tools/pipeline_tool.py
Original file line number Diff line number Diff line change
Expand Up @@ -231,7 +231,10 @@ def from_dict(cls, data: dict[str, Any]) -> "PipelineTool":
:returns:
The deserialized PipelineTool instance.
"""
inner_data = data["data"]
# Copy before deserializing: writing into the caller's mapping destroys the
# serialized handles, so the payload can no longer be JSON-serialized and a
# second from_dict() receives already-parsed objects.
inner_data = dict(data["data"])
# `is_pipeline_async` is a legacy key kept only for backward compatibility
inner_data.pop("is_pipeline_async", None)
pipeline = Pipeline.from_dict(inner_data["pipeline"])
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
fixes:
- |
Fixed ``from_dict`` in several components writing deserialized objects back into the mapping passed in by the caller.
``DocumentWriter``, ``InMemoryBM25Retriever``, ``InMemoryEmbeddingRetriever``, ``DocumentSplitter``, ``ChatPromptBuilder``,
``Agent``, ``LLM``, ``FallbackChatGenerator``, ``MockTextEmbedder``, ``MockDocumentEmbedder``, ``OutputAdapter``,
``FunctionHook``, ``ConfirmationHook``, ``ToolResultOffloadHook``, ``ComponentTool`` and ``PipelineTool`` now deserialize
into a copy. ``default_from_dict`` already copies ``init_parameters`` for that reason, but these components replaced the
serialized handles in the caller's dictionary before calling it, so the copy protected nothing. The caller's mapping was
left holding live callables, enums or components: it could no longer be serialized with ``json.dumps`` and deserializing
it a second time failed.
78 changes: 78 additions & 0 deletions test/core/test_from_dict_does_not_mutate.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,78 @@
# SPDX-FileCopyrightText: 2022-present deepset GmbH <info@deepset.ai>
#
# SPDX-License-Identifier: Apache-2.0

"""`from_dict` must not write deserialized objects back into the caller's mapping.

`default_from_dict` copies `init_parameters` before replacing serialized
sub-objects (see the comment there), precisely so that a second deserialization
does not receive already-parsed objects. Several components did their own
deserialization into `data["init_parameters"]` *before* calling it, which
defeats that copy: the caller's dict ends up holding live objects, so it can no
longer be JSON-serialized and a second `from_dict` fails.

Same defect previously fixed one component at a time: MetadataRouter (#13421),
MockChatGenerator (#13471), ListJoiner (#13563), Tool (#13606). This test pins
the invariant for the components fixed alongside it.
"""

import json
from copy import deepcopy

import pytest

from haystack.components.builders import ChatPromptBuilder
from haystack.components.retrievers.in_memory import InMemoryBM25Retriever, InMemoryEmbeddingRetriever
from haystack.components.writers import DocumentWriter
from haystack.dataclasses import ChatMessage
from haystack.document_stores.in_memory import InMemoryDocumentStore
from haystack.document_stores.types import DuplicatePolicy, FilterPolicy

CASES = [
pytest.param(
DocumentWriter,
lambda: DocumentWriter(document_store=InMemoryDocumentStore(), policy=DuplicatePolicy.OVERWRITE),
id="document-writer-enum",
),
pytest.param(
InMemoryBM25Retriever,
lambda: InMemoryBM25Retriever(document_store=InMemoryDocumentStore(), filter_policy=FilterPolicy.MERGE),
id="bm25-retriever-enum",
),
pytest.param(
InMemoryEmbeddingRetriever,
lambda: InMemoryEmbeddingRetriever(document_store=InMemoryDocumentStore(), filter_policy=FilterPolicy.MERGE),
id="embedding-retriever-enum",
),
pytest.param(
ChatPromptBuilder,
lambda: ChatPromptBuilder(template=[ChatMessage.from_user("Hello")]),
id="chat-prompt-builder-nested-message",
),
]


@pytest.mark.parametrize("cls, build", CASES)
class TestFromDictDoesNotMutateCallerDict:
def test_caller_dict_is_unchanged(self, cls, build):
payload = build().to_dict()
snapshot = deepcopy(payload)

cls.from_dict(payload)

assert payload == snapshot

def test_payload_stays_json_serializable(self, cls, build):
payload = build().to_dict()

cls.from_dict(payload)

json.dumps(payload)

def test_second_deserialization_succeeds(self, cls, build):
payload = build().to_dict()

first = cls.from_dict(payload)
second = cls.from_dict(payload)

assert type(first) is type(second)