Rename compose List() => Stacks to avoid name collision, and remove confusion with compose ps, also renamed Services()

Signed-off-by: Guillaume Tardif <[email protected]>

protos/compose/v1/compose.pb.go

@@ -679,7 +679,7 @@ var file_protos_compose_v1_compose_proto_rawDesc = []byte{
 	0x0d, 0x52, 0x08, 0x72, 0x65, 0x70, 0x6c, 0x69, 0x63, 0x61, 0x73, 0x12, 0x18, 0x0a, 0x07, 0x64,
 	0x65, 0x73, 0x69, 0x72, 0x65, 0x64, 0x18, 0x04, 0x20, 0x01, 0x28, 0x0d, 0x52, 0x07, 0x64, 0x65,
 	0x73, 0x69, 0x72, 0x65, 0x64, 0x12, 0x14, 0x0a, 0x05, 0x50, 0x6f, 0x72, 0x74, 0x73, 0x18, 0x05,
-	0x20, 0x03, 0x28, 0x09, 0x52, 0x05, 0x50, 0x6f, 0x72, 0x74, 0x73, 0x32, 0xd7, 0x03, 0x0a, 0x07,
+	0x20, 0x03, 0x28, 0x09, 0x52, 0x05, 0x50, 0x6f, 0x72, 0x74, 0x73, 0x32, 0xd9, 0x03, 0x0a, 0x07,
 	0x43, 0x6f, 0x6d, 0x70, 0x6f, 0x73, 0x65, 0x12, 0x6d, 0x0a, 0x02, 0x55, 0x70, 0x12, 0x32, 0x2e,
 	0x63, 0x6f, 0x6d, 0x2e, 0x64, 0x6f, 0x63, 0x6b, 0x65, 0x72, 0x2e, 0x61, 0x70, 0x69, 0x2e, 0x70,
 	0x72, 0x6f, 0x74, 0x6f, 0x73, 0x2e, 0x63, 0x6f, 0x6d, 0x70, 0x6f, 0x73, 0x65, 0x2e, 0x76, 0x31,
@@ -694,26 +694,26 @@ var file_protos_compose_v1_compose_proto_rawDesc = []byte{
 	0x75, 0x65, 0x73, 0x74, 0x1a, 0x35, 0x2e, 0x63, 0x6f, 0x6d, 0x2e, 0x64, 0x6f, 0x63, 0x6b, 0x65,
 	0x72, 0x2e, 0x61, 0x70, 0x69, 0x2e, 0x70, 0x72, 0x6f, 0x74, 0x6f, 0x73, 0x2e, 0x63, 0x6f, 0x6d,
 	0x70, 0x6f, 0x73, 0x65, 0x2e, 0x76, 0x31, 0x2e, 0x43, 0x6f, 0x6d, 0x70, 0x6f, 0x73, 0x65, 0x44,
-	0x6f, 0x77, 0x6e, 0x52, 0x65, 0x73, 0x70, 0x6f, 0x6e, 0x73, 0x65, 0x12, 0x79, 0x0a, 0x0a, 0x4c,
-	0x69, 0x73, 0x74, 0x53, 0x74, 0x61, 0x63, 0x6b, 0x73, 0x12, 0x34, 0x2e, 0x63, 0x6f, 0x6d, 0x2e,
-	0x64, 0x6f, 0x63, 0x6b, 0x65, 0x72, 0x2e, 0x61, 0x70, 0x69, 0x2e, 0x70, 0x72, 0x6f, 0x74, 0x6f,
-	0x73, 0x2e, 0x63, 0x6f, 0x6d, 0x70, 0x6f, 0x73, 0x65, 0x2e, 0x76, 0x31, 0x2e, 0x43, 0x6f, 0x6d,
-	0x70, 0x6f, 0x73, 0x65, 0x4c, 0x69, 0x73, 0x74, 0x52, 0x65, 0x71, 0x75, 0x65, 0x73, 0x74, 0x1a,
-	0x35, 0x2e, 0x63, 0x6f, 0x6d, 0x2e, 0x64, 0x6f, 0x63, 0x6b, 0x65, 0x72, 0x2e, 0x61, 0x70, 0x69,
-	0x2e, 0x70, 0x72, 0x6f, 0x74, 0x6f, 0x73, 0x2e, 0x63, 0x6f, 0x6d, 0x70, 0x6f, 0x73, 0x65, 0x2e,
-	0x76, 0x31, 0x2e, 0x43, 0x6f, 0x6d, 0x70, 0x6f, 0x73, 0x65, 0x4c, 0x69, 0x73, 0x74, 0x52, 0x65,
-	0x73, 0x70, 0x6f, 0x6e, 0x73, 0x65, 0x12, 0x6d, 0x0a, 0x02, 0x50, 0x73, 0x12, 0x32, 0x2e, 0x63,
-	0x6f, 0x6d, 0x2e, 0x64, 0x6f, 0x63, 0x6b, 0x65, 0x72, 0x2e, 0x61, 0x70, 0x69, 0x2e, 0x70, 0x72,
-	0x6f, 0x74, 0x6f, 0x73, 0x2e, 0x63, 0x6f, 0x6d, 0x70, 0x6f, 0x73, 0x65, 0x2e, 0x76, 0x31, 0x2e,
-	0x43, 0x6f, 0x6d, 0x70, 0x6f, 0x73, 0x65, 0x50, 0x73, 0x52, 0x65, 0x71, 0x75, 0x65, 0x73, 0x74,
-	0x1a, 0x33, 0x2e, 0x63, 0x6f, 0x6d, 0x2e, 0x64, 0x6f, 0x63, 0x6b, 0x65, 0x72, 0x2e, 0x61, 0x70,
-	0x69, 0x2e, 0x70, 0x72, 0x6f, 0x74, 0x6f, 0x73, 0x2e, 0x63, 0x6f, 0x6d, 0x70, 0x6f, 0x73, 0x65,
-	0x2e, 0x76, 0x31, 0x2e, 0x43, 0x6f, 0x6d, 0x70, 0x6f, 0x73, 0x65, 0x50, 0x73, 0x52, 0x65, 0x73,
-	0x70, 0x6f, 0x6e, 0x73, 0x65, 0x42, 0x34, 0x5a, 0x32, 0x67, 0x69, 0x74, 0x68, 0x75, 0x62, 0x2e,
-	0x63, 0x6f, 0x6d, 0x2f, 0x64, 0x6f, 0x63, 0x6b, 0x65, 0x72, 0x2f, 0x63, 0x6f, 0x6d, 0x70, 0x6f,
-	0x73, 0x65, 0x2d, 0x63, 0x6c, 0x69, 0x2f, 0x70, 0x72, 0x6f, 0x74, 0x6f, 0x73, 0x2f, 0x63, 0x6f,
-	0x6d, 0x70, 0x6f, 0x73, 0x65, 0x2f, 0x76, 0x31, 0x3b, 0x76, 0x31, 0x62, 0x06, 0x70, 0x72, 0x6f,
-	0x74, 0x6f, 0x33,
+	0x6f, 0x77, 0x6e, 0x52, 0x65, 0x73, 0x70, 0x6f, 0x6e, 0x73, 0x65, 0x12, 0x75, 0x0a, 0x06, 0x53,
+	0x74, 0x61, 0x63, 0x6b, 0x73, 0x12, 0x34, 0x2e, 0x63, 0x6f, 0x6d, 0x2e, 0x64, 0x6f, 0x63, 0x6b,
+	0x65, 0x72, 0x2e, 0x61, 0x70, 0x69, 0x2e, 0x70, 0x72, 0x6f, 0x74, 0x6f, 0x73, 0x2e, 0x63, 0x6f,
+	0x6d, 0x70, 0x6f, 0x73, 0x65, 0x2e, 0x76, 0x31, 0x2e, 0x43, 0x6f, 0x6d, 0x70, 0x6f, 0x73, 0x65,
+	0x4c, 0x69, 0x73, 0x74, 0x52, 0x65, 0x71, 0x75, 0x65, 0x73, 0x74, 0x1a, 0x35, 0x2e, 0x63, 0x6f,
+	0x6d, 0x2e, 0x64, 0x6f, 0x63, 0x6b, 0x65, 0x72, 0x2e, 0x61, 0x70, 0x69, 0x2e, 0x70, 0x72, 0x6f,
+	0x74, 0x6f, 0x73, 0x2e, 0x63, 0x6f, 0x6d, 0x70, 0x6f, 0x73, 0x65, 0x2e, 0x76, 0x31, 0x2e, 0x43,
+	0x6f, 0x6d, 0x70, 0x6f, 0x73, 0x65, 0x4c, 0x69, 0x73, 0x74, 0x52, 0x65, 0x73, 0x70, 0x6f, 0x6e,
+	0x73, 0x65, 0x12, 0x73, 0x0a, 0x08, 0x53, 0x65, 0x72, 0x76, 0x69, 0x63, 0x65, 0x73, 0x12, 0x32,
+	0x2e, 0x63, 0x6f, 0x6d, 0x2e, 0x64, 0x6f, 0x63, 0x6b, 0x65, 0x72, 0x2e, 0x61, 0x70, 0x69, 0x2e,
+	0x70, 0x72, 0x6f, 0x74, 0x6f, 0x73, 0x2e, 0x63, 0x6f, 0x6d, 0x70, 0x6f, 0x73, 0x65, 0x2e, 0x76,
+	0x31, 0x2e, 0x43, 0x6f, 0x6d, 0x70, 0x6f, 0x73, 0x65, 0x50, 0x73, 0x52, 0x65, 0x71, 0x75, 0x65,
+	0x73, 0x74, 0x1a, 0x33, 0x2e, 0x63, 0x6f, 0x6d, 0x2e, 0x64, 0x6f, 0x63, 0x6b, 0x65, 0x72, 0x2e,
+	0x61, 0x70, 0x69, 0x2e, 0x70, 0x72, 0x6f, 0x74, 0x6f, 0x73, 0x2e, 0x63, 0x6f, 0x6d, 0x70, 0x6f,
+	0x73, 0x65, 0x2e, 0x76, 0x31, 0x2e, 0x43, 0x6f, 0x6d, 0x70, 0x6f, 0x73, 0x65, 0x50, 0x73, 0x52,
+	0x65, 0x73, 0x70, 0x6f, 0x6e, 0x73, 0x65, 0x42, 0x34, 0x5a, 0x32, 0x67, 0x69, 0x74, 0x68, 0x75,
+	0x62, 0x2e, 0x63, 0x6f, 0x6d, 0x2f, 0x64, 0x6f, 0x63, 0x6b, 0x65, 0x72, 0x2f, 0x63, 0x6f, 0x6d,
+	0x70, 0x6f, 0x73, 0x65, 0x2d, 0x63, 0x6c, 0x69, 0x2f, 0x70, 0x72, 0x6f, 0x74, 0x6f, 0x73, 0x2f,
+	0x63, 0x6f, 0x6d, 0x70, 0x6f, 0x73, 0x65, 0x2f, 0x76, 0x31, 0x3b, 0x76, 0x31, 0x62, 0x06, 0x70,
+	0x72, 0x6f, 0x74, 0x6f, 0x33,
 }
 
 var (
@@ -746,12 +746,12 @@ var file_protos_compose_v1_compose_proto_depIdxs = []int32{
 	9, // 1: com.docker.api.protos.compose.v1.ComposePsResponse.services:type_name -> com.docker.api.protos.compose.v1.Service
 	0, // 2: com.docker.api.protos.compose.v1.Compose.Up:input_type -> com.docker.api.protos.compose.v1.ComposeUpRequest
 	2, // 3: com.docker.api.protos.compose.v1.Compose.Down:input_type -> com.docker.api.protos.compose.v1.ComposeDownRequest
-	4, // 4: com.docker.api.protos.compose.v1.Compose.ListStacks:input_type -> com.docker.api.protos.compose.v1.ComposeListRequest
-	7, // 5: com.docker.api.protos.compose.v1.Compose.Ps:input_type -> com.docker.api.protos.compose.v1.ComposePsRequest
+	4, // 4: com.docker.api.protos.compose.v1.Compose.Stacks:input_type -> com.docker.api.protos.compose.v1.ComposeListRequest
+	7, // 5: com.docker.api.protos.compose.v1.Compose.Services:input_type -> com.docker.api.protos.compose.v1.ComposePsRequest
 	1, // 6: com.docker.api.protos.compose.v1.Compose.Up:output_type -> com.docker.api.protos.compose.v1.ComposeUpResponse
 	3, // 7: com.docker.api.protos.compose.v1.Compose.Down:output_type -> com.docker.api.protos.compose.v1.ComposeDownResponse
-	5, // 8: com.docker.api.protos.compose.v1.Compose.ListStacks:output_type -> com.docker.api.protos.compose.v1.ComposeListResponse
-	8, // 9: com.docker.api.protos.compose.v1.Compose.Ps:output_type -> com.docker.api.protos.compose.v1.ComposePsResponse
+	5, // 8: com.docker.api.protos.compose.v1.Compose.Stacks:output_type -> com.docker.api.protos.compose.v1.ComposeListResponse
+	8, // 9: com.docker.api.protos.compose.v1.Compose.Services:output_type -> com.docker.api.protos.compose.v1.ComposePsResponse
 	6, // [6:10] is the sub-list for method output_type
 	2, // [2:6] is the sub-list for method input_type
 	2, // [2:2] is the sub-list for extension type_name
@@ -920,8 +920,8 @@ const _ = grpc.SupportPackageIsVersion6
 type ComposeClient interface {
 	Up(ctx context.Context, in *ComposeUpRequest, opts ...grpc.CallOption) (*ComposeUpResponse, error)
 	Down(ctx context.Context, in *ComposeDownRequest, opts ...grpc.CallOption) (*ComposeDownResponse, error)
-	ListStacks(ctx context.Context, in *ComposeListRequest, opts ...grpc.CallOption) (*ComposeListResponse, error)
-	Ps(ctx context.Context, in *ComposePsRequest, opts ...grpc.CallOption) (*ComposePsResponse, error)
+	Stacks(ctx context.Context, in *ComposeListRequest, opts ...grpc.CallOption) (*ComposeListResponse, error)
+	Services(ctx context.Context, in *ComposePsRequest, opts ...grpc.CallOption) (*ComposePsResponse, error)
 }
 
 type composeClient struct {
@@ -950,18 +950,18 @@ func (c *composeClient) Down(ctx context.Context, in *ComposeDownRequest, opts .
 	return out, nil
 }
 
-func (c *composeClient) ListStacks(ctx context.Context, in *ComposeListRequest, opts ...grpc.CallOption) (*ComposeListResponse, error) {
+func (c *composeClient) Stacks(ctx context.Context, in *ComposeListRequest, opts ...grpc.CallOption) (*ComposeListResponse, error) {
 	out := new(ComposeListResponse)
-	err := c.cc.Invoke(ctx, "/com.docker.api.protos.compose.v1.Compose/ListStacks", in, out, opts...)
+	err := c.cc.Invoke(ctx, "/com.docker.api.protos.compose.v1.Compose/Stacks", in, out, opts...)
 	if err != nil {
 		return nil, err
 	}
 	return out, nil
 }
 
-func (c *composeClient) Ps(ctx context.Context, in *ComposePsRequest, opts ...grpc.CallOption) (*ComposePsResponse, error) {
+func (c *composeClient) Services(ctx context.Context, in *ComposePsRequest, opts ...grpc.CallOption) (*ComposePsResponse, error) {
 	out := new(ComposePsResponse)
-	err := c.cc.Invoke(ctx, "/com.docker.api.protos.compose.v1.Compose/Ps", in, out, opts...)
+	err := c.cc.Invoke(ctx, "/com.docker.api.protos.compose.v1.Compose/Services", in, out, opts...)
 	if err != nil {
 		return nil, err
 	}
@@ -972,8 +972,8 @@ func (c *composeClient) Ps(ctx context.Context, in *ComposePsRequest, opts ...gr
 type ComposeServer interface {
 	Up(context.Context, *ComposeUpRequest) (*ComposeUpResponse, error)
 	Down(context.Context, *ComposeDownRequest) (*ComposeDownResponse, error)
-	ListStacks(context.Context, *ComposeListRequest) (*ComposeListResponse, error)
-	Ps(context.Context, *ComposePsRequest) (*ComposePsResponse, error)
+	Stacks(context.Context, *ComposeListRequest) (*ComposeListResponse, error)
+	Services(context.Context, *ComposePsRequest) (*ComposePsResponse, error)
 }
 
 // UnimplementedComposeServer can be embedded to have forward compatible implementations.
@@ -986,11 +986,11 @@ func (*UnimplementedComposeServer) Up(context.Context, *ComposeUpRequest) (*Comp
 func (*UnimplementedComposeServer) Down(context.Context, *ComposeDownRequest) (*ComposeDownResponse, error) {
 	return nil, status.Errorf(codes.Unimplemented, "method Down not implemented")
 }
-func (*UnimplementedComposeServer) ListStacks(context.Context, *ComposeListRequest) (*ComposeListResponse, error) {
-	return nil, status.Errorf(codes.Unimplemented, "method ListStacks not implemented")
+func (*UnimplementedComposeServer) Stacks(context.Context, *ComposeListRequest) (*ComposeListResponse, error) {
+	return nil, status.Errorf(codes.Unimplemented, "method Stacks not implemented")
 }
-func (*UnimplementedComposeServer) Ps(context.Context, *ComposePsRequest) (*ComposePsResponse, error) {
-	return nil, status.Errorf(codes.Unimplemented, "method Ps not implemented")
+func (*UnimplementedComposeServer) Services(context.Context, *ComposePsRequest) (*ComposePsResponse, error) {
+	return nil, status.Errorf(codes.Unimplemented, "method Services not implemented")
 }
 
 func RegisterComposeServer(s *grpc.Server, srv ComposeServer) {
@@ -1033,38 +1033,38 @@ func _Compose_Down_Handler(srv interface{}, ctx context.Context, dec func(interf
 	return interceptor(ctx, in, info, handler)
 }
 
-func _Compose_ListStacks_Handler(srv interface{}, ctx context.Context, dec func(interface{}) error, interceptor grpc.UnaryServerInterceptor) (interface{}, error) {
+func _Compose_Stacks_Handler(srv interface{}, ctx context.Context, dec func(interface{}) error, interceptor grpc.UnaryServerInterceptor) (interface{}, error) {
 	in := new(ComposeListRequest)
 	if err := dec(in); err != nil {
 		return nil, err
 	}
 	if interceptor == nil {
-		return srv.(ComposeServer).ListStacks(ctx, in)
+		return srv.(ComposeServer).Stacks(ctx, in)
 	}
 	info := &grpc.UnaryServerInfo{
 		Server:     srv,
-		FullMethod: "/com.docker.api.protos.compose.v1.Compose/ListStacks",
+		FullMethod: "/com.docker.api.protos.compose.v1.Compose/Stacks",
 	}
 	handler := func(ctx context.Context, req interface{}) (interface{}, error) {
-		return srv.(ComposeServer).ListStacks(ctx, req.(*ComposeListRequest))
+		return srv.(ComposeServer).Stacks(ctx, req.(*ComposeListRequest))
 	}
 	return interceptor(ctx, in, info, handler)
 }
 
-func _Compose_Ps_Handler(srv interface{}, ctx context.Context, dec func(interface{}) error, interceptor grpc.UnaryServerInterceptor) (interface{}, error) {
+func _Compose_Services_Handler(srv interface{}, ctx context.Context, dec func(interface{}) error, interceptor grpc.UnaryServerInterceptor) (interface{}, error) {
 	in := new(ComposePsRequest)
 	if err := dec(in); err != nil {
 		return nil, err
 	}
 	if interceptor == nil {
-		return srv.(ComposeServer).Ps(ctx, in)
+		return srv.(ComposeServer).Services(ctx, in)
 	}
 	info := &grpc.UnaryServerInfo{
 		Server:     srv,
-		FullMethod: "/com.docker.api.protos.compose.v1.Compose/Ps",
+		FullMethod: "/com.docker.api.protos.compose.v1.Compose/Services",
 	}
 	handler := func(ctx context.Context, req interface{}) (interface{}, error) {
-		return srv.(ComposeServer).Ps(ctx, req.(*ComposePsRequest))
+		return srv.(ComposeServer).Services(ctx, req.(*ComposePsRequest))
 	}
 	return interceptor(ctx, in, info, handler)
 }
@@ -1082,12 +1082,12 @@ var _Compose_serviceDesc = grpc.ServiceDesc{
 			Handler:    _Compose_Down_Handler,
 		},
 		{
-			MethodName: "ListStacks",
-			Handler:    _Compose_ListStacks_Handler,
+			MethodName: "Stacks",
+			Handler:    _Compose_Stacks_Handler,
 		},
 		{
-			MethodName: "Ps",
-			Handler:    _Compose_Ps_Handler,
+			MethodName: "Services",
+			Handler:    _Compose_Services_Handler,
 		},
 	},
 	Streams:  []grpc.StreamDesc{},

protos/compose/v1/compose.proto

@@ -22,8 +22,8 @@ option go_package = "github.com/docker/compose-cli/protos/compose/v1;v1";
 service Compose {
   rpc Up(ComposeUpRequest) returns (ComposeUpResponse);
   rpc Down(ComposeDownRequest) returns (ComposeDownResponse);
-  rpc ListStacks(ComposeListRequest)returns (ComposeListResponse);
-  rpc Ps(ComposePsRequest)returns (ComposePsResponse);
+  rpc Stacks(ComposeListRequest)returns (ComposeListResponse);
+  rpc Services(ComposePsRequest)returns (ComposePsResponse);
 }
 
 message ComposeUpRequest {

server/metrics.go

@@ -43,6 +43,10 @@ var (
 		"/com.docker.api.protos.volumes.v1.Volumes/VolumesDelete":  "volume rm",
 		"/com.docker.api.protos.volumes.v1.Volumes/VolumesCreate":  "volume create",
 		"/com.docker.api.protos.volumes.v1.Volumes/VolumesInspect": "volume inspect",
+		"/com.docker.api.protos.compose.v1.Compose/Up":             "compose up",
+		"/com.docker.api.protos.compose.v1.Compose/Down":           "compose down",
+		"/com.docker.api.protos.compose.v1.Compose/Stacks":         "compose ls",
+		"/com.docker.api.protos.compose.v1.Compose/Services":       "compose ps",
 	}
 )
 

server/metrics_test.go

@@ -35,6 +35,7 @@ import (
 	"github.com/docker/compose-cli/api/volumes"
 	"github.com/docker/compose-cli/errdefs"
 	"github.com/docker/compose-cli/metrics"
+	composev1 "github.com/docker/compose-cli/protos/compose/v1"
 	containersv1 "github.com/docker/compose-cli/protos/containers/v1"
 	contextsv1 "github.com/docker/compose-cli/protos/contexts/v1"
 	streamsv1 "github.com/docker/compose-cli/protos/streams/v1"
@@ -105,6 +106,7 @@ func setupServer() *grpc.Server {
 	ctx := context.TODO()
 	s := New(ctx)
 	p := proxy.New(ctx)
+	composev1.RegisterComposeServer(s, p)
 	containersv1.RegisterContainersServer(s, p)
 	streamsv1.RegisterStreamingServer(s, p)
 	volumesv1.RegisterVolumesServer(s, p)

server/proxy/compose.go

@@ -21,6 +21,7 @@ import (
 
 	"github.com/compose-spec/compose-go/cli"
 	"github.com/compose-spec/compose-go/types"
+
 	composev1 "github.com/docker/compose-cli/protos/compose/v1"
 )
 
@@ -44,7 +45,7 @@ func (p *proxy) Down(ctx context.Context, request *composev1.ComposeDownRequest)
 	return &composev1.ComposeDownResponse{ProjectName: projectName}, Client(ctx).ComposeService().Down(ctx, projectName)
 }
 
-func (p *proxy) Ps(ctx context.Context, request *composev1.ComposePsRequest) (*composev1.ComposePsResponse, error) {
+func (p *proxy) Services(ctx context.Context, request *composev1.ComposePsRequest) (*composev1.ComposePsResponse, error) {
 	projectName := request.GetProjectName()
 	if projectName == "" {
 		project, err := getComposeProject(request.Files, request.WorkDir, request.ProjectName)
@@ -70,7 +71,7 @@ func (p *proxy) Ps(ctx context.Context, request *composev1.ComposePsRequest) (*c
 	return &composev1.ComposePsResponse{Services: response}, nil
 }
 
-func (p *proxy) ListStacks(ctx context.Context, request *composev1.ComposeListRequest) (*composev1.ComposeListResponse, error) {
+func (p *proxy) Stacks(ctx context.Context, request *composev1.ComposeListRequest) (*composev1.ComposeListResponse, error) {
 	stacks, err := Client(ctx).ComposeService().List(ctx, request.ProjectName)
 	if err != nil {
 		return nil, err