Merge pull request #33 from factorysh/features/dynamic-badges

Add dynamic badges for BadgeMyTask

Author: athoune

application/badge.go

@@ -8,6 +8,7 @@ import (
 	"os"
 	"path/filepath"
 
+	"github.com/factorysh/microdensity/badge"
 	_badge "github.com/factorysh/microdensity/badge"
 	"github.com/go-chi/chi/v5"
 	"go.uber.org/zap"
@@ -30,23 +31,27 @@ func (a *Application) BadgeMyTaskHandler(latest bool) http.HandlerFunc {
 		commit := chi.URLParam(r, "commit")
 		bdg := chi.URLParam(r, "badge")
 
+		// get the task
 		t, err := a.storage.GetByCommit(service, project, branch, commit, latest)
 		if err != nil {
 			l.Warn("Task get error", zap.Error(err))
 			w.WriteHeader(http.StatusNotFound)
 			return
 		}
 
+		// try to get the output badge for this task in this service
 		p := filepath.Join(a.storage.GetVolumePath(t), "/data", fmt.Sprintf("%s.badge", bdg))
-
 		_, err = os.Stat(p)
+
+		// if not found
 		if err != nil {
-			l.Warn("Task get error", zap.Error(err))
+			// fallback to status badge
 			if os.IsNotExist(err) {
-				w.WriteHeader(http.StatusNotFound)
-			} else {
-				w.WriteHeader(http.StatusBadRequest)
+				// use the service name, task status and colors from badge pkg
+				badge.WriteBadge(service, t.State.String(), _badge.Colors.Get(t.State), w)
+				return
 			}
+			w.WriteHeader(http.StatusBadRequest)
 			return
 		}
 		l = l.With(zap.String("path", p))

badge/badge.go

@@ -10,7 +10,8 @@ import (
 	"github.com/narqo/go-badge"
 )
 
-var colors = statusToColors{
+// Colors is used to harmonize status colors for all badges
+var Colors = statusToColors{
 	c: map[task.State]badge.Color{
 		// blue - lapis
 		task.Ready: "#2832C2",
@@ -20,8 +21,8 @@ var colors = statusToColors{
 		task.Running: "#DD571C",
 		// red - ruby
 		task.Failed: "#900603",
-		// green - emerald
-		task.Done: "#028A0F",
+		// green
+		task.Done: "#4ec820",
 	},
 	// blue
 	Default: "#527284",
@@ -67,7 +68,7 @@ func StatusBadge(s storage.Storage, latest bool) func(http.ResponseWriter, *http
 		t, err := s.GetByCommit(service, project, branch, commit, latest)
 
 		if t == nil || err != nil {
-			err = writeBadge("status", "?!", colors.Default, w)
+			err = WriteBadge("status", "?!", Colors.Default, w)
 			if err != nil {
 				panic(err)
 			}
@@ -79,15 +80,15 @@ func StatusBadge(s storage.Storage, latest bool) func(http.ResponseWriter, *http
 			return
 		}
 
-		writeBadge(fmt.Sprintf("status : %s", service), t.State.String(), colors.Get(t.State), w)
+		WriteBadge(fmt.Sprintf("status : %s", service), t.State.String(), Colors.Get(t.State), w)
 		if err != nil {
 			panic(err)
 		}
 	}
 }
 
-// writeBadge is a wrapper use to write a badge into an http response
-func writeBadge(label string, content string, color badge.Color, w http.ResponseWriter) error {
+// WriteBadge is a wrapper use to write a badge into an http response
+func WriteBadge(label string, content string, color badge.Color, w http.ResponseWriter) error {
 	w.Header().Set("content-type", "image/svg+xml")
 	return badge.Render(label, content, color, w)
 }