[#922] control: Extend api with ListOverrideDefinedTargets

Signed-off-by: Anton Nikiforov <an.nikiforov@yadro.com>

pkg/services/control/rpc.go

@@ -25,6 +25,7 @@ const (
 	rpcListChainLocalOverrides   = "ListChainLocalOverrides"
 	rpcRemoveChainLocalOverride  = "RemoveChainLocalOverride"
 	rpcSealWriteCache            = "SealWriteCache"
+	rpcListTargetsLocalOverrides = "ListTargetsLocalOverrides"
 )
 
 // HealthCheck executes ControlService.HealthCheck RPC.
@@ -240,6 +241,19 @@ func ListChainLocalOverrides(cli *client.Client, req *ListChainLocalOverridesReq
 	return wResp.message, nil
 }
 
+// ListTargetsLocalOverrides executes ControlService.ListTargetsLocalOverrides RPC.
+func ListTargetsLocalOverrides(cli *client.Client, req *ListTargetsLocalOverridesRequest, opts ...client.CallOption) (*ListTargetsLocalOverridesResponse, error) {
+	wResp := newResponseWrapper[ListTargetsLocalOverridesResponse]()
+	wReq := &requestWrapper{m: req}
+
+	err := client.SendUnary(cli, common.CallMethodInfoUnary(serviceName, rpcListTargetsLocalOverrides), wReq, wResp, opts...)
+	if err != nil {
+		return nil, err
+	}
+
+	return wResp.message, nil
+}
+
 // RemoveChainLocalOverride executes ControlService.RemoveChainLocalOverride RPC.
 func GetChainLocalOverride(cli *client.Client, req *GetChainLocalOverrideRequest, opts ...client.CallOption) (*GetChainLocalOverrideResponse, error) {
 	wResp := newResponseWrapper[GetChainLocalOverrideResponse]()

pkg/services/control/server/policy_engine.go

@@ -25,6 +25,29 @@ func apeTarget(chainTarget *control.ChainTarget) (engine.Target, error) {
 		fmt.Errorf("target type is not supported: %s", chainTarget.GetType().String()).Error())
 }
 
+func controlTarget(chainTarget *engine.Target) (control.ChainTarget, error) {
+	switch chainTarget.Type {
+	case engine.Container:
+		return control.ChainTarget{
+			Name: chainTarget.Name,
+			Type: control.ChainTarget_CONTAINER,
+		}, nil
+	case engine.Namespace:
+		// If namespace is empty, we take it for root namespace.
+		nm := chainTarget.Name
+		if nm == "root" {
+			nm = ""
+		}
+		return control.ChainTarget{
+			Name: nm,
+			Type: control.ChainTarget_NAMESPACE,
+		}, nil
+	default:
+	}
+	return control.ChainTarget{}, status.Error(codes.InvalidArgument,
+		fmt.Errorf("target type is not supported: %c", chainTarget.Type).Error())
+}
+
 func (s *Server) AddChainLocalOverride(_ context.Context, req *control.AddChainLocalOverrideRequest) (*control.AddChainLocalOverrideResponse, error) {
 	if err := s.isValidRequest(req); err != nil {
 		return nil, status.Error(codes.PermissionDenied, err.Error())
@@ -157,6 +180,37 @@ func (s *Server) RemoveChainLocalOverride(_ context.Context, req *control.Remove
 	return resp, nil
 }
 
+func (s *Server) ListTargetsLocalOverrides(_ context.Context, req *control.ListTargetsLocalOverridesRequest) (*control.ListTargetsLocalOverridesResponse, error) {
+	if err := s.isValidRequest(req); err != nil {
+		return nil, status.Error(codes.PermissionDenied, err.Error())
+	}
+
+	apeChainName := apechain.Name(req.GetBody().GetChainName())
+	apeTargets, err := s.localOverrideStorage.LocalStorage().ListOverrideDefinedTargets(apeChainName)
+	if err != nil {
+		return nil, status.Error(getCodeByLocalStorageErr(err), err.Error())
+	}
+	targets := make([]*control.ChainTarget, 0, len(apeTargets))
+	for i := range apeTargets {
+		target, err := controlTarget(&apeTargets[i])
+		if err != nil {
+			return nil, status.Error(codes.Internal, err.Error())
+		}
+		targets = append(targets, &target)
+	}
+
+	resp := &control.ListTargetsLocalOverridesResponse{
+		Body: &control.ListTargetsLocalOverridesResponse_Body{
+			Targets: targets,
+		},
+	}
+	err = SignMessage(s.key, resp)
+	if err != nil {
+		return nil, status.Error(codes.Internal, err.Error())
+	}
+	return resp, nil
+}
+
 func getCodeByLocalStorageErr(err error) codes.Code {
 	if errors.Is(err, engine.ErrChainNotFound) || errors.Is(err, engine.ErrChainNameNotFound) {
 		return codes.NotFound

pkg/services/control/service.proto

@@ -57,6 +57,9 @@ service ControlService {
     // Remove local access policy engine overrides stored in the node by chaind id.
     rpc RemoveChainLocalOverride (RemoveChainLocalOverrideRequest) returns (RemoveChainLocalOverrideResponse);
 
+    // List targets of the local APE overrides stored in the node.
+    rpc ListTargetsLocalOverrides (ListTargetsLocalOverridesRequest) returns (ListTargetsLocalOverridesResponse);
+
     // Flush objects from write-cache and move it to degraded read only mode.
     rpc SealWriteCache(SealWriteCacheRequest) returns (SealWriteCacheResponse);
 }
@@ -505,6 +508,30 @@ message ListChainLocalOverridesResponse {
     Signature signature = 2;
 }
 
+// ListTargetsLocalOverrides request.
+message ListTargetsLocalOverridesRequest {
+    message Body {
+        // Target for which the overrides are applied.
+        string chainName = 1;
+    }
+
+    Body body = 1;
+
+    Signature signature = 2;
+}
+
+// ListTargetsLocalOverrides response.
+message ListTargetsLocalOverridesResponse {
+    message Body {
+        // The list of chain targets.
+        repeated ChainTarget targets = 1;
+    }
+
+    Body body = 1;
+
+    Signature signature = 2;
+}
+
 message RemoveChainLocalOverrideRequest {
     message Body {
         // Target for which the overrides are applied.

pkg/services/control/service_frostfs.pb.go

@@ -2582,6 +2582,182 @@ func (x *ListChainLocalOverridesResponse) SetSignature(sig *Signature) {
 	x.Signature = sig
 }
 
+// StableSize returns the size of x in protobuf format.
+//
+// Structures with the same field values have the same binary size.
+func (x *ListTargetsLocalOverridesRequest_Body) StableSize() (size int) {
+	if x == nil {
+		return 0
+	}
+	size += proto.StringSize(1, x.ChainName)
+	return size
+}
+
+// StableMarshal marshals x in protobuf binary format with stable field order.
+//
+// If buffer length is less than x.StableSize(), new buffer is allocated.
+//
+// Returns any error encountered which did not allow writing the data completely.
+// Otherwise, returns the buffer in which the data is written.
+//
+// Structures with the same field values have the same binary format.
+func (x *ListTargetsLocalOverridesRequest_Body) StableMarshal(buf []byte) []byte {
+	if x == nil {
+		return []byte{}
+	}
+	if buf == nil {
+		buf = make([]byte, x.StableSize())
+	}
+	var offset int
+	offset += proto.StringMarshal(1, buf[offset:], x.ChainName)
+	return buf
+}
+
+// StableSize returns the size of x in protobuf format.
+//
+// Structures with the same field values have the same binary size.
+func (x *ListTargetsLocalOverridesRequest) StableSize() (size int) {
+	if x == nil {
+		return 0
+	}
+	size += proto.NestedStructureSize(1, x.Body)
+	size += proto.NestedStructureSize(2, x.Signature)
+	return size
+}
+
+// StableMarshal marshals x in protobuf binary format with stable field order.
+//
+// If buffer length is less than x.StableSize(), new buffer is allocated.
+//
+// Returns any error encountered which did not allow writing the data completely.
+// Otherwise, returns the buffer in which the data is written.
+//
+// Structures with the same field values have the same binary format.
+func (x *ListTargetsLocalOverridesRequest) StableMarshal(buf []byte) []byte {
+	if x == nil {
+		return []byte{}
+	}
+	if buf == nil {
+		buf = make([]byte, x.StableSize())
+	}
+	var offset int
+	offset += proto.NestedStructureMarshal(1, buf[offset:], x.Body)
+	offset += proto.NestedStructureMarshal(2, buf[offset:], x.Signature)
+	return buf
+}
+
+// ReadSignedData fills buf with signed data of x.
+// If buffer length is less than x.SignedDataSize(), new buffer is allocated.
+//
+// Returns any error encountered which did not allow writing the data completely.
+// Otherwise, returns the buffer in which the data is written.
+//
+// Structures with the same field values have the same signed data.
+func (x *ListTargetsLocalOverridesRequest) SignedDataSize() int {
+	return x.GetBody().StableSize()
+}
+
+// SignedDataSize returns size of the request signed data in bytes.
+//
+// Structures with the same field values have the same signed data size.
+func (x *ListTargetsLocalOverridesRequest) ReadSignedData(buf []byte) ([]byte, error) {
+	return x.GetBody().StableMarshal(buf), nil
+}
+
+func (x *ListTargetsLocalOverridesRequest) SetSignature(sig *Signature) {
+	x.Signature = sig
+}
+
+// StableSize returns the size of x in protobuf format.
+//
+// Structures with the same field values have the same binary size.
+func (x *ListTargetsLocalOverridesResponse_Body) StableSize() (size int) {
+	if x == nil {
+		return 0
+	}
+	for i := range x.Targets {
+		size += proto.NestedStructureSize(1, x.Targets[i])
+	}
+	return size
+}
+
+// StableMarshal marshals x in protobuf binary format with stable field order.
+//
+// If buffer length is less than x.StableSize(), new buffer is allocated.
+//
+// Returns any error encountered which did not allow writing the data completely.
+// Otherwise, returns the buffer in which the data is written.
+//
+// Structures with the same field values have the same binary format.
+func (x *ListTargetsLocalOverridesResponse_Body) StableMarshal(buf []byte) []byte {
+	if x == nil {
+		return []byte{}
+	}
+	if buf == nil {
+		buf = make([]byte, x.StableSize())
+	}
+	var offset int
+	for i := range x.Targets {
+		offset += proto.NestedStructureMarshal(1, buf[offset:], x.Targets[i])
+	}
+	return buf
+}
+
+// StableSize returns the size of x in protobuf format.
+//
+// Structures with the same field values have the same binary size.
+func (x *ListTargetsLocalOverridesResponse) StableSize() (size int) {
+	if x == nil {
+		return 0
+	}
+	size += proto.NestedStructureSize(1, x.Body)
+	size += proto.NestedStructureSize(2, x.Signature)
+	return size
+}
+
+// StableMarshal marshals x in protobuf binary format with stable field order.
+//
+// If buffer length is less than x.StableSize(), new buffer is allocated.
+//
+// Returns any error encountered which did not allow writing the data completely.
+// Otherwise, returns the buffer in which the data is written.
+//
+// Structures with the same field values have the same binary format.
+func (x *ListTargetsLocalOverridesResponse) StableMarshal(buf []byte) []byte {
+	if x == nil {
+		return []byte{}
+	}
+	if buf == nil {
+		buf = make([]byte, x.StableSize())
+	}
+	var offset int
+	offset += proto.NestedStructureMarshal(1, buf[offset:], x.Body)
+	offset += proto.NestedStructureMarshal(2, buf[offset:], x.Signature)
+	return buf
+}
+
+// ReadSignedData fills buf with signed data of x.
+// If buffer length is less than x.SignedDataSize(), new buffer is allocated.
+//
+// Returns any error encountered which did not allow writing the data completely.
+// Otherwise, returns the buffer in which the data is written.
+//
+// Structures with the same field values have the same signed data.
+func (x *ListTargetsLocalOverridesResponse) SignedDataSize() int {
+	return x.GetBody().StableSize()
+}
+
+// SignedDataSize returns size of the request signed data in bytes.
+//
+// Structures with the same field values have the same signed data size.
+func (x *ListTargetsLocalOverridesResponse) ReadSignedData(buf []byte) ([]byte, error) {
+	return x.GetBody().StableMarshal(buf), nil
+}
+
+func (x *ListTargetsLocalOverridesResponse) SetSignature(sig *Signature) {
+	x.Signature = sig
+}
+
 // StableSize returns the size of x in protobuf format.
 //
 // Structures with the same field values have the same binary size.

pkg/services/control/service_grpc.pb.go

@@ -35,6 +35,7 @@ const (
 	ControlService_GetChainLocalOverride_FullMethodName     = "/control.ControlService/GetChainLocalOverride"
 	ControlService_ListChainLocalOverrides_FullMethodName   = "/control.ControlService/ListChainLocalOverrides"
 	ControlService_RemoveChainLocalOverride_FullMethodName  = "/control.ControlService/RemoveChainLocalOverride"
+	ControlService_ListTargetsLocalOverrides_FullMethodName = "/control.ControlService/ListTargetsLocalOverrides"
 	ControlService_SealWriteCache_FullMethodName            = "/control.ControlService/SealWriteCache"
 )
 
@@ -75,6 +76,8 @@ type ControlServiceClient interface {
 	ListChainLocalOverrides(ctx context.Context, in *ListChainLocalOverridesRequest, opts ...grpc.CallOption) (*ListChainLocalOverridesResponse, error)
 	// Remove local access policy engine overrides stored in the node by chaind id.
 	RemoveChainLocalOverride(ctx context.Context, in *RemoveChainLocalOverrideRequest, opts ...grpc.CallOption) (*RemoveChainLocalOverrideResponse, error)
+	// List targets of the local APE overrides stored in the node.
+	ListTargetsLocalOverrides(ctx context.Context, in *ListTargetsLocalOverridesRequest, opts ...grpc.CallOption) (*ListTargetsLocalOverridesResponse, error)
 	// Flush objects from write-cache and move it to degraded read only mode.
 	SealWriteCache(ctx context.Context, in *SealWriteCacheRequest, opts ...grpc.CallOption) (*SealWriteCacheResponse, error)
 }
@@ -231,6 +234,15 @@ func (c *controlServiceClient) RemoveChainLocalOverride(ctx context.Context, in
 	return out, nil
 }
 
+func (c *controlServiceClient) ListTargetsLocalOverrides(ctx context.Context, in *ListTargetsLocalOverridesRequest, opts ...grpc.CallOption) (*ListTargetsLocalOverridesResponse, error) {
+	out := new(ListTargetsLocalOverridesResponse)
+	err := c.cc.Invoke(ctx, ControlService_ListTargetsLocalOverrides_FullMethodName, in, out, opts...)
+	if err != nil {
+		return nil, err
+	}
+	return out, nil
+}
+
 func (c *controlServiceClient) SealWriteCache(ctx context.Context, in *SealWriteCacheRequest, opts ...grpc.CallOption) (*SealWriteCacheResponse, error) {
 	out := new(SealWriteCacheResponse)
 	err := c.cc.Invoke(ctx, ControlService_SealWriteCache_FullMethodName, in, out, opts...)
@@ -277,6 +289,8 @@ type ControlServiceServer interface {
 	ListChainLocalOverrides(context.Context, *ListChainLocalOverridesRequest) (*ListChainLocalOverridesResponse, error)
 	// Remove local access policy engine overrides stored in the node by chaind id.
 	RemoveChainLocalOverride(context.Context, *RemoveChainLocalOverrideRequest) (*RemoveChainLocalOverrideResponse, error)
+	// List targets of the local APE overrides stored in the node.
+	ListTargetsLocalOverrides(context.Context, *ListTargetsLocalOverridesRequest) (*ListTargetsLocalOverridesResponse, error)
 	// Flush objects from write-cache and move it to degraded read only mode.
 	SealWriteCache(context.Context, *SealWriteCacheRequest) (*SealWriteCacheResponse, error)
 }
@@ -333,6 +347,9 @@ func (UnimplementedControlServiceServer) ListChainLocalOverrides(context.Context
 func (UnimplementedControlServiceServer) RemoveChainLocalOverride(context.Context, *RemoveChainLocalOverrideRequest) (*RemoveChainLocalOverrideResponse, error) {
 	return nil, status.Errorf(codes.Unimplemented, "method RemoveChainLocalOverride not implemented")
 }
+func (UnimplementedControlServiceServer) ListTargetsLocalOverrides(context.Context, *ListTargetsLocalOverridesRequest) (*ListTargetsLocalOverridesResponse, error) {
+	return nil, status.Errorf(codes.Unimplemented, "method ListTargetsLocalOverrides not implemented")
+}
 func (UnimplementedControlServiceServer) SealWriteCache(context.Context, *SealWriteCacheRequest) (*SealWriteCacheResponse, error) {
 	return nil, status.Errorf(codes.Unimplemented, "method SealWriteCache not implemented")
 }
@@ -636,6 +653,24 @@ func _ControlService_RemoveChainLocalOverride_Handler(srv interface{}, ctx conte
 	return interceptor(ctx, in, info, handler)
 }
 
+func _ControlService_ListTargetsLocalOverrides_Handler(srv interface{}, ctx context.Context, dec func(interface{}) error, interceptor grpc.UnaryServerInterceptor) (interface{}, error) {
+	in := new(ListTargetsLocalOverridesRequest)
+	if err := dec(in); err != nil {
+		return nil, err
+	}
+	if interceptor == nil {
+		return srv.(ControlServiceServer).ListTargetsLocalOverrides(ctx, in)
+	}
+	info := &grpc.UnaryServerInfo{
+		Server:     srv,
+		FullMethod: ControlService_ListTargetsLocalOverrides_FullMethodName,
+	}
+	handler := func(ctx context.Context, req interface{}) (interface{}, error) {
+		return srv.(ControlServiceServer).ListTargetsLocalOverrides(ctx, req.(*ListTargetsLocalOverridesRequest))
+	}
+	return interceptor(ctx, in, info, handler)
+}
+
 func _ControlService_SealWriteCache_Handler(srv interface{}, ctx context.Context, dec func(interface{}) error, interceptor grpc.UnaryServerInterceptor) (interface{}, error) {
 	in := new(SealWriteCacheRequest)
 	if err := dec(in); err != nil {
@@ -725,6 +760,10 @@ var ControlService_ServiceDesc = grpc.ServiceDesc{
 			MethodName: "RemoveChainLocalOverride",
 			Handler:    _ControlService_RemoveChainLocalOverride_Handler,
 		},
+		{
+			MethodName: "ListTargetsLocalOverrides",
+			Handler:    _ControlService_ListTargetsLocalOverrides_Handler,
+		},
 		{
 			MethodName: "SealWriteCache",
 			Handler:    _ControlService_SealWriteCache_Handler,