Skip to content
Open
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
3 changes: 3 additions & 0 deletions taskiq/kicker.py
Original file line number Diff line number Diff line change
Expand Up @@ -208,6 +208,7 @@ async def schedule_by_cron(
schedule_id=schedule_id,
task_name=message.task_name,
labels=message.labels,
labels_types=message.labels_types,
args=message.args,
kwargs=message.kwargs,
task_id=self.custom_task_id,
Expand Down Expand Up @@ -242,6 +243,7 @@ async def schedule_by_interval(
schedule_id=schedule_id,
task_name=message.task_name,
labels=message.labels,
labels_types=message.labels_types,
args=message.args,
kwargs=message.kwargs,
task_id=self.custom_task_id,
Expand Down Expand Up @@ -273,6 +275,7 @@ async def schedule_by_time(
schedule_id=schedule_id,
task_name=message.task_name,
labels=message.labels,
labels_types=message.labels_types,
args=message.args,
kwargs=message.kwargs,
task_id=self.custom_task_id,
Expand Down
1 change: 1 addition & 0 deletions taskiq/scheduler/scheduled_task/task.py
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ class ScheduledTask(BaseModel):

task_name: str
labels: dict[str, Any]
labels_types: dict[str, int] | None = None
args: list[Any]
kwargs: dict[str, Any]
task_id: str | None = None
Expand Down
11 changes: 10 additions & 1 deletion taskiq/scheduler/scheduler.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@

from taskiq.exceptions import ScheduledTaskCancelledError
from taskiq.kicker import AsyncKicker
from taskiq.labels import parse_label
from taskiq.scheduler.scheduled_task import ScheduledTask
from taskiq.utils import maybe_awaitable

Expand Down Expand Up @@ -47,8 +48,16 @@ async def on_ready(self, source: "ScheduleSource", task: ScheduledTask) -> None:
except ScheduledTaskCancelledError:
logger.info("Scheduled task %s has been cancelled.", task.task_name)
else:
labels = (
{
label: parse_label(val, task.labels_types.get(label))
for label, val in task.labels.items()
}
if task.labels_types is not None
else dict(task.labels)
)
await (
AsyncKicker(task.task_name, self.broker, task.labels)
AsyncKicker(task.task_name, self.broker, labels)
.with_labels(
schedule_id=task.schedule_id,
)
Expand Down
77 changes: 77 additions & 0 deletions tests/scheduler/test_scheduler.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
from datetime import datetime, timezone
from typing import Any

from taskiq import Context, TaskiqDepends
from taskiq.abc.schedule_source import ScheduleSource
from taskiq.brokers.inmemory_broker import InMemoryBroker
from taskiq.exceptions import ScheduledTaskCancelledError
Expand Down Expand Up @@ -31,3 +35,76 @@ async def test_scheduled_task_cancelled() -> None:
)

await scheduler.on_ready(source, task) # error is caught


class _RecordingScheduleSource(ScheduleSource):
def __init__(self) -> None:
self.schedules: list[ScheduledTask] = []

async def get_schedules(self) -> list[ScheduledTask]:
return list(self.schedules)

async def add_schedule(self, schedule: ScheduledTask) -> None:
self.schedules.append(schedule)


async def test_scheduled_task_preserves_label_types() -> None:
broker = InMemoryBroker(await_inplace=True)
source = _RecordingScheduleSource()
scheduler = TaskiqScheduler(broker=broker, sources=[source])
received: list[dict[str, Any]] = []

@broker.task
async def inspect_labels(context: Context = TaskiqDepends()) -> None:
received.append(dict(context.message.labels))

raw_labels: dict[str, Any] = {
"count": 5,
"ratio": 1.5,
"flag": False,
"data": b"hi",
}
kicker = inspect_labels.kicker().with_labels(**raw_labels)
await kicker.schedule_by_cron(source, "* * * * *")
await kicker.schedule_by_interval(source, 60)
await kicker.schedule_by_time(source, datetime.now(timezone.utc))

for stored in source.schedules:
restored = ScheduledTask.model_validate(stored.model_dump(mode="json"))
await scheduler.on_ready(source, restored)

assert len(received) == 3
for labels in received:
assert labels["count"] == 5
assert type(labels["count"]) is int
assert labels["ratio"] == 1.5
assert type(labels["ratio"]) is float
assert labels["flag"] is False
assert type(labels["flag"]) is bool
assert labels["data"] == b"hi"
assert type(labels["data"]) is bytes


async def test_scheduled_task_without_labels_types_still_works() -> None:
broker = InMemoryBroker(await_inplace=True)
source = _RecordingScheduleSource()
scheduler = TaskiqScheduler(broker=broker, sources=[source])
received: dict[str, Any] = {}

@broker.task
async def inspect_labels(context: Context = TaskiqDepends()) -> None:
received.update(context.message.labels)

task = ScheduledTask(
task_name=inspect_labels.task_name,
labels={"queue": "default", "retries": 2},
args=[],
kwargs={},
cron="* * * * *",
)
await scheduler.on_ready(source, task)

assert received["queue"] == "default"
assert received["retries"] == 2
assert type(received["retries"]) is int
assert "schedule_id" not in task.labels
Loading