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

Use panic instead of errors inside the operator package #14085

Merged
merged 15 commits into from
Oct 10, 2023

Conversation

systay
Copy link
Collaborator

@systay systay commented Sep 23, 2023

Description

To simplify the code and remove most of the

if err != nil { return err }

lines we have, this PR uses panics and a panic handler instead of returning errors. This way we can write code that doesn't need to do error checking, which is more compact and easier to read.

The idea is to use the operator package as an API, and the panics only exist inside the package. Whenever we are returning something to the outside of the package, we transform the panics back into errors, so users of the operator package don't need to do anything different.

We still use errors in a couple of places in the operator package, for situations where the error is handled. The panics are only for errors that are failures we can't fix inside the package.

Related Issue(s)

Checklist

  • "Backport to:" labels have been added if this change should be back-ported
  • Tests were added or are not required
  • Did the new or modified tests pass consistently locally and on the CI
  • Documentation was added or is not required

Deployment Notes

@vitess-bot
Copy link
Contributor

vitess-bot bot commented Sep 23, 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 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 Sep 23, 2023
@github-actions github-actions bot added this to the v18.0.0 milestone Sep 23, 2023
@systay systay modified the milestones: v18.0.0, v19.0.0 Sep 29, 2023
@systay systay changed the title replace errors 12001 and 13001 with panics Use panic instead of errors inside the operator package Oct 9, 2023
@systay systay added Type: Internal Cleanup Component: Query Serving Type: Enhancement Logical improvement (somewhere between a bug and feature) 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 Type: Enhancement Logical improvement (somewhere between a bug and feature) labels Oct 9, 2023
systay added 13 commits October 10, 2023 08:29
Copy link
Collaborator

@vmg vmg left a comment

Choose a reason for hiding this comment

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

LGTM. I think this makes the planner more legible. 👍

@systay systay merged commit e5eea9c into vitessio:main Oct 10, 2023
115 checks passed
@systay systay deleted the op-panic branch October 10, 2023 09:03
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