1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
|
package shared
import (
"context"
"errors"
"fmt"
"strconv"
"github.com/rs/zerolog"
"google.golang.org/genproto/googleapis/rpc/errdetails"
"google.golang.org/grpc/codes"
"google.golang.org/grpc/status"
v1 "github.com/authzed/authzed-go/proto/authzed/api/v1"
"github.com/authzed/spicedb/internal/dispatch"
"github.com/authzed/spicedb/internal/graph"
log "github.com/authzed/spicedb/internal/logging"
"github.com/authzed/spicedb/internal/sharederrors"
"github.com/authzed/spicedb/pkg/cursor"
"github.com/authzed/spicedb/pkg/datastore"
dispatchv1 "github.com/authzed/spicedb/pkg/proto/dispatch/v1"
"github.com/authzed/spicedb/pkg/schema"
"github.com/authzed/spicedb/pkg/schemadsl/compiler"
"github.com/authzed/spicedb/pkg/spiceerrors"
)
// ErrServiceReadOnly is an extended GRPC error returned when a service is in read-only mode.
var ErrServiceReadOnly = mustMakeStatusReadonly()
func mustMakeStatusReadonly() error {
status, err := status.New(codes.Unavailable, "service read-only").WithDetails(&errdetails.ErrorInfo{
Reason: v1.ErrorReason_name[int32(v1.ErrorReason_ERROR_REASON_SERVICE_READ_ONLY)],
Domain: spiceerrors.Domain,
})
if err != nil {
panic("error constructing shared error type")
}
return status.Err()
}
// NewSchemaWriteDataValidationError creates a new error representing that a schema write cannot be
// completed due to existing data that would be left unreferenced.
func NewSchemaWriteDataValidationError(message string, args ...any) SchemaWriteDataValidationError {
return SchemaWriteDataValidationError{
error: fmt.Errorf(message, args...),
}
}
// SchemaWriteDataValidationError occurs when a schema cannot be applied due to leaving data unreferenced.
type SchemaWriteDataValidationError struct {
error
}
// MarshalZerologObject implements zerolog object marshalling.
func (err SchemaWriteDataValidationError) MarshalZerologObject(e *zerolog.Event) {
e.Err(err.error)
}
// GRPCStatus implements retrieving the gRPC status for the error.
func (err SchemaWriteDataValidationError) GRPCStatus() *status.Status {
return spiceerrors.WithCodeAndDetails(
err,
codes.InvalidArgument,
spiceerrors.ForReason(
v1.ErrorReason_ERROR_REASON_SCHEMA_TYPE_ERROR,
map[string]string{},
),
)
}
// MaxDepthExceededError is an error returned when the maximum depth for dispatching has been exceeded.
type MaxDepthExceededError struct {
*spiceerrors.WithAdditionalDetailsError
// AllowedMaximumDepth is the configured allowed maximum depth.
AllowedMaximumDepth uint32
}
// GRPCStatus implements retrieving the gRPC status for the error.
func (err MaxDepthExceededError) GRPCStatus() *status.Status {
return spiceerrors.WithCodeAndDetails(
err,
codes.ResourceExhausted,
spiceerrors.ForReason(
v1.ErrorReason_ERROR_REASON_MAXIMUM_DEPTH_EXCEEDED,
err.AddToDetails(map[string]string{
"maximum_depth_allowed": strconv.Itoa(int(err.AllowedMaximumDepth)),
}),
),
)
}
// NewMaxDepthExceededError creates a new MaxDepthExceededError.
func NewMaxDepthExceededError(allowedMaximumDepth uint32, isCheckRequest bool) error {
if isCheckRequest {
return MaxDepthExceededError{
spiceerrors.NewWithAdditionalDetailsError(fmt.Errorf("the check request has exceeded the allowable maximum depth of %d: this usually indicates a recursive or too deep data dependency. Try running zed with --explain to see the dependency. See: https://spicedb.dev/d/debug-max-depth-check", allowedMaximumDepth)),
allowedMaximumDepth,
}
}
return MaxDepthExceededError{
spiceerrors.NewWithAdditionalDetailsError(fmt.Errorf("the request has exceeded the allowable maximum depth of %d: this usually indicates a recursive or too deep data dependency. See: https://spicedb.dev/d/debug-max-depth", allowedMaximumDepth)),
allowedMaximumDepth,
}
}
func AsValidationError(err error) *SchemaWriteDataValidationError {
var validationErr SchemaWriteDataValidationError
if errors.As(err, &validationErr) {
return &validationErr
}
return nil
}
type ConfigForErrors struct {
MaximumAPIDepth uint32
DebugTrace *v1.DebugInformation
}
func RewriteErrorWithoutConfig(ctx context.Context, err error) error {
return rewriteError(ctx, err, nil)
}
func RewriteError(ctx context.Context, err error, config *ConfigForErrors) error {
rerr := rewriteError(ctx, err, config)
if config != nil && config.DebugTrace != nil {
spiceerrors.WithAdditionalDetails(rerr, spiceerrors.DebugTraceErrorDetailsKey, config.DebugTrace.String())
}
return rerr
}
func rewriteError(ctx context.Context, err error, config *ConfigForErrors) error {
// Check if the error can be directly used.
if _, ok := status.FromError(err); ok {
return err
}
// Otherwise, convert any graph/datastore errors.
var nsNotFoundError sharederrors.UnknownNamespaceError
var relationNotFoundError sharederrors.UnknownRelationError
var compilerError compiler.BaseCompilerError
var sourceError spiceerrors.WithSourceError
var typeError schema.TypeError
var maxDepthError dispatch.MaxDepthExceededError
switch {
case errors.As(err, &typeError):
return spiceerrors.WithCodeAndReason(err, codes.FailedPrecondition, v1.ErrorReason_ERROR_REASON_SCHEMA_TYPE_ERROR)
case errors.As(err, &compilerError):
return spiceerrors.WithCodeAndReason(err, codes.InvalidArgument, v1.ErrorReason_ERROR_REASON_SCHEMA_PARSE_ERROR)
case errors.As(err, &sourceError):
return spiceerrors.WithCodeAndReason(err, codes.InvalidArgument, v1.ErrorReason_ERROR_REASON_SCHEMA_PARSE_ERROR)
case errors.Is(err, cursor.ErrHashMismatch):
return spiceerrors.WithCodeAndReason(err, codes.FailedPrecondition, v1.ErrorReason_ERROR_REASON_INVALID_CURSOR)
case errors.As(err, &nsNotFoundError):
return spiceerrors.WithCodeAndReason(err, codes.FailedPrecondition, v1.ErrorReason_ERROR_REASON_UNKNOWN_DEFINITION)
case errors.As(err, &relationNotFoundError):
return spiceerrors.WithCodeAndReason(err, codes.FailedPrecondition, v1.ErrorReason_ERROR_REASON_UNKNOWN_RELATION_OR_PERMISSION)
case errors.As(err, &maxDepthError):
if config == nil {
return spiceerrors.MustBugf("missing config for API error")
}
_, isCheckRequest := maxDepthError.Request.(*dispatchv1.DispatchCheckRequest)
return NewMaxDepthExceededError(config.MaximumAPIDepth, isCheckRequest)
case errors.As(err, &datastore.ReadOnlyError{}):
return ErrServiceReadOnly
case errors.As(err, &datastore.InvalidRevisionError{}):
return status.Errorf(codes.OutOfRange, "invalid zedtoken: %s", err)
case errors.As(err, &datastore.CaveatNameNotFoundError{}):
return spiceerrors.WithCodeAndReason(err, codes.FailedPrecondition, v1.ErrorReason_ERROR_REASON_UNKNOWN_CAVEAT)
case errors.As(err, &datastore.WatchDisabledError{}):
return status.Errorf(codes.FailedPrecondition, "%s", err)
case errors.As(err, &datastore.CounterAlreadyRegisteredError{}):
return spiceerrors.WithCodeAndReason(err, codes.FailedPrecondition, v1.ErrorReason_ERROR_REASON_COUNTER_ALREADY_REGISTERED)
case errors.As(err, &datastore.CounterNotRegisteredError{}):
return spiceerrors.WithCodeAndReason(err, codes.FailedPrecondition, v1.ErrorReason_ERROR_REASON_COUNTER_NOT_REGISTERED)
case errors.As(err, &graph.RelationMissingTypeInfoError{}):
return status.Errorf(codes.FailedPrecondition, "failed precondition: %s", err)
case errors.As(err, &graph.AlwaysFailError{}):
log.Ctx(ctx).Err(err).Msg("received internal error")
return status.Errorf(codes.Internal, "internal error: %s", err)
case errors.As(err, &graph.UnimplementedError{}):
return status.Errorf(codes.Unimplemented, "%s", err)
case errors.Is(err, context.DeadlineExceeded):
return status.Errorf(codes.DeadlineExceeded, "%s", err)
case errors.Is(err, context.Canceled):
err := context.Cause(ctx)
if err != nil {
if _, ok := status.FromError(err); ok {
return err
}
}
return status.Errorf(codes.Canceled, "%s", err)
default:
log.Ctx(ctx).Err(err).Msg("received unexpected error")
return err
}
}
|
