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.

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

Decouple topotools from vschema #16008

Merged
merged 1 commit into from
May 25, 2024

Conversation

dbussink
Copy link
Contributor

This removes the coupling between vschema and topotools just for a single helper function.

With this change, we don't end up pulling a large dependency tree for other utilities like schemadiff.

See also https://go-proverbs.github.io, "A little copying is better than a little dependency.".

Also see planetscale/schemadiff#22 (comment)

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

This removes the coupling between vschema and topotools just for a
single helper function.

With this change, we don't end up pulling a large dependency tree for
other utilities like schemadiff.

See also https://go-proverbs.github.io, "A little copying is better than
a little dependency.".

Signed-off-by: Dirkjan Bussink <d.bussink@gmail.com>
Copy link
Contributor

vitess-bot bot commented May 25, 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 May 25, 2024
@github-actions github-actions bot added this to the v20.0.0 milestone May 25, 2024
@dbussink dbussink added Type: Internal Cleanup 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 May 25, 2024
Copy link

codecov bot commented May 25, 2024

Codecov Report

Attention: Patch coverage is 40.00000% with 3 lines in your changes are missing coverage. Please review.

Project coverage is 68.27%. Comparing base (248014e) to head (01170b9).

Files Patch % Lines
go/vt/vtgate/vindexes/vschema.go 40.00% 3 Missing ⚠️
Additional details and impacted files
@@           Coverage Diff           @@
##             main   #16008   +/-   ##
=======================================
  Coverage   68.27%   68.27%           
=======================================
  Files        1562     1562           
  Lines      197316   197319    +3     
=======================================
+ Hits       134708   134719   +11     
+ Misses      62608    62600    -8     

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

Copy link
Contributor

@shlomi-noach shlomi-noach left a comment

Choose a reason for hiding this comment

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

Thank you

@shlomi-noach shlomi-noach merged commit d95ce48 into vitessio:main May 25, 2024
105 checks passed
@dbussink dbussink deleted the decouple-topotools branch May 25, 2024 12:19
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