forked from vektah/dataloaden
-
Notifications
You must be signed in to change notification settings - Fork 0
/
template.go
195 lines (160 loc) · 4.58 KB
/
template.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
package main
import "text/template"
var tpl = template.Must(template.New("generated").Parse(`
// Code generated by github.com/vektah/dataloaden, DO NOT EDIT.
package {{.Package}}
import (
"sync"
"time"
{{if .Import}}"{{.Import}}"{{end}}
)
// {{.LoaderName}} batches and caches requests
type {{.LoaderName}} struct {
// this method provides the data for the loader
fetch func(keys []{{.KeyType}}) ([]{{.ValType}}, []error)
// how long to done before sending a batch
wait time.Duration
// this will limit the maximum number of keys to send in one batch, 0 = no limit
maxBatch int
// INTERNAL
// lazily created cache
cache map[{{.KeyType}}]{{.ValType}}
// the current batch. keys will continue to be collected until timeout is hit,
// then everything will be sent to the fetch method and out to the listeners
batch *{{.BatchName}}
// mutex to prevent races
mu sync.Mutex
}
type {{.BatchName}} struct {
keys []{{.KeyType}}
data []{{.ValType}}
error []error
closing bool
done chan struct{}
}
// Load a {{.Name}} by key, batching and caching will be applied automatically
func (l *{{.LoaderName}}) Load(key {{.KeyType}}) ({{.ValType}}, error) {
return l.LoadThunk(key)()
}
// LoadThunk returns a function that when called will block waiting for a {{.Name}}.
// This method should be used if you want one goroutine to make requests to many
// different data loaders without blocking until the thunk is called.
func (l *{{.LoaderName}}) LoadThunk(key {{.KeyType}}) func() ({{.ValType}}, error) {
l.mu.Lock()
if it, ok := l.cache[key]; ok {
l.mu.Unlock()
return func() ({{.ValType}}, error) {
return it, nil
}
}
if l.batch == nil {
l.batch = &{{.BatchName}}{done: make(chan struct{})}
}
batch := l.batch
pos := batch.keyIndex(l, key)
l.mu.Unlock()
return func() ({{.ValType}}, error) {
<-batch.done
var data {{.ValType}}
if pos < len(batch.data) {
data = batch.data[pos]
}
var err error
// its convenient to be able to return a single error for everything
if len(batch.error) == 1 {
err = batch.error[0]
} else if batch.error != nil {
err = batch.error[pos]
}
if err == nil {
l.mu.Lock()
l.unsafeSet(key, data)
l.mu.Unlock()
}
return data, err
}
}
// LoadAll fetches many keys at once. It will be broken into appropriate sized
// sub batches depending on how the loader is configured
func (l *{{.LoaderName}}) LoadAll(keys []{{.KeyType}}) ([]{{.ValType}}, []error) {
results := make([]func() ({{.ValType}}, error), len(keys))
for i, key := range keys {
results[i] = l.LoadThunk(key)
}
{{.Name}}s := make([]{{.ValType}}, len(keys))
errors := make([]error, len(keys))
for i, thunk := range results {
{{.Name}}s[i], errors[i] = thunk()
}
return {{.Name}}s, errors
}
// Prime the cache with the provided key and value. If the key already exists, no change is made
// and false is returned.
// (To forcefully prime the cache, clear the key first with loader.clear(key).prime(key, value).)
func (l *{{.LoaderName}}) Prime(key {{.KeyType}}, value {{.ValType}}) bool {
l.mu.Lock()
var found bool
if _, found = l.cache[key]; !found {
{{- if .Slice }}
l.unsafeSet(key, value)
{{- else }}
// make a copy when writing to the cache, its easy to pass a pointer in from a loop var
// and end up with the whole cache pointing to the same value.
cpy := *value
l.unsafeSet(key, &cpy)
{{- end }}
}
l.mu.Unlock()
return !found
}
// Clear the value at key from the cache, if it exists
func (l *{{.LoaderName}}) Clear(key {{.KeyType}}) {
l.mu.Lock()
delete(l.cache, key)
l.mu.Unlock()
}
func (l *{{.LoaderName}}) unsafeSet(key {{.KeyType}}, value {{.ValType}}) {
if l.cache == nil {
l.cache = map[{{.KeyType}}]{{.ValType}}{}
}
l.cache[key] = value
}
// keyIndex will return the location of the key in the batch, if its not found
// it will add the key to the batch
func (b *{{.BatchName}}) keyIndex(l *{{.LoaderName}}, key {{.KeyType}}) int {
for i, existingKey := range b.keys {
if key == existingKey {
return i
}
}
pos := len(b.keys)
b.keys = append(b.keys, key)
if pos == 0 {
go b.startTimer(l)
}
if l.maxBatch != 0 && pos >= l.maxBatch-1 {
if !b.closing {
b.closing = true
l.batch = nil
go b.end(l)
}
}
return pos
}
func (b *{{.BatchName}}) startTimer(l *{{.LoaderName}}) {
time.Sleep(l.wait)
l.mu.Lock()
// we must have hit a batch limit and are already finalizing this batch
if b.closing {
l.mu.Unlock()
return
}
l.batch = nil
l.mu.Unlock()
b.end(l)
}
func (b *{{.BatchName}}) end(l *{{.LoaderName}}) {
b.data, b.error = l.fetch(b.keys)
close(b.done)
}
`))