mark fields of PatchAppStatus as deprecated

johnstcn · johnstcn · commit 101cf64e083a · 2025-04-11T11:47:41.000+01:00
diff --git a/coderd/workspaceagents_test.go b/coderd/workspaceagents_test.go
@@ -366,8 +366,10 @@ func TestWorkspaceAgentAppStatus(t *testing.T) {
 			AppSlug: "vscode",
 			Message: "testing",
 			URI:     "https://example.com",
-			Icon:    "https://example.com/icon.png",
 			State:   codersdk.WorkspaceAppStatusStateComplete,
+			// Ensure deprecated fields are ignored.
+			Icon:               "https://example.com/icon.png",
+			NeedsUserAttention: true,
 		})
 		require.NoError(t, err)
 
@@ -376,6 +378,9 @@ func TestWorkspaceAgentAppStatus(t *testing.T) {
 		agent, err := client.WorkspaceAgent(ctx, workspace.LatestBuild.Resources[0].Agents[0].ID)
 		require.NoError(t, err)
 		require.Len(t, agent.Apps[0].Statuses, 1)
+		// Deprecated fields should be ignored.
+		require.Empty(t, agent.Apps[0].Statuses[0].Icon)
+		require.False(t, agent.Apps[0].Statuses[0].NeedsUserAttention)
 	})
 }
 
diff --git a/codersdk/agentsdk/agentsdk.go b/codersdk/agentsdk/agentsdk.go
@@ -583,12 +583,14 @@ func (c *Client) PatchLogs(ctx context.Context, req PatchLogs) error {
 
 // PatchAppStatus updates the status of a workspace app.
 type PatchAppStatus struct {
-	AppSlug            string                           `json:"app_slug"`
-	NeedsUserAttention bool                             `json:"needs_user_attention"`
-	State              codersdk.WorkspaceAppStatusState `json:"state"`
-	Message            string                           `json:"message"`
-	URI                string                           `json:"uri"`
-	Icon               string                           `json:"icon"`
+	AppSlug string                           `json:"app_slug"`
+	State   codersdk.WorkspaceAppStatusState `json:"state"`
+	Message string                           `json:"message"`
+	URI     string                           `json:"uri"`
+	// Deprecated: this field is unused and will be removed in a future version.
+	Icon string `json:"icon"`
+	// Deprecated: this field is unused and will be removed in a future version.
+	NeedsUserAttention bool `json:"needs_user_attention"`
 }
 
 func (c *Client) PatchAppStatus(ctx context.Context, req PatchAppStatus) error {
diff --git a/codersdk/workspaceapps.go b/codersdk/workspaceapps.go
@@ -106,14 +106,16 @@ type WorkspaceAppStatus struct {
 	AgentID     uuid.UUID               `json:"agent_id" format:"uuid"`
 	AppID       uuid.UUID               `json:"app_id" format:"uuid"`
 	State       WorkspaceAppStatusState `json:"state"`
-	// Deprecated: This field is unused and will be removed in a future version.
-	NeedsUserAttention bool   `json:"needs_user_attention"`
-	Message            string `json:"message"`
+	Message     string                  `json:"message"`
 	// URI is the URI of the resource that the status is for.
 	// e.g. https://github.com/org/repo/pull/123
 	// e.g. file:///path/to/file
 	URI string `json:"uri"`
-	// Icon is an external URL to an icon that will be rendered in the UI.
+
 	// Deprecated: This field is unused and will be removed in a future version.
+	// Icon is an external URL to an icon that will be rendered in the UI.
 	Icon string `json:"icon"`
+	// Deprecated: This field is unused and will be removed in a future version.
+	// NeedsUserAttention specifies whether the status needs user attention.
+	NeedsUserAttention bool `json:"needs_user_attention"`
 }
