Automate browser based workflows with AI
Python aiapiautomationbrowserbrowser-automationcomputergptllmplaywrightpowerautomatepuppeteerpythonrpaseleniumvisionworkflow
Login endpoint Part 2 - support 3 types of credentials and fix bugs (#2999)
Shuchang Zheng85857e548d8b
diff --git a/skyvern/forge/sdk/routes/run_blocks.py b/skyvern/forge/sdk/routes/run_blocks.pyindex bd7879ec8..f1723f3d7 100644--- a/skyvern/forge/sdk/routes/run_blocks.py+++ b/skyvern/forge/sdk/routes/run_blocks.py@@ -10,14 +10,17 @@ from skyvern.forge.sdk.core import skyvern_contextfrom skyvern.forge.sdk.routes.routers import base_routerfrom skyvern.forge.sdk.schemas.organizations import Organizationfrom skyvern.forge.sdk.services import org_auth_service+from skyvern.forge.sdk.workflow.models.parameter import WorkflowParameterTypefrom skyvern.forge.sdk.workflow.models.workflow import WorkflowRequestBodyfrom skyvern.forge.sdk.workflow.models.yaml import (- CredentialParameterYAML,+ BitwardenLoginCredentialParameterYAML,LoginBlockYAML,+ OnePasswordCredentialParameterYAML,WorkflowCreateYAMLRequest,WorkflowDefinitionYAML,+ WorkflowParameterYAML,)-from skyvern.schemas.run_blocks import LoginRequest+from skyvern.schemas.run_blocks import CredentialType, LoginRequestfrom skyvern.schemas.runs import ProxyLocation, RunType, WorkflowRunRequest, WorkflowRunResponsefrom skyvern.services import workflow_service@@ -40,11 +43,6 @@ async def login(organization: Organization = Depends(org_auth_service.get_current_org),x_api_key: Annotated[str | None, Header()] = None,) -> WorkflowRunResponse:- # 0. validate credential- credential = await app.DATABASE.get_credential(login_request.credential_id, organization.organization_id)- if not credential:- raise HTTPException(status_code=404, detail=f"Credential {login_request.credential_id} not found")-# 1. create empty workflow with a credential parameternew_workflow = await app.WORKFLOW_SERVICE.create_empty_workflow(organization,@@ -53,38 +51,55 @@ async def login(max_screenshot_scrolling_times=login_request.max_screenshot_scrolling_times,extra_http_headers=login_request.extra_http_headers,)- workflow_run = await app.WORKFLOW_SERVICE.setup_workflow_run(- request_id=None,- workflow_request=WorkflowRequestBody(- max_screenshot_scrolls=login_request.max_screenshot_scrolling_times,- browser_session_id=login_request.browser_session_id,- extra_http_headers=login_request.extra_http_headers,- ),- workflow_permanent_id=new_workflow.workflow_permanent_id,- organization=organization,- version=None,- max_steps_override=10,- parent_workflow_run_id=None,- )# 2. add a login block to the workflowlabel = "login"+ yaml_parameters = []+ parameter_key = "credential"+ if login_request.credential_type == CredentialType.skyvern:+ credential = await app.DATABASE.get_credential(login_request.credential_id, organization.organization_id)+ if not credential:+ raise HTTPException(status_code=404, detail=f"Credential {login_request.credential_id} not found")++ yaml_parameters = [+ WorkflowParameterYAML(+ key=parameter_key,+ workflow_parameter_type=WorkflowParameterType.CREDENTIAL_ID,+ description="The ID of the credential to use for login",+ default_value=login_request.credential_id,+ )+ ]+ elif login_request.credential_type == CredentialType.bitwarden:+ yaml_parameters = [+ BitwardenLoginCredentialParameterYAML(+ key=parameter_key,+ collection_id=login_request.collection_id,+ item_id=login_request.item_id,+ url=login_request.url,+ description="The ID of the bitwarden collection to use for login",+ bitwarden_client_id_aws_secret_key="SKYVERN_BITWARDEN_CLIENT_ID",+ bitwarden_client_secret_aws_secret_key="SKYVERN_BITWARDEN_CLIENT_SECRET",+ bitwarden_master_password_aws_secret_key="SKYVERN_BITWARDEN_MASTER_PASSWORD",+ )+ ]+ elif login_request.credential_type == CredentialType.onepassword:+ yaml_parameters = [+ OnePasswordCredentialParameterYAML(+ key=parameter_key,+ vault_id=login_request.vault_id,+ item_id=login_request.item_id,+ )+ ]+login_block_yaml = LoginBlockYAML(label=label,title=label,url=login_request.url,navigation_goal=login_request.prompt or DEFAULT_LOGIN_PROMPT,max_steps_per_run=10,- parameter_keys=[login_request.credential_id],+ parameter_keys=[parameter_key],totp_verification_url=login_request.totp_url,totp_identifier=login_request.totp_identifier,)- yaml_parameters = [- CredentialParameterYAML(- name="credential_id",- type="workflow",- description="The ID of the credential to use for login",- )- ]yaml_blocks = [login_block_yaml]workflow_definition_yaml = WorkflowDefinitionYAML(parameters=yaml_parameters,@@ -105,14 +120,11 @@ async def login()LOG.info("Workflow created", workflow_id=workflow.workflow_id)- # 3. create and run workflow with the credential_id- workflow_id = new_workflow.workflow_id+ # 3. create and run workflow with the credential+ workflow_id = new_workflow.workflow_permanent_idcontext = skyvern_context.ensure_context()request_id = context.request_idlegacy_workflow_request = WorkflowRequestBody(- data={- "credential_id": login_request.credential_id,- },proxy_location=login_request.proxy_location,webhook_callback_url=login_request.webhook_url,totp_identifier=login_request.totp_identifier,@@ -146,9 +158,6 @@ async def login(modified_at=workflow_run.modified_at,run_request=WorkflowRunRequest(workflow_id=new_workflow.workflow_id,- parameters={- "credential_id": login_request.credential_id,- },title=new_workflow.title,proxy_location=login_request.proxy_location,webhook_url=login_request.webhook_url,diff --git a/skyvern/schemas/run_blocks.py b/skyvern/schemas/run_blocks.pyindex 06599382a..c104d0bb5 100644--- a/skyvern/schemas/run_blocks.py+++ b/skyvern/schemas/run_blocks.py@@ -1,10 +1,18 @@-from pydantic import BaseModel+from enum import StrEnum+from typing import Annotated, Literal, Union++from pydantic import BaseModel, Fieldfrom skyvern.schemas.runs import ProxyLocation-class LoginRequest(BaseModel):- credential_id: str+class CredentialType(StrEnum):+ skyvern = "skyvern"+ bitwarden = "bitwarden"+ onepassword = "1password"+++class LoginRequestBase(BaseModel):url: str | None = Noneprompt: str | None = Nonewebhook_url: str | None = None@@ -14,3 +22,27 @@ class LoginRequest(BaseModel):browser_session_id: str | None = Noneextra_http_headers: dict[str, str] | None = Nonemax_screenshot_scrolling_times: int | None = None+++class SkyvernCredentialLoginRequest(LoginRequestBase):+ credential_type: Literal[CredentialType.skyvern] = CredentialType.skyvern+ credential_id: str+++class BitwardenLoginRequest(LoginRequestBase):+ credential_type: Literal[CredentialType.bitwarden] = CredentialType.bitwarden+ collection_id: str | None = None+ item_id: str | None = None+ url: str | None = None+++class OnePasswordLoginRequest(LoginRequestBase):+ credential_type: Literal[CredentialType.onepassword] = CredentialType.onepassword+ vault_id: str+ item_id: str+++LoginRequest = Annotated[+ Union[SkyvernCredentialLoginRequest, BitwardenLoginRequest, OnePasswordLoginRequest],+ Field(discriminator="credential_type"),+]