forked from hashicorp/vault
-
Notifications
You must be signed in to change notification settings - Fork 1
/
spanner.go
374 lines (310 loc) · 9.59 KB
/
spanner.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
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
package spanner
import (
"context"
"fmt"
"os"
"sort"
"strconv"
"strings"
"time"
metrics "github.com/armon/go-metrics"
"github.com/hashicorp/errwrap"
log "github.com/hashicorp/go-hclog"
"github.com/hashicorp/vault/sdk/helper/strutil"
"github.com/hashicorp/vault/sdk/helper/useragent"
"github.com/hashicorp/vault/sdk/physical"
"google.golang.org/api/iterator"
"google.golang.org/api/option"
"google.golang.org/grpc/codes"
"cloud.google.com/go/spanner"
"github.com/pkg/errors"
)
// Verify Backend satisfies the correct interfaces
var _ physical.Backend = (*Backend)(nil)
var _ physical.Transactional = (*Backend)(nil)
const (
// envDatabase is the name of the environment variable to search for the
// database name.
envDatabase = "GOOGLE_SPANNER_DATABASE"
// envHAEnabled is the name of the environment variable to search for the
// boolean indicating if HA is enabled.
envHAEnabled = "GOOGLE_SPANNER_HA_ENABLED"
// envHATable is the name of the environment variable to search for the table
// name to use for HA.
envHATable = "GOOGLE_SPANNER_HA_TABLE"
// envTable is the name of the environment variable to search for the table
// name.
envTable = "GOOGLE_SPANNER_TABLE"
// defaultTable is the default table name if none is specified.
defaultTable = "Vault"
// defaultHASuffix is the default suffix to apply to the table name if no
// HA table is provided.
defaultHASuffix = "HA"
)
var (
// metricDelete is the key for the metric for measuring a Delete call.
metricDelete = []string{"spanner", "delete"}
// metricGet is the key for the metric for measuring a Get call.
metricGet = []string{"spanner", "get"}
// metricList is the key for the metric for measuring a List call.
metricList = []string{"spanner", "list"}
// metricPut is the key for the metric for measuring a Put call.
metricPut = []string{"spanner", "put"}
// metricTxn is the key for the metric for measuring a Transaction call.
metricTxn = []string{"spanner", "txn"}
)
// Backend implements physical.Backend and describes the steps necessary to
// persist data using Google Cloud Spanner.
type Backend struct {
// database is the name of the database to use for data storage and retrieval.
// This is supplied as part of user configuration.
database string
// table is the name of the table in the database.
table string
// client is the API client and permitPool is the allowed concurrent uses of
// the client.
client *spanner.Client
permitPool *physical.PermitPool
// haTable is the name of the table to use for HA in the database.
haTable string
// haEnabled indicates if high availability is enabled. Default: true.
haEnabled bool
// haClient is the API client. This is managed separately from the main client
// because a flood of requests should not block refreshing the TTLs on the
// lock.
//
// This value will be nil if haEnabled is false.
haClient *spanner.Client
// logger is the internal logger.
logger log.Logger
}
// NewBackend creates a new Google Spanner storage backend with the given
// configuration. This uses the official Golang Cloud SDK and therefore supports
// specifying credentials via envvars, credential files, etc.
func NewBackend(c map[string]string, logger log.Logger) (physical.Backend, error) {
logger.Debug("configuring backend")
// Database name
database := os.Getenv(envDatabase)
if database == "" {
database = c["database"]
}
if database == "" {
return nil, errors.New("missing database name")
}
// Table name
table := os.Getenv(envTable)
if table == "" {
table = c["table"]
}
if table == "" {
table = defaultTable
}
// HA table name
haTable := os.Getenv(envHATable)
if haTable == "" {
haTable = c["ha_table"]
}
if haTable == "" {
haTable = table + defaultHASuffix
}
// HA configuration
haClient := (*spanner.Client)(nil)
haEnabled := false
haEnabledStr := os.Getenv(envHAEnabled)
if haEnabledStr == "" {
haEnabledStr = c["ha_enabled"]
}
if haEnabledStr != "" {
var err error
haEnabled, err = strconv.ParseBool(haEnabledStr)
if err != nil {
return nil, errwrap.Wrapf("failed to parse HA enabled: {{err}}", err)
}
}
if haEnabled {
logger.Debug("creating HA client")
var err error
ctx := context.Background()
haClient, err = spanner.NewClient(ctx, database,
option.WithUserAgent(useragent.String()),
)
if err != nil {
return nil, errwrap.Wrapf("failed to create HA client: {{err}}", err)
}
}
// Max parallel
maxParallel, err := extractInt(c["max_parallel"])
if err != nil {
return nil, errwrap.Wrapf("failed to parse max_parallel: {{err}}", err)
}
logger.Debug("configuration",
"database", database,
"table", table,
"haEnabled", haEnabled,
"haTable", haTable,
"maxParallel", maxParallel,
)
logger.Debug("creating client")
ctx := context.Background()
client, err := spanner.NewClient(ctx, database,
option.WithUserAgent(useragent.String()),
)
if err != nil {
return nil, errwrap.Wrapf("failed to create spanner client: {{err}}", err)
}
return &Backend{
database: database,
table: table,
client: client,
permitPool: physical.NewPermitPool(maxParallel),
haEnabled: haEnabled,
haTable: haTable,
haClient: haClient,
logger: logger,
}, nil
}
// Put creates or updates an entry.
func (b *Backend) Put(ctx context.Context, entry *physical.Entry) error {
defer metrics.MeasureSince(metricPut, time.Now())
// Pooling
b.permitPool.Acquire()
defer b.permitPool.Release()
// Insert
m := spanner.InsertOrUpdateMap(b.table, map[string]interface{}{
"Key": entry.Key,
"Value": entry.Value,
})
if _, err := b.client.Apply(ctx, []*spanner.Mutation{m}); err != nil {
return errwrap.Wrapf("failed to put data: {{err}}", err)
}
return nil
}
// Get fetches an entry. If there is no entry, this function returns nil.
func (b *Backend) Get(ctx context.Context, key string) (*physical.Entry, error) {
defer metrics.MeasureSince(metricGet, time.Now())
// Pooling
b.permitPool.Acquire()
defer b.permitPool.Release()
// Read
row, err := b.client.Single().ReadRow(ctx, b.table, spanner.Key{key}, []string{"Value"})
if spanner.ErrCode(err) == codes.NotFound {
return nil, nil
}
if err != nil {
return nil, errwrap.Wrapf(fmt.Sprintf("failed to read value for %q: {{err}}", key), err)
}
var value []byte
if err := row.Column(0, &value); err != nil {
return nil, errwrap.Wrapf("failed to decode value into bytes: {{err}}", err)
}
return &physical.Entry{
Key: key,
Value: value,
}, nil
}
// Delete deletes an entry with the given key.
func (b *Backend) Delete(ctx context.Context, key string) error {
defer metrics.MeasureSince(metricDelete, time.Now())
// Pooling
b.permitPool.Acquire()
defer b.permitPool.Release()
// Delete
m := spanner.Delete(b.table, spanner.Key{key})
if _, err := b.client.Apply(ctx, []*spanner.Mutation{m}); err != nil {
return errwrap.Wrapf("failed to delete key: {{err}}", err)
}
return nil
}
// List enumerates all keys with the given prefix.
func (b *Backend) List(ctx context.Context, prefix string) ([]string, error) {
defer metrics.MeasureSince(metricList, time.Now())
// Pooling
b.permitPool.Acquire()
defer b.permitPool.Release()
// Sanitize
safeTable := sanitizeTable(b.table)
// List
iter := b.client.Single().Query(ctx, spanner.Statement{
SQL: "SELECT Key FROM " + safeTable + " WHERE STARTS_WITH(Key, @prefix)",
Params: map[string]interface{}{
"prefix": prefix,
},
})
defer iter.Stop()
var keys []string
for {
row, err := iter.Next()
if err == iterator.Done {
break
}
if err != nil {
return nil, errwrap.Wrapf("failed to read row: {{err}}", err)
}
var key string
if err := row.Column(0, &key); err != nil {
return nil, errwrap.Wrapf("failed to decode key into string: {{err}}", err)
}
// The results will include the full prefix (folder) and any deeply-nested
// prefixes (subfolders). Vault expects only the top-most things to be
// included.
key = strings.TrimPrefix(key, prefix)
if i := strings.Index(key, "/"); i == -1 {
// Add objects only from the current 'folder'
keys = append(keys, key)
} else {
// Add truncated 'folder' paths
keys = strutil.AppendIfMissing(keys, string(key[:i+1]))
}
}
// Sort because the resulting order is not predictable
sort.Strings(keys)
return keys, nil
}
// Transaction runs multiple entries via a single transaction.
func (b *Backend) Transaction(ctx context.Context, txns []*physical.TxnEntry) error {
defer metrics.MeasureSince(metricTxn, time.Now())
// Quit early if we can
if len(txns) == 0 {
return nil
}
// Build all the ops before taking out the pool
ms := make([]*spanner.Mutation, len(txns))
for i, tx := range txns {
op, key, value := tx.Operation, tx.Entry.Key, tx.Entry.Value
switch op {
case physical.DeleteOperation:
ms[i] = spanner.Delete(b.table, spanner.Key{key})
case physical.PutOperation:
ms[i] = spanner.InsertOrUpdateMap(b.table, map[string]interface{}{
"Key": key,
"Value": value,
})
default:
return fmt.Errorf("unsupported transaction operation: %q", op)
}
}
// Pooling
b.permitPool.Acquire()
defer b.permitPool.Release()
// Transactivate!
if _, err := b.client.Apply(ctx, ms); err != nil {
return errwrap.Wrapf("failed to commit transaction: {{err}}", err)
}
return nil
}
// extractInt is a helper function that takes a string and converts that string
// to an int, but accounts for the empty string.
func extractInt(s string) (int, error) {
if s == "" {
return 0, nil
}
return strconv.Atoi(s)
}
// sanitizeTable attempts to sanitize the table name.
func sanitizeTable(s string) string {
end := strings.IndexRune(s, 0)
if end > -1 {
s = s[:end]
}
return strings.Replace(s, `"`, `""`, -1)
}