arcade-mcp/toolkits/jira/arcade_jira/client.py
Sam Partee b6b4cd0a4c
🏗️ Restructure: Multi-Package Architecture + uv Migration (#412)
### Overview
Major restructuring from monolithic `arcade-ai` package to modular
library architecture with standardized uv-based dependency management.

![arcade-ai Monorepo
(2)](https://github.com/user-attachments/assets/25f102b0-bb87-4a04-9701-d227d05664b1)

### New Package Structure
- **`arcade-tdk`** - Lightweight toolkit development kit (core
decorators, auth)
- **`arcade-core`** - Core execution engine and catalog functionality  
- **`arcade-serve`** - FastAPI/MCP server components
- **`arcade-ai`** - Meta package that includes CLI functionality.
Optionally include evals via the `evals` extra. Optionally include all
packages via the `all` extra.

### Key Benefits
- **Lighter Dependencies**: Toolkits now depend only on `arcade-tdk` (~2
deps) vs full `arcade-ai` (~30+ deps)
- **Faster Builds**: uv provides 10-100x faster dependency resolution
and installation
- **Better Modularity**: Clear separation of concerns, consumers import
only what they need
- **Standard Tooling**: Eliminates custom poetry scripts, uses standard
Python packaging

### Migration Impact
- All 20 toolkits converted from poetry → uv with `arcade-tdk`
dependencies plus `arcade-ai[evals]` and `arcade-serve` dev
dependencies. When developing locally, devs should install toolkits via
`make install-local`.
- Modern Python 3.10+ type hints throughout
- Standardized build system with hatchling backend
- Enhanced Makefile with robust toolkit management commands
- Removed `arcade dev` CLI command
- Reduce the number of files created by `arcade new` and add an option
to not generate a tests and evals folder.

This foundation enables faster development cycles and cleaner dependency
chains for the growing toolkit ecosystem.

### Todo After this PR is merged
- [ ] Post-merge workflow(s) (release & publish containers, etc)
- [ ] Release order plan. @EricGustin suggests releasing in the
following order:
    1. `arcade-core` version 0.1.0
    2. `arcade-serve` version 0.1.0 and `arcade-tdk` version 0.1.0
    3. `arcade-ai` version 2.0.0
4. Patch release for all toolkits (all changes in toolkits are internal
refactors)
- [ ] [Update docs](https://github.com/ArcadeAI/docs/pull/318)

---------

Co-authored-by: Eric Gustin <eric@arcade.dev>
Co-authored-by: Eric Gustin <34000337+EricGustin@users.noreply.github.com>
2025-06-11 16:48:17 -07:00

226 lines
7.6 KiB
Python

import asyncio
import json
import json.decoder
from dataclasses import dataclass
from typing import Any, cast
import httpx
import arcade_jira.cache as cache
from arcade_jira.constants import JIRA_API_VERSION, JIRA_BASE_URL, JIRA_MAX_CONCURRENT_REQUESTS
from arcade_jira.exceptions import JiraToolExecutionError, NotFoundError
@dataclass
class JiraClient:
auth_token: str
base_url: str = JIRA_BASE_URL
api_version: str = JIRA_API_VERSION
max_concurrent_requests: int = JIRA_MAX_CONCURRENT_REQUESTS
_semaphore: asyncio.Semaphore | None = None
_cloud_id: str | None = None
def __post_init__(self) -> None:
if not self._semaphore:
cached_semaphore = cache.get_jira_client_semaphore(self.auth_token)
if cached_semaphore:
self._semaphore = cached_semaphore
else:
self._semaphore = asyncio.Semaphore(self.max_concurrent_requests)
cache.set_jira_client_semaphore(self.auth_token, self._semaphore)
self.base_url = self.base_url.rstrip("/")
self.api_version = self.api_version.strip("/")
async def get_cloud_id(self) -> str:
if self._cloud_id is None:
if (cloud_id := await cache.async_get_cloud_id(self.auth_token)) is not None:
self._cloud_id = cloud_id
else:
cloud = await self._get_cloud_data_from_available_resources()
self._cloud_id = cloud["id"]
await cache.async_set_cloud_id(self.auth_token, cloud["id"])
await cache.async_set_cloud_name(self.auth_token, cloud["name"])
return self._cloud_id
async def _build_url(self, endpoint: str) -> str:
cloud_id = await self.get_cloud_id()
return f"{self.base_url}/{cloud_id}/rest/api/{self.api_version}/{endpoint.lstrip('/')}"
async def _get_cloud_data_from_available_resources(self) -> dict[str, Any]:
async with httpx.AsyncClient() as client:
response = await client.get(
"https://api.atlassian.com/oauth/token/accessible-resources",
headers={"Authorization": f"Bearer {self.auth_token}"},
)
data = response.json()
if len(data) == 0:
raise JiraToolExecutionError(
message="No cloud ID returned by Atlassian, cannot make API calls"
)
if len(data) > 1:
cloud_ids_found = json.dumps([
{
"id": item["id"],
"name": item["name"],
"url": item["url"],
}
for item in data
])
raise JiraToolExecutionError(
message=f"Multiple cloud IDs returned by Atlassian: {cloud_ids_found}. "
"Cannot resolve which one to use."
)
return cast(dict[str, Any], data[0])
def _build_error_messages(self, response: httpx.Response) -> tuple[str, str | None]:
try:
data = response.json()
developer_message = None
if "errorMessages" in data:
if len(data["errorMessages"]) == 1:
error_message = cast(str, data["errorMessages"][0])
elif "errors" in data:
error_message = json.dumps(data["errors"])
else:
error_message = "Unknown error"
elif "message" in data:
error_message = cast(str, data["message"])
else:
error_message = json.dumps(data)
except Exception as e:
error_message = "Failed to parse Jira error response"
developer_message = (
f"Failed to parse Jira error response: {type(e).__name__}: {e!s}. "
f"API Response: {response.text}"
)
return error_message, developer_message
def _raise_for_status(self, response: httpx.Response) -> None:
if response.status_code < 300:
return
error_message, developer_message = self._build_error_messages(response)
if response.status_code == 404:
raise NotFoundError(error_message, developer_message)
raise JiraToolExecutionError(error_message, developer_message)
def _set_request_body(self, kwargs: dict, data: dict | None, json_data: dict | None) -> dict:
if data and json_data:
raise ValueError("Cannot provide both data and json_data") # noqa: TRY003
if data:
kwargs["data"] = data
elif json_data:
kwargs["json"] = json_data
return kwargs
def _format_response_dict(self, response: httpx.Response) -> dict:
try:
return cast(dict, response.json())
except (UnicodeDecodeError, json.decoder.JSONDecodeError):
return {"text": response.text}
async def get(
self,
endpoint: str,
params: dict | None = None,
headers: dict | None = None,
) -> dict:
default_headers = {
"Authorization": f"Bearer {self.auth_token}",
"Accept": "application/json",
}
headers = {**default_headers, **(headers or {})}
kwargs = {
"url": await self._build_url(endpoint),
"headers": headers,
}
if params:
kwargs["params"] = params
async with self._semaphore, httpx.AsyncClient() as client: # type: ignore[union-attr]
response = await client.get(**kwargs) # type: ignore[arg-type]
self._raise_for_status(response)
return self._format_response_dict(response)
async def post(
self,
endpoint: str,
data: dict | None = None,
json_data: dict | None = None,
files: dict | None = None,
headers: dict | None = None,
) -> dict:
default_headers = {
"Authorization": f"Bearer {self.auth_token}",
"Accept": "application/json",
}
if files is None and json_data is not None:
default_headers["Content-Type"] = "application/json"
headers = {**default_headers, **(headers or {})}
kwargs = {
"url": await self._build_url(endpoint),
"headers": headers,
}
if files is not None:
kwargs["files"] = files
if data is not None:
kwargs["data"] = data
else:
kwargs = self._set_request_body(kwargs, data, json_data)
async with self._semaphore, httpx.AsyncClient() as client: # type: ignore[union-attr]
response = await client.post(**kwargs) # type: ignore[arg-type]
self._raise_for_status(response)
return self._format_response_dict(response)
async def put(
self,
endpoint: str,
data: dict | None = None,
json_data: dict | None = None,
params: dict | None = None,
headers: dict | None = None,
) -> dict:
headers = headers or {}
headers["Authorization"] = f"Bearer {self.auth_token}"
headers["Content-Type"] = "application/json"
headers["Accept"] = "application/json"
kwargs = {
"url": await self._build_url(endpoint),
"headers": headers,
}
kwargs = self._set_request_body(kwargs, data, json_data)
if params:
kwargs["params"] = params
async with self._semaphore, httpx.AsyncClient() as client: # type: ignore[union-attr]
response = await client.put(**kwargs) # type: ignore[arg-type]
self._raise_for_status(response)
return self._format_response_dict(response)