docs(swagger): New barcode padding docs

.env

@@ -4,6 +4,7 @@ APIKEY=lfk
 EVENTNAME=Lauf für Kaya! 2025
 CURRENCYSYMBOL=€
 GOTENBERG_BASEURL=http://localhost:3001
+REDIS_ADDR=localhost:6379
 
 CARD_SUBTITLE=Kaya ist cool
 CARD_BARCODEFORMAT=ean13

README.md

@@ -68,3 +68,29 @@ docker build -t registry.odit.services/lfk/document-server:latest .
 # multiarch
 docker buildx build --platform=linux/amd64,linux/arm64 -t registry.odit.services/lfk/document-server:latest --push .
 ```
+
+## ⏱️ Benchmarks
+
+### Barcode Generation
+
+- Requests: 10000
+- Concurrency: Unlimited
+- Data: `123456789123`
+- Width: 1000
+- Height: 500
+
+#### No cache (cold start)
+
+| Format  | Data           | Requests/sec | Slowest | Fastest | Average |
+| ------- | -------------- | ------------ | ------- | ------- | ------- |
+| Code128 | `123456789123` | 763.3996     | 0.7995  | 0.0172  | 0.0654  |
+| EAN13   | `123456789123` | 767.1170     | 0.7607  | 0.0171  | 0.0651  |
+| QR      | `123456789123` | 683.8472     | 0.6528  | 0.0178  | 0.0730  |
+
+#### Redis cache (warm start)
+
+| Format  | Data           | Requests/sec | Slowest | Fastest | Average |
+| ------- | -------------- | ------------ | ------- | ------- | ------- |
+| Code128 | `123456789123` | 15611.5521   | 0.0965  | 0.0006  | 0.0032  |
+| EAN13   | `123456789123` | 14985.4401   | 0.0925  | 0.0006  | 0.0033  |
+| QR      | `123456789123` | 14306.2540   | 0.1143  | 0.0005  | 0.0035  |

docker-compose.dev.yaml

@@ -2,4 +2,8 @@ services:
   gotenberg:
     image: gotenberg/gotenberg:8
     ports:
-      - "3001:3000"
+      - "3001:3000"
+  redis:
+    image: docker.dragonflydb.io/dragonflydb/dragonfly
+    ports:
+      - "6379:6379"

docker-compose.yaml

@@ -8,4 +8,8 @@ services:
   gotenberg:
     image: gotenberg/gotenberg:8
     ports:
-      - "3001:3000"
+      - "3001:3000"
+  redis:
+    image: docker.dragonflydb.io/dragonflydb/dragonfly
+    ports:
+      - "6379:6379"

docker.env

@@ -4,6 +4,7 @@ APIKEY=lfk
 EVENTNAME=Lauf für Kaya! 2025
 CURRENCYSYMBOL=€
 GOTENBERG_BASEURL=http://gotenberg:3000
+REDIS_ADDR=redis:6379
 
 CARD_SUBTITLE=Kaya ist cool
 CARD_BARCODEFORMAT=ean13

docs/docs.go

@@ -70,6 +70,15 @@ const docTemplate = `{
                         "description": "Barcode height",
                         "name": "height",
                         "in": "query"
+                    },
+                    {
+                        "maximum": 100,
+                        "minimum": 0,
+                        "type": "integer",
+                        "default": 10,
+                        "description": "Padding around the barcode (included in image size)",
+                        "name": "padding",
+                        "in": "query"
                     }
                 ],
                 "responses": {}
@@ -312,18 +321,11 @@ const docTemplate = `{
         "models.Group": {
             "type": "object",
             "required": [
-                "id",
                 "name"
             ],
             "properties": {
-                "id": {
-                    "type": "integer"
-                },
                 "name": {
                     "type": "string"
-                },
-                "parent_group": {
-                    "$ref": "#/definitions/models.Group"
                 }
             }
         },

docs/swagger.json

@@ -61,6 +61,15 @@
                         "description": "Barcode height",
                         "name": "height",
                         "in": "query"
+                    },
+                    {
+                        "maximum": 100,
+                        "minimum": 0,
+                        "type": "integer",
+                        "default": 10,
+                        "description": "Padding around the barcode (included in image size)",
+                        "name": "padding",
+                        "in": "query"
                     }
                 ],
                 "responses": {}
@@ -303,18 +312,11 @@
         "models.Group": {
             "type": "object",
             "required": [
-                "id",
                 "name"
             ],
             "properties": {
-                "id": {
-                    "type": "integer"
-                },
                 "name": {
                     "type": "string"
-                },
-                "parent_group": {
-                    "$ref": "#/definitions/models.Group"
                 }
             }
         },

docs/swagger.yaml

@@ -94,14 +94,9 @@ definitions:
     type: object
   models.Group:
     properties:
-      id:
-        type: integer
       name:
         type: string
-      parent_group:
-        $ref: '#/definitions/models.Group'
     required:
-    - id
     - name
     type: object
   models.Runner:
@@ -195,6 +190,13 @@ paths:
         minimum: 1
         name: height
         type: integer
+      - default: 10
+        description: Padding around the barcode (included in image size)
+        in: query
+        maximum: 100
+        minimum: 0
+        name: padding
+        type: integer
       produces:
       - image/png
       responses: {}

go.mod

@@ -14,6 +14,8 @@ require (
 	github.com/KyleBanks/depth v1.2.1 // indirect
 	github.com/andybalholm/brotli v1.1.1 // indirect
 	github.com/boombuler/barcode v1.0.2 // indirect
+	github.com/cespare/xxhash/v2 v2.2.0 // indirect
+	github.com/dgryski/go-rendezvous v0.0.0-20200823014737-9f7001d12a5f // indirect
 	github.com/fsnotify/fsnotify v1.7.0 // indirect
 	github.com/go-openapi/jsonpointer v0.21.0 // indirect
 	github.com/go-openapi/jsonreference v0.21.0 // indirect
@@ -32,6 +34,7 @@ require (
 	github.com/mitchellh/mapstructure v1.5.0 // indirect
 	github.com/oxplot/papersizes v0.0.0-20181201065918-90a3a5ae1915 // indirect
 	github.com/pelletier/go-toml/v2 v2.2.2 // indirect
+	github.com/redis/go-redis/v9 v9.7.0 // indirect
 	github.com/rivo/uniseg v0.4.7 // indirect
 	github.com/sagikazarmark/locafero v0.4.0 // indirect
 	github.com/sagikazarmark/slog-shim v0.1.0 // indirect

go.sum

@@ -4,9 +4,13 @@ github.com/andybalholm/brotli v1.1.1 h1:PR2pgnyFznKEugtsUo0xLdDop5SKXd5Qf5ysW+7X
 github.com/andybalholm/brotli v1.1.1/go.mod h1:05ib4cKhjx3OQYUY22hTVd34Bc8upXjOLL2rKwwZBoA=
 github.com/boombuler/barcode v1.0.2 h1:79yrbttoZrLGkL/oOI8hBrUKucwOL0oOjUgEguGMcJ4=
 github.com/boombuler/barcode v1.0.2/go.mod h1:paBWMcWSl3LHKBqUq+rly7CNSldXjb2rDl3JlRe0mD8=
+github.com/cespare/xxhash/v2 v2.2.0 h1:DC2CZ1Ep5Y4k3ZQ899DldepgrayRUGE6BBZ/cd9Cj44=
+github.com/cespare/xxhash/v2 v2.2.0/go.mod h1:VGX0DQ3Q6kWi7AoAeZDth3/j3BFtOZR5XLFGgcrjCOs=
 github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
 github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
 github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
+github.com/dgryski/go-rendezvous v0.0.0-20200823014737-9f7001d12a5f h1:lO4WD4F/rVNCu3HqELle0jiPLLBs70cWOduZpkS1E78=
+github.com/dgryski/go-rendezvous v0.0.0-20200823014737-9f7001d12a5f/go.mod h1:cuUVRXasLTGF7a8hSLbxyZXjz+1KgoB3wDUb6vlszIc=
 github.com/fsnotify/fsnotify v1.7.0 h1:8JEhPFa5W2WU7YfeZzPNqzMP6Lwt7L2715Ggo0nosvA=
 github.com/fsnotify/fsnotify v1.7.0/go.mod h1:40Bi/Hjc2AVfZrqy+aj+yEI+/bRxZnMJyTJwOpGvigM=
 github.com/go-openapi/jsonpointer v0.21.0 h1:YgdVicSA9vH5RiHs9TZW5oyafXZFc6+2Vc1rr/O9oNQ=
@@ -54,6 +58,8 @@ github.com/pelletier/go-toml/v2 v2.2.2 h1:aYUidT7k73Pcl9nb2gScu7NSrKCSHIDE89b3+6
 github.com/pelletier/go-toml/v2 v2.2.2/go.mod h1:1t835xjRzz80PqgE6HHgN2JOsmgYu/h4qDAS4n929Rs=
 github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
 github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
+github.com/redis/go-redis/v9 v9.7.0 h1:HhLSs+B6O021gwzl+locl0zEDnyNkxMtf/Z3NNBMa9E=
+github.com/redis/go-redis/v9 v9.7.0/go.mod h1:f6zhXITC7JUJIlPEiBOTXxJgPLdZcA93GewI7inzyWw=
 github.com/rivo/uniseg v0.2.0/go.mod h1:J6wj4VEh+S6ZtnVlnTBMWIodfgj8LQOQFoIToxlJtxc=
 github.com/rivo/uniseg v0.4.7 h1:WUdvkW8uEhrYfLC4ZzdpI2ztxP1I582+49Oc5Mq64VQ=
 github.com/rivo/uniseg v0.4.7/go.mod h1:FN3SvrM+Zdj16jyLfmOkMNblXMcoc8DfTHruCPUcx88=

handlers/barcode.go

@@ -11,10 +11,11 @@ import (
 //	@Summary		Generate barcodes
 //	@Description	Generate barcodes based on the provided data
 //	@Tags			barcodes
-//	@Param			type	path	string	true	"Barcode type"		Enums(ean13, code128)
-//	@Param			content	path	string	true	"Barcode content"	MinLength(1)
-//	@Param			width	query	int		false	"Barcode width"		Minimum(1)	Maximum(10000) default(1000)
-//	@Param			height	query	int		false	"Barcode height"	Minimum(1)	Maximum(10000) default(1000)
+//	@Param			type	path	string	true	"Barcode type"											Enums(ean13, code128)
+//	@Param			content	path	string	true	"Barcode content"										MinLength(1)
+//	@Param			width	query	int		false	"Barcode width"											Minimum(1)	Maximum(10000)	default(1000)
+//	@Param			height	query	int		false	"Barcode height"										Minimum(1)	Maximum(10000)	default(1000)
+//	@Param			padding	query	int		false	"Padding around the barcode (included in image size)"	Minimum(0)	Maximum(100)	default(10)
 //	@Produce		image/png
 //	@Router			/v1/barcodes/{type}/{content} [get]
 func (h *DefaultHandler) GenerateBarcode(c *fiber.Ctx) error {
@@ -26,6 +27,7 @@ func (h *DefaultHandler) GenerateBarcode(c *fiber.Ctx) error {
 	// Get the width and height from the query parameters
 	widthStr := c.Query("width", "1000")
 	heightStr := c.Query("height", "1000")
+	paddingStr := c.Query("padding", "10")
 
 	// Convert width and height to integers
 	width, err := strconv.Atoi(widthStr)
@@ -42,8 +44,15 @@ func (h *DefaultHandler) GenerateBarcode(c *fiber.Ctx) error {
 		})
 	}
 
+	padding, err := strconv.Atoi(paddingStr)
+	if err != nil {
+		return c.Status(fiber.StatusBadRequest).JSON(fiber.Map{
+			"error": "Invalid padding parameter",
+		})
+	}
+
 	// Generate the barcode
-	barcode, err := h.BarcodeService.GenerateBarcode(barcodeType, barcodeContent, width, height)
+	barcode, err := h.BarcodeService.GenerateBarcode(barcodeType, barcodeContent, width, height, padding)
 	if err != nil {
 		return c.Status(fiber.StatusInternalServerError).JSON(fiber.Map{
 			"error": err.Error(),

handlers/card.go

@@ -69,6 +69,7 @@ func (h *DefaultHandler) GenerateCard(c *fiber.Ctx) error {
 	}
 
 	c.Set(fiber.HeaderContentType, "application/pdf")
+	c.Set(fiber.HeaderContentDisposition, "attachment; filename=runner-cards.pdf")
 	return c.Send(pdf)
 }
 

handlers/certificate.go

@@ -69,6 +69,7 @@ func (h *DefaultHandler) GenerateCertificate(c *fiber.Ctx) error {
 	}
 
 	c.Set(fiber.HeaderContentType, "application/pdf")
+	c.Set(fiber.HeaderContentDisposition, "attachment; filename=certificate.pdf")
 	return c.Send(pdf)
 }
 

handlers/contract.go

@@ -72,6 +72,7 @@ func (h *DefaultHandler) GenerateContract(c *fiber.Ctx) error {
 	}
 
 	c.Set(fiber.HeaderContentType, "application/pdf")
+	c.Set(fiber.HeaderContentDisposition, "attachment; filename=runner-contracts.pdf")
 	return c.Send(pdf)
 }
 

main.go

@@ -12,6 +12,7 @@ import (
 	"github.com/gofiber/fiber/v2"
 	"github.com/gofiber/fiber/v2/middleware/keyauth"
 	"github.com/gofiber/swagger"
+	"github.com/redis/go-redis/v9"
 	"github.com/spf13/viper"
 )
 
@@ -44,7 +45,7 @@ func loadEnv() error {
 	viper.AutomaticEnv()
 	err := viper.ReadInConfig()
 	if err != nil {
-		return err
+		log.Println("No .env file found")
 	}
 
 	// Unmarshal the config from file and env into the config struct
@@ -73,7 +74,17 @@ func main() {
 		log.Fatal(err)
 	}
 
-	barcodeGenerator := &services.DefaultBarcodeService{}
+	var redisClient *redis.Client
+	if config.RedisAddr != "" {
+		log.Println("Using redis at", config.RedisAddr)
+		redisClient = redis.NewClient(&redis.Options{
+			Addr: config.RedisAddr,
+		})
+	}
+
+	barcodeGenerator := &services.DefaultBarcodeService{
+		RedisClient: redisClient,
+	}
 	staticService := &services.DefaultStaticService{
 		Cache: make(map[string]string),
 	}

models/config.go

@@ -15,4 +15,5 @@ type Config struct {
 	SponsoringBarcodePrefix  string `mapstructure:"SPONSORING_BARCODEPREFIX"`
 	CertificateFooter        string `mapstructure:"CERTIFICATE_FOOTER"`
 	GotenbergBaseUrl         string `mapstructure:"GOTENBERG_BASEURL"`
+	RedisAddr                string `mapstructure:"REDIS_ADDR"`
 }

models/contract.go

@@ -14,9 +14,7 @@ type Runner struct {
 }
 
 type Group struct {
-	ID          int    `json:"id" validate:"required"`
-	Name        string `json:"name" validate:"required"`
-	ParentGroup *Group `json:"parent_group" validate:"optional"`
+	Name string `json:"name" validate:"required"`
 }
 
 type ContractTemplateOptions struct {

services/barcode.go

@@ -2,29 +2,49 @@ package services
 
 import (
 	"bytes"
+	"context"
 	"fmt"
+	"image"
+	"image/color"
+	"image/draw"
 	"image/png"
+	"log"
 	"slices"
+	"time"
 
 	"github.com/boombuler/barcode"
 	"github.com/boombuler/barcode/code128"
 	"github.com/boombuler/barcode/ean"
 	"github.com/boombuler/barcode/qr"
+	"github.com/redis/go-redis/v9"
 )
 
 type BarcodeService interface {
-	GenerateBarcode(format string, content string, width int, height int) (bytes.Buffer, error)
+	GenerateBarcode(format string, content string, width int, height int, padding int) (bytes.Buffer, error)
 	IsTypeSupported(format string) bool
 }
 
 type DefaultBarcodeService struct {
+	RedisClient *redis.Client
 }
 
-func (b *DefaultBarcodeService) GenerateBarcode(format string, content string, width int, height int) (bytes.Buffer, error) {
+func (b *DefaultBarcodeService) GenerateBarcode(format string, content string, width int, height int, padding int) (bytes.Buffer, error) {
+	ctx := context.Background()
+
 	if !b.IsTypeSupported(format) {
 		return bytes.Buffer{}, fmt.Errorf("unsupported barcode type: %s", format)
 	}
 
+	if b.RedisClient != nil {
+		cachedBarcode, err := b.RedisClient.Get(ctx, fmt.Sprintf("barcode:%s:%s:%d:%d:%d", format, content, width, height, padding)).Result()
+		if err == nil {
+			log.Printf("Cache hit for barcode:%s:%s:%d:%d", format, content, width, height)
+			buf := bytes.Buffer{}
+			buf.Write([]byte(cachedBarcode))
+			return buf, nil
+		}
+	}
+
 	var generatedCode barcode.Barcode
 	var err error
 
@@ -49,17 +69,37 @@ func (b *DefaultBarcodeService) GenerateBarcode(format string, content string, w
 		break
 	}
 
-	scaledCode, err := barcode.Scale(generatedCode, width, height)
+	// Create a white background image
+	bg := image.NewRGBA(image.Rect(0, 0, width, height))
+	white := color.RGBA{255, 255, 255, 255}
+	draw.Draw(bg, bg.Bounds(), &image.Uniform{white}, image.Point{}, draw.Src)
+
+	// Calculate the new size for the barcode to fit within the padding
+	newWidth := width - 2*padding
+	newHeight := height - 2*padding
+
+	// Scale the barcode to the new size
+	scaledCode, err := barcode.Scale(generatedCode, newWidth, newHeight)
 	if err != nil {
 		return bytes.Buffer{}, err
 	}
 
+	// Draw the barcode on top of the white background with padding
+	draw.Draw(bg, scaledCode.Bounds().Add(image.Point{padding, padding}), scaledCode, image.Point{}, draw.Over)
+
 	var buf bytes.Buffer
-	err = png.Encode(&buf, scaledCode)
+	err = png.Encode(&buf, bg)
 	if err != nil {
 		return bytes.Buffer{}, err
 	}
 
+	if b.RedisClient != nil {
+		err = b.RedisClient.Set(ctx, fmt.Sprintf("barcode:%s:%s:%d:%d", format, content, width, height), buf.String(), 10*time.Minute).Err()
+		if err != nil {
+			return bytes.Buffer{}, err
+		}
+	}
+
 	return buf, nil
 }
 

services/templater.go

@@ -42,7 +42,7 @@ func (t *DefaultTemplater) GenerateBarcode(code string, format string, prefix st
 		}
 	}
 
-	buf, err := t.BarcodeService.GenerateBarcode(format, code, 1000, 500)
+	buf, err := t.BarcodeService.GenerateBarcode(format, code, 1000, 500, 0)
 
 	return base64.StdEncoding.EncodeToString(buf.Bytes()), err
 }