-
Notifications
You must be signed in to change notification settings - Fork 0
/
gin_middlewares.go
154 lines (130 loc) · 4.01 KB
/
gin_middlewares.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
package main
import (
"context"
"log/slog"
"net/http"
"strconv"
"time"
"github.com/Depado/ginprom"
"github.com/Stogas/feedback-api/internal/dto"
"github.com/Stogas/feedback-api/internal/models"
"github.com/gin-gonic/gin"
"go.opentelemetry.io/otel/trace"
"gorm.io/gorm"
)
func createDBMiddleware(db *gorm.DB) gin.HandlerFunc {
return func(c *gin.Context) {
ctx := c.Request.Context()
c.Set("db", db.WithContext(ctx))
c.Next()
}
}
func metricsMiddleware(p *ginprom.Prometheus) gin.HandlerFunc {
return func(c *gin.Context) {
// Store the prometheus client to allow using custom metrics
c.Set("prom", p)
c.Next()
}
}
func submitTokenMiddleware(token string) gin.HandlerFunc {
return func(c *gin.Context) {
if token == "" || c.GetHeader("X-Feedback-Submit-Token") == token {
c.Next()
} else {
c.AbortWithStatusJSON(http.StatusUnauthorized, gin.H{"error": "X-Feedback-Submit-Token not provided or incorrect"})
return
}
}
}
func reportMiddleware(c *gin.Context) {
logger := getLogger(c.Request.Context())
var r dto.ReportRequest
if err := c.ShouldBindJSON(&r); err != nil {
// If there's an error in parsing JSON, return an error response
c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": err.Error()})
return
}
// special handling for booleans, as it's necessary to detect if it was not provided (default value for booleans is False)
if r.Satisfied == nil {
c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "Field 'satisfied' not provided"})
return
}
// Make sure the satisfaction issue id, if provided, fits known issue types
if r.IssueID != nil {
var knownIssue models.Issue
db := c.MustGet("db").(*gorm.DB)
if err := db.First(&knownIssue, r.IssueID).Error; err != nil {
if err == gorm.ErrRecordNotFound {
c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "Invalid issue ID"})
return
}
logger.Error("Error reading database", "error", err)
c.AbortWithStatusJSON(http.StatusInternalServerError, gin.H{"error": "Database read error"})
return
}
}
c.Set("report", models.Report{
UUID: r.UUID,
Satisfied: r.Satisfied,
IssueID: r.IssueID,
Comment: r.Comment,
Metadata: r.Metadata,
})
c.Next()
if c.Request.Method == "POST" {
statusCode := c.Writer.Status()
if statusCode >= 200 && statusCode < 300 {
logger.Debug("Response will be a success, will increment metrics")
p := c.MustGet("prom").(*ginprom.Prometheus)
err := p.IncrementCounterValue("reports_total", []string{strconv.FormatBool(*r.Satisfied)})
if err != nil {
logger.Error("Failed to increment metrics counter")
}
} else {
logger.Debug("Response will not be a success, skipping metrics increment")
}
}
}
func regularLogMiddleware() gin.HandlerFunc {
return func(c *gin.Context) {
start := time.Now()
// Create a logger without trace/span IDs
logger := slog.Default()
// Store the default logger in the request context
ctx := context.WithValue(c.Request.Context(), contextLogger, logger)
c.Request = c.Request.WithContext(ctx)
// Process request
c.Next()
// Log request details
logger.Info("Request",
"method", c.Request.Method,
"path", c.Request.URL.Path,
"status", c.Writer.Status(),
"latency", time.Since(start),
)
}
}
func traceLogMiddleware() gin.HandlerFunc {
return func(c *gin.Context) {
start := time.Now()
// Extract the span from the context
span := trace.SpanFromContext(c.Request.Context())
// Get the trace and span IDs
traceID := span.SpanContext().TraceID().String()
spanID := span.SpanContext().SpanID().String()
// Create a logger with trace/span IDs
logger := slog.With("traceId", traceID, "spanId", spanID)
// Store the logger in the request context
ctx := context.WithValue(c.Request.Context(), contextLogger, logger)
c.Request = c.Request.WithContext(ctx)
// Process request
c.Next()
// Log request details
logger.Info("request",
"method", c.Request.Method,
"path", c.Request.URL.Path,
"status", c.Writer.Status(),
"latency", time.Since(start),
)
}
}