Skip to content
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

Jump to bottom

VTGate StreamExecute rpc to return session as response #13131

Merged
merged 8 commits into from
May 30, 2023
Merged

VTGate StreamExecute rpc to return session as response #13131

merged 8 commits into from
May 30, 2023

Conversation

harshit-gangal
Copy link
Member

@harshit-gangal harshit-gangal commented May 23, 2023 •
edited
Loading

Description

This PR fixes the issue with StreamExecute VTGate RPC response. It adds the VTGate Session to the response.
This fixes all the side effects caused by not returning the modified session.

The Session is sent as the last message on the stream after all the Query Results are sent. So, the last stream message will have QueryResult as nil and Session as not nil.
Any error that happened during the query phase will be sent only after sending the Session.

Note: This is not an issue if MySQL clients are used to connect to VTGate.

Related Issue(s)

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

Deployment Notes

@harshit-gangal
VTGate StreamExecute rpc to return session as response
44f826f 
Signed-off-by: Harshit Gangal <harshit@planetscale.com>
@vitess-bot vitess-bot bot added NeedsDescriptionUpdate The description is not clear or comprehensive enough, and needs work NeedsIssue A linked issue is missing for this Pull Request NeedsWebsiteDocsUpdate What it says labels May 23, 2023
@vitess-bot
Copy link
Contributor

vitess-bot bot commented May 23, 2023 •
edited by GuptaManan100
Loading

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 May 23, 2023
@harshit-gangal harshit-gangal added Type: Bug and removed NeedsDescriptionUpdate The description is not clear or comprehensive enough, and needs work NeedsWebsiteDocsUpdate What it says NeedsIssue A linked issue is missing for this Pull Request labels May 23, 2023
@harshit-gangal
update go driver to store session returned in stream execute response
b6f1779 
Signed-off-by: Harshit Gangal <harshit@planetscale.com>
@harshit-gangal harshit-gangal marked this pull request as ready for review May 24, 2023 15:06
maxenglander
maxenglander reviewed May 25, 2023
View reviewed changes
go/vt/vtgate/vtgateconn/vtgateconn.go Outdated
@@ -144,7 +144,11 @@ func (sn *VTGateSession) StreamExecute(ctx context.Context, query string, bindVa
// StreamExecute is only used for SELECT queries that don't change
Copy link
Collaborator

Choose a reason for hiding this comment

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

Is this still true?

Copy link
Member Author

Choose a reason for hiding this comment

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

	// StreamExecute is only used for SELECT queries that don't change
	// the session. So, the protocol doesn't return an updated session.
	// This may change in the future.

For sure it has changed and this is the future :)

@harshit-gangal
added driver test and updated vtgate interface api to return session …
e414d99 
…on StreamExecute

Signed-off-by: Harshit Gangal <harshit@planetscale.com>
@harshit-gangal
fix: fill in status flags for stream execute calls as well
6c004b3 
Signed-off-by: Harshit Gangal <harshit@planetscale.com>
@harshit-gangal harshit-gangal requested a review from ajm188 as a code owner May 25, 2023 03:56
@harshit-gangal
added e2e test for grpc api for stream and non-stream for transaction
5203b73 
Signed-off-by: Harshit Gangal <harshit@planetscale.com>
@harshit-gangal harshit-gangal added the release notes (needs details) This PR needs to be listed in the release notes in a dedicated section (deprecation notice, etc...) label May 25, 2023
@harshit-gangal
added release notes
e6105c4 
Signed-off-by: Harshit Gangal <harshit@planetscale.com>
@harshit-gangal harshit-gangal removed the release notes (needs details) This PR needs to be listed in the release notes in a dedicated section (deprecation notice, etc...) label May 26, 2023
@harshit-gangal
addressed review comments
c6935e1 
Signed-off-by: Harshit Gangal <harshit@planetscale.com>
@harshit-gangal
Merge remote-tracking branch 'upstream/main' into streamexec-session
b1c3410 
Signed-off-by: Harshit Gangal <harshit@planetscale.com>
@harshit-gangal harshit-gangal mentioned this pull request May 30, 2023
Closed
42 tasks
GuptaManan100
GuptaManan100 approved these changes May 30, 2023
View reviewed changes
Copy link
Member

@GuptaManan100 GuptaManan100 left a comment

Choose a reason for hiding this comment

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

LGTM

@harshit-gangal harshit-gangal merged commit 2c678fb into vitessio:main May 30, 2023
@harshit-gangal harshit-gangal deleted the streamexec-session branch May 30, 2023 11:19
@harshit-gangal harshit-gangal mentioned this pull request Sep 20, 2023
Merged
4 tasks
@mattrobenolt mattrobenolt mentioned this pull request Jan 27, 2024
Merged
mattrobenolt added a commit to planetscale/psdbproxy that referenced this pull request Jan 29, 2024
@mattrobenolt
Prepare to handle streaming responses that contain session only rows (#…
218caf0 
…15)

This is to accommodate the breaking API change from:

vitessio/vitess#13131

Currently PlanetScale explicitly ignores these results so it doesn't
break clients, so this is pre-emptively support the new rows.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@systay systay systay left review comments

@maxenglander maxenglander maxenglander left review comments

@GuptaManan100 GuptaManan100 GuptaManan100 approved these changes

@frouioui frouioui frouioui approved these changes

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

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

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

@rohit-nayak-ps rohit-nayak-ps Awaiting requested review from rohit-nayak-ps rohit-nayak-ps is a code owner

Assignees
No one assigned
Labels
Component: Query Serving Type: Bug
Projects
None yet
Milestone
v17.0.0
Development

Successfully merging this pull request may close these issues.

VTGate StreamExecute grpc api does not support transactions
5 participants
@harshit-gangal @maxenglander @systay @frouioui @GuptaManan100