-
Notifications
You must be signed in to change notification settings - Fork 231
/
client.go
526 lines (473 loc) · 13.3 KB
/
client.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
// Copyright 2021-present The Atlas Authors. All rights reserved.
// This source code is licensed under the Apache 2.0 license found
// in the LICENSE file in the root directory of this source tree.
package sqlclient
import (
"context"
"database/sql"
"errors"
"fmt"
"io"
"net/url"
"sync"
"ariga.io/atlas/schemahcl"
"ariga.io/atlas/sql/migrate"
"ariga.io/atlas/sql/schema"
)
type (
// Client provides the common functionalities for working with Atlas from different
// applications (e.g. CLI and TF). Note, the Client is dialect specific and should
// be instantiated using a call to Open.
Client struct {
// Name used when creating the client.
Name string
// DB used for creating the client.
DB *sql.DB
// URL holds an enriched url.URL.
URL *URL
// A migration driver for the attached dialect.
migrate.Driver
// Additional closers that can be closed at the
// end of the client lifetime.
closers []io.Closer
// Marshal and Evaluator functions for decoding
// and encoding the schema documents.
schemahcl.Marshaler
schemahcl.Evaluator
// Functions registered by the drivers and used for opening transactions and their clients.
openDriver func(schema.ExecQuerier) (migrate.Driver, error)
openTx TxOpener
hooks []*Hook
}
// TxClient is returned by calling Client.Tx. It behaves the same as Client,
// but wraps all operations within a transaction.
TxClient struct {
*Client
// The transaction this Client wraps.
Tx *Tx
hooks []*Hook
}
// URL extends the standard url.URL with additional
// connection information attached by the Opener (if any).
URL struct {
*url.URL
// The DSN used for opening the connection.
DSN string `json:"-"`
// The Schema this client is connected to.
Schema string
}
// Hook groups all possible hooks in
// connection and transaction lifecycle.
Hook struct {
Conn struct {
AfterOpen func(context.Context, *Client) error
BeforeClose func(*Client) error
}
Tx struct {
AfterBegin func(context.Context, *TxClient) error
BeforeCommit,
BeforeRollback func(*TxClient) error
}
}
)
// Tx returns a transactional client.
func (c *Client) Tx(ctx context.Context, opts *sql.TxOptions) (*TxClient, error) {
if c.openDriver == nil {
return nil, errors.New("sql/sqlclient: unexpected driver opener: <nil>")
}
var tx *Tx
switch {
case c.openTx != nil:
ttx, err := c.openTx(ctx, c.DB, opts)
if err != nil {
return nil, err
}
tx = ttx
default:
ttx, err := c.DB.BeginTx(ctx, opts)
if err != nil {
return nil, fmt.Errorf("sql/sqlclient: starting transaction: %w", err)
}
tx = &Tx{Tx: ttx}
}
drv, err := c.openDriver(tx)
if err != nil {
return nil, fmt.Errorf("sql/sqlclient: opening atlas driver: %w", err)
}
ic := *c
ic.Driver = drv
tc := &TxClient{Client: &ic, Tx: tx, hooks: c.hooks}
if len(tc.hooks) > 0 {
if err := tc.afterBegin(ctx); err != nil {
return nil, errors.Join(err, tx.Rollback())
}
}
return tc, nil
}
// Commit the transaction.
func (c *TxClient) Commit() error {
return errors.Join(c.beforeCommit(), c.Tx.Commit())
}
// Rollback the transaction.
func (c *TxClient) Rollback() error {
return errors.Join(c.beforeRollback(), c.Tx.Rollback())
}
// AddClosers adds list of closers to close at the end of the client lifetime.
func (c *Client) AddClosers(closers ...io.Closer) {
c.closers = append(c.closers, closers...)
}
// Close closes the underlying database connection and the migration
// driver in case it implements the io.Closer interface.
func (c *Client) Close() error {
err := c.beforeClose()
for _, closer := range append(c.closers, c.DB) {
err = errors.Join(err, closer.Close())
}
return err
}
type hookCtxKey struct{}
// hookCtx marks the context as being in a hook.
func hookCtx(ctx context.Context) context.Context {
if ctx.Value(hookCtxKey{}) == nil {
return context.WithValue(ctx, hookCtxKey{}, true)
}
return ctx
}
// afterOpen calls the AfterOpen hooks.
func (c *Client) afterOpen(ctx context.Context) error {
if ctx.Value(hookCtxKey{}) != nil {
return errors.New("sql/sqlclient: cannot open a connection inside a hook")
}
for _, h := range c.hooks {
if f := h.Conn.AfterOpen; f != nil {
if err := f(hookCtx(ctx), c); err != nil {
return err
}
}
}
return nil
}
// beforeClose calls the BeforeClose hooks.
func (c *Client) beforeClose() error {
for _, h := range c.hooks {
if f := h.Conn.BeforeClose; f != nil {
if err := f(c); err != nil {
return err
}
}
}
return nil
}
// afterBegin calls the AfterBegin hooks.
func (c *TxClient) afterBegin(ctx context.Context) error {
if ctx.Value(hookCtxKey{}) != nil {
return errors.New("sql/sqlclient: cannot begin a transaction inside a hook")
}
for _, h := range c.hooks {
if f := h.Tx.AfterBegin; f != nil {
if err := f(hookCtx(ctx), c); err != nil {
return err
}
}
}
return nil
}
// beforeCommit calls the BeforeCommit hooks.
func (c *TxClient) beforeCommit() error {
for _, h := range c.hooks {
if f := h.Tx.BeforeCommit; f != nil {
if err := f(c); err != nil {
return err
}
}
}
return nil
}
// beforeRollback calls the BeforeRollback hooks.
func (c *TxClient) beforeRollback() error {
for _, h := range c.hooks {
if f := h.Tx.BeforeRollback; f != nil {
if err := f(c); err != nil {
return err
}
}
}
return nil
}
type (
// Opener opens a migration driver by the given URL.
Opener interface {
Open(ctx context.Context, u *url.URL) (*Client, error)
}
// OpenerFunc allows using a function as an Opener.
OpenerFunc func(context.Context, *url.URL) (*Client, error)
// URLParser parses an url.URL into an enriched URL and attaches additional info to it.
URLParser interface {
ParseURL(*url.URL) *URL
}
// URLParserFunc allows using a function as an URLParser.
URLParserFunc func(*url.URL) *URL
// SchemaChanger is implemented by a driver if it how to change the connection URL to represent another schema.
SchemaChanger interface {
ChangeSchema(*url.URL, string) *url.URL
}
driver struct {
Opener
name string
parser URLParser
txOpener TxOpener
}
)
// Open calls f(ctx, u).
func (f OpenerFunc) Open(ctx context.Context, u *url.URL) (*Client, error) {
return f(ctx, u)
}
// ParseURL calls f(u).
func (f URLParserFunc) ParseURL(u *url.URL) *URL {
return f(u)
}
// ParseURL is similar to url.Parse but returns errors without
// the raw URL attached to avoid printing userinfo in errors.
func ParseURL(s string) (*url.URL, error) {
u, err := url.Parse(s)
if err != nil {
if err1 := (*url.Error)(nil); errors.As(err, &err1) {
err = err1.Err
}
return nil, err
}
return u, nil
}
var drivers sync.Map
type (
// openOptions holds additional configuration values for opening a Client.
openOptions struct {
schema *string
hooks []*Hook
}
// OpenOption allows to configure a openOptions using functional arguments.
OpenOption func(*openOptions) error
)
// ErrUnsupported is returned if a registered driver does not support changing the schema.
var ErrUnsupported = errors.New("sql/sqlclient: driver does not support changing connected schema")
// Open opens an Atlas client by its provided url string.
func Open(ctx context.Context, s string, opts ...OpenOption) (*Client, error) {
u, err := ParseURL(s)
if err != nil {
return nil, fmt.Errorf("sql/sqlclient: parse open url: %w", err)
}
return OpenURL(ctx, u, opts...)
}
// OpenURL opens an Atlas client by its provided url.URL.
func OpenURL(ctx context.Context, u *url.URL, opts ...OpenOption) (*Client, error) {
cfg := &openOptions{}
for _, opt := range opts {
if err := opt(cfg); err != nil {
return nil, err
}
}
if u.Scheme == "" {
return nil, errors.New("sql/sqlclient: missing driver. See: https://atlasgo.io/url")
}
v, ok := drivers.Load(u.Scheme)
if !ok {
return nil, fmt.Errorf("sql/sqlclient: unknown driver %q. See: https://atlasgo.io/url", u.Scheme)
}
drv := v.(*driver)
// If there is a schema given and the driver allows to change the schema for the url, do it.
if cfg.schema != nil {
sc, ok := drv.parser.(SchemaChanger)
if !ok {
return nil, ErrUnsupported
}
u = sc.ChangeSchema(u, *cfg.schema)
}
client, err := drv.Open(ctx, u)
if err != nil {
return nil, err
}
if client.URL == nil {
client.URL = drv.parser.ParseURL(u)
}
if client.openTx == nil && drv.txOpener != nil {
client.openTx = drv.txOpener
}
if len(cfg.hooks) > 0 {
client.hooks = cfg.hooks
if err := client.afterOpen(ctx); err != nil {
return nil, errors.Join(err, client.DB.Close())
}
}
return client, nil
}
// OpenSchema opens the connection to the given schema.
// If the registered driver does not support this, ErrUnsupported is returned instead.
func OpenSchema(s string) OpenOption {
return func(c *openOptions) error {
c.schema = &s
return nil
}
}
// OpenWithHooks returns an OpenOption that sets
// the hooks for the client after opening.
func OpenWithHooks(hks ...*Hook) OpenOption {
return func(c *openOptions) error {
c.hooks = append(c.hooks, hks...)
return nil
}
}
type (
registerOptions struct {
openDriver func(schema.ExecQuerier) (migrate.Driver, error)
txOpener TxOpener
parser URLParser
flavours []string
codec interface {
schemahcl.Marshaler
schemahcl.Evaluator
}
}
// RegisterOption allows configuring the Opener
// registration using functional options.
RegisterOption func(*registerOptions)
)
// RegisterFlavours allows registering additional flavours
// (i.e. names), accepted by Atlas to open clients.
func RegisterFlavours(flavours ...string) RegisterOption {
return func(opts *registerOptions) {
opts.flavours = flavours
}
}
// RegisterURLParser allows registering a function for parsing
// the url.URL and attach additional info to the extended URL.
func RegisterURLParser(p URLParser) RegisterOption {
return func(opts *registerOptions) {
opts.parser = p
}
}
// RegisterCodec registers static codec for attaching into
// the client after it is opened.
func RegisterCodec(m schemahcl.Marshaler, e schemahcl.Evaluator) RegisterOption {
return func(opts *registerOptions) {
opts.codec = struct {
schemahcl.Marshaler
schemahcl.Evaluator
}{
Marshaler: m,
Evaluator: e,
}
}
}
// RegisterDriverOpener registers a func to create a migrate.Driver from a schema.ExecQuerier.
// Registering this function is implicitly done when using DriverOpener.
// The passed opener is used when creating a TxClient.
func RegisterDriverOpener(open func(schema.ExecQuerier) (migrate.Driver, error)) RegisterOption {
return func(opts *registerOptions) {
opts.openDriver = open
}
}
// DriverOpener is a helper Opener creator for sharing between all drivers.
func DriverOpener(open func(schema.ExecQuerier) (migrate.Driver, error)) Opener {
return OpenerFunc(func(_ context.Context, u *url.URL) (*Client, error) {
v, ok := drivers.Load(u.Scheme)
if !ok {
return nil, fmt.Errorf("sql/sqlclient: unexpected missing opener %q", u.Scheme)
}
drv := v.(*driver)
ur := drv.parser.ParseURL(u)
db, err := sql.Open(drv.name, ur.DSN)
if err != nil {
return nil, err
}
mdr, err := open(db)
if err != nil {
if cerr := db.Close(); cerr != nil {
err = fmt.Errorf("%w: %v", err, cerr)
}
return nil, err
}
return &Client{
Name: drv.name,
DB: db,
URL: ur,
Driver: mdr,
openDriver: open,
openTx: drv.txOpener,
}, nil
})
}
type (
// Tx wraps sql.Tx with optional custom Commit and Rollback functions.
Tx struct {
*sql.Tx
CommitFn func() error // override default commit behavior
RollbackFn func() error // override default rollback behavior
}
// TxOpener opens a transaction with optional closer.
TxOpener func(context.Context, *sql.DB, *sql.TxOptions) (*Tx, error)
)
// Commit the transaction.
func (tx *Tx) Commit() error {
fn := tx.CommitFn
if fn == nil {
fn = tx.Tx.Commit
}
return fn()
}
// Rollback the transaction.
func (tx *Tx) Rollback() error {
fn := tx.RollbackFn
if fn == nil {
fn = tx.Tx.Rollback
}
return fn()
}
// RegisterTxOpener allows registering a custom transaction opener with an optional close function.
func RegisterTxOpener(open TxOpener) RegisterOption {
return func(opts *registerOptions) {
opts.txOpener = open
}
}
// Register registers a client Opener (i.e. creator) with the given name.
func Register(name string, opener Opener, opts ...RegisterOption) {
if opener == nil {
panic("sql/sqlclient: Register opener is nil")
}
opt := ®isterOptions{
// Default URL parser uses the URL as the DSN.
parser: URLParserFunc(func(u *url.URL) *URL { return &URL{URL: u, DSN: u.String()} }),
}
for i := range opts {
opts[i](opt)
}
if opt.codec != nil {
f := opener
opener = OpenerFunc(func(ctx context.Context, u *url.URL) (*Client, error) {
c, err := f.Open(ctx, u)
if err != nil {
return nil, err
}
c.Marshaler, c.Evaluator = opt.codec, opt.codec
return c, nil
})
}
// If there was a driver opener registered by a call to RegisterDriverOpener, it has precedence.
if opt.openDriver != nil {
f := opener
opener = OpenerFunc(func(ctx context.Context, u *url.URL) (*Client, error) {
c, err := f.Open(ctx, u)
if err != nil {
return nil, err
}
c.openDriver = opt.openDriver
return c, err
})
}
drv := &driver{Opener: opener, name: name, parser: opt.parser, txOpener: opt.txOpener}
for _, f := range append(opt.flavours, name) {
if _, ok := drivers.Load(f); ok {
panic("sql/sqlclient: Register called twice for " + f)
}
drivers.Store(f, drv)
}
}