optimize, lazy init, default style fallback

Author: wxiaoguang

modules/badge/badge.go

@@ -5,6 +5,7 @@ package badge
 
 import (
 	"strings"
+	"sync"
 	"unicode"
 
 	actions_model "code.gitea.io/gitea/models/actions"
@@ -49,9 +50,6 @@ func (b Badge) Width() int {
 	return b.Label.width + b.Message.width
 }
 
-// Style represents the style of a badge
-type Style string
-
 const (
 	StyleFlat       = "flat"
 	StyleFlatSquare = "flat-square"
@@ -65,8 +63,13 @@ const (
 	DefaultStyle      = StyleFlat
 )
 
-var (
-	StatusColorMap = map[actions_model.Status]string{
+var GlobalVars = sync.OnceValue(func() (ret struct {
+	StatusColorMap       map[actions_model.Status]string
+	DejaVuGlyphWidthData map[rune]uint8
+	AllStyles            []string
+},
+) {
+	ret.StatusColorMap = map[actions_model.Status]string{
 		actions_model.StatusSuccess:   "#4c1",    // Green
 		actions_model.StatusSkipped:   "#dfb317", // Yellow
 		actions_model.StatusUnknown:   "#97ca00", // Light Green
@@ -76,9 +79,10 @@ var (
 		actions_model.StatusRunning:   "#dfb317", // Yellow
 		actions_model.StatusBlocked:   "#dfb317", // Yellow
 	}
-
-	AllStyles = []Style{StyleFlat, StyleFlatSquare}
-)
+	ret.DejaVuGlyphWidthData = dejaVuGlyphWidthDataFunc()
+	ret.AllStyles = []string{StyleFlat, StyleFlatSquare}
+	return ret
+})
 
 // GenerateBadge generates badge with given template
 func GenerateBadge(label, message, color string) Badge {
@@ -106,7 +110,7 @@ func GenerateBadge(label, message, color string) Badge {
 
 func calculateTextWidth(text string) int {
 	width := 0
-	widthData := DejaVuGlyphWidthData()
+	widthData := GlobalVars().DejaVuGlyphWidthData
 	for _, char := range strings.TrimSpace(text) {
 		charWidth, ok := widthData[char]
 		if !ok {

modules/badge/badge_glyph_width.go

@@ -3,8 +3,6 @@
 
 package badge
 
-import "sync"
-
 // DejaVuGlyphWidthData is generated by `sfnt.Face.GlyphAdvance(nil, <rune>, 11, font.HintingNone)` with DejaVu Sans
 // v2.37 (https://github.com/dejavu-fonts/dejavu-fonts/releases/download/version_2_37/dejavu-sans-ttf-2.37.zip).
 //
@@ -13,7 +11,7 @@ import "sync"
 //
 // A devtest page "/devtest/badge-actions-svg" could be used to check the rendered images.
 
-var DejaVuGlyphWidthData = sync.OnceValue(func() map[rune]uint8 {
+func dejaVuGlyphWidthDataFunc() map[rune]uint8 {
 	return map[rune]uint8{
 		32:  3,
 		33:  4,
@@ -205,4 +203,4 @@ var DejaVuGlyphWidthData = sync.OnceValue(func() map[rune]uint8 {
 		254: 7,
 		255: 7,
 	}
-})
+}

routers/web/devtest/devtest.go

@@ -162,7 +162,7 @@ func prepareMockDataBadgeActionsSvg(ctx *context.Context) {
 	ctx.Data["BadgeSVGs"] = badgeSVGs
 	ctx.Data["BadgeFontFamilyNames"] = fontFamilyNames
 	ctx.Data["SelectedFontFamilyName"] = selectedFontFamilyName
-	ctx.Data["BadgeStyles"] = badge.AllStyles
+	ctx.Data["BadgeStyles"] = badge.GlobalVars().AllStyles
 	ctx.Data["SelectedStyle"] = selectedStyle
 }
 

routers/web/repo/actions/badge.go

@@ -5,33 +5,25 @@ package actions
 
 import (
 	"errors"
-	"fmt"
 	"net/http"
 	"path/filepath"
-	"slices"
 	"strings"
 
 	actions_model "code.gitea.io/gitea/models/actions"
 	"code.gitea.io/gitea/modules/badge"
+	"code.gitea.io/gitea/modules/git"
 	"code.gitea.io/gitea/modules/util"
 	"code.gitea.io/gitea/services/context"
 )
 
 func GetWorkflowBadge(ctx *context.Context) {
 	workflowFile := ctx.PathParam("workflow_name")
-	branch := ctx.Req.URL.Query().Get("branch")
-	if branch == "" {
-		branch = ctx.Repo.Repository.DefaultBranch
-	}
-	branchRef := fmt.Sprintf("refs/heads/%s", branch)
-	event := ctx.Req.URL.Query().Get("event")
-
-	style := ctx.Req.URL.Query().Get("style")
-	if !slices.Contains(badge.AllStyles, badge.Style(style)) {
-		style = badge.DefaultStyle
-	}
+	branch := ctx.FormString("branch", ctx.Repo.Repository.DefaultBranch)
+	event := ctx.FormString("event")
+	style := ctx.FormString("style")
 
-	b, err := getWorkflowBadge(ctx, workflowFile, branchRef, event)
+	branchRef := git.RefNameFromBranch(branch)
+	b, err := getWorkflowBadge(ctx, workflowFile, branchRef.String(), event)
 	if err != nil {
 		ctx.ServerError("GetWorkflowBadge", err)
 		return
@@ -40,10 +32,10 @@ func GetWorkflowBadge(ctx *context.Context) {
 	ctx.Data["Badge"] = b
 	ctx.RespHeader().Set("Content-Type", "image/svg+xml")
 	switch style {
-	case badge.StyleFlat:
-		ctx.HTML(http.StatusOK, "shared/actions/runner_badge_flat")
 	case badge.StyleFlatSquare:
 		ctx.HTML(http.StatusOK, "shared/actions/runner_badge_flat-square")
+	default: // defaults to badge.StyleFlat
+		ctx.HTML(http.StatusOK, "shared/actions/runner_badge_flat")
 	}
 }
 
@@ -59,7 +51,7 @@ func getWorkflowBadge(ctx *context.Context, workflowFile, branchName, event stri
 		return badge.Badge{}, err
 	}
 
-	color, ok := badge.StatusColorMap[run.Status]
+	color, ok := badge.GlobalVars().StatusColorMap[run.Status]
 	if !ok {
 		return badge.GenerateBadge(workflowName, "unknown status", badge.DefaultColor), nil
 	}