Add neoeinstein-prost-crate v0.3.1 plugin

[cobbinma]

add neoeinstein-prost-crate to community plugins

Closes #608

[CLAassistant]

All committers have signed the CLA.

[pkwarren]

Thanks @cobbinma for the contribution. We previously discussed the prost-crate plugin here: #96 (comment)

It relies on accessing files which aren't available to remote plugins, so it would need to be used with no_features to work as a remote plugin. At the time of getting the other prost plugins working, we opted to skip this one as it most likely won't work as expected. In order to gain full control over all of the plugin's features, you'd want to execute it as a local plugin as described here: https://github.com/neoeinstein/protoc-gen-prost/tree/main/protoc-gen-prost-crate#usage-with-buf

[cobbinma]

Thanks @pkwarren.

As I only need the features that can be run remotely, can the plugin be added so that we can use it with no_features?

I am currently using it this way and would like to keep doing so:

  - remote: buf.build/prost/plugins/crate:v0.3.1-1
    out: autogen/lang/rust
    opt:
      - no_features

[mfridman]

As I only need the features that can be run remotely, can the plugin be added so that we can use it with no_features?

Although this works for some use cases, it's also not something we can easily test. I.e., all plugins in this repository are run through at least 1 module and the output is committed as a sum file. We would have to special case this plugin and trust it "just works" without any validation.

Furthermore, no_features is not the default, so if users are running this plugin remotely it'll fail and lead to surprising behaviour. This leads to a bit of a maintenance burden for us.

I'm hesitant to add this plugin unless it has sane default behaviour and can be tested.

[cobbinma]

@mfridman I have added go sum files and a plugins test override, similar to the other rust plugins.

I agree with your comments and think it is unfortunate no_features is not the default behaviour.

The repository does have documentation on why the gen_crate option doesn't work with buf remotely and what options do work.

https://github.com/neoeinstein/protoc-gen-prost/tree/main/protoc-gen-prost-crate#usage-with-buf

[pkwarren]

@cobbinma - Is this plugin functional on its own without specifying any options? We set no_include on prost-serde and tonic just for the purposes of our testing in this repo (which runs each plugin individually), however the plugins are functional with the default options.

[pkwarren]

nit: Can you move this up one line to keep these plugin names sorted?

[cobbinma]

@cobbinma - Is this plugin functional on its own without specifying any options? We set no_include on prost-serde and tonic just for the purposes of our testing in this repo (which runs each plugin individually), however the plugins are functional with the default options.

@pkwarren
According to the usage with buf documentation it should be, but it returns an error for me when running without options.

❯ buf generate --include-imports
WARN    Plugin "buf.build/prost/crate" is deprecated
Failure: plugin buf.build/prost/plugins/crate:v0.3.1-1: Cargo.toml: does not exist

[maoueh]

Really cool, is it usable right now or there is some wait on Buf side?

[pkwarren]

Really cool, is it usable right now or there is some wait on Buf side?

It is available now and ready for use: https://buf.build/community/neoeinstein-prost-crate

There are limitations as documented here: https://github.com/neoeinstein/protoc-gen-prost/blob/main/protoc-gen-prost-crate/README.md. In particular, remote plugins don't have access to arbitrary files from the filesystem, so the gen_crate option isn't supported.

[maoueh]

Yep I'm aware thanks, I'm using it in the way it works.