Skip to content

Automate browser based workflows with AI

11.0 KB
Raw Blame
import json
from datetime import UTC, datetime
from pathlib import Path

import pytest

from skyvern.forge.sdk.copilot import google_connection_notice as notice_module
from skyvern.forge.sdk.copilot.google_connection_notice import (
    GoogleConnectionNotice,
    collect_google_connection_notices,
    google_sheet_connection_bindings,
    google_sheet_connection_ids,
    retain_notices_after_lookup_failure,
    write_google_connection_notice_capture,
)
from skyvern.forge.sdk.schemas.google_oauth import GoogleOAuthCredentialBase
from skyvern.forge.sdk.workflow.models.block import ForLoopBlock
from skyvern.forge.sdk.workflow.models.google_sheets_blocks import GoogleSheetsReadBlock, GoogleSheetsWriteBlock
from skyvern.forge.sdk.workflow.models.parameter import OutputParameter
from skyvern.forge.sdk.workflow.models.workflow import Workflow, WorkflowDefinition


def _workflow(*blocks: object) -> Workflow:
    now = datetime.now(UTC)
    return Workflow(
        workflow_id="wf_test",
        organization_id="org_test",
        title="Test",
        workflow_permanent_id="wpid_test",
        version=1,
        is_saved_task=False,
        workflow_definition=WorkflowDefinition(parameters=[], blocks=list(blocks)),
        created_at=now,
        modified_at=now,
    )


def _write(label: str, connection_id: str | None) -> GoogleSheetsWriteBlock:
    return GoogleSheetsWriteBlock(
        label=label,
        spreadsheet_url="https://docs.google.com/spreadsheets/d/test",
        credential_id=connection_id,
        output_parameter=_output(label),
    )


def _output(label: str) -> OutputParameter:
    now = datetime.now(UTC)
    return OutputParameter(
        key=f"{label}_output",
        output_parameter_id=f"op_{label}",
        workflow_id="wf_test",
        created_at=now,
        modified_at=now,
    )


def _credential(
    connection_id: str,
    state: str,
    name: str = "Sheets account",
    scopes_granted: list[str] | None = None,
) -> GoogleOAuthCredentialBase:
    now = datetime.now(UTC)
    return GoogleOAuthCredentialBase(
        id=connection_id,
        organization_id="org_test",
        credential_name=name,
        state=state,
        scopes_granted=(["https://www.googleapis.com/auth/spreadsheets"] if scopes_granted is None else scopes_granted),
        created_at=now,
        modified_at=now,
    )


def test_reports_missing_and_unusable_new_bindings_but_not_active_or_preexisting() -> None:
    workflow = _workflow(
        _write("missing", "goac_missing"),
        _write("unusable", "goac_error"),
        _write("active", "goac_active"),
        _write("existing", "goac_existing"),
    )

    notices = collect_google_connection_notices(
        turn_start_bindings=(("existing", "goac_existing"),),
        current_bindings=google_sheet_connection_bindings(workflow),
        visible_credentials=[
            _credential("goac_error", "error", "Needs reconnect"),
            _credential("goac_active", "active"),
            _credential("goac_existing", "error"),
        ],
    )

    assert [notice.to_payload() for notice in notices] == [
        {
            "provider": "google",
            "connectionId": "goac_missing",
            "displayName": None,
            "condition": "missing",
            "scopeProfile": "google_sheets",
            "origin": "workflow",
        },
        {
            "provider": "google",
            "connectionId": "goac_error",
            "displayName": "Needs reconnect",
            "condition": "unusable",
            "scopeProfile": "google_sheets",
            "origin": "workflow",
        },
    ]


def test_nested_and_duplicate_bindings_are_flattened_and_deduplicated() -> None:
    nested = GoogleSheetsReadBlock(
        label="nested_read",
        spreadsheet_url="https://docs.google.com/spreadsheets/d/test",
        credential_id="goac_nested",
        output_parameter=_output("nested"),
    )
    loop = ForLoopBlock(
        label="loop",
        loop_over_parameter_key="items",
        loop_blocks=[nested, _write("duplicate", "goac_nested")],
        output_parameter=_output("loop"),
    )

    assert google_sheet_connection_ids(_workflow(loop)) == ("goac_nested",)


def test_unresolved_connection_name_left_in_the_slot_is_not_a_connection_binding() -> None:
    workflow = _workflow(_write("named", "Shared Sheets Account"), _write("bound", "goac_active"))

    assert google_sheet_connection_bindings(workflow) == (("bound", "goac_active"),)


@pytest.mark.parametrize("with_usable_connection", [False, True])
def test_unbound_nested_sheets_offer_only_usable_connections(with_usable_connection: bool) -> None:
    nested = GoogleSheetsReadBlock(
        label="read",
        spreadsheet_url="https://docs.google.com/spreadsheets/d/test",
        credential_id=None,
        output_parameter=_output("read"),
    )
    loop = ForLoopBlock(
        label="loop",
        loop_over_parameter_key="items",
        loop_blocks=[nested, _write("write", "")],
        output_parameter=_output("loop"),
    )
    credentials = [_credential("goac_error", "error"), _credential("goac_mail", "active", scopes_granted=[])]
    if with_usable_connection:
        credentials.append(_credential("goac_active", "active"))

    notices = collect_google_connection_notices(
        turn_start_bindings=(),
        current_bindings=google_sheet_connection_bindings(_workflow(loop)),
        visible_credentials=credentials,
    )

    assert len(notices) == 1
    assert notices[0].condition == "unbound"
    assert notices[0].connectionId is None
    assert [choice.connection_id for choice in notices[0].choices] == (
        ["goac_active"] if with_usable_connection else []
    )


def test_unbound_notice_tracks_draft_binding_changes() -> None:
    assert (
        collect_google_connection_notices(
            turn_start_bindings=(("write", None),),
            current_bindings=(("write", None),),
            visible_credentials=[],
        )
        == []
    )
    notices = collect_google_connection_notices(
        turn_start_bindings=(("write", "goac_old"),),
        current_bindings=(("write", None),),
        visible_credentials=[],
    )
    assert len(notices) == 1
    assert retain_notices_after_lookup_failure(current_connection_ids=(None,), notices=notices) == notices
    assert retain_notices_after_lookup_failure(current_connection_ids=("goac_active",), notices=notices) == []


def test_new_block_using_a_preexisting_connection_is_still_a_new_binding() -> None:
    notices = collect_google_connection_notices(
        turn_start_bindings=(("existing", "goac_error"),),
        current_bindings=(("existing", "goac_error"), ("new", "goac_error")),
        visible_credentials=[_credential("goac_error", "error", "Needs reconnect")],
    )

    assert [notice.connectionId for notice in notices] == ["goac_error"]


def test_repeated_update_can_clear_notice_and_lookup_failure_only_retains_still_bound_notices() -> None:
    notice = GoogleConnectionNotice(connectionId="goac_error", displayName="Old", condition="unusable")
    active = collect_google_connection_notices(
        turn_start_bindings=(),
        current_bindings=(("write", "goac_error"),),
        visible_credentials=[_credential("goac_error", "active")],
    )
    retained = retain_notices_after_lookup_failure(
        current_connection_ids=("goac_error",),
        notices=[notice],
    )
    removed = retain_notices_after_lookup_failure(current_connection_ids=(), notices=[notice])

    assert active == []
    assert retained == [notice]
    assert removed == []


@pytest.mark.parametrize(
    ("other_state", "other_scopes"),
    [
        ("active", ["https://www.googleapis.com/auth/gmail.readonly"]),
        ("error", ["https://www.googleapis.com/auth/gmail.readonly"]),
        ("error", ["https://www.googleapis.com/auth/spreadsheets", "https://www.googleapis.com/auth/drive"]),
    ],
    ids=["active-gmail", "expired-gmail", "expired-sheets-and-drive"],
)
def test_sheets_block_bound_to_a_connection_holding_another_profile_offers_a_sheets_choice_instead_of_a_reconnect(
    other_state: str, other_scopes: list[str]
) -> None:
    notices = collect_google_connection_notices(
        turn_start_bindings=(),
        current_bindings=(("write", "goac_gmail"), ("other", "goac_sheets_error")),
        visible_credentials=[
            _credential("goac_gmail", other_state, "Other profile", scopes_granted=other_scopes),
            _credential("goac_sheets_error", "error", "Sheets expired"),
            _credential("goac_sheets", "active"),
        ],
    )

    assert [
        (notice.connectionId, notice.condition, [choice.connection_id for choice in notice.choices])
        for notice in notices
    ] == [(None, "unbound", ["goac_sheets"]), ("goac_sheets_error", "unusable", [])]


def _capture(tmp_path: Path, turn_id: str, *blocks: object, credentials: list[GoogleOAuthCredentialBase]) -> None:
    write_google_connection_notice_capture(
        output_root=str(tmp_path),
        turn_id=turn_id,
        turn_start_workflow=_workflow(),
        final_workflow=_workflow(*blocks),
        accepted_workflow_yaml="workflow_definition:\n  blocks: []\n",
        visible_credentials=credentials,
        observed_notices=[],
    )


def _captures(tmp_path: Path) -> list[dict[str, object]]:
    return [json.loads(path.read_text()) for path in sorted(tmp_path.glob("capture-*.json"))]


def test_capture_writes_one_token_free_packet_at_the_contract_path(tmp_path: Path) -> None:
    credential = _credential("goac_error", "error", "Needs reconnect", scopes_granted=[])

    _capture(tmp_path, "turn_1", _write("write", "goac_error"), credentials=[credential])

    payload = _captures(tmp_path)[0]
    assert payload["contractVersion"] == 2
    assert payload["turnId"] == "turn_1"
    assert payload["visibleCredentials"] == [
        {
            "id": "goac_error",
            "organization_id": "org_test",
            "credential_name": "Needs reconnect",
            "provider": "google",
            "state": "error",
            "scopes_requested": [],
            "scopes_granted": [],
            "created_at": credential.created_at.isoformat(),
            "modified_at": credential.modified_at.isoformat(),
        }
    ]


def test_capture_records_every_binding_once_per_accepted_update(tmp_path: Path) -> None:
    active = _credential("goac_active", "active")

    _capture(tmp_path, "turn_1", _write("count", "goac_active"), credentials=[active])
    _capture(tmp_path, "turn_1", _write("count", "goac_active"), _write("append", "goac_active"), credentials=[active])

    payloads = _captures(tmp_path)
    assert [payload["observedNotices"] for payload in payloads] == [[], []]
    assert [len(payload["finalWorkflow"]["workflow_definition"]["blocks"]) for payload in payloads] == [1, 2]
    assert all(path.stat().st_mode & 0o077 == 0 for path in tmp_path.glob("capture-*.json"))


def test_capture_is_withheld_outside_a_local_environment(tmp_path: Path, monkeypatch: pytest.MonkeyPatch) -> None:
    monkeypatch.setattr(notice_module.settings, "ENV", "production")

    _capture(tmp_path, "turn_1", _write("append", "goac_active"), credentials=[_credential("goac_active", "active")])

    assert _captures(tmp_path) == []