-
Notifications
You must be signed in to change notification settings - Fork 13
/
DocumentCollection.js
811 lines (756 loc) · 24.7 KB
/
DocumentCollection.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
import flag from 'cozy-flags'
import { uri, attempt, sleep } from './utils'
import uniq from 'lodash/uniq'
import omit from 'lodash/omit'
import head from 'lodash/head'
import merge from 'lodash/merge'
import startsWith from 'lodash/startsWith'
import qs from 'qs'
import {
MangoQueryOptions,
MangoSelector,
MangoPartialFilter,
DesignDoc
} from './mangoIndex'
import Collection, {
dontThrowNotFoundError,
isIndexNotFoundError,
isIndexConflictError,
isNoUsableIndexError,
isDocumentUpdateConflict,
isIndexNotUsedWarning
} from './Collection'
import {
getIndexNameFromFields,
transformSort,
getIndexFields,
isMatchingIndex,
normalizeDesignDoc
} from './mangoIndex'
import * as querystring from './querystring'
import { FetchError } from './errors'
import logger from './logger'
const DATABASE_DOES_NOT_EXIST = 'Database does not exist.'
/**
* Normalize a document, adding its doctype if needed
*
* @param {object} doc - Document to normalize
* @param {string} doctype - Document doctype
* @returns {object} normalized document
* @private
*/
export function normalizeDoc(doc = {}, doctype) {
const id = doc._id || doc.id
return { id, _id: id, _type: doctype, ...doc }
}
const prepareForDeletion = x =>
Object.assign({}, omit(x, '_type'), { _deleted: true })
/**
* Abstracts a collection of documents of the same doctype, providing CRUD methods and other helpers.
*/
class DocumentCollection {
constructor(doctype, stackClient) {
this.doctype = doctype
this.stackClient = stackClient
this.indexes = {}
this.endpoint = `/data/${this.doctype}/`
}
/**
* Provides a callback for `Collection.get`
*
* @param {string} doctype - Document doctype
* @returns {Function} (data, response) => normalizedDocument
* using `normalizeDoc`
*/
static normalizeDoctype(doctype) {
return this.normalizeDoctypeRawApi(doctype)
}
/**
* `normalizeDoctype` for api end points returning json api responses
*
* @private
* @param {string} doctype - Document doctype
* @returns {Function} (data, response) => normalizedDocument
* using `normalizeDoc`
*/
static normalizeDoctypeJsonApi(doctype) {
return function(data, response) {
// use the "data" attribute of the response
return normalizeDoc(data, doctype)
}
}
/**
* `normalizeDoctype` for api end points returning raw documents
*
* @private
* @param {string} doctype - Document doctype
* @returns {Function} (data, response) => normalizedDocument
* using `normalizeDoc`
*/
static normalizeDoctypeRawApi(doctype) {
return function(data, response) {
// use the response directly
return normalizeDoc(response, doctype)
}
}
/**
* Lists all documents of the collection, without filters.
*
* The returned documents are paginated by the stack.
*
* @param {object} options The fetch options: pagination & fetch of specific docs.
* @param {number} [options.limit=100] - Pagination limit
* @param {number} [options.skip=0] - Pagination Skip
* @param {string} [options.bookmark] - Pagination bookmark
* @param {Array<string>} [options.keys] - Keys to query
* @returns {Promise<{data, meta, skip, bookmark, next}>} The JSON API conformant response.
* @throws {FetchError}
*/
async all({ limit = 100, skip = 0, bookmark, keys } = {}) {
// If the limit is intentionnally null, we need to use _all_docs, since
// _normal_docs uses _find and has a hard limit of 1000
const isUsingAllDocsRoute = !!keys || limit === null
const route = isUsingAllDocsRoute ? '_all_docs' : '_normal_docs'
const url = uri`/data/${this.doctype}/${route}`
const params = {
include_docs: true,
limit,
skip,
keys,
bookmark
}
const path = querystring.buildURL(url, params)
// If no document of this doctype exist, this route will return a 404,
// so we need to try/catch and return an empty response object in case of a 404
let resp
try {
resp = await this.stackClient.fetchJSON('GET', path)
} catch (error) {
return dontThrowNotFoundError(error)
}
let data
/* If using `all_docs` we need to filter our design documents and check if
the document is not null. If we use `normal_doc` we can't have any design doc
*/
if (isUsingAllDocsRoute) {
data = resp.rows
.filter(doc => {
return (
doc &&
doc.doc !== null &&
!doc.error &&
!startsWith(doc.id, '_design')
)
})
.map(row => {
return normalizeDoc(row.doc, this.doctype)
})
} else {
data = resp.rows.map(row => {
return normalizeDoc(row, this.doctype)
})
}
// The presence of a bookmark doesn’t guarantee that there are more results.
// See https://docs.couchdb.org/en/2.2.0/api/database/find.html#pagination
const next = bookmark
? resp.rows.length >= limit
: skip + resp.rows.length < resp.total_rows
return {
data,
meta: { count: isUsingAllDocsRoute ? data.length : resp.total_rows },
skip: skip,
bookmark: resp.bookmark,
next
}
}
/**
* Fetch Documents with Mango
*
* @param {string} path - path to fetch
* @param {MangoSelector} selector - selector
* @param {MangoQueryOptions} options - request options
*/
async fetchDocumentsWithMango(path, selector, options = {}) {
return this.stackClient.fetchJSON(
'POST',
path,
this.toMangoOptions(selector, options)
)
}
/**
* Migrate an existing index to a new one with a different name.
*
* Index migration became necessary for optimistic index, because
* we started to use named index while we used to have unamed index,
* i.e. indexes with CouchDB-generated ID. This can also be used to
* migrate an index to a new name.
*
* @param {object} sourceIndex - The index to migrate
* @param {string} targetIndexName - The new index name
* @private
*/
async migrateIndex(sourceIndex, targetIndexName) {
try {
await this.copyIndex(sourceIndex, targetIndexName)
await this.destroyIndex(sourceIndex)
} catch (error) {
// A conflict might occur for parallel queries on same index:
// we retry once
if (!isDocumentUpdateConflict(error)) {
throw error
}
sleep(1000)
await this.copyIndex(sourceIndex, targetIndexName)
await this.destroyIndex(sourceIndex)
}
}
/**
* Handle index creation if it is missing.
*
* When an index is missing, we first check if there is one with a different
* name but the same definition. If yes, it means we found an old unamed
* index, so we migrate it. If there is none, we create the new index.
*
* /!\ Warning: this method is similar to CozyPouchLink.ensureIndex()
* If you edit this method, please check if the change is also needed in CozyPouchLink
*
* @param {object} selector The mango selector
* @param {MangoQueryOptions} options The find options
* @private
*/
async handleMissingIndex(selector, options) {
let { indexedFields, partialFilter } = options
if (!indexedFields) {
indexedFields = getIndexFields({ sort: options.sort, selector })
}
const indexName = getIndexNameFromFields(indexedFields, partialFilter)
const existingIndex = await this.findExistingIndex(selector, options)
if (!existingIndex) {
await this.createIndex(indexedFields, {
partialFilter,
indexName
})
} else if (existingIndex._id !== `_design/${indexName}`) {
await this.migrateIndex(existingIndex, indexName)
} else {
throw new Error(`Index unusable for query, index used: ${indexName}`)
}
}
/**
* Find documents with the mango selector and create index
* if missing.
*
* We adopt an optimistic approach for index creation:
* we run the query first, and only if an index missing
* error is returned, the index is created and
* the query run again.
*
* @param {string} path The route path
* @param {MangoSelector} selector The mango selector
* @param {MangoQueryOptions} options The find options
*
* @returns {Promise<object>} - The find response
* @protected
*/
async findWithMango(path, selector, options = {}) {
let resp
try {
resp = await this.fetchDocumentsWithMango(path, selector, options)
const warning = resp.warning || resp.meta?.warning
if (warning && options.partialFilter && isIndexNotUsedWarning(warning)) {
// This warning might happen when an index including a partial filter
// is not created yet.
throw new Error('no_index')
}
} catch (error) {
if (!isIndexNotFoundError(error) && !isNoUsableIndexError(error)) {
throw error
} else {
await this.handleMissingIndex(selector, options)
resp = await this.fetchDocumentsWithMango(path, selector, options)
}
}
return resp
}
/**
* Returns a filtered list of documents using a Mango selector.
The returned documents are paginated by the stack.
*
* @param {MangoSelector} selector The Mango selector.
* @param {MangoQueryOptions} options MangoQueryOptions
* @returns {Promise<{data, skip, bookmark, next, execution_stats}>} The JSON API conformant response.
* @throws {FetchError}
*/
async find(selector, options = {}) {
const { skip = 0 } = options
let resp
try {
const path = uri`/data/${this.doctype}/_find`
resp = await this.findWithMango(path, selector, options)
} catch (error) {
return dontThrowNotFoundError(error)
}
return {
data: resp.docs.map(doc => normalizeDoc(doc, this.doctype)),
next: resp.next,
skip,
bookmark: resp.bookmark,
execution_stats: resp.execution_stats
}
}
/**
* Returns a filtered list with all documents using a Mango selector,
* automatically fetching more documents if the total of documents is
* superior to the pagination limit.
* Can result in a lot of network requests.
*
The returned documents are paginated by the stack.
*
* @param {MangoSelector} selector The Mango selector.
* @param {MangoQueryOptions} options MangoQueryOptions
* @returns {Promise<Array<{data}>>} Documents fetched
* @throws {FetchError}
*/
async findAll(selector, options = {}) {
let next = true
let documents = []
let bookmark = options.bookmark || undefined
while (next) {
const resp = await this.find(selector, { ...options, bookmark })
documents.push(...resp.data)
bookmark = resp.bookmark
next = resp.next
}
return documents
}
/**
* Get a document by id
*
* @param {string} id The document id.
* @returns {Promise<object>} JsonAPI response containing normalized document as data attribute
*/
async get(id) {
return Collection.get(
this.stackClient,
`${this.endpoint}${encodeURIComponent(id)}`,
{
normalize: this.constructor.normalizeDoctype(this.doctype)
}
)
}
/**
* Get many documents by id
*/
async getAll(ids) {
let resp
try {
resp = await this.stackClient.fetchJSON(
'POST',
uri`/data/${this.doctype}/_all_docs?include_docs=true`,
{
keys: ids
}
)
} catch (error) {
return dontThrowNotFoundError(error)
}
const rows = resp.rows.filter(row => row.doc)
return {
data: rows.map(row => normalizeDoc(row.doc, this.doctype)),
meta: {
count: rows.length
}
}
}
/**
* Creates a document
*
* @param {object} doc - Document to create. Optional: you can force the id with the _id attribute
*/
async create({ _id, _type, ...document }) {
// In case of a fixed id, let's use the dedicated creation endpoint
// https://github.com/cozy/cozy-stack/blob/master/docs/data-system.md#create-a-document-with-a-fixed-id
const hasFixedId = !!_id
const method = hasFixedId ? 'PUT' : 'POST'
const endpoint = uri`/data/${this.doctype}/${hasFixedId ? _id : ''}`
const resp = await this.stackClient.fetchJSON(method, endpoint, document)
return {
data: normalizeDoc(resp.data, this.doctype)
}
}
/**
* Updates a document
*
* @param {object} document - Document to update. Do not forget the _id attribute
*/
async update(document) {
const resp = await this.stackClient.fetchJSON(
'PUT',
uri`/data/${this.doctype}/${document._id}`,
document
)
return {
data: normalizeDoc(resp.data, this.doctype)
}
}
/**
* Destroys a document
*
* @param {object} doc - Document to destroy. Do not forget _id and _rev attributes
*/
async destroy({ _id, _rev, ...document }) {
const resp = await this.stackClient.fetchJSON(
'DELETE',
uri`/data/${this.doctype}/${_id}?rev=${_rev}`
)
return {
data: normalizeDoc(
{ ...document, _id, _rev: resp.rev, _deleted: true },
this.doctype
)
}
}
/**
* Updates several documents in one batch
*
* @param {Document[]} rawDocs Documents to be updated
*/
async updateAll(rawDocs) {
const stackClient = this.stackClient
const docs = rawDocs ? rawDocs.map(d => omit(d, '_type')) : rawDocs
if (!docs || !docs.length) {
return Promise.resolve([])
}
try {
const update = await stackClient.fetchJSON(
'POST',
`/data/${this.doctype}/_bulk_docs`,
{
docs
}
)
return update
} catch (e) {
if (
e.reason &&
e.reason.reason &&
e.reason.reason === DATABASE_DOES_NOT_EXIST
) {
const firstDoc = await this.create(docs[0])
const resp = await this.updateAll(docs.slice(1))
resp.unshift({ ok: true, id: firstDoc._id, rev: firstDoc._rev })
return resp
} else {
throw e
}
}
}
/**
* Deletes several documents in one batch
*
* @param {Document[]} docs - Documents to delete
*/
destroyAll(docs) {
return this.updateAll(docs.map(prepareForDeletion))
}
/**
* Returns Mango Options from Selector and Options
*
* @param {MangoSelector} selector - Mango selector
* @param {MangoQueryOptions} options - Mango Options
* @returns {MangoQueryOptions} Mango options
*/
toMangoOptions(selector, options = {}) {
let { sort, indexedFields, partialFilter } = options
const { fields, skip = 0, limit, bookmark } = options
sort = transformSort(sort)
if (!indexedFields && selector) {
logger.warn(
'Selector fields should be manually indexed to prevent unexpected behaviour'
)
}
indexedFields = indexedFields
? indexedFields
: getIndexFields({ sort, selector })
const indexName =
options.indexId ||
`_design/${getIndexNameFromFields(indexedFields, partialFilter)}`
if (sort) {
const sortOrders = uniq(
sort.map(sortOption => head(Object.values(sortOption)))
)
if (sortOrders.length > 1)
throw new Error('Mango sort can only use a single order (asc or desc).')
const sortOrder = sortOrders.length > 0 ? head(sortOrders) : 'asc'
for (const field of indexedFields) {
if (!sort.find(sortOption => head(Object.keys(sortOption)) === field))
sort.push({ [field]: sortOrder })
}
}
// We need to pass the partialFilter in the selector, otherwise CouchDB might
// fallback on another index if it does not exist yet
const mergedSelector = partialFilter
? merge({ ...selector }, partialFilter)
: selector
return {
selector: mergedSelector,
use_index: indexName,
// _id is necessary for the store, and _rev is required for offline. See https://github.com/cozy/cozy-client/blob/95978d39546023920b0c01d689fed5dd41577a02/packages/cozy-client/src/CozyClient.js#L1153
fields: fields ? [...fields, '_id', '_rev'] : undefined,
limit,
skip,
bookmark: options.bookmark || bookmark,
sort,
execution_stats: flag('debug') ? true : undefined
}
}
async checkUniquenessOf(property, value) {
const indexId = await this.getUniqueIndexId(property)
const existingDocs = await this.find(
{ [property]: value },
{ indexId, fields: ['_id'] }
)
return existingDocs.data.length === 0
}
getUniqueIndexId(property) {
return this.getIndexId([property], {
indexName: `${this.doctype}/${property}`
})
}
async getIndexId(
fields,
{ partialFilter = '', indexName = getIndexNameFromFields(fields) }
) {
if (!this.indexes[indexName]) {
let index
try {
index = await this.createIndex(fields, {
partialFilter
})
} catch (error) {
if (!isIndexConflictError(error)) {
throw error
} else {
// This error much probably comes from 2 parallel index creation.
// So we wait & retry
await sleep(1000)
index = await this.createIndex(fields, {
partialFilter
})
}
}
this.indexes[indexName] = index
}
return this.indexes[indexName].id
}
/**
*
* @param {Array} fields - Fields to index
* @param {object} indexOption - Options for the index
* @param {MangoPartialFilter} [indexOption.partialFilter] - partialFilter
* @param {string} [indexOption.indexName] - indexName
* @returns {Promise<{id, fields}>}
*/
async createIndex(fields, { partialFilter, indexName } = {}) {
const indexDef = {
index: {
fields
}
}
if (indexName) {
indexDef.ddoc = indexName
}
if (partialFilter) {
indexDef.index.partial_filter_selector = partialFilter
}
let resp
try {
resp = await this.stackClient.fetchJSON(
'POST',
uri`/data/${this.doctype}/_index`,
indexDef
)
} catch (error) {
if (!isIndexConflictError(error)) {
throw error
} else {
// This error much probably comes from 2 parallel index creation, so
// there is nothing to do here as the index will eventually be created
return
}
}
const indexResp = {
id: resp.id,
fields
}
if (resp.result === 'exists') return indexResp
// indexes might not be usable right after being created; so we delay the resolving until they are
const selector = {}
fields.forEach(f => (selector[f] = { $gt: null }))
const options = {
indexId: indexResp.id,
limit: 1,
partialFilterFields: partialFilter
? getIndexFields({ partialFilter })
: null
}
if (await attempt(this.find(selector, options))) return indexResp
// one retry
await sleep(1000)
if (await attempt(this.find(selector, options))) return indexResp
await sleep(500)
return indexResp
}
/**
* Retrieve all design docs of mango indexes
*
* @returns {Promise<DesignDoc[]>} The design docs
*/
async fetchAllMangoIndexes() {
const path = uri`/data/${this.doctype}/_design_docs?include_docs=true`
const indexes = await this.stackClient.fetchJSON('GET', path)
// Filter out views index
return indexes.rows
.filter(index => index.doc.language === 'query')
.map(doc => normalizeDesignDoc(doc))
}
/**
* Delete the specified design doc
*
* @param {DesignDoc} index - The design doc to remove
* @returns {Promise<object>} The delete response
*/
async destroyIndex(index) {
const ddoc = index._id.split('/')[1]
const rev = index._rev
const path = uri`/data/${this.doctype}/_design/${ddoc}?rev=${rev}`
return this.stackClient.fetchJSON('DELETE', path)
}
/**
* Copy an existing design doc.
*
* This is useful to create a new design doc without
* having to recompute the existing index.
*
* @param {DesignDoc} existingIndex - The design doc to copy
* @param {string} newIndexName - The name of the copy
* @returns {Promise<DesignDoc>} The copy response
*/
async copyIndex(existingIndex, newIndexName) {
const ddoc = existingIndex._id.split('/')[1]
const rev = existingIndex._rev
const path = uri`/data/${this.doctype}/_design/${ddoc}/copy?rev=${rev}`
const options = {
headers: {
Destination: `_design/${newIndexName}`
}
}
return this.stackClient.fetchJSON('POST', path, null, options)
}
/**
* Find an existing mango index based on the query definition
*
* This is useful to avoid creating new indexes having the
* same definition of an existing one.
*
* @param {MangoSelector} selector The query selector
* @param {MangoQueryOptions} options The find options
*
* @returns {Promise<DesignDoc>} A matching index if it exists
* @private
*/
async findExistingIndex(selector, options) {
let { sort, indexedFields, partialFilter } = options
const indexes = await this.fetchAllMangoIndexes()
if (indexes.length < 1) {
return null
}
sort = transformSort(sort)
const fieldsToIndex = indexedFields
? indexedFields
: getIndexFields({ sort, selector })
const existingIndex = indexes.find(index => {
return isMatchingIndex(index, fieldsToIndex, partialFilter)
})
return existingIndex
}
/**
* Calls _changes route from CouchDB
* No further treatment is done contrary to fetchchanges
*
* @param {object} couchOptions - Couch options for changes https://kutt.it/5r7MNQ
* @param {string} [couchOptions.since] - Bookmark telling CouchDB from which point in time should changes be returned
* @param {Array<string>} [couchOptions.doc_ids] - Only return changes for a subset of documents
* @param {boolean} [couchOptions.includeDocs] - Includes full documents as part of results
* @param {string} [couchOptions.filter] - Filter
* @see https://docs.couchdb.org/en/stable/api/database/changes.html
*/
async fetchChangesRaw(couchOptions) {
const hasDocIds = couchOptions.doc_ids && couchOptions.doc_ids.length > 0
const urlParams = `?${[
qs.stringify({
...omit(couchOptions, ['doc_ids', 'includeDocs']),
include_docs: couchOptions.includeDocs
}),
hasDocIds && couchOptions.filter === undefined
? 'filter=_doc_ids'
: undefined
]
.filter(Boolean)
.join('&')}`
const method = hasDocIds ? 'POST' : 'GET'
const endpoint = `/data/${this.doctype}/_changes${urlParams}`
const params = hasDocIds ? { doc_ids: couchOptions.doc_ids } : undefined
const result = await this.stackClient.fetchJSON(method, endpoint, params)
return result
}
/**
* Use Couch _changes API
* Deleted and design docs are filtered by default, thus documents are retrieved in the response
* (include_docs is set to true in the parameters of _changes).
*
* You should use fetchChangesRaw to have low level control on _changes parameters.
*
* @param {object} couchOptions - Couch options for changes
* @param {string} [couchOptions.since] - Bookmark telling CouchDB from which point in time should changes be returned
* @param {Array<string>} [couchOptions.doc_ids] - Only return changes for a subset of documents
*
* @param {object} options - Further options on the returned documents. By default, it is set to { includeDesign: false, includeDeleted: false }
* @param {boolean} [options.includeDesign] - Whether to include changes from design docs (needs include_docs to be true)
* @param {boolean} [options.includeDeleted] - Whether to include changes for deleted documents (needs include_docs to be true)
*
* @typedef {object} FetchChangesReturnValue
* @property {string} newLastSeq
* @property {Array<object>} documents
* @returns {Promise<FetchChangesReturnValue>}
*/
async fetchChanges(couchOptions = {}, options = {}) {
let opts = {
// Necessary since we deal with deleted and design docs later
includeDocs: true
}
if (typeof couchOptions !== 'object') {
opts.since = couchOptions
logger.warn(
`fetchChanges use couchOptions as Object not a string, since is deprecated, please use fetchChanges({since: "${couchOptions}"}).`
)
} else if (Object.keys(couchOptions).length > 0) {
Object.assign(opts, couchOptions)
}
const result = await this.fetchChangesRaw(opts)
const newLastSeq = result.last_seq
let docs = result.results.map(x => x.doc).filter(Boolean)
if (!options.includeDesign) {
docs = docs.filter(doc => doc._id.indexOf('_design') !== 0)
}
if (!options.includeDeleted) {
docs = docs.filter(doc => !doc._deleted)
}
return {
newLastSeq,
documents: docs.map(doc => normalizeDoc(doc, this.doctype))
}
}
}
export default DocumentCollection
export const normalizeDoctype = DocumentCollection.normalizeDoctype