/
router.go
197 lines (165 loc) · 5.2 KB
/
router.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
// SPDX-License-Identifier: Apache-2.0
/*
Package gin provides some basic implementations for building routers based on gin-gonic/gin
*/
package gin
import (
"context"
"net/http"
"sort"
"strings"
"sync"
"github.com/gin-gonic/gin"
"github.com/luraproject/lura/v2/config"
"github.com/luraproject/lura/v2/core"
"github.com/luraproject/lura/v2/logging"
"github.com/luraproject/lura/v2/proxy"
"github.com/luraproject/lura/v2/router"
"github.com/luraproject/lura/v2/transport/http/server"
)
const logPrefix = "[SERVICE: Gin]"
// RunServerFunc is a func that will run the http Server with the given params.
type RunServerFunc func(context.Context, config.ServiceConfig, http.Handler) error
// Config is the struct that collects the parts the router should be builded from
type Config struct {
Engine *gin.Engine
Middlewares []gin.HandlerFunc
HandlerFactory HandlerFactory
ProxyFactory proxy.Factory
Logger logging.Logger
RunServer RunServerFunc
}
// DefaultFactory returns a gin router factory with the injected proxy factory and logger.
// It also uses a default gin router and the default HandlerFactory
func DefaultFactory(proxyFactory proxy.Factory, logger logging.Logger) router.Factory {
return NewFactory(
Config{
Engine: gin.Default(),
Middlewares: []gin.HandlerFunc{},
HandlerFactory: EndpointHandler,
ProxyFactory: proxyFactory,
Logger: logger,
RunServer: server.RunServer,
},
)
}
// NewFactory returns a gin router factory with the injected configuration
func NewFactory(cfg Config) router.Factory {
return factory{cfg}
}
type factory struct {
cfg Config
}
// New implements the factory interface
func (rf factory) New() router.Router {
return rf.NewWithContext(context.Background())
}
// NewWithContext implements the factory interface
func (rf factory) NewWithContext(ctx context.Context) router.Router {
return ginRouter{
cfg: rf.cfg,
ctx: ctx,
runServerF: rf.cfg.RunServer,
mu: new(sync.Mutex),
urlCatalog: urlCatalog{
mu: new(sync.Mutex),
catalog: map[string][]string{},
},
}
}
type ginRouter struct {
cfg Config
ctx context.Context
runServerF RunServerFunc
mu *sync.Mutex
urlCatalog urlCatalog
}
type urlCatalog struct {
mu *sync.Mutex
catalog map[string][]string
}
// Run completes the router initialization and executes it
func (r ginRouter) Run(cfg config.ServiceConfig) {
r.mu.Lock()
defer r.mu.Unlock()
server.InitHTTPDefaultTransport(cfg)
r.registerEndpointsAndMiddlewares(cfg)
r.cfg.Logger.Info("[SERVICE: Gin] Listening on port:", cfg.Port)
if err := r.runServerF(r.ctx, cfg, r.cfg.Engine.Handler()); err != nil && err != http.ErrServerClosed {
r.cfg.Logger.Error(logPrefix, err.Error())
}
r.cfg.Logger.Info(logPrefix, "Router execution ended")
}
func (r ginRouter) registerEndpointsAndMiddlewares(cfg config.ServiceConfig) {
if cfg.Debug {
r.cfg.Engine.Any("/__debug/*param", DebugHandler(r.cfg.Logger))
}
if cfg.Echo {
r.cfg.Engine.Any("/__echo/*param", EchoHandler())
}
endpointGroup := r.cfg.Engine.Group("/")
endpointGroup.Use(r.cfg.Middlewares...)
r.registerKrakendEndpoints(endpointGroup, cfg)
if opts, ok := cfg.ExtraConfig[Namespace].(map[string]interface{}); ok {
if v, ok := opts["auto_options"].(bool); ok && v {
r.cfg.Logger.Debug(logPrefix, "Enabling the auto options endpoints")
r.registerOptionEndpoints(endpointGroup)
}
}
}
func (r ginRouter) registerKrakendEndpoints(rg *gin.RouterGroup, cfg config.ServiceConfig) {
// build and register the pipes and endpoints sequentially
for _, c := range cfg.Endpoints {
proxyStack, err := r.cfg.ProxyFactory.New(c)
if err != nil {
r.cfg.Logger.Error(logPrefix, "Calling the ProxyFactory", err.Error())
continue
}
r.registerKrakendEndpoint(rg, c.Method, c, r.cfg.HandlerFactory(c, proxyStack), len(c.Backend))
}
}
func (r ginRouter) registerKrakendEndpoint(rg *gin.RouterGroup, method string, e *config.EndpointConfig, h gin.HandlerFunc, total int) {
method = strings.ToTitle(method)
path := e.Endpoint
if method != http.MethodGet && total > 1 {
if !router.IsValidSequentialEndpoint(e) {
r.cfg.Logger.Error(logPrefix, method, "endpoints with sequential proxy enabled only allow a non-GET in the last backend! Ignoring", path)
return
}
}
switch method {
case http.MethodGet:
rg.GET(path, h)
case http.MethodPost:
rg.POST(path, h)
case http.MethodPut:
rg.PUT(path, h)
case http.MethodPatch:
rg.PATCH(path, h)
case http.MethodDelete:
rg.DELETE(path, h)
default:
r.cfg.Logger.Error(logPrefix, "[ENDPOINT:", path, "] Unsupported method", method)
return
}
r.urlCatalog.mu.Lock()
defer r.urlCatalog.mu.Unlock()
methods, ok := r.urlCatalog.catalog[path]
if !ok {
r.urlCatalog.catalog[path] = []string{method}
return
}
r.urlCatalog.catalog[path] = append(methods, method)
}
func (r ginRouter) registerOptionEndpoints(rg *gin.RouterGroup) {
r.urlCatalog.mu.Lock()
defer r.urlCatalog.mu.Unlock()
for path, methods := range r.urlCatalog.catalog {
sort.Strings(methods)
allowed := strings.Join(methods, ", ")
rg.OPTIONS(path, func(c *gin.Context) {
c.Header("Allow", allowed)
c.Header(core.KrakendHeaderName, core.KrakendHeaderValue)
})
}
}