feat: Add static functional analysis report and refactoring plan

[MasumRab]

This change introduces a comprehensive static analysis of the codebase, focusing on functional programming principles like side effects, immutability, and modularity.

The key deliverables are:

• functional_analysis_report.md: Details findings on hidden side effects (global singletons, implicit I/O), mutable state, and imperative loops. It also includes an addendum on the broken state of the test suite, which was discovered and fixed during the pre-commit process.
• refactoring_plan.md: Provides a step-by-step plan to refactor the core components, introduce a modular data source architecture, and eliminate global state through dependency injection.

Additionally, this commit includes a number of fixes to the test suite that were necessary to make it runnable. These fixes address pre-existing syntax errors, indentation issues, merge conflicts, and import errors. It also removes out-of-scope binary and log files that were previously committed.

Summary by Sourcery

Introduce static functional analysis artifacts and a refactoring roadmap, clean up obsolete code, standardize performance logging, and restore test suite functionality.

Bug Fixes:

• Fix syntax, indentation, merge conflict markers, import errors, and decorator usage in test files to make the test suite runnable.

Enhancements:

• Remove outdated performance_monitor internals and conflict remnants.
• Standardize log_performance decorator to use explicit operation parameter across modules.
• Add a global model_manager instance and extend PluginManager with plugin_folder and loaded_plugins attributes.
• Adjust exception handling indentation in workflow_routes for consistency.

Documentation:

• Add functional_analysis_report.md detailing hidden side effects and functional programming violations.
• Add refactoring_plan.md outlining a step-by-step modularization and dependency-injection strategy.

Tests:

• Restructure pytest fixtures, add pytest.mark.asyncio for asynchronous tests, and clean up patch context managers.

Chores:

• Delete the out-of-scope performance_metrics_log.jsonl file.

[sourcery-ai]

Reviewer's Guide

This PR introduces comprehensive static functional analysis and a step-by-step refactoring plan as new documentation, while cleaning up the performance monitoring code, restoring test suite runnability, standardizing performance logging decorators, adding missing component initializations, and removing obsolete artifacts.

Sequence diagram for refactored data source usage with dependency injection

sequenceDiagram
    participant App as "Application Component"
    participant Manager as "DataSourceManager"
    participant Connector as "JsonFileDataSource (IEmailDataSource)"
    App->>Manager: get_active_connector()
    Manager->>Connector: (returns active connector)
    App->>Connector: get_emails()
    Connector-->>App: List[Email]

Loading

Class diagram for proposed modular data source architecture

classDiagram
    class Email {
        +id: str
        +subject: str
        +sender: str
        +content: str
        +category_id: str
        +... // other immutable fields
    }
    class Category {
        +id: str
        +name: str
        +color: str
        +... // other immutable fields
    }
    class IEmailDataSource {
        <<interface>>
        +get_email_by_id(id: str): Email
        +get_emails(): List[Email]
        +update_email(email: Email): Email
        +get_all_categories(): List[Category]
        +... // other abstract methods
    }
    class JsonFileDataSource {
        +get_email_by_id(id: str): Email
        +get_emails(): List[Email]
        +update_email(email: Email): Email
        +get_all_categories(): List[Category]
        +... // implementation details
    }
    class DataSourceManager {
        +register_connector(connector: IEmailDataSource)
        +set_active_connector(name: str)
        +get_active_connector(): IEmailDataSource
        +... // management methods
    }
    Email <|-- IEmailDataSource
    Category <|-- IEmailDataSource
    IEmailDataSource <|.. JsonFileDataSource
    DataSourceManager o-- IEmailDataSource

Loading

File-Level Changes

Change	Details	Files
Add static analysis report and refactoring plan documentation	Create functional_analysis_report.md outlining side-effect and modularity findings Create refactoring_plan.md detailing phased refactoring steps	functional_analysis_report.md refactoring_plan.md
Clean up performance_monitor module	Remove stale methods, unresolved merge-conflict markers, and global instance Retain only the async_wrapper decorator and core monitoring logic	backend/python_backend/performance_monitor.py
Repair and reformat test suite	Fix pytest fixture indentation and remove duplicate blank lines Unify patch context manager syntax in test_workflow_engine Correct fixture definitions in conftest.py for session scope	backend/python_backend/tests/test_workflow_engine.py backend/python_backend/tests/conftest.py
Standardize log_performance decorator usage	Switch to explicit operation="..." keyword for all decorator usages	src/core/database.py backend/python_backend/database.py backend/python_backend/training_routes.py
Initialize missing components and enhance plugin manager	Instantiate model_manager at module level Add plugin_folder and loaded_plugins attributes in PluginManager	backend/python_backend/model_manager.py backend/python_backend/plugin_manager.py
Remove obsolete artifacts	Delete out-of-scope performance_metrics_log.jsonl file	performance_metrics_log.jsonl

Possibly linked issues

• #CodeRabbit Review: The PR provides an analysis and refactoring plan that addresses the code quality and testability concerns raised in the issue, and includes direct fixes for the broken test suite and decorator usage.

---

Tips and commands

Interacting with Sourcery

• Trigger a new review: Comment @sourcery-ai review on the pull request.
• Continue discussions: Reply directly to Sourcery's review comments.
• Generate a GitHub issue from a review comment: Ask Sourcery to create an
  issue from a review comment by replying to it. You can also reply to a
  review comment with @sourcery-ai issue to create an issue from it.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a title at any time. You can also comment
  @sourcery-ai title on the pull request to (re-)generate the title at any time.
• Generate a pull request summary: Write @sourcery-ai summary anywhere in
  the pull request body to generate a PR summary at any time exactly where you
  want it. You can also comment @sourcery-ai summary on the pull request to
  (re-)generate the summary at any time.
• Generate reviewer's guide: Comment @sourcery-ai guide on the pull
  request to (re-)generate the reviewer's guide at any time.
• Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
  pull request to resolve all Sourcery comments. Useful if you've already
  addressed all the comments and don't want to see them anymore.
• Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
  request to dismiss all existing Sourcery reviews. Especially useful if you
  want to start fresh with a new review - don't forget to comment
  @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

• Enable or disable review features such as the Sourcery-generated pull request
  summary, the reviewer's guide, and others.
• Change the review language.
• Add, remove or edit custom review instructions.
• Adjust other review settings.

Getting Help

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[github-actions]

🤖 Hi @MasumRab, I've received your request, and I'm working on it now! You can track my progress in the logs for more details.

[coderabbitai]

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

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.

Note

Other AI code review bot(s) detected

CodeRabbit has detected other AI code review bot(s) in this pull request and will avoid duplicating their findings in the review comments. This may lead to a less comprehensive review.

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch feature/static-analysis-report

---

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

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

[sourcery-ai]

Hey there - I've reviewed your changes and they look great!

Prompt for AI Agents

Please address the comments from this code review:

## Individual Comments

### Comment 1
<location> `functional_analysis_report.md:91` </location>
<code_context>
+
+## 3. Proposed Architectural Design for External Database Interface
+
+To address the issues of side effects and modularity, a new architecture is proposed. This design isolates data access logic and and allows for multiple, swappable data sources.
+
+### 3.1. Core Components
</code_context>

<issue_to_address>
**issue (typo):** Duplicate word 'and' found; should be 'and allows for multiple, swappable data sources'.

Please remove the repeated 'and' for clarity.

```suggestion
To address the issues of side effects and modularity, a new architecture is proposed. This design isolates data access logic and allows for multiple, swappable data sources.
```
</issue_to_address>

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}

[github-actions]

🤖 I'm sorry @MasumRab, but I was unable to process your request. Please see the logs for more details.

[openhands-ai]

Looks like there are a few issues preventing this PR from being merged!

• GitHub Actions are failing:
  • CI

If you'd like me to help, just leave a comment, like

@OpenHands please fix the failing actions on PR #140 at branch `feature/static-analysis-report`

Feel free to include any additional details that might help me get this PR into a better state.

_{^{You can manage your notification settings}}