Merge pull request #76 from ninan-nn/feature/refacotr_sandbox_uuid

Refactor Sandbox Id

Author: hittyt

sdks/code-interpreter/kotlin/code-interpreter/src/main/kotlin/com/alibaba/opensandbox/codeinterpreter/CodeInterpreter.kt

@@ -24,7 +24,6 @@ import com.alibaba.opensandbox.sandbox.domain.exceptions.SandboxException
 import com.alibaba.opensandbox.sandbox.domain.exceptions.SandboxInternalException
 import com.alibaba.opensandbox.sandbox.domain.models.execd.DEFAULT_EXECD_PORT
 import org.slf4j.LoggerFactory
-import java.util.UUID
 
 /**
  * Code Interpreter SDK providing secure, isolated code execution capabilities.
@@ -92,7 +91,7 @@ class CodeInterpreter internal constructor(
     /**
      * Gets the unique identifier of this code interpreter (same as underlying sandbox ID).
      */
-    val id: UUID get() = sandbox.id
+    val id: String get() = sandbox.id
 
     /**
      * Provides access to file system operations within the sandbox.

sdks/code-interpreter/kotlin/code-interpreter/src/test/kotlin/com/alibaba/opensandbox/codeinterpreter/CodeInterpreterTest.kt

@@ -31,7 +31,6 @@ import org.junit.jupiter.api.Assertions.assertSame
 import org.junit.jupiter.api.BeforeEach
 import org.junit.jupiter.api.Test
 import org.junit.jupiter.api.extension.ExtendWith
-import java.util.UUID
 
 @ExtendWith(MockKExtension::class)
 class CodeInterpreterTest {
@@ -42,7 +41,7 @@ class CodeInterpreterTest {
     lateinit var codeService: Codes
 
     private lateinit var codeInterpreter: CodeInterpreter
-    private val sandboxId = UUID.randomUUID()
+    private val sandboxId = "sandbox-id"
 
     @BeforeEach
     fun setUp() {

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

@@ -22,7 +22,6 @@
 """
 
 import logging
-from uuid import UUID
 
 from opensandbox.exceptions import (
     InvalidArgumentException,
@@ -110,12 +109,12 @@ def sandbox(self) -> Sandbox:
         return self._sandbox
 
     @property
-    def id(self) -> UUID:
+    def id(self) -> str:
         """
         Gets the unique identifier of this code interpreter (same as underlying sandbox ID).
 
         Returns:
-            UUID of the code interpreter/sandbox
+            ID of the code interpreter/sandbox
         """
         return self._sandbox.id
 

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

@@ -18,7 +18,6 @@
 """
 
 import logging
-from uuid import UUID
 
 from opensandbox.constants import DEFAULT_EXECD_PORT
 from opensandbox.exceptions import (
@@ -93,12 +92,12 @@ def sandbox(self) -> SandboxSync:
         return self._sandbox
 
     @property
-    def id(self) -> UUID:
+    def id(self) -> str:
         """
         Gets the unique identifier of this code interpreter (same as underlying sandbox ID).
 
         Returns:
-            UUID of the code interpreter/sandbox
+            ID of the code interpreter/sandbox
         """
         return self._sandbox.id
 

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

@@ -23,7 +23,7 @@
 
 class _FakeSandbox:
     def __init__(self) -> None:
-        self._id = __import__("uuid").uuid4()
+        self._id = str(__import__("uuid").uuid4())
         self.connection_config = ConnectionConfig(protocol="http")
         self.files = object()
         self.commands = object()

sdks/sandbox/kotlin/README.md

@@ -196,7 +196,7 @@ PagedSandboxInfos sandboxes = manager.listSandboxInfos(
 sandboxes.getSandboxInfos().forEach(info -> {
     System.out.println("Found sandbox: " + info.getId());
     // Perform admin actions
-    manager.killSandbox(UUID.fromString(info.getId()));
+    manager.killSandbox(info.getId());
 });
 
 // Try-with-resources will automatically call manager.close()

sdks/sandbox/kotlin/README_zh.md

@@ -197,7 +197,7 @@ PagedSandboxInfos sandboxes = manager.listSandboxInfos(
 sandboxes.getSandboxInfos().forEach(info -> {
     System.out.println("Found sandbox: " + info.getId());
     // 执行管理操作
-    manager.killSandbox(UUID.fromString(info.getId()));
+    manager.killSandbox(info.getId());
 });
 
 // Try-with-resources 会自动调用 manager.close()

sdks/sandbox/kotlin/sandbox/src/main/kotlin/com/alibaba/opensandbox/sandbox/Sandbox.kt

@@ -36,7 +36,6 @@ import com.alibaba.opensandbox.sandbox.infrastructure.factory.AdapterFactory
 import org.slf4j.LoggerFactory
 import java.time.Duration
 import java.time.OffsetDateTime
-import java.util.UUID
 
 /**
  * Main entrypoint for the Open Sandbox SDK providing secure, isolated execution environments.
@@ -76,7 +75,7 @@ import java.util.UUID
  *
  */
 class Sandbox internal constructor(
-    val id: UUID,
+    val id: String,
     private val sandboxService: Sandboxes,
     private val fileSystemService: Filesystem,
     private val commandService: Commands,
@@ -147,11 +146,11 @@ class Sandbox internal constructor(
          * Initialization result indicating the type of sandbox being initialized.
          */
         private sealed class InitializationResult {
-            abstract val id: UUID
+            abstract val id: String
 
-            data class NewSandbox(override val id: UUID) : InitializationResult()
+            data class NewSandbox(override val id: String) : InitializationResult()
 
-            data class ExistingSandbox(override val id: UUID) : InitializationResult()
+            data class ExistingSandbox(override val id: String) : InitializationResult()
         }
 
         /**
@@ -310,7 +309,7 @@ class Sandbox internal constructor(
          * @throws SandboxException if connection fails
          */
         private fun connect(
-            sandboxId: UUID,
+            sandboxId: String,
             connectionConfig: ConnectionConfig,
             healthCheck: ((Sandbox) -> Boolean)? = null,
             connectTimeout: Duration,
@@ -347,7 +346,7 @@ class Sandbox internal constructor(
          * @throws SandboxException if resume or readiness check fails
          */
         private fun resume(
-            sandboxId: UUID,
+            sandboxId: String,
             connectionConfig: ConnectionConfig,
             healthCheck: ((Sandbox) -> Boolean)? = null,
             resumeTimeout: Duration,
@@ -561,7 +560,7 @@ class Sandbox internal constructor(
         /**
          * Sandbox ID to connect to
          */
-        private var sandboxId: UUID? = null
+        private var sandboxId: String? = null
 
         /**
          * Connection config
@@ -593,11 +592,11 @@ class Sandbox internal constructor(
         /**
          * Sets the sandbox ID to connect to.
          *
-         * @param sandboxId UUID string of the existing sandbox
+         * @param sandboxId ID of the existing sandbox
          * @return This connector for method chaining
          * @throws InvalidArgumentException if sandboxId is blank
          */
-        fun sandboxId(sandboxId: UUID): Connector {
+        fun sandboxId(sandboxId: String): Connector {
             this.sandboxId = sandboxId
             return this
         }
@@ -1098,7 +1097,7 @@ class Sandbox internal constructor(
         /**
          * Sandbox ID to resume
          */
-        private var sandboxId: UUID? = null
+        private var sandboxId: String? = null
 
         /**
          * Connection config
@@ -1130,10 +1129,10 @@ class Sandbox internal constructor(
         /**
          * Sets the sandbox ID to resume.
          *
-         * @param sandboxId UUID of the paused sandbox
+         * @param sandboxId ID of the paused sandbox
          * @return This resumer for method chaining
          */
-        fun sandboxId(sandboxId: UUID): Resumer {
+        fun sandboxId(sandboxId: String): Resumer {
             this.sandboxId = sandboxId
             return this
         }

sdks/sandbox/kotlin/sandbox/src/main/kotlin/com/alibaba/opensandbox/sandbox/SandboxManager.kt

@@ -28,7 +28,6 @@ import com.alibaba.opensandbox.sandbox.infrastructure.factory.AdapterFactory
 import org.slf4j.LoggerFactory
 import java.time.Duration
 import java.time.OffsetDateTime
-import java.util.UUID
 
 /**
  * Sandbox management interface for administrative operations and monitoring sandbox instances.
@@ -56,7 +55,7 @@ import java.util.UUID
  * )
  *
  * // Individual operations
- * val sandboxId = UUID.fromString("sandbox-id")
+ * val sandboxId = "sandbox-id"
  * manager.getSandboxInfo(sandboxId)
  * manager.pauseSandbox(sandboxId)
  * manager.resumeSandbox(sandboxId)
@@ -105,7 +104,7 @@ class SandboxManager internal constructor(
      * @return SandboxInfo for the specified sandbox
      * @throws SandboxException if the operation fails
      */
-    fun getSandboxInfo(sandboxId: UUID): SandboxInfo {
+    fun getSandboxInfo(sandboxId: String): SandboxInfo {
         logger.debug("Getting info for sandbox: {}", sandboxId)
         return sandboxService.getSandboxInfo(sandboxId)
     }
@@ -116,7 +115,7 @@ class SandboxManager internal constructor(
      * @param sandboxId Sandbox ID to terminate
      * @throws SandboxException if the operation fails
      */
-    fun killSandbox(sandboxId: UUID) {
+    fun killSandbox(sandboxId: String) {
         logger.info("Terminating sandbox: {}", sandboxId)
         sandboxService.killSandbox(sandboxId)
         logger.info("Successfully terminated sandbox: {}", sandboxId)
@@ -132,7 +131,7 @@ class SandboxManager internal constructor(
      * @throws SandboxException if the operation fails
      */
     fun renewSandbox(
-        sandboxId: UUID,
+        sandboxId: String,
         timeout: Duration,
     ): SandboxRenewResponse {
         logger.info("Renew expiration for sandbox {} to {}", sandboxId, OffsetDateTime.now().plus(timeout))
@@ -145,7 +144,7 @@ class SandboxManager internal constructor(
      * @param sandboxId Sandbox ID to pause
      * @throws SandboxException if the operation fails
      */
-    fun pauseSandbox(sandboxId: UUID) {
+    fun pauseSandbox(sandboxId: String) {
         logger.info("Pausing sandbox: {}", sandboxId)
         sandboxService.pauseSandbox(sandboxId)
     }
@@ -156,7 +155,7 @@ class SandboxManager internal constructor(
      * @param sandboxId Sandbox ID to resume
      * @throws SandboxException if the operation fails
      */
-    fun resumeSandbox(sandboxId: UUID) {
+    fun resumeSandbox(sandboxId: String) {
         logger.info("Resuming sandbox: {}", sandboxId)
         sandboxService.resumeSandbox(sandboxId)
     }

sdks/sandbox/kotlin/sandbox/src/main/kotlin/com/alibaba/opensandbox/sandbox/config/ConnectionConfig.kt

@@ -50,6 +50,7 @@ class ConnectionConfig private constructor(
         private const val ENV_DOMAIN = "OPEN_SANDBOX_DOMAIN"
 
         private const val DEFAULT_USER_AGENT = "OpenSandbox-Kotlin-SDK/1.0.1"
+        private const val API_VERSION = "v1"
 
         @JvmStatic
         fun builder(): Builder = Builder()
@@ -69,7 +70,7 @@ class ConnectionConfig private constructor(
         if (currentDomain.startsWith("http://") || currentDomain.startsWith("https://")) {
             return currentDomain
         }
-        return "$protocol://$currentDomain"
+        return "$protocol://$currentDomain/$API_VERSION"
     }
 
     /**