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

feat: Update proto def to pass 'buf lint' #308

Merged
merged 1 commit into from
Aug 29, 2024
Merged

Conversation

alilleybrinker
Copy link
Collaborator

This commit modifies the protobuf definition for Hipcheck plugins to meet the expectations of 'buf lint', which checks protobuf definitions against a set of best practices. The main goal here is to make the service definition more defensive against forward-compatibility issues.

This also includes updates to the code that interacts with the generated code to make sure it still compiles.

@alilleybrinker alilleybrinker added the type: enhancement New feature or request label Aug 28, 2024
@alilleybrinker alilleybrinker added this to the 3.6.0 milestone Aug 28, 2024
@alilleybrinker alilleybrinker self-assigned this Aug 28, 2024
@j-lanson
Copy link
Collaborator

I imagine this will break the working communication with the dummy plugin via hc plugin

@alilleybrinker
Copy link
Collaborator Author

Ah, you're right that I'll need to update that as well. I'll amend the patch with that.

@alilleybrinker
Copy link
Collaborator Author

Julian has some in-flight changes to the demo plugin with stuff that we'll be pulling out into our Rust plugin SDK, and I'd rather that get merged first and then rebase this on top. So this'll wait until that's ready.

@alilleybrinker
Copy link
Collaborator Author

Resolved merge conflicts, now to get it to compile again haha

@alilleybrinker alilleybrinker force-pushed the alilleybrinker/proto-lints branch from 7cecaa2 to 9cdc659 Compare August 29, 2024 18:01
@alilleybrinker alilleybrinker marked this pull request as ready for review August 29, 2024 18:02
@alilleybrinker
Copy link
Collaborator Author

@j-lanson ready for re-review

This commit modifies the protobuf definition for Hipcheck plugins to meet the
expectations of 'buf lint', which checks protobuf definitions against a set
of best practices. The main goal here is to make the service definition more
defensive against forward-compatibility issues.

This also includes updates to the code that interacts with the generated code
to make sure it still compiles.

Signed-off-by: Andrew Lilley Brinker <[email protected]>
@alilleybrinker alilleybrinker force-pushed the alilleybrinker/proto-lints branch from 1594100 to 57cb0f0 Compare August 29, 2024 18:42
@alilleybrinker
Copy link
Collaborator Author

@j-lanson removed boxed query stream. Ready for re-review

Copy link
Collaborator

@j-lanson j-lanson left a comment

Choose a reason for hiding this comment

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

Looks good!

@j-lanson j-lanson merged commit 0e7f7ec into main Aug 29, 2024
9 checks passed
@alilleybrinker alilleybrinker deleted the alilleybrinker/proto-lints branch September 10, 2024 00:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: enhancement New feature or request
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

2 participants