File size: 3,277 Bytes
ce676f7 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 | # SPDX-FileCopyrightText: 2022-present deepset GmbH <info@deepset.ai>
#
# SPDX-License-Identifier: Apache-2.0
import datetime
import logging
from unittest.mock import Mock, patch
import pytest
from haystack import Pipeline, component
from haystack.telemetry._telemetry import pipeline_running
from haystack.utils.auth import Secret, TokenSecret
@patch("haystack.telemetry._telemetry.telemetry")
def test_pipeline_running(telemetry):
telemetry.send_event = Mock()
@component
class Component:
def _get_telemetry_data(self):
return {"key": "values"}
@component.output_types(value=int)
def run(self):
pass
pipe = Pipeline()
pipe.add_component("component", Component())
pipeline_running(pipe)
# First run is always sent
telemetry.send_event.assert_called_once_with(
"Pipeline run (2.x)",
{
"pipeline_id": str(id(pipe)),
"runs": 1,
"components": {"test.test_telemetry.Component": [{"name": "component", "key": "values"}]},
},
)
# Running again before one minute has passed should not send another event
telemetry.send_event.reset_mock()
pipeline_running(pipe)
telemetry.send_event.assert_not_called()
# Set the last telemetry sent time to pretend one minute has passed
pipe._last_telemetry_sent = pipe._last_telemetry_sent - datetime.timedelta(minutes=1)
telemetry.send_event.reset_mock()
pipeline_running(pipe)
telemetry.send_event.assert_called_once_with(
"Pipeline run (2.x)",
{
"pipeline_id": str(id(pipe)),
"runs": 3,
"components": {"test.test_telemetry.Component": [{"name": "component", "key": "values"}]},
},
)
@patch("haystack.telemetry._telemetry.telemetry")
def test_pipeline_running_with_non_serializable_component(telemetry):
telemetry.send_event = Mock()
@component
class Component:
def __init__(self, api_key: Secret = TokenSecret("api_key")):
self.api_key = api_key
def _get_telemetry_data(self):
return {"key": "values"}
@component.output_types(value=int)
def run(self):
pass
pipe = Pipeline()
pipe.add_component("component", Component())
pipeline_running(pipe)
telemetry.send_event.assert_called_once_with(
"Pipeline run (2.x)",
{
"pipeline_id": str(id(pipe)),
"runs": 1,
"components": {"test.test_telemetry.Component": [{"name": "component", "key": "values"}]},
},
)
def test_pipeline_running_with_non_dict_telemetry_data(caplog):
@component
class Component:
def __init__(self, api_key: Secret = TokenSecret("api_key")):
self.api_key = api_key
# telemetry data should be a dictionary but is a list
def _get_telemetry_data(self):
return ["values"]
@component.output_types(value=int)
def run(self):
pass
pipe = Pipeline()
pipe.add_component("my_component", Component())
with caplog.at_level(logging.DEBUG):
pipeline_running(pipe)
assert "TypeError: Telemetry data for component my_component must be a dictionary" in caplog.text
|