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

release-23.1: tenantcapabilities: restructure interfaces #100272

Merged
merged 2 commits into from
Apr 4, 2023

Conversation

blathers-crl[bot]
Copy link

@blathers-crl blathers-crl bot commented Mar 31, 2023

Backport 1/1 commits from #100217 on behalf of @ajwerner.

/cc @cockroachdb/release


This commit is mostly just a refactoring of what we have. The previous iteration had some unfortunate coupling between the protobufs and the top-level package. Having the protobuf generated code not be a leaf hurts.

Another pain point was the lack of strong typing when interacting with capabilities. Given this is go, somewhere there's a need to do some type assertion when dealing sets of variant instance types.

The biggest change is that the TenantCapabilities concept is no longer wrapped in an interface implemented by the protobuf. Instead, the Capability implementations now live inside the tenantcapabilities package, and can be looked up with FromName and FromID, without any access to concrete capabilities. These capabilies then know how to look up values in a strongly typed way from the concrete capabilities.

Epic: none

Release note: None


Release justification: simplifies the code and ensures further backports are successful

This commit is mostly just a refactoring of what we have. The previous
iteration had some unfortunate coupling between the protobufs and the
top-level package. Having the protobuf generated code not be a leaf hurts.

Another pain point was the lack of strong typing when interacting with
capabilities. Given this is go, somewhere there's a need to do some
type assertion when dealing sets of variant instance types.

The biggest change is that the `TenantCapabilities` concept is no longer
wrapped in an interface implemented by the protobuf. Instead, the `Capability`
implementations now live inside the `tenantcapabilities` package, and can
be looked up with `FromName` and `FromID`, without any access to concrete
capabilities. These capabilies then know how to look up values in a strongly
typed way from the concrete capabilities.

Epic: none

Release note: None
@blathers-crl blathers-crl bot requested review from a team as code owners March 31, 2023 08:17
@blathers-crl blathers-crl bot force-pushed the blathers/backport-release-23.1-100217 branch from 7e72aae to 6bf6807 Compare March 31, 2023 08:17
@blathers-crl blathers-crl bot requested review from a team as code owners March 31, 2023 08:17
@blathers-crl blathers-crl bot requested a review from a team March 31, 2023 08:17
@blathers-crl blathers-crl bot force-pushed the blathers/backport-release-23.1-100217 branch from b3a7a1f to 0a3dccb Compare March 31, 2023 08:17
@blathers-crl
Copy link
Author

blathers-crl bot commented Mar 31, 2023

Thanks for opening a backport.

Please check the backport criteria before merging:

  • Patches should only be created for serious issues or test-only changes.
  • Patches should not break backwards-compatibility.
  • Patches should change as little code as possible.
  • Patches should not change on-disk formats or node communication protocols.
  • Patches should not add new functionality.
  • Patches must not add, edit, or otherwise modify cluster versions; or add version gates.
If some of the basic criteria cannot be satisfied, ensure that the exceptional criteria are satisfied within.
  • There is a high priority need for the functionality that cannot wait until the next release and is difficult to address in another way.
  • The new functionality is additive-only and only runs for clusters which have specifically “opted in” to it (e.g. by a cluster setting).
  • New code is protected by a conditional check that is trivial to verify and ensures that it only runs for opt-in clusters.
  • The PM and TL on the team that owns the changed code have signed off that the change obeys the above rules.

Add a brief release justification to the body of your PR to justify this backport.

Some other things to consider:

  • What did we do to ensure that a user that doesn’t know & care about this backport, has no idea that it happened?
  • Will this work in a cluster of mixed patch versions? Did we test that?
  • If a user upgrades a patch version, uses this feature, and then downgrades, what happens?

@cockroach-teamcity
Copy link
Member

This change is Reviewable

@ajwerner
Copy link
Contributor

Will add #100294 before merging

@knz
Copy link
Contributor

knz commented Apr 1, 2023

#100294 is merged

The test should fail if we ever add a new type of capability and use it in the
data driven test but don't update the test to handle it.

Epic: none

Follow-up from #100217 (review)

Release note: None
@knz
Copy link
Contributor

knz commented Apr 4, 2023

I merged #100294 into this manually and will merge this PR once CI is green.

@knz knz merged commit f539117 into release-23.1 Apr 4, 2023
@knz knz deleted the blathers/backport-release-23.1-100217 branch April 4, 2023 12:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants