Skip to content

Conversation

@corbantek
Copy link
Contributor

@corbantek corbantek commented Sep 9, 2025

Description

  • Added a new boolean flag appendCallerID to control the appending of CallerId username to queries.
  • Updated the NewExecutor function to accept the appendCallerID parameter.
  • Modified the newExecute method to conditionally append CallerId to the SQL query if the flag is enabled.

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

- Added a new boolean flag `appendCallerID` to control the appending of CallerId username to queries.
- Updated the `NewExecutor` function to accept the `appendCallerID` parameter.
- Modified the `newExecute` method to conditionally append CallerId to the SQL query if the flag is enabled.

Signed-off-by: Kyle Johnson <[email protected]>
- Introduced comprehensive tests for the addCallerIDUserToQuery function, covering various scenarios including valid caller IDs, edge cases, and consistency checks.
- Ensured 100% test coverage by including cases for usernames with spaces, special characters, and empty SQL queries.

Signed-off-by: Kyle Johnson <[email protected]>
@vitess-bot
Copy link
Contributor

vitess-bot bot commented Sep 9, 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.

@vitess-bot vitess-bot bot added NeedsBackportReason If backport labels have been applied to a PR, a justification is required 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 Sep 9, 2025
@github-actions github-actions bot added this to the v23.0.0 milestone Sep 9, 2025
@codecov
Copy link

codecov bot commented Sep 9, 2025

Codecov Report

❌ Patch coverage is 66.66667% with 3 lines in your changes missing coverage. Please review.
✅ Project coverage is 67.48%. Comparing base (58f753c) to head (5c6dea2).
⚠️ Report is 184 commits behind head on main.

Files with missing lines Patch % Lines
go/vt/vtgate/plan_execute.go 50.00% 2 Missing ⚠️
go/vt/vtgate/vtgate.go 0.00% 1 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main   #18635      +/-   ##
==========================================
- Coverage   67.50%   67.48%   -0.02%     
==========================================
  Files        1607     1608       +1     
  Lines      263527   263535       +8     
==========================================
- Hits       177890   177858      -32     
- Misses      85637    85677      +40     

☔ 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.

@corbantek corbantek marked this pull request as ready for review September 10, 2025 14:43
@sam-k3nny
Copy link

Is there a way of nudging this forward please? Etsy are also very interested in this change.

Comment on lines +73 to +77
// Append caller ID if enabled
if e.appendCallerID {
sql = addCallerIDUserToQuery(ctx, sql)
}

Copy link
Member

Choose a reason for hiding this comment

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

This can bloat the plan cache and more planner work for the prepared statement queries.
I would suggest we move this logic either in vttablet or add it directly as margin comments when we create the vcursol_impl object.

@harshit-gangal
Copy link
Member

Have you looked at the vttablet flag queryserver-config-annotate-queries that enables writing caller ID as comments to the sql query before executing it on MySQL

@systay systay modified the milestones: v23.0.0, v24.0.0 Oct 8, 2025
@corbantek
Copy link
Contributor Author

Have you looked at the vttablet flag queryserver-config-annotate-queries that enables writing caller ID as comments to the sql query before executing it on MySQL

My apologies on the delayed response, let me go investigate if this has equal parity with this PR...

@sam-k3nny
Copy link

The advantage of this approach, IIUC, is that is not based on an honour system. We can't always guarantee the caller will have added Caller ID to the comments. More often than not, when we want to identify the caller, it is because of unexpected requests. This approach ensures we have the caller if there are rogue requests.

Let me know if I've misunderstood anything though.

@timvaillancourt timvaillancourt added Type: Enhancement Logical improvement (somewhere between a bug and feature) Component: VTGate 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 Nov 5, 2025
@github-actions
Copy link
Contributor

github-actions bot commented Dec 6, 2025

This PR is being marked as stale because it has been open for 30 days with no activity. To rectify, you may do any of the following:

  • Push additional commits to the associated branch.
  • Remove the stale label.
  • Add a comment indicating why it is not stale.

If no action is taken within 7 days, this PR will be closed.

@github-actions github-actions bot added the Stale Marks PRs as stale after a period of inactivity, which are then closed after a grace period. label Dec 6, 2025
@github-actions github-actions bot removed the Stale Marks PRs as stale after a period of inactivity, which are then closed after a grace period. label Dec 9, 2025
@github-actions
Copy link
Contributor

github-actions bot commented Jan 8, 2026

This PR is being marked as stale because it has been open for 30 days with no activity. To rectify, you may do any of the following:

  • Push additional commits to the associated branch.
  • Remove the stale label.
  • Add a comment indicating why it is not stale.

If no action is taken within 7 days, this PR will be closed.

@github-actions github-actions bot added Stale Marks PRs as stale after a period of inactivity, which are then closed after a grace period. and removed Stale Marks PRs as stale after a period of inactivity, which are then closed after a grace period. labels Jan 8, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Component: VTGate Type: Enhancement Logical improvement (somewhere between a bug and feature)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants