Skip to content

Feature Request: Ensure that code does not break when services add new RPCs. #784

Closed
@prannayk

Description

@prannayk

Imported from: grpc/grpc-go#2318 as-is.

When a gRPC service is defined in a proto a corresponding interface is generated. A user is expected to implement this interface.
When the proto is updated to add a new API method, the interface generated changes.
Any struct that implements that interface is no longer in conformance. Therefore, the code breaks.

I would expect the structs to be forward compatible.

This can potentially be solved by the code generating a dummy struct that implements the interface. Users can then embed that struct and only implement the methods they care about, effectively overriding the default methods.

Solution proposed by : @dfawley @dsymonds
The solution inside Google is that the stubby codegen creates an UnimplementedFooService concrete type that implements the interface with methods that return an unimplemented error. Servers that wish to avoid breaking when the Foo service is extended can embed that type in their own implementation, and new methods will thus transparently work (by returning that unimplemented error). That's effectively what the OP suggests, and it seems to work well enough in practice.

Activity

changed the title [-]Feature request: Provide a way to make sure that their code does not break when services add new rpcs.[/-] [+]Feature request: Provide a way to make sure that code does not break when services add new rpcs.[/+] on Jan 15, 2019
changed the title [-]Feature request: Provide a way to make sure that code does not break when services add new rpcs.[/-] [+]Feature Request: Ensure that code does not break when services add new RPCs.[/+] on Jan 15, 2019
srikrsna

srikrsna commented on Feb 27, 2019

@srikrsna

I was not sure whether it can be a part of this repo hence I made this: https://github.com/srikrsna/protoc-gen-defaults

dsnet

dsnet commented on Jun 6, 2019

@dsnet
Member

Closing as resolved via #785.

locked and limited conversation to collaborators on Jun 26, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

      Development

      No branches or pull requests

        Participants

        @prannayk@dsnet@srikrsna

        Issue actions

          Feature Request: Ensure that code does not break when services add new RPCs. · Issue #784 · golang/protobuf