/
api.go
196 lines (170 loc) · 8.36 KB
/
api.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
/****************************************************************************
* Copyright 2020-2023, Optimizely, Inc. and contributors *
* *
* 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 routers //
package routers
import (
"net/http"
"github.com/rakyll/statik/fs"
"github.com/rs/zerolog/log"
"github.com/optimizely/agent/config"
"github.com/optimizely/agent/pkg/handlers"
"github.com/optimizely/agent/pkg/metrics"
"github.com/optimizely/agent/pkg/middleware"
"github.com/optimizely/agent/pkg/optimizely"
_ "github.com/optimizely/agent/statik" // Required to serve openapi.yaml
"github.com/go-chi/chi/v5"
chimw "github.com/go-chi/chi/v5/middleware"
"github.com/go-chi/cors"
"github.com/go-chi/render"
)
// APIOptions defines the configuration parameters for Router.
type APIOptions struct {
maxConns int
sdkMiddleware func(next http.Handler) http.Handler
metricsRegistry *metrics.Registry
configHandler http.HandlerFunc
datafileHandler http.HandlerFunc
activateHandler http.HandlerFunc
decideHandler http.HandlerFunc
trackHandler http.HandlerFunc
overrideHandler http.HandlerFunc
lookupHandler http.HandlerFunc
saveHandler http.HandlerFunc
sendOdpEventHandler http.HandlerFunc
nStreamHandler http.HandlerFunc
oAuthHandler http.HandlerFunc
oAuthMiddleware func(next http.Handler) http.Handler
corsHandler func(next http.Handler) http.Handler
}
func forbiddenHandler(message string) http.HandlerFunc {
return func(w http.ResponseWriter, r *http.Request) {
http.Error(w, message, http.StatusForbidden)
}
}
// NewDefaultAPIRouter creates a new router with the default backing optimizely.Cache
func NewDefaultAPIRouter(optlyCache optimizely.Cache, conf config.AgentConfig, metricsRegistry *metrics.Registry) http.Handler {
authProvider := middleware.NewAuth(&conf.API.Auth)
if authProvider == nil {
log.Error().Msg("unable to initialize api auth middleware.")
return nil
}
authHandler := handlers.NewOAuthHandler(&conf.API.Auth)
if authHandler == nil {
log.Error().Msg("unable to initialize api auth handler.")
return nil
}
overrideHandler := handlers.Override
if !conf.API.EnableOverrides {
overrideHandler = forbiddenHandler("Overrides not enabled")
}
nStreamHandler := forbiddenHandler("Notification stream not enabled")
if conf.API.EnableNotifications {
nStreamHandler = handlers.NotificationEventStreamHandler(handlers.DefaultNotificationReceiver)
if conf.Synchronization.Notification.Enable {
nStreamHandler = handlers.NotificationEventStreamHandler(handlers.SyncedNotificationReceiver(conf.Synchronization))
}
}
mw := middleware.CachedOptlyMiddleware{Cache: optlyCache}
corsHandler := createCorsHandler(conf.API.CORS)
spec := &APIOptions{
maxConns: conf.API.MaxConns,
metricsRegistry: metricsRegistry,
configHandler: handlers.OptimizelyConfig,
datafileHandler: handlers.GetDatafile,
activateHandler: handlers.Activate,
decideHandler: handlers.Decide,
overrideHandler: overrideHandler,
lookupHandler: handlers.Lookup,
saveHandler: handlers.Save,
trackHandler: handlers.TrackEvent,
sendOdpEventHandler: handlers.SendOdpEvent,
sdkMiddleware: mw.ClientCtx,
nStreamHandler: nStreamHandler,
oAuthHandler: authHandler.CreateAPIAccessToken,
oAuthMiddleware: authProvider.AuthorizeAPI,
corsHandler: corsHandler,
}
return NewAPIRouter(spec)
}
// NewAPIRouter returns HTTP API router backed by an optimizely.Cache implementation
func NewAPIRouter(opt *APIOptions) *chi.Mux {
r := chi.NewRouter()
WithAPIRouter(opt, r)
return r
}
// WithAPIRouter appends routes and middleware to the given router.
// See https://godoc.org/github.com/go-chi/chi/v5#Mux.Group for usage
func WithAPIRouter(opt *APIOptions, r chi.Router) {
getConfigTimer := middleware.Metricize("get-config", opt.metricsRegistry)
getDatafileTimer := middleware.Metricize("get-datafile", opt.metricsRegistry)
activateTimer := middleware.Metricize("activate", opt.metricsRegistry)
decideTimer := middleware.Metricize("decide", opt.metricsRegistry)
overrideTimer := middleware.Metricize("override", opt.metricsRegistry)
lookupTimer := middleware.Metricize("lookup", opt.metricsRegistry)
saveTimer := middleware.Metricize("save", opt.metricsRegistry)
trackTimer := middleware.Metricize("track-event", opt.metricsRegistry)
sendOdpEventTimer := middleware.Metricize("send-odp-event", opt.metricsRegistry)
createAccesstokenTimer := middleware.Metricize("create-api-access-token", opt.metricsRegistry)
contentTypeMiddleware := chimw.AllowContentType("application/json")
configTracer := middleware.AddTracing("configHandler", "OptimizelyConfig")
datafileTracer := middleware.AddTracing("datafileHandler", "OptimizelyDatafile")
activateTracer := middleware.AddTracing("activateHandler", "Activate")
decideTracer := middleware.AddTracing("decideHandler", "Decide")
trackTracer := middleware.AddTracing("trackHandler", "Track")
overrideTracer := middleware.AddTracing("overrideHandler", "Override")
lookupTracer := middleware.AddTracing("lookupHandler", "Lookup")
saveTracer := middleware.AddTracing("saveHandler", "Save")
sendOdpEventTracer := middleware.AddTracing("sendOdpEventHandler", "SendOdpEvent")
nStreamTracer := middleware.AddTracing("notificationHandler", "SendNotificationEvent")
authTracer := middleware.AddTracing("authHandler", "AuthToken")
if opt.maxConns > 0 {
// Note this is NOT a rate limiter, but a concurrency threshold
r.Use(chimw.Throttle(opt.maxConns))
}
r.Use(middleware.SetTime)
r.Use(render.SetContentType(render.ContentTypeJSON), middleware.SetRequestID)
r.Route("/v1", func(r chi.Router) {
r.Use(opt.corsHandler, opt.sdkMiddleware)
r.With(getConfigTimer, opt.oAuthMiddleware, configTracer).Get("/config", opt.configHandler)
r.With(getDatafileTimer, opt.oAuthMiddleware, datafileTracer).Get("/datafile", opt.datafileHandler)
r.With(activateTimer, opt.oAuthMiddleware, contentTypeMiddleware, activateTracer).Post("/activate", opt.activateHandler)
r.With(decideTimer, opt.oAuthMiddleware, contentTypeMiddleware, decideTracer).Post("/decide", opt.decideHandler)
r.With(trackTimer, opt.oAuthMiddleware, contentTypeMiddleware, trackTracer).Post("/track", opt.trackHandler)
r.With(overrideTimer, opt.oAuthMiddleware, contentTypeMiddleware, overrideTracer).Post("/override", opt.overrideHandler)
r.With(lookupTimer, opt.oAuthMiddleware, contentTypeMiddleware, lookupTracer).Post("/lookup", opt.lookupHandler)
r.With(saveTimer, opt.oAuthMiddleware, contentTypeMiddleware, saveTracer).Post("/save", opt.saveHandler)
r.With(sendOdpEventTimer, opt.oAuthMiddleware, contentTypeMiddleware, sendOdpEventTracer).Post("/send-odp-event", opt.sendOdpEventHandler)
r.With(opt.oAuthMiddleware, nStreamTracer).Get("/notifications/event-stream", opt.nStreamHandler)
})
r.With(createAccesstokenTimer, authTracer).Post("/oauth/token", opt.oAuthHandler)
statikFS, err := fs.New()
if err != nil {
panic(err)
}
staticServer := http.FileServer(statikFS)
r.Handle("/*", staticServer)
}
func createCorsHandler(c config.CORSConfig) func(next http.Handler) http.Handler {
options := cors.Options{
AllowedOrigins: c.AllowedOrigins,
AllowedMethods: c.AllowedMethods,
AllowedHeaders: c.AllowedHeaders,
ExposedHeaders: c.ExposedHeaders,
AllowCredentials: c.AllowedCredentials,
MaxAge: c.MaxAge,
}
return cors.Handler(options)
}