Skip to content

evalengine: Fix NULL document handling in JSON functions #19052

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
arthurschreiber wants to merge 2 commits into
base: main
Choose a base branch
from
+54 −44
Open

evalengine: Fix NULL document handling in JSON functions #19052

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
76a3ea0
evalengine: Fix `NULL` document handling in JSON functions
arthurschreiber Dec 17, 2025
28c3c93
Be more explicit about the compilation result type for null input type.
arthurschreiber Jan 15, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions go/vt/vtgate/evalengine/compiler.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -585,6 +585,8 @@ func (c *compiler) compileParseJSON(fn string, doct ctype, offset int) (ctype, e
case sqltypes.TypeJSON:
case sqltypes.VarChar, sqltypes.VarBinary:
c.asm.Parse_j(offset)
case sqltypes.Null:
return ctype{Type: sqltypes.Null, Flag: flagNull | flagNullable, Col: collationNull}, nil
default:
return ctype{}, errJSONType(fn)
}
Expand Down
9 changes: 9 additions & 0 deletions go/vt/vtgate/evalengine/compiler_asm.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2319,6 +2319,15 @@ func (asm *assembler) Fn_JSON_KEYS(jp *json.Path) {
return 1
}, "FN JSON_KEYS (SP-1)")
} else {
if jp.ContainsWildcards() {
asm.emit(func(env *ExpressionEnv) int {
env.vm.err = errInvalidPathForTransform
return 1
}, "FN JSON_KEYS (SP-1), %q", jp.String())

return
}

asm.emit(func(env *ExpressionEnv) int {
doc := env.vm.stack[env.vm.sp-1]
if doc == nil {
Expand Down
49 changes: 21 additions & 28 deletions go/vt/vtgate/evalengine/fn_json.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -134,16 +134,9 @@ func (call *builtinJSONExtract) compile(c *compiler) (ctype, error) {
nullable := doct.nullable()
skip := c.compileNullCheck1(doct)

// TODO: `*compiler.compileParseJSON` should handle `sqltypes.Null`` properly but
// we'll handle it here until all call sites are fixed.
var jt ctype
if doct.Type != sqltypes.Null {
jt, err = c.compileParseJSON("JSON_EXTRACT", doct, 1)
if err != nil {
return ctype{}, err
}
} else {
jt = ctype{Type: sqltypes.Null, Flag: flagNull | flagNullable, Col: collationNull}
jt, err := c.compileParseJSON("JSON_EXTRACT", doct, 1)
if err != nil {
return ctype{}, err
}

staticPaths := make([]staticPath, 0, len(call.Arguments[1:]))
Expand Down Expand Up @@ -232,16 +225,9 @@ func (call *builtinJSONRemove) compile(c *compiler) (ctype, error) {
nullable := doct.nullable()
skip := c.compileNullCheck1(doct)

// TODO: `*compiler.compileParseJSON` should handle `sqltypes.Null`` properly but
// we'll handle it here until all call sites are fixed.
var jt ctype
if doct.Type != sqltypes.Null {
jt, err = c.compileParseJSON("JSON_REMOVE", doct, 1)
if err != nil {
return ctype{}, err
}
} else {
jt = ctype{Type: sqltypes.Null, Flag: flagNull | flagNullable, Col: collationNull}
jt, err := c.compileParseJSON("JSON_REMOVE", doct, 1)
if err != nil {
return ctype{}, err
}

staticPaths := make([]staticPath, 0, len(call.Arguments[1:]))
Expand Down Expand Up @@ -513,6 +499,13 @@ func (call *builtinJSONContainsPath) compile(c *compiler) (ctype, error) {
return ctype{}, c.unsupported(call)
}

skip := c.compileNullCheck1(doct)

_, err = c.compileParseJSON("JSON_CONTAINS_PATH", doct, 1)
if err != nil {
return ctype{}, err
}

match, err := c.jsonExtractOneOrAll("JSON_CONTAINS_PATH", call.Arguments[1])
if err != nil {
return ctype{}, err
Expand All @@ -528,12 +521,10 @@ func (call *builtinJSONContainsPath) compile(c *compiler) (ctype, error) {
paths = append(paths, jp)
}

_, err = c.compileParseJSON("JSON_CONTAINS_PATH", doct, 1)
if err != nil {
return ctype{}, err
}

c.asm.Fn_JSON_CONTAINS_PATH(match, paths)

c.asm.jumpDestination(skip)

return ctype{Type: sqltypes.Int64, Col: collationNumeric, Flag: flagIsBoolean | flagNullable}, nil
}

Expand Down Expand Up @@ -624,6 +615,8 @@ func (call *builtinJSONKeys) compile(c *compiler) (ctype, error) {
return ctype{}, err
}

skip := c.compileNullCheck1(doc)

_, err = c.compileParseJSON("JSON_KEYS", doc, 1)
if err != nil {
return ctype{}, err
Expand All @@ -635,11 +628,11 @@ func (call *builtinJSONKeys) compile(c *compiler) (ctype, error) {
if err != nil {
return ctype{}, err
}
if jp.ContainsWildcards() {
return ctype{}, errInvalidPathForTransform
}
Comment on lines -638 to -640
Copy link
Member Author

@arthurschreiber arthurschreiber Dec 17, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This needed to be moved from here into the Fn_JSON_KEYS function to ensure the error here is only raised by JSON_KEYS in case the document is not-NULL. To do this, I moved the error handling into the compiled output.

}

c.asm.Fn_JSON_KEYS(jp)

c.asm.jumpDestination(skip)

return ctype{Type: sqltypes.TypeJSON, Flag: flagNullable, Col: collationJSON}, nil
}
23 changes: 14 additions & 9 deletions go/vt/vtgate/evalengine/testcases/cases.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ var Cases = []TestCase{
{Run: FnJSONExtract},
{Run: FnJSONRemove},
{Run: FnJSONContainsPath},
{Run: FnJSONUnquote},
{Run: JSONArray},
{Run: JSONObject},
{Run: CharsetConversionOperators},
Expand Down Expand Up @@ -181,21 +182,21 @@ var Cases = []TestCase{

func FnJSONKeys(yield Query) {
for _, obj := range inputJSONObjects {
yield(fmt.Sprintf("JSON_KEYS('%s')", obj), nil, false)
yield(fmt.Sprintf("JSON_KEYS(%s)", obj), nil, false)

for _, path1 := range inputJSONPaths {
yield(fmt.Sprintf("JSON_KEYS('%s', '%s')", obj, path1), nil, false)
yield(fmt.Sprintf("JSON_KEYS(%s, '%s')", obj, path1), nil, false)
}
}
}

func FnJSONExtract(yield Query) {
for _, obj := range inputJSONObjects {
for _, path1 := range inputJSONPaths {
yield(fmt.Sprintf("JSON_EXTRACT('%s', '%s')", obj, path1), nil, false)
yield(fmt.Sprintf("JSON_EXTRACT(%s, '%s')", obj, path1), nil, false)

for _, path2 := range inputJSONPaths {
yield(fmt.Sprintf("JSON_EXTRACT('%s', '%s', '%s')", obj, path1, path2), nil, false)
yield(fmt.Sprintf("JSON_EXTRACT(%s, '%s', '%s')", obj, path1, path2), nil, false)
}
}
}
Expand Down Expand Up @@ -236,25 +237,29 @@ func FnJSONExtract(yield Query) {
func FnJSONRemove(yield Query) {
for _, obj := range inputJSONObjects {
for _, path1 := range inputJSONPaths {
yield(fmt.Sprintf("JSON_REMOVE('%s', '%s')", obj, path1), nil, false)
yield(fmt.Sprintf("JSON_REMOVE(%s, '%s')", obj, path1), nil, false)
}
}
}

func FnJSONContainsPath(yield Query) {
for _, obj := range inputJSONObjects {
for _, path1 := range inputJSONPaths {
yield(fmt.Sprintf("JSON_CONTAINS_PATH('%s', 'one', '%s')", obj, path1), nil, false)
yield(fmt.Sprintf("JSON_CONTAINS_PATH('%s', 'all', '%s')", obj, path1), nil, false)
yield(fmt.Sprintf("JSON_CONTAINS_PATH(%s, 'one', '%s')", obj, path1), nil, false)
yield(fmt.Sprintf("JSON_CONTAINS_PATH(%s, 'all', '%s')", obj, path1), nil, false)

for _, path2 := range inputJSONPaths {
yield(fmt.Sprintf("JSON_CONTAINS_PATH('%s', 'one', '%s', '%s')", obj, path1, path2), nil, false)
yield(fmt.Sprintf("JSON_CONTAINS_PATH('%s', 'all', '%s', '%s')", obj, path1, path2), nil, false)
yield(fmt.Sprintf("JSON_CONTAINS_PATH(%s, 'one', '%s', '%s')", obj, path1, path2), nil, false)
yield(fmt.Sprintf("JSON_CONTAINS_PATH(%s, 'all', '%s', '%s')", obj, path1, path2), nil, false)
}
}
}
}

func FnJSONUnquote(yield Query) {
yield("JSON_UNQUOTE(NULL)", nil, false)
}

func JSONArray(yield Query) {
for _, a := range inputJSONPrimitives {
yield(fmt.Sprintf("JSON_ARRAY(%s)", a), nil, false)
Expand Down
15 changes: 8 additions & 7 deletions go/vt/vtgate/evalengine/testcases/inputs.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,13 +24,14 @@ import (
)

var inputJSONObjects = []string{
`[ { "a": 1 }, { "a": 2 } ]`,
`{ "a" : "foo", "b" : [ true, { "c" : 123, "c" : 456 } ] }`,
`{ "a" : "foo", "b" : [ true, { "c" : "123" } ] }`,
`{ "a" : "foo", "b" : [ true, { "c" : 123 } ] }`,
`{"a": 1, "b": 2, "c": {"d": 4}}`,
`["a", {"b": [true, false]}, [10, 20]]`,
`[10, 20, [30, 40]]`,
`'[ { "a": 1 }, { "a": 2 } ]'`,
`'{ "a" : "foo", "b" : [ true, { "c" : 123, "c" : 456 } ] }'`,
`'{ "a" : "foo", "b" : [ true, { "c" : "123" } ] }'`,
`'{ "a" : "foo", "b" : [ true, { "c" : 123 } ] }'`,
`'{"a": 1, "b": 2, "c": {"d": 4}}'`,
`'["a", {"b": [true, false]}, [10, 20]]'`,
`'[10, 20, [30, 40]]'`,
`NULL`,
}

var inputJSONPaths = []string{
Expand Down
Loading