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

[flags] extract tabletenv seconds type #12920

Merged

Conversation

ajm188
Copy link
Contributor

@ajm188 ajm188 commented Apr 18, 2023

Description

Two main goals:

  1. Move the Seconds type out of package tabletenv, so that in a separate PR I have in progress, another package (which tabletenv will need to import) can import or otherwise reference the type without creating an import cycle.
  2. Deprecate the "we will parse your float and turn it into seconds" behavior in favor of just using plain-old time.Duration types. One release after this ships, we would then be able to turn these types from our custom type into Durations and delete the custom type from the codebase.

For my purposes, in full transparency, I need (1), and only want (2) if it's not too 🌶️ of a move.

Some notes

tabletenv.ReplicationTrackerConfig

this one is a bit annoying because while the flags are themselves already time.Duration (where we want to end up), the config also can be marshalled from yaml, so we need to shim in a potentially breaking change (hence the deprecation phase) to read pure durations there

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

@ajm188 ajm188 force-pushed the andrew/extract-tabletenv-seconds-type branch from ce934bd to e709888 Compare April 18, 2023 10:30
@github-actions github-actions bot added this to the v17.0.0 milestone Apr 18, 2023
@ajm188 ajm188 force-pushed the andrew/extract-tabletenv-seconds-type branch 2 times, most recently from e45a077 to 259ec2d Compare April 18, 2023 22:25
Andrew Mason added 12 commits April 20, 2023 13:50
Signed-off-by: Andrew Mason <andrew@planetscale.com>
Signed-off-by: Andrew Mason <andrew@planetscale.com>
Signed-off-by: Andrew Mason <andrew@planetscale.com>
Signed-off-by: Andrew Mason <andrew@planetscale.com>
Signed-off-by: Andrew Mason <andrew@planetscale.com>
Signed-off-by: Andrew Mason <andrew@planetscale.com>
Signed-off-by: Andrew Mason <andrew@planetscale.com>
Signed-off-by: Andrew Mason <andrew@planetscale.com>
Signed-off-by: Andrew Mason <andrew@planetscale.com>
this one is a bit annoying because while the _flags_ are themselves already `time.Duration` (where we want to end up), the config also can be marshalled from yaml, so we need to shim in a potentially breaking change (hence the deprecation phase) to read pure durations there

Signed-off-by: Andrew Mason <andrew@planetscale.com>
Signed-off-by: Andrew Mason <andrew@planetscale.com>
Signed-off-by: Andrew Mason <andrew@planetscale.com>
@ajm188 ajm188 force-pushed the andrew/extract-tabletenv-seconds-type branch from 1a94279 to df6e976 Compare April 20, 2023 17:50
Andrew Mason added 5 commits April 20, 2023 14:12
Signed-off-by: Andrew Mason <andrew@planetscale.com>
Signed-off-by: Andrew Mason <andrew@planetscale.com>
Signed-off-by: Andrew Mason <andrew@planetscale.com>
Signed-off-by: Andrew Mason <andrew@planetscale.com>
Signed-off-by: Andrew Mason <andrew@planetscale.com>
@ajm188 ajm188 marked this pull request as ready for review April 21, 2023 13:45
@vitess-bot
Copy link
Contributor

vitess-bot bot commented Apr 21, 2023

Review Checklist

Hello reviewers! 👋 Please follow this checklist when reviewing this Pull Request.

General

  • Ensure that the Pull Request has a descriptive title.
  • If this is a change that users need to know about, please apply the release notes (needs details) label so that merging is blocked unless the summary release notes document is included.
  • If a test is added or modified, there should be a documentation on top of the test to explain what the expected behavior is what the test does.

If a new flag is being introduced:

  • Is it really necessary to add this flag?
  • Flag names should be clear and intuitive (as far as possible)
  • Help text should be descriptive.
  • Flag names should use dashes (-) as word separators rather than underscores (_).

If a workflow is added or modified:

  • Each item in Jobs should be named in order to mark it as required.
  • If the workflow should be required, the maintainer team should be notified.

Bug fixes

  • There should be at least one unit or end-to-end test.
  • The Pull Request description should include a link to an issue that describes the bug.

Non-trivial changes

  • There should be some code comments as to why things are implemented the way they are.

New/Existing features

  • Should be documented, either by modifying the existing documentation or creating new documentation.
  • New features should have a link to a feature request issue or an RFC that documents the use cases, corner cases and test cases.

Backward compatibility

  • Protobuf changes should be wire-compatible.
  • Changes to _vt tables and RPCs need to be backward compatible.
  • vtctl command output order should be stable and awk-able.
  • RPC changes should be compatible with vitess-operator
  • If a flag is removed, then it should also be removed from VTop, if used there.

@ajm188 ajm188 changed the title Andrew/extract tabletenv seconds type [flags] extract tabletenv seconds type Apr 21, 2023
@ajm188 ajm188 added Type: Enhancement Logical improvement (somewhere between a bug and feature) Component: Query Serving Component: CLI labels Apr 21, 2023
Copy link
Contributor

@rohit-nayak-ps rohit-nayak-ps left a comment

Choose a reason for hiding this comment

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

lgtm

❤️ the DeprecatedFloat64Seconds pattern

@ajm188 ajm188 added Flakes and removed Flakes labels Apr 21, 2023
@ajm188 ajm188 merged commit 53d083b into vitessio:main Apr 21, 2023
@ajm188 ajm188 deleted the andrew/extract-tabletenv-seconds-type branch April 21, 2023 16:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Component: CLI Component: Query Serving Type: Enhancement Logical improvement (somewhere between a bug and feature)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Move Seconds type from tabletenv to flagutil (or other appropriate package)
3 participants