/
service.go
475 lines (399 loc) · 16.6 KB
/
service.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
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
package entity
import (
"context"
"github.com/centrifuge/centrifuge-protobufs/gen/go/coredocument"
"github.com/centrifuge/go-centrifuge/anchors"
"github.com/centrifuge/go-centrifuge/contextutil"
"github.com/centrifuge/go-centrifuge/documents"
"github.com/centrifuge/go-centrifuge/documents/entityrelationship"
"github.com/centrifuge/go-centrifuge/errors"
"github.com/centrifuge/go-centrifuge/identity"
"github.com/centrifuge/go-centrifuge/jobs"
cliententitypb "github.com/centrifuge/go-centrifuge/protobufs/gen/go/entity"
"github.com/centrifuge/go-centrifuge/queue"
"github.com/centrifuge/go-centrifuge/utils"
"github.com/ethereum/go-ethereum/common/hexutil"
)
// Service defines specific functions for entity
type Service interface {
documents.Service
// DeriveFromPayload derives Entity from clientPayload
DeriveFromCreatePayload(ctx context.Context, payload *cliententitypb.EntityCreatePayload) (documents.Model, error)
// DeriveFromUpdatePayload derives entity model from update payload
DeriveFromUpdatePayload(ctx context.Context, payload *cliententitypb.EntityUpdatePayload) (documents.Model, error)
// DeriveEntityData returns the entity data as client data
DeriveEntityData(entity documents.Model) (*cliententitypb.EntityData, error)
// DeriveEntityResponse returns the entity model in our standard client format
DeriveEntityResponse(ctx context.Context, entity documents.Model) (*cliententitypb.EntityResponse, error)
// ListEntityRelationships lists all the relationships associated with the passed in entity identifier
ListEntityRelationships(ctx context.Context, entityIdentifier []byte) (documents.Model, []documents.Model, error)
// GetEntityByRelationship returns the entity model from database or requests from granter
GetEntityByRelationship(ctx context.Context, relationshipIdentifier []byte) (documents.Model, error)
// DeriveFromSharePayload derives the entity relationship from the relationship payload
DeriveFromSharePayload(ctx context.Context, payload *cliententitypb.RelationshipPayload) (documents.Model, error)
// Share takes an entity relationship, validates it, and tries to persist it to the DB
Share(ctx context.Context, entityRelationship documents.Model) (documents.Model, jobs.JobID, chan bool, error)
// DeriveFromRevokePayload derives the revoked entity relationship from the relationship payload
DeriveFromRevokePayload(ctx context.Context, payload *cliententitypb.RelationshipPayload) (documents.Model, error)
// Revoke takes a revoked entity relationship, validates it, and tries to persist it to the DB
Revoke(ctx context.Context, entityRelationship documents.Model) (documents.Model, jobs.JobID, chan bool, error)
// DeriveEntityRelationshipResponse returns create response from entity relationship model
DeriveEntityRelationshipResponse(model documents.Model) (*cliententitypb.RelationshipResponse, error)
}
// service implements Service and handles all entity related persistence and validations
// service always returns errors of type `errors.Error` or `errors.TypedError`
type service struct {
documents.Service
repo documents.Repository
queueSrv queue.TaskQueuer
jobManager jobs.Manager
factory identity.Factory
processor documents.DocumentRequestProcessor
erService entityrelationship.Service
anchorRepo anchors.AnchorRepository
idService identity.ServiceDID
receivedEntityValidator func() documents.ValidatorGroup
}
// DefaultService returns the default implementation of the service.
func DefaultService(
srv documents.Service,
repo documents.Repository,
queueSrv queue.TaskQueuer,
jobManager jobs.Manager,
factory identity.Factory,
erService entityrelationship.Service,
idService identity.ServiceDID,
anchorRepo anchors.AnchorRepository,
processor documents.DocumentRequestProcessor,
receivedEntityValidator func() documents.ValidatorGroup,
) Service {
return service{
repo: repo,
queueSrv: queueSrv,
jobManager: jobManager,
Service: srv,
factory: factory,
erService: erService,
idService: idService,
anchorRepo: anchorRepo,
processor: processor,
receivedEntityValidator: receivedEntityValidator,
}
}
// DeriveFromCoreDocument takes a core document model and returns an entity
func (s service) DeriveFromCoreDocument(cd coredocumentpb.CoreDocument) (documents.Model, error) {
entity := new(Entity)
err := entity.UnpackCoreDocument(cd)
if err != nil {
return nil, errors.NewTypedError(documents.ErrDocumentUnPackingCoreDocument, err)
}
return entity, nil
}
// UnpackFromCreatePayload initializes the model with parameters provided from the rest-api call
func (s service) DeriveFromCreatePayload(ctx context.Context, payload *cliententitypb.EntityCreatePayload) (documents.Model, error) {
if payload == nil || payload.Data == nil {
return nil, documents.ErrPayloadNil
}
did, err := contextutil.AccountDID(ctx)
if err != nil {
return nil, documents.ErrDocumentConfigAccountID
}
entity := new(Entity)
err = entity.InitEntityInput(payload, did)
if err != nil {
return nil, errors.NewTypedError(documents.ErrDocumentInvalid, err)
}
return entity, nil
}
// validateAndPersist validates the document, calculates the data root, and persists to DB
func (s service) validateAndPersist(ctx context.Context, old, new documents.Model, validator documents.Validator) (documents.Model, error) {
selfDID, err := contextutil.AccountDID(ctx)
if err != nil {
return nil, errors.NewTypedError(documents.ErrDocumentConfigAccountID, err)
}
entity, ok := new.(*Entity)
if !ok {
return nil, errors.NewTypedError(documents.ErrDocumentInvalidType, errors.New("unknown document type: %T", new))
}
// validate the entity
err = validator.Validate(old, entity)
if err != nil {
return nil, errors.NewTypedError(documents.ErrDocumentInvalid, err)
}
// we use CurrentVersion as the id since that will be unique across multiple versions of the same document
err = s.repo.Create(selfDID[:], entity.CurrentVersion(), entity)
if err != nil {
return nil, errors.NewTypedError(documents.ErrDocumentPersistence, err)
}
return entity, nil
}
// Create takes an entity model and does required validation checks, tries to persist to DB
func (s service) Create(ctx context.Context, entity documents.Model) (documents.Model, jobs.JobID, chan bool, error) {
selfDID, err := contextutil.AccountDID(ctx)
if err != nil {
return nil, jobs.NilJobID(), nil, errors.NewTypedError(documents.ErrDocumentConfigAccountID, err)
}
entity, err = s.validateAndPersist(ctx, nil, entity, CreateValidator(s.factory))
if err != nil {
return nil, jobs.NilJobID(), nil, err
}
txID := contextutil.Job(ctx)
txID, done, err := documents.CreateAnchorTransaction(s.jobManager, s.queueSrv, selfDID, txID, entity.CurrentVersion())
if err != nil {
return nil, jobs.NilJobID(), nil, err
}
return entity, txID, done, nil
}
// Update finds the old document, validates the new version and persists the updated document
func (s service) Update(ctx context.Context, new documents.Model) (documents.Model, jobs.JobID, chan bool, error) {
selfDID, err := contextutil.AccountDID(ctx)
if err != nil {
return nil, jobs.NilJobID(), nil, errors.NewTypedError(documents.ErrDocumentConfigAccountID, err)
}
old, err := s.GetCurrentVersion(ctx, new.ID())
if err != nil {
return nil, jobs.NilJobID(), nil, errors.NewTypedError(documents.ErrDocumentNotFound, err)
}
new, err = s.validateAndPersist(ctx, old, new, UpdateValidator(s.factory))
if err != nil {
return nil, jobs.NilJobID(), nil, err
}
txID := contextutil.Job(ctx)
txID, done, err := documents.CreateAnchorTransaction(s.jobManager, s.queueSrv, selfDID, txID, new.CurrentVersion())
if err != nil {
return nil, jobs.NilJobID(), nil, err
}
return new, txID, done, nil
}
// DeriveEntityResponse returns create response from entity model
func (s service) DeriveEntityResponse(ctx context.Context, model documents.Model) (*cliententitypb.EntityResponse, error) {
data, err := s.DeriveEntityData(model)
if err != nil {
return nil, err
}
// note that token registry is(must be) irrelevant here
h, err := documents.DeriveResponseHeader(nil, model)
if err != nil {
return nil, err
}
entityID := model.ID()
var relationships []*cliententitypb.Relationship
// if this identity is not the owner of the entity, return an empty relationships array
selfDID, err := contextutil.AccountDID(ctx)
if err != nil {
return nil, errors.New("failed to get self ID")
}
isCollaborator, err := model.IsDIDCollaborator(selfDID)
if err != nil {
return nil, err
}
if !isCollaborator {
return &cliententitypb.EntityResponse{
Header: h,
Data: &cliententitypb.EntityDataResponse{
Entity: data,
Relationships: relationships,
},
}, nil
}
_, models, err := s.ListEntityRelationships(ctx, entityID)
if err != nil {
return nil, err
}
//list the relationships associated with the entity
if models != nil {
for _, m := range models {
tokens, err := m.GetAccessTokens()
if err != nil {
return nil, err
}
targetDID := m.(*entityrelationship.EntityRelationship).TargetIdentity.String()
r := &cliententitypb.Relationship{
Identity: targetDID,
Active: len(tokens) != 0,
}
relationships = append(relationships, r)
}
}
return &cliententitypb.EntityResponse{
Header: h,
Data: &cliententitypb.EntityDataResponse{
Entity: data,
Relationships: relationships,
},
}, nil
}
// DeriveEntityRelationshipData returns the relationship data from an entity relationship model
func (s service) DeriveEntityRelationshipData(model documents.Model) (*cliententitypb.RelationshipData, error) {
return s.erService.DeriveEntityRelationshipData(model)
}
// DeriveEntityData returns create response from entity model
func (s service) DeriveEntityData(doc documents.Model) (*cliententitypb.EntityData, error) {
entity, ok := doc.(*Entity)
if !ok {
return nil, documents.ErrDocumentInvalidType
}
return entity.getClientData(), nil
}
// DeriveFromUpdatePayload returns a new version of the old entity identified by identifier in payload
func (s service) DeriveFromUpdatePayload(ctx context.Context, payload *cliententitypb.EntityUpdatePayload) (documents.Model, error) {
if payload == nil || payload.Data == nil {
return nil, documents.ErrPayloadNil
}
// get latest old version of the document
id, err := hexutil.Decode(payload.Identifier)
if err != nil {
return nil, errors.NewTypedError(documents.ErrDocumentIdentifier, errors.New("failed to decode identifier: %v", err))
}
old, err := s.GetCurrentVersion(ctx, id)
if err != nil {
return nil, err
}
cs, err := documents.FromClientCollaboratorAccess(payload.ReadAccess, payload.WriteAccess)
if err != nil {
return nil, err
}
entity := new(Entity)
err = entity.PrepareNewVersion(old, payload.Data, cs)
if err != nil {
return nil, errors.NewTypedError(documents.ErrDocumentPrepareCoreDocument, errors.New("failed to load entity from data: %v", err))
}
return entity, nil
}
// GetEntityByRelationship returns the entity model from database or requests from a granter peer
func (s service) GetEntityByRelationship(ctx context.Context, relationshipIdentifier []byte) (documents.Model, error) {
model, err := s.erService.GetCurrentVersion(ctx, relationshipIdentifier)
if err != nil {
return nil, entityrelationship.ErrERNotFound
}
relationship, ok := model.(*entityrelationship.EntityRelationship)
if !ok {
return nil, entityrelationship.ErrNotEntityRelationship
}
// TODO: to be enabled with document syncing
//entityIdentifier := relationship.EntityIdentifier
//if s.Service.Exists(ctx, entityIdentifier) {
// entity, err := s.Service.GetCurrentVersion(ctx, entityIdentifier)
// if err != nil {
// // in case of an error try to get document from collaborator
// return s.requestEntityWithRelationship(ctx, relationship)
// }
//
// // check if stored document is the latest version
// if err := documents.LatestVersionValidator(s.anchorRepo).Validate(nil, entity); err != nil {
// return s.requestEntityWithRelationship(ctx, relationship)
// }
//
// return entity, nil
//}
return s.requestEntityWithRelationship(ctx, relationship)
}
// ListEntityRelationships lists all the latest versions of the relationships associated with the passed in entity identifier
func (s service) ListEntityRelationships(ctx context.Context, entityIdentifier []byte) (documents.Model, []documents.Model, error) {
entity, err := s.GetCurrentVersion(ctx, entityIdentifier)
if err != nil {
return nil, nil, err
}
relationships, err := s.erService.GetEntityRelationships(ctx, entityIdentifier)
if err != nil {
return nil, nil, err
}
return entity, relationships, nil
}
func (s service) GetCurrentVersion(ctx context.Context, documentID []byte) (documents.Model, error) {
selfDID, err := contextutil.AccountDID(ctx)
if err != nil {
return nil, errors.NewTypedError(documents.ErrDocumentConfigAccountID, err)
}
var entity documents.Model
if s.Service.Exists(ctx, documentID) {
entity, err = s.Service.GetCurrentVersion(ctx, documentID)
if err != nil {
return nil, err
}
isCollaborator, err := entity.IsDIDCollaborator(selfDID)
if err != nil {
return nil, err
}
if !isCollaborator {
return nil, documents.ErrNoCollaborator
}
return entity, nil
}
return nil, documents.ErrDocumentNotFound
}
func (s service) requestEntityWithRelationship(ctx context.Context, relationship *entityrelationship.EntityRelationship) (documents.Model, error) {
accessTokens, err := relationship.GetAccessTokens()
if err != nil {
return nil, documents.ErrCDAttribute
}
// only one access token per entity relationship
if len(accessTokens) != 1 {
return nil, entityrelationship.ErrERNoToken
}
at := accessTokens[0]
if !utils.IsSameByteSlice(at.DocumentIdentifier, relationship.EntityIdentifier) {
return nil, entityrelationship.ErrERInvalidIdentifier
}
granterDID, err := identity.NewDIDFromBytes(at.Granter)
if err != nil {
return nil, err
}
response, err := s.processor.RequestDocumentWithAccessToken(ctx, granterDID, at.Identifier, at.DocumentIdentifier, relationship.Document.DocumentIdentifier)
if err != nil {
return nil, err
}
if response == nil || response.Document == nil {
return nil, documents.ErrDocumentInvalid
}
model, err := s.Service.DeriveFromCoreDocument(*response.Document)
if err != nil {
return nil, err
}
if err := s.receivedEntityValidator().Validate(nil, model); err != nil {
return nil, errors.NewTypedError(documents.ErrDocumentInvalid, err)
}
// TODO: to be enabled with document syncing
//if err = s.store(ctx, model); err != nil {
// return nil, err
//}
return model, nil
}
func (s service) store(ctx context.Context, model documents.Model) error {
selfDID, err := contextutil.AccountDID(ctx)
if err != nil {
errors.NewTypedError(documents.ErrDocumentConfigAccountID, err)
}
if s.Service.Exists(ctx, model.CurrentVersion()) {
err = s.repo.Update(selfDID[:], model.CurrentVersion(), model)
if err != nil {
return errors.NewTypedError(documents.ErrDocumentPersistence, err)
}
} else {
err = s.repo.Create(selfDID[:], model.CurrentVersion(), model)
if err != nil {
return errors.NewTypedError(documents.ErrCDCreate, err)
}
}
return nil
}
// DeriveFromSharePayload derives the entity relationship from the relationship payload
func (s service) DeriveFromSharePayload(ctx context.Context, payload *cliententitypb.RelationshipPayload) (documents.Model, error) {
return s.erService.DeriveFromCreatePayload(ctx, payload)
}
// Share takes an entity relationship, validates it, and tries to persist it to the DB
func (s service) Share(ctx context.Context, entityRelationship documents.Model) (documents.Model, jobs.JobID, chan bool, error) {
return s.erService.Create(ctx, entityRelationship)
}
// DeriveFromRevokePayload derives the revoked entity relationship from the relationship payload
func (s service) DeriveFromRevokePayload(ctx context.Context, payload *cliententitypb.RelationshipPayload) (documents.Model, error) {
return s.erService.DeriveFromUpdatePayload(ctx, payload)
}
// Revoke takes a revoked entity relationship, validates it, and tries to persist it to the DB
func (s service) Revoke(ctx context.Context, entityRelationship documents.Model) (documents.Model, jobs.JobID, chan bool, error) {
return s.erService.Update(ctx, entityRelationship)
}
// DeriveEntityRelationshipResponse returns create response from entity relationship model
func (s service) DeriveEntityRelationshipResponse(model documents.Model) (*cliententitypb.RelationshipResponse, error) {
return s.erService.DeriveEntityRelationshipResponse(model)
}