feat: Add exception telemetry

[Yukiyukiyeah]

This pull request introduces exception telemetry logging to the langflow backend, enabling better tracking and analysis of unhandled exceptions. Key changes include adding a new telemetry payload schema for exceptions, implementing a method to log exceptions to the telemetry service, and adding unit and integration tests to validate the functionality.

Telemetry Enhancements:

• Added ExceptionPayload to the telemetry schema to capture exception details, including type, message, context, and a stack trace hash for grouping similar exceptions (src/backend/base/langflow/services/telemetry/schema.py).
• Implemented log_exception in the telemetry service to log unhandled exceptions with context and a hashed stack trace for grouping (src/backend/base/langflow/services/telemetry/service.py).

Exception Logging Integration:

• Integrated exception telemetry logging into the lifespan and exception_handler methods, ensuring exceptions are captured and reported to the telemetry service (src/backend/base/langflow/main.py) [1] [2] [3].

Testing:

• Added unit tests to validate the ExceptionPayload schema, log_exception method, and telemetry service behavior, including respect for the do_not_track setting (src/backend/tests/unit/test_exception_telemetry.py).
• Added integration tests to verify end-to-end functionality, including HTTP request formatting and service integration without FastAPI (src/backend/tests/integration/test_exception_telemetry.py).

[coderabbitai]

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

This update introduces comprehensive validation and testing infrastructure for Langflow starter project templates. It adds new validation utilities, extensive unit and integration tests, a dedicated GitHub Actions workflow, pre-commit hook, and Makefile targets for template testing. Additionally, it implements telemetry exception logging throughout the FastAPI app and enhances the telemetry service and schema.

Changes

Cohort / File(s)	Change Summary
CI/CD and Pre-commit Integration .github/workflows/ci.yml, .github/workflows/template-tests.yml, .pre-commit-config.yaml, Makefile	Adds a new GitHub Actions workflow and CI job for template tests, a pre-commit hook for starter project validation, and Makefile targets to run and exclude template tests.
Telemetry Exception Logging src/backend/base/langflow/main.py, src/backend/base/langflow/services/telemetry/service.py, src/backend/base/langflow/services/telemetry/schema.py	Implements structured exception telemetry logging in the FastAPI app, adds a new telemetry schema for exceptions, and a method in the telemetry service to log exceptions with stack trace hashing.
Template Validation Utilities src/backend/base/langflow/utils/template_validation.py, src/backend/base/langflow/utils/validate.py	Introduces a new module for validating template structure, build, code, and execution; enhances code validation to use a custom Langflow execution context.
Template and Telemetry Unit/Integration Tests src/backend/tests/unit/template/__init__.py, src/backend/tests/unit/template/test_starter_projects.py, src/backend/tests/unit/test_exception_telemetry.py, src/backend/tests/integration/test_exception_telemetry.py, src/backend/tests/unit/utils/test_template_validation.py, src/backend/tests/unit/utils/test_validate.py	Adds comprehensive unit and integration tests for starter project templates, template validation utilities, telemetry exception logging, and code validation utilities.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant GitHub Actions
    participant Pre-commit
    participant Makefile
    participant TestRunner
    participant TemplateValidation
    participant TelemetryService
    participant FastAPI

    User->>GitHub Actions: Push/PR triggers workflow
    GitHub Actions->>TestRunner: Run test_starter_projects.py
    TestRunner->>TemplateValidation: Validate templates (structure, build, code, execution)
    TemplateValidation-->>TestRunner: Validation results

    User->>Pre-commit: Commit starter project JSON
    Pre-commit->>TestRunner: Run template validation with security check

    User->>Makefile: make template_tests
    Makefile->>TestRunner: Run pytest on test_starter_projects.py

    FastAPI->>TelemetryService: On exception, call log_exception
    TelemetryService->>TelemetryService: Hash stack trace, build ExceptionPayload
    TelemetryService->>Telemetry Backend: Send telemetry data

Loading

Estimated code review effort

🎯 4 (Complex) | ⏱️ ~45 minutes

Possibly related PRs

• feat: Add template tests #9083: Adds and enhances testing infrastructure for starter project templates, targeting the same test file and workflows—directly related to these changes.

Suggested labels

lgtm, size:XL

Suggested reviewers

• deon-sanchez
• erichare
• mendonk

✨ Finishing Touches

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch add-telemetry

---

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

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR/Issue comments)

Type @coderabbitai help to get the list of available commands.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

Status, Documentation and Community

• Visit our Status Page to check the current availability of CodeRabbit.
• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

[codecov]

Codecov Report

❌ Patch coverage is 76.00000% with 6 lines in your changes missing coverage. Please review.
✅ Project coverage is 32.88%. Comparing base (020d1d1) to head (8317efb).
⚠️ Report is 3 commits behind head on main.

Files with missing lines	Patch %	Lines
src/backend/base/langflow/main.py	50.00%	6 Missing ⚠️

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

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #9194      +/-   ##
==========================================
+ Coverage   32.45%   32.88%   +0.42%     
==========================================
  Files        1217     1198      -19     
  Lines       57572    56989     -583     
  Branches     5373     5232     -141     
==========================================
+ Hits        18687    18738      +51     
+ Misses      38825    38191     -634     
  Partials       60       60              

Flag	Coverage Δ
backend	53.98% <76.00%> (+0.12%)	⬆️

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

Files with missing lines	Coverage Δ
...backend/base/langflow/services/telemetry/schema.py	100.00% <100.00%> (ø)
...ackend/base/langflow/services/telemetry/service.py	84.00% <100.00%> (+2.80%)	⬆️
src/backend/base/langflow/main.py	65.03% <50.00%> (-1.52%)	⬇️

... and 125 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.