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

refactor database plugin SDK #29479

Merged
merged 4 commits into from
Feb 3, 2025
Merged

refactor database plugin SDK #29479

merged 4 commits into from
Feb 3, 2025
+270 −166

Conversation

thyton
Copy link
Contributor

@thyton thyton commented Jan 31, 2025 •
edited by jira bot
Loading

Description

What does this PR do?
This PR refactors database plugin SDK and prepares for ENT database plugin SDK development.

Related ENT PR: https://github.com/hashicorp/vault-enterprise/pull/7347
Ticket: VAULT-33548
RFC: https://go.hashi.co/rfc/vlt-337

TODO only if you're a HashiCorp employee

  • Backport Labels: If this fix needs to be backported, use the appropriate backport/ label that matches the desired release branch. Note that in the CE repo, the latest release branch will look like backport/x.x.x, but older release branches will be backport/ent/x.x.x+ent.
    • LTS: If this fixes a critical security vulnerability or severity 1 bug, it will also need to be backported to the current LTS versions of Vault. To ensure this, use all available enterprise labels.
  • ENT Breakage: If this PR either 1) removes a public function OR 2) changes the signature
    of a public function, even if that change is in a CE file, double check that
    applying the patch for this PR to the ENT repo and running tests doesn't
    break any tests. Sometimes ENT only tests rely on public functions in CE
    files.
  • Jira: If this change has an associated Jira, it's referenced either
    in the PR description, commit message, or branch name.
  • RFC: If this change has an associated RFC, please link it in the description.
  • ENT PR: If this change has an associated ENT PR, please link it in the
    description. Also, make sure the changelog is in this PR, not in your ENT PR.

@thyton
refactor database plugin sdk and prepare for ent database plugin sdk …

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
GPG key ID: 4AEE18F83AFDEB23
Expired
Verified
Learn about vigilant mode
e9b3ac4 
…development
@thyton thyton requested a review from a team as a code owner January 31, 2025 23:55
@thyton thyton requested a review from heatherezell January 31, 2025 23:55
@github-actions github-actions bot added the hashicorp-contributed-pr If the PR is HashiCorp (i.e. not-community) contributed label Jan 31, 2025
@thyton thyton added backport/ent/1.16.x+ent Changes are backported to 1.16.x+ent backport/1.18.x backport/ent/1.17.x+ent Changes are backported to 1.17.x+ent and removed hashicorp-contributed-pr If the PR is HashiCorp (i.e. not-community) contributed labels Jan 31, 2025
@thyton thyton added this to the 1.19.0-rc milestone Jan 31, 2025
@github-actions github-actions bot added the hashicorp-contributed-pr If the PR is HashiCorp (i.e. not-community) contributed label Feb 1, 2025
@github-actions GitHub Actions
Copy link

github-actions bot commented Feb 1, 2025 •
edited
Loading

CI Results:
All Go tests succeeded! ✅

@github-actions GitHub Actions
Copy link

github-actions bot commented Feb 1, 2025 •
edited
Loading

Build Results:
All builds succeeded! ✅

@thyton thyton requested a review from a team February 1, 2025 00:13
helenfufu
helenfufu previously approved these changes Feb 1, 2025
View reviewed changes
Copy link
Contributor

@helenfufu helenfufu left a comment

Choose a reason for hiding this comment

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

lgtm, just had a minor comment about file naming for the CE components that are more than a "typical stub" but it could be a moot point

sdk/database/dbplugin/v5/grpc_client_stubs_oss.go Outdated

type entGRPCClient struct{}

func (c gRPCClient) Close() error {
Copy link
Contributor

Choose a reason for hiding this comment

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

Hmm does Close() really count as a "stub" even if it performs real functionality (i.e. not just a no-op)? Not sure what the naming convention should be (i.e. maybe just _oss instead of _stubs_oss for these?) but it seems different than the rest of the stubs I've seen so far

Had a similar thought for the rest of the _stubs_oss files that are also moving existing CE functionality (but they do more than a typical no-op)

sdk/database/dbplugin/v5/grpc_database_plugin_stubs_oss.go Outdated
// GRPCClient (Vault CE edition) initializes and returns a gRPCClient with Database and
// PluginVersion gRPC clients. It implements GRPCClient() defined
// by GRPCPlugin interface in go-plugin/plugin.go
func (GRPCDatabasePlugin) GRPCClient(doneCtx context.Context, _ *plugin.GRPCBroker, c *grpc.ClientConn) (interface{}, error) {
Copy link
Contributor

Choose a reason for hiding this comment

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

Same thought on _stubs_oss to just _oss for this file given GRPCClient and GRPCServer do much more than a typical no-op

sdk/database/dbplugin/v5/plugin_client_stubs_oss.go Outdated

// NewPluginClient returns a databaseRPCClient with a connection to a running
// plugin.
func NewPluginClient(ctx context.Context, sys pluginutil.RunnerUtil, config pluginutil.PluginClientConfig) (Database, error) {
Copy link
Contributor

Choose a reason for hiding this comment

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

Same thought on _stubs_oss to just _oss for this file given NewPluginClient does much more than a typical no-op

@thyton
Copy link
Contributor Author

thyton commented Feb 1, 2025

lgtm, just had a minor comment about file naming for the CE components that are more than a "typical stub" but it could be a moot point

Thanks! I've just learnt today that we also have _oss. I agree to your point. Will update them!

@thyton thyton requested a review from helenfufu February 1, 2025 01:30
helenfufu
helenfufu previously approved these changes Feb 1, 2025
View reviewed changes
@thyton thyton enabled auto-merge (squash) February 3, 2025 15:51
@thyton thyton requested review from a team and helenfufu February 3, 2025 15:51
@thyton thyton merged commit 193796b into main Feb 3, 2025
91 of 92 checks passed
@thyton thyton deleted the thyton/VAULT-33548/ent-database-stubs-oss branch February 3, 2025 16:50
Merged
6 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Zlaticanin Zlaticanin

@heatherezell heatherezell

@helenfufu helenfufu

Assignees
No one assigned
Labels
backport/ent/1.16.x+ent Changes are backported to 1.16.x+ent backport/ent/1.17.x+ent Changes are backported to 1.17.x+ent backport/1.18.x hashicorp-contributed-pr If the PR is HashiCorp (i.e. not-community) contributed pr/no-changelog
Projects
None yet
Milestone
1.19.0-rc
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@thyton @helenfufu @Zlaticanin