Unable to use 'go_package' option with full import path in proto file

[washanhanzi]

I am tring to use gripmock with docker, and mount the user.proto file into docker

but the docker exit with:

Starting GripMock
Serving stub admin on http://:4771
sed: /go/src/grpc/user.pb.go: No such file or directory
2021/01/23 03:11:35 Fail on sed

It seems the pb.go file didn't generated.

[Kareem-Emad]

I think the issue happens when you specify the go_package option in your proto file with the full path of your package
example

package service;

option go_package = "internal/grpc/service";

will fail with

sed: /go/src/internal/grpc/repository-service.pb.go: No such file or directory

removing the option or replacing it with just the package name will work

package service;
option go_package = "service";

reproducible example

syntax = "proto3";

package service;

option go_package = "bitbucket-repository-management-service/internal/grpc/service";


//RepositoryService Definition
service RepositoryService {
	rpc add (Repository) returns (AddRepositoryResponse);
}
 
message AddRepositoryResponse {
	Repository addedRepository = 1;
	Error error = 2;
}
message Error {
	string code = 1;
	string message = 2;
}

message Repository {
	int64 id  = 1;
	string name = 2;
	int64 userId = 3;
	bool isPrivate = 4;
}

Run grip-mock with

docker run -p 4770:4770 -p 4771:4771 -v $(pwd):/proto tkpd/gripmock /proto/repository-service.proto

which will give you an error log

Starting GripMock
Serving stub admin on http://:4771
sed: /go/src/grpc/repository-service.pb.go: No such file or directory
2021/01/23 10:53:51 Fail on sed

[washanhanzi]

Thank you. It fixes my problem.

[Kareem-Emad]

You are welcome

But this is still a valid issue since protoc generator complains about the go package missing the fullpath specification, and it will be required in future release so I think that needs to be supported here.

example with same above file

protoc -I $(pwd) --go_out=plugins=grpc:. $(pwd)/repository-service.proto

will produce warning

WARNING: Deprecated use of 'go_package' option without a full import path in "multi-package/repository-service.proto", please specify:
        option go_package = "multi-package;service";
A future release of protoc-gen-go will require the import path be specified.
See https://developers.google.com/protocol-buffers/docs/reference/go-generated#package for more information.

[benquinteros]

Any update on this?

[jekiapp]

Hi @Kareem-Emad

I'm a bit confused of what is actually being supported in the future. The warning said WARNING: Deprecated use of 'go_package' option without a full import path but the one that fixed the issue is specifying package in the short version. I thought full import path means the longer one.

[jekiapp]

It turns out a huge incompatibility change. In order to support this, I need to require go_package for every proto being used, thus it's non-backward compatible.

[jekiapp]

I created this PR #83 to solve this issue, it's quite a big change. It will make a backward incompatibility to the old .proto files since it will require go_package declaration.

[jekiapp]

I pushed tkpd/gripmock:v1.10 to address this issue, checkout this release

[cchengrbx]

Hi @jekiapp, thanks for pushing the new release to support go_package. After trying it, I get a pretty cryptic error:

/go/src/grpc/server.go:19:2: package <my_go_package> is not in GOROOT (/usr/local/go/src/<my_go_package>)

Here's how I'm invoking gripmock:

# docker-compose.yml
  my-service:
    container_name: my-service-mock
    image: "tkpd/gripmock:${TAG:-v1.10}"
    networks:
      - sendr
    command: "-stub=/stub /proto/my_api.proto"
    volumes:
      - >-
        ./my-service/proto/:/proto
      - >-
        ./my-service/stub/:/stub
    ports:
      - "4770:4770"
      - "4771:4771"

Any ideas where I went wrong?

[jekiapp]

@cchengrbx did you literally put <my_go_package> as value in go_package option?
if yes, then you need to change it to a standard path format. Please check this reference

[cchengrbx]

No, the go_package is set to something in the format foo/barv1 so nothing special.

[jekiapp]

#response_container_BBPPID{font-family: initial; font-size:initial; color: initial;} I just pushed tkpd/gripmock:1.10.1 try it From: ***@***.***: 6 August 2021 23:10To: ***@***.*** to: ***@***.***: ***@***.***; ***@***.***: Re: [tokopedia/gripmock] Unable to use 'go_package' option with full import path in proto file (#65) No, the go_package is set to something in the format foo/barv1 so nothing special. —You are receiving this because you were mentioned.Reply to this email directly, view it on GitHub, or unsubscribe.Triage notifications on the go with GitHub Mobile for iOS or Android. Disclaimer:The information contained in this communication is intended solely for the addressed individual or entity only. If you are not the intended recipient, you are hereby notified that any disclosure, copying, distribution or taking any action in reliance on the contents of this information is strictly prohibited and may be unlawful.If you have received this communication in error, please notify us immediately by responding to this email or contact us at the address mentioned above.

[cchengrbx]

Thanks @jekiapp, 1.10.1 is working great.