feat(sdks): support x-request-id

Author: ninan-nn

sdks/code-interpreter/kotlin/code-interpreter/src/main/kotlin/com/alibaba/opensandbox/codeinterpreter/infrastructure/adapters/service/CodesAdapter.kt

@@ -126,6 +126,7 @@ class CodesAdapter(
                         message = message,
                         statusCode = response.code,
                         error = sandboxError ?: SandboxError(UNEXPECTED_RESPONSE),
+                        requestId = response.header("X-Request-ID"),
                     )
                 }
 

sdks/code-interpreter/kotlin/code-interpreter/src/test/kotlin/com/alibaba/opensandbox/codeinterpreter/infrastructure/adapters/service/CodesAdapterTest.kt

@@ -19,12 +19,14 @@ package com.alibaba.opensandbox.codeinterpreter.infrastructure.adapters.service
 import com.alibaba.opensandbox.codeinterpreter.domain.models.execd.executions.RunCodeRequest
 import com.alibaba.opensandbox.sandbox.HttpClientProvider
 import com.alibaba.opensandbox.sandbox.config.ConnectionConfig
+import com.alibaba.opensandbox.sandbox.domain.exceptions.SandboxApiException
 import com.alibaba.opensandbox.sandbox.domain.models.execd.executions.ExecutionHandlers
 import com.alibaba.opensandbox.sandbox.domain.models.sandboxes.SandboxEndpoint
 import okhttp3.mockwebserver.MockResponse
 import okhttp3.mockwebserver.MockWebServer
 import org.junit.jupiter.api.AfterEach
 import org.junit.jupiter.api.Assertions.assertEquals
+import org.junit.jupiter.api.Assertions.assertThrows
 import org.junit.jupiter.api.Assertions.assertTrue
 import org.junit.jupiter.api.BeforeEach
 import org.junit.jupiter.api.Test
@@ -133,4 +135,20 @@ class CodesAdapterTest {
         assertEquals("/code", request.requestUrl?.encodedPath)
         assertEquals("exec-123", request.requestUrl?.queryParameter("id"))
     }
+
+    @Test
+    fun `run should expose request id on api exception`() {
+        mockWebServer.enqueue(
+            MockResponse()
+                .setResponseCode(500)
+                .addHeader("X-Request-ID", "req-kotlin-code-123")
+                .setBody("""{"code":"INTERNAL_ERROR","message":"boom"}"""),
+        )
+
+        val request = RunCodeRequest.builder().code("print('boom')").build()
+        val ex = assertThrows(SandboxApiException::class.java) { codesAdapter.run(request) }
+
+        assertEquals(500, ex.statusCode)
+        assertEquals("req-kotlin-code-123", ex.requestId)
+    }
 }

sdks/code-interpreter/kotlin/gradle.properties

@@ -5,5 +5,5 @@ org.gradle.parallel=true
 
 # Project metadata
 project.group=com.alibaba.opensandbox
-project.version=1.0.4
+project.version=1.0.5
 project.description=A Kotlin SDK for Code Interpreter

sdks/code-interpreter/kotlin/gradle/libs.versions.toml

@@ -23,7 +23,7 @@ spotless = "6.23.3"
 maven-publish = "0.35.0"
 dokka = "1.9.10"
 jackson = "2.18.2"
-sandbox = "1.0.4"
+sandbox = "1.0.5"
 junit-platform = "1.13.4"
 
 [libraries]

sdks/code-interpreter/python/pyproject.toml

@@ -43,7 +43,7 @@ classifiers = [
 ]
 dependencies = [
     "pydantic>=2.4.2,<3.0",
-    "opensandbox>=0.1.1,<0.2.0",
+    "opensandbox>=0.1.5,<0.2.0",
 ]
 
 [project.urls]

sdks/code-interpreter/python/src/code_interpreter/adapters/code_adapter.py

@@ -32,6 +32,7 @@
     ExecutionEventDispatcher,
 )
 from opensandbox.adapters.converter.response_handler import (
+    extract_request_id,
     handle_api_error,
     require_parsed,
 )
@@ -287,6 +288,7 @@ async def run(
                     raise SandboxApiException(
                         message=f"Failed to run code. Status code: {response.status_code}",
                         status_code=response.status_code,
+                        request_id=extract_request_id(response.headers),
                     )
 
                 dispatcher = ExecutionEventDispatcher(execution, handlers)

sdks/code-interpreter/python/src/code_interpreter/sync/adapters/code_adapter.py

@@ -26,6 +26,7 @@
     ExceptionConverter,
 )
 from opensandbox.adapters.converter.response_handler import (
+    extract_request_id,
     handle_api_error,
     require_parsed,
 )
@@ -252,6 +253,7 @@ def run(
                     raise SandboxApiException(
                         message=f"Failed to run code. Status code: {response.status_code}",
                         status_code=response.status_code,
+                        request_id=extract_request_id(response.headers),
                     )
 
                 for line in response.iter_lines():

sdks/code-interpreter/python/tests/test_code_service_adapter_streaming.py

@@ -52,7 +52,12 @@ async def handle_async_request(self, request: httpx.Request) -> httpx.Response:
             )
             return httpx.Response(200, headers={"Content-Type": "text/event-stream"}, content=sse, request=request)
 
-        return httpx.Response(400, content=b"bad", request=request)
+        return httpx.Response(
+            400,
+            headers={"x-request-id": "req-code-123"},
+            content=b"bad",
+            request=request,
+        )
 
 
 def test_code_execution_converter_includes_context() -> None:
@@ -115,5 +120,6 @@ async def test_run_code_non_200_raises_api_exception() -> None:
     endpoint = SandboxEndpoint(endpoint="localhost:44772", port=44772)
     adapter = CodesAdapter(endpoint, cfg)
 
-    with pytest.raises(SandboxApiException):
+    with pytest.raises(SandboxApiException) as ei:
         await adapter.run("other")
+    assert ei.value.request_id == "req-code-123"

sdks/sandbox/csharp/README.md

@@ -55,6 +55,7 @@ try
 catch (SandboxException ex)
 {
     Console.Error.WriteLine($"Sandbox Error: [{ex.Error.Code}] {ex.Error.Message}");
+    Console.Error.WriteLine($"Request ID: {ex.RequestId}");
 }
 ```
 

sdks/sandbox/csharp/README_zh.md

@@ -55,6 +55,7 @@ try
 catch (SandboxException ex)
 {
     Console.Error.WriteLine($"沙箱错误: [{ex.Error.Code}] {ex.Error.Message}");
+    Console.Error.WriteLine($"Request ID: {ex.RequestId}");
 }
 ```