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

vtenv: Introduce vtenv for passing in collation & parser information #14994

Merged
merged 1 commit into from
Jan 21, 2024
Merged

vtenv: Introduce vtenv for passing in collation & parser information #14994

merged 1 commit into from
Jan 21, 2024

Conversation

dbussink
Copy link
Contributor

We have many places taking already 3 arguments for the collation env, parser & MySQL version. This is due to the refactors to pass in explicit state.

This introduces vtenv to refactor things a bit and slightly clean it up. We now have one thing that can carry all three dependencies and also potential future additional ones where we need it.

Related Issue(s)

Part of #14717

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 added Type: Internal Cleanup Component: General Changes throughout the code base labels Jan 19, 2024
@vitess-bot vitess-bot
Copy link
Contributor

vitess-bot bot commented Jan 19, 2024

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 19, 2024
@dbussink dbussink 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 19, 2024
@github-actions github-actions bot added this to the v19.0.0 milestone Jan 19, 2024
arthurschreiber
arthurschreiber approved these changes Jan 19, 2024
View reviewed changes
Copy link
Contributor

@arthurschreiber arthurschreiber left a comment

Choose a reason for hiding this comment

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

This is a great cleanup! ❤️

go/vt/vtenv/vtenv.go
Comment on lines +13 to +30
truncateUILen int
truncateErrLen int
Copy link
Contributor

Choose a reason for hiding this comment

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

These two feel a bit out of place, because they seem very specific to the status pages. 🤷🏻‍♂️

Copy link
Contributor Author

Choose a reason for hiding this comment

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

They are used in a few more places but yeah. I don’t have a much better idea though, we need to pass them all the through then.

ajm188
ajm188 approved these changes Jan 19, 2024
View reviewed changes
Copy link
Contributor

@ajm188 ajm188 left a comment

Choose a reason for hiding this comment

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

i like this!

frouioui
frouioui reviewed Jan 19, 2024
View reviewed changes
go/vt/vtenv/vtenv.go
Comment on lines +1 to +19
package vtenv

import (
Copy link
Member

Choose a reason for hiding this comment

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

Header is missing here

@frouioui
Copy link
Member

We need to re-run make sizegen as well, the static check workflow fails with Regenerated cached_size files do not match the current version.

frouioui
frouioui approved these changes Jan 19, 2024
View reviewed changes
Copy link
Member

@frouioui frouioui left a comment

Choose a reason for hiding this comment

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

That's a really nice refactor, thank you!

@dbussink dbussink force-pushed the introduce-vtenv branch 2 times, most recently from 5190549 to da1913c Compare January 19, 2024 20:42
@codecov Codecov
Copy link

codecov bot commented Jan 21, 2024 •
edited
Loading

Codecov Report

Attention: 178 lines in your changes are missing coverage. Please review.

Comparison is base (f03155f) 47.34% compared to head (3bec3b9) 47.33%.

Files Patch % Lines
go/vt/vttablet/onlineddl/executor.go 4.00% 24 Missing ⚠️
go/vt/vtenv/cached_size.go 0.00% 14 Missing ⚠️
go/vt/sqlparser/cached_size.go 0.00% 10 Missing ⚠️
go/vt/vttablet/tabletserver/tabletenv/env.go 0.00% 10 Missing ⚠️
...o/vt/vttablet/tabletmanager/vreplication/engine.go 33.33% 8 Missing ⚠️
go/vt/schemadiff/column.go 25.00% 6 Missing ⚠️
go/vt/vtgate/planbuilder/operators/insert.go 0.00% 6 Missing ⚠️
go/vt/wrangler/wrangler.go 57.14% 6 Missing ⚠️
go/vt/vtgate/planbuilder/operators/route.go 0.00% 5 Missing ⚠️
go/vt/vttablet/onlineddl/vrepl.go 0.00% 5 Missing ⚠️
... and 43 more
Additional details and impacted files 
@@            Coverage Diff             @@
##             main   #14994      +/-   ##
==========================================
- Coverage   47.34%   47.33%   -0.01%     
==========================================
  Files        1142     1144       +2     
  Lines      239041   238997      -44     
==========================================
- Hits       113178   113140      -38     
+ Misses     117265   117263       -2     
+ Partials     8598     8594       -4

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

@dbussink
vtenv: Introduce vtenv for passing in collation & parser information
3bec3b9 
We have many places taking already 3 arguments for the collation env,
parser & MySQL version. This is due to the refactors to pass in explicit
state.

This introduces `vtenv` to refactor things a bit and slightly clean it
up. We now have one thing that can carry all three dependencies and also
potential future additional ones where we need it.

Signed-off-by: Dirkjan Bussink <[email protected]>
@dbussink dbussink merged commit 6c4c5fa into vitessio:main Jan 21, 2024
101 of 102 checks passed
@dbussink dbussink deleted the introduce-vtenv branch January 21, 2024 13:08
@GuptaManan100 GuptaManan100 mentioned this pull request Jan 22, 2024
Merged
@dbussink dbussink mentioned this pull request Feb 12, 2024
Merged
5 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@frouioui frouioui frouioui approved these changes

@ajm188 ajm188 ajm188 approved these changes

@shlomi-noach shlomi-noach shlomi-noach approved these changes

@arthurschreiber arthurschreiber arthurschreiber 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

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

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

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

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

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

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

Assignees
No one assigned
Labels
Component: General Changes throughout the code base Type: Internal Cleanup
Projects
None yet
Milestone
v19.0.0
Development

Successfully merging this pull request may close these issues.
5 participants
@dbussink @frouioui @arthurschreiber @shlomi-noach @ajm188