feat: add failed workspaces list to invalidate response

mtojek · mtojek · commit 04ba875d0d50 · 2025-10-27T12:22:29.000Z
Add detailed error tracking to InvalidatePrebuildsResponse:
- Invalidated: list of successfully invalidated workspace names
- Failed: list of workspaces that failed with error messages
- Count: number of successful invalidations

Response structure:
{
  "count": 2,
  "invalidated": ["workspace-1", "workspace-2"],
  "failed": [
    {"workspace_name": "workspace-3", "error": "error message"}
  ]
}
diff --git a/coderd/templates.go b/coderd/templates.go
@@ -1207,14 +1207,16 @@ func (api *API) postInvalidateTemplatePrebuilds(rw http.ResponseWriter, r *http.
 
 	if len(prebuildWorkspaces) == 0 {
 		httpapi.Write(ctx, rw, http.StatusOK, codersdk.InvalidatePrebuildsResponse{
-			Count:      0,
-			Workspaces: []string{},
+			Count:       0,
+			Invalidated: []string{},
+			Failed:      []codersdk.InvalidatedPrebuildError{},
 		})
 		return
 	}
 
 	// Delete each prebuilt workspace using the existing workspace delete logic
 	var invalidatedWorkspaces []string
+	var failedWorkspaces []codersdk.InvalidatedPrebuildError
 
 	api.Logger.Info(ctx, "invalidating prebuilt workspaces",
 		slog.F("template_id", template.ID),
@@ -1245,6 +1247,10 @@ func (api *API) postInvalidateTemplatePrebuilds(rw http.ResponseWriter, r *http.
 				slog.F("workspace_name", workspace.Name),
 				slog.Error(err),
 			)
+			failedWorkspaces = append(failedWorkspaces, codersdk.InvalidatedPrebuildError{
+				WorkspaceName: workspace.Name,
+				Error:         err.Error(),
+			})
 			continue
 		}
 
@@ -1254,11 +1260,12 @@ func (api *API) postInvalidateTemplatePrebuilds(rw http.ResponseWriter, r *http.
 	api.Logger.Info(ctx, "completed prebuild invalidation",
 		slog.F("template_id", template.ID),
 		slog.F("invalidated", len(invalidatedWorkspaces)),
-		slog.F("failed", len(prebuildWorkspaces)-len(invalidatedWorkspaces)),
+		slog.F("failed", len(failedWorkspaces)),
 	)
 
 	httpapi.Write(ctx, rw, http.StatusOK, codersdk.InvalidatePrebuildsResponse{
-		Count:      len(invalidatedWorkspaces),
-		Workspaces: invalidatedWorkspaces,
+		Count:       len(invalidatedWorkspaces),
+		Invalidated: invalidatedWorkspaces,
+		Failed:      failedWorkspaces,
 	})
 }
diff --git a/codersdk/templates.go b/codersdk/templates.go
@@ -510,10 +510,20 @@ func (c *Client) StarterTemplates(ctx context.Context) ([]TemplateExample, error
 
 // InvalidatePrebuildsResponse contains the result of invalidating prebuilt workspaces.
 type InvalidatePrebuildsResponse struct {
-	// Count is the number of prebuilt workspaces that were invalidated.
+	// Count is the number of prebuilt workspaces that were successfully invalidated.
 	Count int `json:"count"`
-	// Workspaces is the list of invalidated prebuilt workspace names.
-	Workspaces []string `json:"workspaces"`
+	// Invalidated is the list of successfully invalidated prebuilt workspace names.
+	Invalidated []string `json:"invalidated"`
+	// Failed is the list of prebuilt workspace names that failed to invalidate with error messages.
+	Failed []InvalidatedPrebuildError `json:"failed,omitempty"`
+}
+
+// InvalidatedPrebuildError represents a failed prebuild invalidation.
+type InvalidatedPrebuildError struct {
+	// WorkspaceName is the name of the workspace that failed to invalidate.
+	WorkspaceName string `json:"workspace_name"`
+	// Error is the error message.
+	Error string `json:"error"`
 }
 
 // InvalidateTemplatePrebuilds invalidates all prebuilt workspaces for the
