-
Notifications
You must be signed in to change notification settings - Fork 1
/
docstore.go
349 lines (306 loc) · 7.04 KB
/
docstore.go
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
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
package repository
import (
"context"
"errors"
"fmt"
"time"
"github.com/google/uuid"
"github.com/ttab/newsdoc"
"github.com/ttab/revisor"
)
type DocStore interface {
GetDocumentMeta(
ctx context.Context, uuid uuid.UUID) (*DocumentMeta, error)
GetDocument(
ctx context.Context, uuid uuid.UUID, version int64,
) (*newsdoc.Document, error)
GetVersion(
ctx context.Context, uuid uuid.UUID, version int64,
) (DocumentUpdate, error)
GetVersionHistory(
ctx context.Context, uuid uuid.UUID,
before int64, count int,
) ([]DocumentUpdate, error)
Update(
ctx context.Context,
workflows WorkflowProvider,
update []*UpdateRequest,
) ([]DocumentUpdate, error)
Delete(ctx context.Context, req DeleteRequest) error
CheckPermission(
ctx context.Context, req CheckPermissionRequest,
) (CheckPermissionResult, error)
GetEventlog(
ctx context.Context, after int64, limit int32,
) ([]Event, error)
GetLastEvent(
ctx context.Context,
) (*Event, error)
GetLastEventID(
ctx context.Context,
) (int64, error)
GetCompactedEventlog(
ctx context.Context, req GetCompactedEventlogRequest,
) ([]Event, error)
OnEventlog(
ctx context.Context, ch chan int64,
)
GetStatusHistory(
ctx context.Context, uuid uuid.UUID,
name string, before int64, count int,
) ([]Status, error)
GetDocumentACL(
ctx context.Context, uuid uuid.UUID,
) ([]ACLEntry, error)
Lock(
ctx context.Context, req LockRequest,
) (LockResult, error)
UpdateLock(
ctx context.Context, req UpdateLockRequest,
) (LockResult, error)
Unlock(
ctx context.Context, uuid uuid.UUID, token string,
) error
}
type SchemaStore interface {
RegisterSchema(
ctx context.Context, req RegisterSchemaRequest,
) error
ActivateSchema(
ctx context.Context, name, version string,
) error
DeactivateSchema(
ctx context.Context, name string,
) error
GetSchema(
ctx context.Context, name, version string,
) (*Schema, error)
GetActiveSchemas(ctx context.Context) ([]*Schema, error)
GetSchemaVersions(ctx context.Context) (map[string]string, error)
OnSchemaUpdate(ctx context.Context, ch chan SchemaEvent)
}
type WorkflowStore interface {
UpdateStatus(
ctx context.Context, req UpdateStatusRequest,
) error
GetStatuses(ctx context.Context) ([]DocumentStatus, error)
UpdateStatusRule(
ctx context.Context, rule StatusRule,
) error
DeleteStatusRule(
ctx context.Context, name string,
) error
GetStatusRules(ctx context.Context) ([]StatusRule, error)
}
type ReportStore interface {
UpdateReport(
ctx context.Context, report Report, enabled bool,
) (time.Time, error)
GetReport(
ctx context.Context, name string,
) (*StoredReport, error)
}
type MetricStore interface {
RegisterMetricKind(
ctx context.Context, name string, aggregation Aggregation,
) error
DeleteMetricKind(
ctx context.Context, name string,
) error
GetMetricKind(
ctx context.Context, name string,
) (*MetricKind, error)
GetMetricKinds(
ctx context.Context,
) ([]*MetricKind, error)
RegisterOrReplaceMetric(
ctx context.Context, metric Metric,
) error
RegisterOrIncrementMetric(
ctx context.Context, metric Metric,
) error
}
type DocumentStatus struct {
Name string
Disabled bool
}
type StatusRule struct {
Name string
Description string
AccessRule bool
AppliesTo []string
ForTypes []string
Expression string
}
type UpdateStatusRequest struct {
Name string
Disabled bool
}
type Schema struct {
Name string
Version string
Specification revisor.ConstraintSet
}
type RegisterSchemaRequest struct {
Name string
Version string
Specification revisor.ConstraintSet
Activate bool
}
type CheckPermissionRequest struct {
UUID uuid.UUID
GranteeURIs []string
Permission Permission
}
type CheckPermissionResult int
const (
PermissionCheckDenied = iota
PermissionCheckAllowed
PermissionCheckNoSuchDocument
)
type UpdateRequest struct {
UUID uuid.UUID
Updated time.Time
Updater string
Meta newsdoc.DataMap
ACL []ACLEntry
DefaultACL []ACLEntry
Status []StatusUpdate
Document *newsdoc.Document
IfMatch int64
LockToken string
}
type DeleteRequest struct {
UUID uuid.UUID
Updated time.Time
Updater string
Meta newsdoc.DataMap
IfMatch int64
LockToken string
}
type DocumentMeta struct {
Created time.Time
Modified time.Time
CurrentVersion int64
ACL []ACLEntry
Statuses map[string]Status
Deleting bool
Lock Lock
}
type ACLEntry struct {
URI string `json:"uri"`
Permissions []string `json:"permissions"`
}
type Lock struct {
Token string
URI string
Created time.Time
Expires time.Time
App string
Comment string
}
type LockRequest struct {
UUID uuid.UUID
URI string
TTL int32
App string
Comment string
}
type LockResult struct {
Token string
Created time.Time
Expires time.Time
}
type UpdateLockRequest struct {
UUID uuid.UUID
TTL int32
Token string
}
type DocumentUpdate struct {
Version int64
Creator string
Created time.Time
Meta newsdoc.DataMap
}
type Status struct {
ID int64
Version int64
Creator string
Created time.Time
Meta newsdoc.DataMap
}
type StatusUpdate struct {
Name string
Version int64
Meta newsdoc.DataMap
}
type Aggregation int16
const (
AggregationNone Aggregation = 0
AggregationReplace Aggregation = 1
AggregationIncrement Aggregation = 2
)
type MetricKind struct {
Name string
Aggregation Aggregation
}
type Metric struct {
UUID uuid.UUID
Kind string
Label string
Value int64
}
type GetCompactedEventlogRequest struct {
After int64
Until int64
Type string
Limit *int32
Offset int32
}
// DocStoreErrorCode TODO: Rename to StoreErrorCode and consistently rename all
// dependent types and methods.
type DocStoreErrorCode string
const (
NoErrCode DocStoreErrorCode = ""
ErrCodeNotFound DocStoreErrorCode = "not-found"
ErrCodeNoSuchLock DocStoreErrorCode = "no-such-lock"
ErrCodeOptimisticLock DocStoreErrorCode = "optimistic-lock"
ErrCodeDeleteLock DocStoreErrorCode = "delete-lock"
ErrCodeBadRequest DocStoreErrorCode = "bad-request"
ErrCodeExists DocStoreErrorCode = "exists"
ErrCodePermissionDenied DocStoreErrorCode = "permission-denied"
ErrCodeFailedPrecondition DocStoreErrorCode = "failed-precondition"
ErrCodeDocumentLock DocStoreErrorCode = "document-lock"
)
type DocStoreError struct {
cause error
code DocStoreErrorCode
msg string
}
func DocStoreErrorf(code DocStoreErrorCode, format string, a ...any) error {
e := fmt.Errorf(format, a...)
return DocStoreError{
cause: errors.Unwrap(e),
code: code,
msg: e.Error(),
}
}
func (e DocStoreError) Error() string {
return e.msg
}
func (e DocStoreError) Unwrap() error {
return e.cause
}
func IsDocStoreErrorCode(err error, code DocStoreErrorCode) bool {
return GetDocStoreErrorCode(err) == code
}
func GetDocStoreErrorCode(err error) DocStoreErrorCode {
if err == nil {
return NoErrCode
}
var e DocStoreError
if errors.As(err, &e) {
return e.code
}
return ""
}