intuned-runtime 1.0.0__py3-none-any.whl

runtime/run/traces.py

@@ -0,0 +1,36 @@
+import os
+from os import environ
+from typing import Optional
+
+import requests
+
+from ..errors import TraceNotFoundError
+
+
+def get_trace_file_path(run_id: str, attempt_number: Optional[str] = "") -> str:
+    file_name = f'{run_id}{attempt_number if attempt_number is not None else ""}'
+    traces_dir = environ.get("TRACES_DIRECTORY", "")
+    return os.path.join(traces_dir, f"{file_name}.zip")
+
+
+def upload_trace(run_id: str, attempt_number: Optional[str], trace_signed_url: str):
+    trace_file_path = get_trace_file_path(run_id, attempt_number)
+
+    if not os.path.exists(trace_file_path):
+        raise TraceNotFoundError()
+
+    file_size = os.path.getsize(trace_file_path)
+
+    with open(trace_file_path, "rb") as trace_file:
+        upload_trace_res = requests.put(trace_signed_url, headers={"Content-Length": str(file_size)}, data=trace_file)
+
+        return upload_trace_res
+
+
+def delete_trace(run_id: str, attempt_number: Optional[str]):
+    trace_file_path = get_trace_file_path(run_id, attempt_number)
+
+    if not os.path.exists(trace_file_path):
+        raise TraceNotFoundError()
+
+    os.remove(trace_file_path)

runtime/types/__init__.py

@@ -0,0 +1,15 @@
+from .payload import Payload
+from .run_types import PayloadToAppend
+from .run_types import RunAutomationErrorResult
+from .run_types import RunAutomationResult
+from .run_types import RunAutomationSuccessResult
+from .run_types import RunBody
+
+__all__ = [
+    "Payload",
+    "RunBody",
+    "RunAutomationResult",
+    "RunAutomationErrorResult",
+    "RunAutomationSuccessResult",
+    "PayloadToAppend",
+]

runtime/types/payload.py

@@ -0,0 +1,7 @@
+from typing import Any
+from typing import TypedDict
+
+
+class Payload(TypedDict):
+    api: str
+    parameters: dict[str, Any]

runtime/types/run_types.py

@@ -0,0 +1,177 @@
+from enum import Enum
+from typing import Any
+from typing import Dict
+from typing import List
+from typing import Literal
+from typing import Optional
+from typing import Union
+
+from pydantic import BaseModel
+from pydantic import ConfigDict
+from pydantic import Field
+from pydantic.alias_generators import to_camel
+
+
+class CamelBaseModel(BaseModel):
+    model_config = ConfigDict(
+        alias_generator=to_camel,
+        populate_by_name=True,
+    )
+
+
+class ProxyConfig(CamelBaseModel):
+    server: str
+    username: str
+    password: str
+
+
+class SameSite(str, Enum):
+    STRICT = "Strict"
+    LAX = "Lax"
+    NONE = "None"
+
+
+class Cookie(CamelBaseModel):
+    name: str
+    value: str
+    domain: str
+    path: str
+    expires: float
+    http_only: bool
+    secure: bool
+    same_site: SameSite
+
+
+class StorageItem(CamelBaseModel):
+    name: str
+    value: str
+
+
+class Origin(CamelBaseModel):
+    origin: str
+    local_storage: List[StorageItem]
+
+
+class SessionStorageOrigin(CamelBaseModel):
+    origin: str
+    session_storage: List[StorageItem]
+
+
+class StorageState(CamelBaseModel):
+    cookies: List[Cookie]
+    origins: List[Origin]
+    session_storage: Optional[List[SessionStorageOrigin]]
+
+
+class FileSession(CamelBaseModel):
+    type: Literal["file"] = "file"
+    path: str
+
+
+class StateSession(CamelBaseModel):
+    type: Literal["state"] = "state"
+    state: Optional[Optional[StorageState]]
+
+
+RunApiSession = Union[FileSession, StateSession]
+
+
+class RunBody(CamelBaseModel):
+    params: dict[str, Any] | None = None
+    functions_token: str | None = None
+    proxy: Optional[ProxyConfig] = None
+    session: Optional[StorageState] = None
+
+
+class StandaloneRunOptions(CamelBaseModel):
+    environment: Literal["standalone"] = "standalone"
+    headless: bool = True
+    proxy: Optional[ProxyConfig] = None
+
+
+class CDPRunOptions(CamelBaseModel):
+    environment: Literal["cdp"] = "cdp"
+    cdp_address: str
+
+
+class AutomationFunction(CamelBaseModel):
+    name: str
+    params: Optional[Any] = None
+
+
+class TracingEnabled(CamelBaseModel):
+    enabled: Literal[True] = True
+    file_path: str
+
+
+class TracingDisabled(CamelBaseModel):
+    enabled: Literal[False] = False
+
+
+class Auth(CamelBaseModel):
+    session: RunApiSession
+    run_check: bool = False
+
+
+class IntunedRunContext(CamelBaseModel):
+    job_id: str | None = None
+    job_run_id: str | None = None
+    run_id: str | None = None
+    auth_session_id: str | None = None
+
+
+class RunApiParameters(CamelBaseModel):
+    automation_function: AutomationFunction
+    tracing: Union[TracingEnabled, TracingDisabled] = Field(default_factory=TracingDisabled)
+    auth: Optional[Auth] = None
+    run_options: Union[StandaloneRunOptions, CDPRunOptions] = Field(default_factory=StandaloneRunOptions)
+    retrieve_session: bool = False
+    functions_token: str | None = None
+    context: Optional[IntunedRunContext] = None
+
+
+class RunApiResultOk(CamelBaseModel):
+    result: Any
+    extended_payloads: Optional[List[Any]]  # Payload type
+
+
+class RunApiResultWithSessionOk(RunApiResultOk):
+    session: Dict[str, Any]  # IntunedStorageState type
+
+
+class PayloadToAppend(CamelBaseModel):
+    api_name: str
+    parameters: Dict[str, Any]
+
+
+class RunAutomationSuccessResult(CamelBaseModel):
+    result: Any
+    payload_to_append: Optional[list[PayloadToAppend]] = Field(default_factory=list[PayloadToAppend])
+    session: Optional[StorageState] = None
+
+
+class RunAutomationErrorResult(CamelBaseModel):
+    error: str
+    message: str
+    status: Optional[int]
+    details: Optional[Any]
+    additional_fields: Dict[str, Any] = Field(default_factory=dict)
+
+
+RunAutomationResult = Union[RunAutomationSuccessResult, RunAutomationErrorResult]
+
+
+class RunAutomationResponse(CamelBaseModel):
+    status: int
+    body: RunAutomationResult
+
+
+class JobPayload(CamelBaseModel):
+    headers: Dict[str, str] = Field(default_factory=dict)
+    original_payload: dict[Any, Any]
+    payload: RunBody
+    start_time: int
+    function_name: str
+    receipt_handle: str
+    trace_signed_url: str | None = None
+    session: StorageState | None = None

runtime_helpers/__init__.py

@@ -0,0 +1,5 @@
+from runtime.helpers import extend_payload
+from runtime.helpers import extend_timeout
+from runtime.helpers.get_auth_session_parameters import get_auth_session_parameters
+
+__all__ = ["extend_payload", "extend_timeout", "get_auth_session_parameters"]