-
Notifications
You must be signed in to change notification settings - Fork 7
Expand file tree
/
Copy pathproxy.go
More file actions
2060 lines (1845 loc) · 73.3 KB
/
proxy.go
File metadata and controls
2060 lines (1845 loc) · 73.3 KB
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 (c) DataStax, 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.
package proxy
import (
"bytes"
"context"
"crypto"
"crypto/md5"
"encoding/hex"
"errors"
"fmt"
"io"
"net"
"os"
"reflect"
"sync"
"time"
"cloud.google.com/go/spanner"
otelgo "github.com/cloudspannerecosystem/cassandra-to-spanner-proxy/otel"
"github.com/cloudspannerecosystem/cassandra-to-spanner-proxy/responsehandler"
spannerModule "github.com/cloudspannerecosystem/cassandra-to-spanner-proxy/spanner"
"github.com/cloudspannerecosystem/cassandra-to-spanner-proxy/tableConfig"
"github.com/cloudspannerecosystem/cassandra-to-spanner-proxy/third_party/datastax/parser"
"github.com/cloudspannerecosystem/cassandra-to-spanner-proxy/third_party/datastax/proxy/iface"
"github.com/cloudspannerecosystem/cassandra-to-spanner-proxy/third_party/datastax/proxycore"
"github.com/cloudspannerecosystem/cassandra-to-spanner-proxy/translator"
"github.com/cloudspannerecosystem/cassandra-to-spanner-proxy/utilities"
"github.com/datastax/go-cassandra-native-protocol/datatype"
"github.com/datastax/go-cassandra-native-protocol/frame"
"github.com/datastax/go-cassandra-native-protocol/message"
"github.com/datastax/go-cassandra-native-protocol/primitive"
lru "github.com/hashicorp/golang-lru"
"go.opentelemetry.io/otel"
"go.opentelemetry.io/otel/attribute"
"go.uber.org/zap"
"google.golang.org/api/option"
"google.golang.org/grpc"
"google.golang.org/grpc/credentials/insecure"
)
const (
commitTsFn = "PENDING_COMMIT_TIMESTAMP()"
SpannerConnectionString = "projects/%s/instances/%s/databases/%s"
)
const (
handleQuery = "handleQuery"
handleBatch = "Batch"
handleExecuteForInsert = "handleExecuteForInsert"
handleExecuteForDelete = "handleExecuteForDelete"
handleExecuteForUpdate = "handleExecuteForUpdate"
handleExecuteForSelect = "handleExecuteForSelect"
cassandraQuery = "Cassandra Query"
spannerQuery = "Spanner Query"
)
// Events
const (
executingSpannerRequestEvent = "Executing Spanner Request"
spannerExecutionDoneEvent = "Spanner Execution Done"
)
var encodedOneValue, _ = proxycore.EncodeType(datatype.Int, primitive.ProtocolVersion4, 1)
var ErrProxyClosed = errors.New("proxy closed")
var ErrProxyAlreadyConnected = errors.New("proxy already connected")
var ErrProxyNotConnected = errors.New("proxy not connected")
var (
system_schema = "system_schema"
keyspaces = "keyspaces"
tables = "tables"
columns = "columns"
system_virtual_schema = "system_virtual_schema"
local = "local"
spannerMaxStaleness = "spanner_maxstaleness"
)
const selectType = "select"
const updateType = "update"
const insertType = "insert"
const deleteType = "delete"
const ttl_column = "spanner_ttl_ts"
const ts_column = "last_commit_ts"
const preparedIdSize = 16
const limitValue = "limitValue"
const Query = "Query"
const translatorErrorMessage = "Error occurred at translator"
const metadataFetchError = "Error while fetching table Metadata - "
const errorAtSpanner = "Error occurred at spanner - "
const errorWhileDecoding = "Error while decoding bytes - "
const errorWhileCasting = "Error while casting - "
const errUnhandledPrepare = "error while preparing query"
const errUnhandledPrepareExecute = "unhandled prepare execute scenario"
const errQueryNotPrepared = "query is not prepared"
const formateMsg = "%s -> %s"
const systemQueryMetadataNotFoundError = "data not found %s[%v]"
const errorStaleReadDecoding = "invalid type for stale read - expected bytes encoded string containing int64 value with suffix s(second), m(minute), h(hour)"
type PeerConfig struct {
RPCAddr string `yaml:"rpc-address"`
DC string `yaml:"data-center,omitempty"`
Tokens []string `yaml:"tokens,omitempty"`
}
type Config struct {
Version primitive.ProtocolVersion
MaxVersion primitive.ProtocolVersion
Auth proxycore.Authenticator
Resolver proxycore.EndpointResolver
RetryPolicy RetryPolicy
Logger *zap.Logger
HeartBeatInterval time.Duration
ConnectTimeout time.Duration
IdleTimeout time.Duration
RPCAddr string
DC string
Tokens []string
SpannerConfig SpannerConfig
OtelConfig *OtelConfig
ReleaseVersion string
Partitioner string
CQLVersion string
// PreparedCache a cache that stores prepared queries. If not set it uses the default implementation with a max
// capacity of ~100MB.
PreparedCache proxycore.PreparedCache
KeyspaceFlatter bool
UseRowTimestamp bool
UseRowTTL bool
Debug bool
UserAgent string
Endpoint string
CaCertificate string
ClientCertificate string
ClientKey string
UsePlainText bool
}
type SpannerConfig struct {
DatabaseName string
ConfigTableName string
NumOfChannels int
InstanceName string
GCPProjectID string
MaxSessions uint64
MinSessions uint64
MaxCommitDelay uint64
ReplayProtection bool
KeyspaceFlatter bool
}
type Proxy struct {
ctx context.Context
config Config
logger *zap.Logger
cluster *proxycore.Cluster
sessions [primitive.ProtocolVersionDse2 + 1]sync.Map // Cache sessions per protocol version
mu sync.Mutex
isConnected bool
isClosing bool
clients map[*client]struct{}
listeners map[*net.Listener]struct{}
eventClients sync.Map
preparedCache proxycore.PreparedCache
preparedIdempotence sync.Map
preparedQueriesCache sync.Map
systemLocalValues map[string]message.Column
closed chan struct{}
localNode *node
nodes []*node
sClient spannerModule.SpannerClientIface
translator *translator.Translator
tableConfig *tableConfig.TableConfig
otelInst *otelgo.OpenTelemetry
otelShutdown func(context.Context) error
systemQueryMetadataCache *spannerModule.SystemQueryMetadataCache
}
type node struct {
addr *net.IPAddr
dc string
tokens []string
}
func (p *Proxy) OnEvent(event proxycore.Event) {
switch evt := event.(type) {
case *proxycore.SchemaChangeEvent:
p.logger.Debug("Schema change event detected", zap.String("SchemaChangeEvent", evt.Message.String()))
}
}
func NewProxy(ctx context.Context, config Config) (*Proxy, error) {
if config.Version == 0 {
config.Version = primitive.ProtocolVersion4
}
if config.MaxVersion == 0 {
config.MaxVersion = primitive.ProtocolVersion4
}
if config.RetryPolicy == nil {
config.RetryPolicy = NewDefaultRetryPolicy()
}
logger := proxycore.GetOrCreateNopLogger(config.Logger)
// Enable OpenTelemetry traces by setting environment variable GOOGLE_API_GO_EXPERIMENTAL_TELEMETRY_PLATFORM_TRACING to the case-insensitive value "opentelemetry" before loading the client library.
otelInit := &otelgo.OTelConfig{}
otelInst := &otelgo.OpenTelemetry{Config: &otelgo.OTelConfig{OTELEnabled: false}}
var shutdownOTel func(context.Context) error
var err error
var spanCl iface.SpannerClientInterface
// Initialize OpenTelemetry
if config.OtelConfig.Enabled {
otelInit = &otelgo.OTelConfig{
TraceEnabled: config.OtelConfig.Traces.Enabled,
MetricEnabled: config.OtelConfig.Metrics.Enabled,
TracerEndpoint: config.OtelConfig.Traces.Endpoint,
MetricEndpoint: config.OtelConfig.Metrics.Endpoint,
ServiceName: config.OtelConfig.ServiceName,
OTELEnabled: config.OtelConfig.Enabled,
TraceSampleRatio: config.OtelConfig.Traces.SamplingRatio,
Database: config.SpannerConfig.DatabaseName,
Instance: config.SpannerConfig.InstanceName,
HealthCheckEnabled: config.OtelConfig.HealthCheck.Enabled,
HealthCheckEp: config.OtelConfig.HealthCheck.Endpoint,
ServiceVersion: config.Version.String(),
DisableRandomServiceInstanceIDKey: config.OtelConfig.DisableRandomServiceInstanceIDKey,
}
otelInst, shutdownOTel, err = otelgo.NewOpenTelemetry(ctx, otelInit, config.Logger)
if err != nil {
config.Logger.Error("Failed to enable the OTEL for the database: " + config.SpannerConfig.DatabaseName)
return nil, err
}
config.Logger.Info("OTEL enabled at the application start for the database: " + config.SpannerConfig.DatabaseName)
} else {
otelInit = &otelgo.OTelConfig{
OTELEnabled: false,
}
otelInst, shutdownOTel, err = otelgo.NewOpenTelemetry(ctx, otelInit, config.Logger)
if err != nil {
config.Logger.Error("Failed to enable the OTEL for the database: " + config.SpannerConfig.DatabaseName)
return nil, err
}
}
spanCl = NewSpannerClient(ctx, config, otelInst)
spannerClient, err := spanCl.GetClient(ctx)
if err != nil {
return nil, err
}
var tableConfigurations *tableConfig.TableConfig
spannerModuleClient := spannerModule.NewSpannerClient(spannerClient, config.Logger, &responsehandler.TypeHandler{
Logger: logger,
},
config.KeyspaceFlatter,
config.SpannerConfig.MaxCommitDelay,
config.SpannerConfig.ReplayProtection)
spannerQuery := fmt.Sprintf("SELECT * FROM %v ORDER BY TableName, IsPrimaryKey, PK_Precedence;", config.SpannerConfig.ConfigTableName)
query := responsehandler.QueryMetadata{
Query: spannerQuery,
TableName: config.SpannerConfig.ConfigTableName,
ProtocalV: config.Version,
KeyspaceName: config.SpannerConfig.DatabaseName,
}
tableMetadata, pkMetadata, systemQueryMetadataCache, err := spannerModuleClient.GetTableConfigs(ctx, query)
if err != nil {
return nil, err
}
tableConfigurations = &tableConfig.TableConfig{
Logger: config.Logger,
TablesMetaData: tableMetadata,
PkMetadataCache: pkMetadata,
}
proxyTranslator := &translator.Translator{
Logger: config.Logger,
TableConfig: tableConfigurations,
KeyspaceFlatter: config.KeyspaceFlatter,
UseRowTimestamp: config.UseRowTimestamp,
UseRowTTL: config.UseRowTTL,
Debug: config.Debug,
}
proxy := Proxy{
ctx: ctx,
config: config,
logger: logger,
clients: make(map[*client]struct{}),
listeners: make(map[*net.Listener]struct{}),
closed: make(chan struct{}),
sClient: spannerModuleClient,
translator: proxyTranslator,
tableConfig: tableConfigurations,
systemQueryMetadataCache: systemQueryMetadataCache,
}
proxy.otelInst = otelInst
proxy.otelShutdown = shutdownOTel
return &proxy, nil
}
func (p *Proxy) Connect() error {
p.mu.Lock()
defer p.mu.Unlock()
if p.isConnected {
return ErrProxyAlreadyConnected
}
var err error
p.preparedCache, err = getOrCreateDefaultPreparedCache(p.config.PreparedCache)
if err != nil {
return fmt.Errorf("unable to create prepared cache %w", err)
}
// Connecting to cassandra cluster
p.cluster, err = proxycore.ConnectCluster(p.ctx, proxycore.ClusterConfig{
Version: p.config.Version,
Auth: p.config.Auth,
Resolver: p.config.Resolver,
HeartBeatInterval: p.config.HeartBeatInterval,
ConnectTimeout: p.config.ConnectTimeout,
IdleTimeout: p.config.IdleTimeout,
Logger: p.logger,
})
if err != nil {
return fmt.Errorf("unable to connect to cluster %w", err)
}
err = p.buildNodes()
if err != nil {
return fmt.Errorf("unable to build node information: %w", err)
}
p.buildLocalRow()
// Create cassandra session
sess, err := proxycore.ConnectSession(p.ctx, p.cluster, proxycore.SessionConfig{
Version: p.cluster.NegotiatedVersion,
Auth: p.config.Auth,
HeartBeatInterval: p.config.HeartBeatInterval,
ConnectTimeout: p.config.ConnectTimeout,
IdleTimeout: p.config.IdleTimeout,
PreparedCache: p.preparedCache,
Logger: p.logger,
})
if err != nil {
return fmt.Errorf("unable to connect session %w", err)
}
p.sessions[p.cluster.NegotiatedVersion].Store("", sess) // No keyspace
p.isConnected = true
return nil
}
// Serve the proxy using the specified listener. It can be called multiple times with different listeners allowing
// them to share the same backend clusters.
func (p *Proxy) Serve(l net.Listener) (err error) {
l = &closeOnceListener{Listener: l}
defer l.Close()
if err = p.addListener(&l); err != nil {
return err
}
defer p.removeListener(&l)
for {
conn, err := l.Accept()
if err != nil {
select {
case <-p.closed:
return ErrProxyClosed
default:
return err
}
}
p.handle(conn)
}
}
func (p *Proxy) addListener(l *net.Listener) error {
p.mu.Lock()
defer p.mu.Unlock()
if p.isClosing {
return ErrProxyClosed
}
if !p.isConnected {
return ErrProxyNotConnected
}
p.listeners[l] = struct{}{}
return nil
}
func (p *Proxy) removeListener(l *net.Listener) {
p.mu.Lock()
defer p.mu.Unlock()
delete(p.listeners, l)
}
func (p *Proxy) Close() error {
p.mu.Lock()
defer p.mu.Unlock()
select {
case <-p.closed:
default:
close(p.closed)
}
var err error
for l := range p.listeners {
if closeErr := (*l).Close(); closeErr != nil && err == nil {
err = closeErr
}
}
for cl := range p.clients {
_ = cl.conn.Close()
p.eventClients.Delete(cl)
delete(p.clients, cl)
}
p.sClient.Close()
if p.otelShutdown != nil {
err = p.otelShutdown(p.ctx)
}
return err
}
func (p *Proxy) Ready() bool {
return true
}
func (p *Proxy) handle(conn net.Conn) {
if tcpConn, ok := conn.(*net.TCPConn); ok {
if err := tcpConn.SetKeepAlive(false); err != nil {
p.logger.Warn("failed to disable keepalive on connection", zap.Error(err))
}
if err := tcpConn.SetNoDelay(true); err != nil {
p.logger.Warn("failed to set TCP_NODELAY on connection", zap.Error(err))
}
}
cl := &client{
ctx: p.ctx,
proxy: p,
preparedSystemQuery: make(map[[preparedIdSize]byte]interface{}),
}
cl.sender = cl
p.addClient(cl)
cl.conn = proxycore.NewConn(conn, cl)
cl.conn.Start()
}
var (
schemaVersion, _ = primitive.ParseUuid("4f2b29e6-59b5-4e2d-8fd6-01e32e67f0d7")
)
func (p *Proxy) buildNodes() (err error) {
localDC := p.config.DC
if len(localDC) == 0 {
localDC = p.cluster.Info.LocalDC
p.logger.Info("no local DC configured using DC from the first successful contact point",
zap.String("dc", localDC))
}
p.localNode = &node{
dc: localDC,
}
return nil
}
func (p *Proxy) buildLocalRow() {
p.systemLocalValues = map[string]message.Column{
"key": p.encodeTypeFatal(datatype.Varchar, "local"),
"data_center": p.encodeTypeFatal(datatype.Varchar, p.localNode.dc),
"rack": p.encodeTypeFatal(datatype.Varchar, "rack1"),
"tokens": p.encodeTypeFatal(datatype.NewListType(datatype.Varchar), [1]string{"-9223372036854775808"}),
"release_version": p.encodeTypeFatal(datatype.Varchar, p.config.ReleaseVersion),
"partitioner": p.encodeTypeFatal(datatype.Varchar, p.config.Partitioner),
"cluster_name": p.encodeTypeFatal(datatype.Varchar, "cql-proxy"),
"cql_version": p.encodeTypeFatal(datatype.Varchar, p.config.CQLVersion),
"schema_version": p.encodeTypeFatal(datatype.Uuid, schemaVersion), // TODO: Make this match the downstream cluster(s)
"native_protocol_version": p.encodeTypeFatal(datatype.Varchar, p.config.Version.String()),
"dse_version": p.encodeTypeFatal(datatype.Varchar, p.cluster.Info.DSEVersion),
}
}
func (p *Proxy) encodeTypeFatal(dt datatype.DataType, val interface{}) []byte {
encoded, err := proxycore.EncodeType(dt, p.config.Version, val)
if err != nil {
p.logger.Fatal("unable to encode type", zap.Error(err))
}
return encoded
}
// isIdempotent checks whether a prepared ID is idempotent.
// If the proxy receives a query that it's never prepared then this will also return false.
func (p *Proxy) IsIdempotent(id []byte) bool {
if val, ok := p.preparedIdempotence.Load(preparedIdKey(id)); !ok {
// This should only happen if the proxy has never had a "PREPARE" request for this query ID.
p.logger.Error("unable to determine if prepared statement is idempotent",
zap.String("preparedID", hex.EncodeToString(id)))
return false
} else {
return val.(bool)
}
}
// MaybeStorePreparedIdempotence stores the idempotence of a "PREPARE" request's query.
// This information is used by future "EXECUTE" requests when they need to be retried.
func (p *Proxy) MaybeStorePreparedIdempotence(raw *frame.RawFrame, msg message.Message) {
if prepareMsg, ok := msg.(*message.Prepare); ok && raw.Header.OpCode == primitive.OpCodeResult { // Prepared result
frm, err := codec.ConvertFromRawFrame(raw)
if err != nil {
p.logger.Error("error attempting to decode prepared result message")
} else if _, ok = frm.Body.Message.(*message.PreparedResult); !ok { // TODO: Use prepared type data to disambiguate idempotency
p.logger.Error("expected prepared result message, but got something else")
} else {
idempotent, err := parser.IsQueryIdempotent(prepareMsg.Query)
if err != nil {
p.logger.Error("error parsing query for idempotence", zap.Error(err))
} else if result, ok := frm.Body.Message.(*message.PreparedResult); ok {
p.preparedIdempotence.Store(preparedIdKey(result.PreparedQueryId), idempotent)
} else {
p.logger.Error("expected prepared result, but got some other type of message",
zap.Stringer("type", reflect.TypeOf(frm.Body.Message)))
}
}
}
}
func (p *Proxy) addClient(cl *client) {
p.mu.Lock()
defer p.mu.Unlock()
p.clients[cl] = struct{}{}
}
func (p *Proxy) registerForEvents(cl *client) {
p.eventClients.Store(cl, struct{}{})
}
func (p *Proxy) removeClient(cl *client) {
p.eventClients.Delete(cl)
p.mu.Lock()
defer p.mu.Unlock()
delete(p.clients, cl)
}
type Sender interface {
Send(hdr *frame.Header, msg message.Message)
}
type client struct {
ctx context.Context
proxy *Proxy
conn *proxycore.Conn
keyspace string
preparedSystemQuery map[[16]byte]interface{}
sender iface.Sender
}
type PreparedQuery struct {
Query string
SelectedColumns []string
PreparedColumns []string
}
func (c *client) AddQueryToCache(id [16]byte, parsedQueryMeta interface{}) {
c.proxy.preparedQueriesCache.Store(id, parsedQueryMeta)
}
func (c *client) GetQueryFromCache(id [16]byte) (interface{}, bool) {
return c.proxy.preparedQueriesCache.Load(id)
}
func (c *client) Receive(reader io.Reader) error {
raw, err := codec.DecodeRawFrame(reader)
if err != nil {
if !errors.Is(err, io.EOF) {
c.proxy.logger.Error("unable to decode frame", zap.Error(err))
}
return err
}
if raw.Header.Version > c.proxy.config.MaxVersion || raw.Header.Version < primitive.ProtocolVersion3 {
c.sender.Send(raw.Header, &message.ProtocolError{
ErrorMessage: fmt.Sprintf("Invalid or unsupported protocol version %d", raw.Header.Version),
})
return nil
}
body, err := codec.DecodeBody(raw.Header, bytes.NewReader(raw.Body))
if err != nil {
c.proxy.logger.Error("unable to decode body", zap.Error(err))
return err
}
switch msg := body.Message.(type) {
case *message.Options:
// CC - responding with status READY
c.sender.Send(raw.Header, &message.Supported{Options: map[string][]string{
"CQL_VERSION": {c.proxy.config.CQLVersion},
"COMPRESSION": {},
}})
case *message.Startup:
// CC - register for Event types and respond READY
c.sender.Send(raw.Header, &message.Ready{})
case *message.Register:
for _, t := range msg.EventTypes {
if t == primitive.EventTypeSchemaChange {
c.proxy.registerForEvents(c)
}
}
c.sender.Send(raw.Header, &message.Ready{})
case *message.Prepare:
c.proxy.logger.Debug("Prepare block -", zap.String(Query, msg.Query))
c.handlePrepare(raw, msg)
case *partialExecute:
if bytes, found := body.CustomPayload[spannerMaxStaleness]; found {
maxStaleness, err := utilities.ParseDurationToSeconds(string(bytes))
if err != nil {
c.sender.Send(raw.Header, &message.Invalid{ErrorMessage: errorStaleReadDecoding})
return nil
}
c.handleExecute(raw, msg, utilities.ExecuteOptions{MaxStaleness: maxStaleness})
} else {
c.handleExecute(raw, msg, utilities.ExecuteOptions{MaxStaleness: 0})
}
case *partialQuery:
c.handleQuery(raw, msg)
case *partialBatch:
c.handleBatch(raw, msg)
default:
c.sender.Send(raw.Header, &message.ProtocolError{ErrorMessage: "Unsupported operation"})
}
return nil
}
// function to execute query on cassandra
func (c *client) handlePrepare(raw *frame.RawFrame, msg *message.Prepare) {
c.proxy.logger.Debug("handling prepare", zap.String(Query, msg.Query), zap.Int16("stream", raw.Header.StreamId))
keyspace := c.keyspace
if len(msg.Keyspace) != 0 {
keyspace = msg.Keyspace
}
handled, stmt, queryType, err := parser.IsQueryHandledWithQueryType(parser.IdentifierFromString(keyspace), msg.Query)
if handled {
if err != nil {
c.proxy.logger.Error("error parsing query to see if it's handled", zap.String(Query, msg.Query), zap.Error(err))
c.sender.Send(raw.Header, &message.Invalid{ErrorMessage: err.Error()})
} else {
switch s := stmt.(type) {
// handling select statement
case *parser.SelectStatement:
if systemColumns, ok := parser.SystemColumnsByName[s.Table]; ok {
if columns, err := parser.FilterColumns(s, systemColumns); err != nil {
c.sender.Send(raw.Header, &message.Invalid{ErrorMessage: err.Error()})
} else {
id := md5.Sum([]byte(msg.Query + keyspace))
c.sender.Send(raw.Header, &message.PreparedResult{
PreparedQueryId: id[:],
ResultMetadata: &message.RowsMetadata{
ColumnCount: int32(len(columns)),
Columns: columns,
},
})
c.preparedSystemQuery[id] = stmt
}
} else {
c.sender.Send(raw.Header, &message.Invalid{ErrorMessage: "system columns doesn't exist"})
}
// Prepare Use statement
case *parser.UseStatement:
id := md5.Sum([]byte(msg.Query))
c.preparedSystemQuery[id] = stmt
c.sender.Send(raw.Header, &message.PreparedResult{
PreparedQueryId: id[:],
})
default:
c.sender.Send(raw.Header, &message.ServerError{ErrorMessage: "Proxy attempted to intercept an unhandled query"})
}
}
} else {
c.handleServerPreparedQuery(raw, msg, queryType)
}
}
// Check if query is already prepared and return response accordingly without re-processing
// Params: id [16]byte - Unique identifier for the prepared statement.
// Returns: []*message.ColumnMetadata - Variable metadata, []*message.ColumnMetadata - Column metadata, bool - Exists in cache.
// Retrieves and returns metadata for Select, Insert, Delete, and Update query maps from the cache, or nil and false if not found.
func (c *client) getMetadataFromCache(id [16]byte) ([]*message.ColumnMetadata, []*message.ColumnMetadata, bool) {
preparedStmt, found := c.GetQueryFromCache(id)
if !found {
return nil, nil, false
}
switch st := preparedStmt.(type) {
case *translator.SelectQueryMap:
return st.VariableMetadata, st.ReturnMetadata, true
case *translator.InsertQueryMap:
return st.VariableMetadata, st.ReturnMetadata, true
case *translator.DeleteQueryMap:
return st.VariableMetadata, st.ReturnMetadata, true
case *translator.UpdateQueryMap:
return st.VariableMetadata, st.ReturnMetadata, true
default:
return nil, nil, false
}
}
// handleServerPreparedQuery handle prepared query that was supposed to run on cassandra server
// This method will keep track of prepared query in a map and send hashed query_id with result
// metadata and variable column metadata to the client
//
// Parameters:
// - raw: *frame.RawFrame
// - msg: *message.Prepare
//
// Returns: nil
func (c *client) handleServerPreparedQuery(raw *frame.RawFrame, msg *message.Prepare, queryType string) {
var PkIndices []uint16
var err error
var columns, variableColumnMetadata []*message.ColumnMetadata
// Generating unique prepared query_id
id := md5.Sum([]byte(msg.Query + c.keyspace))
variableColumnMetadata, columns, found := c.getMetadataFromCache(id)
if !found {
switch queryType {
case selectType:
columns, variableColumnMetadata, err = c.prepareSelectType(raw, msg, id)
case insertType:
columns, variableColumnMetadata, err = c.prepareInsertType(raw, msg, id)
case deleteType:
columns, variableColumnMetadata, err = c.prepareDeleteType(raw, msg, id)
case updateType:
columns, variableColumnMetadata, err = c.prepareUpdateType(raw, msg, id)
default:
c.proxy.logger.Error(errUnhandledPrepare, zap.String(Query, msg.Query))
c.sender.Send(raw.Header, &message.Invalid{ErrorMessage: errUnhandledPrepare})
return
}
if err != nil {
return
}
}
// Generating Index array of size of variableMetadata
for i := range variableColumnMetadata {
PkIndices = append(PkIndices, uint16(i))
}
c.sender.Send(raw.Header, &message.PreparedResult{
PreparedQueryId: id[:],
ResultMetadata: &message.RowsMetadata{
ColumnCount: int32(len(columns)),
Columns: columns,
},
VariablesMetadata: &message.VariablesMetadata{
PkIndices: PkIndices,
Columns: variableColumnMetadata,
},
})
}
// function to handle and delete query of prepared type
func (c *client) prepareDeleteType(raw *frame.RawFrame, msg *message.Prepare, id [16]byte) ([]*message.ColumnMetadata, []*message.ColumnMetadata, error) {
var returnColumns, variableColumns, columnsWithInOp []string
deleteQueryMetadata, err := c.proxy.translator.ToSpannerDelete(c.keyspace, msg.Query, false)
if err != nil {
c.proxy.logger.Error(translatorErrorMessage, zap.String(Query, msg.Query), zap.Error(err))
c.sender.Send(raw.Header, &message.Invalid{ErrorMessage: err.Error()})
return nil, nil, err
}
deleteQueryMetadata.ExecuteByMutation = true
if utilities.KeyExistsInList(ts_column, deleteQueryMetadata.ParamKeys) {
variableColumns = append(variableColumns, ts_column)
}
// Capturing variable columns name assuming all columns are parameterized
for _, clause := range deleteQueryMetadata.Clauses {
variableColumns = append(variableColumns, clause.Column)
// Capture columns with IN operator
if clause.Operator == "IN" {
columnsWithInOp = append(columnsWithInOp, clause.Column)
}
if deleteQueryMetadata.ExecuteByMutation {
deleteQueryMetadata.ExecuteByMutation = !((clause.IsPrimaryKey && clause.Operator != "=") || !clause.IsPrimaryKey)
}
}
if len(variableColumns) > 0 {
// Get column metadata for variable fields
deleteQueryMetadata.VariableMetadata, err = c.proxy.tableConfig.GetMetadataForColumns(deleteQueryMetadata.Table, variableColumns)
if err != nil {
c.proxy.logger.Error(metadataFetchError, zap.String(Query, msg.Query), zap.Error(err))
c.sender.Send(raw.Header, &message.ConfigError{ErrorMessage: err.Error()})
return nil, nil, err
}
}
// Modify type to list type as being used with in operator
for _, columnMeta := range deleteQueryMetadata.VariableMetadata {
if utilities.KeyExistsInList(columnMeta.Name, columnsWithInOp) {
columnMeta.Type = datatype.NewListType(columnMeta.Type)
}
}
deleteQueryMetadata.ReturnMetadata, err = c.proxy.tableConfig.GetMetadataForColumns(deleteQueryMetadata.Table, returnColumns)
if err != nil {
c.sender.Send(raw.Header, &message.ConfigError{ErrorMessage: err.Error()})
return nil, nil, err
}
// Caching Query info
c.AddQueryToCache(id, deleteQueryMetadata)
return deleteQueryMetadata.ReturnMetadata, deleteQueryMetadata.VariableMetadata, err
}
// function to handle and insert query of prepared type
func (c *client) prepareInsertType(raw *frame.RawFrame, msg *message.Prepare, id [16]byte) ([]*message.ColumnMetadata, []*message.ColumnMetadata, error) {
var returnColumns []string
insertQueryMetadata, err := c.proxy.translator.ToSpannerUpsert(c.keyspace, msg.Query)
if err != nil {
c.proxy.logger.Error(translatorErrorMessage, zap.String(Query, msg.Query), zap.Error(err))
c.sender.Send(raw.Header, &message.Invalid{ErrorMessage: err.Error()})
return nil, nil, err
}
insertQueryMetadata.VariableMetadata, err = c.proxy.tableConfig.GetMetadataForColumns(insertQueryMetadata.Table, insertQueryMetadata.ParamKeys)
if err != nil {
c.proxy.logger.Error(metadataFetchError, zap.String(Query, msg.Query), zap.Error(err))
c.sender.Send(raw.Header, &message.ConfigError{ErrorMessage: err.Error()})
return nil, nil, err
}
insertQueryMetadata.ReturnMetadata, err = c.proxy.tableConfig.GetMetadataForColumns(insertQueryMetadata.Table, returnColumns)
if err != nil {
c.proxy.logger.Error("error getting column metadata", zap.Error(err))
c.sender.Send(raw.Header, &message.ConfigError{ErrorMessage: err.Error()})
return nil, nil, err
}
// Caching pre-calculated values
c.AddQueryToCache(id, insertQueryMetadata)
return insertQueryMetadata.ReturnMetadata, insertQueryMetadata.VariableMetadata, err
}
// function to handle and select query of prepared type
func (c *client) prepareSelectType(raw *frame.RawFrame, msg *message.Prepare, id [16]byte) ([]*message.ColumnMetadata, []*message.ColumnMetadata, error) {
var variableColumns, columnsWithInOp []string
queryMetadata, err := c.proxy.translator.ToSpannerSelect(c.keyspace, msg.Query, false)
if err != nil {
c.proxy.logger.Error(translatorErrorMessage, zap.String(Query, msg.Query), zap.Error(err))
c.sender.Send(raw.Header, &message.Invalid{ErrorMessage: err.Error()})
return nil, nil, err
}
// Get Column metadata for the table or selected field
queryMetadata.ReturnMetadata, err = c.proxy.tableConfig.GetMetadataForSelectedColumns(queryMetadata.Table, queryMetadata.ColumnMeta.Column, queryMetadata.AliasMap)
if err != nil {
c.proxy.logger.Error(metadataFetchError, zap.String(Query, msg.Query), zap.Error(err))
c.sender.Send(raw.Header, &message.ConfigError{ErrorMessage: err.Error()})
return nil, nil, err
}
// Capturing variable columns name assuming all columns are parameterized
for _, clause := range queryMetadata.Clauses {
variableColumns = append(variableColumns, clause.Column)
if clause.Operator == "IN" {
columnsWithInOp = append(columnsWithInOp, clause.Column)
}
}
if utilities.KeyExistsInList(limitValue, queryMetadata.ParamKeys) {
variableColumns = append(variableColumns, limitValue)
}
c.proxy.logger.Debug("Prepare Select Query ", zap.Strings("variableColumns", variableColumns))
if len(variableColumns) > 0 {
// Get column metadata for variable fields
queryMetadata.VariableMetadata, err = c.proxy.tableConfig.GetMetadataForColumns(queryMetadata.Table, variableColumns)
if err != nil {
c.sender.Send(raw.Header, &message.ConfigError{ErrorMessage: err.Error()})
c.proxy.logger.Error(metadataFetchError, zap.String(Query, msg.Query), zap.Error(err))
return nil, nil, err
}
}
// Modify type to list type as being used with in operator
for _, columnMeta := range queryMetadata.VariableMetadata {
if utilities.KeyExistsInList(columnMeta.Name, columnsWithInOp) {
columnMeta.Type = datatype.NewListType(columnMeta.Type)
}
}
// Caching Query info
c.AddQueryToCache(id, queryMetadata)
return queryMetadata.ReturnMetadata, queryMetadata.VariableMetadata, err
}
// function to handle update query of prepared type
func (c *client) prepareUpdateType(raw *frame.RawFrame, msg *message.Prepare, id [16]byte) ([]*message.ColumnMetadata, []*message.ColumnMetadata, error) {
var returnColumns, variableColumns, columnsWithInOp []string
updateQueryMetadata, err := c.proxy.translator.ToSpannerUpdate(c.keyspace, msg.Query, false)
if err != nil {
c.proxy.logger.Error(translatorErrorMessage, zap.String(Query, msg.Query), zap.Error(err))
c.sender.Send(raw.Header, &message.Invalid{ErrorMessage: err.Error()})
return nil, nil, err
}
// capturing variable columns name assuming all columns are parameterized
for _, sets := range updateQueryMetadata.UpdateSetValues {
if sets.Value == commitTsFn {
continue
}
variableColumns = append(variableColumns, sets.Column)
}
// Capturing variable columns name assuming all columns are parameterized
for _, clause := range updateQueryMetadata.Clauses {
if ts_column == clause.Column {
continue
}
variableColumns = append(variableColumns, clause.Column)
if clause.Operator == "IN" {
columnsWithInOp = append(columnsWithInOp, clause.Column)
}
}
if len(variableColumns) > 0 {
// Get column metadata for variable fields
updateQueryMetadata.VariableMetadata, err = c.proxy.tableConfig.GetMetadataForColumns(updateQueryMetadata.Table, variableColumns)
if err != nil {
c.proxy.logger.Error(metadataFetchError, zap.String(Query, msg.Query), zap.Error(err))
c.sender.Send(raw.Header, &message.ConfigError{ErrorMessage: err.Error()})
return nil, nil, err
}
if updateQueryMetadata.SelectQueryMapUpdate != "" {
for index, column := range updateQueryMetadata.VariableMetadata {
if column.Name == updateQueryMetadata.MapUpdateColumn {
updateQueryMetadata.VariableMetadata[index].Type = datatype.Varchar
}
}
}
}
// Modify type to list type as being used with in operator
for _, columnMeta := range updateQueryMetadata.VariableMetadata {
if utilities.KeyExistsInList(columnMeta.Name, columnsWithInOp) {
columnMeta.Type = datatype.NewListType(columnMeta.Type)
}
}
updateQueryMetadata.ReturnMetadata, err = c.proxy.tableConfig.GetMetadataForColumns(updateQueryMetadata.Table, returnColumns)
if err != nil {
c.sender.Send(raw.Header, &message.ConfigError{ErrorMessage: err.Error()})
c.proxy.logger.Error(metadataFetchError, zap.String(Query, msg.Query), zap.Error(err))
return nil, nil, err
}
// Caching Query info
c.AddQueryToCache(id, updateQueryMetadata)
return updateQueryMetadata.ReturnMetadata, updateQueryMetadata.VariableMetadata, err
}
// handleExecute for prepared query
func (c *client) handleExecute(raw *frame.RawFrame, msg *partialExecute, executeOptions utilities.ExecuteOptions) {
ctx := context.Background()