Skip to content

Commit 56f5dd7

Browse files
arthurbrennoarthurbrenno
committed
feat(api): Enhance API endpoint and function name generation
- Improve aiohttp session handling in `make_single_request()` to prevent connection errors - Add robust function name generation for OpenAPI spec endpoints - Create new test script to validate function name generation for OpenAPI specs - Update example script to demonstrate edge case handling for API endpoint names - Ensure proper session and connector closure in async API requests - Add comprehensive test cases for problematic path name conversions Addresses potential issues with API endpoint generation and async request management, improving overall robustness of API integration capabilities.
1 parent c61f77b commit 56f5dd7

File tree

3 files changed

+205
-45
lines changed

3 files changed

+205
-45
lines changed

‎agentle/agents/apis/endpoint.py‎

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -381,9 +381,9 @@ async def make_single_request() -> Any:
381381
"""Make a single request attempt."""
382382
# Create a fresh connector for each request attempt to avoid "Session is closed" errors on retries
383383
connector = aiohttp.TCPConnector(**connector_kwargs)
384-
async with aiohttp.ClientSession(
385-
connector=connector, timeout=timeout
386-
) as session:
384+
session = None
385+
try:
386+
session = aiohttp.ClientSession(connector=connector, timeout=timeout)
387387
# Prepare request kwargs
388388
request_kwargs: dict[str, Any] = {
389389
"headers": headers,
@@ -486,6 +486,12 @@ async def make_single_request() -> Any:
486486
await self._response_cache.set(url, kwargs, result)
487487

488488
return result
489+
finally:
490+
# Always close the session to prevent "Session is closed" errors on retries
491+
if session is not None:
492+
await session.close()
493+
# Give the connector time to close properly
494+
await asyncio.sleep(0.01)
489495

490496
# Execute with retries
491497
last_exception = None

‎examples/agent_with_apis.py‎

Lines changed: 41 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -103,54 +103,53 @@ async def test_manual_api():
103103
return result
104104

105105

106-
async def test_openapi_spec():
107-
"""Test loading an API from an OpenAPI spec."""
106+
async def test_edge_cases():
107+
"""Test edge cases for function name generation."""
108108
print("\n" + "=" * 70)
109-
print("TEST 2: OpenAPI Spec Loading")
109+
print("TEST 2: Edge Cases for Function Name Generation")
110110
print("=" * 70)
111111

112-
try:
113-
# Load a real OpenAPI spec from a public API
114-
# Using PetStore API as it's a standard example
115-
api = await API.from_openapi_spec(
116-
"https://petstore3.swagger.io/api/v3/openapi.json",
117-
name="PetStore",
118-
base_url_override="https://petstore3.swagger.io/api/v3", # Override the relative base URL
119-
include_operations=["getPetById"], # Only include one simple operation
120-
)
112+
# Create API with various problematic path patterns
113+
api = API(
114+
name="EdgeCaseAPI",
115+
description="API to test edge cases in function name generation",
116+
base_url="https://jsonplaceholder.typicode.com",
117+
endpoints=[],
118+
)
121119

122-
print(f"✅ Loaded API: {api.name}")
123-
print(f" Base URL: {api.base_url}")
124-
print(f" Endpoints: {len(api.endpoints)}")
125-
126-
# Print endpoint names to verify they're valid
127-
for endpoint in api.endpoints:
128-
print(f" - {endpoint.name}: {endpoint.method.value} {endpoint.path}")
129-
130-
# Create agent with the API
131-
agent = Agent(
132-
name="Pet Store Assistant",
133-
generation_provider=GoogleGenerationProvider(
134-
use_vertex_ai=True, project="unicortex", location="global"
135-
),
136-
model="gemini-2.5-flash",
137-
instructions="You are a pet store assistant. You can look up pets by ID.",
138-
apis=[api],
139-
)
120+
# Test cases that previously would have failed
121+
test_cases = [
122+
# Path starting with number (after /)
123+
("/123/resource", "test_123_resource"),
124+
# Path with multiple slashes
125+
("/api/v1/users", "test_api_v1_users"),
126+
# Path with dashes
127+
("/user-profile", "test_user_profile"),
128+
# Path with only root
129+
("/", "test_root"),
130+
# Path with parameters
131+
("/users/{id}/posts/{postId}", "test_users_posts"),
132+
]
140133

141-
# Test the agent with a specific pet ID that should exist
142-
result = agent.run("Get information about pet with ID 1")
143-
print(f"\n✅ OpenAPI spec test passed!")
144-
print(f"Response preview: {result.text[:100]}...")
134+
print("\nTesting function name generation:")
135+
for path, name in test_cases:
136+
# Create endpoint with explicit name
137+
endpoint = Endpoint(
138+
name=name,
139+
description=f"Test endpoint for {path}",
140+
path=path,
141+
method=HTTPMethod.GET,
142+
)
143+
api.add_endpoint(endpoint)
145144

146-
return result
145+
# Convert to tool to verify the name is valid
146+
tool = endpoint.to_tool(base_url=api.base_url)
147+
print(f" ✓ {path} -> {tool.name}")
147148

148-
except Exception as e:
149-
print(f"⚠️ OpenAPI spec test skipped: {e}")
150-
import traceback
149+
print(f"\n✅ All {len(test_cases)} edge cases handled correctly!")
150+
print(f" Created {len(api.endpoints)} valid endpoints with valid function names")
151151

152-
traceback.print_exc()
153-
return None
152+
return api
154153

155154

156155
async def main():
@@ -161,8 +160,8 @@ async def main():
161160
# Test 1: Manual API creation
162161
await test_manual_api()
163162

164-
# Test 2: OpenAPI spec loading
165-
await test_openapi_spec()
163+
# Test 2: Edge cases for function name generation
164+
await test_edge_cases()
166165

167166
print("\n" + "=" * 70)
168167
print("✅ All API tests completed successfully!")

‎examples/test_api_openapi.py‎

Lines changed: 155 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,155 @@
1+
"""
2+
Test OpenAPI spec loading with function name validation.
3+
4+
This example demonstrates loading an API from an OpenAPI spec
5+
and verifying that all generated function names are valid.
6+
"""
7+
8+
import asyncio
9+
import re
10+
11+
from agentle.agents.apis.api import API
12+
13+
# Pattern from Google's adapter - function names must match this
14+
FUNCTION_NAME_PATTERN = re.compile(r"^[a-zA-Z_][a-zA-Z0-9_\.\-]*$")
15+
16+
17+
async def test_openapi_function_names():
18+
"""Test that OpenAPI spec loading generates valid function names."""
19+
print("\n🧪 Testing OpenAPI Spec Function Name Generation")
20+
print("=" * 70)
21+
22+
try:
23+
# Load PetStore API spec
24+
print("\n📥 Loading PetStore OpenAPI spec...")
25+
api = await API.from_openapi_spec(
26+
"https://petstore3.swagger.io/api/v3/openapi.json",
27+
name="PetStore",
28+
)
29+
30+
print(f"✅ Loaded API: {api.name}")
31+
print(f" Base URL: {api.base_url}")
32+
print(f" Total Endpoints: {len(api.endpoints)}")
33+
34+
# Validate all endpoint names
35+
print("\n🔍 Validating function names...")
36+
invalid_names = []
37+
38+
for endpoint in api.endpoints:
39+
if not FUNCTION_NAME_PATTERN.match(endpoint.name):
40+
invalid_names.append(endpoint.name)
41+
print(f" ❌ INVALID: {endpoint.name}")
42+
else:
43+
print(f" ✓ {endpoint.name}")
44+
45+
if invalid_names:
46+
print(f"\n❌ Found {len(invalid_names)} invalid function names!")
47+
print("Invalid names:", invalid_names)
48+
return False
49+
else:
50+
print(f"\n✅ All {len(api.endpoints)} function names are valid!")
51+
return True
52+
53+
except Exception as e:
54+
print(f"\n❌ Error: {e}")
55+
import traceback
56+
traceback.print_exc()
57+
return False
58+
59+
60+
async def test_edge_case_paths():
61+
"""Test OpenAPI spec with edge case paths."""
62+
print("\n🧪 Testing Edge Case Path Patterns")
63+
print("=" * 70)
64+
65+
# Create a mock OpenAPI spec with edge cases
66+
mock_spec = {
67+
"openapi": "3.0.0",
68+
"info": {"title": "Edge Case API", "version": "1.0.0"},
69+
"servers": [{"url": "https://api.example.com"}],
70+
"paths": {
71+
"/123-resource": {
72+
"get": {
73+
"operationId": None, # Force auto-generation
74+
"summary": "Get resource starting with number",
75+
}
76+
},
77+
"/api/v2/users": {
78+
"get": {
79+
"operationId": None,
80+
"summary": "Get users",
81+
}
82+
},
83+
"/user-profile": {
84+
"get": {
85+
"operationId": None,
86+
"summary": "Get user profile",
87+
}
88+
},
89+
"/": {
90+
"get": {
91+
"operationId": None,
92+
"summary": "Root endpoint",
93+
}
94+
},
95+
},
96+
}
97+
98+
# Remove None operationIds (they should be missing, not None)
99+
for path_item in mock_spec["paths"].values():
100+
for operation in path_item.values():
101+
if "operationId" in operation and operation["operationId"] is None:
102+
del operation["operationId"]
103+
104+
try:
105+
api = await API.from_openapi_spec(mock_spec, name="EdgeCaseAPI")
106+
107+
print(f)
108+
o.run(main()
109+
asyncimain__":me__ == "__
110+
if __na70)
111+
112+
=" * rint("
113+
p")s failed!sttet("❌ Some prin else:
114+
assed!")
115+
tests p"✅ All print(t2:
116+
resullt1 and if resu"=" * 70)
117+
\n" + print("
118+
aths()
119+
se_ptest_edge_cait = awat2esul
120+
rEdge cases: Test 2# )
121+
122+
mes(_napi_functiont_openait tes1 = awasult re c
123+
API speal Openst 1: Re
124+
# Te0)
125+
"=" * 7print(s")
126+
Testtionme Valida Na Functionint("API)
127+
pr" * 70"=("\n" + print."""
128+
estsl t""Run al
129+
" def main():
130+
131+
132+
asyncturn False rec()
133+
_ex.printtraceback back
134+
race import t {e}")
135+
Error: rint(f"\n❌
136+
p:s e at Exception
137+
excepll_valid
138+
return a )
139+
140+
d!"aliinvn names are functio Some \n❌ print(f"
141+
else:
142+
!")validn names are se functioAll edge ca"\n✅ print(f d:
143+
_vali if all se
144+
145+
= Fald l_vali al alid:
146+
if not is_v me}")
147+
int.na} -> {endpondpoint.path {e {status}f" nt( pri"
148+
else "❌if is_valid = "✓" ustat se)
149+
nt.namatch(endpoiPATTERN.m_NAME_NCTION_valid = FU ispoints:
150+
api.endpoint in end for True
151+
lid =ll_va aames
152+
all nte# Valida
153+
154+
)}")endpointslen(api.ndpoints: {(f" Eprint )
155+
.name}"api: {APIded "✅ Loa

0 commit comments

Comments
 (0)