Skip to content

Conversation

@timvaillancourt
Copy link
Contributor

@timvaillancourt timvaillancourt commented Jun 22, 2025

Description

This PR refactors VTOrc to use *topoprotopb.TabletAlias (vs a topoproto.TabletAliasString(...)-encoded string) to reference a tablet throughout the code

Currently the VTOrc encode/decodes string-based tablet aliases using topoproto.TabletAliasString(...) and topoproto.ParseTabletAlias(...). This PR continues to do this same conversion, but only in places where it is required, lower in the code:

  1. The sqlite backend - we need to encode structs as strings in sqlite
  2. Logging that refers to tablet alias - the .String() method on *topoprotopb.TabletAlias produces a weird prototext format so topoproto.TabletAliasString(...)-encoded string is still used
  3. Cache library keys (string)

Finally, a huge if block was moved to switch in inst.GetDetectionAnalysis

This change aids in the implementation of these RFCs:

  1. RFC: gRPC server for VTOrc APIs #18251 - implementing a gRPC server will mean the code will move to using protobuf-based data. So more of the code will be referring to things as real *topoprotopb.TabletAlias (that's my plan at least)
  2. RFC: access data via an interface in vtorc #17190 - having to decode/encode tablet aliases as string is really just an implementation detail of the current sqlite backend. Future backends don't need to be hindered by this, so lets use function signatures that use real *topoprotopb.TabletAlias

Related Issue(s)

  1. RFC: gRPC server for VTOrc APIs #18251
  2. RFC: access data via an interface in vtorc #17190

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

@vitess-bot
Copy link
Contributor

vitess-bot bot commented Jun 22, 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 Jun 22, 2025
@github-actions github-actions bot added this to the v23.0.0 milestone Jun 22, 2025
@timvaillancourt timvaillancourt added Component: VTorc Vitess Orchestrator integration Type: Internal Cleanup and removed 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 Jun 22, 2025
Signed-off-by: Tim Vaillancourt <[email protected]>
Signed-off-by: Tim Vaillancourt <[email protected]>
@timvaillancourt timvaillancourt removed the NeedsDescriptionUpdate The description is not clear or comprehensive enough, and needs work label Jun 22, 2025
@codecov
Copy link

codecov bot commented Jun 22, 2025

Codecov Report

❌ Patch coverage is 39.01345% with 136 lines in your changes missing coverage. Please review.
✅ Project coverage is 69.89%. Comparing base (e48c2d5) to head (2a2c5eb).
⚠️ Report is 9 commits behind head on main.

Files with missing lines Patch % Lines
go/vt/vtorc/logic/topology_recovery.go 0.00% 36 Missing ⚠️
go/vt/vtorc/logic/tablet_discovery.go 0.00% 20 Missing ⚠️
go/vt/vtorc/logic/vtorc.go 5.00% 19 Missing ⚠️
go/vt/vtorc/logic/discovery_queue.go 0.00% 16 Missing ⚠️
go/vt/vtorc/server/api.go 5.88% 16 Missing ⚠️
go/vt/vtorc/inst/instance_dao.go 77.94% 15 Missing ⚠️
go/vt/vtorc/logic/topology_recovery_dao.go 0.00% 13 Missing ⚠️
go/vt/vtorc/inst/shard_dao.go 83.33% 1 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main   #18389      +/-   ##
==========================================
- Coverage   69.90%   69.89%   -0.02%     
==========================================
  Files        1612     1612              
  Lines      215796   215832      +36     
==========================================
- Hits       150858   150845      -13     
- Misses      64938    64987      +49     

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

Signed-off-by: Tim Vaillancourt <[email protected]>
Signed-off-by: Tim Vaillancourt <[email protected]>
Signed-off-by: Tim Vaillancourt <[email protected]>
Signed-off-by: Tim Vaillancourt <[email protected]>
Signed-off-by: Tim Vaillancourt <[email protected]>
Signed-off-by: Tim Vaillancourt <[email protected]>
@github-actions
Copy link
Contributor

github-actions bot commented Aug 1, 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 Aug 1, 2025
@timvaillancourt timvaillancourt removed the Stale Marks PRs as stale after a period of inactivity, which are then closed after a grace period. label Aug 1, 2025
@systay systay modified the milestones: v23.0.0, v24.0.0 Oct 8, 2025
@github-actions
Copy link
Contributor

github-actions bot commented Nov 9, 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 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 Nov 9, 2025
@github-actions
Copy link
Contributor

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 Dec 10, 2025
Signed-off-by: Tim Vaillancourt <[email protected]>
Signed-off-by: Tim Vaillancourt <[email protected]>
Signed-off-by: Tim Vaillancourt <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Component: VTorc Vitess Orchestrator integration Type: Internal Cleanup

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants