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.

5.5 KB
Raw Blame
from typing import Optional, cast

from products.warehouse_sources.sources.qualaroo._config import QualarooSourceConfig
from products.warehouse_sources.sources.qualaroo.qualaroo import (
    QualarooResumeConfig,
    qualaroo_source,
    validate_credentials as _validate_qualaroo_credentials,
)
from products.warehouse_sources.sources.qualaroo.settings import ENDPOINTS, INCREMENTAL_FIELDS, QUALAROO_ENDPOINTS
from products.warehouse_sources.sources.sdk import (
    CanonicalDescriptions,
    DataWarehouseSourceCategory,
    ExternalDataSourceType,
    FieldType,
    ReleaseStatus,
    ResumableSource,
    ResumableSourceManager,
    SourceConfig,
    SourceFieldInputConfig,
    SourceFieldInputConfigType,
    SourceInputs,
    SourceRegistry,
    SourceResponse,
    SourceSchema,
    build_endpoint_schemas,
    detect,
)


@SourceRegistry.register
class QualarooSource(ResumableSource[QualarooSourceConfig, QualarooResumeConfig]):
    codebase_detection = detect(env=("^QUALAROO_",))

    supported_versions = ("v1",)
    default_version = "v1"
    api_docs_url = "https://help.qualaroo.com/hc/en-us/sections/200469946-API-Documentation"

    lists_tables_without_credentials = True  # static endpoint catalog — safe for public docs

    @property
    def source_type(self) -> ExternalDataSourceType:
        return ExternalDataSourceType.QUALAROO

    @property
    def get_source_config(self) -> SourceConfig:
        return SourceConfig(
            name=ExternalDataSourceType.QUALAROO,
            category=DataWarehouseSourceCategory.PRODUCTIVITY,
            label="Qualaroo",
            releaseStatus=ReleaseStatus.BETA,
            caption="""Enter your Qualaroo API key and secret to pull your survey (nudge) data into the PostHog Data warehouse.

You can find your API key and secret under **Settings → API** in [Qualaroo](https://app.qualaroo.com/). They authenticate the REST Reporting API with read access to your nudges.
""",
            iconPath="/static/services/qualaroo.png",
            docsUrl="https://posthog.com/docs/cdp/sources/qualaroo",
            fields=cast(
                list[FieldType],
                [
                    SourceFieldInputConfig(
                        name="api_key",
                        label="API key",
                        type=SourceFieldInputConfigType.PASSWORD,
                        required=True,
                        placeholder="",
                        secret=True,
                    ),
                    SourceFieldInputConfig(
                        name="api_secret",
                        label="API secret",
                        type=SourceFieldInputConfigType.PASSWORD,
                        required=True,
                        placeholder="",
                        secret=True,
                    ),
                ],
            ),
        )

    def get_canonical_descriptions(self) -> CanonicalDescriptions:
        from products.warehouse_sources.sources.qualaroo.canonical_descriptions import (
            CANONICAL_DESCRIPTIONS,  # noqa: PLC0415
        )

        return CANONICAL_DESCRIPTIONS

    def get_non_retryable_errors(self) -> dict[str, str | None]:
        return {
            "401 Client Error: Unauthorized for url: https://api.qualaroo.com": "Your Qualaroo API key or secret is invalid or has been revoked. Generate a new pair under Settings → API, then reconnect.",
            "403 Client Error: Forbidden for url: https://api.qualaroo.com": "Your Qualaroo credentials do not have access to this data. Check the key's permissions, then reconnect.",
        }

    def get_schemas(
        self,
        config: QualarooSourceConfig,
        team_id: int,
        with_counts: bool = False,
        names: list[str] | None = None,
        force_refresh: bool = False,
        api_version: str | None = None,
    ) -> list[SourceSchema]:
        # Responses are merge only: `start_date` re-reads the watermark second, which append would
        # store twice.
        return build_endpoint_schemas(ENDPOINTS, INCREMENTAL_FIELDS, names, merge_only=("responses",))

    def validate_credentials(
        self,
        config: QualarooSourceConfig,
        team_id: int,
        schema_name: Optional[str] = None,
        api_version: str | None = None,
    ) -> tuple[bool, str | None]:
        # The key/secret pair is account-wide, so a single probe validates access to every schema.
        return _validate_qualaroo_credentials(config.api_key, config.api_secret)

    def get_resumable_source_manager(self, inputs: SourceInputs) -> ResumableSourceManager[QualarooResumeConfig]:
        return ResumableSourceManager[QualarooResumeConfig](inputs, QualarooResumeConfig)

    def source_for_pipeline(
        self,
        config: QualarooSourceConfig,
        resumable_source_manager: ResumableSourceManager[QualarooResumeConfig],
        inputs: SourceInputs,
    ) -> SourceResponse:
        if inputs.schema_name not in QUALAROO_ENDPOINTS:
            raise ValueError(f"Unknown Qualaroo schema '{inputs.schema_name}'")

        return qualaroo_source(
            api_key=config.api_key,
            api_secret=config.api_secret,
            endpoint=inputs.schema_name,
            team_id=inputs.team_id,
            job_id=inputs.job_id,
            resumable_source_manager=resumable_source_manager,
            should_use_incremental_field=inputs.should_use_incremental_field,
            db_incremental_field_last_value=(
                inputs.db_incremental_field_last_value if inputs.should_use_incremental_field else None
            ),
            incremental_field=inputs.incremental_field,
        )