Skip to content

json: Fix JSON SQL serialization and ensure to run tests#12861

Merged
frouioui merged 1 commit intovitessio:mainfrom
dbussink:cleanup-and-fix-json-serialization
Apr 11, 2023
Merged

json: Fix JSON SQL serialization and ensure to run tests#12861
frouioui merged 1 commit intovitessio:mainfrom
dbussink:cleanup-and-fix-json-serialization

Conversation

@dbussink
Copy link
Copy Markdown
Member

@dbussink dbussink commented Apr 7, 2023 •
edited
Loading

There was a bug in the JSON SQL serialization. It would directly serialize a raw JSON string which is wrong, we need to serialize the decoded string into an SQL string instead.

The tests didn't expose this since they didn't actually run. This removes the checks since all versions we run these tests against now support JSON.

Lastly it also updates the comparison in the tests to use jsondiff which provides far superior output on failures and allows us to remove the ajson dependency entirely. We also remove the old binlog json parser.

Related Issue(s)

This was broken since #12761

Checklist

  • "Backport to:" labels have been added if this change should be back-ported
  • Tests were added or are not required
  • Did the new or modified tests pass consistently locally and on the CI
  • Documentation was added or is not required

@dbussink
json: Fix JSON SQL serialization and ensure to run tests
1f864ee 
There was a bug in the JSON SQL serialization. It would directly
serialize a raw JSON string which is wrong, we need to serialize the
decoded string into an SQL string instead.

The tests didn't expose this since they didn't actually run. This
removes the checks since all versions we run these tests against now
support JSON.

Lastly it also updates the comparison in the tests to use jsondiff which
provides far superior output on failures and allows us to remove the
ajson dependency entirely. We also remove the old binlog json parser.

Signed-off-by: Dirkjan Bussink <d.bussink@gmail.com>
@vitess-bot vitess-bot bot added NeedsDescriptionUpdate The description is not clear or comprehensive enough, and needs work NeedsWebsiteDocsUpdate What it says labels Apr 7, 2023
@vitess-bot
Copy link
Copy Markdown
Contributor

vitess-bot bot commented Apr 7, 2023

Review Checklist

Hello reviewers! 👋 Please follow this checklist when reviewing this Pull Request.

General

  • Ensure that the Pull Request has a descriptive title.
  • If this is a change that users need to know about, please apply the release notes (needs details) label so that merging is blocked unless the summary release notes document is included.
  • If a test is added or modified, there should be a documentation on top of the test to explain what the expected behavior is what the test does.

If a new flag is being introduced:

  • Is it really necessary to add this flag?
  • Flag names should be clear and intuitive (as far as possible)
  • Help text should be descriptive.
  • Flag names should use dashes (-) as word separators rather than underscores (_).

If a workflow is added or modified:

  • Each item in Jobs should be named in order to mark it as required.
  • If the workflow should be required, the maintainer team should be notified.

Bug fixes

  • There should be at least one unit or end-to-end test.
  • The Pull Request description should include a link to an issue that describes the bug.

Non-trivial changes

  • There should be some code comments as to why things are implemented the way they are.

New/Existing features

  • Should be documented, either by modifying the existing documentation or creating new documentation.
  • New features should have a link to a feature request issue or an RFC that documents the use cases, corner cases and test cases.

Backward compatibility

  • Protobuf changes should be wire-compatible.
  • Changes to _vt tables and RPCs need to be backward compatible.
  • vtctl command output order should be stable and awk-able.
  • RPC changes should be compatible with vitess-operator
  • If a flag is removed, then it should also be removed from VTop, if used there.

@github-actions github-actions bot added this to the v17.0.0 milestone Apr 7, 2023
dbussink
dbussink commented Apr 7, 2023
View reviewed changes
go/mysql/json/marshal.go

func (v *Value) marshalSQLInternal(top bool, dst []byte) []byte {
switch v.t {
switch v.Type() {
Copy link
Copy Markdown
Member Author

@dbussink dbussink Apr 7, 2023

Choose a reason for hiding this comment

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

This ensures we never see a typeRawString but always a properly decoded TypeString.

go/vt/vttablet/tabletmanager/vreplication/vplayer_flaky_test.go
skipTest := true
flavors := []string{"mysql80", "mysql57"}
for _, flavor := range flavors {
if strings.EqualFold(env.Flavor, flavor) {
Copy link
Copy Markdown
Member Author

@dbussink dbussink Apr 7, 2023

Choose a reason for hiding this comment

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

env.Flavor contains the GTID flavor which is always MySQL56 and never any of the values we check against. So we were never running these tests.

go/vt/vttablet/tabletmanager/vreplication/vplayer_flaky_test.go
compare, s := jsondiff.Compare(qr.Rows[i][1].Raw(), []byte(row[1]), &opts)
if compare != jsondiff.FullMatch {
t.Errorf("Diff:\n%s\n", s)
}
Copy link
Copy Markdown
Member Author

@dbussink dbussink Apr 7, 2023

Choose a reason for hiding this comment

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

This gives us a far more superior error format when it fails and makes it much easier to debug what is going on.

@dbussink dbussink added Type: Bug Component: VReplication Component: Evalengine changes to the evaluation engine and removed NeedsDescriptionUpdate The description is not clear or comprehensive enough, and needs work NeedsWebsiteDocsUpdate What it says labels Apr 7, 2023
@dbussink
Copy link
Copy Markdown
Member Author

dbussink commented Apr 7, 2023

Without the marshalling fix it shows an error like:

                   "_id": "5f882c8520a784500e49119e",
                    "about": "Et sunt sunt deserunt ad do irure do amet elit cillum id commodo. Quis voluptate excepteur id ea. Sunt enim id irure reprehenderit mollit nostrud ea qui non culpa aute.\\r\\n" => "Et sunt sunt deserunt ad do irure do amet elit cillum id commodo. Quis voluptate excepteur id ea. Sunt enim id irure reprehenderit mollit nostrud ea qui non culpa aute.\r\n",
                    "address": "196 Madison Street, Woodruff, Virgin Islands, 5496",

You can see here that things like \n end up double encoded as \\n since we don't decode the raw JSON string. These tests pass after the marshalling fix.

@dbussink dbussink mentioned this pull request Apr 7, 2023
Merged
4 tasks
@dbussink
Copy link
Copy Markdown
Member Author

dbussink commented Apr 7, 2023

@rohit-nayak-ps @mattlord @shlomi-noach The issues with these tests not running also made me dig in and there's a bunch more cases where tests are not actually running. Those are for other JSON related tests but also for generated columns tests. Those latter tests seem broken though, or maybe vreplication has been long broken for these worst case.

I have opened a draft PR that showcases this (it's on top of the fixes here) in #12862

rohit-nayak-ps
rohit-nayak-ps approved these changes Apr 7, 2023
View reviewed changes
Copy link
Copy Markdown
Member

@rohit-nayak-ps rohit-nayak-ps left a comment •
edited
Loading

Choose a reason for hiding this comment

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

Oops, thanks for catching and fixing this early!

I confirmed locally that, by adding "first line\\r\\nsecond line\\rline with escapes\\\\ \\r\\n" to the e2e json test cases, it fails before this PR and succeeds on this PR. (will add this in #12862)

@dbussink
Copy link
Copy Markdown
Member Author

dbussink commented Apr 7, 2023

I confirmed locally that, by adding "first line\\r\\nsecond line\\rline with escapes\\\\ \\r\\n" to the e2e json test cases, it fails before this PR and succeeds on this PR. (will add this in #12862)

@rohit-nayak-ps Don't think that's needed? Since the test fixes here in this PR already uncover it? So we already have tests that cover this escaping? We can add more though but don't think it's strictly needed.

@rohit-nayak-ps
Copy link
Copy Markdown
Member

rohit-nayak-ps commented Apr 8, 2023

@rohit-nayak-ps Don't think that's needed? Since the test fixes here in this PR already uncover it? So we already have tests that cover this escaping? We can add more though but don't think it's strictly needed.

I agree that it is already tested, so this is general paranoia I guess, borne out by the issue you found of unit tests not running!

@frouioui frouioui merged commit 556a007 into vitessio:main Apr 11, 2023
@dbussink dbussink deleted the cleanup-and-fix-json-serialization branch April 11, 2023 07:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@frouioui frouioui frouioui approved these changes

@rohit-nayak-ps rohit-nayak-ps rohit-nayak-ps approved these changes

@mattlord mattlord Awaiting requested review from mattlord mattlord is a code owner

@harshit-gangal harshit-gangal Awaiting requested review from harshit-gangal harshit-gangal is a code owner

@systay systay Awaiting requested review from systay systay is a code owner

@ajm188 ajm188 Awaiting requested review from ajm188

@deepthi deepthi Awaiting requested review from deepthi

Assignees

No one assigned

Labels

Component: Evalengine changes to the evaluation engine Component: VReplication Type: Bug

Projects

None yet

Milestone

v17.0.0

Development

Successfully merging this pull request may close these issues.

3 participants

@dbussink @rohit-nayak-ps @frouioui