return failed step in the reason

Author: dobrac

packages/api/internal/api/spec.gen.go

@@ -3,6 +3,7 @@ package templatecache
 import (
 	"context"
 	"database/sql"
+	"encoding/json"
 	"errors"
 	"fmt"
 	"net/http"
@@ -154,7 +155,7 @@ type TemplateBuildInfo struct {
 	TeamID      uuid.UUID
 	TemplateID  string
 	BuildStatus envbuild.Status
-	Reason      *string
+	Reason      *api.BuildStatusReason
 
 	ClusterID     *uuid.UUID
 	ClusterNodeID *string
@@ -182,7 +183,7 @@ func NewTemplateBuildCache(db *db.DB) *TemplatesBuildCache {
 	}
 }
 
-func (c *TemplatesBuildCache) SetStatus(buildID uuid.UUID, status envbuild.Status, reason *string) {
+func (c *TemplatesBuildCache) SetStatus(buildID uuid.UUID, status envbuild.Status, reason *api.BuildStatusReason) {
 	c.mx.Lock()
 	defer c.mx.Unlock()
 
@@ -197,7 +198,6 @@ func (c *TemplatesBuildCache) SetStatus(buildID uuid.UUID, status envbuild.Statu
 		logger.WithBuildID(buildID.String()),
 		zap.String("to_status", status.String()),
 		zap.String("from_status", item.BuildStatus.String()),
-		zap.Stringp("reason", reason),
 	)
 
 	_ = c.cache.Set(
@@ -239,13 +239,33 @@ func (c *TemplatesBuildCache) Get(ctx context.Context, buildID uuid.UUID, templa
 			return TemplateBuildInfo{}, fmt.Errorf("failed to get template build '%s': %w", buildID, envBuildDBErr)
 		}
 
+		dbReason := ""
+		if envBuildDB.Reason != nil {
+			dbReason = *envBuildDB.Reason
+		}
+
+		var parsedReason *api.BuildStatusReason
+		err := json.Unmarshal([]byte(dbReason), &parsedReason)
+		if err != nil {
+			zap.L().Warn("Failed to parse build status reason from DB",
+				logger.WithBuildID(buildID.String()),
+				zap.String("reason", dbReason),
+				zap.Error(err),
+			)
+			// If parsing fails, we just store the raw reason as a message
+			parsedReason = &api.BuildStatusReason{
+				Step:    "",
+				Message: dbReason,
+			}
+		}
+
 		item = c.cache.Set(
 			buildID,
 			TemplateBuildInfo{
 				TeamID:      envDB.TeamID,
 				TemplateID:  envDB.ID,
 				BuildStatus: envBuildDB.Status,
-				Reason:      envBuildDB.Reason,
+				Reason:      parsedReason,
 
 				ClusterID:     envDB.ClusterID,
 				ClusterNodeID: envBuildDB.ClusterNodeID,

packages/api/internal/api/types.gen.go

@@ -54,13 +54,14 @@ func (tm *TemplateManager) CreateTemplate(
 
 		// Report build failur status on any error while creating the template
 		telemetry.ReportCriticalError(ctx, "build failed", e, telemetry.WithTemplateID(templateID))
-		msg := fmt.Sprintf("error when building env: %s", e)
 		err := tm.SetStatus(
 			ctx,
 			templateID,
 			buildID,
 			envbuild.StatusFailed,
-			&msg,
+			&templatemanagergrpc.TemplateBuildStatusReason{
+				Message: fmt.Sprintf("error when building env: %s", e),
+			},
 		)
 		if err != nil {
 			e = errors.Join(e, fmt.Errorf("failed to set build status to failed: %w", err))

packages/api/internal/cache/templates/cache.go

@@ -20,7 +20,7 @@ type fakeTemplateManagerClient struct {
 	getStatusErr      error
 }
 
-func (f fakeTemplateManagerClient) SetStatus(ctx context.Context, templateID string, buildID uuid.UUID, status envbuild.Status, reason *string) error {
+func (f fakeTemplateManagerClient) SetStatus(ctx context.Context, templateID string, buildID uuid.UUID, status envbuild.Status, reason *templatemanagergrpc.TemplateBuildStatusReason) error {
 	return f.setStatusError
 }
 
@@ -35,7 +35,7 @@ func (f fakeTemplateManagerClient) GetStatus(ctx context.Context, buildID uuid.U
 func TestPollBuildStatus_setStatus(t *testing.T) {
 	type fields struct {
 		buildID               uuid.UUID
-		templateManagerClient *fakeTemplateManagerClient
+		templateManagerClient templateManagerClient
 	}
 
 	tests := []struct {
@@ -120,7 +120,7 @@ func TestPollBuildStatus_setStatus(t *testing.T) {
 
 func TestPollBuildStatus_dispatchBasedOnStatus(t *testing.T) {
 	type fields struct {
-		templateManagerClient *fakeTemplateManagerClient
+		templateManagerClient templateManagerClient
 	}
 	type args struct {
 		status *templatemanagergrpc.TemplateBuildStatusResponse
@@ -272,7 +272,7 @@ func TestPollBuildStatus_dispatchBasedOnStatus(t *testing.T) {
 				logger: zap.NewNop(),
 			}
 
-			err, completed := c.dispatchBasedOnStatus(context.TODO(), tt.args.status)
+			completed, err := c.dispatchBasedOnStatus(context.TODO(), tt.args.status)
 			if tt.wantErr {
 				if err == nil {
 					t.Errorf("Expected error, got no error")