overleaf/services/docstore/app/js/MongoManager.js

256 lines
6 KiB
JavaScript
Raw Normal View History

/* eslint-disable
camelcase,
*/
// TODO: This file was created by bulk-decaffeinate.
// Fix any style issues and re-enable lint.
/*
* decaffeinate suggestions:
* DS102: Remove unnecessary code created because of implicit returns
* DS207: Consider shorter variations of null checks
* Full docs: https://github.com/decaffeinate/decaffeinate/blob/master/docs/suggestions.md
*/
let MongoManager
const { db, ObjectId } = require('./mongodb')
const logger = require('@overleaf/logger')
2020-09-10 13:07:14 -04:00
const metrics = require('@overleaf/metrics')
const Settings = require('@overleaf/settings')
2021-08-02 06:36:43 -04:00
const Errors = require('./Errors')
2020-07-31 11:20:07 -04:00
const { promisify } = require('util')
module.exports = MongoManager = {
findDoc(project_id, doc_id, filter, callback) {
if (callback == null) {
callback = function () {}
}
db.docs.findOne(
{
_id: ObjectId(doc_id.toString()),
2021-07-13 07:04:48 -04:00
project_id: ObjectId(project_id.toString()),
},
{
2021-07-13 07:04:48 -04:00
projection: filter,
},
callback
)
},
2014-04-28 12:43:19 -04:00
getProjectsDeletedDocs(project_id, filter, callback) {
db.docs
.find(
{
project_id: ObjectId(project_id.toString()),
2021-07-13 07:04:48 -04:00
deleted: true,
},
{
projection: filter,
sort: { deletedAt: -1 },
2021-07-13 07:04:48 -04:00
limit: Settings.max_deleted_docs,
}
)
.toArray(callback)
},
getProjectsDocs(project_id, options, filter, callback) {
const query = { project_id: ObjectId(project_id.toString()) }
if (!options.include_deleted) {
query.deleted = { $ne: true }
}
const queryOptions = {
2021-07-13 07:04:48 -04:00
projection: filter,
}
if (options.limit) {
queryOptions.limit = options.limit
}
db.docs.find(query, queryOptions).toArray(callback)
},
2014-06-05 08:29:50 -04:00
getArchivedProjectDocs(project_id, maxResults, callback) {
const query = {
project_id: ObjectId(project_id.toString()),
2021-07-13 07:04:48 -04:00
inS3: true,
}
db.docs
.find(query, { projection: { _id: 1 }, limit: maxResults })
.toArray(callback)
},
2014-04-29 10:07:22 -04:00
getNonArchivedProjectDocs(project_id, maxResults, callback) {
const query = {
project_id: ObjectId(project_id.toString()),
2021-07-13 07:04:48 -04:00
inS3: { $ne: true },
}
db.docs.find(query, { limit: maxResults }).toArray(callback)
},
getNonDeletedArchivedProjectDocs(project_id, maxResults, callback) {
const query = {
project_id: ObjectId(project_id.toString()),
deleted: { $ne: true },
2021-07-13 07:04:48 -04:00
inS3: true,
}
db.docs
.find(query, { projection: { _id: 1 }, limit: maxResults })
.toArray(callback)
},
upsertIntoDocCollection(project_id, doc_id, updates, callback) {
const update = {
$set: updates,
$inc: {
2021-07-13 07:04:48 -04:00
rev: 1,
},
$unset: {
2021-07-13 07:04:48 -04:00
inS3: true,
},
}
update.$set.project_id = ObjectId(project_id)
db.docs.updateOne(
{ _id: ObjectId(doc_id) },
update,
{ upsert: true },
callback
)
},
2015-06-02 14:55:22 -04:00
patchDoc(project_id, doc_id, meta, callback) {
db.docs.updateOne(
{
_id: ObjectId(doc_id),
2021-07-13 07:04:48 -04:00
project_id: ObjectId(project_id),
},
{ $set: meta },
callback
)
},
markDocAsArchived(doc_id, rev, callback) {
const update = {
$set: {},
2021-07-13 07:04:48 -04:00
$unset: {},
}
update.$set.inS3 = true
update.$unset.lines = true
update.$unset.ranges = true
const query = {
_id: doc_id,
2021-07-13 07:04:48 -04:00
rev,
}
db.docs.updateOne(query, update, callback)
},
2015-06-01 18:36:26 -04:00
getDocVersion(doc_id, callback) {
if (callback == null) {
callback = function () {}
}
db.docOps.findOne(
{
2021-07-13 07:04:48 -04:00
doc_id: ObjectId(doc_id),
},
{
projection: {
2021-07-13 07:04:48 -04:00
version: 1,
},
},
function (error, doc) {
if (error != null) {
return callback(error)
}
callback(null, (doc && doc.version) || 0)
}
)
},
setDocVersion(doc_id, version, callback) {
if (callback == null) {
callback = function () {}
}
db.docOps.updateOne(
{
2021-07-13 07:04:48 -04:00
doc_id: ObjectId(doc_id),
},
{
2021-07-13 07:04:48 -04:00
$set: { version },
},
{
2021-07-13 07:04:48 -04:00
upsert: true,
},
callback
)
},
2017-03-16 12:46:58 -04:00
2021-07-30 11:06:16 -04:00
getDocRev(doc_id, callback) {
db.docs.findOne(
{
_id: ObjectId(doc_id.toString()),
},
{
projection: { rev: 1 },
},
function (err, doc) {
if (err != null) {
return callback(err)
}
callback(null, doc && doc.rev)
}
)
},
// Helper method to support optimistic locking. Call the provided method for
// an existing doc and return the result if the rev in mongo is unchanged when
// checked afterwards. If the rev has changed, return a DocModifiedError.
2021-08-02 06:02:12 -04:00
withRevCheck(doc, method, callback) {
2021-07-30 11:06:16 -04:00
method(doc._id, function (err, result) {
if (err) return callback(err)
MongoManager.getDocRev(doc._id, function (err, currentRev) {
if (err) return callback(err)
if (isNaN(currentRev) || isNaN(doc.rev)) {
return callback(
new Errors.DocRevValueError('doc rev is NaN', {
doc_id: doc._id,
rev: doc.rev,
currentRev,
})
)
}
2021-07-30 11:06:16 -04:00
if (doc.rev !== currentRev) {
return callback(
2021-08-02 06:36:43 -04:00
new Errors.DocModifiedError('doc rev has changed', {
2021-07-30 11:06:16 -04:00
doc_id: doc._id,
rev: doc.rev,
currentRev,
})
)
}
return callback(null, result)
})
})
},
destroyDoc(doc_id, callback) {
db.docs.deleteOne(
{
2021-07-13 07:04:48 -04:00
_id: ObjectId(doc_id),
},
function (err) {
if (err != null) {
return callback(err)
}
db.docOps.deleteOne(
{
2021-07-13 07:04:48 -04:00
doc_id: ObjectId(doc_id),
},
callback
)
}
)
2021-07-13 07:04:48 -04:00
},
}
2020-07-31 11:20:07 -04:00
const methods = Object.getOwnPropertyNames(MongoManager)
module.exports.promises = {}
for (const method of methods) {
metrics.timeAsyncMethod(MongoManager, method, 'mongo.MongoManager', logger)
2020-07-31 11:20:07 -04:00
module.exports.promises[method] = promisify(module.exports[method])
}