-
Notifications
You must be signed in to change notification settings - Fork 0
/
serve.go
253 lines (215 loc) · 6.31 KB
/
serve.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
package serve
import (
"context"
"embed"
"errors"
"fmt"
"html/template"
"io"
"net/http"
"net/netip"
"os"
"os/signal"
"strings"
"time"
"github.com/labstack/echo/v4"
"github.com/labstack/echo/v4/middleware"
"github.com/labstack/gommon/log"
"go.bbkane.com/shovel/serve/custommiddleware"
"go.bbkane.com/warg/command"
"go.opentelemetry.io/contrib/instrumentation/github.com/labstack/echo/otelecho"
sdktrace "go.opentelemetry.io/otel/sdk/trace"
"go.opentelemetry.io/otel/trace"
)
// -- filesystem
//go:embed static
var embeddedFiles embed.FS
// -- template stuff
type Template struct {
templates *template.Template
}
func (t *Template) Render(w io.Writer, name string, data interface{}, c echo.Context) error {
// I would like to pass errors up to the caller, but the echo v4 framework
// silently swallows any error this function would return :(
// an error for template not found is:
// >> echo: http: panic serving 127.0.0.1:53382: html/template: "submit" is undefined
err := t.templates.ExecuteTemplate(w, name, data)
if err != nil {
panic(err)
}
return nil
}
// -- Run
func mustRead(fSys embed.FS, path string) []byte {
file, err := fSys.ReadFile(path)
if err != nil {
panic("oopsies bad fs path: " + err.Error())
}
return file
}
func addRoutes(e *echo.Echo, s *server) {
e.GET(
"/",
s.Index,
)
e.GET(
"/static/index.css",
func(c echo.Context) error {
blob := mustRead(embeddedFiles, "static/index.css")
return c.Blob(http.StatusOK, "text/css", blob)
},
)
e.GET(
"/static/3p/htmx.org@1.9.5/dist/htmx.min.js",
func(c echo.Context) error {
blob := mustRead(embeddedFiles, "static/3p/htmx.org@1.9.5/dist/htmx.min.js")
return c.Blob(http.StatusOK, "application/javascript; charset=UTF-8", blob)
},
)
e.GET(
"/static/loading-spinner.svg",
func(c echo.Context) error {
blob := mustRead(embeddedFiles, "static/loading-spinner.svg")
return c.Blob(http.StatusOK, "image/svg+xml", blob)
},
)
e.POST(
"/submit",
s.Submit,
)
}
func Run(cmdCtx command.Context) error {
addrPort := cmdCtx.Flags["--addr-port"].(netip.AddrPort).String()
motd, _ := cmdCtx.Flags["--motd"].(string)
footer, _ := cmdCtx.Flags["--footer"].(string)
otelProvider := cmdCtx.Flags["--otel-provider"].(string)
protocol := cmdCtx.Flags["--protocol"].(string)
var certFile string
var keyFile string
switch protocol {
case "HTTP":
// do nothing, we're fine
case "HTTPS":
for _, name := range []string{"--https-certfile", "--https-keyfile"} {
if _, exists := cmdCtx.Flags[name]; !exists {
return errors.New("--protocol HTTPS requires this flag to be set: " + name)
}
}
certFile = cmdCtx.Flags["--https-certfile"].(string)
keyFile = cmdCtx.Flags["--https-keyfile"].(string)
default:
panic("Unknown serve protocol: " + protocol)
}
traceIDTemplate := cmdCtx.Flags["--trace-id-template"].(string)
var tp *sdktrace.TracerProvider
var tpErr error
serviceName := []string{cmdCtx.AppName}
serviceName = append(serviceName, cmdCtx.Path...)
tracerArgs := tracerResourceArgs{
ServiceName: strings.Join(serviceName, " "),
ServiceVersion: cmdCtx.Version,
ServiceEnvironment: cmdCtx.Flags["--otel-service-env"].(string),
}
switch otelProvider {
case "openobserve":
for _, name := range []string{"--openobserve-endpoint", "--openobserve-user", "--openobserve-pass"} {
if _, exists := cmdCtx.Flags[name]; !exists {
return errors.New("--otel-provider requires this flag to be set: " + name)
}
}
httpTracerParams := initHTTPTracerProviderParams{
Endpoint: cmdCtx.Flags["--openobserve-endpoint"].(netip.AddrPort),
User: cmdCtx.Flags["--openobserve-user"].(string),
Password: cmdCtx.Flags["--openobserve-pass"].(string),
}
tp, tpErr = initHTTPTracerProvider(httpTracerParams, tracerArgs)
case "stdout":
tp, tpErr = initStdoutTracerProvider(tracerArgs)
default:
return fmt.Errorf("unknown --otel-provider: %v", otelProvider)
}
if tpErr != nil {
return fmt.Errorf("could not init tracerprovider: %w", tpErr)
}
e := echo.New()
// echo customization
e.HideBanner = true
// Add templates
{
fsTemplates, err := template.New("").
Funcs(template.FuncMap{}).
ParseFS(embeddedFiles, "static/templates/*.html")
if err != nil {
return fmt.Errorf("could not parse embedded template files: %w", err)
}
traceIDFlagTemplate, err := fsTemplates.New("trace-id-template").Parse(traceIDTemplate)
if err != nil {
return fmt.Errorf("could not parse --trace-id-template string: %w", err)
}
t := &Template{
templates: traceIDFlagTemplate,
}
e.Renderer = t
}
// TODO: add ability to log to file
// logger
// e.Logger.SetLevel(log.DEBUG)
// e.Use(middleware.Logger())
// e.Use(custommiddleware.LogRequest())
e.Use(otelecho.Middleware("shovel"))
e.Use(custommiddleware.TraceID())
// recover from panics
e.Use(middleware.Recover())
e.HTTPErrorHandler = func(err error, c echo.Context) {
ctx := c.Request().Context()
trace.SpanFromContext(ctx).RecordError(err)
e.DefaultHTTPErrorHandler(err, c)
}
// routes
s := &server{
Motd: template.HTML(motd),
Version: cmdCtx.Version,
Tracer: tp.Tracer(
"shovel serve", // TODO: get a better name
),
Footer: template.HTML(footer),
}
addRoutes(e, s)
// Start server and shutdown gracefully. https://echo.labstack.com/cookbook/graceful-shutdown/
go func() {
var startFunc func() error
switch protocol {
case "HTTP":
startFunc = func() error { return e.Start(addrPort) }
case "HTTPS":
startFunc = func() error {
return e.StartTLS(addrPort, certFile, keyFile)
}
default:
panic("Unknown serve protocol")
}
if err := startFunc(); err != nil && err != http.ErrServerClosed {
e.Logger.Fatalj(log.JSON{
"message": "start error, shutting down",
"err": err.Error(),
})
}
}()
// Wait for interrupt signal to gracefully shutdown the server with a timeout of 10 seconds.
// Use a buffered channel to avoid missing signals as recommended for signal.Notify
quit := make(chan os.Signal, 1)
signal.Notify(quit, os.Interrupt)
<-quit
ctx, cancel := context.WithTimeout(context.Background(), 10*time.Second)
defer cancel()
if err := e.Shutdown(ctx); err != nil {
e.Logger.Fatal(err)
return err
}
e.Logger.Info("echo shutdown complete")
if err := tp.Shutdown(ctx); err != nil {
e.Logger.Fatal(err)
}
e.Logger.Info("traceprovider shutdown complete")
return nil
}