feat: set 'jetbrains_connection' as build reason on workspace start (#150)

kacpersaw · web-flow · commit 478a5b1b6a8f · 2025-07-22T13:14:45.000+02:00
This PR is part of coder/coder#18827 which introduces new build reason values to identify what type of connection triggered a workspace build, helping to troubleshoot workspace-related issues.
diff --git a/src/main/kotlin/com/coder/toolbox/sdk/CoderRestClient.kt b/src/main/kotlin/com/coder/toolbox/sdk/CoderRestClient.kt
@@ -15,6 +15,7 @@ import com.coder.toolbox.sdk.v2.models.User
 import com.coder.toolbox.sdk.v2.models.Workspace
 import com.coder.toolbox.sdk.v2.models.WorkspaceAgent
 import com.coder.toolbox.sdk.v2.models.WorkspaceBuild
+import com.coder.toolbox.sdk.v2.models.WorkspaceBuildReason
 import com.coder.toolbox.sdk.v2.models.WorkspaceResource
 import com.coder.toolbox.sdk.v2.models.WorkspaceStatus
 import com.coder.toolbox.sdk.v2.models.WorkspaceTransition
@@ -271,7 +272,12 @@ open class CoderRestClient(
      * @throws [APIResponseException].
      */
     suspend fun startWorkspace(workspace: Workspace): WorkspaceBuild {
-        val buildRequest = CreateWorkspaceBuildRequest(null, WorkspaceTransition.START)
+        val buildRequest = CreateWorkspaceBuildRequest(
+            null,
+            WorkspaceTransition.START,
+            null,
+            WorkspaceBuildReason.JETBRAINS_CONNECTION
+        )
         val buildResponse = retroRestClient.createWorkspaceBuild(workspace.id, buildRequest)
         if (buildResponse.code() != HttpURLConnection.HTTP_CREATED) {
             throw APIResponseException(
diff --git a/src/main/kotlin/com/coder/toolbox/sdk/v2/models/CreateWorkspaceBuildRequest.kt b/src/main/kotlin/com/coder/toolbox/sdk/v2/models/CreateWorkspaceBuildRequest.kt
@@ -10,7 +10,8 @@ data class CreateWorkspaceBuildRequest(
     @Json(name = "template_version_id") val templateVersionID: UUID?,
     // Use to start, stop and delete the workspace.
     @Json(name = "transition") val transition: WorkspaceTransition,
-    @Json(name = "orphan") var orphan: Boolean? = null
+    @Json(name = "orphan") var orphan: Boolean? = null,
+    @Json(name = "reason") var reason: WorkspaceBuildReason? = null
 ) {
     override fun equals(other: Any?): Boolean {
         if (this === other) return true
@@ -21,13 +22,15 @@ data class CreateWorkspaceBuildRequest(
         if (templateVersionID != other.templateVersionID) return false
         if (transition != other.transition) return false
         if (orphan != other.orphan) return false
+        if (reason != other.reason) return false
         return true
     }
 
     override fun hashCode(): Int {
         var result = orphan?.hashCode() ?: 0
         result = 31 * result + (templateVersionID?.hashCode() ?: 0)
         result = 31 * result + transition.hashCode()
+        result = 31 * result + (reason?.hashCode() ?: 0)
         return result
     }
 }
diff --git a/src/main/kotlin/com/coder/toolbox/sdk/v2/models/WorkspaceBuildReason.kt b/src/main/kotlin/com/coder/toolbox/sdk/v2/models/WorkspaceBuildReason.kt
@@ -0,0 +1,7 @@
+package com.coder.toolbox.sdk.v2.models
+
+import com.squareup.moshi.Json
+
+enum class WorkspaceBuildReason {
+    @Json(name = "jetbrains_connection") JETBRAINS_CONNECTION,
+}
