django-bolt 0.1.0__cp310-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl

django_bolt/management/commands/runbolt.py

@@ -0,0 +1,427 @@
+import importlib
+import sys
+from django.core.management.base import BaseCommand, CommandError
+from django.conf import settings
+from django.apps import apps
+
+from django_bolt.api import BoltAPI
+from django_bolt import _core
+
+
+class Command(BaseCommand):
+    help = "Run Django-Bolt server with autodiscovered APIs"
+
+    def add_arguments(self, parser):
+        parser.add_argument(
+            "--host", default="0.0.0.0", help="Host to bind to (default: 0.0.0)"
+        )
+        parser.add_argument(
+            "--port", type=int, default=8000, help="Port to bind to (default: 8000)"
+        )
+        parser.add_argument(
+            "--processes", type=int, default=1, help="Number of processes (default: 1)"
+        )
+        parser.add_argument(
+            "--workers", type=int, default=2, help="Workers per process (default: 2)"
+        )
+        parser.add_argument(
+            "--no-admin",
+            action="store_true",
+            help="Disable Django admin integration (admin enabled by default)",
+        )
+        parser.add_argument(
+            "--dev",
+            action="store_true",
+            help="Enable auto-reload on file changes (development mode)"
+        )
+
+    def handle(self, *args, **options):
+        processes = options['processes']
+        dev_mode = options.get('dev', False)
+
+        # Dev mode: force single process + single worker + enable auto-reload
+        if dev_mode:
+            options['workers'] = 1
+            if processes > 1:
+                self.stdout.write(
+                    self.style.WARNING(
+                        "[django-bolt] Dev mode enabled: forcing --processes=1 for auto-reload"
+                    )
+                )
+                options['processes'] = 1
+
+            self.stdout.write(
+                self.style.SUCCESS("[django-bolt] 🔥 Development mode enabled (auto-reload on file changes)")
+            )
+            self.run_with_autoreload(options)
+        else:
+            # Production mode (current logic)
+            if processes > 1:
+                self.start_multiprocess(options)
+            else:
+                self.start_single_process(options)
+
+    def run_with_autoreload(self, options):
+        """Run server with auto-reload using Django's autoreload system"""
+        try:
+            from django.utils import autoreload
+        except ImportError:
+            self.stdout.write(
+                self.style.ERROR(
+                    "[django-bolt] Error: Django autoreload not available. "
+                    "Upgrade Django or use --no-dev mode."
+                )
+            )
+            import sys
+            sys.exit(1)
+
+        # Use Django's autoreload system which is optimized
+        # It only restarts the Python interpreter when necessary
+        # and reuses the same process for faster reloads
+        def run_server():
+            self.start_single_process(options)
+
+        autoreload.run_with_reloader(run_server)
+
+    def start_multiprocess(self, options):
+        """Start multiple processes with SO_REUSEPORT"""
+        import os
+        import sys
+        import signal
+        
+        processes = options['processes']
+        self.stdout.write(f"[django-bolt] Starting {processes} processes with SO_REUSEPORT")
+        
+        # Store child PIDs for cleanup
+        child_pids = []
+        
+        def signal_handler(signum, frame):
+            self.stdout.write("\n[django-bolt] Shutting down processes...")
+            for pid in child_pids:
+                try:
+                    os.kill(pid, signal.SIGTERM)
+                except ProcessLookupError:
+                    pass
+            sys.exit(0)
+        
+        signal.signal(signal.SIGINT, signal_handler)
+        signal.signal(signal.SIGTERM, signal_handler)
+        
+        # Fork processes
+        for i in range(processes):
+            pid = os.fork()
+            if pid == 0:
+                # Child process
+                os.environ['DJANGO_BOLT_REUSE_PORT'] = '1'
+                os.environ['DJANGO_BOLT_PROCESS_ID'] = str(i)
+                self.start_single_process(options, process_id=i)
+                sys.exit(0)
+            else:
+                # Parent process
+                child_pids.append(pid)
+                self.stdout.write(f"[django-bolt] Started process {i} (PID: {pid})")
+        
+        # Parent waits for children
+        try:
+            while True:
+                pid, status = os.wait()
+                self.stdout.write(f"[django-bolt] Process {pid} exited with status {status}")
+                if pid in child_pids:
+                    child_pids.remove(pid)
+                if not child_pids:
+                    break
+        except KeyboardInterrupt:
+            pass
+    
+    def start_single_process(self, options, process_id=None):
+        """Start a single process server"""
+        # Setup Django logging once at server startup (one-shot, respects existing LOGGING)
+        from django_bolt.logging.config import setup_django_logging
+        setup_django_logging()
+
+        # Initialize FileResponse settings cache once at server startup
+        from django_bolt.responses import initialize_file_response_settings
+        initialize_file_response_settings()
+
+        if process_id is not None:
+            self.stdout.write(f"[django-bolt] Process {process_id}: Starting autodiscovery...")
+        else:
+            self.stdout.write("[django-bolt] Starting autodiscovery...")
+
+        # Autodiscover BoltAPI instances
+        apis = self.autodiscover_apis()
+
+        if not apis:
+            self.stdout.write(
+                self.style.WARNING("No BoltAPI instances found. Create api.py files with api = BoltAPI()")
+            )
+            return
+
+        # Merge all APIs and collect routes FIRST
+        merged_api = self.merge_apis(apis)
+
+        # Register OpenAPI routes AFTER merging (so schema includes all routes)
+        openapi_enabled = False
+        openapi_config = None
+
+        # Find first API with OpenAPI config
+        for api_path, api in apis:
+            if api.openapi_config:
+                openapi_config = api.openapi_config
+                openapi_enabled = True
+                break
+
+        # Register OpenAPI routes on merged API if any API had OpenAPI enabled
+        if openapi_enabled and openapi_config:
+            # Transfer OpenAPI config to merged API
+            merged_api.openapi_config = openapi_config
+            merged_api._register_openapi_routes()
+
+            if process_id is not None:
+                self.stdout.write(f"[django-bolt] Process {process_id}: OpenAPI docs enabled at {openapi_config.path}")
+            else:
+                self.stdout.write(self.style.SUCCESS(f"[django-bolt] OpenAPI docs enabled at {openapi_config.path}"))
+
+        # Register Django admin routes if not disabled
+        # Admin is controlled solely by --no-admin command-line flag
+        admin_enabled = not options.get('no_admin', False)
+
+        if admin_enabled:
+            # Register admin routes
+            merged_api._register_admin_routes(options['host'], options['port'])
+
+            if merged_api._admin_routes_registered:
+                from django_bolt.admin.admin_detection import detect_admin_url_prefix
+                admin_prefix = detect_admin_url_prefix() or 'admin'
+                if process_id is not None:
+                    self.stdout.write(f"[django-bolt] Process {process_id}: Django admin enabled at http://{options['host']}:{options['port']}/{admin_prefix}/")
+                else:
+                    self.stdout.write(self.style.SUCCESS(f"[django-bolt] Django admin enabled at http://{options['host']}:{options['port']}/{admin_prefix}/"))
+
+                # Also register static file routes for admin
+                merged_api._register_static_routes()
+                if merged_api._static_routes_registered:
+                    if process_id is not None:
+                        self.stdout.write(f"[django-bolt] Process {process_id}: Static files serving enabled")
+                    else:
+                        self.stdout.write("[django-bolt] Static files serving enabled")
+
+        if process_id is not None:
+            self.stdout.write(f"[django-bolt] Process {process_id}: Found {len(merged_api._routes)} routes from {len(apis)} APIs")
+        else:
+            self.stdout.write(
+                self.style.SUCCESS(f"[django-bolt] Found {len(merged_api._routes)} routes")
+            )
+        
+        # Register routes with Rust
+        rust_routes = []
+        for method, path, handler_id, handler in merged_api._routes:
+            # Ensure matchit path syntax
+            from django_bolt.api import BoltAPI
+            convert = getattr(merged_api, "_convert_path", None)
+            norm_path = convert(path) if callable(convert) else path
+            rust_routes.append((method, norm_path, handler_id, handler))
+
+        _core.register_routes(rust_routes)
+
+        # Register middleware metadata if present
+        if merged_api._handler_middleware:
+            middleware_data = [
+                (handler_id, meta)
+                for handler_id, meta in merged_api._handler_middleware.items()
+            ]
+            _core.register_middleware_metadata(middleware_data)
+            if process_id is not None:
+                self.stdout.write(f"[django-bolt] Process {process_id}: Registered middleware for {len(middleware_data)} handlers")
+            else:
+                self.stdout.write(f"[django-bolt] Registered middleware for {len(middleware_data)} handlers")
+        
+        if process_id is not None:
+            self.stdout.write(self.style.SUCCESS(f"[django-bolt] Process {process_id}: Starting server on http://{options['host']}:{options['port']}"))
+            self.stdout.write(f"[django-bolt] Process {process_id}: Workers: {options['workers']}")
+        else:
+            self.stdout.write(self.style.SUCCESS(f"[django-bolt] Starting server on http://{options['host']}:{options['port']}"))
+            self.stdout.write(f"[django-bolt] Workers: {options['workers']}, Processes: {options['processes']}")
+            self.stdout.write(self.style.SUCCESS(f"[django-bolt] OpenAPI docs enabled at http://{options['host']}:{options['port']}/docs/"))
+        # Set environment variable for Rust to read worker count
+        import os
+        os.environ['DJANGO_BOLT_WORKERS'] = str(options['workers'])
+
+        # Determine compression config (server-level in Actix)
+        # Priority: Django setting > first API with compression config
+        compression_config = None
+        if hasattr(settings, 'BOLT_COMPRESSION'):
+            # Use Django setting if provided (highest priority)
+            if settings.BOLT_COMPRESSION is not None and settings.BOLT_COMPRESSION is not False:
+                compression_config = settings.BOLT_COMPRESSION.to_rust_config()
+        else:
+            # Check if any API has compression configured
+            for api_path, api in apis:
+                if hasattr(api, 'compression') and api.compression is not None:
+                    compression_config = api.compression.to_rust_config()
+                    break
+
+        # Start the server
+        _core.start_server_async(merged_api._dispatch, options["host"], options["port"], compression_config)
+
+    def autodiscover_apis(self):
+        """Discover BoltAPI instances from installed apps.
+
+        Deduplicates by object identity to ensure each handler uses the FIRST
+        API instance created (with correct config), not duplicates from re-imports.
+        """
+        apis = []
+
+        # Check explicit settings first
+        if hasattr(settings, 'BOLT_API'):
+            for api_path in settings.BOLT_API:
+                api = self.import_api(api_path)
+                if api:
+                    apis.append((api_path, api))
+            return self._deduplicate_apis(apis)
+
+        # Try project-level API first (common pattern)
+        project_name = settings.ROOT_URLCONF.split('.')[0]  # Extract project name from ROOT_URLCONF
+        project_candidates = [
+            f"{project_name}.api:api",
+            f"{project_name}.bolt_api:api",
+        ]
+
+        for candidate in project_candidates:
+            api = self.import_api(candidate)
+            if api:
+                apis.append((candidate, api))
+
+        # Track which apps we've already imported (to avoid duplicates)
+        imported_apps = {api_path.split(':')[0].split('.')[0] for api_path, _ in apis}
+
+        # Autodiscover from installed apps
+        for app_config in apps.get_app_configs():
+            # Skip django_bolt itself
+            if app_config.name == 'django_bolt':
+                continue
+
+            # Skip if we already imported this app at project level
+            app_base = app_config.name.split('.')[0]
+            if app_base in imported_apps:
+                continue
+
+            # Check if app config has bolt_api hint
+            if hasattr(app_config, 'bolt_api'):
+                api = self.import_api(app_config.bolt_api)
+                if api:
+                    apis.append((app_config.bolt_api, api))
+                continue
+
+            # Try standard locations
+            app_name = app_config.name
+            candidates = [
+                f"{app_name}.api:api",
+                f"{app_name}.bolt_api:api",
+            ]
+
+            for candidate in candidates:
+                api = self.import_api(candidate)
+                if api:
+                    apis.append((candidate, api))
+                    break  # Only take first match per app
+
+        return self._deduplicate_apis(apis)
+
+    def _deduplicate_apis(self, apis):
+        """Deduplicate APIs by object identity.
+
+        This ensures each handler uses the FIRST API instance created (with original
+        config), not duplicates from module re-imports. Critical for preserving
+        per-API logging, auth, and middleware configs.
+        """
+        seen_ids = set()
+        deduplicated = []
+        for api_path, api in apis:
+            api_id = id(api)
+            if api_id not in seen_ids:
+                seen_ids.add(api_id)
+                deduplicated.append((api_path, api))
+            else:
+                self.stdout.write(f"[django-bolt] Skipped duplicate API instance from {api_path}")
+        return deduplicated
+
+    def import_api(self, dotted_path):
+        """Import a BoltAPI instance from dotted path like 'myapp.api:api'"""
+        try:
+            if ':' not in dotted_path:
+                return None
+            
+            module_path, attr_name = dotted_path.split(':', 1)
+            module = importlib.import_module(module_path)
+            
+            if not hasattr(module, attr_name):
+                return None
+            
+            api = getattr(module, attr_name)
+            
+            # Verify it's a BoltAPI instance
+            if isinstance(api, BoltAPI):
+                return api
+            
+        except (ImportError, AttributeError, ValueError):
+            pass
+        
+        return None
+
+    def merge_apis(self, apis):
+        """Merge multiple BoltAPI instances into one, preserving per-API context.
+
+        Uses Litestar-style approach: each handler maintains reference to its original
+        API instance, allowing it to use that API's logging, auth, and middleware config.
+        """
+        if len(apis) == 1:
+            return apis[0][1]  # Return the single API
+
+        # Create a new merged API without logging (handlers will use their original APIs)
+        merged = BoltAPI(enable_logging=False)
+        route_map = {}  # Track conflicts
+
+        # Map handler_id -> original API instance (preserves per-API context)
+        merged._handler_api_map = {}
+
+        # Track next available handler_id to avoid collisions
+        next_handler_id = 0
+
+        for api_path, api in apis:
+            self.stdout.write(f"[django-bolt] Merging API from {api_path}")
+
+            for method, path, old_handler_id, handler in api._routes:
+                route_key = f"{method} {path}"
+
+                if route_key in route_map:
+                    raise CommandError(
+                        f"Route conflict: {route_key} defined in both "
+                        f"{route_map[route_key]} and {api_path}"
+                    )
+
+                # CRITICAL: Assign NEW unique handler_id to avoid collisions
+                # Each API starts handler_ids at 0, so we must renumber during merge
+                new_handler_id = next_handler_id
+                next_handler_id += 1
+
+                route_map[route_key] = api_path
+                merged._routes.append((method, path, new_handler_id, handler))
+                merged._handlers[new_handler_id] = handler
+
+                # CRITICAL: Store reference to original API for this handler
+                # This preserves logging, auth, middleware, and all per-API config
+                merged._handler_api_map[new_handler_id] = api
+
+                # Merge handler metadata
+                if handler in api._handler_meta:
+                    merged._handler_meta[handler] = api._handler_meta[handler]
+
+                # Merge middleware metadata (use NEW handler_id)
+                if old_handler_id in api._handler_middleware:
+                    merged._handler_middleware[new_handler_id] = api._handler_middleware[old_handler_id]
+
+        # Update next handler ID
+        merged._next_handler_id = next_handler_id
+
+        return merged

django_bolt/middleware/__init__.py

@@ -0,0 +1,32 @@
+"""
+Django-Bolt Middleware System.
+
+Provides decorators and classes for adding middleware to routes.
+Middleware can be global or per-route.
+"""
+
+from .middleware import (
+    Middleware,
+    MiddlewareGroup,
+    MiddlewareConfig,
+    middleware,
+    rate_limit,
+    cors,
+    skip_middleware,
+    no_compress,
+    CORSMiddleware,
+    RateLimitMiddleware,
+)
+
+__all__ = [
+    "Middleware",
+    "MiddlewareGroup",
+    "MiddlewareConfig",
+    "middleware",
+    "rate_limit",
+    "cors",
+    "skip_middleware",
+    "no_compress",
+    "CORSMiddleware",
+    "RateLimitMiddleware",
+]

django_bolt/middleware/compiler.py

@@ -0,0 +1,131 @@
+"""Middleware compilation utilities."""
+from typing import Any, Callable, Dict, List, Optional, Set
+from ..auth.backends import get_default_authentication_classes
+from ..auth.guards import get_default_permission_classes
+
+
+def compile_middleware_meta(
+    handler: Callable,
+    method: str,
+    path: str,
+    global_middleware: List[Any],
+    global_middleware_config: Dict[str, Any],
+    guards: Optional[List[Any]] = None,
+    auth: Optional[List[Any]] = None
+) -> Optional[Dict[str, Any]]:
+    """Compile middleware metadata for a handler, including guards and auth."""
+    # Check for handler-specific middleware
+    handler_middleware = []
+    skip_middleware: Set[str] = set()
+
+    if hasattr(handler, '__bolt_middleware__'):
+        handler_middleware = handler.__bolt_middleware__
+
+    if hasattr(handler, '__bolt_skip_middleware__'):
+        skip_middleware = handler.__bolt_skip_middleware__
+
+    # Merge global and handler middleware
+    all_middleware = []
+
+    # Add global middleware first
+    for mw in global_middleware:
+        mw_dict = middleware_to_dict(mw)
+        if mw_dict and mw_dict.get('type') not in skip_middleware:
+            all_middleware.append(mw_dict)
+
+    # Add global config-based middleware
+    if global_middleware_config:
+        for mw_type, config in global_middleware_config.items():
+            if mw_type not in skip_middleware:
+                mw_dict = {'type': mw_type}
+                mw_dict.update(config)
+                all_middleware.append(mw_dict)
+
+    # Add handler-specific middleware
+    for mw in handler_middleware:
+        mw_dict = middleware_to_dict(mw)
+        if mw_dict:
+            all_middleware.append(mw_dict)
+
+    # Compile authentication backends
+    auth_backends = []
+    if auth is not None:
+        # Per-route auth override
+        for auth_backend in auth:
+            if hasattr(auth_backend, 'to_metadata'):
+                auth_backends.append(auth_backend.to_metadata())
+    else:
+        # Use global default authentication classes
+        for auth_backend in get_default_authentication_classes():
+            if hasattr(auth_backend, 'to_metadata'):
+                auth_backends.append(auth_backend.to_metadata())
+
+    # Compile guards/permissions
+    guard_list = []
+    if guards is not None:
+        # Per-route guards override
+        for guard in guards:
+            # Check if it's an instance with to_metadata method
+            if hasattr(guard, 'to_metadata') and callable(getattr(guard, 'to_metadata', None)):
+                try:
+                    # Try calling as instance method
+                    guard_list.append(guard.to_metadata())
+                except TypeError:
+                    # If it fails, might be a class, try instantiating
+                    try:
+                        instance = guard()
+                        guard_list.append(instance.to_metadata())
+                    except Exception:
+                        pass
+            elif isinstance(guard, type):
+                # It's a class reference, instantiate it
+                try:
+                    instance = guard()
+                    if hasattr(instance, 'to_metadata'):
+                        guard_list.append(instance.to_metadata())
+                except Exception:
+                    pass
+    else:
+        # Use global default permission classes
+        for guard in get_default_permission_classes():
+            if hasattr(guard, 'to_metadata'):
+                guard_list.append(guard.to_metadata())
+
+    # Only include metadata if something is configured
+    # Note: include result even when only skip flags are present so Rust can
+    #       honor route-level skips like `compression`.
+    if not all_middleware and not auth_backends and not guard_list and not skip_middleware:
+        return None
+
+    result = {
+        'method': method,
+        'path': path
+    }
+
+    if all_middleware:
+        result['middleware'] = all_middleware
+
+    # Always include skip flags if present (even without middleware/auth/guards)
+    if skip_middleware:
+        result['skip'] = list(skip_middleware)
+
+    if auth_backends:
+        result['auth_backends'] = auth_backends
+
+    if guard_list:
+        result['guards'] = guard_list
+
+    return result
+
+
+def middleware_to_dict(mw: Any) -> Optional[Dict[str, Any]]:
+    """Convert middleware specification to dictionary."""
+    if isinstance(mw, dict):
+        return mw
+    elif hasattr(mw, '__dict__'):
+        # Convert middleware object to dict
+        return {
+            'type': mw.__class__.__name__.lower().replace('middleware', ''),
+            **mw.__dict__
+        }
+    return None