Support {:all, endpoint} in :services to auto-discover
#49
Conversation
| GrpcReflection, | ||
| {GRPC.Server.Supervisor, endpoint: Helloworld.Endpoint, port: 50051, start_server: true}, | ||
| GrpcReflection |
There was a problem hiding this comment.
Not related to the PR, but I believe this is the correct order, as the server has dependency on infra started by the GrpcReflection supervisor.
|
Closes #48 |
v0idpwn
changed the title
v0idpwn
changed the title
:services to auto-discover
v0idpwn
changed the title
:services to auto-discover:services to auto-discover
| @@ -47,14 +47,15 @@ This is written and tested using [grpcurl](https://github.com/fullstorydev/grpcu | |||
| end | |||
| ``` | |||
| or both as desired. `version` is the grpc reflection spec, which can be `v1` or `v1alpha`. `services` is the services that will be exposed by that server by reflection. You can expose a service through both services if desired. | |||
| 1. Add the reflection supervisor to your supervision tree to host the cached reflection state | |||
| Instead of using an explicit list of services, you may alternatively use `{:all, MyApp.GrpcEndpoint}`, to include all services from an endpoint. This is a more succint alternative if you want to expose reflection for all services in your endpoint. On the other hand, you lose the fine-grained control of the ehaustive list. | |||
There was a problem hiding this comment.
I think this list is starting to get a bit dense with the config options inlined in these paragraphs. Now that services has multiple forms what do you think about simplifying this instruction list and moving the config descriptions into a separate block? I think the two forms for the content of the services entry should be together.
| @@ -11,15 +11,15 @@ defmodule GrpcReflection do | |||
| defmodule Helloworld.Reflection.Server do | |||
| use GrpcReflection.Server, | |||
| version: :v1, | |||
| services: [Helloworld.Greeter.Service] | |||
| services: [Helloworld.Greeter.Service] # alternatively, `{:all, HelloWorld.Endpoint}` can be used to include all services from the endpoint. | |||
There was a problem hiding this comment.
We don't describe version: :v1 vs version: v1alpha here. If you want to include this breakout here I would suggest putting in a stand-in for services and version that can be described in text outside of the code block.
Maybe something like:
defmodule Helloworld.Reflection.Server do use GrpcReflection.Server, version: <version>, services: <services> endWhere
<version>is either:v1or:v1alpha, and<services>is either a list of GRPC services to reflect, or the tuple {:all, Endpoint} to reflect all services from that endpoint
No description provided.