/
record.js
468 lines (408 loc) · 14.4 KB
/
record.js
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
// This mixin is used on View component of Records.
import { compose, validator, NoID } from '@cortezaproject/corteza-js'
import { mapGetters, mapActions } from 'vuex'
import { throttle } from 'lodash'
export default {
data () {
return {
inEditing: false,
processing: false,
processingDelete: false,
processingUndelete: false,
processingSubmit: false,
record: undefined,
initialRecordState: undefined,
errors: new validator.Validated(),
}
},
computed: {
...mapGetters({
getModuleByID: 'module/getByID',
}),
validator () {
if (!this.module) {
throw new Error('can not initialize record validator without module')
}
return new compose.RecordValidator(this.module)
},
isValid () {
return this.errors.valid()
},
/**
* Tells if given record is deleted; If record not provided, returns undefined
* @returns {Boolean}
*/
isDeleted () {
return this.record && this.record.deletedAt
},
},
watch: {
'record.valueErrors': {
handler ({ set = [] } = {}) {
this.errors.push(...set)
},
},
},
methods: {
...mapActions({
updatePrompts: 'wfPrompts/update',
}),
/**
* Handle form submit for record create & update
*
* -> dispatch beforeFormSubmit (on ui:compose:record-page)
* -> validate record (see validateRecord())
* -> stop on errors
* -> send record to the API
* -> apply changes received from the API to current record
* -> dispatch afterFormSubmit
* -> redirect user to record viewer page
*
* @returns {Promise<void>}
*/
handleFormSubmit: throttle(async function (route = 'page.record') {
this.processingSubmit = true
this.processing = true
let record
const isNew = this.record.recordID === NoID
const queue = []
// Collect records from all record lines
this.blocks.forEach((b, index) => {
if (b.kind === 'RecordList' && b.options.editable) {
const p = new Promise((resolve) => {
const recordListUniqueID = [this.page.pageID, (this.record || {}).recordID, b.blockID, false].map(v => v || NoID).join('-')
this.$root.$emit(`record-line:collect:${recordListUniqueID}`, resolve)
})
queue.push(p)
}
})
const pairs = await Promise.all(queue)
for (const p of pairs) {
if (p.positionField) {
let i = 0
for (const item of p.items) {
if (!item.r.deletedAt) {
item.r.values[p.positionField] = i++
}
}
}
}
// Construct batch record payload
const records = pairs.reduce((acc, cur) => {
if (cur.idPrefix) {
// If same module exists, use latest to avoid stale data
const existingIndex = acc.findIndex(({ module }) => module.moduleID === cur.module.moduleID)
if (existingIndex !== -1) {
acc[existingIndex].set = cur.items.map(({ r }) => r).filter(({ deletedAt, recordID }) => recordID !== NoID || !deletedAt)
} else {
acc.push({
refField: cur.refField,
set: cur.items.map(({ r }) => r).filter(({ deletedAt, recordID }) => recordID !== NoID || !deletedAt),
module: cur.module,
idPrefix: cur.idPrefix,
})
}
}
return acc
}, [])
const { recordID = NoID } = this.record || {}
// Append after the payload construction, so it is not presented as a
// sub record.
pairs.push({
module: this.module,
items: [{ r: this.record, id: recordID === NoID ? 'parent:0' : recordID }],
})
return this
.dispatchUiEvent('beforeFormSubmit', this.record, { $records: records })
.then(() => this.validateRecord(pairs))
.then(() => {
if (isNew) {
return this.$ComposeAPI.recordCreate({ ...this.record, records })
} else {
return this.$ComposeAPI.recordUpdate({ ...this.record, records })
}
})
.catch(err => {
const { details = undefined } = err
if (!!details && Array.isArray(details) && details.length > 0) {
this.errors = new validator.Validated()
this.errors.push(...details)
throw new Error(this.$t('notification:record.validationErrors'))
}
throw err
})
.then(r => {
record = new compose.Record(this.module, r)
})
.then(() => this.dispatchUiEvent('afterFormSubmit', this.record, { $records: records }))
.then(() => this.updatePrompts())
.then(() => {
if (this.record.valueErrors.set) {
this.toastWarning(this.$t('notification:record.validationWarnings'))
} else {
this.inCreating = false
this.inEditing = false
// reset the record initial state in cases where the record edit page is redirected to the record view page
this.initialRecordState = this.record.clone()
if (this.showRecordModal) {
this.$emit('handle-record-redirect', { recordID: record.recordID, recordPageID: this.page.pageID })
// If we are in a modal we need to refresh blocks not in modal
this.$root.$emit('module-records-updated', {
moduleID: this.module.moduleID,
notPageID: this.page.pageID,
})
}
if (isNew) {
this.$router.push({ name: route, params: { ...this.$route.params, recordID: record.recordID } })
} else {
this.record = record
// reset the record initial state in cases where the record edit page is opened on a modal
this.initialRecordState = this.record.clone()
this.determineLayout().then(() => {
this.$root.$emit(`refetch-non-record-blocks:${this.page.pageID}`)
})
}
}
this.toastSuccess(this.$t(`notification:record.${isNew ? 'create' : 'update'}Success`))
})
.catch(this.toastErrorHandler(this.$t(`notification:record.${isNew ? 'create' : 'update'}Failed`)))
.finally(() => {
this.processingSubmit = false
this.processing = false
})
}, 500),
/**
* Handle form submit for record browser
* @returns {Promise<void>}
*/
handleFormSubmitSimple: throttle(function (route = 'page.record') {
this.processingSubmit = true
this.processing = true
let record
const isNew = this.record.recordID === NoID
return this
.dispatchUiEvent('beforeFormSubmit')
.then(() => this.validateRecordSimple())
.then(() => {
if (isNew) {
return this.$ComposeAPI.recordCreate(this.record)
} else {
return this.$ComposeAPI.recordUpdate(this.record)
}
})
.catch(err => {
const { details = undefined } = err
if (!!details && Array.isArray(details) && details.length > 0) {
this.errors.push(...details)
throw new Error(this.$t('notification:record.validationErrors'))
}
throw err
})
.then(r => {
record = new compose.Record(this.module, r)
})
.then(() => this.dispatchUiEvent('afterFormSubmit', record))
.then(() => this.updatePrompts())
.then(() => {
if (this.record.valueErrors.set) {
this.toastWarning(this.$t('notification:record.validationWarnings'))
} else {
this.inCreating = false
this.inEditing = false
this.record = record
this.initialRecordState = this.record.clone()
this.$router.push({ name: route, params: { ...this.$route.params, recordID: record.recordID } })
}
})
.catch(this.toastErrorHandler(this.$t(
isNew
? 'notification:record.createFailed'
: 'notification:record.updateFailed',
)))
.finally(() => {
this.processingSubmit = false
this.processing = false
})
}, 500),
/**
* On delete, preserve user's view. Show a notification that the record
* has been deleted.
*/
handleDelete: throttle(function () {
this.processing = true
this.processingDelete = true
return this
.dispatchUiEvent('beforeDelete')
.then(this.$ComposeAPI.recordDelete(this.record))
.then(() => {
this.record.deletedAt = (new Date()).toISOString()
})
.then(this.dispatchUiEvent('afterDelete'))
.then(this.updatePrompts())
.then(this.loadRecord)
.then(this.toastSuccess(this.$t('notification:record.deleteSuccess')))
.catch(this.toastErrorHandler(this.$t('notification:record.deleteFailed')))
.finally(() => {
this.processing = false
this.processingDelete = false
})
}, 500),
handleUndelete: throttle(function () {
this.processingUndelete = true
this.processing = true
return this
.dispatchUiEvent('beforeUndelete')
.then(this.$ComposeAPI.recordUndelete(this.record))
.then(this.dispatchUiEvent('afterUndelete'))
.then(this.updatePrompts())
.then(this.loadRecord)
.then(this.toastSuccess(this.$t('notification:record.restoreSuccess')))
.catch(this.toastErrorHandler(this.$t('notification:record.restoreFailed')))
.finally(() => {
this.processingUndelete = false
this.processing = false
})
}, 500),
handleBulkUpdateSelectedRecords: throttle(function (query) {
this.processing = true
const values = []
this.fields.forEach(f => {
const { name, isMulti, isSystem } = this.getField(f)
const value = isSystem ? this.record[name] : this.record.values[name]
if (!isMulti) {
values.push({ name, value: value ? value.toString() : value })
} else {
value.forEach(v => {
values.push({ name, value: v ? v.toString() : v })
})
}
})
const { moduleID, namespaceID } = this.module
return this
.$ComposeAPI.recordPatch({ moduleID, namespaceID, values, query })
.catch(err => {
const { details = undefined } = err
if (!!details && Array.isArray(details) && details.length > 0) {
this.errors = new validator.Validated()
this.errors.push(...details)
throw new Error(this.$t('notification:record.validationErrors'))
}
throw err
})
.then(this.updatePrompts())
.then(() => {
this.toastSuccess(this.$t('notification:record.bulkRecordUpdateSuccess'))
this.onModalHide()
this.fields = []
this.record = new compose.Record(this.module, {})
this.initialRecordState = this.record.clone()
this.$emit('save')
this.$root.$emit('module-records-updated', { moduleID })
})
.catch(this.toastErrorHandler(this.$t('notification:record.deleteBulkRecordUpdateFailed')))
.finally(() => {
this.processing = false
})
}, 500),
/**
* Validates record and dispatches onFormSubmitError
*
* onFormSubmitError is dispatched only if there are record errors,
* if not, we continue with form submit handling
*
* After onFormSubmitError, record is re-validated and if errors
* are still present, we stop form submit handing
*
* @returns {Promise<void>}
*/
async validateRecord (pairs) {
// Cache validators for later use
const validators = {}
for (const p of pairs) {
validators[p.module.resourceID] = validators[p.module.resourceID] || new compose.RecordValidator(p.module)
}
const vRunner = () => {
// Reset errors
this.errors = new validator.Validated()
// validate
for (const p of pairs) {
const v = validators[p.module.resourceID]
const errs = new validator.Validated()
p.items.forEach(({ r, id }) => {
if (r.deletedAt) {
return
}
const fields = p.module.fields
.filter(({ canUpdateRecordValue }) => canUpdateRecordValue)
.map(({ name }) => name)
// cover the edge case where all fields are not updatable
if (fields.length) {
const err = v.run(r, ...fields)
if (!err.valid()) {
err.applyMeta({ id })
errs.push(...err.set)
}
}
})
this.errors.push(...errs.set)
}
}
vRunner()
if (this.errors.valid()) {
return
}
await this.dispatchUiEvent('onFormSubmitError')
vRunner()
if (!this.errors.valid()) {
throw new Error(this.$t('notification:record.validationErrors'))
}
},
/**
* Validates record browser record
*
* @returns {Promise<void>}
*/
async validateRecordSimple () {
this.errors = this.validator.run(this.record)
if (this.errors.valid()) {
return
}
await this.dispatchUiEvent('onFormSubmitError')
this.errors = this.validator.run(this.record)
if (!this.errors.valid()) {
throw new Error(this.$t('notification:record.validationErrors'))
}
},
/**
* Returns errors, filtered for a specific field
* @param name
* @returns {validator.Validated} filtered validation results
*/
fieldErrors (name) {
if (!this.errors) {
return new validator.Validated()
}
return this.errors.filterByMeta('field', name)
},
/**
* Generic event dispatcher for ui:compose:record-page resource type
*
* This is used when deleting, updating, creating
* records and where validation errors occur
*
* @param eventType
*/
dispatchUiEvent (eventType, record = this.record, args = {}) {
const resourceType = `ui:compose:${this.getUiEventResourceType || 'record-page'}`
const argsBase = {
errors: this.errors,
validator: this.validator,
...args,
}
return this
.$EventBus
.Dispatch(compose.RecordEvent(
record, { eventType, resourceType, args: argsBase }))
},
},
}