-
-
Notifications
You must be signed in to change notification settings - Fork 500
/
spec.go
602 lines (502 loc) · 15.6 KB
/
spec.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
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
// Copyright 2019 Dolthub, Inc.
//
// 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.
//
// This file incorporates work covered by the following copyright and
// permission notice:
//
// Copyright 2016 Attic Labs, Inc. All rights reserved.
// Licensed under the Apache License, version 2.0:
// http://www.apache.org/licenses/LICENSE-2.0
// Package spec provides builders and parsers for spelling Noms databases,
// datasets and values.
package spec
import (
"context"
"errors"
"fmt"
"net/url"
"os"
"os/user"
"path/filepath"
"strings"
"cloud.google.com/go/storage"
"github.com/aws/aws-sdk-go/aws"
"github.com/aws/aws-sdk-go/aws/credentials"
"github.com/aws/aws-sdk-go/aws/session"
"github.com/aws/aws-sdk-go/service/dynamodb"
"github.com/aws/aws-sdk-go/service/s3"
"github.com/dolthub/dolt/go/libraries/utils/filesys"
"github.com/dolthub/dolt/go/store/chunks"
"github.com/dolthub/dolt/go/store/d"
"github.com/dolthub/dolt/go/store/datas"
"github.com/dolthub/dolt/go/store/nbs"
"github.com/dolthub/dolt/go/store/types"
)
const (
Separator = "::"
DefaultAWSRegion = "us-west-2"
DefaultAWSCredsProfile = "default"
)
type ProtocolImpl interface {
NewChunkStore(sp Spec) (chunks.ChunkStore, error)
}
var ExternalProtocols = map[string]ProtocolImpl{}
type AWSCredentialSource int
const (
InvalidCS AWSCredentialSource = iota - 1
// Auto will try env first and fall back to role (This is the default)
AutoCS
// Role Uses the AWS IAM role of the instance for auth
RoleCS
// Env uses the credentials stored in the environment variables AWS_ACCESS_KEY_ID, and AWS_SECRET_ACCESS_KEY
EnvCS
// Uses credentials stored in a file
FileCS
)
func (ct AWSCredentialSource) String() string {
switch ct {
case RoleCS:
return "role"
case EnvCS:
return "env"
case AutoCS:
return "auto"
case FileCS:
return "file"
default:
return "invalid"
}
}
func AWSCredentialSourceFromStr(str string) AWSCredentialSource {
strlwr := strings.TrimSpace(strings.ToLower(str))
switch strlwr {
case "", "auto":
return AutoCS
case "role":
return RoleCS
case "env":
return EnvCS
case "file":
return FileCS
default:
return InvalidCS
}
}
// SpecOptions customize Spec behavior.
type SpecOptions struct {
// Authorization token for requests. For example, if the database is HTTP
// this will used for an `Authorization: Bearer ${authorization}` header.
Authorization string
// Region that should be used when creating the aws session
AWSRegion string
// The type of credentials that should be used when creating the aws session
AWSCredSource AWSCredentialSource
// Credential file to use when using auto or file credentials
AWSCredFile string
}
func (so *SpecOptions) AwsRegionOrDefault() string {
if so.AWSRegion == "" {
return DefaultAWSRegion
}
return so.AWSRegion
}
func (so *SpecOptions) AwsCredFileOrDefault() string {
if so.AWSCredFile == "" {
usr, err := user.Current()
if err != nil {
return ""
}
return filepath.Join(usr.HomeDir, ".aws", "credentials")
}
return so.AWSCredFile
}
// Spec locates a Noms database, dataset, or value globally. Spec caches
// its database instance so it therefore does not reflect new commits in
// the db, by (legacy) design.
type Spec struct {
// Protocol is one of "mem", "aws", "gs", "nbs"
Protocol string
// DatabaseName is the name of the Spec's database, which is the string after
// "protocol:". specs include their leading "//" characters.
DatabaseName string
// Options are the SpecOptions that the Spec was constructed with.
Options SpecOptions
// Path is nil unless the spec was created with ForPath.
Path AbsolutePath
// db is lazily created, so it needs to be a pointer to a Database.
db *datas.Database
vrw *types.ValueReadWriter
}
func newSpec(dbSpec string, opts SpecOptions) (Spec, error) {
protocol, dbName, err := parseDatabaseSpec(dbSpec)
if err != nil {
return Spec{}, err
}
return Spec{
Protocol: protocol,
DatabaseName: dbName,
Options: opts,
db: new(datas.Database),
vrw: new(types.ValueReadWriter),
}, nil
}
// ForDatabase parses a spec for a Database.
func ForDatabase(spec string) (Spec, error) {
return ForDatabaseOpts(spec, SpecOptions{})
}
// ForDatabaseOpts parses a spec for a Database.
func ForDatabaseOpts(spec string, opts SpecOptions) (Spec, error) {
return newSpec(spec, opts)
}
// ForDataset parses a spec for a Dataset.
func ForDataset(spec string) (Spec, error) {
return ForDatasetOpts(spec, SpecOptions{})
}
// ForDatasetOpts parses a spec for a Dataset.
func ForDatasetOpts(spec string, opts SpecOptions) (Spec, error) {
dbSpec, pathStr, err := splitDatabaseSpec(spec)
if err != nil {
return Spec{}, err
}
sp, err := newSpec(dbSpec, opts)
if err != nil {
return Spec{}, err
}
path, err := NewAbsolutePath(pathStr)
if err != nil {
return Spec{}, err
}
if path.Dataset == "" {
return Spec{}, errors.New("dataset name required for dataset spec")
}
if !path.Path.IsEmpty() {
return Spec{}, errors.New("path is not allowed for dataset spec")
}
sp.Path = path
return sp, nil
}
// ForPath parses a spec for a path to a Value.
func ForPath(spec string) (Spec, error) {
return ForPathOpts(spec, SpecOptions{})
}
// ForPathOpts parses a spec for a path to a Value.
func ForPathOpts(spec string, opts SpecOptions) (Spec, error) {
dbSpec, pathStr, err := splitDatabaseSpec(spec)
if err != nil {
return Spec{}, err
}
var path AbsolutePath
if pathStr != "" {
path, err = NewAbsolutePath(pathStr)
if err != nil {
return Spec{}, err
}
}
sp, err := newSpec(dbSpec, opts)
if err != nil {
return Spec{}, err
}
sp.Path = path
return sp, nil
}
func (sp Spec) String() string {
s := sp.Protocol
if s != "mem" {
s += ":" + sp.DatabaseName
}
p := sp.Path.String()
if p != "" {
s += Separator + p
}
return s
}
// GetDatabase returns the Database instance that this Spec's DatabaseName
// describes. The same Database instance is returned every time, unless Close
// is called. If the Spec is closed, it is re-opened with a new Database.
func (sp Spec) GetDatabase(ctx context.Context) datas.Database {
if *sp.db == nil {
db, vrw := sp.createDatabase(ctx)
*sp.db = db
*sp.vrw = vrw
}
return *sp.db
}
func (sp Spec) GetVRW(ctx context.Context) types.ValueReadWriter {
if *sp.db == nil {
db, vrw := sp.createDatabase(ctx)
*sp.db = db
*sp.vrw = vrw
}
return *sp.vrw
}
// NewChunkStore returns a new ChunkStore instance that this Spec's
// DatabaseName describes. It's unusual to call this method, GetDatabase is
// more useful. Unlike GetDatabase, a new ChunkStore instance is returned every
// time. If there is no ChunkStore, for example remote databases, returns nil.
func (sp Spec) NewChunkStore(ctx context.Context) chunks.ChunkStore {
switch sp.Protocol {
case "http", "https":
return nil
case "aws":
return parseAWSSpec(ctx, sp.Href(), sp.Options)
case "gs":
return parseGCSSpec(ctx, sp.Href(), sp.Options)
case "nbs":
cs, err := nbs.NewLocalStore(ctx, types.Format_Default.VersionString(), sp.DatabaseName, 1<<28, nbs.NewUnlimitedMemQuotaProvider())
d.PanicIfError(err)
return cs
case "mem":
storage := &chunks.MemoryStorage{}
return storage.NewView()
default:
impl, ok := ExternalProtocols[sp.Protocol]
if !ok {
d.PanicIfError(fmt.Errorf("unknown protocol: %s", sp.Protocol))
}
r, err := impl.NewChunkStore(sp)
d.PanicIfError(err)
return r
}
}
func parseAWSSpec(ctx context.Context, awsURL string, options SpecOptions) chunks.ChunkStore {
fmt.Println(awsURL, options)
u, _ := url.Parse(awsURL)
parts := strings.SplitN(u.Hostname(), ":", 2) // [table] [, bucket]?
d.PanicIfFalse(len(parts) == 2)
awsConfig := aws.NewConfig().WithRegion(options.AwsRegionOrDefault())
switch options.AWSCredSource {
case RoleCS:
case EnvCS:
awsConfig = awsConfig.WithCredentials(credentials.NewEnvCredentials())
case FileCS:
filePath := options.AwsCredFileOrDefault()
creds := credentials.NewSharedCredentials(filePath, DefaultAWSCredsProfile)
awsConfig = awsConfig.WithCredentials(creds)
case AutoCS:
envCreds := credentials.NewEnvCredentials()
if _, err := envCreds.Get(); err == nil {
awsConfig = awsConfig.WithCredentials(envCreds)
}
filePath := options.AwsCredFileOrDefault()
if _, err := os.Stat(filePath); err == nil {
creds := credentials.NewSharedCredentials(filePath, DefaultAWSCredsProfile)
awsConfig = awsConfig.WithCredentials(creds)
}
default:
panic("unsupported credential type")
}
sess := session.Must(session.NewSession(awsConfig))
cs, err := nbs.NewAWSStore(ctx, types.Format_Default.VersionString(), parts[0], u.Path, parts[1], s3.New(sess), dynamodb.New(sess), 1<<28, nbs.NewUnlimitedMemQuotaProvider())
d.PanicIfError(err)
return cs
}
func parseGCSSpec(ctx context.Context, gcsURL string, options SpecOptions) chunks.ChunkStore {
u, err := url.Parse(gcsURL)
d.PanicIfError(err)
fmt.Println(u)
bucket := u.Host
path := u.Path
gcs, err := storage.NewClient(ctx)
if err != nil {
panic("Could not create GCSBlobstore")
}
cs, err := nbs.NewGCSStore(ctx, types.Format_Default.VersionString(), bucket, path, gcs, 1<<28, nbs.NewUnlimitedMemQuotaProvider())
d.PanicIfError(err)
return cs
}
// GetDataset returns the current Dataset instance for this Spec's Database.
// GetDataset is live, so if Commit is called on this Spec's Database later, a
// new up-to-date Dataset will returned on the next call to GetDataset. If
// this is not a Dataset spec, returns nil.
func (sp Spec) GetDataset(ctx context.Context) (ds datas.Dataset) {
if sp.Path.Dataset != "" {
var err error
ds, err = sp.GetDatabase(ctx).GetDataset(ctx, sp.Path.Dataset)
d.PanicIfError(err)
}
return
}
// GetValue returns the Value at this Spec's Path within its Database, or nil
// if this isn't a Path Spec or if that path isn't found.
func (sp Spec) GetValue(ctx context.Context) (val types.Value, err error) {
if !sp.Path.IsEmpty() {
val, err = sp.Path.Resolve(ctx, sp.GetDatabase(ctx), sp.GetVRW(ctx))
if err != nil {
return nil, err
}
}
return
}
// Href treats the Protocol and DatabaseName as a URL, and returns its href.
// For example, the spec http://example.com/path::ds returns
// "http://example.com/path". If the Protocol is not "http" or "http", returns
// an empty string.
func (sp Spec) Href() string {
switch proto := sp.Protocol; proto {
case "http", "https", "aws", "gs":
return proto + ":" + sp.DatabaseName
default:
return ""
}
}
// Pin returns a Spec in which the dataset component, if any, has been replaced
// with the hash of the HEAD of that dataset. This "pins" the path to the state
// of the database at the current moment in time. Returns itself if the
// PathSpec is already "pinned".
func (sp Spec) Pin(ctx context.Context) (Spec, bool) {
var ds datas.Dataset
if !sp.Path.IsEmpty() {
if !sp.Path.Hash.IsEmpty() {
// Spec is already pinned.
return sp, true
}
var err error
ds, err = sp.GetDatabase(ctx).GetDataset(ctx, sp.Path.Dataset)
d.PanicIfError(err)
} else {
ds = sp.GetDataset(ctx)
}
commit, ok := ds.MaybeHead()
if !ok {
return Spec{}, false
}
nbf := sp.GetVRW(ctx).Format()
r := sp
var err error
r.Path.Dataset = ""
r.Path.Hash, err = commit.Hash(nbf)
d.PanicIfError(err)
return r, true
}
func (sp Spec) Close() error {
db := *sp.db
if db == nil {
return nil
}
*sp.db = nil
return db.Close()
}
func (sp Spec) createDatabase(ctx context.Context) (datas.Database, types.ValueReadWriter) {
switch sp.Protocol {
case "aws":
cs := parseAWSSpec(ctx, sp.Href(), sp.Options)
vrw := types.NewValueStore(cs)
return datas.NewTypesDatabase(vrw), vrw
case "gs":
cs := parseGCSSpec(ctx, sp.Href(), sp.Options)
vrw := types.NewValueStore(cs)
return datas.NewTypesDatabase(vrw), vrw
case "nbs":
// If the database is the oldgen database return a standard NBS store.
if strings.Contains(sp.DatabaseName, "oldgen") {
return getStandardLocalStore(ctx, sp.DatabaseName)
}
oldgenDb := filepath.Join(sp.DatabaseName, "oldgen")
err := validateDir(oldgenDb)
// If we can't validate that an oldgen db exists just use a standard local store.
if err != nil {
return getStandardLocalStore(ctx, sp.DatabaseName)
}
newGenSt, err := nbs.NewLocalStore(ctx, types.Format_Default.VersionString(), sp.DatabaseName, 1<<28, nbs.NewUnlimitedMemQuotaProvider())
d.PanicIfError(err)
oldGenSt, err := nbs.NewLocalStore(ctx, newGenSt.Version(), oldgenDb, 1<<28, nbs.NewUnlimitedMemQuotaProvider())
d.PanicIfError(err)
cs := nbs.NewGenerationalCS(oldGenSt, newGenSt)
vrw := types.NewValueStore(cs)
return datas.NewTypesDatabase(vrw), vrw
case "mem":
storage := &chunks.MemoryStorage{}
cs := storage.NewViewWithDefaultFormat()
vrw := types.NewValueStore(cs)
return datas.NewTypesDatabase(vrw), vrw
default:
impl, ok := ExternalProtocols[sp.Protocol]
if !ok {
d.PanicIfError(fmt.Errorf("unknown protocol: %s", sp.Protocol))
}
cs, err := impl.NewChunkStore(sp)
d.PanicIfError(err)
vrw := types.NewValueStore(cs)
return datas.NewTypesDatabase(vrw), vrw
}
}
func getStandardLocalStore(ctx context.Context, dbName string) (datas.Database, types.ValueReadWriter) {
os.Mkdir(dbName, 0777)
cs, err := nbs.NewLocalStore(ctx, types.Format_Default.VersionString(), dbName, 1<<28, nbs.NewUnlimitedMemQuotaProvider())
d.PanicIfError(err)
vrw := types.NewValueStore(cs)
return datas.NewTypesDatabase(vrw), vrw
}
func validateDir(path string) error {
info, err := os.Stat(path)
if err != nil {
return err
} else if !info.IsDir() {
return filesys.ErrIsFile
}
return nil
}
func parseDatabaseSpec(spec string) (protocol, name string, err error) {
if len(spec) == 0 {
err = fmt.Errorf("empty spec")
return
}
parts := strings.SplitN(spec, ":", 2) // [protocol] [, path]?
// If there was no ":" then this is either a mem spec, or a filesystem path.
// This is ambiguous if the file system path is "mem" but that just means the
// path needs to be explicitly "nbs:mem".
if len(parts) == 1 {
if spec == "mem" {
protocol = "mem"
} else {
protocol, name = "nbs", spec
}
return
} else if len(parts) == 2 && len(parts[0]) == 1 && parts[0][0] >= 'A' && parts[0][0] <= 'Z' { //check for Windows drive letter, ala C:\Users\Public
if _, err := os.Stat(parts[0] + `:\`); !os.IsNotExist(err) {
parts = []string{"nbs", spec}
}
}
if _, ok := ExternalProtocols[parts[0]]; ok {
protocol, name = parts[0], parts[1]
return
}
switch parts[0] {
case "nbs":
protocol, name = parts[0], parts[1]
case "aws", "gs":
u, perr := url.Parse(spec)
if perr != nil {
err = perr
} else if u.Host == "" {
err = fmt.Errorf("%s has empty host", spec)
} else if parts[0] == "aws" && u.Path == "" {
err = fmt.Errorf("%s does not specify a database ID", spec)
} else {
protocol, name = parts[0], parts[1]
}
case "mem":
err = fmt.Errorf(`in-memory database must be specified as "mem", not "mem:"`)
default:
err = fmt.Errorf("invalid database protocol %s in %s", protocol, spec)
}
return
}
func splitDatabaseSpec(spec string) (string, string, error) {
lastIdx := strings.LastIndex(spec, Separator)
if lastIdx == -1 {
return "", "", fmt.Errorf("missing %s after database in %s", Separator, spec)
}
return spec[:lastIdx], spec[lastIdx+len(Separator):], nil
}