/
datasets.js
1701 lines (1569 loc) · 84.9 KB
/
datasets.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
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
const { Writable } = require('stream')
const express = require('express')
const ajv = require('ajv')()
const util = require('util')
const path = require('path')
const fs = require('fs-extra')
const moment = require('moment')
const createError = require('http-errors')
const pump = util.promisify(require('pump'))
const mongodb = require('mongodb')
const config = require('config')
const chardet = require('chardet')
const slug = require('slugify')
const sanitizeHtml = require('../../shared/sanitize-html')
const CronJob = require('cron').CronJob
const LinkHeader = require('http-link-header')
const journals = require('../utils/journals')
const esUtils = require('../utils/es')
const filesUtils = require('../utils/files')
const datasetAPIDocs = require('../../contract/dataset-api-docs')
const privateDatasetAPIDocs = require('../../contract/dataset-private-api-docs')
const permissions = require('../utils/permissions')
const usersUtils = require('../utils/users')
const datasetUtils = require('../utils/dataset')
const virtualDatasetsUtils = require('../utils/virtual-datasets')
const restDatasetsUtils = require('../utils/rest-datasets')
const visibilityUtils = require('../utils/visibility')
const findUtils = require('../utils/find')
const asyncWrap = require('../utils/async-wrap')
const extensions = require('../utils/extensions')
const attachments = require('../utils/attachments')
const geo = require('../utils/geo')
const tiles = require('../utils/tiles')
const cache = require('../utils/cache')
const cacheHeaders = require('../utils/cache-headers')
const outputs = require('../utils/outputs')
const limits = require('../utils/limits')
const locks = require('../utils/locks')
const notifications = require('../utils/notifications')
const datasetPatchSchema = require('../../contract/dataset-patch')
const validatePatch = ajv.compile(datasetPatchSchema)
const datasetPostSchema = require('../../contract/dataset-post')
const validatePost = ajv.compile(datasetPostSchema.properties.body)
const userNotificationSchema = require('../../contract/user-notification')
const validateUserNotification = ajv.compile(userNotificationSchema)
const debugFiles = require('debug')('files')
const { getThumbnail, prepareThumbnailUrl } = require('../utils/thumbnails')
const datasetFileSample = require('../utils/dataset-file-sample')
const { bulkSearchStreams } = require('../utils/master-data')
const applicationKey = require('../utils/application-key')
const { syncDataset: syncRemoteService } = require('./remote-services')
const { basicTypes } = require('../workers/converter')
const { validateId } = require('../utils/validation')
const prometheus = require('../utils/prometheus')
const publicationSites = require('../utils/publication-sites')
const { prepareMarkdownContent } = require('../utils/markdown')
const router = express.Router()
function clean (publicUrl, dataset, query = {}, draft = false) {
const select = query.select ? query.select.split(',') : []
if (query.raw !== 'true') {
const thumbnail = query.thumbnail || '300x200'
if (draft) datasetUtils.mergeDraft(dataset)
if (!select.includes('-public')) dataset.public = permissions.isPublic('datasets', dataset)
if (!select.includes('-visibility')) dataset.visibility = visibilityUtils.visibility(dataset)
if (!query.select || select.includes('description')) {
dataset.description = dataset.description || ''
dataset.description = prepareMarkdownContent(dataset.description, query.html === 'true', query.truncate, 'dataset:' + dataset.id, dataset.updatedAt)
}
if (dataset.schema) {
for (const field of dataset.schema) {
field.description = field.description || ''
field.description = prepareMarkdownContent(field.description, query.html === 'true', null, `dataset:${dataset.id}:${field.key}`, dataset.updatedAt)
}
}
if (dataset.attachments) {
for (let i = 0; i < dataset.attachments.length; i++) {
const attachment = dataset.attachments[i]
attachment.description = attachment.description || ''
attachment.description = prepareMarkdownContent(attachment.description, query.html === 'true', null, `dataset:${dataset.id}:attachment-${i}`, dataset.updatedAt)
if (attachment.type === 'file') {
attachment.url = `${publicUrl}/api/v1/datasets/${dataset.id}/metadata-attachments/${attachment.name}`
}
}
}
if (dataset.schema && !select.includes('-previews')) {
dataset.previews = datasetUtils.previews(dataset, publicUrl)
}
if (!select.includes('-links')) findUtils.setResourceLinks(dataset, 'dataset', publicUrl)
if (dataset.image && dataset.public && !select.includes('-thumbnail')) {
dataset.thumbnail = prepareThumbnailUrl(publicUrl + '/api/v1/datasets/' + encodeURIComponent(dataset.id) + '/thumbnail', thumbnail)
}
if (dataset.image && publicUrl !== config.publicUrl) {
dataset.image = dataset.image.replace(config.publicUrl, publicUrl)
}
}
delete dataset.permissions
delete dataset._id
if (select.includes('-userPermissions')) delete dataset.userPermissions
if (select.includes('-owner')) delete dataset.owner
// TODO: this cleanup of extras.applications.publicationSites should be adapted
// when we introduce implicit filtering on publicationSite based on domain name
if (query.publicationSites && dataset?.extras?.applications) {
const publicationSites = query.publicationSites.split(',')
dataset.extras.applications = dataset.extras.applications
.filter(appRef => appRef.publicationSites && appRef.publicationSites.find(p => publicationSites.includes(p)))
if (publicationSites.length === 1) {
for (const appRef of dataset.extras.applications) delete appRef.publicationSites
}
}
return dataset
}
const checkStorage = (overwrite, indexed = false) => asyncWrap(async (req, res, next) => {
if (process.env.NO_STORAGE_CHECK === 'true') return next()
if (!req.get('Content-Length')) throw createError(411, 'Content-Length is mandatory')
const contentLength = Number(req.get('Content-Length'))
if (Number.isNaN(contentLength)) throw createError(400, 'Content-Length is not a number')
const estimatedContentSize = contentLength - 210
const owner = req.dataset ? req.dataset.owner : usersUtils.owner(req)
if (config.defaultLimits.datasetStorage !== -1 && config.defaultLimits.datasetStorage < estimatedContentSize) {
throw createError(413, 'Vous avez atteint la limite de votre espace de stockage pour ce jeu de données.')
}
if (config.defaultLimits.datasetIndexed !== -1 && config.defaultLimits.datasetIndexed < estimatedContentSize) {
throw createError(413, 'Vous dépassez la taille de données indexées autorisée pour ce jeu de données.')
}
const remaining = await limits.remaining(req.app.get('db'), owner)
if (overwrite && req.dataset && req.dataset.storage) {
// ignore the size of the dataset we are overwriting
if (remaining.storage !== -1) remaining.storage += req.dataset.storage.size
if (remaining.indexed !== -1) remaining.indexed += req.dataset.storage.size
}
const storageOk = remaining.storage === -1 || ((remaining.storage - estimatedContentSize) >= 0)
const indexedOk = !indexed || remaining.indexed === -1 || ((remaining.indexed - estimatedContentSize) >= 0)
if (!storageOk || !indexedOk) {
try {
await pump(
req,
new Writable({
write (chunk, encoding, callback) {
// do nothing wa just want to drain the request
callback()
}
})
)
} catch (err) {
console.warn('Failure to drain request that was rejected for exceeding storage limit', err)
}
if (!storageOk) throw createError(429, req.__('errors.exceedLimitStorage'))
if (!indexedOk) throw createError(429, req.__('errors.exceedLimitIndexed'))
}
next()
})
// create short ids for extensions that will be used as prefix of the properties ids in the schema
// try to make something both readable and with little conflict risk (but not 0 risk)
const prepareExtensions = (req, extensions, oldExtensions = []) => {
extensions
.filter(e => !e.shortId && !e.propertyPrefix)
.forEach(e => {
const oldExtension = oldExtensions.find(oldE => oldE.remoteService === e.remoteService && oldE.action === e.action)
if (oldExtension) {
// do not reprocess already assigned shortIds / propertyPrefixes to prevent compatibility break
if (oldExtension.shortId) e.shortId = oldExtension.shortId
if (oldExtension.propertyPrefix) e.propertyPrefix = oldExtension.propertyPrefix
} else {
// only apply to new extensions to prevent compatibility break
let propertyPrefix = e.action.toLowerCase();
['masterdata', 'find', 'bulk', 'search'].forEach(term => { propertyPrefix = propertyPrefix.replace(term, '') });
[':', '-', '.', ' '].forEach(char => { propertyPrefix = propertyPrefix.replace(char, '_') })
if (propertyPrefix.startsWith('post')) propertyPrefix = propertyPrefix.replace('post', '')
e.propertyPrefix = propertyPrefix.replace(/__/g, '_').replace(/^_/, '').replace(/_$/, '')
e.propertyPrefix = '_' + e.propertyPrefix
// TODO: also check if there is a conflict with an existing calculate property ?
}
})
const propertyPrefixes = extensions.filter(e => !!e.propertyPrefix).map(e => e.propertyPrefix)
if (propertyPrefixes.length !== [...new Set(propertyPrefixes)].length) {
throw createError(400, req.__('errors.extensionShortIdConflict'))
}
}
// Get the list of datasets
router.get('', cacheHeaders.listBased, asyncWrap(async (req, res) => {
const explain = req.query.explain === 'true' && req.user && (req.user.isAdmin || req.user.asAdmin) && {}
const datasets = req.app.get('db').collection('datasets')
req.resourceType = 'datasets'
const filterFields = {
concepts: 'schema.x-refersTo',
'field-type': 'schema.type',
'field-format': 'schema.format',
children: 'virtual.children',
services: 'extensions.remoteService',
status: 'status',
draftStatus: 'draft.status',
topics: 'topics.id',
publicationSites: 'publicationSites',
requestedPublicationSites: 'requestedPublicationSites',
spatial: 'spatial',
keywords: 'keywords',
title: 'title'
}
const facetFields = {
...filterFields,
topics: 'topics'
}
const sumsFields = { count: 'count' }
const nullFacetFields = ['publicationSites']
const extraFilters = []
if (req.query.bbox === 'true') {
extraFilters.push({ bbox: { $ne: null } })
}
if (req.query.queryable === 'true') {
extraFilters.push({ isMetaOnly: { $ne: true } })
extraFilters.push({ finalizedAt: { $ne: null } })
}
if (req.query.file === 'true') extraFilters.push({ file: { $exists: true } })
const query = findUtils.query(req, Object.assign({
filename: 'originalFile.name',
ids: 'id',
id: 'id',
rest: 'isRest',
virtual: 'isVirtual',
metaOnly: 'isMetaOnly'
}, filterFields), null, extraFilters)
const sort = findUtils.sort(req.query.sort)
const project = findUtils.project(req.query.select, [], req.query.raw === 'true')
const [skip, size] = findUtils.pagination(req.query)
const t0 = new Date().getTime()
if (explain) explain.middlewares = t0 - req.ts
const countPromise = req.query.count !== 'false' && datasets.countDocuments(query).then(res => {
if (explain) explain.countMS = new Date().getTime() - t0
return res
})
const resultsPromise = size > 0 && datasets.find(query).collation({ locale: 'en' }).limit(size).skip(skip).sort(sort).project(project).toArray().then(res => {
if (explain) explain.resultsMS = new Date().getTime() - t0
return res
})
const facetsPromise = req.query.facets && datasets.aggregate(findUtils.facetsQuery(req, facetFields, filterFields, nullFacetFields, extraFilters)).toArray().then(res => {
if (explain) explain.facetsMS = new Date().getTime() - t0
return res
})
const sumsPromise = req.query.sums && datasets
.aggregate(findUtils.sumsQuery(req, sumsFields, filterFields, extraFilters)).toArray()
.then(sumsResponse => {
const res = sumsResponse[0] || {}
for (const field of req.query.sums.split(',')) {
res[field] = res[field] || 0
}
if (explain) explain.sumsMS = new Date().getTime() - t0
return res
})
const [count, results, facets, sums] = await Promise.all([countPromise, resultsPromise, facetsPromise, sumsPromise])
const response = {}
if (countPromise) response.count = count
if (resultsPromise) response.results = results
else response.results = []
if (facetsPromise) response.facets = findUtils.parseFacets(facets, nullFacetFields)
if (sumsPromise) response.sums = sums
const t1 = new Date().getTime()
response.results.forEach(r => {
if (req.query.raw !== 'true') r.userPermissions = permissions.list('datasets', r, req.user)
clean(req.publicBaseUrl, r, req.query)
})
if (explain) {
explain.cleanMS = new Date().getTime() - t1
response.explain = explain
}
res.json(response)
}))
// Shared middleware to apply a lock on the modified resource
const lockDataset = (_shouldLock = true) => asyncWrap(async (req, res, next) => {
const db = req.app.get('db')
const shouldLock = typeof _shouldLock === 'function' ? _shouldLock(req.body, req.query) : _shouldLock
if (!shouldLock) return next()
for (let i = 0; i < config.datasetStateRetries.nb; i++) {
const lockKey = `dataset:${req.params.datasetId}`
const ack = await locks.acquire(db, lockKey, `${req.method} ${req.originalUrl}`)
if (ack) {
res.on('close', () => locks.release(db, lockKey).catch(err => console.error('failure to release dataset lock', err)))
return next()
} else {
// dataset found but locked : we cannot safely work on it, wait a little while before failing
await new Promise(resolve => setTimeout(resolve, config.datasetStateRetries.interval))
}
}
throw createError(409, `Une opération bloquante est déjà en cours sur le jeu de données ${req.params.datasetId}.`)
})
const lockNewDataset = async (req, res, dataset) => {
const db = req.app.get('db')
const lockKey = `dataset:${dataset.id}`
const ack = await locks.acquire(db, lockKey, `${req.method} - ${req.originalUrl}`)
if (ack) res.on('close', () => locks.release(db, lockKey).catch(err => console.warn('failure to release dataset lock', err)))
}
// Shared middleware to read dataset in db
// also checks that the dataset is in a state compatible with some action
// supports waiting a little bit to be a little permissive with the user
const readDataset = (_acceptedStatuses, preserveDraft, ignoreDraft) => asyncWrap(async (req, res, next) => {
const db = req.app.get('db')
const acceptedStatuses = typeof _acceptedStatuses === 'function' ? _acceptedStatuses(req.body) : _acceptedStatuses
for (let i = 0; i < config.datasetStateRetries.nb; i++) {
req.dataset = req.resource = await db.collection('datasets')
.findOne({ id: req.params.datasetId }, { projection: { _id: 0 } })
if (!req.dataset) return res.status(404).send('Dataset not found')
// in draft mode the draft is automatically merged and all following operations use dataset.draftReason to adapt
if (preserveDraft) {
req.dataset.prod = { ...req.dataset }
}
if ((preserveDraft || req.query.draft === 'true') && req.dataset.draft) {
Object.assign(req.dataset, req.dataset.draft)
if (!req.dataset.draft.finalizedAt) delete req.dataset.finalizedAt
if (!req.dataset.draft.bbox) delete req.dataset.bbox
}
if (!preserveDraft) {
delete req.dataset.draft
}
req.resourceType = 'datasets'
if (
req.dataset.status !== 'draft' &&
(req.isNewDataset || !acceptedStatuses || acceptedStatuses.includes(req.dataset.status))
) return next()
if (req.dataset.status === 'draft' && ignoreDraft) return next()
// dataset found but not in proper state.. wait a little while
await new Promise(resolve => setTimeout(resolve, config.datasetStateRetries.interval))
}
throw createError(409, `Le jeu de données n'est pas dans un état permettant l'opération demandée. État courant : ${req.dataset.status}.`)
})
router.use('/:datasetId/permissions', readDataset(), permissions.router('datasets', 'dataset', async (req, patchedDataset) => {
// this callback function is called when the resource becomes public
await publicationSites.onPublic(req.app.get('db'), patchedDataset, 'dataset')
}))
// retrieve a dataset by its id
router.get('/:datasetId', readDataset(), applicationKey, permissions.middleware('readDescription', 'read'), cacheHeaders.noCache, (req, res, next) => {
req.dataset.userPermissions = permissions.list('datasets', req.dataset, req.user, req.bypassPermissions)
res.status(200).send(clean(req.publicBaseUrl, req.dataset, req.query))
})
// retrieve only the schema.. Mostly useful for easy select fields
const sendSchema = (req, res, schema) => {
if (req.query.type) {
const types = req.query.type.split(',')
schema = schema.filter(field => types.includes(field.type))
}
if (req.query.format) {
const formats = req.query.format.split(',')
schema = schema.filter(field => formats.includes(field.format))
}
if (req.query.enum === 'true') {
schema = schema.filter(field => !!field.enum)
}
// in json schema format we remove calculated and extended properties by default (better matches the need of form generation)
const filterCalculated = req.query.mimeType === 'application/schema+json' ? req.query.calculated !== 'true' : req.query.calculated === 'false'
if (filterCalculated) {
schema = schema.filter(field => !field['x-calculated'])
}
const filterExtension = req.query.mimeType === 'application/schema+json' ? req.query.extension !== 'true' : req.query.extension === 'false'
if (filterExtension) {
schema = schema.filter(field => !field['x-extension'])
}
if (req.query.separator === 'false') {
schema = schema.filter(field => !field.separator)
}
if (req.query.capability) {
schema = schema.filter(field => {
if (field['x-capabilities'] && field['x-capabilities'][req.query.capability] === false) return false
if (field.key === '_id') return false
if (req.query.capability.startsWith('text') && field.type !== 'string') return false
if (req.query.capability === 'insensitive' && field.type !== 'string') return false
if (field.type === 'string' && (field.format === 'date' || field.format === 'date-time')) {
if (req.query.capability === 'text') return false
if (req.query.capability === 'textAgg') return false
if (req.query.capability === 'insensitive') return false
}
return true
})
}
if (req.query.maxCardinality) {
const maxCardinality = Number(req.query.maxCardinality)
schema = schema.filter(field => field['x-cardinality'] != null && field['x-cardinality'] <= maxCardinality)
}
if (req.query.mimeType === 'application/tableschema+json') {
res.setHeader('content-disposition', `attachment; filename="${req.dataset.id}-tableschema.json"`)
schema = datasetUtils.tableSchema(schema)
} else if (req.query.mimeType === 'application/schema+json') {
res.setHeader('content-disposition', `attachment; filename="${req.dataset.id}-schema.json"`)
schema = datasetUtils.jsonSchema(schema, req.publicBaseUrl)
} else {
schema.forEach(field => {
field.label = field.title || field['x-originalName'] || field.key
})
}
res.status(200).send(schema)
}
router.get('/:datasetId/schema', readDataset(), applicationKey, permissions.middleware('readSchema', 'read'), cacheHeaders.noCache, (req, res, next) => {
sendSchema(req, res, req.dataset.schema)
})
// alternate read schema route that does not return clues about the data (cardinality and enums)
router.get('/:datasetId/safe-schema', readDataset(), applicationKey, permissions.middleware('readSafeSchema', 'read'), cacheHeaders.noCache, (req, res, next) => {
const schema = req.dataset.schema
for (const p of schema) {
delete p['x-cardinality']
delete p.enum
}
sendSchema(req, res, schema)
})
const permissionsWritePublications = permissions.middleware('writePublications', 'admin')
const permissionsWriteExports = permissions.middleware('writeExports', 'admin')
const permissionsWriteDescription = permissions.middleware('writeDescription', 'write')
const descriptionBreakingKeys = ['schema', 'rest', 'virtual', 'lineOwnership', 'primaryKey', 'projection', 'attachmentsAsImage', 'extensions', 'timeZone'] // a change in these properties is considered a breaking change
const permissionsWriteDescriptionBreaking = permissions.middleware('writeDescriptionBreaking', 'write')
// Update a dataset's metadata
router.patch('/:datasetId',
lockDataset((patch) => {
return !!(patch.schema || patch.virtual || patch.extensions || patch.publications || patch.projection)
}),
readDataset((patch) => {
// accept different statuses of the dataset depending on the content of the patch
if (patch.schema || patch.virtual || patch.extensions || patch.publications || patch.projection) {
return ['finalized', 'error']
} else {
return null
}
}),
(req, res, next) => (descriptionBreakingKeys.find(key => key in req.body)) ? permissionsWriteDescriptionBreaking(req, res, next) : permissionsWriteDescription(req, res, next),
(req, res, next) => req.body.publications ? permissionsWritePublications(req, res, next) : next(),
(req, res, next) => req.body.exports ? permissionsWriteExports(req, res, next) : next(),
asyncWrap(async (req, res) => {
const db = req.app.get('db')
const patch = req.body
if (!validatePatch(patch)) return res.status(400).send(validatePatch.errors)
// Changed a previously failed dataset, retry everything.
// Except download.. We only try it again if the fetch failed.
if (req.dataset.status === 'error') {
if (req.dataset.isVirtual) patch.status = 'indexed'
else if (req.dataset.isRest) patch.status = 'analyzed'
else if (req.dataset.remoteFile && !req.dataset.originalFile) patch.status = 'imported'
else if (!basicTypes.includes(req.dataset.originalFile.mimetype)) patch.status = 'uploaded'
else patch.status = 'loaded'
}
// Ignore patch that doesn't bring actual change
Object.keys(patch).forEach(patchKey => {
if (JSON.stringify(patch[patchKey]) === JSON.stringify(req.dataset[patchKey])) { delete patch[patchKey] }
})
if (Object.keys(patch).length === 0) return res.status(200).send(clean(req.publicBaseUrl, req.dataset))
patch.updatedAt = moment().toISOString()
patch.updatedBy = { id: req.user.id, name: req.user.name }
if (patch.extensions) prepareExtensions(req, patch.extensions, req.dataset.extensions)
if (patch.extensions || req.dataset.extensions) {
patch.schema = await extensions.prepareSchema(db, patch.schema || req.dataset.schema, patch.extensions || req.dataset.extensions)
}
// Re-publish publications
if (!patch.publications && req.dataset.publications && req.dataset.publications.length) {
req.dataset.publications.filter(p => p.status !== 'deleted').forEach(p => { p.status = 'waiting' })
patch.publications = req.dataset.publications
}
// manage automatic export of REST datasets into files
if (patch.exports && patch.exports.restToCSV) {
if (patch.exports.restToCSV.active) {
const job = new CronJob(config.exportRestDatasets.cron, () => {})
patch.exports.restToCSV.nextExport = job.nextDates().toISOString()
} else {
delete patch.exports.restToCSV.nextExport
if (await fs.pathExists(datasetUtils.exportedFilePath(req.dataset, '.csv'))) {
await fs.remove(datasetUtils.exportedFilePath(req.dataset, '.csv'))
}
}
patch.exports.restToCSV.lastExport = req.dataset?.exports?.restToCSV?.lastExport
}
if (patch.extensions && req.dataset.isRest && req.dataset.extensions) {
const removedExtensions = req.dataset.extensions.filter(e => !patch.extensions.find(pe => e.remoteService === pe.remoteService && e.action === pe.action))
if (removedExtensions.length) {
await restDatasetsUtils.collection(db, req.dataset).updateMany({},
{ $unset: removedExtensions.reduce((a, re) => { a[extensions.getExtensionKey(re)] = ''; return a }, {}) }
)
await datasetUtils.updateStorage(db, req.dataset)
}
}
const removedRestProp = req.dataset.isRest && patch.schema && req.dataset.schema.find(df => !df['x-calculated'] && !df['x-extension'] && !patch.schema.find(f => f.key === df.key))
if (removedRestProp) {
// some property was removed in rest dataset, trigger full re-indexing
const deleteFields = req.dataset.schema.filter(df => !df['x-calculated'] && !df['x-extension'] && !patch.schema.find(f => f.key === df.key))
await restDatasetsUtils.collection(db, req.dataset).updateMany({},
{ $unset: deleteFields.reduce((a, df) => { a[df.key] = ''; return a }, {}) }
)
await datasetUtils.updateStorage(db, req.dataset)
patch.status = 'analyzed'
}
const coordXProp = req.dataset.schema.find(p => p['x-refersTo'] === 'http://data.ign.fr/def/geometrie#coordX')
const coordYProp = req.dataset.schema.find(p => p['x-refersTo'] === 'http://data.ign.fr/def/geometrie#coordY')
if (req.dataset.isVirtual) {
if (patch.schema || patch.virtual) {
patch.schema = await virtualDatasetsUtils.prepareSchema(db, { ...req.dataset, ...patch })
patch.status = 'indexed'
}
} else if (patch.schema && patch.schema.find(f => req.dataset.schema.find(df => df.key === f.key && df.ignoreDetection !== f.ignoreDetection))) {
// some ignoreDetection param has changed on a field, trigger full analysis / re-indexing
patch.status = 'loaded'
} else if (patch.schema && patch.schema.find(f => req.dataset.schema.find(df => df.key === f.key && df.ignoreIntegerDetection !== f.ignoreIntegerDetection))) {
// some ignoreIntegerDetection param has changed on a field, trigger full analysis / re-indexing
patch.status = 'loaded'
} else if (patch.extensions) {
// extensions have changed, trigger full re-indexing
patch.status = 'analyzed'
} else if (patch.projection && (!req.dataset.projection || patch.projection.code !== req.dataset.projection.code) && coordXProp && coordYProp) {
// geo projection has changed, trigger full re-indexing
patch.status = 'analyzed'
} else if (patch.schema && geo.geoFieldsKey(patch.schema) !== geo.geoFieldsKey(req.dataset.schema)) {
// geo concepts haved changed, trigger full re-indexing
patch.status = 'analyzed'
} else if (patch.schema && patch.schema.find(f => req.dataset.schema.find(df => df.key === f.key && df.separator !== f.separator))) {
// some separator has changed on a field, trigger full re-indexing
patch.status = 'analyzed'
} else if (patch.schema && patch.schema.find(f => req.dataset.schema.find(df => df.key === f.key && df.timeZone !== f.timeZone))) {
// some timeZone has changed on a field, trigger full re-indexing
patch.status = 'analyzed'
} else if (removedRestProp) {
patch.status = 'analyzed'
} else if (patch.schema && !datasetUtils.schemasFullyCompatible(patch.schema, req.dataset.schema)) {
try {
// this method will routinely throw errors
// we just try in case elasticsearch considers the new mapping compatible
// so that we might optimize and reindex only when necessary
await esUtils.updateDatasetMapping(req.app.get('es'), { id: req.dataset.id, schema: patch.schema })
await datasetUtils.updateStorage(db, { ...req.dataset, schema: patch.schema })
patch.status = 'indexed'
} catch (err) {
// generated ES mappings are not compatible, trigger full re-indexing
patch.status = 'analyzed'
}
} else if (patch.thumbnails || patch.masterData) {
// just change finalizedAt so that cache is invalidated, but the worker doesn't relly need to work on the dataset
patch.finalizedAt = (new Date()).toISOString()
} else if (patch.rest) {
// changes in rest history mode will be processed by the finalizer worker
patch.status = 'indexed'
}
const previousDataset = { ...req.dataset }
const mongoPatch = await datasetUtils.applyPatch(db, req.dataset, patch, false)
await publicationSites.applyPatch(db, previousDataset, req.dataset, req.user, 'dataset')
await db.collection('datasets').updateOne({ id: req.dataset.id }, mongoPatch)
await syncRemoteService(db, req.dataset)
res.status(200).json(clean(req.publicBaseUrl, req.dataset))
}))
// Change ownership of a dataset
router.put('/:datasetId/owner', readDataset(), permissions.middleware('changeOwner', 'admin'), asyncWrap(async (req, res) => {
// Must be able to delete the current dataset, and to create a new one for the new owner to proceed
if (!req.user.adminMode) {
if (req.body.type === 'user' && req.body.id !== req.user.id) return res.status(403).send()
if (req.body.type === 'organization') {
const userOrg = req.user.organizations.find(o => o.id === req.body.id)
if (!userOrg) return res.status(403).send()
if (![config.contribRole, config.adminRole].includes(userOrg.role)) return res.status(403).send(req.__('errors.missingPermission'))
}
}
if (req.body.type !== req.dataset.owner.type && req.body.id !== req.dataset.owner.id) {
const remaining = await limits.remaining(req.app.get('db'), req.body)
if (remaining.nbDatasets === 0) {
return res.status(429).send(req.__('errors.exceedLimitNbDatasets'))
}
if (req.dataset.storage) {
if (remaining.storage !== -1 && remaining.storage < req.dataset.storage.size) {
return res.status(429).send(req.__('errors.exceedLimitStorage'))
}
if (remaining.indexed !== -1 && req.dataset.storage.indexed && remaining.indexed < req.dataset.storage.indexed.size) {
return res.status(429).send(req.__('errors.exceedLimitIndexed'))
}
}
}
const patch = {
owner: req.body,
updatedBy: { id: req.user.id, name: req.user.name },
updatedAt: moment().toISOString()
}
await permissions.initResourcePermissions(patch)
const patchedDataset = (await req.app.get('db').collection('datasets')
.findOneAndUpdate({ id: req.params.datasetId }, { $set: patch }, { returnDocument: 'after' })).value
// Move all files
if (datasetUtils.dir(req.dataset) !== datasetUtils.dir(patchedDataset)) {
try {
await fs.move(datasetUtils.dir(req.dataset), datasetUtils.dir(patchedDataset))
} catch (err) {
console.warn('Error while moving dataset directory', err)
}
}
await syncRemoteService(req.app.get('db'), patchedDataset)
await datasetUtils.updateTotalStorage(req.app.get('db'), req.dataset.owner)
await datasetUtils.updateTotalStorage(req.app.get('db'), patch.owner)
res.status(200).json(clean(req.publicBaseUrl, patchedDataset))
}))
// Delete a dataset
router.delete('/:datasetId', readDataset(null, true, true), permissions.middleware('delete', 'admin'), asyncWrap(async (req, res) => {
await datasetUtils.delete(req.app.get('db'), req.app.get('es'), req.dataset)
if (req.dataset.draftReason && req.dataset.prod && req.dataset.prod.status !== 'draft') {
await datasetUtils.delete(req.app.get('db'), req.app.get('es'), req.dataset.prod)
}
await syncRemoteService(req.app.get('db'), { ...req.dataset, masterData: null })
await datasetUtils.updateTotalStorage(req.app.get('db'), req.dataset.owner)
res.sendStatus(204)
}))
const initNew = async (db, req) => {
const dataset = { ...req.body }
dataset.owner = usersUtils.owner(req)
const date = moment().toISOString()
dataset.createdAt = dataset.updatedAt = date
dataset.createdBy = dataset.updatedBy = { id: req.user.id, name: req.user.name }
dataset.permissions = []
dataset.schema = dataset.schema || []
if (dataset.extensions) {
prepareExtensions(req, dataset.extensions)
dataset.schema = await extensions.prepareSchema(db, dataset.schema, dataset.extensions)
}
return dataset
}
const titleFromFileName = (name) => {
let baseFileName = path.parse(name).name
if (baseFileName.endsWith('.gz')) baseFileName = path.parse(baseFileName).name
return path.parse(baseFileName).name.replace(/[.,/#!$%^&*;:{}=\-_`~()]/g, ' ').split(/\s+/).join(' ')
}
const setFileInfo = async (db, file, attachmentsFile, dataset, draft, res) => {
const patch = {
dataUpdatedBy: dataset.updatedBy,
dataUpdatedAt: dataset.updatedAt
}
if (file) {
patch.originalFile = {
name: file.originalname,
size: file.size,
mimetype: file.mimetype
}
}
if (!dataset.id) {
const baseTitle = dataset.title || titleFromFileName(file.originalname)
const baseId = slug(baseTitle, { lower: true, strict: true })
dataset.id = baseId
dataset.title = baseTitle
let i = 1; let dbExists = false; let fileExists = false
do {
if (i > 1) {
dataset.id = baseId + i
dataset.title = baseTitle + ' ' + i
}
// better to check file as well as db entry in case of file currently uploading
dbExists = await db.collection('datasets').countDocuments({ id: dataset.id })
fileExists = await fs.exists(datasetUtils.dir(dataset))
i += 1
} while (dbExists || fileExists)
if (draft) {
dataset.status = 'draft'
patch.draftReason = { key: 'file-new', message: 'Nouveau jeu de données chargé en mode brouillon' }
}
await fs.ensureDir(datasetUtils.dir({ ...dataset, ...patch }))
await fs.move(file.path, datasetUtils.originalFilePath({ ...dataset, ...patch }))
} else {
if (draft) {
patch.draftReason = { key: 'file-updated', message: 'Nouveau fichier chargé sur un jeu de données existant' }
}
}
dataset.title = dataset.title || file.title
// in draft mode this file replacement will occur later, when draft is validated
if (!draft) {
const oldoriginalFilePath = dataset.originalFile && datasetUtils.originalFilePath({ ...dataset, ...patch, originalFile: dataset.originalFile })
const neworiginalFilePath = datasetUtils.originalFilePath({ ...dataset, ...patch })
if (oldoriginalFilePath && oldoriginalFilePath !== neworiginalFilePath) {
await fs.remove(oldoriginalFilePath)
}
}
if (file && !basicTypes.includes(file.mimetype)) {
// we first need to convert the file in a textual format easy to index
patch.status = 'uploaded'
} else {
// The format of the original file is already well suited to workers
patch.status = 'loaded'
if (file) {
patch.file = patch.originalFile
const filePath = datasetUtils.filePath({ ...dataset, ...patch })
// Try to prevent weird bug with NFS by forcing syncing file before sampling
const fd = await fs.open(filePath, 'r')
await fs.fsync(fd)
await fs.close(fd)
const fileSample = await datasetFileSample({ ...dataset, ...patch })
debugFiles(`Attempt to detect encoding from ${fileSample.length} first bytes of file ${filePath}`)
patch.file.encoding = chardet.detect(fileSample)
debugFiles(`Detected encoding ${patch.file.encoding} for file ${filePath}`)
}
}
if (draft && !file && !await fs.pathExists(datasetUtils.filePath({ ...dataset, ...patch }))) {
// this happens if we upload only the attachments, not the data file itself
// in this case copy the one from prod
await fs.copy(datasetUtils.filePath(dataset), datasetUtils.filePath({ ...dataset, ...patch }))
}
if (draft && !attachmentsFile && await fs.pathExists(datasetUtils.attachmentsDir(dataset)) && !await fs.pathExists(datasetUtils.attachmentsDir({ ...dataset, ...patch }))) {
// this happens if we upload only the main data file and not the attachments
// in this case copy the attachments directory from prod
await fs.copy(datasetUtils.attachmentsDir(dataset), datasetUtils.attachmentsDir({ ...dataset, ...patch }))
}
if (attachmentsFile) {
await attachments.replaceAllAttachments({ ...dataset, ...patch }, attachmentsFile)
}
if (draft) {
dataset.draft = patch
} else {
Object.assign(dataset, patch)
}
return dataset
}
// Create a dataset by uploading data
const beforeUpload = asyncWrap(async (req, res, next) => {
if (!req.user) return res.status(401).send()
const owner = usersUtils.owner(req)
if (!permissions.canDoForOwner(owner, 'datasets', 'post', req.user, req.app.get('db'))) return res.sendStatus(403)
if ((await limits.remaining(req.app.get('db'), owner)).nbDatasets === 0) {
return res.status(429).send(req.__('errors.exceedLimitNbDatasets'))
}
next()
})
router.post('', beforeUpload, checkStorage(true, true), filesUtils.uploadFile(), filesUtils.fixFormBody(validatePost), asyncWrap(async (req, res) => {
req.files = req.files || []
debugFiles('POST datasets uploaded some files', req.files)
try {
const db = req.app.get('db')
validateId(req.body.id)
let dataset
// After uploadFile, req.files contains the metadata of an uploaded file, and req.body the content of additional text fields
const datasetFile = req.files.find(f => f.fieldname === 'file' || f.fieldname === 'dataset')
const attachmentsFile = req.files.find(f => f.fieldname === 'attachments')
if (datasetFile) {
if (req.body.isVirtual) throw createError(400, 'Un jeu de données virtuel ne peut pas être initialisé avec un fichier')
// TODO: do this in a worker instead ?
const datasetPromise = setFileInfo(db, datasetFile, attachmentsFile, await initNew(db, req), req.query.draft === 'true', res)
await Promise.race([datasetPromise, new Promise(resolve => setTimeout(resolve, 5000))])
// send header at this point, if we are not finished processing files
// asyncWrap keepalive option will keep request alive
res.writeHeader(201, { 'Content-Type': 'application/json' })
res.write(' ')
try {
dataset = await datasetPromise
permissions.initResourcePermissions(dataset, req.user)
} catch (err) {
// should not happen too often, but sometimes we get an error after sending the 201 status
// we return an error object nevertheless, better than to do nothing
res.send({ error: err.message })
throw err
}
await lockNewDataset(req, res, dataset)
await db.collection('datasets').insertOne(dataset)
await datasetUtils.updateStorage(db, dataset)
} else if (req.body.isVirtual) {
if (!req.body.title) throw createError(400, 'Un jeu de données virtuel doit être créé avec un titre')
if (attachmentsFile) throw createError(400, 'Un jeu de données virtuel ne peut pas avoir de pièces jointes')
if (!validatePost(req.body)) {
throw createError(400, JSON.stringify(validatePost.errors))
}
dataset = await initNew(db, req)
permissions.initResourcePermissions(dataset, req.user)
dataset.virtual = dataset.virtual || { children: [] }
dataset.schema = await virtualDatasetsUtils.prepareSchema(db, dataset)
dataset.status = 'indexed'
if (dataset.id) {
await db.collection('datasets').insertOne(dataset)
} else {
const baseId = slug(req.body.title, { lower: true, strict: true })
await datasetUtils.insertWithBaseId(db, dataset, baseId, res)
}
await lockNewDataset(req, res, dataset)
} else if (req.body.isRest) {
if (!req.body.title) throw createError(400, 'Un jeu de données éditable doit être créé avec un titre')
if (attachmentsFile) throw createError(400, 'Un jeu de données éditable ne peut pas être créé avec des pièces jointes')
if (!validatePost(req.body)) {
throw createError(400, JSON.stringify(validatePost.errors))
}
dataset = await initNew(db, req)
permissions.initResourcePermissions(dataset, req.user)
dataset.rest = dataset.rest || {}
dataset.schema = dataset.schema || []
// the dataset will go through a first index/finalize steps, not really necessary
// but this way everything will be initialized (journal, index)
dataset.status = 'analyzed'
if (dataset.id) {
await db.collection('datasets').insertOne(dataset)
} else {
const baseId = slug(req.body.title, { lower: true, strict: true })
await datasetUtils.insertWithBaseId(db, dataset, baseId, res)
}
await lockNewDataset(req, res, dataset)
await restDatasetsUtils.initDataset(db, dataset)
await db.collection('datasets').updateOne({ id: dataset.id }, { $set: { status: 'analyzed' } })
} else if (req.body.isMetaOnly) {
if (!req.body.title) throw createError(400, 'Un jeu de données métadonnées doit être créé avec un titre')
if (attachmentsFile) throw createError(400, 'Un jeu de données métadonnées ne peut pas être créé avec des pièces jointes')
if (!validatePost(req.body)) {
throw createError(400, JSON.stringify(validatePost.errors))
}
dataset = await initNew(db, req)
permissions.initResourcePermissions(dataset, req.user)
if (dataset.id) {
await db.collection('datasets').insertOne(dataset)
} else {
const baseId = slug(req.body.title, { lower: true, strict: true })
await datasetUtils.insertWithBaseId(db, dataset, baseId, res)
}
await lockNewDataset(req, res, dataset)
} else if (req.body.remoteFile) {
if (!validatePost(req.body)) {
throw createError(400, JSON.stringify(validatePost.errors))
}
dataset = await initNew(db, req)
req.body.remoteFile.name = req.body.remoteFile.name || path.basename(new URL(req.body.remoteFile.url).pathname)
dataset.title = dataset.title || titleFromFileName(req.body.remoteFile.name)
permissions.initResourcePermissions(dataset, req.user)
dataset.status = 'imported'
if (dataset.id) {
await db.collection('datasets').insertOne(dataset)
} else {
const baseId = slug(dataset.title, { lower: true, strict: true })
await datasetUtils.insertWithBaseId(db, dataset, baseId, res)
}
await lockNewDataset(req, res, dataset)
} else {
throw createError(400, 'Un jeu de données doit être initialisé avec un fichier ou déclaré "virtuel" ou "éditable" ou "métadonnées"')
}
delete dataset._id
await datasetUtils.updateTotalStorage(req.app.get('db'), dataset.owner)
await journals.log(req.app, dataset, { type: 'dataset-created', href: config.publicUrl + '/dataset/' + dataset.id }, 'dataset')
await syncRemoteService(db, dataset)
res.status(201).send(clean(req.publicBaseUrl, dataset, {}, req.query.draft === 'true'))
} catch (err) {
// Wrapped the whole thing in a try/catch to remove files in case of failure
for (const file of req.files) {
await fs.remove(file.path)
}
throw err
}
}, { keepalive: true }))
// PUT or POST with an id to create or update an existing dataset data
const attemptInsert = asyncWrap(async (req, res, next) => {
const db = req.app.get('db')
if (!req.user) return res.status(401).send()
const newDataset = await initNew(db, req)
newDataset.id = req.params.datasetId
if (!await db.collection('datasets').countDocuments({ id: newDataset.id })) {
validateId(newDataset.id)
}
// Try insertion if the user is authorized, in case of conflict go on with the update scenario
if (permissions.canDoForOwner(newDataset.owner, 'datasets', 'post', req.user, db)) {
try {
await db.collection('datasets').insertOne(newDataset)
req.isNewDataset = true
if ((await limits.remaining(req.app.get('db'), newDataset.owner)).nbDatasets === 0) {
return res.status(429, req.__('errors.exceedLimitNbDatasets'))
}
await datasetUtils.updateTotalStorage(req.app.get('db'), newDataset.owner)
} catch (err) {
if (err.code !== 11000) throw err
}
}
next()
})
const updateDataset = asyncWrap(async (req, res) => {
const draft = req.query.draft === 'true'
req.files = req.files || []
debugFiles('PUT datasets uploaded some files', req.files)
try {
const db = req.app.get('db')
// After uploadFile, req.files contains the metadata of an uploaded file, and req.body the content of additional text fields
const datasetFile = req.files.find(f => f.fieldname === 'file' || f.fieldname === 'dataset')
const attachmentsFile = req.files.find(f => f.fieldname === 'attachments')
if (!datasetFile && !attachmentsFile && !req.dataset.isVirtual && !req.dataset.isRest && !req.dataset.isMetaOnly) throw createError(400, 'Un jeu de données doit être initialisé avec un fichier ou déclaré "virtuel" ou "éditable" ou "métadonnées seules"')
if (datasetFile && (req.dataset.isVirtual || req.dataset.isRest || req.dataset.isMetaOnly)) throw createError(400, 'Un jeu de données est soit initialisé avec un fichier soit déclaré "virtuel" ou "éditable" ou "métadonnées seules"')
if (req.dataset.isVirtual && !req.dataset.title) throw createError(400, 'Un jeu de données virtuel doit être créé avec un titre')
if (req.dataset.isRest && !req.dataset.title) throw createError(400, 'Un jeu de données éditable doit être créé avec un titre')
if (req.dataset.isMetaOnly && !req.dataset.title) throw createError(400, 'Un jeu de données métadonnées seules doit être créé avec un titre')
if (req.dataset.isVirtual && attachmentsFile) throw createError(400, 'Un jeu de données virtuel ne peut pas avoir des pièces jointes')
if (req.dataset.isRest && attachmentsFile) throw createError(400, 'Un jeu de données éditable ne peut pas être créé avec des pièces jointes')
if (req.dataset.isMetaOnly && attachmentsFile) throw createError(400, 'Un jeu de données métadonnées seules ne peut pas être créé avec des pièces jointes')
let dataset = req.dataset
req.body.schema = req.body.schema || dataset.schema || []
if (req.body.extensions) {
prepareExtensions(req, req.body.extensions, dataset.extensions)
req.body.schema = await extensions.prepareSchema(db, req.body.schema, req.body.extensions)
}
req.body.updatedBy = { id: req.user.id, name: req.user.name }
req.body.updatedAt = moment().toISOString()
if (datasetFile || attachmentsFile) {
// send header at this point, then asyncWrap keepalive option will keep request alive while we process files
// TODO: do this in a worker instead ?
res.writeHeader(req.isNewDataset ? 201 : 200, { 'Content-Type': 'application/json' })
res.write(' ')
dataset = await setFileInfo(db, datasetFile, attachmentsFile, { ...dataset, ...req.body }, req.query.draft === 'true', res)
if (req.query.skipAnalysis === 'true') req.body.status = 'analyzed'
} else if (dataset.isVirtual) {
const { isVirtual, updatedBy, updatedAt, ...patch } = req.body
if (!validatePatch(patch)) {
throw createError(400, validatePatch.errors)
}
req.body.virtual = req.body.virtual || { children: [] }
req.body.schema = await virtualDatasetsUtils.prepareSchema(db, { ...dataset, ...req.body })
req.body.status = 'indexed'
} else if (dataset.isRest) {
const { isRest, updatedBy, updatedAt, ...patch } = req.body
if (!validatePatch(patch)) {
throw createError(400, validatePatch.errors)
}
req.body.rest = req.body.rest || {}
if (req.isNewDataset) {
await restDatasetsUtils.initDataset(db, { ...dataset, ...req.body })
dataset.status = 'analyzed'
} else {
try {
// this method will routinely throw errors
// we just try in case elasticsearch considers the new mapping compatible
// so that we might optimize and reindex only when necessary
await esUtils.updateDatasetMapping(req.app.get('es'), { id: req.dataset.id, schema: req.body.schema })
// Back to indexed state if schema did not change in significant manner
req.body.status = 'indexed'
} catch (err) {
// generated ES mappings are not compatible, trigger full re-indexing
req.body.status = 'analyzed'
}
}
}
if (draft) {
delete dataset.draftReason
Object.assign(dataset.draft, req.body)
} else {
Object.assign(dataset, req.body)
}
if (req.isNewDataset) permissions.initResourcePermissions(dataset, req.user)
await db.collection('datasets').replaceOne({ id: req.params.datasetId }, dataset)
if (req.isNewDataset) await journals.log(req.app, dataset, { type: 'dataset-created' }, 'dataset')
else if (!dataset.isRest && !dataset.isVirtual) {
await journals.log(
req.app,
req.query.draft === 'true' ? datasetUtils.mergeDraft({ ...dataset }) : dataset,
{ type: 'data-updated' }, 'dataset')
}
await Promise.all([
datasetUtils.updateStorage(db, dataset),
syncRemoteService(db, dataset)