Skip to content

Commit

Permalink
fix: route engine to handle column truncation for execute after lookup (
Browse files Browse the repository at this point in the history
#16981)

Signed-off-by: Harshit Gangal <harshit@planetscale.com>
  • Loading branch information
harshit-gangal committed Oct 17, 2024
1 parent b7adf46 commit c8697f8
Show file tree
Hide file tree
Showing 2 changed files with 146 additions and 20 deletions.
31 changes: 11 additions & 20 deletions go/vt/vtgate/engine/route.go
Original file line number Diff line number Diff line change
Expand Up @@ -166,11 +166,12 @@ func (route *Route) SetTruncateColumnCount(count int) {
func (route *Route) TryExecute(ctx context.Context, vcursor VCursor, bindVars map[string]*querypb.BindVariable, wantfields bool) (*sqltypes.Result, error) {
ctx, cancelFunc := addQueryTimeout(ctx, vcursor, route.QueryTimeout)
defer cancelFunc()
qr, err := route.executeInternal(ctx, vcursor, bindVars, wantfields)
rss, bvs, err := route.findRoute(ctx, vcursor, bindVars)
if err != nil {
return nil, err
}
return qr.Truncate(route.TruncateColumnCount), nil

return route.executeShards(ctx, vcursor, bindVars, wantfields, rss, bvs)
}

// addQueryTimeout adds a query timeout to the context it receives and returns the modified context along with the cancel function.
Expand All @@ -188,20 +189,6 @@ const (
IgnoreReserveTxn cxtKey = iota
)

func (route *Route) executeInternal(
ctx context.Context,
vcursor VCursor,
bindVars map[string]*querypb.BindVariable,
wantfields bool,
) (*sqltypes.Result, error) {
rss, bvs, err := route.findRoute(ctx, vcursor, bindVars)
if err != nil {
return nil, err
}

return route.executeShards(ctx, vcursor, bindVars, wantfields, rss, bvs)
}

func (route *Route) executeShards(
ctx context.Context,
vcursor VCursor,
Expand Down Expand Up @@ -255,11 +242,15 @@ func (route *Route) executeShards(
}
}

if len(route.OrderBy) == 0 {
return result, nil
if len(route.OrderBy) != 0 {
var err error
result, err = route.sort(result)
if err != nil {
return nil, err
}
}

return route.sort(result)
return result.Truncate(route.TruncateColumnCount), nil
}

func filterOutNilErrors(errs []error) []error {
Expand Down Expand Up @@ -441,7 +432,7 @@ func (route *Route) sort(in *sqltypes.Result) (*sqltypes.Result, error) {
return 0
})

return out.Truncate(route.TruncateColumnCount), err
return out, err
}

func (route *Route) description() PrimitiveDescription {
Expand Down
135 changes: 135 additions & 0 deletions go/vt/vtgate/engine/vindex_lookup_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,135 @@
/*
Copyright 2024 The Vitess Authors.
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 engine

import (
"context"
"testing"

"github.com/stretchr/testify/require"

"vitess.io/vitess/go/sqltypes"
querypb "vitess.io/vitess/go/vt/proto/query"
"vitess.io/vitess/go/vt/vtgate/evalengine"
"vitess.io/vitess/go/vt/vtgate/vindexes"
)

var (
vindex, _ = vindexes.CreateVindex("lookup_unique", "", map[string]string{
"table": "lkp",
"from": "from",
"to": "toc",
"write_only": "true",
})
ks = &vindexes.Keyspace{Name: "ks", Sharded: true}
)

func TestVindexLookup(t *testing.T) {
planableVindex, ok := vindex.(vindexes.LookupPlanable)
require.True(t, ok, "not a lookup vindex")
_, args := planableVindex.Query()

fp := &fakePrimitive{
results: []*sqltypes.Result{
sqltypes.MakeTestResult(
sqltypes.MakeTestFields("id|keyspace_id", "int64|varbinary"),
"1|\x10"),
},
}
route := NewRoute(ByDestination, ks, "dummy_select", "dummy_select_field")
vdxLookup := &VindexLookup{
Opcode: EqualUnique,
Keyspace: ks,
Vindex: planableVindex,
Arguments: args,
Values: []evalengine.Expr{evalengine.NewLiteralInt(1)},
Lookup: fp,
SendTo: route,
}

vc := &loggingVCursor{results: []*sqltypes.Result{defaultSelectResult}}

result, err := vdxLookup.TryExecute(context.Background(), vc, map[string]*querypb.BindVariable{}, false)
require.NoError(t, err)
fp.ExpectLog(t, []string{`Execute from: type:TUPLE values:{type:INT64 value:"1"} false`})
vc.ExpectLog(t, []string{
`ResolveDestinations ks [type:INT64 value:"1"] Destinations:DestinationKeyspaceID(10)`,
`ExecuteMultiShard ks.-20: dummy_select {} false false`,
})
expectResult(t, result, defaultSelectResult)

Check failure on line 73 in go/vt/vtgate/engine/vindex_lookup_test.go

View workflow job for this annotation

GitHub Actions / Static Code Checks Etc

not enough arguments in call to expectResult

Check failure on line 73 in go/vt/vtgate/engine/vindex_lookup_test.go

View workflow job for this annotation

GitHub Actions / Unit Test (mysql57)

not enough arguments in call to expectResult

fp.rewind()
vc.Rewind()
result, err = wrapStreamExecute(vdxLookup, vc, map[string]*querypb.BindVariable{}, false)
require.NoError(t, err)
vc.ExpectLog(t, []string{
`ResolveDestinations ks [type:INT64 value:"1"] Destinations:DestinationKeyspaceID(10)`,
`StreamExecuteMulti dummy_select ks.-20: {} `,
})
expectResult(t, result, defaultSelectResult)

Check failure on line 83 in go/vt/vtgate/engine/vindex_lookup_test.go

View workflow job for this annotation

GitHub Actions / Static Code Checks Etc

not enough arguments in call to expectResult

Check failure on line 83 in go/vt/vtgate/engine/vindex_lookup_test.go

View workflow job for this annotation

GitHub Actions / Unit Test (mysql57)

not enough arguments in call to expectResult
}

func TestVindexLookupTruncate(t *testing.T) {
planableVindex, ok := vindex.(vindexes.LookupPlanable)
require.True(t, ok, "not a lookup vindex")
_, args := planableVindex.Query()

fp := &fakePrimitive{
results: []*sqltypes.Result{
sqltypes.MakeTestResult(
sqltypes.MakeTestFields("id|keyspace_id", "int64|varbinary"),
"1|\x10"),
},
}
route := NewRoute(ByDestination, ks, "dummy_select", "dummy_select_field")
route.TruncateColumnCount = 1
vdxLookup := &VindexLookup{
Opcode: EqualUnique,
Keyspace: ks,
Vindex: planableVindex,
Arguments: args,
Values: []evalengine.Expr{evalengine.NewLiteralInt(1)},
Lookup: fp,
SendTo: route,
}

vc := &loggingVCursor{results: []*sqltypes.Result{
sqltypes.MakeTestResult(sqltypes.MakeTestFields("name|morecol", "varchar|int64"),
"foo|1", "bar|2", "baz|3"),
}}

wantRes := sqltypes.MakeTestResult(sqltypes.MakeTestFields("name", "varchar"),
"foo", "bar", "baz")
result, err := vdxLookup.TryExecute(context.Background(), vc, map[string]*querypb.BindVariable{}, false)
require.NoError(t, err)
fp.ExpectLog(t, []string{`Execute from: type:TUPLE values:{type:INT64 value:"1"} false`})
vc.ExpectLog(t, []string{
`ResolveDestinations ks [type:INT64 value:"1"] Destinations:DestinationKeyspaceID(10)`,
`ExecuteMultiShard ks.-20: dummy_select {} false false`,
})
expectResult(t, result, wantRes)

Check failure on line 124 in go/vt/vtgate/engine/vindex_lookup_test.go

View workflow job for this annotation

GitHub Actions / Static Code Checks Etc

not enough arguments in call to expectResult

Check failure on line 124 in go/vt/vtgate/engine/vindex_lookup_test.go

View workflow job for this annotation

GitHub Actions / Unit Test (mysql57)

not enough arguments in call to expectResult

fp.rewind()
vc.Rewind()
result, err = wrapStreamExecute(vdxLookup, vc, map[string]*querypb.BindVariable{}, false)
require.NoError(t, err)
vc.ExpectLog(t, []string{
`ResolveDestinations ks [type:INT64 value:"1"] Destinations:DestinationKeyspaceID(10)`,
`StreamExecuteMulti dummy_select ks.-20: {} `,
})
expectResult(t, result, wantRes)

Check failure on line 134 in go/vt/vtgate/engine/vindex_lookup_test.go

View workflow job for this annotation

GitHub Actions / Static Code Checks Etc

not enough arguments in call to expectResult

Check failure on line 134 in go/vt/vtgate/engine/vindex_lookup_test.go

View workflow job for this annotation

GitHub Actions / Unit Test (mysql57)

not enough arguments in call to expectResult
}

0 comments on commit c8697f8

Please sign in to comment.