Add backend plugin architecture (Phase 1 + 2.1) and Library API#216
Closed
davewaring wants to merge 6 commits intomainfrom
Closed
Add backend plugin architecture (Phase 1 + 2.1) and Library API#216davewaring wants to merge 6 commits intomainfrom
davewaring wants to merge 6 commits intomainfrom
Conversation
Adds new API endpoints for plugins to access BrainDrive-Library content:
- GET /api/v1/library/projects - List projects in Library
- POST /api/v1/library/read-file - Read a specific file from a project
- GET /api/v1/library/project/{slug}/context - Get all context files at once
Security:
- Path validation prevents directory traversal attacks
- Restricted to ~/BrainDrive-Library/ only
- Requires authenticated user
- Allowed file types: .md, .txt, .json, .yaml, .yml
This enables plugins like Research Assistant to load project context
for AI-powered analysis without needing direct filesystem access.
Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Contributor
Author
|
@DJJones66 my goal here is to give BrainDrive-Owners the ability to have a BrainDrive-Library file on their computer that their braindrive can access but without accessign any other files on the system. I want this for the plugin we talked about building so when I put an article in the AI can review our projects for relevant context from the article. But I think this functionality could be very useful beyond just this. It's basically another way to get at chat with documents when you have a structured file system like we are building. |
Implements core infrastructure for backend plugins that can register REST API endpoints dynamically without modifying core code. Phase 1 - Core Infrastructure: - Add @plugin_endpoint decorator for marking endpoint functions - Add PluginRouteLoader for dynamic route loading/unloading - Add admin endpoint POST /admin/plugins/reload-routes - Integrate route loader with app startup Phase 2.1 - Plugin Database Model: - Add plugin_type field (frontend/backend/fullstack) - Add endpoints_file field for Python endpoint file - Add route_prefix field for URL prefix - Add backend_dependencies field (JSON list of slugs) - Add Alembic migration for new fields Also includes: - Library API append-file endpoint for writing to project docs - CORS config property helpers Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
davewaring
changed the title
… 2.2-2.3) Phase 2.2 - Extend BaseLifecycleManager: - Add module documentation for backend plugin support - Add VALID_PLUGIN_TYPES constant (frontend, backend, fullstack) - Update validate_plugin_metadata() with backend field validation - Require endpoints_file for backend/fullstack plugins - Validate backend_dependencies is a list, route_prefix starts with / - Add is_backend_plugin() and get_backend_metadata() helper methods Phase 2.3 - Update Plugin Repository: - Add get_backend_plugins(user_id) - returns backend/fullstack plugins - Add get_enabled_backend_plugins(user_id) - enabled backend plugins only - Add get_plugins_depending_on(backend_slug, user_id) - for cascade disable - Add get_all_enabled_backend_plugins() - for route loader startup Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Phase 3.1 - Route Reload Triggers:
- Add _trigger_route_reload_if_backend() helper for route reloads
- Trigger reload after install/uninstall/update of backend plugins
- Support all install methods: local, GitHub, file upload, remote URL
Phase 3.2 - Cascade Disable:
- Update PATCH /plugins/{plugin_id} to cascade-disable dependent plugins
- When disabling backend plugin, find and disable dependents first
- Return cascade_disabled list in response for transparency
- Trigger route reload after enable/disable of backend plugins
Phase 3.3 - Auto-Install Backend Dependencies:
- Add _auto_install_backend_dependencies() to check plugin metadata
- Auto-install missing backend dependencies before main plugin
- Return auto_installed_dependencies in response
- Fail with clear error if required dependency cannot be installed
Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Frontend: - Add PluginTypeTabs component (All/Frontend/Backend/Fullstack) - Add BackendPluginWarningDialog for security warnings - Add backend/fullstack badges to ModuleCard - Add dependency relationships display in ModuleDetailHeader - Add cascade disable confirmation dialog - Add pluginType filter support to useModules hook and moduleService - Add plugin_type to installer types and InstallationResult Backend: - Fix route_loader.py: Change prefix from /api/v1/plugins to /api/v1/plugin-api to avoid removing core plugin management routes - Add plugin_type filter parameter to /plugins/manager endpoint - Add pluginType field to module response from parent plugin Co-Authored-By: Claude <noreply@anthropic.com>
Previously the Library path was hardcoded to ~/BrainDrive-Library. Now users can set LIBRARY_PATH in their .env file to configure a custom location for their BrainDrive-Library folder. - Add LIBRARY_PATH setting to config.py (default: ~/BrainDrive-Library) - Update library.py to use settings.LIBRARY_PATH instead of hardcoded path - Support ~ expansion for home directory paths - Update docstring to document the new configuration option Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Contributor
Author
|
Closing this PR as part of the planned split (see library-integration decisions.md from 2026-01-25). What happened:
The split:
Why:
The useful code from this PR (path validation, auth patterns) has been incorporated into PR #217. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
@plugin_endpointdecorator andPluginRouteLoaderfor dynamic route managementplugin_type,endpoints_file,route_prefix, andbackend_dependenciesfieldsChanges
Phase 1 - Core Infrastructure (Backend Plugin System)
@plugin_endpoint()decorator with path validation, methods, and admin_only flagPluginRouteLoaderclass with async lock, atomic swap pattern, and module cleanup/plugins/reload-routesand/plugins/routesendpointsPhase 2.1 - Plugin Database Model
PluginTypeenum and 4 new fields for backend plugin metadataLibrary API Endpoints
GET /api/v1/library/projects- List projects from active/archived/ideas foldersPOST /api/v1/library/read-file- Read a specific file from LibraryGET /api/v1/library/project/{slug}/context- Get aggregated project contextPOST /api/v1/library/append-file- Append content to project documentation filesSecurity
Test plan
../in paths)🤖 Generated with Claude Code