Skip to content

Conversation

@mhamza15
Copy link
Collaborator

Description

#19007 updated the QueryService interface with a new Session interface that contains the session UUID and the existing ExecuteOptions. Since the options parameter was now redundant and can be pulled from the Session directly, it was removed. This caused a lot of unnecessary changes, but also introduced a race condition in scatter_conn.go:

	allErrors := stc.multiGoTransaction(
		// ...
		func(rs *srvtopo.ResolvedShard, i int, info *shardActionInfo) (*shardActionInfo, error) {
			// ...

			// Goroutine A reading session
			if session != nil && session.Session != nil {
				opts = session.Options
			}

			// Goroutine B writing session
			if opts == nil && fetchLastInsertID {
				opts = &querypb.ExecuteOptions{FetchLastInsertId: fetchLastInsertID}
+				session = econtext.NewSafeSession(&vtgatepb.Session{Options: opts})
			}

			// ...
		}
	)

This PR removes GetOptions from the new Session interface and adds back the options parameter to the QueryService interface. This allows each goroutine in that scatter_conn.go logic to keep its own local opts and not overwrite the shared session, reverting the logic to how it was before.

Related Issue(s)

Checklist

  • "Backport to:" labels have been added if this change should be back-ported to release branches
  • If this change is to be back-ported to previous releases, a justification is included in the PR description
  • Tests were added or are not required
  • Did the new or modified tests pass consistently locally and on CI?
  • Documentation was added or is not required

Deployment Notes

AI Disclosure

vitessio#19007 updated the `QueryService`
interface with a new `Session` interface that contains the session UUID
and the existing `ExecuteOptions`. Since the `options` parameter was now
redundant and can be pulled from the `Session` directly, it was removed.
This caused a lot of unnecessary changes, but also introduced a race
condition in `scatter_conn.go`:

```diff
	allErrors := stc.multiGoTransaction(
		// ...
		func(rs *srvtopo.ResolvedShard, i int, info *shardActionInfo) (*shardActionInfo, error) {
			// ...

			// Goroutine A reading session
			if session != nil && session.Session != nil {
				opts = session.Options
			}

			// Goroutine B writing session
			if opts == nil && fetchLastInsertID {
				opts = &querypb.ExecuteOptions{FetchLastInsertId: fetchLastInsertID}
+				session = econtext.NewSafeSession(&vtgatepb.Session{Options: opts})
			}

			// ...
		}
	)
```

This PR removes `GetOptions` from the new `Session` interface and adds
back the `options` parameter to the `QueryService` interface. This
allows each goroutine in that `scatter_conn.go` logic to keep its own
local `opts` and not overwrite the shared `session`, reverting the logic
to how it was before.

Signed-off-by: Mohamed Hamza <[email protected]>
@mhamza15 mhamza15 self-assigned this Dec 23, 2025
@github-actions github-actions bot added this to the v24.0.0 milestone Dec 23, 2025
@vitess-bot vitess-bot bot added NeedsWebsiteDocsUpdate What it says NeedsDescriptionUpdate The description is not clear or comprehensive enough, and needs work NeedsIssue A linked issue is missing for this Pull Request NeedsBackportReason If backport labels have been applied to a PR, a justification is required labels Dec 23, 2025
@vitess-bot
Copy link
Contributor

vitess-bot bot commented Dec 23, 2025

Review Checklist

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

General

  • Ensure that the Pull Request has a descriptive title.
  • Ensure there is a link to an issue (except for internal cleanup and flaky test fixes), new features should have an RFC that documents use cases and test cases.

Tests

  • Bug fixes should have at least one unit or end-to-end test, enhancement and new features should have a sufficient number of tests.

Documentation

  • Apply the release notes (needs details) label if users need to know about this change.
  • New features should be documented.
  • There should be some code comments as to why things are implemented the way they are.
  • There should be a comment at the top of each new or modified test to explain what the test does.

New flags

  • Is this flag really necessary?
  • Flag names must be clear and intuitive, use dashes (-), and have a clear help text.

If a workflow is added or modified:

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

Backward compatibility

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

@mhamza15 mhamza15 added Type: Bug Component: Query Serving 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 NeedsBackportReason If backport labels have been applied to a PR, a justification is required labels Dec 23, 2025
Signed-off-by: Mohamed Hamza <[email protected]>
@codecov
Copy link

codecov bot commented Dec 24, 2025

Codecov Report

❌ Patch coverage is 73.21429% with 45 lines in your changes missing coverage. Please review.
✅ Project coverage is 69.89%. Comparing base (7a3acd5) to head (95086f2).
⚠️ Report is 3 commits behind head on main.

Files with missing lines Patch % Lines
go/vt/vtcombo/tablet_map.go 0.00% 9 Missing ⚠️
go/vt/vttablet/tabletconntest/fakequeryservice.go 66.66% 7 Missing ⚠️
go/vt/vttablet/sandboxconn/sandboxconn.go 78.57% 6 Missing ⚠️
go/vt/vtgate/scatter_conn.go 75.00% 4 Missing ⚠️
go/vt/vttablet/grpctabletconn/conn.go 77.77% 4 Missing ⚠️
go/vt/vttablet/queryservice/wrapped.go 77.77% 4 Missing ⚠️
go/vt/vttablet/grpcqueryservice/server.go 66.66% 3 Missing ⚠️
go/vt/vtexplain/vtexplain_vttablet.go 66.66% 2 Missing ⚠️
.../queryservice/fakes/stream_health_query_service.go 0.00% 2 Missing ⚠️
go/vt/vttablet/tabletserver/tabletserver.go 87.50% 2 Missing ⚠️
... and 2 more
Additional details and impacted files
@@            Coverage Diff             @@
##             main   #19075      +/-   ##
==========================================
- Coverage   69.90%   69.89%   -0.01%     
==========================================
  Files        1612     1612              
  Lines      215817   215789      -28     
==========================================
- Hits       150865   150824      -41     
- Misses      64952    64965      +13     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@mhamza15 mhamza15 enabled auto-merge (squash) December 24, 2025 16:01
@mhamza15 mhamza15 merged commit b3666b2 into vitessio:main Dec 24, 2025
103 of 112 checks passed
mhamza15 added a commit to mhamza15/vitess that referenced this pull request Jan 5, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants