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 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251
|
package kasapp
import (
"context"
"errors"
"fmt"
"reflect"
"regexp"
"strconv"
"sync"
"time"
"github.com/getsentry/sentry-go"
"github.com/redis/rueidis"
"gitlab.com/gitlab-org/cluster-integration/gitlab-agent/v16/internal/module/modserver"
"gitlab.com/gitlab-org/cluster-integration/gitlab-agent/v16/internal/module/modshared"
"gitlab.com/gitlab-org/cluster-integration/gitlab-agent/v16/internal/tool/errz"
"gitlab.com/gitlab-org/cluster-integration/gitlab-agent/v16/internal/tool/grpctool"
"gitlab.com/gitlab-org/cluster-integration/gitlab-agent/v16/internal/tool/logz"
"gitlab.com/gitlab-org/cluster-integration/gitlab-agent/v16/internal/tool/retry"
"go.opentelemetry.io/otel/trace"
"go.uber.org/zap"
"google.golang.org/protobuf/proto"
"google.golang.org/protobuf/types/known/anypb"
)
var (
// Help deduplicate errors like:
// read tcp 10.222.67.20:40272->10.216.1.45:11443: read: connection reset by peer
// by removing the random egress port.
ipv4 = `(?:\d+\.){3}\d+`
removePortStdLibError = regexp.MustCompile(`(` + ipv4 + `:)\d+(->` + ipv4 + `:\d+)`)
)
const (
redisAttemptInterval = 50 * time.Millisecond
redisInitBackoff = 100 * time.Millisecond
redisMaxBackoff = 10 * time.Second
redisResetDuration = 20 * time.Second
redisBackoffFactor = 2.0
redisJitter = 1.0
gitPushEventsRedisChannel = "kas_git_push_events"
)
type SentryHub interface {
CaptureEvent(event *sentry.Event) *sentry.EventID
}
type serverApi struct {
log *zap.Logger
Hub SentryHub
redisClient rueidis.Client
gitPushEventSubscriptions subscriptions
redisPollConfig retry.PollConfigFactory
}
func newServerApi(log *zap.Logger, hub SentryHub, redisClient rueidis.Client) *serverApi {
return &serverApi{
log: log,
Hub: hub,
redisClient: redisClient,
redisPollConfig: retry.NewPollConfigFactory(redisAttemptInterval, retry.NewExponentialBackoffFactory(
redisInitBackoff,
redisMaxBackoff,
redisResetDuration,
redisBackoffFactor,
redisJitter,
)),
}
}
type subscriptions struct {
mu sync.Mutex
chs []chan<- *modserver.Project
}
func (s *subscriptions) add(ch chan<- *modserver.Project) {
s.mu.Lock()
defer s.mu.Unlock()
s.chs = append(s.chs, ch)
}
func (s *subscriptions) remove(ch chan<- *modserver.Project) {
s.mu.Lock()
defer s.mu.Unlock()
for i, c := range s.chs {
if c == ch {
l := len(s.chs)
newChs := append(s.chs[:i], s.chs[i+1:]...)
s.chs[l-1] = nil // help GC
s.chs = newChs
break
}
}
}
func (a *serverApi) HandleProcessingError(ctx context.Context, log *zap.Logger, agentId int64, msg string, err error) {
handleProcessingError(ctx, a.hub, log, agentId, msg, err)
}
func (a *serverApi) hub() (SentryHub, string) {
return a.Hub, ""
}
func (a *serverApi) OnGitPushEvent(ctx context.Context, callback modserver.GitPushEventCallback) {
ch := make(chan *modserver.Project)
a.gitPushEventSubscriptions.add(ch)
defer a.gitPushEventSubscriptions.remove(ch)
done := ctx.Done()
for {
select {
case <-done:
return
case m := <-ch:
callback(ctx, m)
}
}
}
func (a *serverApi) publishGitPushEvent(ctx context.Context, e *modserver.Project) error {
payload, err := redisProtoMarshal(e)
if err != nil {
return fmt.Errorf("failed to marshal proto message to publish: %w", err)
}
publishCmd := a.redisClient.B().Publish().Channel(gitPushEventsRedisChannel).Message(string(payload)).Build()
return a.redisClient.Do(ctx, publishCmd).Error()
}
// subscribeGitPushEvent subscribes to the Git push event redis channel
// and will dispatch each event to the registered callbacks.
func (a *serverApi) subscribeGitPushEvent(ctx context.Context) {
_ = retry.PollWithBackoff(ctx, a.redisPollConfig(), func(ctx context.Context) (error, retry.AttemptResult) {
subCmd := a.redisClient.B().Subscribe().Channel(gitPushEventsRedisChannel).Build()
err := a.redisClient.Receive(ctx, subCmd, func(msg rueidis.PubSubMessage) {
protoMessage, err := redisProtoUnmarshal(msg.Message)
if err != nil {
a.HandleProcessingError(ctx, a.log, modshared.NoAgentId, fmt.Sprintf("receiver message in channel %q cannot be unmarshalled into proto message", gitPushEventsRedisChannel), err)
return
}
switch m := (protoMessage).(type) {
case *modserver.Project:
a.dispatchGitPushEvent(ctx, m)
default:
a.HandleProcessingError(
ctx,
a.log,
modshared.NoAgentId,
"GitOps: unable to handle received git push event",
fmt.Errorf("failed to cast proto message of type %T to concrete type", m))
}
})
switch err { // nolint:errorlint
case nil, context.Canceled, context.DeadlineExceeded:
return nil, retry.ContinueImmediately
default:
a.HandleProcessingError(ctx, a.log, modshared.NoAgentId, "Error handling Redis SUBSCRIBE", err)
return nil, retry.Backoff
}
})
}
// dispatchGitPushEvent dispatches the given `project` which is the message of the Git push event
// to all registered subscriptions registered by OnGitPushEvent.
func (a *serverApi) dispatchGitPushEvent(ctx context.Context, project *modserver.Project) {
done := ctx.Done()
a.gitPushEventSubscriptions.mu.Lock()
defer a.gitPushEventSubscriptions.mu.Unlock()
for _, ch := range a.gitPushEventSubscriptions.chs {
select {
case <-done:
return
case ch <- project:
}
}
}
func redisProtoMarshal(m proto.Message) ([]byte, error) {
a, err := anypb.New(m) // use Any to capture type information so that a value can be instantiated in redisProtoUnmarshal()
if err != nil {
return nil, err
}
return proto.Marshal(a)
}
func redisProtoUnmarshal(payload string) (proto.Message, error) {
var a anypb.Any
err := proto.Unmarshal([]byte(payload), &a)
if err != nil {
return nil, err
}
return a.UnmarshalNew()
}
func handleProcessingError(ctx context.Context, hub func() (SentryHub, string), log *zap.Logger, agentId int64, msg string, err error) {
if grpctool.RequestCanceledOrTimedOut(err) {
// An error caused by context signalling done
return
}
var ue errz.UserError
isUserError := errors.As(err, &ue)
if isUserError {
// TODO Don't log it, send it somewhere the user can see it https://gitlab.com/gitlab-org/gitlab/-/issues/277323
// Log at Info for now.
log.Info(msg, logz.Error(err))
} else {
h, transaction := hub()
logAndCapture(ctx, h, transaction, log, agentId, msg, err)
}
}
func logAndCapture(ctx context.Context, hub SentryHub, transaction string, log *zap.Logger, agentId int64, msg string, err error) {
log.Error(msg, logz.Error(err))
errStr := removeRandomPort(err.Error())
event := sentry.NewEvent()
if agentId != modshared.NoAgentId {
event.User.ID = strconv.FormatInt(agentId, 10)
}
event.Level = sentry.LevelError
event.Exception = []sentry.Exception{
{
Type: reflect.TypeOf(err).String(),
Value: fmt.Sprintf("%s: %s", msg, errStr),
Stacktrace: sentry.ExtractStacktrace(err),
},
}
tc := trace.SpanContextFromContext(ctx)
traceId := tc.TraceID()
if traceId.IsValid() {
event.Tags[modserver.SentryFieldTraceId] = traceId.String()
sampled := "false"
if tc.IsSampled() {
sampled = "true"
}
event.Tags[modserver.SentryFieldTraceSampled] = sampled
}
event.Transaction = transaction
hub.CaptureEvent(event)
}
func removeRandomPort(err string) string {
return removePortStdLibError.ReplaceAllString(err, "${1}x${2}")
}
|