pkg/common/bizerror/error.go

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package bizerror

import "fmt"

type Error interface {
	Code() ErrorCode
	Message() string
	Error() string
	String() string
}

type ErrorCode string

const (
	InternalError   ErrorCode = "InternalError"
	UnknownError    ErrorCode = "UnknownError"
	InvalidArgument ErrorCode = "InvalidArgument"
	StoreError      ErrorCode = "StoreError"
	AppNotFound     ErrorCode = "AppNotFound"
	Unauthorized    ErrorCode = "Unauthorized"
	SessionError    ErrorCode = "SessionError"
	DiscoveryError  ErrorCode = "DiscoveryError"
	ConfigError     ErrorCode = "ConfigError"
	NacosError      ErrorCode = "NacosError"
	ZKError         ErrorCode = "ZKError"
	EventError      ErrorCode = "EventError"
	GovernorError   ErrorCode = "GovernorError"
	JsonError       ErrorCode = "JsonError"
	YamlError       ErrorCode = "YamlError"
	NotFoundError   ErrorCode = "NotFoundError"
	NetWorkError    ErrorCode = "NetWorkError"
	LockNotHeld     ErrorCode = "LockNotHeld"
	LockExpired     ErrorCode = "LockExpired"
)

type bizError struct {
	code    ErrorCode
	message string
	cause   error
}

var _ Error = &bizError{}

func New(code ErrorCode, message string) Error {
	return &bizError{
		code:    code,
		message: message,
	}
}

func Wrap(cause error, code ErrorCode, message string) Error {
	return &bizError{
		cause:   cause,
		code:    code,
		message: message,
	}
}

func (b *bizError) Code() ErrorCode {
	return b.code
}

func (b *bizError) Message() string {
	return b.message
}

func (b *bizError) Error() string {
	if b.cause != nil {
		return fmt.Sprintf("%s, cause: %s", b.String(), b.cause.Error())
	}
	return b.String()
}

func (b *bizError) String() string {
	return "[" + string(b.code) + "], " + b.message
}