AutoGPT is the vision of accessible AI for everyone, to use and to build on. Our mission is to provide the tools, so that you can focus on what matters.
fix(platform): validate schedule names before dispatch (#13400)
Sahil Mangla77c99b67c0b0
diff --git a/autogpt_platform/backend/backend/api/features/schedules/model.py b/autogpt_platform/backend/backend/api/features/schedules/model.pyindex b05c8bbf4f..35ad166376 100644--- a/autogpt_platform/backend/backend/api/features/schedules/model.py+++ b/autogpt_platform/backend/backend/api/features/schedules/model.py@@ -3,11 +3,12 @@ from typing import Any, Optionalimport pydanticfrom backend.data.model import CredentialsMetaInput+from backend.data.schedule import ScheduleNameclass ScheduleCreationRequest(pydantic.BaseModel):graph_version: Optional[int] = None- name: str+ name: ScheduleNamecron: strinputs: dict[str, Any]credentials: dict[str, CredentialsMetaInput] = pydantic.Field(default_factory=dict)diff --git a/autogpt_platform/backend/backend/api/features/schedules/name_validation_test.py b/autogpt_platform/backend/backend/api/features/schedules/name_validation_test.pynew file mode 100644index 0000000000..00dcb7351f--- /dev/null+++ b/autogpt_platform/backend/backend/api/features/schedules/name_validation_test.py@@ -0,0 +1,41 @@+from unittest.mock import AsyncMock, Mock, patch++import pytest+from fastapi import FastAPI+from fastapi.testclient import TestClient++from backend.api.features.schedules import routes+from backend.api.features.schedules.model import ScheduleCreationRequest++[email protected]("name", ["", " ", "\t\n", "\u2003"])+def test_blank_schedule_name_is_rejected_before_dispatch(name: str):+ app = FastAPI()+ app.include_router(routes.router)+ app.dependency_overrides[routes.requires_user] = lambda: None+ app.dependency_overrides[routes.get_user_id] = lambda: "user-1"+ app.dependency_overrides[routes.get_request_context] = lambda: Mock(+ org_id=None, team_id=None+ )+ with (+ patch.object(+ routes.graph_db, "get_graph", AsyncMock(return_value=None)+ ) as graph,+ patch.object(routes, "get_scheduler_client") as scheduler,+ TestClient(app) as client,+ ):+ response = client.post(+ "/graphs/graph-1/schedules",+ json={"name": name, "cron": "0 9 * * *", "inputs": {}},+ )+ assert response.status_code == 422+ assert response.json()["detail"][0]["loc"] == ["body", "name"]+ graph.assert_not_awaited()+ scheduler.assert_not_called()+++def test_schedule_name_is_trimmed_without_changing_internal_spaces():+ request = ScheduleCreationRequest(+ name=" Weekly report ", cron="0 9 * * *", inputs={}+ )+ assert request.name == "Weekly report"diff --git a/autogpt_platform/backend/backend/copilot/tools/run_agent.py b/autogpt_platform/backend/backend/copilot/tools/run_agent.pyindex 0283948c63..372dd44b65 100644--- a/autogpt_platform/backend/backend/copilot/tools/run_agent.py+++ b/autogpt_platform/backend/backend/copilot/tools/run_agent.py@@ -1219,6 +1219,7 @@ class RunAgentTool(BaseTool):session_id = session.session_id# Validate schedule params+ schedule_name = schedule_name.strip()if not schedule_name:return ErrorResponse(message="schedule_name is required for scheduled execution",diff --git a/autogpt_platform/backend/backend/copilot/tools/run_agent_schedule_name_test.py b/autogpt_platform/backend/backend/copilot/tools/run_agent_schedule_name_test.pynew file mode 100644index 0000000000..a025acef26--- /dev/null+++ b/autogpt_platform/backend/backend/copilot/tools/run_agent_schedule_name_test.py@@ -0,0 +1,36 @@+from unittest.mock import AsyncMock, MagicMock, patch++import pytest++from backend.copilot.tools.models import ErrorResponse+from backend.copilot.tools.run_agent import RunAgentTool++from ._test_data import make_session++[email protected]("name", ["", " ", "\t\n", "\u2003"])+async def test_blank_schedule_name_returns_error_before_side_effects(name: str):+ with (+ patch("backend.copilot.tools.run_agent.user_db") as users,+ patch(+ "backend.copilot.tools.run_agent.get_or_create_library_agent",+ new_callable=AsyncMock,+ ) as library,+ patch("backend.copilot.tools.run_agent.get_scheduler_client") as scheduler,+ ):+ response = await RunAgentTool()._schedule_agent(+ user_id="user-1",+ session=make_session("user-1"),+ graph=MagicMock(),+ graph_credentials={},+ inputs={},+ schedule_name=name,+ cron="0 9 * * *",+ timezone=None,+ )+ assert isinstance(response, ErrorResponse)+ assert response.message == "schedule_name is required for scheduled execution"+ users.assert_not_called()+ library.assert_not_awaited()+ scheduler.assert_not_called()diff --git a/autogpt_platform/backend/backend/data/schedule.py b/autogpt_platform/backend/backend/data/schedule.pynew file mode 100644index 0000000000..7dcc0ae6ed--- /dev/null+++ b/autogpt_platform/backend/backend/data/schedule.py@@ -0,0 +1,12 @@+from typing import Annotated++from pydantic import StringConstraints, TypeAdapter++ScheduleName = Annotated[+ str, StringConstraints(strip_whitespace=True, min_length=1, pattern=r"\S")+]+_schedule_name = TypeAdapter(ScheduleName | None)+++def normalize_schedule_name(name: str | None) -> str | None:+ return _schedule_name.validate_python(name)diff --git a/autogpt_platform/backend/backend/executor/scheduler.py b/autogpt_platform/backend/backend/executor/scheduler.pyindex d6115e1b19..c679e0db01 100644--- a/autogpt_platform/backend/backend/executor/scheduler.py+++ b/autogpt_platform/backend/backend/executor/scheduler.py@@ -43,6 +43,7 @@ from backend.copilot.transports import resolve_default_chat_routefrom backend.data.db_accessors import experts_dbfrom backend.data.execution import ExecutionTrigger, GraphExecutionWithNodesfrom backend.data.model import CredentialsMetaInput, GraphInput+from backend.data.schedule import normalize_schedule_namefrom backend.executor import schedule_eventsfrom backend.executor import utils as execution_utilsfrom backend.executor.jobstore import ResilientSQLAlchemyJobStore@@ -2227,6 +2228,8 @@ class Scheduler(AppService):team_id: Optional[str] = None,expert_id: Optional[str] = None,) -> GraphExecutionJobInfo:+ name = normalize_schedule_name(name)+if expert_id is not None:organization_id, team_id = run_async(experts_db().resolve_private_expert_tenancy(user_id, expert_id)diff --git a/autogpt_platform/backend/backend/executor/scheduler_unit_test.py b/autogpt_platform/backend/backend/executor/scheduler_unit_test.pyindex 1350b30791..eaf7df107a 100644--- a/autogpt_platform/backend/backend/executor/scheduler_unit_test.py+++ b/autogpt_platform/backend/backend/executor/scheduler_unit_test.py@@ -2174,3 +2174,24 @@ async def test_a_switched_on_routine_still_fires():schedule_turn.assert_awaited_once()self_delete.assert_not_awaited()++[email protected]("name", ["", " ", "\t\n", "\u2003"])+def test_graph_schedule_rejects_blank_names_before_validation_or_persistence(name):+ scheduler = Scheduler(register_system_tasks=False)+ with (+ patch(f"{_SCHEDULER_PATH}.run_async") as run,+ patch.object(scheduler, "_persist_schedule") as persist,+ pytest.raises(ValueError, match="at least 1 character"),+ ):+ scheduler.add_graph_execution_schedule(+ user_id="user-1",+ graph_id="graph-1",+ graph_version=1,+ cron="0 9 * * *",+ input_data={},+ input_credentials={},+ name=name,+ )+ run.assert_not_called()+ persist.assert_not_called()diff --git a/autogpt_platform/frontend/src/app/(platform)/build/components/BuilderActions/components/CronSchedulerDialog/CronSchedulerDialog.tsx b/autogpt_platform/frontend/src/app/(platform)/build/components/BuilderActions/components/CronSchedulerDialog/CronSchedulerDialog.tsxindex e6a0023e25..8c1572a485 100644--- a/autogpt_platform/frontend/src/app/(platform)/build/components/BuilderActions/components/CronSchedulerDialog/CronSchedulerDialog.tsx+++ b/autogpt_platform/frontend/src/app/(platform)/build/components/BuilderActions/components/CronSchedulerDialog/CronSchedulerDialog.tsx@@ -31,6 +31,7 @@ export function CronSchedulerDialog({handleCreateSchedule,scheduleName,setScheduleName,+ scheduleNameError,isCreatingSchedule,} = useCronSchedulerDialog({open,@@ -55,6 +56,7 @@ export function CronSchedulerDialog({className="max-w-80"value={scheduleName}onChange={(e) => setScheduleName(e.target.value)}+ error={scheduleNameError}/><CronSchedulerdiff --git a/autogpt_platform/frontend/src/app/(platform)/build/components/BuilderActions/components/CronSchedulerDialog/useCronSchedulerDialog.test.tsx b/autogpt_platform/frontend/src/app/(platform)/build/components/BuilderActions/components/CronSchedulerDialog/useCronSchedulerDialog.test.tsxindex f39e54bf65..dec73f7975 100644--- a/autogpt_platform/frontend/src/app/(platform)/build/components/BuilderActions/components/CronSchedulerDialog/useCronSchedulerDialog.test.tsx+++ b/autogpt_platform/frontend/src/app/(platform)/build/components/BuilderActions/components/CronSchedulerDialog/useCronSchedulerDialog.test.tsx@@ -1,4 +1,7 @@-import { getPostV1CreateExecutionScheduleMockHandler } from "@/app/api/__generated__/endpoints/schedules/schedules.msw";+import {+ getPostV1CreateExecutionScheduleMockHandler,+ getPostV1CreateExecutionScheduleResponseMock,+} from "@/app/api/__generated__/endpoints/schedules/schedules.msw";import { server } from "@/mocks/mock-server";import * as invalidateSchedules from "@/services/schedules/invalidate-schedules";import { act, renderHook, waitFor } from "@/tests/integrations/test-utils";@@ -42,7 +45,13 @@ afterEach(() => {describe("useCronSchedulerDialog", () => {test("successful create invalidates ALL schedule queries (regression: previously invalidated NONE)", async () => {- server.use(getPostV1CreateExecutionScheduleMockHandler());+ const requests: unknown[] = [];+ server.use(+ getPostV1CreateExecutionScheduleMockHandler(async ({ request }) => {+ requests.push(await request.json());+ return getPostV1CreateExecutionScheduleResponseMock();+ }),+ );const invalidateSpy = vi.spyOn(invalidateSchedules,"invalidateAllScheduleQueries",@@ -62,7 +71,7 @@ describe("useCronSchedulerDialog", () => {act(() => {result.current.setCronExpression("0 9 * * *");- result.current.setScheduleName("Morning run");+ result.current.setScheduleName(" Morning run ");});await act(async () => {@@ -75,10 +84,16 @@ describe("useCronSchedulerDialog", () => {"graph-xyz",);});+ expect(requests).toEqual([+ expect.objectContaining({ name: "Morning run" }),+ ]);invalidateSpy.mockRestore();});test("empty cron expression shows destructive toast and skips the mutation", async () => {+ const createScheduleMock = vi.fn();+ server.use(getPostV1CreateExecutionScheduleMockHandler(createScheduleMock));+const { result } = renderHook(() =>useCronSchedulerDialog({@@ -90,6 +105,10 @@ describe("useCronSchedulerDialog", () => {{ wrapper: makeWrapper("?flowID=g&flowVersion=1") },);+ act(() => {+ result.current.setScheduleName("Test Schedule");+ });+await act(async () => {await result.current.handleCreateSchedule();});@@ -97,8 +116,95 @@ describe("useCronSchedulerDialog", () => {expect(toastMock).toHaveBeenCalledWith(expect.objectContaining({title: "Invalid schedule",+ description: "Please enter a valid cron expression",variant: "destructive",}),);+ expect(createScheduleMock).not.toHaveBeenCalled();+ });++ test.each(["", " ", "\t\n", "\u2003"])(+ "blank schedule name %j is rejected without a mutation",+ async (name) => {+ const createScheduleMock = vi.fn();+ server.use(+ getPostV1CreateExecutionScheduleMockHandler(createScheduleMock),+ );++ const { result } = renderHook(+ () =>+ useCronSchedulerDialog({+ open: true,+ setOpen: vi.fn(),+ inputs: {},+ credentials: {},+ }),+ { wrapper: makeWrapper("?flowID=g&flowVersion=1") },+ );++ act(() => {+ result.current.setCronExpression("0 9 * * *");+ result.current.setScheduleName(name);+ });++ await act(async () => {+ await result.current.handleCreateSchedule();+ });++ expect(toastMock).toHaveBeenCalledWith(+ expect.objectContaining({+ title: "Invalid schedule",+ description: "Please enter a schedule name",+ variant: "destructive",+ }),+ );+ expect(result.current.scheduleNameError).toBe(+ "Schedule name is required",+ );+ expect(createScheduleMock).not.toHaveBeenCalled();+ },+ );+});++test("editing a rejected name clears the inline error", async () => {+ const { result } = renderHook(+ () =>+ useCronSchedulerDialog({+ open: true,+ setOpen: vi.fn(),+ inputs: {},+ credentials: {},+ }),+ { wrapper: makeWrapper("?flowID=g&flowVersion=1") },+ );+ await act(async () => {+ await result.current.handleCreateSchedule();+ });+ expect(result.current.scheduleNameError).toBe("Schedule name is required");+ act(() => {+ result.current.setScheduleName("Weekly report");+ });+ expect(result.current.scheduleNameError).toBe("");+});++test("changing the default cron does not erase a typed schedule name", () => {+ const { result, rerender } = renderHook(+ ({ cron }) =>+ useCronSchedulerDialog({+ open: true,+ setOpen: vi.fn(),+ inputs: {},+ credentials: {},+ defaultCronExpression: cron,+ }),+ {+ initialProps: { cron: "0 9 * * *" },+ wrapper: makeWrapper("?flowID=g&flowVersion=1"),+ },+ );+ act(() => {+ result.current.setScheduleName("Weekly report");});+ rerender({ cron: "0 10 * * *" });+ expect(result.current.scheduleName).toBe("Weekly report");});diff --git a/autogpt_platform/frontend/src/app/(platform)/build/components/BuilderActions/components/CronSchedulerDialog/useCronSchedulerDialog.ts b/autogpt_platform/frontend/src/app/(platform)/build/components/BuilderActions/components/CronSchedulerDialog/useCronSchedulerDialog.tsindex ec4f09437c..9c313153d8 100644--- a/autogpt_platform/frontend/src/app/(platform)/build/components/BuilderActions/components/CronSchedulerDialog/useCronSchedulerDialog.ts+++ b/autogpt_platform/frontend/src/app/(platform)/build/components/BuilderActions/components/CronSchedulerDialog/useCronSchedulerDialog.ts@@ -1,3 +1,4 @@+import type { ScheduleCreationRequest } from "@/app/api/__generated__/models/scheduleCreationRequest";import { usePostV1CreateExecutionSchedule } from "@/app/api/__generated__/endpoints/schedules/schedules";import { useToast } from "@/components/molecules/Toast/use-toast";import { trackScheduleCreatedGoal } from "@/services/analytics/activation-goals";@@ -8,7 +9,7 @@ import { useQueryClient } from "@tanstack/react-query";import { parseAsInteger, parseAsString, useQueryStates } from "nuqs";import { useEffect, useState } from "react";-export const useCronSchedulerDialog = ({+export function useCronSchedulerDialog({open,setOpen,inputs,@@ -17,14 +18,15 @@ export const useCronSchedulerDialog = ({}: {open: boolean;setOpen: (open: boolean) => void;- inputs: Record<string, any>;- credentials: Record<string, any>;+ inputs: ScheduleCreationRequest["inputs"];+ credentials: ScheduleCreationRequest["credentials"];defaultCronExpression?: string;-}) => {+}) {const { toast } = useToast();const queryClient = useQueryClient();const [cronExpression, setCronExpression] = useState<string>("");const [scheduleName, setScheduleName] = useState<string>("");+ const [scheduleNameError, setScheduleNameError] = useState<string>("");const [{ flowID, flowVersion }] = useQueryStates({flowID: parseAsString,@@ -66,7 +68,31 @@ export const useCronSchedulerDialog = ({}}, [open, defaultCronExpression]);- const handleCreateSchedule = async () => {+ useEffect(() => {+ if (open) {+ setScheduleName("");+ setScheduleNameError("");+ }+ }, [open]);++ function handleScheduleNameChange(name: string) {+ setScheduleName(name);+ if (name.trim() !== "") {+ setScheduleNameError("");+ }+ }++ async function handleCreateSchedule() {+ if (!scheduleName || scheduleName.trim() === "") {+ setScheduleNameError("Schedule name is required");+ toast({+ variant: "destructive",+ title: "Invalid schedule",+ description: "Please enter a schedule name",+ });+ return;+ }+if (!cronExpression || cronExpression.trim() === "") {toast({variant: "destructive",@@ -79,15 +105,14 @@ export const useCronSchedulerDialog = ({await createSchedule({graphId: flowID || "",data: {- name: scheduleName,+ name: scheduleName.trim(),graph_version: flowID ? flowVersion : undefined,cron: cronExpression,inputs: inputs,credentials: credentials,},});- setOpen(false);- };+ }return {cronExpression,@@ -95,8 +120,9 @@ export const useCronSchedulerDialog = ({userTimezone,timezoneDisplay,handleCreateSchedule,- setScheduleName,+ setScheduleName: handleScheduleNameChange,scheduleName,+ scheduleNameError,isCreatingSchedule,};-};+}diff --git a/autogpt_platform/frontend/src/app/api/openapi.json b/autogpt_platform/frontend/src/app/api/openapi.jsonindex 039616c059..07e6413c61 100644--- a/autogpt_platform/frontend/src/app/api/openapi.json+++ b/autogpt_platform/frontend/src/app/api/openapi.json@@ -28349,7 +28349,12 @@"anyOf": [{ "type": "integer" }, { "type": "null" }],"title": "Graph Version"},- "name": { "type": "string", "title": "Name" },+ "name": {+ "type": "string",+ "minLength": 1,+ "pattern": "\\S",+ "title": "Name"+ },"cron": { "type": "string", "title": "Cron" },"inputs": {"additionalProperties": true,