(feat) Dev APIs: Add lifecycle events with AGUI protocol #10780

dkaushik94 · 2025-11-28T16:38:59Z

Adding support for lifecycle events for components and workflows. This will be a part of the new Developer APIs for Langflow and the APIs will be AG-UI compliant.

AG UI event reference

Design pattern introduced:

@observable decorator introduced to leverage event generation for build methods of any component class.
Classes using this decorator should implement before_callback_event and after_callback_event in order to become observable and should generate the suitable protocol events. In case users don't define these methods, the default behaviour is silent failure to generate the payloads.
Additional metrics can be massaged and injected into the event payloads which allows for dynamic payloads/flexible fields under the raw_event field, without violating AGUI compliance.

Summary by CodeRabbit

New Features
- Observable lifecycle events added for graph runs and vertex builds with start/finish event emission
- Event metrics collection with timestamps and optional fields for richer observability
- Structured event streaming across the execution pipeline for improved visibility
Chores
- Added a runtime dependency to support the new event protocol
Tests
- Added unit tests covering lifecycle event behavior and error/warning cases

_{✏️ Tip: You can customize this high-level summary in your review settings.}

Testing Instructions:
Try this cURL command and add print statements in before_callback and after_callback methods to print payloads in the console primed for publishing to queues later. Verify AGUI compliance.

curl --request POST --url 'http://localhost:3000/api/v1/run/<YOUR FLOW ID here>?stream=true' --header 'Content-Type: application/json' --data '{"output_type": "chat","input_type": "chat","input_value": "What do you think about online betting platforms?","session_id": ""}'

coderabbitai · 2025-11-28T16:39:06Z

Important

Review skipped

Auto incremental reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

Adds an async lifecycle observability system: a new @observable decorator that emits start/finish/error events via optional class hooks and integrates it into Graph and Vertex to publish Run/Step lifecycle events. Also adds dependency ag-ui-protocol>=0.1.10 and unit tests for the decorator.

Changes

Cohort / File(s)	Summary
Dependency Updates `pyproject.toml`, `src/lfx/pyproject.toml`	Added runtime dependency `ag-ui-protocol>=0.1.10`.
Observable Decorator `src/lfx/src/lfx/events/observability/lifecycle_events.py`	New `@observable` decorator for async methods; validates `event_manager`, encodes payloads via EventEncoder, calls optional `before_callback_event` / `after_callback_event` / `error_callback_event`, and logs when hooks/manager are missing.
Graph Integration `src/lfx/src/lfx/graph/graph/base.py`	Imported `RunStartedEvent`/`RunFinishedEvent`; decorated `Graph._run` with `@observable`; added `raw_event_metrics`, `before_callback_event`, `after_callback_event`; adjusted fallback cache callback placeholder.
Vertex Integration `src/lfx/src/lfx/graph/vertex/base.py`	Imported `StepStartedEvent`/`StepFinishedEvent`; added `raw_metrics` field; added `raw_event_metrics`, `before_callback_event`, `after_callback_event`; decorated `_build` with `@observable` (two locations); `get_built_result` now returns `{}` when `UnbuiltResult`.
Tests `src/lfx/tests/unit/events/observability/test_lifecycle_events.py`	New unit tests covering decorator behavior: successful flows, exception handling, missing `event_manager`, and classes without hooks; uses mocked logger, EventManager, and Encoder.

Sequence Diagram

sequenceDiagram
    participant Caller as Caller
    participant Decor as `@observable`
    participant Host as Graph/Vertex
    participant EM as EventManager
    participant Enc as EventEncoder

    Caller->>Host: call observed method (e.g., _run/_build, kwargs include event_manager)
    Host->>Decor: invocation (decorator wrapper)
    Decor->>Host: before_callback_event(...)
    activate Host
    note right of Host `#D3E5FF`: build raw metrics & start payload
    Host-->>Decor: Run/StepStartedEvent payload
    deactivate Host
    Decor->>EM: publish(start payload)
    activate EM
    EM->>Enc: encode(start payload)
    deactivate EM

    Decor->>Host: execute original method
    activate Host
    Host-->>Decor: result / exception
    deactivate Host

    alt success
        Decor->>Host: after_callback_event(result,...)
        activate Host
        note right of Host `#D3E5FF`: build raw metrics & finish payload
        Host-->>Decor: Run/StepFinishedEvent payload
        deactivate Host
        Decor->>EM: publish(finish payload)
        activate EM
        EM->>Enc: encode(finish payload)
        deactivate EM
        Decor-->>Caller: return result
    else error
        Decor->>Host: error_callback_event(exception,...)
        activate Host
        Host-->>Decor: error payload (optional)
        deactivate Host
        Decor->>EM: publish(error payload)
        Decor-->>Caller: return None (exception swallowed by decorator)
    end

Estimated code review effort

🎯 4 (Complex) | ⏱️ ~45 minutes

🚥 Pre-merge checks | ✅ 6 | ❌ 1

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 33.33% which is insufficient. The required threshold is 80.00%.	You can run `@coderabbitai generate docstrings` to improve docstring coverage.

✅ Passed checks (6 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title accurately describes the main change: adding lifecycle events with AGUI protocol support as part of developer APIs.
Test Coverage For New Implementations	✅ Passed	The PR includes comprehensive test coverage for all new implementations including lifecycle events, callback methods, and event metrics across multiple test files.
Test Quality And Coverage	✅ Passed	PR includes comprehensive test coverage for lifecycle events with 4 async tests using pytest.mark.asyncio, proper fixtures, mocks, and assertions.
Test File Naming And Structure	✅ Passed	Test file follows correct naming convention, uses pytest structure with proper fixtures, has descriptive test names, is organized in appropriate unit test directory, and comprehensively covers both positive and negative scenarios including successful execution, exception handling, and missing dependencies.
Excessive Mock Usage Warning	✅ Passed	Test file demonstrates appropriate mock usage targeting external dependencies (Logger, EventManager, Encoder) rather than core logic, with only three primary mock objects providing reasonable coverage for decorator testing.
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing touches

🧪 Generate unit tests (beta)

Create PR with unit tests
Post copyable unit tests in a comment
Commit unit tests in branch add-lifecycle-events

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.

❤️ Share

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

dkaushik94 · 2025-12-06T10:42:40Z

src/lfx/src/lfx/graph/graph/base.py

                raise ValueError(msg)
            vertex.update_raw_params(inputs, overwrite=True)

+    @observable


Heads up: I will remove this once the PR is reviewed and everybody has understood what the intended use of the observable decorator is. This shouldn't go to production since it's not necessary to be called until we are ready for our streaming APIs.

github-actions · 2025-12-06T10:47:33Z

Frontend Unit Test Coverage Report

Coverage Summary

Lines	Statements	Branches	Functions
	17.44% (4977/28526)	10.76% (2364/21957)	11.55% (722/6246)

Unit Test Results

Tests	Skipped	Failures	Errors	Time
1989	0 💤	0 ❌	0 🔥	25.898s ⏱️

codecov · 2025-12-06T10:47:49Z

Codecov Report

❌ Patch coverage is 92.59259% with 6 lines in your changes missing coverage. Please review.
✅ Project coverage is 34.10%. Comparing base (3006b13) to head (33e7af1).
⚠️ Report is 2 commits behind head on main.

Files with missing lines	Patch %	Lines
...x/src/lfx/events/observability/lifecycle_events.py	95.55%	2 Missing ⚠️
src/lfx/src/lfx/graph/graph/base.py	88.88%	0 Missing and 2 partials ⚠️
src/lfx/src/lfx/graph/vertex/base.py	88.88%	0 Missing and 2 partials ⚠️

❌ Your project status has failed because the head coverage (40.80%) is below the target coverage (60.00%). You can increase the head coverage or adjust the target coverage.

Additional details and impacted files

@@            Coverage Diff             @@
##             main   #10780      +/-   ##
==========================================
+ Coverage   34.03%   34.10%   +0.07%     
==========================================
  Files        1407     1408       +1     
  Lines       66661    66770     +109     
  Branches     9839     9858      +19     
==========================================
+ Hits        22689    22773      +84     
- Misses      42787    42804      +17     
- Partials     1185     1193       +8

Flag	Coverage Δ
backend	`53.16% <ø> (ø)`
lfx	`40.80% <92.59%> (+0.17%)`	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Files with missing lines	Coverage Δ
...x/src/lfx/events/observability/lifecycle_events.py	`95.55% <95.55%> (ø)`
src/lfx/src/lfx/graph/graph/base.py	`48.97% <88.88%> (+0.57%)`	⬆️
src/lfx/src/lfx/graph/vertex/base.py	`59.35% <88.88%> (+1.10%)`	⬆️

... and 2 files with indirect coverage changes

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

coderabbitai

Actionable comments posted: 5

🧹 Nitpick comments (4)

src/lfx/src/lfx/events/observability/lifecycle_events.py (1)

70-70: TODO comments indicate incomplete implementation.

The event publishing logic is not yet implemented. Ensure this is tracked for completion before production use.

Would you like me to open an issue to track the completion of event publishing logic?

Also applies to: 82-83
src/lfx/src/lfx/graph/vertex/base.py (1)
845-861: Redundant hasattr checks for methods defined in the same class.

The hasattr(self, "raw_event_metrics") checks are unnecessary since raw_event_metrics is defined in this same class and will always exist.
     def before_callback_event(self, *args, **kwargs):
         """Should be a AGUI compatible event.
         VERTEX class generates a StepStartedEvent event.
         """
-        metrics = {}
-        if hasattr(self, "raw_event_metrics"):
-            metrics = self.raw_event_metrics({"component_id": self.id})
-
+        metrics = self.raw_event_metrics({"component_id": self.id})
         return StepStartedEvent(step_name=self.display_name, raw_event={"langflow": metrics})

     def after_callback_event(self, result, *args, **kwargs):
         """Should be a AGUI compatible event.
         VERTEX class generates a StepFinishedEvent event.
         """
-        metrics = {}
-        if hasattr(self, "raw_event_metrics"):
-            metrics = self.raw_event_metrics({"component_id": self.id})
+        metrics = self.raw_event_metrics({"component_id": self.id})
         return StepFinishedEvent(step_name=self.display_name, raw_event={"langflow": metrics})
src/lfx/src/lfx/graph/graph/base.py (1)
2306-2316: Redundant hasattr checks and unused result parameter.

The hasattr(self, "raw_event_metrics") checks are unnecessary since the method is defined in this class.

The result parameter in after_callback_event is received but never used - RunFinishedEvent is created with result=None. If the result should be included in the event, update accordingly.

The unused *args, **kwargs are part of the callback protocol contract, so the ARG002 warnings can be suppressed with # noqa: ARG002.
-    def before_callback_event(self, *args, **kwargs):
-        metrics = {}
-        if hasattr(self, "raw_event_metrics"):
-            metrics = self.raw_event_metrics({"total_components": len(self.vertices)})
+    def before_callback_event(self, *args, **kwargs):  # noqa: ARG002
+        metrics = self.raw_event_metrics({"total_components": len(self.vertices)})
         return RunStartedEvent(run_id=self._run_id, thread_id=self.flow_id, raw_event=metrics)
 
-    def after_callback_event(self, result: Any = None, *args, **kwargs):
-        metrics = {}
-        if hasattr(self, "raw_event_metrics"):
-            metrics = self.raw_event_metrics({"total_components": len(self.vertices)})
-        return RunFinishedEvent(run_id=self._run_id, thread_id=self.flow_id, result=None, raw_event=metrics)
+    def after_callback_event(self, result: Any = None, *args, **kwargs):  # noqa: ARG002
+        metrics = self.raw_event_metrics({"total_components": len(self.vertices)})
+        return RunFinishedEvent(run_id=self._run_id, thread_id=self.flow_id, result=result, raw_event=metrics)
pyproject.toml (1)

141-142: Dependency addition looks good.

The ag-ui-protocol>=0.1.10 is correctly added and uv.lock is updated. Version 0.1.10 is the latest release (Nov 2025), so the constraint is currently appropriate. If future patch versions become available, consider tightening to >=0.1.10,<0.2.0 to minimize the risk of unexpected changes.

📜 Review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 7a053bd and e04148e.

⛔ Files ignored due to path filters (1)

uv.lock is excluded by !**/*.lock

📒 Files selected for processing (6)

pyproject.toml (1 hunks)
src/lfx/pyproject.toml (1 hunks)
src/lfx/src/lfx/events/observability/lifecycle_events.py (1 hunks)
src/lfx/src/lfx/graph/graph/base.py (4 hunks)
src/lfx/src/lfx/graph/vertex/base.py (5 hunks)
src/lfx/tests/unit/events/observability/test_lifecycle_events.py (1 hunks)

🧰 Additional context used

📓 Path-based instructions (2)

{pyproject.toml,uv.lock}

📄 CodeRabbit inference engine (.cursor/rules/backend_development.mdc)

Use uv (>=0.4) for Python dependency management in backend development

Files:

pyproject.toml

**/test_*.py

📄 CodeRabbit inference engine (Custom checks)

**/test_*.py: Review test files for excessive use of mocks that may indicate poor test design - check if tests have too many mock objects that obscure what's actually being tested
Warn when mocks are used instead of testing real behavior and interactions, and suggest using real objects or test doubles when mocks become excessive
Ensure mocks are used appropriately for external dependencies only, not for core logic
Backend test files should follow the naming convention test_*.py with proper pytest structure
Test files should have descriptive test function names that explain what is being tested
Tests should be organized logically with proper setup and teardown
Consider including edge cases and error conditions for comprehensive test coverage
Verify tests cover both positive and negative scenarios where appropriate
For async functions in backend tests, ensure proper async testing patterns are used with pytest
For API endpoints, verify both success and error response testing

Files:

src/lfx/tests/unit/events/observability/test_lifecycle_events.py

🧠 Learnings (9)

📚 Learning: 2025-11-24T19:47:28.997Z

Learnt from: CR
Repo: langflow-ai/langflow PR: 0
File: .cursor/rules/testing.mdc:0-0
Timestamp: 2025-11-24T19:47:28.997Z
Learning: Applies to src/backend/tests/**/*.py : Test both sync and async code paths, mock external dependencies appropriately, test error handling and edge cases, validate input/output behavior, and test component initialization and configuration

Applied to files:

src/lfx/tests/unit/events/observability/test_lifecycle_events.py

📚 Learning: 2025-11-24T19:47:28.997Z

Learnt from: CR
Repo: langflow-ai/langflow PR: 0
File: .cursor/rules/testing.mdc:0-0
Timestamp: 2025-11-24T19:47:28.997Z
Learning: Applies to src/backend/tests/**/*.py : Use `pytest.mark.asyncio` decorator for async component tests and ensure async methods are properly awaited

Applied to files:

src/lfx/tests/unit/events/observability/test_lifecycle_events.py

📚 Learning: 2025-12-03T18:17:26.525Z

Learnt from: CR
Repo: langflow-ai/langflow PR: 0
File: coderabbit-custom-pre-merge-checks-unique-id-file-non-traceable-F7F2B60C-1728-4C9A-8889-4F2235E186CA.txt:0-0
Timestamp: 2025-12-03T18:17:26.525Z
Learning: Applies to **/test_*.py : For async functions in backend tests, ensure proper async testing patterns are used with pytest

Applied to files:

src/lfx/tests/unit/events/observability/test_lifecycle_events.py

📚 Learning: 2025-11-24T19:47:28.997Z

Learnt from: CR
Repo: langflow-ai/langflow PR: 0
File: .cursor/rules/testing.mdc:0-0
Timestamp: 2025-11-24T19:47:28.997Z
Learning: Applies to src/backend/tests/**/*.py : Be aware of ContextVar propagation in async tests; test both direct event loop execution and `asyncio.to_thread` scenarios; ensure proper context isolation between test cases

Applied to files:

src/lfx/tests/unit/events/observability/test_lifecycle_events.py

📚 Learning: 2025-11-24T19:47:28.997Z

Learnt from: CR
Repo: langflow-ai/langflow PR: 0
File: .cursor/rules/testing.mdc:0-0
Timestamp: 2025-11-24T19:47:28.997Z
Learning: Applies to src/backend/tests/**/*.py : Use `monkeypatch` fixture to mock internal functions for testing error handling scenarios; validate error status codes and error message content in responses

Applied to files:

src/lfx/tests/unit/events/observability/test_lifecycle_events.py

📚 Learning: 2025-12-03T18:17:26.525Z

Learnt from: CR
Repo: langflow-ai/langflow PR: 0
File: coderabbit-custom-pre-merge-checks-unique-id-file-non-traceable-F7F2B60C-1728-4C9A-8889-4F2235E186CA.txt:0-0
Timestamp: 2025-12-03T18:17:26.525Z
Learning: Applies to **/test_*.py : Ensure mocks are used appropriately for external dependencies only, not for core logic

Applied to files:

src/lfx/tests/unit/events/observability/test_lifecycle_events.py

📚 Learning: 2025-11-24T19:47:28.997Z

Learnt from: CR
Repo: langflow-ai/langflow PR: 0
File: .cursor/rules/testing.mdc:0-0
Timestamp: 2025-11-24T19:47:28.997Z
Learning: Applies to src/frontend/**/*.{test,spec}.{ts,tsx,js,jsx} : Use `pytest.mark.asyncio` decorator for async frontend tests; structure tests to verify component behavior, state updates, and proper cleanup

Applied to files:

src/lfx/tests/unit/events/observability/test_lifecycle_events.py

📚 Learning: 2025-11-24T19:47:28.997Z

Learnt from: CR
Repo: langflow-ai/langflow PR: 0
File: .cursor/rules/testing.mdc:0-0
Timestamp: 2025-11-24T19:47:28.997Z
Learning: Applies to src/backend/tests/**/*.py : Test background tasks using `asyncio.create_task()` and verify completion with `asyncio.wait_for()` with appropriate timeout constraints

Applied to files:

src/lfx/tests/unit/events/observability/test_lifecycle_events.py

📚 Learning: 2025-11-24T19:47:28.997Z

Learnt from: CR
Repo: langflow-ai/langflow PR: 0
File: .cursor/rules/testing.mdc:0-0
Timestamp: 2025-11-24T19:47:28.997Z
Learning: Applies to src/backend/tests/**/*.py : Use async fixtures with proper cleanup using try/finally blocks to ensure resources are properly released after tests complete

Applied to files:

src/lfx/tests/unit/events/observability/test_lifecycle_events.py

🧬 Code graph analysis (3)

src/lfx/tests/unit/events/observability/test_lifecycle_events.py (1)

src/lfx/src/lfx/events/observability/lifecycle_events.py (1)

observable (11-101)

src/lfx/src/lfx/graph/vertex/base.py (2)

src/lfx/src/lfx/events/observability/lifecycle_events.py (1)

observable (11-101)

src/lfx/src/lfx/graph/graph/base.py (3)

raw_event_metrics (2301-2304)

before_callback_event (2306-2310)

after_callback_event (2312-2316)

src/lfx/src/lfx/graph/graph/base.py (3)

src/lfx/src/lfx/events/observability/lifecycle_events.py (1)

observable (11-101)

src/lfx/src/lfx/graph/vertex/base.py (3)

raw_event_metrics (834-843)

before_callback_event (845-853)

after_callback_event (855-862)

src/lfx/tests/unit/events/observability/test_lifecycle_events.py (2)

before_callback_event (75-76)

after_callback_event (78-79)

🪛 GitHub Actions: Ruff Style Check

src/lfx/src/lfx/events/observability/lifecycle_events.py

[error] 76-76: RUF013 PEP 484 prohibits implicit Optional.

🪛 GitHub Check: Ruff Style Check (3.13)

src/lfx/src/lfx/events/observability/lifecycle_events.py

[failure] 96-96: Ruff (BLE001)
src/lfx/src/lfx/events/observability/lifecycle_events.py:96:16: BLE001 Do not catch blind exception: Exception

[failure] 76-76: Ruff (RUF013)
src/lfx/src/lfx/events/observability/lifecycle_events.py:76:41: RUF013 PEP 484 prohibits implicit Optional

src/lfx/src/lfx/graph/vertex/base.py

[failure] 835-840: Ruff (D205)
src/lfx/src/lfx/graph/vertex/base.py:835:9: D205 1 blank line required between summary line and description

[failure] 834-834: Ruff (B006)
src/lfx/src/lfx/graph/vertex/base.py:834:57: B006 Do not use mutable data structures for argument defaults

src/lfx/src/lfx/graph/graph/base.py

[failure] 2312-2312: Ruff (ARG002)
src/lfx/src/lfx/graph/graph/base.py:2312:65: ARG002 Unused method argument: kwargs

[failure] 2312-2312: Ruff (ARG002)
src/lfx/src/lfx/graph/graph/base.py:2312:57: ARG002 Unused method argument: args

[failure] 2312-2312: Ruff (ARG002)
src/lfx/src/lfx/graph/graph/base.py:2312:36: ARG002 Unused method argument: result

[failure] 2306-2306: Ruff (ARG002)
src/lfx/src/lfx/graph/graph/base.py:2306:46: ARG002 Unused method argument: kwargs

[failure] 2306-2306: Ruff (ARG002)
src/lfx/src/lfx/graph/graph/base.py:2306:38: ARG002 Unused method argument: args

[failure] 2301-2301: Ruff (B006)
src/lfx/src/lfx/graph/graph/base.py:2301:57: B006 Do not use mutable data structures for argument defaults

⏰ 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). (26)

GitHub Check: Run Frontend Tests / Playwright Tests - Shard 13/13
GitHub Check: Run Frontend Tests / Playwright Tests - Shard 9/13
GitHub Check: Run Frontend Tests / Playwright Tests - Shard 12/13
GitHub Check: Run Frontend Tests / Playwright Tests - Shard 8/13
GitHub Check: Run Frontend Tests / Playwright Tests - Shard 7/13
GitHub Check: Run Frontend Tests / Playwright Tests - Shard 10/13
GitHub Check: Run Frontend Tests / Playwright Tests - Shard 11/13
GitHub Check: Run Frontend Tests / Playwright Tests - Shard 5/13
GitHub Check: Run Frontend Tests / Playwright Tests - Shard 4/13
GitHub Check: Run Frontend Tests / Playwright Tests - Shard 6/13
GitHub Check: Run Frontend Tests / Playwright Tests - Shard 3/13
GitHub Check: Run Frontend Tests / Playwright Tests - Shard 2/13
GitHub Check: Run Frontend Tests / Playwright Tests - Shard 1/13
GitHub Check: Test Docker Images / Test docker images
GitHub Check: Lint Backend / Run Mypy (3.11)
GitHub Check: Lint Backend / Run Mypy (3.10)
GitHub Check: Lint Backend / Run Mypy (3.12)
GitHub Check: Run Backend Tests / Unit Tests - Python 3.10 - Group 2
GitHub Check: Run Backend Tests / Unit Tests - Python 3.10 - Group 5
GitHub Check: Run Backend Tests / Unit Tests - Python 3.10 - Group 4
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 / LFX Tests - Python 3.10
GitHub Check: Run Backend Tests / Integration Tests - Python 3.10
GitHub Check: Test Starter Templates
GitHub Check: Update Component Index

🔇 Additional comments (10)

src/lfx/pyproject.toml (1)

44-44: LGTM!

The dependency addition is consistent with the root pyproject.toml and appropriate for the lifecycle events feature in the lfx package.

src/lfx/tests/unit/events/observability/test_lifecycle_events.py (3)

147-168: Test correctly validates exception swallowing behavior, but consider adding a test for re-raised exceptions.

The test verifies the current behavior where exceptions are swallowed. If the implementation changes to re-raise exceptions (as suggested in the decorator review), this test will need updating.

72-100: Good test class structure with clear separation of concerns.

The test classes appropriately demonstrate observable usage with and without callback implementations. The mocking strategy correctly targets external dependencies rather than core logic, per coding guidelines.

31-66: Well-structured fixtures with proper cleanup.

The fixtures follow best practices with context manager patching and autouse reset for test isolation.

src/lfx/src/lfx/graph/vertex/base.py (3)

11-13: LGTM on imports.

The new imports for AGUI events and the observable decorator are appropriate for the lifecycle event integration.

117-117: LGTM on new raw_metrics field.

The field provides a clean way to attach custom metrics to vertex events.

389-389: LGTM on observable decorator usage.

The decorator is correctly applied to the _build method to enable lifecycle event emission.

src/lfx/src/lfx/graph/graph/base.py (3)

18-20: LGTM on imports.

The new imports for AGUI events and the observable decorator are appropriate for the lifecycle event integration.

734-734: Noted: Temporary decorator usage for review purposes.

Acknowledging the author's comment that this decorator application is for review understanding and may be removed before production.

1424-1425: Fallback cache function change looks correct.

The fallback no-op set_cache_func is appropriately defined for when the chat service is unavailable.

src/lfx/src/lfx/events/observability/lifecycle_events.py

src/lfx/src/lfx/graph/graph/base.py

src/lfx/src/lfx/graph/vertex/base.py

dkaushik94 · 2025-12-08T15:40:34Z

@coderabbitai generate docstrings

coderabbitai · 2025-12-08T15:40:52Z

✅ Actions performed

Initiated docstring generation; will generate only if new commits exist.

coderabbitai · 2025-12-08T15:40:55Z

Note

Docstrings generation - SUCCESS
Generated docstrings for this pull request at #10939

@dkaushik94

Docstrings generation was requested by @dkaushik94. * #10780 (comment) The following files were modified: * `src/lfx/src/lfx/events/observability/lifecycle_events.py` * `src/lfx/src/lfx/graph/graph/base.py` * `src/lfx/src/lfx/graph/vertex/base.py` * `src/lfx/tests/unit/events/observability/test_lifecycle_events.py`

dkaushik94 · 2025-12-09T09:28:11Z

@coderabbitai generate docstrings

coderabbitai · 2025-12-09T09:28:17Z

✅ Actions performed

Initiated docstring generation; will generate only if new commits exist.

@dkaushik94

Docstrings generation was requested by @dkaushik94. * #10780 (comment) The following files were modified: * `src/lfx/src/lfx/events/observability/lifecycle_events.py` * `src/lfx/src/lfx/graph/graph/base.py` * `src/lfx/src/lfx/graph/vertex/base.py` * `src/lfx/tests/unit/events/observability/test_lifecycle_events.py`

dkaushik94 · 2025-12-30T18:54:05Z

@coderabbitai review

coderabbitai · 2025-12-30T18:54:10Z

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

coderabbitai

Actionable comments posted: 0

🧹 Nitpick comments (1)

pyproject.toml (1)
143-143: Consider adding an upper bound for this pre-1.0 dependency.

The version constraint >=0.1.10 is permissive for a pre-1.0 package. As a best practice, add an upper bound to protect against potential breaking changes in minor version bumps (e.g., 0.1.x → 0.2.x). This pattern is already used throughout the codebase for similar dependencies (e.g., astrapy>=2.1.0,<3.0.0, google-search-results>=2.4.1,<3.0.0). The constraint is already consistent with src/lfx/pyproject.toml.
Suggested version constraint
-    "ag-ui-protocol>=0.1.10",
+    "ag-ui-protocol>=0.1.10,<0.2.0",

📜 Review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between e04148e and 6ab731b.

📒 Files selected for processing (1)

pyproject.toml

🧰 Additional context used

📓 Path-based instructions (1)

{pyproject.toml,uv.lock}

📄 CodeRabbit inference engine (.cursor/rules/backend_development.mdc)

Use uv (>=0.4) for Python dependency management in backend development

Files:

pyproject.toml

⏰ 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: Run Backend Tests / Unit Tests - Python 3.10 - Group 3
GitHub Check: Run Backend Tests / Unit Tests - Python 3.10 - Group 5
GitHub Check: Lint Backend / Run Mypy (3.11)
GitHub Check: Run Backend Tests / Unit Tests - Python 3.10 - Group 4
GitHub Check: Lint Backend / Run Mypy (3.10)
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 Frontend Unit Tests / Frontend Jest Unit Tests
GitHub Check: Lint Backend / Run Mypy (3.13)
GitHub Check: Lint Backend / Run Mypy (3.12)
GitHub Check: Test Docker Images / Test docker images
GitHub Check: Run Backend Tests / Integration Tests - Python 3.10
GitHub Check: Run Frontend Tests / Determine Test Suites and Shard Distribution
GitHub Check: Run Backend Tests / LFX Tests - Python 3.10
GitHub Check: Test Starter Templates

🔇 Additional comments (1)

pyproject.toml (1)

142-142: LGTM: Formatting adjustment for new dependency.

The trailing comma addition is a clean formatting change to accommodate the new ag-ui-protocol dependency.

Adam-Aghili

LGTM from an implmentation pointof view but I want to make sure our names are more meaningful.
do we want #11111 merged first?

src/lfx/src/lfx/events/observability/lifecycle_events.py

Jkavia

looks good, these changes are not called anywhere yet so safe to merge for now.

Added AGUI events to vertices and the graph. Created Decorator to add observability to Langflow workflows. TODO: Unit tests, feature gating to nullify impact in current production code paths. Added unit tests for lifecycle_events. Refraining from using event_manager for now since this capability is goig to stay dormant until APIs are ready for streaming. Added unit tests for before_callback_event and after_callback_event in graph and vertex classes.

dkaushik94 marked this pull request as draft November 28, 2025 16:39

dkaushik94 force-pushed the add-lifecycle-events branch 2 times, most recently from 7c77458 to ddac500 Compare December 4, 2025 22:40

dkaushik94 changed the title ~~Dev APIs: Add lifecycle events~~ (feat) Dev APIs: Add lifecycle events with AGUI protocol Dec 4, 2025

dkaushik94 force-pushed the add-lifecycle-events branch 2 times, most recently from ca11b66 to 388f08f Compare December 6, 2025 10:41

dkaushik94 commented Dec 6, 2025

View reviewed changes

dkaushik94 marked this pull request as ready for review December 6, 2025 10:43

coderabbitai bot reviewed Dec 6, 2025

View reviewed changes

dkaushik94 force-pushed the add-lifecycle-events branch 3 times, most recently from ac80720 to 1c1361f Compare December 8, 2025 15:38

coderabbitai bot mentioned this pull request Dec 8, 2025

📝 Add docstrings to add-lifecycle-events #10924

Open

dkaushik94 force-pushed the add-lifecycle-events branch 2 times, most recently from d46a140 to 590ed7d Compare December 9, 2025 09:22

coderabbitai bot mentioned this pull request Dec 9, 2025

📝 Add docstrings to add-lifecycle-events #10939

Open

dkaushik94 force-pushed the add-lifecycle-events branch 2 times, most recently from 5b8031e to 7d1235a Compare December 9, 2025 09:32

dkaushik94 assigned ogabrielluiz and Jkavia Dec 9, 2025

dkaushik94 requested review from Jkavia, jordanrfrazier and ogabrielluiz December 11, 2025 05:12

dkaushik94 force-pushed the add-lifecycle-events branch from a7c1d66 to 3258db0 Compare December 30, 2025 18:47

dkaushik94 added the enhancement New feature or request label Dec 30, 2025

coderabbitai bot reviewed Dec 30, 2025

View reviewed changes

dkaushik94 force-pushed the add-lifecycle-events branch from 6ab731b to fb58273 Compare December 30, 2025 19:21

Adam-Aghili reviewed Dec 31, 2025

View reviewed changes

src/lfx/src/lfx/events/observability/lifecycle_events.py Show resolved Hide resolved

Cristhianzl force-pushed the main branch from 16c748b to e13d33e Compare January 7, 2026 19:17

dkaushik94 force-pushed the add-lifecycle-events branch from fb58273 to 9a6abed Compare January 8, 2026 18:24

Jkavia reviewed Jan 9, 2026

View reviewed changes

src/lfx/src/lfx/events/observability/lifecycle_events.py Outdated Show resolved Hide resolved

Jkavia reviewed Jan 9, 2026

View reviewed changes

src/lfx/src/lfx/events/observability/lifecycle_events.py Show resolved Hide resolved

dkaushik94 force-pushed the add-lifecycle-events branch from 3687a98 to 5bbe83b Compare January 9, 2026 18:27

Jkavia approved these changes Jan 9, 2026

View reviewed changes

github-actions bot added the lgtm This PR has been approved by a maintainer label Jan 9, 2026

dkaushik94 force-pushed the add-lifecycle-events branch from 439e898 to 6deba06 Compare January 9, 2026 18:34

dkaushik94 force-pushed the add-lifecycle-events branch from 6deba06 to 33e7af1 Compare January 9, 2026 18:57

dkaushik94 added this pull request to the merge queue Jan 9, 2026

Adam-Aghili approved these changes Jan 9, 2026

View reviewed changes

Merged via the queue into main with commit fdffcc3 Jan 9, 2026
38 of 39 checks passed

dkaushik94 deleted the add-lifecycle-events branch January 9, 2026 20:30

(feat) Dev APIs: Add lifecycle events with AGUI protocol #10780

(feat) Dev APIs: Add lifecycle events with AGUI protocol #10780

Conversation

dkaushik94 commented Nov 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

coderabbitai bot commented Nov 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Review skipped

Walkthrough

Changes

Sequence Diagram

Estimated code review effort

Uh oh!

dkaushik94 Dec 6, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Dec 6, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Frontend Unit Test Coverage Report

Coverage Summary

Unit Test Results

Uh oh!

codecov bot commented Dec 6, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

dkaushik94 commented Dec 8, 2025

Uh oh!

coderabbitai bot commented Dec 8, 2025

Uh oh!

coderabbitai bot commented Dec 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

dkaushik94 commented Dec 9, 2025

Uh oh!

coderabbitai bot commented Dec 9, 2025

Uh oh!

dkaushik94 commented Dec 30, 2025

Uh oh!

coderabbitai bot commented Dec 30, 2025

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Adam-Aghili left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Jkavia left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

dkaushik94 commented Nov 28, 2025 •

edited

Loading

coderabbitai bot commented Nov 28, 2025 •

edited

Loading

dkaushik94 Dec 6, 2025 •

edited

Loading

github-actions bot commented Dec 6, 2025 •

edited

Loading

codecov bot commented Dec 6, 2025 •

edited

Loading

coderabbitai bot commented Dec 8, 2025 •

edited

Loading

Adam-Aghili left a comment •

edited

Loading