-
Notifications
You must be signed in to change notification settings - Fork 3.8k
/
conn_executor_test.go
1539 lines (1337 loc) · 50.5 KB
/
conn_executor_test.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
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// Copyright 2016 The Cockroach Authors.
//
// Use of this software is governed by the Business Source License
// included in the file licenses/BSL.txt.
//
// As of the Change Date specified in that file, in accordance with
// the Business Source License, use of this software will be governed
// by the Apache License, Version 2.0, included in the file
// licenses/APL.txt.
package sql_test
import (
"context"
gosql "database/sql"
"database/sql/driver"
"fmt"
"net/url"
"regexp"
"strings"
"sync/atomic"
"testing"
"time"
"github.com/cockroachdb/cockroach-go/v2/crdb"
"github.com/cockroachdb/cockroach/pkg/base"
"github.com/cockroachdb/cockroach/pkg/keys"
"github.com/cockroachdb/cockroach/pkg/kv"
"github.com/cockroachdb/cockroach/pkg/kv/kvserver"
"github.com/cockroachdb/cockroach/pkg/kv/kvserver/kvserverbase"
"github.com/cockroachdb/cockroach/pkg/roachpb"
"github.com/cockroachdb/cockroach/pkg/security"
"github.com/cockroachdb/cockroach/pkg/settings/cluster"
"github.com/cockroachdb/cockroach/pkg/sql"
"github.com/cockroachdb/cockroach/pkg/sql/catalog/descpb"
"github.com/cockroachdb/cockroach/pkg/sql/execinfra"
"github.com/cockroachdb/cockroach/pkg/sql/mutations"
"github.com/cockroachdb/cockroach/pkg/sql/parser"
"github.com/cockroachdb/cockroach/pkg/sql/pgwire/pgcode"
"github.com/cockroachdb/cockroach/pkg/sql/rowexec"
"github.com/cockroachdb/cockroach/pkg/sql/sem/tree"
"github.com/cockroachdb/cockroach/pkg/sql/sqlliveness"
"github.com/cockroachdb/cockroach/pkg/sql/tests"
"github.com/cockroachdb/cockroach/pkg/testutils"
"github.com/cockroachdb/cockroach/pkg/testutils/pgtest"
"github.com/cockroachdb/cockroach/pkg/testutils/serverutils"
"github.com/cockroachdb/cockroach/pkg/testutils/sqlutils"
"github.com/cockroachdb/cockroach/pkg/util/ctxgroup"
"github.com/cockroachdb/cockroach/pkg/util/duration"
"github.com/cockroachdb/cockroach/pkg/util/hlc"
"github.com/cockroachdb/cockroach/pkg/util/leaktest"
"github.com/cockroachdb/cockroach/pkg/util/log"
"github.com/cockroachdb/cockroach/pkg/util/syncutil"
"github.com/cockroachdb/cockroach/pkg/util/timeutil"
"github.com/cockroachdb/datadriven"
"github.com/cockroachdb/errors"
"github.com/cockroachdb/logtags"
"github.com/cockroachdb/redact"
"github.com/jackc/pgconn"
"github.com/jackc/pgx/v4"
"github.com/lib/pq"
"github.com/pmezard/go-difflib/difflib"
"github.com/stretchr/testify/require"
)
func TestAnonymizeStatementsForReporting(t *testing.T) {
defer leaktest.AfterTest(t)()
defer log.Scope(t).Close(t)
s := cluster.MakeTestingClusterSettings()
vt, err := sql.NewVirtualSchemaHolder(context.Background(), s)
if err != nil {
t.Fatal(err)
}
const stmt1s = `
INSERT INTO sensitive(super, sensible) VALUES('that', 'nobody', 'must', 'see')
`
stmt1, err := parser.ParseOne(stmt1s)
if err != nil {
t.Fatal(err)
}
rUnsafe := errors.New("some error")
safeErr := sql.WithAnonymizedStatement(rUnsafe, stmt1.AST, vt)
const expMessage = "some error"
actMessage := safeErr.Error()
if actMessage != expMessage {
t.Errorf("wanted: %s\ngot: %s", expMessage, actMessage)
}
const expSafeRedactedMessage = `some error
(1) while executing: INSERT INTO _(_, _) VALUES ('_', '_', __more2__)
Wraps: (2) attached stack trace
-- stack trace:
| github.com/cockroachdb/cockroach/pkg/sql_test.TestAnonymizeStatementsForReporting
| ...conn_executor_test.go:NN
| testing.tRunner
| ...testing.go:NN
| runtime.goexit
| ...asm_scrubbed.s:NN
Wraps: (3) some error
Error types: (1) *safedetails.withSafeDetails (2) *withstack.withStack (3) *errutil.leafError`
// Edit non-determinstic stack trace filenames from the message.
actSafeRedactedMessage := strings.ReplaceAll(strings.ReplaceAll(fileref.ReplaceAllString(
redact.Sprintf("%+v", safeErr).Redact().StripMarkers(), "...$2:NN"),
"asm_arm64", "asm_scrubbed"),
"asm_amd64", "asm_scrubbed")
if actSafeRedactedMessage != expSafeRedactedMessage {
diff, _ := difflib.GetUnifiedDiffString(difflib.UnifiedDiff{
A: difflib.SplitLines(expSafeRedactedMessage),
B: difflib.SplitLines(actSafeRedactedMessage),
FromFile: "Expected",
FromDate: "",
ToFile: "Actual",
ToDate: "",
Context: 1,
})
t.Errorf("Diff:\n%s", diff)
}
}
var fileref = regexp.MustCompile(`((?:[a-zA-Z0-9\._@-]*/)*)([a-zA-Z0-9._@-]*\.(?:go|s)):\d+`)
// Test that a connection closed abruptly while a SQL txn is in progress results
// in that txn being rolled back.
//
// TODO(andrei): This test terminates a client connection by calling Close() on
// a driver.Conn(), which sends a MsgTerminate. We should also have a test that
// closes the connection more abruptly than that.
func TestSessionFinishRollsBackTxn(t *testing.T) {
defer leaktest.AfterTest(t)()
defer log.Scope(t).Close(t)
aborter := NewTxnAborter()
defer aborter.Close(t)
params, _ := tests.CreateTestServerParams()
params.Knobs.SQLExecutor = aborter.executorKnobs()
s, mainDB, _ := serverutils.StartServer(t, params)
defer s.Stopper().Stop(context.Background())
{
pgURL, cleanup := sqlutils.PGUrl(
t, s.ServingSQLAddr(), "TestSessionFinishRollsBackTxn", url.User(security.RootUser))
defer cleanup()
if err := aborter.Init(pgURL); err != nil {
t.Fatal(err)
}
}
if _, err := mainDB.Exec(`
CREATE DATABASE t;
CREATE TABLE t.test (k INT PRIMARY KEY, v TEXT);
`); err != nil {
t.Fatal(err)
}
// We're going to test the rollback of transactions left in various states
// when the connection closes abruptly.
// For the state CommitWait, there's no actual rollback we can test for (since
// the kv-level transaction has already been committed). But we still
// exercise this state to check that the server doesn't crash (which used to
// happen - #9879).
tests := []string{"Open", "Aborted", "CommitWait"}
for _, state := range tests {
t.Run(state, func(t *testing.T) {
// Create a low-level lib/pq connection so we can close it at will.
pgURL, cleanupDB := sqlutils.PGUrl(
t, s.ServingSQLAddr(), state, url.User(security.RootUser))
defer cleanupDB()
c, err := pq.Open(pgURL.String())
if err != nil {
t.Fatal(err)
}
connClosed := false
defer func() {
if connClosed {
return
}
if err := c.Close(); err != nil {
t.Fatal(err)
}
}()
ctx := context.Background()
conn := c.(driver.ConnBeginTx)
txn, err := conn.BeginTx(ctx, driver.TxOptions{})
if err != nil {
t.Fatal(err)
}
tx := txn.(driver.ExecerContext)
if _, err := tx.ExecContext(ctx, "SET TRANSACTION PRIORITY NORMAL", nil); err != nil {
t.Fatal(err)
}
if state == "CommitWait" {
if _, err := tx.ExecContext(ctx, "SAVEPOINT cockroach_restart", nil); err != nil {
t.Fatal(err)
}
}
insertStmt := "INSERT INTO t.public.test(k, v) VALUES (1, 'a')"
if state == "RestartWait" {
// To get a txn in RestartWait, we'll use an aborter.
if err := aborter.QueueStmtForAbortion(
insertStmt, 1 /* restartCount */, false /* willBeRetriedIbid */); err != nil {
t.Fatal(err)
}
}
if _, err := tx.ExecContext(ctx, insertStmt, nil); err != nil {
t.Fatal(err)
}
if err := aborter.VerifyAndClear(); err != nil {
t.Fatal(err)
}
if state == "CommitWait" {
_, err := tx.ExecContext(ctx, "RELEASE SAVEPOINT cockroach_restart", nil)
if state == "CommitWait" {
if err != nil {
t.Fatal(err)
}
} else if !testutils.IsError(err, "pq: restart transaction:.*") {
t.Fatal(err)
}
}
// Abruptly close the connection.
connClosed = true
if err := c.Close(); err != nil {
t.Fatal(err)
}
// Check that the txn we had above was rolled back. We do this by reading
// after the preceding txn and checking that we don't get an error and
// that we haven't been blocked by intents (we can't exactly test that we
// haven't been blocked but we assert that the query didn't take too
// long).
// We do the read in an explicit txn so that automatic retries don't hide
// any errors.
// TODO(andrei): Figure out a better way to test for non-blocking.
// Use a trace when the client-side tracing story gets good enough.
// There's a bit of difficulty because the cleanup is async.
txCheck, err := mainDB.Begin()
if err != nil {
t.Fatal(err)
}
// Run check at low priority so we don't push the previous transaction and
// fool ourselves into thinking it had been rolled back.
if _, err := txCheck.Exec("SET TRANSACTION PRIORITY LOW"); err != nil {
t.Fatal(err)
}
ts := timeutil.Now()
var count int
if err := txCheck.QueryRow("SELECT count(1) FROM t.test").Scan(&count); err != nil {
t.Fatal(err)
}
// CommitWait actually committed, so we'll need to clean up.
if state != "CommitWait" {
if count != 0 {
t.Fatalf("expected no rows, got: %d", count)
}
} else {
if _, err := txCheck.Exec("DELETE FROM t.test"); err != nil {
t.Fatal(err)
}
}
if err := txCheck.Commit(); err != nil {
t.Fatal(err)
}
if d := timeutil.Since(ts); d > time.Second {
t.Fatalf("Looks like the checking tx was unexpectedly blocked. "+
"It took %s to commit.", d)
}
})
}
}
// Test two things about non-retriable errors happening when the Executor does
// an "autoCommit" (i.e. commits the KV txn after running an implicit
// transaction):
// 1) The error is reported to the client.
// 2) The error doesn't leave the session in the Aborted state. After running
// implicit transactions, the state should always be NoTxn, regardless of any
// errors.
func TestNonRetriableErrorOnAutoCommit(t *testing.T) {
defer leaktest.AfterTest(t)()
defer log.Scope(t).Close(t)
query := "SELECT 42"
params := base.TestServerArgs{
Knobs: base.TestingKnobs{
SQLExecutor: &sql.ExecutorTestingKnobs{
BeforeAutoCommit: func(ctx context.Context, stmt string) error {
if strings.Contains(stmt, query) {
return fmt.Errorf("injected autocommit error")
}
return nil
},
},
},
}
s, sqlDB, _ := serverutils.StartServer(t, params)
defer s.Stopper().Stop(context.Background())
sqlDB.SetMaxOpenConns(1)
if _, err := sqlDB.Exec(query); !testutils.IsError(err, "injected") {
t.Fatalf("expected injected error, got: %v", err)
}
var state string
if err := sqlDB.QueryRow("SHOW TRANSACTION STATUS").Scan(&state); err != nil {
t.Fatal(err)
}
if state != "NoTxn" {
t.Fatalf("expected state %s, got: %s", "NoTxn", state)
}
}
// Test that, if a ROLLBACK statement encounters an error, the error is not
// returned to the client and the session state is transitioned to NoTxn.
func TestErrorOnRollback(t *testing.T) {
defer leaktest.AfterTest(t)()
defer log.Scope(t).Close(t)
// We can't get the tableID programmatically here.
// The table id can be retrieved by doing.
// CREATE DATABASE test;
// CREATE TABLE test.t();
// SELECT id FROM system.namespace WHERE name = 't' AND "parentID" != 1
const targetKeyStringFmt string = "/Table/%d/1/1/0"
var targetKeyString atomic.Value
targetKeyString.Store("")
var injectedErr int64
// We're going to inject an error into our EndTxn.
params := base.TestServerArgs{
Knobs: base.TestingKnobs{
Store: &kvserver.StoreTestingKnobs{
TestingProposalFilter: func(fArgs kvserverbase.ProposalFilterArgs) *roachpb.Error {
if !fArgs.Req.IsSingleRequest() {
return nil
}
req := fArgs.Req.Requests[0]
etReq, ok := req.GetInner().(*roachpb.EndTxnRequest)
// We only inject the error once. Turns out that during the
// life of the test there's two EndTxns being sent - one is
// the direct result of the test's call to tx.Rollback(),
// the second is sent by the TxnCoordSender - indirectly
// triggered by the fact that, on the server side, the
// transaction's context gets canceled at the SQL layer.
if ok &&
etReq.Header().Key.String() == targetKeyString.Load().(string) &&
atomic.LoadInt64(&injectedErr) == 0 {
atomic.StoreInt64(&injectedErr, 1)
return roachpb.NewErrorf("test injected error")
}
return nil
},
},
},
}
s, sqlDB, _ := serverutils.StartServer(t, params)
ctx := context.Background()
defer s.Stopper().Stop(ctx)
tdb := sqlutils.MakeSQLRunner(sqlDB)
tdb.Exec(t, `
CREATE DATABASE t;
CREATE TABLE t.test (k INT PRIMARY KEY, v TEXT);
`)
tableID := sqlutils.QueryTableID(t, sqlDB, "t", "public", "test")
targetKeyString.Store(fmt.Sprintf(targetKeyStringFmt, tableID))
tx, err := sqlDB.Begin()
if err != nil {
t.Fatal(err)
}
// Perform a write so that the EndTxn we're going to send doesn't get elided.
if _, err := tx.ExecContext(ctx, "INSERT INTO t.test(k, v) VALUES (1, 'abc')"); err != nil {
t.Fatal(err)
}
if err := tx.Rollback(); err != nil {
t.Fatal(err)
}
var state string
if err := sqlDB.QueryRow("SHOW TRANSACTION STATUS").Scan(&state); err != nil {
t.Fatal(err)
}
if state != "NoTxn" {
t.Fatalf("expected state %s, got: %s", "NoTxn", state)
}
if atomic.LoadInt64(&injectedErr) == 0 {
t.Fatal("test didn't inject the error; it must have failed to find " +
"the EndTxn with the expected key")
}
}
func TestHalloweenProblemAvoidance(t *testing.T) {
defer leaktest.AfterTest(t)()
defer log.Scope(t).Close(t)
// Populate a sufficiently large number of rows. We want at least as
// many rows as an insert can batch in its output buffer (to force a
// buffer flush), plus as many rows as a fetcher can fetch at once
// (to force a read buffer update), plus some more.
//
// Instead of customizing the working set size of the test up to the
// default settings for the SQL package, we scale down the config
// of the SQL package to the test. The reason for this is that
// race-enable builds are very slow and the default batch sizes
// would cause the test duration to exceed the timeout.
//
// We are also careful to override these defaults before starting
// the server, so as to not risk updating them concurrently with
// some background SQL activity.
const smallerKvBatchSize = 5 // This is an approximation based on the TableReaderBatchBytesLimit below.
const smallerInsertBatchSize = 5
mutations.SetMaxBatchSizeForTests(smallerInsertBatchSize)
defer mutations.ResetMaxBatchSizeForTests()
numRows := smallerKvBatchSize + smallerInsertBatchSize + 10
params, _ := tests.CreateTestServerParams()
params.Insecure = true
params.Knobs.DistSQL = &execinfra.TestingKnobs{
TableReaderBatchBytesLimit: 10,
}
s, db, _ := serverutils.StartServer(t, params)
defer s.Stopper().Stop(context.Background())
if _, err := db.Exec(`
CREATE DATABASE t;
CREATE TABLE t.test (x FLOAT);
`); err != nil {
t.Fatal(err)
}
if _, err := db.Exec(
`INSERT INTO t.test(x) SELECT generate_series(1, $1)::FLOAT`,
numRows); err != nil {
t.Fatal(err)
}
// Now slightly modify the values in duplicate rows.
// We choose a float +0.1 to ensure that none of the derived
// values become duplicate of already-present values.
if _, err := db.Exec(`
INSERT INTO t.test(x)
-- the if ensures that no row is processed two times.
SELECT IF(x::INT::FLOAT = x,
x,
crdb_internal.force_error(
'NOOPE', 'insert saw its own writes: ' || x::STRING || ' (it is halloween today)')::FLOAT)
+ 0.1
FROM t.test
`); err != nil {
t.Fatal(err)
}
// Finally verify that no rows has been operated on more than once.
row := db.QueryRow(`SELECT count(DISTINCT x) FROM t.test`)
var cnt int
if err := row.Scan(&cnt); err != nil {
t.Fatal(err)
}
if cnt != 2*numRows {
t.Fatalf("expected %d rows in final table, got %d", 2*numRows, cnt)
}
}
func TestAppNameStatisticsInitialization(t *testing.T) {
defer leaktest.AfterTest(t)()
defer log.Scope(t).Close(t)
params, _ := tests.CreateTestServerParams()
params.Insecure = true
s, _, _ := serverutils.StartServer(t, params)
defer s.Stopper().Stop(context.Background())
// Prepare a session with a custom application name.
pgURL := url.URL{
Scheme: "postgres",
User: url.User(security.RootUser),
Host: s.ServingSQLAddr(),
RawQuery: "sslmode=disable&application_name=mytest",
}
rawSQL, err := gosql.Open("postgres", pgURL.String())
if err != nil {
t.Fatal(err)
}
defer rawSQL.Close()
sqlDB := sqlutils.MakeSQLRunner(rawSQL)
// Issue a query to be registered in stats.
sqlDB.Exec(t, "SELECT version()")
// Verify the query shows up in stats.
rows := sqlDB.Query(t, "SELECT application_name, key FROM crdb_internal.node_statement_statistics")
defer rows.Close()
counts := map[string]int{}
for rows.Next() {
var appName, key string
if err := rows.Scan(&appName, &key); err != nil {
t.Fatal(err)
}
counts[appName+":"+key]++
}
if counts["mytest:SELECT version()"] == 0 {
t.Fatalf("query was not counted properly: %+v", counts)
}
}
func TestQueryProgress(t *testing.T) {
defer leaktest.AfterTest(t)()
defer log.Scope(t).Close(t)
const rows = 1000
defer rowexec.TestingSetScannedRowProgressFrequency(rows / 60)()
// We'll do more than 6 scans because we set a low TableReaderBatchBytesLimit
// below.
const stallAfterScans = 6
var queryRunningAtomic, scannedBatchesAtomic int64
stalled, unblock := make(chan struct{}), make(chan struct{})
// We'll populate the key for the knob after we create the table.
var tableKey atomic.Value
tableKey.Store(roachpb.Key(""))
getTableKey := func() roachpb.Key { return tableKey.Load().(roachpb.Key) }
spanFromKey := func(k roachpb.Key) roachpb.Span {
return roachpb.Span{Key: k, EndKey: k.PrefixEnd()}
}
getTableSpan := func() roachpb.Span { return spanFromKey(getTableKey()) }
// Install a store filter which, if queryRunningAtomic is 1, will count scan
// requests issued to the test table and then, on the `stallAfterScans` one,
// will stall the scan and in turn the query, so the test has a chance to
// inspect the query progress. The filter signals the test that it has reached
// the stall-point by closing the `stalled` ch and then waits for the test to
// run its check(s) by receiving on the `unblock` channel (which the test can
// then close once it has checked the progress).
params := base.TestServerArgs{
Knobs: base.TestingKnobs{
DistSQL: &execinfra.TestingKnobs{
// A low limit, to force many small scans such that we get progress
// reports.
TableReaderBatchBytesLimit: 1500,
},
Store: &kvserver.StoreTestingKnobs{
TestingRequestFilter: func(_ context.Context, req roachpb.BatchRequest) *roachpb.Error {
if req.IsSingleRequest() {
scan, ok := req.Requests[0].GetInner().(*roachpb.ScanRequest)
if ok && getTableSpan().ContainsKey(scan.Key) && atomic.LoadInt64(&queryRunningAtomic) == 1 {
i := atomic.AddInt64(&scannedBatchesAtomic, 1)
if i == stallAfterScans {
close(stalled)
t.Logf("stalling on scan %d at %s and waiting for test to unblock...", i, scan.Key)
<-unblock
}
}
}
return nil
},
},
},
}
s, rawDB, _ := serverutils.StartServer(t, params)
defer s.Stopper().Stop(context.Background())
db := sqlutils.MakeSQLRunner(rawDB)
// TODO(yuzefovich): the vectorized cfetcher doesn't emit metadata about
// the progress nor do we have an infrastructure to emit such metadata at
// the runtime (we can only propagate the metadata during the draining of
// the flow which defeats the purpose of the progress meta), so we use the
// old row-by-row engine in this test. We should fix that (#55758).
db.Exec(t, `SET vectorize=off`)
db.Exec(t, `SET CLUSTER SETTING sql.stats.automatic_collection.enabled = false`)
db.Exec(t, `CREATE DATABASE t; CREATE TABLE t.test (x INT PRIMARY KEY);`)
db.Exec(t, `INSERT INTO t.test SELECT generate_series(1, $1)::INT`, rows)
db.Exec(t, `CREATE STATISTICS __auto__ FROM t.test`)
const query = `SELECT count(*) FROM t.test WHERE x > $1 and x % 2 = 0`
// Invalidate the stats cache so that we can be sure to get the latest stats.
var tableID descpb.ID
ctx := context.Background()
require.NoError(t, rawDB.QueryRow(`SELECT id FROM system.namespace WHERE name = 'test'`).Scan(&tableID))
execCfg := s.ExecutorConfig().(sql.ExecutorConfig)
execCfg.TableStatsCache.InvalidateTableStats(ctx, tableID)
tableKey.Store(execCfg.Codec.TablePrefix(uint32(tableID)))
ctx, cancel := context.WithCancel(ctx)
defer cancel()
g := ctxgroup.WithContext(ctx)
g.GoCtx(func(ctx context.Context) error {
// Ensure that after query execution, we've actually hit and closed the
// stalled ch as expected.
defer func() {
select {
case <-stalled: //stalled was closed as expected.
default:
panic("expected stalled to have been closed during execution")
}
}()
atomic.StoreInt64(&queryRunningAtomic, 1)
_, err := rawDB.ExecContext(ctx, query, rows/2)
return err
})
t.Log("waiting for query to make progress...")
<-stalled
t.Log("query is now stalled. checking progress...")
var progress string
err := rawDB.QueryRow(`SELECT phase FROM [SHOW QUERIES] WHERE query LIKE 'SELECT count(*) FROM t.test%'`).Scan(&progress)
// Unblock the KV requests first, regardless of what we found in the progress.
close(unblock)
require.NoError(t, g.Wait())
if err != nil {
t.Fatal(err)
}
require.Regexp(t, `executing \(..\...%\)`, progress)
}
// This test ensures that when in an explicit transaction, statement preparation
// uses the user's transaction and thus properly interacts with deadlock
// detection.
func TestPrepareInExplicitTransactionDoesNotDeadlock(t *testing.T) {
defer leaktest.AfterTest(t)()
defer log.Scope(t).Close(t)
s, sqlDB, _ := serverutils.StartServer(t, base.TestServerArgs{})
defer s.Stopper().Stop(context.Background())
testDB := sqlutils.MakeSQLRunner(sqlDB)
testDB.Exec(t, "CREATE TABLE foo (i INT PRIMARY KEY)")
testDB.Exec(t, "CREATE TABLE bar (i INT PRIMARY KEY)")
tx1, err := sqlDB.Begin()
require.NoError(t, err)
tx2, err := sqlDB.Begin()
require.NoError(t, err)
// So now I really want to try to have a deadlock.
_, err = tx1.Exec("ALTER TABLE foo ADD COLUMN j INT NOT NULL")
require.NoError(t, err)
_, err = tx2.Exec("ALTER TABLE bar ADD COLUMN j INT NOT NULL")
require.NoError(t, err)
// Now we want tx2 to get blocked on tx1 and stay blocked, then we want to
// push tx1 above tx2 and have it get blocked in planning.
errCh := make(chan error)
go func() {
_, err := tx2.Exec("ALTER TABLE foo ADD COLUMN k INT NOT NULL")
errCh <- err
}()
select {
case <-time.After(time.Millisecond):
case err := <-errCh:
t.Fatalf("expected the transaction to block, got %v", err)
default:
}
// Read from foo so that we can push tx1 above tx2.
testDB.Exec(t, "SELECT count(*) FROM foo")
// Write into foo to push tx1
_, err = tx1.Exec("INSERT INTO foo VALUES (1)")
require.NoError(t, err)
// Plan a query which will resolve bar during planning time, this would block
// and deadlock if it were run on a new transaction.
_, err = tx1.Prepare("SELECT NULL FROM [SHOW COLUMNS FROM bar] LIMIT 1")
require.NoError(t, err)
// Try to commit tx1. Either it should get a RETRY_SERIALIZABLE error or
// tx2 should. Ensure that either one or both of them does.
if tx1Err := tx1.Commit(); tx1Err == nil {
// tx1 committed successfully, ensure tx2 failed.
tx2ExecErr := <-errCh
require.Regexp(t, "RETRY_SERIALIZABLE", tx2ExecErr)
_ = tx2.Rollback()
} else {
require.Regexp(t, "RETRY_SERIALIZABLE", tx1Err)
tx2ExecErr := <-errCh
require.NoError(t, tx2ExecErr)
if tx2CommitErr := tx2.Commit(); tx2CommitErr != nil {
require.Regexp(t, "RETRY_SERIALIZABLE", tx2CommitErr)
}
}
}
// TestRetriableErrorDuringPrepare ensures that when preparing and using a new
// transaction, retriable errors are handled properly and do not propagate to
// the user's transaction.
func TestRetriableErrorDuringPrepare(t *testing.T) {
defer leaktest.AfterTest(t)()
defer log.Scope(t).Close(t)
const uniqueString = "'a very unique string'"
var failed int64
const numToFail = 2 // only fail on the first two attempts
s, sqlDB, _ := serverutils.StartServer(t, base.TestServerArgs{
Knobs: base.TestingKnobs{
SQLExecutor: &sql.ExecutorTestingKnobs{
BeforePrepare: func(ctx context.Context, stmt string, txn *kv.Txn) error {
if strings.Contains(stmt, uniqueString) && atomic.AddInt64(&failed, 1) <= numToFail {
return roachpb.NewTransactionRetryWithProtoRefreshError("boom",
txn.ID(), *txn.TestingCloneTxn())
}
return nil
},
},
},
})
defer s.Stopper().Stop(context.Background())
testDB := sqlutils.MakeSQLRunner(sqlDB)
testDB.Exec(t, "CREATE TABLE foo (i INT PRIMARY KEY)")
stmt, err := sqlDB.Prepare("SELECT " + uniqueString)
require.NoError(t, err)
defer func() { _ = stmt.Close() }()
}
// This test ensures that when in an explicit transaction and statement
// preparation uses the user's transaction, errors during those planning queries
// are handled correctly.
func TestErrorDuringPrepareInExplicitTransactionPropagates(t *testing.T) {
defer leaktest.AfterTest(t)()
defer log.Scope(t).Close(t)
ctx := context.Background()
filter := newDynamicRequestFilter()
s, sqlDB, _ := serverutils.StartServer(t, base.TestServerArgs{
Knobs: base.TestingKnobs{
Store: &kvserver.StoreTestingKnobs{
TestingRequestFilter: filter.filter,
},
},
})
defer s.Stopper().Stop(ctx)
testDB := sqlutils.MakeSQLRunner(sqlDB)
testDB.Exec(t, "CREATE TABLE foo (i INT PRIMARY KEY)")
testDB.Exec(t, "CREATE TABLE bar (i INT PRIMARY KEY)")
// This test will create an explicit transaction that encounters an error on
// a latter statement during planning of SHOW COLUMNS. The planning for this
// SHOW COLUMNS will be run in the user's transaction. The test will inject
// errors into the execution of that planning query and ensure that the user's
// transaction state evolves appropriately.
// Use pgx so that we can introspect error codes returned from cockroach.
pgURL, cleanup := sqlutils.PGUrl(t, s.ServingSQLAddr(), "", url.User("root"))
defer cleanup()
conf, err := pgx.ParseConfig(pgURL.String())
require.NoError(t, err)
conn, err := pgx.ConnectConfig(ctx, conf)
require.NoError(t, err)
tx, err := conn.Begin(ctx)
require.NoError(t, err)
_, err = tx.Exec(ctx, "SAVEPOINT cockroach_restart")
require.NoError(t, err)
// Do something with the user's transaction so that we'll use the user
// transaction in the planning of the below `SHOW COLUMNS`.
_, err = tx.Exec(ctx, "INSERT INTO foo VALUES (1)")
require.NoError(t, err)
// Inject an error that will happen during planning.
filter.setFilter(func(ctx context.Context, ba roachpb.BatchRequest) *roachpb.Error {
if ba.Txn == nil {
return nil
}
if req, ok := ba.GetArg(roachpb.Get); ok {
get := req.(*roachpb.GetRequest)
_, tableID, err := keys.SystemSQLCodec.DecodeTablePrefix(get.Key)
if err != nil || tableID != keys.NamespaceTableID {
err = nil
return nil
}
return roachpb.NewErrorWithTxn(
roachpb.NewTransactionRetryError(roachpb.RETRY_REASON_UNKNOWN, "boom"), ba.Txn)
}
return nil
})
// Plan a query will get a restart error during planning.
_, err = tx.Prepare(ctx, "show_columns", "SELECT NULL FROM [SHOW COLUMNS FROM bar] LIMIT 1")
require.Regexp(t,
`restart transaction: TransactionRetryWithProtoRefreshError: TransactionRetryError: retry txn \(RETRY_REASON_UNKNOWN - boom\)`,
err)
var pgErr = new(pgconn.PgError)
require.True(t, errors.As(err, &pgErr))
require.Equal(t, pgcode.SerializationFailure, pgcode.MakeCode(pgErr.Code))
// Clear the error producing filter, restart the transaction, and run it to
// completion.
filter.setFilter(nil)
_, err = tx.Exec(ctx, "ROLLBACK TO SAVEPOINT cockroach_restart")
require.NoError(t, err)
_, err = tx.Exec(ctx, "INSERT INTO foo VALUES (1)")
require.NoError(t, err)
_, err = tx.Prepare(ctx, "show_columns", "SELECT NULL FROM [SHOW COLUMNS FROM bar] LIMIT 1")
require.NoError(t, err)
require.NoError(t, tx.Commit(ctx))
}
// TestTrimFlushedStatements verifies that the conn executor trims the
// statements buffer once the corresponding results are returned to the user.
func TestTrimFlushedStatements(t *testing.T) {
defer leaktest.AfterTest(t)()
defer log.Scope(t).Close(t)
const (
countStmt = "SELECT count(*) FROM test"
// stmtBufMaxLen is the maximum length the statement buffer should be during
// execution of COUNT(*). This includes a SELECT COUNT(*) command as well
// as a Sync command.
stmtBufMaxLen = 2
)
// stmtBufLen is set to the length of the statement buffer after each SELECT
// COUNT(*) execution.
stmtBufLen := 0
ctx := context.Background()
s, sqlDB, _ := serverutils.StartServer(t, base.TestServerArgs{
Knobs: base.TestingKnobs{
SQLExecutor: &sql.ExecutorTestingKnobs{
AfterExecCmd: func(_ context.Context, cmd sql.Command, buf *sql.StmtBuf) {
if strings.Contains(cmd.String(), countStmt) {
// Only compare statement buffer length on SELECT COUNT(*) queries.
stmtBufLen = buf.Len()
}
},
},
},
})
defer s.Stopper().Stop(ctx)
_, err := sqlDB.Exec("CREATE TABLE test (i int)")
require.NoError(t, err)
tx, err := sqlDB.Begin()
require.NoError(t, err)
for i := 0; i < 10; i++ {
_, err := tx.Exec(countStmt)
require.NoError(t, err)
if stmtBufLen > stmtBufMaxLen {
t.Fatalf("statement buffer grew to %d (> %d) after %dth execution", stmtBufLen, stmtBufMaxLen, i)
}
}
require.NoError(t, tx.Commit())
}
// TestUnqualifiedIntSizeRace makes sure there is no data race using the
// default_int_size session variable during statement parsing.
// Regression test for https://github.com/cockroachdb/cockroach/issues/69451.
func TestUnqualifiedIntSizeRace(t *testing.T) {
defer leaktest.AfterTest(t)()
defer log.Scope(t).Close(t)
ctx := context.Background()
s, _, _ := serverutils.StartServer(t, base.TestServerArgs{
Insecure: true,
})
defer s.Stopper().Stop(ctx)
// Connect to the cluster via the PGWire client.
p, err := pgtest.NewPGTest(ctx, s.SQLAddr(), security.RootUser)
require.NoError(t, err)
require.NoError(t, p.SendOneLine(`Query {"String": "SET default_int_size = 8"}`))
require.NoError(t, p.SendOneLine(`Query {"String": "SET default_int_size = 4"}`))
require.NoError(t, p.SendOneLine(`Parse {"Query": "SELECT generate_series(1, 10)"}`))
// wait for ready
for i := 0; i < 2; i++ {
until := pgtest.ParseMessages("ReadyForQuery")
_, err = p.Until(false /* keepErrMsg */, until...)
require.NoError(t, err)
}
}
func TestTrimSuspendedPortals(t *testing.T) {
defer leaktest.AfterTest(t)()
defer log.Scope(t).Close(t)
const (
// select generates 10 rows of results which the test retrieves using ExecPortal
selectStmt = "SELECT generate_series(1, 10)"
// stmtBufMaxLen is the maximum length the statement buffer should be during
// execution
stmtBufMaxLen = 2
// The name of the portal, used to get a handle on the statement buffer
portalName = "C_1"
)
ctx := context.Background()
var stmtBuff *sql.StmtBuf
s, _, _ := serverutils.StartServer(t, base.TestServerArgs{
Knobs: base.TestingKnobs{
SQLExecutor: &sql.ExecutorTestingKnobs{
// get a handle to the statement buffer during the Bind phase
AfterExecCmd: func(_ context.Context, cmd sql.Command, buf *sql.StmtBuf) {
switch tcmd := cmd.(type) {
case sql.BindStmt:
if tcmd.PortalName == portalName {
stmtBuff = buf
}
default:
}
},
},
},
Insecure: true,
})
defer s.Stopper().Stop(ctx)
// Connect to the cluster via the PGWire client.
p, err := pgtest.NewPGTest(ctx, s.SQLAddr(), security.RootUser)
require.NoError(t, err)
// Setup the portal.
// Note: This also makes sure that modifying the sessionDataStack with
// PushTopClone does not have a race condition.
require.NoError(t, p.SendOneLine(`Query {"String": "BEGIN"}`))
require.NoError(t, p.SendOneLine(fmt.Sprintf(`Parse {"Query": "%s"}`, selectStmt)))
require.NoError(t, p.SendOneLine(fmt.Sprintf(`Bind {"DestinationPortal": "%s"}`, portalName)))
// wait for ready
until := pgtest.ParseMessages("ReadyForQuery")
_, err = p.Until(false /* keepErrMsg */, until...)
require.NoError(t, err)
// Execute the portal 10 times
for i := 1; i <= 10; i++ {
// Exec the portal
require.NoError(t, p.SendOneLine(fmt.Sprintf(`Execute {"Portal": "%s", "MaxRows": 1}`, portalName)))
require.NoError(t, p.SendOneLine(`Sync`))
// wait for ready
msg, _ := p.Until(false /* keepErrMsg */, until...)
// received messages should include a data row with the correct value
received := pgtest.MsgsToJSONWithIgnore(msg, &datadriven.TestData{})
require.Equal(t, 1, strings.Count(received, fmt.Sprintf(`"Type":"DataRow","Values":[{"text":"%d"}]`, i)))
// assert that the stmtBuff never exceeds the expected size
stmtBufLen := stmtBuff.Len()
if stmtBufLen > stmtBufMaxLen {
t.Fatalf("statement buffer grew to %d (> %d) after %dth execution", stmtBufLen, stmtBufMaxLen, i)
}
}
// send commit
require.NoError(t, p.SendOneLine(`Query {"String": "COMMIT"}`))
// wait for ready
msg, _ := p.Until(false /* keepErrMsg */, until...)
received := pgtest.MsgsToJSONWithIgnore(msg, &datadriven.TestData{})
require.Equal(t, 1, strings.Count(received, `"Type":"CommandComplete","CommandTag":"COMMIT"`))
}
func TestShowLastQueryStatisticsUnknown(t *testing.T) {
defer leaktest.AfterTest(t)()
defer log.Scope(t).Close(t)
ctx := context.Background()