Class ScipIndexer

src/codegraphcontext/tools/scip_indexer.py:158–477

Handles running the external SCIP indexer binaries. Takes a project path and language, runs the appropriate CLI, and returns the path to the resulting index.scip file.

class ScipIndexer:
    """
    Handles running the external SCIP indexer binaries.
    Takes a project path and language, runs the appropriate CLI, and
    returns the path to the resulting index.scip file.
    """

    def run(self, project_path: Path, lang: str, output_dir: Path) -> Optional[Path]:
        """
        Run the SCIP indexer for `lang` on `project_path`.
        Returns path to index.scip, or None if the indexer failed / is not installed.
        """
        binary, expected_binary, install_hint, docker_image = self._get_binary(lang)
        output_file = output_dir / "index.scip"
        
        if binary:
            cmd = self._build_command(lang, binary, project_path, output_file, scratch_dir=output_dir)
            if not cmd:
                warning_logger(f"No SCIP command template defined for language: {lang}")
                return None

            info_logger(f"Running local SCIP indexer: {' '.join(str(c) for c in cmd)}")
            try:
                result = subprocess.run(
                    cmd,
                    cwd=str(project_path),
                    capture_output=True,
                    text=True,
                    timeout=_resolve_scip_timeout(),
                )
                if result.returncode == 0 and output_file.exists():
                    info_logger(f"SCIP index written to {output_file}")
                    return output_file
                warning_logger(f"Local SCIP indexer failed (code {result.returncode}). stderr: {result.stderr[:500]}")
            except Exception as e:
                warning_logger(f"Local SCIP indexer failed: {e}")

        # Fallback to Docker
        if docker_image and shutil.which("docker"):
            info_logger(f"Attempting SCIP indexing via Docker ({docker_image})...")
            try:
                # 1. Pre-run: for Go we often need 'go mod tidy'
                if lang == "go":
                    info_logger("Running 'go mod tidy' inside container first...")
                    subprocess.run(
                        ["docker", "run", "--rm", "-v", f"{project_path.resolve()}:/src", "-w", "/src", docker_image, "go", "mod", "tidy"],
                        capture_output=True, timeout=120
                    )

                # 2. Run indexer
                docker_cmd = [
                    "docker", "run", "--rm",
                    "-v", f"{project_path.resolve()}:/src",
                    "-v", f"{output_dir.resolve()}:/out",
                    "-w", "/src",
                    docker_image,
                ]