loopix-sdk 2.30.0__py3-none-any.whl

loopix/sandbox_sync/commands/command.py

@@ -0,0 +1,420 @@
+import threading
+from typing import Callable, Dict, List, Literal, Optional, Union, overload
+
+import loopix_connect
+import httpx
+from packaging.version import Version
+from loopix.api import make_logging_event_hooks
+from loopix.api.client_sync import get_envd_transport
+from loopix.connection_config import (
+    ConnectionConfig,
+    Username,
+    KEEPALIVE_PING_HEADER,
+    KEEPALIVE_PING_INTERVAL_SEC,
+)
+from loopix.envd.process import process_connect, process_pb2
+from loopix.envd.api import check_sandbox_health
+from loopix.envd.rpc import authentication_header, handle_rpc_exception_with_health
+from loopix.envd.versions import ENVD_COMMANDS_STDIN, ENVD_ENVD_CLOSE
+from loopix.exceptions import SandboxException
+from loopix.sandbox.commands.main import ProcessInfo
+from loopix.sandbox.commands.command_handle import CommandResult
+from loopix.sandbox_sync.commands.command_handle import CommandHandle
+
+
+class Commands:
+    """
+    Module for executing commands in the sandbox.
+    """
+
+    def __init__(
+        self,
+        envd_api_url: str,
+        connection_config: ConnectionConfig,
+        envd_version: Version,
+    ) -> None:
+        self._envd_api_url = envd_api_url
+        self._connection_config = connection_config
+        self._envd_version = envd_version
+        self._thread_local = threading.local()
+
+    def _create_envd_api(self) -> httpx.Client:
+        transport = get_envd_transport(self._connection_config)
+        return httpx.Client(
+            base_url=self._envd_api_url,
+            transport=transport,
+            headers=self._connection_config.sandbox_headers,
+            event_hooks=make_logging_event_hooks(self._connection_config.logger),
+        )
+
+    def _create_rpc(self) -> process_connect.ProcessClient:
+        transport = get_envd_transport(self._connection_config)
+        return process_connect.ProcessClient(
+            self._envd_api_url,
+            # TODO: Fix and enable compression again — the headers compression is not solved for streaming.
+            # compressor=loopix_connect.GzipCompressor,
+            pool=transport.pool,
+            json=True,
+            headers=self._connection_config.sandbox_headers,
+            logger=self._connection_config.logger,
+        )
+
+    @property
+    def _envd_api(self) -> httpx.Client:
+        envd_api = getattr(self._thread_local, "envd_api", None)
+        if envd_api is None:
+            envd_api = self._create_envd_api()
+            self._thread_local.envd_api = envd_api
+        return envd_api
+
+    @property
+    def _rpc(self) -> process_connect.ProcessClient:
+        rpc = getattr(self._thread_local, "rpc", None)
+        if rpc is None:
+            rpc = self._create_rpc()
+            self._thread_local.rpc = rpc
+        return rpc
+
+    def _check_health(self) -> Optional[bool]:
+        return check_sandbox_health(self._envd_api)
+
+    def list(
+        self,
+        request_timeout: Optional[float] = None,
+    ) -> List[ProcessInfo]:
+        """
+        Lists all running commands and PTY sessions.
+
+        :param request_timeout: Timeout for the request in **seconds**
+
+        :return: List of running commands and PTY sessions
+        """
+        try:
+            res = self._rpc.list(
+                process_pb2.ListRequest(),
+                request_timeout=self._connection_config.get_request_timeout(
+                    request_timeout
+                ),
+            )
+            return [
+                ProcessInfo(
+                    pid=p.pid,
+                    tag=p.tag if p.HasField("tag") else None,
+                    cmd=p.config.cmd,
+                    args=list(p.config.args),
+                    envs=dict(p.config.envs),
+                    cwd=p.config.cwd if p.config.HasField("cwd") else None,
+                )
+                for p in res.processes
+            ]
+        except Exception as e:
+            raise handle_rpc_exception_with_health(e, self._check_health)
+
+    def kill(
+        self,
+        pid: int,
+        request_timeout: Optional[float] = None,
+    ) -> bool:
+        """
+        Kill a running command specified by its process ID.
+        It uses `SIGKILL` signal to kill the command.
+
+        :param pid: Process ID of the command. You can get the list of processes using `sandbox.commands.list()`
+        :param request_timeout: Timeout for the request in **seconds**
+
+        :return: `True` if the command was killed, `False` if the command was not found
+        """
+        try:
+            self._rpc.send_signal(
+                process_pb2.SendSignalRequest(
+                    process=process_pb2.ProcessSelector(pid=pid),
+                    signal=process_pb2.Signal.SIGNAL_SIGKILL,
+                ),
+                request_timeout=self._connection_config.get_request_timeout(
+                    request_timeout
+                ),
+            )
+            return True
+        except Exception as e:
+            if isinstance(e, loopix_connect.ConnectException):
+                if e.status == loopix_connect.Code.not_found:
+                    return False
+            raise handle_rpc_exception_with_health(e, self._check_health)
+
+    def send_stdin(
+        self,
+        pid: int,
+        data: Union[str, bytes],
+        request_timeout: Optional[float] = None,
+    ):
+        """
+        Send data to command stdin.
+
+        :param pid Process ID of the command. You can get the list of processes using `sandbox.commands.list()`.
+        :param data: Data to send to the command
+        :param request_timeout: Timeout for the request in **seconds**
+        """
+        try:
+            self._rpc.send_input(
+                process_pb2.SendInputRequest(
+                    process=process_pb2.ProcessSelector(pid=pid),
+                    input=process_pb2.ProcessInput(
+                        stdin=data.encode() if isinstance(data, str) else data,
+                    ),
+                ),
+                request_timeout=self._connection_config.get_request_timeout(
+                    request_timeout
+                ),
+            )
+        except Exception as e:
+            raise handle_rpc_exception_with_health(e, self._check_health)
+
+    def close_stdin(
+        self,
+        pid: int,
+        request_timeout: Optional[float] = None,
+    ) -> None:
+        """
+        Close the command stdin.
+
+        This signals EOF to the command. The command must have been started with `stdin=True`.
+
+        :param pid Process ID of the command. You can get the list of processes using `sandbox.commands.list()`.
+        :param request_timeout: Timeout for the request in **seconds**
+        """
+        if self._envd_version < ENVD_ENVD_CLOSE:
+            raise SandboxException(
+                f"Sandbox envd version {self._envd_version} doesn't support closing stdin. "
+                f"Please rebuild your template to pick up the latest sandbox version."
+            )
+
+        try:
+            self._rpc.close_stdin(
+                process_pb2.CloseStdinRequest(
+                    process=process_pb2.ProcessSelector(pid=pid),
+                ),
+                request_timeout=self._connection_config.get_request_timeout(
+                    request_timeout
+                ),
+            )
+        except Exception as e:
+            raise handle_rpc_exception_with_health(e, self._check_health)
+
+    @overload
+    def run(
+        self,
+        cmd: str,
+        background: Union[Literal[False], None] = None,
+        envs: Optional[Dict[str, str]] = None,
+        user: Optional[Username] = None,
+        cwd: Optional[str] = None,
+        on_stdout: Optional[Callable[[str], None]] = None,
+        on_stderr: Optional[Callable[[str], None]] = None,
+        stdin: Optional[bool] = None,
+        timeout: Optional[float] = 60,
+        request_timeout: Optional[float] = None,
+    ) -> CommandResult:
+        """
+        Start a new command and wait until it finishes executing.
+
+        :param cmd: Command to execute
+        :param background: **`False` if the command should be executed in the foreground**, `True` if the command should be executed in the background
+        :param envs: Environment variables used for the command
+        :param user: User to run the command as
+        :param cwd: Working directory to run the command
+        :param on_stdout: Callback for command stdout output
+        :param on_stderr: Callback for command stderr output
+        :param stdin: If `True`, the command will have a stdin stream that you can send data to using `sandbox.commands.send_stdin()`
+        :param timeout: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time
+        :param request_timeout: Timeout for the request in **seconds**
+
+        :return: `CommandResult` result of the command execution
+        """
+        ...
+
+    @overload
+    def run(
+        self,
+        cmd: str,
+        background: Literal[True],
+        envs: Optional[Dict[str, str]] = None,
+        user: Optional[Username] = None,
+        cwd: Optional[str] = None,
+        on_stdout: None = None,
+        on_stderr: None = None,
+        stdin: Optional[bool] = None,
+        timeout: Optional[float] = 60,
+        request_timeout: Optional[float] = None,
+    ) -> CommandHandle:
+        """
+        Start a new command and return a handle to interact with it.
+
+        :param cmd: Command to execute
+        :param background: `False` if the command should be executed in the foreground, **`True` if the command should be executed in the background**
+        :param envs: Environment variables used for the command
+        :param user: User to run the command as
+        :param cwd: Working directory to run the command
+        :param stdin: If `True`, the command will have a stdin stream that you can send data to using `sandbox.commands.send_stdin()`
+        :param timeout: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time
+        :param request_timeout: Timeout for the request in **seconds**
+
+        :return: `CommandHandle` handle to interact with the running command
+        """
+        ...
+
+    def run(
+        self,
+        cmd: str,
+        background: Union[bool, None] = None,
+        envs: Optional[Dict[str, str]] = None,
+        user: Optional[Username] = None,
+        cwd: Optional[str] = None,
+        on_stdout: Optional[Callable[[str], None]] = None,
+        on_stderr: Optional[Callable[[str], None]] = None,
+        stdin: Optional[bool] = None,
+        timeout: Optional[float] = 60,
+        request_timeout: Optional[float] = None,
+    ):
+        # Check version for stdin support
+        if stdin is False and self._envd_version < ENVD_COMMANDS_STDIN:
+            raise SandboxException(
+                f"Sandbox envd version {self._envd_version} can't specify stdin, it's always turned on. "
+                f"Please rebuild your template if you need this feature."
+            )
+
+        # Default to `False`
+        stdin = stdin or False
+
+        proc = self._start(
+            cmd,
+            envs,
+            user,
+            cwd,
+            stdin,
+            timeout,
+            request_timeout,
+        )
+
+        return (
+            proc
+            if background
+            else proc.wait(
+                on_stdout=on_stdout,
+                on_stderr=on_stderr,
+            )
+        )
+
+    def _start(
+        self,
+        cmd: str,
+        envs: Optional[Dict[str, str]],
+        user: Optional[Username],
+        cwd: Optional[str],
+        stdin: bool,
+        timeout: Optional[float],
+        request_timeout: Optional[float],
+    ):
+        events = self._rpc.start(
+            process_pb2.StartRequest(
+                process=process_pb2.ProcessConfig(
+                    cmd="/bin/bash",
+                    envs=envs,
+                    args=["-l", "-c", cmd],
+                    cwd=cwd,
+                ),
+                stdin=stdin,
+            ),
+            headers={
+                **authentication_header(self._envd_version, user),
+                KEEPALIVE_PING_HEADER: str(KEEPALIVE_PING_INTERVAL_SEC),
+            },
+            timeout=timeout,
+            request_timeout=self._connection_config.get_request_timeout(
+                request_timeout
+            ),
+        )
+
+        try:
+            start_event = events.__next__()
+
+            if not start_event.HasField("event"):
+                raise SandboxException(
+                    f"Failed to start process: expected start event, got {start_event}"
+                )
+
+            pid = start_event.event.start.pid
+            return CommandHandle(
+                pid=pid,
+                handle_kill=lambda: self.kill(pid),
+                events=events,
+                handle_send_stdin=lambda data, request_timeout=None: self.send_stdin(
+                    pid, data, request_timeout
+                ),
+                handle_close_stdin=lambda request_timeout=None: self.close_stdin(
+                    pid, request_timeout
+                ),
+                check_health=self._check_health,
+            )
+        except Exception as e:
+            try:
+                events.close()
+            except Exception:
+                pass
+            raise handle_rpc_exception_with_health(e, self._check_health)
+
+    def connect(
+        self,
+        pid: int,
+        timeout: Optional[float] = 60,
+        request_timeout: Optional[float] = None,
+    ):
+        """
+        Connects to a running command.
+        You can use `CommandHandle.wait()` to wait for the command to finish and get execution results.
+
+        :param pid: Process ID of the command to connect to. You can get the list of processes using `sandbox.commands.list()`
+        :param timeout: Timeout for the connection in **seconds**. Using `0` will not limit the connection time
+        :param request_timeout: Timeout for the request in **seconds**
+
+        :return: `CommandHandle` handle to interact with the running command
+        """
+        events = self._rpc.connect(
+            process_pb2.ConnectRequest(
+                process=process_pb2.ProcessSelector(pid=pid),
+            ),
+            headers={
+                KEEPALIVE_PING_HEADER: str(KEEPALIVE_PING_INTERVAL_SEC),
+            },
+            timeout=timeout,
+            request_timeout=self._connection_config.get_request_timeout(
+                request_timeout
+            ),
+        )
+
+        try:
+            start_event = events.__next__()
+
+            if not start_event.HasField("event"):
+                raise SandboxException(
+                    f"Failed to connect to process: expected start event, got {start_event}"
+                )
+
+            pid = start_event.event.start.pid
+            return CommandHandle(
+                pid=pid,
+                handle_kill=lambda: self.kill(pid),
+                events=events,
+                handle_send_stdin=lambda data, request_timeout=None: self.send_stdin(
+                    pid, data, request_timeout
+                ),
+                handle_close_stdin=lambda request_timeout=None: self.close_stdin(
+                    pid, request_timeout
+                ),
+                check_health=self._check_health,
+            )
+        except Exception as e:
+            try:
+                events.close()
+            except Exception:
+                pass
+            raise handle_rpc_exception_with_health(e, self._check_health)

loopix/sandbox_sync/commands/command_handle.py

@@ -0,0 +1,239 @@
+import codecs
+
+from typing import Optional, Callable, Any, Generator, List, Union, Tuple
+
+from loopix.envd.rpc import handle_rpc_exception_with_health
+from loopix.envd.process import process_pb2
+from loopix.exceptions import SandboxException
+from loopix.sandbox.commands.command_handle import (
+    CommandExitException,
+    CommandResult,
+    Stderr,
+    Stdout,
+    PtyOutput,
+)
+
+
+class CommandHandle:
+    """
+    Command execution handle.
+
+    It provides methods for waiting for the command to finish, retrieving stdout/stderr, and killing the command.
+    """
+
+    @property
+    def pid(self):
+        """
+        Command process ID.
+        """
+        return self._pid
+
+    def __init__(
+        self,
+        pid: int,
+        handle_kill: Callable[[], bool],
+        events: Generator[
+            Union[process_pb2.StartResponse, process_pb2.ConnectResponse], Any, None
+        ],
+        handle_send_stdin: Optional[
+            Callable[[Union[str, bytes], Optional[float]], None]
+        ] = None,
+        handle_close_stdin: Optional[Callable[[Optional[float]], None]] = None,
+        check_health: Optional[Callable[[], Optional[bool]]] = None,
+    ):
+        self._pid = pid
+        self._handle_kill = handle_kill
+        self._handle_send_stdin = handle_send_stdin
+        self._handle_close_stdin = handle_close_stdin
+        self._check_health = check_health
+        self._events = events
+
+        self._stdout_chunks: List[str] = []
+        self._stderr_chunks: List[str] = []
+
+        self._stdout_decoder = codecs.getincrementaldecoder("utf-8")(errors="replace")
+        self._stderr_decoder = codecs.getincrementaldecoder("utf-8")(errors="replace")
+
+        self._result: Optional[CommandResult] = None
+        self._iteration_exception: Optional[Exception] = None
+
+    def __iter__(self):
+        """
+        Iterate over the command output.
+
+        :return: Generator of command outputs
+        """
+        return self._handle_events()
+
+    def _flush_decoders(
+        self,
+    ) -> List[Union[Tuple[Stdout, None, None], Tuple[None, Stderr, None]]]:
+        """
+        Flush any bytes still buffered in the stream decoders.
+
+        Incomplete trailing UTF-8 sequences are emitted as replacement
+        characters, matching the per-chunk decoding behavior.
+        """
+        events: List[Union[Tuple[Stdout, None, None], Tuple[None, Stderr, None]]] = []
+        out = self._stdout_decoder.decode(b"", final=True)
+        if out:
+            self._stdout_chunks.append(out)
+            events.append((out, None, None))
+        err = self._stderr_decoder.decode(b"", final=True)
+        if err:
+            self._stderr_chunks.append(err)
+            events.append((None, err, None))
+        return events
+
+    def _handle_events(
+        self,
+    ) -> Generator[
+        Union[
+            Tuple[Stdout, None, None],
+            Tuple[None, Stderr, None],
+            Tuple[None, None, PtyOutput],
+        ],
+        None,
+        None,
+    ]:
+        try:
+            for event in self._events:
+                if event.event.HasField("data"):
+                    if event.event.data.stdout:
+                        out = self._stdout_decoder.decode(event.event.data.stdout)
+                        if out:
+                            self._stdout_chunks.append(out)
+                            yield out, None, None
+                    if event.event.data.stderr:
+                        out = self._stderr_decoder.decode(event.event.data.stderr)
+                        if out:
+                            self._stderr_chunks.append(out)
+                            yield None, out, None
+                    if event.event.data.pty:
+                        yield None, None, event.event.data.pty
+                if event.event.HasField("end"):
+                    # Flush trailing decoder bytes into the accumulators and
+                    # record the result before yielding the flushed chunks, so a
+                    # consumer that stops iterating on the first flushed chunk
+                    # still observes the exit code.
+                    flushed = list(self._flush_decoders())
+                    self._result = CommandResult(
+                        stdout="".join(self._stdout_chunks),
+                        stderr="".join(self._stderr_chunks),
+                        exit_code=event.event.end.exit_code,
+                        error=event.event.end.error,
+                    )
+                    yield from flushed
+
+            # If the stream closed without an end event (e.g. disconnect or a
+            # dropped connection), flush any bytes still buffered in the
+            # decoders so incomplete trailing sequences surface as replacement
+            # characters instead of being silently dropped.
+            if self._result is None:
+                yield from self._flush_decoders()
+        except Exception as e:
+            # The stream raised before an end event (e.g. disconnect or RPC
+            # failure). Flush any bytes still buffered in the decoders so
+            # incomplete trailing sequences surface as replacement characters
+            # instead of being silently dropped, then surface the error.
+            yield from self._flush_decoders()
+            raise handle_rpc_exception_with_health(e, self._check_health)
+
+    def disconnect(self) -> None:
+        """
+        Disconnect from the command.
+
+        The command is not killed, but SDK stops receiving events from the command.
+        You can reconnect to the command using `sandbox.commands.connect` method.
+        """
+        self._events.close()
+
+    def wait(
+        self,
+        on_pty: Optional[Callable[[PtyOutput], None]] = None,
+        on_stdout: Optional[Callable[[str], None]] = None,
+        on_stderr: Optional[Callable[[str], None]] = None,
+    ) -> CommandResult:
+        """
+        Wait for the command to finish and returns the result.
+        If the command exits with a non-zero exit code, it throws a `CommandExitException`.
+
+        :param on_pty: Callback for pty output
+        :param on_stdout: Callback for stdout output
+        :param on_stderr: Callback for stderr output
+
+        :return: `CommandResult` result of command execution
+        """
+        try:
+            for stdout, stderr, pty in self:
+                if stdout is not None and on_stdout:
+                    on_stdout(stdout)
+                elif stderr is not None and on_stderr:
+                    on_stderr(stderr)
+                elif pty is not None and on_pty:
+                    on_pty(pty)
+        except StopIteration:
+            pass
+        except Exception as e:
+            self._iteration_exception = handle_rpc_exception_with_health(
+                e, self._check_health
+            )
+
+        if self._iteration_exception:
+            raise self._iteration_exception
+
+        if self._result is None:
+            raise Exception("Command ended without an end event")
+
+        if self._result.exit_code != 0:
+            raise CommandExitException(
+                stdout="".join(self._stdout_chunks),
+                stderr="".join(self._stderr_chunks),
+                exit_code=self._result.exit_code,
+                error=self._result.error,
+            )
+
+        return self._result
+
+    def kill(self) -> bool:
+        """
+        Kills the command.
+
+        It uses `SIGKILL` signal to kill the command.
+
+        :return: Whether the command was killed successfully
+        """
+        return self._handle_kill()
+
+    def send_stdin(
+        self,
+        data: Union[str, bytes],
+        request_timeout: Optional[float] = None,
+    ) -> None:
+        """
+        Send data to the command stdin.
+
+        The command must have been started with `stdin=True`.
+
+        :param data: Data to send to the command
+        :param request_timeout: Timeout for the request in **seconds**
+        """
+        if self._handle_send_stdin is None:
+            raise SandboxException(
+                "Sending stdin is not supported for this command handle."
+            )
+        self._handle_send_stdin(data, request_timeout)
+
+    def close_stdin(self, request_timeout: Optional[float] = None) -> None:
+        """
+        Close the command stdin.
+
+        This signals EOF to the command. The command must have been started with `stdin=True`.
+
+        :param request_timeout: Timeout for the request in **seconds**
+        """
+        if self._handle_close_stdin is None:
+            raise SandboxException(
+                "Closing stdin is not supported for this command handle."
+            )
+        self._handle_close_stdin(request_timeout)