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

Improve sizegen to handle more types #17583

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Improve sizegen to handle more types #17583

wants to merge 1 commit into from
+506 −7

Conversation

dbussink
Copy link
Contributor

This improves sizegen to handle additional types and also have a custom handler for big.Int since the size is computable with the given accessors and decimals are used pretty often.

Related Issue(s)

This is follow up to #17556 which fixed #17555 to make it more robust for more types in the future. There's another path that now would panic on unknown types instead of silently ignoring them.

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

@dbussink dbussink requested a review from vmg January 20, 2025 20:54
@vitess-bot vitess-bot
Copy link
Contributor

vitess-bot bot commented Jan 20, 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 Jan 20, 2025
@github-actions github-actions bot added this to the v22.0.0 milestone Jan 20, 2025
dbussink
dbussink commented Jan 20, 2025
View reviewed changes
go/tools/sizegen/sizegen.go
var stmts []jen.Code
if node.String() == "math/big.Int" {
// This type is not accessible, but with the given
// accessors we can compute a proper size.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Custom handling here for big.Int for which we can more accurately compute the size.

go/tools/sizegen/sizegen.go
@@ -502,7 +613,6 @@ func (sizegen *sizegen) sizeStmtForType(fieldName *jen.Statement, field types.Ty

var defaultGenTypes = []string{
"vitess.io/vitess/go/pools/smartconnpool.Setting",
"vitess.io/vitess/go/vt/schema.DDLStrategySetting",
Copy link
Contributor Author

Choose a reason for hiding this comment

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

This type is not used in any cache at the moment, so we can remove it.

@dbussink dbussink added Type: Enhancement Logical improvement (somewhere between a bug and feature) 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 Jan 20, 2025
@dbussink
Improve sizegen to handle more types
53cb2da 
This improves sizegen to handle additional types and also have a custom
handler for big.Int since the size is computable with the given
accessors and decimals are used pretty often.

Signed-off-by: Dirkjan Bussink <[email protected]>
systay
systay approved these changes Jan 22, 2025
View reviewed changes
Copy link
Collaborator

@systay systay left a comment

Choose a reason for hiding this comment

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

LGTM

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@systay systay systay approved these changes

@vmg vmg Awaiting requested review from vmg

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

@shlomi-noach shlomi-noach Awaiting requested review from shlomi-noach shlomi-noach is a code owner

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

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

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

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

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

At least 2 approving reviews are required to merge this pull request.

Assignees
No one assigned
Labels
Component: Query Serving Type: Enhancement Logical improvement (somewhere between a bug and feature)
Projects
None yet
Milestone
v22.0.0
Development

Successfully merging this pull request may close these issues.

Bug Report: Sizegen is broken for cached results on v21 and later
2 participants
@dbussink @systay