-
Notifications
You must be signed in to change notification settings - Fork 34
/
server.go
464 lines (397 loc) · 14.5 KB
/
server.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
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
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
//
// Copyright 2023 Stacklok, Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package controlplane
import (
"context"
"fmt"
"net"
"net/http"
"time"
"github.com/gorilla/handlers"
"github.com/grpc-ecosystem/grpc-gateway/v2/runtime"
"github.com/open-feature/go-sdk/openfeature"
"github.com/prometheus/client_golang/prometheus/promhttp"
"github.com/rs/zerolog/log"
_ "github.com/signalfx/splunk-otel-go/instrumentation/github.com/lib/pq/splunkpq" // Auto-instrumented version of lib/pq
"go.opentelemetry.io/contrib/instrumentation/google.golang.org/grpc/otelgrpc"
"go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp"
"go.opentelemetry.io/otel"
"go.opentelemetry.io/otel/attribute"
"go.opentelemetry.io/otel/exporters/prometheus"
stdout "go.opentelemetry.io/otel/exporters/stdout/stdouttrace"
"go.opentelemetry.io/otel/propagation"
"go.opentelemetry.io/otel/sdk/instrumentation"
sdkmetric "go.opentelemetry.io/otel/sdk/metric"
"go.opentelemetry.io/otel/sdk/resource"
sdktrace "go.opentelemetry.io/otel/sdk/trace"
semconv "go.opentelemetry.io/otel/semconv/v1.17.0"
"golang.org/x/oauth2"
"google.golang.org/grpc"
"google.golang.org/grpc/credentials/insecure"
"google.golang.org/grpc/reflection"
"github.com/stacklok/minder/internal/assets"
"github.com/stacklok/minder/internal/auth"
"github.com/stacklok/minder/internal/authz"
serverconfig "github.com/stacklok/minder/internal/config/server"
"github.com/stacklok/minder/internal/controlplane/metrics"
"github.com/stacklok/minder/internal/crypto"
"github.com/stacklok/minder/internal/db"
"github.com/stacklok/minder/internal/events"
"github.com/stacklok/minder/internal/logger"
"github.com/stacklok/minder/internal/profiles"
"github.com/stacklok/minder/internal/projects"
"github.com/stacklok/minder/internal/providers"
ghprov "github.com/stacklok/minder/internal/providers/github"
"github.com/stacklok/minder/internal/providers/github/service"
"github.com/stacklok/minder/internal/providers/manager"
"github.com/stacklok/minder/internal/repositories/github"
"github.com/stacklok/minder/internal/ruletypes"
"github.com/stacklok/minder/internal/util"
pb "github.com/stacklok/minder/pkg/api/protobuf/go/minder/v1"
)
const metricsPath = "/metrics"
var (
readHeaderTimeout = 2 * time.Second
// RequestBodyMaxBytes is the maximum number of bytes that can be read from a request body
// We limit to 2MB for now
RequestBodyMaxBytes int64 = 2 << 20
)
// Server represents the controlplane server
type Server struct {
store db.Store
cfg *serverconfig.Config
evt events.Publisher
mt metrics.Metrics
grpcServer *grpc.Server
jwt auth.JwtValidator
providerAuthFactory func(string, bool) (*oauth2.Config, error)
authzClient authz.Client
idClient auth.Resolver
cryptoEngine crypto.Engine
featureFlags openfeature.IClient
// We may want to start breaking up the server struct if we use it to
// inject more entity-specific interfaces. For example, we may want to
// consider having a struct per grpc service
ruleTypes ruletypes.RuleTypeService
repos github.RepositoryService
profiles profiles.ProfileService
ghProviders service.GitHubProviderService
providerStore providers.ProviderStore
ghClient ghprov.ClientService
providerManager manager.ProviderManager
projectCreator projects.ProjectCreator
projectDeleter projects.ProjectDeleter
// Implementations for service registration
pb.UnimplementedHealthServiceServer
pb.UnimplementedOAuthServiceServer
pb.UnimplementedUserServiceServer
pb.UnimplementedRepositoryServiceServer
pb.UnimplementedProjectsServiceServer
pb.UnimplementedProfileServiceServer
pb.UnimplementedArtifactServiceServer
pb.UnimplementedPermissionsServiceServer
pb.UnimplementedProvidersServiceServer
pb.UnimplementedEvalResultsServiceServer
}
// NewServer creates a new server instance
func NewServer(
store db.Store,
evt events.Publisher,
cfg *serverconfig.Config,
serverMetrics metrics.Metrics,
jwt auth.JwtValidator,
cryptoEngine crypto.Engine,
authzClient authz.Client,
idClient auth.Resolver,
repoService github.RepositoryService,
profileService profiles.ProfileService,
ruleService ruletypes.RuleTypeService,
ghProviders service.GitHubProviderService,
providerManager manager.ProviderManager,
providerStore providers.ProviderStore,
projectDeleter projects.ProjectDeleter,
projectCreator projects.ProjectCreator,
) *Server {
return &Server{
store: store,
cfg: cfg,
evt: evt,
cryptoEngine: cryptoEngine,
jwt: jwt,
providerAuthFactory: auth.NewOAuthConfig,
mt: serverMetrics,
profiles: profileService,
ruleTypes: ruleService,
providerStore: providerStore,
featureFlags: openfeature.NewClient(cfg.Flags.AppName),
ghClient: &ghprov.ClientServiceImplementation{},
providerManager: providerManager,
repos: repoService,
ghProviders: ghProviders,
authzClient: authzClient,
idClient: idClient,
projectCreator: projectCreator,
projectDeleter: projectDeleter,
}
}
func (s *Server) initTracer() (*sdktrace.TracerProvider, error) {
// create a stdout exporter to show collected spans out to stdout.
exporter, err := stdout.New(stdout.WithPrettyPrint())
if err != nil {
return nil, err
}
sample_ratio := s.cfg.Tracing.SampleRatio
sampler := sdktrace.ParentBased(sdktrace.TraceIDRatioBased(sample_ratio))
tp := sdktrace.NewTracerProvider(
sdktrace.WithSampler(sampler),
sdktrace.WithBatcher(exporter),
)
otel.SetTracerProvider(tp)
otel.SetTextMapPropagator(propagation.TraceContext{})
return tp, nil
}
func initMetrics(r sdkmetric.Reader) *sdkmetric.MeterProvider {
// See the go.opentelemetry.io/otel/sdk/resource package for more
res := resource.NewWithAttributes(
semconv.SchemaURL,
semconv.ServiceName("minder"),
// TODO: Make this auto-generated
semconv.ServiceVersion("v0.1.0"),
)
// By default/spec (?!), otel includes net.sock.peer.{addr,port}.
// See https://github.com/open-telemetry/opentelemetry-go-contrib/issues/3071
// This exposes a DoS vector and needlessly blows up the RPC metrics.
// This view filters the peer address and port out of the metrics.
rpcPeerFilter := sdkmetric.NewView(
sdkmetric.Instrument{Scope: instrumentation.Scope{
Name: "go.opentelemetry.io/contrib/instrumentation/google.golang.org/grpc/otelgrpc",
}},
sdkmetric.Stream{AttributeFilter: attribute.NewDenyKeysFilter(
"net.sock.peer.addr", "net.sock.peer.port",
)},
)
mp := sdkmetric.NewMeterProvider(
sdkmetric.WithResource(res),
sdkmetric.WithReader(r),
sdkmetric.WithView(rpcPeerFilter),
)
otel.SetMeterProvider(mp)
return mp
}
// StartGRPCServer starts a gRPC server and blocks while serving.
func (s *Server) StartGRPCServer(ctx context.Context) error {
lis, err := net.Listen("tcp", s.cfg.GRPCServer.GetAddress())
if err != nil {
return fmt.Errorf("failed to listen: %v", err)
}
// add logger and tracing (if enabled)
interceptors := []grpc.UnaryServerInterceptor{
// TODO: this has no test coverage!
util.SanitizingInterceptor(),
logger.Interceptor(s.cfg.LoggingConfig),
TokenValidationInterceptor,
EntityContextProjectInterceptor,
ProjectAuthorizationInterceptor,
}
options := []grpc.ServerOption{
grpc.Creds(insecure.NewCredentials()),
grpc.ChainUnaryInterceptor(interceptors...),
}
otelGRPCOpts := s.getOTELGRPCInterceptorOpts()
if len(otelGRPCOpts) > 0 {
options = append(options, grpc.StatsHandler(otelgrpc.NewServerHandler()))
}
s.grpcServer = grpc.NewServer(
options...,
)
// register the services (declared within register_handlers.go)
RegisterGRPCServices(s)
reflection.Register(s.grpcServer)
errch := make(chan error)
log.Printf("Starting gRPC server on %s", s.cfg.GRPCServer.GetAddress())
go func() {
if err := s.grpcServer.Serve(lis); err != nil {
errch <- fmt.Errorf("failed to serve: %w", err)
}
}()
select {
case err := <-errch:
log.Printf("GRPC server fatal error: %v\n", err)
return err
case <-ctx.Done():
log.Printf("shutting down 'GRPC server'")
s.grpcServer.GracefulStop()
return nil
}
}
// getOTELGRPCInterceptorOpts gathers relevant options and
func (s *Server) getOTELGRPCInterceptorOpts() []otelgrpc.Option {
opts := []otelgrpc.Option{}
if s.cfg.Tracing.Enabled {
opts = append(opts, otelgrpc.WithTracerProvider(otel.GetTracerProvider()))
}
if s.cfg.Metrics.Enabled {
opts = append(opts, otelgrpc.WithMeterProvider(otel.GetMeterProvider()))
}
return opts
}
// StartHTTPServer starts a HTTP server and registers the gRPC handler mux to it
// set store as a blank identifier for now as we will use it in the future
func (s *Server) StartHTTPServer(ctx context.Context) error {
mux := http.NewServeMux()
addTracing := s.cfg.Tracing.Enabled
if addTracing {
tp, err := s.initTracer()
if err != nil {
return fmt.Errorf("failed to initialize TracerProvider: %w", err)
}
defer shutdownHandler("TracerProvider", func(ctx context.Context) error {
return tp.Shutdown(ctx)
})
}
gwmux := runtime.NewServeMux()
opts := []grpc.DialOption{grpc.WithTransportCredentials(insecure.NewCredentials())}
// register the services (declared within register_handlers.go)
RegisterGatewayHTTPHandlers(ctx, gwmux, s.cfg.GRPCServer.GetAddress(), opts)
fs := http.FileServer(http.FS(assets.StaticAssets))
mw := otelhttp.NewMiddleware("webhook")
// Explicitly handle HTTP only requests
err := gwmux.HandlePath(http.MethodGet, "/api/v1/auth/callback/{provider}/cli", s.HandleOAuthCallback())
if err != nil {
return fmt.Errorf("failed to register provider callback handler: %w", err)
}
err = gwmux.HandlePath(http.MethodGet, "/api/v1/auth/callback/{provider}/web", s.HandleOAuthCallback())
if err != nil {
return fmt.Errorf("failed to register provider callback handler: %w", err)
}
err = gwmux.HandlePath(http.MethodGet, "/api/v1/auth/callback/{provider}/app", s.HandleGitHubAppCallback())
if err != nil {
return fmt.Errorf("failed to register GitHub App callback handler: %w", err)
}
mux.Handle("/", withMaxSizeMiddleware(s.handlerWithHTTPMiddleware(gwmux)))
mux.Handle("/api/v1/webhook/", mw(withMaxSizeMiddleware(s.HandleGitHubWebHook())))
mux.Handle("/api/v1/ghapp/", mw(withMaxSizeMiddleware(s.HandleGitHubAppWebhook())))
mux.Handle("/api/v1/gh-marketplace/", mw(withMaxSizeMiddleware(s.NoopWebhookHandler())))
mux.Handle("/static/", fs)
errch := make(chan error)
log.Printf("Starting HTTP server on %s", s.cfg.HTTPServer.GetAddress())
server := http.Server{
Addr: s.cfg.HTTPServer.GetAddress(),
Handler: mux,
ReadHeaderTimeout: readHeaderTimeout,
}
// start the metrics server if enabled
if s.cfg.Metrics.Enabled {
go func() {
if err := s.startMetricServer(ctx); err != nil {
log.Printf("failed to start metrics server: %v", err)
}
}()
}
// start the HTTP server
go func() {
if err := server.ListenAndServe(); err != nil {
errch <- fmt.Errorf("failed to serve: %w", err)
}
}()
select {
case err := <-errch:
log.Printf("HTTP server fatal error: %v", err)
return err
case <-ctx.Done():
shutdownCtx, shutdownRelease := context.WithTimeout(context.Background(), 5*time.Second)
defer shutdownRelease()
log.Printf("shutting down 'HTTP server'")
return server.Shutdown(shutdownCtx)
}
}
func (s *Server) handlerWithHTTPMiddleware(h http.Handler) http.Handler {
if s.cfg.HTTPServer.CORS.Enabled {
var opts []handlers.CORSOption
if len(s.cfg.HTTPServer.CORS.AllowOrigins) > 0 {
opts = append(opts, handlers.AllowedOrigins(s.cfg.HTTPServer.CORS.AllowOrigins))
}
if len(s.cfg.HTTPServer.CORS.AllowMethods) > 0 {
opts = append(opts, handlers.AllowedMethods(s.cfg.HTTPServer.CORS.AllowMethods))
}
if len(s.cfg.HTTPServer.CORS.AllowHeaders) > 0 {
opts = append(opts, handlers.AllowedHeaders(s.cfg.HTTPServer.CORS.AllowHeaders))
}
if len(s.cfg.HTTPServer.CORS.ExposeHeaders) > 0 {
opts = append(opts, handlers.ExposedHeaders(s.cfg.HTTPServer.CORS.ExposeHeaders))
}
if s.cfg.HTTPServer.CORS.AllowCredentials {
opts = append(opts, handlers.AllowCredentials())
}
return handlers.CORS(opts...)(h)
}
return h
}
// startMetricServer starts a Prometheus metrics server and blocks while serving
func (s *Server) startMetricServer(ctx context.Context) error {
// pull-based Prometheus exporter
prometheusExporter, err := prometheus.New(
prometheus.WithNamespace("minder"),
)
if err != nil {
return fmt.Errorf("could not initialize metrics: %w", err)
}
mp := initMetrics(prometheusExporter)
defer shutdownHandler("MeterProvider", func(ctx context.Context) error {
return mp.Shutdown(ctx)
})
err = s.mt.Init(s.store)
if err != nil {
return fmt.Errorf("could not initialize instruments: %w", err)
}
handler := promhttp.Handler()
mux := http.NewServeMux()
mux.Handle(metricsPath, handler)
ch := make(chan error)
log.Printf("Starting metrics server on %s", s.cfg.MetricServer.GetAddress())
server := http.Server{
Addr: s.cfg.MetricServer.GetAddress(),
Handler: mux,
ReadHeaderTimeout: readHeaderTimeout,
}
go func() {
ch <- server.ListenAndServe()
}()
select {
case err := <-ch:
log.Printf("Metric server fatal error: %v", err)
return err
case <-ctx.Done():
shutdownCtx, shutdownRelease := context.WithTimeout(context.Background(), 5*time.Second)
defer shutdownRelease()
log.Printf("shutting down 'Metric server'")
return server.Shutdown(shutdownCtx)
}
}
type shutdowner func(context.Context) error
func shutdownHandler(component string, sdf shutdowner) {
shutdownCtx, shutdownRelease := context.WithTimeout(context.Background(), 5*time.Second)
defer shutdownRelease()
log.Printf("shutting down '%s'", component)
if err := sdf(shutdownCtx); err != nil {
log.Fatal().Msgf("error shutting down '%s': %+v", component, err)
}
}
func withMaxSizeMiddleware(h http.Handler) http.Handler {
return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
r.Body = http.MaxBytesReader(w, r.Body, RequestBodyMaxBytes)
h.ServeHTTP(w, r)
})
}