github.com/cs3org/reva/v2@v2.27.7/pkg/sdk/common/net/rpc.go (about)

     1  // Copyright 2018-2021 CERN
     2  //
     3  // Licensed under the Apache License, Version 2.0 (the "License");
     4  // you may not use this file except in compliance with the License.
     5  // You may obtain a copy of the License at
     6  //
     7  //     http://www.apache.org/licenses/LICENSE-2.0
     8  //
     9  // Unless required by applicable law or agreed to in writing, software
    10  // distributed under the License is distributed on an "AS IS" BASIS,
    11  // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    12  // See the License for the specific language governing permissions and
    13  // limitations under the License.
    14  //
    15  // In applying this license, CERN does not waive the privileges and immunities
    16  // granted to it by virtue of its status as an Intergovernmental Organization
    17  // or submit itself to any jurisdiction.
    18  
    19  package net
    20  
    21  import (
    22  	"fmt"
    23  
    24  	rpc "github.com/cs3org/go-cs3apis/cs3/rpc/v1beta1"
    25  )
    26  
    27  type rpcStatusGetter interface {
    28  	GetStatus() *rpc.Status
    29  }
    30  
    31  // CheckRPCInvocation checks if an RPC invocation has succeeded.
    32  // For this, the error from the original call is first checked; after that, the actual RPC response status is checked.
    33  func CheckRPCInvocation(operation string, res rpcStatusGetter, callErr error) error {
    34  	if callErr != nil {
    35  		return fmt.Errorf("%s: %v", operation, callErr)
    36  	}
    37  
    38  	return CheckRPCStatus(operation, res)
    39  }
    40  
    41  // CheckRPCStatus checks the returned status of an RPC call.
    42  func CheckRPCStatus(operation string, res rpcStatusGetter) error {
    43  	status := res.GetStatus()
    44  	if status.Code != rpc.Code_CODE_OK {
    45  		return fmt.Errorf("%s: %q (code=%+v, trace=%q)", operation, status.Message, status.Code, status.Trace)
    46  	}
    47  
    48  	return nil
    49  }