Implement persistent background agent execution with scheduling and event‑driven triggers#10502
Implement persistent background agent execution with scheduling and event‑driven triggers#10502Bharani010 wants to merge 6 commits into
Conversation
…and database migration Co-authored-by: Bharani010 <159679943+Bharani010@users.noreply.github.com>
Co-authored-by: Bharani010 <159679943+Bharani010@users.noreply.github.com>
Co-authored-by: Bharani010 <159679943+Bharani010@users.noreply.github.com>
Co-authored-by: Bharani010 <159679943+Bharani010@users.noreply.github.com>
…ckground agent execution with scheduling and event-driven triggers Implement persistent background agent execution with scheduling and event-driven triggers
WalkthroughIntroduces a Background Agents feature enabling autonomous, scheduled Langflow flows with persistent execution tracking. Adds database models, Alembic migration, FastAPI endpoints for CRUD and lifecycle management, APScheduler-based service orchestration, background execution utilities, and comprehensive documentation and tests. Changes
Sequence DiagramsequenceDiagram
participant Client
participant API as API Endpoint
participant Service as BackgroundAgentService
participant Scheduler as APScheduler
participant FlowExec as execute_flow_background
participant DB as Database
rect rgb(220, 240, 250)
Note over Client,DB: Agent Lifecycle: Start
Client->>API: POST /background_agents/{id}/start
API->>Service: start_agent(agent_id)
Service->>DB: Fetch agent config & trigger config
Service->>Service: _create_trigger(trigger_type, config)
Service->>Scheduler: scheduler.add_job(trigger, ...)
Scheduler-->>Service: job_id
Service->>DB: Update agent status=ACTIVE, next_run_at
Service-->>API: {status: "started"}
API-->>Client: 200 OK
end
rect rgb(245, 245, 220)
Note over Scheduler,DB: Scheduled Execution (CRON/INTERVAL)
Scheduler->>Service: _execute_agent(agent_id)
Service->>Service: _execute_agent_job(agent_id, execution_id, trigger_source)
Service->>DB: Create BackgroundAgentExecution record
Service->>FlowExec: execute_flow_background(flow_id, user_id, inputs)
FlowExec->>DB: Load flow definition
FlowExec->>FlowExec: LangflowRunnerExperimental.execute()
FlowExec-->>Service: {status, session_id, result}
Service->>DB: Update execution (completed_at, result, status)
Service->>DB: Update agent (last_run_at, next_run_at)
end
rect rgb(240, 220, 250)
Note over Client,DB: Manual Trigger
Client->>API: POST /background_agents/{id}/trigger
API->>Service: trigger_agent(agent_id, trigger_source="manual")
Service->>DB: Create execution record
Service->>Service: _execute_agent_job(async)
Service->>FlowExec: execute_flow_background(...)
FlowExec-->>Service: result
Service->>DB: Persist execution result
Service-->>API: {execution_id, status}
API-->>Client: 200 OK
end
Estimated code review effort🎯 4 (Complex) | ⏱️ ~50 minutes
Areas requiring extra attention:
Possibly related PRs
Suggested labels
Suggested reviewers
Pre-merge checks and finishing touchesImportant Pre-merge checks failedPlease resolve all errors before merging. Addressing warnings is optional. ❌ Failed checks (1 error, 1 warning, 1 inconclusive)
✅ Passed checks (3 passed)
✨ Finishing touches
🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 10
🧹 Nitpick comments (1)
src/backend/base/langflow/services/database/models/background_agent/__init__.py (1)
1-23: Consider alphabetical ordering for consistency.The exports group related classes together (Agent models, then Execution models, then enums), which aids readability. However, the coding guidelines suggest alphabetical ordering for imports. Within the current grouping,
AgentStatusshould precedeTriggerTypealphabetically.Apply this diff if strict alphabetical ordering is preferred:
from langflow.services.database.models.background_agent.model import ( + AgentStatus, BackgroundAgent, BackgroundAgentCreate, - BackgroundAgentRead, - BackgroundAgentUpdate, BackgroundAgentExecution, BackgroundAgentExecutionCreate, BackgroundAgentExecutionRead, + BackgroundAgentRead, + BackgroundAgentUpdate, TriggerType, - AgentStatus, ) __all__ = [ + "AgentStatus", "BackgroundAgent", "BackgroundAgentCreate", - "BackgroundAgentRead", - "BackgroundAgentUpdate", "BackgroundAgentExecution", "BackgroundAgentExecutionCreate", "BackgroundAgentExecutionRead", + "BackgroundAgentRead", + "BackgroundAgentUpdate", "TriggerType", - "AgentStatus", ]Based on learnings.
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (20)
docs/docs/API-Reference/api-background-agents.mdx(1 hunks)docs/docs/Agents/background-agents.mdx(1 hunks)pyproject.toml(1 hunks)src/backend/base/langflow/alembic/versions/add_background_agent_tables.py(1 hunks)src/backend/base/langflow/api/router.py(2 hunks)src/backend/base/langflow/api/v1/__init__.py(2 hunks)src/backend/base/langflow/api/v1/background_agents.py(1 hunks)src/backend/base/langflow/services/background_agent/__init__.py(1 hunks)src/backend/base/langflow/services/background_agent/factory.py(1 hunks)src/backend/base/langflow/services/background_agent/service.py(1 hunks)src/backend/base/langflow/services/background_agent/utils.py(1 hunks)src/backend/base/langflow/services/database/models/__init__.py(2 hunks)src/backend/base/langflow/services/database/models/background_agent/__init__.py(1 hunks)src/backend/base/langflow/services/database/models/background_agent/model.py(1 hunks)src/backend/base/langflow/services/deps.py(2 hunks)src/backend/base/langflow/services/schema.py(1 hunks)src/backend/tests/conftest.py(1 hunks)src/backend/tests/unit/api/v1/test_background_agents.py(1 hunks)src/backend/tests/unit/services/background_agent/__init__.py(1 hunks)src/backend/tests/unit/services/background_agent/test_service.py(1 hunks)
🧰 Additional context used
📓 Path-based instructions (6)
{src/backend/**/*.py,tests/**/*.py,Makefile}
📄 CodeRabbit inference engine (.cursor/rules/backend_development.mdc)
{src/backend/**/*.py,tests/**/*.py,Makefile}: Run make format_backend to format Python code before linting or committing changes
Run make lint to perform linting checks on backend Python code
Files:
src/backend/base/langflow/services/database/models/__init__.pysrc/backend/base/langflow/alembic/versions/add_background_agent_tables.pysrc/backend/base/langflow/services/background_agent/utils.pysrc/backend/tests/conftest.pysrc/backend/tests/unit/services/background_agent/test_service.pysrc/backend/base/langflow/services/background_agent/__init__.pysrc/backend/base/langflow/services/deps.pysrc/backend/tests/unit/services/background_agent/__init__.pysrc/backend/base/langflow/services/database/models/background_agent/__init__.pysrc/backend/base/langflow/services/schema.pysrc/backend/base/langflow/services/background_agent/service.pysrc/backend/base/langflow/api/v1/__init__.pysrc/backend/base/langflow/services/database/models/background_agent/model.pysrc/backend/base/langflow/api/router.pysrc/backend/tests/unit/api/v1/test_background_agents.pysrc/backend/base/langflow/services/background_agent/factory.pysrc/backend/base/langflow/api/v1/background_agents.py
src/backend/base/langflow/services/database/models/**/*.py
📄 CodeRabbit inference engine (.cursor/rules/backend_development.mdc)
Place database models in src/backend/base/langflow/services/database/models/
Files:
src/backend/base/langflow/services/database/models/__init__.pysrc/backend/base/langflow/services/database/models/background_agent/__init__.pysrc/backend/base/langflow/services/database/models/background_agent/model.py
docs/**/*.{md,mdx}
📄 CodeRabbit inference engine (.cursor/rules/docs_development.mdc)
docs/**/*.{md,mdx}: All Markdown/MDX pages must start with front matter including at least title and description; include sidebar_position for docs pages when applicable
Code blocks must specify a language and may include a title (```lang title="…")
Use sentence case for headings and keep paragraphs short and scannable
Write in second person, present tense, with a professional but approachable tone
Use inline code with backticks for code terms; use bold for UI elements and italics for emphasis; keep lists in parallel structure
Ensure internal links are functional and navigation works (update cross-references as needed)
Verify all code examples in docs and blog actually run as shown
Use correct terminology capitalization: Langflow, Component, Flow, API, JSON
Reference images with absolute paths under /img/... and provide descriptive alt text
Files:
docs/docs/Agents/background-agents.mdxdocs/docs/API-Reference/api-background-agents.mdx
docs/docs/**/*.{md,mdx}
📄 CodeRabbit inference engine (.cursor/rules/docs_development.mdc)
Use Docusaurus admonitions (:::+tip|warning|danger) instead of custom callouts in docs pages
Files:
docs/docs/Agents/background-agents.mdxdocs/docs/API-Reference/api-background-agents.mdx
src/backend/tests/**/*.py
📄 CodeRabbit inference engine (.cursor/rules/testing.mdc)
src/backend/tests/**/*.py: Unit tests for backend code must be located in the 'src/backend/tests/' directory, with component tests organized by component subdirectory under 'src/backend/tests/unit/components/'.
Test files should use the same filename as the component under test, with an appropriate test prefix or suffix (e.g., 'my_component.py' → 'test_my_component.py').
Use the 'client' fixture (an async httpx.AsyncClient) for API tests in backend Python tests, as defined in 'src/backend/tests/conftest.py'.
When writing component tests, inherit from the appropriate base class in 'src/backend/tests/base.py' (ComponentTestBase, ComponentTestBaseWithClient, or ComponentTestBaseWithoutClient) and provide the required fixtures: 'component_class', 'default_kwargs', and 'file_names_mapping'.
Each test in backend Python test files should have a clear docstring explaining its purpose, and complex setups or mocks should be well-commented.
Test both sync and async code paths in backend Python tests, using '@pytest.mark.asyncio' for async tests.
Mock external dependencies appropriately in backend Python tests to isolate unit tests from external services.
Test error handling and edge cases in backend Python tests, including using 'pytest.raises' and asserting error messages.
Validate input/output behavior and test component initialization and configuration in backend Python tests.
Use the 'no_blockbuster' pytest marker to skip the blockbuster plugin in tests when necessary.
Be aware of ContextVar propagation in async tests; test both direct event loop execution and 'asyncio.to_thread' scenarios to ensure proper context isolation.
Test error handling by mocking internal functions using monkeypatch in backend Python tests.
Test resource cleanup in backend Python tests by using fixtures that ensure proper initialization and cleanup of resources.
Test timeout and performance constraints in backend Python tests using 'asyncio.wait_for' and timing assertions.
Test Langflow's Messag...
Files:
src/backend/tests/conftest.pysrc/backend/tests/unit/services/background_agent/test_service.pysrc/backend/tests/unit/services/background_agent/__init__.pysrc/backend/tests/unit/api/v1/test_background_agents.py
src/backend/tests/unit/**/*.py
📄 CodeRabbit inference engine (.cursor/rules/backend_development.mdc)
Test component integration within flows using create_flow, build_flow, and get_build_events utilities
Files:
src/backend/tests/unit/services/background_agent/test_service.pysrc/backend/tests/unit/services/background_agent/__init__.pysrc/backend/tests/unit/api/v1/test_background_agents.py
🧠 Learnings (23)
📓 Common learnings
Learnt from: CR
Repo: langflow-ai/langflow PR: 0
File: .cursor/rules/backend_development.mdc:0-0
Timestamp: 2025-07-18T18:25:54.486Z
Learning: Applies to src/backend/base/langflow/components/**/*.py : Use asyncio.create_task for background work in async components and ensure proper cleanup on cancellation
📚 Learning: 2025-07-18T18:25:54.486Z
Learnt from: CR
Repo: langflow-ai/langflow PR: 0
File: .cursor/rules/backend_development.mdc:0-0
Timestamp: 2025-07-18T18:25:54.486Z
Learning: Applies to src/backend/base/langflow/services/database/models/**/*.py : Place database models in src/backend/base/langflow/services/database/models/
Applied to files:
src/backend/base/langflow/services/database/models/__init__.pysrc/backend/base/langflow/services/database/models/background_agent/__init__.pysrc/backend/base/langflow/services/database/models/background_agent/model.py
📚 Learning: 2025-07-18T18:25:54.486Z
Learnt from: CR
Repo: langflow-ai/langflow PR: 0
File: .cursor/rules/backend_development.mdc:0-0
Timestamp: 2025-07-18T18:25:54.486Z
Learning: Applies to src/backend/base/langflow/components/**/__init__.py : Update __init__.py with alphabetical imports when adding new components
Applied to files:
src/backend/base/langflow/services/database/models/__init__.pysrc/backend/base/langflow/services/database/models/background_agent/__init__.pysrc/backend/base/langflow/api/v1/__init__.py
📚 Learning: 2025-07-18T18:25:54.486Z
Learnt from: CR
Repo: langflow-ai/langflow PR: 0
File: .cursor/rules/backend_development.mdc:0-0
Timestamp: 2025-07-18T18:25:54.486Z
Learning: Applies to src/backend/base/langflow/components/**/*.py : Use asyncio.create_task for background work in async components and ensure proper cleanup on cancellation
Applied to files:
src/backend/base/langflow/services/background_agent/utils.py
📚 Learning: 2025-07-21T14:16:14.125Z
Learnt from: CR
Repo: langflow-ai/langflow PR: 0
File: .cursor/rules/testing.mdc:0-0
Timestamp: 2025-07-21T14:16:14.125Z
Learning: Applies to src/backend/tests/**/*.py : Test Langflow's REST API endpoints in backend Python tests using the async client fixture and asserting response codes and payloads.
Applied to files:
src/backend/base/langflow/services/background_agent/utils.pysrc/backend/tests/conftest.pysrc/backend/tests/unit/services/background_agent/test_service.pysrc/backend/tests/unit/api/v1/test_background_agents.py
📚 Learning: 2025-07-21T14:16:14.125Z
Learnt from: CR
Repo: langflow-ai/langflow PR: 0
File: .cursor/rules/testing.mdc:0-0
Timestamp: 2025-07-21T14:16:14.125Z
Learning: Applies to src/backend/tests/**/*.py : Use the 'client' fixture (an async httpx.AsyncClient) for API tests in backend Python tests, as defined in 'src/backend/tests/conftest.py'.
Applied to files:
src/backend/tests/conftest.pysrc/backend/tests/unit/services/background_agent/test_service.py
📚 Learning: 2025-07-21T14:16:14.125Z
Learnt from: CR
Repo: langflow-ai/langflow PR: 0
File: .cursor/rules/testing.mdc:0-0
Timestamp: 2025-07-21T14:16:14.125Z
Learning: Applies to src/backend/tests/**/*.py : Test flows using predefined JSON data and utility functions such as 'create_flow', 'build_flow', 'get_build_events', and 'consume_and_assert_stream' in backend Python tests.
Applied to files:
src/backend/tests/conftest.pysrc/backend/tests/unit/api/v1/test_background_agents.py
📚 Learning: 2025-07-18T18:25:54.487Z
Learnt from: CR
Repo: langflow-ai/langflow PR: 0
File: .cursor/rules/backend_development.mdc:0-0
Timestamp: 2025-07-18T18:25:54.487Z
Learning: Applies to src/backend/tests/unit/**/*.py : Test component integration within flows using create_flow, build_flow, and get_build_events utilities
Applied to files:
src/backend/tests/conftest.pysrc/backend/tests/unit/services/background_agent/test_service.pysrc/backend/tests/unit/api/v1/test_background_agents.py
📚 Learning: 2025-07-18T18:25:54.486Z
Learnt from: CR
Repo: langflow-ai/langflow PR: 0
File: .cursor/rules/backend_development.mdc:0-0
Timestamp: 2025-07-18T18:25:54.486Z
Learning: Applies to tests/**/*.py : Use the client fixture from conftest.py for API endpoint tests
Applied to files:
src/backend/tests/conftest.py
📚 Learning: 2025-07-21T14:16:14.125Z
Learnt from: CR
Repo: langflow-ai/langflow PR: 0
File: .cursor/rules/testing.mdc:0-0
Timestamp: 2025-07-21T14:16:14.125Z
Learning: Applies to conftest.py : Use 'conftest.py' to define and share fixtures for backend Python tests.
Applied to files:
src/backend/tests/conftest.py
📚 Learning: 2025-07-21T14:16:14.125Z
Learnt from: CR
Repo: langflow-ai/langflow PR: 0
File: .cursor/rules/testing.mdc:0-0
Timestamp: 2025-07-21T14:16:14.125Z
Learning: Applies to src/backend/tests/**/*.py : Test resource cleanup in backend Python tests by using fixtures that ensure proper initialization and cleanup of resources.
Applied to files:
src/backend/tests/conftest.pysrc/backend/tests/unit/services/background_agent/test_service.py
📚 Learning: 2025-07-21T14:16:14.125Z
Learnt from: CR
Repo: langflow-ai/langflow PR: 0
File: .cursor/rules/testing.mdc:0-0
Timestamp: 2025-07-21T14:16:14.125Z
Learning: Applies to src/backend/tests/**/*.py : Test Langflow's Message objects and chat functionality in backend Python tests by asserting correct instantiation and property values.
Applied to files:
src/backend/tests/conftest.py
📚 Learning: 2025-07-21T14:16:14.125Z
Learnt from: CR
Repo: langflow-ai/langflow PR: 0
File: .cursor/rules/testing.mdc:0-0
Timestamp: 2025-07-21T14:16:14.125Z
Learning: Applies to src/backend/tests/**/*.py : Mock external dependencies appropriately in backend Python tests to isolate unit tests from external services.
Applied to files:
src/backend/tests/unit/services/background_agent/test_service.pysrc/backend/tests/unit/services/background_agent/__init__.pysrc/backend/tests/unit/api/v1/test_background_agents.py
📚 Learning: 2025-07-18T18:25:54.486Z
Learnt from: CR
Repo: langflow-ai/langflow PR: 0
File: .cursor/rules/backend_development.mdc:0-0
Timestamp: 2025-07-18T18:25:54.486Z
Learning: Applies to src/backend/tests/unit/components/**/*.py : Create comprehensive unit tests for all new components
Applied to files:
src/backend/tests/unit/services/background_agent/test_service.pysrc/backend/tests/unit/api/v1/test_background_agents.py
📚 Learning: 2025-07-21T14:16:14.125Z
Learnt from: CR
Repo: langflow-ai/langflow PR: 0
File: .cursor/rules/testing.mdc:0-0
Timestamp: 2025-07-21T14:16:14.125Z
Learning: Applies to src/backend/tests/**/*.py : Test both sync and async code paths in backend Python tests, using 'pytest.mark.asyncio' for async tests.
Applied to files:
src/backend/tests/unit/services/background_agent/test_service.py
📚 Learning: 2025-07-21T14:16:14.125Z
Learnt from: CR
Repo: langflow-ai/langflow PR: 0
File: .cursor/rules/testing.mdc:0-0
Timestamp: 2025-07-21T14:16:14.125Z
Learning: Applies to src/backend/tests/**/*.py : Validate input/output behavior and test component initialization and configuration in backend Python tests.
Applied to files:
src/backend/tests/unit/services/background_agent/test_service.pysrc/backend/tests/unit/services/background_agent/__init__.pysrc/backend/tests/unit/api/v1/test_background_agents.py
📚 Learning: 2025-07-21T14:16:14.125Z
Learnt from: CR
Repo: langflow-ai/langflow PR: 0
File: .cursor/rules/testing.mdc:0-0
Timestamp: 2025-07-21T14:16:14.125Z
Learning: Applies to src/backend/tests/**/*.py : Test timeout and performance constraints in backend Python tests using 'asyncio.wait_for' and timing assertions.
Applied to files:
src/backend/tests/unit/services/background_agent/test_service.py
📚 Learning: 2025-07-21T14:16:14.125Z
Learnt from: CR
Repo: langflow-ai/langflow PR: 0
File: .cursor/rules/testing.mdc:0-0
Timestamp: 2025-07-21T14:16:14.125Z
Learning: Applies to src/backend/tests/**/*.py : Each test in backend Python test files should have a clear docstring explaining its purpose, and complex setups or mocks should be well-commented.
Applied to files:
src/backend/tests/unit/services/background_agent/__init__.py
📚 Learning: 2025-07-21T14:16:14.125Z
Learnt from: CR
Repo: langflow-ai/langflow PR: 0
File: .cursor/rules/testing.mdc:0-0
Timestamp: 2025-07-21T14:16:14.125Z
Learning: Applies to src/backend/tests/**/*.py : Unit tests for backend code must be located in the 'src/backend/tests/' directory, with component tests organized by component subdirectory under 'src/backend/tests/unit/components/'.
Applied to files:
src/backend/tests/unit/services/background_agent/__init__.py
📚 Learning: 2025-07-18T18:25:54.486Z
Learnt from: CR
Repo: langflow-ai/langflow PR: 0
File: .cursor/rules/backend_development.mdc:0-0
Timestamp: 2025-07-18T18:25:54.486Z
Learning: Database tests may fail in batch runs; run individually if needed
Applied to files:
src/backend/tests/unit/services/background_agent/__init__.py
📚 Learning: 2025-07-21T14:16:14.125Z
Learnt from: CR
Repo: langflow-ai/langflow PR: 0
File: .cursor/rules/testing.mdc:0-0
Timestamp: 2025-07-21T14:16:14.125Z
Learning: Applies to src/backend/tests/**/*.py : Test webhook endpoints in backend Python tests by posting payloads and asserting correct processing and response codes.
Applied to files:
src/backend/tests/unit/api/v1/test_background_agents.py
📚 Learning: 2025-07-21T14:16:14.125Z
Learnt from: CR
Repo: langflow-ai/langflow PR: 0
File: .cursor/rules/testing.mdc:0-0
Timestamp: 2025-07-21T14:16:14.125Z
Learning: Applies to src/backend/tests/**/*.py : Test components that require external APIs using appropriate pytest markers (e.g., 'api_key_required', 'no_blockbuster') and environment variables for API keys.
Applied to files:
src/backend/tests/unit/api/v1/test_background_agents.py
📚 Learning: 2025-07-18T18:25:54.486Z
Learnt from: CR
Repo: langflow-ai/langflow PR: 0
File: .cursor/rules/backend_development.mdc:0-0
Timestamp: 2025-07-18T18:25:54.486Z
Learning: Applies to tests/**/*.py : Test authenticated API endpoints using logged_in_headers
Applied to files:
src/backend/tests/unit/api/v1/test_background_agents.py
🧬 Code graph analysis (12)
src/backend/base/langflow/services/database/models/__init__.py (1)
src/backend/base/langflow/services/database/models/background_agent/model.py (7)
BackgroundAgent(111-118)BackgroundAgentCreate(121-130)BackgroundAgentRead(133-137)BackgroundAgentUpdate(140-149)BackgroundAgentExecution(194-198)BackgroundAgentExecutionCreate(201-205)BackgroundAgentExecutionRead(208-211)
src/backend/base/langflow/services/background_agent/utils.py (3)
src/backend/base/langflow/services/database/models/flow/model.py (1)
Flow(186-212)src/backend/base/langflow/services/deps.py (1)
session_scope(163-185)src/backend/base/langflow/services/flow/flow_runner.py (1)
LangflowRunnerExperimental(23-265)
src/backend/tests/conftest.py (1)
src/backend/tests/unit/services/background_agent/test_service.py (1)
test_flow(38-50)
src/backend/tests/unit/services/background_agent/test_service.py (3)
src/backend/base/langflow/services/background_agent/service.py (6)
start_agent(117-155)stop_agent(157-193)pause_agent(195-226)resume_agent(228-259)trigger_agent(261-295)_create_trigger(345-385)src/backend/base/langflow/services/database/models/background_agent/model.py (4)
AgentStatus(28-34)BackgroundAgent(111-118)BackgroundAgentExecution(194-198)TriggerType(18-25)src/backend/base/langflow/services/deps.py (2)
get_settings_service(123-136)session_scope(163-185)
src/backend/base/langflow/services/background_agent/__init__.py (1)
src/backend/base/langflow/services/background_agent/service.py (1)
BackgroundAgentService(31-549)
src/backend/base/langflow/services/deps.py (3)
src/backend/base/langflow/services/background_agent/service.py (1)
BackgroundAgentService(31-549)src/backend/base/langflow/services/background_agent/factory.py (1)
BackgroundAgentServiceFactory(7-22)src/backend/base/langflow/services/schema.py (1)
ServiceType(4-23)
src/backend/base/langflow/services/database/models/background_agent/__init__.py (1)
src/backend/base/langflow/services/database/models/background_agent/model.py (9)
BackgroundAgent(111-118)BackgroundAgentCreate(121-130)BackgroundAgentRead(133-137)BackgroundAgentUpdate(140-149)BackgroundAgentExecution(194-198)BackgroundAgentExecutionCreate(201-205)BackgroundAgentExecutionRead(208-211)TriggerType(18-25)AgentStatus(28-34)
src/backend/base/langflow/services/background_agent/service.py (4)
src/backend/base/langflow/services/background_agent/utils.py (1)
execute_flow_background(13-83)src/backend/base/langflow/services/database/models/background_agent/model.py (4)
AgentStatus(28-34)BackgroundAgent(111-118)BackgroundAgentExecution(194-198)TriggerType(18-25)src/backend/base/langflow/services/deps.py (1)
session_scope(163-185)src/backend/base/langflow/api/v1/background_agents.py (2)
get_agent_status(465-507)get_agent_executions(511-557)
src/backend/base/langflow/services/database/models/background_agent/model.py (1)
src/backend/base/langflow/services/database/models/flow/model.py (1)
Flow(186-212)
src/backend/tests/unit/api/v1/test_background_agents.py (2)
src/backend/tests/conftest.py (2)
logged_in_headers(507-513)test_flow(812-834)src/backend/tests/unit/services/background_agent/test_service.py (3)
test_flow(38-50)test_get_agent_status(161-169)test_get_agent_executions(173-192)
src/backend/base/langflow/services/background_agent/factory.py (2)
src/backend/tests/unit/services/variable/test_service.py (1)
service(17-19)src/backend/base/langflow/services/background_agent/service.py (1)
BackgroundAgentService(31-549)
src/backend/base/langflow/api/v1/background_agents.py (4)
src/backend/base/langflow/services/database/models/background_agent/model.py (5)
AgentStatus(28-34)BackgroundAgent(111-118)BackgroundAgentCreate(121-130)BackgroundAgentRead(133-137)BackgroundAgentUpdate(140-149)src/backend/base/langflow/services/database/models/flow/model.py (1)
Flow(186-212)src/backend/base/langflow/services/deps.py (1)
get_background_agent_service(258-266)src/backend/base/langflow/services/background_agent/service.py (7)
stop_agent(157-193)start_agent(117-155)pause_agent(195-226)resume_agent(228-259)trigger_agent(261-295)get_agent_status(483-513)get_agent_executions(515-549)
🪛 GitHub Actions: Ruff Style Check
src/backend/base/langflow/api/v1/background_agents.py
[error] 10-10: Ruff check failed. Command: uv run --only-dev ruff check --output-format=github . | F401 'sqlmodel.ext.asyncio.session.AsyncSession' imported but unused in src/backend/base/langflow/api/v1/background_agents.py.
🪛 GitHub Check: Ruff Style Check (3.13)
src/backend/base/langflow/api/v1/background_agents.py
[failure] 318-318: Ruff (RET504)
src/backend/base/langflow/api/v1/background_agents.py:318:16: RET504 Unnecessary assignment to result before return statement
[failure] 318-318: Ruff (TRY300)
src/backend/base/langflow/api/v1/background_agents.py:318:9: TRY300 Consider moving this statement to an else block
[failure] 276-276: Ruff (RUF010)
src/backend/base/langflow/api/v1/background_agents.py:276:46: RUF010 Use explicit conversion flag
[failure] 273-273: Ruff (RUF100)
src/backend/base/langflow/api/v1/background_agents.py:273:29: RUF100 Unused noqa directive (unused: BLE001)
[failure] 272-272: Ruff (RET504)
src/backend/base/langflow/api/v1/background_agents.py:272:16: RET504 Unnecessary assignment to result before return statement
[failure] 272-272: Ruff (TRY300)
src/backend/base/langflow/api/v1/background_agents.py:272:9: TRY300 Consider moving this statement to an else block
[failure] 227-227: Ruff (RUF100)
src/backend/base/langflow/api/v1/background_agents.py:227:19: RUF100 Unused noqa directive (unused: S110)
[failure] 227-227: Ruff (PIE790)
src/backend/base/langflow/api/v1/background_agents.py:227:13: PIE790 Unnecessary pass statement
[failure] 225-225: Ruff (W293)
src/backend/base/langflow/api/v1/background_agents.py:225:1: W293 Blank line contains whitespace
[failure] 10-10: Ruff (F401)
src/backend/base/langflow/api/v1/background_agents.py:10:42: F401 sqlmodel.ext.asyncio.session.AsyncSession imported but unused
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (15)
- GitHub Check: Test Docker Images / Test docker images
- GitHub Check: Run Backend Tests / Unit Tests - Python 3.10 - Group 4
- GitHub Check: Run Backend Tests / Unit Tests - Python 3.10 - Group 5
- GitHub Check: Run Backend Tests / Unit Tests - Python 3.10 - Group 3
- GitHub Check: Run Backend Tests / Unit Tests - Python 3.10 - Group 1
- GitHub Check: Run Backend Tests / Unit Tests - Python 3.10 - Group 2
- GitHub Check: Run Backend Tests / Integration Tests - Python 3.10
- GitHub Check: Test Docs Build / Test Docs Build
- GitHub Check: Run Backend Tests / LFX Tests - Python 3.10
- GitHub Check: Lint Backend / Run Mypy (3.10)
- GitHub Check: Lint Backend / Run Mypy (3.13)
- GitHub Check: Run Frontend Tests / Determine Test Suites and Shard Distribution
- GitHub Check: Test Starter Templates
- GitHub Check: Optimize new Python code in this PR
- GitHub Check: Update Component Index
🔇 Additional comments (9)
pyproject.toml (1)
140-140: LGTM! APScheduler dependency added correctly.The version constraint
>=3.10.4,<4.0.0appropriately pins to the stable 3.x branch while avoiding breaking changes in the upcoming 4.x series.src/backend/tests/unit/services/background_agent/__init__.py (1)
1-1: LGTM! Standard test package marker.The comment clearly identifies the package purpose.
src/backend/base/langflow/services/background_agent/__init__.py (1)
1-3: LGTM! Clean package interface.The module correctly exports
BackgroundAgentServiceas the public API surface for this package.src/backend/base/langflow/api/router.py (2)
6-6: LGTM! Router import added correctly.The import follows the alphabetical ordering convention used in this file.
56-56: LGTM! Router registration added correctly.The background agents router is properly registered with the v1 API router, consistent with the pattern used for other routers.
src/backend/base/langflow/services/schema.py (1)
8-8: LGTM! Service type enum member added correctly.The new enum member follows the established naming convention and maintains alphabetical ordering within the
ServiceTypeenum.src/backend/base/langflow/services/deps.py (1)
16-16: LGTM! Type import added correctly.The
BackgroundAgentServicetype import in theTYPE_CHECKINGblock enables proper type hints without runtime import overhead, consistent with the pattern used for other services in this file.src/backend/base/langflow/api/v1/__init__.py (2)
2-2: LGTM! Router import follows alphabetical ordering.The import is correctly positioned in alphabetical order among the other router imports.
24-24: LGTM! Export added to__all__in alphabetical order.The
background_agents_routerexport is correctly positioned in the__all__list, maintaining alphabetical ordering.
| --- | ||
| title: Background Agents | ||
| sidebar_position: 6 | ||
| --- |
There was a problem hiding this comment.
Add required description to front matter.
Docs guidelines require every page to declare a description in the front matter. Add a concise summary so the page builds correctly and produces proper metadata.
Apply this diff:
---
-title: Background Agents
-sidebar_position: 6
+title: Background Agents
+description: Learn how to schedule, trigger, and monitor Langflow Background Agents for autonomous flows.
+sidebar_position: 6
---📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| --- | |
| title: Background Agents | |
| sidebar_position: 6 | |
| --- | |
| --- | |
| title: Background Agents | |
| description: Learn how to schedule, trigger, and monitor Langflow Background Agents for autonomous flows. | |
| sidebar_position: 6 | |
| --- |
🤖 Prompt for AI Agents
In docs/docs/Agents/background-agents.mdx lines 1-4, the front matter is missing
a required description field; add a concise description key to the YAML front
matter (e.g., description: "Short summary of the page") so the page builds with
proper metadata — insert a one-line description under the title and before the
closing front-matter delimiter, keeping it brief and relevant to background
agents.
| { | ||
| "name": "Daily Sales Report", | ||
| "trigger_type": "CRON", | ||
| "trigger_config": { | ||
| "minute": "0", | ||
| "hour": "8", | ||
| "day": "*", | ||
| "month": "*", | ||
| "day_of_week": "1-5" // Weekdays only | ||
| }, | ||
| "input_config": { | ||
| "input_value": "Generate sales report for yesterday" | ||
| } | ||
| } |
There was a problem hiding this comment.
Keep JSON examples valid.
The // Weekdays only inline comments make these samples invalid JSON, violating the requirement that examples run as shown. Please remove the comments (and update the similar blocks below) or move the note into surrounding prose.
Apply this diff:
"trigger_config": {
"minute": "0",
"hour": "8",
"day": "*",
"month": "*",
- "day_of_week": "1-5" // Weekdays only
+ "day_of_week": "1-5"
},🤖 Prompt for AI Agents
In docs/docs/Agents/background-agents.mdx around lines 132 to 145, the JSON
example contains an inline comment ("// Weekdays only") which makes the snippet
invalid; remove the inline comment from the JSON block and instead add a short
sentence in the surrounding prose explaining that day_of_week "1-5" means
weekdays only, and scan/update any other JSON blocks in this file that include
inline comments the same way so all JSON examples remain valid.
| <Admonition type="warning" title="Resource Considerations"> | ||
| Very frequent executions (every minute or less) can impact system performance. Use appropriately based on your infrastructure. | ||
| </Admonition> |
There was a problem hiding this comment.
Use Docusaurus admonitions instead of <Admonition>.
Per the docs style guide, replace the theme component with the :::warning (or similar) syntax and remove the corresponding import.
Apply this diff:
-import Admonition from '@theme/Admonition';
...
-<Admonition type="warning" title="Resource Considerations">
-Very frequent executions (every minute or less) can impact system performance. Use appropriately based on your infrastructure.
-</Admonition>
+:::warning Resource considerations
+Very frequent executions (every minute or less) can impact system performance. Use them sparingly and scale infrastructure accordingly.
+:::Committable suggestion skipped: line range outside the PR's diff.
🤖 Prompt for AI Agents
In docs/docs/Agents/background-agents.mdx around lines 406 to 408, replace the
React theme Admonition component usage with Docusaurus markdown admonition
syntax; change the <Admonition type="warning" title="Resource Considerations">
... </Admonition> block to a :::warning block with the same content and close
with :::, and remove any import of Admonition at the top of the file if present.
| --- | ||
| title: Background Agents API | ||
| sidebar_position: 8 | ||
| --- |
There was a problem hiding this comment.
Add required description to front matter
Please include a description field in the front matter. Our docs guidelines require each Markdown page to start with at least title and description, so leaving it out breaks compliance and downstream tooling. As per coding guidelines
🤖 Prompt for AI Agents
In docs/docs/API-Reference/api-background-agents.mdx lines 1 to 4, the front
matter only contains title and sidebar_position; add a description field to
comply with docs guidelines. Edit the YAML front matter to include a short
descriptive sentence under a "description:" key (e.g., one-line summary of the
page) immediately after the title, ensuring proper YAML format and quoting if
necessary.
|
|
||
| from fastapi import APIRouter, Depends, HTTPException, status | ||
| from sqlmodel import select | ||
| from sqlmodel.ext.asyncio.session import AsyncSession |
There was a problem hiding this comment.
Remove unused AsyncSession import to unblock Ruff.
AsyncSession isn’t referenced anywhere in this module, and Ruff is failing the pipeline on F401. Please drop the import so the style check passes.
-from sqlmodel.ext.asyncio.session import AsyncSession📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| from sqlmodel.ext.asyncio.session import AsyncSession |
🧰 Tools
🪛 GitHub Actions: Ruff Style Check
[error] 10-10: Ruff check failed. Command: uv run --only-dev ruff check --output-format=github . | F401 'sqlmodel.ext.asyncio.session.AsyncSession' imported but unused in src/backend/base/langflow/api/v1/background_agents.py.
🪛 GitHub Check: Ruff Style Check (3.13)
[failure] 10-10: Ruff (F401)
src/backend/base/langflow/api/v1/background_agents.py:10:42: F401 sqlmodel.ext.asyncio.session.AsyncSession imported but unused
🤖 Prompt for AI Agents
In src/backend/base/langflow/api/v1/background_agents.py around line 10, the
module imports AsyncSession from sqlmodel.ext.asyncio.session but never uses it,
causing a Ruff F401 unused-import error; remove the AsyncSession import line
from this file so the unused import is gone and the style check will pass.
| try: | ||
| await background_agent_service.stop_agent(agent_id) | ||
| except Exception as e: # noqa: BLE001 | ||
| # Log but continue with deletion even if stop fails | ||
| from lfx.log.logger import logger | ||
|
|
||
| await logger.awarning(f"Failed to stop agent {agent_id} during deletion: {e}") | ||
| pass # noqa: S110 |
There was a problem hiding this comment.
Drop the no-op pass/noqa after logging.
The pass # noqa: S110 line is unnecessary, and Ruff flags both the stray whitespace and the unused noqa. Removing it keeps the intent (log and continue) without tripping lint.
- except Exception as e: # noqa: BLE001
- # Log but continue with deletion even if stop fails
- from lfx.log.logger import logger
-
- await logger.awarning(f"Failed to stop agent {agent_id} during deletion: {e}")
- pass # noqa: S110
+ except Exception as e: # noqa: BLE001
+ # Log but continue with deletion even if stop fails
+ from lfx.log.logger import logger
+
+ await logger.awarning(f"Failed to stop agent {agent_id} during deletion: {e!s}")📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| try: | |
| await background_agent_service.stop_agent(agent_id) | |
| except Exception as e: # noqa: BLE001 | |
| # Log but continue with deletion even if stop fails | |
| from lfx.log.logger import logger | |
| await logger.awarning(f"Failed to stop agent {agent_id} during deletion: {e}") | |
| pass # noqa: S110 | |
| try: | |
| await background_agent_service.stop_agent(agent_id) | |
| except Exception as e: # noqa: BLE001 | |
| # Log but continue with deletion even if stop fails | |
| from lfx.log.logger import logger | |
| await logger.awarning(f"Failed to stop agent {agent_id} during deletion: {e!s}") |
🧰 Tools
🪛 GitHub Check: Ruff Style Check (3.13)
[failure] 227-227: Ruff (RUF100)
src/backend/base/langflow/api/v1/background_agents.py:227:19: RUF100 Unused noqa directive (unused: S110)
[failure] 227-227: Ruff (PIE790)
src/backend/base/langflow/api/v1/background_agents.py:227:13: PIE790 Unnecessary pass statement
[failure] 225-225: Ruff (W293)
src/backend/base/langflow/api/v1/background_agents.py:225:1: W293 Blank line contains whitespace
🤖 Prompt for AI Agents
In src/backend/base/langflow/api/v1/background_agents.py around lines 220 to
227, remove the unnecessary trailing "pass # noqa: S110" after the exception
logger; keep the try/except as-is that logs the error and continues, and also
remove the unused noqa comment so Ruff no longer flags stray whitespace or
unused pragmas.
| try: | ||
| result = await background_agent_service.start_agent(agent_id) | ||
| return result | ||
| except Exception as e: # noqa: BLE001 | ||
| raise HTTPException( | ||
| status_code=status.HTTP_500_INTERNAL_SERVER_ERROR, | ||
| detail=f"Failed to start agent: {str(e)}", | ||
| ) from e |
There was a problem hiding this comment.
Simplify the start-agent error handler to satisfy Ruff.
Ruff raises RET504/TRY300/RUF010 here: the temporary result isn’t needed, the assignment should be in an else, and f"...{str(e)}" wants an explicit conversion flag. Returning directly and switching to {exc!s} fixes all three. Please apply the same pattern to the other lifecycle endpoints in this file.
- try:
- result = await background_agent_service.start_agent(agent_id)
- return result
- except Exception as e: # noqa: BLE001
+ try:
+ return await background_agent_service.start_agent(agent_id)
+ except Exception as exc: # noqa: BLE001
raise HTTPException(
status_code=status.HTTP_500_INTERNAL_SERVER_ERROR,
- detail=f"Failed to start agent: {str(e)}",
- ) from e
+ detail=f"Failed to start agent: {exc!s}",
+ ) from exc🧰 Tools
🪛 GitHub Check: Ruff Style Check (3.13)
[failure] 276-276: Ruff (RUF010)
src/backend/base/langflow/api/v1/background_agents.py:276:46: RUF010 Use explicit conversion flag
[failure] 273-273: Ruff (RUF100)
src/backend/base/langflow/api/v1/background_agents.py:273:29: RUF100 Unused noqa directive (unused: BLE001)
[failure] 272-272: Ruff (RET504)
src/backend/base/langflow/api/v1/background_agents.py:272:16: RET504 Unnecessary assignment to result before return statement
[failure] 272-272: Ruff (TRY300)
src/backend/base/langflow/api/v1/background_agents.py:272:9: TRY300 Consider moving this statement to an else block
🤖 Prompt for AI Agents
In src/backend/base/langflow/api/v1/background_agents.py around lines 270 to
277, simplify the try/except per Ruff: return the awaited call directly inside
the try (no temporary result variable), catch the exception as exc and use
f"Failed to start agent: {exc!s}" for the detail (explicit conversion), and
remove any unnecessary else/assignment; apply the same pattern and string
conversion ({exc!s}) to the other lifecycle endpoints in this file
(stop/restart/pause/etc.) so each returns directly on success and uses the same
exception handling structure.
| # Date trigger expects a specific datetime | ||
| run_date = trigger_config.get("run_date") | ||
| if run_date: | ||
| if isinstance(run_date, str): | ||
| run_date = datetime.fromisoformat(run_date) | ||
| return DateTrigger(run_date=run_date) | ||
| elif trigger_type in (TriggerType.WEBHOOK, TriggerType.EVENT): |
There was a problem hiding this comment.
Fix DATE trigger parsing for RFC3339/Zulu inputs.
datetime.fromisoformat() still raises on strings ending in "Z" on Python 3.10–3.12, which Langflow explicitly supports. That means DATE-triggered agents configured with standard RFC3339 timestamps (e.g., "2025-11-04T21:07:56Z") will raise ValueError and never schedule—breaking a core trigger type. Normalize the suffix before parsing so all supported runtimes accept the value.
elif trigger_type == TriggerType.DATE:
# Date trigger expects a specific datetime
run_date = trigger_config.get("run_date")
if run_date:
if isinstance(run_date, str):
- run_date = datetime.fromisoformat(run_date)
+ if run_date.endswith("Z"):
+ run_date = f"{run_date[:-1]}+00:00"
+ run_date = datetime.fromisoformat(run_date)
return DateTrigger(run_date=run_date)📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| # Date trigger expects a specific datetime | |
| run_date = trigger_config.get("run_date") | |
| if run_date: | |
| if isinstance(run_date, str): | |
| run_date = datetime.fromisoformat(run_date) | |
| return DateTrigger(run_date=run_date) | |
| elif trigger_type in (TriggerType.WEBHOOK, TriggerType.EVENT): | |
| # Date trigger expects a specific datetime | |
| run_date = trigger_config.get("run_date") | |
| if run_date: | |
| if isinstance(run_date, str): | |
| if run_date.endswith("Z"): | |
| run_date = f"{run_date[:-1]}+00:00" | |
| run_date = datetime.fromisoformat(run_date) | |
| return DateTrigger(run_date=run_date) | |
| elif trigger_type in (TriggerType.WEBHOOK, TriggerType.EVENT): |
🤖 Prompt for AI Agents
In src/backend/base/langflow/services/background_agent/service.py around lines
374 to 380, the DATE trigger parsing uses datetime.fromisoformat which raises on
RFC3339 "Z" suffixes; normalize timezone suffixes before parsing so Python
3.10–3.12 accept the value. Specifically, if run_date is a string and ends with
"Z" or "z", replace that suffix with "+00:00" (or otherwise convert it to an
RFC3339 offset) and then call datetime.fromisoformat on the normalized string so
Zulu timestamps are accepted and DateTrigger can be created.
| flow_dict = { | ||
| "id": str(flow.id), | ||
| "name": flow.name, | ||
| "data": flow.data, | ||
| } | ||
|
|
||
| # Create runner | ||
| runner = LangflowRunnerExperimental( | ||
| should_initialize_db=False, | ||
| disable_logs=False, | ||
| ) | ||
|
|
||
| # Execute flow | ||
| input_value = input_config.get("input_value", "") | ||
| input_type = input_config.get("input_type", "chat") | ||
| output_type = input_config.get("output_type", "all") | ||
| tweaks_values = input_config.get("tweaks", None) | ||
|
|
||
| result = await runner.run( | ||
| session_id=session_id, | ||
| flow=flow_dict, | ||
| input_value=input_value, | ||
| input_type=input_type, | ||
| output_type=output_type, | ||
| user_id=str(user_id), | ||
| cleanup=True, | ||
| tweaks_values=tweaks_values, | ||
| ) |
There was a problem hiding this comment.
Prevent flow/user deletion during background execution.
Passing the persisted flow ID and cleanup=True into LangflowRunnerExperimental causes the runner to call clear_flow_state before and after execution and clear_user_state when cleaning up. In flow_runner.py this deletes the original flow record and, with a real user_id, wipes the user and all their flows. That will nuke customer data the first time an agent runs. Work on a cloned flow ID and disable cleanup so the runner only touches the temporary copy.
Apply this diff:
- flow_dict = {
- "id": str(flow.id),
+ flow_dict = {
+ "id": str(uuid4()),
"name": flow.name,
"data": flow.data,
}
...
- result = await runner.run(
+ result = await runner.run(
session_id=session_id,
flow=flow_dict,
input_value=input_value,
input_type=input_type,
output_type=output_type,
user_id=str(user_id),
- cleanup=True,
+ cleanup=False,
tweaks_values=tweaks_values,
)Also ensure flow_dict["data"] is deep-copied if mutating tweaks to avoid touching the ORM instance.
Committable suggestion skipped: line range outside the PR's diff.
🤖 Prompt for AI Agents
In src/backend/base/langflow/services/background_agent/utils.py around lines 38
to 65, the code currently passes the persisted flow ID and cleanup=True into the
runner which causes deletion of real flow/user state; instead clone the flow ID
(e.g., assign a new UUID string to flow_dict["id"]) and call runner.run with
cleanup=False so the runner only touches a temporary copy; also deep-copy
flow_dict["data"] (use copy.deepcopy) before applying any tweaks to avoid
mutating the ORM instance; optionally avoid passing the real user_id (pass None
or a dedicated background-agent id) to ensure no user-level cleanup can occur.
| def get_background_agent_service(): | ||
| """Retrieves the BackgroundAgentService instance from the service manager. | ||
|
|
||
| Returns: | ||
| BackgroundAgentService: The BackgroundAgentService instance. | ||
| """ | ||
| from langflow.services.background_agent.factory import BackgroundAgentServiceFactory | ||
|
|
||
| return get_service(ServiceType.BACKGROUND_AGENT_SERVICE, BackgroundAgentServiceFactory()) |
There was a problem hiding this comment.
🛠️ Refactor suggestion | 🟠 Major
Add return type annotation for consistency.
The function correctly retrieves the BackgroundAgentService instance, but the return type annotation is missing from the signature. Other service getter functions in this file include explicit return types (e.g., get_telemetry_service() -> TelemetryService on line 56).
Apply this diff to add the return type annotation:
-def get_background_agent_service():
+def get_background_agent_service() -> BackgroundAgentService:
"""Retrieves the BackgroundAgentService instance from the service manager.🤖 Prompt for AI Agents
In src/backend/base/langflow/services/deps.py around lines 258 to 266, the
get_background_agent_service function is missing a return type annotation;
update the function signature to include the BackgroundAgentService return type
(matching other getters) and ensure you import or reference the
BackgroundAgentService type if necessary so the signature becomes: def
get_background_agent_service() -> BackgroundAgentService: while leaving the body
unchanged.
This PR introduces a new persistent background agent subsystem that enables Langflow agents to run continuously and reliably. Background tasks may be scheduled (cron/interval/datetime) or triggered by external events (webhooks, message queues, internal signals). The subsystem includes durable state persistence, concurrency controls, retry/backoff, graceful shutdown/restart semantics, observability hooks (logs/metrics), management endpoints/CLI, tests, and documentation.
What this change implements
Persistent background runner
Long-running scheduler and worker pool to execute agents persistently.
Supports cron expressions, fixed intervals, and one-off datetimes.
Event-driven triggers via HTTP/webhook and pluggable queue/pubsub adapters.
Durable state persistence
Abstract storage interface with local (file/SQLite) and SQL (e.g., Postgres) implementations.
Task and run state persisted (status, timestamps, metadata) so tasks can resume after failures or restarts.
Concurrency and safety
Max concurrent runs and queueing/backpressure policies.
Multi-instance coordination via storage-backed locking / optimistic coordination to avoid duplicate runs.
Signal handlers (SIGTERM/SIGINT) for graceful shutdown and in-flight state persistence.
Reliability and retries
Configurable retry policies (attempts, backoff strategies, jitter).
Exponential backoff with jitter for robust retry behavior.
Management API / CLI
Endpoints/commands to create/list/get/pause/resume/cancel tasks and inspect runs.
Event ingestion endpoint for webhook-style triggers.
Observability
Structured logging for lifecycle events (task created, run started, succeeded, failed, retry scheduled).
Metrics hooks (counters/timers) with integration points for Prometheus or other monitoring.
Tests
Unit and integration-style tests for scheduling, triggers, persistence, retries, and graceful shutdown/restart.
Documentation
New Background Agents guide covering concepts, configuration, examples, deployment notes and troubleshooting.
Updates to developer docs to reference how to run and test background tasks locally.
Why this change
Enables common production workflows (periodic reports, continuous monitors, reactive processing of events).
Replaces ad-hoc cron scripts and single-run agent invocations with a first-class, durable, and observable subsystem.
Usage examples
Example task (YAML) name: daily-report schedule: cron: "0 8 * * *" # every day at 08:00 UTC agent: my_reporting_agent retries: attempts: 3 backoff_seconds: 60 concurrency: max_parallel: 1
Programmatic registration (pseudocode) task = Task(name="daily-report", schedule={"cron":"0 8 * * *"}, agent=my_agent, retries={"attempts":3}) scheduler.register(task) scheduler.start()
Event trigger (HTTP) POST /api/background/triggers/dataset-update body: { "dataset_id": "123", "changed_by": "user" }
API / CLI (added)
POST /api/background/tasks — create task
GET /api/background/tasks — list tasks
GET /api/background/tasks/{id} — get task
POST /api/background/tasks/{id}/pause
POST /api/background/tasks/{id}/resume
POST /api/background/triggers/{name} — trigger an event
GET /api/background/tasks/{id}/runs — list runs for a task
CLI commands mirror key API actions for local/dev usage.
Backward compatibility & migration
Opt-in subsystem: existing agent behavior remains unchanged unless background tasks are configured.
Local file/SQLite mode provided for development; Postgres/SQL backend recommended for production.
For multi-instance deployments, use a shared persistent backend and coordinate locks to avoid duplicate runs.
Tests & QA
Tests cover:
Cron/interval/datetime schedule parsing and next-run computation.
Event trigger ingestion and mapping to tasks.
Retry/backoff behavior (including jitter).
Persistence and restart/resume semantics for in-flight tasks.
Graceful shutdown and restart behavior.
Integration smoke tests demonstrate tasks survive process restart and resume correctly.
Documentation
New Background Agents guide (concepts, configuration, sample YAML, API/CLI reference, deployment notes, troubleshooting).
Minor updates to DEVELOPMENT.md and the docs site to reference the new subsystem.
Changelog / Release Notes
Added: Persistent background agent execution subsystem with scheduling and event-driven triggers.
Added: Task persistence with pluggable storage backends.
Added: Management API/CLI for task lifecycle and event ingestion.
Added: Logging and metrics hooks for observability.
Added: Tests and developer documentation for background agents.
Files changed
This merge commit is a merge of PR #1 (branch: Bharani010/copilot/Implement persistent background agent execution with scheduling and event-driven triggers). The commit metadata is at: c493885
For the full list of modified/added files and exact diffs, please see the commit diff (link above) or the PR files view.
Notes for reviewers
Focus review on:
Storage abstraction and correctness of state transitions.
Multi-instance safety / locking behavior.
Scheduling correctness (cron/interval parsing and next-run calculation).
Retry/backoff with jitter correctness and configurability.
API semantics and default settings suitable for single-node dev while tunable for production.
Summary by CodeRabbit
Release Notes
New Features
Documentation
Tests