feat: Server client vs. codebase client

Author: caroljung-cg

src/codegen/runner/clients/codebase_client.py

@@ -0,0 +1,36 @@
+"""Client used to abstract the weird stdin/stdout communication we have with the sandbox"""
+
+import logging
+
+from codegen.git.schemas.repo_config import RepoConfig
+from codegen.runner.clients.server_client import LocalServerClient
+from codegen.runner.models.apis import SANDBOX_SERVER_PORT
+
+logger = logging.getLogger(__name__)
+
+RUNNER_SERVER_PATH = "codegen.runner.sandbox.server:app"
+
+
+class CodebaseClient(LocalServerClient):
+    """Client for interacting with the locally hosted sandbox server."""
+
+    repo_config: RepoConfig
+    git_access_token: str | None
+
+    def __init__(self, repo_config: RepoConfig, git_access_token: str | None, host: str = "127.0.0.1", port: int = SANDBOX_SERVER_PORT):
+        self.repo_config = repo_config
+        self.git_access_token = git_access_token
+        super().__init__(server_path=RUNNER_SERVER_PATH, host=host, port=port)
+
+    def _get_envs(self):
+        envs = super()._get_envs()
+        envs.update(
+            {
+                "CODEGEN_REPOSITORY__REPO_PATH": self.repo_config.repo_path,
+                "CODEGEN_REPOSITORY__REPO_NAME": self.repo_config.name,
+                "CODEGEN_REPOSITORY__FULL_NAME": self.repo_config.full_name,
+                "CODEGEN_REPOSITORY__LANGUAGE": self.repo_config.language.value,
+                "CODEGEN_SECRETS__GITHUB_TOKEN": self.git_access_token,
+            }
+        )
+        return envs

src/codegen/runner/clients/sandbox_client.py renamed to src/codegen/runner/clients/server_client.py

@@ -8,71 +8,73 @@
 import requests
 from fastapi import params
 
-from codegen.git.schemas.repo_config import RepoConfig
-from codegen.runner.models.apis import SANDBOX_SERVER_PORT
-
 logger = logging.getLogger(__name__)
 
+DEFAULT_SERVER_PORT = 4002
+
+EPHEMERAL_SERVER_PATH = "codegen.runner.sandbox.ephemeral_server:app"
 
-class SandboxClient:
-    """Client for interacting with the locally hosted sandbox server."""
+
+class LocalServerClient:
+    """Client for interacting with the sandbox server."""
 
     host: str
     port: int
     base_url: str
     _process: subprocess.Popen | None
 
-    def __init__(self, repo_config: RepoConfig, git_access_token: str | None, host: str = "127.0.0.1", port: int = SANDBOX_SERVER_PORT):
+    def __init__(self, server_path: str = EPHEMERAL_SERVER_PATH, host: str = "127.0.0.1", port: int = DEFAULT_SERVER_PORT):
         self.host = host
         self.port = port
         self.base_url = f"http://{host}:{port}"
         self._process = None
-        self._start_server(repo_config, git_access_token)
+        self._start_server(server_path)
+
+    def __del__(self):
+        """Cleanup the subprocess when the client is destroyed"""
+        if self._process is not None:
+            self._process.terminate()
+            self._process.wait()
+
+    def _get_envs(self):
+        return os.environ.copy()
 
-    def _start_server(self, repo_config: RepoConfig, git_access_token: str | None) -> None:
+    def _start_server(self, server_path: str) -> None:
         """Start the FastAPI server in a subprocess"""
-        env = os.environ.copy()
-        env.update(
-            {
-                "CODEGEN_REPOSITORY__REPO_PATH": repo_config.repo_path,
-                "CODEGEN_REPOSITORY__REPO_NAME": repo_config.name,
-                "CODEGEN_REPOSITORY__FULL_NAME": repo_config.full_name,
-                "CODEGEN_REPOSITORY__LANGUAGE": repo_config.language.value,
-                "CODEGEN_SECRETS__GITHUB_TOKEN": git_access_token,
-            }
-        )
+        envs = self._get_envs()
+        logger.info(f"Starting local server on {self.base_url} with envvars: {envs}")
 
-        logger.info(f"Starting local sandbox server on {self.base_url} with repo setup in base_dir {repo_config.base_dir}")
         self._process = subprocess.Popen(
             [
                 "uvicorn",
-                "codegen.runner.sandbox.server:app",
+                server_path,
                 "--host",
                 self.host,
                 "--port",
                 str(self.port),
             ],
-            env=env,
+            env=envs,
         )
         self._wait_for_server()
 
     def _wait_for_server(self, timeout: int = 60, interval: float = 0.1) -> None:
         """Wait for the server to start by polling the health endpoint"""
         start_time = time.time()
         while (time.time() - start_time) < timeout:
-            try:
-                self.get("/")
+            if self.healthcheck(raise_on_error=False):
                 return
-            except requests.ConnectionError:
-                time.sleep(interval)
+            time.sleep(interval)
         msg = "Server failed to start within timeout period"
         raise TimeoutError(msg)
 
-    def __del__(self):
-        """Cleanup the subprocess when the client is destroyed"""
-        if self._process is not None:
-            self._process.terminate()
-            self._process.wait()
+    def healthcheck(self, raise_on_error: bool = True) -> bool:
+        try:
+            self.get("/")
+            return True
+        except requests.exceptions.ConnectionError:
+            if raise_on_error:
+                raise
+            return False
 
     def get(self, endpoint: str, data: dict | None = None) -> requests.Response:
         url = f"{self.base_url}{endpoint}"

tests/integration/codegen/runner/conftest.py

@@ -8,7 +8,7 @@
 from codegen.git.clients.git_repo_client import GitRepoClient
 from codegen.git.repo_operator.remote_repo_operator import RemoteRepoOperator
 from codegen.git.schemas.repo_config import RepoConfig
-from codegen.runner.clients.sandbox_client import SandboxClient
+from codegen.runner.clients.codebase_client import CodebaseClient
 from codegen.shared.configs.session_configs import config
 from codegen.shared.enums.programming_language import ProgrammingLanguage
 
@@ -45,7 +45,7 @@ def git_repo_client(repo_config: RepoConfig) -> Generator[GitRepoClient, None, N
 
 
 @pytest.fixture
-def sandbox_client(repo_config: RepoConfig, get_free_port) -> Generator[SandboxClient, None, None]:
-    sb_client = SandboxClient(repo_config=repo_config, port=get_free_port, git_access_token=config.secrets.github_token)
+def codebase_client(repo_config: RepoConfig, get_free_port) -> Generator[CodebaseClient, None, None]:
+    sb_client = CodebaseClient(repo_config=repo_config, port=get_free_port, git_access_token=config.secrets.github_token)
     sb_client.runner = Mock()
     yield sb_client

tests/integration/codegen/runner/test_create_branch.py

@@ -5,14 +5,14 @@
 
 from codegen.git.clients.git_repo_client import GitRepoClient
 from codegen.git.repo_operator.remote_repo_operator import RemoteRepoOperator
-from codegen.runner.clients.sandbox_client import SandboxClient
+from codegen.runner.clients.codebase_client import CodebaseClient
 from codegen.runner.models.apis import BRANCH_ENDPOINT, CreateBranchRequest, CreateBranchResponse
 from codegen.runner.models.codemod import BranchConfig, Codemod, GroupingConfig
 
 
 @pytest.mark.asyncio
 @pytest.mark.timeout(60)
-async def test_create_branch(sandbox_client: SandboxClient, git_repo_client: GitRepoClient, op: RemoteRepoOperator):
+async def test_create_branch(codebase_client: CodebaseClient, git_repo_client: GitRepoClient, op: RemoteRepoOperator):
     # set-up
     codemod_source = """
 for file in codebase.files:
@@ -29,7 +29,7 @@ async def test_create_branch(sandbox_client: SandboxClient, git_repo_client: Git
     )
 
     # execute
-    response = sandbox_client.post(endpoint=BRANCH_ENDPOINT, data=request.model_dump())
+    response = codebase_client.post(endpoint=BRANCH_ENDPOINT, data=request.model_dump())
     assert response.status_code == HTTPStatus.OK
 
     # verify

tests/integration/codegen/runner/test_create_branch_with_grouping.py

@@ -5,15 +5,15 @@
 
 from codegen.git.clients.git_repo_client import GitRepoClient
 from codegen.git.repo_operator.remote_repo_operator import RemoteRepoOperator
-from codegen.runner.clients.sandbox_client import SandboxClient
+from codegen.runner.clients.codebase_client import CodebaseClient
 from codegen.runner.models.apis import BRANCH_ENDPOINT, CreateBranchRequest, CreateBranchResponse
 from codegen.runner.models.codemod import BranchConfig, Codemod, GroupingConfig
 from codegen.sdk.codebase.flagging.groupers.enums import GroupBy
 
 
 @pytest.mark.timeout(120)
 @pytest.mark.parametrize("group_by", [GroupBy.INSTANCE, GroupBy.FILE])
-def test_create_branch_with_grouping(sandbox_client: SandboxClient, git_repo_client: GitRepoClient, op: RemoteRepoOperator, group_by: GroupBy):
+def test_create_branch_with_grouping(codebase_client: CodebaseClient, git_repo_client: GitRepoClient, op: RemoteRepoOperator, group_by: GroupBy):
     codemod_source = """
 for file in codebase.files[:5]:
     flag = codebase.flag_instance(file)
@@ -31,7 +31,7 @@ def test_create_branch_with_grouping(sandbox_client: SandboxClient, git_repo_cli
     )
 
     # execute
-    response = sandbox_client.post(endpoint=BRANCH_ENDPOINT, data=request.model_dump())
+    response = codebase_client.post(endpoint=BRANCH_ENDPOINT, data=request.model_dump())
     assert response.status_code == HTTPStatus.OK
 
     # verify