Add private method to GrpcServer interface, disallow direct implement…

…ation (#7029) Fixes #6966 Signed-off-by: Bogdan Drutu <[email protected]>
open-telemetry · Jan 27, 2023 · e520829 · e520829
1 parent 504a00b
commit e520829
Show file tree

Hide file tree

Showing 4 changed files with 28 additions and 0 deletions.
diff --git a/.chloggen/fixgrpc.yaml b/.chloggen/fixgrpc.yaml
@@ -0,0 +1,11 @@
+# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix'
+change_type: breaking
+
+# The name of the component, or a single word describing the area of concern, (e.g. otlpreceiver)
+component: pdata
+
+# A brief description of the change.  Surround your text with quotes ("") if it needs to start with a backtick (`).
+note: Add private method to GrpcServer interface, disallow direct implementation
+
+# One or more tracking issues or pull requests related to the change
+issues: [6966]
diff --git a/pdata/plog/plogotlp/grpc.go b/pdata/plog/plogotlp/grpc.go
@@ -63,6 +63,9 @@ type GRPCServer interface {
 	// For performance reasons, it is recommended to keep this RPC
 	// alive for the entire life of the application.
 	Export(context.Context, ExportRequest) (ExportResponse, error)
+
+	// unexported disallow implementation of the GRPCServer.
+	unexported()
 }
 
 var _ GRPCServer = (*UnimplementedGRPCServer)(nil)
@@ -74,6 +77,8 @@ func (*UnimplementedGRPCServer) Export(context.Context, ExportRequest) (ExportRe
 	return ExportResponse{}, status.Errorf(codes.Unimplemented, "method Export not implemented")
 }
 
+func (*UnimplementedGRPCServer) unexported() {}
+
 // RegisterGRPCServer registers the Server to the grpc.Server.
 func RegisterGRPCServer(s *grpc.Server, srv GRPCServer) {
 	otlpcollectorlog.RegisterLogsServiceServer(s, &rawLogsServer{srv: srv})

diff --git a/pdata/pmetric/pmetricotlp/grpc.go b/pdata/pmetric/pmetricotlp/grpc.go
@@ -56,12 +56,16 @@ func (c *grpcClient) Export(ctx context.Context, request ExportRequest, opts ...
 func (c *grpcClient) unexported() {}
 
 // GRPCServer is the server API for OTLP gRPC MetricsService service.
+// Implementations MUST embed UnimplementedGRPCServer.
 type GRPCServer interface {
 	// Export is called every time a new request is received.
 	//
 	// For performance reasons, it is recommended to keep this RPC
 	// alive for the entire life of the application.
 	Export(context.Context, ExportRequest) (ExportResponse, error)
+
+	// unexported disallow implementation of the GRPCServer.
+	unexported()
 }
 
 var _ GRPCServer = (*UnimplementedGRPCServer)(nil)
@@ -73,6 +77,8 @@ func (*UnimplementedGRPCServer) Export(context.Context, ExportRequest) (ExportRe
 	return ExportResponse{}, status.Errorf(codes.Unimplemented, "method Export not implemented")
 }
 
+func (*UnimplementedGRPCServer) unexported() {}
+
 // RegisterGRPCServer registers the GRPCServer to the grpc.Server.
 func RegisterGRPCServer(s *grpc.Server, srv GRPCServer) {
 	otlpcollectormetrics.RegisterMetricsServiceServer(s, &rawMetricsServer{srv: srv})

diff --git a/pdata/ptrace/ptraceotlp/grpc.go b/pdata/ptrace/ptraceotlp/grpc.go
@@ -57,12 +57,16 @@ func (c *grpcClient) Export(ctx context.Context, request ExportRequest, opts ...
 func (c *grpcClient) unexported() {}
 
 // GRPCServer is the server API for OTLP gRPC TracesService service.
+// Implementations MUST embed UnimplementedGRPCServer.
 type GRPCServer interface {
 	// Export is called every time a new request is received.
 	//
 	// For performance reasons, it is recommended to keep this RPC
 	// alive for the entire life of the application.
 	Export(context.Context, ExportRequest) (ExportResponse, error)
+
+	// unexported disallow implementation of the GRPCServer.
+	unexported()
 }
 
 var _ GRPCServer = (*UnimplementedGRPCServer)(nil)
@@ -74,6 +78,8 @@ func (*UnimplementedGRPCServer) Export(context.Context, ExportRequest) (ExportRe
 	return ExportResponse{}, status.Errorf(codes.Unimplemented, "method Export not implemented")
 }
 
+func (*UnimplementedGRPCServer) unexported() {}
+
 // RegisterGRPCServer registers the GRPCServer to the grpc.Server.
 func RegisterGRPCServer(s *grpc.Server, srv GRPCServer) {
 	otlpcollectortrace.RegisterTraceServiceServer(s, &rawTracesServer{srv: srv})