frostfs-sdk-go/client/status/common.go

package apistatus

import (
	"encoding/binary"

	status "git.frostfs.info/TrueCloudLab/frostfs-api-go/v2/status"
	statusgrpc "git.frostfs.info/TrueCloudLab/frostfs-api-go/v2/status/grpc"
	"github.com/golang/protobuf/proto"
)

// ServerInternal describes failure statuses related to internal server errors.
// Instances provide Status and StatusV2 interfaces.
//
// The status is purely informative, the client should not go into details of the error except for debugging needs.
type ServerInternal struct {
	status *statusgrpc.Status
}

func NewServerInternal() ServerInternal {
	return ServerInternal{
		status: new(statusgrpc.Status),
	}
}

func (x ServerInternal) Error() string {
	return errMessageStatusV2(
		globalizeCodeV2(status.Internal, status.GlobalizeCommonFail),
		x.status.GetMessage(),
	)
}

// implements local interface defined in FromStatusV2 func.
func (x ServerInternal) fromStatusV2(st *statusgrpc.Status) {
	if x.status == nil {
		x.status = new(statusgrpc.Status)
	}
	proto.Merge(x.status, st)
}

// ToStatusV2 implements StatusV2 interface method.
// If the value was returned by FromStatusV2, returns the source message.
// Otherwise, returns message with
//   - code: INTERNAL;
//   - string message: empty;
//   - details: empty.
func (x ServerInternal) ToStatusV2() *statusgrpc.Status {
	x.status.SetCode(uint32(globalizeCodeV2(status.Internal, status.GlobalizeCommonFail)))
	return x.status
}

// SetMessage sets message describing internal error.
//
// Message should be used for debug purposes only.
func (x *ServerInternal) SetMessage(msg string) {
	x.status.SetMessage(msg)
}

// Message returns message describing internal server error.
//
// Message should be used for debug purposes only. By default, it is empty.
func (x ServerInternal) Message() string {
	return x.status.GetMessage()
}

// WriteInternalServerErr writes err message to ServerInternal instance.
func WriteInternalServerErr(x *ServerInternal, err error) {
	x.SetMessage(err.Error())
}

// WrongMagicNumber describes failure status related to incorrect network magic.
// Instances provide Status and StatusV2 interfaces.
type WrongMagicNumber struct {
	status *statusgrpc.Status
}

func NewWrongMagicNumber() WrongMagicNumber {
	return WrongMagicNumber{
		status: new(statusgrpc.Status),
	}
}

func (x WrongMagicNumber) Error() string {
	return errMessageStatusV2(
		globalizeCodeV2(status.WrongMagicNumber, status.GlobalizeCommonFail),
		x.status.GetMessage(),
	)
}

// implements local interface defined in FromStatusV2 func.
func (x WrongMagicNumber) fromStatusV2(st *statusgrpc.Status) {
	if x.status == nil {
		x.status = new(statusgrpc.Status)
	}
	proto.Merge(x.status, st)
}

// ToStatusV2 implements StatusV2 interface method.
// If the value was returned by FromStatusV2, returns the source message.
// Otherwise, returns message with
//   - code: WRONG_MAGIC_NUMBER;
//   - string message: empty;
//   - details: empty.
func (x WrongMagicNumber) ToStatusV2() *statusgrpc.Status {
	x.status.SetCode(uint32(globalizeCodeV2(status.WrongMagicNumber, status.GlobalizeCommonFail)))
	return x.status
}

// WriteCorrectMagic writes correct network magic.
func (x *WrongMagicNumber) WriteCorrectMagic(magic uint64) {
	// serialize the number
	buf := make([]byte, 8)

	binary.BigEndian.PutUint64(buf, magic)

	// create corresponding detail
	var d statusgrpc.Status_Detail

	d.SetId(statusgrpc.DetailIDCorrectMagic)
	d.SetValue(buf)

	// attach the detail
	x.status.AppendDetails(&d)
}

// CorrectMagic returns network magic returned by the server.
// Second value indicates presence status:
//   - -1 if number is presented in incorrect format
//   - 0 if number is not presented
//   - +1 otherwise
func (x WrongMagicNumber) CorrectMagic() (magic uint64, ok int8) {
	x.status.IterateDetails(func(d *statusgrpc.Status_Detail) bool {
		if d.GetId() == statusgrpc.DetailIDCorrectMagic {
			if val := d.GetValue(); len(val) == 8 {
				magic = binary.BigEndian.Uint64(val)
				ok = 1
			} else {
				ok = -1
			}
		}

		return ok != 0
	})

	return
}

// SignatureVerification describes failure status related to signature verification.
// Instances provide Status and StatusV2 interfaces.
type SignatureVerification struct {
	status *statusgrpc.Status
}

func NewSignatureVerification() SignatureVerification {
	return SignatureVerification{
		status: new(statusgrpc.Status),
	}
}

const defaultSignatureVerificationMsg = "signature verification failed"

func (x SignatureVerification) Error() string {
	msg := x.status.GetMessage()
	if msg == "" {
		msg = defaultSignatureVerificationMsg
	}

	return errMessageStatusV2(
		globalizeCodeV2(status.SignatureVerificationFail, status.GlobalizeCommonFail),
		msg,
	)
}

// implements local interface defined in FromStatusV2 func.
func (x SignatureVerification) fromStatusV2(st *statusgrpc.Status) {
	if x.status == nil {
		x.status = new(statusgrpc.Status)
	}
	proto.Merge(x.status, st)
}

// ToStatusV2 implements StatusV2 interface method.
// If the value was returned by FromStatusV2, returns the source message.
// Otherwise, returns message with
//   - code: SIGNATURE_VERIFICATION_FAIL;
//   - string message: written message via SetMessage or
//     "signature verification failed" as a default message;
//   - details: empty.
func (x SignatureVerification) ToStatusV2() *statusgrpc.Status {
	x.status.SetCode(uint32(globalizeCodeV2(status.SignatureVerificationFail, status.GlobalizeCommonFail)))

	if x.status.GetMessage() == "" {
		x.status.SetMessage(defaultSignatureVerificationMsg)
	}

	return x.status
}

// SetMessage writes signature verification failure message.
// Message should be used for debug purposes only.
//
// See also Message.
func (x *SignatureVerification) SetMessage(v string) {
	x.status.SetMessage(v)
}

// Message returns status message. Zero status returns empty message.
// Message should be used for debug purposes only.
//
// See also SetMessage.
func (x SignatureVerification) Message() string {
	return x.status.GetMessage()
}

// NodeUnderMaintenance describes failure status for nodes being under maintenance.
// Instances provide Status and StatusV2 interfaces.
type NodeUnderMaintenance struct {
	status *statusgrpc.Status
}

func NewNodeUnderMaintenance() NodeUnderMaintenance {
	return NodeUnderMaintenance{
		status: new(statusgrpc.Status),
	}
}

const defaultNodeUnderMaintenanceMsg = "node is under maintenance"

// Error implements the error interface.
func (x NodeUnderMaintenance) Error() string {
	msg := x.Message()
	if msg == "" {
		msg = defaultNodeUnderMaintenanceMsg
	}

	return errMessageStatusV2(
		globalizeCodeV2(status.NodeUnderMaintenance, status.GlobalizeCommonFail),
		msg,
	)
}

func (x NodeUnderMaintenance) fromStatusV2(st *statusgrpc.Status) {
	if x.status == nil {
		x.status = new(statusgrpc.Status)
	}
	proto.Merge(x.status, st)
}

// ToStatusV2 implements StatusV2 interface method.
// If the value was returned by FromStatusV2, returns the source message.
// Otherwise, returns message with
//   - code: NODE_UNDER_MAINTENANCE;
//   - string message: written message via SetMessage or
//     "node is under maintenance" as a default message;
//   - details: empty.
func (x NodeUnderMaintenance) ToStatusV2() *statusgrpc.Status {
	x.status.SetCode(uint32(globalizeCodeV2(status.NodeUnderMaintenance, status.GlobalizeCommonFail)))
	if x.status.GetMessage() == "" {
		x.status.SetMessage(defaultNodeUnderMaintenanceMsg)
	}

	return x.status
}

// SetMessage writes signature verification failure message.
// Message should be used for debug purposes only.
//
// See also Message.
func (x *NodeUnderMaintenance) SetMessage(v string) {
	x.status.SetMessage(v)
}

// Message returns status message. Zero status returns empty message.
// Message should be used for debug purposes only.
//
// See also SetMessage.
func (x NodeUnderMaintenance) Message() string {
	return x.status.GetMessage()
}