/
server.go
160 lines (131 loc) · 5.26 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
package server
import (
"strings"
"math"
"github.com/OpenBankingUK/conformance-suite/pkg/version"
"github.com/gorilla/websocket"
"github.com/labstack/echo/v4"
"github.com/labstack/echo/v4/middleware"
"github.com/sirupsen/logrus"
)
// ListenHost defines the name/address by which the service can be accessed.
const ListenHost = "0.0.0.0"
// Server - wraps *echo.Echo.
type Server struct {
*echo.Echo // Wrap (using composition) *echo.Echo, allows us to pretend Server is echo.Echo.
logger *logrus.Entry
version version.Checker
}
// NewServer returns new echo.Echo server.
func NewServer(journey Journey, logger *logrus.Entry, version version.Checker) *Server {
server := &Server{
Echo: echo.New(),
logger: logger,
version: version,
}
server.Validator = newEchoValidatorAdapter()
server.HideBanner = true
server.HidePort = true
// Use custom logger config so that we can control where log lines like below get sent to - either /dev/null or stdout.
// {"time":"2018-12-18T13:00:40.291032Z","id":"","remote_ip":"192.0.2.1","host":"example.com","method":"POST","uri":"/api/config/global?pretty","status":400, "latency":627320,"latency_human":"627.32µs","bytes_in":0,"bytes_out":137}
server.Use(middleware.LoggerWithConfig(middleware.LoggerConfig{
Output: logger.Writer(),
}))
server.Use(middleware.Recover())
// TODO(mbana): figure out if this will break the downloading the report.zip file from the `/api/export` route.
// https://github.com/labstack/echo/issues/873. If it doesn't break it, enable Gzip compression.
// Another approach is to skip `/api/export` route using a skipper, see https://github.com/labstack/echo/issues/964.
server.Use(middleware.GzipWithConfig(middleware.GzipConfig{
// level between 1-9
// where 1 indicates the fastest compression (less compression), and
// 9 indicates the slowest compression method (best compression)
Level: 5,
Skipper: skipperGzip,
}))
// serve Vue.js site
server.Use(middleware.StaticWithConfig(middleware.StaticConfig{
Skipper: skipperSwagger,
Root: "web/dist",
Index: "index.html",
HTML5: true,
Browse: false,
}))
registerRoutes(journey, server, logger, version)
return server
}
func registerRoutes(journey Journey, server *Server, logger *logrus.Entry, version version.Checker) {
// swagger ui endpoints
for path, handler := range swaggerHandlers(logger) {
server.GET(path, handler)
}
// anything prefixed with api
api := server.Group("/api")
api.GET("/ping", func(c echo.Context) error { return nil })
importHandlers := newImportHandlers(journey, logger)
api.POST("/import/review", importHandlers.postImportReview)
api.POST("/import/rerun", importHandlers.postImportRerun)
configHandlers := newConfigHandlers(journey, logger)
// endpoint to post global configuration
api.POST("/config/global", configHandlers.configGlobalPostHandler)
api.GET("/config/conditional-property", configHandlers.configConditionalPropertyHandler)
// endpoints for discovery model
discoveryHandlers := newDiscoveryHandlers(journey, logger)
api.POST("/discovery-model", discoveryHandlers.setDiscoveryModelHandler)
// endpoints for test cases
testCaseHandlers := newTestCaseHandlers(journey, NewWebSocketUpgrader(), logger)
api.GET("/test-cases", testCaseHandlers.testCasesHandler)
// endpoints for test runner
runHandlers := newRunHandlers(journey, NewWebSocketUpgrader(), logger)
api.POST("/run", runHandlers.runStartPostHandler)
api.GET("/run/ws", runHandlers.listenResultWebSocket)
api.DELETE("/run", runHandlers.stopRunHandler)
// endpoints for validating and storing the token retrieved in `/conformancesuite/callback`
// `pkg/server/assets/main.js` calls into this endpoint.
redirectHandlers := newRedirectHandlers(journey, logger)
api.POST("/redirect/fragment/ok", redirectHandlers.postFragmentOKHandler)
api.POST("/redirect/query/ok", redirectHandlers.postQueryOKHandler)
api.POST("/redirect/error", redirectHandlers.postErrorHandler)
exportHandlers := newExportHandlers(journey, logger)
api.POST("/export", exportHandlers.postExport)
// endpoints for utility function such as version/update checking.
utilityEndpoints := newUtilityEndpoints(version)
api.GET("/version", utilityEndpoints.versionCheck)
}
// skipperSwagger - ensures that all requests not prefixed with any string in `pathsToSkip` is skipped.
// E.g., ensure that `/api/validation-runs` or `/swagger/docs` is not handled by the static middleware.
func skipperSwagger(c echo.Context) bool {
pathsToSkip := []string{
"/api",
"/swagger",
}
path := c.Path()
for _, pathToSkip := range pathsToSkip {
if strings.HasPrefix(path, pathToSkip) {
return true
}
}
return false
}
// skipperGzip - ensures that gzip compression is not turned on for the `/api/export` and `/api/import` paths.
// I.e., don't run the Gzip middleware for certain paths.
func skipperGzip(c echo.Context) bool {
pathsToSkip := []string{
"/api/export",
"/api/import",
}
path := c.Path()
for _, pathToSkip := range pathsToSkip {
if strings.HasPrefix(path, pathToSkip) {
return true
}
}
return false
}
// NewWebSocketUpgrader creates a new websocket.Ugprader.
func NewWebSocketUpgrader() *websocket.Upgrader {
maxMessageSize := math.MaxInt32
return &websocket.Upgrader{
ReadBufferSize: maxMessageSize,
WriteBufferSize: maxMessageSize,
}
}