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

Cleanup of dead code #14799

Merged
merged 1 commit into from
Dec 19, 2023
Merged

Cleanup of dead code #14799

merged 1 commit into from
Dec 19, 2023

Conversation

dbussink
Copy link
Contributor

Go recently announced https://go.dev/blog/deadcode and this does a first pass and cleans up a bunch of things.

Not everything it identifies is really dead code for us. We have a bunch of test implementations of interfaces for example, which is seen as dead code when running without the -test flag.

But with the -test flag, it doesn't find code that only is used from tests.

What it points at is a good starting point though for what to then manually verify and clean up. That's what I did here.

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 Dec 18, 2023
@vitess-bot vitess-bot
Copy link
Contributor

vitess-bot bot commented Dec 18, 2023

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 Dec 18, 2023
@github-actions github-actions bot added this to the v19.0.0 milestone Dec 18, 2023
@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 Dec 18, 2023
harshit-gangal
harshit-gangal approved these changes Dec 19, 2023
View reviewed changes
Copy link
Member

@harshit-gangal harshit-gangal left a comment

Choose a reason for hiding this comment

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

nice clean up 💯

@dbussink
Cleanup of dead code
424eb4c 
Go recently announced https://go.dev/blog/deadcode and this does a first
pass and cleans up a bunch of things.

Not everything it identifies is really dead code for us. We have a bunch
of test implementations of interfaces for example, which is seen as dead
code when running without the `-test` flag.

But with the `-test` flag, it doesn't find code that only is used from
tests.

What it points at is a good starting point though for what to then
manually verify and clean up. That's what I did here.

Signed-off-by: Dirkjan Bussink <[email protected]>
@dbussink dbussink force-pushed the dbussink/deadcode-cleanup branch from 788d0c1 to 424eb4c Compare December 19, 2023 08:37
@dbussink dbussink merged commit 08d48cf into vitessio:main Dec 19, 2023
116 checks passed
@dbussink dbussink deleted the dbussink/deadcode-cleanup branch December 19, 2023 09:28
ejortegau referenced this pull request in slackhq/vitess Jan 24, 2024
@dbussink @ejortegau
Cleanup of dead code (#14799)
487d571 
Signed-off-by: Dirkjan Bussink <[email protected]>
Signed-off-by: Eduardo J. Ortega U. <[email protected]>
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

@harshit-gangal harshit-gangal harshit-gangal approved these changes

@ajm188 ajm188 ajm188 approved these changes

@systay systay Awaiting requested review from systay systay 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

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

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

@GuptaManan100 GuptaManan100 Awaiting requested review from GuptaManan100 GuptaManan100 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.
4 participants
@dbussink @ajm188 @harshit-gangal @frouioui