This repository has been archived by the owner on Jul 12, 2023. It is now read-only.
/
render.go
128 lines (107 loc) · 3.19 KB
/
render.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
// Copyright 2020 Google LLC
//
// 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 render defines rendering functionality.
package render
import (
"bytes"
"context"
"fmt"
"html/template"
"os"
"path/filepath"
"sync"
"github.com/google/exposure-notifications-server/pkg/logging"
"go.uber.org/zap"
)
// allowedResponseCodes are the list of allowed response codes. This is
// primarily here to catch if someone, in the future, accidentially includes a
// bad status code.
var allowedResponseCodes = map[int]struct{}{
200: {},
400: {},
401: {},
404: {},
405: {},
413: {},
429: {},
500: {},
}
// Renderer is responsible for rendering various content and templates like HTML
// and JSON responses.
type Renderer struct {
// debug indicates templates should be reloaded on each invocation and real
// error responses should be rendered. Do not enable in production.
debug bool
// logger is the log writer.
logger *zap.SugaredLogger
// rendererPool is a pool of *bytes.Buffer, used as a rendering buffer to
// prevent partial responses being sent to clients.
rendererPool *sync.Pool
// templates is the actually collection of templates. templatesLoader is a
// function for (re)loading templates. templatesLock is a mutex to prevent
// concurrent modification of the templates field.
templates *template.Template
templatesRoot string
}
// New creates a new renderer with the given details.
func New(ctx context.Context, root string, debug bool) (*Renderer, error) {
logger := logging.FromContext(ctx)
r := &Renderer{
debug: debug,
logger: logger,
rendererPool: &sync.Pool{
New: func() interface{} {
return bytes.NewBuffer(make([]byte, 0, 1024))
},
},
templatesRoot: root,
}
// Load initial templates
if err := r.loadTemplates(); err != nil {
return nil, err
}
return r, nil
}
// loadTemplates loads or reloads all templates.
func (r *Renderer) loadTemplates() error {
if r.templatesRoot == "" {
return nil
}
tmpl := template.New("").Option("missingkey=zero")
if err := loadTemplates(tmpl, r.templatesRoot); err != nil {
return fmt.Errorf("failed to load templates: %w", err)
}
r.templates = tmpl
return nil
}
func loadTemplates(tmpl *template.Template, root string) error {
return filepath.Walk(root, func(path string, info os.FileInfo, err error) error {
if err != nil {
return err
}
if info.IsDir() {
return nil
}
if _, err := tmpl.ParseFiles(path); err != nil {
return fmt.Errorf("failed to parse %s: %w", path, err)
}
return nil
})
}
// AllowedResponseCode returns true if the code is a permitted response code,
// false otherwise.
func (r *Renderer) AllowedResponseCode(code int) bool {
_, ok := allowedResponseCodes[code]
return ok
}