mirror of
https://github.com/bytedance/deer-flow.git
synced 2026-09-18 18:46:17 +00:00
4f192cb469
* fix: align sandbox artifact mounts with channel user * fix: clean up sandbox user-scoped ids
122 lines
4.0 KiB
Python
122 lines
4.0 KiB
Python
import asyncio
|
|
from abc import ABC, abstractmethod
|
|
|
|
from deerflow.config import get_app_config
|
|
from deerflow.reflection import resolve_class
|
|
from deerflow.sandbox.sandbox import Sandbox
|
|
|
|
|
|
class SandboxProvider(ABC):
|
|
"""Abstract base class for sandbox providers"""
|
|
|
|
uses_thread_data_mounts: bool = False
|
|
needs_upload_permission_adjustment: bool = True
|
|
|
|
@abstractmethod
|
|
def acquire(self, thread_id: str | None = None, *, user_id: str | None = None) -> str:
|
|
"""Acquire a sandbox environment and return its ID.
|
|
|
|
Returns:
|
|
The ID of the acquired sandbox environment.
|
|
"""
|
|
pass
|
|
|
|
async def acquire_async(self, thread_id: str | None = None, *, user_id: str | None = None) -> str:
|
|
"""Acquire a sandbox without blocking the event loop.
|
|
|
|
Most sandbox providers expose a synchronous lifecycle API because local
|
|
Docker/provisioner operations are blocking. Async runtimes should call
|
|
this method so those blocking operations run in a worker thread instead
|
|
of stalling the event loop.
|
|
"""
|
|
return await asyncio.to_thread(self.acquire, thread_id, user_id=user_id)
|
|
|
|
@abstractmethod
|
|
def get(self, sandbox_id: str) -> Sandbox | None:
|
|
"""Get a sandbox environment by ID.
|
|
|
|
Args:
|
|
sandbox_id: The ID of the sandbox environment to retain.
|
|
"""
|
|
pass
|
|
|
|
@abstractmethod
|
|
def release(self, sandbox_id: str) -> None:
|
|
"""Release a sandbox environment.
|
|
|
|
Args:
|
|
sandbox_id: The ID of the sandbox environment to destroy.
|
|
"""
|
|
pass
|
|
|
|
def reset(self) -> None:
|
|
"""Clear cached state that survives provider instance replacement."""
|
|
pass
|
|
|
|
|
|
_default_sandbox_provider: SandboxProvider | None = None
|
|
|
|
|
|
def get_sandbox_provider(**kwargs) -> SandboxProvider:
|
|
"""Get the sandbox provider singleton.
|
|
|
|
Returns a cached singleton instance. Use `reset_sandbox_provider()` to clear
|
|
the cache, or `shutdown_sandbox_provider()` to properly shutdown and clear.
|
|
|
|
Returns:
|
|
A sandbox provider instance.
|
|
"""
|
|
global _default_sandbox_provider
|
|
if _default_sandbox_provider is None:
|
|
config = get_app_config()
|
|
cls = resolve_class(config.sandbox.use, SandboxProvider)
|
|
_default_sandbox_provider = cls(**kwargs)
|
|
return _default_sandbox_provider
|
|
|
|
|
|
def reset_sandbox_provider() -> None:
|
|
"""Reset the sandbox provider singleton.
|
|
|
|
This clears the cached instance without calling shutdown.
|
|
The next call to `get_sandbox_provider()` will create a new instance.
|
|
Useful for testing or when switching configurations.
|
|
|
|
Providers can override `reset()` to clear any module-level state they keep
|
|
alive across instances (for example, `LocalSandboxProvider`'s cached
|
|
`LocalSandbox` singleton). Without it, config/mount changes would not take
|
|
effect on the next acquire().
|
|
|
|
Note: If the provider has active sandboxes, they will be orphaned.
|
|
Use `shutdown_sandbox_provider()` for proper cleanup.
|
|
"""
|
|
global _default_sandbox_provider
|
|
if _default_sandbox_provider is not None:
|
|
_default_sandbox_provider.reset()
|
|
_default_sandbox_provider = None
|
|
|
|
|
|
def shutdown_sandbox_provider() -> None:
|
|
"""Shutdown and reset the sandbox provider.
|
|
|
|
This properly shuts down the provider (releasing all sandboxes)
|
|
before clearing the singleton. Call this when the application
|
|
is shutting down or when you need to completely reset the sandbox system.
|
|
"""
|
|
global _default_sandbox_provider
|
|
if _default_sandbox_provider is not None:
|
|
if hasattr(_default_sandbox_provider, "shutdown"):
|
|
_default_sandbox_provider.shutdown()
|
|
_default_sandbox_provider = None
|
|
|
|
|
|
def set_sandbox_provider(provider: SandboxProvider) -> None:
|
|
"""Set a custom sandbox provider instance.
|
|
|
|
This allows injecting a custom or mock provider for testing purposes.
|
|
|
|
Args:
|
|
provider: The SandboxProvider instance to use.
|
|
"""
|
|
global _default_sandbox_provider
|
|
_default_sandbox_provider = provider
|