-
Notifications
You must be signed in to change notification settings - Fork 16
Expand file tree
/
Copy pathplatform_api.py
More file actions
371 lines (322 loc) · 17.6 KB
/
platform_api.py
File metadata and controls
371 lines (322 loc) · 17.6 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
# eval_protocol/platform_api.py
import logging
import sys
from typing import Any, Dict, Optional
import requests
from dotenv import find_dotenv, load_dotenv
from eval_protocol.auth import (
get_fireworks_account_id,
get_fireworks_api_base,
get_fireworks_api_key,
)
logger = logging.getLogger(__name__)
# --- Load .env files ---
# Attempt to load .env.dev first, then .env as a fallback.
# This happens when the module is imported.
# We use override=False (default) so that existing environment variables
# (e.g., set in the shell) are NOT overridden by .env files.
ENV_DEV_PATH = find_dotenv(filename=".env.dev", raise_error_if_not_found=False, usecwd=True)
if ENV_DEV_PATH:
load_dotenv(dotenv_path=ENV_DEV_PATH, override=False)
logger.info(f"eval_protocol.platform_api: Loaded environment variables from: {ENV_DEV_PATH}")
else:
ENV_PATH = find_dotenv(filename=".env", raise_error_if_not_found=False, usecwd=True)
if ENV_PATH:
load_dotenv(dotenv_path=ENV_PATH, override=False)
logger.info(f"eval_protocol.platform_api: Loaded environment variables from: {ENV_PATH}")
else:
logger.info(
"eval_protocol.platform_api: No .env.dev or .env file found. "
"Relying on shell/existing environment variables."
)
# --- End .env loading ---
class PlatformAPIError(Exception):
"""Custom exception for platform API errors."""
def __init__(
self,
message: str,
status_code: Optional[int] = None,
response_text: Optional[str] = None,
):
super().__init__(message)
self.status_code = status_code
self.response_text = response_text
def __str__(self) -> str:
return f"{super().__str__()} (Status: {self.status_code}, Response: {self.response_text or 'N/A'})"
def _normalize_secret_resource_id(key_name: str) -> str:
"""
Normalize a secret's resource ID for Fireworks paths:
- Lowercase
- Replace underscores with hyphens
- Leave other characters as-is (server enforces allowed set)
"""
return key_name.lower().replace("_", "-")
def create_or_update_fireworks_secret(
account_id: str,
key_name: str, # This is the identifier for the secret, e.g., "my-eval-api-key"
secret_value: str,
api_key: Optional[str] = None,
api_base: Optional[str] = None,
) -> bool:
"""
Creates a new secret on the Fireworks AI platform or updates it if it already exists.
The 'name' of the secret in Fireworks API terms is the resource path, while 'keyName' is the identifier.
Args:
account_id: Fireworks Account ID.
key_name: The identifier for the secret (e.g., "WOLFRAM_ALPHA_API_KEY", "my_eval_shim_key").
secret_value: The actual secret string.
api_key: Fireworks API key for authenticating this request. Resolves from env/config if None.
api_base: Fireworks API base URL. Resolves from env/config if None.
Returns:
True if successful, False otherwise.
"""
resolved_api_key = api_key or get_fireworks_api_key()
resolved_api_base = api_base or get_fireworks_api_base()
resolved_account_id = account_id # Must be provided
if not all([resolved_api_key, resolved_api_base, resolved_account_id]):
logger.error("Missing Fireworks API key, base URL, or account ID for creating/updating secret.")
return False
headers = {
"Authorization": f"Bearer {resolved_api_key}",
"Content-Type": "application/json",
}
# The secret_id for GET/PATCH/DELETE operations is the key_name.
# The 'name' field in the gatewaySecret model for POST/PATCH is a bit ambiguous.
# For POST (create), the body is gatewaySecret, which has 'name', 'keyName', 'value'.
# 'name' in POST body is likely just the 'keyName' or 'secret_id' for creation context,
# as the full resource name 'accounts/.../secrets/...' is server-generated.
# Let's assume for POST, we send 'keyName' and 'value'.
# For PATCH, the path contains {secret_id} which is the key_name. The body is also gatewaySecret.
# Check if secret exists using GET (path uses normalized resource id)
resource_id = _normalize_secret_resource_id(key_name)
get_url = f"{resolved_api_base.rstrip('/')}/v1/accounts/{resolved_account_id}/secrets/{resource_id}"
secret_exists = False
try:
response = requests.get(get_url, headers=headers, timeout=10)
if response.status_code == 200:
secret_exists = True
logger.info(f"Secret '{key_name}' already exists. Will attempt to update.")
elif response.status_code == 404:
logger.info(f"Secret '{key_name}' does not exist. Will attempt to create.")
secret_exists = False
elif response.status_code == 500: # As per user feedback, 500 on GET might mean not found
logger.warning(
f"Received 500 error when checking for secret '{key_name}'. Assuming it does not exist and will attempt to create. Response: {response.text}"
)
secret_exists = False
else:
logger.error(f"Error checking for secret '{key_name}': {response.status_code} - {response.text}")
return False
except requests.exceptions.RequestException as e:
logger.error(f"Request exception while checking for secret '{key_name}': {e}")
return False
if secret_exists:
# Update existing secret (PATCH)
patch_url = f"{resolved_api_base.rstrip('/')}/v1/accounts/{resolved_account_id}/secrets/{resource_id}"
# Body for PATCH requires 'keyName' and 'value'.
# Transform key_name for payload: uppercase and underscores
payload_key_name = key_name.upper().replace("-", "_")
# Ensure it starts with an uppercase letter (though .upper() should handle it)
if not payload_key_name or not payload_key_name[0].isupper():
# This case should be rare if key_name is not empty and contains letters
logger.warning(
f"Could not transform key_name '{key_name}' to valid starting uppercase for payload. Using default 'EP_SECRET.'"
)
payload_key_name = "EP_SECRET" # Fallback, though unlikely needed with .upper()
payload = {"keyName": payload_key_name, "value": secret_value}
try:
logger.debug(f"PATCH payload for '{key_name}': {payload}")
response = requests.patch(patch_url, headers=headers, json=payload, timeout=30)
response.raise_for_status()
logger.info(f"Successfully updated secret '{key_name}' on Fireworks platform.")
return True
except requests.exceptions.HTTPError as e:
logger.error(f"HTTP error updating secret '{key_name}': {e.response.status_code} - {e.response.text}")
return False
except requests.exceptions.RequestException as e:
logger.error(f"Request exception updating secret '{key_name}': {e}")
return False
else:
# Create new secret (POST)
post_url = f"{resolved_api_base.rstrip('/')}/v1/accounts/{resolved_account_id}/secrets"
# Body for POST is gatewaySecret. 'name' field in payload is the resource path.
# Let's assume for POST, the 'name' in payload can be omitted or is the key_name.
# The API should ideally use 'keyName' from URL or a specific 'secretId' in payload for creation if 'name' is server-assigned.
# Given the Swagger, 'name' is required in gatewaySecret.
# Let's try with 'name' being the 'key_name' for the payload, as the full path is not known yet.
# This might need adjustment based on actual API behavior.
# Construct the full 'name' path for the POST payload as per Swagger's title for 'name'
full_resource_name_for_payload = f"accounts/{resolved_account_id}/secrets/{resource_id}"
# Transform key_name for payload "keyName" field: uppercase and underscores
payload_key_name = key_name.upper().replace("-", "_")
if not payload_key_name or not payload_key_name[0].isupper():
logger.warning(
f"Could not transform key_name '{key_name}' to valid starting uppercase for payload. Using default 'EP_SECRET.'"
)
payload_key_name = "EP_SECRET"
payload = {
"name": full_resource_name_for_payload, # This 'name' is the resource path
"keyName": payload_key_name, # This 'keyName' is the specific field with new rules
"value": secret_value,
}
try:
logger.debug(f"POST payload for '{key_name}': {payload}")
response = requests.post(post_url, headers=headers, json=payload, timeout=30)
response.raise_for_status()
logger.info(
f"Successfully created secret '{key_name}' on Fireworks platform. Full name: {response.json().get('name')}"
)
return True
except requests.exceptions.HTTPError as e:
logger.error(f"HTTP error creating secret '{key_name}': {e.response.status_code} - {e.response.text}")
# If error is due to 'name' field, this log will show it.
return False
except requests.exceptions.RequestException as e:
logger.error(f"Request exception creating secret '{key_name}': {e}")
return False
def get_fireworks_secret(
account_id: str,
key_name: str, # This is the identifier for the secret
api_key: Optional[str] = None,
api_base: Optional[str] = None,
) -> Optional[Dict[str, Any]]:
"""
Retrieves a secret from the Fireworks AI platform by its keyName.
Note: This typically does not return the secret's actual value for security reasons,
but rather its metadata.
"""
resolved_api_key = api_key or get_fireworks_api_key()
resolved_api_base = api_base or get_fireworks_api_base()
resolved_account_id = account_id
if not all([resolved_api_key, resolved_api_base, resolved_account_id]):
logger.error("Missing Fireworks API key, base URL, or account ID for getting secret.")
return None
headers = {"Authorization": f"Bearer {resolved_api_key}"}
resource_id = _normalize_secret_resource_id(key_name)
url = f"{resolved_api_base.rstrip('/')}/v1/accounts/{resolved_account_id}/secrets/{resource_id}"
try:
response = requests.get(url, headers=headers, timeout=10)
if response.status_code == 200:
logger.info(f"Successfully retrieved secret '{key_name}'.")
return response.json()
elif response.status_code == 404:
logger.info(f"Secret '{key_name}' not found.")
return None
else:
logger.error(f"Error getting secret '{key_name}': {response.status_code} - {response.text}")
return None
except requests.exceptions.RequestException as e:
logger.error(f"Request exception while getting secret '{key_name}': {e}")
return None
def delete_fireworks_secret(
account_id: str,
key_name: str, # This is the identifier for the secret
api_key: Optional[str] = None,
api_base: Optional[str] = None,
) -> bool:
"""
Deletes a secret from the Fireworks AI platform by its keyName.
"""
resolved_api_key = api_key or get_fireworks_api_key()
resolved_api_base = api_base or get_fireworks_api_base()
resolved_account_id = account_id
if not all([resolved_api_key, resolved_api_base, resolved_account_id]):
logger.error("Missing Fireworks API key, base URL, or account ID for deleting secret.")
return False
headers = {"Authorization": f"Bearer {resolved_api_key}"}
resource_id = _normalize_secret_resource_id(key_name)
url = f"{resolved_api_base.rstrip('/')}/v1/accounts/{resolved_account_id}/secrets/{resource_id}"
try:
response = requests.delete(url, headers=headers, timeout=30)
if response.status_code == 200 or response.status_code == 204: # 204 No Content is also success for DELETE
logger.info(f"Successfully deleted secret '{key_name}'.")
return True
elif response.status_code == 404:
logger.info(f"Secret '{key_name}' not found, nothing to delete.")
return True
elif (
response.status_code == 500
): # As per user feedback, 500 on GET might mean not found, apply same logic for DELETE
logger.warning(
f"Received 500 error when deleting secret '{key_name}'. Assuming it might not have existed. Response: {response.text}"
)
return True # Consider deletion successful if it results in non-existence
else:
logger.error(f"Error deleting secret '{key_name}': {response.status_code} - {response.text}")
return False
except requests.exceptions.RequestException as e:
logger.error(f"Request exception while deleting secret '{key_name}': {e}")
return False
if __name__ == "__main__":
# Example usage for manual testing of secret management
logging.basicConfig(
level=logging.INFO,
format="%(asctime)s - %(levelname)s - %(name)s - %(message)s",
)
# Note: .env file loading is now handled at the module level when platform_api.py is imported.
# The section that was here for loading .env files specifically for __main__ has been removed
# to rely on the module-level loading.
# These should be set in your .env.dev, .env file (or shell environment) for this test to run
# FIREWORKS_API_KEY="your_fireworks_api_key"
# FIREWORKS_ACCOUNT_ID="your_fireworks_account_id"
# FIREWORKS_API_BASE="https://api.fireworks.ai" # or your dev/staging endpoint
test_account_id = get_fireworks_account_id()
test_api_key = get_fireworks_api_key() # Not passed directly, functions will resolve
test_api_base = get_fireworks_api_base()
logger.info("Attempting to use the following configuration for testing Fireworks secrets API:")
logger.info(f" Resolved FIREWORKS_ACCOUNT_ID: {test_account_id}")
logger.info(f" Resolved FIREWORKS_API_BASE: {test_api_base}")
logger.info(
f" Resolved FIREWORKS_API_KEY: {'********' + test_api_key[-4:] if test_api_key and len(test_api_key) > 4 else 'Not set or too short'}"
)
if not test_account_id or not test_api_key or not test_api_base:
logger.error(
"CRITICAL: FIREWORKS_ACCOUNT_ID, FIREWORKS_API_KEY, and FIREWORKS_API_BASE must be correctly set in environment or .env file to run this test."
)
import sys # Make sure sys is imported if using sys.exit
sys.exit(1)
test_secret_key_name = "rewardkit-test-secret-delete-me" # Changed to be valid
test_secret_value = "test_secret_value_12345"
updated_secret_value = "updated_secret_value_67890"
logger.info(f"--- Testing Fireworks Secret Management for account: {test_account_id} ---")
# 1. Ensure it doesn't exist initially (or delete if it does from a previous failed run)
logger.info(f"\n[Test Step 0] Attempting to delete '{test_secret_key_name}' if it exists (cleanup)...")
delete_fireworks_secret(test_account_id, test_secret_key_name)
retrieved = get_fireworks_secret(test_account_id, test_secret_key_name)
if retrieved is None:
logger.info(f"Confirmed secret '{test_secret_key_name}' does not exist before creation test.")
else:
logger.error(f"Secret '{test_secret_key_name}' still exists after cleanup attempt. Manual check needed.")
# sys.exit(1) # Optional: make it fatal
# 2. Create secret
logger.info(f"\n[Test Step 1] Creating secret '{test_secret_key_name}' with value '{test_secret_value}'...")
success_create = create_or_update_fireworks_secret(test_account_id, test_secret_key_name, test_secret_value)
logger.info(f"Create operation success: {success_create}")
# 3. Get secret (to verify creation, though value won't be returned)
logger.info(f"\n[Test Step 2] Getting secret '{test_secret_key_name}'...")
retrieved_after_create = get_fireworks_secret(test_account_id, test_secret_key_name)
if retrieved_after_create:
logger.info(f"Retrieved secret metadata: {retrieved_after_create}")
# Assert against the transformed keyName that's expected in the payload/response body
expected_payload_key_name = test_secret_key_name.upper().replace("-", "_")
assert retrieved_after_create.get("keyName") == expected_payload_key_name
assert retrieved_after_create.get("value") == test_secret_value # Also check value if returned
else:
logger.error(f"Failed to retrieve secret '{test_secret_key_name}' after creation.")
# 4. Update secret
logger.info(f"\n[Test Step 3] Updating secret '{test_secret_key_name}' with value '{updated_secret_value}'...")
success_update = create_or_update_fireworks_secret(test_account_id, test_secret_key_name, updated_secret_value)
logger.info(f"Update operation success: {success_update}")
# (Getting again won't show the value, so we assume PATCH worked if it returned True)
# 5. Delete secret
logger.info(f"\n[Test Step 4] Deleting secret '{test_secret_key_name}'...")
success_delete = delete_fireworks_secret(test_account_id, test_secret_key_name)
logger.info(f"Delete operation success: {success_delete}")
# 6. Get secret (to verify deletion)
logger.info(f"\n[Test Step 5] Getting secret '{test_secret_key_name}' again to confirm deletion...")
retrieved_after_delete = get_fireworks_secret(test_account_id, test_secret_key_name)
if retrieved_after_delete is None:
logger.info(f"Secret '{test_secret_key_name}' successfully confirmed as deleted.")
else:
logger.error(f"Secret '{test_secret_key_name}' still exists after delete operation: {retrieved_after_delete}")
logger.info("\n--- Test script finished ---")