Compare commits
2 Commits
f584c3e53b
...
f101d8bd3e
| Author | SHA1 | Date | |
|---|---|---|---|
| f101d8bd3e | |||
| 7e2be324ff |
@ -161,6 +161,14 @@ async def _handle_submit(
|
|||||||
await _finalize_zero(frozen_id, record.proxy_call_id, "error exception")
|
await _finalize_zero(frozen_id, record.proxy_call_id, "error exception")
|
||||||
raise HTTPException(status_code=502, detail=f"Provider unreachable: {exc}") from exc
|
raise HTTPException(status_code=502, detail=f"Provider unreachable: {exc}") from exc
|
||||||
|
|
||||||
|
# HTTP-level failure
|
||||||
|
if status_code >= 400:
|
||||||
|
reason = f"error_http_{status_code}"
|
||||||
|
await _finalize_zero(frozen_id, record.proxy_call_id, reason)
|
||||||
|
if resp_json is not None:
|
||||||
|
ledger.update_response(record.proxy_call_id, resp_json)
|
||||||
|
return Response(content=resp_body, status_code=status_code, headers=resp_headers, media_type="application/json")
|
||||||
|
|
||||||
resp_json = _try_parse_json(resp_body)
|
resp_json = _try_parse_json(resp_body)
|
||||||
|
|
||||||
if resp_json is None:
|
if resp_json is None:
|
||||||
@ -189,14 +197,6 @@ async def _handle_submit(
|
|||||||
media_type = resp_headers.get("content-type")
|
media_type = resp_headers.get("content-type")
|
||||||
return Response(content=resp_body, status_code=status_code, headers=resp_headers, media_type=media_type)
|
return Response(content=resp_body, status_code=status_code, headers=resp_headers, media_type=media_type)
|
||||||
|
|
||||||
# HTTP-level failure
|
|
||||||
if status_code >= 400:
|
|
||||||
reason = f"error_http_{status_code}"
|
|
||||||
await _finalize_zero(frozen_id, record.proxy_call_id, reason)
|
|
||||||
if resp_json is not None:
|
|
||||||
ledger.update_response(record.proxy_call_id, resp_json)
|
|
||||||
return Response(content=resp_body, status_code=status_code, headers=resp_headers, media_type="application/json")
|
|
||||||
|
|
||||||
# Extract task_id from response; no task_id means provider rejected at business level
|
# Extract task_id from response; no task_id means provider rejected at business level
|
||||||
provider_task_id: str | None = None
|
provider_task_id: str | None = None
|
||||||
if resp_json is not None:
|
if resp_json is not None:
|
||||||
|
|||||||
@ -215,15 +215,14 @@ async def forward_request(
|
|||||||
) -> tuple[int, dict[str, str], bytes]:
|
) -> tuple[int, dict[str, str], bytes]:
|
||||||
"""Forward *method* *path* to the provider and return (status_code, headers, body).
|
"""Forward *method* *path* to the provider and return (status_code, headers, body).
|
||||||
|
|
||||||
The provider's API key (read from the environment variable named in
|
If configured, the provider API key from ``provider_config.api_key_env``
|
||||||
``provider_config.api_key_env``) is injected automatically, replacing
|
is used to replace API key marker placeholders in forwarded headers/body.
|
||||||
any Authorization header the caller might have sent.
|
|
||||||
"""
|
"""
|
||||||
target_url = provider_config.base_url.rstrip("/") + "/" + path.lstrip("/")
|
target_url = provider_config.base_url.rstrip("/") + "/" + path.lstrip("/")
|
||||||
if query_params:
|
if query_params:
|
||||||
target_url += "?" + query_params
|
target_url += "?" + query_params
|
||||||
|
|
||||||
# Build forwarded headers: drop internal/hop-by-hop, then inject API key
|
# Build forwarded headers: drop internal/hop-by-hop, then replace API key markers.
|
||||||
forward_headers = {
|
forward_headers = {
|
||||||
k: v for k, v in headers.items() if k.lower() not in _STRIP_REQUEST_HEADERS
|
k: v for k, v in headers.items() if k.lower() not in _STRIP_REQUEST_HEADERS
|
||||||
}
|
}
|
||||||
@ -233,7 +232,6 @@ async def forward_request(
|
|||||||
# Dependency-injection style: replace marker placeholders first.
|
# Dependency-injection style: replace marker placeholders first.
|
||||||
forward_headers = _replace_api_key_marker_in_headers(forward_headers, api_key)
|
forward_headers = _replace_api_key_marker_in_headers(forward_headers, api_key)
|
||||||
body = _replace_api_key_marker_in_body(forward_headers, body, api_key)
|
body = _replace_api_key_marker_in_body(forward_headers, body, api_key)
|
||||||
forward_headers[provider_config.api_key_header] = provider_config.api_key_prefix + api_key
|
|
||||||
else:
|
else:
|
||||||
logger.warning(
|
logger.warning(
|
||||||
"[ThirdPartyProxy] api_key_env '%s' is not set for provider",
|
"[ThirdPartyProxy] api_key_env '%s' is not set for provider",
|
||||||
|
|||||||
@ -79,14 +79,6 @@ class ThirdPartyProviderConfig(BaseModel):
|
|||||||
default=None,
|
default=None,
|
||||||
description="Name of the environment variable holding the API key",
|
description="Name of the environment variable holding the API key",
|
||||||
)
|
)
|
||||||
api_key_header: str = Field(
|
|
||||||
default="Authorization",
|
|
||||||
description="Request header name for the API key",
|
|
||||||
)
|
|
||||||
api_key_prefix: str = Field(
|
|
||||||
default="Bearer ",
|
|
||||||
description="String prepended to the API key value in the header",
|
|
||||||
)
|
|
||||||
timeout_seconds: float = Field(
|
timeout_seconds: float = Field(
|
||||||
default=30.0,
|
default=30.0,
|
||||||
gt=0,
|
gt=0,
|
||||||
|
|||||||
@ -61,8 +61,6 @@ third_party_proxy:
|
|||||||
runninghub:
|
runninghub:
|
||||||
base_url: https://www.runninghub.cn
|
base_url: https://www.runninghub.cn
|
||||||
api_key_env: RUNNINGHUB_API_KEY
|
api_key_env: RUNNINGHUB_API_KEY
|
||||||
api_key_header: Authorization
|
|
||||||
api_key_prefix: "Bearer "
|
|
||||||
timeout_seconds: 30.0
|
timeout_seconds: 30.0
|
||||||
frozen_amount: 10.0
|
frozen_amount: 10.0
|
||||||
frozen_type: 2
|
frozen_type: 2
|
||||||
@ -102,8 +100,6 @@ third_party_proxy:
|
|||||||
dashscope:
|
dashscope:
|
||||||
base_url: https://dashscope.aliyuncs.com
|
base_url: https://dashscope.aliyuncs.com
|
||||||
api_key_env: DASHSCOPE_API_KEY
|
api_key_env: DASHSCOPE_API_KEY
|
||||||
api_key_header: Authorization
|
|
||||||
api_key_prefix: "Bearer "
|
|
||||||
timeout_seconds: 60.0
|
timeout_seconds: 60.0
|
||||||
frozen_token: 32768
|
frozen_token: 32768
|
||||||
submit_routes:
|
submit_routes:
|
||||||
|
|||||||
@ -9,7 +9,7 @@ Applicable scenarios:
|
|||||||
## 1. Migration Goals
|
## 1. Migration Goals
|
||||||
|
|
||||||
1. The skill no longer calls third-party domains directly.
|
1. The skill no longer calls third-party domains directly.
|
||||||
2. The skill no longer manages third-party API keys itself.
|
2. Real API keys are replaced by an API key marker in scripts being migrated.
|
||||||
3. All requests go through `/api/proxy/{provider}/...`.
|
3. All requests go through `/api/proxy/{provider}/...`.
|
||||||
4. Gateway handles:
|
4. Gateway handles:
|
||||||
- API key injection
|
- API key injection
|
||||||
@ -22,7 +22,11 @@ Applicable scenarios:
|
|||||||
1. Keep provider names stable (for example, `runninghub`); do not encode model paths in provider names.
|
1. Keep provider names stable (for example, `runninghub`); do not encode model paths in provider names.
|
||||||
2. Only submit requests should carry `X-Idempotency-Key`; query requests should not.
|
2. Only submit requests should carry `X-Idempotency-Key`; query requests should not.
|
||||||
3. Use `X-Thread-Id` as a common context header whenever available.
|
3. Use `X-Thread-Id` as a common context header whenever available.
|
||||||
4. Use shorthand dot-paths in config extraction fields:
|
4. Replace API key usage in scripts with marker `API_KEY_MARKER = "__API_KEY_MARKER__"` at the actual usage location:
|
||||||
|
- If the script uses header auth, replace with `Authorization: Bearer __API_KEY_MARKER__`.
|
||||||
|
- If the script uses body auth, replace the body `apiKey` field value with `__API_KEY_MARKER__`.
|
||||||
|
- Choose header/body based on the script's real provider contract; do not force a single style.
|
||||||
|
5. Use shorthand dot-paths in config extraction fields:
|
||||||
- Correct: `taskId`, `status`, `usage.thirdPartyConsumeMoney`
|
- Correct: `taskId`, `status`, `usage.thirdPartyConsumeMoney`
|
||||||
- Incorrect: `$.taskId`, `'$'.taskId`
|
- Incorrect: `$.taskId`, `'$'.taskId`
|
||||||
|
|
||||||
@ -45,6 +49,7 @@ Implement:
|
|||||||
- always sets `Content-Type: application/json`
|
- always sets `Content-Type: application/json`
|
||||||
- optionally sets `X-Thread-Id`
|
- optionally sets `X-Thread-Id`
|
||||||
- sets `X-Idempotency-Key` only when `include_idempotency=True`
|
- sets `X-Idempotency-Key` only when `include_idempotency=True`
|
||||||
|
- if this script authenticates via header, set `Authorization: Bearer __API_KEY_MARKER__`
|
||||||
|
|
||||||
### Step 3: Route submit calls through gateway
|
### Step 3: Route submit calls through gateway
|
||||||
|
|
||||||
@ -68,13 +73,15 @@ With:
|
|||||||
And use:
|
And use:
|
||||||
- `headers=build_proxy_headers()`
|
- `headers=build_proxy_headers()`
|
||||||
|
|
||||||
### Step 5: Remove third-party API key logic from the skill
|
### Step 5: Replace third-party API key values with marker (do not keep real keys in scripts)
|
||||||
|
|
||||||
Remove:
|
Replace in the script being migrated:
|
||||||
- Loading `RUNNINGHUB_API_KEY` in the script
|
- Any real `Authorization: Bearer <real-key>` value -> `Authorization: Bearer __API_KEY_MARKER__`
|
||||||
- Building `Authorization: Bearer ...` in the script
|
- Any real body `apiKey` value -> `"apiKey": "__API_KEY_MARKER__"`
|
||||||
|
|
||||||
Reason: third-party credentials are injected by gateway.
|
Keep the original auth location (header vs body) unchanged unless provider API requirements changed.
|
||||||
|
|
||||||
|
Reason: gateway injects real credentials by replacing marker values at proxy forwarding time.
|
||||||
|
|
||||||
### Step 6: Keep essential error handling
|
### Step 6: Keep essential error handling
|
||||||
|
|
||||||
@ -115,8 +122,6 @@ third_party_proxy:
|
|||||||
runninghub:
|
runninghub:
|
||||||
base_url: https://www.runninghub.cn
|
base_url: https://www.runninghub.cn
|
||||||
api_key_env: RUNNINGHUB_API_KEY
|
api_key_env: RUNNINGHUB_API_KEY
|
||||||
api_key_header: Authorization
|
|
||||||
api_key_prefix: "Bearer "
|
|
||||||
timeout_seconds: 30.0
|
timeout_seconds: 30.0
|
||||||
frozen_amount: 10.0
|
frozen_amount: 10.0
|
||||||
frozen_type: 2
|
frozen_type: 2
|
||||||
@ -150,10 +155,12 @@ from pathlib import Path
|
|||||||
|
|
||||||
from dotenv import dotenv_values
|
from dotenv import dotenv_values
|
||||||
|
|
||||||
|
API_KEY_MARKER = "__API_KEY_MARKER__"
|
||||||
|
|
||||||
|
|
||||||
def load_skill_env() -> dict[str, str]:
|
def load_skill_env() -> dict[str, str]:
|
||||||
"""Load skill-local .env values."""
|
"""Load skill-local .env values."""
|
||||||
env_path = Path(__file__).parent.parent / ".env"
|
env_path = Path(__file__).parent / ".env"
|
||||||
return {
|
return {
|
||||||
key: value
|
key: value
|
||||||
for key, value in dotenv_values(env_path).items()
|
for key, value in dotenv_values(env_path).items()
|
||||||
@ -184,6 +191,13 @@ def build_proxy_headers(*, include_idempotency: bool = False) -> dict[str, str]:
|
|||||||
from uuid import uuid4
|
from uuid import uuid4
|
||||||
headers["X-Idempotency-Key"] = str(uuid4())
|
headers["X-Idempotency-Key"] = str(uuid4())
|
||||||
return headers
|
return headers
|
||||||
|
|
||||||
|
|
||||||
|
# Optional helper when provider requires header auth in script contract:
|
||||||
|
def build_proxy_headers_with_auth(*, include_idempotency: bool = False) -> dict[str, str]:
|
||||||
|
headers = build_proxy_headers(include_idempotency=include_idempotency)
|
||||||
|
headers["Authorization"] = f"Bearer {API_KEY_MARKER}"
|
||||||
|
return headers
|
||||||
```
|
```
|
||||||
|
|
||||||
## 6. Common Pitfalls
|
## 6. Common Pitfalls
|
||||||
@ -206,7 +220,7 @@ For Docker-based sandbox execution, use:
|
|||||||
## 7. Validation Checklist
|
## 7. Validation Checklist
|
||||||
|
|
||||||
1. No direct third-party domain calls remain in the skill script.
|
1. No direct third-party domain calls remain in the skill script.
|
||||||
2. The skill script no longer reads third-party API keys.
|
2. The skill script no longer contains real third-party API key values.
|
||||||
3. Submit uses proxy URL + `include_idempotency=True`.
|
3. Submit uses proxy URL + `include_idempotency=True`.
|
||||||
4. Query uses proxy URL + `include_idempotency=False`.
|
4. Query uses proxy URL + `include_idempotency=False`.
|
||||||
5. Config extraction fields use shorthand dot-paths only.
|
5. Config extraction fields use shorthand dot-paths only.
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user