Skip to content

:hedgehog: PostHog is the leading platform for building self-driving products. Our developer tools – AI observability, analytics, session replay, flags, experiments, error tracking, logs, and more – capture all the context agents need to diagnose problems, uncover opportunities, and ship fixes. Steer it all from Slack, web, desktop, or the MCP.

6.9 KB
Raw Blame
from dataclasses import field

from products.warehouse_sources.sources.sdk import DependentEndpointConfig, IncrementalField, frozen

# CodeScene's list endpoints take a generic `filter` expression but no server-side timestamp
# filter, so every endpoint here is full refresh only.
INCREMENTAL_FIELDS: dict[str, list[IncrementalField]] = {}


@frozen
class CodesceneEndpointConfig:
    name: str
    path: str
    # Key holding the row array in the response body (e.g. `{"projects": [...], "max_pages": 3}`).
    # `None` for an endpoint that returns a bare array with no envelope.
    data_selector: str | None
    primary_key: str | list[str] = "id"
    page_size: int = 100
    # The endpoints differ in what they page on: most take `page` + `page_size` and report
    # `max_pages`, `analyses` and `delta-analyses` page on `page` alone, and `author-statistics`,
    # `branch-statistics` and `commit-activity` return the whole collection in a single
    # unpaginated response.
    paginated: bool = True
    page_size_param: str | None = "page_size"
    fanout: DependentEndpointConfig | None = None
    # No endpoint here has a documented server-side timestamp filter, so every stream is full
    # refresh; these stay empty but satisfy the fan-out helper's endpoint protocol.
    incremental_fields: list[IncrementalField] = field(default_factory=list)
    default_incremental_field: str | None = None


CODESCENE_ENDPOINTS: dict[str, CodesceneEndpointConfig] = {
    "Projects": CodesceneEndpointConfig(
        name="Projects",
        path="/projects",
        data_selector="projects",
        primary_key="id",
    ),
    "Files": CodesceneEndpointConfig(
        name="Files",
        path="/projects/{project_id}/analyses/latest/files",
        data_selector="files",
        primary_key=["project_id", "name"],
        fanout=DependentEndpointConfig(
            parent_name="Projects",
            resolve_param="project_id",
            resolve_field="id",
            include_from_parent=["id"],
            parent_field_renames={"id": "project_id"},
        ),
    ),
    "Components": CodesceneEndpointConfig(
        name="Components",
        path="/projects/{project_id}/analyses/latest/components",
        data_selector="components",
        primary_key=["project_id", "name"],
        fanout=DependentEndpointConfig(
            parent_name="Projects",
            resolve_param="project_id",
            resolve_field="id",
            include_from_parent=["id"],
            parent_field_renames={"id": "project_id"},
        ),
    ),
    "Analyses": CodesceneEndpointConfig(
        name="Analyses",
        path="/projects/{project_id}/analyses",
        data_selector="analyses",
        primary_key=["project_id", "id"],
        page_size_param=None,
        fanout=DependentEndpointConfig(
            parent_name="Projects",
            resolve_param="project_id",
            resolve_field="id",
            include_from_parent=["id"],
            parent_field_renames={"id": "project_id"},
        ),
    ),
    "Issues": CodesceneEndpointConfig(
        name="Issues",
        path="/projects/{project_id}/analyses/latest/issues",
        data_selector="issues",
        primary_key=["project_id", "id"],
        page_size=200,
        fanout=DependentEndpointConfig(
            parent_name="Projects",
            resolve_param="project_id",
            resolve_field="id",
            include_from_parent=["id"],
            parent_field_renames={"id": "project_id"},
        ),
    ),
    "TechnicalDebt": CodesceneEndpointConfig(
        name="TechnicalDebt",
        path="/projects/{project_id}/analyses/latest/technical-debt",
        data_selector="result",
        primary_key=["project_id", "file_name"],
        page_size=200,
        fanout=DependentEndpointConfig(
            parent_name="Projects",
            resolve_param="project_id",
            resolve_field="id",
            include_from_parent=["id"],
            parent_field_renames={"id": "project_id"},
            # Without this the endpoint returns the friction summary rather than the
            # per-file refactoring targets.
            child_params={"refactoring_targets": "true"},
        ),
    ),
    "AuthorStatistics": CodesceneEndpointConfig(
        name="AuthorStatistics",
        path="/projects/{project_id}/analyses/latest/author-statistics",
        data_selector=None,
        primary_key=["project_id", "author"],
        paginated=False,
        page_size_param=None,
        fanout=DependentEndpointConfig(
            parent_name="Projects",
            resolve_param="project_id",
            resolve_field="id",
            include_from_parent=["id"],
            parent_field_renames={"id": "project_id"},
        ),
    ),
    "Commits": CodesceneEndpointConfig(
        name="Commits",
        path="/projects/{project_id}/analyses/latest/commits",
        data_selector="commits",
        # A project can span several repositories, so a commit hash is only unique per repository.
        primary_key=["project_id", "repository", "rev"],
        page_size=200,
        fanout=DependentEndpointConfig(
            parent_name="Projects",
            resolve_param="project_id",
            resolve_field="id",
            include_from_parent=["id"],
            parent_field_renames={"id": "project_id"},
        ),
    ),
    "CommitActivity": CodesceneEndpointConfig(
        name="CommitActivity",
        path="/projects/{project_id}/analyses/latest/commit-activity",
        data_selector="commit_activity_trend",
        primary_key=["project_id", "date"],
        paginated=False,
        page_size_param=None,
        fanout=DependentEndpointConfig(
            parent_name="Projects",
            resolve_param="project_id",
            resolve_field="id",
            include_from_parent=["id"],
            parent_field_renames={"id": "project_id"},
        ),
    ),
    "BranchStatistics": CodesceneEndpointConfig(
        name="BranchStatistics",
        path="/projects/{project_id}/analyses/latest/branch-statistics",
        data_selector=None,
        primary_key=["project_id", "repository_name", "branch"],
        paginated=False,
        page_size_param=None,
        fanout=DependentEndpointConfig(
            parent_name="Projects",
            resolve_param="project_id",
            resolve_field="id",
            include_from_parent=["id"],
            parent_field_renames={"id": "project_id"},
        ),
    ),
    "DeltaAnalyses": CodesceneEndpointConfig(
        name="DeltaAnalyses",
        path="/projects/{project_id}/delta-analyses",
        data_selector="delta_analyses",
        primary_key=["project_id", "id"],
        page_size_param=None,
        fanout=DependentEndpointConfig(
            parent_name="Projects",
            resolve_param="project_id",
            resolve_field="id",
            include_from_parent=["id"],
            parent_field_renames={"id": "project_id"},
        ),
    ),
}

ENDPOINTS = tuple(CODESCENE_ENDPOINTS)