init v2

errors/codes.go

@@ -0,0 +1,285 @@
+package errors
+
+import (
+	"errors"
+	"fmt"
+)
+
+// Cancelled The operation was cancelled, typically by the caller.
+// HTTP Mapping: 499 Client Closed Request
+func Cancelled(reason, format string, a ...interface{}) error {
+	return &StatusError{
+		Code:    1,
+		Reason:  reason,
+		Message: fmt.Sprintf(format, a...),
+	}
+}
+
+func IsCancelled(err error) bool {
+	if se := new(StatusError); errors.As(err, &se) {
+		return se.Code == 1
+	}
+	return false
+}
+
+// Unknown error.
+// HTTP Mapping: 500 Internal Server Error
+func Unknown(reason, format string, a ...interface{}) error {
+	return &StatusError{
+		Code:    2,
+		Reason:  reason,
+		Message: fmt.Sprintf(format, a...),
+	}
+}
+
+func IsUnknown(err error) bool {
+	if se := new(StatusError); errors.As(err, &se) {
+		return se.Code == 2
+	}
+	return false
+}
+
+// InvalidArgument The client specified an invalid argument.
+// HTTP Mapping: 400 Bad Request
+func InvalidArgument(reason, format string, a ...interface{}) error {
+	return &StatusError{
+		Code:    3,
+		Reason:  reason,
+		Message: fmt.Sprintf(format, a...),
+	}
+}
+
+func IsInvalidArgument(err error) bool {
+	if se := new(StatusError); errors.As(err, &se) {
+		return se.Code == 3
+	}
+	return false
+}
+
+// DeadlineExceeded The deadline expired before the operation could complete.
+// HTTP Mapping: 504 Gateway Timeout
+func DeadlineExceeded(reason, format string, a ...interface{}) error {
+	return &StatusError{
+		Code:    4,
+		Reason:  reason,
+		Message: fmt.Sprintf(format, a...),
+	}
+}
+
+func IsDeadlineExceeded(err error) bool {
+	if se := new(StatusError); errors.As(err, &se) {
+		return se.Code == 4
+	}
+	return false
+}
+
+// NotFound Some requested entity (e.g., file or directory) was not found.
+// HTTP Mapping: 404 Not Found
+func NotFound(reason, format string, a ...interface{}) error {
+	return &StatusError{
+		Code:    5,
+		Reason:  reason,
+		Message: fmt.Sprintf(format, a...),
+	}
+}
+
+func IsNotFound(err error) bool {
+	if se := new(StatusError); errors.As(err, &se) {
+		return se.Code == 5
+	}
+	return false
+}
+
+// AlreadyExists The entity that a client attempted to create (e.g., file or directory) already exists.
+// HTTP Mapping: 409 Conflict
+func AlreadyExists(reason, format string, a ...interface{}) error {
+	return &StatusError{
+		Code:    6,
+		Reason:  reason,
+		Message: fmt.Sprintf(format, a...),
+	}
+}
+
+func IsAlreadyExists(err error) bool {
+	if se := new(StatusError); errors.As(err, &se) {
+		return se.Code == 6
+	}
+	return false
+}
+
+// PermissionDenied The caller does not have permission to execute the specified operation.
+// HTTP Mapping: 403 Forbidden
+func PermissionDenied(reason, format string, a ...interface{}) error {
+	return &StatusError{
+		Code:    7,
+		Reason:  reason,
+		Message: fmt.Sprintf(format, a...),
+	}
+}
+
+func IsPermissionDenied(err error) bool {
+	if se := new(StatusError); errors.As(err, &se) {
+		return se.Code == 7
+	}
+	return false
+}
+
+// ResourceExhausted Some resource has been exhausted, perhaps a per-user quota, or
+// perhaps the entire file system is out of space.
+// HTTP Mapping: 429 Too Many Requests
+func ResourceExhausted(reason, format string, a ...interface{}) error {
+	return &StatusError{
+		Code:    8,
+		Reason:  reason,
+		Message: fmt.Sprintf(format, a...),
+	}
+}
+
+func IsResourceExhausted(err error) bool {
+	if se := new(StatusError); errors.As(err, &se) {
+		return se.Code == 8
+	}
+	return false
+}
+
+// FailedPrecondition The operation was rejected because the system is not in a state
+// required for the operation's execution.
+// HTTP Mapping: 400 Bad Request
+func FailedPrecondition(reason, format string, a ...interface{}) error {
+	return &StatusError{
+		Code:    9,
+		Reason:  reason,
+		Message: fmt.Sprintf(format, a...),
+	}
+}
+
+func IsFailedPrecondition(err error) bool {
+	if se := new(StatusError); errors.As(err, &se) {
+		return se.Code == 9
+	}
+	return false
+}
+
+// Aborted The operation was aborted, typically due to a concurrency issue such as
+// a sequencer check failure or transaction abort.
+// HTTP Mapping: 409 Conflict
+func Aborted(reason, format string, a ...interface{}) error {
+	return &StatusError{
+		Code:    10,
+		Reason:  reason,
+		Message: fmt.Sprintf(format, a...),
+	}
+}
+
+func IsAborted(err error) bool {
+	if se := new(StatusError); errors.As(err, &se) {
+		return se.Code == 10
+	}
+	return false
+}
+
+// OutOfRange The operation was attempted past the valid range.  E.g., seeking or
+// reading past end-of-file.
+// HTTP Mapping: 400 Bad Request
+func OutOfRange(reason, format string, a ...interface{}) error {
+	return &StatusError{
+		Code:    11,
+		Reason:  reason,
+		Message: fmt.Sprintf(format, a...),
+	}
+}
+
+func IsOutOfRange(err error) bool {
+	if se := new(StatusError); errors.As(err, &se) {
+		return se.Code == 11
+	}
+	return false
+}
+
+// Unimplemented The operation is not implemented or is not supported/enabled in this service.
+// HTTP Mapping: 501 Not Implemented
+func Unimplemented(reason, format string, a ...interface{}) error {
+	return &StatusError{
+		Code:    12,
+		Reason:  reason,
+		Message: fmt.Sprintf(format, a...),
+	}
+}
+
+func IsUnimplemented(err error) bool {
+	if se := new(StatusError); errors.As(err, &se) {
+		return se.Code == 12
+	}
+	return false
+}
+
+// Internal This means that some invariants expected by the
+// underlying system have been broken.  This error code is reserved
+// for serious errors.
+//
+// HTTP Mapping: 500 Internal Server Error
+func Internal(reason, format string, a ...interface{}) error {
+	return &StatusError{
+		Code:    13,
+		Reason:  reason,
+		Message: fmt.Sprintf(format, a...),
+	}
+}
+
+func IsInternal(err error) bool {
+	if se := new(StatusError); errors.As(err, &se) {
+		return se.Code == 13
+	}
+	return false
+}
+
+// Unavailable The service is currently unavailable.
+// HTTP Mapping: 503 Service Unavailable
+func Unavailable(reason, format string, a ...interface{}) error {
+	return &StatusError{
+		Code:    14,
+		Reason:  reason,
+		Message: fmt.Sprintf(format, a...),
+	}
+}
+
+func IsUnavailable(err error) bool {
+	if se := new(StatusError); errors.As(err, &se) {
+		return se.Code == 14
+	}
+	return false
+}
+
+// DataLoss Unrecoverable data loss or corruption.
+// HTTP Mapping: 500 Internal Server Error
+func DataLoss(reason, format string, a ...interface{}) error {
+	return &StatusError{
+		Code:    15,
+		Reason:  reason,
+		Message: fmt.Sprintf(format, a...),
+	}
+}
+
+func IsDataLoss(err error) bool {
+	if se := new(StatusError); errors.As(err, &se) {
+		return se.Code == 15
+	}
+	return false
+}
+
+// Unauthorized The request does not have valid authentication credentials for the operation.
+// HTTP Mapping: 401 Unauthorized
+func Unauthorized(reason, format string, a ...interface{}) error {
+	return &StatusError{
+		Code:    16,
+		Reason:  reason,
+		Message: fmt.Sprintf(format, a...),
+	}
+}
+
+func IsUnauthorized(err error) bool {
+	if se := new(StatusError); errors.As(err, &se) {
+		return se.Code == 16
+	}
+	return false
+}

errors/errors.go

@@ -0,0 +1,73 @@
+package errors
+
+import (
+	"errors"
+	"fmt"
+)
+
+const (
+	// UnknownReason is unknown reason for error info.
+	UnknownReason = ""
+	// SupportPackageIsVersion1 this constant should not be referenced by any other code.
+	SupportPackageIsVersion1 = true
+)
+
+var _ error = (*StatusError)(nil)
+
+// StatusError contains an error response from the server.
+type StatusError = Status
+
+// Is matches each error in the chain with the target value.
+func (e *StatusError) Is(target error) bool {
+	err, ok := target.(*StatusError)
+	if ok {
+		return e.Code == err.Code
+	}
+	return false
+}
+
+func (e *StatusError) Error() string {
+	return fmt.Sprintf("error: code = %d reason = %s message = %s details = %+v", e.Code, e.Reason, e.Message, e.Details)
+}
+
+// Error returns a Status representing c and msg.
+func Error(code int32, reason, message string) error {
+	return &StatusError{
+		Code:    code,
+		Reason:  reason,
+		Message: message,
+	}
+}
+
+// Errorf returns New(c, fmt.Sprintf(format, a...)).
+func Errorf(code int32, reason, format string, a ...interface{}) error {
+	return Error(code, reason, fmt.Sprintf(format, a...))
+}
+
+// Code returns the status code.
+func Code(err error) int32 {
+	if err == nil {
+		return 0 // ok
+	}
+	if se := new(StatusError); errors.As(err, &se) {
+		return se.Code
+	}
+	return 2 // unknown
+}
+
+// Reason returns the status for a particular error.
+// It supports wrapped errors.
+func Reason(err error) string {
+	if se := new(StatusError); errors.As(err, &se) {
+		return se.Reason
+	}
+	return UnknownReason
+}
+
+// FromError returns status error.
+func FromError(err error) (*StatusError, bool) {
+	if se := new(StatusError); errors.As(err, &se) {
+		return se, true
+	}
+	return nil, false
+}

errors/errors.pb.go

@@ -0,0 +1,187 @@
+// Code generated by protoc-gen-go. DO NOT EDIT.
+// versions:
+// 	protoc-gen-go v1.25.0
+// 	protoc        v3.13.0
+// source: errors.proto
+
+package errors
+
+import (
+	proto "github.com/golang/protobuf/proto"
+	any "github.com/golang/protobuf/ptypes/any"
+	protoreflect "google.golang.org/protobuf/reflect/protoreflect"
+	protoimpl "google.golang.org/protobuf/runtime/protoimpl"
+	reflect "reflect"
+	sync "sync"
+)
+
+const (
+	// Verify that this generated code is sufficiently up-to-date.
+	_ = protoimpl.EnforceVersion(20 - protoimpl.MinVersion)
+	// Verify that runtime/protoimpl is sufficiently up-to-date.
+	_ = protoimpl.EnforceVersion(protoimpl.MaxVersion - 20)
+)
+
+// This is a compile-time assertion that a sufficiently up-to-date version
+// of the legacy proto package is being used.
+const _ = proto.ProtoPackageIsVersion4
+
+type Status struct {
+	state         protoimpl.MessageState
+	sizeCache     protoimpl.SizeCache
+	unknownFields protoimpl.UnknownFields
+
+	Code    int32      `protobuf:"varint,1,opt,name=code,proto3" json:"code,omitempty"`
+	Reason  string     `protobuf:"bytes,2,opt,name=reason,proto3" json:"reason,omitempty"`
+	Message string     `protobuf:"bytes,3,opt,name=message,proto3" json:"message,omitempty"`
+	Details []*any.Any `protobuf:"bytes,4,rep,name=details,proto3" json:"details,omitempty"`
+}
+
+func (x *Status) Reset() {
+	*x = Status{}
+	if protoimpl.UnsafeEnabled {
+		mi := &file_errors_proto_msgTypes[0]
+		ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
+		ms.StoreMessageInfo(mi)
+	}
+}
+
+func (x *Status) String() string {
+	return protoimpl.X.MessageStringOf(x)
+}
+
+func (*Status) ProtoMessage() {}
+
+func (x *Status) ProtoReflect() protoreflect.Message {
+	mi := &file_errors_proto_msgTypes[0]
+	if protoimpl.UnsafeEnabled && x != nil {
+		ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
+		if ms.LoadMessageInfo() == nil {
+			ms.StoreMessageInfo(mi)
+		}
+		return ms
+	}
+	return mi.MessageOf(x)
+}
+
+// Deprecated: Use Status.ProtoReflect.Descriptor instead.
+func (*Status) Descriptor() ([]byte, []int) {
+	return file_errors_proto_rawDescGZIP(), []int{0}
+}
+
+func (x *Status) GetCode() int32 {
+	if x != nil {
+		return x.Code
+	}
+	return 0
+}
+
+func (x *Status) GetReason() string {
+	if x != nil {
+		return x.Reason
+	}
+	return ""
+}
+
+func (x *Status) GetMessage() string {
+	if x != nil {
+		return x.Message
+	}
+	return ""
+}
+
+func (x *Status) GetDetails() []*any.Any {
+	if x != nil {
+		return x.Details
+	}
+	return nil
+}
+
+var File_errors_proto protoreflect.FileDescriptor
+
+var file_errors_proto_rawDesc = []byte{
+	0x0a, 0x0c, 0x65, 0x72, 0x72, 0x6f, 0x72, 0x73, 0x2e, 0x70, 0x72, 0x6f, 0x74, 0x6f, 0x12, 0x0d,
+	0x6b, 0x72, 0x61, 0x74, 0x6f, 0x73, 0x2e, 0x65, 0x72, 0x72, 0x6f, 0x72, 0x73, 0x1a, 0x19, 0x67,
+	0x6f, 0x6f, 0x67, 0x6c, 0x65, 0x2f, 0x70, 0x72, 0x6f, 0x74, 0x6f, 0x62, 0x75, 0x66, 0x2f, 0x61,
+	0x6e, 0x79, 0x2e, 0x70, 0x72, 0x6f, 0x74, 0x6f, 0x22, 0x7e, 0x0a, 0x06, 0x53, 0x74, 0x61, 0x74,
+	0x75, 0x73, 0x12, 0x12, 0x0a, 0x04, 0x63, 0x6f, 0x64, 0x65, 0x18, 0x01, 0x20, 0x01, 0x28, 0x05,
+	0x52, 0x04, 0x63, 0x6f, 0x64, 0x65, 0x12, 0x16, 0x0a, 0x06, 0x72, 0x65, 0x61, 0x73, 0x6f, 0x6e,
+	0x18, 0x02, 0x20, 0x01, 0x28, 0x09, 0x52, 0x06, 0x72, 0x65, 0x61, 0x73, 0x6f, 0x6e, 0x12, 0x18,
+	0x0a, 0x07, 0x6d, 0x65, 0x73, 0x73, 0x61, 0x67, 0x65, 0x18, 0x03, 0x20, 0x01, 0x28, 0x09, 0x52,
+	0x07, 0x6d, 0x65, 0x73, 0x73, 0x61, 0x67, 0x65, 0x12, 0x2e, 0x0a, 0x07, 0x64, 0x65, 0x74, 0x61,
+	0x69, 0x6c, 0x73, 0x18, 0x04, 0x20, 0x03, 0x28, 0x0b, 0x32, 0x14, 0x2e, 0x67, 0x6f, 0x6f, 0x67,
+	0x6c, 0x65, 0x2e, 0x70, 0x72, 0x6f, 0x74, 0x6f, 0x62, 0x75, 0x66, 0x2e, 0x41, 0x6e, 0x79, 0x52,
+	0x07, 0x64, 0x65, 0x74, 0x61, 0x69, 0x6c, 0x73, 0x42, 0x62, 0x0a, 0x11, 0x64, 0x65, 0x76, 0x2e,
+	0x6b, 0x72, 0x61, 0x74, 0x6f, 0x73, 0x2e, 0x65, 0x72, 0x72, 0x6f, 0x72, 0x73, 0x42, 0x0b, 0x45,
+	0x72, 0x72, 0x6f, 0x72, 0x73, 0x50, 0x72, 0x6f, 0x74, 0x6f, 0x50, 0x01, 0x5a, 0x2c, 0x67, 0x69,
+	0x74, 0x68, 0x75, 0x62, 0x2e, 0x63, 0x6f, 0x6d, 0x2f, 0x67, 0x6f, 0x2d, 0x6b, 0x72, 0x61, 0x74,
+	0x6f, 0x73, 0x2f, 0x6b, 0x72, 0x61, 0x74, 0x6f, 0x73, 0x2f, 0x76, 0x32, 0x2f, 0x65, 0x72, 0x72,
+	0x6f, 0x72, 0x73, 0x3b, 0x65, 0x72, 0x72, 0x6f, 0x72, 0x73, 0xf8, 0x01, 0x01, 0xa2, 0x02, 0x0c,
+	0x4b, 0x72, 0x61, 0x74, 0x6f, 0x73, 0x45, 0x72, 0x72, 0x6f, 0x72, 0x73, 0x62, 0x06, 0x70, 0x72,
+	0x6f, 0x74, 0x6f, 0x33,
+}
+
+var (
+	file_errors_proto_rawDescOnce sync.Once
+	file_errors_proto_rawDescData = file_errors_proto_rawDesc
+)
+
+func file_errors_proto_rawDescGZIP() []byte {
+	file_errors_proto_rawDescOnce.Do(func() {
+		file_errors_proto_rawDescData = protoimpl.X.CompressGZIP(file_errors_proto_rawDescData)
+	})
+	return file_errors_proto_rawDescData
+}
+
+var file_errors_proto_msgTypes = make([]protoimpl.MessageInfo, 1)
+var file_errors_proto_goTypes = []interface{}{
+	(*Status)(nil),  // 0: kratos.errors.Status
+	(*any.Any)(nil), // 1: google.protobuf.Any
+}
+var file_errors_proto_depIdxs = []int32{
+	1, // 0: kratos.errors.Status.details:type_name -> google.protobuf.Any
+	1, // [1:1] is the sub-list for method output_type
+	1, // [1:1] is the sub-list for method input_type
+	1, // [1:1] is the sub-list for extension type_name
+	1, // [1:1] is the sub-list for extension extendee
+	0, // [0:1] is the sub-list for field type_name
+}
+
+func init() { file_errors_proto_init() }
+func file_errors_proto_init() {
+	if File_errors_proto != nil {
+		return
+	}
+	if !protoimpl.UnsafeEnabled {
+		file_errors_proto_msgTypes[0].Exporter = func(v interface{}, i int) interface{} {
+			switch v := v.(*Status); i {
+			case 0:
+				return &v.state
+			case 1:
+				return &v.sizeCache
+			case 2:
+				return &v.unknownFields
+			default:
+				return nil
+			}
+		}
+	}
+	type x struct{}
+	out := protoimpl.TypeBuilder{
+		File: protoimpl.DescBuilder{
+			GoPackagePath: reflect.TypeOf(x{}).PkgPath(),
+			RawDescriptor: file_errors_proto_rawDesc,
+			NumEnums:      0,
+			NumMessages:   1,
+			NumExtensions: 0,
+			NumServices:   0,
+		},
+		GoTypes:           file_errors_proto_goTypes,
+		DependencyIndexes: file_errors_proto_depIdxs,
+		MessageInfos:      file_errors_proto_msgTypes,
+	}.Build()
+	File_errors_proto = out.File
+	file_errors_proto_rawDesc = nil
+	file_errors_proto_goTypes = nil
+	file_errors_proto_depIdxs = nil
+}

errors/errors.proto

@@ -0,0 +1,19 @@
+syntax = "proto3";
+
+package kratos.errors;
+
+import "google/protobuf/any.proto";
+
+option cc_enable_arenas = true;
+option go_package = "github.com/go-kratos/kratos/v2/errors;errors";
+option java_multiple_files = true;
+option java_outer_classname = "ErrorsProto";
+option java_package = "com.github.kratos.errors";
+option objc_class_prefix = "KratosErrors";
+
+message Status {
+  int32 code = 1;
+  string reason = 2;
+  string message = 3;
+  repeated google.protobuf.Any details = 4;
+}

errors/errors_test.go

@@ -0,0 +1,54 @@
+package errors
+
+import (
+	"errors"
+	"fmt"
+	"testing"
+)
+
+func TestErrorsMatch(t *testing.T) {
+	s := &StatusError{Code: 1}
+	st := &StatusError{Code: 2}
+
+	if errors.Is(s, st) {
+		t.Errorf("error is not match: %+v -> %+v", s, st)
+	}
+
+	s.Code = 1
+	st.Code = 1
+	if !errors.Is(s, st) {
+		t.Errorf("error is not match: %+v -> %+v", s, st)
+	}
+
+	s.Reason = "test_reason"
+	s.Reason = "test_reason"
+
+	if !errors.Is(s, st) {
+		t.Errorf("error is not match: %+v -> %+v", s, st)
+	}
+
+	if Reason(s) != "test_reason" {
+		t.Errorf("error is not match: %+v -> %+v", s, st)
+	}
+}
+
+func TestErrorIs(t *testing.T) {
+	err1 := &StatusError{Code: 1}
+	t.Log(err1)
+	err2 := fmt.Errorf("wrap : %w", err1)
+	t.Log(err2)
+
+	if !(errors.Is(err2, err1)) {
+		t.Errorf("error is not match: a: %v b: %v ", err2, err1)
+	}
+}
+
+func TestErrorAs(t *testing.T) {
+	err1 := &StatusError{Code: 1}
+	err2 := fmt.Errorf("wrap : %w", err1)
+
+	err3 := new(StatusError)
+	if !errors.As(err2, &err3) {
+		t.Errorf("error is not match: %v", err2)
+	}
+}