Skip to content

codegen: create RPC service interface with gRPC & DRPC adapters #4

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

Merged
merged 1 commit into from
Jun 3, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
104 changes: 104 additions & 0 deletions cmd/protoc-gen-go-drpc/main.go
Original file line number Diff line number Diff line change
Expand Up @@ -92,10 +92,28 @@ func (d *drpc) ClientIface(service *protogen.Service) string {
return "DRPC" + service.GoName + "Client"
}

func (d *drpc) RPCClientIface(service *protogen.Service) string {
return "RPC" + service.GoName + "Client"
}

func (d *drpc) GRPCClientAdapter(service *protogen.Service) string {
return "grpc" + service.GoName + "ClientAdapter"
}

func (d *drpc) DRPCClientAdapter(service *protogen.Service) string {
return "drpc" + service.GoName + "ClientAdapter"
}

func (d *drpc) ClientImpl(service *protogen.Service) string {
return "drpc" + service.GoName + "Client"
}

func unexport(s string) string { return strings.ToLower(s[:1]) + s[1:] }

func (d *drpc) GRPCClientImpl(service *protogen.Service) string {
return unexport(service.GoName) + "Client"
}

func (d *drpc) ServerIface(service *protogen.Service) string {
return "DRPC" + service.GoName + "Server"
}
Expand Down Expand Up @@ -323,6 +341,9 @@ func (d *drpc) generateService(service *protogen.Service) {
for _, method := range service.Methods {
d.generateServerMethod(method)
}

d.generateServiceRPCInterfaces(service)
d.generateServiceAdapters(service)
}

//
Expand Down Expand Up @@ -595,3 +616,86 @@ func (d *drpc) generateRPCClientInterface(method *protogen.Method) {
d.P("}")
d.P()
}

func (d *drpc) generateServiceRPCInterfaces(service *protogen.Service) {
// Client interface
d.P("type ", d.RPCClientIface(service), " interface {")
d.P()
for _, method := range service.Methods {
d.P(d.generateRPCClientSignature(method))
}
d.P("}")
d.P()
}

func (d *drpc) generateRPCClientSignature(method *protogen.Method) string {
reqArg := ", in *" + d.InputType(method)
if method.Desc.IsStreamingClient() {
reqArg = ""
}
respName := "*" + d.OutputType(method)
if method.Desc.IsStreamingServer() || method.Desc.IsStreamingClient() {
respName = d.ClientStreamRPCIface(method)
}
return fmt.Sprintf("%s(ctx %s%s) (%s, error)", method.GoName, d.Ident("context", "Context"), reqArg, respName)
}
func (d *drpc) generateServiceAdapters(service *protogen.Service) {
d.generateGRPCAdapter(service)
d.generateDRPCAdapter(service)
}

func (d *drpc) generateGRPCAdapter(service *protogen.Service) {
adapter := d.GRPCClientAdapter(service)
grpcClientImpl := d.GRPCClientImpl(service)
rpcIface := d.RPCClientIface(service)

d.P("// ", service.GoName, " gRPC -> RPC adapter")
d.P("type ", adapter, " ", grpcClientImpl)
d.P()
d.P("func NewGRPC", service.GoName, "ClientAdapter(conn *", d.Ident("google.golang.org/grpc", "ClientConn"), ") ", rpcIface, " {")
d.P("return (*", adapter, ")(&", grpcClientImpl, "{conn})")
d.P("}")
d.P()

for _, m := range service.Methods {
d.P("func (a *", adapter, ") ", d.generateRPCClientSignature(m), " {")
if m.Desc.IsStreamingClient() {
d.P("return (*", grpcClientImpl, ")(a).", m.GoName, "(ctx)")
} else {
d.P("return (*", grpcClientImpl, ")(a).", m.GoName, "(ctx, in)")
}
d.P("}")
d.P()
}
d.P("// compile-time assertion")
d.P("var _ ", rpcIface, " = (*", adapter, ")(nil)")
d.P()
}

func (d *drpc) generateDRPCAdapter(service *protogen.Service) {
adapter := d.DRPCClientAdapter(service)
drpcClientImpl := d.ClientImpl(service)
rpcIface := d.RPCClientIface(service)

d.P("// ", service.GoName, " DRPC -> RPC adapter")
d.P("type ", adapter, " ", drpcClientImpl)
d.P()
d.P("func NewDRPC", service.GoName, "ClientAdapter(conn ", d.Ident("storj.io/drpc", "Conn"), ") ", rpcIface, " {")
d.P("return (*", adapter, ")(&", drpcClientImpl, "{conn})")
d.P("}")
d.P()

for _, m := range service.Methods {
d.P("func (a *", adapter, ") ", d.generateRPCClientSignature(m), " {")
if m.Desc.IsStreamingClient() {
d.P("return (*", drpcClientImpl, ")(a).", m.GoName, "(ctx)")
} else {
d.P("return (*", drpcClientImpl, ")(a).", m.GoName, "(ctx, in)")
}
d.P("}")
d.P()
}
d.P("// compile-time assertion")
d.P("var _ ", rpcIface, " = (*", adapter, ")(nil)")
d.P()
}
Binary file added cmd/protoc-gen-go-drpc/protoc-gen-go-drpc
Binary file not shown.